/*

* 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:  Class for managing intercommunication between Camcera UI*

*/

#ifndef CAMAPPCONTROLLER_H

#define CAMAPPCONTROLLER_H

// ===========================================================================

//  INCLUDES

#include <e32base.h>

#include <ProductVariant.hrh>

#include <cflistener.h> // publish zoom state related

#include <cfclient.h>

#include <sensrvdatalistener.h>

#include <sensrvchannel.h>

#include <sensrvorientationsensor.h>

#include "MCamAppController.h"

#include "CamControllerObservers.h"

#include "mcamsettingsmodelobserver.h"

#include "CamSettings.hrh"

#include "Cam.hrh"          // TCamSoundId

#include "CamSettingsInternal.hrh"

#include "mcamplayerobserver.h"

#include "CamImageSaveActive.h"

#include "CamCallStateAo.h"

#include "CamObserver.h"

#include "CamBurstModeObserver.h"

#include "CamPerformance.h"

#ifndef __WINSCW__

#include <rlocationtrail.h>

#endif

#include "CamPropertyObserver.h"

// <CAMERAAPP_CAPI_V2_MIGRATION>

#include "mcamcameraobserver.h" 

#include "camcamerarequests.h"

#include "camfolderutility.h"

#include "camcameracontroller.h"

#include "CamDriveChangeNotifier.h"

#include "CamSyncRotatorAo.h"

// ===========================================================================

// CONSTANTS

// !Do not change the order of these without careful consideration!

// 

enum TCamCameraState

  {

  ECamCameraIdle          = 0,

  ECamCameraReserved      = 1 << 0,

  ECamCameraPowerOn       = 1 << 1,

  ECamCameraPreparedImage = 1 << 2,

  ECamCameraPreparedVideo = 1 << 3,

  ECamCameraStateLast // Not valid state, only marker

  };

/**

* Flags for ongoing operations

*/

enum TCamBusyFlags

  {

  EBusyNone     = 0,

  EBusyRequest  = 1<<0,

  EBusySequence = 1<<1,

  EBusySetting  = 1<<2,

  EBusyLast // Marker

  };

// ===========================================================================

// FORWARD DECLARATIONS

class CRepository;

//class CCamSettingsModelBase;

class MCamAppController;

class MCamSettingsModel;

class MCamSettingPreviewHandler;   // <CAMERAAPP_CAPI_V2_MIGRATION/>

//class CCamConstantSettingProvider; // <CAMERAAPP_CAPI_V2_MIGRATION/>

class CCamSettingProvider; // <CAMERAAPP_CAPI_V2_MIGRATION/>

class CCamTimer;

class CCamObserverHandler;

class CCamBurstCaptureArray;

class CCamAudioPlayerController;

class MCamStaticSettings;

class CCamGSInterface;

class CCameraUiConfigManager;

class CCamPropertyWatcher;

class CCamFlashStatus;

class CCamConfiguration;

class CCFClient;

// ===========================================================================

// CLASS DECLARATION

class TCamAppControllerInfo

  {

  public:

    TCamAppControllerInfo();

  public:

    TCamActiveCamera      iActiveCamera;

    TCamCameraMode        iMode;

    TCamCameraMode        iTargetMode;

    TCamImageCaptureMode  iImageMode; // ECamImageCaptureNone in video controller mode

    TCamImageCaptureMode  iTargetImageMode; 

    TCamCaptureOperation iOperation; // Current operation 

    // Target viewfinder state and mode

    TCamCameraTriState iTargetVfState;

    TBool              iViewfinderMirror; // set when viewfinder initialized

    // Target image parameters        

    TInt               iTargetImageResolution;

    TInt               iTargetImageQuality;

    // Target video parameters

    /** not supported yet */

    // Request being handled        

    TCamCameraRequestId iBusyRequestId;

  };

/**

* Handle intercommunication between camcorder UI and engine.

*

*  @since 2.8

*/

class CCamAppController : public CBase, 

                          public MCamAppController,

                          public MCamSettingsModelObserver,

                          public MCamCameraObserver,

                          public MCamImageSaveObserver,

                          public MCamCallStateObserver,

                          public MPropertyObserver,

                          public MSensrvDataListener,

                          public MCamPlayerObserver,

                          public MCamObserver,

                          public MCamBurstModeObserver,

                          public MCFListener

                          ,public MCamDriveChangeNotifierObserver

                          ,public MBitmapRotationObserver 

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        * @since 2.8

        * @return pointer to the created CCamAppController object

        */

        static CCamAppController* NewL();

        /**

        * Complete construction of the engine and issue notification requests.

        * The camera engine cannot be instantiated until the application

        * orientation has been set by the CCamAppUi. This does not

        * exist when the CCamAppController is constructed. CompleteConstructionL

        * must be called in the CCamAppUi::ConstructL()

        * @since 3.0

        */ 

        void CompleteConstructionL();

        /**

        * Destructor.

        * @since 2.8

        */

        virtual ~CCamAppController();

   public:		

     /** 

      * Calls CamSettingModel to save user defined FT setting

      * @since S60 5.0

      * @param None

      * @return None

      */

      void StoreFaceTrackingValue();		

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

  // From MCamCameraObserver

  public:

    virtual void HandleCameraEventL( TInt              aStatus, 

                                     TCamCameraEventId aEventId, 

                                     TAny*             aEventData /*= NULL*/ );

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

  // from MCamSettingsModelObserver 

  public:

    virtual void IntSettingChangedL( TCamSettingItemIds aSettingItem, 

                                     TInt               aSettingValue );

    virtual void TextSettingChangedL( TCamSettingItemIds aSettingItem, 

                                      const TDesC&       aSettingValue );

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

  // from MCamBurstModeObserver

    /**

    * Burst mode activation has changed

    * @since 2.8

    * @param aActive whether or not burst mode is active

    * @param aStillModeActive whether or not still capture is active

    */

    virtual void BurstModeActiveL( TBool aActive, TBool aStillModeActive );

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

  // from MCamAudioPlayerObserver

    virtual void PlayComplete( TInt aStatus, TInt aSoundId );

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

  public:

    // From MCFListener ( Context framework for publishing zoom state.

    /**

    * Indicates a change in context for subscribed clients.

    * If client has subscribed to partial context class path,

    * only the changed context will be indicated.

    * 

    * @since S60 4.0

    * @param aIndication: Context indication.

    * @return None

    */

    inline void ContextIndicationL(

            const CCFContextIndication& /*aChangedContext*/ ) {};

    /**

    * Indicates that specified action is needed to be executed.

    * When action indication is received certain rule has been triggered

    * and action is needed to be performed.

    *

    * @since S60 4.0

    * @param aActionToExecute Action indication.

    * @return None

    */

    inline void ActionIndicationL(

        const CCFActionIndication& /*aActionToExecute*/ ) {};

    /**

    * Indicates that error has occured.

    * @since S60 4.0

    * @param aError Error code.

    * @return None

    */

    inline void HandleContextFrameworkError( TCFError /*aError*/,

            const TDesC& /*aSource*/,

            const TDesC& /*aType*/ ){};

    /**

    * Returns an extension interface.

    * The extension interface is mapped with the extension UID.

    *

    * If the client does not support the requested interface,

    * client must return NULL. Otherwise client needs to return

    * the correct interface combined with the UID.

    *

    * @since S60 5.0

    * @param aExtensionUid: The identifier of the extension.

    * @return Pointer to the extension.

    */

   inline TAny* Extension( const TUid& /*aExtensionUid*/ ) const { return NULL; };

    // New Function

    /*

    * Method to publish the zoom key and setting the

    * value or the state to enabled or disabled.

    * @Paran aEnabled used to set the the state of zoom key

    * to be enabled or disabled.

    */

    void PublishZoomStateL( const TBool aEnabled );

  public: 

      /**

      * Returns whether or not the current profile is silent

      * @since 3.0

      * @return ETrue if current profile is silent

      */

      TBool IsProfileSilent();    

      /**

      * Returns whether or not we have touch screen support in the device

      * @return ETrue if device supports touch screen

      */

      TBool IsTouchScreenSupported();

      /**

      * Returns whether or not we have direct screen viewfinder support in the device

      * @return ETrue if device supports direct screen viewfinder

      */

      TBool IsDirectScreenVFSupported( TBool aPrimaryCamera = ETrue );

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

	//Helper function for making notification about deleted files

	//Added this method to do notification if files have been

	//deleted outside camera application and then camera is

	//put back to foreground in postcapture view.

	//Security note. Contents of the files might have been

	//changed when camera was in background.

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

	//

	void  MediaFileChangedNotification();

	TBool EngineRequestsPending() const; 	

    /**

    * Set settings restore to be done at earliest

    * convenient time.

    */

    void  SetSettingsRestoreNeeded();

    /**

    * Set the flag to indicate that the original values 

    * of remaining images is stored

    */

     void SetRemainingImageStored();

    /** 

    * Returns the flag that indicates if the original value 

    * of remaing images is stored or not.

    */    

     TBool IsRemainingImageStored() const;

    /** 

    * Return whether saving is still in progress.

    */    

    TBool IsSavingInProgress() const;

    /**

    * Return if settings restore is set pending.

    */

    TBool IsSettingsRestoreNeeded() const;

    void RestartTimeLapseTimerL();

    static TInt CamerasAvailable();

    /**

    * Is time lapse supported.

    * Value read from Central Repository.

    */

    TBool TimeLapseSupported();

    /**

    * Is time lapse supported.

    * Value read from Central Repository.

    */

    TBool AlwaysOnSupported();

    /**

    * Release version number.

    * Value read from Central Repository.

    */

    const TVersion& Version();

    /***

    * Can a new request be made to controller or not.

    * Shutdown may be requested at any moment.

    */

    TBool Busy() const;

    /**

    * Returns true if the last captured image was saved

    * @since 2.8

    * @return ETrue if the last captured image has been saved.

    */

    TBool SavedCurrentImage() const;

    /**

    * Rename image/video.

    * @since 2.8

    * @param aNewName the new name for the current capture array file.

    * @param aMode the current capture mode.

    * @return ETrue if the file has been renamed successfully. 

    */

    TBool RenameCurrentFileL( const TDesC&          aNewName, 

                              const TCamCameraMode& aMode    );

    /**

    * Add a controller observer.

    * @since 2.8

    * @param aObserver Pointer to an object implementing 

    *                   MCamControllerObserver

    * @return ?description

    */

    void AddControllerObserverL( const MCamControllerObserver* aObserver );

    /**

    * Remove a controller observer

    * @since 2.8

    * @param aObserver Pointer to the observer to remove. The object

    *                  does not have to be added as an observer.

    */

    void RemoveControllerObserver

        ( const MCamControllerObserver* aObserver );

    /**

    * Add camera observer.

    * Forwards call to CCamCameraController.

    * @see CCamCameraController for more details.

    */

    void AddCameraObserverL( const MCamCameraObserver* aObserver, 

                             const TUint&              aEventInterest );

    /**

    * Removes camera observer.

    * Forwards call to CCamCameraController.

    * @see CCamCameraController for more details.

    */

    void RemoveCameraObserver( const MCamCameraObserver* aObserver );

    void AddSettingsObserverL( const MCamSettingsModelObserver* aObserver );

    void RemoveSettingsObserver( const MCamSettingsModelObserver* aObserver );

    TBool CameraControllerBusy() const;

    TUint CameraControllerState() const;

    TCamCameraState       CameraState() const;

    TCamCameraMode        CurrentMode() const;

    TCamCameraMode        TargetMode() const;

    TCamImageCaptureMode  CurrentImageModeSetup() const;

    TCamCaptureOperation  CurrentOperation() const;

    TCamCaptureOperation  CurrentImageOperation() const;

    TCamCaptureOperation  CurrentVideoOperation() const;

    TCamImageCaptureMode  CurrentImageMode() const;

    TInt CaptureLimit() const;

    TInt CaptureLimitSetting() const;

    void SetCaptureLimitL( TInt aLimit );

    /**

    * From MBitmapRotationObserver

    * Notification of bitmap rotation complete events

    * @param aErr KErrNone if successful

    */

    void RotationCompleteL( TInt aErr );

private:

    void ReadVariantFlagsL();

    void SetMode( const TCamCameraMode& aNewMode );

    void SetTargetMode( const TCamCameraMode& aNewMode );

    void SetImageMode( const TCamImageCaptureMode& aNewMode );

    void SetTargetImageMode( const TCamImageCaptureMode& aNewMode );

    void SetOperation( TCamCaptureOperation aNewOperation, 

                       TInt                 aError = KErrNone );

    TCamCameraTriState ViewfinderTargetState() const;

public:

    /*

     *  Handle to Camera Ui Config Manager

     */

    CCameraUiConfigManager* UiConfigManagerPtr();

    /*

    * De-register harvester client events.

    */

    void DeRegisterHarverterClientEvents();

    /**

    * Return resource id for video viewfinder layout

    * @since 3.0

    * @param aResolution for current resolution

    * @return Resource id for video viewfinder layout

    */

    TInt VideoViewFinderResourceId( TCamVideoResolution aResolution );

    /**

    * Start the viewfinder for the specified mode

    * as soon as the engine is intialised

    * @since 2.8

    * @param aMode The viewfinder mode being entered

    */

    void EnterViewfinderMode( const TCamCameraMode& aMode );

    /**

    * ExitViewinderMode    

    * @since 2.8

    * @param aMode The viewfinder mode being exited

    */

    void ExitViewfinderMode( const TCamCameraMode& aMode );

    /**

    * FreezeViewFinder    

    * @since 2.8

    * @param aFreeze Whether or not the viewfinder is

    * being frozen after this frame

    */