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
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-08-16 15:02:04 +02:00
from enum import Enum
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-08-16 15:02:04 +02:00
import yaml
2021-09-04 23:56:01 +02:00
from pydantic import BaseModel , Extra , Field , validator
2021-06-24 07:45:27 +02:00
from pydantic . fields import PrivateAttr
2020-11-01 13:17:44 +01:00
2021-12-12 16:27:05 +01:00
from frigate . const import BASE_DIR , CACHE_DIR , YAML_EXT
2021-12-31 18:59:43 +01:00
from frigate . util import create_mask , deep_merge , load_labels
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 " ]
2021-08-16 14:39:20 +02:00
DEFAULT_DETECTORS = { " cpu " : { " type " : " 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-09-04 23:56:01 +02:00
class FrigateBaseModel ( BaseModel ) :
class Config :
extra = Extra . forbid
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-09-04 23:56:01 +02:00
class DetectorConfig ( FrigateBaseModel ) :
2021-08-16 14:39:20 +02:00
type : DetectorTypeEnum = Field ( default = DetectorTypeEnum . cpu , title = " Detector Type " )
2021-06-24 07:45:27 +02:00
device : str = Field ( default = " usb " , title = " Device Type " )
num_threads : int = Field ( default = 3 , title = " Number of detection threads " )
2022-02-27 15:04:12 +01:00
class UIConfig ( FrigateBaseModel ) :
use_experimental : bool = Field ( default = False , title = " Experimental UI " )
2021-06-24 07:45:27 +02:00
2021-09-04 23:56:01 +02:00
class MqttConfig ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
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
2021-12-11 16:22:44 +01:00
class RetainModeEnum ( str , Enum ) :
all = " all "
motion = " motion "
active_objects = " active_objects "
2021-09-04 23:56:01 +02:00
class RetainConfig ( FrigateBaseModel ) :
2021-09-21 01:59:16 +02:00
default : float = Field ( default = 10 , title = " Default retention period. " )
2022-02-05 16:28:21 +01:00
mode : RetainModeEnum = Field ( default = RetainModeEnum . motion , title = " Retain mode. " )
2021-09-21 01:59:16 +02:00
objects : Dict [ str , float ] = Field (
2021-06-24 07:45:27 +02:00
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-09-08 15:02:26 +02:00
class EventsConfig ( FrigateBaseModel ) :
max_seconds : int = Field ( default = 300 , title = " Maximum event duration. " )
pre_capture : int = Field ( default = 5 , title = " Seconds to retain before event starts. " )
post_capture : int = Field ( default = 5 , title = " Seconds to retain after event ends. " )
2021-07-09 22:14:16 +02:00
required_zones : List [ str ] = Field (
default_factory = list ,
2021-09-08 15:02:26 +02:00
title = " List of required zones to be entered in order to save the event. " ,
2021-07-09 22:14:16 +02:00
)
objects : Optional [ List [ str ] ] = Field (
2021-09-08 15:02:26 +02:00
title = " List of objects to be detected in order to save the event. " ,
2021-07-09 22:14:16 +02:00
)
2021-06-24 07:45:27 +02:00
retain : RetainConfig = Field (
2021-09-08 15:02:26 +02:00
default_factory = RetainConfig , title = " Event retention settings. "
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-12-11 16:22:44 +01:00
class RecordRetainConfig ( FrigateBaseModel ) :
days : float = Field ( default = 0 , title = " Default retention period. " )
mode : RetainModeEnum = Field ( default = RetainModeEnum . all , title = " Retain mode. " )
2021-09-04 23:56:01 +02:00
class RecordConfig ( FrigateBaseModel ) :
2021-07-09 22:14:16 +02:00
enabled : bool = Field ( default = False , title = " Enable record on all cameras. " )
2022-02-05 15:51:18 +01:00
expire_interval : int = Field (
default = 60 ,
title = " Number of minutes to wait between cleanup runs. " ,
)
2021-12-11 16:22:44 +01:00
# deprecated - to be removed in a future version
retain_days : Optional [ float ] = Field ( title = " Recording retention period in days. " )
retain : RecordRetainConfig = Field (
default_factory = RecordRetainConfig , title = " Record retention settings. "
)
2021-09-08 15:02:26 +02:00
events : EventsConfig = Field (
default_factory = EventsConfig , title = " Event specific settings. "
2021-07-09 22:14:16 +02:00
)
2021-09-04 23:56:01 +02:00
class MotionConfig ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
threshold : int = Field (
default = 25 ,
title = " Motion detection threshold (1-255). " ,
ge = 1 ,
le = 255 ,
)
2021-11-07 20:16:38 +01:00
contour_area : Optional [ int ] = Field ( default = 30 , title = " Contour Area " )
2021-06-24 07:45:27 +02:00
delta_alpha : float = Field ( default = 0.2 , title = " Delta Alpha " )
frame_alpha : float = Field ( default = 0.2 , title = " Frame Alpha " )
2021-11-07 20:16:38 +01:00
frame_height : Optional [ int ] = Field ( default = 50 , title = " Frame Height " )
2021-06-24 07:45:27 +02:00
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
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
2021-09-04 23:56:01 +02:00
extra = Extra . ignore
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
2022-02-13 15:58:44 +01:00
class StationaryMaxFramesConfig ( FrigateBaseModel ) :
default : Optional [ int ] = Field ( title = " Default max frames. " , ge = 1 )
objects : Dict [ str , int ] = Field (
default_factory = dict , title = " Object specific max frames. "
)
class StationaryConfig ( FrigateBaseModel ) :
interval : Optional [ int ] = Field (
default = 0 ,
title = " Frame interval for checking stationary objects. " ,
ge = 0 ,
)
threshold : Optional [ int ] = Field (
title = " Number of frames without a position change for an object to be considered stationary " ,
ge = 1 ,
)
max_frames : StationaryMaxFramesConfig = Field (
default_factory = StationaryMaxFramesConfig ,
title = " Max frames for stationary objects. " ,
)
2021-09-04 23:56:01 +02:00
class DetectConfig ( FrigateBaseModel ) :
2021-08-28 15:51:29 +02:00
height : int = Field ( default = 720 , title = " Height of the stream for the detect role. " )
width : int = Field ( default = 1280 , title = " Width of the stream for the detect role. " )
fps : int = Field (
default = 5 , title = " Number of frames per second to process through detection. "
)
2021-06-24 07:45:27 +02:00
enabled : bool = Field ( default = True , title = " Detection Enabled. " )
2021-06-26 16:57:32 +02:00
max_disappeared : Optional [ int ] = Field (
2021-06-24 07:45:27 +02:00
title = " Maximum number of frames the object can dissapear before detection ends. "
)
2022-02-13 15:58:44 +01:00
stationary : StationaryConfig = Field (
default_factory = StationaryConfig ,
title = " Stationary objects config. " ,
2022-02-08 14:40:45 +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-09-04 23:56:01 +02:00
class FilterConfig ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
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
2021-09-04 23:56:01 +02:00
extra = Extra . ignore
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-09-04 23:56:01 +02:00
# this uses the base model because the color is an extra attribute
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. "
)
2021-07-07 14:31:42 +02:00
objects : List [ str ] = Field (
default_factory = list ,
title = " List of objects that can trigger the zone. " ,
)
2021-06-24 07:45:27 +02:00
_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-09-04 23:56:01 +02:00
class ObjectConfig ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
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-09-04 23:56:01 +02:00
class BirdseyeConfig ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
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. " )
2021-07-02 14:50:09 +02:00
quality : int = Field (
default = 8 ,
title = " Encoding quality. " ,
ge = 1 ,
le = 31 ,
)
2021-06-24 07:45:27 +02:00
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
RECORD_FFMPEG_OUTPUT_ARGS_DEFAULT = [
" -f " ,
" segment " ,
" -segment_time " ,
2021-07-09 22:14:16 +02:00
" 10 " ,
2021-02-17 14:23:32 +01:00
" -segment_format " ,
2021-10-23 02:17:55 +02:00
" mp4 " ,
2021-02-17 14:23:32 +01:00
" -reset_timestamps " ,
" 1 " ,
" -strftime " ,
" 1 " ,
" -c " ,
" copy " ,
2021-10-23 02:17:55 +02:00
" -an " ,
2021-02-17 14:23:32 +01:00
]
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-09-04 23:56:01 +02:00
class FfmpegOutputArgsConfig ( FrigateBaseModel ) :
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
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-09-04 23:56:01 +02:00
class FfmpegConfig ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
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-08-28 15:16:25 +02:00
class CameraRoleEnum ( str , Enum ) :
record = " record "
rtmp = " rtmp "
detect = " detect "
2021-09-04 23:56:01 +02:00
class CameraInput ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
path : str = Field ( title = " Camera input path. " )
2021-08-28 15:16:25 +02:00
roles : List [ CameraRoleEnum ] = 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. " )
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-09-04 23:56:01 +02:00
class SnapshotsConfig ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
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-07-02 14:47:03 +02:00
quality : int = Field (
default = 70 ,
title = " Quality of the encoded jpeg (0-100). " ,
ge = 0 ,
le = 100 ,
)
2021-02-17 14:23:32 +01:00
2021-06-15 22:19:49 +02:00
2021-09-04 23:56:01 +02:00
class ColorConfig ( FrigateBaseModel ) :
2021-09-04 23:39:56 +02:00
red : int = Field ( default = 255 , ge = 0 , le = 255 , title = " Red " )
green : int = Field ( default = 255 , ge = 0 , le = 255 , title = " Green " )
blue : int = Field ( default = 255 , ge = 0 , le = 255 , title = " Blue " )
2021-06-15 22:19:49 +02:00
2021-09-04 23:34:48 +02:00
class TimestampPositionEnum ( str , Enum ) :
tl = " tl "
tr = " tr "
bl = " bl "
br = " br "
class TimestampEffectEnum ( str , Enum ) :
solid = " solid "
shadow = " shadow "
2021-09-04 23:56:01 +02:00
class TimestampStyleConfig ( FrigateBaseModel ) :
2021-09-04 23:34:48 +02:00
position : TimestampPositionEnum = Field (
default = TimestampPositionEnum . tl , title = " Timestamp position. "
)
2021-06-24 07:45:27 +02:00
format : str = Field ( default = DEFAULT_TIME_FORMAT , title = " Timestamp format. " )
color : ColorConfig = Field ( default_factory = ColorConfig , title = " Timestamp color. " )
thickness : int = Field ( default = 2 , title = " Timestamp thickness. " )
2021-09-04 23:34:48 +02:00
effect : Optional [ TimestampEffectEnum ] = 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-09-04 23:56:01 +02:00
class CameraMqttConfig ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
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-07-02 14:47:03 +02:00
quality : int = Field (
default = 70 ,
title = " Quality of the encoded jpeg (0-100). " ,
ge = 0 ,
le = 100 ,
)
2021-02-05 04:44:44 +01:00
2020-11-29 22:55:53 +01:00
2021-09-04 23:56:01 +02:00
class RtmpConfig ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
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-09-04 23:56:01 +02:00
class CameraLiveConfig ( FrigateBaseModel ) :
2021-07-21 14:47:11 +02:00
height : int = Field ( default = 720 , title = " Live camera view height " )
2021-06-24 07:45:27 +02:00
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-09-04 23:56:01 +02:00
class CameraConfig ( FrigateBaseModel ) :
2022-02-05 21:31:06 +01:00
name : Optional [ str ] = Field ( title = " Camera name. " , regex = " ^[a-zA-Z0-9_-]+$ " )
2021-06-24 07:45:27 +02:00
ffmpeg : CameraFfmpegConfig = Field ( title = " FFmpeg configuration for the camera. " )
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. "
)
record : RecordConfig = Field (
default_factory = RecordConfig , title = " Record configuration. "
)
2021-09-03 14:03:36 +02:00
rtmp : RtmpConfig = Field (
default_factory = RtmpConfig , title = " RTMP restreaming configuration. "
2021-06-24 07:45:27 +02:00
)
2021-08-28 16:14:00 +02:00
live : CameraLiveConfig = Field (
default_factory = CameraLiveConfig , title = " Live playback settings. "
)
snapshots : SnapshotsConfig = Field (
default_factory = SnapshotsConfig , title = " Snapshot configuration. "
2021-06-24 07:45:27 +02:00
)
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. " )
2021-08-28 16:14:00 +02:00
detect : DetectConfig = Field (
default_factory = DetectConfig , title = " Object detection configuration. "
)
2021-06-24 23:02:46 +02:00
timestamp_style : TimestampStyleConfig = Field (
default_factory = TimestampStyleConfig , title = " Timestamp style configuration. "
2021-06-24 07:45:27 +02:00
)
2021-11-08 14:32:29 +01:00
_ffmpeg_cmds : List [ Dict [ str , List [ str ] ] ] = PrivateAttr ( )
2021-06-24 07:45:27 +02:00
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 ( ) )
}
2021-10-16 14:46:39 +02:00
# add roles to the input if there is only one
if len ( config [ " ffmpeg " ] [ " inputs " ] ) == 1 :
config [ " ffmpeg " ] [ " inputs " ] [ 0 ] [ " roles " ] = [ " record " , " rtmp " , " detect " ]
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
@property
def frame_shape ( self ) - > Tuple [ int , int ] :
2021-08-14 21:18:35 +02:00
return self . detect . height , self . detect . width
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_yuv ( self ) - > Tuple [ int , int ] :
2021-08-14 21:18:35 +02:00
return self . detect . height * 3 / / 2 , self . detect . width
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 ffmpeg_cmds ( self ) - > List [ Dict [ str , List [ str ] ] ] :
2021-11-08 14:32:29 +01:00
return self . _ffmpeg_cmds
2021-11-09 02:05:39 +01:00
def create_ffmpeg_cmds ( self ) :
2022-01-14 14:31:25 +01:00
if " _ffmpeg_cmds " in self :
return
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 = [ ]
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 } )
2021-11-09 01:20:47 +01:00
self . _ffmpeg_cmds = ffmpeg_cmds
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 _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-08-14 21:18:35 +02:00
ffmpeg_output_args = (
[
" -r " ,
str ( self . detect . fps ) ,
" -s " ,
f " { self . detect . width } x { self . detect . height } " ,
]
+ detect_args
+ ffmpeg_output_args
+ [ " pipe: " ]
)
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
)
2021-08-15 15:30:27 +02:00
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 ( " " )
)
2021-10-16 17:36:13 +02:00
2021-06-24 22:45:15 +02:00
ffmpeg_output_args = (
record_args
2021-10-23 02:17:55 +02:00
+ [ f " { os . path . join ( CACHE_DIR , self . name ) } -%Y%m%d%H%M%S.mp4 " ]
2021-02-17 14:23:32 +01:00
+ 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-09-04 23:56:01 +02:00
class DatabaseConfig ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
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-09-04 23:56:01 +02:00
class ModelConfig ( FrigateBaseModel ) :
2021-09-12 08:06:37 +02:00
path : Optional [ str ] = Field ( title = " Custom Object detection model path. " )
labelmap_path : Optional [ str ] = Field ( title = " Label map for custom object detector. " )
2021-06-24 07:45:27 +02:00
width : int = Field ( default = 320 , title = " Object detection model input width. " )
height : int = Field ( default = 320 , title = " Object detection model input height. " )
2021-07-08 05:57:19 +02:00
labelmap : Dict [ int , str ] = Field (
default_factory = dict , title = " Labelmap customization. "
)
_merged_labelmap : Optional [ Dict [ int , str ] ] = PrivateAttr ( )
2021-08-16 15:02:04 +02:00
_colormap : Dict [ int , Tuple [ int , int , int ] ] = PrivateAttr ( )
2021-07-08 05:57:19 +02:00
@property
def merged_labelmap ( self ) - > Dict [ int , str ] :
return self . _merged_labelmap
2021-08-16 15:02:04 +02:00
@property
2021-12-31 18:59:43 +01:00
def colormap ( self ) - > Dict [ int , Tuple [ int , int , int ] ] :
2021-08-16 15:02:04 +02:00
return self . _colormap
2021-07-08 05:57:19 +02:00
def __init__ ( self , * * config ) :
super ( ) . __init__ ( * * config )
self . _merged_labelmap = {
2021-09-12 08:06:37 +02:00
* * load_labels ( config . get ( " labelmap_path " , " /labelmap.txt " ) ) ,
2021-07-08 05:57:19 +02:00
* * config . get ( " labelmap " , { } ) ,
}
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-08-16 15:02:04 +02:00
cmap = plt . cm . get_cmap ( " tab10 " , len ( self . _merged_labelmap . keys ( ) ) )
self . _colormap = { }
for key , val in self . _merged_labelmap . items ( ) :
self . _colormap [ val ] = tuple ( int ( round ( 255 * c ) ) for c in cmap ( key ) [ : 3 ] )
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-09-04 23:56:01 +02:00
class LoggerConfig ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
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-09-04 23:56:01 +02:00
class FrigateConfig ( FrigateBaseModel ) :
2021-06-24 07:45:27 +02:00
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. "
)
2022-02-27 15:04:12 +01:00
ui : UIConfig = Field ( default_factory = UIConfig , title = " UI configuration. " )
2021-06-24 07:45:27 +02:00
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. "
)
record : RecordConfig = Field (
default_factory = RecordConfig , title = " Global record configuration. "
)
snapshots : SnapshotsConfig = Field (
default_factory = SnapshotsConfig , title = " Global snapshots configuration. "
)
2021-09-14 03:33:00 +02:00
live : CameraLiveConfig = Field (
default_factory = CameraLiveConfig , title = " Global live configuration. "
)
2021-09-03 14:03:36 +02:00
rtmp : RtmpConfig = Field (
default_factory = RtmpConfig , title = " Global RTMP restreaming configuration. "
)
2021-06-24 07:45:27 +02:00
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. "
)
2021-08-28 16:14:00 +02:00
detect : DetectConfig = Field (
default_factory = DetectConfig , title = " Global object tracking configuration. "
2021-06-24 07:45:27 +02:00
)
cameras : Dict [ str , CameraConfig ] = Field ( title = " Camera configuration. " )
2021-09-03 14:03:36 +02:00
timestamp_style : TimestampStyleConfig = Field (
default_factory = TimestampStyleConfig ,
title = " Global timestamp style 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 = {
" record " : . . . ,
" snapshots " : . . . ,
2021-09-14 03:33:00 +02:00
" live " : . . . ,
2021-09-03 14:03:36 +02:00
" rtmp " : . . . ,
2021-06-24 07:45:27 +02:00
" objects " : . . . ,
" motion " : . . . ,
" detect " : . . . ,
" ffmpeg " : . . . ,
2021-09-03 14:03:36 +02:00
" timestamp_style " : . . . ,
2021-06-24 07:45:27 +02:00
} ,
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 )
2021-07-09 22:14:16 +02:00
camera_config : CameraConfig = CameraConfig . parse_obj (
{ " name " : name , * * merged_config }
)
2021-06-24 07:45:27 +02:00
2021-08-28 16:14:00 +02:00
# Default max_disappeared configuration
2021-08-28 15:51:29 +02:00
max_disappeared = camera_config . detect . fps * 5
if camera_config . detect . max_disappeared is None :
camera_config . detect . max_disappeared = max_disappeared
2022-02-11 14:12:51 +01:00
# Default stationary_threshold configuration
2022-02-11 14:30:47 +01:00
stationary_threshold = camera_config . detect . fps * 10
2022-02-13 15:58:44 +01:00
if camera_config . detect . stationary . threshold is None :
camera_config . detect . stationary . threshold = stationary_threshold
2022-02-11 14:12:51 +01:00
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-10-23 02:41:28 +02:00
# check runtime config
2021-10-24 20:33:13 +02:00
assigned_roles = list (
set ( [ r for i in camera_config . ffmpeg . inputs for r in i . roles ] )
)
if camera_config . record . enabled and not " record " in assigned_roles :
raise ValueError (
f " Camera { name } has record enabled, but record is not assigned to an input. "
2021-10-23 02:41:28 +02:00
)
2021-10-24 20:33:13 +02:00
if camera_config . rtmp . enabled and not " rtmp " in assigned_roles :
raise ValueError (
f " Camera { name } has rtmp enabled, but rtmp is not assigned to an input. "
)
2021-12-11 16:22:44 +01:00
# backwards compatibility for retain_days
if not camera_config . record . retain_days is None :
logger . warning (
" The ' retain_days ' config option has been DEPRECATED and will be removed in a future version. Please use the ' days ' setting under ' retain ' "
)
if camera_config . record . retain . days == 0 :
camera_config . record . retain . days = camera_config . record . retain_days
2021-12-11 20:33:52 +01:00
# warning if the higher level record mode is potentially more restrictive than the events
2022-02-06 17:12:49 +01:00
rank_map = {
RetainModeEnum . all : 0 ,
RetainModeEnum . motion : 1 ,
RetainModeEnum . active_objects : 2 ,
}
2021-12-11 20:33:52 +01:00
if (
camera_config . record . retain . days != 0
2022-02-06 17:12:49 +01:00
and rank_map [ camera_config . record . retain . mode ]
> rank_map [ camera_config . record . events . retain . mode ]
2021-12-11 20:33:52 +01:00
) :
logger . warning (
2022-02-06 17:12:49 +01:00
f " { name } : Recording retention is configured for { camera_config . record . retain . mode } and event retention is configured for { camera_config . record . events . retain . mode } . The more restrictive retention policy will be applied. "
2021-12-11 20:33:52 +01:00
)
2022-01-14 14:31:25 +01:00
# generage the ffmpeg commands
camera_config . create_ffmpeg_cmds ( )
2021-10-24 20:33:13 +02:00
config . cameras [ name ] = camera_config
2021-10-23 02:41:28 +02: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
2021-12-12 16:27:05 +01:00
if config_file . endswith ( YAML_EXT ) :
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 )
