1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/devsound/devsoundpluginsupport/src/CustomInterfaces/g729encoderconfigci.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,251 @@
1.4 +// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// Implementation of g729 encoder custom interface pair
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef G729ENCODERCONFIGCI_H
1.22 +#define G729ENCODERCONFIGCI_H
1.23 +
1.24 +#include <e32base.h>
1.25 +#include <mmf/common/mmfipc.h>
1.26 +#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
1.27 +#include <mmf/common/mmfipcserver.h>
1.28 +#endif
1.29 +#include <mmf/server/mmfdevsoundcustominterface.h>
1.30 +#include <mmf/server/mmfdevsoundcustomcommands.h>
1.31 +#include <mmf/server/devsoundstandardcustominterfaces.h>
1.32 +#include <mmf/plugin/mmfdevsoundcustominterface.hrh>
1.33 +
1.34 +/**
1.35 +Enum to represent the methods called by this custom interface
1.36 +@internalComponent
1.37 +@prototype
1.38 +@file
1.39 +*/
1.40 +enum TMMFDevSoundCIG729EncoderIntfcCommands
1.41 + {
1.42 + EMMFDevSoundCIG729EncoderIntfcSetVadMode,
1.43 + EMMFDevSoundCIG729EncoderIntfcGetVadMode
1.44 + };
1.45 +
1.46 +
1.47 +/**
1.48 +Implementation of the G729 Encoder custom interface Mux
1.49 +@internalComponent
1.50 +@prototype
1.51 +@file
1.52 +*/
1.53 +class CMMFG729EncoderIntfcMux : public CBase,
1.54 + public MMMFDevSoundCustomInterfaceMuxPlugin,
1.55 + public MG729EncoderIntfc
1.56 + {
1.57 +public:
1.58 +
1.59 + // from MMMFDevSoundCustomInterfaceMuxPlugin
1.60 + /**
1.61 + Attempt to open the interface.
1.62 + @param aInterfaceId
1.63 + The UID of the interface to open.
1.64 + @return one of the system wide error codes
1.65 + */
1.66 + virtual TInt OpenInterface(TUid aInterfaceId);
1.67 +
1.68 + /**
1.69 + Equivalent to destructor. Called to destroy plugin.
1.70 + */
1.71 + virtual void Release();
1.72 +
1.73 + /**
1.74 + Pass destructor key.
1.75 + Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()
1.76 + @param aDestructorKey
1.77 + The Uid returned by REComSession::CreateImplementationL() or similar
1.78 + */
1.79 + virtual void PassDestructorKey(TUid aDestructorKey);
1.80 +
1.81 + /**
1.82 + Complete construction.
1.83 + Pass additional values from the construction phase, used subsequently by the plugin.
1.84 + @param aCustomUtility
1.85 + The custom interface utility used by the plugin to communicate with the remote
1.86 + server side DeMux plugin
1.87 + @leave This method may leave with one of the system-wide error codes.
1.88 + */
1.89 + virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceMuxUtility* aCustomUtility);
1.90 +
1.91 + /**
1.92 + Return the custom interface
1.93 + @param aInterfaceId
1.94 + The UID of the required custom interface
1.95 + @return the custom interface supported by this plugin
1.96 + */
1.97 + virtual TAny* CustomInterface(TUid aInterfaceId);
1.98 +
1.99 + /**
1.100 + Instantiate a CI Mux class
1.101 + @return the pointer to the new class, cast to the Mux plugin mixin
1.102 + @leave This method may leave with one of the system-wide error codes.
1.103 + */
1.104 + static MMMFDevSoundCustomInterfaceMuxPlugin* NewL();
1.105 +
1.106 + // from MG729EncoderIntfc
1.107 + //@see MG729EncoderIntfc
1.108 + virtual TInt SetVadMode(TBool aVadModeOn);
1.109 + //@see MG729EncoderIntfc
1.110 + virtual TInt GetVadMode(TBool& aVadModeOn);
1.111 +
1.112 +protected:
1.113 + CMMFG729EncoderIntfcMux();
1.114 + ~CMMFG729EncoderIntfcMux();
1.115 +
1.116 +protected:
1.117 + TUid iKey;
1.118 + TInt iRemoteHandle;
1.119 + MMMFDevSoundCustomInterfaceMuxUtility* iUtility;
1.120 + };
1.121 +
1.122 +
1.123 +/**
1.124 +Implementation of the G729 Encoder custom interface DeMux
1.125 +@internalComponent
1.126 +@prototype
1.127 +@file
1.128 +*/
1.129 +class CMMFG729EncoderIntfcDeMux : public CBase,
1.130 + public MMMFDevSoundCustomInterfaceDeMuxPlugin
1.131 + {
1.132 +public:
1.133 + /**
1.134 + Instantiate a CMMFG729EncoderIntfcDeMux class
1.135 + @return a pointer to the new class cast to the DeMux plugin mixin
1.136 + @leave This method may leave with one of the system-wide error codes.
1.137 + */
1.138 + static MMMFDevSoundCustomInterfaceDeMuxPlugin* NewL();
1.139 +
1.140 + /**
1.141 + Attempt to open the interface.
1.142 + @param aInterfaceId
1.143 + The UID of the interface to open.
1.144 + @return a handle to the remote plugin
1.145 + */
1.146 + virtual TInt OpenInterface(TUid aInterfaceId);
1.147 +
1.148 + /**
1.149 + Equivalent to destructor. Called to destroy plugin.
1.150 + */
1.151 + virtual void Release();
1.152 +
1.153 + /**
1.154 + Pass destructor key.
1.155 + Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()
1.156 + @param aDestructorKey
1.157 + The Uid returned by REComSession::CreateImplementationL() or similar
1.158 + */
1.159 + virtual void PassDestructorKey(TUid aDestructorKey);
1.160 +
1.161 + /**
1.162 + Set the target of the custom interface call
1.163 + @param aTarget
1.164 + The DevSound to call the custom interface on.
1.165 + */
1.166 + virtual void SetInterfaceTarget(MMMFDevSoundCustomInterfaceTarget* aTarget);
1.167 +
1.168 + /**
1.169 + Complete construction.
1.170 + @param aUtility
1.171 + The DeMux utility to use
1.172 + @leave This method may leave with one of the system-wide error codes.
1.173 + */
1.174 + virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceDeMuxUtility* aUtility);
1.175 +
1.176 + /**
1.177 + Refresh the current custom interface connections
1.178 + @leave This method may leave with one of the system-wide error codes.
1.179 + */
1.180 + virtual void RefreshL();
1.181 +
1.182 + // from MMMFDevSoundCustomInterfaceDeMuxPlugin
1.183 + /**
1.184 + Open the slave
1.185 + @param aInterface
1.186 + The UID of the requested interface
1.187 + @param aPackageBuf
1.188 + A package of data that can be supplied for initialisation
1.189 + @return the result of the operation
1.190 + @leave This method may leave with one of the system-wide error codes.
1.191 + */
1.192 + virtual TInt DoOpenSlaveL(TUid aInterface, const TDesC8& aPackageBuf);
1.193 +
1.194 + /**
1.195 + Close the slave
1.196 + @param aHandle
1.197 + The handle of the slave plugin
1.198 + @leave This method may leave with one of the system-wide error codes.
1.199 + */
1.200 + virtual void DoCloseSlaveL(TInt aHandle);
1.201 +
1.202 + // original RMessage is supplied so that remote DeMux plugin can extract necessary details
1.203 + // using DeMux utility
1.204 +
1.205 + /**
1.206 + Relay the synchronous custom command onto the slave
1.207 + @param aMessage
1.208 + The IPC message to be sent to the slave
1.209 + @return the result of the operation
1.210 + @leave This method may leave with one of the system-wide error codes.
1.211 + */
1.212 + virtual TInt DoSendSlaveSyncCommandL(const RMmfIpcMessage& aMessage);
1.213 +
1.214 + /**
1.215 + Relay the synchronous custom command onto the slave and obtain a result
1.216 + @param aMessage
1.217 + The IPC message to be sent to the slave
1.218 + @return the result of the operation
1.219 + @leave This method may leave with one of the system-wide error codes.
1.220 + */
1.221 + virtual TInt DoSendSlaveSyncCommandResultL(const RMmfIpcMessage& aMessage);
1.222 +
1.223 + /**
1.224 + Relay an asynchronous command onto the slave
1.225 + @param aMessage
1.226 + The IPC message to be sent to the slave
1.227 + @leave This method may leave with one of the system-wide error codes.
1.228 + */
1.229 + virtual void DoSendSlaveAsyncCommandL(const RMmfIpcMessage& aMessage);
1.230 +
1.231 + /**
1.232 + Relay an asynchronous command onto the slave and obtain a result
1.233 + @param aMessage
1.234 + The IPC message to be sent to the slave@param aMessage
1.235 + @leave This method may leave with one of the system-wide error codes.
1.236 + */
1.237 + virtual void DoSendSlaveAsyncCommandResultL(const RMmfIpcMessage& aMessage);
1.238 +
1.239 +protected:
1.240 + ~CMMFG729EncoderIntfcDeMux();
1.241 + CMMFG729EncoderIntfcDeMux();
1.242 +
1.243 + // from mirror MG729EncoderIntfc method.
1.244 + TInt DoSetVadModeL(TBool aVadModeOn);
1.245 + TInt DoGetVadModeL(TBool& aVadModeOn);
1.246 +
1.247 +protected:
1.248 + MMMFDevSoundCustomInterfaceDeMuxUtility* iUtility;
1.249 + MMMFDevSoundCustomInterfaceTarget* iTarget;
1.250 + TUid iKey;
1.251 + MG729EncoderIntfc* iInterfaceG729EncoderIntfc;
1.252 + };
1.253 +
1.254 +#endif