1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/devsound/devsoundpluginsupport/src/CustomInterfaces/bufferframesconfigci.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,243 @@
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 +//
1.18 +
1.19 +#ifndef BUFFERFRAMESCONFIGCI_H
1.20 +#define BUFFERFRAMESCONFIGCI_H
1.21 +
1.22 +#include <e32base.h>
1.23 +#include <mmf/common/mmfipc.h>
1.24 +#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
1.25 +#include <mmf/common/mmfipcserver.h>
1.26 +#endif
1.27 +#include <mmf/server/mmfdevsoundcustominterface.h>
1.28 +#include <mmf/server/mmfdevsoundcustomcommands.h>
1.29 +#include <mmf/server/devsoundstandardcustominterfaces.h>
1.30 +#include <mmf/plugin/mmfdevsoundcustominterface.hrh>
1.31 +
1.32 +/**
1.33 + @internalComponent
1.34 + @prototype
1.35 + @file
1.36 + */
1.37 +enum TMMFDevSoundCIBufferFramesConfigCommands
1.38 + {
1.39 + EMMFDevSoundCIInputBufferFramesConfig = 0,
1.40 + EMMFDevSoundCIOutputBufferFramesConfig
1.41 + };
1.42 +
1.43 +
1.44 +/**
1.45 + @internalComponent
1.46 + @prototype
1.47 + @file
1.48 + */
1.49 +
1.50 +/**
1.51 + * CMMFBufferFramesConfigMux
1.52 + *
1.53 + * implementation of the Play back status custom interface pair
1.54 + */
1.55 +class CMMFBufferFramesConfigMux : public CBase,
1.56 + public MMMFDevSoundCustomInterfaceMuxPlugin,
1.57 + public MMMFBufferFramesConfig
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 + Pass destructor key.
1.76 + Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation()
1.77 + @param aDestructorKey
1.78 + The Uid returned by REComSession::CreateImplementationL() or similar
1.79 + */
1.80 + virtual void PassDestructorKey(TUid aDestructorKey);
1.81 +
1.82 + /**
1.83 + Complete construction.
1.84 + Pass additional values from the construction phase, used subsequently by the plugin.
1.85 + @param aCustomUtility
1.86 + The custom interface utility used by the plugin to communicate with the remote
1.87 + server side DeMux plugin
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 + */
1.103 + static MMMFDevSoundCustomInterfaceMuxPlugin* NewL();
1.104 +
1.105 + // from MMMFBufferFramesConfig
1.106 + /**
1.107 + @see MMMFBufferFramesConfig
1.108 + */
1.109 + virtual TInt MmbfcSetNumberOfFramesPerInputBuffer(TInt aFrameCount, TInt aSamplesPerFrame);
1.110 +
1.111 + /**
1.112 + @see MMMFBufferFramesConfig
1.113 + */
1.114 + virtual TInt MmbfcSetNumberOfFramesPerOutputBuffer(TInt aFrameCount, TInt aSamplesPerFrame);
1.115 +
1.116 +protected:
1.117 + CMMFBufferFramesConfigMux();
1.118 + ~CMMFBufferFramesConfigMux();
1.119 +
1.120 +protected:
1.121 + TUid iDestructorKey;
1.122 + TInt iRemoteHandle;
1.123 + MMMFDevSoundCustomInterfaceMuxUtility* iUtility;
1.124 + };
1.125 +
1.126 +
1.127 +/**
1.128 + * DeMux side of pair
1.129 + */
1.130 +
1.131 +class CMMFBufferFramesConfigDeMux : public CBase,
1.132 + public MMMFDevSoundCustomInterfaceDeMuxPlugin
1.133 + {
1.134 +public:
1.135 + /**
1.136 + Instantiate a CMMFBufferFramesConfigDeMux class
1.137 + @return a pointer to the new class cast to the DeMux plugin mixin
1.138 + */
1.139 + static MMMFDevSoundCustomInterfaceDeMuxPlugin* NewL();
1.140 +
1.141 + /**
1.142 + Attempt to open the interface.
1.143 + @param aInterfaceId
1.144 + The UID of the interface to open.
1.145 + @return a handle to the remote plugin
1.146 + */
1.147 + virtual TInt OpenInterface(TUid aInterfaceId);
1.148 +
1.149 + /**
1.150 + Equivalent to destructor. Called to destroy plugin.
1.151 + */
1.152 + virtual void Release();
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 + */
1.173 + virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceDeMuxUtility* aUtility);
1.174 +
1.175 + /**
1.176 + Refresh the current custom interface connections
1.177 + */
1.178 + virtual void RefreshL();
1.179 +
1.180 + // from MMMFDevSoundCustomInterfaceDeMuxPlugin
1.181 + /**
1.182 + Open the slave
1.183 + @param aInterface
1.184 + The UID of the requested interface
1.185 + @param aPackageBuf
1.186 + A package of data that can be supplied for initialisation
1.187 + @return the result of the operation
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 + */
1.196 + virtual void DoCloseSlaveL(TInt aHandle);
1.197 +
1.198 + // original RMessage is supplied so that remote demux plugin can extract necessary details
1.199 + // using DeMux utility
1.200 +
1.201 + /**
1.202 + Relay the synchronous custom command onto the slave
1.203 + @param aMessage
1.204 + The IPC message to be sent to the slave
1.205 + @return the result of the operation
1.206 + */
1.207 + virtual TInt DoSendSlaveSyncCommandL(const RMmfIpcMessage& aMessage);
1.208 +
1.209 + /**
1.210 + Relay the synchronous custom command onto the slave and obtain a result
1.211 + @param aMessage
1.212 + The IPC message to be sent to the slave
1.213 + @return the result of the operation
1.214 + */
1.215 + virtual TInt DoSendSlaveSyncCommandResultL(const RMmfIpcMessage& aMessage);
1.216 +
1.217 + /**
1.218 + Relay an asynchronous command onto the slave
1.219 + @param aMessage
1.220 + The IPC message to be sent to the slave
1.221 + */
1.222 + virtual void DoSendSlaveAsyncCommandL(const RMmfIpcMessage& aMessage);
1.223 +
1.224 + /**
1.225 + Relay an asynchronous command onto the slave and obtain a result
1.226 + @param aMessage
1.227 + The IPC message to be sent to the slave@param aMessage
1.228 + */
1.229 + virtual void DoSendSlaveAsyncCommandResultL(const RMmfIpcMessage& aMessage);
1.230 +
1.231 +protected:
1.232 + ~CMMFBufferFramesConfigDeMux();
1.233 + CMMFBufferFramesConfigDeMux();
1.234 +
1.235 + // mirrors MMMFBufferFramesConfig method.
1.236 + TInt DoMmbfcSetNumberOfFramesPerInputBuffer(TInt aFrameCount, TInt aSamplesPerFrame);
1.237 + TInt DoMmbfcSetNumberOfFramesPerOutputBuffer(TInt aFrameCount, TInt aSamplesPerFrame);
1.238 +
1.239 +protected:
1.240 + MMMFDevSoundCustomInterfaceDeMuxUtility* iUtility;
1.241 + MMMFDevSoundCustomInterfaceTarget* iTarget;
1.242 + TUid iDestructorKey;
1.243 + MMMFBufferFramesConfig* iInterfaceBufferFramesConfig;
1.244 + };
1.245 +
1.246 +#endif