爱国者130万sdk说明书

1、DLCSDK 用户使用指南V1。0华旗数码技术Digital Lab Inc公司二零零六年二月九日目录版本更新说明 2返回值类型说明 6HqDLInitialize6HqDLStartView 8HqDLStopView9HqDLPauseView 101、2、3、4、5、6、HqDinitialize117、8、HqDLSetCa12nfo HqDLGetFrameRate 1310、 HqDLGetRawFrame1411、 HqDLGetRgbFrame159、12、 HqDLGetPausedFrame 1613、 HqDLGetPausedFrameToBmp1714、 HqDLGe

2、tRawFrameToBmp 1815、 HqDLGetRgbFrameToBmp 1916、 HqDLSetParam-2017、 HqDLSetGammaValue2118、 HqDLSetFrameCallback 2219、 HqDLEnableColorOffset2320、 HqDLBitOperation2421、 HqDLRegOperation2522、HqDLSetDoAWB2623、HqDLSetDoAE2724、HqDLSetDoAF2825、HqDLSetViewWin2926、HqDLGetViewWin3027、HqDLGetTotalDeviceNum3128、

3、HqDLGetSerialsNum 3229、HqDLCalibration 3330、HqDLNoiseCalibration3431、HqDLAutoFocus3532、HqDLLedControl3633、HqDLCaptureToAvi371、版本更新说明版本：V1.0.0.1更新日期：2005.12.13库说明:对于所有华旗数码的头提供接口对于功能最强大的智能证照检查仪提供所有可操作接口对于其他简化版头有些接口不要调用比如对于 White Hawk 不支持 HqDLBitOperation对于黑白头不支持 HqDLSetDoAWB,并且对于黑白头,用原始数据预览并作.是标准的方式,但

4、黑白头也可以用彩色头的方式操版本：V1.0.0.3更新日期：2006.1.4库说明:加入噪点检测函数 HqDLNoiseCalibration加入位置调节函数 HqDLSizeCalibration版本：V1.0.0.4更新日期：2006.1.18库说明:加入控制电机 HqDLAutoFocus 及光源函数 HqDLLedControl版本：V1.0.0.6更新日期：2006.1.25库说明:加 入aviHqDLCaptureToAvi及 自 动 调 焦 功 能HqDLSetDoAF注：提供的开发包的所有操作都是针对 24 比特 BMP 图像。2、返回值类型说明Recs0 x00000 x00

5、010 x00020 x00030 x00040 x00050 x00060 x00070 x00080 x00090 x000a0 x000b/返回成功无效句柄指针为空文件打开失败/ 没有设备连接无效的参数/ 内存溢出/ 预览没有开启操作系统版本错误设备无效设备不支持此功能不到序列号ResNullHandleErrResNullPoerErrResFileOpenErr ResNoDeviceErr ResInvalidParameterErr ResOutOfMemoryErrResNoPreviewRunningErr/ResOSVerErr/ResUsbNotAvailableErr

6、ResNotSupportedErr ResNoSerialString ResVerificationErr ResTimeoutErr ResScaleModeErr ResUnknownErr ResDisplayWndExist ResAllocated ResAllocateFail ResReadError ResWriteError ResUsbOpen ResCreateStreamErr ResSetStreamFormatErr0 x000c0 x000d 0 x000f0 x00ff 0 x00110 x00120 x00130 x00140 x0015/效验失败/超时缩

7、放错误未知错误应该关闭预览窗口内存已经分配/内存分配失败/ USB失败/ USB 命令发出失败/ USB 端口已经打开/ 创建 avi 流失败/ 设置 AVI 流格式失败0 x00160 x00170 x00183、HqDLInitialize函数:HQDL_AINHqDLInitialize(LPCTSTRpFilterName,ndex,OUT INCa OU);*nfoStruct *pCanfo,NDLE*hCamera功能:参数:初始化设备，返回头句柄，用于其它函数的调用头索引ndexpFilterName返回保留初始化pCanfo头参数hCamera必须要给 pCa空间要大一些，返

8、回给调用者的设备句柄nfo-Buffer 分配足够的内存空间，一般要分配比最大用 MAXWIDTH*MAXHEIGHT+512，用于传递说明:数据说明:此函数要先于所有的A函数，并且每一次调用，都要有HqDinitialize相对应。当返回 Recs 时表示函数调用成功，hCamera 是返回给用户设备句柄。这个句柄将作为其它 A函数的参数。*注 1：头。*注 2：头的索引值从 0 开始计数。用户可以通过索引值同时操作多个头的索引值在每次重新启动计算机后有可能发生改变。一般是根据的顺序由操作系统搜索设备。CanfoStruct 结构定义：struct CaUCHARULONGnfoStruct

9、*Buffer;Height;/ 用户分配，用于接收的原始数据 8bit/高度ULONG ULONG ULONG ULONG UCHAR UCHAR UCHARUCHARWidth; OffsetX;OffsetY;/宽度水平偏移垂直偏移值 1-500MSExure;Gain3; Control;ernalUse; /ColorOff3; / R G B 增益 1-63/ 控制位用户不要对此字节进行操作用户从外面不要改变此数组的值， 要调用EnableColorOffset 来改变UCHAR4; /保留位;注 3：对于 3M 像素的设备，Exure 的取值范围一般在 300MS 左右。注 4：

10、Control 一般只在 GoldenHawk 系列产品中使用，对于其他设备，初始化为 0。4、HqDLStartView函数:HQDL_AHqDLStartView( IN HANDLEhCamera,IN LPCTSTR IN DWORD ININ IN ININ HWNDIN HlpszWindowName, dwStyle,x,y, nWidth, nHeight,hwndParent,nIDorH);打开预览窗口,并启动功能:参数:说明:流hCamera通过调用 HqDLInitialize 得到的设备句柄主要参数请参见 CWnd：CreateEx 函数说明。5、HqDLStopVi

11、ew函数:功能:参数:说明:HQDL_A停止HqDLStopView( IN HANDLEhCamera );流hCamera通过调用 HqDLInitialize 得到的设备句柄6、HqDLPauseView函数:HQDL_A bPause );功能:暂停HqDLPauseView( IN HANDLE hCamera, IN BOOL流参数:说明:hCamera通过调用 HqDLInitialize 得到的设备句柄7、HqD函数:功能:参数:说明:initializeHQDL_AHqDinitialize( IN HANDLE*hCamera );反初始化设备hCamera通过调用 HqD

12、LInitialize 得到的设备句柄必须在程序退出时调用,用于内存分配空间8、HqDLSetCa函数:HQDL_AnfoHqDLSetCanfo(INHANDLEhCamera,INCanfoStruct*pCanfo );参数功能:实时设置参数:说明:hCamera通过调用 HqDLInitialize 得到的设备句柄9、HqDLGetFrameRate函数:HQDL_AHqDLGetFrameRate( IN HANDLE hCamera,OUT float *pfFrameRate );功能:参数:得到头的当前帧率hCamera通过调用 HqDLInitialize 得到的设备句柄说明

13、:10、HqDLGetRawFrame函数:HQDL_AHqDLGetRawFrame(IN HANDLE hCamera,IN struct CanfoStruct *pCanfo);功能:参数:一帧原始数据到 pCanfo-Buffer 中hCamera通过调用 HqDLInitialize 得到的设备句柄说明:11、HqDLGetRgbFrame函数:HQDL_AHqDLGetRgbFrame(INHANDLEhCamera,INstructCanfoStruct*pCanfo, OUT BYTE* pDest);功能:hCamera参数:通过调用 HqDLInitialize 得到的设

14、备句柄说明:一帧 24bitRGB 数据到 pDest 中，同时原始数据会保存在pCanfo-Buffer 中，pDest 中的结果会根据 CARAM 中的设定而改变，如果设置 bClearView,pDest 中是经过优化的转换算法而得到 24bit 的结果，如果设置 bBW,那么是转换为 8bit 的灰度图像数据，如果设置 UPDOWN 则图像数据会做相应的垂直翻转。12、HqDLGetPausedFrame函数:HQDL_AHqDLGetPausedFrame(IN HANDLE hCamera,OUT BYTE* pDest);功能:参数:根据当前暂停的hCamera，得到暂停的数据通

15、过调用 HqDLInitialize 得到的设备句柄说明:通过调用此函数所得到的图像是当用户调用 HqDLPauseView 时暂存在内存中，等待用户来取得。参见 HqDLPauseView 函数。注：调用此函数时，流必须处于暂停状态。13、HqDLGetPausedFrameToBmp函数:HQDL_AHqDLGetPausedFrameToBm OUT BYTE* pDest, LPCTSTR strFileName );保存为 BMP 文件N HANDLE hCamera,功能:参数:将当前暂停hCamera通过调用 HqDLInitialize 得到的设备句柄说明：通过调用此函数所得到

16、的图像是当用户调用 HqDLPauseView 时暂存在内存中，等待用户来取得。参见 HqDLPauseView 函数。注：调用此函数时，流必须处于暂停状态。14、HqDLGetRawFrameToBmp函数:HQDL_AHqDLGetRawFrameToBmN HANDLE hCamera,IN struct CanfoStruct *pCanfo,LPCTSTRstrFileName );功能:一帧原始数据到 pCanfo-Buffer 中的同时，将原始数据以 8位位图的格式进行保存。参数:hCamera通过调用 HqDLInitialize 得到的设备句柄说明:注：pCanfo-Buff

17、er 必须由用户分配空间。15、HqDLGetRgbFrameToBmp函数:HQDL_AHqDLGetRgbFrameToBmp( IN HANDLE hCamera,IN struct CanfoStruct *pCanfo,OUT BYTE* pDest,LPCTSTRstrFileName );功能:一帧图像到文件，文件格式会根据 CARAM 中的设定改变。如果设置 bClearView,pDest 中是经过优化的转换算法而得到 24bit的结果，如果设置bBW,那么是转换为8bit 的灰度图像数据，如果设置UPDOWN则图像数据会做相应的垂直翻转。参数:hCamera通过调用 HqD

18、LInitialize 得到的设备句柄说明:注：pCanfo-Buffer 的空间必须在用户调用此函数前进行分配。如果用户不想通过 pDest 得到 Rgb 数据，可以将 pDest 设置为 NULL,这样开发包不会在保存文件的同时，拷贝数据到 pDest 中。16、HqDLSetParam函数:HQDL_AHqDLSetParam(IN HANDLE hCamera,DLPARAMDLParam,ULONGValue );功能:参数:设置图像参数hCamera通过调用 HqDLInitialize 得到的设备句柄说明:DLParam 定义如下：enumDLPARAM BWSHOW = 0,R

19、AWDATASHOW,/ 是否黑白显示/ 是否直接显示原始数据是否利用优化算法进行转换/ 上下翻转CLEARVIEW, UPDOWN,;/17、HqDLSetGammaValue函数:HQDL_AHqDLSetGammaValue(IN HANDLE hCamera,IN float fGammaValue,IN BOOL bGammaOn);功能:参数:加入 Gamma 校正功能hCamerafGammaValue通过调用 HqDLInitialize 得到的设备句柄范围 1 200bGammaOn TRUE 加入 Gamma 校正功能说明:18、HqDLSetFrameCallback函数

20、:HQDL_AHqDLSetFrameCallback(INHANDLEhCamera,DL_FRAMECALLBACK pfFrameCallback, LPVOID lpContext );功能:用于鼠标在预览窗口上点击的回调，lpParam 为用户上下文参数:hCamera通过调用 HqDLInitialize 得到的设备句柄pfFrameCallback 用户给定的每帧到达时的回调函数地址lpContext用户上下文说明:回调函数的定义：typedefVOID(WINA*DL_FRAMECALLBACK)(LPVOIDlpParam1,LPVOID lpPo, LPVOID lpCon

21、text );lpParam1 - 指向显示数据指针lpPo- 鼠标点击图像位置lpContext- 上下文回调函数的使用方法：19、HqDLEnableColorOffset函数:HQDL_AIN ININHqDLEnableColorOffset( IN HANDLE hCamera, nRedOffset,nGreenOffset,nBlueOffset,IN BOOL bColorOffset );进行颜色偏移量的调节功能:参数:hCamera nRedOffset nGreenOffsetnBlueOffset通过调用 HqDLInitialize 得到的设备句柄-255 255-2

22、55 255-255 255说明:这 3 个色彩偏移量分别对应硬件中 3 个控制色彩的寄存器。20、HqDLBitOperation函数:HQDL_AHqDLBitOperation( IN HANDLE hCamera,IN BYTE Out,OUT BYTE *IN UCHARn,d );功能:参数:说明:对于智能证照检查仪，GoldenEagle，WhiteHawk 的特殊操作保留,调用此函数时不允许开启用户暂不要调用。21、HqDLRegOperation函数:HQDL_AHqDLRegOperation( IN HANDLE hCamera,IN BYTE RegAddress,IN

23、 OUT USHORT* Value,IN BOOL bWrite);功能:参数:说明:对于 GoldenHawk，GoldenEagle，WhiteHawk 的特殊操作保留,调用此函数时不允许开启用户暂不要调用。22、HqDLSetDoAWB函数:HQDL_AHqDLSetDoAWB(IN HANDLE hCamera,IN BOOL bAWB, IN BYTE btINpfAWBCallback,DL_AUTOCALLBACKIN LPVOID lpContext );功能:参数:设置白平衡操作完成的回调函数hCamera pfAWBCallbackVOID (WINA通过调用 HqDLI

24、nitialize 得到的设备句柄指定 AWB 结束后的回调函数指针*DL_AUTOCALLBACK )( DWORD dw1, LPVOIDlpContext );lpParam1是指向 AWB 结果的指针，通过 lpParam1 来获得 AWB 结果如下：ULONGResult = dw1;/ 0 xFF202020/ 0 x20BYTE btRed BYTE btGreen BYTE btBlueULONG Ex= ( BYTE )(Result);= ( BYTE )( Result8 );= ( BYTE )( Result16 );/ 0 x20/ 0 x20ure= ( BYTE

25、 )( Result24 ) * 2;/ 255 * 2 =510 ms说明:当白平衡操作完成后，会调用用户设定的回调函数，在传递给回调函数的参数中给出操作结果，由于用户来更新程序中的 Ca新界面的各项值。nfoStruct 结构，或更23、HqDLSetDoAE函数:HQDL_AHqDLSetDoAE(IN HANDLE hCamera,IN BOOL bAE,IN BYTE bt,IN DL_AUTOCALLBACK pfAECallback,IN LPVOID lpContext );功能:参数:开始自动hCamera操作通过调用 HqDLInitialize 得到的设备句柄说明:24、

26、HqDLSetDoAF函数:功能:参数:HQDL_AHqDLSetDoAF( IN HANDLE hCamera, IN BOOL bAF );开始自动聚焦hCamera通过调用 HqDLInitialize 得到的设备句柄说明:25、HqDLSetViewWin函数:HQDL_AHqDLSetViewWin(IN HANDLE hCamera,IN DLRECT *pRect);功能:参数:设置预览窗口的位置hCamera通过调用 HqDLInitialize 得到的设备句柄说明:DLRECT 结构定义如下：typedef struct _tagDLLeft; Top; Width;Heig

27、ht;RECT/相对于父窗口的水平偏移相对于父窗口的垂直偏移/窗口宽度窗口高度/DLRECT, *PDLRECT;26、HqDLGetViewWin函数:HQDL_AHqDLGetViewWin(IN HANDLE hCamera,IN DLRECT *pRect);功能:参数:得到预览窗口的位置hCamera通过调用 HqDLInitialize 得到的设备句柄说明:DLRECT 结构定义如下：typedef struct _tagDLLeft; Top; Width;Height;RECT/相对于父窗口的水平偏移相对于父窗口的垂直偏移/窗口宽度窗口高度/DLRECT, *PDLRECT;2

28、7、HqDLGetTotalDeviceNum函数:HQDL_AHqDLGetTotalDeviceNum( IN HANDLE hCamera,IN*pDeviceNum );功能:参数:得到与本机连接的hCamera头数目通过调用 HqDLInitialize 得到的设备句柄说明:28、HqDLGetSerialsNum函数:HQDL_AHqDLGetSerialsNum(IN HANDLE hCamera,IN char *SerialsNum );功能:参数:得到头序列号hCamera通过调用 HqDLInitialize 得到的设备句柄说明:目前的序列号不是真正意义上的序列号，它是固

29、件版本的说明。29、HqDLCalibration函数:HQDL_AHqDLSizeCalibration(IN HANDLE hCamera,IN OUT USHORT *pOffH,IN OUT USHORT *pOffV,IN OUT USHORT*pWidth,IN OUT USHORT *pHeight,BOOL bWrite );功能:参数:专门对于hCamera图像位置的校正，其参数在硬件之中通过调用 HqDLInitialize 得到的设备句柄说明:GoldenHawk 设备专有，其他设备不要调用此函数。30、HqDLNoiseCalibration函数:HQDL_AHqDLN

30、oiseCalibration( IN HANDLE hCamera,const char*FileName,BOOL bPreview,BOOL bSave );功能:参数:加载校正图像，主要用于去除噪点。hCamera bPreview bSaveFileName通过调用 HqDLInitialize 得到的设备句柄指定是否在预览时加入去噪功能指定是否在保存时加入去噪功能加载校正图像的文件名,是原始数据得到的 256色bmp 灰度图, 当 FileName = 时,可以只设置加入去噪的时机说明:注意:可以在无流时调用加载图像的大小必须与大小相符,否则不会加载31、HqDLAutoFocus函数:HQDL_AHqDLAutoFocus(IN HANDLE h