Defines the creation time parameters for all IVIDDEC3 instance objects. More...

#include <ividdec3.h>

Collaboration diagram for IVIDDEC3_Params:

Data Fields
XDAS_Int32	size
XDAS_Int32	maxHeight
XDAS_Int32	maxWidth
XDAS_Int32	maxFrameRate
XDAS_Int32	maxBitRate
XDAS_Int32	dataEndianness
XDAS_Int32	forceChromaFormat
	Chroma formats.
XDAS_Int32	operatingMode
XDAS_Int32	displayDelay
	Video decoder output frame order.
XDAS_Int32	inputDataMode
XDAS_Int32	outputDataMode
XDAS_Int32	numInputDataUnits
XDAS_Int32	numOutputDataUnits
XDAS_Int32	errorInfoMode
XDAS_Int32	displayBufsMode
XDAS_Int32	metadataType [3]

Detailed Description

Defines the creation time parameters for all IVIDDEC3 instance objects.

@remarks This structure may be extended by individual codec implementations allowing customization with vendor specific parameters.  The presence of vendor specific extensions will be detected by the value of the @c size parameter.

Remarks:: The size field must be correctly set by the caller. See https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

Field Documentation

XDAS_Int32 IVIDDEC3_Params::size

Size of this structure in bytes. Because this structure can be extended, this field must be correctly set by the caller.

XDAS_Int32 IVIDDEC3_Params::maxHeight

Maximum video height in pixels.

XDAS_Int32 IVIDDEC3_Params::maxWidth

Maximum video width in pixels.

XDAS_Int32 IVIDDEC3_Params::maxFrameRate

Maximum frame rate in fps * 1000. For example, if max frame rate is 30 frames per second, set this field to 30000.

XDAS_Int32 IVIDDEC3_Params::maxBitRate

Maximum bit rate, bits per second. For example, if bit rate is 10 Mbps, set this field to 10000000

XDAS_Int32 IVIDDEC3_Params::dataEndianness

Endianness of output data.

                                @sa XDM_DataFormat

XDAS_Int32 IVIDDEC3_Params::forceChromaFormat

Chroma formats.

@remarks This enumeration data type should not be used for storage, but rather only for its constant values.

@remarks This enumeration defines a base set of values.  Algorithms which require proprietary enumeration values may define them - much like extended fields in base structures.  These extended enums should be between #XDM_CUSTOMENUMBASE and 0x7FFF.

See also:: XDM_CUSTOMENUMBASE

                                 @sa XDM_ChromaFormat

XDAS_Int32 IVIDDEC3_Params::operatingMode

Video coding mode of operation.

                                @sa IVIDEO_OperatingMode

XDAS_Int32 IVIDDEC3_Params::displayDelay

Video decoder output frame order.

Remarks:: This enumeration data type should not be used for storage, but rather only for its constant values.

See also:: IVIDDEC3_Params.displayDelay

                                 @sa IVIDDEC3_displayDelay

XDAS_Int32 IVIDDEC3_Params::inputDataMode

Input data mode.

                                @remarks   If a subframe mode is provided,
                                           the application must call
                                           IVIDDEC3_Fxns.control() with
                                           #XDM_SETPARAMS id prior to
                                           IVIDDEC3_Fxns.process() to
                                           set
                                           IVIDDEC3_DynamicParams.getDataFxn()
                                           and
                                           IVIDDEC3_DynamicParams.getDataHandle
                                           (and optionally
                                           IVIDDEC3_DynamicParams.putBufferFxn(),
                                           and
                                           IVIDDEC3_DynamicParams.putBufferHandle).
                                           Else, the alg can return error.

                                @sa IVIDEO_DataMode

XDAS_Int32 IVIDDEC3_Params::outputDataMode

Output data mode.

                                @remarks   If a subframe mode is provided,
                                           the application must call
                                           IVIDDEC3_Fxns.control() with
                                           #XDM_SETPARAMS id prior to
                                           #IVIDDEC3_Fxns.process() to
                                           set
                                           IVIDDEC3_DynamicParams.putDataFxn(),
                                           and
                                           IVIDDEC3_DynamicParams.putDataHandle.
                                           Else, the alg can return error.

                                @sa IVIDEO_DataMode

XDAS_Int32 IVIDDEC3_Params::numInputDataUnits

Number of input slices/rows.

                                @remarks   Units depend on the
                                           IVIDDEC3_Params.inputDataMode,
                                           like number of
                                           slices/rows/blocks etc.

                                @remarks   Ignored if
                                           IVIDDEC3_Params.inputDataMode
                                           is set to full frame mode.

XDAS_Int32 IVIDDEC3_Params::numOutputDataUnits

Number of output slices/rows.

                                @remarks   Units depend on the
                                           IVIDDEC3_Params.outputDataMode,
                                           like number of
                                           slices/rows/blocks etc.

                                @remarks   Ignored if
                                           IVIDDEC3_Params.outputDataMode
                                           is set to full frame mode.

XDAS_Int32 IVIDDEC3_Params::errorInfoMode

Enable/disable packet error information for input and/or output.

See also:: IVIDEO_ErrorInfoMode

XDAS_Int32 IVIDDEC3_Params::displayBufsMode

Indicates which mode the displayBufs are presented in.

Remarks:: See the IVIDDEC3_DisplayBufsMode enum for the values this field may contain.

See also:: IVIDDEC3_OutArgs.displayBufsMode; IVIDDEC3_DisplayBufsMode

XDAS_Int32 IVIDDEC3_Params::metadataType[3]

Type of each metadata plane.

See also:: IVIDEO_MetadataType

The documentation for this struct was generated from the following file:

cetools/packages/ti/xdais/dm/ividdec3.h

Data Fields

Detailed Description

Field Documentation