// 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.