Defines all of the operations on IVIDANALYTICS objects. More...
#include <ividanalytics.h>
Data Fields | |
IALG_Fxns | ialg |
XDAS_Int32(* | process )(IVIDANALYTICS_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IVIDANALYTICS_InArgs *inArgs, IVIDANALYTICS_OutArgs *outArgs) |
Basic video decoding call. | |
XDAS_Int32(* | control )(IVIDANALYTICS_Handle handle, IVIDANALYTICS_Cmd id, IVIDANALYTICS_DynamicParams *params, IVIDANALYTICS_Status *status) |
Control behavior of an algorithm. |
Defines all of the operations on IVIDANALYTICS objects.
XDAIS algorithm interface.
XDAS_Int32(* IVIDANALYTICS_Fxns::process)(IVIDANALYTICS_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IVIDANALYTICS_InArgs *inArgs, IVIDANALYTICS_OutArgs *outArgs) |
Basic video decoding call.
[in] | handle | Handle to an algorithm instance. |
[in,out] | inBufs | Input 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->numBufs
will indicate the total number of input buffers supplied for input frame.inArgs
must not be NULL, and must point to a valid IVIDANALYTICS_InArgs structure.outArgs
must not be NULL, and must point to a valid IVIDANALYTICS_OutArgs structure.inBufs
must not be NULL, and must point to a valid XDM1_BufDesc structure.inBufs->descs
[0].buf must not be NULL, and must point to a valid buffer of data that is at least inBufs->descs
[0].bufSize bytes in length.outBufs
must not be NULL, and must point to a valid XDM1_BufDesc structure.outBufs->descs
[0].buf must not be NULL, and must point to a valid buffer of data that is at least outBufs->descs
[0].bufSize bytes in length.inBufs
and outBufs
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->descs
[].accessMask and appropriately indicate the mode in which each of the buffers in inBufs
were read. For example, if the algorithm only read from inBufs.descs
[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
and outBufs
are owned by the calling application.IVIDANALYTICS_EOK | Success. |
IVIDANALYTICS_EFAIL | General failure. See IVIDANALYTICS_Status::extendedError for more detailed further error conditions. |
IVIDANALYTICS_EUNSUPPORTED | Request is unsupported. |
XDAS_Int32(* IVIDANALYTICS_Fxns::control)(IVIDANALYTICS_Handle handle, IVIDANALYTICS_Cmd id, IVIDANALYTICS_DynamicParams *params, IVIDANALYTICS_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 IVIDANALYTICS_DynamicParams structure.status
must not be NULL, and must point to a valid IVIDANALYTICS_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.IVIDANALYTICS_EOK | Success. |
IVIDANALYTICS_EFAIL | General failure. See IVIDANALYTICS_Status::extendedError for more detailed further error conditions. |
IVIDANALYTICS_EUNSUPPORTED | Request is unsupported. |