// Copyright (c) 2005-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:

//

/**

 @file

 @publishedPartner

 @released

*/

#ifndef  ECAMADVSETTINGSINTF_H

#define  ECAMADVSETTINGSINTF_H

#include <ecamadvsettings.h>

#include <ecam/ecamimageprocessingintf.h>

#include <ecam/ecamadvsettingsintfuids.hrh>

/** This is the UID which is used to obtain the interface MCameraPresets, via the 

CCamera::CustomInterface() call, which provides implementation of the M-class interface.

 */   

static const TUid KECamMCameraPresetsUid 			=  {KECamMCameraPresetsUidValue};

/** 

This is the UID which is used to obtain the interface MCameraPresets2, via the 

CCamera::CustomInterface() call, which provides implementation of the M-class interface. 

@publishedPartner

@prototype 

*/   

static const TUid KECamMCameraPresets2Uid 			=  {KECamMCameraPresets2UidValue};

/** This is the UID which is used to obtain the interface MCameraAdvancedSettings, via the 

CCamera::CustomInterface() call, which provides implementation of the M-class interface. */   

static const TUid KECamMCameraAdvancedSettingsUid 	=  {KECamMCameraAdvancedSettingsUidValue};

/** This is the UID which is used to obtain the interface MCameraAdvancedSettings2, via the 

CCamera::CustomInterface() call, which provides implementation of the M-class interface. */   

static const TUid KECamMCameraAdvancedSettings2Uid 	=  {KECamMCameraAdvancedSettings2UidValue};

/** 

This is the UID which is used to obtain the interface MCameraAdvancedSettings3, via the 

CCamera::CustomInterface() call, which provides implementation of the M-class interface.

*/   

static const TUid KECamMCameraAdvancedSettings3Uid 	=  {KECamMCameraAdvancedSettings3UidValue};

/** 

This is the UID which is used to obtain the interface MCameraAdvancedSettings4, via the 

CCamera::CustomInterface() call, which provides implementation of the M-class interface.

@publishedPartner

@prototype 

*/   

static const TUid KECamMCameraAdvancedSettings4Uid 	=  {KECamMCameraAdvancedSettings4UidValue};

/** 

This is the UID which is used to obtain the interface MCameraContinuousZoom, via the 

CCamera::CCameraAdvancedSettings::CreateContinuousZoomImpl() call, which provides 

implementation of the M-class interface.

@internalTechnology

@prototype 

*/   

static const TUid KECamMCameraContinuousZoomUid 	=  {KECamMCameraContinuousZoomUidValue};

/** 

Mixin class for implementation by providers of the Advanced Settings Camera Extension API.

CCamera advanced settings class exposes an API for controlling individually 

digital camera advanced settings. These settings directly relate to the 

image acquisition phase both for still images and video.

@publishedPartner

@released 	

*/	

class MCameraAdvancedSettings

	{

public:

	/** 

	Releases the interface. 

	*/

	virtual void Release()=0;

   	/** 

	Gets the type of this camera. 

	@see TCameraType

	@return a TCameraType value. 

	*/

  	virtual CCamera::CCameraAdvancedSettings::TCameraType CameraType() const=0;

  	/** 

	Get the type of a specific  camera denoted by its index. A pluggable camera

	may not necessarily be physically present. The type denotes whether the slot allocated

	to that index is for pluggable or onboard camera. 

    @param aCameraIndex

           An integer in the range of [0: CCamera::CamerasAvailable()-1].

	@return the TCameraType value for the specific camera. 

	        If the index is out of range, the return value is ECameraUnknown.

	*/

	virtual CCamera::CCameraAdvancedSettings::TCameraType CameraType(TInt aCameraIndex) const=0;

   	/** 

	Checks whether the current camera is present.

	@return Whether the camera is currently present. 

			ETrue if camera is present, EFalse otherwise. 

			For example ECameraOnBoard (built-in) cameras are always present.   

	*/	

	virtual TBool IsCameraPresent() const=0;

	/** 

	Checks whether the camera, denoted by its index, is currently present.

	The index uniquely identifies the camera on the device.

    @param aCameraIndex

           An integer in the range of [0:CCamera::CamerasAvailable()-1] specifying the

	       camera device to use

	@return Whether the camera is currently present. 

			ETrue if camera is present, EFalse otherwise. 

			For example built-in (ECameraOnBoard) cameras 

			are always present. 

	*/	

   	virtual TBool IsCameraPresent(TInt aCameraIndex) const=0;

    /**

    Gets current camera index. The index uniquely identifies the camera on the device.

	@return camera index in the inclusive range of [0:CCamera::CamerasAvailable() - 1].

    */

  	virtual TInt CameraIndex() const=0;	

    /** 

	Gets all of the supported stabilization modes on the device. The result is a bitfield

	of the valid TStabilizationMode flags. 

	@return a bitfield of all supported stabilization modes. 

	*/

    virtual TInt SupportedStabilizationModes() const=0;

    /** 

	Gets current stabilization mode on the device. 

	The result is a valid TStabilizationMode value. 

	@return current stabilization mode of type TStabilizationMode. 

	*/

    virtual CCamera::CCameraAdvancedSettings::TStabilizationMode StabilizationMode() const=0;

    /** 

	Sets a specific stabilization mode on the device.

	Stabilization mode change fires a KUidECamEventCameraSettingStabilizationMode

	event to all MCameraObserver2 clients of this specific camera.

	@param aStabilizationMode

	       new stabilization mode of TStabilizationMode type.

	*/

    virtual void SetStabilizationMode(CCamera::CCameraAdvancedSettings::TStabilizationMode aStabilizationMode)=0;

    /** 

	Gets all of the supported focus modes on the device. The result is a bitfield

	of the valid TFocusMode flags. 

	@return a bitfield of all supported focus modes. 

	*/

    virtual TInt SupportedFocusModes() const=0;

    /** 

	Gets current focus mode on the device. 

	The result is a valid TFocusMode value. 

	@return current focus mode. 

	*/

    virtual CCamera::CCameraAdvancedSettings::TFocusMode FocusMode() const=0;

    /** 

	Sets a specific focus mode on the device.

	Focus mode change fires a KUidECamEventCameraSettingFocusMode event

	to all MCameraObserver2 clients of the camera.

	@param aFocusMode 

	       new focus mode of TFocusMode type.

	*/

    virtual void SetFocusMode(CCamera::CCameraAdvancedSettings::TFocusMode aFocusMode)=0;

	/** 

	Gets all supported focus ranges on the device.

	@return an integer - a bitfield of all supported TFocusRange values. 

	*/

    virtual TInt SupportedFocusRanges() const=0;

    /** 

	Gets current focus range on the device.

	@return the current TFocusRange value. 

	*/

    virtual CCamera::CCameraAdvancedSettings::TFocusRange FocusRange() const=0;

    /** 

	Sets a specific focus range on the device.

	The focus range change fires both, KUidECamEventCameraSettingFocusRange and 

	KUidECamEventCameraSettingFocusRange2 event	to all MCameraObserver2 clients of the camera.

	@see KUidECamEventCameraSettingFocusRange

    @param aFocusRange

           newly selected focus range.

	*/

    virtual void SetFocusRange(CCamera::CCameraAdvancedSettings::TFocusRange aFocusRange)=0;

    /** 

	Gets all supported auto focus types on the device.

	@return an integer - a bitfield of all supported TAutoFocusType values. 

	*/

    virtual TInt SupportedAutoFocusTypes() const=0;

    /** 

	Gets current auto focus type on the device.

	@return a CCamera::TAutoFocusType value. 

	*/

    virtual CCamera::CCameraAdvancedSettings::TAutoFocusType AutoFocusType() const=0;

    /** 

	Sets a specific auto focus type on the device.

	The focus type change fires both, KUidECamEventCameraSettingAutoFocusType and 

	KUidECamEventCameraSettingAutoFocusType2 event to all MCameraObserver2 clients of the camera.

	@see KUidECamEventCameraSettingAutoFocusType

	@param aAutoFocusType

	       Autofocus selection.

    */

    virtual void SetAutoFocusType(CCamera::CCameraAdvancedSettings::TAutoFocusType aAutoFocusType)=0;

    /** 

	Gets all supported auto focus areas on the device.

	@return an integer - a bitfield of al supported TAutoFocusArea values. 

	*/

    virtual TInt SupportedAutoFocusAreas() const=0;

    /** 

	Gets current chosen auto focus area on the device.

	@return a CCamera::TAutoFocusArea value. 

	*/

    virtual CCamera::CCameraAdvancedSettings::TAutoFocusArea AutoFocusArea() const=0;

    /** 

	Sets a specific auto focus area on the device.

	Focus area change fires a KUidECamEventCameraSettingAutoFocusArea event

	to all MCameraObserver2 clients of the camera.

	@param aAutoFocusArea

	       Autofocus area selection.

    */

    virtual void SetAutoFocusArea(CCamera::CCameraAdvancedSettings::TAutoFocusArea aAutoFocusArea)=0;

    /**

    Get focus distance in millimetres.

    @return the current focus distance in millimetres, directly from user setting of lenses.

    */

	virtual TInt FocusDistance() const=0;

	/**

    Set focus distance in millimetres. Focus distance change fires a KUidECamEventCameraSettingFocusDistance event

    to all MCameraObserver2 clients of the camera.

    @param aDistance 

    		the current value in millimetres, directly from user setting of lenses.

    */

	virtual void SetFocusDistance(TInt aDistance)=0;

	/**

    Get minimum focus distance in millimetres. 

    @return the minimum (35 camera equivalent) focal length of a device. 

    @note Current Focal length is calculated as 

     		focalLength =  opticalZoom * minFocalLength;  

    */

	virtual TInt GetMinFocalLength() const=0;

	/**

    Gets the set of camera supported ISO rates.

    @param aSupportedIsoRates

           an array of integers which gets filled in with the supported ISO rates. 

    @note  When camera device is incapable of revealing the ISO rates supported, it has to be assumed that 

		   camera will work only on the parmanently set value. If this value is not known, empty array should be 

		   returned, and the corresponding getter/setters for this feature for this feature should not be used. 

    */

    virtual void GetSupportedIsoRatesL(RArray<TInt>& aSupportedIsoRates) const=0;

    /**

    Gets current ISO rate.

    @return current ISO rate as a TInt value.

    @note  In case there is an error, a negative error value from system wide error should be returned.

    */

    virtual TInt IsoRate() const=0;

    /**

    Set current ISO rate for the camera.

    Triggers a KUidECamEventCameraSettingIsoRate event to all MCameraObserver2 clients of the camera.

    @param aRate

    	   required new ISO rate.

    */

    virtual void SetIsoRate(TInt aRate)=0;

	/** 

	Gets the current discrete aperture steps (F-stops) supported by the device.

	@param  aFStops

	        A reference to an empty array of TInt which would be populated by the implementation with 

	        the specific supported values. If the array is empty on return, 

	        the camera supports all integer values in the aperture range. Each value is multiplied by 

	        a factor of KECamFineResolutionFactor.

	@param  aInfo 

	        a reference to TValueInfo, which establishes the type of the returned data.     

	@leave KErrNoMemory Out of memory.

	@note  When camera device is incapable of revealing the aperture openings supported, it has to be assumed that 

		   camera will work only on the parmanently set value. If this value is not known, empty array should be 

		   returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used.

 	*/

    virtual void GetAperturesL(RArray<TInt>& aFStops, TValueInfo& aInfo) const=0;

    /** 

    Get current aperture value.

    The default aperture value is ECAM implementation specific and could be either auto aperture or any other supported value.

    @return Current aperture value as an integer, multiplied by KECamFineResolutionFactor. 

    	    For example the function will return 280 for the actual aperture of F2.8.

    @note  In case there is an error, a negative error value from system wide error should be returned. 

    */

    virtual TInt Aperture() const=0; 

    /** 

    Set a new aperture value. 

    All MCameraObserver2 clients of the camera receive a KUidECamEventCameraSettingAperture 

    event notification when aperture value is changed.

    @note The aperture parameter value is an integer, multiplied by KECamFineResolutionFactor. 

    	  For example to set an aperture of F2.8, call SetAperture(280).

    @param aFStop 

    	   a new aperture value in the supported by the device range.       

    */

    virtual void SetAperture(TInt aFStop)=0; 

	/**

	Gets the set of supported shutter speeds

	@param aShutterSpeeds

			a reference to an RArray of TInt representing the discrete shutter speeds supported 

			currently by the device.

	@param  aInfo 

			a reference to TValueInfo, which establishes the type of the returned data.     

	@return the populated array with all shutter speeds in microseconds. 

	@leave KErrNoMemory Out of memory.

	@note  When camera device is incapable of revealing the shutter speeds supported, it has to be assumed that 

		   camera will work only on the parmanently set value. If this value is not known, empty array should be 

		   returned and TValueInfo should be ENotActive, and the corresponding getter/setters for this feature should not be used.

	*/

	virtual void GetShutterSpeedsL(RArray<TInt>& aShutterSpeeds, TValueInfo& aInfo) const=0; 

	/**

	Gets the current shutter speed

	@return the current shutter speed in microseconds. 

	@note  In case there is an error, a negative error value from system wide error should be returned.

	*/

    virtual TInt ShutterSpeed() const=0; 

    /**

	Sets the current shutter speed. When set, all MCameraObserver2 clients of the camera

	receive a KUidECamEventCameraSettingShutterSpeed event

	@param aShutterSpeed

	       the required shutter speed in microseconds.

	*/

    virtual void SetShutterSpeed(TInt aShutterSpeed)=0; 

	/**

	Get all supported metering modes on this device represented as bitfield of type TMeteringMode.

	@return the set of supported metering modes.

	*/

    virtual TInt SupportedMeteringModes() const=0;

    /**

    Get current metering mode.

    @return a value of type TMeteringMode.

    */

    virtual CCamera::CCameraAdvancedSettings::TMeteringMode MeteringMode() const=0;

    /**

    Set the current metering mode. When set, all MCameraObserver2 clients are notified 

    with a KUidECamEventCameraSettingMeteringMode event.

    @param aMeteringMode

    		a new selection for metering mode of type TMeteringMode.

    */

    virtual void SetMeteringMode(CCamera::CCameraAdvancedSettings::TMeteringMode aMeteringMode)=0;

    /** 

    Get all supported drive modes as bitfields of TDriveMode type. 

    @return the set of supported drive modes.

    */

    virtual TInt SupportedDriveModes() const=0;

    /** 

    Gets currently active drive mode.

    @return current drive mode.

    */

    virtual CCamera::CCameraAdvancedSettings::TDriveMode DriveMode() const=0;

    /**

    Set the current metering mode. When set all MCameraObserver2 clients are notified with a

    KUidECamEventCameraSettingDriveMode event. 

    @param aDriveMode

    		new selection for drive mode value of type TDriveMode.

    @note  Unless reduced Latency scheme is not used (ie CaptureImageL(TInt aSequenceNumber) or PerformantStopVideoCaptureL())

	   	   if an image/video capture is still outstanding, this method may report error KErrInUse.

    */

    virtual void SetDriveMode(CCamera::CCameraAdvancedSettings::TDriveMode aDriveMode)=0;

	/**

	Get all supported bracket modes as bitfields.

	@return the set of all supported bracket modes.

	*/

    virtual TInt SupportedBracketModes() const=0;

    /**

	Get current bracket mode.

	@return the current bracket mode TBracketMode.

	*/

    virtual CCamera::CCameraAdvancedSettings::TBracketMode BracketMode() const=0;

    /**

    Set new bracket mode. All MCameraObserver2 clients are notified with a

    KUidECamEventCameraSettingBracketMode event. 

    @param aBracketMode

    		new selection for bracket mode of type TBracketMode.

    */

    virtual void SetBracketMode(CCamera::CCameraAdvancedSettings::TBracketMode aBracketMode)=0;

 	/**

	Get all supported bracket parameters as bitfields.

	@return the set of all currently supported bracket modes.

	*/

    virtual TInt SupportedBracketParameters() const=0;

    /**

	Get current bracket parameter.

	@return the current bracket mode TBracketParameter.

	*/

    virtual CCamera::CCameraAdvancedSettings::TBracketParameter BracketParameter() const=0;

    /**

    Set new bracket parameter

    When set all clients are notified with a

    KUidECamEventCameraSettingBracketParameter event. 

    @param aBracketParameter

    		new selection for parameter type of type TBracketParameter.

    */

    virtual void SetBracketParameter(CCamera::CCameraAdvancedSettings::TBracketParameter aBracketParameter)=0;

	/**

	Get all supported bracket steps as bitfields.

	@return the set of all supported bracket modes.

	*/

    virtual TInt SupportedBracketSteps() const=0;

    /**

	Get current bracket step.

	@return the current bracket mode TBracketStep.

	*/

    virtual CCamera::CCameraAdvancedSettings::TBracketStep BracketStep() const=0;

    /**

    Set new bracket step. All MCameraObserver2 clients are notified with 

    KUidECamEventCameraSettingBracketStep. 

    @param aBracketStep

    		new selection for step of type TBracketStep.

    */

    virtual void SetBracketStep(CCamera::CCameraAdvancedSettings::TBracketStep aBracketStep)=0;

    /** 

	Gets the settings for which frames to merge. Valid only in EDriveModeBracketMerge mode.