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

//

#ifndef TSU_MMF_DEVSOUND_STEP_H

#define TSU_MMF_DEVSOUND_STEP_H

#include <testframework.h>

#include <mmf/server/sounddevice.h>

#include "TSU_MMF_DEVSOUND_SUITE.h"

#include "../TestInterface/TSU_MMF_DEVSOUND_TestInterface_ImplementationUID.hrh"

#include "../TestInterface1/TSU_MMF_DEVSOUND_TestInterface1_ImplementationUID.hrh"

#include "../TestInterface/TSU_MMF_DEVSOUND_TestInterface.h"

#include "../TestInterface1/TSU_MMF_DEVSOUND_TestInterface1.h"

#include <mmf/plugin/mmfdevsoundcustominterface.hrh>

const TInt KMaxVolume = 0xFFFF;

const TInt KMaxGain   = 0xFFFF;

class CTestSuite;

class CTestSuiteDevSound;

/**

 *

 * CActiveListener provides the asynchronous operation

 * of an active object

 *

 * @lib "TSU_MMF_DEVSOUND_SUITE.lib"

 *

 *

 */

class CActiveListener : public CActive

	{

public:

	CActiveListener() : CActive(CActive::EPriorityStandard) 

		{ 

		CActiveScheduler::Add(this);

		}

	void InitialiseActiveListener()

		{

		iStatus = KRequestPending; SetActive();

		}

	~CActiveListener()

		{

		Cancel();

		}

	// From CActive

	virtual void RunL()

		{

		CActiveScheduler::Stop();

		}

	virtual void DoCancel()

		{

		CActiveScheduler::Stop();

		};

	};

/**

 *

 * CTestStepDevSound - Test class that enables DevSound tests.

 * It's a base class for all test steps.

 *

 * @lib "TSU_MMF_DEVSOUND_SUITE.lib"

 *

 *

 */

class CTestStepDevSound : public CTestStep, public MDevSoundObserver

	{

public:

	CTestStepDevSound();

	~CTestStepDevSound();

	static void CleanUp(TAny *aPtr);

	void SetTestSuite(const CTestSuiteDevSound* aTestSuite);

protected:

	virtual TVerdict DoTestStepPreambleL();

	virtual TVerdict DoTestStepPostambleL();

	// Callback methods from MDevSoundObserver mixin

	void InitializeComplete (TInt aError);

	void ToneFinished (TInt aError);

	void BufferToBeFilled (CMMFBuffer* aBuffer);

	void PlayError (TInt aError);

	void BufferToBeEmptied (CMMFBuffer* aBuffer);

	void RecordError (TInt aError);

	void ConvertError (TInt aError);

	void DeviceMessage (TUid aMessageType, const TDesC8& aMsg);

	// Test methods (called by test cases)

	TVerdict TestInitialize(TMMFState aMode);

	TVerdict TestInitialize(TFourCC& aDataType, TMMFState aMode);

	TVerdict TestInitialize(TUid aHwDeviceUid, TMMFState aMode);

	TVerdict TestCaps();

	TVerdict TestPlayTone(TInt aFreq, TTimeIntervalMicroSeconds aDur);

	TVerdict TestPlayDTMFString(TPtrC aDTMFString);

	void TestSetVolume(TInt aVol);

	void TestSetGain(TInt aGain);

	TVerdict TestSetVolRamp(TInt aVol, TInt aDur);

	TInt TestMaxVolume();

	TInt TestMaxGain();

	TInt TestVolume();

	TInt TestGain();

	TVerdict TestPlayInit();

	TVerdict TestPlayData();

	TVerdict TestRecordInit();

	TVerdict TestRecordInitCapsNotMatch();

	TVerdict TestRecordData();

	TVerdict TestRecordDataCapsNotMatch();

	// Utility Methods

	void ResetCallbacks();

	TInt GetCallbackTotal();

	TVerdict TestDigitalPlayback(TInt aNumSamples, TDesC& aFilename);

	TVerdict TestDigitalRecord(TInt aNumSamples, TDesC& aFilename);

	TVerdict TestDigitalPlayback(TInt aNumSamples, TDesC& aFilename, TFourCC& aDataType);

	TVerdict TestDigitalRecord(TInt aNumSamples, TDesC& aFilename, TFourCC& aDataType);

protected:

	typedef enum TCallback 

		{

		EInitComplete,

		EToneFinished,

		EBuffToFill,

		EPlayError,

		EBuffToEmpty,

		ERecError,

		EConvertMsg,

		EDeviceMsg

		};

	TFixedArray<TInt, 7> iCallbackArray;

	// pointer to suite which owns this test 

	const CTestSuiteDevSound* iDevSoundTestSuite;

	CActiveScheduler* iAS;

	CActiveListener* iAL;

	CMMFDevSound* iMMFDevSound;

	TInt iExpectedValue;

	TInt iCallbackError;

	CMMFBuffer* iBuffer;

};

// DevSound events

enum TMmfDevSoundEvents

    {

    EDevSoundInit = 0,

    EDevSoundPlayInit,

    EDevSoundPlayData,

    EDevSoundEmptyBuffer

    };

enum TCallback 

	{

	EInitComplete = 0,

	EToneFinished,

	EBuffToFill,

	EPlayError,

	EBuffToEmpty,

	ERecError,

	EConvertMsg,

	EDeviceMsg

	};

/**

 *

 * CTestStepDevSoundCustomInterface.

 * 

 *

 * @lib "TSU_MMF_DEVSOUND_SUITE.lib"

 *

 *

 */

class CTestStepDevSoundCustomInterface : public CTestStep, public MDevSoundObserver

	{

public:

	CTestStepDevSoundCustomInterface();

	~CTestStepDevSoundCustomInterface();

	void SetTestSuite(const CTestSuiteDevSound* aTestSuite);

protected:

	virtual TVerdict DoTestStepPreambleL();

	virtual TVerdict DoTestStepPostambleL();

	virtual TVerdict RunTest();

	// Executes events of DevSound

    void FsmL(TMmfDevSoundEvents aDevSoundEvent);

	// Callback methods from MDevSoundObserver mixin

	void InitializeComplete(TInt aError);

	void ToneFinished(TInt aError);

	void BufferToBeFilled(CMMFBuffer* aBuffer);

	void PlayError(TInt aError);

	void BufferToBeEmptied(CMMFBuffer* aBuffer);

	void RecordError(TInt aError);

	void ConvertError(TInt aError);

	void DeviceMessage(TUid aMessageType, const TDesC8& aMsg);

	// Utility Methods

	void ResetCallbacks();

	TInt GetCallbackTotal();

protected:

	TFixedArray<TInt, 7> iCallbackArray;

	// pointer to suite which owns this test 

	const CTestSuiteDevSound* iDevSoundTestSuite;

	CActiveScheduler* iAS;

	CMMFDevSound* iMMFDevSound;

	TInt iExpectedValue;

	TInt iCallbackError;

	CMMFBuffer* iBuffer;

	RFile iFile;

    RFs iFs;

    //The sequence of methods called in this test - 1.Initilaize DevSound

 	// 2.PlayInitL, 3.Play 4.EmptyBuffers .Continue sequence 3 to 4

 	//This variable is used to count number of buffers in the sequence of call from 3 to 4

    TInt iBufferCount;

    //To know the last buffer

    TBool iLastBuffer;

};

//------------------------------------------------------------------

class CTestStepDevSoundInitializePlay : public CTestStepDevSound

	{

public:

	CTestStepDevSoundInitializePlay();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundInitializeHwDeviceUidPlay : public CTestStepDevSound

	{

public:

	CTestStepDevSoundInitializeHwDeviceUidPlay();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundInitializeFourCCPlay : public CTestStepDevSound

	{

public:

	CTestStepDevSoundInitializeFourCCPlay();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundInitializeRecord : public CTestStepDevSound

	{

public:

	CTestStepDevSoundInitializeRecord();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundInitializeHwDeviceUidRecord : public CTestStepDevSound

	{

public:

	CTestStepDevSoundInitializeHwDeviceUidRecord();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundInitializeFourCCRecord : public CTestStepDevSound

	{

public:

	CTestStepDevSoundInitializeFourCCRecord();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundInitializeInvalidFourCC : public CTestStepDevSound

	{

public:

	CTestStepDevSoundInitializeInvalidFourCC();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundCheckCaps : public CTestStepDevSound

	{

public:

	CTestStepDevSoundCheckCaps();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundSimpleTone : public CTestStepDevSound

	{

public:

	CTestStepDevSoundSimpleTone();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundDTMFTones : public CTestStepDevSound

	{

public:

	CTestStepDevSoundDTMFTones();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundSimpleToneChangeVolume : public CTestStepDevSound

	{

public:

	CTestStepDevSoundSimpleToneChangeVolume();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundDTMFTonesInvalidStrings : public CTestStepDevSound

	{

public:

	CTestStepDevSoundDTMFTonesInvalidStrings();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundSimpleToneInvalidFreq : public CTestStepDevSound

	{

public:

	CTestStepDevSoundSimpleToneInvalidFreq();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundSimpleToneInvalidDuration : public CTestStepDevSound

	{

public:

	CTestStepDevSoundSimpleToneInvalidDuration();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundPlayInit : public CTestStepDevSound

	{

public:

	CTestStepDevSoundPlayInit();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundPlay1BufferPCM16 : public CTestStepDevSound

	{

public:

	CTestStepDevSoundPlay1BufferPCM16();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundPlay5BuffersPCM16 : public CTestStepDevSound

	{

public:

	CTestStepDevSoundPlay5BuffersPCM16();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundPlayEOFPCM16 : public CTestStepDevSound

	{

public:

	CTestStepDevSoundPlayEOFPCM16();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundPlay1BufferPCM8 : public CTestStepDevSound

	{

public:

	CTestStepDevSoundPlay1BufferPCM8();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundPlay5BuffersPCM8 : public CTestStepDevSound

	{

public:

	CTestStepDevSoundPlay5BuffersPCM8();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundPlayEOFPCM8 : public CTestStepDevSound

	{

public:

	CTestStepDevSoundPlayEOFPCM8();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundPlayGarbageEOF : public CTestStepDevSound

	{

public:

	CTestStepDevSoundPlayGarbageEOF();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundMaxGain : public CTestStepDevSound

	{

public:

	CTestStepDevSoundMaxGain();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundMaxVolume : public CTestStepDevSound

	{

public:

	CTestStepDevSoundMaxVolume();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundSetGain : public CTestStepDevSound

	{

public:

	CTestStepDevSoundSetGain();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundSetVolume : public CTestStepDevSound

	{

public:

	CTestStepDevSoundSetVolume();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundRecord1BufferPCM16 : public CTestStepDevSound

	{

public:

	CTestStepDevSoundRecord1BufferPCM16();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundRecord10BuffersPCM16 : public CTestStepDevSound

	{

public:

	CTestStepDevSoundRecord10BuffersPCM16();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundRecord1BufferPCM8 : public CTestStepDevSound

	{

public:

	CTestStepDevSoundRecord1BufferPCM8();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundRecord10BuffersPCM8 : public CTestStepDevSound

	{

public:

	CTestStepDevSoundRecord10BuffersPCM8();

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundRecordInitNoUECap : public CTestStepDevSound

	{

public:

	CTestStepDevSoundRecordInitNoUECap(TBool aHasMMDDCap);

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundRecordInitWithUECap : public CTestStepDevSound

	{

public:

	CTestStepDevSoundRecordInitWithUECap(TBool aHasAllCaps);

	TVerdict DoTestStepL();

	};

//------------------------------------------------------------------

class CTestStepDevSoundRecordDataWithUECap : public CTestStepDevSound

	{

public:

	CTestStepDevSoundRecordDataWithUECap(TBool aHasAllCaps);

	TVerdict DoTestStepL();