|
|
|
Codec Engine Application Programming Interface (API)
ce-w08
|
Defines all of the operations on IVIDDEC2FRONT objects. More...
#include <ividdec2.h>
Data Fields | |
| IALG_Fxns | ialg |
| XDAS_Int32(* | process )(IVIDDEC2FRONT_Handle handle, IVIDDEC2_InArgs *inArgs, XDM_Context *context, IVIDDEC2FRONT_OutArgs *outArgs) |
| Basic video decoding call. | |
| XDAS_Int32(* | control )(IVIDDEC2FRONT_Handle handle, IVIDDEC2_Cmd id, IVIDDEC2_DynamicParams *params, XDM_Context *context, IVIDDEC2FRONT_Status *status) |
| Control behavior of an algorithm. | |
Defines all of the operations on IVIDDEC2FRONT objects.
| IALG_Fxns IVIDDEC2FRONT_Fxns::ialg |
XDAIS algorithm interface.
@sa IALG_Fxns
| XDAS_Int32(* IVIDDEC2FRONT_Fxns::process)(IVIDDEC2FRONT_Handle handle, IVIDDEC2_InArgs *inArgs, XDM_Context *context, IVIDDEC2FRONT_OutArgs *outArgs) |
Basic video decoding call.
@param[in] handle Handle to an algorithm instance.
@param[in] inArgs Input arguments. This is a required
parameter.
@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.
@remarks The application must call IVIDDEC2FRONT::control() with
#XDM_GETCONTEXTINFO to obtain the minimum buffer sizes
the codec requires.
@remarks @c context includes input and output buffers, intermediate
buffers, and other values used by the codec. See
#XDM_Context for more details.
@pre @c context->numInBufs will indicate the total number of input
buffers supplied for input frame, and conditionally, the
encoders MB data buffer.
@pre If IVIDDEC2_DynamicParams::mbDataFlag was set to #XDAS_FALSE
in a previous control() call, the application only needs to
provide buffers for reconstruction frames.
@pre If IVIDDEC2_DynamicParams::mbDataFlag was set to #XDAS_TRUE
in a previous control() call,
@c context->outBufs[context->numOutBufs - 1] is a buffer
descriptor into which the algorithm will write MB data
for each macro block. The size of the MB data buffer
will vary based on the decoder type. H.264 may
generate N264 bytes per MB, while Mpeg2 may generate
NMP2 bytes. The exact size of the buffers should be
obtained by calling the algorithm's control() method
with XDM_GETBUFINFO.
@pre @c inArgs must not be NULL, and must point to a valid
IVIDDEC2_InArgs structure.
@pre @c outArgs must not be NULL, and must point to a valid
IVIDDEC2FRONT_OutArgs structure.
@pre @c context must not be NULL, and must point to a valid
XDM_Context structure.
@pre @c context->inBufs[0].buf must not be NULL, and must point to
a valid buffer of data that is at least
@c context->inBufs[0].bufSize bytes in length.
@pre @c context->outBufs[0] must not be NULL, and must point to
a valid buffer of data that is at least
@c context->outBufs[0].bufSize bytes in length.
@pre @c context->numInOutBufs must be zero (0).
@pre The buffers in @c context->inBufs and @c context->outBufs are
physically contiguous and owned by the calling application.
@post The algorithm <b>must not</b> modify the contents of @c inArgs.
@post The algorithm <b>must not</b> modify the contents of
@c context->inBufs, with the exception of
@c context->inBufs[].accessMask.
That is, the data and buffers pointed to by these parameters
must be treated as read-only.
@post The algorithm <b>must</b> modify the contents of
@c context->inBufs[].accessMask and appropriately indicate the
mode in which each of the buffers in @c context->inBufs were
read. For example, if the algorithm only read from
@c context->inBufs[0].buf using the algorithm processor, it
could utilize #XDM_SETACCESSMODE_READ to update the appropriate
@c accessMask fields.
The application <i>may</i> utilize these
returned values to appropriately manage cache.
@post The buffers in @c context->inBufs and @c context->outBufs are
not owned by the calling application.
@post The buffers in @c context->algContext and
@c context->intermediateBufs[] are owned by the calling
application, but must be provided - unmodified - to the
next part in this split codec.
@retval IVIDDEC2_EOK \copybrief IVIDDEC2_EOK
Success.
| IVIDDEC2_EFAIL | General failure. See IVIDDEC2_Status::extendedError for more detailed further error conditions. |
| IVIDDEC2_EUNSUPPORTED | Request is unsupported. |
| XDAS_Int32(* IVIDDEC2FRONT_Fxns::control)(IVIDDEC2FRONT_Handle handle, IVIDDEC2_Cmd id, IVIDDEC2_DynamicParams *params, XDM_Context *context, IVIDDEC2FRONT_Status *status) |
Control behavior of an algorithm.
@param[in] handle Handle to an algorithm instance.
@param[in] id Command id. See #XDM_CmdId.
@param[in] params Dynamic parameters. This is a required
parameter.
@param[in,out] context Context provided to, and managed by the
split codec.
@param[out] status Output results. This is a required parameter.
@pre @c handle must be a valid algorithm instance handle.
@pre @c params must not be NULL, and must point to a valid
IVIDDEC2_DynamicParams structure.
@pre @c status must not be NULL, and must point to a valid
IVIDDEC2FRONT_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 The algorithm <b>must not</b> modify the contents of @c params.
That is, the data pointed to by this parameter must be
treated as read-only.
@post If a buffer was provided in the @c status->data field,
it is owned by the calling application.
@remark @c context <i>may</i> be NULL. The FRONT part of a codec
<i>may</i> be capable of completely handling the control()
command. The codec indicates this the application is sure the
FRONT part of the codec can return and must point to a valid
XDM_Context structure.
@retval IVIDDEC2_EOK \copybrief IVIDDEC2_EOK
Success.
| IVIDDEC2_EFAIL | General failure. See IVIDDEC2_Status::extendedError for more detailed further error conditions. |
| IVIDDEC2_EUNSUPPORTED | Request is unsupported. |