1.背景知识
这个事项对我而言是个新知,我从:https://www.cnblogs.com/liwen01/p/17337916.html
跳转到了:ONVIF协议网络摄像机(IPC)客户端程序开发(1):专栏开篇_onvif 许振坪-CSDN博客
1.1 ONVIF协议的分类:
Profile S:「网络摄像机」的技术规格,包括如何发送音视频流,音视频编码器配置,PTZ控制、中继控制等。
Profile C:「门禁控制系统(PACS)设备」的技术规格。
Profile G:「视频储存和录像」的技术规格,包括视频储存,搜索,检索,以及媒体播放功能的技术规格。
Profile A:「常见的例行门禁控制功能」的技术规范,适用于负责授予和撤销员工凭证、创建和更新计划表,以及对系统内门禁控制权限进行更改的安保人员、接待员或人力资源专员等用户。
Profile Q:「传输层安全性(TLS)」的技术规格,该安全通信协议使ONVIF合标设备能够以不受篡改和窃听威胁的方式在网络上与客户通讯。
S是等级最低的,在它之前似乎还有个T。这里是S的协议文档
然后我看到的文档里推荐下载这个:https://download.csdn.net/download/benkaoya/9818513
大概是中文版。
2 可能利用的三方代码
2.1 实现:
作者推荐使用gSoap工具来提供ONVIF协议的解析。
而chatgpt的推荐是使用客户端工具,阅读源码来反向构建其服务程序:
-
onvif-py
:- 这个库有一个模块化结构,可以用来创建一个支持 ONVIF 协议的服务端。但它主要是作为一个 ONVIF 客户端库,因此你需要阅读源代码来了解如何使用它来创建服务端。这需要一定的编程知识。
-
onvif_zm
(用于 ZoneMinder):- 这个库原本是为 ZoneMinder 设计的,用于实现与 ONVIF 设备的通讯。虽然它是作为客户端库,但了解其工作原理后,你可以参考其代码来构建服务端。
-
onvif.server
:- 这个库是 ONVIF 服务器的一个实现,它支持标准的 ONVIF 服务如 Discovery、Device、Media、PTZ、Event 等。这个库提供了创建和管理 ONVIF 服务器所需的所有基本功能。
2.2 可能的原生代码支持:
2.2.1 gstreamer
https://gstreamer.freedesktop.org/documentation/gst-rtsp-server/rtsp-onvif-server.html?gi-language=c
我大概知道ONVIF的服务端涉及两个端口:
- 摄像头发现端口:udp 239.255.255.250:3702
- ONVIF协议侦听端口。
大概率gstreamer能搞定后一个。前一个是个udp端口
2.2.2 一个可能使用的完整服务端封装:
基于ONVIF协议,实现 网络摄像机 设备发现 功能: 基于ONVIF协议,实现 网络摄像机 设备发现 功能 (gitee.com)
3. 测试
3.1 设备发现代码(In Python)
参阅:https://blog.csdn.net/benkaoya/article/details/72476120
多播地址(Multicast Address)有很多,各个行业都不一样,IPC摄像头用的是239.255.255.250(端口3702)。多播地址的范围和分类可以见官方IANA(互联网地址分配机构)的说明:IPv4 Multicast Address Space Registry。
import socket
import struct
# 组播地址和端口
MULTICAST_GROUP = '239.255.255.250'
PORT = 3702
UDP_LOCAL_PORT = 1975 #本地接口不可以是组播端口3702
def discover_onvif_devices():
# 创建一个 UDP 套接字
sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM, socket.IPPROTO_UDP)
# 设置多播 TTL
TTL = 2
sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, TTL) #TTL 生存时间
# 允许重用地址
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
# 绑定到本地端口
sock.bind(('', UDP_LOCAL_PORT ))
# 禁用组播环回
sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_LOOP, 0)
# 加入组播组
mreq = struct.pack("4sl", socket.inet_aton(MULTICAST_GROUP), socket.INADDR_ANY)
sock.setsockopt(socket.IPPROTO_IP, socket.IP_ADD_MEMBERSHIP, mreq)
is_SendSSDP_request = False
# 构造 SSDP 请求
ssdp_request ='<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing"><s:Header><a:Action s:mustUnderstand="1">http://schemas.xmlsoap.org/ws/2005/04/discovery/Probe</a:Action><a:MessageID>uuid:2fe59dad-ae6e-47f2-9b3c-5caba35ad4fc</a:MessageID><a:ReplyTo><a:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo><a:To s:mustUnderstand="1">urn:schemas-xmlsoap-org:ws:2005:04:discovery</a:To></s:Header><s:Body><Probe xmlns="http://schemas.xmlsoap.org/ws/2005/04/discovery"><d:Types xmlns:d="http://schemas.xmlsoap.org/ws/2005/04/discovery" xmlns:dp0="http://www.onvif.org/ver10/network/wsdl">dp0:NetworkVideoTransmitter</d:Types></Probe></s:Body></s:Envelope>'
# 发送请求到多播地址
sock.sendto(ssdp_request.encode(), (MULTICAST_GROUP , PORT))
while True:
try:
# 设置接收超时时间
sock.settimeout(3.0)
# 接收响应
response, _ = sock.recvfrom(4096)
print(f'Received response:\n{response.decode()}')
except socket.timeout:
if(is_SendSSDP_request):
break;
else:
sock.sendto(ssdp_request.encode(), (MULTICAST_GROUP , PORT))
# 退出组播组
sock.setsockopt(socket.IPPROTO_IP, socket.IP_DROP_MEMBERSHIP, mreq)
# 关闭套接字
sock.close()
if __name__ == "__main__":
discover_onvif_devices()
3.1.1 运行效果:
下面是局域网的一个开通了ONVIF协议的摄像头在收到设备发现组播帧的回执:
Received response:
<?xml version="1.0" encoding="UTF-8"?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:soapenc="http://www.w3.org/2003/05/soap-encoding" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tt="http://www.onvif.org/ver10/schema" xmlns:tds="http://www.onvif.org/ver10/device/wsdl" xmlns:trt="http://www.onvif.org/ver10/media/wsdl" xmlns:timg="http://www.onvif.org/ver20/imaging/wsdl" xmlns:tev="http://www.onvif.org/ver10/events/wsdl" xmlns:tptz="http://www.onvif.org/ver20/ptz/wsdl" xmlns:tan="http://www.onvif.org/ver20/analytics/wsdl" xmlns:tst="http://www.onvif.org/ver10/storage/wsdl" xmlns:ter="http://www.onvif.org/ver10/error" xmlns:dn="http://www.onvif.org/ver10/network/wsdl" xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tmd="http://www.onvif.org/ver10/deviceIO/wsdl" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl" xmlns:wsoap12="http://schemas.xmlsoap.org/wsdl/soap12" xmlns:http="http://schemas.xmlsoap.org/wsdl/http" xmlns:d="http://schemas.xmlsoap.org/ws/2005/04/discovery" xmlns:wsadis="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:wstop="http://docs.oasis-open.org/wsn/t-1" xmlns:wsrf-bf="http://docs.oasis-open.org/wsrf/bf-2" xmlns:wsntw="http://docs.oasis-open.org/wsn/bw-2" xmlns:wsrf-rw="http://docs.oasis-open.org/wsrf/rw-2" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl" xmlns:wsrf-r="http://docs.oasis-open.org/wsrf/r-2" xmlns:trc="http://www.onvif.org/ver10/recording/wsdl" xmlns:tse="http://www.onvif.org/ver10/search/wsdl" xmlns:trp="http://www.onvif.org/ver10/replay/wsdl" xmlns:tnshik="http://www.hikvision.com/2011/event/topics" xmlns:hikwsd="http://www.onvifext.com/onvif/ext/ver10/wsdl" xmlns:hikxsd="http://www.onvifext.com/onvif/ext/ver10/schema" xmlns:tas="http://www.onvif.org/ver10/advancedsecurity/wsdl" xmlns:tr2="http://www.onvif.org/ver20/media/wsdl" xmlns:axt="http://www.onvif.org/ver20/analytics"><env:Header><wsadis:MessageID>urn:uuid:4e774000-6f8b-11b2-8068-240f9bbadc0c</wsadis:MessageID>
<wsadis:RelatesTo>uuid:2fe59dad-ae6e-47f2-9b3c-5caba35ad4fc</wsadis:RelatesTo>
<wsadis:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsadis:To>
<wsadis:Action>http://schemas.xmlsoap.org/ws/2005/04/discovery/ProbeMatches</wsadis:Action>
<d:AppSequence InstanceId="1722420540" MessageNumber="1220"/>
</env:Header>
<env:Body><d:ProbeMatches><d:ProbeMatch><wsadis:EndpointReference><wsadis:Address>urn:uuid:4e774000-6f8b-11b2-8068-240f9bbadc0c</wsadis:Address>
</wsadis:EndpointReference>
<d:Types>dn:NetworkVideoTransmitter tds:Device</d:Types>
<d:Scopes>onvif://www.onvif.org/type/video_encoder onvif://www.onvif.org/Profile/Streaming onvif://www.onvif.org/Profile/T onvif://www.onvif.org/MAC/24:0f:9b:ba:dc:0c onvif://www.onvif.org/hardware/DS-2CD3T25D-I3 onvif://www.onvif.org/name/HIKVISION%20DS-2CD3T25D-I3 onvif://www.onvif.org/location/city/hangzhou</d:Scopes>
<d:XAddrs>http://192.168.0.6/onvif/device_service http://[240e:33d:17:6a0:260f:9bff:feba:dc0c]/onvif/device_service</d:XAddrs>
<d:MetadataVersion>10</d:MetadataVersion>
</d:ProbeMatch>
</d:ProbeMatches>
</env:Body>
</env:Envelope>
3.2 使用网络调试助手进行设备发现
3.2.1 步骤清单
- 网络调试助手设定UDP协议,地址设定为局域网IP(与摄像头同网段),PORT任意。
- 打开
- 右下角选择组播,然后加入ONVIF路由发现组播地址:
- 给组播地址239.255.255.250:3702端口发送一个查询帧,内容:
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://schemas.xmlsoap.org/ws/2004/08/addressing"><s:Header><a:Action s:mustUnderstand="1">http://schemas.xmlsoap.org/ws/2005/04/discovery/Probe</a:Action><a:MessageID>uuid:2fe59dad-ae6e-47f2-9b3c-5caba35ad4fc</a:MessageID><a:ReplyTo><a:Address>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</a:Address></a:ReplyTo><a:To s:mustUnderstand="1">urn:schemas-xmlsoap-org:ws:2005:04:discovery</a:To></s:Header><s:Body><Probe xmlns="http://schemas.xmlsoap.org/ws/2005/04/discovery"><d:Types xmlns:d="http://schemas.xmlsoap.org/ws/2005/04/discovery" xmlns:dp0="http://www.onvif.org/ver10/network/wsdl">dp0:NetworkVideoTransmitter</d:Types></Probe></s:Body></s:Envelope> - 你会收到局域网内的所有设备以自己的私有IP发来的回应帧。暴露自己的基础访问参数。
3.3 找到设备对外视频接口
下面使用3.1、3.2得到的某一个设备的onvif soap接口,比如:http://192.168.0.6/onvif/device_service
,尝试获取它的在线视频地址:
3.3.1 Python代码初次尝试
为了收发soap消息,使用asyncio做 soap请求异步收发:
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# 获取当前脚本文件所在目录的父目录,并构建相对路径
import os
import sys
current_dir = os.path.dirname(os.path.abspath(__file__))
project_path = os.path.join(current_dir, '..')
sys.path.append(project_path)
sys.path.append(current_dir)
import aiohttp
import asyncio
async def get_stream_uri():
url = 'http://192.168.0.6/onvif/device_service'
soap_message = '''<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:trt="http://www.onvif.org/ver10/media/wsdl">
<soap:Header/>
<soap:Body>
<trt:GetStreamUri>
<trt:StreamSetup>
<trt:Stream>RTP-Unicast</trt:Stream>
<trt:Transport>
<trt:Protocol>UDP</trt:Protocol>
</trt:Transport>
</trt:StreamSetup>
<trt:ProfileToken>PROFILE_TOKEN</trt:ProfileToken>
</trt:GetStreamUri>
</soap:Body>
</soap:Envelope>'''
async with aiohttp.ClientSession() as session:
async with session.post(url, data=soap_message, headers={'Content-Type': 'application/soap+xml'}) as response:
result = await response.text()
print(result)
if __name__ == "__main__":
# 运行异步函数
asyncio.run(get_stream_uri())
3.3.1.1 结果:
python3 ./gpONVIF.py
<!DOCTYPE html>
<html><head><title>Document Error: Unauthorized</title></head>
<body><h2>Access Error: 401 -- Unauthorized</h2>
<p>Authentication Error: This onvif request requires authentication information</p>
</body>
</html>
3.3.2 使用身份认证信息再次查询设备对外视频接口
这里使用httpx来处理digest+ws-username auth.
soap封装的xml消息,使用xml.etree来解析。
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# 获取当前脚本文件所在目录的父目录,并构建相对路径
import os
import sys
current_dir = os.path.dirname(os.path.abspath(__file__))
project_path = os.path.join(current_dir, '..')
sys.path.append(project_path)
sys.path.append(current_dir)
import asyncio
import aiohttp
import xml.etree.ElementTree as ET
from httpx import AsyncClient, DigestAuth
import httpx
# ONVIF 设备服务 URL
device_service_url = 'http://192.168.0.6/onvif/device_service'
username = 'admin'
password = 'xxxxxxxxxx'
async def get_device_information(session, url):
headers = {'Content-Type': 'application/soap+xml'}
body = """<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:tds="http://www.onvif.org/ver10/device/wsdl">
<s:Header/>
<s:Body>
<tds:GetServices>
<tds:IncludeCapability>false</tds:IncludeCapability>
</tds:GetServices>
</s:Body>
</s:Envelope>"""
try:
response = httpx.post(url, headers=headers, data=body, auth=DigestAuth(username, password))
return response.text
except Exception as e:
print(f'An error occurred: {e}')
return None
def parse_media_service_url(device_response):
media_service_url = None
root = ET.fromstring(device_response)
ns = {'soap': 'http://www.w3.org/2003/05/soap-envelope', 'tds': 'http://www.onvif.org/ver10/device/wsdl'}
services = root.find('.//tds:GetServicesResponse', namespaces=ns)
#print(services)
# 查找 <tds:XAddr> 元素
for s in services:
ns1 = s.find('.//tds:Namespace', namespaces=ns)
#print('........ns................',ns1)
if(ns1 is not None):
if('media' in ns1.text):
addr = s.find('.//tds:XAddr', namespaces = ns)
if(addr is not None):
#print('........addr................',addr)
media_service_url = addr.text
return media_service_url
async def get_video_stream_url(session, media_service_url):
headers = {'Content-Type': 'application/soap+xml'}
body = """<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:trt="http://www.onvif.org/ver10/media/wsdl">
<s:Header/>
<s:Body>
<trt:GetStreamUri>
<trt:StreamSetup>
<trt:Stream>RTP-Unicast</trt:Stream>
<trt:Transport>
<trt:Protocol>RTSP</trt:Protocol>
</trt:Transport>
</trt:StreamSetup>
<trt:ProfileToken>ProfileToken</trt:ProfileToken>
</trt:GetStreamUri>
</s:Body>
</s:Envelope>"""
try:
response = httpx.post(media_service_url, headers=headers, data=body, auth=DigestAuth(username, password))
return response.text
except Exception as e:
print(f'An error occurred: {e}')
return None
def parse_video_stream_url(media_response):
root = ET.fromstring(media_response)
ns = {'soap': 'http://www.w3.org/2003/05/soap-envelope', 'trt': 'http://www.onvif.org/ver10/media/wsdl'}
uri = root.find('.//trt:GetStreamUriResponse/trt:MediaUri', namespaces=ns)
if uri is not None:
return uri.text
return None
async def main():
async with httpx.AsyncClient() as session:
device_response = await get_device_information(session, device_service_url)
#print(device_response)
print('>>>>>>>>>>>>>>>>>>>>>>>>>>>')
media_service_url = parse_media_service_url(device_response)
print(media_service_url)
if media_service_url:
media_response = await get_video_stream_url(session, media_service_url)
print(media_response)
video_stream_url = parse_video_stream_url(media_response)
print("Video Stream URL:", video_stream_url)
else:
print("Media service URL not found")
# 运行异步主函数
if __name__ == '__main__':
asyncio.run(main())
3.3.2.1 结果:
似乎找错了服务接口,现在已经很接近了。对吧?
http://192.168.0.6/onvif/Media2
<?xml version="1.0" encoding="UTF-8"?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:soapenc="http://www.w3.org/2003/05/soap-encoding" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tt="http://www.onvif.org/ver10/schema" xmlns:tds="http://www.onvif.org/ver10/device/wsdl" xmlns:trt="http://www.onvif.org/ver10/media/wsdl" xmlns:timg="http://www.onvif.org/ver20/imaging/wsdl" xmlns:tev="http://www.onvif.org/ver10/events/wsdl" xmlns:tptz="http://www.onvif.org/ver20/ptz/wsdl" xmlns:tan="http://www.onvif.org/ver20/analytics/wsdl" xmlns:tst="http://www.onvif.org/ver10/storage/wsdl" xmlns:ter="http://www.onvif.org/ver10/error" xmlns:dn="http://www.onvif.org/ver10/network/wsdl" xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tmd="http://www.onvif.org/ver10/deviceIO/wsdl" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl" xmlns:wsoap12="http://schemas.xmlsoap.org/wsdl/soap12" xmlns:http="http://schemas.xmlsoap.org/wsdl/http" xmlns:d="http://schemas.xmlsoap.org/ws/2005/04/discovery" xmlns:wsadis="http://schemas.xmlsoap.org/ws/2004/08/addressing" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:wstop="http://docs.oasis-open.org/wsn/t-1" xmlns:wsrf-bf="http://docs.oasis-open.org/wsrf/bf-2" xmlns:wsntw="http://docs.oasis-open.org/wsn/bw-2" xmlns:wsrf-rw="http://docs.oasis-open.org/wsrf/rw-2" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl" xmlns:wsrf-r="http://docs.oasis-open.org/wsrf/r-2" xmlns:trc="http://www.onvif.org/ver10/recording/wsdl" xmlns:tse="http://www.onvif.org/ver10/search/wsdl" xmlns:trp="http://www.onvif.org/ver10/replay/wsdl" xmlns:tnshik="http://www.hikvision.com/2011/event/topics" xmlns:hikwsd="http://www.onvifext.com/onvif/ext/ver10/wsdl" xmlns:hikxsd="http://www.onvifext.com/onvif/ext/ver10/schema" xmlns:tas="http://www.onvif.org/ver10/advancedsecurity/wsdl" xmlns:tr2="http://www.onvif.org/ver20/media/wsdl" xmlns:axt="http://www.onvif.org/ver20/analytics"><env:Body><env:Fault><env:Code><env:Value>env:Sender</env:Value>
<env:Subcode><env:Value>ter:InvalidArgVal</env:Value>
<env:Subcode><env:Value>ter:NoProfile</env:Value>
</env:Subcode>
</env:Subcode>
</env:Code>
<env:Reason><env:Text xml:lang="en">The requested profile token ProfileToken does not exist.</env:Text>
</env:Reason>
<env:Node>http://www.w3.org/2003/05/soap-envelope/node/ultimateReceiver</env:Node>
<env:Role>http://www.w3.org/2003/05/soap-envelope/role/ultimateReceiver</env:Role>
<env:Detail><env:Text>No Such ProfileToken</env:Text>
</env:Detail>
</env:Fault>
</env:Body>
</env:Envelope>Video Stream URL: None
4.FAQ
4.1 什么是gSoap?
gSOAP 是一个开源的 C 语言库,用于开发 Web 服务和客户端。它简化了 SOAP(Simple Object Access Protocol)和 XML 相关的通信,使得在 C 语言应用程序中实现 Web 服务变得更容易。gSOAP 提供了自动化的工具来生成 C 语言的客户端和服务器端代码,从而支持 Web 服务的创建和消费。
以下是 gSOAP 的一些关键特点:
-
SOAP 支持:gSOAP 实现了 SOAP 1.1 和 SOAP 1.2 协议,使得开发人员可以通过简单的接口来创建和解析 SOAP 消息。
-
WSDL 支持:gSOAP 可以从 WSDL(Web Services Description Language)文件自动生成 C 语言代码,简化了 Web 服务的客户端和服务器端的开发。
-
轻量级:gSOAP 设计为一个轻量级库,适合嵌入式和资源有限的环境。
-
高效:gSOAP 具有高效的解析和序列化功能,可以处理大量的数据交换。
-
灵活性:它支持多种数据格式,包括 XML 和 JSON。
-
跨平台:gSOAP 是跨平台的,可以在多种操作系统上使用,包括 Windows、Linux 和 macOS。
-
XML 和 JSON 处理:除了 SOAP,gSOAP 还提供对 XML 和 JSON 数据格式的处理支持。
使用 gSOAP,可以快速地将现有的 C 语言应用程序与 Web 服务集成,实现分布式计算和数据交换。
附录A 测试工具 ODM
原始链接:ODM download | SourceForge.net
A.1 摄像头ONVIF协议使能
测试时可能需要参考一些既有的摄像头的功能实现。注意支持ONVIF的摄像头默认一般不自动打开这个功能,需要先在摄像头的控制界面配置。ONVIF的中文名称是:开放型网络视频接口