IVIDDEC_OutArgs Struct Reference
[XDM IVIDDEC Video Decoder Interface]

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

#include <ividdec.h>

Collaboration diagram for IVIDDEC_OutArgs:

[legend]

Data Fields
XDAS_Int32	size
XDAS_Int32	extendedError
XDAS_Int32	bytesConsumed
XDAS_Int32	decodedFrameType
XDAS_Int32	outputID
IVIDEO_BufDesc	displayBufs

---

Detailed Description

Defines the run time output arguments for all IVIDDEC 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 http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:

IVIDDEC_Fxns::process()

---

Field Documentation

XDAS_Int32 IVIDDEC_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 IVIDDEC_OutArgs::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.

.

XDAS_Int32 IVIDDEC_OutArgs::bytesConsumed

Bytes consumed.

XDAS_Int32 IVIDDEC_OutArgs::decodedFrameType

Decoded frame type. See IVIDEO_FrameType.

XDAS_Int32 IVIDDEC_OutArgs::outputID

Output ID. Refer to comment IVIDDEC_InArgs::inputID.

IVIDEO_BufDesc IVIDDEC_OutArgs::displayBufs

The decoder fills this structure to denote the buffer pointers for current displayable frames. In case of sequences having I & P frames only, these values are identical to outBufs passed in process().

---

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

• ividdec.h