Defines | |
#define | VIDANALYTICS_EOK IVIDANALYTICS_EOK |
#define | VIDANALYTICS_EFAIL IVIDANALYTICS_EFAIL |
#define | VIDANALYTICS_EUNSUPPORTED IVIDANALYTICS_EUNSUPPORTED |
#define | VIDANALYTICS_ETIMEOUT VISA_ETIMEOUT |
#define | VIDANALYTICS_FOREVER VISA_FOREVER |
Typedefs | |
typedef VISA_Handle | VIDANALYTICS_Handle |
Opaque handle to a VIDANALYTICS codec. | |
typedef struct IVIDANALYTICS_Params | VIDANALYTICS_Params |
This structure defines the parameters necessary to create an instance of a video analytics algorithm. | |
typedef IVIDANALYTICS_InArgs | VIDANALYTICS_InArgs |
typedef IVIDANALYTICS_OutArgs | VIDANALYTICS_OutArgs |
typedef IVIDANALYTICS_Cmd | VIDANALYTICS_Cmd |
typedef IVIDANALYTICS_Status | VIDANALYTICS_Status |
typedef IVIDANALYTICS_DynamicParams | VIDANALYTICS_DynamicParams |
Functions | |
Int32 | VIDANALYTICS_control (VIDANALYTICS_Handle handle, VIDANALYTICS_Cmd id, VIDANALYTICS_DynamicParams *params, VIDANALYTICS_Status *status) |
Execute the control() method in this instance of a video analytics algorithm. | |
VIDANALYTICS_Handle | VIDANALYTICS_create (Engine_Handle e, String name, VIDANALYTICS_Params *params) |
Create an instance of a video analytics algorithm. | |
Void | VIDANALYTICS_delete (VIDANALYTICS_Handle handle) |
Delete the instance of a video analytics algorithm. | |
Int32 | VIDANALYTICS_process (VIDANALYTICS_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, VIDANALYTICS_InArgs *inArgs, VIDANALYTICS_OutArgs *outArgs) |
Execute the process() method in this instance of a video analytics algorithm. | |
XDAS_Int32 | VIDANALYTICS_processAsync (VIDANALYTICS_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IVIDANALYTICS_InArgs *inArgs, IVIDANALYTICS_OutArgs *outArgs) |
Perform asynchronous submission to this instance of a video analytics algorithm. | |
XDAS_Int32 | VIDANALYTICS_processWait (VIDANALYTICS_Handle handle, XDM1_BufDesc *inBufs, XDM1_BufDesc *outBufs, IVIDANALYTICS_InArgs *inArgs, IVIDANALYTICS_OutArgs *outArgs, UInt timeout) |
Wait for a return message from a previous invocation of VIDANALYTICS_processAsync() in this instance of an video analytics algorithm. |
This is the video analytics codec interface. Several of the data types in this API are specified by the XDM interface; please see the XDM documentation for those details.
#define VIDANALYTICS_EOK IVIDANALYTICS_EOK |
Success.
#define VIDANALYTICS_EFAIL IVIDANALYTICS_EFAIL |
General failure.
#define VIDANALYTICS_EUNSUPPORTED IVIDANALYTICS_EUNSUPPORTED |
Request is unsupported. Timeout occurred.
#define VIDANALYTICS_ETIMEOUT VISA_ETIMEOUT |
Special value for timeout parameter indicating never timeout.
#define VIDANALYTICS_FOREVER VISA_FOREVER |
typedef VISA_Handle VIDANALYTICS_Handle |
Opaque handle to a VIDANALYTICS codec.
typedef struct IVIDANALYTICS_Params VIDANALYTICS_Params |
This structure defines the parameters necessary to create an instance of a video analytics algorithm.
Defines the input arguments for all IVIDANALYTICS instance process function.
size
parameter. size
field must be correctly set by the caller. See http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.Defines the run time output arguments for all IVIDANALYTICS instance objects.
size
parameter. size
field must be correctly set by the caller. See http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.typedef IVIDANALYTICS_Cmd VIDANALYTICS_Cmd |
Defines the control commands for the IVIDANALYTICS module.
Defines instance status parameters.
size
parameter. size
field must be correctly set by the caller. See http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.This structure defines the algorithm parameters that can be modified after creation via control() calls.
size
parameter. size
field must be correctly set by the caller. See http://tiexpressdsp.com/index.php?title=Extending_data_structures_in_xDM for more details.Int32 VIDANALYTICS_control | ( | VIDANALYTICS_Handle | handle, | |
VIDANALYTICS_Cmd | id, | |||
VIDANALYTICS_DynamicParams * | params, | |||
VIDANALYTICS_Status * | status | |||
) |
Execute the control() method in this instance of a video analytics algorithm.
[in] | handle | Handle to a created video analytics instance. |
[in] | id | Command id for XDM control operation. |
[in] | params | Runtime control parameters used for the video analytics instance. |
[out] | status | Status info returned by the video analytics instance. |
handle
is a valid (non-NULL) video analytics handle and the video analytics instance is in the created state.VIDANALYTICS_EOK | Success. | |
VIDANALYTICS_EFAIL | Failure. | |
VIDANALYTICS_EUNSUPPORTED | Unsupported request. |
VIDANALYTICS_Handle VIDANALYTICS_create | ( | Engine_Handle | e, | |
String | name, | |||
VIDANALYTICS_Params * | params | |||
) |
Create an instance of a video analytics algorithm.
Instance handles must not be concurrently accessed by multiple threads; each thread must either obtain its own handle (via VIDANALYTICS_create()) or explicitly serialize access to a shared handle.
[in] | e | Handle to an opened engine. |
[in] | name | String identifier of the type of video analytics algorithm to create. |
[in] | params | Creation parameters. |
NULL | An error has occurred. | |
non-NULL | The handle to the newly created video analytics instance. |
params
is optional. If it's not supplied, codec-specific default params will be used.name
is the name of the codec configured by the system integrator. However, an optional "argument string" may be appended to the codec name, to allow the codec's configured priority and/or the heaps where its memory will be allocated and/or the number of VISA messages to allocate, to be overridden. This optional argument string is of the form ":priority:flag:number-of-messages", and can be specified with an empty field for any element that you don't want to be overridden, e.g. "mp3:::3" to cause 3 messages to be allocated while using the default values for priority and the heap flag. IALG_EXTERNAL
. If flag is 0, the memory for the codec will be allocated from the heaps it has requested. For example, if a codec named "mp3" has been configured into the system, setting name to "mp3:4" would cause the codec to be created at priority 4, instead of whatever priority was configured. This feature is useful if more than one instance of the codec are to be created at different priorities. Void VIDANALYTICS_delete | ( | VIDANALYTICS_Handle | handle | ) |
Delete the instance of a video analytics algorithm.
[in] | handle | Handle to a created video analytics instance. |
handle
is a valid (non-NULL) handle which is in the created state.Int32 VIDANALYTICS_process | ( | VIDANALYTICS_Handle | handle, | |
XDM1_BufDesc * | inBufs, | |||
XDM1_BufDesc * | outBufs, | |||
VIDANALYTICS_InArgs * | inArgs, | |||
VIDANALYTICS_OutArgs * | outArgs | |||
) |
Execute the process() method in this instance of a video analytics algorithm.
[in] | handle | Handle to a created video analytics instance. |
[in] | inBufs | A buffer descriptor containing input buffers. |
[out] | outBufs | A buffer descriptor containing output buffers. |
[in] | inArgs | Input Arguments. |
[out] | outArgs | Output Arguments. |
handle
is a valid (non-NULL) video analytics handle and the video analytics algorithm instance is in the created state.VIDANALYTICS_EOK | Success. | |
VIDANALYTICS_EFAIL | Failure. | |
VIDANALYTICS_EUNSUPPORTED | Unsupported request. |
XDAS_Int32 VIDANALYTICS_processAsync | ( | VIDANALYTICS_Handle | handle, | |
XDM1_BufDesc * | inBufs, | |||
XDM1_BufDesc * | outBufs, | |||
IVIDANALYTICS_InArgs * | inArgs, | |||
IVIDANALYTICS_OutArgs * | outArgs | |||
) |
Perform asynchronous submission to this instance of a video analytics algorithm.
[in] | handle | Handle to a created video analytics instance. |
[in] | inBufs | A buffer descriptor containing input buffers. |
[out] | outBufs | A buffer descriptor containing output buffers. |
[in] | inArgs | Input Arguments. |
[out] | outArgs | Output Arguments. |
handle
is a valid (non-NULL) video analytics handle and the video analytics algorithm instance is in the created state.VIDANALYTICS_EOK | Success. | |
VIDANALYTICS_EFAIL | Failure. | |
VIDANALYTICS_EUNSUPPORTED | Unsupported request. |
XDAS_Int32 VIDANALYTICS_processWait | ( | VIDANALYTICS_Handle | handle, | |
XDM1_BufDesc * | inBufs, | |||
XDM1_BufDesc * | outBufs, | |||
IVIDANALYTICS_InArgs * | inArgs, | |||
IVIDANALYTICS_OutArgs * | outArgs, | |||
UInt | timeout | |||
) |
Wait for a return message from a previous invocation of VIDANALYTICS_processAsync() in this instance of an video analytics algorithm.
[in] | handle | Handle to a created video analytics instance. |
[in] | inBufs | A buffer descriptor containing input buffers. |
[out] | outBufs | A buffer descriptor containing output buffers. |
[in] | inArgs | Input Arguments. |
[out] | outArgs | Output Arguments. |
[in] | timeout | Amount of "time" to wait (from 0 -> VIDANALYTICS_FOREVER) |
handle
is a valid (non-NULL) video analytics handle and the video analytics algorithm instance is in the created state.VIDANALYTICS_EOK | Success. | |
VIDANALYTICS_EFAIL | Failure. | |
VIDANALYTICS_EUNSUPPORTED | Unsupported request. | |
VIDANALYTICS_ETIMEOUT | Operation timed out. |