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