// 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 Integraton test step classes for A3f DevSound Play test cases.

// 

//

#include "tsi_a3f_devsound_play.h"

/*

 *

 * RTestStepA3FDevSoundPlayBase - Test step constructor

 *

 */

RTestStepA3FDevSoundPlayBase::RTestStepA3FDevSoundPlayBase(const TDesC& aTestName, const TDesC& aSectName, const TFourCC& aInputDataType)

:RAsyncTestStep(),

 iMMFDevSound(NULL),

 iBuffer(NULL),

 iTimer(NULL),

 iCallBack(NULL, NULL),

 iInputDataType(aInputDataType),

 iSectName(aSectName),

 iFilename(KNullDesC),

 iSampleRate(KNullDesC),

 iMonoStereo(KNullDesC),

 iPlayState(EStatePlayStart),

 iBufferCount(0),

 iConfig(EFalse),

 iInvalidConfig(EFalse),

 iUseFourCC(EFalse)

	{

	// From RTestStep

	iTestStepName = aTestName; // store the name of the test case

	}

/*

 *

 * RTestStepA3FDevSoundPlayBase - Test step constructor

 *

 */

RTestStepA3FDevSoundPlayBase::RTestStepA3FDevSoundPlayBase(const TDesC& aTestName, const TDesC& aSectName)

:RAsyncTestStep(),

 iMMFDevSound(NULL),

 iBuffer(NULL),

 iTimer(NULL),

 iCallBack(NULL, NULL),

 iInputDataType(KMMFFourCCCodePCM16),

 iSectName(aSectName),

 iFilename(KNullDesC),

 iSampleRate(KNullDesC),

 iMonoStereo(KNullDesC),

 iPlayState(EStatePlayStart),

 iBufferCount(0),

 iConfig(EFalse),

 iInvalidConfig(EFalse),

 iUseFourCC(EFalse)

	{

	// From RTestStep

	iTestStepName = aTestName; // store the name of the test case

	}

/*

 *

 * RTestStepA3FDevSoundPlayBase - Test step constructor

 *

 */

RTestStepA3FDevSoundPlayBase::RTestStepA3FDevSoundPlayBase(const TDesC& aTestName, const TFourCC& aInputDataType)

:RAsyncTestStep(),

 iMMFDevSound(NULL),

 iBuffer(NULL),

 iTimer(NULL),

 iCallBack(NULL, NULL),

 iInputDataType(aInputDataType),

 iSectName(KNullDesC),

 iFilename(KNullDesC),

 iSampleRate(KNullDesC),

 iMonoStereo(KNullDesC),

 iPlayState(EStatePlayStart),

 iBufferCount(0),

 iConfig(EFalse),

 iInvalidConfig(EFalse),

 iUseFourCC(EFalse)

	{

	// From RTestStep

	iTestStepName = aTestName; // store the name of the test case

	}

/*

 *

 * RTestStepA3FDevSoundPlayBase - Test step constructor

 *

 */

RTestStepA3FDevSoundPlayBase::RTestStepA3FDevSoundPlayBase(const TDesC& aTestName)

:RAsyncTestStep(),

 iMMFDevSound(NULL),

 iBuffer(NULL),

 iTimer(NULL),

 iCallBack(NULL, NULL),

 iInputDataType(KMMFFourCCCodePCM16),

 iSectName(KNullDesC),

 iFilename(KNullDesC),

 iSampleRate(KNullDesC),

 iMonoStereo(KNullDesC),

 iPlayState(EStatePlayStart),

 iBufferCount(0),

 iConfig(EFalse),

 iInvalidConfig(EFalse),

 iUseFourCC(EFalse)

	{

	// From RTestStep

	iTestStepName = aTestName; // store the name of the test case

	}

/*

 *

 * KickoffTestL

 * - Starts the test

 *

 */

void RTestStepA3FDevSoundPlayBase::KickoffTestL()

	{

	TInt err = iFs.Connect();

	if (err != KErrNone)

		{

		ERR_PRINTF2(_L("Could not connect to Filesystem. Error = %d"), err);

		StopTest(err);

		}

	// Get the file name of the audio file to play

	#ifdef __WINS__

		if(!GetStringFromConfig(iSectName, _L("EmuPlayFile"), iFilename))

		{

		TPtrC keyName(_L("EmuPlayFile"));

		ERR_PRINTF3(_L("Error in getting file name from config file in %S section via the %S key field."), &iSectName, &keyName);

		StopTest(KErrPathNotFound);

		return;

		}

	#elif __MARM__

		if(!GetStringFromConfig(iSectName, _L("HwPlayFile"), iFilename))

		{

		TPtrC keyName(_L("HwPlayFile"));

		ERR_PRINTF3(_L("Error in getting file name from config file in %S section via the %S key field."), &iSectName, &keyName);

		StopTest(KErrPathNotFound);

		return;

		}

	#endif

	// Check if SetConfig and FourCC are to be used or not

	CheckConfigAndFourCCUsage();

	INFO_PRINTF2(_L("Section Name is :%S"), &iSectName);

	// Open using RFile for playback

	err = iFile.Open(iFs, iFilename, EFileRead);

	if (err != KErrNone)

		{

		ERR_PRINTF2(_L("Could not Open the File: Error = %d"), err);

		StopTest(err);

		}

	// Create instance of CMMFDevSound

	iMMFDevSound = CMMFDevSound::NewL();

	iTimer = CPeriodic::NewL(CActive::EPriorityHigh);

	iCallBack = TCallBack(TimerCallback, this);

	DoKickoffTestL();

	Fsm(EEventPlayStart, KErrNone); // call to initialize DevSound

	}

/*

 *

 * DoKickoffTestL

 *

 */

void RTestStepA3FDevSoundPlayBase::DoKickoffTestL()

	{

	INFO_PRINTF2(_L("File to be played -> %S"), &iFilename);

	DisplayCodecInfo();

	}

/*

 * ToneFinished

 *

 */

void RTestStepA3FDevSoundPlayBase::ToneFinished(TInt /*aError*/)

	{

	__ASSERT_ALWAYS(0,Panic(_L("RTestStepA3FDevSoundPlayBase"),EInvalidCallbackCall));

	}

/*

 *

 * RecordError

 *

 */

void RTestStepA3FDevSoundPlayBase::RecordError(TInt)

	{

	__ASSERT_ALWAYS(0,Panic(_L("RTestStepA3FDevSoundPlayBase"),EInvalidCallbackCall));

	}

/*

 *

 * BufferToBeEmptied

 *

 */

void RTestStepA3FDevSoundPlayBase::BufferToBeEmptied(CMMFBuffer* /*aBuffer*/)

	{

	__ASSERT_ALWAYS(0,Panic(_L("RTestStepA3FDevSoundPlayBase"),EInvalidCallbackCall));

	}

/*

 *

 * ConvertError

 *

 */

void RTestStepA3FDevSoundPlayBase::ConvertError(TInt /*aError*/)

	{

	__ASSERT_ALWAYS(0,Panic(_L("RTestStepA3FDevSoundPlayBase"),EInvalidCallbackCall));

	}

/*

 *

 * DeviceMessage

 *

 */

void RTestStepA3FDevSoundPlayBase::DeviceMessage(TUid /*aMessageType*/, const TDesC8& /*aMsg*/)

	{

	__ASSERT_ALWAYS(0,Panic(_L("RTestStepA3FDevSoundPlayBase"),EInvalidCallbackCall));

	}

/*

 *

 * TimerCallback

 *

 */

TInt RTestStepA3FDevSoundPlayBase::TimerCallback(TAny* aPtr)

	{

	static_cast<RTestStepA3FDevSoundPlayBase*>(aPtr)->DoTimerCallback();

	return KErrNone;

	}

/*

 *

 * DoTimerCallback

 *

 */

void RTestStepA3FDevSoundPlayBase::DoTimerCallback()

	{

	// The derived classes may provide the implementation if needed

	}

/*

 *

 * CallStopTest

 *

 */

void RTestStepA3FDevSoundPlayBase::CloseTest()

	{

	if (iMMFDevSound)

		{

		INFO_PRINTF1(_L("Deleting DevSound object..."));

		delete iMMFDevSound;

		iMMFDevSound = NULL;

		}

	if (iTimer)

		{

		delete iTimer;

		iTimer = NULL;

		}

	iFile.Close();

	iFs.Close();

	}

/*

 *

 * InitializeComplete

 *

 */

void RTestStepA3FDevSoundPlayBase::InitializeComplete(TInt aError)

	{

	if (iPlayState == EStatePlayInitializing)

		{

		Fsm(EEventInitCompletePlay,aError);

		}

	}

/*

 *

 * BufferToBeFilled

 *

 */

void RTestStepA3FDevSoundPlayBase::BufferToBeFilled(CMMFBuffer* aBuffer)

	{

	if (!aBuffer)

		{

		ERR_PRINTF1(_L("BufferToBeFilled callback received a NULL CMMFBuffer!"));

		StopTest(KErrGeneral);

		return;

		}

	iBuffer = aBuffer;

	// Call to continue the Play process

	Fsm(EEventBTBF,KErrNone);

	}

/*

 *

 * PlayError

 *

 */

void RTestStepA3FDevSoundPlayBase::PlayError(TInt aError)

	{

	INFO_PRINTF2(_L("DevSound called PlayError with error = %d"), aError);

	if ((iBuffer->LastBuffer()) && (aError == KErrUnderflow))

		{

		StopTest();

		}

	else

		{

		StopTest(aError, EFail);

		}

	}

/*

 *

 * Fsm

 *	- Executes playing events of DevSound in sequence

 *

 */

void RTestStepA3FDevSoundPlayBase::Fsm(TDevSoundPlayEvents aDevSoundEvent, TInt aError)

	{

	switch (iPlayState)

		{

		case EStatePlayStart:

			{

			__ASSERT_ALWAYS((aError == KErrNone),Panic(_L("RTestStepA3FDevSoundPlayBase"),EFsmIncorrectErrorPassed));

			if (aDevSoundEvent == EEventPlayStart)

				{

				// Initializing DevSound object for playing mode to process audio data via desired FourCC code

				INFO_PRINTF1(_L("Calling CMMFDevSound::InitializeL"));

				TInt err;

				if(iUseFourCC)

					{

					TRAP(err, iMMFDevSound->InitializeL(*this, iInputDataType, EMMFStatePlaying));

					}

				else

					{

					TRAP(err, iMMFDevSound->InitializeL(*this, EMMFStatePlaying));

					}

				if (err != KErrNone)

					{

					ERR_PRINTF2(_L("CMMFDevSound::InitializeL left with error = %d"), err);

					StopTest(err);

					break;

					}

				INFO_PRINTF1(_L("State: EStatePlayInitializing"));

				iPlayState = EStatePlayInitializing;

				}

			else

				{

				ERR_PRINTF2(_L("DevSound EEventPlayStart not received as expected. Received event: %d"), aDevSoundEvent);

				StopTest(aError, EFail);

				}

			break;

			}

		case EStatePlayInitializing:

			{

			if (aDevSoundEvent == EEventInitCompletePlay && aError == KErrNone)

				{

				if(iConfig)

					{

					// Set Devsound capability settings using CMMFDevSound::SetConfigL

					SetSampleRateAndChannelMode();

					TMMFCapabilities capabilities;

					capabilities.iRate = ConvertDesToTMMFSampleRate(iSampleRate);

					capabilities.iChannels = ConvertDesToTMMFMonoStereo(iMonoStereo);

					TRAPD(errConfig, iMMFDevSound->SetConfigL(capabilities));

					if (errConfig != KErrNone && !iInvalidConfig)

						{

						ERR_PRINTF2(_L("CMMFDevSound::SetConfigL() left with error = %d"), errConfig);

						StopTest(errConfig);

						return;

						}

					else if (errConfig == KErrArgument && iInvalidConfig)

						{

						ERR_PRINTF2(_L("CMMFDevSound::SetConfigL() left with expected error = %d"), errConfig);

						iInvalidConfig = EFalse;

						StopTest(errConfig, EPass);

						return;

						}

					}

				// Initialize audio device and starts the playing process

				INFO_PRINTF1(_L("Calling CMMFDevSound::PlayInitL()"));

				TRAPD(errPlay, iMMFDevSound->PlayInitL());

				if (errPlay != KErrNone)

					{

					ERR_PRINTF2(_L("CMMFDevSound::PlayInitL() left with error = %d"), errPlay);

					StopTest(errPlay);

					break;

					}

				INFO_PRINTF1(_L("State: EStatePlaying"));

				iPlayState = EStatePlaying;

				}

			else if (aDevSoundEvent == EEventInitCompletePlay && aError != KErrNone)

				{

				ERR_PRINTF2(_L("DevSound called CMMFDevSound::InitializeComplete with error = %d"), aError);

				StopTest(aError);

				}

			else

				{

				ERR_PRINTF2(_L("DevSound EEventInitCompletePlay not received as expected. Received event: %d"), aDevSoundEvent);

				StopTest(aError, EFail);

				}

			break;

			}

		case EStatePlaying:

			{

			__ASSERT_ALWAYS((aError == KErrNone),Panic(_L("RTestStepA3FDevSoundPlayBase"),EFsmIncorrectErrorPassed));

			if (aDevSoundEvent == EEventBTBF)

				{

				// Fill the buffer with audio data and play the data in the buffer

				CMMFDataBuffer* buffer = static_cast <CMMFDataBuffer*> (iBuffer);

				TInt err = iFile.Read(buffer->Data());

				if (err != KErrNone)

					{

					ERR_PRINTF2(_L("ERROR : iFile.Read() failed with %d"), err);

					StopTest(err);

					break;

					}

				if (buffer->Data().Length() != buffer->RequestSize())

					{

					INFO_PRINTF3(_L("Data length copied from file = %d. Expected = %d. Must be EOF."), buffer->Data().Length(), buffer->RequestSize());

					iBuffer->SetLastBuffer(ETrue);

					}

				// Playing data in the buffer at the current volume

				iMMFDevSound->PlayData();

				iBufferCount++;

				}

			else

				{

				ERR_PRINTF2(_L("DevSound EEventBTBF not received as expected. Received event: %d"), aDevSoundEvent);

				StopTest(aError, EFail);

				}

			break;

			}

		default:

			{

			ERR_PRINTF2(_L("Invalid DevSound state received: %d"), iPlayState);

			StopTest(KErrGeneral);

			}

		}

	}

/*

 *

 * DisplayCodecInfo

 *

 */

void RTestStepA3FDevSoundPlayBase::DisplayCodecInfo()

	{

	// Display trace about codec under test

	TUint32 fourCC = iInputDataType.FourCC();

	INFO_PRINTF5(_L("Codec under test -> %c%c%c%c"), fourCC, fourCC>>8, fourCC>>16, fourCC>>24);

	}

/*

 *

 * ConvertDesToTMMFSampleRate

 *

 */

TUint RTestStepA3FDevSoundPlayBase::ConvertDesToTMMFSampleRate(const TDesC& aSampleRateString)

	{

	TUint rate = 0;

	STR_SWITCH(aSampleRateString)

	STR_CASE(_L("EMMFSampleRate8000Hz"))

		{

		rate = EMMFSampleRate8000Hz;

		break;

		}

	STR_CASE(_L("EMMFSampleRate11025Hz"))

		{

		rate = EMMFSampleRate11025Hz;

		break;

		}