IIMGDEC_OutArgs Struct Reference
[XDM IIMGDEC Image Decoder Interface]

#include <iimgdec.h>

Detailed Description

Defines the run time output arguments for all IIMGDEC 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 also:
IIMGDEC1_Fxns::process()


Data Fields

XDAS_Int32 size
XDAS_Int32 extendedError
XDAS_Int32 bytesconsumed
XDAS_Int32 currentAU
XDAS_Int32 currentScan

Field Documentation

XDAS_Int32 IIMGDEC_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 IIMGDEC_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.

See also:
XDM_ErrorBit

XDAS_Int32 IIMGDEC_OutArgs::bytesconsumed

Number of bytes consumed during the process() call.

XDAS_Int32 IIMGDEC_OutArgs::currentAU

Current access unit number.

XDAS_Int32 IIMGDEC_OutArgs::currentScan

Current scan number.

The documentation for this struct was generated from the following file:
Copyright 2009, Texas Instruments Incorporated