IVIDDEC2_Status Struct Reference

Defines instance status parameters. More...

#include <ividdec2.h>

Collaboration diagram for IVIDDEC2_Status:

Data Fields
XDAS_Int32	size
XDAS_Int32	extendedError
	Extended error information.
XDM1_SingleBufDesc	data
XDAS_Int32	maxNumDisplayBufs
XDAS_Int32	outputHeight
XDAS_Int32	outputWidth
XDAS_Int32	frameRate
XDAS_Int32	bitRate
XDAS_Int32	contentType
	Video content types.
XDAS_Int32	outputChromaFormat
	Chroma formats.
XDM_AlgBufInfo	bufInfo

---

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 https://processors.wiki.ti.com/index.php/Extending_data_structures_in_XDM for more details.

All fields correspond to latest IVIDDEC2_Fxns::process() call on the particular instance of the decoder.

See also:

IVIDDEC2_Fxns::control()

---

Field Documentation

XDAS_Int32 IVIDDEC2_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 IVIDDEC2_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 IVIDDEC2_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 IVIDDEC2_Fxns.control() call. The algorithm must not retain a pointer to this data.

See also:

XDM_GETVERSION

XDAS_Int32 IVIDDEC2_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 IVIDDEC2_Status::outputHeight

Output height in pixels.

XDAS_Int32 IVIDDEC2_Status::outputWidth

Output width in pixels.

XDAS_Int32 IVIDDEC2_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 IVIDDEC2_Status::bitRate

Average bit rate, in bits per second.

XDAS_Int32 IVIDDEC2_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 IVIDDEC2_Status::outputChromaFormat

Chroma formats.

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:

XDM_ChromaFormat

XDM_AlgBufInfo IVIDDEC2_Status::bufInfo

Input and output buffer information.

See also:

XDM_AlgBufInfo

---

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

• packages/ti/xdais/dm/ividdec2.h