车牌自动识别器DLL接口说明

车牌识别系统 DLL 软件开发对外接口 使使 用用 说说 明明 书书 1 目录目录 第一章 HVDLL dll 接口概述 3 第二章 对外接口函数详细说明 4 1 单个设备连接接口函数 4 1 1 OpenHv 4 1 2 CloseHv 4 1 3 CloseIP 5 1 4 HvIsConnected 5 1 5 SetHvCallBack 5 1 6 CARINFO BEGIN CALLBACK 6 1 7 CARINFO END CALLBACK 6 1 8 PLATE NO CALLBACK 7 1 9 BIG IMAGE CALLBACK 7 1 10 SMALL IMAGE CALLBACK 8 1 11 BINARY IMAGE CALLBACK 8 1 12 VIDEO CALLBACK 9 1 13 VIDEO HISTORY CALLBACK 10 1 14 STREAM CALLBACK 10 1 15 DEBUG STR CALLBACK 11 1 16 SearchHVDeviceCount 11 1 17 GetHVDeviceAddr 12 1 18 SetHvIPFromMac 12 1 19 Yuv2Rgb 12 1 20 Yuv2BMP 13 1 21 Yuv2Jpg 13 1 22 HV ForceSend 14 1 23 HV ForceSendEx 14 1 24 HV GetPlateInfo 14 1 25 HV ProcessUserData 15 1 26 HV GetHistoryVideo 15 1 27 HV CombineTwoImagesToOneImage 16 1 28 HV AntiTamper Embed 16 1 29 HV AntiTamper Examine 17 1 30 SendTriggerOut 17 1 31 SetHvTime 18 1 32 GetHvTime 18 2 视频检测器接口函数 18 2 1 TRIGGERINFO CALLBACK 18 2 2 HV GetStatInfo 19 3 主动连接接口函数 20 3 1 OpenHvServer 20 3 2 CloseHvServer 20 3 3 CONNECT EVENT 20 3 4 DISCONNECT EVENT 21 3 5 SetHvServerEvent 21 第三章 应用系统开发说明 21 第四章 HVDLL 编程指南 25 1 编写回调函数 25 2 创建句柄 25 3 设置回调 25 4 Timer 事件 26 5 取消回调 26 6 关闭句柄 27 2 HVDLL dll 接口概述接口概述 HVDLL dll 是我公司车牌识别系统的核心接口 负责从识别器接收识别结果和视频信 息 是各种接收应用程序的底层接口 由于 HVDLL API 函数内部实现中只能提供有限的保护 任何句柄和指针参数的错误传 递都有可能导致后台软件的崩溃 HVDLL API 数据类型定义 HVDLL API 定义类型定义类型类型原型类型原型 HV APIextern C declspec dllimport HV HANDLEvoid E HV INVALID HANDLENULL S OK0 x00000000L E FAIL0 x80000008L E HANDLE0 x80000006L S FALSE0 x00000001L E POINTER0 x80000005L 图像格式 IMAGE YUV1 IMAGE JPEG2 IMAGE BIN3 数据流类型定义 TYPE PLATE STR0 x8002该数据所承载的 信息流是 车牌 号码字符流 TYPE BIG IMAGE0 x8003该数据所承载的 信息流是 车牌 大图像流 TYPE SMALL IMAGE0 x8004该数据所承载的 信息流是 车牌 小图像流 TYPE FULL CMP IMAGE0 x8005该数据所承载 的信息流是 完整的压缩视 频流 TYPE BINARY IMAGE0 x8006该数据所承载 的信息流是 车牌二值化小 图像流 TYPE CARINFO BEGIN0 x8008该数据所承载 的信息流是 车辆信息开始 接收信号 TYPE CARINFO END0 x8009该数据所承载 的信息流是 车辆信息结束 3 接收信号 TYPE CUSTOMERDETECT BI N 0 x810D该数据所承载 的信息流是 与检测有关的 调试二进制流 第一章第一章 对外接口函数详细说明对外接口函数详细说明 1 单个设备连接接口函数单个设备连接接口函数 1 1 OpenHv HV API HV HANDLE cdecl OpenHv const PSTR pcIP 功能描述功能描述 打开一个视频处理系统句柄 在对视频处理系统作任何操作之前 必须使用该函数打开视频处理系统取得一个句柄后 才可使用该句柄对视频处理系统进行操作 参数说明参数说明 pcIP 视频处理系统的 IP 地址或串口名称 以 0 结尾 返回值返回值 当成功地打开一个视频处理系统连接时 将返回一个的视频处理系统的句柄 当打开失败时 函数返回 E HV INVALID HANDLE 注意注意 此函数返回的是一个指针类型 用户应妥善保存该返回值 以用于后序的操作 2109 之后 包括 2109 版本的 HVDLL dll 的单连接有自动重连功能 参数设置如下 接收程序运行后 会在接收程序目录下自动生成 HVDLL ini 文件 该文件的如下字段表示 重连功能 ReConnect TryTimes 0 重连尝试次数 默认是 0 0 为不尝试重连 1 为一直尝试重连 直到连上为 止 正数为尝试重连次数 该参数修改后 重新 OpenHv 后生效 1 2 CloseHv HV API HRESULT cdecl CloseHv HV HANDLE hHandle 功能描述功能描述 关闭一个视频处理系统句柄 参数说明参数说明 hHandle由 OpenHv 函数打开的句柄 此参数必须是 OpenHv 函数的 返 回值 否则将导致不可预想的后果 如果此参数为 E HV INVALID HANDLE 函数将不作任何操作 并且返回 E HANDLE 返回值返回值 返回 S OK 表示操作成功 返回 E HANDLE 表示 hHandle 参数是一个非法的句柄 4 返回 E FAIL 表示未知的错误导致操作失败 注意注意 此函数成功调用后 将关闭与视频处理系统的所有连接 并释放所有与该视频 处理系统有关的所有资源 1 3 CloseIP HV API HRESULT cdecl CloseIP char pszIP 功能描述功能描述 关闭指定 IP 的视频处理系统 参数说明参数说明 pszIP需要关闭的视频处理系统的 IP 返回值返回值 返回 S OK 表示操作成功 返回 S FALSE 表示没有找到该 IP 的句柄 返回 E FAIL 表示未知的错误导致操作失败 注意注意 此函数成功调用后 将关闭与视频处理系统的所有连接 并释放所有与该视频 处理系统有关的所有资源 1 4 HvIsConnected HV API HRESULT cdecl HvIsConnected HV HANDLE hHandle INT32 piStatus 功能描述功能描述 获取连接状态 参数说明参数说明 hHandle由 OpenHv 函数打开的句柄 此参数必须是 OpenHv 函数的 返 回值 否则将导致不可预想的后果 如果此参数为 E HV INVALID HANDLE 函数将不作任何操作 并且返回 E HANDLE piStatus 输出连接状态 0 表示已连接 1 表示未连接 返回值返回值 返回 S OK 表示操作成功 返回 E HANDLE 表示 hHandle 参数是一个非法的句柄 返回 E FAIL 表示未知的错误导致操作失败 注意注意 应用程序可定时调用该接口函数检查当前是否连接成功 如果当前未连接请 重新连接 1 5 SetHvCallBack HV API HRESULT cdecl SetHvCallBack HV HANDLE hHandle void pFunction void pFirstParameter WORD wVideoID WORD wStream 5 功能描述功能描述 设置一个视频流的一种数据类型的回调函数 在数据连接上收到的任何数据将通过回调函数的形式传递给应用程序的上层 参数说明参数说明 hHandle由 OpenHv 函数打开的句柄 此参数必须是 OpenHv 函数的 返 回值 否则将导致不可预想的后果 如果此参数为 E HV INVALID HANDLE 函数将不作任何操作 并且返回 E HANDLE pFunction回调函数的函数指针 该参数是一个函数指针 当数据连接上 收 到数据时 将调用该函数 如果该参数为 NULL 则表示关闭该 回调功能 数据连接上的该类型数据流也随即被关闭 如果该 参数为非 NULL 则表示打开该回调功能 数据连接上的该类型 数据流随即被打开 pFirstParameter 回调 pFunction 时传递的第 一个参数 该参数一般为一个对象的指针 以便于在回调函数 中直接访问一个对象 如果用户在回调函数中不准备使用该参 数 则该参数可以为 NULL wVideoID表示视频 ID 的 2 字节的无符号整数 wStream表示数据类型的 2 字节的无符号整数 返回值返回值 返回 S OK 表示操作成功 返回 E HANDLE 表示 hHandle 参数是一个非法的句柄 返回 E FAIL 表示未知的错误导致操作失败 1 6 CARINFO BEGIN CALLBACK typedef int cdecl CARINFO BEGIN CALLBACK void pFirstParameter DWORD32 dwCarID 功能描述功能描述 记录数据开始记录数据开始类型的回调函数指针原型 参数说明参数说明 pFirstParameter回调时传递的第一个参数 dwCarID车辆 ID 返回值返回值 目前本接口的内部实现中不对此返回值作任何处理 该返回值的存在只是为 了将来的用途 但建议函数在成功处理了该数据之后返回 0 否则返回 1 注意 注意 系统在接收一个车辆记录前或开始接收硬盘录像数据调用本函数 1 7 CARINFO END CALLBACK typedef int cdecl CARINFO END CALLBACK void pFirstParameter DWORD32 dwCarID 功能描述功能描述 记录数据结束类型的回调函数指针原型 参数说明参数说明 hHandle由 OpenHv 函数打开的句柄 6 dwCarID车辆 ID 号 返回值返回值 目前本接口的内部实现中不对此返回值作任何处理 该返回值的存在只是为 了将来的用途 但建议函数在成功处理了该数据之后返回 0 否则返回 1 注意注意 系统在接收完一个车辆记录后或结束接收硬盘录像数据调用本函数 1 8 PLATE NO CALLBACK typedef int cdecl PLATE NO CALLBACK void pFirstParameter DWORD32 dwCarID PSTR pcPlateNo DWORD64 dwTimeMs 功能描述功能描述 车牌号码数据类型的回调函数指针原型 参数说明参数说明 pFirstParameter 回调时传递的第一个参数 该参数的值即为 SetHvCallBack 调用中 pFirstParameter 的值 dwCarID车辆 ID pPlateNo车牌号码字符串 该参数为以 0 结尾的字符串指针 dwTimeMs时间 1970 1 1 0 0 0 以来的毫秒数 返回值返回值 目前本接口的内部实现中不对此返回值作任何处理 该返回值的存在只是为 了将来的用途 但建议函数在成功处理了该数据之后返回 0 否则返回 1 注意注意 pPlateNo 这个指针所指向的内存在函数返回时即被释放 因此如果用户希望 函数返回后还使用该指针所指的内容 则必须把该内容复制下来 1 9 BIG IMAGE CALLBACK typedef int cdecl BIG IMAGE CALLBACK void pFirstParameter DWORD32 dwCarID WORD wImageWidth WORD wImageHigh BYTE bType WORD wSize PBYTE pbImage WORD wImageID WORD wHighImgFlag WORD wPlateWidth WORD wPlateHigh DWORD64 dwTimeMs 功能描述功能描述 车辆全景图数据类型的回调函数指针原型 参数说明参数说明 pFirstParameter回调时传递的第一个参数 7 dwCarID车辆 ID wImageWidth图像的宽度 wImageHigh图像的高度 bType图像类型 wSize数据大小 pbImage图像数据的指针 wImageID图像的 ID 号 表示得到的是哪一张图片 用 COM 口连接 只返回 0 wHighImgFlag高清图片标志 如果该变量高 8 位值是 0 xFF00 则该变量低 8 位值为图片大小的高位值 即该图片数据大小为 int wHighImgFlag 车牌回调函数实现 int CHVDLLTestDlg OnPlate DWORD32 dwCarID PSTR pcPlateNo DWORD64 dw64TimeMs 以下是函数体 表示对车牌回调的处理 return 0 2 创建句柄创建句柄 使用 OpenHv const PSTR pcIP 创建一个可用的句柄 后续操作都是基于此句柄进行 因 此必须对返回的句柄进行检查 示例 HV HANDLE m hHV 视频处理系统句柄 m hHV OpenHv szIP GetBuffer MAX PATH 打开盒子句柄 szIP为要连接的IP地 址 if E HV INVALID HANDLE m hHV AfxMessageBox 句柄打开失败 输入的IP或COM口不正确或不存在 return 3 设置回调设置回调 如果句柄有效 则在回调时使用 HRESULT mResult2 mResult2 SetHvCallBack m hHV CHVDLLTestDlg OnPlateProxy this 0 TYPE PLATE STR 25 if mResult2 E HANDLE AfxMessageBox SetHvCallBack非法句柄 return false 4 Timer 事件事件 在 Timer 事件中 检查 dwiState 的状态 0 为已连接 2 为线程退出 否则就是关闭状态 单连接状态检查 if m hHV int dwiState 1 EnterCriticalSection HRESULT h HvIsConnected m hHV dwiState变量 输出连接状态 LeaveCriticalSection if h S OK 操作成功 if dwiState 0 GetDlgItem I