/*

* Copyright (c) 2004-2007 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:  Video session interface.

*

*/

#ifndef CVTENGMEDIAHANDLER_H

#define CVTENGMEDIAHANDLER_H

//  INCLUDES

#include <e32base.h>

#include <mvtprotocolhandler.h>

#include "MVtEngMedia.h"

#include "vtengcommands.h"

#include "CVtEngLocalVideo.h"

#include "MVtEngSettingObserver.h"

// FORWARD DECLARATIONS

class CVtEngLocalVideo;

class CVtEngRemoteVideo;

class MVtEngFrameObserver;

class CVtEngOperation;

class CVtEngExtensionBase;

// CLASS DECLARATION

/**

*  Media control.

*

*  @lib videoteleng.lib

*  @since Series 60 2.6

*/

NONSHARABLE_CLASS( CVtEngMediaHandler ) :

    public CBase,

    public MVtEngMedia,

    public MVtEngSettingObserver,

    public MVtProtocolHandler

    {

    public: // Constructor and destructor.

        /**

        * Symbian two-phase constructor.

        * @return media handler instance

        */

        static CVtEngMediaHandler* NewL();

        /**

        * Destructor.

        */

        ~CVtEngMediaHandler();

    public: // From MVtEngMedia.

        /**

        * @see MVtEngMedia

        */

        virtual TInt GetMediaState(

            const TMediaDirection aMediaDirection,

            TInt& aActiveMedia ) const;

        /**

        * @see MVtEngMedia

        */

        virtual TBool RenderingStarted(

            const TMediaDirection

            aDirection ) const;

        /**

        * @see MVtEngMedia

        */

        virtual TInt GetSource( TMediaSource& aSource ) const;

        /**

        * @see MVtEngMedia

        */

        virtual TInt GetSourcesCaps( TInt& aCaps ) const;

        /**

        * @see MVtEngMedia

        */

        virtual TInt GetCurrentCameraId( TCameraId& aId ) const;

        /**

        * @see MVtEngMedia

        */

        virtual TInt GetCameraInfo(

            const TCameraId aId,

            TCameraInfo& aInfo ) const;

        /**

        * @see MVtEngMedia

        */

        virtual TInt GetCurrentZoomStep( TInt& aCurrentStep );

        /**

        * @see MVtEngMedia

        */

        virtual TInt GetMaxZoomStep( TInt& aMaxZoomStep );

        /**

        * @see MVtEngMedia

        */

        virtual TInt GetMajorZoomStepCount( TInt& aCount );

        /**

        * @see MVtEngMedia

        */

        virtual void GetMajorZoomStep( TInt aIndex, TInt& aStep );

        /**

        * @see MVtEngMedia

        */

        virtual TInt GetFreezeSupported( TBool& aFreezeSupported ) const;

        /**

        * @see MVtEngMedia

        */

        virtual TInt GetFreezeState( TBool& aFrozen ) const;

        /**

        * @see MVtEngMedia

        */

        virtual TInt GetDsaState(

            const TMediaDirection aMediaDirection,

            TBool& aActive ) const;

        /**

        * @see MVtEngMedia

        */

        virtual TBool VideoCallConnected () const;

        /**

        * @see MVtEngMedia

        */

        virtual void GetVideoQuality( TVideoQuality& aVideoQuality ) const;

        /**

        * @see MVtEngMedia

        */

        virtual void GetObjectSharingState(

            TShareObjectState& aObjectSharingState ) const;

        /**

        * @ see MVtEngMedia

        */

        virtual void GetCameraOrientations(

            TCameraOrientation& aPrimaryCameraOrientation,

            TCameraOrientation& aSecondaryCameraOrientation ) const;

public: // New functions.

        /**

        * Tells if the Protocol initialization has completed.

        * @return ETrue if initialized

        */

        TBool ProtoInitialized() const;

        /**

        * Performs an operation in the handler.

        * @param operation to be performed on the handler

        */

        virtual void HandleL( CVtEngOperation& aOperation );

        /**

        * Returns if command can be performed by media handler.

        * @return KErrNone if a command can be perfomed

        *         KErrNotReady if not in appropriate state

        *         KErrNotSupported if command is not for media handler

        */

        TInt ValidateCommand( const TVtEngCommandId aCommand ) const;

        /**

        * Returns ETrue if video channel is closed.

        */

        TBool IsVideoChannelClosed() const;

        /**

         * Request update last remote video frame through MVtEngFrameObserver::vtSetFrame

         */

        void RequestLastRemoteFrame();        

    public: // from MVtProtocolHandler

        /**

        * Handles callback from protocol.

        * @param aResponse response

        */

        virtual void HandleSessionCommandEventL(const TVtCommandResponse& aResponse);

    public: // From MVtProtocolHandler.

        /**

        * Handles callback from protocol audiocontroller.

        * @param aId which command

        * @param aCmd which audio command

        * @param aContextData any additional data

        * @param aStatus how did it end up with

        */

        virtual void HandleAudioOutputControlCommandComplete(TInt aId,

            TVtAudioOutputControlCommand aCmd,

            TAny *aContextData,

            TInt aStatus);

    public: // From MVtProtocolHandler.

        /**

        * Handles event from protocol.

        * @param aEvent event

        */

        virtual void HandleSessionInformationalEventL(

            const TVtIndicationEvent& aEvent);

    public: // from MVtProtocolHandler

        /**

        * Handles error event from protocol.

        * @param aEvent error event

        */

        virtual void HandleSessionErrorEventL(const TVtErrorEvent& aEvent);

    public: // from MVtEngSettingObserver

        /**

        * Handles shared data setting change.

        * @param aId setting id

        * @param aValue setting value

        */

        virtual void HandleSettingChangedL(

            CVtEngSettings::TSettingId aId,

            const TDesC& aValue );

    public: // From MVtProtocolHandler.

        /**

        * @see MVtProtocolHandler.

        */

        void HandleVideoEncoderCommandCompletedL(

            const TVtCommandResponse& aResponse );

        /**

        * @see MVtProtocolHandler.

        */

        void HandleVideoEncoderInformationalEventL(

            const TVtIndicationEvent& aEvent);

    public: // From MVtProtocolHandler

        /**

        * @see MVtProtocolHandler.

        * @since 3.1

        */

        void HandleH324MConfigCommandCompletedL( const TVtCommandResponse& aResponse );

        /**

        * @see MVtProtocolHandler.

        * @since 3.1

        */

        void HandleH324MConfigInformationalEventL(

            const TVtIndicationEvent& aEvent );

    public: // New functions.

        /**

        * Initializes media handler.

        * @param aStatus signaling handle

        */

        void InitializeL( TRequestStatus& aStatus );

        /**

        * Cancels media handler initialization.

        */

        void CancelInitialize();

        /**

        * Initializes default blank provider.

        * @param aStatus signaling handle

        */

        void InitializeProviderL( TRequestStatus& aStatus );

        /**

        * Cancel Image sharing initialization.         

        */        

        void CancelInitializeShareImage();

        /**

        * Sets protocol interface.

        * aProto2Way protocol interface

        */

        void SetSessionCommand( MVtSessionCommand* aProto2Way );

        /**

        * Unitializes media handler.

        * @param aStatus request semaphore to complete

        * when uninitialization is complete

        */

        void Uninitialize( TRequestStatus& aStatus );

        /**

        * Goes to next step of uninitialization process, it can

        * be one of following

        * - Cancel all Protocol commands

        * - Protocol disconnect

        * - Protocol reset

        * - Switch blank provider.

        */

        void UninitializeNextStep();

        /**

        * Sets selected camera ID.

        * @param aId camera ID (primary or secondary)

        * @param aUpdateRequired if ETrue switch could not be performed

        *        Switch will be done when engine has been initialized.

        */

        void SetSelectedCameraId(

            const TCameraId aId,

            TBool aUpdateRequired = EFalse );

        /**

        * Handles source initialization or switch.

        * @param aResult Symbian OS error code

        */

        void HandleLocalVideoOperationCompleteL( const TInt aResult );

        /**

        * SDK init info.

        * @return Protocol initialization info

        */

        TVtInitInfo& SdkInitInfo();

        /**

        * Returns protocol state maintained by VTEngine, not by Protocol.

        * @return state

        */

        MVtProtocolCommand::TVtProtocolState ProtoState();

        /**

        * Sets up video connection to remote terminal.

        * @return Symbian OS error code

        */

        TInt Connect();

        /**

        * Disconnects session.

        * @return Symbian OS error code

        */

        TInt Disconnect();

        /**

        * Adds video data source to protocol engine.

		* @param Video channel logical channel ID number.

        * @return Symbian OS error code

        */

        TInt AddVideoSource( TUint aChannelId );

        /**

        * Adds audio data source to protocol engine.

		* @param Audio channel logical channel ID number.

        * @return Symbian OS error code

        */

        TInt AddAudioSource( TUint aChannelId );

        /**

        * Adds video sink.

		* @param Video channel logical channel ID number.

        * @return Symbian OS error code

        */

        TInt AddVideoSink( TUint aChannelId );

        /**

        * Adds audio sink.

		* @param Audio channel logical channel ID number.

        * @return Symbian OS error code

        */

        TInt AddAudioSink( TUint aChannelId );

        /**

        * Sets the output volume for Protocol.

        * @param aVolume the level of the volume

        * @return Symbian OS error code

        */

        TInt SetVolume( const TInt aVolume,

            CVtEngOperation* aOperation = NULL );

        /**

        * Enables video when primary camera becomes available.

        * @param aEnable do we enable or disable

        * @return Symbian OS error code

        */

        TInt AutoEnableVideo( TBool aEnable = ETrue );

        /**

        * Deletes protocol instance and associated Protocol interfaces.

        */

        void FinalizeUninitialization();

        /**

        * Creates extension according to API Uid.

        * @since S60 v3.2

        * @param aUid extension API Uid.

        * @return Extension pointer

        * @exeption Leaves if creation fails

        *

        */

        CVtEngExtensionBase* CreateExtensionsL( const TUid& aUid );

        /**

        * Checks if there is already an operation pending.

        * @return KVtEngCommandNone if no operation is pending or Command identifier

        */

        TVtEngCommandId GetPendingCommand();

    private: // new functions

        /**

        * Sends a sync message to Protocol after provider switch.

        */

        void RequestFrame( );

        /**

        * Sets video quality

        */

        void SetVideoQualityL(

            const TVideoQuality aVideoQuality,

            const TBool aSetPeerVideoQuality );

        /**

        * Sets peer video quality

        */

        void SetPeerVideoQuality( const TVideoQuality aVideoQuality );

        /**

        * Check's flag's validity. If not valid, panic's in debug mode.

        * @param aFlag flag to check.

        */

        void AssertFlag( const TInt aFlag ) const;

        /**

        * Gets the version information from SysUtil

        * and sets it into Protocol.

        */

        void SetVersionInfoL();

        /**

        * Sets supported resolutions to Protocol.

        */

        void SetSupportedResolutions();

		/**

        * Sets used call setup enhancement parameters.

        */

		void SetFastCsupOptions();

        /**

        * Does Protocol reset.

        */

        void ResetProtoL();

        /**

        * Does the actual disconnecting with Protocol.

        */

        void DisconnectProtoL();

        /**

        * Sets the defaults for volumes.

        */

        void InitializeVolume();

        /**

        * Checks if a flag in iProtoInitFlags is set.

        * @return ETrue if flag is set

        */

        TBool IsFlag( const TInt aFlag ) const;

        /**

        * Sets a flag in iProtoInitFlags.

        * @param aFlag flag to set

        */

        inline void SetFlag( const TInt aFlag );

        /**

        * Clears a flag in iProtoInitFlags.

        * @param aFlag flag to clear

        */

        inline void ClearFlag( const TInt aFlag );

        /**

        * Requests the volume controller.

        * @return ETrue if retrieved ok

        */

        TBool RequestAudioControllerL();

        /**

        * Spatial trade off indication handling method. Indication is

        * sent by the peer every time when its spatial trade off is updated.

        * @param aLogicalChannelId Indication's logical channel Id.

        * @param aTradeOff Indication trade off value.

        */

        void HandleSpatialTradeoffIndication(

            const TUint16 aLogicalChannelId, const TUint8 aTradeOff );

        /**

        * Spatial trade off command handling method. Spatial trade off

        * command is sent by the peer whenever peer wants to adjust our

        * video quality.

        * @param aLogicalChannelId Command's logical channel Id.

        * @param aTradeOff New trade off value.

        */

        void HandleSpatialTradeoffCommandL(

            const TUint16 aLogicalChannelId, const TUint8 aTradeOff );

    private: // constructor and destructor

        /**

        * C++ default constructor.

        */