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

//

#ifndef __DEVVIDEOPLAY_H__

#define __DEVVIDEOPLAY_H__

#include <e32std.h>

#include <mmf/devvideo/devvideobase.h>

class MMMFDevVideoPlayObserver;

class CMMFVideoPlayHwDevice;

class CMMFVideoDecodeHwDevice;

class CMMFVideoPostProcHwDevice;

/**

MMMFDevVideoPlayProxy is the interface to the CMMFDevVideoPlay API implementation that the hardware devices 

use to deliver data back to the client and report their progress to the API implementation.

@publishedAll

@released

*/

class MMMFDevVideoPlayProxy

	{

public:

	/**

	Delivers a new decoded picture to the client. The CMMFDevVideoPlay implementation will maintain 

	a list of decoded pictures and implement GetNewPictureInfo() and NextPictureL() based on those. 

	The pictures will be returned back to the hardware device using ReturnPicture().

	@param "aPicture" "The newly processed picture."

	*/

	virtual void MdvppNewPicture(TVideoPicture* aPicture) = 0;

	/**

	Notifies the client that one or more new empty input buffers are available. Called by the decoder 

	hardware device.

	*/

	virtual void MdvppNewBuffers() = 0;

	/**

	Returns a used input video picture back to the caller. Called by a post-processor hardware device 

	after the picture has been processed and the picture source was the client, not another plug-in.

	@param "aPicture" "The picture to return."

	*/

	virtual void MdvppReturnPicture(TVideoPicture* aPicture) = 0;

	/**

	Delivers supplemental information from a decoder hardware device to the client. 

	The information is codec-dependent. The method is synchronous - the client 

	MMMFDevVideoPlayObserver::MdvppSupplementalInformation() method is called immediately, 

	and the memory for the supplemental information can be re-used when the call returns.

	@param "aData"		"The supplemental data."

	@param "aTimestamp" "The presentation timestamp for the picture that the supplemental data is part of."

	@param "aPictureId" "Picture identifier for the picture. If a picture ID is not available, 

						aPictureId.iIdType is set to ENone."

	*/

	virtual void MdvppSupplementalInformation(const TDesC8& aData, 

		const TTimeIntervalMicroSeconds& aTimestamp, const TPictureId& aPictureId) = 0;

	/**

	Back channel information, indicating a picture loss without specifying the lost picture.

	*/

	virtual void MdvppPictureLoss() = 0;

	/**

	Back channel information, indicating the pictures that have been lost.

	@param "aPictures"	"Picture identifiers for the lost pictures. The reference is only valid

						until the method returns."

	*/

	virtual void MdvppPictureLoss(const TArray<TPictureId>& aPictures) = 0;

	/**

	Back channel information, indicating the loss of consecutive macroblocks in raster scan order.

	@param "aFirstMacroblock"	"The first lost macroblock.  The macroblocks are numbered 

								such that the macroblock in the upper left corner of the picture is 

								considered macroblock number 1 and the number for each macroblock increases 

								from left to right and then from top to bottom in raster-scan order."

	@param "aNumMacroblocks"	"The number of lost macroblocks that are consecutive in raster-scan order."

	@param "aPicture"			"The picture identifier for the picture where the macroblocks were lost.  

								If the picture is not known, aPicture.iIdType is set to ENone.  The 

								reference is only valid until the method returns."

	*/

	virtual void MdvppSliceLoss(TUint aFirstMacroblock, TUint aNumMacroblocks, const TPictureId& aPicture)= 0;

	/**

	Back channel information from the decoder, indicating a reference picture selection request. 

	The request is delivered as a coding-standard specific binary message.  Reference picture selection

	can be used to select a pervious correctly transmitted picture to use as a reference in case later 

	pictures have been lost.

	@param "aSelectionData"	"The reference picture selection request message. The message format is 

							coding-standard specific, and defined separately. The reference is only 

							valid until the method returns."

	*/

	virtual void MdvppReferencePictureSelection(const TDesC8& aSelectionData)= 0;

	/**

	Delivers a timed snapshot result to the client. The memory reserved for the snapshot picture 

	can no longer be used in the device.

	@param "aError"					"An error code, KErrNone if no errors occurred. 

									If an error occurred, the data in the snapshot may not be valid, 

									but the memory can still be freed."

	@param "aPictureData"			"The snapshot picture data."

	@param "aPresentationTimestamp"	"The presentation timestamp for the snapshot picture."

	@param "aPictureId"				"Picture identifier for the picture. If a picture ID is not 

									available, aPictureId.iIdType is set to ENone."

	*/

	virtual void MdvppTimedSnapshotComplete(TInt aError, TPictureData* aPictureData, 

		const TTimeIntervalMicroSeconds& aPresentationTimestamp, const TPictureId& aPictureId) = 0;

	/**

	Reports a fatal error to the client. The device must automatically stop processing 

	video data when such errors occur, and may not do further processing before it has 

	been deleted and re-created.

	@param "aDevice" "The device that reported the error."

	@param "aError"	 "The error code."	

	*/

	virtual void MdvppFatalError(CMMFVideoHwDevice* aDevice, TInt aError) = 0;

	/**

	Reports that an asynchronous Initialize() method has completed. 

	The device is now ready for playback.

	@param "aDevice" "The device that was initialzied."

	@param "aError"	 "Initialization result error code, KErrNone if initialization was successful."	

	*/

	virtual void MdvppInitializeComplete(CMMFVideoHwDevice* aDevice, TInt aError) = 0;

	/**

	Reports that the input video stream end has been reached and all pictures have been processed. 

	Called by each hardware device after their InputEnd() methods have been called and all data has 

	been processed. The proxy implementation will notify the client about stream end when all 

	hardware devices have called this method.

	*/

	virtual void MdvppStreamEnd() = 0;

	};

/**

A buffer for compressed video data, contains one coded data unit. Video buffers are used for writing 

video data to the API.

@publishedAll

@released

*/

class TVideoInputBuffer

	{

public:

	/**

	Default constructor. Zeroes all members (including iData which will point to garbage until manually

	set to point to the real video buffer memory data area by the user).

	*/

	IMPORT_C TVideoInputBuffer();

public:

	/**

	 */

	enum TVideoBufferOptions

		{

		/** The sequence number field is valid. */

		ESequenceNumber	 = 0x00000001,

		/** The decoding timestamp field is valid */

		EDecodingTimestamp  = 0x00000002,

		/** The presentation timestamp field is valid.*/

		EPresentationTimestamp = 0x00000004,

		/** Content protected pictures cannot be displayed on unprotected 

		    external displays such as TV-out.

		*/

		EContentProtected = 0x00000008

		};

	/**

	Pointer to the video data.

	*/

	TPtr8 iData;

	/**

	Data unit options. The value is a bitfield combined from values from TVideoBufferOptions.

	@see TVideoBufferOptions

	*/

	TUint32 iOptions;

	/**

	Data unit decoding timestamp. Valid if EDecodingTimestamp is set in the options.

	*/

	TTimeIntervalMicroSeconds iDecodingTimestamp;

	/**

	Data unit presentation timestamp. Valid if EPresentationTimestamp is set in the options. 

	If the input bitstream does not contain timestamp information, this field should be valid, 

	otherwise pictures cannot be displayed at the correct time.   If the input bitstream contains 

	timestamp information (such as the TR syntax element of H.263 bitstreams) and valid 

	iPresentationTimestamp is provided, the value of iPresentationTimestamp is used in playback.

	*/

	TTimeIntervalMicroSeconds iPresentationTimestamp;

	/**

	True if the data is part of a pre-roll period and may not be drawn. The decoder may skip 

	display-related operations, but must still decode normally since pre-roll may not end in a key 

	frame.

	*/

	TBool iPreRoll;

	/**

	Data unit sequence number. Valid if ESequenceNumber is set in the options. If present, the 

	sequence number is incremented once per coded data unit, a gap in the numbers indicates missing 

	data.

	*/

	TUint iSequenceNumber;

	/**

	True if the data unit is known to contain erroneous data.

	*/

	TBool iError;

	/**

	A queue link used internally by the MSL API. The field must not be modified while the buffer is 

	in the MSL API, but can be used by the client before the buffer has been written and after the 

	buffer has been returned.

	*/

	TDblQueLink iLink;

	/**

	A pointer for free-form user data. The pointer is set by the module that created the buffer, and 

	is usually used for memory management purposes.

	*/

	TAny* iUser;

	};

/**

This class contains information about the post-processing functionality that a single post-processor 

or decoder hardware device has. Although it mainly contains static data, it is defined as a complete 

CBase-derived class since the data is relatively complex and proper memory management is necessary.

The objects are created by the post-processor or decoder devices, and used by the MSL video client code.

@publishedAll

@released

*/

class CPostProcessorInfo : public CBase

	{

public:

	/**

	Creates and returns a new CPostProcessorInfo object.

	@param	"aUid"							"The UID of the post-processor."

	@param	"aManufacturer"					"The manufacturer of the post-processor hw device."

	@param	"aIdentifier"					"The post-processor hw device manufacturer-specific 

											identifier."

	@param	"aVersion"						"The post-processor version."

	@param	"aSupportedFormats"				"The source formats supported by the post-processor."

	@param	"aSupportedCombinations"		"The supported post-processing combinations.  An array of 

											values created by the bitwise OR-ing of values from 

											TPrePostProcessType."

	@param	"aAccelerated"					"Whether the post processor is hardware-accelerated. 

											Accelerated post-processors can run on an application DSP 

											or dedicated hardware."

	@param	"aSupportsDirectDisplay"		"Whether the hw device supports output directly to the 

											screen."

	@param	"aYuvToRgbCapabilities"			"The post-processor YUV to RGB conversion capabilities."

	@param	"aSupportedRotations"			"A bitwise OR of values of TRotationType to indicate the 

											supported rotation types."

	@param	"aSupportArbitraryScaling"		"Whether the post-processor supports arbitrary scaling."

	@param	"aSupportedScaleFactors"		"A list of the discrete scaling factors supported. If the

											post-processor supports arbitrary scaling, this list should

											be left zero-length."

	@param	"aAntiAliasedScaling"			"Whether anti-aliasing filtering for scaling is supported."

	@param	"aImplementationSpecificInfo"	"Implementation-specific information."

	@return "A new CPostProcessorInfo object."

	@leave	"This method may leave with one of the system-wide error codes."

	*/

	IMPORT_C static CPostProcessorInfo* NewL(TUid aUid,

											 const TDesC& aManufacturer,

											 const TDesC& aIdentifier,

											 TVersion aVersion,

											 const TArray<TUncompressedVideoFormat>& aSupportedFormats,

											 const TArray<TUint32>& aSupportedCombinations,

											 TBool aAccelerated,

											 TBool aSupportsDirectDisplay,

											 const TYuvToRgbCapabilities& aYuvToRgbCapabilities,

											 TUint32 aSupportedRotations,

											 TBool aSupportArbitraryScaling,

											 const TArray<TScaleFactor>& aSupportedScaleFactors,

											 TBool aAntiAliasedScaling,

											 const TDesC8& aImplementationSpecificInfo = KNullDesC8);

	/**

	Destructor

	*/

	IMPORT_C ~CPostProcessorInfo();

	/**

	Returns the post-processor UID.

	@return "Post-processor UID"

	*/

	IMPORT_C TUid Uid() const;

	/**

	Returns the post-processor hardware device manufacturer.

	@return "The manufacturer name as a standard Symbian descriptor. The reference is valid until the 

			CPostProcessorInfo object is destroyed."

	*/

	IMPORT_C const TDesC& Manufacturer() const;

	/**

	Returns the post-processor hardware device manufacturer-specific identifier. 

	The combination of the manufacturer and identifier uniquely identifies the device.

	@return "The identifier as a standard Symbian descriptor. The reference is valid until the 

			CPostProcessorInfo object is destroyed."

	*/

	IMPORT_C const TDesC& Identifier() const;

	/**

	Returns the post-processor version.

	@return "Post-processor version."

	*/

	IMPORT_C TVersion Version() const;

	/**

	Checks if the post-processor supports the given format as a source format.

	@param	"aFormat"	"The format to check. The reference is not used after the method returns."

	@return "ETrue if the post-processor supports the given format, EFalse if not."

	*/

	IMPORT_C TBool SupportsFormat(const TUncompressedVideoFormat& aFormat) const;

	/**

	Lists the source formats supported by the post-processor.

	@return "A RArray table of supported video formats (TUncompressedVideoFormat). The reference is 

			valid until the CPostProcessorInfo object is destroyed."

	*/

	IMPORT_C const RArray<TUncompressedVideoFormat>& SupportedFormats() const;

	/**

	Checks if the post-processor supports the given post-processing combination.

	@param	"aCombination" "Post-processing combination, a bitwise OR of values from TPrePostProcessType."

	@return "ETrue if the post-processing combination is supported, EFalse if not."

	*/

	IMPORT_C TBool SupportsCombination(TUint32 aCombination) const;

	/**

	Lists all supported post-processing combinations.

	@return "A RArray table or post-processing combinations. Each value is a bitwise OR of values from 

			TPrePostProcessType. The reference is valid until the CPostProcessorInfo object is destroyed."

	*/

	IMPORT_C const RArray<TUint32>& SupportedCombinations() const;

	/**

	Returns whether the hardware device is hardware-accelerated. Hardware-accelerated post-processors 

	can run on an application DSP or dedicated hardware.

	@return "ETrue if the device is hardware-accelerated."

	*/

	IMPORT_C TBool Accelerated() const;

	/**

	Returns whether the hardware device supports output directly to the screen. Output to memory buffers 

	is always supported.

	@return "ETrue if the post-processor supports direct screen output."

	*/

	IMPORT_C TBool SupportsDirectDisplay() const;

	/**

	Returns the post-processor YUV to RGB color conversion capabilities.

	@return "The conversion capabilities as a TYuvToRgbCapabilities structure. The reference is valid 

			until the CPostProcessorInfo object is destroyed. If the post-processor does not support 

			YUV to RGB conversion, the contents are undefined."

	*/

	IMPORT_C const TYuvToRgbCapabilities& YuvToRgbCapabilities() const;

	/**

	Returns the rotation types the post-processor supports.

	@return "The supported rotation types as a bitwise OR of TRotationType values. If the 

			post-processor does not support rotation, the return value is zero."

	*/

	IMPORT_C TUint32 SupportedRotations() const;

	/**

	Returns whether the post-processor supports arbitrary scaling. If arbitrary scaling is not 

	supported, a limited selection of scaling factors may still be available, use 

	SupportedScaleFactors() to retrieve those.

	@return "ETrue if the post-processor supports arbitrary scaling, EFalse if not."

	*/

	IMPORT_C TBool SupportsArbitraryScaling() const;

	/**

	Returns the scaling factors the post-processor supports. If the post-processor supports arbitrary 

	scaling the list is empty - use SupportsArbitraryScaling() first.

	@return "A RArray list of supported scale factors (TScaleFactor). The reference is valid until the 

			CPostProcessorInfo object is destroyed. If the post-processor supports arbitrary scaling 

			or no scaling at all, the list is empty."

	*/

	IMPORT_C const RArray<TScaleFactor>& SupportedScaleFactors() const;

	/**

	Returns whether the hardware device supports anti-aliasing filtering for scaling.

	@return "True if anti-aliasing filtering is supported."

	*/

	IMPORT_C TBool AntiAliasedScaling() const;

	/**

	Returns implementation-specific information about the post-processor.

	@return "Implementation- specific information about the post-processor. The data format is 

			implementation-specific, and defined separately by the post-processor supplier. The 

			reference is valid until the CPostProcessorInfo object is destroyed."

	*/

	IMPORT_C const TDesC8& ImplementationSpecificInfo() const;

	/**

	Adds the screen number into the list of screens supported by the post processor.

	@leave	"KErrNoMemory when there is no memory to expand the list of supported screens. 

			 KErrNotSupported if the secondary screen display is not supported in Multimedia Framework."

	*/

	IMPORT_C void AddSupportedScreenL(TInt aScreenNo);

	/**

	Lists the screens supported by the post processor.

	@param	"aSupportedScreens"		"An array to retrieve the list of supported screens. 

									 This method resets	the array before adding elements to it. 

									 The array must be created and destroyed by the caller."

	@leave "KErrNotSupported if the secondary screen display is not supported in Multimedia Framework.

			KErrNoMemory when there is no memory to expand the list."

	*/

	IMPORT_C void GetSupportedScreensL(RArray<TInt>& aSupportedScreens) const;

	/** Sets a flag indicating whether the PostProcessor supports per picture content protection.

	    E.g. Where content protection within a video stream can alter.

	 @param "aSetting" "Set to TRUE to indicate PostProcessor supports content protection. 

	 @See TVideoPicture::TVideoPictureOptions::EContentProtected 

	 @See TVideoInputBuffer::TVideoBufferOptions::EContentProtected 

	*/

	IMPORT_C void SetSupportsContentProtected(const TBool aSetting);

	/** Returns whether the PostProcessor supports per picture content protection.

	    E.g. Where content protection within a video stream can alter.

	 @return "True if the PostProcessor supports Content Protection." 

	 @See TVideoPicture::TVideoPictureOptions::EContentProtected

	 @See TVideoInputBuffer::TVideoBufferOptions::EContentProtected

	*/

	IMPORT_C TBool SupportsContentProtected() const;

private:

	CPostProcessorInfo(TUid aUid,

					   TVersion aVersion,

					   TBool aAccelerated,

					   TBool aSupportDirectDisplay,

					   const TYuvToRgbCapabilities& aYuvToRgbCapabilities,

					   TUint32 aSupportedRotations,

					   TBool aSupportArbitraryScaling,

					   TBool aAntiAliasedScaling);

	void ConstructL(const TDesC& aManufacturer,

					const TDesC& aIdentifier,

					const TArray<TUncompressedVideoFormat>& aSupportedFormats,

					const TArray<TUint32>& aSupportedCombinations,

					const TArray<TScaleFactor>& aSupportedScaleFactors,

					const TDesC8& aImplementationSpecificInfo);

private:

	TUid iUid;

	TVersion iVersion;

	TBool iAccelerated;

	TBool iSupportDirectDisplay;

	TYuvToRgbCapabilities iYuvToRgbCapabilities;

	TUint32 iSupportedRotations;

	TBool iSupportArbitraryScaling;

	TBool iAntiAliasedScaling;

	HBufC* iManufacturer;

	HBufC* iIdentifier;

	HBufC8* iImplementationSpecificInfo;

 	RArray<TUncompressedVideoFormat> iSupportedFormats;

	RArray<TUint32> iSupportedCombinations;

	RArray<TScaleFactor> iSupportedScaleFactors;

	RArray<TInt> iSupportedScreens;

	TBool iSupportsContentProtected;

	};

/**

This class contains information about a single video decoder. Although it mainly contains static data, 

it is defined as a complete CBase-derived class since the data is relatively complex and proper memory 

management is necessary.

The objects are created by the video decoder hardware devices, and used by the MSL video client code.

@publishedAll

@released

*/

class CVideoDecoderInfo : public CBase

	{

public:

	/**

	Creates and returns a new CVideoDecoderInfo object.

	@param	"aUid"							"The uid of the decoder."

	@param	"aManufacturer"					"The video decoder manufacturer."

	@param	"aIdentifier"					"The manufacturer-specific identifier for this video decoder."

	@param	"aVersion"						"The version of this video decoder."

	@param	"aSupportedFormats"				"An array of the formats supported by the decoder. 

											A copy will be taken of the array and the referenced 

											CCompressedVideoFormat objects"

	@param	"aAccelerated"					"Whether this decoder is accelerated or not."

	@param	"aSupportsDirectDisplay"		"Whether this decoder supports direct display or not."

	@param	"aMaxPictureSize"				"The maximum picture size supported by the decoder."

	@param	"aMaxBitrate"					"The maximum bit rate supported by the decoder. Use KMaxTUint32 if there are no bit-rate restrictions."

	@param	"aMaxPictureRates"				"An array of the maximum picture size/rate combinations supported by the decoder."

	@param	"aSupportsPictureLoss"			"Whether the decoder supports picture loss indications."

	@param	"aSupportsSliceLoss"			"Whether the decoder supports slice loss indications."

	@param	"aCodingStandardSpecificInfo"	"Coding-standard specific information about the decoder."

	@param	"aImplementationSpecificInfo"	"Implementation-specific information about the decoder."

	@return "A new CVideoDecoderInfo object."

	@leave	"This method may leave with one of the system-wide error codes."