Video Core Feature Interface Reference Manual  jpl-r3.13.10
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_SVFTR_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_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...
 

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]instancePointer to the OSC instance which is to be configured.
[in]obj_listobject list.
[out]statusosc status.
Returns
The execution result.
Return values
0success.
-EFAULTinput pointer is NULL.
See also
VFTR_OSC_getStat()
INT32 VFTR_OSC_deleteInstance ( VFTR_OSC_INSTANCE_S **  instance)

Delete object shape classifier instance.

Returns
The execution result.
Return values
0fail to create instance
-EFAULTpointer 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]instancePointer to the OSC instance which is to be configured.
[out]paramosc parameters.
Returns
The execution result.
Return values
0success.
-EFAULTinput 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]instancePointer to the OSC instance which is to be configured.
[in]statusosc status.
Returns
The execution result.
Return values
0success.
-EFAULTinput 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
NULLfail to create instance
Not NULLsuccess 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]instancePointer to the OSC instance which is to be configured.
[in]szsize of video layout.
[in]paramosc parameters.
Return values
0success.
-EFAULTinput pointer is NULL.
-EINVALinvalid parameters.
See also
VFTR_OSC_getParam()