基于ONVIF协议的（IPC）客户端程序开发-7：设备搜索
1 前言
要访问一个IPC摄像头，或者说要调用IPC摄像头提供的WEB服务接口，就要先知道其IP地址，这就是「设备发现」的过程，或者叫「设备搜索」的过程。ONVIF规范并没有自己定义服务发现框架，而是复用了已经很成熟的WS-Discovery标准，WS-Discovery 协议使得服务能够被客户端发现。我们先了解下什么是WS-Discovery。
2 WS-Discovery原理
WS-Discovery：全称Web Services Dynamic Discovery。
官方技术规范：http://docs.oasis-open.org/ws-dd/discovery/1.1/os/wsdd-discovery-1.1-spec-os.html
我们传统的Web Services服务调用的模式都是这样的：客户端在设计时就预先知道目标服务的地址（IP地址或者域名），客户端基于这个地址进行服务调用。那如果客户端预先不知道目标服务的地址该怎么办？
WS-Discovery（全称为Web Services Dynamic Discovery）标准就是用于解决该问题的，遵循该标准，客户端预先不知道目标服务地址的情况下，可以动态地探测到可用的目标服务，以便进行服务调用。这个过程就是「设备发现」的过程。
WS-Discovery定义了两种模式：Ad hoc模式和Managed模式。
-
Ad hoc模式：客户端以多播(multicast)的形式往多播组(multicast group)发送一个Probe（探测）消息搜寻目标服务，在该探测消息中，包含相应的搜寻条件。如果目标服务满足该条件，则直接将响应ProbeMatch消息（服务自身相关的信息，包括地址）回复给客户端。
-
Managed模式：即代理模式。Ad hoc模式有个局限性，只能局限于一个较小的网络。Managed模式就是为了解决这个问题的，在Managed模式下，一个维护所有可用目标服务的中心发现代理（Discovery Proxy）被建立起来，客户端只需要将探测消息发送到该发现代理就可以得到相应的目标服务信息。
3 单播、多播（组播）和广播的区别
WS-Discovery协议用到了多播，那什么是多播？
TCP/IP有三种传输方式：单播(Unicast)、多播(Multicast)和广播(Broadcast)，在IPv6领域还有另一种方式：任播(Anycast)。任播在此不做介绍，以下简要介绍下单播、多播和广播的区别：
-
单播(Unicast)：一对一，双向通信，目的地址是对方主机地址。网络上绝大部分的数据都是以单播的形式传输的。如收发邮件、浏览网页等。
-
广播(Broadcast)：一对所有，单向通信，目的地址是广播地址，整个网络中所有主机均可以收到（不管你是否需要），如ARP地址解析、GARP数据包等。广播会被限制在局域网范围内，禁止广播数据穿过路由器，防止广播数据影响大面积的主机。
-
多播(Multicast)：也叫组播，一对多，单向通信，目的地址是多播地址，主机可以通过IGMP协议请求加入或退出某个多播组(multicast group)，数据只会转发给有需要（已加入组）的主机，不影响其他不需要（未加入组）的主机。如网上视频会议、网上视频点播、IPTV等。
网上这篇文章「单播、多播（组播）和广播的区别」写的很全面，也区分了他们各自的优缺点，想深入了解的可以研究下：
多播地址（Multicast Address）有很多，各个行业都不一样，IPC摄像头用的是239.255.255.250（端口3702）。多播地址的范围和分类可以见官方IANA（互联网地址分配机构）的说明：IPv4 Multicast Address Space Registry。
4 设备搜索
回到「设备发现」这个正轨上，搜索IPC有两种搜索方式：
-
自己实现socket编程（UDP），通过sendto往多播地址发送探测消息（Probe），再使用recvfrom接收IPC的应答消息（ProbeMatch）。
-
根据ONVIF标准的remotediscovery.wsdl文档，使用gSOAP工具快速生成框架代码，直接调用其生成的函数接口来搜索IPC。
从原理上来说，这两种方式归根结底是一样的，都是WS-Discovery协议，方式1是自己造轮子（自己码代码），方式2是利用gSOAP快速生成代码。在项目中肯定是要用方式2，之所以要介绍方式1，是为了让大家对搜索IPC的原理、过程有个更深刻的认识。
4.1 搜索IPC（方式1）
直接上代码，如下所示，这里需要说明几点：
-
这份代码在linux和Windows下都可以使用，其他平台没测过。
-
设备发现的多播地址为239.255.255.250，端口3702。
-
从技术层面来说，通过单播、多播、广播三种方式都能探测到IPC，但多播最具实用性。单播得预先知道IPC的地址（那还搜索啥子嘛），没有实用性。多播是ONVIF规定的方式，能搜多到多播组内的所有IPC。广播能搜索到局域网内的所有IPC，但涉及广播风暴的问题，不推荐。
-
const char *probe变量的内容，即探测消息(Probe)的内容，是ONVIF Device Test Tool 15.06工具搜索IPC时通过Wireshark抓包工具抓包到的。
-
从实际执行结果来看，探测到的应答信息都是一堆SOAP协议数据包，一堆XML要自己解析，实用性极差，所以这种方式知道下就好，不要在项目使用。
#include
#include
#include
#include "mutlcast.h"
#ifdef WIN32
#include
#else
#include
#include
#include
#include
#include
#endif
/* 从技术层面来说，通过单播、多播、广播三种方式都能探测到IPC，但多播最具实用性*/
#define COMM_TYPE_UNICAST 1 // 单播
#define COMM_TYPE_MULTICAST 2 // 多播
#define COMM_TYPE_BROADCAST 3 // 广播
#define COMM_TYPE COMM_TYPE_MULTICAST
/* 发送探测消息（Probe）的目标地址、端口号 */
#if COMM_TYPE == COMM_TYPE_UNICAST
#define CAST_ADDR "100.100.100.15" // 单播地址，预先知道的IPC地址
#elif COMM_TYPE == COMM_TYPE_MULTICAST
#define CAST_ADDR "239.255.255.250" // 多播地址，固定的239.255.255.250
#elif COMM_TYPE == COMM_TYPE_BROADCAST
#define CAST_ADDR "100.100.100.255" // 广播地址
#endif
#define CAST_PORT 3702 // 端口号
/* 以下几个宏是为了socket编程能够跨平台，这几个宏是从gsoap中拷贝来的 */
#ifndef SOAP_SOCKET
# ifdef WIN32
# define SOAP_SOCKET SOCKET
# define soap_closesocket(n) closesocket(n)
# else
# define SOAP_SOCKET int
# define soap_closesocket(n) close(n)
# endif
#endif
#if defined(_AIX) || defined(AIX)
# if defined(_AIX43)
# define SOAP_SOCKLEN_T socklen_t
# else
# define SOAP_SOCKLEN_T int
# endif
#elif defined(SOCKLEN_T)
# define SOAP_SOCKLEN_T SOCKLEN_T
#elif defined(__socklen_t_defined) || defined(_SOCKLEN_T) || defined(CYGWIN) || defined(FREEBSD) || defined(__FreeBSD__) || defined(OPENBSD) || defined(__QNX__) || defined(QNX) || defined(OS390) || defined(__ANDROID__) || defined(_XOPEN_SOURCE)
# define SOAP_SOCKLEN_T socklen_t
#elif defined(IRIX) || defined(WIN32) || defined(__APPLE__) || defined(SUN_OS) || defined(OPENSERVER) || defined(TRU64) || defined(VXWORKS) || defined(HP_UX)
# define SOAP_SOCKLEN_T int
#elif !defined(SOAP_SOCKLEN_T)
# define SOAP_SOCKLEN_T size_t
#endif
#ifdef WIN32
#define SLEEP(n) Sleep(1000 * (n))
#else
#define SLEEP(n) sleep((n))
#endif
/* 探测消息(Probe)，这些内容是ONVIF Device Test Tool 15.06工具搜索IPC时的Probe消息，通过Wireshark抓包工具抓包到的 */
const char *probe = "uuid:fc0bad56-5f5a-47f3-8ae2-c94a4e907d70 urn:schemas-xmlsoap-org:ws:2005:04:discovery http://schemas.xmlsoap.org/ws/2005/04/discovery/Probe dn:NetworkVideoTransmitter Send Probe message to [239.255.255.250:3702]
===Recv ProbeMatch from [100.100.100.15:3702]===
uuid:283c0c28-4c5c-4318-8c7e-000058f29c9f uuid:fc0bad56-5f5a-47f3-8ae2-c94a4e907d70 http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous http://schemas.xmlsoap.org/ws/2005/04/discovery/ProbeMatches urn:uuid:00b90d02-7408-8301-ac36-00b90d027408 dn:NetworkVideoTransmitter onvif://www.onvif.org/type/video_encoder onvif://www.onvif.org/type/audio_encoder onvif://www.onvif.org/type/ptz onvif://www.onvif.org/hardware/HW0100302 onvif://www.onvif.org/location/country/china onvif://www.onvif.org/name/hd onvif://www.onvif.org/Profile/Streaming http://100.100.100.15:2000/onvif/device_service 32152654 urn:uuid:0b4bede6-5566-7788-99aa-00121312da25 uuid:fc0bad56-5f5a-47f3-8ae2-c94a4e907d70 http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous http://schemas.xmlsoap.org/ws/2005/04/discovery/ProbeMatches urn:uuid:0b4bede6-5566-7788-99aa-00121312da25 dn:NetworkVideoTransmitter onvif://www.onvif.org/type/video_encoder onvif://www.onvif.org/type/audio_encoder onvif://www.onvif.org/hardware/IPC-model onvif://www.onvif.org/location/country/china onvif://www.onvif.org/name/NVT http://100.100.100.119:8899/onvif/device_service 1 这才是我们项目开发中要用到的方式，我们需要用到ONVIF框架代码，如何使用gSOAP生成ONVIF框架代码在专栏前面的文章已经提到了，此次不再赘述。
直接上代码，附加几点说明：
-
头文件onvif_dump.h是我自己封装的代码，仅仅用于打印IPC应答的数据结构体信息，具体代码就不列出来了。
-
搜索时必须指定设备类型为「dn:NetworkVideoTransmitter」，否则将搜索不到IPC，该值的来源请参考「ONVIF Profile S Specification」（https://www.onvif.org/profiles/profile-s/），看Types章节说明，如下所示（摘自ONVIF Profile S Specification Version 1.1.1版本）：
9.1 Types
Section “Discovery definitions” of the ONVIF Core Specification defines a generic tds:Device for
the
#include
#include
#include
#include "soapH.h"
#include "wsaapi.h"
#include "onvif_dump.h"
#define SOAP_ASSERT assert
#define SOAP_DBGLOG printf
#define SOAP_DBGERR printf
#define SOAP_TO "urn:schemas-xmlsoap-org:ws:2005:04:discovery"
#define SOAP_ACTION "http://schemas.xmlsoap.org/ws/2005/04/discovery/Probe"
#define SOAP_MCAST_ADDR "soap.udp://239.255.255.250:3702" // onvif规定的组播地址
#define SOAP_ITEM "" // 寻找的设备范围
#define SOAP_TYPES "dn:NetworkVideoTransmitter" // 寻找的设备类型
#define SOAP_SOCK_TIMEOUT (10) // socket超时时间（单秒秒）
void soap_perror(struct soap *soap, const char *str)
{
if (NULL == str) {
SOAP_DBGERR("[soap] error: %d, %s, %s\n", soap->error, *soap_faultcode(soap), *soap_faultstring(soap));
} else {
SOAP_DBGERR("[soap] %s error: %d, %s, %s\n", str, soap->error, *soap_faultcode(soap), *soap_faultstring(soap));
}
return;
}
void* ONVIF_soap_malloc(struct soap *soap, unsigned int n)
{
void *p = NULL;
if (n > 0) {
p = soap_malloc(soap, n);
SOAP_ASSERT(NULL != p);
memset(p, 0x00 ,n);
}
return p;
}
struct soap *ONVIF_soap_new(int timeout)
{
struct soap *soap = NULL; // soap环境变量
SOAP_ASSERT(NULL != (soap = soap_new()));
soap_set_namespaces(soap, namespaces); // 设置soap的namespaces
soap->recv_timeout = timeout; // 设置超时（超过指定时间没有数据就退出）
soap->send_timeout = timeout;
soap->connect_timeout = timeout;
#if defined(__linux__) || defined(__linux) // 参考https://www.genivia.com/dev.html#client-c的修改：
soap->socket_flags = MSG_NOSIGNAL; // To prevent connection reset errors
#endif
soap_set_mode(soap, SOAP_C_UTFSTRING); // 设置为UTF-8编码，否则叠加中文OSD会乱码
return soap;
}
void ONVIF_soap_delete(struct soap *soap)
{
soap_destroy(soap); // remove deserialized class instances (C++ only)
soap_end(soap); // Clean up deserialized data (except class instances) and temporary data
soap_done(soap); // Reset, close communications, and remove callbacks
soap_free(soap); // Reset and deallocate the context created with soap_new or soap_copy
}
/************************************************************************
**函数：ONVIF_init_header
**功能：初始化soap描述消息头
**参数：
[in] soap - soap环境变量
**返回：无
**备注：
1). 在本函数内部通过ONVIF_soap_malloc分配的内存，将在ONVIF_soap_delete中被释放
************************************************************************/
void ONVIF_init_header(struct soap *soap)
{
struct SOAP_ENV__Header *header = NULL;
SOAP_ASSERT(NULL != soap);
header = (struct SOAP_ENV__Header *)ONVIF_soap_malloc(soap, sizeof(struct SOAP_ENV__Header));
soap_default_SOAP_ENV__Header(soap, header);
header->wsa__MessageID = (char*)soap_wsa_rand_uuid(soap);
header->wsa__To = (char*)ONVIF_soap_malloc(soap, strlen(SOAP_TO) + 1);
header->wsa__Action = (char*)ONVIF_soap_malloc(soap, strlen(SOAP_ACTION) + 1);
strcpy(header->wsa__To, SOAP_TO);
strcpy(header->wsa__Action, SOAP_ACTION);
soap->header = header;
return;
}
/************************************************************************
**函数：ONVIF_init_ProbeType
**功能：初始化探测设备的范围和类型
**参数：
[in] soap - soap环境变量
[out] probe - 填充要探测的设备范围和类型
**返回：
0表明探测到，非0表明未探测到
**备注：
1). 在本函数内部通过ONVIF_soap_malloc分配的内存，将在ONVIF_soap_delete中被释放
************************************************************************/
void ONVIF_init_ProbeType(struct soap *soap, struct wsdd__ProbeType *probe)
{
struct wsdd__ScopesType *scope = NULL; // 用于描述查找哪类的Web服务
SOAP_ASSERT(NULL != soap);
SOAP_ASSERT(NULL != probe);
scope = (struct wsdd__ScopesType *)ONVIF_soap_malloc(soap, sizeof(struct wsdd__ScopesType));
soap_default_wsdd__ScopesType(soap, scope); // 设置寻找设备的范围
scope->__item = (char*)ONVIF_soap_malloc(soap, strlen(SOAP_ITEM) + 1);
strcpy(scope->__item, SOAP_ITEM);
memset(probe, 0x00, sizeof(struct wsdd__ProbeType));
soap_default_wsdd__ProbeType(soap, probe);
probe->Scopes = scope;
probe->Types = (char*)ONVIF_soap_malloc(soap, strlen(SOAP_TYPES) + 1); // 设置寻找设备的类型
strcpy(probe->Types, SOAP_TYPES);
return;
}
void ONVIF_DetectDevice(void (*cb)(char *DeviceXAddr))
{
int i;
int result = 0;
unsigned int count = 0; // 搜索到的设备个数
struct soap *soap = NULL; // soap环境变量
struct wsdd__ProbeType req; // 用于发送Probe消息
struct __wsdd__ProbeMatches rep; // 用于接收Probe应答
struct wsdd__ProbeMatchType *probeMatch;
SOAP_ASSERT(NULL != (soap = ONVIF_soap_new(SOAP_SOCK_TIMEOUT)));
ONVIF_init_header(soap); // 设置消息头描述
ONVIF_init_ProbeType(soap, &req); // 设置寻找的设备的范围和类型
result = soap_send___wsdd__Probe(soap, SOAP_MCAST_ADDR, NULL, &req); // 向组播地址广播Probe消息
while (SOAP_OK == result) // 开始循环接收设备发送过来的消息
{
memset(&rep, 0x00, sizeof(rep));
result = soap_recv___wsdd__ProbeMatches(soap, &rep);
if (SOAP_OK == result) {
if (soap->error) {
soap_perror(soap, "ProbeMatches");
} else { // 成功接收到设备的应答消息
dump__wsdd__ProbeMatches(&rep);
if (NULL != rep.wsdd__ProbeMatches) {
count += rep.wsdd__ProbeMatches->__sizeProbeMatch;
for(i = 0; i < rep.wsdd__ProbeMatches->__sizeProbeMatch; i++) {
probeMatch = rep.wsdd__ProbeMatches->ProbeMatch + i;
if (NULL != cb) {
cb(probeMatch->XAddrs); // 使用设备服务地址执行函数回调
}
}
}
}
} else if (soap->error) {
break;
}
}
SOAP_DBGLOG("\ndetect end! It has detected %d devices!\n", count);
if (NULL != soap) {
ONVIF_soap_delete(soap);
}
return ;
}
int main(int argc, char **argv)
{
ONVIF_DetectDevice(NULL);
return 0;
}
================= + dump__wsdd__ProbeMatches + >>>
wsdd__ProbeMatches: (0x8ace650)
|- __sizeProbeMatch: 1
|- ProbeMatch: (0x8ace654)
|- 0
|- wsa__EndpointReference: (0x8acd568)
|- Address: urn:uuid:00b974cb-7c65-8301-ac36-00b974cb7c65
|- ReferenceProperties: (null)
|- ReferenceParameters: (null)
|- PortType: (null)
|- ServiceName: (null)
|- __size: 0
|- __any: (null)
|- __anyAttribute:
|- Types: tdn:NetworkVideoTransmitter
|- Scopes: (0x8ace770)
|- __item: onvif://www.onvif.org/type/video_encoder onvif://www.onvif.org/type/audio_encoder onvif://www.onvif.org/type/ptz onvif://www.onvif.org/hardware/HW0100302 onvif://www.onvif.org/location/country/china onvif://www.onvif.org/name/hd onvif://www.onvif.org/Profile/Streaming
|- MatchBy: (null)
|- XAddrs: http://100.100.100.24:2000/onvif/device_service
|- MetadataVersion: 32152654
================= - dump__wsdd__ProbeMatches - <<<
================= + dump__wsdd__ProbeMatches + >>>
wsdd__ProbeMatches: (0x8ace668)
|- __sizeProbeMatch: 1
|- ProbeMatch: (0x8ace66c)
|- 0
|- wsa__EndpointReference: (0x8acd750)
|- Address: urn:uuid:00b90d02-7408-8301-ac36-00b90d027408
|- ReferenceProperties: (null)
|- ReferenceParameters: (null)
|- PortType: (null)
|- ServiceName: (null)
|- __size: 0
|- __any: (null)
|- __anyAttribute:
|- Types: tdn:NetworkVideoTransmitter
|- Scopes: (0x8aceba0)
|- __item: onvif://www.onvif.org/type/video_encoder onvif://www.onvif.org/type/audio_encoder onvif://www.onvif.org/type/ptz onvif://www.onvif.org/hardware/HW0100302 onvif://www.onvif.org/location/country/china onvif://www.onvif.org/name/hd onvif://www.onvif.org/Profile/Streaming
|- MatchBy: (null)
|- XAddrs: http://100.100.100.15:2000/onvif/device_service
|- MetadataVersion: 32152654
================= - dump__wsdd__ProbeMatches - <<<
detect end! It has detected 2 devices!