/*

* Copyright (c) 2006 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:  This file contains the base class from which specific audio

*                play controllers are derived. This class encapsulates common

*                behavior for all audio play controllers.

*

*/

#ifndef CADVANCEDAUDIOPLAYCONTROLLER_H

#define CADVANCEDAUDIOPLAYCONTROLLER_H

// INCLUDES

#include "AdvancedAudioController.h"

#include "AdvancedAudioOutput.h"

#include "AdvancedAudioUtility.h"   // for CAdvancedAudioUtility, MAdvancedAudioUtilityObserver

#include <mmf/common/mmfdrmcustomcommands.h>

#include <mmffile.h>

#include <MultimediaDataSource.h>

#include <StreamControlCustomCommandsParser.h>

#include <StreamControlEvents.h>

#include "DataSourceAdapter.h"

//#include <s32file.h>

// CONSTANTS

const TUint KAAPSampleRate8000Hz        = 8000;

const TUint KAAPSampleRate11025Hz       = 11025;

const TUint KAAPSampleRate12000Hz       = 12000;

const TUint KAAPSampleRate16000Hz       = 16000;

const TUint KAAPSampleRate22050Hz       = 22050;

const TUint KAAPSampleRate24000Hz       = 24000;

const TUint KAAPSampleRate32000Hz       = 32000;

const TUint KAAPSampleRate44100Hz       = 44100;

const TUint KAAPSampleRate48000Hz       = 48000;

const TUint KAAPSampleRate64000Hz       = 64000;

const TUint KAAPSampleRate88200Hz       = 88200;

const TUint KAAPSampleRate96000Hz       = 96000;

enum TStopCondition

	{

	ECommanded,

	EPlayComplete,

	EErr

	};

class MTrailingSilenceObserver

    {

public:

    /**

    * From MTrailingSilenceObserver

    * * Call back function indicating that that trailing silence timer has expired during loop play

    *

    * @since 5.x

    * @param none

    * @return  void

    */

    virtual void TrailingSilenceTimerComplete() = 0;

    };

// FORWARD DECLARATIONS

class CAdvancedAudioResource;

class CMultimediaDataSource;

class CDataSourceAdapter;

class CTrailingSilenceTimer;

// CLASS DECLARATION

/**

*  This is the base class CAdvancedAudioPlayController.

*  All specific audio play controllers derive from this class.

*

*  @lib AdvancedAudioController.lib

*  @since 3.0

*/

class CAdvancedAudioPlayController : public CAdvancedAudioController,

									 public MAdvancedAudioOutputObserver,

									 public MMMFAudioPlayControllerCustomCommandImplementor,

									 public MAdvancedAudioUtilityObserver,

 									 public MMultimediaDataSourceObserver,

 									 public MStreamControlCustomCommandImplementor,

 									 public MMMFAudioPlayControllerSetRepeatsCustomCommandImplementor,

#ifndef SYMBIAN_CAF_V2

                                     public MMMFAudioPlayDeviceCustomCommandImplementor

#else

                                     public MMMFAudioPlayDeviceCustomCommandImplementor,

							         public MMMFDRMCustomCommandImplementor,

							         public MTrailingSilenceObserver

#endif

    {

    protected:	// Constructors and destructor

		/**

		* Destructor

		*/

		IMPORT_C virtual ~CAdvancedAudioPlayController();

        /**

        * C++ default constructor.

        */

        IMPORT_C CAdvancedAudioPlayController();

        IMPORT_C virtual void ConstructL();

	protected: // New functions

        /**

        * Format specific initialization for Data Source

        * @since 3.0

        * @return void

        */

        virtual void DoAddDataSourceL() = 0;

        /**

        * Format specific initialization for Data Sink

        * @since 3.0

        * @return void

        */

        virtual void DoAddDataSinkL() = 0;

        /**

        * Instantiates codec

        * @since 5.0

        * @return CAdvancedAudioDecoder*

        */

        virtual CAdvancedAudioDecoder* BuildDecoderL() = 0;

        /**

        * Format specific initialization for Data Sink

        * @since 5.0

        * @return void

        */

        IMPORT_C virtual void DoInitializeSinkL();

		/**

        * Stops playback.

        * @since 3.0

        * @return void

        */

        IMPORT_C virtual void DoStopL(TInt aError);

        /**

        * Format specific header scanning

        * @since 3.0

        * @return void

        */

        IMPORT_C virtual void DoReadHeaderL(CMMFDataBuffer* aBuffer);

        /**

        * support functionality for SetPositionL

        * @since 3.2

        * @param aTimePos Position given by its time interval in micro secs

        * @return void

        */

        IMPORT_C virtual void DoSetPositionL(const TTimeIntervalMicroSeconds& aTimePos);

        /**

        * Fills source buffer from clip

        * @since 3.0

        * @return void

        */

        IMPORT_C virtual void InitSharedBuffersL();

        /**

        * Stops the source and sink

        * @since 3.0

        * @return void

        */

        IMPORT_C virtual void SourceSinkStopL();

        /**

        * Fills shared buffer from source

        * @since 3.0

        * @return void

        */

        IMPORT_C virtual void FillSharedBufferL(CMMFBuffer* aBuffer);

        /**

        * Find the index of buffer which contain a given position

        * @since 3.2

        * @param aPos the position to find

        * @return TInt the buffer index which recorded the position

        */

        IMPORT_C virtual TInt FindBufferFromPos(TUint aPos);

        /**

        * Prepare shared buffers and its current index

        * @since 3.2

        * @param aStreaming whether SharedBuffers contain streaming source

        * @return void

        */

        IMPORT_C virtual TInt SetPositionInSharedBuffers(TUint aTimeMs, TInt& aFoundPosition, TInt& aFoundTimeMs);

        /**

        * Update duration, should be called everytime source size changes

        * @since 3.2

        * @param aLimitInMilliSecond, the limit of difference of the new duration in millisec for a callback

        *        to occur, -1 would mean no callback

        * @return void

        */

        IMPORT_C virtual TInt UpdateDuration(TInt aLimitInMilliSecond = -1);

        IMPORT_C virtual TInt UpdateBitRate();

        /**

        * Handle AutoPaused event during SendEvent callback

        * @since 3.2

        * @return void

        */

        IMPORT_C virtual void HandleAutoPauseEvent();

        /**

        * Handle Preemption event during SendEvent callback

        * @since 3.2

        * @return void

        */

        IMPORT_C virtual void HandlePreemptionEvent(TInt aError);

        /**

        * Handle General event during SendEvent callback

        * @since 3.2

        * @return void

        */

        IMPORT_C virtual void HandleGeneralEvent(const TMMFEvent& aEvent);

        /**

		* Set the playback window boundaries

		* @since 3.2

		* @param aStart start of the window, in microseconds

		* @param aEnd end of the window, in microseconds

		* @return void

		*/

		IMPORT_C virtual void SetPlaybackWindowBoundariesL(const TTimeIntervalMicroSeconds& aStart,

			const TTimeIntervalMicroSeconds& aEnd);

        IMPORT_C virtual TInt GetCodecConfigData(RArray<TInt>& aCodecConfigData);

		IMPORT_C void RefillPreceedingBuffersL();

    protected:	// Functions from base classes (CMMFController)

        /**

        * From CMMFController

        * Handles creation of the data source

        *

        * @since 3.0

        * @param aSource data source

        * @return void

        */

        IMPORT_C virtual void AddDataSourceL(MDataSource& aSource);

        /**

        * From CMMFController

        * Handles creation of the data output

        *

        * @since 3.0

        * @param aSing data output

        * @return void

        */

        IMPORT_C virtual void AddDataSinkL(MDataSink& aSink);

        /**

        * From CMMFController

        * Deletes the data source

        *

        * @since 3.0

        * @param aDataSource the address of this source must be same as

        *                    the existing datasource

        * @return void

        */

        IMPORT_C virtual void RemoveDataSourceL(MDataSource& aDataSource);

        /**

        * From CMMFController

        * Deletes the data output

        *

        * @since 3.0

        * @param aDataSource the address of this output must be same as

        *                    the existing output

        * @return void

        */

        IMPORT_C virtual void RemoveDataSinkL(MDataSink& aDataSink);

        /**

        * From CMMFController

        * Resets the controller object, removes datasource/sink, resets the datapath.

        *

        * @since 3.0

        * @param none

        * @return void

        */

        IMPORT_C virtual void ResetL();

        /**

        * From CMMFController

        * Prepares the resources for play. Source and sink must have been added before

        * calling PrimeL().

        *

        * @since 3.0

        * @param none

        * @return void

        */

        IMPORT_C virtual void PrimeL();

        /**

        * From CMMFController

        * Will leave with if PrimeL() has not been called.

        *

        * @since 3.0

        * @param none

        * @return void

        */

        IMPORT_C virtual void PlayL();

        /**

        * From CMMFController

        * Will leave with if Play() has not been called.

        *

        * @since 3.0

        * @param none

        * @return void

        */

        IMPORT_C virtual void PauseL();

        /**

        * From CMMFController

        * Will leave if controller state is already stopped.

        *

        * @since 3.0

        * @param none

        * @return void

        */

        IMPORT_C virtual void StopL();

        /**

        * From CMMFController

        * Calculates the current position in microseconds.

        *

        * @since 3.0

        * @param none

        * @return TTimeIntervalMicroSeconds The current position in microseconds.

        */

        IMPORT_C virtual TTimeIntervalMicroSeconds PositionL() const;

        /**

        * From CMMFController

        * Sets the play position.

        *

        * @since 3.0

        * @param aTimePos Position given by its time interval in micro secs

        * @return void

        */

        IMPORT_C virtual void SetPositionL(const TTimeIntervalMicroSeconds& aTimePos);

        /**

        * From CMMFController

        * Method to set the source priority settings if

        * a priority mechanism is required to arbitrate between multiple clients

        * trying to access the same resource. Sets the priority for the source

        * and the sink (provided they are defined).

        *

        * @since 3.0

        * @param aPrioritySettings

        * @return void

        */

        IMPORT_C virtual void SetPrioritySettings(const TMMFPrioritySettings& aPrioritySettings);

		/**

		* From CMMFController

		* Gets the number of meta data entries in the clip.

        *

        * @since 3.0

        * @param aNumberOfEntries the number of meta data entries

		* @return void

		*/

		IMPORT_C virtual void GetNumberOfMetaDataEntriesL(TInt& aNumberOfEntries);

		/**

		* From CMMFController

		* Gets the specified meta data entry.

        *

        * @since 3.0

        * @param aIndex zero based meta data entry index to retrieve.

		* @return pointer to the meta data entry.

		*/

		IMPORT_C virtual CMMFMetaDataEntry* GetMetaDataEntryL(TInt aIndex);

		/**

        * From CMMFController

		* Returns the duration of source (or the sink if the source is not defined)

		* If neither source nor sink are defined, it returns 0.

		* @param none

		* @return duration in microseconds

		*/

		IMPORT_C virtual TTimeIntervalMicroSeconds DurationL() const;

    protected:  // functions from base classes (CAdvancedAudioController)

        /**

        * Send StateChanged vent to client

        * @since 3.2

        * @return error code. KErrNone if successful

        */

        IMPORT_C virtual TInt SendEventToClient(const TMMFEvent& aEvent);

    protected:	// Functions from base classes (MMMFAudioControllerCustomCommandImplementor)

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Sets the sample rate of the data sink in samples/second.

		* @param aSampleRate The sample rate, in samples/second.

		* @return void

		*/

		IMPORT_C virtual void MacSetSinkSampleRateL(TUint aSampleRate);

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Sets the bit rate of the data sink in bits/second.

		* @param aRate bit rate, in bits/second.

		* @return void

		*/

		IMPORT_C virtual void MacSetSinkBitRateL(TUint aRate);

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Sets the number of channels in the data sink.

		* For example, one channel for mono, two channels for stereo, etc.

		* @param aNumChannels number of channels

		* @return void

		*/

		IMPORT_C virtual void MacSetSinkNumChannelsL(TUint aNumChannels);

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Sets the format of the data sink.

		* The UID corresponds to the UID of the CMMFFormat-derived ECOM plugin to be used.

		* @param aFormatUid format plugin to be used

		* @return void

		*/

        IMPORT_C virtual void MacSetSinkFormatL(TUid aFormatUid);

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Sets the fourCC multimedia data type code of the sink.

		* @param aDataType fourCC code

		* @return void

		*/

		IMPORT_C virtual void MacSetSinkDataTypeL(TFourCC aDataType);

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Gets the sample rate of the data source in samples/second.

		* @param aRate source sample rate, in samples/second

		* @return void

		*/

		IMPORT_C virtual void MacGetSourceSampleRateL(TUint& aRate);

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Gets the bit rate of the data source in bits/second.

		* @param aRate source bit rate, in samples/second

		* @return void

		*/

		IMPORT_C virtual void MacGetSourceBitRateL(TUint& aRate);

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Gets the number of channels in the data source.

		* @param aNumChannels number of channels

		* @return void

		*/

		IMPORT_C virtual void MacGetSourceNumChannelsL(TUint& aNumChannels);

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Gets the format of the data source.

		* The UID corresponds to the UID of the CMMFFormat-derived ECOM plugin being used.

		* @param aFormat format plugin being used

		* @return void

		*/

		IMPORT_C virtual void MacGetSourceFormatL(TUid& aFormat);

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Gets the fourCC code of the source.

		* @param aDataType fourCC code

		* @return void

		*/

		IMPORT_C virtual void MacGetSourceDataTypeL(TFourCC& aDataType);

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Gets the sample rate of the data sink in samples/second.

		* @param aRate sample rate, in samples/second

		* @return void

		*/

		IMPORT_C virtual void MacGetSinkSampleRateL(TUint& aRate);

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Gets the bit rate of the data sink in bits/second.

		* @param aRate bit rate, in bits/second.

		* @return void

		*/

		IMPORT_C virtual void MacGetSinkBitRateL(TUint& aRate);

		/**

		* From MMMFAudioControllerCustomCommandImplementor

		* Gets the number of channels in the data sink.

		* @param aNumChannels number of channels.

		* @return void

		*/

		IMPORT_C virtual void MacGetSinkNumChannelsL(TUint& aNumChannels);

        /**

		* From MMMFAudioControllerCustomCommandImplementor