Add RTSP video video streaming support

Adds support for streaming video from IP video sources over RTSP.

This work was sponsored by OIP Sensor Systems.

Signed-off-by: Thomas Vreys <thomas.vreys999@gmail.com>

Author: Thomas-Vreys

doc/configuration.rst

@@ -1387,6 +1387,21 @@ Arguments:
 Used by:
   - `HTTPVideoDriver`_
 
+RTSPVideoStream
+~~~~~~~~~~~~~~~
+An :any:`RTSPVideoStream` resource describes an IP video stream over RTSP.
+
+.. code-block:: yaml
+
+   RTSPVideoStream:
+     url: 'rtsp://192.168.110.11/stream1'
+
+Arguments:
+  - url (str): URI of the IP video stream
+
+Used by:
+  - `RTSPVideoDriver`_
+
 USBHub
 ~~~~~~
 
@@ -3448,6 +3463,25 @@ Although the driver can be used from Python code by calling the ``stream()``
 method, it is currently mainly useful for the ``video`` subcommand of
 ``labgrid-client``.
 
+RTSPVideoDriver
+~~~~~~~~~~~~~~~
+The :any:`RTSPVideoDriver` is used to show a video stream over RTSP
+from a remote IP video source in a local window.
+
+Binds to:
+  video:
+    - `RTSPVideoStream`_
+
+Implements:
+  - :any:`VideoProtocol`
+
+Arguments:
+  - latency (int, default=100): rtspsrc jitterbuffer size in milliseconds
+
+Although the driver can be used from Python code by calling the ``stream()``
+method, it is currently mainly useful for the ``video`` subcommand of
+``labgrid-client``.
+
 ========== =========================================================
 Key        Description
 ========== =========================================================

labgrid/driver/__init__.py

@@ -40,6 +40,7 @@
 from .usbaudiodriver import USBAudioInputDriver
 from .usbvideodriver import USBVideoDriver
 from .httpvideodriver import HTTPVideoDriver
+from .rtspvideodriver import RTSPVideoDriver
 from .networkinterfacedriver import NetworkInterfaceDriver
 from .provider import HTTPProviderDriver, NFSProviderDriver, TFTPProviderDriver
 from .rawnetworkinterfacedriver import RawNetworkInterfaceDriver

labgrid/driver/rtspvideodriver.py

@@ -0,0 +1,45 @@
+import subprocess
+import sys
+from urllib.parse import urlsplit
+
+import attr
+
+from .common import Driver
+from ..factory import target_factory
+from ..util.proxy import proxymanager
+from ..protocol import VideoProtocol
+
+
+@target_factory.reg_driver
+@attr.s(eq=False)
+class RTSPVideoDriver(Driver, VideoProtocol):
+    bindings = {
+        "video": "RTSPVideoStream",
+    }
+
+    latency = attr.ib(default=100, validator=attr.validators.instance_of(int))
+
+    @Driver.check_active
+    def stream(self, quality_hint=None, controls=None):
+        s = urlsplit(self.video.url)
+        if s.scheme != "rtsp":
+            print(f"Unknown scheme: {s.scheme}", file=sys.stderr)
+            return
+
+        url = proxymanager.get_url(self.video.url, default_port=554)
+        pipeline = [
+            "gst-launch-1.0",
+            "rtspsrc",
+            f"location={url}",
+            f"latency={self.latency}",
+            "!",
+            "decodebin",
+            "!",
+            "autovideoconvert",
+            "!",
+            "autovideosink",
+            "sync=false",
+        ]
+
+        sub = subprocess.run(pipeline)
+        return sub.returncode

labgrid/remote/client.py

@@ -1373,6 +1373,7 @@ def video(self):
         target = self._get_target(place)
         name = self.args.name
         from ..resource.httpvideostream import HTTPVideoStream
+        from ..resource.rtspvideostream import RTSPVideoStream
         from ..resource.udev import USBVideo
         from ..resource.remote import NetworkUSBVideo
 
@@ -1387,6 +1388,8 @@ def video(self):
                     drv = self._get_driver_or_new(target, "USBVideoDriver", name=name)
                 elif isinstance(resource, HTTPVideoStream):
                     drv = self._get_driver_or_new(target, "HTTPVideoDriver", name=name)
+                elif isinstance(resource, RTSPVideoStream):
+                    drv = self._get_driver_or_new(target, "RTSPVideoDriver", name=name)
                 if drv:
                     break
         if not drv:

labgrid/remote/exporter.py

@@ -749,6 +749,24 @@ def _get_params(self):
 exports["HTTPVideoStream"] = HTTPVideoStreamExport
 
 
+@attr.s
+class RTSPVideoStreamExport(ResourceExport):
+    """ResourceExport for an RTSPVideoStream"""
+
+    def __attrs_post_init__(self):
+        super().__attrs_post_init__()
+        from ..resource.rtspvideostream import RTSPVideoStream
+
+        self.data["cls"] = "RTSPVideoStream"
+        self.local = RTSPVideoStream(target=None, name=None, **self.local_params)
+
+    def _get_params(self):
+        return self.local_params
+
+
+exports["RTSPVideoStream"] = RTSPVideoStreamExport
+
+
 @attr.s(eq=False)
 class LXAIOBusNodeExport(ResourceExport):
     """ResourceExport for LXAIOBusNode devices accessed via the HTTP API"""

labgrid/resource/__init__.py

@@ -44,6 +44,7 @@
 from .provider import TFTPProvider, NFSProvider, HTTPProvider
 from .mqtt import TasmotaPowerPort
 from .httpvideostream import HTTPVideoStream
+from .rtspvideostream import RTSPVideoStream
 from .dediprogflasher import DediprogFlasher, NetworkDediprogFlasher
 from .httpdigitalout import HttpDigitalOutput
 from .sigrok import SigrokDevice

labgrid/resource/rtspvideostream.py

@@ -0,0 +1,10 @@
+import attr
+
+from ..factory import target_factory
+from .common import Resource
+
+
+@target_factory.reg_resource
+@attr.s(eq=False)
+class RTSPVideoStream(Resource):
+    url = attr.ib(validator=attr.validators.instance_of(str))

tests/test_rtspvideo.py

@@ -0,0 +1,19 @@
+from labgrid.resource.rtspvideostream import RTSPVideoStream
+from labgrid.driver.rtspvideodriver import RTSPVideoDriver
+
+
+def test_ipvideo_create_rtsp(target):
+    r = RTSPVideoStream(target, name=None, url="rtsp://localhost/stream1")
+    d = RTSPVideoDriver(target, name=None)
+    assert isinstance(d, RTSPVideoDriver)
+
+def test_ipvideo_create_with_port(target):
+    r = RTSPVideoStream(target, name=None, url="rtsp://localhost:8554/stream1")
+    d = RTSPVideoDriver(target, name=None)
+    assert isinstance(d, RTSPVideoDriver)
+
+def test_ipvideo_create_with_latency(target):
+    r = RTSPVideoStream(target, name=None, url="rtsp://localhost/stream1")
+    d = RTSPVideoDriver(target, name=None, latency=500)
+    assert isinstance(d, RTSPVideoDriver)
+    assert d.latency == 500