Split config.py into multiple files (#14038)

* Replace logging.warn with logging.warning * Install config global state early * Split config.py into more manageable pieces
2026-08-02 09:02:15 +03:00 · 2024-09-28 14:21:42 -05:00
parent 576191cd4e
commit bbbb3b4a06
39 changed files with 2240 additions and 1892 deletions
@@ -0,0 +1,96 @@
+from enum import Enum
+from typing import Optional
+
+from pydantic import Field
+
+from frigate.const import MAX_PRE_CAPTURE
+
+from ..base import FrigateBaseModel
+
+__all__ = [
+    "RecordConfig",
+    "RecordExportConfig",
+    "RecordPreviewConfig",
+    "RecordQualityEnum",
+    "EventsConfig",
+    "ReviewRetainConfig",
+    "RecordRetainConfig",
+    "RetainModeEnum",
+]
+
+DEFAULT_TIME_LAPSE_FFMPEG_ARGS = "-vf setpts=0.04*PTS -r 30"
+
+
+class RetainModeEnum(str, Enum):
+    all = "all"
+    motion = "motion"
+    active_objects = "active_objects"
+
+
+class RecordRetainConfig(FrigateBaseModel):
+    days: float = Field(default=0, title="Default retention period.")
+    mode: RetainModeEnum = Field(default=RetainModeEnum.all, title="Retain mode.")
+
+
+class ReviewRetainConfig(FrigateBaseModel):
+    days: float = Field(default=10, title="Default retention period.")
+    mode: RetainModeEnum = Field(default=RetainModeEnum.motion, title="Retain mode.")
+
+
+class EventsConfig(FrigateBaseModel):
+    pre_capture: int = Field(
+        default=5, title="Seconds to retain before event starts.", le=MAX_PRE_CAPTURE
+    )
+    post_capture: int = Field(default=5, title="Seconds to retain after event ends.")
+    retain: ReviewRetainConfig = Field(
+        default_factory=ReviewRetainConfig, title="Event retention settings."
+    )
+
+
+class RecordQualityEnum(str, Enum):
+    very_low = "very_low"
+    low = "low"
+    medium = "medium"
+    high = "high"
+    very_high = "very_high"
+
+
+class RecordPreviewConfig(FrigateBaseModel):
+    quality: RecordQualityEnum = Field(
+        default=RecordQualityEnum.medium, title="Quality of recording preview."
+    )
+
+
+class RecordExportConfig(FrigateBaseModel):
+    timelapse_args: str = Field(
+        default=DEFAULT_TIME_LAPSE_FFMPEG_ARGS, title="Timelapse Args"
+    )
+
+
+class RecordConfig(FrigateBaseModel):
+    enabled: bool = Field(default=False, title="Enable record on all cameras.")
+    sync_recordings: bool = Field(
+        default=False, title="Sync recordings with disk on startup and once a day."
+    )
+    expire_interval: int = Field(
+        default=60,
+        title="Number of minutes to wait between cleanup runs.",
+    )
+    retain: RecordRetainConfig = Field(
+        default_factory=RecordRetainConfig, title="Record retention settings."
+    )
+    detections: EventsConfig = Field(
+        default_factory=EventsConfig, title="Detection specific retention settings."
+    )
+    alerts: EventsConfig = Field(
+        default_factory=EventsConfig, title="Alert specific retention settings."
+    )
+    export: RecordExportConfig = Field(
+        default_factory=RecordExportConfig, title="Recording Export Config"
+    )
+    preview: RecordPreviewConfig = Field(
+        default_factory=RecordPreviewConfig, title="Recording Preview Config"
+    )
+    enabled_in_config: Optional[bool] = Field(
+        default=None, title="Keep track of original state of recording."
+    )