vftr_md.h File Reference

Core feature-lib for motion detection. More...

#include "mpi_base_types.h"
#include "mpi_iva.h"

Data Structures
struct	VFTR_MD_REG_ATTR_S
	Struct for region attributes. More...
struct	VFTR_MD_REG_STAT_S
	Struct for region status. More...
struct	VFTR_MD_PARAM_S
	Struct for motion detection parameter. More...
struct	VFTR_MD_STATUS_S
	Struct for motion detection status. More...
struct	VFTR_MD_INSTANCE_S
	Struct for motion detection object. More...

Macros
#define	VFTR_MD_MAX_THR_V_OBJ   (255)
#define	VFTR_MD_MIN_THR_V_OBJ   (0)
#define	VFTR_MD_MAX_THR_V_REG(W, H)   ((W) * (H)*VFTR_MD_MAX_THR_V_OBJ)
#define	VFTR_MD_MIN_THR_V_REG   (0)
#define	VFTR_MD_MAX_REG_NUM   (64)
#define	VFTR_MD_MIN_REG_NUM   (0)
#define	VFTR_MD_MAX_DET_SUBTRACT_NUM   (3)
#define	VFTR_MD_MIN_OBJ_LIFE_TH   (0)
#define	VFTR_MD_MAX_OBJ_LIFE_TH   (MPI_IVA_OD_MAX_LIFE)
#define	VFTR_MD_THR_V_REG_BIT_SHIFT   8

Typedefs
typedef UINT16	VFTR_MD_OBJ_SP_BF
typedef UINT64	VFTR_MD_REG_MOT_BF

Enumerations
enum	VFTR_MD_ALARM_MODE_E { VFTR_MD_ALARM_FALSE = 0, VFTR_MD_ALARM_TRUE = 1 }
	Enumeration of motion detection alarm mode. More...
enum	VFTR_MD_DET_MODE_E { VFTR_MD_MOVING_AREA = 0, VFTR_MD_MOVING_ENERGY = 1 }
	Enumeration of motion detection detect mode. More...
enum	VFTR_MD_DET_METHOD_E { VFTR_MD_DET_NORMAL = 0, VFTR_MD_DET_SUBTRACT = 1 }
	Enumeration of motion detection detect mode. More...

Functions
VFTR_MD_INSTANCE_S *	VFTR_MD_newInstance ()
	Create motion detection instance. More...
INT32	VFTR_MD_deleteInstance (VFTR_MD_INSTANCE_S **instance)
	Delete motion detection instance. More...
INT32	VFTR_MD_setParam (VFTR_MD_INSTANCE_S *instance, const VFTR_MD_PARAM_S *param)
	Set motion detection parameters. More...
INT32	VFTR_MD_checkParam (const VFTR_MD_PARAM_S *param, const MPI_SIZE_S *res)
	Check motion detection parameters is valid or not. More...
INT32	VFTR_MD_getParam (const VFTR_MD_INSTANCE_S *instance, VFTR_MD_PARAM_S *param)
	Get motion detection parameters. More...
INT32	VFTR_MD_detectMotion (VFTR_MD_INSTANCE_S *instance, const MPI_IVA_OBJ_LIST_S *obj_list, VFTR_MD_STATUS_S *status)
	Detect motion. More...
INT32	VFTR_MD_getStat (const VFTR_MD_INSTANCE_S *instance, VFTR_MD_STATUS_S *stat)
	Get motion detection detected result. More...

Detailed Description

Core feature-lib for motion detection.

Macro Definition Documentation

#define VFTR_MD_THR_V_REG_BIT_SHIFT   8

Left shift of user set thr_v_reg

Typedef Documentation

typedef UINT16 VFTR_MD_OBJ_SP_BF

Bit-field of object speed.

typedef UINT64 VFTR_MD_REG_MOT_BF

Bit-field of region motion. Max bit :VFTR_MD_INSTANCE_SP_BF * UINT32 * MPI_IVA_MAX_OBJ_NUM

Enumeration Type Documentation

enum VFTR_MD_ALARM_MODE_E

Enumeration of motion detection alarm mode.

Enumerator
VFTR_MD_ALARM_FALSE	Alarm none.
VFTR_MD_ALARM_TRUE	Alarm true.

enum VFTR_MD_DET_METHOD_E

Enumeration of motion detection detect mode.

Enumerator
VFTR_MD_DET_NORMAL	Method for detecting motion based on MD_DET_MODE_E
VFTR_MD_DET_SUBTRACT	Method for detection motion based on MD_DET_MODE_E with region-0 subtraction.

enum VFTR_MD_DET_MODE_E

Enumeration of motion detection detect mode.

Enumerator
VFTR_MD_MOVING_AREA	Mode for detecting motion based on moving area.
VFTR_MD_MOVING_ENERGY	Mode for detection motion based on moving energy.

Function Documentation

INT32 VFTR_MD_checkParam	(	const VFTR_MD_PARAM_S *	param,
		const MPI_SIZE_S *	res
	)

Check motion detection parameters is valid or not.

Parameters

[in]	param	Pointer to motion detection parameters.
[in]	res	Pointer to mpi resolution.

Returns

The execution result.

Return values

0	success.
-EINVAL	motion detection parameters is invalid.

See also

VFTR_MD_setParam()

VFTR_MD_getParam()

INT32 VFTR_MD_deleteInstance

(

VFTR_MD_INSTANCE_S **

instance

)

Delete motion detection instance.

Parameters

[in]

instance

Pointer to pointer to motion detection instance.

Returns

The execution result.

Return values

0	success.
-EFAULT	pointer of motion detection instance is NULL.

See also

VFTR_MD_newInstance()

INT32 VFTR_MD_detectMotion	(	VFTR_MD_INSTANCE_S *	instance,
		const MPI_IVA_OBJ_LIST_S *	obj_list,
		VFTR_MD_STATUS_S *	status
	)

Detect motion.

Parameters

[in]	instance	Pointer to motion detection instance.
[in]	obj_list	Pointer to object list.
[out]	status	Pointer to motion detection detected result.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

none

INT32 VFTR_MD_getParam	(	const VFTR_MD_INSTANCE_S *	instance,
		VFTR_MD_PARAM_S *	param
	)

Get motion detection parameters.

Parameters

[in]	instance	Pointer to motion detection instance.
[out]	param	Pointer to motion detection parameters.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

VFTR_MD_setParam()

VFTR_MD_checkParam()

INT32 VFTR_MD_getStat	(	const VFTR_MD_INSTANCE_S *	instance,
		VFTR_MD_STATUS_S *	status
	)

Get motion detection detected result.

Parameters

[in]	instance	Pointer to motion detection instance.
[out]	status	Pointer to motion detection detected result.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

None.

VFTR_MD_INSTANCE_S* VFTR_MD_newInstance

(

)

Create motion detection instance.

Returns

The pointer of motion detection instance.

Return values

NULL	fail to create instance
Not NULL	success to create instance

See also

VFTR_MD_deleteInstance()

INT32 VFTR_MD_setParam	(	VFTR_MD_INSTANCE_S *	instance,
		const VFTR_MD_PARAM_S *	param
	)

Set motion detection parameters.

Parameters

[in]	instance	Pointer to motion detection instance.
[in]	param	Pointer to motion detection parameters.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

VFTR_MD_checkParam()

VFTR_MD_getParam()