// Copyright (c) 2005-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 "MmfAudioOutput.h"

#include <ecom/implementationproxy.h>

#include <mmf/server/mmfformat.h>

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <mmf/common/mmfhelper.h>

#endif

#include <mmf/plugin/mmfaudioiointerfaceuids.hrh>

void Panic(TInt aPanicCode)

	{

	_LIT(KMMFAudioOutputPanicCategory, "MMFAudioOutput");

	User::Panic(KMMFAudioOutputPanicCategory, aPanicCode);

	}

/**

Allocates and constructs a new audio output sink.

Static standard SymbianOS 2 phase constuction method.

@return A pointer to the new sink.

*/

MDataSink* CMMFAudioOutput::NewSinkL()

	{

	CMMFAudioOutput* self = new (ELeave) CMMFAudioOutput ;

	CleanupStack::PushL(self);

	self->ConstructL();

	CleanupStack::Pop();

	return STATIC_CAST( MDataSink*, self ) ;

	}

/**

Standard SymbianOS ConstructL.

Used to initialise member varibles with device specific behaviour.

*/

void CMMFAudioOutput::ConstructL()

	{

	iInitializeState = KErrNone;

	iDataTypeCode = KMMFFourCCCodePCM16;

	iNeedsSWConversion = EFalse;

	iSourceSampleRate = 0;

	iActiveSchedulerWait = new(ELeave) CActiveSchedulerWait;

	}

/**

Overridable constuction specific to this datasource.

The default implementation does nothing.

@param  aInitData

        The initialisation data.

*/

void CMMFAudioOutput::ConstructSinkL( const TDesC8& /*aInitData*/ )

	{

	}

/**

@deprecated

Gets audio from hardware device abstracted MMFDevsound (not used).

@param  aBuffer

        The data to write out to a Hardware Device.

@param  aSupplier

        The MDataSource consuming the data contained in aBuffer

*/

void CMMFAudioOutput::HWEmptyBufferL(CMMFBuffer* /*aBuffer*/, MDataSource* /*aSupplier*/)

	{

	}

/**

Sends audio to MMFDevsound.

@param  aBuffer

        The data to write out.

@param  aSupplier

        The search criteria for the supplier.

@param  aMediaId

        The type of data supplied - currently ignored.

*/

void CMMFAudioOutput::EmptyBufferL(CMMFBuffer* aBuffer, MDataSource* aSupplier, TMediaId /*aMediaId*/)

	{

	iSupplier = aSupplier;

	if (!iMMFDevSound)

		Panic(EMMFAudioOutputDevSoundNotLoaded);

	if (aSupplier == NULL)

		User::Leave(KErrArgument);

	// In order to avoid changes at the datapath data transfer state machine 

	// EmptyBufferL is still being called even

	// if the first time there is no buffer to send

	if (!iCanSendBuffers)

		{

		iCanSendBuffers = ETrue;

		return;

		}

	if (iNeedsSWConversion)

		{//need to perform channel & sample rate conversion before writing to clip

		CMMFDataBuffer* audio;

		//need to make sure aBuffer is not null before it is used

		if (aBuffer == NULL)

			{

			User::Leave(KErrArgument);

			}

		//buffer check is placed here before possible use of the buffer

		if (!CMMFBuffer::IsSupportedDataBuffer(aBuffer->Type()))

			{

			User::Leave(KErrNotSupported);

			}

		iConvertBuffer = CMMFDataBuffer::NewL(((CMMFDataBuffer*)aBuffer)->Data().Length());

		iChannelAndSampleRateConverter->Convert(*(CMMFDataBuffer*)aBuffer, *iConvertBuffer);

		audio = iConvertBuffer;

		//copy our converted data back into the real buffer to return to datapath

		TDes8& dest = STATIC_CAST( CMMFDataBuffer*, aBuffer )->Data() ;

		dest.SetLength(0);

		dest.Copy(audio->Data());

		}

	if (iState != EDevSoundReady && iState != EPaused) // If we're paused we still feed a buffer to DevSound

		User::Leave(KErrNotReady);

	iMMFDevSound->PlayData();

#if defined(__AUDIO_PROFILING)

	RDebug::ProfileEnd(0);

	User::Leave(KErrEof);

#endif  // defined(__AUDIO_PROFILING)

	// The following will never have been allocated unless

	// software conversion was required, and due to certain DevSound

	// implementations, this requirement can change dynamically.

	delete iConvertBuffer;

	iConvertBuffer = NULL;

	}

/**

Negotiates with the source to set, for example, the sample rate and number of channels.

Called if the sink's setup depends on source.

@param  aSource

        The data source with which to negotiate.

*/

void CMMFAudioOutput::NegotiateL(MDataSource& aSource)

	{

	if (aSource.DataSourceType() == KUidMmfFormatDecode)

		{//source is a clip so for now set sink settings to match source

		iSourceSampleRate = ((CMMFFormatDecode&)aSource).SampleRate();

		iSourceChannels = ((CMMFFormatDecode&)aSource).NumChannels(); 

		iSourceFourCC.Set(aSource.SourceDataTypeCode(TMediaId(KUidMediaTypeAudio)));

		((CMMFFormatDecode&)aSource).SuggestSourceBufferSize(KAudioOutputDefaultFrameSize);

		}

	// Query DevSound capabilities and Try to use DevSound sample rate and 

	// mono/stereo capability

	if (!iMMFDevSound)

		Panic(EMMFAudioOutputDevSoundNotLoaded);

	TMMFState prioritySettingsState = iPrioritySettings.iState; //should be EMMFStatePlaying

	//to use the GetSupportedInputDatatypes but we'll save it just in case it's not

	iPrioritySettings.iState = EMMFStatePlaying; //if playing does not support any output data types

	RArray<TFourCC> supportedDataTypes;

	//note Input data types becuase if we are playing audio ie audio output

	//the data is sent as an input to DevSound

	TRAPD(err, iMMFDevSound->GetSupportedInputDataTypesL(supportedDataTypes, iPrioritySettings));

	iPrioritySettings.iState = prioritySettingsState;

	if (err == KErrNone)

		{

		if (supportedDataTypes.Find(iSourceFourCC) == KErrNotFound)

			{//the source fourCC code could not be found in the list of 

			//data types supported by the Devsound therefor default to pcm16

			iDataTypeCode = KMMFFourCCCodePCM16;	

			}

		else

			{

			//the DevSound does support the same datatype as the source 

			//so set the fourcc to that of the source

			iDataTypeCode = iSourceFourCC;

			}

		}

	supportedDataTypes.Close();

	if (err == KErrNotSupported)

		{//if the Devsound does not support the GetSupportedOutputDataTypesL method

		//then assume that the DevSound is pcm16 only

		iDataTypeCode = KMMFFourCCCodePCM16;	

		}

	else if (err != KErrNone) //we had a real leave error from GetSupportedOuputDataTypesL

		{

		User::Leave(err);

		}

	// Prevent defect when SinkPrimeL is called before NegotiateL()

	// since characterization is ambiguous

	if(iState == EDevSoundReady)

		{

		iState = EIdle;

		}

	//INC40817 do the initialize here as capabilities may depend on datatype

	//note this implies client of audiooutput must call negotiate

	iMMFDevSound->InitializeL(*this, iDataTypeCode, EMMFStatePlaying);

	// In some implementations InitializeComplete is sent

	// in context, so check before starting activeSchedulerWait.

	if (iState != EDevSoundReady)

		{

		iInitializeState = KRequestPending;

		iActiveSchedulerWait->Start();

		}

	User::LeaveIfError(iInitializeState);

	// Reset the following flag in case DevSound's capabilities have

	// changed since we were last here: INC037165

	iNeedsSWConversion = EFalse;

	TMMFCapabilities devSoundCaps;

	devSoundCaps = iMMFDevSound->Capabilities();

	// Default PCM16

	iDevSoundConfig.iEncoding = EMMFSoundEncoding16BitPCM;

	// 1 = Monophonic and 2 == Stereo

	if (((iSourceChannels == 1) && (devSoundCaps.iChannels & EMMFMono)) ||

		((iSourceChannels == 2) && (devSoundCaps.iChannels & EMMFStereo)))

		iDevSoundConfig.iChannels = iSourceChannels;

	else //default or SW conversion, e.g. stereo on mono support

		{

		iDevSoundConfig.iChannels = EMMFMono;

		iNeedsSWConversion = ETrue;

		iSWConvertChannels = 1;

		iSWConvertSampleRate = iSourceSampleRate;

		}

	// Check for std sample rates.

	if ((iSourceSampleRate == 96000) && (devSoundCaps.iRate & EMMFSampleRate96000Hz))

		iDevSoundConfig.iRate = EMMFSampleRate96000Hz;

	else if ((iSourceSampleRate == 88200) && (devSoundCaps.iRate & EMMFSampleRate88200Hz))

		iDevSoundConfig.iRate = EMMFSampleRate88200Hz;

	else if ((iSourceSampleRate == 64000) && (devSoundCaps.iRate & EMMFSampleRate64000Hz))

		iDevSoundConfig.iRate = EMMFSampleRate64000Hz;

	else if ((iSourceSampleRate == 48000) && (devSoundCaps.iRate & EMMFSampleRate48000Hz))

		iDevSoundConfig.iRate = EMMFSampleRate48000Hz;

	else if ((iSourceSampleRate == 44100) && (devSoundCaps.iRate & EMMFSampleRate44100Hz))

		iDevSoundConfig.iRate = EMMFSampleRate44100Hz;

	else if ((iSourceSampleRate == 32000) && (devSoundCaps.iRate & EMMFSampleRate32000Hz))

		iDevSoundConfig.iRate = EMMFSampleRate32000Hz;

	else if ((iSourceSampleRate == 24000) && (devSoundCaps.iRate & EMMFSampleRate24000Hz))

		iDevSoundConfig.iRate = EMMFSampleRate24000Hz;

	else if ((iSourceSampleRate == 22050) && (devSoundCaps.iRate & EMMFSampleRate22050Hz))

		iDevSoundConfig.iRate = EMMFSampleRate22050Hz;

	else if ((iSourceSampleRate == 16000) && (devSoundCaps.iRate & EMMFSampleRate16000Hz))

		iDevSoundConfig.iRate = EMMFSampleRate16000Hz;

	else if ((iSourceSampleRate == 12000) && (devSoundCaps.iRate & EMMFSampleRate12000Hz))

		iDevSoundConfig.iRate = EMMFSampleRate12000Hz;

	else if ((iSourceSampleRate == 11025) && (devSoundCaps.iRate & EMMFSampleRate11025Hz))

		iDevSoundConfig.iRate = EMMFSampleRate11025Hz;

	else if ((iSourceSampleRate == 8000) && (devSoundCaps.iRate & EMMFSampleRate8000Hz))

		iDevSoundConfig.iRate = EMMFSampleRate8000Hz;

	else // non standard sample rate

		{

		iNeedsSWConversion = ETrue;

		// we need to choose to the closest, and smaller standard sample rate

		// and eventually convert the audio samples to this standard sample rate

		//NB: this list must be in ascending order

		const TInt KNumSampleRates = 12;

		static const TUint supportedSR[KNumSampleRates][2] = {{8000,  EMMFSampleRate8000Hz},

									{11025, EMMFSampleRate11025Hz},

									{12000, EMMFSampleRate12000Hz},

									{16000, EMMFSampleRate16000Hz},

									{22050, EMMFSampleRate22050Hz},

									{24000, EMMFSampleRate24000Hz},

									{32000, EMMFSampleRate32000Hz},

									{44100, EMMFSampleRate44100Hz},

									{48000, EMMFSampleRate48000Hz},

									{64000, EMMFSampleRate64000Hz},

									{88200, EMMFSampleRate88200Hz},

									{96000, EMMFSampleRate96000Hz}};

		//Only support down sampling

   		if (iSourceSampleRate < supportedSR[0][0]) 

   			User::Leave(KErrNotSupported);

   		TInt sampleRateIndex = KNumSampleRates;

   		//find the source sampleRateIndex

   		for (sampleRateIndex--; sampleRateIndex > -1; sampleRateIndex--)

   			{

   			if(iSourceSampleRate >= supportedSR[sampleRateIndex][0])

   				{

   				break;

   				}

   			}

   		//find the highest sink sample rate below the source rate

   		for (; sampleRateIndex > -1; sampleRateIndex--)

   			{

   			if(devSoundCaps.iRate & supportedSR[sampleRateIndex][1])

   				{

   				iSWConvertSampleRate = supportedSR[sampleRateIndex][0];

   				iDevSoundConfig.iRate = supportedSR[sampleRateIndex][1];

   				break;

   				}

   			}

   		//if a suitable sink sample rate is not available

   		if (sampleRateIndex < 0) 

   			User::Leave(KErrNotSupported);

   		// set the channels as well

   		iSWConvertChannels = iDevSoundConfig.iChannels;

   		} // else // non standard sample rate

	if (iNeedsSWConversion)

		{//can only software convert if datatype is pcm16

		//note cannot set non standard sample rates on DevSound API

		//as the API does not allow this

		//we need to reinitialize the devsound with pcm16 in this case

		iDataTypeCode = KMMFFourCCCodePCM16;

		iState = EIdle;

		iMMFDevSound->InitializeL(*this, iDataTypeCode, EMMFStatePlaying);

		// In some implementations InitializeComplete is called

		// in context, so check before starting activeSchedulerWait.

		if (iState != EDevSoundReady)

			{

			iInitializeState = KRequestPending;

			iActiveSchedulerWait->Start();

			}

		User::LeaveIfError(iInitializeState);

		}

	}

/**

Sets the sink's priority settings.

@param  aPrioritySettings

        The sink's priority settings. Takes enumerations to determine audio playback priority. 

        Higher numbers mean high priority (can interrupt lower priorities).

*/

void CMMFAudioOutput::SetSinkPrioritySettings(const TMMFPrioritySettings& aPrioritySettings)

	{

	iPrioritySettings = aPrioritySettings;

	if (!iMMFDevSound)

		Panic(EMMFAudioOutputDevSoundNotLoaded);

	else

		iMMFDevSound->SetPrioritySettings(iPrioritySettings);

	}

/**

Gets the sink's data type code.

Used by datapath MDataSource / MDataSink for codec matching.

@param  aMediaId

        The Media ID. Optional parameter to specifiy specific stream when datasource contains more

        than one stream of data.

@return	The 4CC of the data expected by this sink.

*/

TFourCC CMMFAudioOutput::SinkDataTypeCode(TMediaId /*aMediaId*/)

	{

	return iDataTypeCode;

	}

/**

Sets the sink's data type code.

@param  aSinkFourCC

        The 4CC of the data to be supplied to this sink.

@param  aMediaId

        The Media ID. Optional parameter to specifiy specific stream when datasource contains more 

        than one stream of data.

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

        another of the system-wide error codes.

*/

TInt CMMFAudioOutput::SetSinkDataTypeCode(TFourCC aSinkFourCC, TMediaId /*aMediaId*/)

	{//will check with devsound to see if aSinkFourCC is supported

	 //when this is added to devsound

	iDataTypeCode = aSinkFourCC;

	return KErrNone;

	}

/**

Primes the sink.

This is a virtual function that each derived class must implement, but may be left blank for default 

behaviour.

Called by CMMFDataPath::PrimeL().

*/

void CMMFAudioOutput::SinkPrimeL()

	{

	if(iPlayStarted != EFalse)

		{

		return;

		}

	iPlayStarted = EFalse;

	iCanSendBuffers = EFalse;

	if (iState == EIdle)

		{

		if (!iMMFDevSound) 

			{

			User::Leave(KErrNotReady);

			}

		iState = EDevSoundReady;

		}

	}

/**

Pauses the sink.

This is a virtual function that each derived class must implement, but may be left blank for default 

behaviour.

*/

void CMMFAudioOutput::SinkPauseL()

	{

	if (!iMMFDevSound)

		Panic(EMMFAudioOutputDevSoundNotLoaded);

	else

		iMMFDevSound->Pause();

	iPlayStarted = EFalse;

	iState = EPaused;

	}

/**

Starts playing the sink.

This is a virtual function that each derived class must implement, but may be left blank for default

behaviour.

*/

void CMMFAudioOutput::SinkPlayL()

	{

	if (iState == EPaused)

		{

		TBool isResumeSupported = iMMFDevSound->IsResumeSupported();

		// CMMFAudioOutput is not supposed to be paused 

		// if Resume is not supported by DevSound

		if(!isResumeSupported)

			{

			User::Leave(KErrNotSupported);

			}

		User::LeaveIfError(iMMFDevSound->Resume());

		iPlayStarted = ETrue;

		}

	else if (iPlayStarted == EFalse)

		{

		ConfigDevSoundL();	

		// This is a one-shot to "prime" MMFDevSound as first buffer uninitialised

		iMMFDevSound->PlayInitL();

		iPlayStarted = ETrue;

		}

	if ((iNeedsSWConversion)&&(iSourceChannels>0))

		{//can only do SW convert  - therefore need to do a conversion

		//currently only pcm16 is supported so return with an error if format not pcm16

		if (!iChannelAndSampleRateConverterFactory)

			{

			iChannelAndSampleRateConverterFactory

				= new(ELeave)CMMFChannelAndSampleRateConverterFactory;

			iChannelAndSampleRateConverter =

				iChannelAndSampleRateConverterFactory->CreateConverterL( iSourceSampleRate, iSourceChannels,

																		iSWConvertSampleRate, iSWConvertChannels);

			}

		//need to create an intermediate buffer in which to place the converted data

		}

	iState = EDevSoundReady;

	}

/**

Stops the sink.

This is a virtual function that each derived class must implement, but may be left blank for default

behaviour.

*/

void CMMFAudioOutput::SinkStopL()

	{

	if (iState == EDevSoundReady)

		{//not waiting on a buffer being played so stop devsound now

		iState = EIdle;

		if (iPlayStarted)

			{

			if (!iMMFDevSound)

				{

				Panic(EMMFAudioOutputDevSoundNotLoaded);

				}

			else

				{

				iPlayStarted = EFalse;

				iMMFDevSound->Stop();

				}

			}

		}

	else if (iState == EPaused)	//DEF46250 need to handle pause separately as we should always stop regardless of the state of iFirstBufferSent

		{

		iPlayStarted = EFalse;

		iMMFDevSound->Stop();

		iState = EIdle; 

		}

	iCanSendBuffers = EFalse;