onvif規範的實現：server端Discovery實現，通過OnvifTestTool12.06測試

beachboyy發表於2015-03-07
Server

【http://blog.csdn.net/ghostyu/article/details/8182516】

說明：網上關於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?

[cpp] view plaincopy
  1. #Use gSOAP 2.8.10 and up. In the typemap.dat file used by wsdl2h, add:  
  2. #   ONVIF recommended prefixes  
  3. tds = "http://www.onvif.org/ver10/device/wsdl"  
  4. tev = "http://www.onvif.org/ver10/events/wsdl"  
  5. tls = "http://www.onvif.org/ver10/display/wsdl"  
  6. tmd = "http://www.onvif.org/ver10/deviceIO/wsdl"  
  7. timg    = "http://www.onvif.org/ver20/imaging/wsdl"  
  8. trt = "http://www.onvif.org/ver10/media/wsdl"  
  9. tptz    = "http://www.onvif.org/ver20/ptz/wsdl"  
  10. trv = "http://www.onvif.org/ver10/receiver/wsdl"  
  11. trc = "http://www.onvif.org/ver10/recording/wsdl"  
  12. tse = "http://www.onvif.org/ver10/search/wsdl"  
  13. trp = "http://www.onvif.org/ver10/replay/wsdl"  
  14. tan = "http://www.onvif.org/ver20/analytics/wsdl"  
  15. tad = "http://www.onvif.org/ver10/analyticsdevice/wsdl"  
  16. tdn = "http://www.onvif.org/ver10/network/wsdl"  
  17. tt  = "http://www.onvif.org/ver10/schema"  
  18. #   OASIS recommended prefixes  
  19. wsnt    = "http://docs.oasis-open.org/wsn/b-2"  
  20. wsntw   = "http://docs.oasis-open.org/wsn/bw-2"  
  21. wsrfbf  = "http://docs.oasis-open.org/wsrf/bf-2"  
  22. wsrfr   = "http://docs.oasis-open.org/wsrf/r-2"  
  23. wsrfrw  = "http://docs.oasis-open.org/wsrf/rw-2"  
  24. wstop   = "http://docs.oasis-open.org/wsn/t-1"  
  25. #   WS-Discovery 1.0 remapping  
  26. wsdd10__HelloType       = | wsdd__HelloType  
  27. wsdd10__ByeType         = | wsdd__ByeType  
  28. wsdd10__ProbeType       = | wsdd__ProbeType  
  29. wsdd10__ProbeMatchesType    = | wsdd__ProbeMatchesType  
  30. wsdd10__ProbeMatchType      = | wsdd__ProbeMatchType  
  31. wsdd10__ResolveType     = | wsdd__ResolveType  
  32. wsdd10__ResolveMatchesType  = | wsdd__ResolveMatchesType  
  33. wsdd10__ResolveMatchType    = | wsdd__ResolveMatchType  
  34. #   SOAP-ENV mapping  
  35. SOAP_ENV__Envelope  = struct SOAP_ENV__Envelope { struct SOAP_ENV__Header *SOAP_ENV__Header; _XML SOAP_ENV__Body; }; | struct SOAP_ENV__Envelope  
  36. SOAP_ENV__Header    = | struct SOAP_ENV__Header  
  37. SOAP_ENV__Fault     = | struct SOAP_ENV__Fault  
  38. SOAP_ENV__Detail    = | struct SOAP_ENV__Detail  
  39. SOAP_ENV__Code      = | struct SOAP_ENV__Code  
  40. SOAP_ENV__Subcode   = | struct SOAP_ENV__Subcode  
  41. 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來產生標頭檔案，不要下載下來。

[html] view plaincopy
  1. wsdl2h -o onvif.h -c -s -t ./typemap.dat http://www.onvif.org/onvif/ver10/network/wsdl/remotediscovery.wsdl  

3、使用onvif.h來產生骨架程式碼

[html] view plaincopy
  1. 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

[cpp] view plaincopy
  1. int bind_server_udp1(int server_s)  
  2. {  
  3.     struct sockaddr_in local_addr;  
  4.     memset(&local_addr,0,sizeof(local_addr));  
  5.     local_addr.sin_family = AF_INET;  
  6.     local_addr.sin_addr.s_addr = htonl(INADDR_ANY);  
  7.     local_addr.sin_port = htons(3702);  
  8.     return bind(server_s,(struct sockaddr*)&local_addr,sizeof(local_addr));  
  9.   
  10. }  
  11. static int create_server_socket_udp(void)  
  12. {  
  13.     int server_udp;  
  14.     unsigned char one = 1;  
  15.     int sock_opt = 1;  
  16.       
  17.     //server_udp = socket(PF_INET, SOCK_DGRAM, 0);  
  18.     server_udp = socket(PF_INET, SOCK_DGRAM, IPPROTO_UDP);  
  19.     if (server_udp == -1) {  
  20.         printf("unable to create socket\n");  
  21.     }  
  22.   
  23.     /* reuse socket addr */  
  24.     if ((setsockopt(server_udp, SOL_SOCKET, SO_REUSEADDR, (void *) &sock_opt,  
  25.                     sizeof (sock_opt))) == -1) {  
  26.         printf("setsockopt\n");  
  27.     }  
  28.     if ((setsockopt(server_udp, IPPROTO_IP, IP_MULTICAST_LOOP,  
  29.                        &one, sizeof (unsigned char))) == -1) {  
  30.         printf("setsockopt\n");  
  31.     }  
  32.   
  33.     struct ip_mreq mreq;  
  34.     mreq.imr_multiaddr.s_addr = inet_addr("239.255.255.250");  
  35.     mreq.imr_interface.s_addr = htonl(INADDR_ANY);  
  36.   
  37.     if(setsockopt(server_udp,IPPROTO_IP,IP_ADD_MEMBERSHIP,&mreq,sizeof(mreq))==-1){  
  38.         perror("memberchip error\n");  
  39.     }  
  40.   
  41.     return server_udp;  
  42. }  
需要注意幾點：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函式，新增如下內容

[cpp] view plaincopy
  1. int  __wsdd__Probe(struct soap* soap, struct wsdd__ProbeType *wsdd__Probe)  
  2. {  
  3.     DBG("__wsdd__Probe\n");  
  4.     char macaddr[6];  
  5.     char _IPAddr[INFO_LENGTH];  
  6.     char _HwId[1024];  
  7.       
  8.     wsdd__ProbeMatchesType ProbeMatches;  
  9.     ProbeMatches.ProbeMatch = (struct wsdd__ProbeMatchType *)soap_malloc(soap, sizeof(struct wsdd__ProbeMatchType));  
  10.     ProbeMatches.ProbeMatch->XAddrs = (char *)soap_malloc(soap, sizeof(char) * INFO_LENGTH);  
  11.     ProbeMatches.ProbeMatch->Types = (char *)soap_malloc(soap, sizeof(char) * INFO_LENGTH);  
  12.     ProbeMatches.ProbeMatch->Scopes = (struct wsdd__ScopesType*)soap_malloc(soap,sizeof(struct wsdd__ScopesType));  
  13.     ProbeMatches.ProbeMatch->wsa__EndpointReference.ReferenceProperties = (struct wsa__ReferencePropertiesType*)soap_malloc(soap,sizeof(struct wsa__ReferencePropertiesType));  
  14.     ProbeMatches.ProbeMatch->wsa__EndpointReference.ReferenceParameters = (struct wsa__ReferenceParametersType*)soap_malloc(soap,sizeof(struct wsa__ReferenceParametersType));  
  15.     ProbeMatches.ProbeMatch->wsa__EndpointReference.ServiceName = (struct wsa__ServiceNameType*)soap_malloc(soap,sizeof(struct wsa__ServiceNameType));  
  16.     ProbeMatches.ProbeMatch->wsa__EndpointReference.PortType = (char **)soap_malloc(soap, sizeof(char *) * SMALL_INFO_LENGTH);  
  17.     ProbeMatches.ProbeMatch->wsa__EndpointReference.__any = (char **)soap_malloc(soap, sizeof(char*) * SMALL_INFO_LENGTH);  
  18.     ProbeMatches.ProbeMatch->wsa__EndpointReference.__anyAttribute = (char *)soap_malloc(soap, sizeof(char) * SMALL_INFO_LENGTH);  
  19.     ProbeMatches.ProbeMatch->wsa__EndpointReference.Address = (char *)soap_malloc(soap, sizeof(char) * INFO_LENGTH);  
  20.   
  21.     macaddr[0]=0x01;macaddr[1]=0x01;macaddr[2]=0x01;macaddr[3]=0x01;macaddr[4]=0x01;macaddr[5]=0x01;  
  22.     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]);  
  23.   
  24.     sprintf(_IPAddr, "http://%03d.%03d.%1d.%03d/onvif/device_service", 192, 168, 1, 233);  
  25.     ProbeMatches.__sizeProbeMatch = 1;  
  26.     ProbeMatches.ProbeMatch->Scopes->__item =(char *)soap_malloc(soap, 1024);  
  27.     memset(ProbeMatches.ProbeMatch->Scopes->__item,0,sizeof(ProbeMatches.ProbeMatch->Scopes->__item));    
  28.   
  29.     //Scopes MUST BE  
  30.     strcat(ProbeMatches.ProbeMatch->Scopes->__item, "onvif://www.onvif.org/type/NetworkVideoTransmitter");  
  31.   
  32.     ProbeMatches.ProbeMatch->Scopes->MatchBy = NULL;  
  33.     strcpy(ProbeMatches.ProbeMatch->XAddrs, _IPAddr);  
  34.     strcpy(ProbeMatches.ProbeMatch->Types, wsdd__Probe->Types);  
  35.     DBG("wsdd__Probe->Types=%s\n",wsdd__Probe->Types);  
  36.     ProbeMatches.ProbeMatch->MetadataVersion = 1;  
  37.     //ws-discovery規定 為可選項  
  38.     ProbeMatches.ProbeMatch->wsa__EndpointReference.ReferenceProperties->__size = 0;  
  39.     ProbeMatches.ProbeMatch->wsa__EndpointReference.ReferenceProperties->__any = NULL;  
  40.     ProbeMatches.ProbeMatch->wsa__EndpointReference.ReferenceParameters->__size = 0;  
  41.     ProbeMatches.ProbeMatch->wsa__EndpointReference.ReferenceParameters->__any = NULL;  
  42.       
  43.     ProbeMatches.ProbeMatch->wsa__EndpointReference.PortType[0] = (char *)soap_malloc(soap, sizeof(char) * SMALL_INFO_LENGTH);  
  44.     //ws-discovery規定 為可選項  
  45.     strcpy(ProbeMatches.ProbeMatch->wsa__EndpointReference.PortType[0], "ttl");  
  46.     ProbeMatches.ProbeMatch->wsa__EndpointReference.ServiceName->__item = NULL;  
  47.     ProbeMatches.ProbeMatch->wsa__EndpointReference.ServiceName->PortName = NULL;  
  48.     ProbeMatches.ProbeMatch->wsa__EndpointReference.ServiceName->__anyAttribute = NULL;  
  49.     ProbeMatches.ProbeMatch->wsa__EndpointReference.__any[0] = (char *)soap_malloc(soap, sizeof(char) * SMALL_INFO_LENGTH);  
  50.     strcpy(ProbeMatches.ProbeMatch->wsa__EndpointReference.__any[0], "Any");  
  51.     strcpy(ProbeMatches.ProbeMatch->wsa__EndpointReference.__anyAttribute, "Attribute");  
  52.     ProbeMatches.ProbeMatch->wsa__EndpointReference.__size = 0;  
  53.     strcpy(ProbeMatches.ProbeMatch->wsa__EndpointReference.Address, _HwId);  
  54.   
  55.     /*註釋的部分為可選，註釋掉onvif test也能發現ws-d*/  
  56.     //soap->header->wsa__To = "http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous";  
  57.     //soap->header->wsa__Action = "http://schemas.xmlsoap.org/ws/2005/04/discovery/ProbeMatches";  
  58.     soap->header->wsa__RelatesTo = (struct wsa__Relationship*)soap_malloc(soap, sizeof(struct wsa__Relationship));  
  59.     //it's here  
  60.     soap->header->wsa__RelatesTo->__item = soap->header->wsa__MessageID;  
  61.     soap->header->wsa__RelatesTo->RelationshipType = NULL;  
  62.     soap->header->wsa__RelatesTo->__anyAttribute = NULL;  
  63.   
  64.     soap->header->wsa__MessageID =(char *)soap_malloc(soap, sizeof(char) * INFO_LENGTH);  
  65.     strcpy(soap->header->wsa__MessageID,_HwId+4);  
  66.   
  67.     /* send over current socket as HTTP OK response: */  
  68.     /*測試過，第二引數必須http，action隨意*/  
  69.     soap_send___wsdd__ProbeMatches(soap, "http://", NULL, &ProbeMatches);  
  70.     return SOAP_OK;  
  71.   
  72. }  
想要寫出上述程式碼，是一定要了解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函式登場了

[cpp] view plaincopy
  1. int main()  
  2. {  
  3.     int server_udp;  
  4.       
  5.     int retval=0;  
  6.     struct soap *soap_udp;  
  7.     int fault_flag = 0;  
  8.       
  9.     server_udp = create_server_socket_udp();  
  10.     bind_server_udp1(server_udp);  
  11.     while(1){  
  12.         soap_udp=soap_new();  
  13.         soap_init1(soap_udp, SOAP_IO_UDP);  
  14.         soap_udp->master = server_udp;  
  15.         soap_udp->socket = server_udp;  
  16.         soap_udp->errmode = 0;  
  17.         soap_udp->bind_flags = 1;  
  18.         if (!soap_valid_socket(soap_bind(soap_udp, NULL, 3702, 100)))  
  19.         {      
  20.             soap_print_fault(soap_udp, stderr);  
  21.         }  
  22.         fprintf(stderr,"soap_serve starting..\n");  
  23.         retval = soap_serve(soap_udp); //阻塞在這裡  
  24.         fprintf(stderr,"retval=%d\n",retval);  
  25.         if(retval && !(fault_flag))  
  26.         {  
  27.             fault_flag = 1;  
  28.         }  
  29.         else if(!retval)  
  30.         {  
  31.             fault_flag = 0;  
  32.         }  
  33.         soap_destroy(soap_udp);  
  34.         soap_end(soap_udp);  
  35.         soap_done(soap_udp);  
  36.         free(soap_udp);  
  37.     }  
  38. }  
soap_server函式會一直阻塞，直到接收到SOAP訊息，並且該處理是一次性的，所以要將將soap_server放到while裡或者獨立的執行緒中。
最後編譯執行

make server

./discovery.tmp

單擊OnvifTestTool的Discover Devices，執行discovery.tmp的中會列印除錯資訊，如圖


然後，在OnvifTestTool中會搜尋到我的裝置


響應Discover Devices的SOAP訊息如下：

[html] view plaincopy
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <SOAP-ENV:Envelope   
  3.     xmlns:SOAP-ENV="http://www.w3.org/2003/05/soap-envelope"   
  4.     xmlns:SOAP-ENC="http://www.w3.org/2003/05/soap-encoding"   
  5.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"   
  6.     xmlns:xsd="http://www.w3.org/2001/XMLSchema"   
  7.     xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"   
  8.     xmlns:wsdd="http://schemas.xmlsoap.org/ws/2005/04/discovery"   
  9.     xmlns:ns1="http://www.onvif.org/ver10/network/wsdl/RemoteDiscoveryBinding"   
  10.     xmlns:ns2="http://www.onvif.org/ver10/network/wsdl/DiscoveryLookupBinding"   
  11.     xmlns:ns3="http://www.onvif.org/ver10/network/wsdl/DiscoveryLookupBinding"   
  12.     xmlns:tdn="http://www.onvif.org/ver10/network/wsdl">  
  13.   
  14.     <SOAP-ENV:Header>  
  15.         <wsa:MessageID>uuid:2419d68a-2dd2-21b2-a205-010101010101</wsa:MessageID>  
  16.         <wsa:RelatesTo>uuid:88a3958a-6155-4510-8279-69aeafd31681</wsa:RelatesTo>  
  17.         <wsa:To SOAP-ENV:mustUnderstand="true">urn:schemas-xmlsoap-org:ws:2005:04:discovery</wsa:To>  
  18.         <wsa:Action SOAP-ENV:mustUnderstand="true">http://schemas.xmlsoap.org/ws/2005/04/discovery/Probe</wsa:Action>  
  19.     </SOAP-ENV:Header>  
  20.   
  21.     <SOAP-ENV:Body>  
  22.         <wsdd:ProbeMatches>  
  23.             <wsdd:ProbeMatch xmlns:_0="http://www.onvif.org/ver10/device/wsdl">  
  24.                 <wsa:EndpointReference>  
  25.                 <wsa:Address>urn:uuid:2419d68a-2dd2-21b2-a205-010101010101</wsa:Address>  
  26.                 <wsa:ReferenceProperties></wsa:ReferenceProperties>  
  27.                 <wsa:ReferenceParameters></wsa:ReferenceParameters>  
  28.                 <wsa:PortType>ttl</wsa:PortType>  
  29.                 </wsa:EndpointReference>  
  30.                 <wsdd:Types>_0:Device</wsdd:Types>  
  31.                 <wsdd:Scopes>onvif://www.onvif.org/type/NetworkVideoTransmitter</wsdd:Scopes>  
  32.                 <wsdd:XAddrs>http://192.168.1.233/onvif/device_service</wsdd:XAddrs>  
  33.                 <wsdd:MetadataVersion>1</wsdd:MetadataVersion>  
  34.             </wsdd:ProbeMatch>  
  35.         </wsdd:ProbeMatches>  
  36.     </SOAP-ENV:Body>  
  37. </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測試工具網上有的，我就不上傳了。

相關文章