Class CPreProcessorInfo

class CPreProcessorInfo : public CBase;

Description

This class contains information about the pre-processing capabilities that an encoder or a pre-processor hardware 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 pre-processor or encoder devices, and used by the MSL video client code.

Derivation

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

• CPreProcessorInfo - This class contains information about the pre-processing capabilities that an encoder or a pre-processor hardware has

Members

Defined in CPreProcessorInfo:
Accelerated(), Identifier(), ImplementationSpecificInfo(), Manufacturer(), NewL(), SupportedCombinations(), SupportedInputFormats(), SupportedOutputFormats(), SupportedRgbRanges(), SupportedRotations(), SupportedScaleFactors(), SupportsAntiAliasedScaling(), SupportsArbitraryScaling(), SupportsCombination(), SupportsDirectCapture(), SupportsInputFormat(), SupportsOutputFormat(), Uid(), Version(), YuvToYuvCapabilities(), ~CPreProcessorInfo()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CPreProcessorInfo *NewL(TUid aUid, const TDesC &aManufacturer, const TDesC &aIdentifier, TVersion aVersion, TBool aAccelerated, TBool aSupportsDirectCapture, const TArray< TUncompressedVideoFormat > &aInputFormats, const TArray< TUncompressedVideoFormat > &aOutputFormats, const TArray< TUint32 > &aSupportedCombinations, TBool aSupportsArbitraryScaling, TBool aSupportsAntiAliasedScaling, const TArray< TScaleFactor > &aSupportedScaleFactors, const TYuvToYuvCapabilities &aYuvToYuvCapabilities, TUint32 aSupportedRgbRanges, TUint32 aSupportedRotations, const TDesC8 &aImplementationSpecificInfo);

Description

Creates and returns a new CPreProcessorInfo object. All data passed into this method is copied.

Parameters

TUid aUid "The uid of the pre-processor." const TDesC &aManufacturer "The manufacturer of the pre-processor." const TDesC &aIdentifier "The manufacturer-specific identifier of the pre-processor." TVersion aVersion "The version of the pre-processor." TBool aAccelerated "Whether the pre-processor is hw accelerated or not." TBool aSupportsDirectCapture "Whether the pre-processor supports direct capture." const TArray< TUncompressedVideoFormat > &aInputFormats "An array of the supported input formats." const TArray< TUncompressedVideoFormat > &aOutputFormats "An array of the supported output formats." const TArray< TUint32 > &aSupportedCombinations "An array of the supported combinations." TBool aSupportsArbitraryScaling "Whether the pre-processor supports arbitrary scaling." TBool aSupportsAntiAliasedScaling "Whether the pre-processor supports anti-alias filtering on scaling."" const TArray< TScaleFactor > &aSupportedScaleFactors "An array of the supported scale factors if arbitrary scaling isn't suported" const TYuvToYuvCapabilities &aYuvToYuvCapabilities "The yuv to yuv conversion capabilities of the pre-processor." TUint32 aSupportedRgbRanges "The supported rgb ranges." TUint32 aSupportedRotations "The supported rotations." const TDesC8 &aImplementationSpecificInfo "Implementation-specific information."

Return value

CPreProcessorInfo * "The newly created CPreProcessorInfo object."

Leave codes

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

IMPORT_C ~CPreProcessorInfo();

Description

Destructor.

IMPORT_C TUid Uid() const;

Description

Returns the pre-processor UID.

Return value

TUid "Pre-processor UID."

IMPORT_C const TDesC &Manufacturer() const;

Description

Returns the hardware device manufacturer.

Return value

const TDesC & "The hardware device manufacturer. The reference is valid until this is destroyed."

IMPORT_C const TDesC &Identifier() const;

Description

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

Return value

const TDesC & "The hardware device identifier. The reference is valid until this object is destroyed."

IMPORT_C TVersion Version() const;

Description

Returns the pre-processor version.

Return value

TVersion "Pre-processor version."

IMPORT_C TBool Accelerated() const;

Description

Returns whether the plug-in is hardware-accelerated. Hardware-accelerated pre-processors can run on an application DSP or dedicated hardware.

Return value

TBool "True if the pre-processor is hardware-accelerated."

IMPORT_C TBool SupportsDirectCapture() const;

Description

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

Return value

TBool "True if the pre-processor supports direct capture."

IMPORT_C TBool SupportsInputFormat(const TUncompressedVideoFormat &aFormat) const;

Description

Returns whether the pre-processor supports the given input format.

Parameters

const TUncompressedVideoFormat &aFormat "The format to be checked."

Return value

TBool "True if the pre-processor supports the given input format."

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

Description

Returns the input formats that the pre-processor supports.

Return value

const RArray< TUncompressedVideoFormat > & "An RArray table of supported video formats (TUncompressedVideoFormat). The reference is valid until the CPreProcessorInfo object is destroyed."

IMPORT_C TBool SupportsOutputFormat(const TUncompressedVideoFormat &aFormat) const;

Description

Returns whether the pre-processor supports the given output format.

Parameters

const TUncompressedVideoFormat &aFormat "The format to be checked."

Return value

TBool "True if the pre-processor supports the given input format."

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

Description

Returns the output formats that the pre-processor supports.

Return value

const RArray< TUncompressedVideoFormat > & "An RArray table of supported video formats (TUncompressedVideoFormat). The reference is valid until the CPreProcessorInfo object is destroyed."

IMPORT_C TBool SupportsCombination(TUint32 aCombination) const;

Description

Returns whether the pre-processor supports the given pre-processing combination.

Parameters

TUint32 aCombination "Pre-processing combination, a bitwise OR of values from TPrePostProcessType."

Return value

TBool "True if the pre-processing combination is supported."

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

Description

Lists all supported pre-processing combinations.

Return value

const RArray< TUint32 > & "An RArray table of pre-processing combinations. Each value is a bitwise OR of values from TPrePostProcessType. The reference is valid until the CPreProcessorInfo object is destroyed."

IMPORT_C TBool SupportsArbitraryScaling() const;

Description

Returns whether the pre-processor supports arbitrary scaling.

Return value

TBool "True if arbitrary scaling is supported. If arbitrary scaling is not supported, some specific scale factors can still be available."

IMPORT_C TBool SupportsAntiAliasedScaling() const;

Description

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

Return value

TBool "True if anti-aliasing filtering is supported."

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

Description

Returns the scaling factors the plug-in supports. If the plug-in supports arbitrary scaling the list is empty - use SupportsArbitraryScaling() first.

Return value

const RArray< TScaleFactor > & "An RArray list of supported scale factors (TScaleFactor). The reference is valid until the CPreProcessorInfo object is destroyed. If the pre-processor supports arbitrary scaling or no scaling at all, the list is empty."

IMPORT_C const TYuvToYuvCapabilities &YuvToYuvCapabilities() const;

Description

Returns the YUV to YUV conversion capabilities for the pre-processor.

Return value

const TYuvToYuvCapabilities & "The conversion capabilities, as a TYuvToYuvCapabilities structure. The reference is valid until the CPreProcessorInfo object is destroyed."

IMPORT_C TUint32 SupportedRgbRanges() const;

Description

Returns RGB value ranges the hardware device supports for RGB to YUV conversion.

Return value

TUint32 "The supported RGB ranges as a bitwise OR of TRgbRange values."

IMPORT_C TUint32 SupportedRotations() const;

Description

Returns the rotation types the plug-in supports.

Return value

TUint32 "The supported rotation types as a bitwise OR of TRotationType values. If the pre-processor does not support rotation, the return value is zero."

IMPORT_C const TDesC8 &ImplementationSpecificInfo() const;

Description

Returns implementation-specific information about the pre-processor.

Return value

const TDesC8 & "Implementation- specific information about the pre-processor. The data format is implementation-specific, and defined separately by the pre-processor supplier. The reference is valid until the CPreProcessorInfo object is destroyed."