use relative coordinates for masks & zones (#10912)

* Handle zones and masks as relative coords

* Ensure that zone coords are saved as relative

* Get motion mask working with relative coordinates

* Rewrite object mask to use relative coordinates as well

* Formatting

* Fix always trying to convert

* fix mask logic

frigate/test/test_config.py

@@ -64,7 +64,7 @@ class TestConfig(unittest.TestCase):
 
     def test_config_class(self):
         frigate_config = FrigateConfig(**self.minimal)
-        assert self.minimal == frigate_config.dict(exclude_unset=True)
+        assert self.minimal == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert "cpu" in runtime_config.detectors.keys()
@@ -157,7 +157,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert "dog" in runtime_config.cameras["back"].objects.track
@@ -183,7 +183,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert not runtime_config.cameras["back"].birdseye.enabled
@@ -209,7 +209,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].birdseye.enabled
@@ -234,7 +234,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].birdseye.enabled
@@ -263,7 +263,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert "cat" in runtime_config.cameras["back"].objects.track
@@ -288,7 +288,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert "dog" in runtime_config.cameras["back"].objects.filters
@@ -316,7 +316,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert "dog" in runtime_config.cameras["back"].objects.filters
@@ -345,7 +345,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert "dog" in runtime_config.cameras["back"].objects.filters
@@ -375,7 +375,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         back_camera = runtime_config.cameras["back"]
@@ -383,6 +383,55 @@ class TestConfig(unittest.TestCase):
         assert len(back_camera.objects.filters["dog"].raw_mask) == 2
         assert len(back_camera.objects.filters["person"].raw_mask) == 1
 
+    def test_motion_mask_relative_matches_explicit(self):
+        config = {
+            "mqtt": {"host": "mqtt"},
+            "record": {
+                "events": {"retain": {"default": 20, "objects": {"person": 30}}}
+            },
+            "cameras": {
+                "explicit": {
+                    "ffmpeg": {
+                        "inputs": [
+                            {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
+                        ]
+                    },
+                    "detect": {
+                        "height": 400,
+                        "width": 800,
+                        "fps": 5,
+                    },
+                    "motion": {
+                        "mask": [
+                            "0,0,200,100,600,300,800,400",
+                        ]
+                    },
+                },
+                "relative": {
+                    "ffmpeg": {
+                        "inputs": [
+                            {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
+                        ]
+                    },
+                    "detect": {
+                        "height": 400,
+                        "width": 800,
+                        "fps": 5,
+                    },
+                    "motion": {
+                        "mask": [
+                            "0.0,0.0,0.25,0.25,0.75,0.75,1.0,1.0",
+                        ]
+                    },
+                },
+            },
+        }
+        frigate_config = FrigateConfig(**config).runtime_config()
+        assert np.array_equal(
+            frigate_config.cameras["explicit"].motion.mask,
+            frigate_config.cameras["relative"].motion.mask,
+        )
+
     def test_default_input_args(self):
         config = {
             "mqtt": {"host": "mqtt"},
@@ -406,7 +455,7 @@ class TestConfig(unittest.TestCase):
         }
 
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert "-rtsp_transport" in runtime_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
@@ -435,7 +484,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert "-re" in runtime_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
@@ -465,7 +514,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert "-re" in runtime_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
@@ -500,7 +549,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert "-re" in runtime_config.cameras["back"].ffmpeg_cmds[0]["cmd"]
@@ -530,7 +579,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert (
@@ -608,7 +657,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert isinstance(
@@ -616,6 +665,41 @@ class TestConfig(unittest.TestCase):
         )
         assert runtime_config.cameras["back"].zones["test"].color != (0, 0, 0)
 
+    def test_zone_relative_matches_explicit(self):
+        config = {
+            "mqtt": {"host": "mqtt"},
+            "record": {
+                "events": {"retain": {"default": 20, "objects": {"person": 30}}}
+            },
+            "cameras": {
+                "back": {
+                    "ffmpeg": {
+                        "inputs": [
+                            {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
+                        ]
+                    },
+                    "detect": {
+                        "height": 400,
+                        "width": 800,
+                        "fps": 5,
+                    },
+                    "zones": {
+                        "explicit": {
+                            "coordinates": "0,0,200,100,600,300,800,400",
+                        },
+                        "relative": {
+                            "coordinates": "0.0,0.0,0.25,0.25,0.75,0.75,1.0,1.0",
+                        },
+                    },
+                }
+            },
+        }
+        frigate_config = FrigateConfig(**config).runtime_config()
+        assert np.array_equal(
+            frigate_config.cameras["back"].zones["explicit"].contour,
+            frigate_config.cameras["back"].zones["relative"].contour,
+        )
+
     def test_clips_should_default_to_global_objects(self):
         config = {
             "mqtt": {"host": "mqtt"},
@@ -640,7 +724,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         back_camera = runtime_config.cameras["back"]
@@ -671,7 +755,7 @@ class TestConfig(unittest.TestCase):
         }
 
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         ffmpeg_cmds = runtime_config.cameras["back"].ffmpeg_cmds
@@ -702,7 +786,7 @@ class TestConfig(unittest.TestCase):
         }
 
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].detect.max_disappeared == 5 * 5
@@ -730,7 +814,7 @@ class TestConfig(unittest.TestCase):
         }
 
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].motion.frame_height == 100
@@ -758,7 +842,7 @@ class TestConfig(unittest.TestCase):
         }
 
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert round(runtime_config.cameras["back"].motion.contour_area) == 10
@@ -787,7 +871,7 @@ class TestConfig(unittest.TestCase):
         }
 
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.model.merged_labelmap[7] == "truck"
@@ -815,7 +899,7 @@ class TestConfig(unittest.TestCase):
         }
 
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.model.merged_labelmap[0] == "person"
@@ -844,7 +928,7 @@ class TestConfig(unittest.TestCase):
         }
 
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.model.merged_labelmap[0] == "person"
@@ -878,7 +962,7 @@ class TestConfig(unittest.TestCase):
         }
 
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config(PlusApi())
         assert runtime_config.model.merged_labelmap[0] == "amazon"
@@ -1012,7 +1096,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].detect.max_disappeared == 1
@@ -1040,7 +1124,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].detect.max_disappeared == 25
@@ -1069,7 +1153,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].detect.max_disappeared == 1
@@ -1102,7 +1186,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].snapshots.enabled
@@ -1130,7 +1214,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].snapshots.bounding_box
@@ -1163,7 +1247,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].snapshots.bounding_box is False
@@ -1193,7 +1277,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].live.quality == 4
@@ -1220,7 +1304,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].live.quality == 8
@@ -1251,7 +1335,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].live.quality == 7
@@ -1280,7 +1364,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].timestamp_style.position == "bl"
@@ -1307,7 +1391,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].timestamp_style.position == "tl"
@@ -1336,7 +1420,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].timestamp_style.position == "bl"
@@ -1365,7 +1449,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert runtime_config.cameras["back"].snapshots.retain.default == 1.5
@@ -1505,7 +1589,7 @@ class TestConfig(unittest.TestCase):
             },
         }
         frigate_config = FrigateConfig(**config)
-        assert config == frigate_config.dict(exclude_unset=True)
+        assert config == frigate_config.model_dump(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config()
         assert "dog" in runtime_config.cameras["back"].objects.filters