// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

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

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

#ifndef MMFDEVSOUNDSESSION_H

#define MMFDEVSOUNDSESSION_H

#include <e32base.h>

#include <e32std.h>

#include <e32msgqueue.h>

#include <mmf/common/mmfbase.h>

#include <mmf/common/mmfutilities.h>

#include <mmf/common/mmfipc.h>

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <mmf/common/mmfipcserver.h>

#endif

#include <mmf/server/sounddevice.h>

#include <a3f/mmfdevsoundcustominterfaceextensions.h>

#include "mmfaudioclientserver.h"

#include "mmfdevsoundadaptation.h"

#include <mmf/server/mmfdevsoundcustominterface.h>

#include "MmfDevSoundCIDeMuxUtility.h"

#include <mmf/common/mcustominterface.h>

// FORWARD DECLARATIONS

class CMMFDevSoundServer;

class CMMFDevSoundAdaptation;

class MGlobalProperties;

/**

Panic category and codes that MMFDevSoundSession raises on the client

*/

_LIT(KMMFDevSoundSessionPanicCategory, "MMFDevSoundSession");

enum TMMFDevSoundSessionPanicCodes

	{

	EMsgQueueFailedToSendMsg =1,

	EQueueRequestsFailedToAppend,

	EUnexpectedAsyncOpCompleteHandlingCI,

	ERequestBeingServicedMismatch

	};

// CLASS DECLARATION

/*

	This class is wrapper for RMmfIpcMessage

	The main purpose of this class is to hold a messages and 

	keep the status of the process started with the request

	This is not related to message status itself (if was completed or not)

	@lib MmfDevSoundServer.lib

	@since 

*/

class TMMFDevSoundRequest

	{

public:

	enum TA3FDevSoundRequestType

		{ 

		EQuery_Synchronous,			// Message completed immediately, doesn't involve commit cycle, can be serviced even when a commit operation is pending

		EQuery_Asynchronous,		// Message is not completed until operation is completed, doesn't involve commit cycle

		EConfigure_Synchronous,		// Message completed immediately, doesn't involve commit cycle, can be serviced even when a commit operation is pending

		EConfigure_Asynchronous,	// Message is not completed until operation is completed, cannot be serviced when a commit operation is pending

		EAction_Asynchronous,		// Message is not completed until operation is completed, cannot be serviced when a commit operation is pending

		EAction_PseudoAsynchronous,	// Message is completed, but all the incoming asynchronous request that involves commit are enqueued 

		EOther_Synchronous,			// Message completed immediately, doesn't involve commit cycle, can be serviced even when a commit operation is pending

		EBufferExchangeRelated,		// Message completed immediately, doesn't involve commit cycle, can be serviced even when a commit operation is pending

		ECustomInterfacesRelated,	// Message completed immediately, doesn't involve commit cycle, can be serviced even when a commit operation is pending

		EUndefinedType,

		ECallBackType,

		ESessionEvents,

		};	

public:

	TMMFDevSoundRequest();

	TMMFDevSoundRequest(TInt aIsCallBack);

	TMMFDevSoundRequest(const TMMFDevSoundRequest& aRequest);

	void SetMessage(const RMmfIpcMessage& aMessage);

	void SetMessageCallback();

	TBool operator==(const TMMFDevSoundRequest& aRequest) const;

	const RMmfIpcMessage& Message();

	TInt Function() const;

	TA3FDevSoundRequestType Type() const;

	TInt IsCallBack() const;

	void Complete(TInt aError);

private:

	TA3FDevSoundRequestType ResolveType();

private:

	TBool			iMessageCompleted;

	/**	

	The encapsulated request message	

	*/

	RMmfIpcMessage iMessage;

	/**

	The classification for this request

	*/

	TA3FDevSoundRequestType		iRequestType;

	TInt			iCallBackPF;

	};

// CLASS DECLARATION

/*

	Server-side session implementation.

	This class handles all the request from RMmfDevSoundProxy.

	This classes uses MmfDevSoundAdaptation library and forwards all the reqeusts

	to it. The main purpose of this class is to handle client server

	communication.

	@lib MmfDevSoundServer.lib

	@since 

*/

class CMMFDevSoundSession : public CMmfIpcSession,

							public MDevSoundAdaptationObserver,

							public MMMFDevSoundCustomInterfaceDeMuxInterface,

							public MCustomInterface,

							public MMMFDevSoundCustomInterfaceTarget

	{

public:  // Constructors and destructor	

	/**

		Constructs, and returns a pointer to, a new CMMFDevSoundSession

		object.

		Leaves on failure.

		@param MGlobalProperties a reference to global properties such as FourCC to format converter

		@return CMMFDevSoundSession* A pointer to newly created object.

	*/

	static CMMFDevSoundSession* NewL(MGlobalProperties& aGlobalProperties);

	/**

		Destructor.

	*/

	~CMMFDevSoundSession();

public: // New functions

	/**

		Called by Client/Server framework when a new session is created.

		Leaves on failure.

		@since 

		@param const CMmfIpcServer& aServer A constant reference to server

			creating this session.

		@return void

	*/

	void CreateL(const CMmfIpcServer& aServer);

	/**

		Called by Client/Server framework when service request is made by the

		corresponding RMmfDevSoundProxy.object.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return void

	*/

	void ServiceL(const RMmfIpcMessage& aMessage);

	/**

		Function to handle DevSound session id request.

		@since 

		@return TInt A integer assigned to this DevSound server.

	*/

	TInt DevSoundSessionId() {return iDevSoundSessionId;};

	// TODO: Review if the parameter should be kept or not

	void SendEventToClient(/*TMMFAudioServerEvent& aEvent*/);

	/**

		Method to service PostOpen request - 2nd phase async open.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoPostOpenL(const RMmfIpcMessage& aMessage);

	/**

		Method to service Initialize1L request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoInitialize1L(const RMmfIpcMessage& aMessage);

	/**

		Method to service Initialize1L request that has already completed, but

		not finished due to a pre-emption clash during its commit cycle(s).

		Leaves on failure.

		@return void

	*/

	void DoAlreadyCompletedInitialize1L();

	/**

		Method to service Initialize2L request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoInitialize2L(const RMmfIpcMessage& aMessage);

	/**

		Method to service Initialize2L request that has already completed, but

		not finished due to a pre-emption clash during its commit cycle(s).

		Leaves on failure.

		@return void

	*/

	void DoAlreadyCompletedInitialize2L();

	/**

		Method to service Initialize3L request.

		Leaves on failure.

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoInitialize3L(const RMmfIpcMessage& aMessage);

	/**

		Method to service Initialize4L request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoInitialize4L(const RMmfIpcMessage& aMessage);

	/**

		Method to service Initialize4L request that has already completed, but

		not finished due to a pre-emption clash during its commit cycle(s).

		Leaves on failure.

		@return void

	*/

	void DoAlreadyCompletedInitialize4L();

	/**

		Method to service CancelInitialize request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoCancelInitializeL(const RMmfIpcMessage& aMessage);

	/**

		Method to service capabilities query request from

		RMmfDevSoundProxy.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoCapabilitiesL(const RMmfIpcMessage& aMessage);

	/**

		Method to service current configuration query request from

		RMmfDevSoundProxy.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoConfigL(const RMmfIpcMessage& aMessage);

	/**

		Method to service set current configuration request from

		RMmfDevSoundProxy.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoSetConfigL(const RMmfIpcMessage& aMessage);

	/**

		Method to service maximum volume query request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoMaxVolumeL(const RMmfIpcMessage& aMessage);

	/**

		Method to service current volume level query request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoVolumeL(const RMmfIpcMessage& aMessage);

	/**

		Method to service set current volume level request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoSetVolumeL(const RMmfIpcMessage& aMessage);

	/**

		Method to service maximum gain query request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoMaxGainL(const RMmfIpcMessage& aMessage);

	/**

		Method to service current gain level query request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoGainL(const RMmfIpcMessage& aMessage);

	/**

		Method to service set current gain level request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoSetGainL(const RMmfIpcMessage& aMessage);

	/**

		Method to service current play balance level query request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoGetPlayBalanceL(const RMmfIpcMessage& aMessage);

	/**

		Method to service set current play balance level request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoSetPlayBalanceL(const RMmfIpcMessage& aMessage);

	/**

		Method to service current record balance level query request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoGetRecordBalanceL(const RMmfIpcMessage& aMessage);

	/**

		Method to service set current record balance level request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoSetRecordBalanceL(const RMmfIpcMessage& aMessage);

	/**

		Method to service initialize DevSound to play request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoPlayInitL(const RMmfIpcMessage& aMessage);

	/**

		Method to service initialize DevSound to play request that has already completed,

		but not finished due to a pre-emption clash during its commit cycle(s).

		Leaves on failure.

		@return void

	*/

	void DoAlreadyCompletedPlayInitL();

	/**

		Method to service initialize DevSound to record request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoRecordInitL(const RMmfIpcMessage& aMessage);

	/**

		Method to service initialize DevSound to record request that has already completed,

		but not finished due to a pre-emption clash during its commit cycle(s).

		Leaves on failure.

		@return void

	*/

	void DoAlreadyCompletedRecordInitL();

	/**

		Method to service signal DevSound to playing current buffer request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoPlayDataL(const RMmfIpcMessage& aMessage);

	/**

		Method to service signal DevSound to continue record request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoRecordDataL(const RMmfIpcMessage& aMessage);

	/**

		Method to service signal DevSound to stop ongoing operation request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoStopL(const RMmfIpcMessage& aMessage);

	/**

		Method to service signal DevSound to temporarily stop ongoing

		operation request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoPauseL(const RMmfIpcMessage& aMessage);

	/**

		Method to service signal DevSound to play simple tone  operation

		request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoPlayToneL(const RMmfIpcMessage& aMessage);

	/**

		Method to service signal DevSound to play simple tone operation

		request that has already completed, but not finished due to a

		pre-emption clash during its commit cycle(s).

		Leaves on failure.

		@return void

	*/

	void DoAlreadyCompletedPlayToneL();

	/**

		Method to service signal DevSound to play dual tone  operation

		request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoPlayDualToneL(const RMmfIpcMessage& aMessage);

	/**

		Method to service signal DevSound to play dual tone operation

		request that has already completed, but not finished due to a

		pre-emption clash during its commit cycle(s).

		Leaves on failure.

		@return void

	*/

	void DoAlreadyCompletedPlayDualToneL();

	/**

		Method to service signal DevSound to play DTMFString operation

		request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoPlayDTMFStringL(const RMmfIpcMessage& aMessage);

	/**

		Method to service signal DevSound to play DTMFString operation

		request that has already completed, but not finished due to a

		pre-emption clash during its commit cycle(s).

		Leaves on failure.

		@return void

	*/

	void DoAlreadyCompletedPlayDTMFStringL();

	/**

		Method to service signal DevSound to play tone sequence operation

		request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoPlayToneSequenceL(const RMmfIpcMessage& aMessage);

	/**

		Method to service signal DevSound to play tone sequence operation

		request that has already completed, but not finished due to a

		pre-emption clash during its commit cycle(s).

		Leaves on failure.

		@return void

	*/

	void DoAlreadyCompletedPlayToneSequenceL();

	/**

		Method to service signal DevSound to play fixed sequence operation

		request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoPlayFixedSequenceL(const RMmfIpcMessage& aMessage);

	/**

		Method to service signal DevSound to play fixed sequence operation

		request that has already completed, but not finished due to a

		pre-emption clash during its commit cycle(s).

		Leaves on failure.

		@return void

	*/

	void DoAlreadyCompletedPlayFixedSequenceL();

	/**

		Method to service signal DevSound to initilize DTMF String operation

		request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoSetDTMFLengthsL(const RMmfIpcMessage& aMessage);

	/**

		Method to service signal DevSound to set volume ramp operation

		request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoSetVolumeRampL(const RMmfIpcMessage& aMessage);

	/**

		Method to service query DevSound to return supported input data types

		operation request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoGetSupportedInputDataTypesL(const RMmfIpcMessage& aMessage);

	/**

		Method to service query DevSound to copy FourCC array data

		operation request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoCopyFourCCArrayDataL(const RMmfIpcMessage& aMessage);

	/**

		Method to service the request querying samples recorded so far.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoSamplesRecordedL(const RMmfIpcMessage& aMessage);

	/**

		Method to service the request querying samples played so far.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoSamplesPlayedL(const RMmfIpcMessage& aMessage);

	/**

		Method to service the request to set tone repeats.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoSetToneRepeatsL(const RMmfIpcMessage& aMessage);

	/**

		Method to service the request to set priority settings.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoSetPrioritySettingsL(const RMmfIpcMessage& aMessage);

	/**

		Method to service the request querrying fixed sequence name.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoFixedSequenceNameL(const RMmfIpcMessage& aMessage);

	/**

		Method to service the request querrying fixed sequence count.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoFixedSequenceCountL(const RMmfIpcMessage& aMessage);

	/**

		Method to service the request querrying supported output data types.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoGetSupportedOutputDataTypesL(const RMmfIpcMessage& aMessage);

	/**

		Method to service the request querrying specifics of the TBF data

			 buffer.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoBufferToBeFilledDataL(const RMmfIpcMessage& aMessage);

	/**

		Method to service the request querrying specifics of the TBE data

			buffer.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoBufferToBeEmptiedDataL(const RMmfIpcMessage& aMessage);

	/**

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoEmptyBuffersL(const RMmfIpcMessage& aMessage);

	/**

		Method to service the request querrying preparation for close session

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoPrepareCloseL(const RMmfIpcMessage& aMessage);

	TBool DoRegisterAsClientL(const RMmfIpcMessage& aMessage);

	TBool DoCancelRegisterAsClientL(const RMmfIpcMessage& aMessage);

	TBool DoGetResourceNotificationDataL(const RMmfIpcMessage& aMessage);

	TBool DoWillResumePlayL(const RMmfIpcMessage& aMessage);

	TBool DoSetClientThreadInfoL(const RMmfIpcMessage& aMessage);

	/**

		Method to get the current play time from the audio renderer

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoGetTimePlayedL(const RMmfIpcMessage& aMessage);

	/**

		Method to query if True Pause is supported by current codec format

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoQueryResumeSupportedL(const RMmfIpcMessage& aMessage);

	/**

		Method to service signal DevSound to resume playback, recording or tone playing

		request.

		Leaves on failure.

		@since 

		@param const RMmfIpcMessage& aMessage A reference to message object

			containing request attributes.

		@return ETrue if the request is serviced completely else EFalse.

	*/

	TBool DoResumeL(const RMmfIpcMessage& aMessage);

	/**

		Initializes to raw audio data PCM16 and Sampling Rate of 8 KHz.

		On completion of Initialization, calls InitializeComplete() on

		aDevSoundObserver.

		Leaves on failure.

		@since 

		@param MDevSoundAdaptationObserver& aDevSoundObserver A reference to DevSound

			Observer instance.

		@param TMMFState aMode Mode for which this object will be used.

		@return void

	*/

	void InitializeL(MDevSoundAdaptationObserver& aDevSoundObserver,

									TMMFState aMode);

	/**

		Initializes DevSound object for the mode aMode for processing audio

		data with hardware device aHWDev.

		On completion of Initialization, calls InitializeComplete() on

		aDevSoundObserver.

		Leaves on failure.

		@since 

		@param MDevSoundAdaptationObserver& aDevSoundObserver A reference to DevSound

			Observer instance.

		@param TUid aHWDev The CMMFHwDevice implementation identifier.

		@param TMMFState aMode The mode for which this object will be used

		@return void

	*/

	void InitializeL(MDevSoundAdaptationObserver& aDevSoundObserver,

					TUid aHWDev,

					TMMFState aMode);

	/**

		Initializes DevSound object for the mode aMode for processing audio

		data with hardware device supporting FourCC aDesiredFourCC.

		Leaves on failure.

		@since 

		@param MDevSoundAdaptationObserver& aDevSoundObserver A reference to

			the DevSound adaptation observer instance.

		@param TFourCC aDesiredFourCC The CMMFHwDevice implementation FourCC

			code.

		@param TMMFState aMode The mode for which this object will be used

		@return KErrNone if successfull, else corresponding error code

		@return void

	*/

	void InitializeL(MDevSoundAdaptationObserver& aDevSoundObserver,

					TFourCC aDesiredFourCC,

					TMMFState aMode);

	/**

		Returns the supported Audio settings ie. encoding, sample rates,

		mono/stereo operation, buffer size etc..

		@since 

		@return TMMFCapabilities The device settings.

	*/

	TMMFCapabilities Capabilities();

	/**

		Returns the current device configuration.

		@since 

		@return TMMFCapabilities The device settings.

	*/

	TMMFCapabilities Config() const;

	/**

		Configure CMMFDevSound object with the settings in aConfig. Use this

		to set sampling rate, encoding and mono/stereo.

		Leaves on failure.

		@since 

		@param const TMMFCapabilities& aConfig The attribute values to which

			CMMFDevSound object will be configured to.

		@return void

	*/

	void SetConfigL(const TMMFCapabilities& aCaps);

	/**

		Returns an integer representing the maximum volume device supports.

		This is the maximum value which can be passed to

		CMMFDevSound::SetVolume.

		@since 

		@return TInt The maximum volume. This value is platform dependent but

			is always greater than or equal to one.

	*/

	TInt MaxVolume();

	/**

		Returns an integer representing the current volume.

		@since 

		@return TInt The current volume level.

	*/

	TInt Volume();

	/**

		Changes the current playback volume to a specified value. The volume

		can be changed before or during playback and is effective immediately.

		@since 

		@param TInt aVolume The volume setting. This can be any value from 0

			to the value returned by a call to

			CMMFDevSound::MaxVolume(). If the volume is not

			within this range, the volume is automatically set

			to minimum or maximum value based on the value

			that is being passed. Setting a zero value mutes

			the sound. Setting the maximum value results in

			the loudest possible sound.

		@return void

	*/

	void SetVolume(TInt aVolume);

	/**

		Returns an integer representing the maximum gain the device supports.

		This is the maximum value which can be passed to CMMFDevSound::SetGain

		@since 

		@return TInt The maximum gain. This value is platform dependent but is

			always greater than or equal to one.

	*/

	TInt MaxGain();

	/**

		Returns an integer representing the current gain.

		@since 

		@return TInt The current gain level.

	*/

	TInt Gain();

	/**

		Changes the current recording gain to a specified value. The gain can

		be changed before or during recording and is effective immediately.

		@since 

		@param TInt aGain The gain setting. This can be any value from zero to

			the value returned by a call to

			CMMFDevSound::MaxGain(). If the volume

			is not within this range, the gain is automatically

			set to minimum or maximum value based on the value

			that is being passed. Setting a zero value mutes the

			sound. Setting the maximum value results in the

			loudest possible sound.

		@return void

	*/

	void SetGain(TInt aGain);

	/**

		Returns the speaker balance set for playing.

		Leaves on failure.

		@since 

		@param TInt &aLeftPercentage On return contains the left speaker

			volume percentage.

		@param TInt &aRightPercentage On return contains the right speaker

			volume percentage.

		@return void

	*/

	void GetPlayBalanceL(TInt& aLeftPercentage, TInt& aRightPercentage);

	/**

		Sets the speaker balance for playing. The speaker balance can be

		changed before or during playback and is effective immediately.

		Leaves on failure.

		@since 

		@param TInt aLeftPercentage The left speaker volume percentage. This

			can be any value from zero to 100. Setting

			a zero value mutes the sound on left

			speaker.

		@param TInt aRightPercentage The right speaker volume percentage.

			This can be any value from zero to 100.

			Setting a zero value mutes the sound on

			right speaker.

		@return void

	*/

	void SetPlayBalanceL(TInt aLeftPercentage, TInt aRightPercentage);

	/**

		Returns the microphone gain balance set for recording.

		Leaves on failure.

		@since 

		@param TInt &aLeftPercentage On return contains the left microphone

			gain percentage.

		@param TInt &aRightPercentage On return contains the right microphone

			 gain percentage.

		@return void

	*/

	void GetRecordBalanceL(TInt& aLeftPercentage, TInt& aRightPercentage);

	/**

		Sets the microphone balance for recording. The microphone balance can

		be changed before or during recording and is effective immediately.

		Leaves on failure.

		@since 

		@param TInt aLeftPercentage The left microphone gain percentage. This

		can be any value from zero to 100. Setting

			a zero value mutes the sound from left

			microphone.

		@param TInt aRightPercentage The right microphone gain percentage.

			This can be any value from zero to 100.

			Setting a zero value mutes the sound from

			right microphone.

		@return void

	*/

	void SetRecordBalanceL(TInt aLeftPercentage, TInt aRightPercentage);

	/**

		Initializes the audio device and starts the play process. This

		function queries and acquires the audio policy before initializing

		audio device. If there was an error during policy initialization,

		PlayError() function will be called on the observer with error code

		KErrAccessDenied, otherwise BufferToBeFilled() function will be called

		with a buffer reference. After reading data into the buffer reference

		passed, the client should call PlayData() to play data.

		The amount of data that can be played is specified in

		CMMFBuffer::RequestSize(). Any data that is read into buffer beyond

		this size will be ignored.

		Leaves on failure.

		@since 

		@return void

	*/

	void PlayInitL();

	/**

		Initializes the audio device and starts the record process. This

		function queries and acquires the audio policy before initializing

		audio device. If there was an error during policy initialization,

		RecordError() function will be called on the observer with error code

		KErrAccessDenied, otherwise BufferToBeEmptied() function will be called

		with a buffer reference. This buffer contains recorded or encoded