IVIDDEC2_DynamicParams Struct Reference

This structure defines the codec parameters that can be modified after creation via control() calls. More...

#include <ividdec2.h>

Collaboration diagram for IVIDDEC2_DynamicParams:

Data Fields
XDAS_Int32	size
XDAS_Int32	decodeHeader
	Decode entire access unit or only header.
XDAS_Int32	displayWidth
XDAS_Int32	frameSkipMode
	Video frame skip features for video decoder.
XDAS_Int32	frameOrder
	Video decoder output frame order.
XDAS_Int32	newFrameFlag
XDAS_Int32	mbDataFlag

---

Detailed Description

This structure defines the codec parameters that can be modified after creation via control() calls.

@remarks    It is not necessary that a given implementation support all
            dynamic parameters to be configurable at run time.  If a
            particular algorithm does not support run-time updates to
            a parameter that the application is attempting to change
            at runtime, it may indicate this as an error.

@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 @c size parameter.

Remarks:

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.

@sa         IVIDDEC2_Fxns::control()

---

Field Documentation

XDAS_Int32 IVIDDEC2_DynamicParams::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_DynamicParams::decodeHeader

Decode entire access unit or only header.

@remarks This enumeration data type should not be used for storage, but rather only for its constant values.

@remarks 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

                                 @sa XDM_DecMode

XDAS_Int32 IVIDDEC2_DynamicParams::displayWidth

Pitch. If set to zero, use the decoded image width. Else, use given display width in pixels.

XDAS_Int32 IVIDDEC2_DynamicParams::frameSkipMode

Video frame skip features for video decoder.

@remarks This enumeration data type should not be used for storage, but rather only for its constant values.

@remarks 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

                                 @sa IVIDEO_FrameSkip

XDAS_Int32 IVIDDEC2_DynamicParams::frameOrder

Video decoder output frame order.

Remarks:

This enumeration data type should not be used for storage, but rather only for its constant values.

See also:

IVIDDEC2_DynamicParams::frameOrder

                                 @sa IVIDDEC2_FrameOrder

XDAS_Int32 IVIDDEC2_DynamicParams::newFrameFlag

Flag to indicate that the algorithm should start a new frame.

Remarks:

Valid values are XDAS_TRUE and XDAS_FALSE.

This is useful for error recovery, for example when the end of frame cannot be detected by the codec but is known to the application.

XDAS_Int32 IVIDDEC2_DynamicParams::mbDataFlag

Flag to indicate that the algorithm should generate MB Data in addition to decoding the data.

Remarks:

Valid values are XDAS_TRUE and XDAS_FALSE.

See also:

IVIDDEC2_OutArgs::mbDataBuf

---

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

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