Evo 7.12.0-TM26061101
Evo LPR Engine
Loading...
Searching...
No Matches
C_API.h File Reference
APIs » C

C header file common to all type of engines and functionalities.

Go to the source code of this file.

Macros

#define EVO_INV_OBJ_ID   -1

Typedefs

typedef int EvoObjID

Functions

EvoRC Evo_Initialize (const char *dnnRunMode, const char *dataDir, EvoObjID *idDDI)
EvoRC Evo_GetLastRC (void)
EvoRC Evo_CvtUTF8ToCP (const char *utf8, char *cpBuf, unsigned bufLen)
void Evo_FreeObj (EvoObjID *idObj)
EvoRC EvoDDI_GetNumDev (EvoObjID idDDI, unsigned *num)
EvoRC EvoDDI_SelectDev (EvoObjID idDDI, unsigned idx)
EvoRC EvoDDI_GetSelDev (EvoObjID idDDI, unsigned *idx)
EvoRC EvoDDI_GetDevID (EvoObjID idDDI, char *buf, unsigned len)
EvoRC EvoDDI_GetNumDMDF (EvoObjID idDDI, unsigned *num)
EvoRC EvoDDI_GetDMDF (EvoObjID idDDI, unsigned idx, char *buf, unsigned len)
EvoRC EvoDDI_GetFullName (EvoObjID idDDI, char *buf, unsigned len)
EvoRC EvoLPI_GetNumLP (EvoObjID idLPI, unsigned *num)
EvoRC EvoLPI_SelectLP (EvoObjID idLPI, unsigned idx)
EvoRC EvoLPI_GetSelLP (EvoObjID idLPI, unsigned *idx)
EvoRC EvoLPI_GetType (EvoObjID idLPI, EvoLPT *type, float *confidence)
EvoRC EvoLPI_GetPos (EvoObjID idLPI, EvoRect *rect)
EvoRC EvoLPI_GetStr (EvoObjID idLPI, char *buf, unsigned len)
EvoRC EvoLPI_GetCharConf (EvoObjID idLPI, float *buf, unsigned *num)
EvoRC EvoPic_GetImage (EvoObjID idPic, EvoImage *img)
EvoRC EvoPic_GetTime (EvoObjID idPic, int64_t *time, EvoTimeUnit unit)
EvoRC EvoPic_SaveInJPEG (EvoObjID idPic, const char *path, int quality)
EvoRC EvoPic_SaveInPNG (EvoObjID idPic, const char *path, int compression)
EvoRC EvoGOP_GetNumPic (EvoObjID idGOP, unsigned *num)
EvoRC EvoGOP_SelectPic (EvoObjID idGOP, unsigned idx)
EvoRC EvoGOP_GetSelPic (EvoObjID idGOP, unsigned *idx)
EvoRC EvoGOP_GetPicImg (EvoObjID idGOP, EvoImage *img)
EvoRC EvoGOP_GetPicTime (EvoObjID idGOP, int64_t *time, EvoTimeUnit unit)
EvoRC EvoGOP_GetPosInPic (EvoObjID idGOP, EvoRect *rect)
EvoRC EvoGOP_GetHeadDir (EvoObjID idGOP, EvoHeadDir *heading)
EvoRC EvoGOP_SavePicInJPEG (EvoObjID idGOP, const char *path, int quality)
EvoRC EvoGOP_SavePicInPNG (EvoObjID idGOP, const char *path, int compression)
EvoRC EvoGOP_SaveAllInTIFF (EvoObjID idGOP, const char *path, int quality)
EvoObjID EvoGIC_Admin_Get (void)
EvoRC EvoGIC_Admin_UpdateDevList (EvoObjID idAdmin)
EvoRC EvoGIC_Admin_GetNumDev (EvoObjID idAdmin, unsigned *num)
EvoRC EvoGIC_Admin_SelectDev (EvoObjID idAdmin, unsigned idx)
EvoRC EvoGIC_Admin_GetSelDev (EvoObjID idAdmin, unsigned *idx)
EvoRC EvoGIC_Admin_GetDevIfc (EvoObjID idAdmin, char *buf, unsigned len)
EvoRC EvoGIC_Admin_GetDevVendor (EvoObjID idAdmin, char *buf, unsigned len)
EvoRC EvoGIC_Admin_GetDevModel (EvoObjID idAdmin, char *buf, unsigned len)
EvoRC EvoGIC_Admin_GetDevSerialNo (EvoObjID idAdmin, char *buf, unsigned len)
EvoRC EvoGIC_Admin_GetDevID (EvoObjID idAdmin, char *buf, unsigned len)
EvoObjID EvoGIC_Admin_OpenDev (EvoObjID idAdmin)
EvoRC EvoGIC_Dev_GetInterface (EvoObjID idDev, char *buf, unsigned len)
EvoRC EvoGIC_Dev_GetVendor (EvoObjID idDev, char *buf, unsigned len)
EvoRC EvoGIC_Dev_GetModel (EvoObjID idDev, char *buf, unsigned len)
EvoRC EvoGIC_Dev_GetSerialNo (EvoObjID idDev, char *buf, unsigned len)
EvoRC EvoGIC_Dev_GetID (EvoObjID idDev, char *buf, unsigned len)
EvoRC EvoGIC_Dev_GetNumDataStreams (EvoObjID idDev, unsigned *num)
EvoRC EvoCC_GetCalibName (EvoObjID idCamModel, char *buf, unsigned len)
EvoRC EvoCC_GetCamProd (EvoObjID idCamModel, char *buf, unsigned len)
EvoRC EvoCC_GetLensProd (EvoObjID idCamModel, char *buf, unsigned len)
EvoRC EvoCC_GetMaxResol (EvoObjID idCamModel, EvoSize *resol)
EvoObjID EvoCC_Fisheye_Create (const char *calibName)
EvoRC EvoCC_Fisheye_GetFocalLen (EvoObjID idFisheye, double *len)
EvoRC EvoCC_Fisheye_ChangeFocalLen (EvoObjID idFisheye, double delta)
EvoRC EvoCC_Fisheye_GetOutputSize (EvoObjID idFisheye, EvoSize *size)
EvoRC EvoCC_Fisheye_SetOutputSize (EvoObjID idFisheye, EvoSize *size)
EvoObjID EvoCC_Fisheye_Rectify_ImgFile (EvoObjID idFisheye, const char *imgPath)
EvoObjID EvoCC_Fisheye_Rectify_ImgData (EvoObjID idFisheye, const EvoImage *data)
EvoObjID EvoCC_Fisheye_Rectify_EncImg (EvoObjID idFisheye, const void *encImg, unsigned len)
EvoRC EvoEng_SetParam_Output (EvoObjID idEngine, const EvoOutput *output)
EvoRC EvoEng_SetParam_LPDJudgeCB (EvoObjID idEngine, EvoLPDJudgeCB cbLPDJudge)
EvoRC EvoEng_SetParam_SearchRect (EvoObjID idEngine, const EvoRect *rect)
EvoRC EvoEng_SetParam_GOPSize (EvoObjID idEngine, int size)
EvoRC EvoEng_SetParam_StayTimeout (EvoObjID idEngine, int timeout)
EvoRC EvoEng_SetParam_MinSearch (EvoObjID idEngine, EvoBool enable)
EvoRC EvoEng_GetParam_Output (EvoObjID idEngine, EvoOutput *output)
EvoRC EvoEng_GetParam_LPDJudgeCB (EvoObjID idEngine, EvoLPDJudgeCB *cbLPDJudge)
EvoRC EvoEng_GetParam_SearchRect (EvoObjID idEngine, EvoRect *rect)
EvoRC EvoEng_GetParam_GOPSize (EvoObjID idEngine, int *size)
EvoRC EvoEng_GetParam_StayTimeout (EvoObjID idEngine, int *timeout)
EvoRC EvoEng_GetParam_MinSearch (EvoObjID idEngine, EvoBool *enabled)
EvoObjID EvoSSE_Create (void)
EvoRC EvoSSE_Init (EvoObjID idSSE, const char *ccode, const char *dnnDevDesc)
void EvoSSE_Deinit (EvoObjID idSSE)
EvoObjID EvoSSE_Run_ImgFile (EvoObjID idSSE, const char *imgPath)
EvoObjID EvoSSE_Run_ImgData (EvoObjID idSSE, const EvoImage *data)
EvoObjID EvoSSE_Run_EncImg (EvoObjID idSSE, const void *encImg, unsigned len)
EvoObjID EvoTSSE_Create (void)
EvoRC EvoTSSE_Init_IPP (EvoObjID idTSSE, const char *ccode, const char *dnnDevDesc, const char *url)
EvoRC EvoTSSE_Init_GIC (EvoObjID idTSSE, const char *ccode, const char *dnnDevDesc, EvoObjID idDev, unsigned idxDS)
void EvoTSSE_Deinit (EvoObjID idTSSE)
EvoObjID EvoTSSE_Trigger (EvoObjID idTSSE, EvoObjID *idPic)
EvoRC EvoTSSE_OpenLiveView (EvoObjID idTSSE, uintptr_t win, EvoBool keepAR)
void EvoTSSE_CloseLiveView (EvoObjID idTSSE)
EvoObjID EvoFAVE_Create (void)
EvoRC EvoFAVE_Init_IPP (EvoObjID idFAVE, const char *ccode, const char *dnnDevDesc, const char *url)
EvoRC EvoFAVE_Init_GIC (EvoObjID idFAVE, const char *ccode, const char *dnnDevDesc, EvoObjID idDev, unsigned idxDS)
void EvoFAVE_Deinit (EvoObjID idFAVE)
EvoObjID EvoFAVE_PopLPI (EvoObjID idFAVE, EvoObjID *idGOP)
EvoRC EvoFAVE_GetNumLPI (EvoObjID idFAVE, unsigned *num)
EvoRC EvoFAVE_OpenLiveView (EvoObjID idFAVE, uintptr_t win, EvoBool keepAR)
void EvoFAVE_CloseLiveView (EvoObjID idFAVE)
EvoRC EvoFAVE_SetColorOfSABL (EvoObjID idFAVE, const EvoColor *color)
EvoRC EvoFAVE_SetDepthOfSABL (EvoObjID idFAVE, float depth)
EvoRC EvoFAVE_DrawSABL (EvoObjID idFAVE, EvoBool enable)

Macro Definition Documentation

◆ EVO_INV_OBJ_ID

#define EVO_INV_OBJ_ID   -1

Invalid Object ID, which can be any negative number.

Typedef Documentation

◆ EvoObjID

typedef int EvoObjID

Object ID for all kinds of objects

Function Documentation

◆ Evo_CvtUTF8ToCP()

EvoRC Evo_CvtUTF8ToCP ( const char * utf8,
char * cpBuf,
unsigned bufLen )

Convert strings encoded in UTF-8 into one encoded in the current CodePage.

Note
This function is supported only in Windows platform.
Parameters
[in]utf8String encoded in UTF-8.
[out]cpBufBuffer to store string encoded in the CodePage.
[in]bufLenLength of the buffer in bytes.
Returns
EvoRC code

◆ Evo_FreeObj()

void Evo_FreeObj ( EvoObjID * idObj)

Release all kinds of objects.

Parameters
[in,out]idObjID of object to be released. If normally released, return negative number.

◆ Evo_GetLastRC()

EvoRC Evo_GetLastRC ( void )

Get return codes of Evo Engine's API functions which were called immediately before. This function reflects only non-void API functions which don't have EvoRC codes as return values.

Returns
EvoRC code
Note
This function is aware of multi-threads.

◆ Evo_Initialize()

EvoRC Evo_Initialize ( const char * dnnRunMode,
const char * dataDir,
EvoObjID * idDDI )

Initialize engine's entire environemnt.

Parameters
[in]dnnRunModeDNN Run Mode string. In case of NULL, 'latency' is is used by default. For details, refer to DRM.
[in]dataDirPath to the data directory in installed Evo SDK.
In case of NULL, engines gain the path information from the environment variable EVOENG_DATA_DIR. If both aren't specified, error returns. Note the environment varaiable has precedence when both are specified.
[out]idDDIDDI object ID to be get. If not required, set to NULL. When no more used, must be released using Evo_FreeObj().
Returns
EvoRC code
Note
The country-codes are case-sensitive.
The data direcoty path must include only characters in ASCII code. Or, it could not be found by engine.

◆ EvoCC_Fisheye_ChangeFocalLen()

EvoRC EvoCC_Fisheye_ChangeFocalLen ( EvoObjID idFisheye,
double delta )

Change the current local length. This doesn't directly set the focal length but adds to or subtracts from the default one.

Parameters
[in]idFisheyeObject ID of fisheye-lens camera operation model.
[in]deltaValue which is added or subtraced. If set to zero, the current focal length is set to default value.
Returns
EvoRC code

◆ EvoCC_Fisheye_Create()

EvoObjID EvoCC_Fisheye_Create ( const char * calibName)

Create object of fisheye-lens camera operation model.

Parameters
[in]calibNameName of applied calibration data.
Returns
Object ID of fisheye-Lens camera operation model. If errors occured, NULL is returned and the error code can be obtained using GetLastRC().

◆ EvoCC_Fisheye_GetFocalLen()

EvoRC EvoCC_Fisheye_GetFocalLen ( EvoObjID idFisheye,
double * len )

Get the current focal length.

Parameters
[in]idFisheyeObject ID of fisheye-lens camera operation model.
[out]lenCurrent focal length
Returns
EvoRC

◆ EvoCC_Fisheye_GetOutputSize()

EvoRC EvoCC_Fisheye_GetOutputSize ( EvoObjID idFisheye,
EvoSize * size )

Get current ouptput size of the rectitied image.

Parameters
[in]idFisheyeObject ID of fisheye-lens camera operation model.
[out]sizeCurrent output size.
Returns
EvoRC code

◆ EvoCC_Fisheye_Rectify_EncImg()

EvoObjID EvoCC_Fisheye_Rectify_EncImg ( EvoObjID idFisheye,
const void * encImg,
unsigned len )

Rectify the input image distorted by fisheye-lens.

Parameters
[in]idFisheyeObject ID of fisheye-lens camera operation model.
[in]encImgBuffer for Encoded image such as jpg, png, bmp and so on.
[in]lenLength of the buffer.
Returns
The same as EvoCC_Fisheye_Rectify_ImgFile().

◆ EvoCC_Fisheye_Rectify_ImgData()

EvoObjID EvoCC_Fisheye_Rectify_ImgData ( EvoObjID idFisheye,
const EvoImage * data )

Rectify the input image distorted by fisheye-lens.

Parameters
[in]idFisheyeObject ID of fisheye-lens camera operation model.
[in]dataImage data.
Returns
The same as EvoCC_Fisheye_Rectify_ImgFile().

◆ EvoCC_Fisheye_Rectify_ImgFile()

EvoObjID EvoCC_Fisheye_Rectify_ImgFile ( EvoObjID idFisheye,
const char * imgPath )

Rectify the input image distorted by fisheye-lens.

Parameters
[in]idFisheyeObject ID of fisheye-lens camera operation model.
[in]imgPathPath of the image file.
Returns
Object ID of rectified picture. If no more used, must be release using Evo_FreeObj(). If errors occured, negative number is returned and the error code can be obtained using GetLastRC().

◆ EvoCC_Fisheye_SetOutputSize()

EvoRC EvoCC_Fisheye_SetOutputSize ( EvoObjID idFisheye,
EvoSize * size )

Set ouptput size of the rectitied image. The absolute difference between the max resolution and new output size must be multiple of 2.

Parameters
[in]idFisheyeObject ID of fisheye-lens camera operation model.
[out]sizeNew output size.
Returns
EvoRC code

◆ EvoCC_GetCalibName()

EvoRC EvoCC_GetCalibName ( EvoObjID idCamModel,
char * buf,
unsigned len )

Get name of applied calibration data.

Parameters
[in]idCamModelObject ID of any camera operation model.
[out]bufBuffer to store name of calibration data
[in]lenLength of the buffer in bytes.
Returns
EvoRC code

◆ EvoCC_GetCamProd()

EvoRC EvoCC_GetCamProd ( EvoObjID idCamModel,
char * buf,
unsigned len )

Get name of camera-body product.

Parameters
[in]idCamModelObject ID of any camera operation model.
[out]bufBuffer of the product name.
[in]lenLength of the buffer in bytes.
Returns
EvoRC code
Note
In case camera is not separated as body and lens module but all-in-one type, return name of entire camera product with the lens module included.

◆ EvoCC_GetLensProd()

EvoRC EvoCC_GetLensProd ( EvoObjID idCamModel,
char * buf,
unsigned len )

Get name of lens-module product.

Parameters
[in]idCamModelObject ID of any camera operation model.
[out]bufBuffer of the product name.
[in]lenLength of the buffer in bytes.
Returns
EvoRC code

◆ EvoCC_GetMaxResol()

EvoRC EvoCC_GetMaxResol ( EvoObjID idCamModel,
EvoSize * resol )

Get max resolution of the image sensor.

Parameters
[in]idCamModelObject ID of any camera operation model.
[out]resolSize of the max resolution.
Returns
EvoRC code

◆ EvoDDI_GetDevID()

EvoRC EvoDDI_GetDevID ( EvoObjID idDDI,
char * buf,
unsigned len )

Get ID of the selected DNN device.

Parameters
[in]idDDIDDI object ID
[out]bufBuffer to store the device ID.
[in]lenLength of the buffer in bytes.
Returns
EvoRC code

◆ EvoDDI_GetDMDF()

EvoRC EvoDDI_GetDMDF ( EvoObjID idDDI,
unsigned idx,
char * buf,
unsigned len )

Get specific DMDF supported by the selected DNN device.

Parameters
[in]idDDIDDI object ID
[in]idxIndex of the required DMDF. Its range is [0, Number of DMDFs).
[out]bufBuffer to store the DMDF.
[in]lenLength of the buffer in bytes.
Returns
EvoRC code
Deprecated
Don't use any more because it's deprecated.
If errors occur, surround the code with a pair of the macros 'EVO_ENABLE_DEPRECATION_WARNINGS' and 'EVO_DISABLE_DEPRECATION_WARNINGS'. For example,
EVO_ENABLE_DEPRECATION_WARNINGS
rc = EvoDDI_GetDMDF(idDDI, idx, buf, len);
EVO_DISABLE_DEPRECATION_WARNINGS

◆ EvoDDI_GetFullName()

EvoRC EvoDDI_GetFullName ( EvoObjID idDDI,
char * buf,
unsigned len )

Get full name of the selected DNN device.

Parameters
[in]idDDIDDI object ID
[out]bufBuffer to store device's full name.
[in]lenLength of the buffer in bytes.
Returns
EvoRC code

◆ EvoDDI_GetNumDev()

EvoRC EvoDDI_GetNumDev ( EvoObjID idDDI,
unsigned * num )

Get number of the available DNN devices. For deatils, refer to DNN Devices.

Parameters
[in]idDDIDDI object ID
[out]numNumber of available devices
Returns
EvoRC code

◆ EvoDDI_GetNumDMDF()

EvoRC EvoDDI_GetNumDMDF ( EvoObjID idDDI,
unsigned * num )

Get number of DMDFs supported by the selected DNN device.

Parameters
[in]idDDIDDI object ID
[out]numNumber of supported DMDFs
Returns
EvoRC code
Deprecated
Don't use any more because it's deprecated.
If errors occur, surround the code with a pair of the macros 'EVO_ENABLE_DEPRECATION_WARNINGS' and 'EVO_DISABLE_DEPRECATION_WARNINGS'. For example,
EVO_ENABLE_DEPRECATION_WARNINGS
rc = EvoDDI_GetNumDMDF(idDDI, &num);
EVO_DISABLE_DEPRECATION_WARNINGS

◆ EvoDDI_GetSelDev()

EvoRC EvoDDI_GetSelDev ( EvoObjID idDDI,
unsigned * idx )

Get index of the selected DNN device.

Parameters
[in]idDDIDDI object ID
[out]idxof the selected device.
Returns
EvoRC code

◆ EvoDDI_SelectDev()

EvoRC EvoDDI_SelectDev ( EvoObjID idDDI,
unsigned idx )

Select required DNN device for further process.

Parameters
[in]idDDIDDI object ID
[in]idxIndex of the required device.
Returns
EvoRC code

◆ EvoEng_GetParam_GOPSize()

EvoRC EvoEng_GetParam_GOPSize ( EvoObjID idEngine,
int * size )

Get GOP size parameter of engine. For details, refer to EVOPARAM_GOP_SIZE description in EvoParam.

Parameters
[in]idEngineEngine object ID.
[in]sizeCurrent value.
Returns
EvoRC code

◆ EvoEng_GetParam_LPDJudgeCB()

EvoRC EvoEng_GetParam_LPDJudgeCB ( EvoObjID idEngine,
EvoLPDJudgeCB * cbLPDJudge )

Get LPD callback function parameter of engine. For details, refer to EVOPARAM_LPD_JUDGE_CB description in EvoParam.

Parameters
[in]idEngineEngine object ID.
[out]cbLPDJudgeCurrent value.
Returns
EvoRC code

◆ EvoEng_GetParam_MinSearch()

EvoRC EvoEng_GetParam_MinSearch ( EvoObjID idEngine,
EvoBool * enabled )

Get Min Search parameter of engine. For details, refer to EVOPARAM_MIN_SEARCH description in EvoParam.

Parameters
[in]idEngineEngine object ID.
[in]enabledCurrent value.
Returns
EvoRC code

◆ EvoEng_GetParam_Output()

EvoRC EvoEng_GetParam_Output ( EvoObjID idEngine,
EvoOutput * output )

Get output parameter of engine. For details, refer to EVOPARAM_OUTPUT description in EvoParam.

Parameters
[in]idEngineEngine object ID.
[out]outputCurrent value.
Returns
EvoRC code

◆ EvoEng_GetParam_SearchRect()

EvoRC EvoEng_GetParam_SearchRect ( EvoObjID idEngine,
EvoRect * rect )

Get search rectangle parameter of engine. For details, refer to EVOPARAM_SEARCH_RECT description in EvoParam.

Parameters
[in]idEngineEngine object ID.
[out]rectCurrent value.
Returns
EvoRC code

◆ EvoEng_GetParam_StayTimeout()

EvoRC EvoEng_GetParam_StayTimeout ( EvoObjID idEngine,
int * timeout )

Get Stay Timeout parameter of engine. For details, refer to EVOPARAM_STAY_TIMEOUT description in EvoParam.

Parameters
[in]idEngineEngine object ID.
[in]timeoutCurrent value.
Returns
EvoRC code

◆ EvoEng_SetParam_GOPSize()

EvoRC EvoEng_SetParam_GOPSize ( EvoObjID idEngine,
int size )

Set GOP size parameter of engine. For details, refer to EVOPARAM_GOP_SIZE description in EvoParam.

Parameters
[in]idEngineEngine object ID.
[in]sizeNew value to be set.
Returns
EvoRC code

◆ EvoEng_SetParam_LPDJudgeCB()

EvoRC EvoEng_SetParam_LPDJudgeCB ( EvoObjID idEngine,
EvoLPDJudgeCB cbLPDJudge )

Set LPD callback function parameter of engine For details, refer to EVOPARAM_LPD_JUDGE_CB description in EvoParam.

Parameters
[in]idEngineEngine object ID.
[in]cbLPDJudgeNew value to be set. If not required, set to NULL.
Returns
EvoRC code

◆ EvoEng_SetParam_MinSearch()

EvoRC EvoEng_SetParam_MinSearch ( EvoObjID idEngine,
EvoBool enable )

Set Min Search parameter of engine. For details, refer to EVOPARAM_MIN_SEARCH description in EvoParam.

Parameters
[in]idEngineEngine object ID.
[in]enableNew value to be set.
Returns
EvoRC code

◆ EvoEng_SetParam_Output()

EvoRC EvoEng_SetParam_Output ( EvoObjID idEngine,
const EvoOutput * output )

Set output parameter of engine. For details, refer to EVOPARAM_OUTPUT description in EvoParam.

Parameters
[in]idEngineEngine object ID.
[in]outputNew value to be set.
Returns
EvoRC code

◆ EvoEng_SetParam_SearchRect()

EvoRC EvoEng_SetParam_SearchRect ( EvoObjID idEngine,
const EvoRect * rect )

Set search rectangle parameter of engine. For details, refer to EVOPARAM_SEARCH_RECT description in EvoParam.

Parameters
[in]idEngineEngine object ID.
[in]rectNew value to be set.
Returns
EvoRC code

◆ EvoEng_SetParam_StayTimeout()

EvoRC EvoEng_SetParam_StayTimeout ( EvoObjID idEngine,
int timeout )

Set Stay Timeout parameter of engine. For details, refer to EVOPARAM_STAY_TIMEOUT description in EvoParam.

Parameters
[in]idEngineEngine object ID.
[in]timeoutNew value to be set.
Returns
EvoRC code

◆ EvoFAVE_CloseLiveView()

void EvoFAVE_CloseLiveView ( EvoObjID idFAVE)

◆ EvoFAVE_Create()

EvoObjID EvoFAVE_Create ( void )

Create a Fully Automatic Video Engine.

Returns
The same as EvoSSE_Create()

◆ EvoFAVE_Deinit()

void EvoFAVE_Deinit ( EvoObjID idFAVE)

Deinitialise Fully Automatic Video Engine to release all the resources in use. For further process, must be reinitialized.

Parameters
[in]idFAVEFAVEngine object ID.
Note
After called, recommend checking whether there is any LPI object in the output queue using EvoFAVE_GetNumLPI() or EvoFAVE_PopLPI() because other LPI objects could be received while deinitializing.

◆ EvoFAVE_DrawSABL()

EvoRC EvoFAVE_DrawSABL ( EvoObjID idFAVE,
EvoBool enable )

◆ EvoFAVE_GetNumLPI()

EvoRC EvoFAVE_GetNumLPI ( EvoObjID idFAVE,
unsigned * num )

Get number of LPI data which exists in the output queued.

Parameters
[in]idFAVEFAVEngine object ID.
[out]numNumber of queued LPI objects.
Returns
EvoRC code

◆ EvoFAVE_Init_GIC()

EvoRC EvoFAVE_Init_GIC ( EvoObjID idFAVE,
const char * ccode,
const char * dnnDevDesc,
EvoObjID idDev,
unsigned idxDS )

Initialize Fully Automatic Video Engine for video streaming from GenICam-compatable device.

Parameters
[in]idFAVEFAVEngine object ID.
[in]ccodeThe same as EvoSSE_Init().
[in]dnnDevDescThe same as EvoSSE_Init().
[in]idDevThe same as EvoTSSE_Init_GIC().
[in]idxDSThe same as EvoTSSE_Init_GIC().
Returns
EvoRC code

◆ EvoFAVE_Init_IPP()

EvoRC EvoFAVE_Init_IPP ( EvoObjID idFAVE,
const char * ccode,
const char * dnnDevDesc,
const char * url )

Initialize Fully Automatic Video Engine for video streaming based on IP protocol.

Parameters
[in]idFAVEFAVEngine object ID.
[in]ccodeThe same as EvoSSE_Init().
[in]dnnDevDescThe same as EvoSSE_Init().
[in]urlThe same as EvoTSSE_Init().
Returns
EvoRC code
Note
Don't use any white space in DNN Device Descriptor argument.

◆ EvoFAVE_OpenLiveView()

EvoRC EvoFAVE_OpenLiveView ( EvoObjID idFAVE,
uintptr_t win,
EvoBool keepAR )

The same as EvoTSSE_OpenLiveView().

◆ EvoFAVE_PopLPI()

EvoObjID EvoFAVE_PopLPI ( EvoObjID idFAVE,
EvoObjID * idGOP )

Obtain LPIs and GOPs from output queue. If the queue is empty, this is blocked until there exist.

Parameters
[in]idFAVEFAVEngine object ID.
[out]idGOPGOP object ID related to the returned LPI object. When called, value of the object ID variable must be negative number. If no more used, must be released using Evo_FreeObj().
Returns
Ths same as EvoSSE_Run_ImgFile().
Note
When the video stream has been closed, negative numbers are returned and GetLastRC() return 'EVORC_NO_MORE_DATA'.

◆ EvoFAVE_SetColorOfSABL()

EvoRC EvoFAVE_SetColorOfSABL ( EvoObjID idFAVE,
const EvoColor * color )

◆ EvoFAVE_SetDepthOfSABL()

EvoRC EvoFAVE_SetDepthOfSABL ( EvoObjID idFAVE,
float depth )

◆ EvoGIC_Admin_Get()

EvoObjID EvoGIC_Admin_Get ( void )

Get GenICam administrator. When no more used, must be released using Evo_FreeObj().

Returns
administrator object ID

◆ EvoGIC_Admin_GetDevID()

EvoRC EvoGIC_Admin_GetDevID ( EvoObjID idAdmin,
char * buf,
unsigned len )

Get ID of the selected GenICam device.

Parameters
[in]idAdminAdministrator object ID.
[out]bufBuffer to store the ID
[in]lenLength of the buffer in bytes.
Returns
EvoRC code
Note
This method is effective after EvoGIC_Admin_SelectDev() is called.

◆ EvoGIC_Admin_GetDevIfc()

EvoRC EvoGIC_Admin_GetDevIfc ( EvoObjID idAdmin,
char * buf,
unsigned len )

Get interface type of the selected GenICam device.

Parameters
[in]idAdminAdministrator object ID.
[out]bufBuffer to store the interface type name
[in]lenLength of the buffer in bytes.
Returns
EvoRC code
Note
This method is effective after EvoGIC_Admin_SelectDev() is called.

◆ EvoGIC_Admin_GetDevModel()

EvoRC EvoGIC_Admin_GetDevModel ( EvoObjID idAdmin,
char * buf,
unsigned len )

Get model name of the selected GenICam device.

Parameters
[in]idAdminAdministrator object ID.
[out]bufBuffer to store the model name
[in]lenLength of the buffer in bytes.
Returns
EvoRC code
Note
This method is effective after EvoGIC_Admin_SelectDev() is called.

◆ EvoGIC_Admin_GetDevSerialNo()

EvoRC EvoGIC_Admin_GetDevSerialNo ( EvoObjID idAdmin,
char * buf,
unsigned len )

Get serial number of the selected GenICam device.

Parameters
[in]idAdminAdministrator object ID.
[out]bufBuffer to store the serial number
[in]lenLength of the buffer in bytes.
Returns
EvoRC code
Note
This method is effective after EvoGIC_Admin_SelectDev() is called.

◆ EvoGIC_Admin_GetDevVendor()

EvoRC EvoGIC_Admin_GetDevVendor ( EvoObjID idAdmin,
char * buf,
unsigned len )

Get vendor of the selected GenICam device.

Parameters
[in]idAdminAdministrator object ID.
[out]bufBuffer to store the vendor name
[in]lenLength of the buffer in bytes.
Returns
EvoRC code
Note
This method is effective after EvoGIC_Admin_SelectDev() is called.

◆ EvoGIC_Admin_GetNumDev()

EvoRC EvoGIC_Admin_GetNumDev ( EvoObjID idAdmin,
unsigned * num )

Get number of all the supported GenICam devices.

Parameters
[in]idAdminAdministrator object ID.
[out]numNumber of supported GenICam devices.
Returns
EvoRC code
Note
This method is effective after EvoGIC_Admin_UpdateDevList() is called.

◆ EvoGIC_Admin_GetSelDev()

EvoRC EvoGIC_Admin_GetSelDev ( EvoObjID idAdmin,
unsigned * idx )

Get the GenICam device which is currently selected.

Parameters
[in]idAdminAdministrator object ID.
[in]idxIndex of the selected GenICam device
Returns
EvoRC code
Note
This method is effective after EvoGIC_Admin_SelectDev() is called.

◆ EvoGIC_Admin_OpenDev()

EvoObjID EvoGIC_Admin_OpenDev ( EvoObjID idAdmin)

Open the required GenICam device. When no more used, must be released using Evo_FreeObj().

Parameters
[in]idAdminAdministrator object ID.
Returns
Object ID of the opened device.
Note
This method is effective after EvoGIC_Admin_SelectDev() is called.

◆ EvoGIC_Admin_SelectDev()

EvoRC EvoGIC_Admin_SelectDev ( EvoObjID idAdmin,
unsigned idx )

Select specific GenICam device.

Parameters
[in]idAdminAdministrator object ID.
[in]idxIndex to required GenICam device.
Returns
EvoRC code
Note
This method is effective after EvoGIC_Admin_UpdateDevList() is called.

◆ EvoGIC_Admin_UpdateDevList()

EvoRC EvoGIC_Admin_UpdateDevList ( EvoObjID idAdmin)

Find out all the GenICam devices connected through supported interfaces such as Ethernet, USB, FireWire and so on. This function could take several seconds dependinig on systems.

Parameters
[in]idAdminAdministrator object ID.
Returns
EvoRC code

◆ EvoGIC_Dev_GetID()

EvoRC EvoGIC_Dev_GetID ( EvoObjID idDev,
char * buf,
unsigned len )

Get GenICam device's ID.

Parameters
[in]idDevDevice object ID
[out]bufBuffer to store the ID
[in]lenLength of the buffer in bytes.
Returns
EvoRC code

◆ EvoGIC_Dev_GetInterface()

EvoRC EvoGIC_Dev_GetInterface ( EvoObjID idDev,
char * buf,
unsigned len )

Get GenICam device's interface type such as Ethernet, USB and so on.

Parameters
[in]idDevDevice object ID
[out]bufBuffer to store the interface type name
[in]lenLength of the buffer in bytes.
Returns
EvoRC code

◆ EvoGIC_Dev_GetModel()

EvoRC EvoGIC_Dev_GetModel ( EvoObjID idDev,
char * buf,
unsigned len )

Get GenICam device's model.

Parameters
[in]idDevDevice object ID
[out]bufBuffer to store the model name
[in]lenLength of the buffer in bytes.
Returns
EvoRC code

◆ EvoGIC_Dev_GetNumDataStreams()

EvoRC EvoGIC_Dev_GetNumDataStreams ( EvoObjID idDev,
unsigned * num )

Get number of data streams which the GenICam device can provide.

Parameters
[in]idDevDevice object ID
[out]numNumber of data streams
Returns
EvoRC code

◆ EvoGIC_Dev_GetSerialNo()

EvoRC EvoGIC_Dev_GetSerialNo ( EvoObjID idDev,
char * buf,
unsigned len )

Get GenICam device's serial number.

Parameters
[in]idDevDevice object ID
[out]bufBuffer to store the serial-number
[in]lenLength of the buffer in bytes.
Returns
EvoRC code

◆ EvoGIC_Dev_GetVendor()

EvoRC EvoGIC_Dev_GetVendor ( EvoObjID idDev,
char * buf,
unsigned len )

Get GenICam device's vendor.

Parameters
[in]idDevDevice object ID
[out]bufBuffer to store the vendor name
[in]lenLength of the buffer in bytes.
Returns
EvoRC code

◆ EvoGOP_GetHeadDir()

EvoRC EvoGOP_GetHeadDir ( EvoObjID idGOP,
EvoHeadDir * heading )

Get automobile's heading direction all over the pictures. This is influenced by EvoEng_SetParam_Output().

Parameters
[in]idGOPGOP object ID
[out]headingHeading direction
Returns
EvoRC code

◆ EvoGOP_GetNumPic()

EvoRC EvoGOP_GetNumPic ( EvoObjID idGOP,
unsigned * num )

Get number of pictures which the GOP contains.

Parameters
[in]idGOPGOP object ID
[out]numNumber of pictures
Returns
EvoRC

◆ EvoGOP_GetPicImg()

EvoRC EvoGOP_GetPicImg ( EvoObjID idGOP,
EvoImage * img )

Get image data of the selected picture.

Parameters
[in]idGOPGOP object ID
[out]imgimage data
Returns
EvoRC code

◆ EvoGOP_GetPicTime()

EvoRC EvoGOP_GetPicTime ( EvoObjID idGOP,
int64_t * time,
EvoTimeUnit unit )

Get time stamp when selected picture was captured. For details, refer to EvoPic_GetTime().

Parameters
[in]idGOPGOP object ID
[out]timeThe same as EvoPic_GetTime()
[in]unitThe same as EvoPic_GetTime()
Returns
EvoRC code

◆ EvoGOP_GetPosInPic()

EvoRC EvoGOP_GetPosInPic ( EvoObjID idGOP,
EvoRect * rect )

Get position of the license plate in the selected picture.

Parameters
[in]idGOPGOP object ID
[out]rectPosition of the license plate.
Returns
EvoRC code

◆ EvoGOP_GetSelPic()

EvoRC EvoGOP_GetSelPic ( EvoObjID idGOP,
unsigned * idx )

Get the currently selected picture.

Parameters
idGOPGOP object ID
idxIndex of the selected picture.

◆ EvoGOP_SaveAllInTIFF()

EvoRC EvoGOP_SaveAllInTIFF ( EvoObjID idGOP,
const char * path,
int quality )

Create TIFF file with all the pictures JPEG-compressed.

Parameters
[in]idGOPGOP object ID
[in]pathThe same as EvoPic_SaveInJPEG()
[in]qualityThe same as EvoPic_SaveInJPEG()
Returns
EvoRC code

◆ EvoGOP_SavePicInJPEG()

EvoRC EvoGOP_SavePicInJPEG ( EvoObjID idGOP,
const char * path,
int quality )

Create JPEG file from the selected picture.

Parameters
[in]idGOPGOP object ID
[in]pathThe same as EvoPic_SaveInJPEG()
[in]qualityThe same as EvoPic_SaveInJPEG()
Returns
EvoRC code

◆ EvoGOP_SavePicInPNG()

EvoRC EvoGOP_SavePicInPNG ( EvoObjID idGOP,
const char * path,
int compression )

Create PNG file of the selected picture.

Parameters
[in]idGOPGOP object ID
[in]pathThe same as EvoPic_SaveInPNG()
[in]compressionThe same as EvoPic_SaveInPNG()
Returns
EvoRC code

◆ EvoGOP_SelectPic()

EvoRC EvoGOP_SelectPic ( EvoObjID idGOP,
unsigned idx )

Select required picture.

Parameters
[in]idGOPGOP object ID
[in]idxIndex of required picture
Returns
EvoRC code

◆ EvoLPI_GetCharConf()

EvoRC EvoLPI_GetCharConf ( EvoObjID idLPI,
float * buf,
unsigned * num )

Get confidence of each character to compose the string. The order of confidences are equal to one of characters to be returned on EvoLPI_GetStr().

Parameters
[in]idLPILPI object ID
[out]bufBuffer to store the confidences
[in,out]numWhen called, it is max number of confidences which can be stored in the buffer. When return, it is number of condiences which are actually stored in the buffer.
Returns
EvoRC code

◆ EvoLPI_GetNumLP()

EvoRC EvoLPI_GetNumLP ( EvoObjID idLPI,
unsigned * num )

Get number of recognized license plates.

Parameters
[in]idLPILPI object ID
[out]numNumber of the license plates
Returns
EvoRC code

◆ EvoLPI_GetPos()

EvoRC EvoLPI_GetPos ( EvoObjID idLPI,
EvoRect * rect )

Get position of the selected license plate.

Parameters
[in]idLPILPI object ID
[out]rectPosition on input image
Returns
EvoRC code
Note
In FAVEngine, this is invalidated. Instead, use EvoGOP_GetPos().

◆ EvoLPI_GetSelLP()

EvoRC EvoLPI_GetSelLP ( EvoObjID idLPI,
unsigned * idx )

Get the currently selected license plate.

Parameters
[in]idLPILPI object ID
[out]idxIndex of selected license plate.
Returns
EvoRC code

◆ EvoLPI_GetStr()

EvoRC EvoLPI_GetStr ( EvoObjID idLPI,
char * buf,
unsigned len )

Get string of the selected license plate.

Parameters
[in]idLPILPI object ID
[out]bufBuffer to store the string in UTF-8.
[in]lenLength of the buffer in bytes.
Returns
EvoRC code

◆ EvoLPI_GetType()

EvoRC EvoLPI_GetType ( EvoObjID idLPI,
EvoLPT * type,
float * confidence )

Get type of the selected license plate.

Parameters
[in]idLPILPI object ID
[out]typeType of the license plate. For details, refer to License Plate Types.
[out]confidenceConfidence of the type. Its range is [0, 100].
Returns
EvoRC code

◆ EvoLPI_SelectLP()

EvoRC EvoLPI_SelectLP ( EvoObjID idLPI,
unsigned idx )

Select required license plate for further process.

Parameters
[in]idLPILPI object ID
[in]idxIndex of required license plate.
Returns
EvoRC code

◆ EvoPic_GetImage()

EvoRC EvoPic_GetImage ( EvoObjID idPic,
EvoImage * img )

Get image data of the picture.

Parameters
[in]idPicPicture object ID.
[out]imgImage Data.
Returns
EvoRC Code

◆ EvoPic_GetTime()

EvoRC EvoPic_GetTime ( EvoObjID idPic,
int64_t * time,
EvoTimeUnit unit )

Get time stamp when the picture was captured.

Parameters
[in]idPicPicture object ID
[in]unitPrecision of the time stamp
[out]timeTime Stamp
Returns
EvoRC code
Note
Because the time stamp is represented as Unix's Epoch Time, for local time must be converted as below
int64_t timeUTC;

if(EvoPic_GetTime(idPic, &timeUTC, EVOTU_MS) == EVORC_OK)
{
    time_t timeRaw;
    int64_t timeMS;
    struct tm *timeInfo = NULL;

    timeMS = timeUTC % 1000;
    timeRaw = time_t(timeUTC / 1000);
    timeInfo = localtime(&timeRaw);

    cout << timeInfo->tm_year + 1900 << '-'
         << timeInfo->tm_mon + 1 << '-'
         << timeInfo->tm_mday << ' '
         << timeInfo->tm_hour << ':'
         << timeInfo->tm_min << ':'
         << timeInfo->tm_sec << '.'
         << timeMS << endl;
}

◆ EvoPic_SaveInJPEG()

EvoRC EvoPic_SaveInJPEG ( EvoObjID idPic,
const char * path,
int quality )

Create JPEG file of the picture.

Parameters
[in]idPicPicture object ID
[in]pathPath to JPEG file, which must have eigher of the extension '.jpg' or '.jpeg'.
[in]qualityQuality level of the compressed picture, which is the range [0, 100].
Returns
EvoRC code

◆ EvoPic_SaveInPNG()

EvoRC EvoPic_SaveInPNG ( EvoObjID idPic,
const char * path,
int compression )

Create PNG file of the picture.

Parameters
[in]idPicPicture object ID
[in]pathPath to PNG file, which must have the extension '.png'.
[in]compressionCompression level of the picture, which is the range [0, 9].
Returns
EvoRC code

◆ EvoSSE_Create()

EvoObjID EvoSSE_Create ( void )

Create a Snapshot Engine.

Returns
Object ID of the created engine. If fail, negative number returns. In that case, Evo_GetLastRC() can be used to know the reasion.
If no more used, must be destroyed using Evo_FreeObj().

◆ EvoSSE_Deinit()

void EvoSSE_Deinit ( EvoObjID idSSE)

Deinitialise Snapshot Engine to release all the resources in use. For further process, Must be reinitialized.

Parameters
[in]idSSESSEngine object ID.

◆ EvoSSE_Init()

EvoRC EvoSSE_Init ( EvoObjID idSSE,
const char * ccode,
const char * dnnDevDesc )

Initialize Snapshot Engine

Parameters
[in]idSSESSEngine object ID.
[in]ccodeRequired country-code which has been already registered. For details, refer to Evo_Initialize() and Country Codes.
[in]dnnDevDescDNN Device Descriptor string. If NULL, the engine builds optimal descriptor automatically.For details, refer to DNN Device Descriptor.
Returns
EvoRC code
Note
Don't use any white space in DNN Device Descriptor string.

◆ EvoSSE_Run_EncImg()

EvoObjID EvoSSE_Run_EncImg ( EvoObjID idSSE,
const void * encImg,
unsigned len )

Detect and recognize all the license plates on single image.

Parameters
[in]idSSESSEngine object ID.
[in]encImgBuffer to contain the image which is encoded in JPEG, PNG, BMP and so on.
[in]lenLength of the buffer in bytes.
Returns
The same as EvoSSE_Run_ImgFile()
Warning
Must keep the input image buffer intact until returned. Or, the engine could become unknown state.

◆ EvoSSE_Run_ImgData()

EvoObjID EvoSSE_Run_ImgData ( EvoObjID idSSE,
const EvoImage * data )

Detect and recognize all the license plates on single image.

Parameters
[in]idSSESSEngine object ID.
[in]dataImage data
Returns
The same as EvoSSE_Run_ImgFile()
Warning
Must keep the input image buffer intact until returned. Or, the engine could become unknown state.

◆ EvoSSE_Run_ImgFile()

EvoObjID EvoSSE_Run_ImgFile ( EvoObjID idSSE,
const char * imgPath )

Detect and recognize all the license plates on single image.

Parameters
[in]idSSESSEngine object ID.
[in]imgPathPath to the image file.
Returns
LPI object ID. If there is nothing or error occurs, return negative number. In this case, Evo_GetLastRC() can be used to know the reasion.
If no more used, must be released using Evo_FreeObj().

◆ EvoTSSE_CloseLiveView()

void EvoTSSE_CloseLiveView ( EvoObjID idTSSE)

If live-view is opened, close it.

Parameters
[in]idTSSETSSEngine object ID.
Note
If the live-view is opened, this method must be explicitly called before any of following cases occur.
  1. EvoTSSE_Deinit() or Evo_FreeObj() is called.
  2. The window for live-view is destroyed.
  3. The window for live-view is changed to a different one.

◆ EvoTSSE_Create()

EvoObjID EvoTSSE_Create ( void )

Create a Triggered Snapshot Engine.

Returns
The same as EvoSSE_Create()

◆ EvoTSSE_Deinit()

void EvoTSSE_Deinit ( EvoObjID idTSSE)

Deinitialise Triggered Snapshot Engine to release all the resources in use. For further process, must be reinitialized.

Parameters
[in]idTSSETSSEngine object ID.

◆ EvoTSSE_Init_GIC()

EvoRC EvoTSSE_Init_GIC ( EvoObjID idTSSE,
const char * ccode,
const char * dnnDevDesc,
EvoObjID idDev,
unsigned idxDS )

Initialize the Triggered Snapshot Engine for video streaming from GenICam-compatable device.

Parameters
[in]idTSSETSSEngine object ID.
[in]ccodeThe same as EvoSSE_Init().
[in]dnnDevDescThe same as EvoSSE_Init(). If NULL, the engine builds optimal descriptor automatically.
[in]idDevObject ID of the opened GenICam device. For details, refer to EvoGIC_Admin_OpenDev().
[in]idxDSData-Stream index which corresponds to video stream from the GenICam device.
Returns
EvoRC code
Note
Don't use any white space in DNN Device Descriptor argument.

◆ EvoTSSE_Init_IPP()

EvoRC EvoTSSE_Init_IPP ( EvoObjID idTSSE,
const char * ccode,
const char * dnnDevDesc,
const char * url )

Initialize the Triggered Snapshot Engine for video streaming based on IP protocol.

Parameters
[in]idTSSETSSEngine object ID.
[in]ccodeThe same as EvoSSE_Init().
[in]dnnDevDescThe same as EvoSSE_Init().
[in]urlURL of video streaming source. For example, 'rtsp://192.168.10.5/media'.
Returns
EvoRC code
Note
Don't use any white space in DNN Device Descriptor argument.

◆ EvoTSSE_OpenLiveView()

EvoRC EvoTSSE_OpenLiveView ( EvoObjID idTSSE,
uintptr_t win,
EvoBool keepAR )

Open video's live-view, which uses OpenGL to reduce latency and CPU load. So, it is recommended to install the last version of display driver. For details, refer to 'System Requirements' section.

Parameters
[in]idTSSETSSEngine object ID.
[in]winWindow handle or ID to be used as live view. On Linux platform, This is value of Xlib's 'Window' type and on Windows platform, this is value of Win32-API's 'HWND' type.
[in]keepARDetermine whether video's aspect-ratio is kept or not although the live-view window is resized.
Returns
EvoRC code

◆ EvoTSSE_Trigger()

EvoObjID EvoTSSE_Trigger ( EvoObjID idTSSE,
EvoObjID * idPic )

Get the last captured picture and find license plates on it.

Parameters
[in]idTSSETSSEngine object ID.
[out]idPicPicture object ID. When called, value of the object ID variable must be negative number. If no more used, must be released using Evo_FreeObj().
Returns
Ths same as EvoSSE_Run_ImgFile().
Note
When the video stream has been closed, negative numbers are returned and GetLastRC() return 'EVORC_NO_MORE_DATA'.