Class CPostProcessorInfo

class CPostProcessorInfo : public CBase;

Description

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.

Derivation

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

• CPostProcessorInfo - This class contains information about the post-processing functionality that a single post-processor or decoder hardware device has

Members

Defined in CPostProcessorInfo:
Accelerated(), AddSupportedScreenL(), AntiAliasedScaling(), GetSupportedScreensL(), Identifier(), ImplementationSpecificInfo(), Manufacturer(), NewL(), SupportedCombinations(), SupportedFormats(), SupportedRotations(), SupportedScaleFactors(), SupportsArbitraryScaling(), SupportsCombination(), SupportsDirectDisplay(), SupportsFormat(), Uid(), Version(), YuvToRgbCapabilities(), ~CPostProcessorInfo()

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

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

Description

Creates and returns a new CPostProcessorInfo object.

Parameters

TUid aUid "The UID of the post-processor." const TDesC &aManufacturer "The manufacturer of the post-processor hw device." const TDesC &aIdentifier "The post-processor hw device manufacturer-specific identifier." TVersion aVersion "The post-processor version." const TArray< TUncompressedVideoFormat > &aSupportedFormats "The source formats supported by the post-processor." const TArray< TUint32 > &aSupportedCombinations "The supported post-processing combinations. An array of values created by the bitwise OR-ing of values from TPrePostProcessType." TBool aAccelerated "Whether the post processor is hardware-accelerated. Accelerated post-processors can run on an application DSP or dedicated hardware." TBool aSupportsDirectDisplay "Whether the hw device supports output directly to the screen." const TYuvToRgbCapabilities &aYuvToRgbCapabilities "The post-processor YUV to RGB conversion capabilities." TUint32 aSupportedRotations "A bitwise OR of values of TRotationType to indicate the supported rotation types." TBool aSupportArbitraryScaling "Whether the post-processor supports arbitrary scaling." const TArray< TScaleFactor > &aSupportedScaleFactors "A list of the discrete scaling factors supported. If the post-processor supports arbitrary scaling, this list should be left zero-length." TBool aAntiAliasedScaling "Whether anti-aliasing filtering for scaling is supported." const TDesC8 &aImplementationSpecificInfo "Implementation-specific information."

Return value

CPostProcessorInfo * "A new CPostProcessorInfo object."

Leave codes

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

IMPORT_C ~CPostProcessorInfo();

Description

Destructor

IMPORT_C TUid Uid() const;

Description

Returns the post-processor UID.

Return value

TUid "Post-processor UID"

IMPORT_C const TDesC &Manufacturer() const;

Description

Returns the post-processor hardware device manufacturer.

Return value

const TDesC & "The manufacturer name as a standard Symbian descriptor. The reference is valid until the CPostProcessorInfo object is destroyed."

IMPORT_C const TDesC &Identifier() const;

Description

Returns the post-processor hardware device manufacturer-specific identifier. The combination of the manufacturer and identifier uniquely identifies the device.

Return value

const TDesC & "The identifier as a standard Symbian descriptor. The reference is valid until the CPostProcessorInfo object is destroyed."

IMPORT_C TVersion Version() const;

Description

Returns the post-processor version.

Return value

TVersion "Post-processor version."

IMPORT_C TBool SupportsFormat(const TUncompressedVideoFormat &aFormat) const;

Description

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

Parameters

const TUncompressedVideoFormat &aFormat "The format to check. The reference is not used after the method returns."

Return value

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

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

Description

Lists the source formats supported by the post-processor.

Return value

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

IMPORT_C TBool SupportsCombination(TUint32 aCombination) const;

Description

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

Parameters

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

Return value

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

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

Description

Lists all supported post-processing combinations.

Return value

const RArray< TUint32 > & "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 TBool Accelerated() const;

Description

Returns whether the hardware device is hardware-accelerated. Hardware-accelerated post-processors can run on an application DSP or dedicated hardware.

Return value

TBool "ETrue if the device is hardware-accelerated."

IMPORT_C TBool SupportsDirectDisplay() const;

Description

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

Return value

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

IMPORT_C const TYuvToRgbCapabilities &YuvToRgbCapabilities() const;

Description

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

Return value

const TYuvToRgbCapabilities & "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 TUint32 SupportedRotations() const;

Description

Returns the rotation types the post-processor supports.

Return value

TUint32 "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 TBool SupportsArbitraryScaling() const;

Description

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 value

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

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

Description

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

Return value

const RArray< TScaleFactor > & "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 TBool AntiAliasedScaling() 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 TDesC8 &ImplementationSpecificInfo() const;

Description

Returns implementation-specific information about the post-processor.

Return value

const TDesC8 & "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 void AddSupportedScreenL(TInt aScreenNo);

Description

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

Parameters

TInt aScreenNo

Leave codes

"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 GetSupportedScreensL(RArray< TInt > &aSupportedScreens) const;

Description

Lists the screens supported by the post processor.

Parameters

RArray< TInt > &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 codes

"KErrNotSupported if the secondary screen display is not supported in Multimedia Framework. KErrNoMemory when there is no memory to expand the list."