GA/T 1181-2014 安防指静脉识别应用 程序接口规范

ICS13.310

A91

中华人民共和国公共安全行业标准

/—

GAT11812014

安防指静脉识别应用程序接口规范

Alicationrorammininterfaceoffinerveinreconnitioninsecuritsstem

pppggggyy

ㅤㅤㅤㅤ

2014-09-01发布2014-10-01实施

中华人民共和国公安部发布

/—

GAT11812014

目次

前言…………………………Ⅲ

1范围………………………1

2规范性引用文件…………………………1

3接口文件…………………1

3.1文件格式……………1

3.2文件名称……………1

4接口函数…………………1

4.1接口描述方式………………………1

4.2指静脉采集设备接口………………3

4.3指静脉识别模块接口………………8

4.4指静脉识别算法接口………………16

4.5错误代码……………19

4.6常量列表……………20

……………………

、

4.7类型调用定义21

()……………………

附录A资料性附录应用程序接口函数调用流程23

ㅤㅤㅤㅤ

Ⅰ

/—

GAT11812014

安防指静脉识别应用程序接口规范

1范围

本标准规定了安防指静脉识别应用程序接口的文件格式与接口函数。

本标准适用于安防指静脉识别应用中图像采集和数据处理过程。

2规范性引用文件

。,

下列文件对于本文件的应用是必不可少的凡是注日期的引用文件仅注日期的版本适用于本文

。,()。

件凡是不注日期的引用文件其最新版本包括所有的修改单适用于本文件

信息技术通用多八位编码字符集()

GB13000UCS

3接口文件

3.1文件格式

,()。

在Windows平台下接口函数采用Windows动态链接库DLL形式发布支持的操作系统应包

///。,。

括WindowsXPVista78及兼容系统接口函数应在动态链接库中导出支持多线程对于不同的

ㅤㅤㅤㅤ

,。

平台应该分别编译成不同的动态链接库进行发布

,()。

在Linux平台下接口函数采用Linux动态链接库SO形式发布接口函数应在动态链接库中导

,。,。

出支持多线程对于不同的平台和Linux内核版本应该分别编译成不同的动态链接库进行发布

3.2文件名称

动态链接库文件名称见表1。

表1动态链接库文件命名

接口Windows系统Linux系统

__

指静脉采集设备接口IDFVD.dllIDFVD.so

__

指静脉识别模块接口IDFVM.dllIDFVM.so

__

指静脉算法接口IDFVA.dllIDFVA.so

4接口函数

4.1接口描述方式

,,,。

在本标准中接口函数用语言进行描述若采用其他语言可以根据语义进行转换

C

接口函数中的返回错误代码应符合4.5的要求。

,、、、。

接口函数中的常量包括工作状态定义参数类型定义操作选项标志定义等应符合4.6的要求

、、、、_,

接口函数中与平台相关的宏定义例如FVAPIFVCALLINOUTINOUT等类型定义FVRE-

1

/—

GAT11812014

、、等应符合的要求。

SULTFVDHANDLEFVMHANDLE4.7

接口的简单调用流程参见附录A。

全部接口函数列表见表2。

表2全部接口函数列表

名称说明章条号

_

FVDGetVersion获取指静脉采集设备接口库版本4.2.1

_

FVDGetErrorInfo获取指静脉采集设备错误代码描述信息4.2.2

_

FVDInitialize初始化指静脉采集设备接口4.2.3

_

FVDRelease释放指静脉采集设备接口4.2.4

_

FVDEnumDevices枚举指静脉采集设备4.2.5

_

FVDOenDevice打开指静脉采集设备4.2.6

p

_

FVDCloseDevice关闭指静脉采集设备4.2.7

_

FVDGetDeviceInfo获取一个指静脉采集设备的描述信息4.2.8

_

FVDGetStatus获取指静脉采集设备当前状态4.2.9

_

FVDCancel终止指静脉采集设备当前动作4.2.10

_

FVDGetParameter获取指静脉采集设备的参数4.2.11

_

FVDSetParameter设置指静脉采集设备的参数4.2.12

_

FVDWaitFiner等待手指放好或离开4.2.13

g

ㅤㅤㅤㅤ

_

FVDCature采集指静脉图像4.2.14

p

_

FVMGetVersion获取指静脉识别模块接口库版本4.3.1

_

FVMGetErrorInfo获取指静脉识别模块错误代码描述信息4.3.2

_

FVMInitialize初始化指静脉识别模块接口4.3.3

_

FVMRelease释放指静脉识别模块接口4.3.4

_

FVMEnumModules枚举指静脉识别模块4.3.5

_

FVMOenModule打开指静脉识别模块4.3.6

p

_

FVMCloseModule关闭指静脉识别模块4.3.7

_

FVMGetModuleInfo获取一个指静脉识别模块的描述信息4.3.8

_

FVMGetStatus获取指静脉识别模块当前状态4.3.9

_

FVMCancel终止指静脉识别模块当前动作4.3.10

_

FVMGetParameter获取指静脉识别模块的参数4.3.11

_

FVMSetParameter设置指静脉识别模块的参数4.3.12

_

FVMWaitFiner等待手指放好或离开4.3.13

g

_

FVMCreateGroup创建组4.3.14

_

FVMRemoveGroup删除组4.3.15

_

FVMListGrous列出组4.3.16

p

_

FVMGrouExists判断组是否存在4.3.17

p

2

/—

GAT11812014

()

表续

2

名称说明章条号

_

FVMGetTemlate获得指静脉模板4.3.18

p

_

FVMSetTemlate设置指静脉模板4.3.19

p

_

FVMRemoveTemlate删除组中模板4.3.20

p

_

FVMListTemlates列出组中模板4.3.21

p

_

FVMTemlateExists判断模板是否存在4.3.22

p

_

FVMBackuGrous指静脉分组注册信息备份4.3.23

pp

_

FVMRestoreGrous指静脉分组注册信息恢复4.3.24

p

_

FVMEnroll指静脉注册4.3.25

_

FVMMatch指静脉特征比对4.3.26

_

FVMIdentif指静脉特征辨认4.3.27

y

_

FVAGetVersion获取指静脉算法接口程序版本4.4.1

_

FVAGetErrorInfo获取静脉识别算法错误代码描述信息4.4.2

_

FVAInitialize指静脉算法接口初始化4.4.3

_

FVARelease指静脉算法接口释放4.4.4

_

FVAGetParameter获取指静脉算法参数4.4.5

ㅤㅤㅤㅤ

_

FVASetParameter设置指静脉算法参数4.4.6

_

FVASamleQualit获取指静脉图像质量评分4.4.7

py

_

FVAQualitLevel获取图像质量建议等级4.4.8

y

_

FVAFeatureExtract指静脉特征提取4.4.9

_

FVAMatch指静脉特征比对4.4.10

4.2指静脉采集设备接口

4.2.1获取指静脉采集设备接口库版本

函数原型:_([])

FVAPIFVRESULTFVCALLFVDGetVersionOUTCHARcode16

参数:[],返回指静脉采集设备接口库版本。[]统一规定为

CHARcode16code0~3

’’。[]。[]。

1000code4~7为开发者代码code8~15为版本号可使用的字符包括数

、。。

字大小写字母和空格输出参数

返回值:调用成功返回1,

。_。

否则返回错误代码调用4.2.2所描述FVDGetErrorInfo函数获取错误信息

说明:获取指静脉采集设备接口库版本。

4.2.2获取指静脉采集设备错误代码描述信息

函数原型:_(,

FVAPIFVRESULTFVCALLFVDGetErrorInfoININT32nErrorNoOUT

[])

CHARszErrorInfo256

3

/—

GAT11812014

:,。。

参数UINT32nErrorNo错误代码输入参数

[],,

CHARszErrorInfo256存放错误信息的内存块错误信息的长度不能超过256个

。。

字节输出参数

返回值:调用成功返回1,

否则返回错误代码。

说明:获取指静脉采集设备错误代码描述信息。szErrorInfo应符合GB13000中规定的

字符。

4.2.3初始化指静脉采集设备接口

函数原型:FVAPIFVRESULTFVCALLFVDInitialize_()

参数:无。

返回值:调用成功返回1,

否则返回错误代码。

_

:。,

说明初始化指静脉采集设备接口在成功调用此函数之前除和

FVDGetVersionFVD

_

。,,

GetErrorInfo以外的接口函数都无效在每个进程中本函数只需要调用一次允

,。

许重复调用其结果与多次调用相同

4.2.4释放指静脉采集设备接口

函数原型:FVAPIFVRESULTFVCALLFVDRelease_()

参数:无。ㅤㅤㅤㅤ

返回值:调用成功返回1,

否则返回错误代码。

:。,,

说明释放指静脉采集设备接口调用此函数后所有采集设备的当前操作终止所有采集

_

,。。

设备关闭释放所有分配的资源系统恢复到调用FVDInitialize函数之前的状态

4.2.5枚举指静脉采集设备

函数原型:_(

FVAPIFVRESULTFVCALLFVDEnumDevicesOUTUINT32*

,,

DeviceCountOUTFVDEVICEINFO*DeviceArraINUINT32unDeviceAr-

ppy

)

raSize

y

:,,(

参数UINT32*DeviceCount采集设备数量传入UINT32型变量的地址不可为

p

),。。

NULL返回系统中可用的指静脉采集设备数量输出参数

,,

FVDEVICEINFO*DeviceArra枚举结果数组传入一个FVDEVICEINFO数组

py

,。。

地址返回枚举结果到其中输出参数

,。。

eArraSize枚举结果数组大小输入参数

UINT32unDevicy

返回值:调用成功返回1,

否则返回错误代码。

:,,

说明枚举系统中所有可用的指静脉采集设备返回设备数量到pDeviceCount返回当前

系统中所有可用采集设备的描述信息到DeviceArra中。

py

,,

DeviceArra可传入此时须同时设置为本函数此时

pyNULLunDeviceArraSize0

y

只返回可用的采集设备数量。

4

/—

GAT11812014

4.2.6打开指静脉采集设备

函数原型:_([],

FVAPIFVRESULTFVCALLFVDOenDeviceINCHARDeviceUUID16

p

)

OUTFVDHANDLE*hDevice

p

:[],。。

参数CHARDeviceUUID16设备唯一识别码输入参数

,。。

FVDHANDLE*hDevice设备句柄输出参数

p

返回值:调用成功返回1,

否则返回错误代码。

:,,

说明打开设备唯一识别码为DeviceUUID的指静脉采集设备初始化硬件为其分配所需

,。

的资源并返回一个操作句柄到phDevice设备唯一识别码DeviceUUID可用FVD

_EnumDevices接口枚举得到。

,,

同一个采集设备只可以打开一次通过返回的设备句柄对其进行操作再次打开此设

备则返回失败。

,。

设备打开前处于关闭状态成功打开后变为就绪状态

4.2.7关闭指静脉采集设备

函数原型:_()

FVAPIFVRESULTFVCALLFVDCloseDeviceINFVDHANDLEhDevice

:,。。

参数FVDHANDLEhDevice设备句柄输入参数

返回值:调用成功返回1,

否则返回错误代码。

:,,,

说明关闭一个设备句柄释放为此句柄分配的资源调用成功后变为关闭状态不能再对

ㅤㅤㅤㅤ

此句柄进行其他操作。

4.2.8获取一个指静脉采集设备的描述信息

函数原型:_(,

FVAPIFVRESULTFVCALLFVDGetDeviceInfoINFVDHANDLEhDevice

OUTFVDEVICEINFO*DeviceInfo)

p

:,。。

参数FVDHANDLEhDevice设备句柄输入参数

,,

FVDEVICEINFO*DeviceInfo传入一个FVDEVICEINFO类型地址返回设备

p

。。

描述信息到其中输出参数

返回值:调用成功返回1,

否则返回错误代码。

说明:获取设备句柄hDevice所指向的指静脉采集设备的描述信息。

4.2.9获取指静脉采集设备当前状态

函数原型:_(,

FVAPIFVRESULTFVCALLFVDGetStatusINFVDHANDLEhDeviceOUT

)

INT32*Status

p

:,。。

参数FVDHANDLEhDevice设备句柄输入参数

,。。

UINT32*Status状态编码输出参数

p

返回值:调用成功返回1,

否则返回错误代码。

说明:获取设备句柄hDevice所指向的指静脉采集设备的状态。

工作状态见表4。

5

/—

GAT11812014

4.2.10终止指静脉采集设备当前动作

函数原型:_()

FVAPIFVRESULTFVCALLFVDCancelINFVDHANDLEhDevice

:,。。

参数FVDHANDLEhDevice设备句柄输入参数

返回值:调用成功返回1,

否则返回错误代码。

:。

说明终止设备句柄hDevice所指向的指静脉采集设备的当前动作即如果采集设备当前

,,。

正在工作状态则调用此函数后其正在进行的动作被终止状态变为就绪状态

4.2.11获取指静脉采集设备的参数

函数原型:_(,

FVAPIFVRESULTFVCALLFVDGetParameterINFVDHANDLEhDeviceIN

,,,

INT32nParameterOUTBYTE*DataBufferINUINT32unDataBufferSize

p

)

OUTUINT32*DataSize

p

:,。。

参数FVDHANDLEhDevice设备句柄输入参数

,。。

UINT32nParameter参数种类输入参数

,,。输出

BYTE*DataBuffer返回数据缓冲区具体数据格式取决于nParameter

p

参数。

,。。

UINT32unDataBufferSize数据缓冲区的字节数输入参数

,。。

UINT32*DataSize返回参数数据的字节数输出参数

p

返回值:调用成功返回1,

ㅤㅤㅤㅤ

否则返回错误代码。

说明:获取设备句柄hDevice所指向的指静脉采集设备的当前参数,的定义见

nParameter

4.6.2。

,。

传入一个数据缓冲区地址pDataBuffer用于返回参数数据

,,

pDataBuffer可传入NULLunDataBufferSize须同时设置为0本函数此时返回参数

nParameter所可能返回的最大数据字节数到pDataSize中。