Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
from __future__ import annotations
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
from enum import Enum
|
2020-11-03 15:15:58 +01:00
|
|
|
import json
|
2020-12-21 15:03:27 +01:00
|
|
|
import logging
|
2020-11-03 15:15:58 +01:00
|
|
|
import os
|
2021-06-24 07:45:27 +02:00
|
|
|
from typing import Dict, List, Optional, Tuple, Union
|
2020-11-03 15:15:58 +01:00
|
|
|
|
|
|
|
|
import matplotlib.pyplot as plt
|
|
|
|
|
import numpy as np
|
2021-06-24 07:45:27 +02:00
|
|
|
from pydantic import BaseModel, Field, validator
|
|
|
|
|
from pydantic.fields import PrivateAttr
|
2020-11-04 13:31:25 +01:00
|
|
|
import yaml
|
2020-11-01 13:17:44 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
from frigate.const import BASE_DIR, RECORD_DIR, CACHE_DIR
|
|
|
|
|
from frigate.util import create_mask, deep_merge
|
2020-12-01 14:22:23 +01:00
|
|
|
|
2020-12-21 15:03:27 +01:00
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
2021-06-15 22:19:49 +02:00
|
|
|
# TODO: Identify what the default format to display timestamps is
|
|
|
|
|
DEFAULT_TIME_FORMAT = "%m/%d/%Y %H:%M:%S"
|
|
|
|
|
# German Style:
|
|
|
|
|
# DEFAULT_TIME_FORMAT = "%d.%m.%Y %H:%M:%S"
|
2021-01-16 14:39:08 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
FRIGATE_ENV_VARS = {k: v for k, v in os.environ.items() if k.startswith("FRIGATE_")}
|
|
|
|
|
|
2021-06-15 22:19:49 +02:00
|
|
|
DEFAULT_TRACKED_OBJECTS = ["person"]
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
DEFAULT_DETECTORS = {"coral": {"type": "edgetpu", "device": "usb"}}
|
|
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class DetectorTypeEnum(str, Enum):
|
|
|
|
|
edgetpu = "edgetpu"
|
|
|
|
|
cpu = "cpu"
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class DetectorConfig(BaseModel):
|
|
|
|
|
type: DetectorTypeEnum = Field(
|
|
|
|
|
default=DetectorTypeEnum.edgetpu, title="Detector Type"
|
|
|
|
|
)
|
|
|
|
|
device: str = Field(default="usb", title="Device Type")
|
|
|
|
|
num_threads: int = Field(default=3, title="Number of detection threads")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class MqttConfig(BaseModel):
|
|
|
|
|
host: str = Field(title="MQTT Host")
|
|
|
|
|
port: int = Field(default=1883, title="MQTT Port")
|
|
|
|
|
topic_prefix: str = Field(default="frigate", title="MQTT Topic Prefix")
|
|
|
|
|
client_id: str = Field(default="frigate", title="MQTT Client ID")
|
|
|
|
|
stats_interval: int = Field(default=60, title="MQTT Camera Stats Interval")
|
|
|
|
|
user: Optional[str] = Field(title="MQTT Username")
|
|
|
|
|
password: Optional[str] = Field(title="MQTT Password")
|
|
|
|
|
tls_ca_certs: Optional[str] = Field(title="MQTT TLS CA Certificates")
|
|
|
|
|
tls_client_cert: Optional[str] = Field(title="MQTT TLS Client Certificate")
|
|
|
|
|
tls_client_key: Optional[str] = Field(title="MQTT TLS Client Key")
|
|
|
|
|
tls_insecure: Optional[bool] = Field(title="MQTT TLS Insecure")
|
|
|
|
|
|
|
|
|
|
@validator("password", pre=True, always=True)
|
|
|
|
|
def validate_password(cls, v, values):
|
|
|
|
|
if (v is None) != (values["user"] is None):
|
|
|
|
|
raise ValueError("Password must be provided with username.")
|
2021-06-24 22:53:01 +02:00
|
|
|
return v
|
2021-06-24 07:45:27 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
class RetainConfig(BaseModel):
|
|
|
|
|
default: int = Field(default=10, title="Default retention period.")
|
|
|
|
|
objects: Dict[str, int] = Field(
|
|
|
|
|
default_factory=dict, title="Object retention period."
|
|
|
|
|
)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2020-11-23 15:25:46 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class ClipsConfig(BaseModel):
|
|
|
|
|
max_seconds: int = Field(default=300, title="Maximum clip duration.")
|
|
|
|
|
retain: RetainConfig = Field(
|
|
|
|
|
default_factory=RetainConfig, title="Clip retention settings."
|
|
|
|
|
)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class MotionConfig(BaseModel):
|
|
|
|
|
threshold: int = Field(
|
|
|
|
|
default=25,
|
|
|
|
|
title="Motion detection threshold (1-255).",
|
|
|
|
|
ge=1,
|
|
|
|
|
le=255,
|
|
|
|
|
)
|
|
|
|
|
contour_area: int = Field(default=100, title="Contour Area")
|
|
|
|
|
delta_alpha: float = Field(default=0.2, title="Delta Alpha")
|
|
|
|
|
frame_alpha: float = Field(default=0.2, title="Frame Alpha")
|
|
|
|
|
frame_height: Optional[int] = Field(title="Frame Height")
|
|
|
|
|
mask: Union[str, List[str]] = Field(
|
|
|
|
|
default="", title="Coordinates polygon for the motion mask."
|
|
|
|
|
)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class RuntimeMotionConfig(MotionConfig):
|
|
|
|
|
raw_mask: Union[str, List[str]] = ""
|
|
|
|
|
mask: np.ndarray = None
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
def __init__(self, **config):
|
|
|
|
|
frame_shape = config.get("frame_shape", (1, 1))
|
2020-11-01 13:17:44 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
if "frame_height" not in config:
|
|
|
|
|
config["frame_height"] = frame_shape[0] // 6
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
mask = config.get("mask", "")
|
|
|
|
|
config["raw_mask"] = mask
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
if mask:
|
|
|
|
|
config["mask"] = create_mask(frame_shape, mask)
|
|
|
|
|
else:
|
|
|
|
|
empty_mask = np.zeros(frame_shape, np.uint8)
|
|
|
|
|
empty_mask[:] = 255
|
|
|
|
|
config["mask"] = empty_mask
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
super().__init__(**config)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
def dict(self, **kwargs):
|
|
|
|
|
ret = super().dict(**kwargs)
|
|
|
|
|
if "mask" in ret:
|
|
|
|
|
ret["mask"] = ret["raw_mask"]
|
|
|
|
|
ret.pop("raw_mask")
|
|
|
|
|
return ret
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class Config:
|
|
|
|
|
arbitrary_types_allowed = True
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class DetectConfig(BaseModel):
|
|
|
|
|
enabled: bool = Field(default=True, title="Detection Enabled.")
|
|
|
|
|
max_disappeared: int = Field(
|
|
|
|
|
title="Maximum number of frames the object can dissapear before detection ends."
|
|
|
|
|
)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class FilterConfig(BaseModel):
|
|
|
|
|
min_area: int = Field(
|
|
|
|
|
default=0, title="Minimum area of bounding box for object to be counted."
|
|
|
|
|
)
|
|
|
|
|
max_area: int = Field(
|
|
|
|
|
default=24000000, title="Maximum area of bounding box for object to be counted."
|
|
|
|
|
)
|
|
|
|
|
threshold: float = Field(
|
|
|
|
|
default=0.7,
|
|
|
|
|
title="Average detection confidence threshold for object to be counted.",
|
|
|
|
|
)
|
|
|
|
|
min_score: float = Field(
|
|
|
|
|
default=0.5, title="Minimum detection confidence for object to be counted."
|
|
|
|
|
)
|
|
|
|
|
mask: Optional[Union[str, List[str]]] = Field(
|
|
|
|
|
title="Detection area polygon mask for this filter configuration.",
|
|
|
|
|
)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class RuntimeFilterConfig(FilterConfig):
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
mask: Optional[np.ndarray]
|
2021-06-24 07:45:27 +02:00
|
|
|
raw_mask: Optional[Union[str, List[str]]]
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
def __init__(self, **config):
|
|
|
|
|
mask = config.get("mask")
|
|
|
|
|
config["raw_mask"] = mask
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
if mask is not None:
|
|
|
|
|
config["mask"] = create_mask(config.get("frame_shape", (1, 1)), mask)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
super().__init__(**config)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
def dict(self, **kwargs):
|
|
|
|
|
ret = super().dict(**kwargs)
|
|
|
|
|
if "mask" in ret:
|
|
|
|
|
ret["mask"] = ret["raw_mask"]
|
|
|
|
|
ret.pop("raw_mask")
|
|
|
|
|
return ret
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class Config:
|
|
|
|
|
arbitrary_types_allowed = True
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class ZoneConfig(BaseModel):
|
|
|
|
|
filters: Dict[str, FilterConfig] = Field(
|
|
|
|
|
default_factory=dict, title="Zone filters."
|
|
|
|
|
)
|
|
|
|
|
coordinates: Union[str, List[str]] = Field(
|
|
|
|
|
title="Coordinates polygon for the defined zone."
|
|
|
|
|
)
|
|
|
|
|
_color: Optional[Tuple[int, int, int]] = PrivateAttr()
|
|
|
|
|
_contour: np.ndarray = PrivateAttr()
|
|
|
|
|
|
|
|
|
|
@property
|
|
|
|
|
def color(self) -> Tuple[int, int, int]:
|
|
|
|
|
return self._color
|
|
|
|
|
|
|
|
|
|
@property
|
|
|
|
|
def contour(self) -> np.ndarray:
|
|
|
|
|
return self._contour
|
|
|
|
|
|
|
|
|
|
def __init__(self, **config):
|
|
|
|
|
super().__init__(**config)
|
|
|
|
|
|
|
|
|
|
self._color = config.get("color", (0, 0, 0))
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
coordinates = config["coordinates"]
|
|
|
|
|
|
|
|
|
|
if isinstance(coordinates, list):
|
2021-06-24 07:45:27 +02:00
|
|
|
self._contour = np.array(
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
[[int(p.split(",")[0]), int(p.split(",")[1])] for p in coordinates]
|
|
|
|
|
)
|
|
|
|
|
elif isinstance(coordinates, str):
|
|
|
|
|
points = coordinates.split(",")
|
2021-06-24 07:45:27 +02:00
|
|
|
self._contour = np.array(
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
[[int(points[i]), int(points[i + 1])] for i in range(0, len(points), 2)]
|
|
|
|
|
)
|
|
|
|
|
else:
|
2021-06-24 07:45:27 +02:00
|
|
|
self._contour = np.array([])
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class ObjectConfig(BaseModel):
|
|
|
|
|
track: List[str] = Field(default=DEFAULT_TRACKED_OBJECTS, title="Objects to track.")
|
|
|
|
|
filters: Optional[Dict[str, FilterConfig]] = Field(title="Object filters.")
|
|
|
|
|
mask: Union[str, List[str]] = Field(default="", title="Object mask.")
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class BirdseyeModeEnum(str, Enum):
|
|
|
|
|
objects = "objects"
|
|
|
|
|
motion = "motion"
|
|
|
|
|
continuous = "continuous"
|
2021-06-11 14:26:35 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class BirdseyeConfig(BaseModel):
|
|
|
|
|
enabled: bool = Field(default=True, title="Enable birdseye view.")
|
|
|
|
|
width: int = Field(default=1280, title="Birdseye width.")
|
|
|
|
|
height: int = Field(default=720, title="Birdseye height.")
|
|
|
|
|
quality: int = Field(default=8, title="Encoding quality.")
|
|
|
|
|
mode: BirdseyeModeEnum = Field(
|
|
|
|
|
default=BirdseyeModeEnum.objects, title="Tracking mode."
|
|
|
|
|
)
|
2021-06-11 14:26:35 +02:00
|
|
|
|
|
|
|
|
|
2021-02-17 14:23:32 +01:00
|
|
|
FFMPEG_GLOBAL_ARGS_DEFAULT = ["-hide_banner", "-loglevel", "warning"]
|
|
|
|
|
FFMPEG_INPUT_ARGS_DEFAULT = [
|
|
|
|
|
"-avoid_negative_ts",
|
|
|
|
|
"make_zero",
|
|
|
|
|
"-fflags",
|
|
|
|
|
"+genpts+discardcorrupt",
|
|
|
|
|
"-rtsp_transport",
|
|
|
|
|
"tcp",
|
|
|
|
|
"-stimeout",
|
|
|
|
|
"5000000",
|
|
|
|
|
"-use_wallclock_as_timestamps",
|
|
|
|
|
"1",
|
|
|
|
|
]
|
|
|
|
|
DETECT_FFMPEG_OUTPUT_ARGS_DEFAULT = ["-f", "rawvideo", "-pix_fmt", "yuv420p"]
|
2020-11-29 22:55:53 +01:00
|
|
|
RTMP_FFMPEG_OUTPUT_ARGS_DEFAULT = ["-c", "copy", "-f", "flv"]
|
2021-02-17 14:23:32 +01:00
|
|
|
SAVE_CLIPS_FFMPEG_OUTPUT_ARGS_DEFAULT = [
|
|
|
|
|
"-f",
|
|
|
|
|
"segment",
|
|
|
|
|
"-segment_time",
|
|
|
|
|
"10",
|
|
|
|
|
"-segment_format",
|
|
|
|
|
"mp4",
|
|
|
|
|
"-reset_timestamps",
|
|
|
|
|
"1",
|
|
|
|
|
"-strftime",
|
|
|
|
|
"1",
|
|
|
|
|
"-c",
|
|
|
|
|
"copy",
|
|
|
|
|
"-an",
|
|
|
|
|
]
|
|
|
|
|
RECORD_FFMPEG_OUTPUT_ARGS_DEFAULT = [
|
|
|
|
|
"-f",
|
|
|
|
|
"segment",
|
|
|
|
|
"-segment_time",
|
|
|
|
|
"60",
|
|
|
|
|
"-segment_format",
|
|
|
|
|
"mp4",
|
|
|
|
|
"-reset_timestamps",
|
|
|
|
|
"1",
|
|
|
|
|
"-strftime",
|
|
|
|
|
"1",
|
|
|
|
|
"-c",
|
|
|
|
|
"copy",
|
|
|
|
|
"-an",
|
|
|
|
|
]
|
2020-11-01 13:17:44 +01:00
|
|
|
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class FfmpegOutputArgsConfig(BaseModel):
|
2021-06-24 22:45:15 +02:00
|
|
|
detect: Union[str, List[str]] = Field(
|
2021-06-24 07:45:27 +02:00
|
|
|
default=DETECT_FFMPEG_OUTPUT_ARGS_DEFAULT,
|
|
|
|
|
title="Detect role FFmpeg output arguments.",
|
|
|
|
|
)
|
2021-06-24 22:45:15 +02:00
|
|
|
record: Union[str, List[str]] = Field(
|
2021-06-24 07:45:27 +02:00
|
|
|
default=RECORD_FFMPEG_OUTPUT_ARGS_DEFAULT,
|
|
|
|
|
title="Record role FFmpeg output arguments.",
|
|
|
|
|
)
|
2021-06-24 22:45:15 +02:00
|
|
|
clips: Union[str, List[str]] = Field(
|
2021-06-24 07:45:27 +02:00
|
|
|
default=SAVE_CLIPS_FFMPEG_OUTPUT_ARGS_DEFAULT,
|
|
|
|
|
title="Clips role FFmpeg output arguments.",
|
|
|
|
|
)
|
2021-06-24 22:45:15 +02:00
|
|
|
rtmp: Union[str, List[str]] = Field(
|
2021-06-24 07:45:27 +02:00
|
|
|
default=RTMP_FFMPEG_OUTPUT_ARGS_DEFAULT,
|
|
|
|
|
title="RTMP role FFmpeg output arguments.",
|
|
|
|
|
)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class FfmpegConfig(BaseModel):
|
|
|
|
|
global_args: Union[str, List[str]] = Field(
|
|
|
|
|
default=FFMPEG_GLOBAL_ARGS_DEFAULT, title="Global FFmpeg arguments."
|
|
|
|
|
)
|
|
|
|
|
hwaccel_args: Union[str, List[str]] = Field(
|
|
|
|
|
default_factory=list, title="FFmpeg hardware acceleration arguments."
|
|
|
|
|
)
|
|
|
|
|
input_args: Union[str, List[str]] = Field(
|
|
|
|
|
default=FFMPEG_INPUT_ARGS_DEFAULT, title="FFmpeg input arguments."
|
|
|
|
|
)
|
|
|
|
|
output_args: FfmpegOutputArgsConfig = Field(
|
|
|
|
|
default_factory=FfmpegOutputArgsConfig,
|
|
|
|
|
title="FFmpeg output arguments per role.",
|
|
|
|
|
)
|
|
|
|
|
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class CameraInput(BaseModel):
|
|
|
|
|
path: str = Field(title="Camera input path.")
|
|
|
|
|
roles: List[str] = Field(title="Roles assigned to this input.")
|
2021-06-24 22:45:15 +02:00
|
|
|
global_args: Union[str, List[str]] = Field(
|
2021-06-24 07:45:27 +02:00
|
|
|
default_factory=list, title="FFmpeg global arguments."
|
|
|
|
|
)
|
2021-06-24 22:45:15 +02:00
|
|
|
hwaccel_args: Union[str, List[str]] = Field(
|
2021-06-24 07:45:27 +02:00
|
|
|
default_factory=list, title="FFmpeg hardware acceleration arguments."
|
|
|
|
|
)
|
2021-06-24 22:45:15 +02:00
|
|
|
input_args: Union[str, List[str]] = Field(
|
|
|
|
|
default_factory=list, title="FFmpeg input arguments."
|
|
|
|
|
)
|
2021-06-24 07:45:27 +02:00
|
|
|
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class CameraFfmpegConfig(FfmpegConfig):
|
|
|
|
|
inputs: List[CameraInput] = Field(title="Camera inputs.")
|
2021-06-24 22:45:15 +02:00
|
|
|
global_args: Union[str, List[str]] = Field(
|
2021-06-24 07:45:27 +02:00
|
|
|
default_factory=list, title="FFmpeg global arguments."
|
|
|
|
|
)
|
2021-06-24 22:45:15 +02:00
|
|
|
hwaccel_args: Union[str, List[str]] = Field(
|
2021-06-24 07:45:27 +02:00
|
|
|
default_factory=list, title="FFmpeg hardware acceleration arguments."
|
|
|
|
|
)
|
2021-06-24 22:45:15 +02:00
|
|
|
input_args: Union[str, List[str]] = Field(
|
|
|
|
|
default_factory=list, title="FFmpeg input arguments."
|
|
|
|
|
)
|
2021-06-24 07:45:27 +02:00
|
|
|
output_args: FfmpegOutputArgsConfig = Field(
|
|
|
|
|
default_factory=FfmpegOutputArgsConfig, title="FFmpeg output arguments."
|
2021-02-17 14:23:32 +01:00
|
|
|
)
|
2020-11-01 13:17:44 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
@validator("inputs")
|
|
|
|
|
def validate_roles(cls, v):
|
|
|
|
|
roles = [role for i in v for role in i.roles]
|
|
|
|
|
roles_set = set(roles)
|
2020-11-03 15:15:58 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
if len(roles) > len(roles_set):
|
|
|
|
|
raise ValueError("Each input role may only be used once.")
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
if not "detect" in roles:
|
|
|
|
|
raise ValueError("The detect role is required.")
|
2021-02-17 14:23:32 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
return v
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2020-11-08 23:05:15 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class CameraSnapshotsConfig(BaseModel):
|
|
|
|
|
enabled: bool = Field(default=False, title="Snapshots enabled.")
|
|
|
|
|
clean_copy: bool = Field(
|
|
|
|
|
default=True, title="Create a clean copy of the snapshot image."
|
|
|
|
|
)
|
|
|
|
|
timestamp: bool = Field(
|
|
|
|
|
default=False, title="Add a timestamp overlay on the snapshot."
|
|
|
|
|
)
|
|
|
|
|
bounding_box: bool = Field(
|
|
|
|
|
default=True, title="Add a bounding box overlay on the snapshot."
|
|
|
|
|
)
|
|
|
|
|
crop: bool = Field(default=False, title="Crop the snapshot to the detected object.")
|
|
|
|
|
required_zones: List[str] = Field(
|
|
|
|
|
default_factory=list,
|
|
|
|
|
title="List of required zones to be entered in order to save a snapshot.",
|
|
|
|
|
)
|
|
|
|
|
height: Optional[int] = Field(title="Snapshot image height.")
|
|
|
|
|
retain: RetainConfig = Field(
|
|
|
|
|
default_factory=RetainConfig, title="Snapshot retention."
|
|
|
|
|
)
|
2021-02-17 14:23:32 +01:00
|
|
|
|
2021-06-15 22:19:49 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class ColorConfig(BaseModel):
|
|
|
|
|
red: int = Field(default=255, le=0, ge=255, title="Red")
|
|
|
|
|
green: int = Field(default=255, le=0, ge=255, title="Green")
|
|
|
|
|
blue: int = Field(default=255, le=0, ge=255, title="Blue")
|
2021-06-15 22:19:49 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class TimestampStyleConfig(BaseModel):
|
|
|
|
|
position: str = Field(default="tl", title="Timestamp position.")
|
|
|
|
|
format: str = Field(default=DEFAULT_TIME_FORMAT, title="Timestamp format.")
|
|
|
|
|
color: ColorConfig = Field(default_factory=ColorConfig, title="Timestamp color.")
|
|
|
|
|
scale: float = Field(default=1.0, title="Timestamp scale.")
|
|
|
|
|
thickness: int = Field(default=2, title="Timestamp thickness.")
|
|
|
|
|
effect: Optional[str] = Field(title="Timestamp effect.")
|
2021-06-15 22:19:49 +02:00
|
|
|
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class CameraMqttConfig(BaseModel):
|
|
|
|
|
enabled: bool = Field(default=True, title="Send image over MQTT.")
|
|
|
|
|
timestamp: bool = Field(default=True, title="Add timestamp to MQTT image.")
|
|
|
|
|
bounding_box: bool = Field(default=True, title="Add bounding box to MQTT image.")
|
|
|
|
|
crop: bool = Field(default=True, title="Crop MQTT image to detected object.")
|
|
|
|
|
height: int = Field(default=270, title="MQTT image height.")
|
|
|
|
|
required_zones: List[str] = Field(
|
|
|
|
|
default_factory=list,
|
|
|
|
|
title="List of required zones to be entered in order to send the image.",
|
|
|
|
|
)
|
2021-02-05 04:44:44 +01:00
|
|
|
|
2020-11-29 22:55:53 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class CameraClipsConfig(BaseModel):
|
|
|
|
|
enabled: bool = Field(default=False, title="Save clips.")
|
|
|
|
|
pre_capture: int = Field(default=5, title="Seconds to capture before event starts.")
|
|
|
|
|
post_capture: int = Field(default=5, title="Seconds to capture after event ends.")
|
|
|
|
|
required_zones: List[str] = Field(
|
|
|
|
|
default_factory=list,
|
|
|
|
|
title="List of required zones to be entered in order to save the clip.",
|
|
|
|
|
)
|
|
|
|
|
objects: Optional[List[str]] = Field(
|
|
|
|
|
title="List of objects to be detected in order to save the clip.",
|
|
|
|
|
)
|
|
|
|
|
retain: RetainConfig = Field(default_factory=RetainConfig, title="Clip retention.")
|
2021-02-17 14:23:32 +01:00
|
|
|
|
2020-11-03 15:15:58 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class CameraRtmpConfig(BaseModel):
|
|
|
|
|
enabled: bool = Field(default=True, title="RTMP restreaming enabled.")
|
2021-02-17 14:23:32 +01:00
|
|
|
|
2020-11-03 15:15:58 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class CameraLiveConfig(BaseModel):
|
|
|
|
|
height: Optional[int] = Field(title="Live camera view height")
|
|
|
|
|
width: Optional[int] = Field(title="Live camera view width")
|
|
|
|
|
quality: int = Field(default=8, ge=1, le=31, title="Live camera view quality")
|
2021-02-17 14:23:32 +01:00
|
|
|
|
2021-06-23 15:09:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class RecordConfig(BaseModel):
|
|
|
|
|
enabled: bool = Field(default=False, title="Enable record on all cameras.")
|
|
|
|
|
retain_days: int = Field(default=30, title="Recording retention period in days.")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class CameraConfig(BaseModel):
|
|
|
|
|
name: Optional[str] = Field(title="Camera name.")
|
|
|
|
|
ffmpeg: CameraFfmpegConfig = Field(title="FFmpeg configuration for the camera.")
|
|
|
|
|
height: int = Field(title="Height of the stream for the detect role.")
|
|
|
|
|
width: int = Field(title="Width of the stream for the detect role.")
|
|
|
|
|
fps: Optional[int] = Field(
|
|
|
|
|
title="Number of frames per second to process through Frigate."
|
|
|
|
|
)
|
|
|
|
|
best_image_timeout: int = Field(
|
|
|
|
|
default=60,
|
|
|
|
|
title="How long to wait for the image with the highest confidence score.",
|
|
|
|
|
)
|
|
|
|
|
zones: Dict[str, ZoneConfig] = Field(
|
|
|
|
|
default_factory=dict, title="Zone configuration."
|
|
|
|
|
)
|
|
|
|
|
clips: CameraClipsConfig = Field(
|
|
|
|
|
default_factory=CameraClipsConfig, title="Clip configuration."
|
|
|
|
|
)
|
|
|
|
|
record: RecordConfig = Field(
|
|
|
|
|
default_factory=RecordConfig, title="Record configuration."
|
|
|
|
|
)
|
|
|
|
|
rtmp: CameraRtmpConfig = Field(
|
|
|
|
|
default_factory=CameraRtmpConfig, title="RTMP restreaming configuration."
|
|
|
|
|
)
|
|
|
|
|
live: Optional[CameraLiveConfig] = Field(title="Live playback settings.")
|
|
|
|
|
snapshots: CameraSnapshotsConfig = Field(
|
|
|
|
|
default_factory=CameraSnapshotsConfig, title="Snapshot configuration."
|
|
|
|
|
)
|
|
|
|
|
mqtt: CameraMqttConfig = Field(
|
|
|
|
|
default_factory=CameraMqttConfig, title="MQTT configuration."
|
|
|
|
|
)
|
|
|
|
|
objects: ObjectConfig = Field(
|
|
|
|
|
default_factory=ObjectConfig, title="Object configuration."
|
|
|
|
|
)
|
|
|
|
|
motion: Optional[MotionConfig] = Field(title="Motion detection configuration.")
|
|
|
|
|
detect: Optional[DetectConfig] = Field(title="Object detection configuration.")
|
|
|
|
|
timestamp_style: Optional[TimestampStyleConfig] = Field(
|
|
|
|
|
title="Timestamp style configuration."
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
def __init__(self, **config):
|
|
|
|
|
# Set zone colors
|
|
|
|
|
if "zones" in config:
|
|
|
|
|
colors = plt.cm.get_cmap("tab10", len(config["zones"]))
|
|
|
|
|
config["zones"] = {
|
|
|
|
|
name: {**z, "color": tuple(round(255 * c) for c in colors(idx)[:3])}
|
|
|
|
|
for idx, (name, z) in enumerate(config["zones"].items())
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
super().__init__(**config)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
@property
|
|
|
|
|
def frame_shape(self) -> Tuple[int, int]:
|
|
|
|
|
return self.height, self.width
|
|
|
|
|
|
|
|
|
|
@property
|
|
|
|
|
def frame_shape_yuv(self) -> Tuple[int, int]:
|
|
|
|
|
return self.height * 3 // 2, self.width
|
|
|
|
|
|
|
|
|
|
@property
|
|
|
|
|
def ffmpeg_cmds(self) -> List[Dict[str, List[str]]]:
|
|
|
|
|
ffmpeg_cmds = []
|
|
|
|
|
for ffmpeg_input in self.ffmpeg.inputs:
|
2020-12-07 15:07:35 +01:00
|
|
|
ffmpeg_cmd = self._get_ffmpeg_cmd(ffmpeg_input)
|
|
|
|
|
if ffmpeg_cmd is None:
|
|
|
|
|
continue
|
|
|
|
|
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
ffmpeg_cmds.append({"roles": ffmpeg_input.roles, "cmd": ffmpeg_cmd})
|
|
|
|
|
return ffmpeg_cmds
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
def _get_ffmpeg_cmd(self, ffmpeg_input: CameraInput):
|
2020-11-29 22:55:53 +01:00
|
|
|
ffmpeg_output_args = []
|
2021-02-17 14:23:32 +01:00
|
|
|
if "detect" in ffmpeg_input.roles:
|
2021-06-24 22:45:15 +02:00
|
|
|
detect_args = (
|
|
|
|
|
self.ffmpeg.output_args.detect
|
|
|
|
|
if isinstance(self.ffmpeg.output_args.detect, list)
|
|
|
|
|
else self.ffmpeg.output_args.detect.split(" ")
|
2021-02-17 14:23:32 +01:00
|
|
|
)
|
2021-06-24 22:45:15 +02:00
|
|
|
ffmpeg_output_args = detect_args + ffmpeg_output_args + ["pipe:"]
|
2020-11-29 22:55:53 +01:00
|
|
|
if self.fps:
|
|
|
|
|
ffmpeg_output_args = ["-r", str(self.fps)] + ffmpeg_output_args
|
2021-02-17 14:23:32 +01:00
|
|
|
if "rtmp" in ffmpeg_input.roles and self.rtmp.enabled:
|
2021-06-24 22:45:15 +02:00
|
|
|
rtmp_args = (
|
2021-06-24 07:45:27 +02:00
|
|
|
self.ffmpeg.output_args.rtmp
|
2021-06-24 22:45:15 +02:00
|
|
|
if isinstance(self.ffmpeg.output_args.rtmp, list)
|
|
|
|
|
else self.ffmpeg.output_args.rtmp.split(" ")
|
2021-02-17 14:23:32 +01:00
|
|
|
)
|
|
|
|
|
ffmpeg_output_args = (
|
2021-06-24 22:45:15 +02:00
|
|
|
rtmp_args + [f"rtmp://127.0.0.1/live/{self.name}"] + ffmpeg_output_args
|
|
|
|
|
)
|
|
|
|
|
if "clips" in ffmpeg_input.roles:
|
|
|
|
|
clips_args = (
|
2021-06-24 07:45:27 +02:00
|
|
|
self.ffmpeg.output_args.clips
|
2021-06-24 22:45:15 +02:00
|
|
|
if isinstance(self.ffmpeg.output_args.clips, list)
|
|
|
|
|
else self.ffmpeg.output_args.clips.split(" ")
|
|
|
|
|
)
|
|
|
|
|
ffmpeg_output_args = (
|
|
|
|
|
clips_args
|
2021-02-17 14:23:32 +01:00
|
|
|
+ [f"{os.path.join(CACHE_DIR, self.name)}-%Y%m%d%H%M%S.mp4"]
|
|
|
|
|
+ ffmpeg_output_args
|
|
|
|
|
)
|
|
|
|
|
if "record" in ffmpeg_input.roles and self.record.enabled:
|
2021-06-24 22:45:15 +02:00
|
|
|
record_args = (
|
2021-06-24 07:45:27 +02:00
|
|
|
self.ffmpeg.output_args.record
|
2021-06-24 22:45:15 +02:00
|
|
|
if isinstance(self.ffmpeg.output_args.record, list)
|
|
|
|
|
else self.ffmpeg.output_args.record.split(" ")
|
|
|
|
|
)
|
|
|
|
|
ffmpeg_output_args = (
|
|
|
|
|
record_args
|
2021-02-17 14:23:32 +01:00
|
|
|
+ [f"{os.path.join(RECORD_DIR, self.name)}-%Y%m%d%H%M%S.mp4"]
|
|
|
|
|
+ ffmpeg_output_args
|
|
|
|
|
)
|
2021-01-09 18:26:46 +01:00
|
|
|
|
2020-12-07 15:07:35 +01:00
|
|
|
# if there arent any outputs enabled for this input
|
|
|
|
|
if len(ffmpeg_output_args) == 0:
|
|
|
|
|
return None
|
|
|
|
|
|
2021-06-24 22:45:15 +02:00
|
|
|
global_args = ffmpeg_input.global_args or self.ffmpeg.global_args
|
|
|
|
|
hwaccel_args = ffmpeg_input.hwaccel_args or self.ffmpeg.hwaccel_args
|
|
|
|
|
input_args = ffmpeg_input.input_args or self.ffmpeg.input_args
|
|
|
|
|
|
|
|
|
|
global_args = (
|
|
|
|
|
global_args if isinstance(global_args, list) else global_args.split(" ")
|
|
|
|
|
)
|
|
|
|
|
hwaccel_args = (
|
|
|
|
|
hwaccel_args if isinstance(hwaccel_args, list) else hwaccel_args.split(" ")
|
|
|
|
|
)
|
|
|
|
|
input_args = (
|
|
|
|
|
input_args if isinstance(input_args, list) else input_args.split(" ")
|
|
|
|
|
)
|
|
|
|
|
|
2021-02-17 14:23:32 +01:00
|
|
|
cmd = (
|
|
|
|
|
["ffmpeg"]
|
2021-06-24 22:45:15 +02:00
|
|
|
+ global_args
|
|
|
|
|
+ hwaccel_args
|
|
|
|
|
+ input_args
|
2021-02-17 14:23:32 +01:00
|
|
|
+ ["-i", ffmpeg_input.path]
|
|
|
|
|
+ ffmpeg_output_args
|
|
|
|
|
)
|
2021-01-09 18:26:46 +01:00
|
|
|
|
2021-02-17 14:23:32 +01:00
|
|
|
return [part for part in cmd if part != ""]
|
2021-01-09 18:26:46 +01:00
|
|
|
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class DatabaseConfig(BaseModel):
|
|
|
|
|
path: str = Field(
|
|
|
|
|
default=os.path.join(BASE_DIR, "frigate.db"), title="Database path."
|
|
|
|
|
)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class ModelConfig(BaseModel):
|
|
|
|
|
width: int = Field(default=320, title="Object detection model input width.")
|
|
|
|
|
height: int = Field(default=320, title="Object detection model input height.")
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class LogLevelEnum(str, Enum):
|
|
|
|
|
debug = "debug"
|
|
|
|
|
info = "info"
|
|
|
|
|
warning = "warning"
|
|
|
|
|
error = "error"
|
|
|
|
|
critical = "critical"
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class LoggerConfig(BaseModel):
|
|
|
|
|
default: LogLevelEnum = Field(
|
|
|
|
|
default=LogLevelEnum.info, title="Default logging level."
|
|
|
|
|
)
|
|
|
|
|
logs: Dict[str, LogLevelEnum] = Field(
|
|
|
|
|
default_factory=dict, title="Log level for specified processes."
|
|
|
|
|
)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class SnapshotsConfig(BaseModel):
|
|
|
|
|
retain: RetainConfig = Field(
|
|
|
|
|
default_factory=RetainConfig, title="Global snapshot retention configuration."
|
|
|
|
|
)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
class FrigateConfig(BaseModel):
|
|
|
|
|
mqtt: MqttConfig = Field(title="MQTT Configuration.")
|
|
|
|
|
database: DatabaseConfig = Field(
|
|
|
|
|
default_factory=DatabaseConfig, title="Database configuration."
|
|
|
|
|
)
|
|
|
|
|
environment_vars: Dict[str, str] = Field(
|
|
|
|
|
default_factory=dict, title="Frigate environment variables."
|
|
|
|
|
)
|
|
|
|
|
model: ModelConfig = Field(
|
|
|
|
|
default_factory=ModelConfig, title="Detection model configuration."
|
|
|
|
|
)
|
|
|
|
|
detectors: Dict[str, DetectorConfig] = Field(
|
|
|
|
|
default={name: DetectorConfig(**d) for name, d in DEFAULT_DETECTORS.items()},
|
|
|
|
|
title="Detector hardware configuration.",
|
|
|
|
|
)
|
|
|
|
|
logger: LoggerConfig = Field(
|
|
|
|
|
default_factory=LoggerConfig, title="Logging configuration."
|
|
|
|
|
)
|
|
|
|
|
clips: ClipsConfig = Field(
|
|
|
|
|
default_factory=ClipsConfig, title="Global clips configuration."
|
|
|
|
|
)
|
|
|
|
|
record: RecordConfig = Field(
|
|
|
|
|
default_factory=RecordConfig, title="Global record configuration."
|
|
|
|
|
)
|
|
|
|
|
snapshots: SnapshotsConfig = Field(
|
|
|
|
|
default_factory=SnapshotsConfig, title="Global snapshots configuration."
|
|
|
|
|
)
|
|
|
|
|
birdseye: BirdseyeConfig = Field(
|
|
|
|
|
default_factory=BirdseyeConfig, title="Birdseye configuration."
|
|
|
|
|
)
|
|
|
|
|
ffmpeg: FfmpegConfig = Field(
|
|
|
|
|
default_factory=FfmpegConfig, title="Global FFmpeg configuration."
|
|
|
|
|
)
|
|
|
|
|
objects: ObjectConfig = Field(
|
|
|
|
|
default_factory=ObjectConfig, title="Global object configuration."
|
|
|
|
|
)
|
|
|
|
|
motion: Optional[MotionConfig] = Field(
|
|
|
|
|
title="Global motion detection configuration."
|
|
|
|
|
)
|
|
|
|
|
detect: Optional[DetectConfig] = Field(
|
|
|
|
|
title="Global object tracking configuration."
|
|
|
|
|
)
|
|
|
|
|
cameras: Dict[str, CameraConfig] = Field(title="Camera configuration.")
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
@property
|
|
|
|
|
def runtime_config(self) -> FrigateConfig:
|
|
|
|
|
"""Merge camera config with globals."""
|
|
|
|
|
config = self.copy(deep=True)
|
2021-06-24 22:53:01 +02:00
|
|
|
|
|
|
|
|
# MQTT password substitution
|
|
|
|
|
if config.mqtt.password:
|
|
|
|
|
config.mqtt.password = config.mqtt.password.format(**FRIGATE_ENV_VARS)
|
|
|
|
|
|
|
|
|
|
# Global config to propegate down to camera level
|
2021-06-24 07:45:27 +02:00
|
|
|
global_config = config.dict(
|
|
|
|
|
include={
|
|
|
|
|
"clips": {"retain"},
|
|
|
|
|
"record": ...,
|
|
|
|
|
"snapshots": ...,
|
|
|
|
|
"objects": ...,
|
|
|
|
|
"motion": ...,
|
|
|
|
|
"detect": ...,
|
|
|
|
|
"ffmpeg": ...,
|
|
|
|
|
},
|
|
|
|
|
exclude_unset=True,
|
|
|
|
|
)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
for name, camera in config.cameras.items():
|
|
|
|
|
merged_config = deep_merge(camera.dict(exclude_unset=True), global_config)
|
|
|
|
|
camera_config = CameraConfig.parse_obj({"name": name, **merged_config})
|
|
|
|
|
|
2021-06-24 22:53:01 +02:00
|
|
|
# FFMPEG input substitution
|
|
|
|
|
for input in camera_config.ffmpeg.inputs:
|
|
|
|
|
input.path = input.path.format(**FRIGATE_ENV_VARS)
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
# Add default filters
|
|
|
|
|
object_keys = camera_config.objects.track
|
|
|
|
|
if camera_config.objects.filters is None:
|
|
|
|
|
camera_config.objects.filters = {}
|
|
|
|
|
object_keys = object_keys - camera_config.objects.filters.keys()
|
|
|
|
|
for key in object_keys:
|
|
|
|
|
camera_config.objects.filters[key] = FilterConfig()
|
|
|
|
|
|
|
|
|
|
# Apply global object masks and convert masks to numpy array
|
|
|
|
|
for object, filter in camera_config.objects.filters.items():
|
|
|
|
|
if camera_config.objects.mask:
|
|
|
|
|
filter_mask = []
|
|
|
|
|
if filter.mask is not None:
|
|
|
|
|
filter_mask = (
|
|
|
|
|
filter.mask
|
|
|
|
|
if isinstance(filter.mask, list)
|
|
|
|
|
else [filter.mask]
|
|
|
|
|
)
|
|
|
|
|
object_mask = (
|
|
|
|
|
camera_config.objects.mask
|
|
|
|
|
if isinstance(camera_config.objects.mask, list)
|
|
|
|
|
else [camera_config.objects.mask]
|
|
|
|
|
)
|
|
|
|
|
filter.mask = filter_mask + object_mask
|
|
|
|
|
|
|
|
|
|
# Set runtime filter to create masks
|
|
|
|
|
camera_config.objects.filters[object] = RuntimeFilterConfig(
|
|
|
|
|
frame_shape=camera_config.frame_shape,
|
|
|
|
|
**filter.dict(exclude_unset=True),
|
|
|
|
|
)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
# Convert motion configuration
|
|
|
|
|
if camera_config.motion is None:
|
|
|
|
|
camera_config.motion = RuntimeMotionConfig(
|
|
|
|
|
frame_shape=camera_config.frame_shape
|
|
|
|
|
)
|
|
|
|
|
else:
|
|
|
|
|
camera_config.motion = RuntimeMotionConfig(
|
|
|
|
|
frame_shape=camera_config.frame_shape,
|
|
|
|
|
raw_mask=camera_config.motion.mask,
|
|
|
|
|
**camera_config.motion.dict(exclude_unset=True),
|
|
|
|
|
)
|
Use dataclasses for config handling
Use config data classes to eliminate some of the boilerplate associated
with setting up the configuration. In particular, using dataclasses
removes a lot of the boilerplate around assigning properties to the
object and allows these to be easily immutable by freezing them. In the
case of simple, non-nested dataclasses, this also provides more
convenient `asdict` helpers.
To set this up, where previously the objects would be parsed from the
config via the `__init__` method, create a `build` classmethod that does
this and calls the dataclass initializer.
Some of the objects are mutated at runtime, in particular some of the
zones are mutated to set the color (this might be able to be refactored
out) and some of the camera functionality can be enabled/disabled. Some
of the configs with `enabled` properties don't seem to have mqtt hooks
to be able to toggle this, in particular, the clips, snapshots, and
detect can be toggled but rtmp and record configs do not, but all of
these configs are still not frozen in case there is some other
functionality I am missing.
There are a couple other minor fixes here, one that was introduced
by me recently where `max_seconds` was not defined, the other to
properly `get()` the message payload when handling publishing mqtt
messages sent via websocket.
2021-05-23 00:28:15 +02:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
# Default detect configuration
|
|
|
|
|
if camera_config.detect is None:
|
|
|
|
|
max_disappeared = (camera_config.fps or 5) * 5
|
|
|
|
|
camera_config.detect = DetectConfig(max_disappeared=max_disappeared)
|
|
|
|
|
|
|
|
|
|
# Default live configuration
|
|
|
|
|
if camera_config.live:
|
|
|
|
|
if (
|
|
|
|
|
camera_config.live.height
|
|
|
|
|
and camera_config.live.height <= camera_config.height
|
|
|
|
|
):
|
|
|
|
|
camera_config.live.width = int(
|
|
|
|
|
camera_config.live.height
|
|
|
|
|
* (camera_config.width / camera_config.height)
|
|
|
|
|
)
|
|
|
|
|
else:
|
|
|
|
|
camera_config.live.height = camera_config.height
|
|
|
|
|
camera_config.live.width = camera_config.width
|
|
|
|
|
else:
|
|
|
|
|
camera_config.live = CameraLiveConfig(
|
|
|
|
|
height=camera_config.height, width=camera_config.width
|
|
|
|
|
)
|
2021-01-09 18:26:46 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
config.cameras[name] = camera_config
|
2021-01-09 18:26:46 +01:00
|
|
|
|
2020-11-03 15:15:58 +01:00
|
|
|
return config
|
|
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
@validator("cameras")
|
|
|
|
|
def ensure_zones_and_cameras_have_different_names(cls, v: Dict[str, CameraConfig]):
|
|
|
|
|
zones = [zone for camera in v.values() for zone in camera.zones.keys()]
|
|
|
|
|
for zone in zones:
|
|
|
|
|
if zone in v.keys():
|
|
|
|
|
raise ValueError("Zones cannot share names with cameras")
|
|
|
|
|
return v
|
|
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
|
def parse_file(cls, config_file):
|
2020-11-03 15:15:58 +01:00
|
|
|
with open(config_file) as f:
|
|
|
|
|
raw_config = f.read()
|
2021-01-09 18:26:46 +01:00
|
|
|
|
|
|
|
|
if config_file.endswith(".yml"):
|
2020-11-03 15:15:58 +01:00
|
|
|
config = yaml.safe_load(raw_config)
|
|
|
|
|
elif config_file.endswith(".json"):
|
|
|
|
|
config = json.loads(raw_config)
|
2021-01-09 18:26:46 +01:00
|
|
|
|
2021-06-24 07:45:27 +02:00
|
|
|
return cls.parse_obj(config)
|
