1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/mmlibs/mmfw/src/Client/Audio/mmfclientaudioplayer.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,261 @@
1.4 +// Copyright (c) 2002-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 +
1.20 +#ifndef MMFCLIENTAUDIOPLAY_H
1.21 +#define MMFCLIENTAUDIOPLAY_H
1.22 +
1.23 +#include <e32std.h>
1.24 +#include <e32base.h>
1.25 +#include <mdaaudiosampleplayer.h>
1.26 +#include <mmf/common/mmfcontroller.h>
1.27 +#include <mmf/server/mmffile.h>
1.28 +#include <mmf/server/mmfdes.h>
1.29 +#include <mmfcontrollerimplementationuids.hrh>
1.30 +#include <mmf/common/mmfstandardcustomcommands.h>
1.31 +#include <mmf/common/mmfdrmcustomcommands.h>
1.32 +#include "mmfclientutility.h"
1.33 +#include <mmf/common/mmfdurationinfocustomcommands.h>
1.34 +
1.35 +static const TUid KUidMmfAudioController = {KMmfUidControllerAudio};
1.36 +
1.37 +/**
1.38 +Mixin class to allow notification that the timed silence has finished.
1.39 +*/
1.40 +class MRepeatTrailingSilenceTimerObs
1.41 + {
1.42 +public:
1.43 + virtual void RepeatTrailingSilenceTimerComplete() = 0;
1.44 + };
1.45 +
1.46 +/**
1.47 +CTimer-based active object that waits the requested time before notifying its observer.
1.48 +*/
1.49 +class CRepeatTrailingSilenceTimer : public CTimer
1.50 + {
1.51 +public:
1.52 + static CRepeatTrailingSilenceTimer* NewL(MRepeatTrailingSilenceTimerObs& aObs);
1.53 + void RunL();
1.54 +private:
1.55 + CRepeatTrailingSilenceTimer(MRepeatTrailingSilenceTimerObs& aObs);
1.56 +private:
1.57 + MRepeatTrailingSilenceTimerObs& iObs;
1.58 + };
1.59 +
1.60 +/**
1.61 +Active object utility class to allow the callback to be called asynchronously.
1.62 +This should help prevent re-entrant code in clients of the mediaframework.
1.63 +*/
1.64 +class CMMFMdaAudioPlayerCallBack : public CActive
1.65 + {
1.66 +public:
1.67 + enum TCallbackState {
1.68 + ECallbackInitComplete,
1.69 + ECallbackPlayComplete
1.70 + };
1.71 +
1.72 +
1.73 +public:
1.74 + static CMMFMdaAudioPlayerCallBack* NewL(MMdaAudioPlayerCallback& aCallback);
1.75 + ~CMMFMdaAudioPlayerCallBack();
1.76 + void InitComplete(TInt aError, const TTimeIntervalMicroSeconds& aDuration);
1.77 + void PlayComplete(TInt aError);
1.78 +private:
1.79 + CMMFMdaAudioPlayerCallBack(MMdaAudioPlayerCallback& aCallback);
1.80 + void RunL();
1.81 + void DoCancel();
1.82 +private:
1.83 + MMdaAudioPlayerCallback& iCallback;
1.84 + TInt iError;
1.85 + TTimeIntervalMicroSeconds iDuration;
1.86 + TCallbackState iState;
1.87 + };
1.88 +
1.89 +/**
1.90 +Concrete implementation of the CMdaAudioPlayerUtility API.
1.91 +@see CMdaAudioPlayerUtility
1.92 +*/
1.93 +class CMMFMdaAudioPlayerUtility;
1.94 +NONSHARABLE_CLASS( CMMFMdaAudioPlayerUtility ): public CBase,
1.95 + public MMMFControllerEventMonitorObserver,
1.96 + public MRepeatTrailingSilenceTimerObs,
1.97 + public MMMFFindAndOpenControllerObserver
1.98 + {
1.99 +friend class CMdaAudioPlayerUtility;
1.100 +// friends for Unit testing only
1.101 +friend class CTestStepUnitMMFAudClient;
1.102 +
1.103 +public:
1.104 + enum TMMFAudioPlayerState
1.105 + {
1.106 + EStopped,
1.107 + EOpening,
1.108 + EPaused,
1.109 + EPlaying
1.110 + };
1.111 +public:
1.112 + static CMMFMdaAudioPlayerUtility* NewFilePlayerL(const TDesC& aFileName,
1.113 + MMdaAudioPlayerCallback& aCallback,
1.114 + TInt aPriority = EMdaPriorityNormal,
1.115 + TInt aPref = EMdaPriorityPreferenceTimeAndQuality,
1.116 + CMdaServer* aServer = NULL);
1.117 + static CMMFMdaAudioPlayerUtility* NewDesPlayerL(const TDesC8& aData,
1.118 + MMdaAudioPlayerCallback& aCallback,
1.119 + TInt aPriority = EMdaPriorityNormal,
1.120 + TInt aPref = EMdaPriorityPreferenceTimeAndQuality,
1.121 + CMdaServer* aServer = NULL);
1.122 + static CMMFMdaAudioPlayerUtility* NewDesPlayerReadOnlyL(const TDesC8& aData,
1.123 + MMdaAudioPlayerCallback& aCallback,
1.124 + TInt aPriority = EMdaPriorityNormal,
1.125 + TInt aPref = EMdaPriorityPreferenceTimeAndQuality,
1.126 + CMdaServer* aServer = NULL);
1.127 +
1.128 + static CMMFMdaAudioPlayerUtility* NewL(MMdaAudioPlayerCallback& aCallback,
1.129 + TInt aPriority = EMdaPriorityNormal,
1.130 + TInt aPref = EMdaPriorityPreferenceTimeAndQuality);
1.131 +
1.132 +/**
1.133 + Destructor
1.134 +*/
1.135 + ~CMMFMdaAudioPlayerUtility();
1.136 +
1.137 + void UseSharedHeap();
1.138 +
1.139 + void OpenFileL(const TDesC& aFileName);
1.140 + void OpenFileL(const RFile& aFile);
1.141 + void OpenFileL(const TMMSource& aSource);
1.142 +
1.143 + void OpenDesL(const TDesC8& aDescriptor);
1.144 + void OpenUrlL(const TDesC& aUrl, TInt aIapId=KUseDefaultIap, const TDesC8& aMimeType = KNullDesC8);
1.145 + void Play();
1.146 + void Stop();
1.147 + TInt SetVolume(TInt aVolume);
1.148 + void SetRepeats(TInt aRepeatNumberOfTimes, const TTimeIntervalMicroSeconds& aTrailingSilence);
1.149 + void SetVolumeRamp(const TTimeIntervalMicroSeconds& aRampDuration);
1.150 + const TTimeIntervalMicroSeconds& Duration();
1.151 + TInt MaxVolume();
1.152 +
1.153 + // API Additions since version 7.0
1.154 + TInt Pause();
1.155 + void Close();
1.156 + TInt GetPosition(TTimeIntervalMicroSeconds& aPosition);
1.157 + void SetPosition(const TTimeIntervalMicroSeconds& aPosition);
1.158 +
1.159 + TInt SetPriority(TInt aPriority, TInt aPref);
1.160 + TInt GetVolume(TInt& aVolume);
1.161 + TInt GetNumberOfMetaDataEntries(TInt& aNumEntries);
1.162 + CMMFMetaDataEntry* GetMetaDataEntryL(TInt aMetaDataIndex);
1.163 + TInt SetPlayWindow(const TTimeIntervalMicroSeconds& aStart,
1.164 + const TTimeIntervalMicroSeconds& aEnd);
1.165 + TInt ClearPlayWindow();
1.166 + TInt SetBalance(TInt aBalance = KMMFBalanceCenter);
1.167 + TInt GetBalance(TInt& aBalance);
1.168 + TInt GetBitRate(TUint& aBitRate);
1.169 +
1.170 + void RegisterForAudioLoadingNotification(MAudioLoadingObserver& aCallback);
1.171 + void GetAudioLoadingProgressL(TInt& aPercentageProgress);
1.172 + const CMMFControllerImplementationInformation& ControllerImplementationInformationL();
1.173 +
1.174 + TInt RegisterAudioResourceNotification(MMMFAudioResourceNotificationCallback& aCallback,TUid aNotificationEventUid,const TDesC8& aNotificationRegistrationData = KNullDesC8);
1.175 + TInt CancelRegisterAudioResourceNotification(TUid aNotificationEventId);
1.176 + TInt WillResumePlay();
1.177 + TInt CustomCommandSync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2, TDes8& aDataFrom);
1.178 + TInt CustomCommandSync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2);
1.179 + void CustomCommandAsync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2, TDes8& aDataFrom, TRequestStatus& aStatus);
1.180 + void CustomCommandAsync(const TMMFMessageDestinationPckg& aDestination, TInt aFunction, const TDesC8& aDataTo1, const TDesC8& aDataTo2, TRequestStatus& aStatus);
1.181 +
1.182 + MMMFDRMCustomCommand* GetDRMCustomCommand();
1.183 +
1.184 + TInt SetThreadPriority(const TThreadPriority& aThreadPriority) const;
1.185 +
1.186 + TMMFDurationInfo Duration(TTimeIntervalMicroSeconds& aDuration);
1.187 +
1.188 + // from MMMFControllerEventMonitorObserver
1.189 + virtual void HandleEvent(const TMMFEvent& aEvent);
1.190 + // from MRepeatTrailingSilenceTimerObs
1.191 + virtual void RepeatTrailingSilenceTimerComplete();
1.192 +
1.193 + // from MMMFFindAndOpenControllerObserver
1.194 + virtual void MfaocComplete(
1.195 + TInt& aError,
1.196 + RMMFController* aController,
1.197 + TUid aControllerUid,
1.198 + TMMFMessageDestination* aSourceHandle,
1.199 + TMMFMessageDestination* aSinkHandle);
1.200 +
1.201 +protected:
1.202 + CMMFMdaAudioPlayerUtility(MMdaAudioPlayerCallback& aCallback, TInt aPriority, TInt aPref);
1.203 + void ConstructL();
1.204 + void DoPlay();
1.205 +
1.206 +private:
1.207 + void PlaySilence();
1.208 +
1.209 +private:
1.210 + // last play window command
1.211 + enum TPlayWindowCommand
1.212 + {
1.213 + ENone,
1.214 + ESet,
1.215 + EClear
1.216 + };
1.217 +
1.218 + MMdaAudioPlayerCallback& iCallback;
1.219 + CMMFMdaAudioPlayerCallBack* iAsyncCallBack;
1.220 + MAudioLoadingObserver* iLoadingObserver;
1.221 + MMMFAudioResourceNotificationCallback* iAudioResourceNotificationCallBack;
1.222 + RMMFController iController;
1.223 + CMMFControllerEventMonitor* iControllerEventMonitor;
1.224 + TMMFAudioPlayerState iState;
1.225 + TTimeIntervalMicroSeconds iDuration; // Needed because of api "Duration()" that returns a reference
1.226 + TMMFPrioritySettings iPrioritySettings;
1.227 +
1.228 + TInt iNumberOfTimesPlayed;
1.229 + TInt iNumberOfTimesToRepeat;
1.230 + TTimeIntervalMicroSeconds iTrailingSilence;
1.231 + TTimeIntervalMicroSeconds iTrailingSilenceLeftToPlay;
1.232 + CRepeatTrailingSilenceTimer* iRepeatTrailingSilenceTimer;
1.233 +
1.234 + // Source and sink handle info
1.235 + TMMFMessageDestination iSourceHandle;
1.236 + TMMFMessageDestination iSinkHandle;
1.237 +
1.238 + // Custom command handlers
1.239 + RMMFAudioPlayDeviceCustomCommands iAudioPlayDeviceCommands;
1.240 + RMMFAudioPlayControllerCustomCommands iAudioPlayControllerCommands;
1.241 + RMMFResourceNotificationCustomCommands iNotificationRegistrationCommands;
1.242 + RMMFDRMCustomCommands iDRMCustomCommands;
1.243 + RMMFAudioPlayControllerSetRepeatsCustomCommands iAudioPlayControllerSetRepeatsCommands;
1.244 +
1.245 + // Current playback time so we can resume from where we were stopped
1.246 + TTimeIntervalMicroSeconds iPosition;
1.247 +
1.248 + // Play window start and end times and whether it has been set
1.249 + TTimeIntervalMicroSeconds iPlayStart;
1.250 + TTimeIntervalMicroSeconds iPlayEnd;
1.251 + TPlayWindowCommand iPlayWindowSet;
1.252 + RArray<TUid> iMediaIds;
1.253 +
1.254 + CMMFControllerImplementationInformation* iControllerImplementationInformation;
1.255 + TUid iControllerUid;
1.256 +
1.257 + // utility class to find and open a suitable controller asynchronously
1.258 + CMMFFindAndOpenController* iFindAndOpenController;
1.259 + TUid iEventHolder;
1.260 + TBuf8<256> iNotificationDataHolder;
1.261 + TBool iRepeatCancelled;
1.262 + };
1.263 +
1.264 +#endif