vftr_td.h File Reference

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

Data Structures
struct	VFTR_TD_PARAM_S
	Structure for the parameters of tamper detection. More...
struct	VFTR_TD_STATUS_S
	Structure for the result of tamper detection. More...
struct	VFTR_TD_MPI_INPUT_S
	Structure for the inputs of tamper detection within Region of interest. More...
struct	VFTR_TD_INSTANCE_S
	Structure for the tamper detection object. More...

Macros
#define	VFTR_TD_SENSITIVITY_MIN   0
#define	VFTR_TD_SENSITIVITY_MAX   255
#define	VFTR_TD_ENDURANCE_MIN   0
#define	VFTR_TD_ENDURANCE_MAX   255
#define	VFTR_TD_ALARM_MASK

Typedefs
typedef struct vftr_td_algo_status_s	VFTR_TD_ALGO_STATUS_S

Enumerations
enum	VFTR_TD_ALARM_E {   VFTR_TD_ALARM_MULTIPLE, VFTR_TD_ALARM_BLOCK, VFTR_TD_ALARM_DEFOCUSING, VFTR_TD_ALARM_REDIRECTING,   VFTR_TD_ALARM_NUM }
	Enumeration of tamper alarm. More...

Functions
VFTR_TD_INSTANCE_S *	VFTR_TD_newInstance ()
	Create tamper detection instance. More...
INT32	VFTR_TD_deleteInstance (VFTR_TD_INSTANCE_S **instance)
	Delete tamper detection instance. More...
INT32	VFTR_TD_setParam (VFTR_TD_INSTANCE_S *instance, const VFTR_TD_PARAM_S *param)
	Set tamper detection parameters. More...
INT32	VFTR_TD_checkParam (const VFTR_TD_PARAM_S *param)
	check tamper detection parameters. More...
INT32	VFTR_TD_getParam (const VFTR_TD_INSTANCE_S *instance, VFTR_TD_PARAM_S *param)
	Get tamper detection parameters. More...
INT32	VFTR_TD_detect (VFTR_TD_INSTANCE_S *instance, const VFTR_TD_MPI_INPUT_S *mpi_input, VFTR_TD_STATUS_S *status)
	Detect tamper. More...
INT32	VFTR_TD_getStat (const VFTR_TD_INSTANCE_S *instance, VFTR_TD_STATUS_S *stat)
	Get tamper detection status. More...
INT32	VFTR_TD_init (VFTR_TD_INSTANCE_S *instance, const MPI_RECT_S *roi)
	Initialize tamper detect instance value. More...

Detailed Description

Core feature-lib for tamper detection.

Macro Definition Documentation

#define VFTR_TD_ALARM_MASK

Value:

((1 << VFTR_TD_ALARM_MULTIPLE) | (1 << VFTR_TD_ALARM_BLOCK) | (1 << VFTR_TD_ALARM_DEFOCUSING) | \
         (1 << VFTR_TD_ALARM_REDIRECTING))

alarm bit mask.

#define VFTR_TD_ENDURANCE_MAX   255

maxmal endurance.

#define VFTR_TD_ENDURANCE_MIN   0

minimal endurance.

#define VFTR_TD_SENSITIVITY_MAX   255

maxmal sensitivity.

#define VFTR_TD_SENSITIVITY_MIN   0

minimal sensitivity.

Enumeration Type Documentation

enum VFTR_TD_ALARM_E

Enumeration of tamper alarm.

Enumerator
VFTR_TD_ALARM_MULTIPLE	Unknown tamper.
VFTR_TD_ALARM_BLOCK	Block tamper type detects.
VFTR_TD_ALARM_DEFOCUSING	Defocusing tamper type detects.
VFTR_TD_ALARM_REDIRECTING	Redirecting tamper type detects.
VFTR_TD_ALARM_NUM	The number of the tamper type.

Function Documentation

INT32 VFTR_TD_checkParam

(

const VFTR_TD_PARAM_S *

param

)

check tamper detection parameters.

Parameters

[in]

param

Tamper detection parameters.

Return values

0	Success.
EFAULT	Input pointer is NULL.
EINVAL	Tamper detection parameters are invalid.

See also

VFTR_TD_getParam() VFTR_TD_checkParam()

INT32 VFTR_TD_deleteInstance

(

VFTR_TD_INSTANCE_S **

instance

)

Delete tamper detection instance.

Parameters

[in,out]

instance

Tamper detection instance.

Returns

The execution result.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_TD_newInstance()

INT32 VFTR_TD_detect	(	VFTR_TD_INSTANCE_S *	instance,
		const VFTR_TD_MPI_INPUT_S *	mpi_input,
		VFTR_TD_STATUS_S *	status
	)

Detect tamper.

Parameters

[in,out]	instance	Tamper detection instance.
[in]	mpi_input	Tamper detection input.
[out]	status	Tamper detection output result.

Returns

The execution result

Return values

0	Success.
EFAULT	Parameters are NULL.

See also

VFTR_TD_getParam() VFTR_TD_checkParam()

INT32 VFTR_TD_getParam	(	const VFTR_TD_INSTANCE_S *	instance,
		VFTR_TD_PARAM_S *	param
	)

Get tamper detection parameters.

Parameters

[in]	instance	TD instance.
[out]	param	TD parameters.

Return values

0	Success.
EFAULT	Input pointer is NULL.

See also

VFTR_TD_setParam()

INT32 VFTR_TD_getStat	(	const VFTR_TD_INSTANCE_S *	instance,
		VFTR_TD_STATUS_S *	status
	)

Get tamper detection status.

Parameters

[in]	instance	Tamper detection instance.
[out]	status	Detected result.

Return values

0	Success.
EFAULT	Input pointer is NULL

See also

VFTR_TD_detect()

INT32 VFTR_TD_init	(	VFTR_TD_INSTANCE_S *	instance,
		const MPI_RECT_S *	roi
	)

Initialize tamper detect instance value.

Parameters

[in,out]	instance	Tamper detection instance.
[in]	roi	Region of interest to be detected

Returns

The execution result.

Return values

0

Success.

See also

VFTR_TD_newInstance()

VFTR_TD_INSTANCE_S* VFTR_TD_newInstance

(

)

Create tamper detection instance.

Returns

The pointer of tamper detection instance.

Return values

Not NULL	success to create instance.
NULL	fail to create instance.

See also

VFTR_TD_deleteInstance()

INT32 VFTR_TD_setParam	(	VFTR_TD_INSTANCE_S *	instance,
		const VFTR_TD_PARAM_S *	param
	)

Set tamper detection parameters.

Parameters

[in,out]	instance	tamper detection instance.
[in]	param	tamper detection parameters.

Return values

0	success.
EFAULT	input pointer is NULL.

See also

VFTR_TD_getParam() VFTR_TD_checkParam()