Class CVideoEncoderInfo

class CVideoEncoderInfo : public CBase;

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.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CVideoEncoderInfo - This class contains information about a video encoder hardware device and its ca...

Members

Defined in CVideoEncoderInfo:

• Accelerated()constReturns whether the encoder is hardware-accelerated. Hardware-accelerated encode...
• CodingStandardSpecificInfo()constReturns coding-standard specific information about the encoder.
• Identifier()constReturns the encoder hardware device manufacturer-specific identifier. The combin...
• ImplementationSpecificInfo()constReturns implementation-specific information about the encoder.
• Manufacturer()constReturns the encoder hardware device manufacturer.
• MaxBitrate()constReturns the maximum bit-rate supported by the encoder.
• MaxBitrateLayers()constReturns the maximum number of bit-rate scalability layers supported.
• MaxInLayerScalabilitySteps()constReturns the maximum number of in-layer scalability steps supported.
• MaxPictureRates()constReturns the maximum picture size/rate combinations supported by the encoder. Vid...
• MaxPictureSize()constReturns the maximum picture size the encoder supports.
• MaxUnequalErrorProtectionLevels()constReturns the maximum number of unequal error protection levels 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 &)Creates and returns a new CVideoEncoderInfo object. All data passed in is copied...
• SupportedDataUnitEncapsulations()constReturns the data unit encapsulation types that the encoder supports.
• SupportedDataUnitTypes()constReturns the data unit types supported by the encoder.
• SupportedInputFormats()constReturns the input formats that the encoder supports.
• SupportedOutputFormats()constReturns the output formats that the encoder supports.
• SupportedPictureOptions()constReturns the input picture options that the encoder supports.
• SupportsDirectCapture()constReturns whether the encoder supports direct capture. Encoders supporting direct ...
• SupportsInputFormat(const TUncompressedVideoFormat &)constReturns whether the encoder supports the given input format.
• SupportsOutputFormat(const CCompressedVideoFormat &)constReturns whether the encoder supports the given output format.
• SupportsPictureLoss()constReturns whether the encoder supports picture loss indications. If true, the enco...
• SupportsSliceLoss()constReturns whether the encoder supports slice loss indications. If true, the encode...
• SupportsSupplementalEnhancementInfo()constReturns whether the encoder implements SendSupplementalInfoL(). If SendSupplemen...
• Uid()constReturns the encoder UID.
• Version()constReturns the encoder version.
• ~CVideoEncoderInfo()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static 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);

Description

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

Parameters

Return value

Leave codes

IMPORT_C ~CVideoEncoderInfo();

Description

Destructor.

IMPORT_C TUid Uid() const;

Description

Returns the encoder UID.

Return value

IMPORT_C TVersion Version() const;

Description

Returns the encoder version.

Return value

IMPORT_C const TDesC& Manufacturer() const;

Description

Returns the encoder hardware device manufacturer.

Return value

IMPORT_C const TDesC& Identifier() const;

Description

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

Return value

IMPORT_C TBool Accelerated() const;

Description

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

Return value

IMPORT_C TBool SupportsDirectCapture() const;

Description

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.

Return value

IMPORT_C TBool SupportsInputFormat(const TUncompressedVideoFormat &aFormat) const;

Description

Returns whether the encoder supports the given input format.

Parameters

Return value

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

Description

Returns the input formats that the encoder supports.

Return value

IMPORT_C TBool SupportsOutputFormat(const CCompressedVideoFormat &aFormat) const;

Description

Returns whether the encoder supports the given output format.

Parameters

Return value

IMPORT_C const RPointerArray< CCompressedVideoFormat >& SupportedOutputFormats() const;

Description

Returns the output formats that the encoder supports.

Return value

IMPORT_C const TSize& MaxPictureSize() const;

Description

Returns the maximum picture size the encoder supports.

Return value

IMPORT_C TUint32 SupportedDataUnitTypes() const;

Description

Returns the data unit types supported by the encoder.

Return value

IMPORT_C TUint32 SupportedDataUnitEncapsulations() const;

Description

Returns the data unit encapsulation types that the encoder supports.

Return value

IMPORT_C TUint MaxBitrateLayers() const;

Description

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

Return value

IMPORT_C TBool SupportsSupplementalEnhancementInfo() const;

Description

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.

Return value

IMPORT_C TUint MaxUnequalErrorProtectionLevels() const;

Description

Returns the maximum number of unequal error protection levels supported.

Return value

IMPORT_C TUint MaxBitrate() const;

Description

Returns the maximum bit-rate supported by the encoder.

Return value

IMPORT_C const RArray< TPictureRateAndSize >& MaxPictureRates() const;

Description

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.

Return value

IMPORT_C TUint MaxInLayerScalabilitySteps() const;

Description

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

Return value

IMPORT_C TUint32 SupportedPictureOptions() const;

Description

Returns the input picture options that the encoder supports.

Return value

IMPORT_C TBool SupportsPictureLoss() const;

Description

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

Return value

IMPORT_C TBool SupportsSliceLoss() const;

Description

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.

Return value

IMPORT_C const TDesC8& CodingStandardSpecificInfo() const;

Description

Returns coding-standard specific information about the encoder.

Return value

IMPORT_C const TDesC8& ImplementationSpecificInfo() const;

Description

Returns implementation-specific information about the encoder.

Return value