/*

* 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:  Local video handler.

*

*/

#ifndef CVTENGLOCALVIDEO_H

#define CVTENGLOCALVIDEO_H

//  INCLUDES

#include <e32base.h>

#include <capivideosource.h>

#include "TVtEngRendering.h"

#include "TVtEngRenderingDSA.h"

#include "TVtEngRenderingDP.h"

#include "TVtEngRenderingNGA.h"

#include "VtEngEvents.h"

#include "MVtEngMedia.h" //TMediaSource

#include "MVtEngSettingPSObserver.h"

#include "CVTEngPubSubsListener.h"

#include "mvtengcamerapreferencesobserver.h"

#include "graphics/surfacemanager.h"

#include "graphics/surface.h"

#include "graphics/surfaceupdateclient.h"

// FORWARD DECLARATIONS

class CVSDataProvider;

class CVtEngMediaHandler;

class CVtEngCameraPreferences;

// LOCAL CONSTANTS

// Default source width.

static const TInt KVtEngLocalVideoDefaultWidth = 176;

// Default source height.

static const TInt KVtEngLocalVideoDefaultHeight = 144;

// CLASS DECLARATION

/**

*  Local (uplink) video handling.

*

*  @lib videoteleng.lib

*  @since Series 60 2.6

*/

NONSHARABLE_CLASS( CVtEngLocalVideo ) :

    public CActive,

    public MVSDataProviderObserver,

    public MVSDataSourceObserver,

    public MVSControllerObserver,

	public MVtEngSettingPSObserver

    {

    public:  // Constructors and destructor

        /**

        * Symbian two-phase constructor.

        * @param aObserver callback interface to Media Handler

        * @return local video instance

        */

        static CVtEngLocalVideo* NewL(

            CVtEngMediaHandler& aObserver );

        /**

        * Destructor.

        */

        virtual ~CVtEngLocalVideo();

    public: // Public data structures

        enum TVtEngProviderType

            {

            KVtEngProviderUndefined  = -1,

            /** Blank imnage provider */

            KVtEngProviderNone       = 0,

            /** Primary camera provider */

            KVtEngProviderCam1,

            /** Secondary camera provider */

            KVtEngProviderCam2,

            /** GS image provider */

            KVtEngProviderImage,

            /** ? */

            KVtEngProviderTempImage,

            /** Still share provider */

            KVtEngProviderShareImage,

            /** Video share provider */

            KVtEngProviderShareVideoClip,

            /** Default image provider */

            KVtEngProviderDefaultStillImage

            };

    public: // from MVSDataProviderObserver

        /**

        * @see MVSDataProviderObserver::vsProviderError

        */

        virtual void vsProviderError( TInt aError );

        /**

        * @see MVSDataProviderObserver::vsProviderReady

        */

        virtual void vsProviderReady();

        /**

        * @see MVSDataProviderObserver::vsViewFinderFrameReady

        */

        virtual void vsViewFinderFrameReady( CFbsBitmap& aFrame );

    public: // from MVSDataSourceObserver

        /**

        * @see MVSDataSourceObserver::vsProviderSwitchDone

        */

        virtual void vsProviderSwitchDone( CVSDataProvider* aOldProvider );

    public: // from MVSControllerObserver

        /**

        * @see MVSControllerObserver::vsProvidersChanged

        */

        void vsProvidersChanged( TBool aAttached );

    public: // From MVtEngSettingPSObserver.

        /** @see MVtEngSettingPSObserver */

        virtual void HandleNotifyPSL( const TUid aUid,

                const TInt& aKey, const TRequestStatus& aStatus );

    public:  // New functions

        /**

        * Pauses frame sending from video source (this method is called when

        * VT is initializing and video source has not yet been added to stack)

        *

        */

        void PauseVideoSending();

        /**

        * Resumes frame sending from video source.

        *

        */

        void ResumeVideoSending();

        /**

        * Tells if the provider has started viewfinder.

        * @return ETrue if started

        */

        TBool ViewFinderStarted() const;

        /**

        * Tells if the provider has been frozen.

        * @return ETrue if frozen

        */

        TBool IsFrozen() const;

        /**

        * Creates an audio source.

        * @return an error code

        */

        TInt CreateAudioSource();

        /**

        * Sets configuration for view finder.

        * @param aParams view finder configuration

        */

        void SetViewFinderParameters( const TVtEngRenderingOptions& aParams );

        /**

        * Sets DSA configuration for view finder.

        * @param aDSA DSA configuration

        */

        void SetViewFinderParameters( const TVtEngRenderingOptionsDSA& aDSA );

        /**

        * Sets DP configuration for view finder.

        * @param aDP DP configuration

        */

        void SetViewFinderParameters( const TVtEngRenderingOptionsDP& aDP );

        /**

        * Sets NGA configuration for view finder.

        * @param aNGA NGA configuration

        */

        void SetViewFinderParameters( const TVtEngRenderingOptionsNGA &aNGA );

        /**

        * Sets default still image.

        */

        void SetDefaultStillImageL();

        /**

        * Sets still image or none.

        * @param aSetAsActive sets as active provider

        */

        void SetStillImageL( TBool aSetAsActive );

        /**

        * Initializes default blank provider.

        */

        void InitializeL();

        /**

        * Selects camera1, camera2, still image or none as source.

        * @param aSource video source

        * @return ETrue if selecting started

        */

        TBool SelectSourceL( TVtEngProviderType aSource );

        /**

        * Returns currently active video provider.

        * @return provider type

        */

        TVtEngProviderType ActiveProvider( ) const;

        /**

        * Starts view finder if it was started earlier and current state is

        * ELocReady.

        */

        void StartViewFinderIfWasStartedL();

        /**

        * Starts view finder. Uses either DSA or WS depending on

        * which configuration is active.

        * @param aClientRequest request issued by user

        */

        void StartViewFinderL( TBool aClientRequest = EFalse );

        /**

        * Stops view finder.

        * @param aClientRequest request issued by user

        */

        void StopViewFinder( TBool aClientRequest = EFalse );

        /**

        * Freeze video sending (i.e. start sending last frame only).

        */

        void FreezeL();

        /**

        * Unfreeze video sending (i.e. resume sending).

        */

        void UnfreezeL();

        /**

        * Checks that all other providers don't have

        * view finder active and stops if found.

        * @param aProvider provider that should not be stopped

        */

        void CheckOthersStopped( const CVSDataProvider& aProvider );

        /**

        * Returns video source.

        * @return video source

        */

        MVTVideoSource* Source() const;

        /**

        * Returns audio source.

        * @return audio source

        */

        MVTAudioSource* AudioSource() const;

        /**

        * Gets media state.

        * @param aActiveMedia returns active TMediaType

        * @return Symbian OS error code

        */

        TInt GetMediaState( TInt& aActiveMedia );

        /**

        * Gets source type.

        * @return media source type

        */

        MVtEngMedia::TMediaSource GetMediaSource();

        /**

        * Gets source capabilities.

        * @param aCaps capability of providers

        * @return Symbian OS error code

        */

        TInt GetSourceCaps( TInt& aCaps );

        /**

        * Sets boolean to indicate if the provider is to be initialized only.

        * Selected camera is not necessary activated. If current media is

        * other than camera, initialization can be done on the background.

        * @param aInitOnly boolean value stating if to initialize only

        */

        void InitializeOnly( TBool aInitOnly = ETrue );

        /**

        * Sets boolean to indicate if the provider is to be initialized only.

        * @param aInitOnly boolean value stating if to initialize only

        */

        void InitializeOnlyEx( TBool aInitOnly = ETrue );

        /**

        * Indicates if camera provider is initialized.

        * @param aId provider ID

        * @param aInitialized

        * @return Symbian OS error code

        */

        TInt IsInitialized( MVtEngMedia::TCameraId aId, TBool& aInitialized );

        /**

        * Gets camera info.

        * @param TCameraId camera ID

        * @param aInfo camera info

        * @return Symbian OS error code

        */

        TInt GetCameraInfo( MVtEngMedia::TCameraId aId,

            MVtEngMedia::TCameraInfo& aInfo );

        /**

        * Gets current digital zoom step (Factor in VS camera terminology).

        * @param aCurrentStep current zoom step

        * @return Symbian OS error code

        */

        TInt GetDigitalZoomFactor( TInt& aCurrentStep );

        /**

        * Gets maximum digital zoom value that may be passed to camera.

        * @param aMaxZoomStep maximum zoom step

        * @return Symbian OS error code

        */

        TInt GetMaxDigitalZoomStep( TInt& aMaxZoomStep );

        /**

        * Gets number of major zoom level leaps.

        * One to maximum digital zoom steps plus one.

        * Less than or equal to maximum digital zoom steps plus one.

        * @param aCount number of leaps

        * @param aProviderSupplied use original or mapped

        * @return Symbian OS error code

        */

        TInt GetMajorDigitalZoomStepCount( TInt& aCount,

            TBool aProviderSupplied = EFalse );

        /**

        * Maps major zoom leap step to corresponding step index.

        * @param aIndex major zoom step

        * @param aStep zoom step

        */

        void GetMajorDigitalZoomStep( const TInt aIndex, TInt& aStep );

        /**

        * Sets video provider's digital zoom step.

        * @param aDigitalZoomFactor step

        */

        void SetDigitalZoomFactorL( TInt aDigitalZoomFactor );

        /**

        * Gets video provider's freeze support.

        * @param aFreezeSupported Freeze support status

        * @return KErrNotReady if provider not initialized.

        */

        TInt GetFreezeSupported( TBool& aFreezeSupported ) const;

        /**

        * Returns ETrue if it is ok to freeze provider.

        */

        TBool OkToFreeze() const;

        /**

        * Returns ETrue if it is ok to unfreeze provider.

        */

        TBool OkToUnfreeze() const;

        /**

        * Sets audio as muted.

        */

        void Mute();

        /**

        * Resumes audio output.

        */

        void UnMute();

        /**

        * Sets UI foreground state (i.e. is the Application

        * current active application or not).

        * @param aForeground ETrue if the VT application is

        * in foreground, EFalse otherwise.

        */

        void SetUIForeground( TBool aForeground );

        /**

        * Gets current media object sharing state. Only local video related

        * checks do here. Connection issues have been checked by

        * the caller.

        * @param aObjectSharingState On return contains current media object

        * sharing state. @see MVtEngMedia::TShareObjectState.

        */

        void GetObjectSharingState(

            MVtEngMedia::TShareObjectState& aObjectSharingState ) const;

        /**

        * Start Image sharing initialization.

        */

        void InitializeShareImageL(

            const MVtEngMedia::TShareObjectImageParameters& aParameters,

            TBool& aFirstTime );

        /**

        * Cancel Image sharing initialization.

        */        

        void CancelInitializeShareImage();

        /**

        * Start Image sharing.

        */

        void StartShareImageL();

        /**

        * Stop Image sharing.

        */

        void StopShareImageL();

        /**

        * Report error.

        */

        void ShareError( TInt aError );

        /**

        * Returns share's stored media source.

        */

        TVtEngProviderType ShareStoredSource() const;

        /**

        * General settings changed.

        */

        void SettingsChanged();

        /**

        * Creates camera preferences extension

        * @since S60 v3.2

        * @return pointer to extension

        * @exeption Leaves if creation fails

        */

        CVtEngCameraPreferences* CreateCameraPreferencesL();

        /**

        * Called when prepare camera has been handled in media handler.

        */

        void SetIsPrepareCameraCalled( TBool aCalled );

        /**

        * Returns ETrue if prepare camera has been handled in media handler,

        * EFalse otherwise.

        */

        TBool IsPrepareCameraCalled() const;

        /**

        * Reinitializes camera if onboard camera is being used as a provider.

        */

        void HandleLayoutChangeL();

        /**

        * Returns ETrue if delayed select is pending.

        */

        TBool IsDelayedSelectPending() const;

        /**

        * Completes operation to mediahandler.

        */

        void CompleteOperation( const TInt aResult );

        /**

        * Called when video channel is opened.

        */

        void VideoChannelOpenedL();

     private: // constructors

        /**

        * C++ constructor.

        * @param aObserver callback interface to Media Handler

        */

        CVtEngLocalVideo(

            CVtEngMediaHandler& aObserver );

        /**

        * By default Symbian 2nd phase constructor is private.

        */

        void ConstructL( );

        /**

        * Async callback method

        */

        static TInt CallBackFunc( TAny* aPtr );

        /**

        * Returns result.

        */

        TInt Result() const;

        /**

        * Sets result.

        */

        void SetResult( const TInt aResult );

    private:  // Rendering configuration

        /**

        * Options for window server rendering.

        *   iObserver callback interface

        *   iSize VF image size

        */

        struct TOptions

            {

            MVtEngFrameObserver* iObserver;

            TSize iSize;

            };

        /**

        * Direct screen access options.