/*
* Copyright (c) 2002 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: Restricted Audio Output Test
*
*/



#ifndef CRestrictedAOTestClass_H
#define CRestrictedAOTestClass_H

//  INCLUDES
#include <StifLogger.h>
#include <TestScripterInternal.h>
#include <StifTestModule.h>
#include <RestrictedAudioOutputMessageHandler.h>
#include <e32svr.h>
#include <e32base.h>
#include <e32cons.h>
#include <customInterfaceUtility.h>
#include <SoundDevice.h>
#include <ConfigurationComponentsFactory.h>
#include <RestrictedAudioOutput.h>
#include <RestrictedAudioOutputProxy.h>


#include "TimeoutController.h"


// CONSTANTS
const TInt KErrBadTestParameter= -1000;         // Error on configuration file

const TInt KErrEventPending =-2000;             // Timeout and not callback
const TInt KErrCallbackErrorCode = -2001;       // Callback return error code
const TInt KErrUnexpectedValue =-2002;          // Unexpected value at setting
const TInt KExpectedFrequencyChange = -2003;		// Is not finding more than one station
const TInt KErrTimeoutController = -2007;		// Unexpected notification

const TInt KShortTimeout = 1000;
const TInt KMediumTimeout = 4000;
const TInt KLongTimeout = 100000;


_LIT( KMsgBadTestParameters, "[Error] No valid test case parameters");

// General
_LIT( KTagAll, "All");
_LIT( KTagAudioAnalog, "AudioAnalog");
_LIT( KTagFM, "FM");
_LIT( KTagStereoBT, "StereoBT");
_LIT( KTagBTA2DP, "BTA2DP");
_LIT( KTagAudioUplink, "AudioUplink");
_LIT( KTagUSB, "USB");
_LIT( KTagRecord, "Record");
_LIT( KTagVisualization, "Visualization");

/**
* RIM CR 417-7642: HDMI with HDCP to Resctricted Audio Output API
* Adding new ENUMs to CRestrictedAudioOutput::TAllowedOutputPreference for HDMI and HDCP
* EAllowAudioHDMI and EAllowAudioHdmiHdcpRequired
*/
_LIT( KTagHDMI, "HDMI");
_LIT( KTagHdmiHdcpRequired, "HdmiHdcpRequired");


// MACROS
//#define ?macro ?macro_def
// Logging path
#ifdef __WINSCW__
_LIT( KRestrictedAOTestClassLogPath, "\\logs\\testframework\\RestrictedAOTestClass\\" );
#else
_LIT( KRestrictedAOTestClassLogPath, "e:\\testing\\Log\\" );
#endif

// Log file
_LIT( KRestrictedAOTestClassLogFile, "CRestrictedAOTestClass.txt" );


// FORWARD DECLARATIONS
class CRestrictedAOTestClass;


// CLASS DECLARATION

/**
*  CRadioUtilityTestClass test class for STIF Test Framework TestScripter.
*  ?other_description_lines
*
*  @lib ?library
*  @since Series60_3_2
*/
NONSHARABLE_CLASS(CRestrictedAOTestClass) : public CScriptBase,
											public MTimeoutObserver,
											public MDevSoundObserver

    {
    public:  // Constructors and destructor

        /**
        * Two-phased constructor.
        */
        static CRestrictedAOTestClass* NewL( CTestModuleIf& aTestModuleIf );

        /**
        * Destructor.
        */
        virtual ~CRestrictedAOTestClass();

		enum TROExpectedEvent
		{
			EInitializeComplete,

		};

    public: // New functions

        /**
        * ?member_description.
        * @since ?Series60_version
        * @param ?arg1
        * @return
        */
        //?type ?member_function( ?type ?arg1 );

    public: // Functions from base classes

        /**
        * From CScriptBase Runs a script line.
        * @since ?Series60_version
        * @param aItem Script line containing method name and parameters
        * @return Symbian OS error code
        */
        virtual TInt RunMethodL( CStifItemParser& aItem );


	// Required for MDevSoundObserver:
	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*/);


	    // From MTimeoutObserver

	    /**
	    * @since ?Series60_version
	    * @param none
	    * Review if all the expected events have ocurred once the time is over
	    */
	    void HandleTimeout(TInt error);





    protected:  // New functions

        /**
        * ?member_description.
        * @since ?Series60_version
        * @param ?arg1
        * @return
        */
        //?type ?member_function( ?type ?arg1 );

    protected:  // Functions from base classes

        /**
        * From ?base_class ?member_description
        */
        //?type ?member_function();

    private:

        /**
        * C++ default constructor.
        */
        CRestrictedAOTestClass( CTestModuleIf& aTestModuleIf );

        /**
        * By default Symbian 2nd phase constructor is private.
        */
        void ConstructL();

        // Prohibit copy constructor if not deriving from CBase.
        // ?classname( const ?classname& );
        // Prohibit assigment operator if not deriving from CBase.
        // ?classname& operator=( const ?classname& );

        /**
        * Frees all resources allocated from test methods.
        * @since ?Series60_version
        */
        void Delete();

        /**
        * Test methods are listed below.
        */

        /**
        * Example test method.
        * @since ?Series60_version
        * @param aItem Script line containing parameters.
        * @return Symbian OS error code.
        */

	    /**
	    * Set an event as expected and set default timeout
	    * @since ?Series60_version
	    */
	    void AddExpectedEvent(TROExpectedEvent event, TInt ms);


	    /**
	    * Unset an event as expected
	    * @since ?Series60_version
	    */
	    TBool RemoveExpectedEvent(TROExpectedEvent event);


	    /**
	    * @since ?Series60_version
	    * @param none
	    * Removes all expected events
	    */
	    void RemoveAllExpectedEvents();

	    /**
	    * Verify that the event was expected, removes it from the list
	    * Signal the TestScripter with the returned error code
	    * @since ?Series60_version
	    */
	    void ProcessEvent(TROExpectedEvent aEvent, TInt aError);

	    /**
	    * Maps a event with a descriptor with its name
	    * @since ?Series60_version
	    */
	    TPtrC EventName( TInt aKey );

	    /*
	    * Test methods are listed below.
	    */

	    /**
	    * Sets a timeout different since the default
	    * @since Series60_3_2
	    * @param aItem Script line containing parameters.
	    * @return Symbian OS error code.
	    */
	    TInt SetTimeout( CStifItemParser& aItem );

	    /**
	    *
	    * @since Series60_3_2
	    * @param aItem Script line containing parameters.
	    * @return Symbian OS error code.
	    */
	    TInt SetExpectedEvents( CStifItemParser& aItem );

	    /**
	    *
	    * @since Series60_3_2
	    * @param aItem Script line containing parameters.
	    * @return Symbian OS error code.
	    */
	    TInt SetAllowedPanic( CStifItemParser& aItem );

	    /**
	    * Connect to the default client to the server
	    * @since ?Series60_version
	    * @param aItem Script line containing parameters.
	    * @return Symbian OS error code.
	    */

		TInt ExampleL( CStifItemParser& aItem );

		TInt CreateFactory( CStifItemParser& aItem );
		TInt CreateRestrictedAO( CStifItemParser& aItem );

		TInt AppendAllowedOutput( CStifItemParser& aItem );
		TInt RemoveAllowedOutput( CStifItemParser& aItem );
		TInt GetAllowedOutputCount( CStifItemParser& aItem );
		TInt GetAllowedOutput( CStifItemParser& aItem );
		TInt Reset( CStifItemParser& aItem );
		TInt Commit( CStifItemParser& aItem );
		TInt GetUid(CStifItemParser& aItem);


    public:     // Data
        // ?one_line_short_description_of_data
        //?data_declaration;

    protected:  // Data
        // ?one_line_short_description_of_data
        //?data_declaration;

    private:    // Data

    // reference to TestModuleIf
    CTestModuleIf& iTestModuleIf;

    	CConfigurationComponentsFactory* iFactory;
			CMMFDevSound*	iDevSound;
			CRestrictedAudioOutput* iRestrictedAudioOutput;
			CRestrictedAudioOutputMessageHandler* iRestrictedAudioOutputMessageHandler;
			CRestrictedAudioOutputProxy* iRestrictedAudioOutputProxy;


    // Active object with a timer to timeout the test case
    CSimpleTimeout * iTimeoutController;

    // Indicates if the test case use a normal exit reason
    TBool iNormalExitReason;

    // List of expected events
    RArray<TROExpectedEvent> iExpectedEvents;

    // List of notification event (by the callback)
    RArray<TROExpectedEvent> iOcurredEvents;


        // ?one_line_short_description_of_data
        //?data_declaration;

        // Reserved pointer for future extension
        //TAny* iReserved;

    public:     // Friend classes
        //?friend_class_declaration;
    protected:  // Friend classes
        //?friend_class_declaration;
    private:    // Friend classes
        //?friend_class_declaration;

    };

#endif      // CRestrictedAOTestClass_H

// End of File