Symaptic: os/mm/mm_plat/audio_effects_proxy_api/inc/EnvironmentalReverbProxy.h@260cb5ec6c19

     1 /*

     2 * Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  This is the definition of the Environmental Reverb proxy class.

    15 *

    16 *

    17 */

    20 #ifndef CENVIRONMENTALREVERBPROXY_H

    21 #define CENVIRONMENTALREVERBPROXY_H

    23 // INCLUDES

    25 #include <e32base.h>

    26 #include "EnvironmentalReverbMessageTypes.h"

    27 #include <EnvironmentalReverbBase.h>

    28 #include <mmf/common/mmfcontrollerframework.h>

    29 #include <CustomCommandUtility.h>

    30 #include <MEnvironmentalReverbObserver.h>

    31 #include <MAudioEffectObserver.h>

    33 // FORWARD DECLARATION

    34 class CEnvironmentalReverbEventObserver;

    35 class CRoomLevelProxy;

    37 // CLASS DECLARATION

    39 /**

    40 *  Interface class to be implemented by objects that receives callbacks from Environmental Reverb Event Observer.

    41 *

    42 *  @since 3.0

    43 */

    44 class MEnvironmentalReverbCallback

    45     {

    46     public:

    48         /**

    49         * Invoked by the EnvironmentalReverb Event Observer when the EnvironmentalReverb object changes state

    50         * @since 3.0

    51         * @param aBuffer Buffer containing the EnvironmentalReverb data

    52         */

    53         virtual void EnvironmentalReverbEvent( const TDesC8& aDataPckg ) = 0;

    55     };

    57 /**

    58 *  This is the EnvironmentalReverb effect proxy class responsible for handling framework messages.

    59 *

    60 *  @lib EnvironmentalReverbProxy.lib

    61 *  @since 3.0

    62 */

    64 class CEnvironmentalReverbProxy : public CEnvironmentalReverb,

    65 					         	  public MEnvironmentalReverbCallback

    66 	{

    67 	public:		// Constructors and destructor

    69 	    /**

    70         *

    71         * Factory function for creating the EnvironmentalReverb proxy object.

    72         * @since 3.0

    73         * @param aMessageHandler reference to message handler

    74         * @param aCustomCommand reference to custom command utility

    75         * @return	pointer to a EnvironmentalReverb proxy object

    76         */

    77 		IMPORT_C static CEnvironmentalReverbProxy* NewL( TMMFMessageDestinationPckg aMessageHandler,

    78                      						        	 MCustomCommand& aCustomCommand,

    79                       						        	 CCustomInterfaceUtility* aCustomInterfaceUtility );

    80 		/**

    81         *

    82         * Destructor

    83         */

    84 		virtual ~CEnvironmentalReverbProxy();

    86 	public: // functions from base class

    88 		/**

    89 		* From CAudioEffect

    90         * Apply effect settings

    91         * @since 3.0

    92         */

    93 		IMPORT_C virtual void ApplyL();

    95 		/**

    96         * Gets unique ID used by Adapation to identify stream specific Reverb

    97         * @since 3.1

    98         * @return ID

    99         */

   100 		virtual TUint32 GetUniqueId() const;

   102 		/**

   103         * Add the reference to Room Level object to array

   104         * @since 3.1

   105         * @return error/no error

   106         */

   107 		virtual TInt RoomLevelAttached(CRoomLevelProxy& aProxy);

   110 		/**

   111         * Remove the reference to Room Level object from array

   112         * @since 3.1

   113         * @return error/no error

   114         */

   116 		virtual TInt RoomLevelDetached(CRoomLevelProxy& aProxy);

   119 	public: // functions from MEnvironmentalReverbCallback

   121 		/**

   122 		* From MEnvironmentalReverbCallback

   123         * Changes to EnvironmentalReverb data has occured

   124         * @since 3.0

   125         * @param aBuffer Buffer containing serialized EnvironmentalReverb data

   126         */

   127 		void EnvironmentalReverbEvent( const TDesC8& aDataPckg );

   130 	private:

   131 		/**

   132 		* Private C++ constructor for this class.

   133         * @since	3.0

   134         * @param aMessageHandler reference to message handler

   135         * @param aCustomCommand reference to custom command utility

   136         * @return	-

   137         */

   138 		CEnvironmentalReverbProxy(TMMFMessageDestinationPckg aMessageHandler, MCustomCommand& aCustomCommand,

   139 					         	  CCustomInterfaceUtility* aCustomInterfaceUtility);

   141 		/**

   142 		* Second phase constructor for this class.

   143         * @since	3.0

   144         * @return -

   145         */

   146 		void ConstructL();

   148 		/**

   149 		* Start the active observer.

   150         * @since	3.0

   151 		* @param -

   152         * @return -

   153         */

   154         void StartObserver();

   156 	private:

   158 		// Pointer to custom command utility

   159 		MCustomCommand* iCustomCommand;

   160 		// Message handler handle

   161 		TMMFMessageDestinationPckg iMessageHandler;

   162 	 	// EnvironmentalReverb Event Observer

   163 		CEnvironmentalReverbEventObserver* iEnvironmentalReverbEventObserver;

   164 		// Pointer to the custom interface utility

   165     	CCustomInterfaceUtility* iCustomInterfaceUtility;

   167         RPointerArray<CRoomLevelProxy> iCRoomLevelProxyList;

   169 	};

   171 #endif	// of CENVIRONMENTALREVERBPROXY_H

   173 // End of File

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200
changeset 1	260cb5ec6c19
permissions	-rw-r--r--