Added Workaround for WSDiscovery Bug (#49)

* Added exceptions to handle closing WSD properly * Moved wsd to class variable * Changed WSD to be singleton * Added docstring * Bumped version * Automatically reformatting code with black and isort * Added comments --------- Co-authored-by: Auto-format Bot <[email protected]>
groundlight · Jul 24, 2024 · 447f0aa · 447f0aa
1 parent 89a00b0
commit 447f0aa
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 18 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "framegrab"
-version = "0.6.0"
+version = "0.6.1"
 description = "Easily grab frames from cameras or streams"
 authors = ["Groundlight <[email protected]>"]
 license = "MIT"

diff --git a/src/framegrab/rtsp_discovery.py b/src/framegrab/rtsp_discovery.py
@@ -67,6 +67,21 @@ class ONVIFDeviceInfo(BaseModel):
 class RTSPDiscovery:
     """Simple RTSP camera discovery with ONVIF capabilities"""
 
+    _wsd_instance = None
+
+    @classmethod
+    def _get_wsd(cls):
+        """
+        Get the WSDiscovery instance, creating it if it doesn't exist.
+
+        Returns:
+        WSDiscovery: The WSDiscovery instance.
+        """
+
+        if cls._wsd_instance is None:
+            cls._wsd_instance = WSDiscovery()
+        return cls._wsd_instance
+
     @staticmethod
     def discover_onvif_devices(
         auto_discover_mode: AutodiscoverMode = AutodiscoverMode.ip_only,
@@ -95,24 +110,27 @@ def discover_onvif_devices(
             logger.debug("ONVIF device discovery disabled")
             return device_ips
 
-        wsd = WSDiscovery()
-        wsd.start()
-        types = [QName("http://www.onvif.org/ver10/network/wsdl", "NetworkVideoTransmitter")]
-        ret = wsd.searchServices(types=types)
-        for service in ret:
-            xaddr = service.getXAddrs()[0]
-            parsed_url = urllib.parse.urlparse(xaddr)
-            ip = parsed_url.hostname
-            port = parsed_url.port or 80  # Use the default port 80 if not specified
-
-            logger.debug(f"Found ONVIF service at {xaddr}")
-            device_ip = ONVIFDeviceInfo(ip=ip, port=port, username="", password="", xaddr=xaddr, rtsp_urls=[])
-
-            if auto_discover_mode is not AutodiscoverMode.ip_only:
-                RTSPDiscovery._try_logins(device=device_ip, auto_discover_mode=auto_discover_mode)
+        try:
+            wsd = RTSPDiscovery._get_wsd()
+            wsd.start()
+            types = [QName("http://www.onvif.org/ver10/network/wsdl", "NetworkVideoTransmitter")]
+            ret = wsd.searchServices(types=types)
+            for service in ret:
+                xaddr = service.getXAddrs()[0]
+                parsed_url = urllib.parse.urlparse(xaddr)
+                ip = parsed_url.hostname
+                port = parsed_url.port or 80  # Use the default port 80 if not specified
+
+                logger.debug(f"Found ONVIF service at {xaddr}")
+                device_ip = ONVIFDeviceInfo(ip=ip, port=port, username="", password="", xaddr=xaddr, rtsp_urls=[])
+
+                if auto_discover_mode is not AutodiscoverMode.ip_only:
+                    RTSPDiscovery._try_logins(device=device_ip, auto_discover_mode=auto_discover_mode)
+
+                device_ips.append(device_ip)
+        finally:
+            wsd.stop()  # This is supposed to clean up the threads but it doesn't seem to work, sock is still open after running this
 
-            device_ips.append(device_ip)
-        wsd.stop()
         return device_ips
 
     @staticmethod