說明:網上關於ONVIF開發的文章並不多,也更找不到具體的實例來入門學習。只能靠翻閱各種Specification摸索中前進,下面是最近幾天的成果。調通了服務端(或者說設備端)的Discovery,使用OnvifTestTool12.06能夠搜到我的設備。【來自http://blog.csdn.net/ghostyu】
1、在使用wsdl2h產生頭文件前需要修改typemap.dat,
修改的依據在這裏:http://www.cs.fsu.edu/~engelen/soap.html,在FAQ頁面下的How do I use gSOAP for the ONVIF specifications?
- #Use gSOAP 2.8.10 and up. In the typemap.dat file used by wsdl2h, add:
- # ONVIF recommended prefixes
- tds = "http://www.onvif.org/ver10/device/wsdl"
- tev = "http://www.onvif.org/ver10/events/wsdl"
- tls = "http://www.onvif.org/ver10/display/wsdl"
- tmd = "http://www.onvif.org/ver10/deviceIO/wsdl"
- timg = "http://www.onvif.org/ver20/imaging/wsdl"
- trt = "http://www.onvif.org/ver10/media/wsdl"
- tptz = "http://www.onvif.org/ver20/ptz/wsdl"
- trv = "http://www.onvif.org/ver10/receiver/wsdl"
- trc = "http://www.onvif.org/ver10/recording/wsdl"
- tse = "http://www.onvif.org/ver10/search/wsdl"
- trp = "http://www.onvif.org/ver10/replay/wsdl"
- tan = "http://www.onvif.org/ver20/analytics/wsdl"
- tad = "http://www.onvif.org/ver10/analyticsdevice/wsdl"
- tdn = "http://www.onvif.org/ver10/network/wsdl"
- tt = "http://www.onvif.org/ver10/schema"
- # OASIS recommended prefixes
- wsnt = "http://docs.oasis-open.org/wsn/b-2"
- wsntw = "http://docs.oasis-open.org/wsn/bw-2"
- wsrfbf = "http://docs.oasis-open.org/wsrf/bf-2"
- wsrfr = "http://docs.oasis-open.org/wsrf/r-2"
- wsrfrw = "http://docs.oasis-open.org/wsrf/rw-2"
- wstop = "http://docs.oasis-open.org/wsn/t-1"
- # WS-Discovery 1.0 remapping
- wsdd10__HelloType = | wsdd__HelloType
- wsdd10__ByeType = | wsdd__ByeType
- wsdd10__ProbeType = | wsdd__ProbeType
- wsdd10__ProbeMatchesType = | wsdd__ProbeMatchesType
- wsdd10__ProbeMatchType = | wsdd__ProbeMatchType
- wsdd10__ResolveType = | wsdd__ResolveType
- wsdd10__ResolveMatchesType = | wsdd__ResolveMatchesType
- wsdd10__ResolveMatchType = | wsdd__ResolveMatchType
- # SOAP-ENV mapping
- SOAP_ENV__Envelope = struct SOAP_ENV__Envelope { struct SOAP_ENV__Header *SOAP_ENV__Header; _XML SOAP_ENV__Body; }; | struct SOAP_ENV__Envelope
- SOAP_ENV__Header = | struct SOAP_ENV__Header
- SOAP_ENV__Fault = | struct SOAP_ENV__Fault
- SOAP_ENV__Detail = | struct SOAP_ENV__Detail
- SOAP_ENV__Code = | struct SOAP_ENV__Code
- SOAP_ENV__Subcode = | struct SOAP_ENV__Subcode
- SOAP_ENV__Reason = | struct SOAP_ENV__Reason
2、根據onvif官網提供的remotediscovery.wsdl產生onvif.h頭文件
關於onvif所有的wsdl都在這裏:http://www.onvif.org/Documents/Specifications.aspx中的ONVIF WSDL and XML Schemas Specifications一節,雖然可以全部下載爲wsdl文件,但是wsdl文件中存在相互依賴的關係,並且是帶有存儲的依賴,所以最好直接使用url來產生頭文件,不要下載下來。
- wsdl2h -o onvif.h -c -s -t ./typemap.dat http://www.onvif.org/onvif/ver10/network/wsdl/remotediscovery.wsdl
3、使用onvif.h來產生骨架代碼
- soapcpp2 -c onvif.h -x -I /root/onvif/gsoap-2.8/gsoap/import -I /root/onvif/gsoap-2.8/gsoap/
4、ProbeMatches代碼
這樣就創建了基本的服務端和客戶端的代碼了,下面需要添加具體的代碼了。
其中包括:
(1)創建組播用的udp socket,綁定組播地址爲239.255.255.250,端口爲3702,因爲ws-discovery的組播地址和端口就是爲239.255.255.250和3702
(2)在產生的Probe函數中添加ProbeMatches代碼
首先是udp socket
- int bind_server_udp1(int server_s)
- {
- struct sockaddr_in local_addr;
- memset(&local_addr,0,sizeof(local_addr));
- local_addr.sin_family = AF_INET;
- local_addr.sin_addr.s_addr = htonl(INADDR_ANY);
- local_addr.sin_port = htons(3702);
- return bind(server_s,(struct sockaddr*)&local_addr,sizeof(local_addr));
- }
- static int create_server_socket_udp(void)
- {
- int server_udp;
- unsigned char one = 1;
- int sock_opt = 1;
- //server_udp = socket(PF_INET, SOCK_DGRAM, 0);
- server_udp = socket(PF_INET, SOCK_DGRAM, IPPROTO_UDP);
- if (server_udp == -1) {
- printf("unable to create socket\n");
- }
- /* reuse socket addr */
- if ((setsockopt(server_udp, SOL_SOCKET, SO_REUSEADDR, (void *) &sock_opt,
- sizeof (sock_opt))) == -1) {
- printf("setsockopt\n");
- }
- if ((setsockopt(server_udp, IPPROTO_IP, IP_MULTICAST_LOOP,
- &one, sizeof (unsigned char))) == -1) {
- printf("setsockopt\n");
- }
- struct ip_mreq mreq;
- mreq.imr_multiaddr.s_addr = inet_addr("239.255.255.250");
- mreq.imr_interface.s_addr = htonl(INADDR_ANY);
- if(setsockopt(server_udp,IPPROTO_IP,IP_ADD_MEMBERSHIP,&mreq,sizeof(mreq))==-1){
- perror("memberchip error\n");
- }
- return server_udp;
- }
需要注意幾點:1/設置socket屬性SO_REUSEADDR,2、設置socket屬性IP_ADD_MEMBERSHIP,目的是讓3702的端口能夠重複綁定,一家加入組播組。
其次是添加ProbeMatches代碼
(1)首先複製client的soap_send___wsdd__ProbeMatches函數到服務端來,因爲soap_send___wsdd__ProbeMatches已經寫好了用於響應Probe消息的框架了,不用白不用啊。
(2)編寫__wsdd__Probe函數,添加如下內容
- int __wsdd__Probe(struct soap* soap, struct wsdd__ProbeType *wsdd__Probe)
- {
- DBG("__wsdd__Probe\n");
- char macaddr[6];
- char _IPAddr[INFO_LENGTH];
- char _HwId[1024];
- wsdd__ProbeMatchesType ProbeMatches;
- ProbeMatches.ProbeMatch = (struct wsdd__ProbeMatchType *)soap_malloc(soap, sizeof(struct wsdd__ProbeMatchType));
- ProbeMatches.ProbeMatch->XAddrs = (char *)soap_malloc(soap, sizeof(char) * INFO_LENGTH);
- ProbeMatches.ProbeMatch->Types = (char *)soap_malloc(soap, sizeof(char) * INFO_LENGTH);
- ProbeMatches.ProbeMatch->Scopes = (struct wsdd__ScopesType*)soap_malloc(soap,sizeof(struct wsdd__ScopesType));
- ProbeMatches.ProbeMatch->wsa__EndpointReference.ReferenceProperties = (struct wsa__ReferencePropertiesType*)soap_malloc(soap,sizeof(struct wsa__ReferencePropertiesType));
- ProbeMatches.ProbeMatch->wsa__EndpointReference.ReferenceParameters = (struct wsa__ReferenceParametersType*)soap_malloc(soap,sizeof(struct wsa__ReferenceParametersType));
- ProbeMatches.ProbeMatch->wsa__EndpointReference.ServiceName = (struct wsa__ServiceNameType*)soap_malloc(soap,sizeof(struct wsa__ServiceNameType));
- ProbeMatches.ProbeMatch->wsa__EndpointReference.PortType = (char **)soap_malloc(soap, sizeof(char *) * SMALL_INFO_LENGTH);
- ProbeMatches.ProbeMatch->wsa__EndpointReference.__any = (char **)soap_malloc(soap, sizeof(char*) * SMALL_INFO_LENGTH);
- ProbeMatches.ProbeMatch->wsa__EndpointReference.__anyAttribute = (char *)soap_malloc(soap, sizeof(char) * SMALL_INFO_LENGTH);
- ProbeMatches.ProbeMatch->wsa__EndpointReference.Address = (char *)soap_malloc(soap, sizeof(char) * INFO_LENGTH);
- macaddr[0]=0x01;macaddr[1]=0x01;macaddr[2]=0x01;macaddr[3]=0x01;macaddr[4]=0x01;macaddr[5]=0x01;
- sprintf(_HwId,"urn:uuid:2419d68a-2dd2-21b2-a205-%02X%02X%02X%02X%02X%02X",macaddr[0], macaddr[1], macaddr[2], macaddr[3], macaddr[4], macaddr[5]);
- sprintf(_IPAddr, "http://%03d.%03d.%1d.%03d/onvif/device_service", 192, 168, 1, 233);
- ProbeMatches.__sizeProbeMatch = 1;
- ProbeMatches.ProbeMatch->Scopes->__item =(char *)soap_malloc(soap, 1024);
- memset(ProbeMatches.ProbeMatch->Scopes->__item,0,sizeof(ProbeMatches.ProbeMatch->Scopes->__item));
- //Scopes MUST BE
- strcat(ProbeMatches.ProbeMatch->Scopes->__item, "onvif://www.onvif.org/type/NetworkVideoTransmitter");
- ProbeMatches.ProbeMatch->Scopes->MatchBy = NULL;
- strcpy(ProbeMatches.ProbeMatch->XAddrs, _IPAddr);
- strcpy(ProbeMatches.ProbeMatch->Types, wsdd__Probe->Types);
- DBG("wsdd__Probe->Types=%s\n",wsdd__Probe->Types);
- ProbeMatches.ProbeMatch->MetadataVersion = 1;
- //ws-discovery規定 爲可選項
- ProbeMatches.ProbeMatch->wsa__EndpointReference.ReferenceProperties->__size = 0;
- ProbeMatches.ProbeMatch->wsa__EndpointReference.ReferenceProperties->__any = NULL;
- ProbeMatches.ProbeMatch->wsa__EndpointReference.ReferenceParameters->__size = 0;
- ProbeMatches.ProbeMatch->wsa__EndpointReference.ReferenceParameters->__any = NULL;
- ProbeMatches.ProbeMatch->wsa__EndpointReference.PortType[0] = (char *)soap_malloc(soap, sizeof(char) * SMALL_INFO_LENGTH);
- //ws-discovery規定 爲可選項
- strcpy(ProbeMatches.ProbeMatch->wsa__EndpointReference.PortType[0], "ttl");
- ProbeMatches.ProbeMatch->wsa__EndpointReference.ServiceName->__item = NULL;
- ProbeMatches.ProbeMatch->wsa__EndpointReference.ServiceName->PortName = NULL;
- ProbeMatches.ProbeMatch->wsa__EndpointReference.ServiceName->__anyAttribute = NULL;
- ProbeMatches.ProbeMatch->wsa__EndpointReference.__any[0] = (char *)soap_malloc(soap, sizeof(char) * SMALL_INFO_LENGTH);
- strcpy(ProbeMatches.ProbeMatch->wsa__EndpointReference.__any[0], "Any");
- strcpy(ProbeMatches.ProbeMatch->wsa__EndpointReference.__anyAttribute, "Attribute");
- ProbeMatches.ProbeMatch->wsa__EndpointReference.__size = 0;
- strcpy(ProbeMatches.ProbeMatch->wsa__EndpointReference.Address, _HwId);
- /*註釋的部分爲可選,註釋掉onvif test也能發現ws-d*/
- //soap->header->wsa__To = "http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous";
- //soap->header->wsa__Action = "http://schemas.xmlsoap.org/ws/2005/04/discovery/ProbeMatches";
- soap->header->wsa__RelatesTo = (struct wsa__Relationship*)soap_malloc(soap, sizeof(struct wsa__Relationship));
- //it's here
- soap->header->wsa__RelatesTo->__item = soap->header->wsa__MessageID;
- soap->header->wsa__RelatesTo->RelationshipType = NULL;
- soap->header->wsa__RelatesTo->__anyAttribute = NULL;
- soap->header->wsa__MessageID =(char *)soap_malloc(soap, sizeof(char) * INFO_LENGTH);
- strcpy(soap->header->wsa__MessageID,_HwId+4);
- /* send over current socket as HTTP OK response: */
- /*測試過,第二參數必須http,action隨意*/
- soap_send___wsdd__ProbeMatches(soap, "http://", NULL, &ProbeMatches);
- return SOAP_OK;
- }
想要寫出上述代碼,是一定要了解SOAP格式的,在WS-Discovery中描述了discovery所用的soap格式
1首先是瞭解消息頭header和ProbeMatches中的內容,非常重要,可以參考這裏http://www.w3.org/Submission/ws-addressing/ 最好詳細的學習一下,裏面的內容非常重要。
2其次需要理解的是,其實當你看完ws-addressing後你會發現,骨架代碼中的結構體和SOAP消息中的內容是一一對應的,例如:
結構體osap->header對應SOAP消息的<SOAP-ENV:Header></SOAP-ENV:Header>中的內容,包含在header裏的內容當然會包含在SOAP的header內。例如:
結構體soap->header->wsa__RelatesTo對應的是<wsa:RelatesTo></wsa:RelatesTo>。
3最後需要理解的是,在代碼中的"__"雙下劃線一般對應xml中的命名空間的":",下劃線前是命名空間,後是具體內容。
4最後的最後是要詳細的閱讀ONVIF Core Specification
下圖爲響應OnvifTestTool的Probe命令的SOAP消息
結合上圖再分析代碼就親切多了。在ONVIF Core Specification的7.3.2.2 Scopes 一節描述了onvif需要的Scopes,這個是需要在程序裏填充,具體填充什麼,文檔裏說的很明確:
注意點是在太多,隨便漏掉一個都可能會導致搜不到設備,下圖是非常重要的一個:
SOAP1.1和SOAP1.2所使用的SOAP-ENV是不同的,ONVIF使用的是SOAP1.1,如果soapcpp2產生的nsmap文件中的SOAP-ENV是SOAP1.2版本的話,那麼OnvifTestTool是不會識別設備發出的SOAP消息的。
5、該main函數登場了
- int main()
- {
- int server_udp;
- int retval=0;
- struct soap *soap_udp;
- int fault_flag = 0;
- server_udp = create_server_socket_udp();
- bind_server_udp1(server_udp);
- while(1){
- soap_udp=soap_new();
- soap_init1(soap_udp, SOAP_IO_UDP);
- soap_udp->master = server_udp;
- soap_udp->socket = server_udp;
- soap_udp->errmode = 0;
- soap_udp->bind_flags = 1;
- if (!soap_valid_socket(soap_bind(soap_udp, NULL, 3702, 100)))
- {
- soap_print_fault(soap_udp, stderr);
- }
- fprintf(stderr,"soap_serve starting..\n");
- retval = soap_serve(soap_udp); //阻塞在這裏
- fprintf(stderr,"retval=%d\n",retval);
- if(retval && !(fault_flag))
- {
- fault_flag = 1;
- }
- else if(!retval)
- {
- fault_flag = 0;
- }
- soap_destroy(soap_udp);
- soap_end(soap_udp);
- soap_done(soap_udp);
- free(soap_udp);
- }
- }
soap_server函數會一直阻塞,直到接收到SOAP消息,並且該處理是一次性的,所以要將將soap_server放到while裏或者獨立的線程中。
最後編譯運行
make server
./discovery.tmp
單擊OnvifTestTool的Discover Devices,運行discovery.tmp的中會打印調試信息,如圖
然後,在OnvifTestTool中會搜索到我的設備
響應Discover Devices的SOAP消息如下:
- <?xml version="1.0" encoding="UTF-8"?>
- <SOAP-ENV:Envelope
- xmlns:SOAP-ENV="http://www.w3.org/2003/05/soap-envelope"
- xmlns:SOAP-ENC="http://www.w3.org/2003/05/soap-encoding"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns:xsd="http://www.w3.org/2001/XMLSchema"
- xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
- xmlns:wsdd="http://schemas.xmlsoap.org/ws/2005/04/discovery"
- xmlns:ns1="http://www.onvif.org/ver10/network/wsdl/RemoteDiscoveryBinding"
- xmlns:ns2="http://www.onvif.org/ver10/network/wsdl/DiscoveryLookupBinding"
- xmlns:ns3="http://www.onvif.org/ver10/network/wsdl/DiscoveryLookupBinding"
- xmlns:tdn="http://www.onvif.org/ver10/network/wsdl">
- <SOAP-ENV:Header>
- <wsa:MessageID>uuid:2419d68a-2dd2-21b2-a205-010101010101</wsa:MessageID>
- <wsa:RelatesTo>uuid:88a3958a-6155-4510-8279-69aeafd31681</wsa:RelatesTo>
- <wsa:To SOAP-ENV:mustUnderstand="true">urn:schemas-xmlsoap-org:ws:2005:04:discovery</wsa:To>
- <wsa:Action SOAP-ENV:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2005/04/discovery/Probe</wsa:Action>
- </SOAP-ENV:Header>
- <SOAP-ENV:Body>
- <wsdd:ProbeMatches>
- <wsdd:ProbeMatch xmlns:_0="http://www.onvif.org/ver10/device/wsdl">
- <wsa:EndpointReference>
- <wsa:Address>urn:uuid:2419d68a-2dd2-21b2-a205-010101010101</wsa:Address>
- <wsa:ReferenceProperties></wsa:ReferenceProperties>
- <wsa:ReferenceParameters></wsa:ReferenceParameters>
- <wsa:PortType>ttl</wsa:PortType>
- </wsa:EndpointReference>
- <wsdd:Types>_0:Device</wsdd:Types>
- <wsdd:Scopes>onvif://www.onvif.org/type/NetworkVideoTransmitter</wsdd:Scopes>
- <wsdd:XAddrs>http://192.168.1.233/onvif/device_service</wsdd:XAddrs>
- <wsdd:MetadataVersion>1</wsdd:MetadataVersion>
- </wsdd:ProbeMatch>
- </wsdd:ProbeMatches>
- </SOAP-ENV:Body>
- </SOAP-ENV:Envelope>
資料下載
上述完整的代碼包在這裏,有需要的就去下載吧:http://download.csdn.net/detail/ghostyu/4766025
另外我參考的部分文檔可以再這裏下載
ONVIF-Core-Spec-v210.pdf:http://download.csdn.net/detail/ghostyu/4766067
gSOAP手冊:http://download.csdn.net/detail/ghostyu/4766075
OnvifTestTool12.06測試工具網上有的,我就不上傳了。