IVIDDEC2FRONT_Status Struct Reference

Defines instance status parameters. More...

#include <ividdec2.h>

Collaboration diagram for IVIDDEC2FRONT_Status:

Data Fields
XDM_ContextInfo	contextInfo
XDAS_Int32	nextPartRequiredFlag
XDAS_Int32	partialExtendedError
	Extended error information.
IVIDDEC2_Status	fullStatus

---

Detailed Description

Defines instance status parameters.

Remarks:

All fields correspond to latest IVIDDEC2FRONT_Fxns::process() call on the particular instance of the decoder.

See also:

IVIDDEC2FRONT_Fxns::control()

---

Field Documentation

XDM_ContextInfo IVIDDEC2FRONT_Status::contextInfo

Context info.

                                @remarks   Only valid when the cmd issued
                                           to control() is
                                           XDM_GETCONTEXTINFO.

XDAS_Int32 IVIDDEC2FRONT_Status::nextPartRequiredFlag

Flag indicating whether the next part in the split codec must be called or not.

Remarks:

If the control() call returned IVIDDEC2_EOK, and this nextPartRequiredFlag field is XDAS_TRUE, the application must call the next part in the split codec.

If the control() call returned failure (i.e., something other than IVIDDEC2_EOK), the codec must set this field to XDAS_FALSE. Further information about the failure can be obtained via the partialExtendedError field.

XDAS_Int32 IVIDDEC2FRONT_Status::partialExtendedError

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

                                @remarks   This field should be
                                           filled by the codec
                                           if the control() call
                                           does not return
                                           IVIDDEC2_EOK.  Otherwise,
                                           it is an undefined output
                                           field.

IVIDDEC2_Status IVIDDEC2FRONT_Status::fullStatus

Complete status results.

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

                                 @remarks   The @c size field of this
                                            structure must be
                                            filled by the
                                            application before
                                            calling control().
                                            This is necessary even
                                            if the FRONT codec is
                                            unable to complete the
                                            request (e.g., the
                                            codec sets the
                                            @c nextPartRequiredFlag
                                            to XDAS_TRUE) and
                                            further parts of
                                            the codec must be
                                            called.  This @c size
                                            field indicates to the
                                            codec whether any
                                            codec-specific
                                            extensions are
                                            requested.

                                 @remarks   The @c fullStatus.size
                                            field should only
                                            indicate the size of
                                            the [potentially
                                            extended]
                                            @c fullStatus
                                            structure.

                                 @remarks   This field should be used if
                                            @c nextPartRequiredFlag is
                                            XDAS_FALSE.

                                 @remarks   This struct, with the
                                            exception of the
                                            @c size field,
                                            will be populated by
                                            the codec.  If the
                                            control() call returns
                                            IVIDDEC2_EOK, the
                                            application must
                                            inspect the
                                            @c nextPartRequiredFlag
                                            field to determine
                                            whether it must
                                            call the next part
                                            or whether this
                                            @c fullStatus field
                                            contains the
                                            complete results
                                            of the control()
                                            call.

                                 @remarks   The @c fullStatus.data
                                            field should not be
                                            used to provide
                                            buffers to split
                                            codecs.  In the same
                                            way the application
                                            provides data buffers
                                            to process() via an
                                            XDM_Context argument,
                                            control() does the
                                            same.  As a result,
                                            the
                                            @c fullStatus.data
                                            field is ignored
                                            and unused in this
                                            struct.

                                 @remarks   If control() is called with
                                            the #XDM_GETVERSION
                                            command, the
                                            application must
                                            provide the buffer
                                            into which the codec
                                            will place its version
                                            string in the
                                            @c context->outBuffers[0]
                                            field.

---

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

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