Defines all of the operations on IVIDDEC2BACK objects. More...

#include <ividdec2.h>

Collaboration diagram for IVIDDEC2BACK_Fxns:

Data Fields
IALG_Fxns	ialg
XDAS_Int32(*	process )(IVIDDEC2BACK_Handle handle, XDM_Context context, IVIDDEC2_OutArgs outArgs)
	Basic video decoding call.
XDAS_Int32(*	control )(IVIDDEC2BACK_Handle handle, XDM_Context context, IVIDDEC2_Status status)
	Control behavior of an algorithm.

Detailed Description

Defines all of the operations on IVIDDEC2BACK objects.

Field Documentation

IALG_Fxns IVIDDEC2BACK_Fxns::ialg

XDAIS algorithm interface.

                                  @sa      IALG_Fxns

XDAS_Int32(* IVIDDEC2BACK_Fxns::process)(IVIDDEC2BACK_Handle handle, XDM_Context *context, IVIDDEC2_OutArgs *outArgs)

Basic video decoding call.

@param[in]  handle          Handle to an algorithm instance.
@param[in,out] context      Context provided to, and managed by the
                            split codec.
@param[out] outArgs         Ouput results.  This is a required parameter.

@remarks    process() is a blocking call.  When process() returns, the
            algorithm's processing is complete.

@pre        @c context must not be NULL, and must point to a valid
            XDM_Context structure.

@pre        @c context->numInOutBufs must be zero (0).

@pre        @c outArgs must not be NULL, and must point to a valid
            IVIDDEC2_OutArgs structure.

@post       The buffers in @c context are
            owned by the calling application.

@retval     IVIDDEC2_EOK            \copybrief IVIDDEC2_EOK

Success.

Return values:

IVIDDEC2_EFAIL	General failure. See IVIDDEC2_Status::extendedError for more detailed further error conditions.
IVIDDEC2_EUNSUPPORTED	Request is unsupported.

XDAS_Int32(* IVIDDEC2BACK_Fxns::control)(IVIDDEC2BACK_Handle handle, XDM_Context *context, IVIDDEC2_Status *status)

Control behavior of an algorithm.

@param[in]  handle          Handle to an algorithm instance.
@param[in]  context         Codec context.  This is a required
                            parameter.
@param[out] status          Output results.  This is a required parameter.

@pre        @c handle must be a valid algorithm instance handle.

@pre        @c context must not be NULL, and must point to a valid
            XDM_Context structure.

@pre        @c status must not be NULL, and must point to a valid
            IVIDDEC2_Status structure.

@pre        If a buffer is provided in the @c status->data field,
            it must be physically contiguous and owned by the calling
            application.

@post       If a buffer was provided in the @c status->data field,
            it is owned by the calling application.

@retval     IVIDDEC2_EOK            \copybrief IVIDDEC2_EOK

Success.

Return values:

IVIDDEC2_EFAIL	General failure. See IVIDDEC2_Status::extendedError for more detailed further error conditions.
IVIDDEC2_EUNSUPPORTED	Request is unsupported.

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

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

Data Fields

Detailed Description

Field Documentation