sl@0: // Copyright (c) 2007-2009 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:
sl@0: //
sl@0: 
sl@0: #ifndef SBCENCODERCI_H
sl@0: #define SBCENCODERCI_H
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <mmf/common/mmfipc.h>
sl@0: #ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0: #include <mmf/common/mmfipcserver.h>
sl@0: #endif
sl@0: #include <mmf/server/mmfdevsoundcustominterface.h>
sl@0: #include <mmf/server/mmfdevsoundcustomcommands.h>
sl@0: #include <mmf/server/devsoundstandardcustominterfaces.h>
sl@0: #include <mmf/plugin/mmfdevsoundcustominterface.hrh>
sl@0: 
sl@0: /**
sl@0:  Enum to represent the methods called by this custom interface
sl@0:  @internalComponent
sl@0:  @prototype
sl@0:  @file
sl@0:  */
sl@0: enum TMMFDevSoundCISbcEncoderCommands
sl@0: 	{
sl@0: 	EMMFDevSoundCISbcEncoderGetSupportedSamplingFrequenciesCount = 0,
sl@0: 	EMMFDevSoundCISbcEncoderGetSupportedSamplingFrequenciesArray,
sl@0: 	EMMFDevSoundCISbcEncoderGetSupportedChannelModesCount,
sl@0: 	EMMFDevSoundCISbcEncoderGetSupportedChannelModesArray,
sl@0: 	EMMFDevSoundCISbcEncoderGetSupportedSubbandsCount,
sl@0: 	EMMFDevSoundCISbcEncoderGetSupportedSubbandsArray,
sl@0: 	EMMFDevSoundCISbcEncoderGetSupportedAllocationMethodsCount,
sl@0: 	EMMFDevSoundCISbcEncoderGetSupportedAllocationMethodsArray,
sl@0: 	EMMFDevSoundCISbcEncoderGetSupportedBlocksCount,
sl@0: 	EMMFDevSoundCISbcEncoderGetSupportedBlocksArray,
sl@0: 	EMMFDevSoundCISbcEncoderGetSupportedBitpoolRange,
sl@0: 	EMMFDevSoundCISbcEncoderSetSamplingFrequency,
sl@0: 	EMMFDevSoundCISbcEncoderSetChannelMode,
sl@0: 	EMMFDevSoundCISbcEncoderSetSubbands,
sl@0: 	EMMFDevSoundCISbcEncoderSetBlocks,
sl@0: 	EMMFDevSoundCISbcEncoderSetAllocationMethod,
sl@0: 	EMMFDevSoundCISbcEncoderSetBitpoolSize,
sl@0: 	EMMFDevSoundCISbcEncoderApplyConfig,
sl@0: 	EMMFDevSoundCISbcEncoderGetSamplingFrequency,	
sl@0: 	EMMFDevSoundCISbcEncoderGetChannelMode,
sl@0: 	EMMFDevSoundCISbcEncoderGetSubbands,
sl@0: 	EMMFDevSoundCISbcEncoderGetBlocks,
sl@0: 	EMMFDevSoundCISbcEncoderGetAllocationMethod,
sl@0: 	EMMFDevSoundCISbcEncoderGetBitpoolSize
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /**
sl@0:  CMMFSbcEncoderMux implementation of the SBC encoder custom interface pair
sl@0:  @internalComponent
sl@0:  @prototype
sl@0:  @file
sl@0:  */
sl@0: class CMMFSbcEncoderMux : public CBase,
sl@0: 						  public MMMFDevSoundCustomInterfaceMuxPlugin,
sl@0: 						  public MSbcEncoderIntfc
sl@0: 	{
sl@0: public:
sl@0: 
sl@0: 	// from MMMFDevSoundCustomInterfaceMuxPlugin
sl@0: 	/**
sl@0: 	Attempt to open the interface.
sl@0: 	@param aInterfaceId
sl@0: 		   The UID of the interface to open.
sl@0: 	@return One of the system wide error codes
sl@0: 	*/
sl@0: 	virtual TInt OpenInterface(TUid aInterfaceId);
sl@0: 
sl@0: 	/**
sl@0: 	Equivalent to destructor.  Called to destroy plugin.
sl@0: 	*/
sl@0: 	virtual void Release();
sl@0: 	
sl@0: 	/**
sl@0: 	Pass destructor key.
sl@0: 	Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()
sl@0: 	@param aDestructorKey
sl@0: 	       The Uid returned by REComSession::CreateImplementationL() or similar
sl@0: 	*/
sl@0: 	virtual void PassDestructorKey(TUid aDestructorKey);
sl@0: 	
sl@0: 	/**
sl@0: 	Complete construction.
sl@0: 	Pass additional values from the construction phase, used subsequently by the plugin.
sl@0: 	@param aCustomUtility
sl@0: 	       The custom interface utility used by the plugin to communicate with the remote
sl@0: 		   server side DeMux plugin
sl@0: 	@leave This method may leave with one of the system-wide error codes.
sl@0: 	*/
sl@0: 	virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceMuxUtility* aCustomUtility);
sl@0: 
sl@0: 	/** 
sl@0: 	Return the custom interface
sl@0: 	@param aInterfaceId
sl@0: 		   The UID of the required custom interface
sl@0: 	@return The custom interface supported by this plugin
sl@0: 	*/
sl@0: 	virtual TAny* CustomInterface(TUid aInterfaceId);
sl@0: 
sl@0: 	/**
sl@0: 	Instantiate a CI Mux class
sl@0: 	@leave This method may leave with one of the system-wide error codes.
sl@0: 	@return The pointer to the new class, cast to the Mux plugin mixin
sl@0: 	*/
sl@0: 	static MMMFDevSoundCustomInterfaceMuxPlugin* NewL();
sl@0: 
sl@0: 	// from MSbcEncoderIntfc
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/
sl@0: 	virtual TInt GetSupportedSamplingFrequencies(RArray<TUint>& aSamplingFrequencies);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/
sl@0: 	virtual TInt GetSupportedChannelModes(RArray<TSbcChannelMode>& aChannelModes);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/
sl@0: 	virtual TInt GetSupportedNumOfSubbands(RArray<TUint>& aNumOfSubbands); 
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/
sl@0: 	virtual TInt GetSupportedAllocationMethods(RArray<TSbcAllocationMethod>& aAllocationMethods);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/
sl@0: 	virtual TInt GetSupportedNumOfBlocks(RArray<TUint>& aNumOfBlocks);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/
sl@0: 	virtual TInt GetSupportedBitpoolRange(TUint& aMinSupportedBitpoolSize, TUint& aMaxSupportedBitpoolSize);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/
sl@0: 	virtual void SetSamplingFrequency(TUint aSamplingFrequency);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/	
sl@0: 	virtual void SetChannelMode(TSbcChannelMode aChannelMode);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/	
sl@0: 	virtual void SetNumOfSubbands(TUint aNumOfSubbands);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/	
sl@0: 	virtual void SetNumOfBlocks(TUint aNumOfBlocks);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/	
sl@0: 	virtual void SetAllocationMethod(TSbcAllocationMethod aAllocationMethod);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/	
sl@0: 	virtual void SetBitpoolSize(TUint aBitpoolSize);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/	
sl@0: 	virtual TInt ApplyConfig();
sl@0: 
sl@0: 	/**
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/	
sl@0: 	virtual TInt GetSamplingFrequency(TUint& aSamplingFrequency);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/	
sl@0: 	virtual TInt GetChannelMode(TSbcChannelMode& aChannelMode);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/	
sl@0: 	virtual TInt GetNumOfSubbands(TUint& aNumOfSubbands);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/	
sl@0: 	virtual TInt GetNumOfBlocks(TUint& aNumOfBlocks);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/
sl@0: 	virtual TInt GetAllocationMethod(TSbcAllocationMethod& aAllocationMethod);
sl@0: 
sl@0: 	/** 
sl@0: 	@see MSbcEncoderIntfc
sl@0: 	*/	
sl@0: 	virtual TInt GetBitpoolSize(TUint& aBitpoolSize);
sl@0: 
sl@0: protected:
sl@0: 	CMMFSbcEncoderMux();
sl@0: 	~CMMFSbcEncoderMux();
sl@0: 
sl@0: private:
sl@0: 	void DoGetTUintArrayL(RArray<TUint>& aArray, TInt aCount, TMMFDevSoundCISbcEncoderCommands aCommand);
sl@0: 	void DoGetChannelModesArrayL(RArray<TSbcChannelMode>& aChannelModes, TInt aCount);
sl@0: 	void DoGetAllocMethodsArrayL(RArray<TSbcAllocationMethod>& aAllocationMethods, TInt aCount);
sl@0: 	void DoWriteArrayToClientL(const RMmfIpcMessage& aMessage);
sl@0: 	
sl@0: protected:
sl@0: 	TUid iDestructorKey;
sl@0: 	TInt iRemoteHandle;
sl@0: 	MMMFDevSoundCustomInterfaceMuxUtility* iUtility;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0:  CMMFSbcEncoderDeMux - DeMux side of pair
sl@0:  @internalComponent
sl@0:  @prototype
sl@0:  @file
sl@0:  */
sl@0: class CMMFSbcEncoderDeMux : public CBase,
sl@0: 							public MMMFDevSoundCustomInterfaceDeMuxPlugin
sl@0: 	{
sl@0: public:
sl@0: 	/**
sl@0: 	Instantiate a CMMFSbcEncoderDeMux class
sl@0: 	@leave This method may leave with one of the system-wide error codes.
sl@0: 	@return A pointer to the new class cast to the DeMux plugin mixin
sl@0: 	*/
sl@0: 	static MMMFDevSoundCustomInterfaceDeMuxPlugin* NewL();
sl@0: 		
sl@0: 	/**
sl@0: 	Attempt to open the interface.
sl@0: 	@param aInterfaceId
sl@0: 		   The UID of the interface to open.
sl@0: 	@return a handle to the remote plugin
sl@0: 	*/
sl@0: 	virtual TInt OpenInterface(TUid aInterfaceId);
sl@0: 
sl@0: 	/**
sl@0: 	Equivalent to destructor.  Called to destroy plugin.
sl@0: 	*/
sl@0: 	virtual void Release();
sl@0: 	
sl@0: 	/**
sl@0: 	Pass destructor key.
sl@0: 	Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()
sl@0: 	@param aDestructorKey
sl@0: 	       The Uid returned by REComSession::CreateImplementationL() or similar
sl@0: 	*/
sl@0: 	virtual void PassDestructorKey(TUid aDestructorKey);
sl@0: 	
sl@0: 	/**
sl@0: 	Set the target of the custom interface call
sl@0: 	@param aTarget
sl@0: 	       The DevSound to call the custom interface on.
sl@0: 	*/
sl@0: 	virtual void SetInterfaceTarget(MMMFDevSoundCustomInterfaceTarget* aTarget);
sl@0: 	
sl@0: 	/**
sl@0: 	Complete construction.
sl@0: 	@param aUtility
sl@0: 	       The DeMux utility to use
sl@0: 	@leave This method may leave with one of the system-wide error codes.
sl@0: 	*/
sl@0: 	virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceDeMuxUtility* aUtility);
sl@0: 
sl@0: 	/**
sl@0: 	Refresh the current custom interface connections
sl@0: 	@leave This method may leave with one of the system-wide error codes.
sl@0: 	*/
sl@0: 	virtual void RefreshL();
sl@0: 
sl@0: 	// from MMMFDevSoundCustomInterfaceDeMuxPlugin
sl@0: 	/**
sl@0: 	Open the slave
sl@0: 	@param aInterface
sl@0: 		   The UID of the requested interface
sl@0: 	@param aPackageBuf
sl@0: 		   A package of data that can be supplied for initialisation
sl@0: 	@leave This method may leave with one of the system-wide error codes.
sl@0: 	@return The result of the operation
sl@0: 	*/
sl@0: 	virtual TInt DoOpenSlaveL(TUid aInterface, const TDesC8& aPackageBuf);
sl@0: 
sl@0: 	/** 
sl@0: 	Close the slave
sl@0: 	@param aHandle
sl@0: 		   The handle of the slave plugin
sl@0: 	@leave This method may leave with one of the system-wide error codes.
sl@0: 	*/
sl@0: 	virtual void DoCloseSlaveL(TInt aHandle);
sl@0: 
sl@0: 	// original RMessage is supplied so that remote demux plugin can extract necessary details
sl@0: 	// using DeMux utility
sl@0: 
sl@0: 	/**
sl@0: 	Relay the synchronous custom command onto the slave
sl@0: 	@param aMessage
sl@0: 		   The IPC message to be sent to the slave
sl@0: 	@leave This method may leave with one of the system-wide error codes.
sl@0: 	@return The result of the operation
sl@0: 	*/
sl@0: 	virtual TInt DoSendSlaveSyncCommandL(const RMmfIpcMessage& aMessage);
sl@0: 
sl@0: 	/**
sl@0: 	Relay the synchronous custom command onto the slave and obtain a result
sl@0: 	@param aMessage
sl@0: 		   The IPC message to be sent to the slave
sl@0: 	@leave This method may leave with one of the system-wide error codes.
sl@0: 	@return The result of the operation
sl@0: 	*/
sl@0: 	virtual TInt DoSendSlaveSyncCommandResultL(const RMmfIpcMessage& aMessage);
sl@0: 
sl@0: 	/**
sl@0: 	Relay an asynchronous command onto the slave
sl@0: 	@param aMessage
sl@0: 		   The IPC message to be sent to the slave
sl@0: 	@leave This method may leave with one of the system-wide error codes.
sl@0: 	*/
sl@0: 	virtual void DoSendSlaveAsyncCommandL(const RMmfIpcMessage& aMessage);
sl@0: 
sl@0: 	/**
sl@0: 	Relay an asynchronous command onto the slave and obtain a result
sl@0: 	@param aMessage
sl@0: 		   The IPC message to be sent to the slave@param aMessage
sl@0: 	@leave This method may leave with one of the system-wide error codes.
sl@0: 	*/
sl@0: 	virtual void DoSendSlaveAsyncCommandResultL(const RMmfIpcMessage& aMessage);
sl@0: 
sl@0: protected:
sl@0: 	~CMMFSbcEncoderDeMux();
sl@0: 	CMMFSbcEncoderDeMux();
sl@0: 
sl@0: 	// mirrors MSbcEncoderIntfc methods.
sl@0: 	TInt DoGetSupportedSamplingFrequencies (RArray<TUint>& aSamplingFrequencies );
sl@0: 	TInt DoGetSupportedChannelModes (RArray<MSbcEncoderIntfc::TSbcChannelMode>& aChannelModes );
sl@0: 	TInt DoGetSupportedNumOfSubbands (RArray<TUint>& aNumOfSubbands ); 
sl@0: 	TInt DoGetSupportedAllocationMethods (RArray<MSbcEncoderIntfc::TSbcAllocationMethod>& aAllocationMethods );
sl@0: 	TInt DoGetSupportedNumOfBlocks (RArray<TUint>& aNumOfBlocks );
sl@0: 	TInt DoGetSupportedBitpoolRange (TUint& aMinSupportedBitpoolSize, TUint& aMaxSupportedBitpoolSize);
sl@0: 	void DoSetSamplingFrequency (TUint aSamplingFrequency );	
sl@0: 	void DoSetChannelMode (MSbcEncoderIntfc::TSbcChannelMode aChannelMode );
sl@0: 	void DoSetNumOfSubbands (TUint aNumOfSubbands );
sl@0: 	void DoSetNumOfBlocks (TUint aNumOfBlocks );
sl@0: 	void DoSetAllocationMethod (MSbcEncoderIntfc::TSbcAllocationMethod aAllocationMethod );
sl@0: 	void DoSetBitpoolSize (TUint aBitpoolSize );
sl@0: 	TInt DoApplyConfig();
sl@0: 	TInt DoGetSamplingFrequency (TUint& aSamplingFrequency );
sl@0: 	TInt DoGetChannelMode (MSbcEncoderIntfc::TSbcChannelMode& aChannelMode );
sl@0: 	TInt DoGetNumOfSubbands (TUint& aNumOfSubbands );
sl@0: 	TInt DoGetNumOfBlocks (TUint& aNumOfBlocks );
sl@0: 	TInt DoGetAllocationMethod (MSbcEncoderIntfc::TSbcAllocationMethod& aAllocationMethod );
sl@0: 	TInt DoGetBitpoolSize (TUint& aBitpoolSize );
sl@0: 	
sl@0: private:
sl@0: 	void DoWriteArrayToClientL(const RMmfIpcMessage& aMessage, RArray<TUint>& aArray);
sl@0: 	void DoWriteArrayToClientL(const RMmfIpcMessage& aMessage, TBool aWriteChannelModeArray);
sl@0: 	
sl@0: protected:
sl@0: 	MMMFDevSoundCustomInterfaceDeMuxUtility* iUtility;
sl@0: 	MMMFDevSoundCustomInterfaceTarget* iTarget;
sl@0: 	TUid iDestructorKey;
sl@0: 	MSbcEncoderIntfc* iInterfaceSbcEncoder;
sl@0: 	
sl@0: private:
sl@0: 	RArray<TUint> iSamplingFrequencies;
sl@0: 	RArray<TUint> iNumOfSubbands;
sl@0: 	RArray<TUint> iNumOfBlocks;
sl@0: 	RArray<MSbcEncoderIntfc::TSbcAllocationMethod> iAllocationMethods;
sl@0: 	RArray<MSbcEncoderIntfc::TSbcChannelMode> iChannelModes;
sl@0: 	};
sl@0: 
sl@0: #endif // SBCENCODERCI_H