IVIDDEC3_Status Struct Reference [IVIDDEC3 - XDM Video Decoder Interface]

Defines instance status parameters. More...

#include <ividdec3.h>

Collaboration diagram for IVIDDEC3_Status:

Data Fields
XDAS_Int32	size
XDAS_Int32	extendedError
XDM1_SingleBufDesc	data
XDAS_Int32	maxNumDisplayBufs
XDAS_Int32	maxOutArgsDisplayBufs
XDAS_Int32	outputHeight
XDAS_Int32	outputWidth
XDAS_Int32	frameRate
XDAS_Int32	bitRate
XDAS_Int32	contentType
XDAS_Int32	sampleAspectRatioHeight
XDAS_Int32	sampleAspectRatioWidth
XDAS_Int32	bitRange
XDAS_Int32	forceChromaFormat
XDAS_Int32	operatingMode
XDAS_Int32	frameOrder
XDAS_Int32	inputDataMode
XDAS_Int32	outputDataMode
XDM1_AlgBufInfo	bufInfo
XDAS_Int32	numInputDataUnits
XDAS_Int32	numOutputDataUnits
XDAS_Int32	configurationID
XDAS_Int32	metadataType [3]
IVIDDEC3_DynamicParams	decDynamicParams

---

Detailed Description

Defines instance status parameters.

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 size parameter.

The size field must be correctly set by the caller. See http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:

IVIDDEC3_Fxns::control()

---

Field Documentation

XDAS_Int32 IVIDDEC3_Status::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_Status::extendedError

Extended error information.

Remarks:

When an internal error occurs, the algorithm will return an error return value (e.g. EFAIL, EUNSUPPORTED)

The value of each enum is the bit which is set.

Bits 31-16 are reserved. Bits 7-0 are codec and implementation specific.

The algorithm can set multiple bits to 1 based on conditions. e.g. it will set bits XDM_FATALERROR (fatal) and XDM_UNSUPPORTEDPARAM (unsupported params) in case of unsupported run time parameters.

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

See also:

XDM_ErrorBit

XDM1_SingleBufDesc IVIDDEC3_Status::data

Buffer descriptor for data passing.

Remarks:

If this field is not used, the application must set data.buf to NULL.

This buffer can be used as either input or output, depending on the command.

The buffer will be provided by the application, and returned to the application upon return of the IVIDDEC3_Fxns.control() call. The algorithm must not retain a pointer to this data.

See also:

XDM_GETVERSION

XDAS_Int32 IVIDDEC3_Status::maxNumDisplayBufs

The maximum number of buffers that will be required by the codec.

Remarks:

The maximum number of buffers can be IVIDEO2_MAX_IO_BUFFERS.

XDAS_Int32 IVIDDEC3_Status::maxOutArgsDisplayBufs

The maximum number of display buffers that can be returned via IVIDDEC3_OutArgs.displayBufs.

Remarks:

If returning display buffers embedded into the OutArgs struct, this field provides the size of the OutArgs.displayBufs.bufDesc[] array.

XDAS_Int32 IVIDDEC3_Status::outputHeight

Output height in pixels.

XDAS_Int32 IVIDDEC3_Status::outputWidth

Output width in pixels.

XDAS_Int32 IVIDDEC3_Status::frameRate

Average frame rate in fps * 1000. For example, if average frame rate is 30 frames per second, this field should be 30000.

XDAS_Int32 IVIDDEC3_Status::bitRate

Average bit rate, in bits per second.

XDAS_Int32 IVIDDEC3_Status::contentType

Video content types.

Remarks:

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

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

See also:

IVIDEO_ContentType

XDAS_Int32 IVIDDEC3_Status::sampleAspectRatioHeight

Sample aspect ratio height.

XDAS_Int32 IVIDDEC3_Status::sampleAspectRatioWidth

Sample aspect ratio width.

XDAS_Int32 IVIDDEC3_Status::bitRange

Full 8 bit, CCIR 601

XDAS_Int32 IVIDDEC3_Status::forceChromaFormat

Output chroma format.

See also:

XDM_ChromaFormat

XDAS_Int32 IVIDDEC3_Status::operatingMode

Video decoding mode of operation.

See also:

IVIDEO_OperatingMode

XDAS_Int32 IVIDDEC3_Status::frameOrder

Frame Order

Remarks:

This field reflects the value provided during creation in IVIDDEC3_Params.displayDelay

XDAS_Int32 IVIDDEC3_Status::inputDataMode

Input data mode.

See also:

IVIDDEC3_Params.inputDataMode

IVIDEO_DataMode

XDAS_Int32 IVIDDEC3_Status::outputDataMode

Output data mode.

See also:

IVIDDEC3_Params.outputDataMode

IVIDEO_DataMode

XDM1_AlgBufInfo IVIDDEC3_Status::bufInfo

Input and output buffer information.

Remarks:

This field provides the application with the algorithm's buffer requirements. The requirements may vary depending on the current configuration of the algorithm instance.

See also:

XDM1_AlgBufInfo

XDAS_Int32 IVIDDEC3_Status::numInputDataUnits

Number of input slices/rows.

Remarks:

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

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

See also:

IVIDDEC3_Params.inputDataMode

XDAS_Int32 IVIDDEC3_Status::numOutputDataUnits

Number of output slices/rows.

Remarks:

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

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

See also:

IVIDDEC3_Params.outputDataMode

XDAS_Int32 IVIDDEC3_Status::configurationID

Configuration ID of given codec.

Remarks:

This is based on the input stream & can be used by the framework to optimize the save/restore overhead of any resources used.

This can be useful in multichannel use case scenarios.

XDAS_Int32 IVIDDEC3_Status::metadataType[3]

Type of each metadata plane.

See also:

IVIDEO_MetadataType

IVIDDEC3_DynamicParams IVIDDEC3_Status::decDynamicParams

Current values of the decoder's dynamic parameters.

Remarks:

This is the last field in the base struct as it can be extended.

---

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

• ividdec3.h