homesec 1.2.1__py3-none-any.whl → 1.2.2__py3-none-any.whl

homesec/sources/rtsp/recorder.py

@@ -0,0 +1,180 @@
+from __future__ import annotations
+
+import logging
+import subprocess
+from pathlib import Path
+from typing import Protocol
+
+from homesec.sources.rtsp.clock import Clock
+from homesec.sources.rtsp.utils import _format_cmd, _is_timeout_option_error, _redact_rtsp_url
+
+logger = logging.getLogger(__name__)
+
+
+class Recorder(Protocol):
+    def start(self, output_file: Path, stderr_log: Path) -> subprocess.Popen[bytes] | None: ...
+
+    def stop(self, proc: subprocess.Popen[bytes], output_file: Path | None) -> None: ...
+
+    def is_alive(self, proc: subprocess.Popen[bytes]) -> bool: ...
+
+
+class FfmpegRecorder:
+    def __init__(
+        self,
+        *,
+        rtsp_url: str,
+        ffmpeg_flags: list[str],
+        rtsp_connect_timeout_s: float,
+        rtsp_io_timeout_s: float,
+        clock: Clock,
+    ) -> None:
+        self._rtsp_url = rtsp_url
+        self._ffmpeg_flags = ffmpeg_flags
+        self._rtsp_connect_timeout_s = rtsp_connect_timeout_s
+        self._rtsp_io_timeout_s = rtsp_io_timeout_s
+        self._clock = clock
+
+    def start(self, output_file: Path, stderr_log: Path) -> subprocess.Popen[bytes] | None:
+        def _read_tail(path: Path, max_bytes: int = 4000) -> str:
+            try:
+                data = path.read_bytes()
+            except Exception as exc:
+                logger.warning("Failed to read recording stderr tail: %s", exc, exc_info=True)
+                return ""
+            if len(data) <= max_bytes:
+                return data.decode(errors="replace")
+            return data[-max_bytes:].decode(errors="replace")
+
+        cmd_base = [
+            "ffmpeg",
+            "-rtsp_transport",
+            "tcp",
+            "-rtsp_flags",
+            "prefer_tcp",
+            "-user_agent",
+            "Lavf",
+        ]
+
+        user_flags = self._ffmpeg_flags
+        has_stimeout = any(x == "-stimeout" for x in user_flags)
+        has_rw_timeout = any(x == "-rw_timeout" for x in user_flags)
+        timeout_us_connect = str(int(max(0.1, self._rtsp_connect_timeout_s) * 1_000_000))
+        timeout_us_io = str(int(max(0.1, self._rtsp_io_timeout_s) * 1_000_000))
+
+        timeout_args: list[str] = []
+        if not has_stimeout and self._rtsp_connect_timeout_s > 0:
+            timeout_args.extend(["-stimeout", timeout_us_connect])
+        if not has_rw_timeout and self._rtsp_io_timeout_s > 0:
+            timeout_args.extend(["-rw_timeout", timeout_us_io])
+
+        cmd_tail = ["-i", self._rtsp_url, "-c", "copy", "-f", "mp4", "-y"]
+
+        # Naive check to see if user overrode defaults
+        # If user supplies ANY -loglevel, we don't add ours.
+        # If user supplies ANY -fflags, we don't add ours (to avoid concatenation complexity).
+        # This allows full user control.
+        has_loglevel = any(x == "-loglevel" for x in user_flags)
+        if not has_loglevel:
+            cmd_tail.extend(["-loglevel", "warning"])
+
+        has_fflags = any(x == "-fflags" for x in user_flags)
+        if not has_fflags:
+            cmd_tail.extend(["-fflags", "+genpts+igndts"])
+
+        has_fps_mode = any(x == "-fps_mode" or x == "-vsync" for x in user_flags)
+        if not has_fps_mode:
+            cmd_tail.extend(["-vsync", "0"])
+
+        # Add user flags last so they can potentially override or add to the above
+        cmd_tail.extend(user_flags)
+        cmd_tail.extend([str(output_file)])
+
+        attempts: list[tuple[str, list[str]]] = []
+        if timeout_args:
+            attempts.append(("timeouts", timeout_args))
+        attempts.append(("no_timeouts" if timeout_args else "default", []))
+
+        for label, extra_args in attempts:
+            cmd = list(cmd_base) + list(extra_args) + cmd_tail
+
+            safe_cmd = list(cmd)
+            try:
+                idx = safe_cmd.index("-i")
+                safe_cmd[idx + 1] = _redact_rtsp_url(str(safe_cmd[idx + 1]))
+            except Exception as exc:
+                logger.warning("Failed to redact recording RTSP URL: %s", exc, exc_info=True)
+            logger.debug("Recording ffmpeg (%s): %s", label, _format_cmd(safe_cmd))
+
+            try:
+                with open(stderr_log, "w") as stderr_file:
+                    proc = subprocess.Popen(cmd, stdout=subprocess.DEVNULL, stderr=stderr_file)
+
+                self._clock.sleep(0.5)
+                if proc.poll() is None:
+                    return proc
+
+                stderr_tail = _read_tail(stderr_log)
+                timeout_option_error = (
+                    label == "timeouts"
+                    and bool(stderr_tail)
+                    and _is_timeout_option_error(stderr_tail)
+                )
+
+                if timeout_option_error:
+                    logger.warning(
+                        "Recording process died immediately (%s, exit code: %s); timeout options unsupported",
+                        label,
+                        proc.returncode,
+                    )
+                    logger.warning("Check logs at: %s", stderr_log)
+                else:
+                    logger.error(
+                        "Recording process died immediately (%s, exit code: %s)",
+                        label,
+                        proc.returncode,
+                    )
+                    logger.error("Check logs at: %s", stderr_log)
+
+                if stderr_tail:
+                    redacted_tail = stderr_tail.replace(
+                        self._rtsp_url, _redact_rtsp_url(self._rtsp_url)
+                    )
+                    if timeout_option_error:
+                        logger.warning("Recording stderr tail (%s):\n%s", label, redacted_tail)
+                        logger.warning(
+                            "Recording ffmpeg missing timeout options; retrying without timeouts"
+                        )
+                        continue
+                    logger.error("Recording stderr tail (%s):\n%s", label, redacted_tail)
+                if label == "timeouts":
+                    return None
+            except Exception:
+                logger.exception("Failed to start recording")
+                return None
+
+        return None
+
+    def stop(self, proc: subprocess.Popen[bytes], output_file: Path | None) -> None:
+        try:
+            if proc.poll() is None:
+                proc.terminate()
+                proc.wait(timeout=5)
+        except subprocess.TimeoutExpired:
+            logger.warning("Recording process did not terminate, killing (PID: %s)", proc.pid)
+            try:
+                proc.kill()
+                proc.wait(timeout=2)
+            except Exception:
+                logger.exception("Failed to kill recording process (PID: %s)", proc.pid)
+        except Exception:
+            logger.exception("Failed while stopping recording process (PID: %s)", proc.pid)
+
+        logger.debug(
+            "Stopped recording: %s",
+            output_file,
+            extra={"recording_id": output_file.name if output_file else None},
+        )
+
+    def is_alive(self, proc: subprocess.Popen[bytes]) -> bool:
+        return proc.poll() is None

homesec/sources/rtsp/utils.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+import logging
+import shlex
+
+logger = logging.getLogger(__name__)
+
+
+def _redact_rtsp_url(url: str) -> str:
+    if "://" not in url:
+        return url
+    scheme, rest = url.split("://", 1)
+    if "@" not in rest:
+        return url
+    _creds, host = rest.split("@", 1)
+    return f"{scheme}://***:***@{host}"
+
+
+def _format_cmd(cmd: list[str]) -> str:
+    try:
+        return shlex.join([str(x) for x in cmd])
+    except Exception as exc:
+        logger.warning("Failed to format command with shlex.join: %s", exc, exc_info=True)
+        return " ".join([str(x) for x in cmd])
+
+
+def _is_timeout_option_error(stderr_text: str) -> bool:
+    text = stderr_text.lower()
+    return ("rw_timeout" in text and ("not found" in text or "unrecognized option" in text)) or (
+        "stimeout" in text and ("not found" in text or "unrecognized option" in text)
+    )
+
+
+def _next_backoff(backoff_s: float, cap_s: float, *, factor: float = 1.6) -> float:
+    return min(backoff_s * factor, cap_s)

{homesec-1.2.1.dist-info → homesec-1.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: homesec
-Version: 1.2.1
+Version: 1.2.2
 Summary: Pluggable async home security camera pipeline with detection, VLM analysis, and alerts.
 Project-URL: Homepage, https://github.com/lan17/homesec
 Project-URL: Source, https://github.com/lan17/homesec
@@ -404,9 +404,11 @@ cameras:
       config:
         rtsp_url_env: DRIVEWAY_RTSP_URL
         output_dir: "./recordings"
-        # Critical for camera compatibility:
-        ffmpeg_flags: ["-rtsp_transport", "tcp", "-vsync", "0"]
-        reconnect_backoff_s: 5
+        stream:
+          # Critical for camera compatibility:
+          ffmpeg_flags: ["-rtsp_transport", "tcp", "-vsync", "0"]
+        reconnect:
+          backoff_s: 5
 
 filter:
   plugin: yolo
@@ -488,7 +490,7 @@ HomeSec uses a plugin architecture where every component is discovered at runtim
 
 | Type | Plugins |
 |------|---------|
-| Sources | [`rtsp`](src/homesec/sources/rtsp.py), [`ftp`](src/homesec/sources/ftp.py), [`local_folder`](src/homesec/sources/local_folder.py) |
+| Sources | [`rtsp`](src/homesec/sources/rtsp/core.py), [`ftp`](src/homesec/sources/ftp.py), [`local_folder`](src/homesec/sources/local_folder.py) |
 | Filters | [`yolo`](src/homesec/plugins/filters/yolo.py) |
 | Storage | [`dropbox`](src/homesec/plugins/storage/dropbox.py), [`local`](src/homesec/plugins/storage/local.py) |
 | VLM analyzers | [`openai`](src/homesec/plugins/analyzers/openai.py) |

{homesec-1.2.1.dist-info → homesec-1.2.2.dist-info}/RECORD

@@ -13,16 +13,19 @@ homesec/health/__init__.py,sha256=fbndfsLOR9aA7d_5I1mEZN0oM5IYMmcJNjOt0iaXKZc,10
 homesec/health/server.py,sha256=VP-4XmZ0K3ooFyd000AFOZohZ5R7QcnZC4n7oj0RMqI,7014
 homesec/maintenance/__init__.py,sha256=6a5W2x8oUgnoWaK374-Wq_nrOD5UDAUqUtSANaEck2M,60
 homesec/maintenance/cleanup_clips.py,sha256=sqeWLE9GrJfe29ntCasgvT2M-FWTymydHDQG-fZ3khg,23451
-homesec/models/__init__.py,sha256=IVmkIEgTe1SvOzXilWw6BwSRQezAeBbqAt5y6EdZV5o,1955
+homesec/models/__init__.py,sha256=0gcTdSg0CW77Hy3D7wlCyyYvvBJMdD51BL5uIiz4Vfc,2043
 homesec/models/alert.py,sha256=cMFr4NUGygq0-m2ep0jhjzVrFKM7kN1wJON1J0XwGY4,1010
 homesec/models/clip.py,sha256=QaftnY7q20fQX4BTX6j-FBZLaoVSgk0DbpNf8kdnT60,2225
-homesec/models/config.py,sha256=Z70xKrbDHi96j8IoRXPBw7DYAI7sjHR4M6nqReHTNds,14184
+homesec/models/config.py,sha256=5V0_RNIh-hqKA8OCU5EdBwQVRbZ3nmkqoay54V6vgVE,14272
 homesec/models/enums.py,sha256=WQk1PvYnJd5iaz51P5GM3XayqCf0VpQnLYmSuw1hrZk,3293
 homesec/models/events.py,sha256=sgPDCSp9w60VUKKREYxNBZaxrFWW_bYyLwMFGHBawjk,4942
 homesec/models/filter.py,sha256=6NS1rBI2zmrswK9NtMn0vZlbwbeMGCPuLCDKP9XWN0I,2259
-homesec/models/source.py,sha256=F8ksGrOa09bxx5IEgQmxPWJNWOm8zvFLsRJxihJTlM4,2367
 homesec/models/storage.py,sha256=63wyHdDt3QrfdsP0SmhrxtOeWRllZ1O2GPrA4jI7XmU,235
 homesec/models/vlm.py,sha256=Uk6TPwqbKxzyAsOlBSzZru74nKjp2-LLyzIp5b3wM_c,3293
+homesec/models/source/__init__.py,sha256=vZFpll5ftShIGe_VOoqQ6XiFZKKAKqgZ3bOW9feB_VM,60
+homesec/models/source/ftp.py,sha256=ZRU0YxNa99qTlCS2pIXKl8kmM1KQyIHOHyaFox6XPKk,2871
+homesec/models/source/local_folder.py,sha256=ymneTjcCzvLzFmen3GF8kYfGIlxWgb10BDvgdXnWFcQ,803
+homesec/models/source/rtsp.py,sha256=h_XzIM22JKHA0Mz4IUZMTPlzKkU_U7sSF6p5PPIVoWw,4852
 homesec/pipeline/__init__.py,sha256=kiQLECc6JIPmeIdBJrVpTApPs0GBAgWoZ1kU4XZyJVY,214
 homesec/pipeline/alert_policy.py,sha256=gFl5SJ96fgEfEUnhSL51YA6O2GPGXTXmxaDC-q3h1rs,152
 homesec/pipeline/core.py,sha256=D552e-xpIpom5C-Y_TkWB9Ufbm8xClGmCdo_4tseXuU,23840
@@ -41,19 +44,26 @@ homesec/plugins/notifiers/mqtt.py,sha256=1zUKUHFvT65ysawFXEwWHvY8rg310fRsSSKhIFe
 homesec/plugins/notifiers/multiplex.py,sha256=LlnwozjkMDQwz7__v7mT4AohZbiWZK39CZunamRp7FM,3676
 homesec/plugins/notifiers/sendgrid_email.py,sha256=gZSv3FRaN8qCMO6D-MX8b6XVz-gSgrFhkFV6j1ILdi4,8682
 homesec/plugins/sources/__init__.py,sha256=weLYuCLrmWIUvRTYmfgqVcOFHonZgTngDKFSks4yg8s,1025
-homesec/plugins/sources/ftp.py,sha256=hdMcjC3lhCAdn9ZnuYNZbKbUWsXUOcql1r_OJXoCPso,849
-homesec/plugins/sources/local_folder.py,sha256=nCAJr0l8FpUpI3amkOPDN69XkAYtxgez3utq1jNRdPQ,1214
-homesec/plugins/sources/rtsp.py,sha256=PbSrDEcvbTPq6xnA6i87DLCEtxHWdMVBjd6QQm1DAsc,814
+homesec/plugins/sources/ftp.py,sha256=c2HktqWlzQyRDMVMVEb6R9zIK-Q1AyJMHPUp92jHhyM,853
+homesec/plugins/sources/local_folder.py,sha256=zHyMT-PKEJCaf4mw29TBjj-jK_oQmO3zPyOAt4n5HWI,1227
+homesec/plugins/sources/rtsp.py,sha256=rqWtOOKgxGqC2lwdgkEdpH_xMatH2-3xn_Kt_biAA20,824
 homesec/plugins/storage/__init__.py,sha256=oJPrjgpke7VK3MY8L-GGmDVB4eWx7IgXcmVQXMcMw7g,1235
 homesec/plugins/storage/dropbox.py,sha256=AQkEFV4lXqS1pbVazNuskEaEpr5CvLkrYdUK8EE7eAM,9992
 homesec/plugins/storage/local.py,sha256=CbuSaWEi9ft1zxOURcmOKzwyq0UXIyHqyHoQD6sxivI,3231
 homesec/repository/__init__.py,sha256=6cye2uQIA2v6jeLk5D2S9y3rlkfzJH5GceqdOroF3hU,160
 homesec/repository/clip_repository.py,sha256=nRcswsIX--Z9p7J33FsqNlDtMAmt438VUbfvZHX0FlY,17090
-homesec/sources/__init__.py,sha256=wuCtiF44ceo7n3wJN51VHHcDavko3ubUDICtFbWmaRI,505
+homesec/sources/__init__.py,sha256=zjjoGbpha4Aqx2Y3fca743gs6gEyYDtRjUbCCwJ0NG0,598
 homesec/sources/base.py,sha256=dKTxJxcDwJtykWDN3WYzkW5mtkRqlOJxJLWcLy82_Zo,7582
-homesec/sources/ftp.py,sha256=ynIPbgcbIi1jub8yr4H1259Y1HbNM42RFDBBivXD4mg,7308
-homesec/sources/local_folder.py,sha256=eW7ghgRsqTnZ5ZMPbsXh9ntqfue1UeM29ZpvRvLthPA,8461
-homesec/sources/rtsp.py,sha256=T_DoAExu58pukRDjPNZ7wELDIebbQpVFrg29L9xACa8,48866
+homesec/sources/ftp.py,sha256=t1XFo7aN31mN4wFfSVJuJhA2o_nFi1zQQZCl4VZGQlA,7312
+homesec/sources/local_folder.py,sha256=UduSyDKesT5DBoBx8Qjp7tAZatUR6bvXTEHzC7VoLWQ,8474
+homesec/sources/rtsp/__init__.py,sha256=wtBzdwzL7Cg0HyIGIpS3lBagekCAi_EYJOyCZFbT7K0,103
+homesec/sources/rtsp/clock.py,sha256=Gf-CLBfgUmxfajmZim89vmWRG14hnc7iUUBVNNiUz6w,338
+homesec/sources/rtsp/core.py,sha256=tX6FH_ete2Xop-6O7CzH-a0A42OaCa2-jUQXjl5oQ0E,48235
+homesec/sources/rtsp/frame_pipeline.py,sha256=cIGrH5z4WE8swoAThTl7Wu3SViNq-00YyCcKMLBrCso,11620
+homesec/sources/rtsp/hardware.py,sha256=sKCJhoVdmkDfCk2s5RL0lDPX_CuvcwlgVUESgRJK3us,4892
+homesec/sources/rtsp/motion.py,sha256=FKDa1hvD_H3uxgnQ-Z0c7MhVd6u_35cO6XKZRVrXpaY,2870
+homesec/sources/rtsp/recorder.py,sha256=fqL-zr-vtnFrDQc87zZFYeM-6JSUfMwQsc0zfR-mgy4,7009
+homesec/sources/rtsp/utils.py,sha256=aufPAP6oc39kyFAiN0HTDhdXf3bQqWSVeVWNIHx5MmI,1021
 homesec/state/__init__.py,sha256=Evt1jqTebmpJD1NUzNh3vwt5pbjDlLjQ0DgMCSAZOuM,255
 homesec/state/postgres.py,sha256=I-cXqW5cgz-hpaHc0JIv3DnIBTmGxE28P8ZxBAGabSw,17765
 homesec/telemetry/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -61,8 +71,8 @@ homesec/telemetry/db_log_handler.py,sha256=KM8g4kcOyPzFJbpGxpSzecx_hrEWY0YfpoIKy
 homesec/telemetry/postgres_settings.py,sha256=EVD2_oi_KReFJvQmXxW026aurl_YD-KexT7rkbGQPHc,1198
 homesec/telemetry/db/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 homesec/telemetry/db/log_table.py,sha256=wcZLwRht7FMa0z2gf37f_RxdVTNIdDiK4i_N3c_ibwg,473
-homesec-1.2.1.dist-info/METADATA,sha256=UqWtHMZ6XjaykxI7ya_Fu-fwUTHVAEMl15sBfEbysjI,25121
-homesec-1.2.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-homesec-1.2.1.dist-info/entry_points.txt,sha256=8ocCj_fP1qxIuL-DVDAUiaUbEdTMX_kg_BzVrJsbQYg,45
-homesec-1.2.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-homesec-1.2.1.dist-info/RECORD,,
+homesec-1.2.2.dist-info/METADATA,sha256=dYxpcVPEWLuX_TLZIEZZywjcgYgJO--J1IGgDu8aUyQ,25157
+homesec-1.2.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+homesec-1.2.2.dist-info/entry_points.txt,sha256=8ocCj_fP1qxIuL-DVDAUiaUbEdTMX_kg_BzVrJsbQYg,45
+homesec-1.2.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+homesec-1.2.2.dist-info/RECORD,,

homesec/models/source.py

@@ -1,81 +0,0 @@
-"""Source configuration models."""
-
-from __future__ import annotations
-
-from pydantic import BaseModel, Field, field_validator
-
-
-class RTSPSourceConfig(BaseModel):
-    """RTSP source configuration."""
-
-    model_config = {"extra": "forbid"}
-
-    camera_name: str | None = None
-    rtsp_url_env: str | None = None
-    rtsp_url: str | None = None
-    detect_rtsp_url_env: str | None = None
-    detect_rtsp_url: str | None = None
-    output_dir: str = "./recordings"
-    pixel_threshold: int = 45
-    min_changed_pct: float = 1.0
-    blur_kernel: int = 5
-    stop_delay: float = 10.0
-    max_recording_s: float = 60.0
-    max_reconnect_attempts: int = 20
-    disable_hwaccel: bool = False
-    frame_timeout_s: float = 2.0
-    frame_queue_size: int = 20
-    reconnect_backoff_s: float = 1.0
-    debug_motion: bool = False
-    heartbeat_s: float = 30.0
-    rtsp_connect_timeout_s: float = 2.0
-    rtsp_io_timeout_s: float = 2.0
-    ffmpeg_flags: list[str] = Field(default_factory=list)
-
-
-class LocalFolderSourceConfig(BaseModel):
-    """Local folder source configuration."""
-
-    model_config = {"extra": "forbid"}
-
-    camera_name: str | None = None
-    watch_dir: str = "recordings"
-    poll_interval: float = 1.0
-    stability_threshold_s: float = 3.0
-
-
-class FtpSourceConfig(BaseModel):
-    """FTP source configuration."""
-
-    model_config = {"extra": "forbid"}
-
-    camera_name: str | None = None
-    host: str = "0.0.0.0"
-    port: int = 2121
-    root_dir: str = "./ftp_incoming"
-    ftp_subdir: str | None = None
-    anonymous: bool = True
-    username_env: str | None = None
-    password_env: str | None = None
-    perms: str = "elw"
-    passive_ports: str | None = None
-    masquerade_address: str | None = None
-    heartbeat_s: float = 30.0
-    allowed_extensions: list[str] = Field(default_factory=lambda: [".mp4"])
-    delete_non_matching: bool = True
-    delete_incomplete: bool = True
-    default_duration_s: float = 10.0
-    log_level: str = "INFO"
-
-    @field_validator("allowed_extensions")
-    @classmethod
-    def _normalize_extensions(cls, value: list[str]) -> list[str]:
-        cleaned: list[str] = []
-        for item in value:
-            ext = str(item).strip().lower()
-            if not ext:
-                continue
-            if not ext.startswith("."):
-                ext = f".{ext}"
-            cleaned.append(ext)
-        return cleaned