1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/devsound/devsoundpluginsupport/src/CustomInterfaces/g729decoderconfigci.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,247 @@
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 decoder config custom interface pair
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef G729DECODERCONFIGCI_H
1.22 +#define G729DECODERCONFIGCI_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 method called by this custom interface
1.36 +@internalComponent
1.37 +@prototype
1.38 +@file
1.39 +*/
1.40 +enum TMMFDevSoundCIG729DecoderIntfcCommands
1.41 + {
1.42 + EMMFDevSoundCIG729DecoderIntfcBadLsfNextBuffer
1.43 + };
1.44 +
1.45 +
1.46 +/**
1.47 +Implementation of the G729 Decoder config custom interface Mux
1.48 +@internalComponent
1.49 +@prototype
1.50 +@file
1.51 +*/
1.52 +class CMMFG729DecoderIntfcMux : public CBase,
1.53 + public MMMFDevSoundCustomInterfaceMuxPlugin,
1.54 + public MG729DecoderIntfc
1.55 + {
1.56 +public:
1.57 +
1.58 + // from MMMFDevSoundCustomInterfaceMuxPlugin
1.59 + /**
1.60 + Attempt to open the interface.
1.61 + @param aInterfaceId
1.62 + The UID of the interface to open.
1.63 + @return One of the system wide error codes
1.64 + */
1.65 + virtual TInt OpenInterface(TUid aInterfaceId);
1.66 +
1.67 + /**
1.68 + Equivalent to destructor. Called to destroy plugin.
1.69 + */
1.70 + virtual void Release();
1.71 +
1.72 + /**
1.73 + Pass destructor key.
1.74 + Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()
1.75 + @param aDestructorKey
1.76 + The Uid returned by REComSession::CreateImplementationL() or similar
1.77 + */
1.78 + virtual void PassDestructorKey(TUid aDestructorKey);
1.79 +
1.80 + /**
1.81 + Complete construction.
1.82 + Pass additional values from the construction phase, used subsequently by the plugin.
1.83 + @param aCustomUtility
1.84 + The custom interface utility used by the plugin to communicate with the remote
1.85 + server side DeMux plugin
1.86 + @leave This method may leave with one of the system-wide error codes.
1.87 + */
1.88 + virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceMuxUtility* aCustomUtility);
1.89 +
1.90 + /**
1.91 + Return the custom interface
1.92 + @param aInterfaceId
1.93 + The UID of the required custom interface
1.94 + @return The custom interface supported by this plugin
1.95 + */
1.96 + virtual TAny* CustomInterface(TUid aInterfaceId);
1.97 +
1.98 + /**
1.99 + Instantiate a CI Mux class
1.100 + @return The pointer to the new class, cast to the Mux plugin mixin
1.101 + @leave This method may leave with one of the system-wide error codes.
1.102 + */
1.103 + static MMMFDevSoundCustomInterfaceMuxPlugin* NewL();
1.104 +
1.105 + // from MG729DecoderIntfc
1.106 + //@see MG729DecoderIntfc
1.107 + virtual TInt BadLsfNextBuffer();
1.108 +
1.109 +protected:
1.110 + CMMFG729DecoderIntfcMux();
1.111 + ~CMMFG729DecoderIntfcMux();
1.112 +
1.113 +protected:
1.114 + TUid iKey;
1.115 + TInt iRemoteHandle;
1.116 + MMMFDevSoundCustomInterfaceMuxUtility* iUtility;
1.117 + };
1.118 +
1.119 +
1.120 +/**
1.121 +Implementation of the G729 Decoder custom interface DeMux
1.122 +@internalComponent
1.123 +@prototype
1.124 +@file
1.125 +*/
1.126 +class CMMFG729DecoderIntfcDeMux : public CBase,
1.127 + public MMMFDevSoundCustomInterfaceDeMuxPlugin
1.128 + {
1.129 +public:
1.130 + /**
1.131 + Instantiate a CMMFG729DecoderIntfcDeMux class
1.132 + @return A pointer to the new class cast to the DeMux plugin mixin
1.133 + @leave This method may leave with one of the system-wide error codes.
1.134 + */
1.135 + static MMMFDevSoundCustomInterfaceDeMuxPlugin* NewL();
1.136 +
1.137 + /**
1.138 + Attempt to open the interface.
1.139 + @param aInterfaceId
1.140 + The UID of the interface to open.
1.141 + @return A handle to the remote plugin
1.142 + */
1.143 + virtual TInt OpenInterface(TUid aInterfaceId);
1.144 +
1.145 + /**
1.146 + Equivalent to destructor. Called to destroy plugin.
1.147 + */
1.148 + virtual void Release();
1.149 +
1.150 + /**
1.151 + Pass destructor key.
1.152 + Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()
1.153 + @param aDestructorKey
1.154 + The Uid returned by REComSession::CreateImplementationL() or similar
1.155 + */
1.156 + virtual void PassDestructorKey(TUid aDestructorKey);
1.157 +
1.158 + /**
1.159 + Set the target of the custom interface call
1.160 + @param aTarget
1.161 + The DevSound to call the custom interface on.
1.162 + */
1.163 + virtual void SetInterfaceTarget(MMMFDevSoundCustomInterfaceTarget* aTarget);
1.164 +
1.165 + /**
1.166 + Complete construction.
1.167 + @param aUtility
1.168 + The DeMux utility to use
1.169 + @leave This method may leave with one of the system-wide error codes.
1.170 + */
1.171 + virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceDeMuxUtility* aUtility);
1.172 +
1.173 + /**
1.174 + Refresh the current custom interface connections
1.175 + @leave This method may leave with one of the system-wide error codes.
1.176 + */
1.177 + virtual void RefreshL();
1.178 +
1.179 + // from MMMFDevSoundCustomInterfaceDeMuxPlugin
1.180 + /**
1.181 + Open the slave
1.182 + @param aInterface
1.183 + The UID of the requested interface
1.184 + @param aPackageBuf
1.185 + A package of data that can be supplied for initialisation
1.186 + @return The result of the operation
1.187 + @leave This method may leave with one of the system-wide error codes.
1.188 + */
1.189 + virtual TInt DoOpenSlaveL(TUid aInterface, const TDesC8& aPackageBuf);
1.190 +
1.191 + /**
1.192 + Close the slave
1.193 + @param aHandle
1.194 + The handle of the slave plugin
1.195 + @leave This method may leave with one of the system-wide error codes.
1.196 + */
1.197 + virtual void DoCloseSlaveL(TInt aHandle);
1.198 +
1.199 + // original RMessage is supplied so that remote DeMux plugin can extract necessary details
1.200 + // using DeMux utility
1.201 +
1.202 + /**
1.203 + Relay the synchronous custom command onto the slave
1.204 + @param aMessage
1.205 + The IPC message to be sent to the slave
1.206 + @return the result of the operation
1.207 + @leave This method may leave with one of the system-wide error codes.
1.208 + */
1.209 + virtual TInt DoSendSlaveSyncCommandL(const RMmfIpcMessage& aMessage);
1.210 +
1.211 + /**
1.212 + Relay the synchronous custom command onto the slave and obtain a result
1.213 + @param aMessage
1.214 + The IPC message to be sent to the slave
1.215 + @return the result of the operation
1.216 + @leave This method may leave with one of the system-wide error codes.
1.217 + */
1.218 + virtual TInt DoSendSlaveSyncCommandResultL(const RMmfIpcMessage& aMessage);
1.219 +
1.220 + /**
1.221 + Relay an asynchronous command onto the slave
1.222 + @param aMessage
1.223 + The IPC message to be sent to the slave
1.224 + @leave This method may leave with one of the system-wide error codes.
1.225 + */
1.226 + virtual void DoSendSlaveAsyncCommandL(const RMmfIpcMessage& aMessage);
1.227 +
1.228 + /**
1.229 + Relay an asynchronous command onto the slave and obtain a result
1.230 + @param aMessage
1.231 + The IPC message to be sent to the slave@param aMessage
1.232 + @leave This method may leave with one of the system-wide error codes.
1.233 + */
1.234 + virtual void DoSendSlaveAsyncCommandResultL(const RMmfIpcMessage& aMessage);
1.235 +
1.236 +protected:
1.237 + ~CMMFG729DecoderIntfcDeMux();
1.238 + CMMFG729DecoderIntfcDeMux();
1.239 +
1.240 + // from mirror MG729DecoderIntfc method.
1.241 + TInt DoBadLsfNextBufferL();
1.242 +
1.243 +protected:
1.244 + MMMFDevSoundCustomInterfaceDeMuxUtility* iUtility;
1.245 + MMMFDevSoundCustomInterfaceTarget* iTarget;
1.246 + TUid iKey;
1.247 + MG729DecoderIntfc* iInterfaceG729DecoderIntfc;
1.248 + };
1.249 +
1.250 +#endif