IVIDDEC1_OutArgs Struct Reference

Defines the run time output arguments for all IVIDDEC1 instance objects. More...

#include <ividdec1.h>

Collaboration diagram for IVIDDEC1_OutArgs:

Data Fields
XDAS_Int32	size
XDAS_Int32	bytesConsumed
XDAS_Int32	outputID [16]
IVIDEO1_BufDesc	decodedBufs
IVIDEO1_BufDesc	displayBufs [16]
XDAS_Int32	outputMbDataID
XDM1_SingleBufDesc	mbDataBuf
XDAS_Int32	freeBufID [16]
XDAS_Int32	outBufsInUseFlag

---

Detailed Description

Defines the run time output arguments for all IVIDDEC1 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 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.

See also:

IVIDDEC1_Fxns::process()

---

Field Documentation

XDAS_Int32 IVIDDEC1_OutArgs::size

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

XDAS_Int32 IVIDDEC1_OutArgs::bytesConsumed

Number of bytes consumed during the process() call.

XDAS_Int32 IVIDDEC1_OutArgs::outputID[16]

Output ID corresponding to displayBufs[].

Remarks:

A value of zero (0) indicates an invalid ID. The first zero entry in array will indicate end of valid outputIDs within the array. Hence the application can stop reading the array when it encounters the first zero entry.

See also:

IVIDDEC1_OutArgs::displayBufs

IVIDDEC1_InArgs::inputID

IVIDEO1_BufDesc IVIDDEC1_OutArgs::decodedBufs

The decoder fills this structure with buffer pointers to the decoded frame. Related information fields for the decoded frame are also populated.

When frame decoding is not complete, as indicated by outBufsInUseFlag, the frame data in this structure will be incomplete. However, the algorithm will provide incomplete decoded frame data in case application may choose to use it for error recovery purposes.

See also:

IVIDDEC1_OutArgs::outBufsInUseFlag

IVIDEO1_BufDesc IVIDDEC1_OutArgs::displayBufs[16]

Array containing display frames corresponding to valid ID entries in the outputID[] array.

Remarks:

Entries in the array corresponding to invalid ID values (zero) in outputID[] will set zero value for the following fields in the IVIDEO1_BufDesc structure: numBufs, frameWidth, frameHeight, and framePitch.

Implied by the previous remark, as this array corresponds to buffer IDs indicated by outputID[], elements of this array are undefined if the corresponding outputID[] element is zero (0).

XDAS_Int32 IVIDDEC1_OutArgs::outputMbDataID

Output ID corresponding with the MB Data

Remarks:

This will be set to zero when there is no MB Data Buffer

XDM1_SingleBufDesc IVIDDEC1_OutArgs::mbDataBuf

The decoder populates the last buffer among the buffers supplied within outBufs->bufs[] with the decoded MB data generated by the ECD module. The pointer buffer along with the buffer size is output via this buffer descriptor.

XDAS_Int32 IVIDDEC1_OutArgs::freeBufID[16]

This is an array of inputID's corresponding to the buffers that have been unlocked in the current process call.

Remarks:

Buffers returned to the application for display (via IVIDDEC1_OutArgs::displayBufs) continue to be owned by the algorithm until they are released - indicated by the ID being returned in this freeBuf array.

The buffers released by the algorithm are indicated by their non-zero ID (previously provided via IVIDDEC1_InArgs::inputID).

A value of zero (0) indicates an invalid ID. The first zero entry in array will indicate end of valid freeBufIDs within the array. Hence the application can stop searching the array when it encounters the first zero entry.

If no buffer was unlocked in the process call, freeBufID[0] will have a value of zero.

See also:

IVIDDEC1_InArgs::inputID

IVIDDEC1_OutArgs::displayBufs

XDAS_Int32 IVIDDEC1_OutArgs::outBufsInUseFlag

Flag to indicate that the outBufs provided with the process() call are in use. No outBufs are required to be supplied with the next process() call.

Remarks:

Valid values are XDAS_TRUE and XDAS_FALSE.

---

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

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