Symaptic: os/mm/devsound/devsoundpluginsupport/src/CustomInterfaces/g729decoderconfigci.h@260cb5ec6c19

     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 // Implementation of g729 decoder config custom interface pair

    15 //

    16 //

    18 #ifndef G729DECODERCONFIGCI_H

    19 #define G729DECODERCONFIGCI_H

    21 #include <e32base.h>

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

    23 #ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

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

    25 #endif

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

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

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

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

    31 /**

    32 Enum to represent the method called by this custom interface

    33 @internalComponent

    34 @prototype

    35 @file

    36 */

    37 enum TMMFDevSoundCIG729DecoderIntfcCommands

    38 	{

    39 	EMMFDevSoundCIG729DecoderIntfcBadLsfNextBuffer

    40 	};

    43 /**

    44 Implementation of the G729 Decoder config custom interface Mux

    45 @internalComponent

    46 @prototype

    47 @file

    48 */

    49 class CMMFG729DecoderIntfcMux : public CBase,

    50 								public MMMFDevSoundCustomInterfaceMuxPlugin,

    51 								public MG729DecoderIntfc

    52 	{

    53 public:

    55 	// from MMMFDevSoundCustomInterfaceMuxPlugin

    56 	/**

    57 	Attempt to open the interface.

    58 	@param  aInterfaceId

    59 		    The UID of the interface to open.

    60 	@return One of the system wide error codes

    61 	*/

    62 	virtual TInt OpenInterface(TUid aInterfaceId);

    64 	/**

    65 	Equivalent to destructor.  Called to destroy plugin.

    66 	*/

    67 	virtual void Release();

    69 	/**

    70 	Pass destructor key.

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

    72 	@param aDestructorKey

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

    74 	*/

    75 	virtual void PassDestructorKey(TUid aDestructorKey);

    77 	/**

    78 	Complete construction.

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

    80 	@param aCustomUtility

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

    82 		   server side DeMux plugin

    83 	@leave This method may leave with one of the system-wide error codes.

    84 	*/

    85 	virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceMuxUtility* aCustomUtility);

    87 	/**

    88 	Return the custom interface

    89 	@param  aInterfaceId

    90 		    The UID of the required custom interface

    91 	@return The custom interface supported by this plugin

    92 	*/

    93 	virtual TAny* CustomInterface(TUid aInterfaceId);

    95 	/**

    96 	Instantiate a CI Mux class

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

    98 	@leave  This method may leave with one of the system-wide error codes.

    99 	*/

   100 	static MMMFDevSoundCustomInterfaceMuxPlugin* NewL();

   102 	// from MG729DecoderIntfc

   103 	//@see MG729DecoderIntfc

   104 	virtual TInt BadLsfNextBuffer();

   106 protected:

   107 	CMMFG729DecoderIntfcMux();

   108 	~CMMFG729DecoderIntfcMux();

   110 protected:

   111 	TUid iKey;

   112 	TInt iRemoteHandle;

   113 	MMMFDevSoundCustomInterfaceMuxUtility* iUtility;

   114 	};

   117 /**

   118 Implementation of the G729 Decoder custom interface DeMux

   119 @internalComponent

   120 @prototype

   121 @file

   122 */

   123 class CMMFG729DecoderIntfcDeMux : public CBase,

   124 								  public MMMFDevSoundCustomInterfaceDeMuxPlugin

   125 	{

   126 public:

   127 	/**

   128 	Instantiate a CMMFG729DecoderIntfcDeMux class

   129 	@return A pointer to the new class cast to the DeMux plugin mixin

   130 	@leave  This method may leave with one of the system-wide error codes.

   131 	*/

   132 	static MMMFDevSoundCustomInterfaceDeMuxPlugin* NewL();

   134 	/**

   135 	Attempt to open the interface.

   136 	@param  aInterfaceId

   137 		    The UID of the interface to open.

   138 	@return A handle to the remote plugin

   139 	*/

   140 	virtual TInt OpenInterface(TUid aInterfaceId);

   142 	/**

   143 	Equivalent to destructor.  Called to destroy plugin.

   144 	*/

   145 	virtual void Release();

   147 	/**

   148 	Pass destructor key.

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

   150 	@param aDestructorKey

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

   152 	*/

   153 	virtual void PassDestructorKey(TUid aDestructorKey);

   155 	/**

   156 	Set the target of the custom interface call

   157 	@param aTarget

   158 		   The DevSound to call the custom interface on.

   159 	*/

   160 	virtual void SetInterfaceTarget(MMMFDevSoundCustomInterfaceTarget* aTarget);

   162 	/**

   163 	Complete construction.

   164 	@param aUtility

   165 		   The DeMux utility to use

   166 	@leave This method may leave with one of the system-wide error codes.

   167 	*/

   168 	virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceDeMuxUtility* aUtility);

   170 	/**

   171 	Refresh the current custom interface connections

   172 	@leave This method may leave with one of the system-wide error codes.

   173 	*/

   174 	virtual void RefreshL();

   176 	// from MMMFDevSoundCustomInterfaceDeMuxPlugin

   177 	/**

   178 	Open the slave

   179 	@param  aInterface

   180 		    The UID of the requested interface

   181 	@param  aPackageBuf

   182 		    A package of data that can be supplied for initialisation

   183 	@return The result of the operation

   184 	@leave  This method may leave with one of the system-wide error codes.

   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 	@leave This method may leave with one of the system-wide error codes.

   193 	*/

   194 	virtual void DoCloseSlaveL(TInt aHandle);

   196 	// original RMessage is supplied so that remote DeMux plugin can extract necessary details

   197 	// using DeMux utility

   199 	/**

   200 	Relay the synchronous custom command onto the slave

   201 	@param  aMessage

   202 		    The IPC message to be sent to the slave

   203 	@return the result of the operation

   204 	@leave  This method may leave with one of the system-wide error codes.

   205 	*/

   206 	virtual TInt DoSendSlaveSyncCommandL(const RMmfIpcMessage& aMessage);

   208 	/**

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

   210 	@param  aMessage

   211 		    The IPC message to be sent to the slave

   212 	@return the result of the operation

   213 	@leave  This method may leave with one of the system-wide error codes.

   214 	*/

   215 	virtual TInt DoSendSlaveSyncCommandResultL(const RMmfIpcMessage& aMessage);

   217 	/**

   218 	Relay an asynchronous command onto the slave

   219 	@param  aMessage

   220 		    The IPC message to be sent to the slave

   221 	@leave  This method may leave with one of the system-wide error codes.

   222 	*/

   223 	virtual void DoSendSlaveAsyncCommandL(const RMmfIpcMessage& aMessage);

   225 	/**

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

   227 	@param  aMessage

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

   229 	@leave  This method may leave with one of the system-wide error codes.

   230 	*/

   231 	virtual void DoSendSlaveAsyncCommandResultL(const RMmfIpcMessage& aMessage);

   233 protected:

   234 	~CMMFG729DecoderIntfcDeMux();

   235 	CMMFG729DecoderIntfcDeMux();

   237 	// from mirror MG729DecoderIntfc method.

   238 	TInt DoBadLsfNextBufferL();

   240 protected:

   241 	MMMFDevSoundCustomInterfaceDeMuxUtility* iUtility;

   242 	MMMFDevSoundCustomInterfaceTarget*		 iTarget;

   243 	TUid				iKey;

   244 	MG729DecoderIntfc*	iInterfaceG729DecoderIntfc;

   245 	};

   247 #endif

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200
changeset 1	260cb5ec6c19
permissions	-rw-r--r--