CVideoEncoderInfo Class Reference

#include "devvideorecord.h"

Link against: devvideo.lib

class CVideoEncoderInfo : public CBase

Inherits from

CVideoEncoderInfo

Public Member Functions
	~CVideoEncoderInfo()
IMPORT_C TBool	Accelerated()
IMPORT_C const TDesC8 &	CodingStandardSpecificInfo()
IMPORT_C const TDesC &	Identifier()
IMPORT_C const TDesC8 &	ImplementationSpecificInfo()
IMPORT_C const TDesC &	Manufacturer()
IMPORT_C TUint	MaxBitrate()
IMPORT_C TUint	MaxBitrateLayers()
IMPORT_C TUint	MaxInLayerScalabilitySteps()
IMPORT_C const RArray< TPictureRateAndSize > &	MaxPictureRates()
IMPORT_C const TSize &	MaxPictureSize()
IMPORT_C TUint	MaxUnequalErrorProtectionLevels()
IMPORT_C CVideoEncoderInfo *	NewL(TUid, const TDesC &, const TDesC &, TVersion, TBool, TBool, const TArray< TUncompressedVideoFormat > &, const TArray< CCompressedVideoFormat * > &, const TSize &, TUint32, TUint32, TUint, TBool, TUint, TUint, const TArray< TPictureRateAndSize > &, TUint, TUint32, TBool, TBool, const TDesC8 &, const TDesC8 &)
IMPORT_C TUint32	SupportedDataUnitEncapsulations()
IMPORT_C TUint32	SupportedDataUnitTypes()
IMPORT_C const RArray< TUncompressedVideoFormat > &	SupportedInputFormats()
IMPORT_C const RPointerArray< CCompressedVideoFormat > &	SupportedOutputFormats()
IMPORT_C TUint32	SupportedPictureOptions()
IMPORT_C TBool	SupportsDirectCapture()
IMPORT_C TBool	SupportsInputFormat(const TUncompressedVideoFormat &)
IMPORT_C TBool	SupportsOutputFormat(const CCompressedVideoFormat &)
IMPORT_C TBool	SupportsPictureLoss()
IMPORT_C TBool	SupportsSliceLoss()
IMPORT_C TBool	SupportsSupplementalEnhancementInfo()
IMPORT_C TUid	Uid()
IMPORT_C TVersion	Version()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

This class contains information about a video encoder hardware device and its capabilities. 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 encoder devices, and used by the MSL video client code.

Constructor & Destructor Documentation

~CVideoEncoderInfo ( )

IMPORT_C

~CVideoEncoderInfo

(

)

Destructor.

Member Function Documentation

Accelerated ( )

IMPORT_C TBool

Accelerated

(

)

const

Returns whether the encoder is hardware-accelerated. Hardware-accelerated encoders can run on an application DSP or dedicated hardware.

Returns: "True if the encoder is hardware-accelerated."

CodingStandardSpecificInfo ( )

IMPORT_C const TDesC8 &

CodingStandardSpecificInfo

(

)

const

Returns coding-standard specific information about the encoder.

Returns: "Coding-standard specific information about the encoder. The data format is coding-standard specific, and defined separately. The reference is valid until the CVideoEncoderInfo object is destroyed."

Identifier ( )

IMPORT_C const TDesC &

Identifier

(

)

const

Returns the encoder hardware device manufacturer-specific identifier. The combination of the manufacturer and identifier uniquely identifies the plug-in.

Returns: "The identifier. The reference is valid until the CVideoEncoderInfo object is destroyed."

ImplementationSpecificInfo ( )

IMPORT_C const TDesC8 &

ImplementationSpecificInfo

(

)

const

Returns implementation-specific information about the encoder.

Returns: "Implementation-specific information about the encoder. The data format is implementation-specific, and defined separately by the encoder supplier. The reference is valid until the CVideoEncoderInfo object is destroyed."

Manufacturer ( )

IMPORT_C const TDesC &

Manufacturer

(

)

const

Returns the encoder hardware device manufacturer.

Returns: "The manufacturer name. The reference is valid until the CVideoEncoderInfo object is destroyed."

MaxBitrate ( )

IMPORT_C TUint

MaxBitrate

(

)

const

Returns the maximum bit-rate supported by the encoder.

Returns: "Maximum bit-rate supported, in bits per second. KMaxTUint32 can be used if the encoder has no bit-rate restrictions."

MaxBitrateLayers ( )

IMPORT_C TUint

MaxBitrateLayers

(

)

const

Returns the maximum number of bit-rate scalability layers supported.

Returns: "Maximum number of bit-rate scalability layers supported, one (1) if layered scalability is not supported."

MaxInLayerScalabilitySteps ( )

IMPORT_C TUint

MaxInLayerScalabilitySteps

(

)

const

Returns the maximum number of in-layer scalability steps supported.

Returns: "Maximum number of in-layer scalability steps supported, one (1) if in-layer scalability is not supported."

MaxPictureRates ( )

IMPORT_C const RArray< TPictureRateAndSize > &

MaxPictureRates

(

)

const

Returns the maximum picture size/rate combinations supported by the encoder. Video encoders can have different maximum picture rate limitations depending on the picture size used.

Returns: "A reference to an array of picture size/rate combinations. The reference remains valid until this object is deleted."

MaxPictureSize ( )

IMPORT_C const TSize &

MaxPictureSize

(

)

const

Returns the maximum picture size the encoder supports.

Returns: "The maximum picture size supported. The reference is valid until the CVideoEncoderInfo object is destroyed."

MaxUnequalErrorProtectionLevels ( )

IMPORT_C TUint

MaxUnequalErrorProtectionLevels

(

)

const

Returns the maximum number of unequal error protection levels supported.

Returns: "Maximum number of unequal error protection levels supported, one (1) if unequal error protection is not supported."

NewL ( TUid, const TDesC &, const TDesC &, TVersion, TBool, TBool, const TArray< TUncompressedVideoFormat > &, const TArray< CCompressedVideoFormat * > &, const TSize &, TUint32, TUint32, TUint, TBool, TUint, TUint, const TArray< TPictureRateAndSize > &, TUint, TUint32, TBool, TBool, const TDesC8 &, const TDesC8 & )

IMPORT_C CVideoEncoderInfo *	NewL	(	TUid	aUid,
			const TDesC &	aManufacturer,
			const TDesC &	aIdentifier,
			TVersion	aVersion,
			TBool	aAccelerated,
			TBool	aSupportsDirectCapture,
			const TArray< TUncompressedVideoFormat > &	aSupportedInputFormats,
			const TArray< CCompressedVideoFormat * > &	aSupportedOutputFormats,
			const TSize &	aMaxPictureSize,
			TUint32	aSupportedDataUnitTypes,
			TUint32	aSupportedDataUnitEncapsulations,
			TUint	aMaxBitrateLayers,
			TBool	aSupportsSupplementalEnhancementInfo,
			TUint	aMaxUnequalErrorProtectionLevels,
			TUint	aMaxBitRate,
			const TArray< TPictureRateAndSize > &	aMaxPictureRates,
			TUint	aMaxInLayerScalabilitySteps,
			TUint32	aSupportedPictureOptions,
			TBool	aSupportsPictureLoss,
			TBool	aSupportsSliceLoss,
			const TDesC8 &	aCodingStandardSpecificInfo,
			const TDesC8 &	aImplementationSpecificInfo
		)	[static]

Creates and returns a new CVideoEncoderInfo object. All data passed in is copied on construction of the object.

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

Parameter	Description
aUid	The uid of the encoder.
aManufacturer	The video encoder manufacturer.
aIdentifier	The manufacturer-specific identifier for this encoder.
aVersion	The version of this encoder.
aAccelerated	Whether this encoder is accelerated.
aSupportsDirectCapture	Whether this encoder supports direct capture.
aSupportedInputFormats	An array of the supported input formats.
aSupportedOutputFormats	An array of the supported output formats.
aMaxPictureSize	The maximum supported picture size.
aSupportedDataUnitTypes	The supported data unit types.
aSupportedDataUnitEncapsulations	The supported data unit encapsulations.
aMaxBitrateLayers	The maximum number of bitrate layers supported.
aSupportsSupplementalEnhancementInfo	Whether supplemental enhancement info is supported.
aMaxUnequalErrorProtectionLevels	The maximum unequal error protection level supported.
aMaxBitRate	The maximum bit rate supported.
aMaxPictureRates	An array of the maximum picture size/rates supported.
aMaxInLayerScalabilitySteps	The maximum in-layer scalability steps supported.
aSupportedPictureOptions	The picture options supported.
aCodingStandardSpecificInfo	Coding standard specific info.
aImplementationSpecificInfo	Implementation specific info.

Returns: A new CVideoEncoderInfo object.

SupportedDataUnitEncapsulations ( )

IMPORT_C TUint32

SupportedDataUnitEncapsulations

(

)

const

Returns the data unit encapsulation types that the encoder supports.

Returns: "Supported data unit encapsulation types. The value is a binary OR of values from TVideoDataUnitEncapsulation."

SupportedDataUnitTypes ( )

IMPORT_C TUint32

SupportedDataUnitTypes

(

)

const

Returns the data unit types supported by the encoder.

Returns: "Supported data unit types. The value is a binary OR of values from TVideoDataUnitType."

SupportedInputFormats ( )

IMPORT_C const RArray< TUncompressedVideoFormat > &

SupportedInputFormats

(

)

const

Returns the input formats that the encoder supports.

Returns: "An RArray table of supported video formats (TUncompressedVideoFormat). The reference is valid until the CVideoEncoderInfo object is destroyed."

SupportedOutputFormats ( )

IMPORT_C const RPointerArray< CCompressedVideoFormat > &

SupportedOutputFormats

(

)

const

Returns the output formats that the encoder supports.

Returns: "An RArray table of supported video formats (CCompressedVideoFormat). The reference is valid until the CVideoEncoderInfo object is destroyed."

SupportedPictureOptions ( )

IMPORT_C TUint32

SupportedPictureOptions

(

)

const

Returns the input picture options that the encoder supports.

Returns: "Supported input picture options, a bitwise OR of values from TVideoPicture::TVideoPictureOptions."

SupportsDirectCapture ( )

IMPORT_C TBool

SupportsDirectCapture

(

)

const

Returns whether the encoder supports direct capture. Encoders supporting direct capture can get the input pictures directly from a camera, possibly using an efficient hardware-dependent data path.

Returns: "True if the encoder supports direct capture."

SupportsInputFormat ( const TUncompressedVideoFormat & )

IMPORT_C TBool

SupportsInputFormat

(

const TUncompressedVideoFormat &

aFormat

)

const

Returns whether the encoder supports the given input format.

Parameter	Description
aFormat	"The format to check."

Returns: "True if the encoder supports the given input format."

SupportsOutputFormat ( const CCompressedVideoFormat & )

IMPORT_C TBool

SupportsOutputFormat

(

const CCompressedVideoFormat &

aFormat

)

const

Returns whether the encoder supports the given output format.

Parameter	Description
aFormat	"The format to check."

Returns: "True if the encoder supports the given output format."

SupportsPictureLoss ( )

IMPORT_C TBool

SupportsPictureLoss

(

)

const

Returns whether the encoder supports picture loss indications. If true, the encoder implements PictureLoss(), and recovers lost picture contents when it receives the indication.

Returns: "True if the encoder supports picture loss indications."

SupportsSliceLoss ( )

IMPORT_C TBool

SupportsSliceLoss

(

)

const

Returns whether the encoder supports slice loss indications. If true, the encoder implements SliceLoss(), and recovers lost or damaged macroblocks when it receives the indication.

Returns: "True if the encoder supports slice loss indications."

SupportsSupplementalEnhancementInfo ( )

IMPORT_C TBool

SupportsSupplementalEnhancementInfo

(

)

const

Returns whether the encoder implements SendSupplementalInfoL(). If SendSupplementalInfoL() is implemented, the client can send supplemental enhancement information messages as binary strings using that method. If SendSupplementalInfoL() is not implemented, this is not possible, but the encoder can still generate and send coding standard or implementation specific supplemental enhancement information automatically.

Returns: "True if the encoder supports supplemental enhancement information."

Uid ( )

IMPORT_C TUid

Uid

(

)

const

Returns the encoder UID.

Returns: "The encoder UID."

Version ( )

IMPORT_C TVersion

Version

(

)

const

Returns the encoder version.

Returns: "The encoder version."