sl@0: /*
sl@0: * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description:  This is the definition of the Environmental Reverb proxy class.
sl@0: *
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef CENVIRONMENTALREVERBPROXY_H
sl@0: #define CENVIRONMENTALREVERBPROXY_H
sl@0: 
sl@0: // INCLUDES
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include "EnvironmentalReverbMessageTypes.h"
sl@0: #include <EnvironmentalReverbBase.h>
sl@0: #include <mmf/common/mmfcontrollerframework.h>
sl@0: #include <CustomCommandUtility.h>
sl@0: #include <MEnvironmentalReverbObserver.h>
sl@0: #include <MAudioEffectObserver.h>
sl@0: 
sl@0: // FORWARD DECLARATION
sl@0: class CEnvironmentalReverbEventObserver;
sl@0: class CRoomLevelProxy;
sl@0: 
sl@0: // CLASS DECLARATION
sl@0: 
sl@0: /**
sl@0: *  Interface class to be implemented by objects that receives callbacks from Environmental Reverb Event Observer.
sl@0: *
sl@0: *  @since 3.0
sl@0: */
sl@0: class MEnvironmentalReverbCallback
sl@0:     {
sl@0:     public:
sl@0: 
sl@0:         /**
sl@0:         * Invoked by the EnvironmentalReverb Event Observer when the EnvironmentalReverb object changes state
sl@0:         * @since 3.0
sl@0:         * @param aBuffer Buffer containing the EnvironmentalReverb data
sl@0:         */
sl@0:         virtual void EnvironmentalReverbEvent( const TDesC8& aDataPckg ) = 0;
sl@0: 
sl@0:     };
sl@0: 
sl@0: /**
sl@0: *  This is the EnvironmentalReverb effect proxy class responsible for handling framework messages.
sl@0: *
sl@0: *  @lib EnvironmentalReverbProxy.lib
sl@0: *  @since 3.0
sl@0: */
sl@0: 
sl@0: class CEnvironmentalReverbProxy : public CEnvironmentalReverb,
sl@0: 					         	  public MEnvironmentalReverbCallback
sl@0: 	{
sl@0: 	public:		// Constructors and destructor
sl@0: 
sl@0: 	    /**
sl@0:         *
sl@0:         * Factory function for creating the EnvironmentalReverb proxy object.
sl@0:         * @since 3.0
sl@0:         * @param aMessageHandler reference to message handler
sl@0:         * @param aCustomCommand reference to custom command utility
sl@0:         * @return	pointer to a EnvironmentalReverb proxy object
sl@0:         */
sl@0: 		IMPORT_C static CEnvironmentalReverbProxy* NewL( TMMFMessageDestinationPckg aMessageHandler,
sl@0:                      						        	 MCustomCommand& aCustomCommand,
sl@0:                       						        	 CCustomInterfaceUtility* aCustomInterfaceUtility );
sl@0: 		/**
sl@0:         *
sl@0:         * Destructor
sl@0:         */
sl@0: 		virtual ~CEnvironmentalReverbProxy();
sl@0: 
sl@0: 	public: // functions from base class
sl@0: 
sl@0: 		/**
sl@0: 		* From CAudioEffect
sl@0:         * Apply effect settings
sl@0:         * @since 3.0
sl@0:         */
sl@0: 		IMPORT_C virtual void ApplyL();
sl@0: 
sl@0: 		/**
sl@0:         * Gets unique ID used by Adapation to identify stream specific Reverb
sl@0:         * @since 3.1
sl@0:         * @return ID
sl@0:         */
sl@0: 		virtual TUint32 GetUniqueId() const;
sl@0: 
sl@0: 		/**
sl@0:         * Add the reference to Room Level object to array
sl@0:         * @since 3.1
sl@0:         * @return error/no error
sl@0:         */
sl@0: 		virtual TInt RoomLevelAttached(CRoomLevelProxy& aProxy);
sl@0: 
sl@0: 
sl@0: 		/**
sl@0:         * Remove the reference to Room Level object from array
sl@0:         * @since 3.1
sl@0:         * @return error/no error
sl@0:         */
sl@0: 
sl@0: 		virtual TInt RoomLevelDetached(CRoomLevelProxy& aProxy);
sl@0: 
sl@0: 
sl@0: 	public: // functions from MEnvironmentalReverbCallback
sl@0: 
sl@0: 		/**
sl@0: 		* From MEnvironmentalReverbCallback
sl@0:         * Changes to EnvironmentalReverb data has occured
sl@0:         * @since 3.0
sl@0:         * @param aBuffer Buffer containing serialized EnvironmentalReverb data
sl@0:         */
sl@0: 		void EnvironmentalReverbEvent( const TDesC8& aDataPckg );
sl@0: 
sl@0: 
sl@0: 	private:
sl@0: 		/**
sl@0: 		* Private C++ constructor for this class.
sl@0:         * @since	3.0
sl@0:         * @param aMessageHandler reference to message handler
sl@0:         * @param aCustomCommand reference to custom command utility
sl@0:         * @return	-
sl@0:         */
sl@0: 		CEnvironmentalReverbProxy(TMMFMessageDestinationPckg aMessageHandler, MCustomCommand& aCustomCommand,
sl@0: 					         	  CCustomInterfaceUtility* aCustomInterfaceUtility);
sl@0: 
sl@0: 		/**
sl@0: 		* Second phase constructor for this class.
sl@0:         * @since	3.0
sl@0:         * @return -
sl@0:         */
sl@0: 		void ConstructL();
sl@0: 
sl@0: 		/**
sl@0: 		* Start the active observer.
sl@0:         * @since	3.0
sl@0: 		* @param -
sl@0:         * @return -
sl@0:         */
sl@0:         void StartObserver();
sl@0: 
sl@0: 	private:
sl@0: 
sl@0: 		// Pointer to custom command utility
sl@0: 		MCustomCommand* iCustomCommand;
sl@0: 		// Message handler handle
sl@0: 		TMMFMessageDestinationPckg iMessageHandler;
sl@0: 	 	// EnvironmentalReverb Event Observer
sl@0: 		CEnvironmentalReverbEventObserver* iEnvironmentalReverbEventObserver;
sl@0: 		// Pointer to the custom interface utility
sl@0:     	CCustomInterfaceUtility* iCustomInterfaceUtility;
sl@0: 
sl@0:         RPointerArray<CRoomLevelProxy> iCRoomLevelProxyList;
sl@0: 
sl@0: 	};
sl@0: 
sl@0: #endif	// of CENVIRONMENTALREVERBPROXY_H
sl@0: 
sl@0: // End of File