Symaptic: os/mm/devsound/devsoundpluginsupport/src/CustomInterfaces/bufferframesconfigci.h@bde4ae8d615e

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

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

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

     5 // which accompanies this distribution, and is available

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

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    16 #ifndef BUFFERFRAMESCONFIGCI_H

    17 #define BUFFERFRAMESCONFIGCI_H

    19 #include <e32base.h>

    20 #include <mmf/common/mmfipc.h>

    21 #ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

    22 #include <mmf/common/mmfipcserver.h>

    23 #endif

    24 #include <mmf/server/mmfdevsoundcustominterface.h>

    25 #include <mmf/server/mmfdevsoundcustomcommands.h>

    26 #include <mmf/server/devsoundstandardcustominterfaces.h>

    27 #include <mmf/plugin/mmfdevsoundcustominterface.hrh>

    29 /**

    30  @internalComponent

    31  @prototype

    32  @file

    33  */

    34 enum TMMFDevSoundCIBufferFramesConfigCommands

    35 	{

    36 	EMMFDevSoundCIInputBufferFramesConfig = 0,

    37 	EMMFDevSoundCIOutputBufferFramesConfig

    38 	};

    41 /**

    42  @internalComponent

    43  @prototype

    44  @file

    45  */

    47 /**

    48  * CMMFBufferFramesConfigMux

    49  *

    50  * implementation of the Play back status custom interface pair

    51  */

    52 class CMMFBufferFramesConfigMux : public CBase,

    53 			      	    	      public MMMFDevSoundCustomInterfaceMuxPlugin,

    54 			      	 		      public MMMFBufferFramesConfig

    55 	 {

    56 public:

    58 	// from MMMFDevSoundCustomInterfaceMuxPlugin

    59 	/**

    60 	Attempt to open the interface.

    61 	@param aInterfaceId

    62 		   The UID of the interface to open.

    63 	@return one of the system wide error codes

    64 	*/

    65 	virtual TInt OpenInterface(TUid aInterfaceId);

    67 	/**

    68 	Equivalent to destructor.  Called to destroy plugin.

    69 	*/

    70 	virtual void Release();

    71 	/**

    72 	Pass destructor key.

    73 	Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()

    74 	@param aDestructorKey

    75 	       The Uid returned by REComSession::CreateImplementationL() or similar

    76 	*/

    77 	virtual void PassDestructorKey(TUid aDestructorKey);

    79 	/**

    80 	Complete construction.

    81 	Pass additional values from the construction phase, used subsequently by the plugin.

    82 	@param aCustomUtility

    83 	       The custom interface utility used by the plugin to communicate with the remote

    84 		   server side DeMux plugin

    85 	*/

    86 	virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceMuxUtility* aCustomUtility);

    88 	/**

    89 	Return the custom interface

    90 	@param aInterfaceId

    91 		   The UID of the required custom interface

    92 	@return the custom interface supported by this plugin

    93 	*/

    94 	virtual TAny* CustomInterface(TUid aInterfaceId);

    96 	/**

    97 	Instantiate a CI Mux class

    98 	@return the pointer to the new class, cast to the Mux plugin mixin

    99 	*/

   100 	static MMMFDevSoundCustomInterfaceMuxPlugin* NewL();

   102 	// from MMMFBufferFramesConfig

   103 	/**

   104 	@see MMMFBufferFramesConfig

   105 	*/

   106 	virtual TInt MmbfcSetNumberOfFramesPerInputBuffer(TInt aFrameCount, TInt aSamplesPerFrame);

   108 	/**

   109 	@see MMMFBufferFramesConfig

   110 	*/

   111 	virtual TInt MmbfcSetNumberOfFramesPerOutputBuffer(TInt aFrameCount, TInt aSamplesPerFrame);

   113 protected:

   114 	CMMFBufferFramesConfigMux();

   115 	~CMMFBufferFramesConfigMux();

   117 protected:

   118 	TUid iDestructorKey;

   119 	TInt iRemoteHandle;

   120 	MMMFDevSoundCustomInterfaceMuxUtility* iUtility;

   121 	};

   124 /**

   125  * DeMux side of pair

   126  */

   128 class CMMFBufferFramesConfigDeMux : public CBase,

   129 			      	   				public MMMFDevSoundCustomInterfaceDeMuxPlugin

   130 	{

   131 public:

   132 	/**

   133 	Instantiate a CMMFBufferFramesConfigDeMux class

   134 	@return a pointer to the new class cast to the DeMux plugin mixin

   135 	*/

   136 	static MMMFDevSoundCustomInterfaceDeMuxPlugin* NewL();

   138 	/**

   139 	Attempt to open the interface.

   140 	@param aInterfaceId

   141 		   The UID of the interface to open.

   142 	@return a handle to the remote plugin

   143 	*/

   144 	virtual TInt OpenInterface(TUid aInterfaceId);

   146 	/**

   147 	Equivalent to destructor.  Called to destroy plugin.

   148 	*/

   149 	virtual void Release();

   150 	/**

   151 	Pass destructor key.

   152 	Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()

   153 	@param aDestructorKey

   154 	       The Uid returned by REComSession::CreateImplementationL() or similar

   155 	*/

   156 	virtual void PassDestructorKey(TUid aDestructorKey);

   158 	/**

   159 	Set the target of the custom interface call

   160 	@param aTarget

   161 	       The DevSound to call the custom interface on.

   162 	*/

   163 	virtual void SetInterfaceTarget(MMMFDevSoundCustomInterfaceTarget* aTarget);

   165 	/**

   166 	Complete construction.

   167 	@param aUtility

   168 	       The DeMux utility to use

   169 	*/

   170 	virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceDeMuxUtility* aUtility);

   172 	/**

   173 	Refresh the current custom interface connections

   174 	*/

   175 	virtual void RefreshL();

   177 	// from MMMFDevSoundCustomInterfaceDeMuxPlugin

   178 	/**

   179 	Open the slave

   180 	@param aInterface

   181 		   The UID of the requested interface

   182 	@param aPackageBuf

   183 		   A package of data that can be supplied for initialisation

   184 	@return the result of the operation

   185 	 */

   186 	virtual TInt DoOpenSlaveL(TUid aInterface, const TDesC8& aPackageBuf);

   188 	/**

   189 	Close the slave

   190 	@param aHandle

   191 		   The handle of the slave plugin

   192 	 */

   193 	virtual void DoCloseSlaveL(TInt aHandle);

   195 	// original RMessage is supplied so that remote demux plugin can extract necessary details

   196 	// using DeMux utility

   198 	/**

   199 	Relay the synchronous custom command onto the slave

   200 	@param aMessage

   201 		   The IPC message to be sent to the slave

   202 	@return the result of the operation

   203 	 */

   204 	virtual TInt DoSendSlaveSyncCommandL(const RMmfIpcMessage& aMessage);

   206 	/**

   207 	Relay the synchronous custom command onto the slave and obtain a result

   208 	@param aMessage

   209 		   The IPC message to be sent to the slave

   210 	@return the result of the operation

   211 	 */

   212 	virtual TInt DoSendSlaveSyncCommandResultL(const RMmfIpcMessage& aMessage);

   214 	/**

   215 	Relay an asynchronous command onto the slave

   216 	@param aMessage

   217 		   The IPC message to be sent to the slave

   218 	 */

   219 	virtual void DoSendSlaveAsyncCommandL(const RMmfIpcMessage& aMessage);

   221 	/**

   222 	Relay an asynchronous command onto the slave and obtain a result

   223 	@param aMessage

   224 		   The IPC message to be sent to the slave@param aMessage

   225 	 */

   226 	virtual void DoSendSlaveAsyncCommandResultL(const RMmfIpcMessage& aMessage);

   228 protected:

   229 	~CMMFBufferFramesConfigDeMux();

   230 	CMMFBufferFramesConfigDeMux();

   232 	// mirrors MMMFBufferFramesConfig method.

   233 	TInt DoMmbfcSetNumberOfFramesPerInputBuffer(TInt aFrameCount, TInt aSamplesPerFrame);

   234 	TInt DoMmbfcSetNumberOfFramesPerOutputBuffer(TInt aFrameCount, TInt aSamplesPerFrame);

   236 protected:

   237 	MMMFDevSoundCustomInterfaceDeMuxUtility* iUtility;

   238 	MMMFDevSoundCustomInterfaceTarget* iTarget;

   239 	TUid iDestructorKey;

   240 	MMMFBufferFramesConfig* iInterfaceBufferFramesConfig;

   241 	};

   243 #endif

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