Defines all of the operations on IVIDENC2 objects. More...
#include <ividenc2.h>
Data Fields | |
IALG_Fxns | ialg |
XDAS_Int32(* | process )(IVIDENC2_Handle handle, IVIDEO2_BufDesc *inBufs, XDM2_BufDesc *outBufs, IVIDENC2_InArgs *inArgs, IVIDENC2_OutArgs *outArgs) |
Basic video encoding call. | |
XDAS_Int32(* | control )(IVIDENC2_Handle handle, IVIDENC2_Cmd id, IVIDENC2_DynamicParams *params, IVIDENC2_Status *status) |
Control behavior of an algorithm. |
Defines all of the operations on IVIDENC2 objects.
XDAIS algorithm interface.
XDAS_Int32(* IVIDENC2_Fxns::process)(IVIDENC2_Handle handle, IVIDEO2_BufDesc *inBufs, XDM2_BufDesc *outBufs, IVIDENC2_InArgs *inArgs, IVIDENC2_OutArgs *outArgs) |
Basic video encoding call.
[in] | handle | Handle to an algorithm instance. |
[in,out] | inBufs | Input video buffer descriptors. |
[in,out] | outBufs | Output buffer descriptors. The algorithm may modify the output buffer pointers. |
[in] | inArgs | Input arguments. This is a required parameter. |
[out] | outArgs | Ouput results. This is a required parameter. |
inBufs
must not be NULL, and must point to a valid IVIDEO2_BufDesc structure.inBufs->numPlanes
will indicate the total number of input buffers supplied for input frame in the inBufs->planeDesc
[] array.inBufs->numMetaPlanes
will indicate the total number of input buffers supplied for meta data planes in the inBufs->metadataPlaneDesc
[] array.outBufs
must not be NULL, and must point to a valid XDM2_BufDesc structure.outBufs->buf
[0] must not be NULL, and must point to a valid buffer of data that is at least outBufs->bufSizes
[0] bytes in length.inArgs
must not be NULL, and must point to a valid IVIDENC2_InArgs structure.outArgs
must not be NULL, and must point to a valid IVIDENC2_OutArgs structure.inBuf
and outBuf
are physically contiguous and owned by the calling application.inArgs
.inBufs
, with the exception of inBufs.bufDesc
[].accessMask. That is, the data and buffers pointed to by these parameters must be treated as read-only.inBufs
to indicate the mode in which each of the respective buffers were read. For example, if the algorithm only read from inBufs.planeDesc
[0].buf using the algorithm processor, it could utilize XDM_SETACCESSMODE_READ to update the appropriate accessMask
fields. The application may utilize these returned values to appropriately manage cache.inBufs
are owned by the calling application.IVIDENC2_EOK | Success. |
IVIDENC2_EFAIL | General failure. See IVIDENC2_Status.extendedError for more detailed further error conditions. |
IVIDENC2_EUNSUPPORTED | Request is unsupported. |
inBufs
and outBufs
are correctly described. XDAS_Int32(* IVIDENC2_Fxns::control)(IVIDENC2_Handle handle, IVIDENC2_Cmd id, IVIDENC2_DynamicParams *params, IVIDENC2_Status *status) |
Control behavior of an algorithm.
[in] | handle | Handle to an algorithm instance. |
[in] | id | Command id. See XDM_CmdId. |
[in] | params | Dynamic parameters. This is a required parameter. |
[out] | status | Output results. This is a required parameter. |
handle
must be a valid algorithm instance handle.params
must not be NULL, and must point to a valid IVIDENC2_DynamicParams structure.status
must not be NULL, and must point to a valid IVIDENC2_Status structure.status->data
field, it must be physically contiguous and owned by the calling application.params
. That is, the data pointed to by this parameter must be treated as read-only.status->data
field, it is owned by the calling application.IVIDENC2_EOK | Success. |
IVIDENC2_EFAIL | General failure. See IVIDENC2_Status.extendedError for more detailed further error conditions. |
IVIDENC2_EUNSUPPORTED | Request is unsupported. |