diff -r 000000000000 -r 40261b775718 devsound/devsoundpluginsupport/src/CustomInterfaces/errorconcealmentci.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/devsound/devsoundpluginsupport/src/CustomInterfaces/errorconcealmentci.h Tue Feb 02 01:56:55 2010 +0200 @@ -0,0 +1,255 @@ +// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies). +// All rights reserved. +// This component and the accompanying materials are made available +// under the terms of "Eclipse Public License v1.0" +// which accompanies this distribution, and is available +// at the URL "http://www.eclipse.org/legal/epl-v10.html". +// +// Initial Contributors: +// Nokia Corporation - initial contribution. +// +// Contributors: +// +// Description: +// Implementation of error concealment custom interface pair +// +// + +#ifndef ERRORCONCEALMENTCI_H +#define ERRORCONCEALMENTCI_H + +#include +#include +#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS +#include +#endif +#include +#include +#include +#include + +/** +Enum to represent the method called by this custom interface +@internalComponent +@prototype +@file +*/ +enum TMMFDevSoundCIErrorConcealmentIntfcCommands + { + EMMFDevSoundCIErrorConcealmentIntfcConcealErrorForNextBuffer, + EMMFDevSoundCIErrorConcealmentIntfcSetFrameMode, + EMMFDevSoundCIErrorConcealmentIntfcFrameModeRqrdForEC + }; + + +/** +Implementation of the error concealment custom interface Mux +@internalComponent +@prototype +@file +*/ +class CMMFErrorConcealmentIntfcMux : public CBase, + public MMMFDevSoundCustomInterfaceMuxPlugin, + public MMMFErrorConcealmentIntfc + { +public: + + // from MMMFDevSoundCustomInterfaceMuxPlugin + /** + Attempt to open the interface. + @param aInterfaceId + The UID of the interface to open. + @return One of the system wide error codes + */ + virtual TInt OpenInterface(TUid aInterfaceId); + + /** + Equivalent to destructor. Called to destroy plugin. + */ + virtual void Release(); + + /** + Pass destructor key. + Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation() + @param aDestructorKey + The Uid returned by REComSession::CreateImplementationL() or similar + */ + virtual void PassDestructorKey(TUid aDestructorKey); + + /** + Complete construction. + Pass additional values from the construction phase, used subsequently by the plugin. + @param aCustomUtility + The custom interface utility used by the plugin to communicate with the remote + server side DeMux plugin + @leave This method may leave with one of the system-wide error codes. + */ + virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceMuxUtility* aCustomUtility); + + /** + Return the custom interface + @param aInterfaceId + The UID of the required custom interface + @return The custom interface supported by this plugin + */ + virtual TAny* CustomInterface(TUid aInterfaceId); + + /** + Instantiate a CI Mux class + @return The pointer to the new class, cast to the Mux plugin mixin + @leave This method may leave with one of the system-wide error codes. + */ + static MMMFDevSoundCustomInterfaceMuxPlugin* NewL(); + + // from MErrorConcealmentIntfc + //@see MErrorConcealmentIntfc + virtual TInt ConcealErrorForNextBuffer(); + //@see MErrorConcealmentIntfc + virtual TInt SetFrameMode(TBool aFrameModeOn); + //@see MErrorConcealmentIntfc + virtual TInt FrameModeRqrdForEC(TBool& aFrameModeRqrd); + +protected: + CMMFErrorConcealmentIntfcMux(); + ~CMMFErrorConcealmentIntfcMux(); + +protected: + TUid iKey; + TInt iRemoteHandle; + MMMFDevSoundCustomInterfaceMuxUtility* iUtility; + }; + + +/** +Implementation of the G729 Decoder custom interface DeMux +@internalComponent +@prototype +@file +*/ +class CMMFErrorConcealmentIntfcDeMux : public CBase, + public MMMFDevSoundCustomInterfaceDeMuxPlugin + { +public: + /** + Instantiate a CMMFErrorConcealmentIntfcDeMux class + @return A pointer to the new class cast to the DeMux plugin mixin + @leave This method may leave with one of the system-wide error codes. + */ + static MMMFDevSoundCustomInterfaceDeMuxPlugin* NewL(); + + /** + Attempt to open the interface. + @param aInterfaceId + The UID of the interface to open. + @return A handle to the remote plugin + */ + virtual TInt OpenInterface(TUid aInterfaceId); + + /** + Equivalent to destructor. Called to destroy plugin. + */ + virtual void Release(); + + /** + Pass destructor key. + Called on construction so plugin takes responsibility to call REComSession::DestroyedImplementation() + @param aDestructorKey + The Uid returned by REComSession::CreateImplementationL() or similar + */ + virtual void PassDestructorKey(TUid aDestructorKey); + + /** + Set the target of the custom interface call + @param aTarget + The DevSound to call the custom interface on. + */ + virtual void SetInterfaceTarget(MMMFDevSoundCustomInterfaceTarget* aTarget); + + /** + Complete construction. + @param aUtility + The DeMux utility to use + @leave This method may leave with one of the system-wide error codes. + */ + virtual void CompleteConstructL(MMMFDevSoundCustomInterfaceDeMuxUtility* aUtility); + + /** + Refresh the current custom interface connections + @leave This method may leave with one of the system-wide error codes. + */ + virtual void RefreshL(); + + // from MMMFDevSoundCustomInterfaceDeMuxPlugin + /** + Open the slave + @param aInterface + The UID of the requested interface + @param aPackageBuf + A package of data that can be supplied for initialisation + @return The result of the operation + @leave This method may leave with one of the system-wide error codes. + */ + virtual TInt DoOpenSlaveL(TUid aInterface, const TDesC8& aPackageBuf); + + /** + Close the slave + @param aHandle + The handle of the slave plugin + @leave This method may leave with one of the system-wide error codes. + */ + virtual void DoCloseSlaveL(TInt aHandle); + + // original RMessage is supplied so that remote DeMux plugin can extract necessary details + // using DeMux utility + + /** + Relay the synchronous custom command onto the slave + @param aMessage + The IPC message to be sent to the slave + @return the result of the operation + @leave This method may leave with one of the system-wide error codes. + */ + virtual TInt DoSendSlaveSyncCommandL(const RMmfIpcMessage& aMessage); + + /** + Relay the synchronous custom command onto the slave and obtain a result + @param aMessage + The IPC message to be sent to the slave + @return the result of the operation + @leave This method may leave with one of the system-wide error codes. + */ + virtual TInt DoSendSlaveSyncCommandResultL(const RMmfIpcMessage& aMessage); + + /** + Relay an asynchronous command onto the slave + @param aMessage + The IPC message to be sent to the slave + @leave This method may leave with one of the system-wide error codes. + */ + virtual void DoSendSlaveAsyncCommandL(const RMmfIpcMessage& aMessage); + + /** + Relay an asynchronous command onto the slave and obtain a result + @param aMessage + The IPC message to be sent to the slave@param aMessage + @leave This method may leave with one of the system-wide error codes. + */ + virtual void DoSendSlaveAsyncCommandResultL(const RMmfIpcMessage& aMessage); + +protected: + ~CMMFErrorConcealmentIntfcDeMux(); + CMMFErrorConcealmentIntfcDeMux(); + + // from mirror MErrorConcealmentIntfc method. + TInt DoConcealErrorForNextBufferL(); + TInt DoSetFrameModeL(TBool aFrameModeOn); + TInt DoFrameModeRqrdForECL(TBool& aFrameModeRqrd); + +protected: + MMMFDevSoundCustomInterfaceDeMuxUtility* iUtility; + MMMFDevSoundCustomInterfaceTarget* iTarget; + TUid iKey; + MMMFErrorConcealmentIntfc* iInterfaceErrorConcealmentIntfc; + }; + +#endif