vidanalytics.h File Reference

---

Detailed Description

The VIDANALYTICS video analytics interface. Provides the user an interface to create and interact with XDAIS algorithms that are compliant with the XDM-defined IVIDANALYTICS video analytics interface.

#include <ti/xdais/dm/xdm.h>
#include <ti/xdais/dm/ividanalytics.h>
#include <ti/sdo/ce/Engine.h>
#include <ti/sdo/ce/visa.h>
#include <ti/sdo/ce/skel.h>

Include dependency graph for vidanalytics.h:

Go to the source code of this file.

Macros
#define	VIDANALYTICS_EOK   IVIDANALYTICS_EOK
#define	VIDANALYTICS_EFAIL   IVIDANALYTICS_EFAIL
#define	VIDANALYTICS_EUNSUPPORTED   IVIDANALYTICS_EUNSUPPORTED
#define	VIDANALYTICS_ETIMEOUT   VISA_ETIMEOUT
	Timeout occurred.
#define	VIDANALYTICS_FOREVER   VISA_FOREVER
	Special value for timeout parameter indicating never timeout.
#define	VIDANALYTICS_STUBSNAME   "VIDANYLITIC_STUBS"
	Name of stub functions. Use this name when registering the VIDANALYTICS_STUBS functions with Engine_addStubFxns.
#define	VIDANALYTICS_VISATYPE   "ti.sdo.ce.vidanalytics.IVIDANALYTICS"
	The VISA type.

Typedefs
typedef VISA_Handle	VIDANALYTICS_Handle
	Opaque handle to a VIDANALYTICS codec.
typedef IVIDANALYTICS_Params	VIDANALYTICS_Params
	Defines the creation time parameters for all IVIDANALYTICS instance objects.
typedef IVIDANALYTICS_InArgs	VIDANALYTICS_InArgs
	Defines the input arguments for all IVIDANALYTICS instance process function.
typedef IVIDANALYTICS_OutArgs	VIDANALYTICS_OutArgs
	Defines the run time output arguments for all IVIDANALYTICS instance objects.
typedef IVIDANALYTICS_Cmd	VIDANALYTICS_Cmd
	Defines the control commands for the IVIDANALYTICS module.
typedef IVIDANALYTICS_DynamicParams	VIDANALYTICS_DynamicParams
	This structure defines the algorithm parameters that can be modified after creation via control() calls.
typedef IVIDANALYTICS_Status	VIDANALYTICS_Status
	Defines instance status parameters.

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.