python-aidot-cameras 0.15.5__tar.gz → 0.15.6__tar.gz

{python_aidot_cameras-0.15.5/python_aidot_cameras.egg-info → python_aidot_cameras-0.15.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-aidot-cameras
-Version: 0.15.5
+Version: 0.15.6
 Summary: Control AiDot/Leedarson WiFi lights and cameras (WebRTC streaming, two-way audio, PTZ, controls)
 Author-email: cbrightly <chris.brightly@gmail.com>
 License-Expression: MIT

{python_aidot_cameras-0.15.5 → python_aidot_cameras-0.15.6}/aidot_cameras/camera/sdes_open.py

@@ -39,6 +39,41 @@ from .protocol import (
 _LOGGER = logging.getLogger(__name__)
 
 
+#: What we ask the kernel for on a media receive socket.  The kernel clamps to
+#: ``net.core.rmem_max`` (4 MB on Home Assistant OS), and doubles what it grants
+#: for bookkeeping, so asking for more than the cap is harmless.
+_MEDIA_RCVBUF_BYTES = 4 * 1024 * 1024
+
+
+def _widen_media_rcvbuf(sock, kind: str, device_id: str = "?") -> int:
+    """Ask for a large receive buffer on a camera media socket.
+
+    These sockets ran on the OS default, which is 208 KB on Home Assistant OS.
+    A keyframe from an A001064 is 146-190 KB and arrives as one burst of ~130
+    packets, so a single keyframe nearly fills that buffer: any delay in the
+    reader - the GIL while another camera's bridge runs, an ffmpeg write
+    blocking - and the kernel drops the tail of the burst.  ffmpeg then reports
+    ``RTP: missed N packets`` and backs up its input queue.
+
+    Returns the buffer the kernel actually granted (it reports double what it
+    reserves), or 0 if the option could not be set.  Best-effort by design: a
+    platform that refuses the option must not stop a camera from streaming.
+    """
+    try:
+        import socket as _sock_rb
+
+        sock.setsockopt(_sock_rb.SOL_SOCKET, _sock_rb.SO_RCVBUF,
+                        _MEDIA_RCVBUF_BYTES)
+        got = sock.getsockopt(_sock_rb.SOL_SOCKET, _sock_rb.SO_RCVBUF)
+    except Exception:
+        _LOGGER.debug("camera %s: could not widen the %s receive buffer",
+                      device_id, kind, exc_info=True)
+        return 0
+    _LOGGER.debug("camera %s: %s receive buffer %d bytes (asked %d)",
+                  device_id, kind, got, _MEDIA_RCVBUF_BYTES)
+    return got
+
+
 def _start_serve_stderr_drain(proc, *, maxlines: int = 40) -> None:
     """Drain a serve ffmpeg's stderr continuously into a bounded tail on the proc.
 
@@ -529,11 +564,13 @@ class _SdesOpenMixin:
         import socket as _socket
 
         _audio_sock = _socket.socket(_socket.AF_INET, _socket.SOCK_DGRAM)
+        _widen_media_rcvbuf(_audio_sock, "audio", getattr(self, "device_id", "?"))
         _audio_sock.bind(("0.0.0.0", 0))
         audio_port = _audio_sock.getsockname()[1]
         _cl(_audio_sock.close)   # also unblocks the bridge thread's recv on cleanup
 
         _video_sock = _socket.socket(_socket.AF_INET, _socket.SOCK_DGRAM)
+        _widen_media_rcvbuf(_video_sock, "video", getattr(self, "device_id", "?"))
         _video_sock.bind(("0.0.0.0", 0))
         video_port = _video_sock.getsockname()[1]
         _cl(_video_sock.close)

{python_aidot_cameras-0.15.5 → python_aidot_cameras-0.15.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-aidot-cameras"
-version = "0.15.5"
+version = "0.15.6"
 description = "Control AiDot/Leedarson WiFi lights and cameras (WebRTC streaming, two-way audio, PTZ, controls)"
 readme = "README.md"
 license = "MIT"

{python_aidot_cameras-0.15.5 → python_aidot_cameras-0.15.6/python_aidot_cameras.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-aidot-cameras
-Version: 0.15.5
+Version: 0.15.6
 Summary: Control AiDot/Leedarson WiFi lights and cameras (WebRTC streaming, two-way audio, PTZ, controls)
 Author-email: cbrightly <chris.brightly@gmail.com>
 License-Expression: MIT

{python_aidot_cameras-0.15.5 → python_aidot_cameras-0.15.6}/python_aidot_cameras.egg-info/SOURCES.txt

@@ -109,6 +109,7 @@ tests/test_light_active_color_mode.py
 tests/test_live_stream_param.py
 tests/test_live_validate_policy.py
 tests/test_logging_caps.py
+tests/test_media_socket_rcvbuf.py
 tests/test_media_wait_floor.py
 tests/test_motion_poll.py
 tests/test_mqtt_credential_refetch.py

python_aidot_cameras-0.15.6/tests/test_media_socket_rcvbuf.py

@@ -0,0 +1,69 @@
+"""Camera media sockets must ask for a receive buffer big enough for a keyframe.
+
+These sockets ran on the OS default - 208 KB on Home Assistant OS. An A001064
+keyframe is 146-190 KB delivered as one burst of ~130 packets, so a single
+keyframe nearly fills that buffer. Any delay in the reader (the GIL while
+another camera's bridge runs, an ffmpeg write blocking) and the kernel drops the
+tail of the burst, which ffmpeg reports as ``RTP: missed N packets`` while its
+input queue backs up. The box carried 44.3 million ``RcvbufErrors`` against
+161 million datagrams received over four days, and every UDP receive error on it
+was a buffer overflow rather than a checksum or port error.
+"""
+import socket
+
+from aidot_cameras.camera.sdes_open import (
+    _MEDIA_RCVBUF_BYTES,
+    _widen_media_rcvbuf,
+)
+
+
+def test_the_request_clears_a_keyframe_burst():
+    # 190 KB is the largest keyframe measured on the A001064; the request has to
+    # leave room for that plus scheduling jitter, not merely match it.
+    assert _MEDIA_RCVBUF_BYTES >= 8 * 190 * 1024
+
+
+def test_a_real_socket_gets_more_than_the_os_default():
+    sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+    try:
+        default = sock.getsockopt(socket.SOL_SOCKET, socket.SO_RCVBUF)
+        got = _widen_media_rcvbuf(sock, "video", "dev-abc")
+        assert got > 0, "the option was not set at all"
+        # Kernels clamp to rmem_max and report double what they reserve, so the
+        # exact number is not assertable - only that it grew, and that it now
+        # clears one keyframe.
+        assert got >= default
+        assert got >= 190 * 1024, f"granted {got} bytes, under one keyframe"
+    finally:
+        sock.close()
+
+
+def test_failure_is_survivable():
+    """A platform that refuses the option must not stop a camera streaming."""
+
+    class _Refuses:
+        def setsockopt(self, *_a):
+            raise OSError("nope")
+
+        def getsockopt(self, *_a):
+            raise OSError("nope")
+
+    assert _widen_media_rcvbuf(_Refuses(), "audio", "dev-abc") == 0
+
+
+def test_both_media_sockets_are_widened_before_bind():
+    """Pin the call sites: a socket widened after bind may already have dropped.
+
+    The open path is one long method that cannot be called in isolation, so
+    assert on its source - both the audio and video sockets must be widened, and
+    each before its own bind.
+    """
+    import inspect
+
+    from aidot_cameras.camera import sdes_open
+
+    src = inspect.getsource(sdes_open)
+    for kind in ("_audio_sock", "_video_sock"):
+        widen = src.index(f"_widen_media_rcvbuf({kind}")
+        bind = src.index(f"{kind}.bind(")
+        assert widen < bind, f"{kind} is bound before its receive buffer is set"