// Copyright (c) 2002-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:

//

#include <bautils.h>

#include <utf.h>

#include <mmf/common/mmfpaniccodes.h>

#include "mmfclientaudioplayer.h"

#include "mmfclientutility.h"

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <mmf/common/mmfdurationinfocustomcommandsimpl.h>

#include <mmf/common/mmfdurationinfocustomcommandsenums.h>

#endif

using namespace ContentAccess;

// declared in the recorder module

void Panic(TInt aPanicCode);

/**

Constructs and initialises a new instance of the audio player utility.

The function leaves if the audio player utility object cannot be created.

No callback notification is made upon completion of NewL().

@param  aCallback

        The audio player observer interface.

@param  aPriority

        The Priority Value - this client's relative priority. This is a value between EMdaPriorityMin and 

        EMdaPriorityMax and represents a relative priority. A higher value indicates a more important request.

@param  aPref

        The Priority Preference - an additional audio policy parameter. The suggested default is 

        EMdaPriorityPreferenceNone. Further values are given by TMdaPriorityPreference, and additional 

        values may be supported by given phones and/or platforms, but should not be depended upon by 

        portable code.

@return A pointer to the new audio player utility object.

Note: The Priority Value and Priority Preference are used primarily when deciding what to do when

several audio clients attempt to play or record simultaneously. In addition to the Priority Value and Preference, 

the adaptation may consider other parameters such as the SecureId and Capabilities of the client process. 

Whatever, the decision  as to what to do in such situations is up to the audio adaptation, and may

vary between different phones. Portable applications are advised not to assume any specific behaviour. 

*/

EXPORT_C CMdaAudioPlayerUtility* CMdaAudioPlayerUtility::NewL(MMdaAudioPlayerCallback& aCallback,

															  TInt aPriority,

															  TInt aPref)

	{

	CMdaAudioPlayerUtility* self = new(ELeave) CMdaAudioPlayerUtility();

	CleanupStack::PushL(self);

	self->iProperties = CMMFMdaAudioPlayerUtility::NewL(aCallback, aPriority, aPref);

	CleanupStack::Pop(self);

	return self;

	}

/**

Constructs and initialises a new instance of the audio player utility for playing sampled audio data 

from a file. The audio data must be in a supported format (e.g. WAV and AU).

The function leaves if the audio player utility object cannot be created.

When initialisation of the audio player utility is complete, successfully or otherwise, the callback 

function MMdaAudioPlayerCallback::MapcInitComplete() is called.

@param  aFileName 

        The full path name of the file containing the audio data.

@param  aCallback 

        The audio player observer interface.

@param  aPriority

        The Priority Value - this client's relative priority. This is a value between EMdaPriorityMin and 

        EMdaPriorityMax and represents a relative priority. A higher value indicates a more important request.

@param  aPref

        The Priority Preference - an additional audio policy parameter. The suggested default is 

        EMdaPriorityPreferenceNone. Further values are given by TMdaPriorityPreference, and additional 

        values may be supported by given phones and/or platforms, but should not be depended upon by 

        portable code.

@param  aServer

        Not used in 7.0s. This parameter is provided for binary compatibility with previous versions.

@return A pointer to the new audio player utility object.

Note: The Priority Value and Priority Preference are used primarily when deciding what to do when

several audio clients attempt to play or record simultaneously. In addition to the Priority Value and Preference, 

the adaptation may consider other parameters such as the SecureId and Capabilities of the client process. 

Whatever, the decision  as to what to do in such situations is up to the audio adaptation, and may

vary between different phones. Portable applications are advised not to assume any specific behaviour. 

*/

EXPORT_C CMdaAudioPlayerUtility* CMdaAudioPlayerUtility::NewFilePlayerL(const TDesC& aFileName,

																		MMdaAudioPlayerCallback& aCallback,

																		TInt aPriority,

																		TInt aPref,

																		CMdaServer* /*aServer*/)

	{

	CMdaAudioPlayerUtility* self = new(ELeave) CMdaAudioPlayerUtility();

	CleanupStack::PushL(self);

	self->iProperties = CMMFMdaAudioPlayerUtility::NewFilePlayerL(aFileName, aCallback, aPriority, aPref);

	CleanupStack::Pop(self);

	return self;

	}

/**

Constructs and initialises a new instance of the audio player utility for playing sampled audio data 

from a descriptor.

The audio data must be in a supported format (e.g. WAV and AU).

The function leaves if the audio player utility object cannot be created. When initialisation of the 

audio player utility is complete, successfully or otherwise, the callback function 

MMdaAudioPlayerCallback::MapcInitComplete() is called.

@param  aData 

        A descriptor containing the audio data. This descriptor must remain in existence for the 

        lifetime of this audio player utility object.

@param  aCallback 

        The audio player observer interface.

@param  aPriority

        The Priority Value - this client's relative priority. This is a value between EMdaPriorityMin and 

        EMdaPriorityMax and represents a relative priority. A higher value indicates a more important request.

@param  aPref

        The Priority Preference - an additional audio policy parameter. The suggested default is 

        EMdaPriorityPreferenceNone. Further values are given by TMdaPriorityPreference, and additional 

        values may be supported by given phones and/or platforms, but should not be depended upon by 

        portable code.

@param  aServer

        Not used in 7.0s. This parameter is provided for binary compatibility with previous versions.

@return A pointer to the new audio player utility object.

Note: The Priority Value and Priority Preference are used primarily when deciding what to do when

several audio clients attempt to play or record simultaneously. In addition to the Priority Value and Preference, 

the adaptation may consider other parameters such as the SecureId and Capabilities of the client process. 

Whatever, the decision  as to what to do in such situations is up to the audio adaptation, and may

vary between different phones. Portable applications are advised not to assume any specific behaviour. 

*/

EXPORT_C CMdaAudioPlayerUtility* CMdaAudioPlayerUtility::NewDesPlayerL(const TDesC8& aData, MMdaAudioPlayerCallback& aCallback, TInt aPriority, TInt aPref, CMdaServer* /*aServer*/)

	{

	CMdaAudioPlayerUtility* self = new(ELeave) CMdaAudioPlayerUtility();

	CleanupStack::PushL(self);

	self->iProperties = CMMFMdaAudioPlayerUtility::NewDesPlayerL(aData, aCallback, aPriority, aPref);

	CleanupStack::Pop(self);

	return self;

	}

/**

Constructs and initialises a new instance of the audio player utility for playing sampled audio data 

from a read only descriptor.

The audio data must be in a supported format (e.g. WAV and AU).

The function leaves if the audio player utility object cannot be created. When initialisation of 

the audio player utility is complete, successfully or otherwise, the callback function 

MMdaAudioPlayerCallback::MapcInitComplete() is called.

@param  aData 

        A read only descriptor containing the audio data. This descriptor must remain in existence 

        for the lifetime of this audio player utility object.

@param  aCallback 

        The audio player observer interface.

@param  aPriority

        The Priority Value - this client's relative priority. This is a value between EMdaPriorityMin and 

        EMdaPriorityMax and represents a relative priority. A higher value indicates a more important request.

@param  aPref

        The Priority Preference - an additional audio policy parameter. The suggested default is 

        EMdaPriorityPreferenceNone. Further values are given by TMdaPriorityPreference, and additional 

        values may be supported by given phones and/or platforms, but should not be depended upon by 

        portable code.

@param  aServer

        Not used in 7.0s. This parameter is provided for binary compatibility with previous versions.

@return A pointer to a new audio player utility.

Note: The Priority Value and Priority Preference are used primarily when deciding what to do when

several audio clients attempt to play or record simultaneously. In addition to the Priority Value and Preference, 

the adaptation may consider other parameters such as the SecureId and Capabilities of the client process. 

Whatever, the decision  as to what to do in such situations is up to the audio adaptation, and may

vary between different phones. Portable applications are advised not to assume any specific behaviour. 

*/

EXPORT_C CMdaAudioPlayerUtility* CMdaAudioPlayerUtility::NewDesPlayerReadOnlyL(const TDesC8& aData, MMdaAudioPlayerCallback& aCallback, TInt aPriority, TInt aPref, CMdaServer* /*aServer*/)

	{

	CMdaAudioPlayerUtility* self = new(ELeave) CMdaAudioPlayerUtility();

	CleanupStack::PushL(self);

	self->iProperties = CMMFMdaAudioPlayerUtility::NewDesPlayerReadOnlyL(aData, aCallback, aPriority, aPref);

	CleanupStack::Pop(self);

	return self;

	}

CMdaAudioPlayerUtility::CMdaAudioPlayerUtility()

	{

	}

/**

Destructor.

Frees all resources owned by the object prior to its destruction.

*/

CMdaAudioPlayerUtility::~CMdaAudioPlayerUtility()

	{

	delete iProperties;

	}

/**

Ensures that any subsequent calls to OpenXYZ() will create controllers that

share a heap.

The default behaviour is that for each player utility a controller with its own heap

is created. Each heap uses a chunk, so using this function avoids situations where 

the number of chunks per process is limited.

The default behaviour is generally to be preferred, and should give lower overall

memory usage. However, if many controllers are to be created for a particular thread,

then this function should be used to prevent running out of heaps or chunks.

@since	9.1

*/

EXPORT_C void CMdaAudioPlayerUtility::UseSharedHeap()

	{

	ASSERT(iProperties);

	iProperties->UseSharedHeap();

	}

// 5.0 functions

/**

Begins playback of audio sample data at the current playback position using the current volume,

gain and priority settings.

When playing of the audio sample is complete, successfully or

otherwise, the callback function

MMdaAudioPlayerCallback::MapcPlayComplete() is

called.

If this function is called whilst already playing then 

MMdaAudioPlayerCallback::MapcPlayComplete will return with the

error code KErrNotReady.

@since	5.0

*/

void CMdaAudioPlayerUtility::Play()

	{

	ASSERT(iProperties);

	iProperties->Play();

	}

/**

Stops playback of the audio sample as soon as possible.

If the audio sample is playing, playback is stopped as soon as

possible. If playback is already complete, nothing further happens as

a result of calling this function. The callback function

MMdaAudioPlayerCallback::MapcPlayComplete() is not

called.

@since	5.0

*/

void CMdaAudioPlayerUtility::Stop()

	{

	ASSERT(iProperties);

	iProperties->Stop();

	}

/**

Changes the current playback volume to a specified value.

The volume can be changed before or during playback and is effective

immediately. The volume can be set to any value between zero (mute) and 

the maximum permissible volume (determined using MaxVolume()).

@param  aVolume

        The volume setting. This can be any value from zero to

        the value returned by a call to

        CMdaAudioPlayerUtility::MaxVolume().

        Setting a zero value mutes the sound. Setting the maximum

        value results in the loudest possible sound. Values less 

        than zero would be set to zero and the values greater than 

        the maximum permitted volume would be set to the maximum volume.

@return An error code indicating if the function call was successful. KErrNone on success, 

		otherwise another of the system-wide error codes.

@panic  EMMFMediaClientBadArgument is raised when the audio player utility is not initialised.

@since	5.0

*/

TInt CMdaAudioPlayerUtility::SetVolume(TInt aVolume)

	{

	ASSERT(iProperties);

	return iProperties->SetVolume(aVolume);

	}

/**

Sets the number of times the audio sample is to be repeated during the

playback operation.

A period of silence can follow each playing of the sample. The audio

sample can be repeated indefinitely.

@param   aRepeatNumberOfTimes

         The number of times the audio sample, together with

         the trailing silence, is to be repeated. If this is

         set to KMdaRepeatForever, then the audio

         sample, together with the trailing silence, is

         repeated indefinitely or until Stop() is

         called. If this is set to zero, then the audio sample

         is not repeated.

@param   aTrailingSilence

         The time interval of the trailing silence in microseconds.

@since	5.0

*/

void CMdaAudioPlayerUtility::SetRepeats(TInt aRepeatNumberOfTimes, const TTimeIntervalMicroSeconds& aTrailingSilence)

	{

	ASSERT(iProperties);

	iProperties->SetRepeats(aRepeatNumberOfTimes, aTrailingSilence);

	}

/**

Defines the period over which the volume level is to rise smoothly

from nothing to the normal volume level.

@param  aRampDuration

        The period over which the volume is to rise. A zero

        value causes the audio sample to be played at the

        normal level for the full duration of the playback. A

        value which is longer than the duration of the audio

        sample means that the sample never reaches its normal

        volume level.

@since	5.0

*/

void CMdaAudioPlayerUtility::SetVolumeRamp(const TTimeIntervalMicroSeconds& aRampDuration)

	{

	ASSERT(iProperties);

	iProperties->SetVolumeRamp(aRampDuration);

	}

/**

Returns the duration of the audio sample in microseconds.

@return The duration of the sample in microseconds.

@since	5.0

*/

const TTimeIntervalMicroSeconds& CMdaAudioPlayerUtility::Duration()

	{

	ASSERT(iProperties);

	return iProperties->Duration();

	}

/**

Returns the duration of the audio sample in microseconds, and the duration state.

@param aDuration

	   The duration of the sample in microseconds.

@return The duration state

@since	9.1

*/	

EXPORT_C TMMFDurationInfo CMdaAudioPlayerUtility::Duration(TTimeIntervalMicroSeconds& aDuration)

{

	ASSERT(iProperties);

	return iProperties->Duration(aDuration);

}

/**

Returns an integer representing the maximum volume.

This is the maximum value which can be passed to

CMdaAudioPlayerUtility::SetVolume(). This value is platform 

independent, but is always greater than or equal to one.

@return The maximum volume setting.

@panic  EMMFMediaClientPanicServerCommunicationProblem is raised when the audio player utility is not initialised. 

@since	5.0

*/

TInt CMdaAudioPlayerUtility::MaxVolume()

	{

	ASSERT(iProperties);

	return iProperties->MaxVolume();

	}

// 7.0s functions

/**

Opens an audio clip from a file.

The audio data must be in a supported format (for example, WAV or AU).

This function leaves with KErrNotReady if there is a previous open statement awaiting notification of completion.

@param  aFileName

        The file to open.

@leave  KErrNotReady

        If a previous open statement is awaiting notification of completion.

		opening the file

@since	7.0s

*/

EXPORT_C void CMdaAudioPlayerUtility::OpenFileL(const TDesC& aFileName)

	{

	ASSERT(iProperties);

	iProperties->OpenFileL(aFileName);

	}

/**

Opens an audio clip from a file.

The audio data must be in a supported format (for example, WAV or AU).

This function leaves with KErrNotReady if there is a previous open statement awaiting notification of completion.

Note: it is generally advisable that the RFile is shared through the call RFs::ShareProtected().

This allows the adaptation to pass it to another process, if that is required. This is particularly

true of playing DRM encrypted files.

@param  aFile

        The open shared session file handle to use

@leave 	KErrBadHandle

		If the file handle is not shared through the call RFs::ShareProtected(), and the adaptation needs it to be.

@leave  KErrNotReady

        If a previous open statement is awaiting notification of completion.

		opening the file

*/

EXPORT_C void CMdaAudioPlayerUtility::OpenFileL(const RFile& aFile)

	{

	ASSERT(iProperties);

	RFile& file = const_cast<RFile&>(aFile);

	TMMFileHandleSource tfs(file, KDefaultContentObject, EPlay);

	iProperties->OpenFileL(tfs);

	}

/**

Opens an audio clip from a file.

The audio data must be in a supported format (for example, WAV or AU).

This function leaves with KErrNotReady if there is a previous open statement awaiting notification of completion.

@param  aSource

        The file to open or an open file handle to use

@leave  KErrNotReady

        If a previous open statement is awaiting notification of completion.

		opening the file

*/

EXPORT_C void CMdaAudioPlayerUtility::OpenFileL(const TMMSource& aSource)

	{

	ASSERT(iProperties);

	iProperties->OpenFileL(aSource);

	}

/**

Opens an audio clip from a descriptor.

The audio data must be in a supported format (for example, WAV or AU).

@param  aDescriptor

        A descriptor containing the audio clip.

@leave  KErrInUse

        If a previous open statement is awaiting notification of completion.

@since	7.0s

*/

EXPORT_C void CMdaAudioPlayerUtility::OpenDesL(const TDesC8& aDescriptor)

	{

	ASSERT(iProperties);

	iProperties->OpenDesL(aDescriptor);

	}

/**

Opens an audio clip from a URL.

The audio data must be in a supported format (for example, WAV or AU).

@param	aUrl

		The URL to open.

@param 	aIapId

		Internet access point(IAP) ID to use. KUseDefaultIap selects the default IAP.

@param  aMimeType

		MIME type of the URL source.

@leave  KErrInUse 

        If a previous open statement is awaiting notification of completion.

@since  7.0s

*/

EXPORT_C void CMdaAudioPlayerUtility::OpenUrlL(const TDesC& aUrl, const TInt aIapId /*=KUseDefaultIap*/, const TDesC8& aMimeType /*=KNullDesC8*/)

	{

	ASSERT(iProperties);

	iProperties->OpenUrlL(aUrl, aIapId, aMimeType);

	}

/**

Pauses the playback of the audio clip.

@return An error code indicating if the function call was successful. KErrNone on success, otherwise

        another of the system-wide error codes.

@since	7.0s

*/

EXPORT_C TInt CMdaAudioPlayerUtility::Pause()

	{

	ASSERT(iProperties);

	return iProperties->Pause();

	}

/**

Closes the current audio clip (allowing another clip to be opened).

@since	7.0s

*/

EXPORT_C void CMdaAudioPlayerUtility::Close()

	{

	ASSERT(iProperties);

	iProperties->Close();

	}

/**

Returns the current playback position in microseconds from the start of the clip.