mirror of
https://github.com/blakeblackshear/frigate.git
synced 2026-02-20 13:54:36 +01:00
4c689dde8e
* Add optional idle heartbeat for Birdseye (periodic frame emission when idle) birdseye: add optional idle heartbeat and FFmpeg tuning envs (default off) This adds an optional configuration field `birdseye.idle_heartbeat_fps` to enable a lightweight idle heartbeat mechanism in Birdseye. When set to a value greater than 0, Birdseye periodically re-sends the last composed frame during idle periods (no motion or active updates). This helps downstream consumers such as go2rtc, Alexa, or Scrypted to attach faster and maintain a low-latency RTSP stream when the system is idle. Key details: - Config-based (`birdseye.idle_heartbeat_fps`), default `0` (disabled). - Uses existing Birdseye rendering pipeline; minimal performance impact. - Does not alter behavior when unset. Documentation: added tip section in docs/configuration/restream.md. * Update docs/docs/configuration/restream.md Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com> * Update docs/docs/configuration/reference.md Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com> * Refactors Birdseye idle frame broadcasting Simplifies the idle frame broadcasting logic by removing the dedicated thread. The idle frame is now resent directly within the main loop, improving efficiency and reducing complexity. Also, limits the idle heartbeat FPS to a maximum of 10 since the framebuffer is limited to 10 anyway * ruff fix --------- Co-authored-by: Nicolas Mowen <nickmowen213@gmail.com> Co-authored-by: Francesco Durighetto <francesco.durighetto@subbyx.com> Co-authored-by: duri <duri@homelabubuntu.durihome.unifi>
74 lines
2.0 KiB
Python
74 lines
2.0 KiB
Python
from enum import Enum
|
|
from typing import Optional
|
|
|
|
from pydantic import BaseModel, Field
|
|
|
|
from ..base import FrigateBaseModel
|
|
|
|
__all__ = [
|
|
"BirdseyeCameraConfig",
|
|
"BirdseyeConfig",
|
|
"BirdseyeLayoutConfig",
|
|
"BirdseyeModeEnum",
|
|
]
|
|
|
|
|
|
class BirdseyeModeEnum(str, Enum):
|
|
objects = "objects"
|
|
motion = "motion"
|
|
continuous = "continuous"
|
|
|
|
@classmethod
|
|
def get_index(cls, type):
|
|
return list(cls).index(type)
|
|
|
|
@classmethod
|
|
def get(cls, index):
|
|
return list(cls)[index]
|
|
|
|
|
|
class BirdseyeLayoutConfig(FrigateBaseModel):
|
|
scaling_factor: float = Field(
|
|
default=2.0, title="Birdseye Scaling Factor", ge=1.0, le=5.0
|
|
)
|
|
max_cameras: Optional[int] = Field(default=None, title="Max cameras")
|
|
|
|
|
|
class BirdseyeConfig(FrigateBaseModel):
|
|
enabled: bool = Field(default=True, title="Enable birdseye view.")
|
|
mode: BirdseyeModeEnum = Field(
|
|
default=BirdseyeModeEnum.objects, title="Tracking mode."
|
|
)
|
|
|
|
restream: bool = Field(default=False, title="Restream birdseye via RTSP.")
|
|
width: int = Field(default=1280, title="Birdseye width.")
|
|
height: int = Field(default=720, title="Birdseye height.")
|
|
quality: int = Field(
|
|
default=8,
|
|
title="Encoding quality.",
|
|
ge=1,
|
|
le=31,
|
|
)
|
|
inactivity_threshold: int = Field(
|
|
default=30, title="Birdseye Inactivity Threshold", gt=0
|
|
)
|
|
layout: BirdseyeLayoutConfig = Field(
|
|
default_factory=BirdseyeLayoutConfig, title="Birdseye Layout Config"
|
|
)
|
|
idle_heartbeat_fps: float = Field(
|
|
default=0.0,
|
|
ge=0.0,
|
|
le=10.0,
|
|
title="Idle heartbeat FPS (0 disables, max 10)",
|
|
)
|
|
|
|
|
|
# uses BaseModel because some global attributes are not available at the camera level
|
|
class BirdseyeCameraConfig(BaseModel):
|
|
enabled: bool = Field(default=True, title="Enable birdseye view for camera.")
|
|
mode: BirdseyeModeEnum = Field(
|
|
default=BirdseyeModeEnum.objects, title="Tracking mode for camera."
|
|
)
|
|
|
|
order: int = Field(default=0, title="Position of the camera in the birdseye view.")
|