四川省城市报警与监控系统技术要求附录1 视频编码设备接口协议.doc

附录1 视频编码设备接口协议一、引言视频编码设备协议VCDP（Video Coding Device Protocol）用于视频编码设备与系统中其它设备的通信。如图1.1所示，视频编码设备与客户端通信，传输视频流、语音流、报警事件等；与存储服务器通信，传输录像文件；与监控报警管理平台（简称，中心）通信，接受中心的管理；与分发服务器通信，传输视频流，由分发服务器将该路视频进行组播或广播。存储服务器视频编码设备控制箱摄像头客户端管理平台分发服务器图1.1 视频编码设备与各部分的关系VCDP是应用层控制协议，用于视频连接、语音连接、云镜控制（PTZ）、参数设置、报警联动、录像调阅、设备注册、KeepAlive（心跳）、系统版本更新、PTZ解码器更新，等等。VCDP还是传输协议，用于音、视频数据的传输。VCDP与流行的视频编码设备控制协议最大的区别在于设备管理功能，例如，设备注册、KeepAlive等。在系统中，视频编码设备启动后的第一个动作就是，在中心注册。只有注册成功后，设备才能正常工作。视频编码设备定时（默认每两分钟）往中心发送心跳（KeepAlive），一旦发送失败（例如，网络暂时中断），会按照一定时间间隔反复重新注册。VCDP的控制协议和传输协议基本上都是基于TCP协议传输的，不同之处在于PTZ控制协议，它除了支持基于TCP的传输之外，还支持基于UDP的传输。二、VCDP约定2.1 数据类型定义N：整数N+：正整数（不包含0）R：浮点型数R+：正浮点型数Byte：一个字节范围的数（0 - 255）C：单个字符S：字符串X：十六进制的流DT：日期/时间格式字符串（2003-12-20 03:02:13）LDT：linux时间字符串（060215482004.45 表示 6月2日15点48分2004年45秒）D：日期格式字符串（2003-12-20）T：时间格式字符串（03:02:13）T+：时间小时和分钟格式字符串（03:02）B：布尔类型（0、1）B+：布尔类型的字符串表示（false、true）IP：IP地址格式的字符串（23）2.2 控制指令格式VCDP采用请求/响应模式。请求由指令头指令体组成，响应由返回指令头指令体组成。其中，指令体的编码语言是XML（eXtensible Markup Language）。如果指令头或返回头中的指令长度为0，则指令体不存在。指令头4Bytes4 Bytes4 Bytes4 Bytes32 Bytes32 Bytes版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)版本号默认为257指令长度指令体的长度。如果没有指令体，则长度值为0指令编号每个指令都有一个唯一的编号指令序号指令发起端设定的一个数值，对应的指令返回头中的指令序号与它完全相同源ID发起端的业务ID。业务ID是系统分配的系统唯一的标识。目地ID操作目标（一级或二级设备）的业务ID返回指令头4Bytes4 Bytes4 Bytes4 Bytes4 Bytes版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)版本号请求指令的版本号指令长度指令体的长度指令编号请求指令的指令编号加一。例如，请求指令的编号是5010，则其返回指令编号是5011。指令序号等于请求指令的序号成功标志为0表示成功，其它表示错误编号。注意：错误编号在协议中没有规定。2.3 数据流传输格式数据流传输格式与控制指令格式类似，数据流由一系列数据包组成，数据包由包头包体组成。包头的格式与指令返回头一样，包体是二进制的数据。2.4 VCDP实现约定TCP套接字由主动连接端关闭。2.5设备的业务ID业务ID是系统给设备（或子设备）指定的逻辑ID，用于标识设备。每个设备还有一个唯一的物理ID，即设备的出厂ID，只在设备注册时使用。三、设备管理3.1注册功能将视频编码设备注册到中心，以便于中心管理。同时通过设备ID可以检测设备的真伪。获取视频编码设备以及子设备的业务ID。请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度2002000因为注册时，设备还没有获取自身的业务ID，所以源ID和目的ID都填写0XML： 视频连接端口（N）对讲呼叫连接端口（N）消息端口（N）设备版本信息（N）其中连接类型：1是LAN，2为ADSL，3为其它类型。视频的最大连接数是指前端和网络带宽能够支持的最大视频路数。 响应返回指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257XML的长度200300XML： 设备ID不是业务ID（参见2.5）。HeartCycle 表示心跳周期，默认值是2分钟。SysRebootTime和SysRebootCycle：视频编码设备必须支持自动重新启动。SysRebootCycle表示重起周期。SysRebootTime 表示重起时刻。如 15：45。表示在15点45分重起。CurrentDateTime是中心的时间。060215482004.45表示为6月2号15点48分2004年45秒。以便让前端和中心同步时间。Camera表示一个摄像头。其中 ID 为摄像头的业务ID，HasPan 表示是否有云台。StoreScheme 表示此摄像头的存储（录像）有关的信息。IsLocaleSaved是否本地存储。如果不是，则指定远程存储服务器的IP以及ftp上传的参数，如 FtpUser 、FtpPwd、RemotePort 等等。StorePlanHourFlag表示存储方案，是一个168字符的0或1。表示以一周168个小时为单位，从星期日开始，1表示存。0 表示不存。AlarmIn表示一个报警输入。ID为报警输入的业务ID。AlarmOut表示一个报警输出。ID为报警输出的业务ID。3.2 KeepAlive（心跳）功能主动向中心报告自己的状态。请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度20前端业务ID0XML：TYPE_TERMINALDevType为设备类型，TYPE_TERMINAL 表示设备类型为视频编码设备（TYPE_TERMINAL2）。响应返回指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257XML的长度300XML：注意：心跳信息如果在一次不成功后，在等待 10 秒后再次发送一次。如果还是不成功就认为视频编码设备心跳失败，然后必须使用机制3.3来尝试重新注册！3.3自动重新注册功能以下情况需要重新注册：1、 网络出现故障后重新恢复；2、 ADSL断线后重拨成功后，这个和第一条类试；3、 中心程序重新启动后；4、 心跳连接失败，心跳发送信息失败，心跳接收信息失败。见3.2.注意1：重新注册检测周期为2分钟。实际编程时可以只处理第4条就行了，因为心跳连接失败就是由现象1、2、3所致。注意2：重新注册时有两种情况要做不同处理：1. 如果第一次注册失败，以前从来没有成功过。这时，不做视频、图片录像存储。因为无法得到摄像头业务ID等信息，所以没有办法为录像文件创建目录（录像文件的路径由摄像头业务ID、日期、时间等组成）。2. 如果程序以前注册成功过，这时就必须启用上次的注册信息。这时要视频、图片录像存储。3.4解码器、报警器控制协议文件下载功能根据在视频编码设备上设置的协议编号，主动从中心下载解码器、报警器控制协议文件。解码器用于PTZ控制，报警器用于控制报警箱。不同厂家的产品可能采用不同的控制协议。为了兼容不同的协议，系统提供了一个标准控制协议，并在视频编码设备将标准协议转换成厂家专有协议。协议文件定义了标准协议与专有协议之间的对应关系。请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度20040前端业务ID0XML：Key指定要下载的协议的具体编号。响应返回指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257XML的长度200500XML：根据返回的XML信息，就可以主动从指定的FTP服务器上下载具体协议文件。FtpAddress是指协议文件的IP地址，FtpPort指端口，User指用户名，Pwd指密码，Path指协议文件的相对于FTP主目录的路径。3.5远程系统升级（手动更新视频编码设备系统）功能手动更新包括按照顺序执行的两个指令：1、更新请求，如果请求通过后，就可以更新了；2、更新。1、更新请求请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度80100客户端SessionID前端业务IDXML：这个表示客户端要更新程序的版本。响应返回指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257XML的长度801100XML：无。2、更新请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度80120客户端SessionID前端业务IDXML：通过指定返回的FTP服务器的参数来获取更新包。FtpAddress是IP，FtpPort 指端口，User 指用户名，Pwd指密码，Path 指更新包相对于FTP主目录的路径。FileName为更新包的文件名。然后前端通过这些信息到指定服务器和路径下载更新就可以了。响应返回指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257XML的长度801300XML：无。更新成功后，返回更新的结果。3.6远程设置视频编码设备的参数请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度50460客户端SessionID前端业务IDTYPE 1 是修改前端IP等信息。格式如下： 类型（N+）值是1 IP地址（IP） IP地址（IP） IP地址（IP） TYPE 2 是前端重新启动。格式如下： 类型（N+）值是2 TYPE 3 是获取前端的版本和编译日期和时间。格式如下： 类型（N+）值是3 TYPE 4 是获取前端的IP、子网掩码、网关。格式如下： 类型（N+）值是4 响应返回指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257XML的长度504700XML：Type 为和时是简单的信息描述。如下： succ!为是如下：版本号（）值比如：2.0编译日期和时间（ + T）值比如：2005-9-28 10:59:20 succ!为4是如下： IP地址（IP） IP地址（IP） IP地址（IP）四、实时视频4.1授权功能从管理平台获得一个ticket。这是一个随机产生的、32字节的字符串（包括结尾的“0”字节）。每一个服务请求中都有一个ticket作为参数。当收到请求后，视频编码设备用获得的ticket与请求的ticket比较，如果相同则验证通过。 请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度5010、60020客户端SessionID摄像头IDXML：前端业务（S）连接的验证信息（S31）DevDataID是前端业务ID，用于校验。Ticket为验证信息。响应返回指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257XML的长度5011，600300指令编号:5011是对应企业客户端的返回请求，6003是对应显示服务器的返回请求。显示服务器支持电视墙。XML：连接的验证信息（S）视频连接端口（N）视频编码器的类型（S）其中Ticket表示回送发送的Ticket，VideoPort表示为视频连接的端口，Protocol表示为视频编码的类型（如，Mpeg4、H.264）。4.2 建立视频连接功能在客户端（或电视墙）与视频编码设备之间建立视频连接，传输视频流。 请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度80000客户端SessionID摄像头IDXML： 连接验证信息（S31） 响应 第一步：连接成功或失败。返回指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257XML的长度800100XML：如果成功，此处为空。如果失败，此处为错误的描述信息（预留的部分，现在系统还没有给出任何错误描述信息）。第二步：如果第一步视频连接成功，则发送第二个返回结果，视频session参数包。该参数包通常是厂商专有的，它包括视频编解码标准（codec，如Mpeg4、H.264等）以及其他的视频参数，用于协调发送和接收视频流的两个端点。视频session参数包 返回指令头 + 厂商专有参数包返回指令头参见2.3：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257厂商专有参数包800200 指令体：二进制格式的厂商专有参数包。第三步：连续发送视频数据包，直到用户中止或异常退出。视频数据包 返回指令头 +视频数据返回指令头参见2.3：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257视频数据长度800400指令体：二进制格式的视频数据。4.3报告视频连接开始和结束功能这是个主动发起协议。在视频连接开始和结束时，向中心发送一个报告。请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度40前端业务ID0XML：连接的验证信息（S）设备类型 (N+)开始和结束标志（）Ticket为视频请求时的验证信息。设备类型为TYPE_TERMINAL见3.2。Switch 中表示开始，表示结束。响应返回指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257XML的长度00XML：无4.4获取视频参数请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度50340客户端SessionID摄像头IDXML：参数的子集（N+）Para为分别为八种视频参数：1、帧率。2、图像质量。3、最大码流。4、图像格式。、遮挡区域。、时间和Logo。、视频参数。、图像移动侦测参数。 响应返回指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257XML的长度503500XML：对于具体的子集参数1-8分别的XML为 其中，FrameRate的范围325。KeyFrameIntervals的范围10100。默认值自定义。2其中，Level 为等级。范围：最好、较好、好、一般。分别用 0,1,2,3代替。默认值自定义。3其中，MaxBPS为码流值。单位是1000bit/sec范围：大于50。默认值自定义。4其中，PicFormat范围： CIF 、QCIF 、2CIF、4CIF/D1。分别用0,1,2,3代替。SupportFormat为支持的视频格式。如支持CIF 、QCIF 、2CIF为 012。如支持QCIF 、2CIF为13。默认值自定义。5图像遮挡设置：bLogoing值为或分别为设置和取消图像遮挡。Left、Top、Width、Height分别为遮挡矩形区域。范围：有一个矩型区域，大小在352288之间。默认值是没有效，即没有设置遮挡。6 时间和Logo设置：bOSDing为或分别为打开和关闭时间和Logo设置。nOSDPlace表示时间的显示位置。分别为左上，中上，右上，中左，中右，左下，中下，右下八个位置。nWordPlace表示Logo的显示位置。也是。Word为Logo 的字。默认值是有效，LOGO位置左上。汉字位置右下。汉字内容为：视频位置。7 视频参数设置：范围，对比度、色度、亮度、饱和度的大小范围都是0-255。默认值自定义。8 移动侦测设置：bDectecting为或0分别为打开和关闭移动侦测。DetectGrade为侦测的灵敏度。大小为。0最灵敏，6最迟钝。Left、Top、Width、Height分别为移动侦测的矩形区域。，大小在352288之间。默认值是没有效，即没有设置移动侦测。4.5设置视频参数请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度50320客户端SessionID摄像头IDXML：根据不同的Para的值有不同的参数值 具体含义见上面的参数获取指令。如果每一项值是 1，表示要设置默认值。2 具体含义见上面的参数获取指令。如果每一项值是 1，表示要设置默认值。3 具体含义见上面的参数获取指令。如果每一项值是 1，表示要设置默认值。4 具体含义见上面的参数获取指令。如果每一项值是 1，表示要设置默认值。5 具体含义见上面的参数获取指令。不允许设置默认值。6 具体含义见上面的参数获取指令。不允许设置默认值。7 具体含义见上面的参数获取指令。如果每一项值是 1，表示要设置默认值。8 具体含义见上面的参数获取指令。不允许设置默认值。响应返回指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257XML的长度503300XML：无。五、语音呼叫5.1授权类似4.1。不同的地方是，指令编号是6110，返回指令编号是6111。5.2呼叫连接功能在客户端与视频编码设备之间建立语音连接，传输语音流。 请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度61120客户端SessionID摄像头IDXML： 连接验证信息（S31） Ticket为验证信息。 响应 第一步：返回指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)成功标志(N)257XML的长度611300XML：语音通道数(N)采样深度(N)采样速率(N)压缩格式(S) 注语音通道取值可以为1 或 2 分别为单声道和立体声；采样深度有8位和16位；采样速率可以为8000、11025等等；压缩格式有none，Liner2alaw，G722，G729APCM编码：8000Hz 1通道 8位 压缩代码：none 工控机专用Liner2alaw: 压缩代码：EALAW 北工大专用G722：压缩代码：g722 海康嵌入式专用，假标准，只能用海康的HCNetSDK.dll实现G729A：压缩代码：g729a 由于前端不支持PCM播放由李文军引入G729A建议使用的原始声音数据为：16位 2通道 PCM sample 为 8000Hz第二步：然后再循环的发送具体的语音流，直到用户中止或异常退出。音频流 返回指令头 +语音流返回指令头参见2.3：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257语音流数据长度61140客户端SessionID摄像头ID指令体：二进制格式的语音流数据。六、云镜控制（PTZ） 请求指令头：版本号(N)指令长度(N)指令编号(N)指令序号(N)源ID(S)目地ID(S)257XML的长度50060客户端SessionID摄像头IDXML：有两种xml协议。第一种为基本协议，必须实现。第二种为扩展协议。l 第一种基本协议: 0-20分别代表：0 #停止1 #云台上2 #云台下3 #云台左4 #云台右5 #光圈+6 #光圈-7 #变倍+8 #变倍-9 #聚焦+10 #聚焦-11 #云台自动扫描开12 #云台自动扫描关13 #灯光开14 #灯光关15 #雨刷开16 #雨刷关17 #探头电源开18 #探头电源关19 #摄头电源开20 #摄头电源关l 第二种为扩展协议:云台镜头控制命令在需保持动作时，需在1秒以内重复发码。每一个指令分别叙述如下： 进入菜单模式8100 开自动光圈81021 关自动光圈81020 开背光补偿81041 关背光补偿81040 开数字变倍81061 关数字变倍81060 自动切换夜视功能81081 手动切换夜视功能81080 转换为彩色显示81101 转换为夜视显示81100