CYNET-API编程手册

CYNET-API.dllVersion1.3（针对J系列网络数字摄像机）Camyu数字摄像机API函数编程手册(Windows2K/XP版)中国·重庆创宇光电子技术有限公司2008年4月DOC-40CAMYU07008-A4–CYNET-APIforWindows2K/XPRev0t.doc1CamyuTechnologiesCYUSB-API.dllforWin2K/XP版权：本手册包含重庆创宇光电子技术有限公司之专利及保密信息。未经重庆创宇光电子技术有限公司之书面许可，任何人不得以任何形式改变或复制本手册或本手册任何部分。重庆创宇光电子技术有限公司版权所有。免责声明：本手册所含信息已经过仔细检查，重庆创宇光电子技术有限公司相信其是完全可靠的，并与其介绍的产品是完全一致的。对于由于使用本手册中介绍的产品、电路或软件而导致你的系统问题，我们将不承担责任。重庆创宇光电子技术有限公司保留对任何产品以及相关产品文件进行修改或改进的权利。本公司产品的技术描述以最新发布为准。商标：WINDOWS98，WINDOWS2000，WINDOWSXP是微软公司注册商标；Camyu是重庆创宇光电子技术有限公司的注册商标。用户权限：本数字摄象机以及所附软件代码在翻版、使用及转让上受到重庆创宇光电子技术有限公司相关条款的限制，所附软件仅限于在一台计算机上的使用。用户对于本数字摄象机和软件的使用将意味着对上述使用条款及说明的同意，以及同意通过位于中国重庆市的法庭解决任何纠纷。销售：重庆创宇光电子技术有限公司拥有本产品完全知识产权，所涉及的软硬件均为本公司自主研发，决非代理产品。本产品仅允许通过重庆创宇光电子技术有限公司的注册销售代表销售。联系地址：中国·重庆市高新区科园一路200号科技发展大厦C座13层重庆创宇光电子技术有限公司联系电话：[phone]传真：[phone]邮编：400039–CYNET-APIforWindows2K/XPRev0t.doc2CamyuTechnologiesCYUSB-API.dllforWin2K/XP目录1前言2应用软件开发3与计算机通讯4摄像机数据格式5摄像机参数管理6API函数描述DOC-40CAMYU07008-A4–CYNET-APIforWindows2K/XPRev0t.doc3CamyuTechnologiesCYUSB-API.dllforWin2K/XP1前言感谢您采用本公司的产品!如果你不准备通过编程开发自己的应用程序，就不用往下阅读，以免浪费你的时间。该文档详细介绍了Camyu公司生产的系列数字摄像机命令集和配套的应用程序接口(API)规范，对应的CYNET_API.DLL版本为1.3.0版。CYNET_API.DLL是一个在MicrosoftWindows2000/XP环境中，有效控制数字摄像机可靠工作的动态连接库。其中包括了供你进行二次开发所需的所有应用程序接口函数(API)，概括了针对Camyu数字摄像机编程所涉及的各个方面。该接口库适用于Camyu公司生产的J系列网络数字摄像机。Camyu技术部将随时更新的DLL文件发布在公司网站上，供你升级下载。手册按功能对API接口库中的各个函数提供了全面、详细的分类描述，并具体给出了它们的函数原型、返回值、参数定义、说明、范例等信息。建议用户仔细阅读该文档内容，以便你更好地了解Camyu数字摄像机系统的运行机制和接口规范，并在此基础上有效进行应用程序的二次开发。如果用户在使用过程中发现错误和纰漏，恳请你及时与Camyu公司的市场部或研发中心联系，我们将非常感谢你为我们的改进工作所作的贡献。如果你有任何相关技术问题，我们都将很乐意为您提供我们能力范围内的技术支持和服务。我们竭诚希望您能感受我们在发展工业数字摄像机上所作的不懈努力。Camyu研发中心2008/04DOC-40CAMYU07008-A4–CYNET-APIforWindows2K/XPRev0t.doc4CamyuTechnologiesCYUSB-API.dllforWin2K/XP2应用软件开发在你购买的数字摄像机产品包装中配套有一张CD-ROM光盘，其中包含了网络数字摄像机驱动程序、API接口库、Camyu数字摄像机测试软件和供你编程参考的Demo软件(含全部工程源代码文件，用MicrosoftVisualC/C++6.0建立)。2.1API接口库CD-ROM盘中有\API子目录，在此目录下包含了构成API接口库的三个基本文件：CYNET_API.DLL：在MicrosoftWindows2000/XP环境中控制摄像机工作的动态连接库，用户应将其放在Windows系统路径或当前工作路径下。CYNET_API.H：动态链接库的头文件，包含了库中各函数的原形、参数定义、调用说明等信息。你应将其包含(#Include)到需调用库中API函数的用户程序源代码中。CYNET_API.LIB：供用户程序在编译链接时使用的链接库文件。用户应将其加入到自己的工程文件中。2.3测试软件CD-ROM盘中有\TEST文件夹，其中包含了Camyu数字摄像机测试软件的全部运行文件。在确定数字摄像机安装好之后(参见用户手册)，你可以将该文件夹全部拷贝在你的硬盘上，直接双击cam.exe即可启动该软件。测试软件已具备较强的通用图像采集、处理、分析、录像和存储管理功能。软件的安装和使用参见《Camyu数字摄像机测试软件操作手册》2.4编程演示源工程代码CD-ROM盘中有VC++Demo文件夹，其中包含了一个完整的用MicrosoftVisualC/C++6.0建立的编程演示软件工程。在确定网络数字摄像机安装好之后(参见用户手册)，你可以将该文件夹全部拷DOC-40CAMYU07008-A4–CYNET-APIforWindows2K/XPRev0t.doc5CamyuTechnologiesCYUSB-API.dllforWin2K/XP贝在你的硬盘上，直接运行cam.exe可执行文件，即可采集图像，并可对摄像机的各工作参数进行控制。你可以在VC++6.0下直接编译该工程（Release模式），重新生成演示程序Demo.exe，以验证该工程的完整性。你也可以通过修改演示软件中的相关源代码来添加你所需的功能特性，快速建立你自己的应用程序。请仔细解读相关源代码中对各API函数(特别是数字摄像机控制命令)的调用范例，以便你更好地理解和使用API函数。2.5开发环境CYNET_API.DLL是一个标准Win32动态链接库。支持标准的32位编程开发工具，如MicrosoftVisualC/C++、MicrosoftVisualBasic、BorlandC/C++、Delphi、C++Builder、PowerBuilder等。你可以选择其中之一建立你的开发环境，编译链接自己的应用程序。使用C/C++编程工具，你应将CYNET_API.H包含(#Include)到需调用动态链接库中API函数的源代码中，并将CYNET_API.LIB链接库文件加入到工程文件中，供编译系统在链接（Link）时使用。需要说明的是，MS-VisualC/C++和C++Builder定义了各自的链接库文件格式，它们之间是不通用的。使用MS-VisualBasic、Delphi、PowerBuilder等编程工具调用应用接口库时，应按照调用标准的32位动态链接库的方法，在程序中重新声明函数原型，这时要注意正确定义参数的数据类型。Camyu技术部推荐你使用MicrosoftVisualC/C++6.0作为你应用CYNET_API.DLL动态链接库的开发环境。DOC-40CAMYU07008-A4–CYNET-APIforWindows2K/XPRev0t.doc6CamyuTechnologiesCYUSB-API.dllforWin2K/XP3与计算机通讯3.1与计算机通讯图3.1表示了以网络接口方式在计算机上获取摄像机图像数据的链接关系。.图中，在输入端，数字摄像机用标准的网络接口方式与计算机连接，通过双绞线将采集到的图像数据传送到指定的计算机。用户程序调用API接口库中的读取摄像机图像数据函数，即可获得在用户端进行处理和显示的图像数据。用户程序调用API接口库中的摄像机参数控制函数，即可实现对数字摄像机工作参数和状态的读取及控制。3.2编程结构一般情况下，对摄像机的初始化操作(设备连接、申请资源、参数设置)，最好在用户应用程序的初始化段中完成，对摄像机的结束操作(释放资源)，应在用户应用程序退出前完成。网络摄像机的传输端口被连接时，就会向计算机发送采集的图像数据，计算机接收到这些数据并存入内存，然后用户程序可对已存入计算机内存的一帧图像进行实时处理和显示。图3.1命令和图像数据链接关系网络摄像机计算机SVGA监视器API接口库CYNET-API.DLL用户程序输入端图像数据控制参数Windows2K/XP操作系统DOC-40CAMYU07008-A4–CYNET-APIforWindows2K/XPRev0t.doc7CamyuTechnologiesCYUSB-API.dllforWin2K/XP通常情况下，为了获得摄像机图像数据，在你的应用程序中总是表现为如下结构形式：用户程序的初始化部分调用CYNET_Open()初始化库，启动采集线程用户程序的结束部分调用CYNET_Close()释放资源While(1){//查询是否取到新的图像while(CYNET_GetFrame(…)==RET_ERR)Sleep(1);//根据帧头判断图象来源//用户处理或显示图像数据}添加摄像机，并同步摄像机参数控制摄像机参数用户程序的线程循环体部分DOC-40CAMYU07008-A4–CYNET-APIforWindows2K/XPRev0t.doc8CamyuTechnologiesCYUSB-API.dllforWin2K/XP4摄像机数据格式J系列网络数字摄像机传输的图象数据格式均为JPEG标准编码文件，相机格式可参见JPEG编码标准。DOC-40CAMYU07008-A4–CYNET-APIforWindows2K/XPRev0t.doc9CamyuTechnologiesCYUSB-API.dllforWin2K/XP5摄像机参数管理5.1参数名定义CAMYU系列工业数字摄像机的功能强大、控制灵活、编程简单，所有控制对象均以参数名的形式，经API库中统一的控制函数实现对摄像机的实时控制。表5-1定义了可编程读取或修改的摄像机参数，你只需将表中参数名之一作为API库中相应读写函数的参数调用，即可获得或修改对应的摄像机参数。表5-1参数名(nName)定义操作描述ID设备ID码R0--无设备，!0--有设备WIDTH图像宽度值R像素单位HEIGHT图像高度值R像素单位BITS图像数据的A/D位数R8Bit（J系列相机为8Bit）COLOR图像数据格式R0---灰度1---Bayer(RG)2---Bayer(GB)5---RGB6---YUV4226---JPEGSOFT_VERSION摄像机固件版本RDEVICE_NO摄像机生产编号RGAIN当前增益控制值R/WxFREQ当前帧频控制值R/WxTIME当前曝光时间控制值R/WxSYNC同步方式（摄像机工作模式）R/W0—连续采集模式1－抓拍模式2－快速抓拍模式3－监控模式4－选拍模式AGCMODE增益控制方式R/W1--自动(AGC)，0--手动AGCLIMITAGC门限值R/W0~255AGCSELECTAGC取样区域选择R/WAGCTIMEAGC连动电子快门R/W1--开，0--关AGC_GAIN_MAXAGC增益控制范围R/W限制增益调整范围MAX值AGC_TIME_MIN快门连动控制范围MINR/WAGC_TIME_MAX快门连动控制范围MAXR/