IIMGDEC1_Status Struct Reference
[XDM IIMGDEC1 Image Decoder Interface]

Defines instance status parameters. More...

#include <iimgdec1.h>

Collaboration diagram for IIMGDEC1_Status:

[legend]

Data Fields
XDAS_Int32	size
XDAS_Int32	extendedError
XDM1_SingleBufDesc	data
XDAS_Int32	outputHeight
XDAS_Int32	outputWidth
XDAS_Int32	imageWidth
XDAS_Int32	outputChromaFormat
XDAS_Int32	totalAU
XDAS_Int32	totalScan
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 http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.

See also:

IIMGDEC1_Fxns::control()

---

Field Documentation

XDAS_Int32 IIMGDEC1_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 IIMGDEC1_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 IIMGDEC1_Status::data

Buffer descriptor for data passing.

Remarks:

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

See also:

XDM_GETVERSION

XDAS_Int32 IIMGDEC1_Status::outputHeight

Output height.

XDAS_Int32 IIMGDEC1_Status::outputWidth

Output width. Padding should be taken care of by the decoder.

XDAS_Int32 IIMGDEC1_Status::imageWidth

Image width.

XDAS_Int32 IIMGDEC1_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

XDAS_Int32 IIMGDEC1_Status::totalAU

Total number of Access Units.

XDAS_Int32 IIMGDEC1_Status::totalScan

Total number of scans.

XDM_AlgBufInfo IIMGDEC1_Status::bufInfo

Input and output buffer information.

See also:

XDM_AlgBufInfo

---

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

• iimgdec1.h