/*

* Copyright (c) 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:  Dummy Camera Application Engine*

*/

#ifndef CAMERAAPPDUMMYENGINE_H

#define CAMERAAPPDUMMYENGINE_H

//  INCLUDES

#include <CaeEngine.h>

// FORWARD DECLARATIONS

class CCameraappDummyCallbackActive;

// CLASS DECLARATION  

/**

* Dummy Camera Application Engine interface 

*

*/

class CCameraappDummyEngine : public CCaeEngine

    {

    public: // Creation

        /**

        * A static (factory) function to create the class instance.

        * @since 2.1

        * @return Pointer to a fully constructed CCaeEngine object. 

        * Ownership is passed to the caller.

        */

        static CCaeEngine* NewL();

    };

class CCameraappDummyEngineImp : public CCameraappDummyEngine

    {

    public: // Creation

        static CCameraappDummyEngineImp* NewL();

        /**

        * Sets the Camera Application Engine observer.

        * @since 2.1

        * @param aObserver Reference to Camera Application Engine observer.

        * @return void

        */

        void SetCamAppEngineObserver( 

            MCamAppEngineObserver& aObserver );

        ~CCameraappDummyEngineImp();

    public: // General methods

        /**

        * Gets information about the supported Camera Application Engine and 

        * Camera features.

        * @since 2.1

        * @param aInfo Info about supported features.

        * @return void

        */

        void GetInfo( TCamAppEngineInfo& /*aInfo*/ ) const;

        /**

        * Initializes Camera Application Engine for still image capturing. 

        * Reserves the camera and switches the camera power on. 

        * Intialization must be done before all other operations, except 

        * SetCamAppEngineObserver and GetInfo. 

        * Calls observer method McaeoInitComplete().

        * @since 2.1

        * @param aCreateSnapImage Boolean indicating if "snap-images" 

        * should be created, leading to calls of McaeoSnapImageReady.

        * @return void

        */

        void InitL( TBool aCreateSnapImage = ETrue );

        /**

        * Initialize the engine for still image capturing. 

        * Switches also camera power on. 

        * Intialization must be done before all other operations, except 

        * SetCamAppEngineObserver and GetInfo. 

        * Calls observer method McaeoInitComplete().

        * @since 2.1

        * @param aSdUidStillQltyLevels Still capturing quality levels Shared Data initialization file UID.

        * @param aCreateSnapImage Boolean indicating if "snap-images" should be created 

        * leading to calls of McaeoSnapImageReady.

        * @return void

        */

        void InitL( TUid /*aSdUidStillQltyLevels*/, 

                            TBool /*aCreateSnapImage = ETrue*/ ){};

        /**

        * Initializes video recording. 

        * The initialization must be done before video recording operations.

        * @since 2.1

        * @return void

        */

        void InitVideoRecorderL(){};

        /**

        * Initializes video recording. 

        * The initialization must be done before video recording operations.

        * @since 2.1

        * @param aSdUidVideoQltyLevels Video recording quality levels Shared Data initialization file UID.

        * @return void

        */

        void InitVideoRecorderL( TUid /*aSdUidVideoQltyLevels*/ ){};

        /**

        * Reserves the camera into use and switches the camera power on. 

        * Calls observer method McaeoInitComplete().

        * @since 2.1

        * @return void

        */

        void Reserve();

        /**

        * Switches the camera power off and releases the camera.

        * @since 2.1

        * @return void

        */

        void Release(){};

        /**

        * Switches the camera power on. 

        * Calls observer method McaeoInitComplete().

        * @since 2.1

        * @return void

        */

        void PowerOn(){};

        /**

        * Switches the camera power off.

        * @since 2.1

        * @return void

        */

        void PowerOff(){};

    public: // Camera settings

        /**

        * Sets the zoom mode.

        * @since 2.1

        * @param aZoomMode Zoom mode to set.

        * @return void

        */

        void SetZoomModeL( TZoomMode /*aZoomMode = EZoomModeDigital*/ );

        /**

        * Gets the current zoom mode.

        * @since 2.1

        * @return The current zoom mode.

        */

        TZoomMode ZoomMode() const{ return EZoomModeDigital; };

        /**

        * Sets the zoom value.

        * @since 2.1

        * @param aZoomValue Index of the zoom factor to set.

        * @return void

        */

        void SetZoomValueL( TInt /*aZoomValue = 0*/ );

        /**

        * Gets the current zoom value.

        * @since 2.1

        * @return Index of the current zoom factor.

        */

        TInt ZoomValue() const;

        /**

        * Sets the brightness.

        * @since 2.1

        * @param aBrightness Brightness value in the range ECam.h SetBrightnessL allows.

        * @return void

        */

        void SetBrightnessL( TInt /*aBrightness = 0*/ ){}; 

        /**

        * Gets the current brightness setting.

        * @since 2.1

        * @return Brightness value.

        */

        TInt Brightness() const{ return 0; };

        /**

        * Sets the contrast.

        * @since 2.1

        * @param aContrast Contrast value in the range ECam.h SetContrastL allows.

        * @return void

        */

        void SetContrastL( TInt/* aContrast= 0*/ ){}; 

        /**

        * Gets the current contrast setting.

        * @since 2.1

        * @return Contrast value.

        */

        TInt Contrast() const{ return 0; };

        /**

        * Sets the exposure mode.

        * @since 2.1

        * @param aExposureMode Exposure mode in the range ECam.h SetExposureL allows.

        * @return void

        */

        void SetExposureModeL( 

            CCamera::TExposure /*aExposureMode = CCamera::EExposureAuto*/ ){};

        /**

        * Gets the current exposure mode.

        * @since 2.1

        * @return Exposure mode.

        */

        CCamera::TExposure ExposureMode() const{ return CCamera::EExposureAuto; };

        /**

        * Sets the white balance mode.

        * @since 2.1

        * @param aWhiteBalanceMode White balance mode in the range ECam.h SetWhiteBalanceL allows.

        * @return void

        */

        void SetWhiteBalanceModeL( 

            CCamera::TWhiteBalance /*aWhiteBalanceMode = CCamera::EWBAuto*/ ){};

        /**

        * Gets the current white balance mode.

        * @since 2.1

        * @return White balance mode.

        */

        CCamera::TWhiteBalance WhiteBalanceMode() const{ return CCamera::EWBAuto; };

        /**

        * Sets the flash mode.

        * @since 2.1

        * @param aFlashMode Flash mode in the range ECam.h SetFlashL allows.

        * @return void

        */

        void SetFlashModeL( 

            CCamera::TFlash /*aFlashMode = CCamera::EFlashNone*/ ){};

        /**

        * Gets the current flash mode.

        * @since 2.1

        * @return Flash mode.

        */

        CCamera::TFlash FlashMode() const{ return CCamera::EFlashNone; };

        /**

        * Resets to the default setting values.

        * Resets the following settings: exposure mode, white balance mode, 

        * zoom mode, zoom value, flash mode, brightness, and contrast. 

        * @since 2.1

        * @return void

        */

        void ResetToDefaultsL(){};

    public: // View finder

        /**

        * Sets/resets view finder image mirroring.

        * @since 2.1

        * @param aMirror Boolean indicating whether view finder image should be mirrored or not.

        * @return void

        */

        void SetViewFinderMirrorL( TBool /*aMirror = EFalse*/ ){};

        /**

        * Queries if view finder image mirroring is on.

        * @since 2.1

        * @return Boolean indicating whether view finder image is currently mirrored or not.

        */

        TBool ViewFinderMirror() const{ return EFalse; };

        /**

        * Starts the bitmap-based view finder.

        * The engine starts to call observer method McaeoViewFinderFrameReady() repeatedly.

        * @since 2.1

        * @param aSize Desired view finder size.

        * @return void

        */

        void StartViewFinderBitmapsL( TSize& aSize );

        /**

        * Starts the bitmap-based view finder.

        * The engine starts to call observer method McaeoViewFinderFrameReady() repeatedly.

        * @since 2.1

        * @param aSize Desired view finder size.

        * @param aCropRect Desired cropping/clipping rectangle.

        * @return void

        */

        void StartViewFinderBitmapsL(

            TSize& /*aSize*/, 

            TRect& /*aCropRect*/ ){};

        /**

        * Starts the direct screen access view finder.

        * @since 2.1

        * @param aWs Window server session.

        * @param aScreenDevice Software device screen.

        * @param aWindow Client-side handle to a server-side window.

        * @param aScreenRect Portion of screen in screen co-ordinates.

        * @return void

        */

        void StartViewFinderDirectL( 

            RWsSession& /*aWs*/, 

            CWsScreenDevice& /*aScreenDevice*/, 

            RWindowBase& /*aWindow*/, 

            TRect& /*aScreenRect*/ ){};

        /**

        * Starts the direct screen access view finder.

        * @since 2.1

        * @param aWs Window server session.

        * @param aScreenDevice Software device screen.

        * @param aWindow Client-side handle to a server-side window.

        * @param aScreenRect Portion of screen in screen co-ordinates.

        * @param aCropRect Desired cropping/clipping rectangle.

        * @return void

        */

        void StartViewFinderDirectL(

            RWsSession& /*aWs*/, 

            CWsScreenDevice& /*aScreenDevice*/, 

            RWindowBase& /*aWindow*/, 

            TRect& /*aScreenRect*/, 

            TRect& /*aCropRect*/ ){};

        /**

        * Stops the view finder.

        * @since 2.1

        * @return void

        */

        void StopViewFinder();

        /**

        * Queries if view finder is running.

        * @since 2.1

        * @return Boolean indicating whether view finder is running or not.

        */

        TBool IsViewFinding() const;

        /**

        * Gets the current view finder size.

        * @since 2.1

        * @param aSize View finder size.

        * @return void

        */

        void GetViewFinderSize( TSize& /*aSize*/ ){};

    public: // Still image capturing

        /**

        * Prepares Camera Application Engine for still image capture on 

        * specified quality level.

        * Calls observer method McaeoStillPrepareComplete().

        * @since 2.1

        * @param aStillQualityIndex Still image quality level index.

        * Imaging parameters linked to quality levels are defined by Shared Data ini-file. 

        * @return void

        */

        void PrepareStillCaptureL( TInt /*aStillQualityIndex*/ ){};

        /**

        * Prepares Camera Application Engine for still image capture on 

        * specified quality level.

        * Calls observer method McaeoStillPrepareComplete().

        * @since 2.1

        * @param aStillQualityIndex Still image quality level index. 

        * Can have values 0 ... TCamAppEngineInfo::iNumStillQualityLevelsSupported - 1

        * @param aCropRect Desired cropping/clipping rectangle.

        * @return void

        */

        void PrepareStillCaptureL( 

            TInt /*aStillQualityIndex*/, 

            const TRect& /*aCropRect*/ ){};

        /**

        * Prepares Camera Application Engine for still image capture with 

        * specified image size and format.

        * Calls observer method McaeoStillPrepareComplete().

        * @since 2.1

        * @param aSize Still image size.

        * @param aFormat Still image format.

        * @param aCompressionQuality Still image compression quality [0...100].

        * @return void

        */

        void PrepareStillCaptureL(

            const TSize& /*aSize*/, 

            CCamera::TFormat /*aFormat*/,  

            TInt /*aCompressionQuality*/ ){};

        /**

        * Prepares Camera Application Engine for still image capture with specified image size and format.

        * Calls observer method McaeoStillPrepareComplete().

        * @since 2.1

        * @param aSize Still image size.

        * @param aFormat Still image format.

        * @param aCompressionQuality Still image compression quality [0...100].

        * @param aCropRect Desired cropping/clipping rectangle.

        * @return void

        */

        void PrepareStillCaptureL(

            const TSize& /*aSize*/, 

            CCamera::TFormat /*aFormat*/,  

            TInt /*aCompressionQuality*/, 

            const TRect& /*aCropRect*/ ){};

        /**

        * Gets the current prepared still quality level index.

        * @since 2.1

        * @return Still quality level index.

        */

        TInt StillQualityIndex() const{ return 0; };

        /**

        * Gets the still image frame size for the specified quality level.

        * @since 2.1

        * @return void

        */

        void GetStillFrameSize(

            TInt /*aStillQualityIndex*/, 

            TSize& /*aSize*/ ) const{};

        /**

        * Gets the estimated still image size in bytes for the 

        * specified quality level.

        * @since 2.1

        * @return Estimated still capturing image size in bytes.

        */

        TInt EstimatedStillSizeInBytes( 

            TInt /*aStillQualityIndex*/ ) const{ return 0; };

        /**

        * Captures a still image or a still image burst.

        * Calls first observer method McaeoSnapImageReady() and then 

        * McaeoStillImageReady().

        * McaeoSnapImageReady() is not called if engine initialization 

        * has been done 

        * with parameter aCreateSnapImage == EFalse.

        * @since 2.1

        * @return void

        */

        void CaptureStill();

        /**

        * Cancels the on-going still image (single/burst) capture request.

        * @since 2.1

        * @return void

        */

        void CancelCaptureStill(){};

        /** 

        * Sets the size of the snap image bitmap.

        * @since 3.0

        * @param aSize The size of the snap bitmap. Corrected size is returned. 

        * @return void

        */

        void SetSnapImageSizeL(

            TSize& ){};

         /** 

        * Sets the color mode of the snap image bitmap

        * @since 3.0

        * @param aMode The color mode of the snap bitmap.

        * @return void

        */

        void SetSnapImageColorMode(

        TDisplayMode ){};

    public: // Video recording

        /**

        * Sets the file name for the video clip to be recorded.

        * @since 2.1

        * @param aVideoClipFileName File name.

        * @return void

        */

        void SetVideoRecordingFileNameL( 

            const TDesC& aVideoClipFileName );

        /**

        * Prepares Camera Application Engine for video recording on 

        * specified quality level.

        * Calls observer method McaeoVideoPrepareComplete().

        * @since 2.1

        * Can have values 0 ... TCamAppEngineInfo::iNumVideoQualityLevelsSupported - 1

        * @return void

        */

        void PrepareVideoRecordingL( TInt /*aVideoQualityIndex*/ ){};

        /**

        * Prepares Camera Application Engine for video recording with 

        * specified recording parameters.

        * Calls observer method McaeoVideoPrepareComplete().

        * @since 2.1

        * @return void

        */

        void PrepareVideoRecordingL( 

            const TSize& /*aFrameSize*/, 

            TReal32 /*aFrameRate*/, 

            TInt /*aBitRate*/, 

            TBool /*aAudioEnabled*/,

            const TDesC8& /*aMimeType*/, 

            const TDesC& /*aPreferredSupplier*/, 

            const TDesC8& /*aVideoType = KNullDesC8*/, 

            const TDesC8& /*aAudioType = KNullDesC8*/ ){};

         /**

        * Closes (prepared) video recording to free resources.

        * @since 2.1

        * @return void

        */

        void CloseVideoRecording(){};

        /**

        * Gets the current prepared video quality level index.

        * @since 2.1

        * @return Video quality level index.