vftr_osc.h File Reference

Core feature-lib for object shape classifier (OSC) More...

Data Structures
struct	VFTR_OSC_PARAM_S
	Struct for object shape classifier parameter. More...
struct	VFTR_OSC_STATUS_S
	Struct for osc status. More...
struct	VFTR_OSC_INSTANCE_S

Macros
#define	VFTR_OSC_AR_FRACTIONAL_BIT   (16)
#define	VFTR_OSC_MIN_ASPECT_RATIO   (1)
#define	VFTR_OSC_MAX_ASPECT_RATIO   (0xffffffff)
#define	VFTR_OSC_MIN_OBJ_LIFE_TH   (0)
#define	VFTR_OSC_MAX_OBJ_LIFE_TH   (MPI_IVA_OD_MAX_LIFE)

Functions
VFTR_OSC_INSTANCE_S *	VFTR_OSC_newInstance (void)
	Create object shape classifier instance. More...
INT32	VFTR_OSC_deleteInstance (VFTR_OSC_INSTANCE_S **instance)
	Delete object shape classifier instance. More...
INT32	VFTR_OSC_setParam (VFTR_OSC_INSTANCE_S *instance, const MPI_SIZE_S *size, const VFTR_OSC_PARAM_S *param)
	Set osc parameters. More...
INT32	VFTR_OSC_getParam (const VFTR_OSC_INSTANCE_S *instance, VFTR_OSC_PARAM_S *param)
	Get osc parameters. More...
INT32	_VFTR_OSC_dump (VFTR_OSC_INSTANCE_S *instance, const MPI_IVA_OBJ_LIST_S *obj_list, VFTR_OSC_STATUS_S *status)
	Dump OSC debuging info. More...
INT32	_VFTR_OSC_classify (VFTR_OSC_INSTANCE_S *instance, const MPI_IVA_OBJ_LIST_S *obj_list, VFTR_OSC_STATUS_S *status)
	Calculate osc. More...
INT32	VFTR_OSC_getStat (const VFTR_OSC_INSTANCE_S *instance, VFTR_OSC_STATUS_S *status)
	Get object shape classifier status. More...
FORCE_INLINE INT32	VFTR_OSC_classify (VFTR_OSC_INSTANCE_S *instance, const MPI_IVA_OBJ_LIST_S *obj_list, VFTR_OSC_STATUS_S *status)
	An inline function. If variable vftr_dump_en is true, then call dump function for debugging. More...

Detailed Description

Core feature-lib for object shape classifier (OSC)

Function Documentation

INT32 _VFTR_OSC_classify	(	VFTR_OSC_INSTANCE_S *	instance,
		const MPI_IVA_OBJ_LIST_S *	obj_list,
		VFTR_OSC_STATUS_S *	status
	)

Calculate osc.

Parameters

[in]	instance	Pointer to the OSC instance which is to be configured.
[in]	obj_list	object list.
[out]	status	osc status.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

VFTR_OSC_getStat()

INT32 _VFTR_OSC_dump	(	VFTR_OSC_INSTANCE_S *	instance,
		const MPI_IVA_OBJ_LIST_S *	obj_list,
		VFTR_OSC_STATUS_S *	status
	)

Dump OSC debuging info.

Parameters

[in]	instance	Pointer to OSC instance.
[in]	obj_list	Pointer to object list.
[out]	status	Pointer to OSC result.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

none

FORCE_INLINE INT32 VFTR_OSC_classify	(	VFTR_OSC_INSTANCE_S *	instance,
		const MPI_IVA_OBJ_LIST_S *	obj_list,
		VFTR_OSC_STATUS_S *	status
	)

An inline function. If variable vftr_dump_en is true, then call dump function for debugging.

See also

_VFTR_OSC_dump()

_VFTR_OSC_classify()

INT32 VFTR_OSC_deleteInstance

(

VFTR_OSC_INSTANCE_S **

instance

)

Delete object shape classifier instance.

Returns

The execution result.

Return values

0	fail to create instance
-EFAULT	pointer of OSC instance is NULL.

See also

VFTR_OSC_newInstance()

INT32 VFTR_OSC_getParam	(	const VFTR_OSC_INSTANCE_S *	instance,
		VFTR_OSC_PARAM_S *	param
	)

Get osc parameters.

Parameters

[in]	instance	Pointer to the OSC instance which is to be configured.
[out]	param	osc parameters.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

VFTR_OSC_setParam()

INT32 VFTR_OSC_getStat	(	const VFTR_OSC_INSTANCE_S *	instance,
		VFTR_OSC_STATUS_S *	status
	)

Get object shape classifier status.

Parameters

[in]	instance	Pointer to the OSC instance which is to be configured.
[in]	status	osc status.

Returns

The execution result.

Return values

0	success.
-EFAULT	input pointer is NULL.

See also

VFTR_OSC_classify()

VFTR_OSC_INSTANCE_S* VFTR_OSC_newInstance

(

void

)

Create object shape classifier instance.

Default value of OSC parameter is as following

{
    .min_sz = { 0, 0 },
    .max_sz = { 3840, 1080 },
    .min_aspect_ratio = VFTR_OSC_MIN_ASPECT_RATIO,
    .max_aspect_ratio = VFTR_OSC_MAX_ASPECT_RATIO,
    .obj_life_th = 0,
}

Returns

Pointer to the OSC instance.

Return values

NULL	fail to create instance
Not NULL	success to create instance

See also

VFTR_OSC_setParam()

VFTR_OSC_deleteInstance()

INT32 VFTR_OSC_setParam	(	VFTR_OSC_INSTANCE_S *	instance,
		const MPI_SIZE_S *	sz,
		const VFTR_OSC_PARAM_S *	param
	)

Set osc parameters.

Parameters

[in]	instance	Pointer to the OSC instance which is to be configured.
[in]	sz	size of video layout.
[in]	param	osc parameters.

Return values

0	success.
-EFAULT	input pointer is NULL.
-EINVAL	invalid parameters.

See also

VFTR_OSC_getParam()