mpi_iva.h File Reference

MPI for IVA OD (object detection) More...

#include <sys/time.h>
#include "mpi_index.h"

Data Structures
struct	MPI_IVA_OD_PARAM_S
	Structure for the parameters of object detection. More...
struct	MPI_IVA_OD_MOTOR_PARAM_S
	Structure for the parameters of camera motor. More...
struct	MPI_IVA_OBJ_ATTR_S
	Struct for object attributes. More...
struct	MPI_IVA_OBJ_LIST_S
	Struct for object list. More...
struct	MPI_IVA_OD_CTX_S
	Structure for Object Detection (OD) context. More...
struct	MPI_IVA_OD_CALLBACK_S
	This structure defines the callback functions for an Object Detection (OD) algorithm. More...

Macros
#define	MPI_IVA_MAX_OBJ_NUM   10
#define	MPI_IVA_OD_MAX_QUA   63
#define	MPI_IVA_OD_MIN_QUA   0
#define	MPI_IVA_OD_MAX_TRACK_REFINE   63
#define	MPI_IVA_OD_MIN_TRACK_REFINE   0
#define	MPI_IVA_OD_MAX_OBJ_SIZE   255
#define	MPI_IVA_OD_MIN_OBJ_SIZE   0
#define	MPI_IVA_OD_MAX_SEN   255
#define	MPI_IVA_OD_MIN_SEN   0
#define	MPI_IVA_OD_MAX_LIFE   160
#define	MPI_IVA_OD_ENABLE_STOP_DET   1
#define	MPI_IVA_OD_DISABLE_STOP_DET   0
#define	MPI_IVA_OD_ENABLE_GMV_DET   1
#define	MPI_IVA_OD_DISABLE_GMV_DET   0
#define	MPI_IVA_OD_MOTOR_ENABLE   1
#define	MPI_IVA_OD_MOTOR_DISABLE   0
#define	MPI_IVA_OD_MAX_CONF   255
#define	MPI_IVA_OD_MIN_CONF   0
#define	MPI_IVA_OD_MAX_IOU   255
#define	MPI_IVA_OD_MIN_IOU   0
#define	MPI_IVA_OD_SNAPSHOT_Y   0
#define	MPI_IVA_OD_SNAPSHOT_NV12   1
#define	MPI_IVA_OD_SNAPSHOT_RGB   2

Functions
INT32	MPI_IVA_enableObjDet (MPI_WIN idx)
	Enable OD (object detection) on specified video window. More...
INT32	MPI_IVA_disableObjDet (MPI_WIN idx)
	Disable OD on specified video window. More...
INT32	MPI_IVA_setObjParam (MPI_WIN idx, const MPI_IVA_OD_PARAM_S *param)
	Set OD (object detection) parameters. More...
INT32	MPI_IVA_getObjParam (MPI_WIN idx, MPI_IVA_OD_PARAM_S *param)
	Get OD parameters. More...
INT32	MPI_IVA_setObjMotorParam (MPI_WIN idx, const MPI_IVA_OD_MOTOR_PARAM_S *param)
	Set OD (object detection) motor parameters. More...
INT32	MPI_IVA_getObjMotorParam (MPI_WIN idx, MPI_IVA_OD_MOTOR_PARAM_S *param)
	Get OD motor parameters. More...
INT32	MPI_IVA_getObjList (MPI_WIN idx, MPI_IVA_OBJ_LIST_S *list)
	Get current object list. More...
INT32	MPI_IVA_getBitStreamObjList (MPI_WIN idx, UINT32 timestamp, MPI_IVA_OBJ_LIST_S *list)
	Get object list for specific frame index. More...
INT32	MPI_IVA_regOdCallback (const MPI_WIN idx, const MPI_IVA_OD_CALLBACK_S *cb, void *cb_ctx)
	Registers OD callback functions for a given MPI window. More...

Detailed Description

MPI for IVA OD (object detection)

Macro Definition Documentation

#define MPI_IVA_MAX_OBJ_NUM   10

Max object number.

#define MPI_IVA_OD_DISABLE_GMV_DET   0

Disable OD global motion vector detection.

#define MPI_IVA_OD_DISABLE_STOP_DET   0

Disable OD stop detect of object.

#define MPI_IVA_OD_ENABLE_GMV_DET   1

Enable OD global motion vector detection.

#define MPI_IVA_OD_ENABLE_STOP_DET   1

Enable OD stop detect of object.

#define MPI_IVA_OD_MAX_CONF   255

Max OD confidience level.

#define MPI_IVA_OD_MAX_IOU   255

Max Intersection over Union level of two objects.

#define MPI_IVA_OD_MAX_LIFE   160

Max OD life of object.

#define MPI_IVA_OD_MAX_OBJ_SIZE   255

Max OD object size(percentage in a frame size).

#define MPI_IVA_OD_MAX_QUA   63

Max OD quality index.

#define MPI_IVA_OD_MAX_SEN   255

Max OD sensitivity.

#define MPI_IVA_OD_MAX_TRACK_REFINE   63

Max OD track refinement index.

#define MPI_IVA_OD_MIN_CONF   0

Min OD confidience level.

#define MPI_IVA_OD_MIN_IOU   0

Min Intersection over Union level of two objects.

#define MPI_IVA_OD_MIN_OBJ_SIZE   0

Min OD object size(percentage in a frame size).

#define MPI_IVA_OD_MIN_QUA   0

Min OD quality index.

#define MPI_IVA_OD_MIN_SEN   0

Min OD sensitivity.

#define MPI_IVA_OD_MIN_TRACK_REFINE   0

Min OD track refinement index.

#define MPI_IVA_OD_MOTOR_DISABLE   0

Disable OD camera motor when gmv detection is enabled.

#define MPI_IVA_OD_MOTOR_ENABLE   1

Enable OD camera motor when gmv detection is enabled.

#define MPI_IVA_OD_SNAPSHOT_NV12   1

Snapshot NV12.

#define MPI_IVA_OD_SNAPSHOT_RGB   2

Snapshot RGB.

#define MPI_IVA_OD_SNAPSHOT_Y   0

Snapshot Y only.

Function Documentation

INT32 MPI_IVA_disableObjDet

(

MPI_WIN

idx

)

Disable OD on specified video window.

Parameters

[in]

idx

Index of the video window that is to be configured.

Returns

The execution result

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_ERR_DEV_NOT_PERM	object detection hasn't been enabled.
MPI_ERR_DEV_CONFLICT	object detection run on another video window.
MPI_FAILURE	unexpected fail.

Note

• Object detection should be disabled before suspending target window. That is, MPI_IVA_disableObjDet() should be called before MPI_DEV_stopChn() or MPI_DEV_stopAllChn() is called.

See also

MPI_IVA_enableObjDet()

INT32 MPI_IVA_enableObjDet

(

MPI_WIN

idx

)

Enable OD (object detection) on specified video window.

Parameters

[in]

idx

Index of the video window that is to be configured.

Returns

The execution result

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_ERR_DEV_BUSY	object detection has been enabled.
MPI_FAILURE	unexpected fail.

Note

• Object detection should be enabled after target window is running. That is, MPI_DEV_startChn() or MPI_DEV_startAllChn() should be called first.

See also

MPI_IVA_disableObjDet()

INT32 MPI_IVA_getBitStreamObjList	(	MPI_WIN	idx,
		uint32_t	timestamp,
		MPI_IVA_OBJ_LIST_S *	obj_list
	)

Get object list for specific frame index.

Parameters

[in]	idx	Index of the video window that is to retrieve Object Detection (OD) result.
[in]	timestamp	time stamp from bit-stream.
[out]	obj_list	Object list.

Returns

The execution result.

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_NULL_POINTER	input pointer is NULL.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_ERR_DEV_NOT_PERM	OD hasn't been enabled.
MPI_ERR_DEV_CONFLICT	OD run on another video window.
MPI_ERR_DEV_INVALID_PARAM	frame count difference is too large.
MPI_FAILURE	unexpected fail.

Note

• User can get correct timestamp by MPI_DEV_waitWin(). Example is shown below.

  MPI_IVA_OBJ_LIST_S list;
  uint32_t timestamp = 0;
  
  MPI_DEV_waitWin(idx, &timestamp, 0);
  MPI_IVA_getBitStreamObjList(idx, timestamp, &obj_list);

See also

MPI_DEV_waitWin()

MPI_IVA_enableObjDet()

MPI_IVA_getObjList()

INT32 MPI_IVA_getObjList	(	MPI_WIN	idx,
		MPI_IVA_OBJ_LIST_S *	obj_list
	)

Get current object list.

Parameters

[in]	idx	Index of the video window that is to retrieve Object Detection (OD) result.
[out]	obj_list	Object list.

Returns

The execution result.

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_NULL_POINTER	input pointer is NULL.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_ERR_DEV_NOT_PERM	OD hasn't been enabled.
MPI_ERR_DEV_CONFLICT	OD run on another video window.
MPI_FAILURE	unexpected fail.

See also

MPI_IVA_enableObjDet()

MPI_IVA_getBitStreamObjList()

INT32 MPI_IVA_getObjMotorParam	(	MPI_WIN	idx,
		MPI_IVA_OD_MOTOR_PARAM_S *	param
	)

Get OD motor parameters.

Parameters

[in]	idx	Index of the video window that is to retrieve attributes.
[out]	param	OD motor parameters.

Returns

The execution result.

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_NULL_POINTER	input pointer is NULL.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_FAILURE	unexpected fail.

See also

MPI_IVA_setObjMotorParam()

INT32 MPI_IVA_getObjParam	(	MPI_WIN	idx,
		MPI_IVA_OD_PARAM_S *	param
	)

Get OD parameters.

Parameters

[in]	idx	Index of the video window that is to retrieve attributes.
[out]	param	OD parameters.

Returns

The execution result.

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_NULL_POINTER	input pointer is NULL.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_FAILURE	unexpected fail.

See also

MPI_IVA_setObjParam()

INT32 MPI_IVA_regOdCallback	(	const MPI_WIN	idx,
		const MPI_IVA_OD_CALLBACK_S *	cb,
		void *	cb_ctx
	)

Registers OD callback functions for a given MPI window.

Parameters

[in]	idx	The MPI window index to register the callback function for.
[in]	cb	Pointer to the MPI_IVA_OD_CALLBACK_S structure containing callback functions to be registered.
[in,out]	cb_ctx	Context pointer that will be passed to the callback function when it is invoked.

Returns

MPI_SUCCESS on successful registration of the callback function.

MPI_FAILURE if the registration fails.

INT32 MPI_IVA_setObjMotorParam	(	MPI_WIN	idx,
		const MPI_IVA_OD_MOTOR_PARAM_S *	param
	)

Set OD (object detection) motor parameters.

Parameters

[in]	idx	Index of the video window that is to be configured.
[in]	param	OD motor parameters.

Returns

The execution result.

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_NULL_POINTER	input pointer is NULL.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_INVALID_PARAM	invalid parameters.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_FAILURE	unexpected fail.

See also

MPI_IVA_getObjMotorParam()

INT32 MPI_IVA_setObjParam	(	MPI_WIN	idx,
		const MPI_IVA_OD_PARAM_S *	param
	)

Set OD (object detection) parameters.

Parameters

[in]	idx	Index of the video window that is to be configured.
[in]	param	OD parameters.

Returns

The execution result.

Return values

MPI_SUCCESS	success.
MPI_ERR_DEV_NULL_POINTER	input pointer is NULL.
MPI_ERR_DEV_INVALID_WIN	invalid video window index.
MPI_ERR_DEV_INVALID_CHN	invalid video channel index.
MPI_ERR_DEV_INVALID_DEV	invalid device index.
MPI_ERR_DEV_INVALID_PARAM	invalid parameters.
MPI_ERR_DEV_NOT_EXIST	device/channel not exist.
MPI_FAILURE	unexpected fail.

See also

MPI_IVA_getObjParam()