Symaptic: os/mm/mm_plat/audio_effects_proxy_api/inc/EnvironmentalReverbProxy.h@bde4ae8d615e (annotated)

sl@0	1	/*
sl@0	2	* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies).
sl@0	3	* All rights reserved.
sl@0	4	* This component and the accompanying materials are made available
sl@0	5	* under the terms of "Eclipse Public License v1.0"
sl@0	6	* which accompanies this distribution, and is available
sl@0	7	* at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0	8	*
sl@0	9	* Initial Contributors:
sl@0	10	* Nokia Corporation - initial contribution.
sl@0	11	*
sl@0	12	* Contributors:
sl@0	13	*
sl@0	14	* Description: This is the definition of the Environmental Reverb proxy class.
sl@0	15	*
sl@0	16	*
sl@0	17	*/
sl@0	18
sl@0	19
sl@0	20	#ifndef CENVIRONMENTALREVERBPROXY_H
sl@0	21	#define CENVIRONMENTALREVERBPROXY_H
sl@0	22
sl@0	23	// INCLUDES
sl@0	24
sl@0	25	#include <e32base.h>
sl@0	26	#include "EnvironmentalReverbMessageTypes.h"
sl@0	27	#include <EnvironmentalReverbBase.h>
sl@0	28	#include <mmf/common/mmfcontrollerframework.h>
sl@0	29	#include <CustomCommandUtility.h>
sl@0	30	#include <MEnvironmentalReverbObserver.h>
sl@0	31	#include <MAudioEffectObserver.h>
sl@0	32
sl@0	33	// FORWARD DECLARATION
sl@0	34	class CEnvironmentalReverbEventObserver;
sl@0	35	class CRoomLevelProxy;
sl@0	36
sl@0	37	// CLASS DECLARATION
sl@0	38
sl@0	39	/**
sl@0	40	* Interface class to be implemented by objects that receives callbacks from Environmental Reverb Event Observer.
sl@0	41	*
sl@0	42	* @since 3.0
sl@0	43	*/
sl@0	44	class MEnvironmentalReverbCallback
sl@0	45	{
sl@0	46	public:
sl@0	47
sl@0	48	/**
sl@0	49	* Invoked by the EnvironmentalReverb Event Observer when the EnvironmentalReverb object changes state
sl@0	50	* @since 3.0
sl@0	51	* @param aBuffer Buffer containing the EnvironmentalReverb data
sl@0	52	*/
sl@0	53	virtual void EnvironmentalReverbEvent( const TDesC8& aDataPckg ) = 0;
sl@0	54
sl@0	55	};
sl@0	56
sl@0	57	/**
sl@0	58	* This is the EnvironmentalReverb effect proxy class responsible for handling framework messages.
sl@0	59	*
sl@0	60	* @lib EnvironmentalReverbProxy.lib
sl@0	61	* @since 3.0
sl@0	62	*/
sl@0	63
sl@0	64	class CEnvironmentalReverbProxy : public CEnvironmentalReverb,
sl@0	65	public MEnvironmentalReverbCallback
sl@0	66	{
sl@0	67	public: // Constructors and destructor
sl@0	68
sl@0	69	/**
sl@0	70	*
sl@0	71	* Factory function for creating the EnvironmentalReverb proxy object.
sl@0	72	* @since 3.0
sl@0	73	* @param aMessageHandler reference to message handler
sl@0	74	* @param aCustomCommand reference to custom command utility
sl@0	75	* @return pointer to a EnvironmentalReverb proxy object
sl@0	76	*/
sl@0	77	IMPORT_C static CEnvironmentalReverbProxy* NewL( TMMFMessageDestinationPckg aMessageHandler,
sl@0	78	MCustomCommand& aCustomCommand,
sl@0	79	CCustomInterfaceUtility* aCustomInterfaceUtility );
sl@0	80	/**
sl@0	81	*
sl@0	82	* Destructor
sl@0	83	*/
sl@0	84	virtual ~CEnvironmentalReverbProxy();
sl@0	85
sl@0	86	public: // functions from base class
sl@0	87
sl@0	88	/**
sl@0	89	* From CAudioEffect
sl@0	90	* Apply effect settings
sl@0	91	* @since 3.0
sl@0	92	*/
sl@0	93	IMPORT_C virtual void ApplyL();
sl@0	94
sl@0	95	/**
sl@0	96	* Gets unique ID used by Adapation to identify stream specific Reverb
sl@0	97	* @since 3.1
sl@0	98	* @return ID
sl@0	99	*/
sl@0	100	virtual TUint32 GetUniqueId() const;
sl@0	101
sl@0	102	/**
sl@0	103	* Add the reference to Room Level object to array
sl@0	104	* @since 3.1
sl@0	105	* @return error/no error
sl@0	106	*/
sl@0	107	virtual TInt RoomLevelAttached(CRoomLevelProxy& aProxy);
sl@0	108
sl@0	109
sl@0	110	/**
sl@0	111	* Remove the reference to Room Level object from array
sl@0	112	* @since 3.1
sl@0	113	* @return error/no error
sl@0	114	*/
sl@0	115
sl@0	116	virtual TInt RoomLevelDetached(CRoomLevelProxy& aProxy);
sl@0	117
sl@0	118
sl@0	119	public: // functions from MEnvironmentalReverbCallback
sl@0	120
sl@0	121	/**
sl@0	122	* From MEnvironmentalReverbCallback
sl@0	123	* Changes to EnvironmentalReverb data has occured
sl@0	124	* @since 3.0
sl@0	125	* @param aBuffer Buffer containing serialized EnvironmentalReverb data
sl@0	126	*/
sl@0	127	void EnvironmentalReverbEvent( const TDesC8& aDataPckg );
sl@0	128
sl@0	129
sl@0	130	private:
sl@0	131	/**
sl@0	132	* Private C++ constructor for this class.
sl@0	133	* @since 3.0
sl@0	134	* @param aMessageHandler reference to message handler
sl@0	135	* @param aCustomCommand reference to custom command utility
sl@0	136	* @return -
sl@0	137	*/
sl@0	138	CEnvironmentalReverbProxy(TMMFMessageDestinationPckg aMessageHandler, MCustomCommand& aCustomCommand,
sl@0	139	CCustomInterfaceUtility* aCustomInterfaceUtility);
sl@0	140
sl@0	141	/**
sl@0	142	* Second phase constructor for this class.
sl@0	143	* @since 3.0
sl@0	144	* @return -
sl@0	145	*/
sl@0	146	void ConstructL();
sl@0	147
sl@0	148	/**
sl@0	149	* Start the active observer.
sl@0	150	* @since 3.0
sl@0	151	* @param -
sl@0	152	* @return -
sl@0	153	*/
sl@0	154	void StartObserver();
sl@0	155
sl@0	156	private:
sl@0	157
sl@0	158	// Pointer to custom command utility
sl@0	159	MCustomCommand* iCustomCommand;
sl@0	160	// Message handler handle
sl@0	161	TMMFMessageDestinationPckg iMessageHandler;
sl@0	162	// EnvironmentalReverb Event Observer
sl@0	163	CEnvironmentalReverbEventObserver* iEnvironmentalReverbEventObserver;
sl@0	164	// Pointer to the custom interface utility
sl@0	165	CCustomInterfaceUtility* iCustomInterfaceUtility;
sl@0	166
sl@0	167	RPointerArray<CRoomLevelProxy> iCRoomLevelProxyList;
sl@0	168
sl@0	169	};
sl@0	170
sl@0	171	#endif // of CENVIRONMENTALREVERBPROXY_H
sl@0	172
sl@0	173	// End of File

author	sl@SLION-WIN7.fritz.box
	Fri, 15 Jun 2012 03:10:57 +0200
changeset 0	bde4ae8d615e
permissions	-rw-r--r--