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