ignore db files generated during tests

.gitignore

@@ -12,6 +12,7 @@ config/*
 models
 *.mp4
 *.db
+*.db-*
 *.csv
 frigate/version.py
 web/build

frigate/camera/maintainer.py

@@ -117,7 +117,9 @@ class CameraMaintainer(threading.Thread):
 
         if runtime:
             self.camera_metrics[name] = CameraMetrics(self.metrics_manager)
-            self.ptz_metrics[name] = PTZMetrics(autotracker_enabled=False)
+            self.ptz_metrics[name] = PTZMetrics(
+                autotracker_enabled=config.onvif.autotracking.enabled
+            )
             self.region_grids[name] = get_camera_regions_grid(
                 name,
                 config.detect,

frigate/camera/state.py

@@ -111,9 +111,9 @@ class CameraState:
                 # draw thicker box around ptz autotracked object
                 if (
                     self.camera_config.onvif.autotracking.enabled
-                    and self.ptz_autotracker_thread.ptz_autotracker.autotracker_init[
+                    and self.ptz_autotracker_thread.ptz_autotracker.autotracker_init.get(
                         self.name
-                    ]
+                    )
                     and self.ptz_autotracker_thread.ptz_autotracker.tracked_object[
                         self.name
                     ]

frigate/comms/dispatcher.py

@@ -588,6 +588,10 @@ class Dispatcher:
                 self.ptz_metrics[camera_name].start_time.value = 0
                 ptz_autotracker_settings.enabled = False
 
+        self.config_updater.publish_update(
+            CameraConfigUpdateTopic(CameraConfigUpdateEnum.autotracking, camera_name),
+            ptz_autotracker_settings,
+        )
         self.publish(f"{camera_name}/ptz_autotracker/state", payload, retain=True)
 
     def _on_motion_contour_area_command(self, camera_name: str, payload: int) -> None:

frigate/config/camera/updater.py

@@ -14,6 +14,7 @@ class CameraConfigUpdateEnum(str, Enum):
     add = "add"  # for adding a camera
     audio = "audio"
     audio_transcription = "audio_transcription"
+    autotracking = "autotracking"  # ptz autotracking only, without an onvif reinit
     birdseye = "birdseye"
     detect = "detect"
     enabled = "enabled"
@@ -145,6 +146,8 @@ class CameraConfigUpdateSubscriber:
             config.snapshots = updated_config
         elif update_type == CameraConfigUpdateEnum.onvif:
             config.onvif = updated_config
+        elif update_type == CameraConfigUpdateEnum.autotracking:
+            config.onvif.autotracking = updated_config
         elif update_type == CameraConfigUpdateEnum.timestamp_style:
             config.timestamp_style = updated_config
         elif update_type == CameraConfigUpdateEnum.zones:

frigate/ptz/autotrack.py

@@ -20,6 +20,10 @@ from norfair.camera_motion import (
 from frigate.camera import PTZMetrics
 from frigate.comms.dispatcher import Dispatcher
 from frigate.config import CameraConfig, FrigateConfig, ZoomingModeEnum
+from frigate.config.camera.updater import (
+    CameraConfigUpdateEnum,
+    CameraConfigUpdateSubscriber,
+)
 from frigate.const import (
     AUTOTRACKING_MAX_AREA_RATIO,
     AUTOTRACKING_MAX_MOVE_METRICS,
@@ -194,7 +198,9 @@ class PtzAutoTrackerThread(threading.Thread):
 
     def run(self):
         while not self.stop_event.wait(1):
-            for camera, camera_config in self.config.cameras.items():
+            self.ptz_autotracker.check_for_updates()
+
+            for camera, camera_config in list(self.config.cameras.items()):
                 if not camera_config.enabled:
                     continue
 
@@ -211,6 +217,7 @@ class PtzAutoTrackerThread(threading.Thread):
                         self.ptz_autotracker.tracked_object[camera] = None
                         self.ptz_autotracker.tracked_object_history[camera].clear()
 
+        self.ptz_autotracker.config_subscriber.stop()
         logger.info("Exiting autotracker...")
 
 
@@ -244,6 +251,16 @@ class PtzAutoTracker:
         self.zoom_time: dict[str, float] = {}
         self.zoom_factor: dict[str, object] = {}
 
+        self.config_subscriber = CameraConfigUpdateSubscriber(
+            self.config,
+            self.config.cameras,
+            [
+                CameraConfigUpdateEnum.add,
+                CameraConfigUpdateEnum.autotracking,
+                CameraConfigUpdateEnum.onvif,
+            ],
+        )
+
         # if cam is set to autotrack, onvif should be set up
         for camera, camera_config in self.config.cameras.items():
             if not camera_config.enabled:
@@ -260,6 +277,29 @@ class PtzAutoTracker:
                 # Wait for the coroutine to complete
                 future.result()
 
+    def check_for_updates(self) -> None:
+        """Apply camera config updates and mirror autotracking state to ptz metrics.
+
+        The camera processes read autotracker_enabled rather than the config, so it
+        has to follow every path that can change autotracking, not just the mqtt
+        toggle that writes it directly.
+        """
+        updates = self.config_subscriber.check_for_updates()
+
+        for cameras in updates.values():
+            for camera in cameras:
+                camera_config = self.config.cameras.get(camera)
+                metrics = self.ptz_metrics.get(camera)
+
+                # a camera added at runtime gets its metrics from the maintainer on
+                # another thread, which seeds them from this same config value
+                if camera_config is None or metrics is None:
+                    continue
+
+                metrics.autotracker_enabled.value = (
+                    camera_config.onvif.autotracking.enabled
+                )
+
     async def _autotracker_setup(self, camera_config: CameraConfig, camera: str):
         logger.debug(f"{camera}: Autotracker init")
 
@@ -1365,7 +1405,7 @@ class PtzAutoTracker:
         camera_config = self.config.cameras[camera]
 
         if camera_config.onvif.autotracking.enabled:
-            if not self.autotracker_init[camera]:
+            if not self.autotracker_init.get(camera):
                 future = asyncio.run_coroutine_threadsafe(
                     self._autotracker_setup(camera_config, camera), self.onvif.loop
                 )
@@ -1483,9 +1523,11 @@ class PtzAutoTracker:
                 }
 
     async def camera_maintenance(self, camera):
-        # bail and don't check anything if we're calibrating or tracking an object
+        # bail and don't check anything if we're not set up yet, calibrating, or
+        # tracking an object. a camera enabled at runtime has no autotracker_init
+        # entry until autotrack_object sets it up
         if (
-            not self.autotracker_init[camera]
+            not self.autotracker_init.get(camera)
             or self.calibrating[camera]
             or self.tracked_object[camera] is not None
         ):

frigate/ptz/onvif.py

@@ -344,16 +344,17 @@ class OnvifController:
             autotracking_config.enabled_in_config and autotracking_config.enabled
         )
 
-        # autotracking-only: status request and service capabilities
-        if autotracking_enabled:
-            status_request = ptz.create_type("GetStatus")
-            status_request.ProfileToken = profile.token
-            self.cams[camera_name]["status_request"] = status_request
+        # these are local and cost nothing to build, and autotracking can be enabled
+        # after a camera is initialized, so always create them rather than baking the
+        # current config value into init state
+        status_request = ptz.create_type("GetStatus")
+        status_request.ProfileToken = profile.token
+        self.cams[camera_name]["status_request"] = status_request
 
-            service_capabilities_request = ptz.create_type("GetServiceCapabilities")
-            self.cams[camera_name]["service_capabilities_request"] = (
-                service_capabilities_request
-            )
+        service_capabilities_request = ptz.create_type("GetServiceCapabilities")
+        self.cams[camera_name]["service_capabilities_request"] = (
+            service_capabilities_request
+        )
 
         # setup relative move request when FOV relative movement is supported
         if (

frigate/test/test_ptz_autotrack.py

@@ -0,0 +1,130 @@
+"""Tests for autotracker state that must survive runtime config changes.
+
+Regression coverage for a family of bugs where per-camera autotracker state was
+built once at startup and never revisited. A camera that is added or enabled
+after startup, or has autotracking enabled from the UI, would either raise a
+KeyError on the autotracker thread or silently keep the wrong state:
+
+- autotracker_init only got an entry for cameras enabled when PtzAutoTracker was
+  constructed, so runtime-enabled cameras raised KeyError on lookup.
+- ptz_metrics autotracker_enabled is what the camera processes read, but nothing
+  updated it when autotracking was enabled through a config save, so it stayed
+  False and the tracker never built a motion estimator.
+"""
+
+import unittest
+from unittest.mock import MagicMock
+
+from frigate.camera import PTZMetrics
+from frigate.config import FrigateConfig
+from frigate.ptz.autotrack import PtzAutoTracker
+
+CAMERA = "ptz_cam"
+
+
+def _config(autotracking_enabled: bool) -> FrigateConfig:
+    return FrigateConfig(
+        **{
+            "mqtt": {"enabled": False},
+            "cameras": {
+                CAMERA: {
+                    "ffmpeg": {
+                        "inputs": [
+                            {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
+                        ]
+                    },
+                    "detect": {"width": 1920, "height": 1080},
+                    "zones": {"zone": {"coordinates": "0,0,1,0,1,1,0,1"}},
+                    "onvif": {
+                        "host": "10.0.0.1",
+                        "autotracking": {
+                            "enabled": autotracking_enabled,
+                            "required_zones": ["zone"],
+                        },
+                    },
+                }
+            },
+        }
+    )
+
+
+def _make_tracker(autotracking_enabled: bool = True) -> PtzAutoTracker:
+    """Build a PtzAutoTracker without invoking __init__, which would try to set up
+    onvif over the network. Only the config/metrics state is relevant here."""
+    tracker = PtzAutoTracker.__new__(PtzAutoTracker)
+    tracker.config = _config(autotracking_enabled)
+    tracker.ptz_metrics = {CAMERA: PTZMetrics(autotracker_enabled=False)}
+    tracker.onvif = MagicMock()
+    tracker.config_subscriber = MagicMock()
+    tracker.autotracker_init = {}
+    tracker.calibrating = {}
+    tracker.tracked_object = {}
+    return tracker
+
+
+class TestAutotrackerInitGuards(unittest.IsolatedAsyncioTestCase):
+    async def test_camera_maintenance_returns_early_when_not_initialized(self) -> None:
+        # a camera enabled at runtime has no autotracker_init entry, which used to
+        # raise KeyError and kill the autotracker thread for every camera
+        tracker = _make_tracker()
+        self.assertNotIn(CAMERA, tracker.autotracker_init)
+
+        await tracker.camera_maintenance(CAMERA)
+
+        tracker.onvif.get_camera_status.assert_not_called()
+
+    async def test_camera_maintenance_returns_early_when_init_incomplete(self) -> None:
+        # autotracker_init is seeded False for enabled cameras before setup runs
+        tracker = _make_tracker()
+        tracker.autotracker_init[CAMERA] = False
+
+        await tracker.camera_maintenance(CAMERA)
+
+        tracker.onvif.get_camera_status.assert_not_called()
+
+
+class TestAutotrackerMetricSync(unittest.TestCase):
+    def test_metric_follows_config_when_enabled_by_update(self) -> None:
+        # autotracking enabled via a config save: the metric was seeded False when
+        # the camera was added and nothing else updates it
+        tracker = _make_tracker(autotracking_enabled=True)
+        metrics = tracker.ptz_metrics[CAMERA]
+        self.assertFalse(metrics.autotracker_enabled.value)
+
+        tracker.config_subscriber.check_for_updates.return_value = {"onvif": [CAMERA]}
+        tracker.check_for_updates()
+
+        self.assertTrue(metrics.autotracker_enabled.value)
+
+    def test_metric_follows_config_when_disabled_by_update(self) -> None:
+        tracker = _make_tracker(autotracking_enabled=False)
+        metrics = tracker.ptz_metrics[CAMERA]
+        metrics.autotracker_enabled.value = True
+
+        tracker.config_subscriber.check_for_updates.return_value = {
+            "autotracking": [CAMERA]
+        }
+        tracker.check_for_updates()
+
+        self.assertFalse(metrics.autotracker_enabled.value)
+
+    def test_metric_sync_skips_camera_without_metrics(self) -> None:
+        # `add` reaches the maintainer and the autotracker on separate threads with
+        # no ordering guarantee, so the metrics may not exist yet
+        tracker = _make_tracker()
+        tracker.ptz_metrics = {}
+        tracker.config_subscriber.check_for_updates.return_value = {"add": [CAMERA]}
+
+        tracker.check_for_updates()
+
+    def test_metric_sync_skips_unknown_camera(self) -> None:
+        tracker = _make_tracker()
+        tracker.config_subscriber.check_for_updates.return_value = {
+            "add": ["not_in_config"]
+        }
+
+        tracker.check_for_updates()
+
+
+if __name__ == "__main__":
+    unittest.main()

frigate/test/test_ptz_onvif.py

@@ -0,0 +1,147 @@
+"""Tests for ONVIF init state that must not depend on the autotracking config.
+
+Regression coverage for a camera that is initialized while autotracking is off and
+has it enabled later, which is the normal wizard flow: set the camera up first,
+configure autotracking afterwards. The autotracking-only request objects used to
+be created only when autotracking was enabled at init time, so the camera was left
+with init=True but no status_request. get_camera_status skips its re-init branch
+when init is True, so it went straight to the missing key and raised KeyError on
+the tracking thread.
+
+The request objects are built from the locally parsed WSDL and cost no network, so
+they are always created and init=True now implies they exist.
+"""
+
+import unittest
+from unittest.mock import AsyncMock, MagicMock
+
+from frigate.config import FrigateConfig
+from frigate.ptz.onvif import OnvifController
+
+CAMERA = "ptz_cam"
+
+
+def _config(autotracking_enabled: bool) -> FrigateConfig:
+    return FrigateConfig(
+        **{
+            "mqtt": {"enabled": False},
+            "cameras": {
+                CAMERA: {
+                    "ffmpeg": {
+                        "inputs": [
+                            {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
+                        ]
+                    },
+                    "detect": {"width": 1920, "height": 1080},
+                    "zones": {"zone": {"coordinates": "0,0,1,0,1,1,0,1"}},
+                    "onvif": {
+                        "host": "10.0.0.1",
+                        "autotracking": {
+                            "enabled": autotracking_enabled,
+                            "required_zones": ["zone"],
+                        },
+                    },
+                }
+            },
+        }
+    )
+
+
+def _make_profile() -> MagicMock:
+    profile = MagicMock()
+    profile.token = "profile_1"
+    profile.Name = "MainStream"
+    profile.VideoEncoderConfiguration = MagicMock()
+    ptz_config = MagicMock()
+    ptz_config.token = "ptz_config_1"
+    ptz_config.DefaultContinuousPanTiltVelocitySpace = "space"
+    ptz_config.DefaultContinuousZoomVelocitySpace = "space"
+    profile.PTZConfiguration = ptz_config
+    return profile
+
+
+def _make_onvif_camera() -> MagicMock:
+    """A camera that supports PTZ but nothing optional, so init takes the simplest
+    path through the feature detection below."""
+    onvif = MagicMock()
+    onvif.update_xaddrs = AsyncMock()
+
+    video_source = MagicMock()
+    video_source.token = "video_source_1"
+
+    media = MagicMock()
+    media.GetProfiles = AsyncMock(return_value=[_make_profile()])
+    media.GetVideoSources = AsyncMock(return_value=[video_source])
+    onvif.create_media_service = AsyncMock(return_value=media)
+    onvif.get_definition = MagicMock(return_value={"ptz": "definition"})
+
+    ptz = MagicMock()
+    # create_type is a local WSDL lookup, so tag the result to assert on it later
+    ptz.create_type = MagicMock(side_effect=lambda name: MagicMock(request_type=name))
+    ptz.GetConfigurationOptions = AsyncMock(side_effect=Exception("not supported"))
+    onvif.create_ptz_service = AsyncMock(return_value=ptz)
+    onvif.create_imaging_service = AsyncMock(side_effect=Exception("not supported"))
+    return onvif
+
+
+def _make_controller(autotracking_enabled: bool) -> OnvifController:
+    """Build a controller without invoking __init__, which would start an event loop
+    thread and reach out to the camera."""
+    config = _config(autotracking_enabled)
+    controller = OnvifController.__new__(OnvifController)
+    controller.config = config
+    controller.cams = {CAMERA: {"onvif": _make_onvif_camera(), "init": False}}
+    controller.failed_cams = {}
+    controller.camera_configs = {CAMERA: config.cameras[CAMERA]}
+    controller.ptz_metrics = {CAMERA: MagicMock()}
+    return controller
+
+
+class TestOnvifInitRequests(unittest.IsolatedAsyncioTestCase):
+    async def test_status_request_created_when_autotracking_disabled(self) -> None:
+        # the wizard flow: onvif configured first, autotracking enabled later
+        controller = _make_controller(autotracking_enabled=False)
+
+        self.assertTrue(await controller._init_onvif(CAMERA))
+
+        cam = controller.cams[CAMERA]
+        self.assertTrue(cam["init"])
+        self.assertIn("status_request", cam)
+        self.assertIn("service_capabilities_request", cam)
+
+    async def test_status_request_created_when_autotracking_enabled(self) -> None:
+        controller = _make_controller(autotracking_enabled=True)
+
+        self.assertTrue(await controller._init_onvif(CAMERA))
+
+        cam = controller.cams[CAMERA]
+        self.assertIn("status_request", cam)
+        self.assertIn("service_capabilities_request", cam)
+
+    async def test_init_implies_status_request_exists(self) -> None:
+        # the invariant get_camera_status relies on: it skips re-init when init is
+        # True and then reads status_request without guarding
+        for autotracking_enabled in (True, False):
+            with self.subTest(autotracking_enabled=autotracking_enabled):
+                controller = _make_controller(autotracking_enabled)
+
+                await controller._init_onvif(CAMERA)
+
+                cam = controller.cams[CAMERA]
+                if cam["init"]:
+                    self.assertEqual(cam["status_request"].request_type, "GetStatus")
+
+    async def test_requests_built_without_contacting_camera(self) -> None:
+        # create_type is a local WSDL lookup; cameras that do not implement
+        # GetServiceCapabilities must not be asked about it during init
+        controller = _make_controller(autotracking_enabled=False)
+
+        await controller._init_onvif(CAMERA)
+
+        ptz = controller.cams[CAMERA]["ptz"]
+        ptz.GetServiceCapabilities.assert_not_called()
+        ptz.GetStatus.assert_not_called()
+
+
+if __name__ == "__main__":
+    unittest.main()