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

 @publishedAll

 @released

*/

#ifndef ECAM_H

#define ECAM_H

#include <e32base.h>

#include <ecamuids.hrh>

#include <e32property.h>

#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <ecamdef.h>

#endif

class MFrameBuffer;

class RWsSession;

class CWsScreenDevice;

class RWindowBase;

class CFbsBitmap;

typedef TInt TPostCaptureControlId;

/** Specifies camera device information.

If either zoom or digital zoom are available then the appropriate entries

in this class will be set to indicate the range of values that they may take.

This should be implemented such that a setting of zero corresponds to no zoom,

and a step of one corresponds to the smallest increment available, in a linear

fashion.

There are also zoom factors that correspond to the actual zoom factor when

at minimum (non-digital only) and maximum zoom. Negative zoom values represent

macro functionality.

Image capture, if supported, is simply a case of transferring the current

image from the camera to the client via MCameraObserver::ImageReady(). The

camera class must set the iImageFormatsSupported bitfield to indicate the

formats available.

@publishedAll

@released

*/

class TCameraInfo

	{

public:

	/** Possible directions in which the camera may point.

	*/

	enum TCameraOrientation

		{

		/** Outward pointing camera for taking pictures.

		Camera is directed away from the user. */

		EOrientationOutwards,

		/** Inward pointing camera for conferencing.

		Camera is directed towards the user. */

		EOrientationInwards,

		/** Mobile camera capable of multiple orientations.

		Camera orientation may be changed by the user. */

		EOrientationMobile,

		/** Camera orientation is not known. */

		EOrientationUnknown

		};

	/** Various flags describing the features available for a particular implementation

	*/

	enum TOptions

		{

		/** View finder display direct-to-screen flag */

		EViewFinderDirectSupported		= 0x0001,

		/** View finder bitmap generation flag */

		EViewFinderBitmapsSupported		= 0x0002,

		/** Still image capture flag */

		EImageCaptureSupported			= 0x0004,

		/** Video capture flag */

		EVideoCaptureSupported			= 0x0008,

		/** View finder display mirroring flag */

		EViewFinderMirrorSupported		= 0x0010,

		/** Contrast setting flag */

		EContrastSupported				= 0x0020,

		/** Brightness setting flag */

		EBrightnessSupported			= 0x0040,

		/** View finder clipping flag */

		EViewFinderClippingSupported	= 0x0080,

		/** Still image capture clipping flag */

		EImageClippingSupported			= 0x0100,

		/** Video capture clipping flag */

		EVideoClippingSupported			= 0x0200

		};

public:

	/** Version number and name of camera hardware. */

	TVersion iHardwareVersion;

	/** Version number and name of camera software (device driver). */

	TVersion iSoftwareVersion;

	/** Orientation of this particular camera device. */

	TCameraOrientation iOrientation;

	/** Bitfield of TOptions available */

	TUint32 iOptionsSupported;

	/** The supported flash modes.

	This is a bitfield of CCamera::TFlash values. 

	If methods CCamera::New2L() or CCamera::NewDuplicate2L() are not used to create the CCamera object, it is assumed that the 

	application may not be able to cope with any future additions to the enum values. So, any unrecognised enum value passed 

    from the implementation should be filtered by ECAM Implementation.

    To receive unrecognised/extra added enum values, application should rather use CCamera::New2L() or CCamera::NewDuplicate2L() 

    to create camera object. This is an indication to ECAM implementation. In this case, application is assumed 

    to be prepared to receive unrecognised enum values.

    @see CCamera::CCameraAdvancedSettings::SupportedFlashModes()

	*/

	TUint32 iFlashModesSupported;

	/** The supported exposure modes.

	This is a bitfield of CCamera::TExposure values. */

	TUint32 iExposureModesSupported;

	/** The supported white balance settings.

	This is a bitfield of of CCamera::TWhiteBalance values. 

	If methods CCamera::New2L() or CCamera::NewDuplicate2L() are not used to create the CCamera object, it is assumed that the 

	application may not be able to cope with any future additions to the enum values. So, any unrecognised enum value passed 

    from the implementation should be filtered by ECAM Implementation.

    To receive unrecognised/extra added enum values, application should rather use CCamera::New2L() or CCamera::NewDuplicate2L() 

    to create camera object. This is an indication to ECAM implementation. In this case, application is assumed 

    to be prepared to receive unrecognised enum values.

    Refer to CCamera::CCameraAdvancedSettings::SupportedWhiteBalanceModes() implementation

    @see CCamera::CCameraAdvancedSettings::SupportedWhiteBalanceModes()

	*/

	TUint32 iWhiteBalanceModesSupported;

	/** Minimum zoom value allowed. 

	Must be negative, or zero if not supported.

	This is the minimum value that may be passed to CCamera::SetZoomFactorL(). */

	TInt iMinZoom;

	/** Maximum zoom value allowed. 

	Must be positive, or zero if not supported.

	This is the maximum value that may be passed to CCamera::SetZoomFactorL(). */

	TInt iMaxZoom;

	/** Maximum digital zoom value allowed. 

	Must be positive, or zero if not supported.

	This is the maximum value that may be passed to CCamera::SetDigitalZoomFactorL(). 

	Digital zoom factor is assumed to be a linear scale from 0 to iMaxDigitalZoom. */

	TInt iMaxDigitalZoom;

	/** Image size multiplier corresponding to minimum zoom value. 

	Must be between 0 and 1 inclusive. Both 0 and 1 indicate that macro functionality 

	is not supported. */

	TReal32 iMinZoomFactor;

	/** Image size multiplier corresponding to maximum zoom value. 

	May take the value 0, or values greater than or equal to 1. Both 0 and 1 indicate 

	that zoom functionality is not supported. */

	TReal32 iMaxZoomFactor;

	/** Image size multiplier corresponding to maximum digital zoom value. 

	Implementation recommendation is to use 'appropriate value' for maximum digital zoom which could cover only values 

	given by new digital zoom methods based on image format and capture mode.

	Must be greater than or equal to 1. */

	TReal32 iMaxDigitalZoomFactor;

	/** Count of still image capture sizes allowed.

	Number of different image sizes that CCamera::EnumerateCaptureSizes() will 

	support, based on the index passed in. Index must be between 0 and iNumImageSizesSupported-1. */

	TInt iNumImageSizesSupported;

	/** The supported still image formats.

	This is a bitfield of CCamera::TFormat values. */

	TUint32 iImageFormatsSupported;

	/** Count of video frame sizes allowed. 

	This is the number of different video frame sizes that CCamera::EnumerateVideoFrameSizes() 

	will support, based on the specified index. The index must be between 0 and 

	iNumVideoFrameSizesSupported-1. */

	TInt iNumVideoFrameSizesSupported;

	/** Count of video frame rates allowed.

	This is the number of different video frame rates that CCamera::EnumerateVideoFrameRates() 

	will support, based on the specified index. The index must be between 0 and 

	iNumVideoFrameRatesSupported-1. */

	TInt iNumVideoFrameRatesSupported;

	/** The supported video frame formats.

	This is a bitfield of video frame CCamera::TFormat values. 

	If methods CCamera::New2L() or CCamera::NewDuplicate2L() are not used to create the CCamera object, it is assumed that the 

	application may not be able to cope with any future additions to the enum values. So, any unrecognised enum value passed 

    from the implementation should be filtered by the ECAM implementation.

    To receive unrecognised/extra added enum values, the application should rather use CCamera::New2L() or CCamera::NewDuplicate2L() 

    to create the camera object. This is an indication to the ECAM implementation. In this case, the application is assumed 

    to be prepared to receive unrecognised enum values.	

	*/

	TUint32 iVideoFrameFormatsSupported;

	/** Maximum number of frames per buffer that may be requested. */

	TInt iMaxFramesPerBufferSupported;

	/** Maximum number of buffers allowed */

	TInt iMaxBuffersSupported;

	};

/** Mixin base class for camera clients.

An application must implement an MCameraObserver or MCameraObserver2 (recommended)

in order to use the camera API. This derived class is called when the camera is 

ready for use, an image has been captured or a buffer of video data is ready, including 

when errors occur.

Implementations of the camera API should use MCameraObserver::FrameBufferReady()

and MFrameBuffer::Release() to co-ordinate the mapping of any special memory

objects.

@publishedAll

@released

*/

class MCameraObserver

	{

public:

	/** Camera reservation is complete.

	Called asynchronously when CCamera::Reserve() completes.

	@param  aError

	        An error on failure and KErrNone on success.

	*/

	virtual void ReserveComplete(TInt aError)=0;

	/** Indicates camera power on is complete.

	Called on completion of CCamera:PowerOn().

	@param  aError

	        KErrNone on success, KErrInUse if the camera is in

	        use by another client or KErrNoMemory if insufficient system memory is available.

	*/

	virtual void PowerOnComplete(TInt aError)=0;

	/** Tests whether transfer of view finder data has completed.

	Called periodically in response to the use of CCamera::StartViewFinderBitmapsL().

	@param  aFrame

	        The view finder frame.

	*/

	virtual void ViewFinderFrameReady(CFbsBitmap& aFrame)=0;

	/** Transfers the current image from the camera to the client.

	Called asynchronously when CCamera::CaptureImage() completes.

	@param  aBitmap

	        On return, a pointer to an image held in CFbsBitmap form if

	        this was the format specified in CCamera::PrepareImageCaptureL().

	@param  aData

	        On return, a pointer to an HBufC8 if this was the format specified

	        in CCamera::PrepareImageCaptureL(). NULL if there was an error.

	@param  aError

	        KErrNone on success or an error code on failure.

	*/

	virtual void ImageReady(CFbsBitmap* aBitmap,HBufC8* aData,TInt aError)=0;

	/** Passes a filled frame buffer to the client.

	Called asynchronously, when a buffer has been filled with the required number

	of video frames by CCamera::StartVideoCapture().

	@param  aFrameBuffer

	        On return, a pointer to an MFrameBuffer if successful,

	        or NULL if not successful.

	@param  aError

	        KErrNone if successful, or an error code if not successful.

	*/

	virtual void FrameBufferReady(MFrameBuffer* aFrameBuffer,TInt aError)=0;

	};

/**

Class used for passing camera picture data between camera and client in the V2 observer.

Used for viewfinder, image capture and video capture.

The class offers APIs for the client to access the data as a descriptor, a bitmap

or a handle to a kernel chunk. Depending on the format previously requested by

the client, one or more of the API choices may be inappropriate e.g. an image will

not be avaiable as a bitmap in the FBS unless the client has specifically requested

it.

The buffer may contain multiple frames.

@publishedAll

@released

*/

class MCameraBuffer

	{

public:

	/** 

	Returns the number of frames of image data contained within the buffer. This

	would be 1 for a image capture, and match the requested count

	for video capture. For other methods in this class that take a aFrameIndex

	param, 0 <= aFrameIndex < NumFrames()

	@return The number of frames of image data in the buffer. 

	*/

	virtual TInt NumFrames()=0;

	/**

	Returns a pointer to a descriptor containing a frame of camera data. The format

	will have been previously specified by a CCamera class method.

	@param  aFrameIndex

	        The index of the required frame. For a still image this should be 0.

	@leave  KErrArgument if aIndex is out of range and 

	@leave  KErrNotSupported if the camera data is actually bitmaps in the FBS.

	@return A pointer to a descriptor containing a frame of image data.

	*/

	virtual TDesC8* DataL(TInt aFrameIndex)=0;

	/** 

	Returns a reference to a FBS bitmap containing a frame of image data.

	@param  aFrameIndex 

	        The index of the required frame. For a still image this should be 0.

	@leave  KErrArgument if aIndex is out of range and 

	@leave  KErrNotSupported if the picture data is not a FBS bitmap.

	@return A reference to a FBS bitmap containing a frame of picture data. 

	*/

	virtual CFbsBitmap& BitmapL(TInt aFrameIndex)=0;

	/** 

	Returns a handle for the chunk that contains the camera data.

	The RChunk is exposed so that it can potentially be shared between multiple

	processes.

	The ptr returned by DataL(aFrameIndex) is effectively derived from this

	RChunk (where both are supported simulataneously). The equivalent ptr would be:

	TPtrC8* ptr;

	ptr.Set(ChunkL().Base() + ChunkOffset(aFrameIndex), FrameSize(aFrameIndex));

	@leave  KErrNotSupported if the chunk is not available.

	@return A reference to a handle to the chunk that contains the buffer of picture data. 

	*/

	virtual RChunk& ChunkL()=0;

	/** 

	Returns the offset into the chunk that contains the frame specified by aFrameIndex.

	The client would add this offset to the ptr returned by ChunkL().Base() to

	get the address of the start of the frame data. 

	@param  aIndex 

	        The index of the required frame. For a still image this should be 0.

	@leave  KErrNotSupported if the chunk is not available 

	@leave  KErrArgument if aIndex is out of range.

	@return The offset into the chunk for the start of the frame. 

	*/

	virtual TInt ChunkOffsetL(TInt aFrameIndex)=0;

	/** 

	Returns the size of the data in bytes that comprises the frame specified by aIndex.

	@param  aFrameIndex 

	        The index of the required frame. For a still image this should be 0.

	@leave  KErrArgument 

			if aIndex is out of range.

	@return Returns the size of the data in bytes that comprises the frame. 

	*/

	virtual TInt FrameSize(TInt aFrameIndex)=0;

	/** 

	Releases the buffer. Once the client has processed

	the picture data it should use this method to signal to CCamera that the

	buffer can be re-used.

	*/

	virtual void Release()=0;

public:

	/** 

	Sequential frame number of the first frame in the buffer, counting from when

	CCamera::StartVideoCapture() was called and including frames dropped due to

	lack of buffers. Always zero for still images. May also be used by client viewfinders.

	*/

	TInt iIndexOfFirstFrameInBuffer;

	/** 

	Time elapsed from when CCamera::StartVideoCapture() was called until the first

	frame in the buffer was captured. Always zero for still images.

	*/

	TTimeIntervalMicroSeconds iElapsedTime;

	};

/** 

	Uid used to identify the event that the request to Reserve() has completed

*/

static const TUid  KUidECamEventReserveComplete = {0x101F7D3B};

/** 

	Uid used to identify the event that the request to PowerOn() has completed

*/

static const TUid  KUidECamEventPowerOnComplete = {0x101F7D3C};

/** 

	Uid used to identify the event that the client has lost

	control of the camera

*/

static const TUid  KUidECamEventCameraNoLongerReserved = {0x101F7D3D};

/** 

Uid used to notify the client who made the new reserve request. 

Error value KErrECamHighPriorityReserveRequesterExists indicates another such reserve request is outstanding and

has higher priority than this one.

Error value KErrCancel indicates a new reserve requester with higher priority than the current requester has 

been made. That's why, this one got cancelled.

Any other error may also occur.

@see CCamera::CCameraAdvancedSettings::ReserveL(const TTimeIntervalMicroseconds32& aMaxTimeToWait, TBool aKickOut);

*/

static const TUid  KUidECamEventNewReserveComplete = {KUidECamEventNewReserveCompleteUidValue};

/**

@publishedAll

@released

General purpose class to describe an ECam event.

Contains a UID to define the actual event type, and an integer to define the event code.

*/

class TECAMEvent

	{

public:

	/**

	Constructor.

	@param  aEventType

	        A UID to define the type of event.

	@param  aErrorCode

	        The error code associated with the event.

	*/

	IMPORT_C TECAMEvent(TUid aEventType, TInt aErrorCode);

	/**

	Default constructor.

	Provided so this class can be packaged in a TPckgBuf<>.

	*/

	IMPORT_C TECAMEvent();

	/**

	A UID to define the event type.

	*/

	TUid iEventType;

	/**

	The error code associated with the event.

	*/

	TInt iErrorCode;

	};

/** 

Uid used to identify a particular version of TECAMEvent base class being used i.e. TECAMEvent2 . 

Useful for MCameraObserver2::HandleEvent implementation to detect the version of TECAMEvent base class.

*/

static const TUid  KUidECamEventClass2 = {KUidECamEventClass2UidValue};

/** 

event indicating setting of color entry in the color swap operation. This is a part of class CCamera::CCameraImageProcessing. 

This event should be packed in TECAMEvent2 class.

@note  TECAMEvent2::iParam represents color entry.

*/

static const TUid  KUidECamEventCIPSetColorSwapEntry 		   = {KUidECamEventCIPSetColorSwapEntryUidValue};

static const TUid  KUidECamEvent2CIPSetColorSwapEntry 		   = {KUidECamEventCIPSetColorSwapEntryUidValue};

/** 

event indicating removal of color entry in the color swap operation. This is a part of class CCamera::CCameraImageProcessing. 

This event should be packed in TECAMEvent2 class.

@note  TECAMEvent2::iParam represents color entry.

*/

static const TUid  KUidECamEventCIPRemoveColorSwapEntry 	   = {KUidECamEventCIPRemoveColorSwapEntryUidValue};

static const TUid  KUidECamEvent2CIPRemoveColorSwapEntry 	   = {KUidECamEventCIPRemoveColorSwapEntryUidValue};

/** 

event indicating setting of color entry in the color accent operation. This is a part of class CCamera::CCameraImageProcessing. 

This event should be packed in TECAMEvent2 class.

@note  TECAMEvent2::iParam represents color entry.

*/

static const TUid  KUidECamEventCIPSetColorAccentEntry 		   = {KUidECamEventCIPSetColorAccentEntryUidValue};

static const TUid  KUidECamEvent2CIPSetColorAccentEntry 	   = {KUidECamEventCIPSetColorAccentEntryUidValue};

/** 

event indicating removal of color entry in the color accent operation. This is a part of class CCamera::CCameraImageProcessing. 

This event should be packed in TECAMEvent2 class.