Merge branch 'dev' of https://github.com/blakeblackshear/frigate into improve-devcontainer

.github/FUNDING.yml

@@ -1,3 +1,3 @@
 github:
   - blakeblackshear
-  - paularmstrong
+  - NickM-27

.github/ISSUE_TEMPLATE/edgetpu_support_request.yml

@@ -0,0 +1,84 @@
+name: EdgeTpu Support Request
+description: Support for setting up EdgeTPU in Frigate
+title: "[EdgeTPU Support]: "
+labels: ["support", "triage"]
+assignees: []
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the problem you are having
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: Visible on the Debug page in the Web UI
+    validations:
+      required: true
+  - type: textarea
+    id: config
+    attributes:
+      label: Frigate config file
+      description: This will be automatically formatted into code, so no need for backticks.
+      render: yaml
+    validations:
+      required: true
+  - type: textarea
+    id: docker
+    attributes:
+      label: docker-compose file or Docker CLI command
+      description: This will be automatically formatted into code, so no need for backticks.
+      render: yaml
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating system
+      options:
+        - HassOS
+        - Debian
+        - Other Linux
+        - Proxmox
+        - UNRAID
+        - Windows
+        - Other
+    validations:
+      required: true
+  - type: dropdown
+    id: install-method
+    attributes:
+      label: Install method
+      options:
+        - HassOS Addon
+        - Docker Compose
+        - Docker CLI
+    validations:
+      required: true
+  - type: dropdown
+    id: coral
+    attributes:
+      label: Coral version
+      options:
+        - USB
+        - PCIe
+        - M.2
+        - Dev Board
+        - Other
+        - CPU (no coral)
+    validations:
+      required: true
+  - type: textarea
+    id: other
+    attributes:
+      label: Any other information that may be helpful

.github/ISSUE_TEMPLATE/hwaccel_support_request.yml

@@ -0,0 +1,96 @@
+name: Hardware Acceleration Support Request
+description: Support for setting up GPU hardware acceleration in Frigate
+title: "[HW Accel Support]: "
+labels: ["support", "triage"]
+assignees: []
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the problem you are having
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: Visible on the Debug page in the Web UI
+    validations:
+      required: true
+  - type: textarea
+    id: config
+    attributes:
+      label: Frigate config file
+      description: This will be automatically formatted into code, so no need for backticks.
+      render: yaml
+    validations:
+      required: true
+  - type: textarea
+    id: docker
+    attributes:
+      label: docker-compose file or Docker CLI command
+      description: This will be automatically formatted into code, so no need for backticks.
+      render: yaml
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: ffprobe
+    attributes:
+      label: FFprobe output from your camera
+      description: Run `ffprobe <camera_url>` and provide output below
+      render: shell
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating system
+      options:
+        - HassOS
+        - Debian
+        - Other Linux
+        - Proxmox
+        - UNRAID
+        - Windows
+        - Other
+    validations:
+      required: true
+  - type: dropdown
+    id: install-method
+    attributes:
+      label: Install method
+      options:
+        - HassOS Addon
+        - Docker Compose
+        - Docker CLI
+    validations:
+      required: true
+  - type: dropdown
+    id: network
+    attributes:
+      label: Network connection
+      options:
+        - Wired
+        - Wireless
+        - Mixed
+    validations:
+      required: true
+  - type: input
+    id: camera
+    attributes:
+      label: Camera make and model
+      description: Dahua, hikvision, amcrest, reolink, etc and model number
+    validations:
+      required: true
+  - type: textarea
+    id: other
+    attributes:
+      label: Any other information that may be helpful

.github/dependabot.yml

@@ -0,0 +1,32 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    target-branch: dev
+  - package-ecosystem: "docker"
+    directory: "/docker"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    target-branch: dev
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    target-branch: dev
+  - package-ecosystem: "npm"
+    directory: "/web"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    target-branch: dev
+  - package-ecosystem: "npm"
+    directory: "/docs"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    target-branch: dev

.github/stale.yml

@@ -1,17 +0,0 @@
-# Number of days of inactivity before an issue becomes stale
-daysUntilStale: 30
-# Number of days of inactivity before a stale issue is closed
-daysUntilClose: 3
-# Issues with these labels will never be considered stale
-exemptLabels:
-  - pinned
-  - security
-# Label to use when marking an issue as stale
-staleLabel: stale
-# Comment to post when marking an issue as stale. Set to `false` to disable
-markComment: >
-  This issue has been automatically marked as stale because it has not had
-  recent activity. It will be closed if no further activity occurs. Thank you
-  for your contributions.
-# Comment to post when closing a stale issue. Set to `false` to disable
-closeComment: false

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - dev
+      - master
+
+env:
+  PYTHON_VERSION: 3.9
+
+jobs:
+  multi_arch_build:
+    runs-on: ubuntu-latest
+    name: Image Build
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Log in to the Container registry
+        uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Build web
+        run: make build_web
+      - name: Build image
+        run: make push

.github/workflows/pull_request.yml

@@ -10,7 +10,7 @@ jobs:
     name: Web - Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@master
         with:
           node-version: 16.x
@@ -24,7 +24,7 @@ jobs:
     name: Web - Test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v3
       - uses: actions/setup-node@master
         with:
           node-version: 16.x
@@ -39,9 +39,9 @@ jobs:
     name: Python checks
     steps:
       - name: Check out the repository
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v3
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
-        uses: actions/setup-python@v2.2.2
+        uses: actions/setup-python@v4.3.0
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
       - name: Install requirements
@@ -57,7 +57,7 @@ jobs:
     name: Python Tests
     steps:
       - name: Check out code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - uses: actions/setup-node@master
         with:
           node-version: 16.x
@@ -67,9 +67,9 @@ jobs:
         run: npm run build
         working-directory: ./web
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v1
+        uses: docker/setup-qemu-action@v2
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v2
       - name: Create Version Module
         run: make version
       - name: Build

.github/workflows/stale.yml

@@ -0,0 +1,25 @@
+# Close Stale Issues
+# Warns and then closes issues and PRs that have had no activity for a specified amount of time.
+# https://github.com/actions/stale
+
+name: "Stalebot"
+on:
+  schedule:
+    - cron: "0 0 * * *" # run stalebot once a day
+    
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@main
+        id: stale
+        with:
+          stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.'
+          close-issue-message: ''
+          days-before-stale: 30
+          days-before-close: 3
+          exempt-draft-pr: true
+          exempt-issue-labels: 'pinned,security'
+          exempt-pr-labels: 'pinned,security'
+      - name: Print outputs
+        run: echo ${{ join(steps.stale.outputs.*, ',') }}

Makefile

@@ -1,7 +1,7 @@
 default_target: local
 
 COMMIT_HASH := $(shell git log -1 --pretty=format:"%h"|tail -1)
-VERSION = 0.11.0
+VERSION = 0.12.0
 CURRENT_UID := $(shell id -u)
 CURRENT_GID := $(shell id -g)
 
@@ -9,7 +9,7 @@ version:
 	echo "VERSION=\"$(VERSION)-$(COMMIT_HASH)\"" > frigate/version.py
 
 build_web:
-	docker run --volume ${PWD}/web:/web -w /web --volume /etc/passwd:/etc/passwd:ro --volume /etc/group:/etc/group:ro -u $(CURRENT_UID):$(CURRENT_GID) node:16 /bin/bash -c "npm install && npm run build"
+	docker run -e npm_config_cache=/web/.npm --volume ${PWD}/web:/web -w /web --group-add $(CURRENT_GID) -u $(CURRENT_UID):$(CURRENT_GID) node:16 /bin/bash -c "npm install && npm run build"
 
 nginx_frigate:
 	docker buildx build --push --platform linux/arm/v7,linux/arm64/v8,linux/amd64 --tag blakeblackshear/frigate-nginx:1.0.2 --file docker/Dockerfile.nginx .
@@ -30,7 +30,7 @@ build: version amd64 arm64 armv7
 	docker buildx build --platform linux/arm/v7,linux/arm64/v8,linux/amd64 --tag blakeblackshear/frigate:$(VERSION)-$(COMMIT_HASH) --file docker/Dockerfile .
 
 push: build
-	docker buildx build --push --platform linux/arm/v7,linux/arm64/v8,linux/amd64 --tag blakeblackshear/frigate:$(VERSION)-$(COMMIT_HASH) --file docker/Dockerfile .
+	docker buildx build --push --platform linux/arm/v7,linux/arm64/v8,linux/amd64 --tag ghcr.io/blakeblackshear/frigate:${GITHUB_REF_NAME}-$(COMMIT_HASH) --file docker/Dockerfile .
 
 run_tests: frigate
 	docker run --rm --entrypoint=python3 frigate:latest -u -m unittest

benchmark.py

@@ -3,10 +3,16 @@ from statistics import mean
 import multiprocessing as mp
 import numpy as np
 import datetime
-from frigate.edgetpu import LocalObjectDetector, EdgeTPUProcess, RemoteObjectDetector, load_labels
+from frigate.config import DetectorTypeEnum
+from frigate.object_detection import (
+    LocalObjectDetector,
+    ObjectDetectProcess,
+    RemoteObjectDetector,
+    load_labels,
+)
 
 my_frame = np.expand_dims(np.full((300, 300, 3), 1, np.uint8), axis=0)
-labels = load_labels('/labelmap.txt')
+labels = load_labels("/labelmap.txt")
 
 ######
 # Minimal same process runner
@@ -39,7 +45,9 @@ labels = load_labels('/labelmap.txt')
 
 
 def start(id, num_detections, detection_queue, event):
-  object_detector = RemoteObjectDetector(str(id), '/labelmap.txt', detection_queue, event)
+    object_detector = RemoteObjectDetector(
+        str(id), "/labelmap.txt", detection_queue, event
+    )
     start = datetime.datetime.now().timestamp()
 
     frame_times = []
@@ -54,6 +62,7 @@ def start(id, num_detections, detection_queue, event):
     print(f"{id} - FPS: {object_detector.fps.eps():.2f}")
     print(f"{id} - Average frame processing time: {mean(frame_times)*1000:.2f}ms")
 
+
 ######
 # Separate process runner
 ######
@@ -73,11 +82,17 @@ events = {}
 for x in range(0, 10):
     events[str(x)] = mp.Event()
 detection_queue = mp.Queue()
-edgetpu_process_1 = EdgeTPUProcess(detection_queue, events, 'usb:0')
-edgetpu_process_2 = EdgeTPUProcess(detection_queue, events, 'usb:1')
+edgetpu_process_1 = ObjectDetectProcess(
+    detection_queue, events, DetectorTypeEnum.edgetpu, "usb:0"
+)
+edgetpu_process_2 = ObjectDetectProcess(
+    detection_queue, events, DetectorTypeEnum.edgetpu, "usb:1"
+)
 
 for x in range(0, 10):
-  camera_process = mp.Process(target=start, args=(x, 300, detection_queue, events[str(x)]))
+    camera_process = mp.Process(
+        target=start, args=(x, 300, detection_queue, events[str(x)])
+    )
     camera_process.daemon = True
     camera_processes.append(camera_process)
 

docker-compose.yml

@@ -29,6 +29,7 @@ services:
       - "5000:5000"
       - "5001:5001"
       - "8080:8080"
+      - "8554:8554"
     entrypoint: ["sudo", "/init"]
     command: /bin/sh -c "while sleep 1000; do :; done"
   mqtt:

docker/Dockerfile

@@ -46,7 +46,6 @@ RUN pip3 wheel --wheel-dir=/wheels -r requirements-wheels.txt
 FROM debian:11-slim AS frigate-without-web
 ARG TARGETARCH
 
-ARG JELLYFIN_FFMPEG_VERSION=5.0.1-7
 # https://askubuntu.com/questions/972516/debian-frontend-environment-variable
 ARG DEBIAN_FRONTEND="noninteractive"
 # http://stackoverflow.com/questions/48162574/ddg#49462622
@@ -64,6 +63,7 @@ RUN apt-get -qq update \
     apt-transport-https \
     gnupg \
     wget \
+    procps \
     unzip tzdata libxml2 xz-utils \
     python3-pip \
     # add raspberry pi repo
@@ -80,14 +80,25 @@ RUN apt-get -qq update \
     # coral drivers
     libedgetpu1-max python3-tflite-runtime python3-pycoral \
     && pip3 install -U /wheels/*.whl \
-    # jellyfin-ffmpeg
-    && wget -O jellyfin.deb "https://repo.jellyfin.org/releases/server/debian/versions/jellyfin-ffmpeg/${JELLYFIN_FFMPEG_VERSION}/jellyfin-ffmpeg5_${JELLYFIN_FFMPEG_VERSION}-$( awk -F'=' '/^VERSION_CODENAME=/{ print $NF }' /etc/os-release )_$( dpkg --print-architecture ).deb" \
-    && apt-get -qq install --no-install-recommends --no-install-suggests -y ./jellyfin.deb \
-    && rm jellyfin.deb \
+    # btbn-ffmpeg -> amd64 / arm64
+    && if [ "${TARGETARCH}" = "amd64" ] || [ "${TARGETARCH}" = "arm64" ]; then \
+    mkdir -p /usr/lib/btbn-ffmpeg \
+    && wget -O btbn-ffmpeg.tar.xz "https://github.com/BtbN/FFmpeg-Builds/releases/download/autobuild-2022-07-31-12-37/ffmpeg-n5.1-2-g915ef932a3-linux$( [ "$TARGETARCH" = "amd64" ] && echo "64" || echo "arm64" )-gpl-5.1.tar.xz" \
+    && tar -xf btbn-ffmpeg.tar.xz -C /usr/lib/btbn-ffmpeg --strip-components 1 \
+    && rm btbn-ffmpeg.tar.xz; \
+    fi \
+    # ffmpeg -> arm32
+    && if [ "${TARGETARCH}" = "arm" ]; then \
+    apt-get -qq install --no-install-recommends --no-install-suggests -y ffmpeg; \
+    fi \
     # arch specific packages
     && if [ "${TARGETARCH}" = "amd64" ]; then \
     apt-get -qq install --no-install-recommends --no-install-suggests -y \
-    mesa-va-drivers intel-media-va-driver-non-free; \
+    mesa-va-drivers libva-drm2 intel-media-va-driver-non-free i965-va-driver libmfx1; \
+    fi \
+    && if [ "${TARGETARCH}" = "arm64" ]; then \
+    apt-get -qq install --no-install-recommends --no-install-suggests -y \
+    libva-drm2 mesa-va-drivers; \
     fi \
     # not sure why 32bit arm requires all these
     && if [ "${TARGETARCH}" = "arm" ]; then \
@@ -105,7 +116,13 @@ RUN apt-get -qq update \
     && apt-get autoremove -y \
     && rm -rf /var/lib/apt/lists/*
 
-ENV PATH=$PATH:/usr/lib/jellyfin-ffmpeg
+ENV PATH=$PATH:/usr/lib/btbn-ffmpeg/bin
+
+# install go2rtc
+RUN wget -O go2rtc "https://github.com/AlexxIT/go2rtc/releases/download/v0.1-rc.2/go2rtc_linux_${TARGETARCH}" \
+    && chmod +x go2rtc \
+    && mkdir -p /usr/local/go2rtc/sbin/ \
+    && mv go2rtc /usr/local/go2rtc/sbin/go2rtc
 
 COPY --from=nginx /usr/local/nginx/ /usr/local/nginx/
 
@@ -130,6 +147,8 @@ RUN S6_ARCH="${TARGETARCH}" \
 
 EXPOSE 5000
 EXPOSE 1935
+EXPOSE 8554
+EXPOSE 8555
 
 ENTRYPOINT ["/init"]
 

docker/rootfs/etc/services.d/go2rtc/finish

@@ -0,0 +1,5 @@
+#!/usr/bin/execlineb -S1
+if { s6-test ${1} -ne 0 }
+if { s6-test ${1} -ne 256 }
+
+s6-svscanctl -t /var/run/s6/services

docker/rootfs/etc/services.d/go2rtc/run

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+# https://gist.github.com/mohanpedala/1e2ff5661761d3abd0385e8223e16425?permalink_comment_id=3945021
+set -euo pipefail
+
+if [[ -f "/config/frigate-go2rtc.yaml" ]]; then
+    CONFIG_PATH=/config/frigate-go2rtc.yaml
+else
+    CONFIG_PATH=/usr/local/go2rtc/sbin/go2rtc.yaml
+fi
+
+exec /usr/local/go2rtc/sbin/go2rtc -config="$CONFIG_PATH"

docker/rootfs/usr/local/go2rtc/sbin/go2rtc.yaml

@@ -0,0 +1,4 @@
+webrtc:
+  listen: ":8555"
+  candidates:
+    - stun:8555

docker/rootfs/usr/local/nginx/conf/nginx.conf

@@ -44,6 +44,11 @@ http {
       keepalive 1024;
     }
 
+    upstream go2rtc {
+        server 127.0.0.1:1984;
+        keepalive 1024;
+    }
+
     server {
         listen 5000;
 
@@ -55,6 +60,7 @@ http {
         vod_upstream_location /api;
         vod_align_segments_to_key_frames on;
         vod_manifest_segment_durations_mode accurate;
+        vod_ignore_edit_list on;
 
         # vod caches
         vod_metadata_cache metadata_cache 512m;
@@ -164,7 +170,7 @@ http {
             proxy_set_header Host $host;
         }
 
-        location /live/ {
+        location /live/jsmpeg/ {
             proxy_pass http://jsmpeg/;
             proxy_http_version 1.1;
             proxy_set_header Upgrade $http_upgrade;
@@ -172,10 +178,27 @@ http {
             proxy_set_header Host $host;
         }
 
-        location ~* /api/(.*\.(jpg|jpeg|png)$) {
+        location /live/mse/ {
+            proxy_pass http://go2rtc/;
+            proxy_http_version 1.1;
+            proxy_set_header Upgrade $http_upgrade;
+            proxy_set_header Connection "Upgrade";
+            proxy_set_header Host $host;
+        }
+
+        location /live/webrtc/ {
+            proxy_pass http://go2rtc/;
+            proxy_http_version 1.1;
+            proxy_set_header Upgrade $http_upgrade;
+            proxy_set_header Connection "Upgrade";
+            proxy_set_header Host $host;
+        }
+
+        location ~* /api/.*\.(jpg|jpeg|png)$ {
             add_header 'Access-Control-Allow-Origin' '*';
             add_header 'Access-Control-Allow-Methods' 'GET, POST, PUT, DELETE, OPTIONS';
-            proxy_pass http://frigate_api/$1$is_args$args;
+            rewrite ^/api/(.*)$ $1 break;
+            proxy_pass http://frigate_api;
             proxy_pass_request_headers on;
             proxy_set_header Host $host;
             proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

docs/docs/configuration/advanced.md

@@ -4,8 +4,6 @@ title: Advanced Options
 sidebar_label: Advanced Options
 ---
 
-## Advanced configuration
-
 ### `logger`
 
 Change the default log level for troubleshooting purposes.
@@ -25,7 +23,7 @@ Examples of available modules are:
 
 - `frigate.app`
 - `frigate.mqtt`
-- `frigate.edgetpu`
+- `frigate.object_detection`
 - `frigate.zeroconf`
 - `detector.<detector_name>`
 - `watchdog.<camera_name>`
@@ -52,6 +50,30 @@ database:
 
 If using a custom model, the width and height will need to be specified.
 
+Custom models may also require different input tensor formats. The colorspace conversion supports RGB, BGR, or YUV frames to be sent to the object detector. The input tensor shape parameter is an enumeration to match what specified by the model.
+
+| Tensor Dimension | Description    |
+| :--------------: | -------------- |
+|        N         | Batch Size     |
+|        H         | Model Height   |
+|        W         | Model Width    |
+|        C         | Color Channels |
+
+| Available Input Tensor Shapes |
+| :---------------------------: |
+|            "nhwc"             |
+|            "nchw"             |
+
+```yaml
+# Optional: model config
+model:
+  path: /path/to/model
+  width: 320
+  height: 320
+  input_tensor: "nhwc"
+  input_pixel_format: "bgr"
+```
+
 The labelmap can be customized to your needs. A common reason to do this is to combine multiple object types that are easily confused when you don't need to be as granular such as car/truck. By default, truck is renamed to car because they are often confused. You cannot add new object types, but you can change the names of existing objects in the model.
 
 ```yaml
@@ -67,3 +89,15 @@ model:
 ```
 
 Note that if you rename objects in the labelmap, you will also need to update your `objects -> track` list as well.
+
+## Custom ffmpeg build
+
+Included with Frigate is a build of ffmpeg that works for the vast majority of users. However, there exists some hardware setups which have incompatibilities with the included build. In this case, a docker volume mapping can be used to overwrite the included ffmpeg build with an ffmpeg build that works for your specific hardware setup.
+
+To do this:
+
+1. Download your ffmpeg build and uncompress to a folder on the host (let's use `/home/appdata/frigate/custom-ffmpeg` for this example).
+2. Update your docker-compose or docker CLI to include `'/home/appdata/frigate/custom-ffmpeg':'/usr/lib/btbn-ffmpeg':'ro'` in the volume mappings.
+3. Restart frigate and the custom version will be used if the mapping was done correctly.
+
+NOTE: The folder that is mapped from the host needs to be the folder that contains `/bin`. So if the full structure is `/home/appdata/frigate/custom-ffmpeg/bin/ffmpeg` then `/home/appdata/frigate/custom-ffmpeg` needs to be mapped to `/usr/lib/btbn-ffmpeg`.

docs/docs/configuration/birdseye.md

@@ -11,4 +11,25 @@ Birdseye offers different modes to customize which cameras show under which circ
 
 ### Custom Birdseye Icon
 
-A custom icon can be added to the birdseye background by provided a file `custom.png` inside of the Frigate `media` folder. The file must be a png with the icon as transparent, any non-transparent pixels will be white when displayed in the birdseye view. 
+A custom icon can be added to the birdseye background by providing a 180x180 image named `custom.png` inside of the Frigate `media` folder. The file must be a png with the icon as transparent, any non-transparent pixels will be white when displayed in the birdseye view.
+
+### Birdseye view override at camera level
+
+If you want to include a camera in Birdseye view only for specific circumstances, or just don't include it at all, the Birdseye setting can be set at the camera level.
+
+```yaml
+# Include all cameras by default in Birdseye view
+birdseye:
+  enabled: True
+  mode: continuous
+
+cameras:
+  front:
+    # Only include the "front" camera in Birdseye view when objects are detected
+    birdseye:
+      mode: objects
+  back:
+    # Exclude the "back" camera from Birdseye view
+    birdseye:
+      enabled: False
+```

docs/docs/configuration/camera_specific.md

@@ -3,12 +3,12 @@ id: camera_specific
 title: Camera Specific Configurations
 ---
 
-### MJPEG Cameras
+## MJPEG Cameras
 
 The input and output parameters need to be adjusted for MJPEG cameras
 
 ```yaml
-input_args: -avoid_negative_ts make_zero -fflags nobuffer -flags low_delay -strict experimental -fflags +genpts+discardcorrupt -use_wallclock_as_timestamps 1
+input_args: -avoid_negative_ts make_zero -fflags nobuffer -flags low_delay -strict experimental -fflags +genpts+discardcorrupt -use_wallclock_as_timestamps 1 -c:v mjpeg
 ```
 
 Note that mjpeg cameras require encoding the video into h264 for recording, and rtmp roles. This will use significantly more CPU than if the cameras supported h264 feeds directly.
@@ -19,7 +19,7 @@ output_args:
   rtmp: -c:v libx264 -an -f flv
 ```
 
-### JPEG Stream Cameras
+## JPEG Stream Cameras
 
 Cameras using a live changing jpeg image will need input parameters as below
 
@@ -47,7 +47,7 @@ input_args:
 
 Outputting the stream will have the same args and caveats as per [MJPEG Cameras](#mjpeg-cameras)
 
-### RTMP Cameras
+## RTMP Cameras
 
 The input parameters need to be adjusted for RTMP cameras
 
@@ -56,20 +56,67 @@ ffmpeg:
   input_args: -avoid_negative_ts make_zero -fflags nobuffer -flags low_delay -strict experimental -fflags +genpts+discardcorrupt -rw_timeout 5000000 -use_wallclock_as_timestamps 1 -f live_flv
 ```
 
+## UDP Only Cameras
+
+If your cameras do not support TCP connections for RTSP, you can use UDP.
+
+```yaml
+ffmpeg:
+  input_args: -avoid_negative_ts make_zero -fflags +genpts+discardcorrupt -rtsp_transport udp -timeout 5000000 -use_wallclock_as_timestamps 1
+```
+
+## Model/vendor specific setup
+
+### Annke C800
+This camera is H.265 only. To be able to play clips on some devices (like MacOs or iPhone) the H.265 stream has to be repackaged and the audio stream has to be converted to aac. Unfortunately direct playback of in the browser is not working (yet), but the downloaded clip can be played locally.
+
+```yaml
+cameras:
+  annkec800: # <------ Name the camera
+    ffmpeg:
+      output_args:
+        record: -f segment -segment_time 10 -segment_format mp4 -reset_timestamps 1 -strftime 1 -c:v copy -tag:v hvc1 -bsf:v hevc_mp4toannexb -c:a aac
+        rtmp: -c:v copy -c:a aac -f flv
+        
+      inputs:
+        - path: rtsp://user:password@camera-ip:554/H264/ch1/main/av_stream # <----- Update for your camera
+          roles:
+            - detect
+            - record
+            - rtmp
+    rtmp:
+      enabled: False # <-- RTMP should be disabled if your stream is not H264
+    detect:
+      width:  # <---- update for your camera's resolution
+      height:  # <---- update for your camera's resolution
+
+
+```
+
+### Blue Iris RTSP Cameras
+
+You will need to remove `nobuffer` flag for Blue Iris RTSP cameras
+
+```yaml
+ffmpeg:
+  input_args: -avoid_negative_ts make_zero -flags low_delay -strict experimental -fflags +genpts+discardcorrupt -rtsp_transport tcp -timeout 5000000 -use_wallclock_as_timestamps 1
+```
+
 ### Reolink 410/520 (possibly others)
 
-According to [this discussion](https://github.com/blakeblackshear/frigate/issues/1713#issuecomment-932976305), the http video streams seem to be the most reliable for Reolink.
+![Resolutions](/img/reolink-settings.png)
+
+According to [this discussion](https://github.com/blakeblackshear/frigate/issues/3235#issuecomment-1135876973), the http video streams seem to be the most reliable for Reolink.
 
 ```yaml
 cameras:
   reolink:
     ffmpeg:
-      hwaccel_args:
       input_args:
         - -avoid_negative_ts
         - make_zero
         - -fflags
-        - nobuffer+genpts+discardcorrupt
+        - +genpts+discardcorrupt
         - -flags
         - low_delay
         - -strict
@@ -94,22 +141,13 @@ cameras:
       fps: 7
 ```
 
-![Resolutions](/img/reolink-settings.png)
+### Unifi Protect Cameras
 
-### Blue Iris RTSP Cameras
-
-You will need to remove `nobuffer` flag for Blue Iris RTSP cameras
+In the Unifi 2.0 update Unifi Protect Cameras had a change in audio sample rate which causes issues for ffmpeg. The input rate needs to be set for record and rtmp.
 
 ```yaml
 ffmpeg:
-  input_args: -avoid_negative_ts make_zero -flags low_delay -strict experimental -fflags +genpts+discardcorrupt -rtsp_transport tcp -timeout 5000000 -use_wallclock_as_timestamps 1
-```
-
-### UDP Only Cameras
-
-If your cameras do not support TCP connections for RTSP, you can use UDP.
-
-```yaml
-ffmpeg:
-  input_args: -avoid_negative_ts make_zero -fflags +genpts+discardcorrupt -rtsp_transport udp -timeout 5000000 -use_wallclock_as_timestamps 1
+  output_args:
+    record: -f segment -segment_time 10 -segment_format mp4 -reset_timestamps 1 -strftime 1 -c:v copy -ar 44100 -c:a aac
+    rtmp: -c:v copy -f flv -ar 44100 -c:a aac
 ```

docs/docs/configuration/cameras.md

@@ -7,19 +7,23 @@ title: Cameras
 
 Several inputs can be configured for each camera and the role of each input can be mixed and matched based on your needs. This allows you to use a lower resolution stream for object detection, but create recordings from a higher resolution stream, or vice versa.
 
+A camera is enabled by default but can be temporarily disabled by using `enabled: False`. Existing events and recordings can still be accessed. Live streams, recording and detecting are not working. Camera specific configurations will be used.
+
 Each role can only be assigned to one input per camera. The options for roles are as follows:
 
 | Role       | Description                                                                                          |
-| -------- | ----------------------------------------------------------------------------------------------- |
+| ---------- | ---------------------------------------------------------------------------------------------------- |
 | `detect`   | Main feed for object detection                                                                       |
 | `record`   | Saves segments of the video feed based on configuration settings. [docs](/configuration/record)      |
-| `rtmp`   | Broadcast as an RTMP feed for other services to consume. [docs](/configuration/rtmp)            |
+| `restream` | Broadcast as RTSP feed and use the full res stream for live view. [docs](/configuration/restream)    |
+| `rtmp`     | Deprecated: Broadcast as an RTMP feed for other services to consume. [docs](/configuration/restream) |
 
 ```yaml
 mqtt:
   host: mqtt.server.com
 cameras:
   back:
+    enabled: True
     ffmpeg:
       inputs:
         - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2
@@ -43,3 +47,5 @@ cameras:
   front: ...
   side: ...
 ```
+
+For camera model specific settings check the [camera specific](/configuration/camera_specific) infos.

docs/docs/configuration/hardware_acceleration.md

@@ -21,7 +21,7 @@ ffmpeg:
 ffmpeg:
   hwaccel_args: -hwaccel vaapi -hwaccel_device /dev/dri/renderD128 -hwaccel_output_format yuv420p
 ```
-**NOTICE**: With some of the processors, like the J4125, the default driver `iHD` doesn't seem to work correctly for hardware acceleration. You may need to change the driver to `i965` by adding the following environment variable `LIBVA_DRIVER_NAME_JELLYFIN=i965` to your docker-compose file.   
+**NOTICE**: With some of the processors, like the J4125, the default driver `iHD` doesn't seem to work correctly for hardware acceleration. You may need to change the driver to `i965` by adding the following environment variable `LIBVA_DRIVER_NAME=i965` to your docker-compose file or [in the frigate.yml for HA OS users](advanced.md#environment_vars).   
 
 ### Intel-based CPUs (>=10th Generation) via Quicksync
 
@@ -41,10 +41,12 @@ ffmpeg:
 
 ### NVIDIA GPU
 
+[Supported Nvidia GPUs for Decoding](https://developer.nvidia.com/video-encode-and-decode-gpu-support-matrix-new)
+
 These instructions are based on the [jellyfin documentation](https://jellyfin.org/docs/general/administration/hardware-acceleration.html#nvidia-hardware-acceleration-on-docker-linux)
 
 Add `--gpus all` to your docker run command or update your compose file.
-
+If you have multiple Nvidia graphic card, you can add them with their ids obtained via `nvidia-smi` command
 ```yaml
 services:
   frigate:
@@ -55,7 +57,7 @@ services:
         reservations:
           devices:
             - driver: nvidia
-            count: 1
+              device_ids: ['0'] # this is only needed when using multiple GPUs
               capabilities: [gpu]
 ```
 
@@ -84,7 +86,7 @@ ffmpeg:
 ```
 
 If everything is working correctly, you should see a significant improvement in performance.
-Verify that hardware decoding is working by running `nvidia-smi`, which should show the ffmpeg
+Verify that hardware decoding is working by running `docker exec -it frigate nvidia-smi`, which should show the ffmpeg
 processes:
 
 ```

docs/docs/configuration/index.md

@@ -19,12 +19,16 @@ cameras:
         - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2
           roles:
             - detect
-            - rtmp
+            - restream
     detect:
       width: 1280
       height: 720
 ```
 
+### VSCode Configuration Schema
+
+VSCode (and VSCode addon) supports the JSON schemas which will automatically validate the config. This can be added by adding `# yaml-language-server: $schema=http://frigate_host:5000/api/config/schema` to the top of the config file. `frigate_host` being the IP address of frigate or `ccab4aaf-frigate` if running in the addon.
+
 ### Full configuration reference:
 
 :::caution
@@ -93,6 +97,12 @@ model:
   width: 320
   # Required: Object detection model input height (default: shown below)
   height: 320
+  # Optional: Object detection model input colorspace
+  # Valid values are rgb, bgr, or yuv. (default: shown below)
+  input_pixel_format: rgb
+  # Optional: Object detection model input tensor format
+  # Valid values are nhwc or nchw (default: shown below)
+  input_tensor: "nhwc"
   # Optional: Label name modifications. These are merged into the standard labelmap.
   labelmap:
     2: vehicle
@@ -311,6 +321,8 @@ snapshots:
   # Optional: Enable writing jpg snapshot to /media/frigate/clips (default: shown below)
   # This value can be set via MQTT and will be updated in startup based on retained value
   enabled: False
+  # Optional: save a clean PNG copy of the snapshot image (default: shown below)
+  clean_copy: True
   # Optional: print a timestamp on the snapshots (default: shown below)
   timestamp: False
   # Optional: draw bounding box on the snapshots (default: shown below)
@@ -330,19 +342,26 @@ snapshots:
       person: 15
 
 # Optional: RTMP configuration
+# NOTE: RTMP is deprecated in favor of restream
 # NOTE: Can be overridden at the camera level
 rtmp:
-  # Optional: Enable the RTMP stream (default: True)
-  enabled: True
+  # Optional: Enable the RTMP stream (default: False)
+  enabled: False
 
-# Optional: Live stream configuration for WebUI
+# Optional: Restream configuration
 # NOTE: Can be overridden at the camera level
-live:
-  # Optional: Set the height of the live stream. (default: 720)
+restream:
+  # Optional: Enable the restream (default: True)
+  enabled: True
+  # Optional: Force audio compatibility with browsers (default: shown below)
+  force_audio: False
+  # Optional: jsmpeg stream configuration for WebUI
+  jsmpeg:
+    # Optional: Set the height of the jsmpeg stream. (default: 720)
     # This must be less than or equal to the height of the detect stream. Lower resolutions
-  # reduce bandwidth required for viewing the live stream. Width is computed to match known aspect ratio.
+    # reduce bandwidth required for viewing the jsmpeg stream. Width is computed to match known aspect ratio.
     height: 720
-  # Optional: Set the encode quality of the live stream (default: shown below)
+    # Optional: Set the encode quality of the jsmpeg stream (default: shown below)
     # 1 is the highest quality, and 31 is the lowest. Lower quality feeds utilize less CPU resources.
     quality: 8
 
@@ -374,6 +393,10 @@ timestamp_style:
 cameras:
   # Required: name of the camera
   back:
+    # Optional: Enable/Disable the camera (default: shown below).
+    # If disabled: config is used but no live stream and no capture etc.
+    # Events/Recordings are still viewable.
+    enabled: True
     # Required: ffmpeg settings for the camera
     ffmpeg:
       # Required: A list of input streams for the camera. See documentation for more information.
@@ -381,11 +404,12 @@ cameras:
         # Required: the path to the stream
         # NOTE: path may include environment variables, which must begin with 'FRIGATE_' and be referenced in {}
         - path: rtsp://viewer:{FRIGATE_RTSP_PASSWORD}@10.0.10.10:554/cam/realmonitor?channel=1&subtype=2
-          # Required: list of roles for this stream. valid values are: detect,record,rtmp
-          # NOTICE: In addition to assigning the record, and rtmp roles,
+          # Required: list of roles for this stream. valid values are: detect,record,restream,rtmp
+          # NOTICE: In addition to assigning the record, restream, and rtmp roles,
           # they must also be enabled in the camera config.
           roles:
             - detect
+            - restream
             - rtmp
           # Optional: stream specific global args (default: inherit)
           # global_args:

docs/docs/configuration/live.md

@@ -0,0 +1,41 @@
+---
+id: live
+title: Live View
+---
+
+Frigate has different live view options, some of which require [restream](restream.md) to be enabled.
+
+## Live View Options
+
+Live view options can be selected while viewing the live stream. The options are:
+
+| Source | Latency | Frame Rate                             | Resolution     | Audio                        | Requires Restream | Other Limitations     |
+| ------ | ------- | -------------------------------------- | -------------- | ---------------------------- | ----------------- | --------------------- |
+| jsmpeg | low     | same as `detect -> fps`, capped at 10  | same as detect | no                           | no                | none                  |
+| mse    | low     | native                                 | native         | yes (depends on audio codec) | yes               | none                  |
+| webrtc | lowest  | native                                 | native         | yes (depends on audio codec) | yes               | requires extra config |
+
+### WebRTC extra configuration:
+
+webRTC works by creating a websocket connection on extra ports. One of the following is required for webRTC to work:
+* Frigate is run with `network_mode: host` to support automatic UDP port pass through locally and remotely. See https://github.com/AlexxIT/go2rtc#module-webrtc for more details
+* Frigate is run with `network_mode: bridge` and has:
+    * Router setup to forward port `8555` to port `8555` on the frigate device.
+    * For local webRTC, you will need to create your own go2rtc config:
+
+```yaml
+webrtc:
+  listen: ":8555"
+  candidates:
+    - <frigate host ip address>:8555 # <--- enter frigate host IP here
+    - stun:8555
+```
+
+and pass that config to frigate via docker or `frigate-go2rtc.yaml` for addon users:
+
+See https://github.com/AlexxIT/go2rtc#module-webrtc for more details
+
+```yaml
+volumes:
+  - /path/to/your/go2rtc.yaml:/config/frigate-go2rtc.yaml:ro
+```

docs/docs/configuration/record.md

@@ -7,6 +7,10 @@ Recordings can be enabled and are stored at `/media/frigate/recordings`. The fol
 
 H265 recordings can be viewed in Edge and Safari only. All other browsers require recordings to be encoded with H264.
 
+## Will Frigate delete old recordings if my storage runs out?
+
+As of Frigate 0.12 if there is less than an hour left of storage, the oldest 2 hours of recordings will be deleted.
+
 ## What if I don't want 24/7 recordings?
 
 If you only used clips in previous versions with recordings disabled, you can use the following config to get the same behavior. This is also the default behavior when recordings are enabled.
@@ -42,3 +46,35 @@ The same options are available with events. Let's consider a scenario where you
 - With the `all` option all segments for the duration of the event would be saved for the event. This event would have 4 hours of footage.
 - With the `motion` option all segments for the duration of the event with motion would be saved. This means any segment where a car drove by in the street, person walked by, lighting changed, etc. would be saved.
 - With the `active_objects` it would only keep segments where the object was active. In this case the only segments that would be saved would be the ones where the car was driving up, you going inside, you coming outside, and the car driving away. Essentially reducing the 4 hours to a minute or two of event footage.
+
+A configuration example of the above retain modes where all `motion` segments are stored for 7 days and `active objects` are stored for 14 days would be as follows:
+```yaml
+record:
+  enabled: True
+  retain:
+    days: 7
+    mode: motion
+  events:
+    retain:
+      default: 14
+      mode: active_objects
+```
+The above configuration example can be added globally or on a per camera basis.
+
+### Object Specific Retention
+
+You can also set specific retention length for an object type. The below configuration example builds on from above but also specifies that recordings of dogs only need to be kept for 2 days and recordings of cars should be kept for 7 days.
+```yaml
+record:
+  enabled: True
+  retain:
+    days: 7
+    mode: motion
+  events:
+    retain:
+      default: 14
+      mode: active_objects
+      objects:
+        dog: 2
+        car: 7
+```

docs/docs/configuration/restream.md

@@ -0,0 +1,12 @@
+---
+id: restream
+title: Restream
+---
+
+### RTSP
+
+Frigate can restream your video feed as an RTSP feed for other applications such as Home Assistant to utilize it at `rtsp://<frigate_host>:8554/<camera_name>`. Port 8554 must be open. This allows you to use a video feed for detection in frigate and Home Assistant live view at the same time without having to make two separate connections to the camera. The video feed is copied from the original video feed directly to avoid re-encoding. This feed does not include any annotation by Frigate.
+
+### RTMP (Deprecated)
+
+In previous Frigate versions RTMP was used for re-streaming. RTMP has disadvantages however including being incompatible with H.265, high bitrates, and certain audio codecs. RTMP is deprecated and it is recommended to move to the new restream role.

docs/docs/configuration/rtmp.md

@@ -1,8 +0,0 @@
----
-id: rtmp
-title: RTMP
----
-
-Frigate can re-stream your video feed as a RTMP feed for other applications such as Home Assistant to utilize it at `rtmp://<frigate_host>/live/<camera_name>`. Port 1935 must be open. This allows you to use a video feed for detection in frigate and Home Assistant live view at the same time without having to make two separate connections to the camera. The video feed is copied from the original video feed directly to avoid re-encoding. This feed does not include any annotation by Frigate.
-
-Some video feeds are not compatible with RTMP. If you are experiencing issues, check to make sure your camera feed is h264 with AAC audio. If your camera doesn't support a compatible format for RTMP, you can use the ffmpeg args to re-encode it on the fly at the expense of increased CPU utilization. Some more information about it can be found [here](../faqs#audio-in-recordings). 

docs/docs/contributing.md

@@ -126,7 +126,7 @@ ffmpeg -c:v h264_qsv -re -stream_loop -1 -i https://streams.videolan.org/ffmpeg/
 
 - [Frigate source code](#frigate-core-web-and-docs)
 - All [core](#core) prerequisites _or_ another running Frigate instance locally available
-- Node.js 14
+- Node.js 16
 
 ### Making changes
 
@@ -169,6 +169,7 @@ npm run lint
 ```
 
 - Add to unit tests and ensure they pass. As much as possible, you should strive to _increase_ test coverage whenever making changes. This will help ensure features do not accidentally become broken in the future.
+- If you run into error messages like "TypeError: Cannot read properties of undefined (reading 'context')" when running tests, this may be due to these issues (https://github.com/vitest-dev/vitest/issues/1910, https://github.com/vitest-dev/vitest/issues/1652) in vitest, but I haven't been able to resolve them.
 
 ```console
 npm run test
@@ -181,7 +182,7 @@ npm run test
 ### Prerequisites
 
 - [Frigate source code](#frigate-core-web-and-docs)
-- Node.js 14
+- Node.js 16
 
 ### Making changes
 

docs/docs/faqs.md

@@ -13,7 +13,7 @@ A solid green image means that frigate has not received any frames from ffmpeg.
 
 ### How can I get sound or audio in my recordings? {#audio-in-recordings}
 
-By default, Frigate removes audio from recordings to reduce the likelihood of failing for invalid data. If you would like to include audio, you need to override the output args to remove `-an` for where you want to include audio. The recommended audio codec is `aac`. Not all audio codecs are supported by RTMP, so you may need to re-encode your audio with `-c:a aac`. The default ffmpeg args are shown [here](/configuration/index/#full-configuration-reference).
+By default, Frigate removes audio from recordings to reduce the likelihood of failing for invalid data. If you would like to include audio, you need to override the output args to remove `-an` for where you want to include audio. The recommended audio codec is `aac`. Not all audio codecs are supported by RTMP, so you may need to re-encode your audio with `-c:a aac`. The default ffmpeg args are shown [here](/configuration/#full-configuration-reference).
 
 :::tip
 
@@ -47,3 +47,7 @@ These messages in the logs are expected in certain situations. Frigate checks th
 ### "On connect called"
 
 If you see repeated "On connect called" messages in your config, check for another instance of frigate. This happens when multiple frigate containers are trying to connect to mqtt with the same client_id.
+
+### Error: Database Is Locked
+
+sqlite does not work well on a network share, if the `/media` folder is mapped to a network share then [this guide](/configuration/advanced#database) should be used to move the database to a location on the internal drive.

docs/docs/guides/events_setup.md

@@ -0,0 +1,10 @@
+---
+id: events_setup
+title: Setting Up Events
+---
+
+[Snapshots](../configuration/snapshots.md) and/or [Recordings](../configuration/record.md) must be enabled for events to be created for detected objects.
+
+## Limiting Events to Areas of Interest
+
+The best way to limit events to areas of interest is to use [zones](../configuration/zones.md) along with `required_zones` for events and snapshots to only have events created in areas of interest.

docs/docs/guides/stationary_objects.md

@@ -3,7 +3,7 @@ id: stationary_objects
 title: Avoiding stationary objects
 ---
 
-Many people use Frigate to detect cars entering their driveway, and they often run into an issue with repeated events of a parked car being repeatedly detected. This is because object tracking stops when motion ends and the event ends. Motion detection works by determining if a sufficient number of pixels have changed between frames. Shadows or other lighting changes will be detected as motion. This will often cause a new event for a parked car.
+Many people use Frigate to detect cars entering their driveway, and they often run into an issue with repeated events of a parked car being repeatedly detected over the course of multiple days (for example if the car is lost at night and detected again the following morning.
 
 You can use zones to restrict events and notifications to objects that have entered specific areas.
 

docs/docs/hardware.md

@@ -24,14 +24,14 @@ I may earn a small commission for my endorsement, recommendation, testimonial, o
 My current favorite is the Minisforum GK41 because of the dual NICs that allow you to setup a dedicated private network for your cameras where they can be blocked from accessing the internet. There are many used workstation options on eBay that work very well. Anything with an Intel CPU and capable of running Debian should work fine. As a bonus, you may want to look for devices with a M.2 or PCIe express slot that is compatible with the Google Coral. I may earn a small commission for my endorsement, recommendation, testimonial, or link to any products or services from this website.
 
 | Name                                                                                                                                                                                                                                                                                                              | Inference Speed | Coral Compatibility | Notes                                                                                                                                   |
-| ------------------------------------------------------------------------------------------------------------------------------- | --------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| <a href="https://amzn.to/3oH4BKi" target="_blank" rel="nofollow noopener sponsored">Odyssey X86 Blue J4125</a> (affiliate link) | 9-10ms          | M.2 B+M             | Dual gigabit NICs for easy isolated camera network. Easily handles several 1080p cameras.                                               |
-| <a href="https://amzn.to/3ptnb8D" target="_blank" rel="nofollow noopener sponsored">Minisforum GK41</a> (affiliate link)        | 9-10ms          | USB                 | Dual gigabit NICs for easy isolated camera network. Easily handles several 1080p cameras.                                               |
-| <a href="https://amzn.to/35E79BC" target="_blank" rel="nofollow noopener sponsored">Beelink GK55</a> (affiliate link)           | 9-10ms          | USB                 | Dual gigabit NICs for easy isolated camera network. Easily handles several 1080p cameras.                                               |
-| <a href="https://amzn.to/3psFlHi" target="_blank" rel="nofollow noopener sponsored">Intel NUC</a> (affiliate link)              | 8-10ms          | USB                 | Overkill for most, but great performance. Can handle many cameras at 5fps depending on typical amounts of motion. Requires extra parts. |
-| <a href="https://amzn.to/3a6TBh8" target="_blank" rel="nofollow noopener sponsored">BMAX B2 Plus</a> (affiliate link)           | 10-12ms         | USB                 | Good balance of performance and cost. Also capable of running many other services at the same time as frigate.                          |
-| <a href="https://amzn.to/2YjpY9m" target="_blank" rel="nofollow noopener sponsored">Atomic Pi</a> (affiliate link)              | 16ms            | USB                 | Good option for a dedicated low power board with a small number of cameras. Can leverage Intel QuickSync for stream decoding.           |
-| <a href="https://amzn.to/2YhSGHH" target="_blank" rel="nofollow noopener sponsored">Raspberry Pi 4 (64bit)</a> (affiliate link) | 10-15ms         | USB                 | Can handle a small number of cameras.                                                                                                   |
+| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
+| Odyssey X86 Blue J4125 (<a href="https://amzn.to/3oH4BKi" target="_blank" rel="nofollow noopener sponsored">Amazon</a>) (<a href="https://www.seeedstudio.com/Frigate-NVR-with-Odyssey-Blue-and-Coral-USB-Accelerator.html?utm_source=Frigate" target="_blank" rel="nofollow noopener sponsored">SeeedStudio</a>) | 9-10ms          | M.2 B+M, USB        | Dual gigabit NICs for easy isolated camera network. Easily handles several 1080p cameras.                                               |
+| Minisforum GK41 (<a href="https://amzn.to/3ptnb8D" target="_blank" rel="nofollow noopener sponsored">Amazon</a>)                                                                                                                                                                                                  | 9-10ms          | USB                 | Dual gigabit NICs for easy isolated camera network. Easily handles several 1080p cameras.                                               |
+| Beelink GK55 (<a href="https://amzn.to/35E79BC" target="_blank" rel="nofollow noopener sponsored">Amazon</a>)                                                                                                                                                                                                     | 9-10ms          | USB                 | Dual gigabit NICs for easy isolated camera network. Easily handles several 1080p cameras.                                               |
+| Intel NUC (<a href="https://amzn.to/3psFlHi" target="_blank" rel="nofollow noopener sponsored">Amazon</a>)                                                                                                                                                                                                        | 8-10ms          | USB                 | Overkill for most, but great performance. Can handle many cameras at 5fps depending on typical amounts of motion. Requires extra parts. |
+| BMAX B2 Plus (<a href="https://amzn.to/3a6TBh8" target="_blank" rel="nofollow noopener sponsored">Amazon</a>)                                                                                                                                                                                                     | 10-12ms         | USB                 | Good balance of performance and cost. Also capable of running many other services at the same time as frigate.                          |
+| Atomic Pi (<a href="https://amzn.to/2YjpY9m" target="_blank" rel="nofollow noopener sponsored">Amazon</a>)                                                                                                                                                                                                        | 16ms            | USB                 | Good option for a dedicated low power board with a small number of cameras. Can leverage Intel QuickSync for stream decoding.           |
+| Raspberry Pi 4 (64bit) (<a href="https://amzn.to/2YhSGHH" target="_blank" rel="nofollow noopener sponsored">Amazon</a>)                                                                                                                                                                                           | 10-15ms         | USB                 | Can handle a small number of cameras.                                                                                                   |
 
 ## Google Coral TPU
 

docs/docs/installation.md

@@ -21,12 +21,6 @@ Windows is not officially supported, but some users have had success getting it
 
 Frigate uses the following locations for read/write operations in the container. Docker volume mappings can be used to map these to any location on your host machine.
 
-:::caution
-
-Note that Frigate does not currently support limiting recordings based on available disk space automatically. If using recordings, you must specify retention settings for a number of days that will fit within the available disk space of your drive or Frigate will crash.
-
-:::
-
 - `/media/frigate/clips`: Used for snapshot storage. In the future, it will likely be renamed from `clips` to `snapshots`. The file structure here cannot be modified and isn't intended to be browsed or managed manually.
 - `/media/frigate/recordings`: Internal system storage for recording segments. The file structure here cannot be modified and isn't intended to be browsed or managed manually.
 - `/media/frigate/frigate.db`: Default location for the sqlite database. You will also see several files alongside this file while frigate is running. If moving the database location (often needed when using a network drive at `/media/frigate`), it is recommended to mount a volume with docker at `/db` and change the storage location of the database to `/db/frigate.db` in the config file.
@@ -100,18 +94,7 @@ Additionally, the USB Coral draws a considerable amount of power. If using any o
 
 ## Docker
 
-Running in Docker directly is the recommended install method.
-
-Make sure you choose the right image for your architecture:
-
-| Arch        | Image Name                                 |
-| ----------- | ------------------------------------------ |
-| amd64       | blakeblackshear/frigate:stable-amd64       |
-| amd64nvidia | blakeblackshear/frigate:stable-amd64nvidia |
-| armv7       | blakeblackshear/frigate:stable-armv7       |
-| aarch64     | blakeblackshear/frigate:stable-aarch64     |
-
-It is recommended to run with docker-compose:
+Running in Docker with compose is the recommended install method:
 
 ```yaml
 version: "3.9"
@@ -120,7 +103,7 @@ services:
     container_name: frigate
     privileged: true # this may not be necessary for all setups
     restart: unless-stopped
-    image: blakeblackshear/frigate:<specify_version_tag>
+    image: blakeblackshear/frigate:stable
     shm_size: "64mb" # update for your cameras based on calculation above
     devices:
       - /dev/bus/usb:/dev/bus/usb # passes the USB Coral, needs to be modified for other versions
@@ -157,7 +140,7 @@ docker run -d \
   -e FRIGATE_RTSP_PASSWORD='password' \
   -p 5000:5000 \
   -p 1935:1935 \
-  blakeblackshear/frigate:<specify_version_tag>
+  blakeblackshear/frigate:stable
 ```
 
 ## Home Assistant Operating System (HassOS)

docs/docs/integrations/api.md

@@ -264,3 +264,11 @@ Get recording segment details for the given timestamp range.
 | -------- | ---- | ------------------------------------- |
 | `after`  | int  | Unix timestamp for beginning of range |
 | `before` | int  | Unix timestamp for end of range       |
+
+### `GET /api/ffprobe`
+
+Get ffprobe output for camera feed paths.
+
+| param   | Type   | Description                        |
+| ------- | ------ | ---------------------------------- |
+| `paths` | string | `,` separated list of camera paths |

docs/docs/integrations/home-assistant.md

@@ -85,6 +85,17 @@ The integration provides:
 
 This is accessible via "Media Browser" on the left menu panel in Home Assistant.
 
+## Casting Clips To Media Devices
+
+The integration supports casting clips and camera streams to supported media devices.
+
+:::tip
+For clips to be castable to media devices, audio is required and may need to be [enabled for recordings](../faqs.md#audio-in-recordings).
+
+**NOTE: Even if you camera does not support audio, audio will need to be enabled for Casting to be accepted.**
+
+:::
+
 <a name="api"></a>
 
 ## Notification API
@@ -167,7 +178,7 @@ for how to set these.
 
 When multiple Frigate instances are configured, [API](#api) URLs should include an
 identifier to tell Home Assistant which Frigate instance to refer to. The
-identifier used is the MQTT `client_id` paremeter included in the configuration,
+identifier used is the MQTT `client_id` parameter included in the configuration,
 and is used like so:
 
 ```

docs/docs/integrations/mqtt.md

@@ -45,6 +45,7 @@ Message published for each changed event. The first message is published when th
     "frame_time": 1607123961.837752,
     "snapshot_time": 1607123961.837752,
     "label": "person",
+    "sub_label": null,
     "top_score": 0.958984375,
     "false_positive": false,
     "start_time": 1607123955.475377,
@@ -69,6 +70,7 @@ Message published for each changed event. The first message is published when th
     "frame_time": 1607123962.082975,
     "snapshot_time": 1607123961.837752,
     "label": "person",
+    "sub_label": null,
     "top_score": 0.958984375,
     "false_positive": false,
     "start_time": 1607123955.475377,

docs/docusaurus.config.js

@@ -12,9 +12,15 @@ module.exports = {
   projectName: 'frigate',
   themeConfig: {
     algolia: {
+      appId: 'WIURGBNBPY',
       apiKey: '81ec882db78f7fed05c51daf973f0362',
       indexName: 'frigate',
     },
+    docs: {
+      sidebar: {
+        hideable: true,
+      }
+    },
     navbar: {
       title: 'Frigate',
       logo: {
@@ -35,7 +41,7 @@ module.exports = {
           position: 'right',
         },
         {
-          href: 'https://demo.frigate.video',
+          href: 'http://demo.frigate.video',
           label: 'Demo',
           position: 'right',
         },
@@ -46,8 +52,6 @@ module.exports = {
         },
       ],
     },
-    sidebarCollapsible: false,
-    hideableSidebar: true,
     footer: {
       style: 'dark',
       links: [
@@ -78,6 +82,7 @@ module.exports = {
           sidebarPath: require.resolve('./sidebars.js'),
           // Please change this to your repo.
           editUrl: 'https://github.com/blakeblackshear/frigate/edit/master/docs/',
+          sidebarCollapsible: false
         },
 
         theme: {

docs/package.json

@@ -8,17 +8,20 @@
     "build": "docusaurus build",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
+    "clear": "docusaurus clear",
     "serve": "docusaurus serve",
-    "clear": "docusaurus clear"
+    "write-translations": "docusaurus write-translations",
+    "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.0-beta.20",
-    "@docusaurus/preset-classic": "^2.0.0-beta.20",
+    "@docusaurus/core": "^2.2.0",
+    "@docusaurus/preset-classic": "^2.2.0",
     "@mdx-js/react": "^1.6.22",
-    "clsx": "^1.1.1",
+    "clsx": "^1.2.1",
     "raw-loader": "^4.0.2",
-    "react": "^16.14.0",
-    "react-dom": "^16.14.0"
+    "prism-react-renderer": "^1.3.5",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
   },
   "browserslist": {
     "production": [
@@ -33,6 +36,10 @@
     ]
   },
   "devDependencies": {
-    "@types/react": "^16.14.0"
+    "@types/react": "^17.0.0",
+    "@docusaurus/module-type-aliases": "2.2.0"
+  },
+  "engines": {
+    "node": ">=16.14"
   }
 }

docs/sidebars.js

@@ -4,6 +4,7 @@ module.exports = {
     Guides: [
       "guides/camera_setup",
       "guides/getting_started",
+      "guides/events_setup",
       "guides/false_positives",
       "guides/ha_notifications",
       "guides/stationary_objects",
@@ -16,7 +17,8 @@ module.exports = {
       "configuration/record",
       "configuration/snapshots",
       "configuration/objects",
-      "configuration/rtmp",
+      "configuration/restream",
+      "configuration/live",
       "configuration/zones",
       "configuration/birdseye",
       "configuration/stationary_objects",

frigate/app.py

@@ -1,27 +1,21 @@
-import json
 import logging
 import multiprocessing as mp
 from multiprocessing.queues import Queue
 from multiprocessing.synchronize import Event
-from multiprocessing.context import Process
 import os
 import signal
 import sys
-import threading
-from logging.handlers import QueueHandler
 from typing import Optional
 from types import FrameType
 
 import traceback
-import yaml
 from peewee_migrate import Router
 from playhouse.sqlite_ext import SqliteExtDatabase
 from playhouse.sqliteq import SqliteQueueDatabase
-from pydantic import ValidationError
 
 from frigate.config import DetectorTypeEnum, FrigateConfig
 from frigate.const import CACHE_DIR, CLIPS_DIR, RECORD_DIR
-from frigate.edgetpu import EdgeTPUProcess
+from frigate.object_detection import ObjectDetectProcess
 from frigate.events import EventCleanup, EventProcessor
 from frigate.http import create_app
 from frigate.log import log_process, root_configurer
@@ -31,7 +25,9 @@ from frigate.object_processing import TrackedObjectProcessor
 from frigate.output import output_frames
 from frigate.plus import PlusApi
 from frigate.record import RecordingCleanup, RecordingMaintainer
+from frigate.restream import RestreamApi
 from frigate.stats import StatsEmitter, stats_init
+from frigate.storage import StorageMaintainer
 from frigate.version import VERSION
 from frigate.video import capture_camera, track_camera
 from frigate.watchdog import FrigateWatchdog
@@ -44,7 +40,7 @@ class FrigateApp:
     def __init__(self) -> None:
         self.stop_event: Event = mp.Event()
         self.detection_queue: Queue = mp.Queue()
-        self.detectors: dict[str, EdgeTPUProcess] = {}
+        self.detectors: dict[str, ObjectDetectProcess] = {}
         self.detection_out_events: dict[str, Event] = {}
         self.detection_shms: list[mp.shared_memory.SharedMemory] = []
         self.log_queue: Queue = mp.Queue()
@@ -168,6 +164,10 @@ class FrigateApp:
             self.plus_api,
         )
 
+    def init_restream(self) -> None:
+        self.restream = RestreamApi(self.config)
+        self.restream.add_cameras()
+
     def init_mqtt(self) -> None:
         self.mqtt_client = create_mqtt_client(self.config, self.camera_metrics)
 
@@ -178,8 +178,6 @@ class FrigateApp:
         self.mqtt_relay.start()
 
     def start_detectors(self) -> None:
-        model_path = self.config.model.path
-        model_shape = (self.config.model.height, self.config.model.width)
         for name in self.config.cameras.keys():
             self.detection_out_events[name] = mp.Event()
 
@@ -203,23 +201,12 @@ class FrigateApp:
             self.detection_shms.append(shm_out)
 
         for name, detector in self.config.detectors.items():
-            if detector.type == DetectorTypeEnum.cpu:
-                self.detectors[name] = EdgeTPUProcess(
+            self.detectors[name] = ObjectDetectProcess(
                 name,
                 self.detection_queue,
                 self.detection_out_events,
-                    model_path,
-                    model_shape,
-                    "cpu",
-                    detector.num_threads,
-                )
-            if detector.type == DetectorTypeEnum.edgetpu:
-                self.detectors[name] = EdgeTPUProcess(
-                    name,
-                    self.detection_queue,
-                    self.detection_out_events,
-                    model_path,
-                    model_shape,
+                self.config.model,
+                detector.type,
                 detector.device,
                 detector.num_threads,
             )
@@ -253,15 +240,18 @@ class FrigateApp:
         logger.info(f"Output process started: {output_processor.pid}")
 
     def start_camera_processors(self) -> None:
-        model_shape = (self.config.model.height, self.config.model.width)
         for name, config in self.config.cameras.items():
+            if not self.config.cameras[name].enabled:
+                logger.info(f"Camera processor not started for disabled camera {name}")
+                continue
+
             camera_process = mp.Process(
                 target=track_camera,
                 name=f"camera_processor:{name}",
                 args=(
                     name,
                     config,
-                    model_shape,
+                    self.config.model,
                     self.config.model.merged_labelmap,
                     self.detection_queue,
                     self.detection_out_events[name],
@@ -276,6 +266,10 @@ class FrigateApp:
 
     def start_camera_capture_processes(self) -> None:
         for name, config in self.config.cameras.items():
+            if not self.config.cameras[name].enabled:
+                logger.info(f"Capture process not started for disabled camera {name}")
+                continue
+
             capture_process = mp.Process(
                 target=capture_camera,
                 name=f"camera_capture:{name}",
@@ -310,6 +304,10 @@ class FrigateApp:
         self.recording_cleanup = RecordingCleanup(self.config, self.stop_event)
         self.recording_cleanup.start()
 
+    def start_storage_maintainer(self) -> None:
+        self.storage_maintainer = StorageMaintainer(self.config, self.stop_event)
+        self.storage_maintainer.start()
+
     def start_stats_emitter(self) -> None:
         self.stats_emitter = StatsEmitter(
             self.config,
@@ -364,11 +362,13 @@ class FrigateApp:
         self.start_camera_capture_processes()
         self.init_stats()
         self.init_web_server()
+        self.init_restream()
         self.start_mqtt_relay()
         self.start_event_processor()
         self.start_event_cleanup()
         self.start_recording_maintainer()
         self.start_recording_cleanup()
+        self.start_storage_maintainer()
         self.start_stats_emitter()
         self.start_watchdog()
         # self.zeroconf = broadcast_zeroconf(self.config.mqtt.client_id)

frigate/config.py

@@ -12,8 +12,19 @@ import yaml
 from pydantic import BaseModel, Extra, Field, validator
 from pydantic.fields import PrivateAttr
 
-from frigate.const import BASE_DIR, CACHE_DIR, YAML_EXT
-from frigate.util import create_mask, deep_merge, load_labels
+from frigate.const import (
+    BASE_DIR,
+    CACHE_DIR,
+    REGEX_CAMERA_NAME,
+    YAML_EXT,
+)
+from frigate.util import (
+    create_mask,
+    deep_merge,
+    escape_special_characters,
+    load_config_with_no_duplicates,
+    load_labels,
+)
 
 logger = logging.getLogger(__name__)
 
@@ -403,6 +414,7 @@ class FfmpegConfig(FrigateBaseModel):
 
 class CameraRoleEnum(str, Enum):
     record = "record"
+    restream = "restream"
     rtmp = "rtmp"
     detect = "detect"
 
@@ -513,12 +525,22 @@ class CameraMqttConfig(FrigateBaseModel):
 
 
 class RtmpConfig(FrigateBaseModel):
-    enabled: bool = Field(default=True, title="RTMP restreaming enabled.")
+    enabled: bool = Field(default=False, title="RTMP restreaming enabled.")
 
 
-class CameraLiveConfig(FrigateBaseModel):
-    height: int = Field(default=720, title="Live camera view height")
-    quality: int = Field(default=8, ge=1, le=31, title="Live camera view quality")
+class JsmpegStreamConfig(FrigateBaseModel):
+    height: int = Field(default=720, title="Live camera view height.")
+    quality: int = Field(default=8, ge=1, le=31, title="Live camera view quality.")
+
+
+class RestreamConfig(FrigateBaseModel):
+    enabled: bool = Field(default=True, title="Restreaming enabled.")
+    force_audio: bool = Field(
+        default=False, title="Force audio compatibility with the browser."
+    )
+    jsmpeg: JsmpegStreamConfig = Field(
+        default_factory=JsmpegStreamConfig, title="Jsmpeg Stream Configuration."
+    )
 
 
 class CameraUiConfig(FrigateBaseModel):
@@ -529,7 +551,8 @@ class CameraUiConfig(FrigateBaseModel):
 
 
 class CameraConfig(FrigateBaseModel):
-    name: Optional[str] = Field(title="Camera name.", regex="^[a-zA-Z0-9_-]+$")
+    name: Optional[str] = Field(title="Camera name.", regex=REGEX_CAMERA_NAME)
+    enabled: bool = Field(default=True, title="Enable camera.")
     ffmpeg: CameraFfmpegConfig = Field(title="FFmpeg configuration for the camera.")
     best_image_timeout: int = Field(
         default=60,
@@ -544,8 +567,8 @@ class CameraConfig(FrigateBaseModel):
     rtmp: RtmpConfig = Field(
         default_factory=RtmpConfig, title="RTMP restreaming configuration."
     )
-    live: CameraLiveConfig = Field(
-        default_factory=CameraLiveConfig, title="Live playback settings."
+    restream: RestreamConfig = Field(
+        default_factory=RestreamConfig, title="Restreaming configuration."
     )
     snapshots: SnapshotsConfig = Field(
         default_factory=SnapshotsConfig, title="Snapshot configuration."
@@ -582,7 +605,16 @@ class CameraConfig(FrigateBaseModel):
 
         # add roles to the input if there is only one
         if len(config["ffmpeg"]["inputs"]) == 1:
-            config["ffmpeg"]["inputs"][0]["roles"] = ["record", "rtmp", "detect"]
+            has_rtmp = "rtmp" in config["ffmpeg"]["inputs"][0].get("roles", [])
+
+            config["ffmpeg"]["inputs"][0]["roles"] = [
+                "record",
+                "detect",
+                "restream",
+            ]
+
+            if has_rtmp:
+                config["ffmpeg"]["inputs"][0]["roles"].append("rtmp")
 
         super().__init__(**config)
 
@@ -674,7 +706,7 @@ class CameraConfig(FrigateBaseModel):
             + global_args
             + hwaccel_args
             + input_args
-            + ["-i", ffmpeg_input.path]
+            + ["-i", escape_special_characters(ffmpeg_input.path)]
             + ffmpeg_output_args
         )
 
@@ -687,6 +719,17 @@ class DatabaseConfig(FrigateBaseModel):
     )
 
 
+class PixelFormatEnum(str, Enum):
+    rgb = "rgb"
+    bgr = "bgr"
+    yuv = "yuv"
+
+
+class InputTensorEnum(str, Enum):
+    nchw = "nchw"
+    nhwc = "nhwc"
+
+
 class ModelConfig(FrigateBaseModel):
     path: Optional[str] = Field(title="Custom Object detection model path.")
     labelmap_path: Optional[str] = Field(title="Label map for custom object detector.")
@@ -695,6 +738,12 @@ class ModelConfig(FrigateBaseModel):
     labelmap: Dict[int, str] = Field(
         default_factory=dict, title="Labelmap customization."
     )
+    input_tensor: InputTensorEnum = Field(
+        default=InputTensorEnum.nhwc, title="Model Input Tensor Shape"
+    )
+    input_pixel_format: PixelFormatEnum = Field(
+        default=PixelFormatEnum.rgb, title="Model Input Pixel Color Format"
+    )
     _merged_labelmap: Optional[Dict[int, str]] = PrivateAttr()
     _colormap: Dict[int, Tuple[int, int, int]] = PrivateAttr()
 
@@ -738,6 +787,66 @@ class LoggerConfig(FrigateBaseModel):
     )
 
 
+def verify_config_roles(camera_config: CameraConfig) -> None:
+    """Verify that roles are setup in the config correctly."""
+    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 {camera_config.name} has record enabled, but record is not assigned to an input."
+        )
+
+    if camera_config.rtmp.enabled and not "rtmp" in assigned_roles:
+        raise ValueError(
+            f"Camera {camera_config.name} has rtmp enabled, but rtmp is not assigned to an input."
+        )
+
+    if camera_config.restream.enabled and not "restream" in assigned_roles:
+        raise ValueError(
+            f"Camera {camera_config.name} has restream enabled, but restream is not assigned to an input."
+        )
+
+
+def verify_old_retain_config(camera_config: CameraConfig) -> None:
+    """Leave log if old retain_days is used."""
+    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
+
+
+def verify_recording_retention(camera_config: CameraConfig) -> None:
+    """Verify that recording retention modes are ranked correctly."""
+    rank_map = {
+        RetainModeEnum.all: 0,
+        RetainModeEnum.motion: 1,
+        RetainModeEnum.active_objects: 2,
+    }
+
+    if (
+        camera_config.record.retain.days != 0
+        and rank_map[camera_config.record.retain.mode]
+        > rank_map[camera_config.record.events.retain.mode]
+    ):
+        logger.warning(
+            f"{camera_config.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."
+        )
+
+
+def verify_zone_objects_are_tracked(camera_config: CameraConfig) -> None:
+    """Verify that user has not entered zone objects that are not in the tracking config."""
+    for zone_name, zone in camera_config.zones.items():
+        for obj in zone.objects:
+            if obj not in camera_config.objects.track:
+                raise ValueError(
+                    f"Zone {zone_name} is configured to track {obj} but that object type is not added to objects -> track."
+                )
+
+
 class FrigateConfig(FrigateBaseModel):
     mqtt: MqttConfig = Field(title="MQTT Configuration.")
     database: DatabaseConfig = Field(
@@ -763,12 +872,12 @@ class FrigateConfig(FrigateBaseModel):
     snapshots: SnapshotsConfig = Field(
         default_factory=SnapshotsConfig, title="Global snapshots configuration."
     )
-    live: CameraLiveConfig = Field(
-        default_factory=CameraLiveConfig, title="Global live configuration."
-    )
     rtmp: RtmpConfig = Field(
         default_factory=RtmpConfig, title="Global RTMP restreaming configuration."
     )
+    restream: RestreamConfig = Field(
+        default_factory=RestreamConfig, title="Global restream configuration."
+    )
     birdseye: BirdseyeConfig = Field(
         default_factory=BirdseyeConfig, title="Birdseye configuration."
     )
@@ -799,14 +908,14 @@ class FrigateConfig(FrigateBaseModel):
         if config.mqtt.password:
             config.mqtt.password = config.mqtt.password.format(**FRIGATE_ENV_VARS)
 
-        # Global config to propegate down to camera level
+        # Global config to propagate down to camera level
         global_config = config.dict(
             include={
                 "birdseye": ...,
                 "record": ...,
                 "snapshots": ...,
-                "live": ...,
                 "rtmp": ...,
+                "restream": ...,
                 "objects": ...,
                 "motion": ...,
                 "detect": ...,
@@ -879,46 +988,19 @@ class FrigateConfig(FrigateBaseModel):
                     **camera_config.motion.dict(exclude_unset=True),
                 )
 
-            # check runtime config
-            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."
-                )
+            verify_config_roles(camera_config)
+            verify_old_retain_config(camera_config)
+            verify_recording_retention(camera_config)
+            verify_zone_objects_are_tracked(camera_config)
 
-            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."
-                )
-
-            # backwards compatibility for retain_days
-            if not camera_config.record.retain_days is None:
+            if camera_config.rtmp.enabled:
                 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'"
+                    "RTMP restream is deprecated in favor of the restream role, recommend disabling RTMP."
                 )
-                if camera_config.record.retain.days == 0:
-                    camera_config.record.retain.days = camera_config.record.retain_days
 
-            # warning if the higher level record mode is potentially more restrictive than the events
-            rank_map = {
-                RetainModeEnum.all: 0,
-                RetainModeEnum.motion: 1,
-                RetainModeEnum.active_objects: 2,
-            }
-            if (
-                camera_config.record.retain.days != 0
-                and rank_map[camera_config.record.retain.mode]
-                > rank_map[camera_config.record.events.retain.mode]
-            ):
-                logger.warning(
-                    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."
-                )
-            # generage the ffmpeg commands
+            # generate the ffmpeg commands
             camera_config.create_ffmpeg_cmds()
             config.cameras[name] = camera_config
-
         return config
 
     @validator("cameras")
@@ -935,7 +1017,7 @@ class FrigateConfig(FrigateBaseModel):
             raw_config = f.read()
 
         if config_file.endswith(YAML_EXT):
-            config = yaml.safe_load(raw_config)
+            config = load_config_with_no_duplicates(raw_config)
         elif config_file.endswith(".json"):
             config = json.loads(raw_config)
 

frigate/const.py

@@ -5,3 +5,8 @@ CACHE_DIR = "/tmp/cache"
 YAML_EXT = (".yaml", ".yml")
 PLUS_ENV_VAR = "PLUS_API_KEY"
 PLUS_API_HOST = "https://api.frigate.video"
+
+# Regex Consts
+
+REGEX_CAMERA_NAME = "^[a-zA-Z0-9_-]+$"
+REGEX_CAMERA_USER_PASS = ":\/\/[a-zA-Z0-9_-]+:[\S]+@"

frigate/detectors/cpu_tfl.py

@@ -0,0 +1,46 @@
+import logging
+import numpy as np
+
+from frigate.detectors.detection_api import DetectionApi
+import tflite_runtime.interpreter as tflite
+
+logger = logging.getLogger(__name__)
+
+
+class CpuTfl(DetectionApi):
+    def __init__(self, det_device=None, model_config=None, num_threads=3):
+        self.interpreter = tflite.Interpreter(
+            model_path=model_config.path or "/cpu_model.tflite", num_threads=num_threads
+        )
+
+        self.interpreter.allocate_tensors()
+
+        self.tensor_input_details = self.interpreter.get_input_details()
+        self.tensor_output_details = self.interpreter.get_output_details()
+
+    def detect_raw(self, tensor_input):
+        self.interpreter.set_tensor(self.tensor_input_details[0]["index"], tensor_input)
+        self.interpreter.invoke()
+
+        boxes = self.interpreter.tensor(self.tensor_output_details[0]["index"])()[0]
+        class_ids = self.interpreter.tensor(self.tensor_output_details[1]["index"])()[0]
+        scores = self.interpreter.tensor(self.tensor_output_details[2]["index"])()[0]
+        count = int(
+            self.interpreter.tensor(self.tensor_output_details[3]["index"])()[0]
+        )
+
+        detections = np.zeros((20, 6), np.float32)
+
+        for i in range(count):
+            if scores[i] < 0.4 or i == 20:
+                break
+            detections[i] = [
+                class_ids[i],
+                float(scores[i]),
+                boxes[i][0],
+                boxes[i][1],
+                boxes[i][2],
+                boxes[i][3],
+            ]
+
+        return detections

frigate/detectors/detection_api.py

@@ -0,0 +1,17 @@
+import logging
+
+from abc import ABC, abstractmethod
+from typing import Dict
+
+
+logger = logging.getLogger(__name__)
+
+
+class DetectionApi(ABC):
+    @abstractmethod
+    def __init__(self, det_device=None, model_config=None):
+        pass
+
+    @abstractmethod
+    def detect_raw(self, tensor_input):
+        pass

frigate/detectors/edgetpu_tfl.py

@@ -0,0 +1,63 @@
+import logging
+import numpy as np
+
+from frigate.detectors.detection_api import DetectionApi
+import tflite_runtime.interpreter as tflite
+from tflite_runtime.interpreter import load_delegate
+
+logger = logging.getLogger(__name__)
+
+
+class EdgeTpuTfl(DetectionApi):
+    def __init__(self, det_device=None, model_config=None):
+        device_config = {"device": "usb"}
+        if not det_device is None:
+            device_config = {"device": det_device}
+
+        edge_tpu_delegate = None
+
+        try:
+            logger.info(f"Attempting to load TPU as {device_config['device']}")
+            edge_tpu_delegate = load_delegate("libedgetpu.so.1.0", device_config)
+            logger.info("TPU found")
+            self.interpreter = tflite.Interpreter(
+                model_path=model_config.path or "/edgetpu_model.tflite",
+                experimental_delegates=[edge_tpu_delegate],
+            )
+        except ValueError:
+            logger.error(
+                "No EdgeTPU was detected. If you do not have a Coral device yet, you must configure CPU detectors."
+            )
+            raise
+
+        self.interpreter.allocate_tensors()
+
+        self.tensor_input_details = self.interpreter.get_input_details()
+        self.tensor_output_details = self.interpreter.get_output_details()
+
+    def detect_raw(self, tensor_input):
+        self.interpreter.set_tensor(self.tensor_input_details[0]["index"], tensor_input)
+        self.interpreter.invoke()
+
+        boxes = self.interpreter.tensor(self.tensor_output_details[0]["index"])()[0]
+        class_ids = self.interpreter.tensor(self.tensor_output_details[1]["index"])()[0]
+        scores = self.interpreter.tensor(self.tensor_output_details[2]["index"])()[0]
+        count = int(
+            self.interpreter.tensor(self.tensor_output_details[3]["index"])()[0]
+        )
+
+        detections = np.zeros((20, 6), np.float32)
+
+        for i in range(count):
+            if scores[i] < 0.4 or i == 20:
+                break
+            detections[i] = [
+                class_ids[i],
+                float(scores[i]),
+                boxes[i][0],
+                boxes[i][1],
+                boxes[i][2],
+                boxes[i][3],
+            ]
+
+        return detections

frigate/http.py

@@ -1,13 +1,14 @@
 import base64
-from collections import OrderedDict
 from datetime import datetime, timedelta
 import copy
 import logging
+import json
 import os
 import subprocess as sp
 import time
 from functools import reduce
 from pathlib import Path
+from urllib.parse import unquote
 
 import cv2
 
@@ -25,9 +26,11 @@ from flask import (
 from peewee import SqliteDatabase, operator, fn, DoesNotExist
 from playhouse.shortcuts import model_to_dict
 
-from frigate.const import CLIPS_DIR, PLUS_ENV_VAR
+from frigate.const import CLIPS_DIR
 from frigate.models import Event, Recordings
+from frigate.object_processing import TrackedObject
 from frigate.stats import stats_snapshot
+from frigate.util import clean_camera_user_pass, ffprobe_stream
 from frigate.version import VERSION
 
 logger = logging.getLogger(__name__)
@@ -210,7 +213,7 @@ def delete_retain(id):
 @bp.route("/events/<id>/sub_label", methods=("POST",))
 def set_sub_label(id):
     try:
-        event = Event.get(Event.id == id)
+        event: Event = Event.get(Event.id == id)
     except DoesNotExist:
         return make_response(
             jsonify({"success": False, "message": "Event " + id + " not found"}), 404
@@ -233,6 +236,16 @@ def set_sub_label(id):
             400,
         )
 
+    if not event.end_time:
+        tracked_obj: TrackedObject = (
+            current_app.detected_frames_processor.camera_states[
+                event.camera
+            ].tracked_objects.get(event.id)
+        )
+
+        if tracked_obj:
+            tracked_obj.obj_data["sub_label"] = new_sub_label
+
     event.sub_label = new_sub_label
     event.save()
     return make_response(
@@ -341,11 +354,11 @@ def event_thumbnail(id, max_cache_age=2592000):
 @bp.route("/<camera_name>/<label>/best.jpg")
 @bp.route("/<camera_name>/<label>/thumbnail.jpg")
 def label_thumbnail(camera_name, label):
+    label = unquote(label)
     if label == "any":
         event_query = (
             Event.select()
             .where(Event.camera == camera_name)
-            .where(Event.has_snapshot == True)
             .order_by(Event.start_time.desc())
         )
     else:
@@ -353,7 +366,6 @@ def label_thumbnail(camera_name, label):
             Event.select()
             .where(Event.camera == camera_name)
             .where(Event.label == label)
-            .where(Event.has_snapshot == True)
             .order_by(Event.start_time.desc())
         )
 
@@ -424,6 +436,7 @@ def event_snapshot(id):
 
 @bp.route("/<camera_name>/<label>/snapshot.jpg")
 def label_snapshot(camera_name, label):
+    label = unquote(label)
     if label == "any":
         event_query = (
             Event.select()
@@ -491,7 +504,7 @@ def event_clip(id):
 def events():
     limit = request.args.get("limit", 100)
     camera = request.args.get("camera", "all")
-    label = request.args.get("label", "all")
+    label = unquote(request.args.get("label", "all"))
     sub_label = request.args.get("sub_label", "all")
     zone = request.args.get("zone", "all")
     after = request.args.get("after", type=float)
@@ -569,9 +582,9 @@ def config():
         camera_dict = config["cameras"][camera_name]
         camera_dict["ffmpeg_cmds"] = copy.deepcopy(camera.ffmpeg_cmds)
         for cmd in camera_dict["ffmpeg_cmds"]:
-            cmd["cmd"] = " ".join(cmd["cmd"])
+            cmd["cmd"] = clean_camera_user_pass(" ".join(cmd["cmd"]))
 
-    config["plus"] = {"enabled": PLUS_ENV_VAR in os.environ}
+    config["plus"] = {"enabled": current_app.plus_api.is_active()}
 
     return jsonify(config)
 
@@ -739,6 +752,7 @@ def recordings(camera_name):
             Recordings.id,
             Recordings.start_time,
             Recordings.end_time,
+            Recordings.segment_size,
             Recordings.motion,
             Recordings.objects,
         )
@@ -753,9 +767,9 @@ def recordings(camera_name):
     return jsonify([e for e in recordings.dicts()])
 
 
-@bp.route("/<camera>/start/<int:start_ts>/end/<int:end_ts>/clip.mp4")
-@bp.route("/<camera>/start/<float:start_ts>/end/<float:end_ts>/clip.mp4")
-def recording_clip(camera, start_ts, end_ts):
+@bp.route("/<camera_name>/start/<int:start_ts>/end/<int:end_ts>/clip.mp4")
+@bp.route("/<camera_name>/start/<float:start_ts>/end/<float:end_ts>/clip.mp4")
+def recording_clip(camera_name, start_ts, end_ts):
     download = request.args.get("download", type=bool)
 
     recordings = (
@@ -765,7 +779,7 @@ def recording_clip(camera, start_ts, end_ts):
             | (Recordings.end_time.between(start_ts, end_ts))
             | ((start_ts > Recordings.start_time) & (end_ts < Recordings.end_time))
         )
-        .where(Recordings.camera == camera)
+        .where(Recordings.camera == camera_name)
         .order_by(Recordings.start_time.asc())
     )
 
@@ -780,9 +794,10 @@ def recording_clip(camera, start_ts, end_ts):
         if clip.end_time > end_ts:
             playlist_lines.append(f"outpoint {int(end_ts - clip.start_time)}")
 
-    file_name = f"clip_{camera}_{start_ts}-{end_ts}.mp4"
+    file_name = f"clip_{camera_name}_{start_ts}-{end_ts}.mp4"
     path = f"/tmp/cache/{file_name}"
 
+    if not os.path.exists(path):
         ffmpeg_cmd = [
             "ffmpeg",
             "-y",
@@ -800,16 +815,20 @@ def recording_clip(camera, start_ts, end_ts):
             "+faststart",
             path,
         ]
-
         p = sp.run(
             ffmpeg_cmd,
             input="\n".join(playlist_lines),
             encoding="ascii",
             capture_output=True,
         )
+
         if p.returncode != 0:
             logger.error(p.stderr)
-        return f"Could not create clip from recordings for {camera}.", 500
+            return f"Could not create clip from recordings for {camera_name}.", 500
+    else:
+        logger.debug(
+            f"Ignoring subsequent request for {path} as it already exists in the cache."
+        )
 
     response = make_response()
     response.headers["Content-Description"] = "File Transfer"
@@ -825,9 +844,9 @@ def recording_clip(camera, start_ts, end_ts):
     return response
 
 
-@bp.route("/vod/<camera>/start/<int:start_ts>/end/<int:end_ts>")
-@bp.route("/vod/<camera>/start/<float:start_ts>/end/<float:end_ts>")
-def vod_ts(camera, start_ts, end_ts):
+@bp.route("/vod/<camera_name>/start/<int:start_ts>/end/<int:end_ts>")
+@bp.route("/vod/<camera_name>/start/<float:start_ts>/end/<float:end_ts>")
+def vod_ts(camera_name, start_ts, end_ts):
     recordings = (
         Recordings.select()
         .where(
@@ -835,7 +854,7 @@ def vod_ts(camera, start_ts, end_ts):
             | Recordings.end_time.between(start_ts, end_ts)
             | ((start_ts > Recordings.start_time) & (end_ts < Recordings.end_time))
         )
-        .where(Recordings.camera == camera)
+        .where(Recordings.camera == camera_name)
         .order_by(Recordings.start_time.asc())
     )
 
@@ -846,16 +865,13 @@ def vod_ts(camera, start_ts, end_ts):
     for recording in recordings:
         clip = {"type": "source", "path": recording.path}
         duration = int(recording.duration * 1000)
-        # Determine if offset is needed for first clip
-        if recording.start_time < start_ts:
-            offset = int((start_ts - recording.start_time) * 1000)
-            clip["clipFrom"] = offset
-            duration -= offset
+
         # Determine if we need to end the last clip early
         if recording.end_time > end_ts:
             duration -= int((recording.end_time - end_ts) * 1000)
 
         if duration > 0:
+            clip["keyFrameDurations"] = [duration]
             clips.append(clip)
             durations.append(duration)
         else:
@@ -876,14 +892,14 @@ def vod_ts(camera, start_ts, end_ts):
     )
 
 
-@bp.route("/vod/<year_month>/<day>/<hour>/<camera>")
-def vod_hour(year_month, day, hour, camera):
+@bp.route("/vod/<year_month>/<day>/<hour>/<camera_name>")
+def vod_hour(year_month, day, hour, camera_name):
     start_date = datetime.strptime(f"{year_month}-{day} {hour}", "%Y-%m-%d %H")
     end_date = start_date + timedelta(hours=1) - timedelta(milliseconds=1)
     start_ts = start_date.timestamp()
     end_ts = end_date.timestamp()
 
-    return vod_ts(camera, start_ts, end_ts)
+    return vod_ts(camera_name, start_ts, end_ts)
 
 
 @bp.route("/vod/event/<id>")
@@ -941,3 +957,37 @@ def imagestream(detected_frames_processor, camera_name, fps, height, draw_option
             b"--frame\r\n"
             b"Content-Type: image/jpeg\r\n\r\n" + jpg.tobytes() + b"\r\n\r\n"
         )
+
+
+@bp.route("/ffprobe", methods=["GET"])
+def ffprobe():
+    path_param = request.args.get("paths", "")
+
+    if not path_param:
+        return jsonify(
+            {"success": False, "message": f"Path needs to be provided."}, "404"
+        )
+
+    if "," in clean_camera_user_pass(path_param):
+        paths = path_param.split(",")
+    else:
+        paths = [path_param]
+
+    # user has multiple streams
+    output = []
+
+    for path in paths:
+        ffprobe = ffprobe_stream(path)
+        output.append(
+            {
+                "return_code": ffprobe.returncode,
+                "stderr": json.loads(ffprobe.stderr.decode("unicode_escape").strip())
+                if ffprobe.stderr.decode()
+                else {},
+                "stdout": json.loads(ffprobe.stdout.decode("unicode_escape").strip())
+                if ffprobe.stdout.decode()
+                else {},
+            }
+        )
+
+    return jsonify(output)

frigate/log.py

@@ -2,7 +2,6 @@
 import logging
 import threading
 import os
-import signal
 import queue
 from multiprocessing.queues import Queue
 from logging import handlers
@@ -10,6 +9,8 @@ from setproctitle import setproctitle
 from typing import Deque
 from collections import deque
 
+from frigate.util import clean_camera_user_pass
+
 
 def listener_configurer() -> None:
     root = logging.getLogger()
@@ -55,6 +56,11 @@ class LogPipe(threading.Thread):
         self.pipeReader = os.fdopen(self.fdRead)
         self.start()
 
+    def cleanup_log(self, log: str) -> str:
+        """Cleanup the log line to remove sensitive info and string tokens."""
+        log = clean_camera_user_pass(log).strip("\n")
+        return log
+
     def fileno(self) -> int:
         """Return the write file descriptor of the pipe"""
         return self.fdWrite
@@ -62,7 +68,7 @@ class LogPipe(threading.Thread):
     def run(self) -> None:
         """Run the thread, logging everything."""
         for line in iter(self.pipeReader.readline, ""):
-            self.deque.append(line.strip("\n"))
+            self.deque.append(self.cleanup_log(line))
 
         self.pipeReader.close()
 

frigate/models.py

@@ -41,3 +41,4 @@ class Recordings(Model):  # type: ignore[misc]
     duration = FloatField()
     motion = IntegerField(null=True)
     objects = IntegerField(null=True)
+    segment_size = FloatField(default=0)  # this should be stored as MB

frigate/mqtt.py

@@ -84,6 +84,8 @@ def create_mqtt_client(config: FrigateConfig, camera_metrics):
                         f"Turning on motion for {camera_name} due to detection being enabled."
                     )
                     camera_metrics[camera_name]["motion_enabled"].value = True
+                    state_topic = f"{message.topic[:-11]}/motion/state"
+                    client.publish(state_topic, payload, retain=True)
         elif payload == "OFF":
             if camera_metrics[camera_name]["detection_enabled"].value:
                 logger.info(f"Turning off detection for {camera_name} via mqtt")

frigate/object_detection.py

@@ -8,9 +8,11 @@ import threading
 from abc import ABC, abstractmethod
 
 import numpy as np
-import tflite_runtime.interpreter as tflite
 from setproctitle import setproctitle
-from tflite_runtime.interpreter import load_delegate
+
+from frigate.config import DetectorTypeEnum, InputTensorEnum
+from frigate.detectors.edgetpu_tfl import EdgeTpuTfl
+from frigate.detectors.cpu_tfl import CpuTfl
 
 from frigate.util import EventsPerSecond, SharedMemoryFrameManager, listen, load_labels
 
@@ -23,46 +25,43 @@ class ObjectDetector(ABC):
         pass
 
 
+def tensor_transform(desired_shape):
+    # Currently this function only supports BHWC permutations
+    if desired_shape == InputTensorEnum.nhwc:
+        return None
+    elif desired_shape == InputTensorEnum.nchw:
+        return (0, 3, 1, 2)
+
+
 class LocalObjectDetector(ObjectDetector):
-    def __init__(self, tf_device=None, model_path=None, num_threads=3, labels=None):
+    def __init__(
+        self,
+        det_type=DetectorTypeEnum.cpu,
+        det_device=None,
+        model_config=None,
+        num_threads=3,
+        labels=None,
+    ):
         self.fps = EventsPerSecond()
         if labels is None:
             self.labels = {}
         else:
             self.labels = load_labels(labels)
 
-        device_config = {"device": "usb"}
-        if not tf_device is None:
-            device_config = {"device": tf_device}
+        if model_config:
+            self.input_transform = tensor_transform(model_config.input_tensor)
+        else:
+            self.input_transform = None
 
-        edge_tpu_delegate = None
-
-        if tf_device != "cpu":
-            try:
-                logger.info(f"Attempting to load TPU as {device_config['device']}")
-                edge_tpu_delegate = load_delegate("libedgetpu.so.1.0", device_config)
-                logger.info("TPU found")
-                self.interpreter = tflite.Interpreter(
-                    model_path=model_path or "/edgetpu_model.tflite",
-                    experimental_delegates=[edge_tpu_delegate],
+        if det_type == DetectorTypeEnum.edgetpu:
+            self.detect_api = EdgeTpuTfl(
+                det_device=det_device, model_config=model_config
             )
-            except ValueError:
-                logger.error(
-                    "No EdgeTPU was detected. If you do not have a Coral device yet, you must configure CPU detectors."
-                )
-                raise
         else:
             logger.warning(
                 "CPU detectors are not recommended and should only be used for testing or for trial purposes."
             )
-            self.interpreter = tflite.Interpreter(
-                model_path=model_path or "/cpu_model.tflite", num_threads=num_threads
-            )
-
-        self.interpreter.allocate_tensors()
-
-        self.tensor_input_details = self.interpreter.get_input_details()
-        self.tensor_output_details = self.interpreter.get_output_details()
+            self.detect_api = CpuTfl(model_config=model_config, num_threads=num_threads)
 
     def detect(self, tensor_input, threshold=0.4):
         detections = []
@@ -79,31 +78,9 @@ class LocalObjectDetector(ObjectDetector):
         return detections
 
     def detect_raw(self, tensor_input):
-        self.interpreter.set_tensor(self.tensor_input_details[0]["index"], tensor_input)
-        self.interpreter.invoke()
-
-        boxes = self.interpreter.tensor(self.tensor_output_details[0]["index"])()[0]
-        class_ids = self.interpreter.tensor(self.tensor_output_details[1]["index"])()[0]
-        scores = self.interpreter.tensor(self.tensor_output_details[2]["index"])()[0]
-        count = int(
-            self.interpreter.tensor(self.tensor_output_details[3]["index"])()[0]
-        )
-
-        detections = np.zeros((20, 6), np.float32)
-
-        for i in range(count):
-            if scores[i] < 0.4 or i == 20:
-                break
-            detections[i] = [
-                class_ids[i],
-                float(scores[i]),
-                boxes[i][0],
-                boxes[i][1],
-                boxes[i][2],
-                boxes[i][3],
-            ]
-
-        return detections
+        if self.input_transform:
+            tensor_input = np.transpose(tensor_input, self.input_transform)
+        return self.detect_api.detect_raw(tensor_input=tensor_input)
 
 
 def run_detector(
@@ -112,9 +89,9 @@ def run_detector(
     out_events: dict[str, mp.Event],
     avg_speed,
     start,
-    model_path,
-    model_shape,
-    tf_device,
+    model_config,
+    det_type,
+    det_device,
     num_threads,
 ):
     threading.current_thread().name = f"detector:{name}"
@@ -133,7 +110,10 @@ def run_detector(
 
     frame_manager = SharedMemoryFrameManager()
     object_detector = LocalObjectDetector(
-        tf_device=tf_device, model_path=model_path, num_threads=num_threads
+        det_type=det_type,
+        det_device=det_device,
+        model_config=model_config,
+        num_threads=num_threads,
     )
 
     outputs = {}
@@ -148,7 +128,7 @@ def run_detector(
         except queue.Empty:
             continue
         input_frame = frame_manager.get(
-            connection_id, (1, model_shape[0], model_shape[1], 3)
+            connection_id, (1, model_config.height, model_config.width, 3)
         )
 
         if input_frame is None:
@@ -165,15 +145,15 @@ def run_detector(
         avg_speed.value = (avg_speed.value * 9 + duration) / 10
 
 
-class EdgeTPUProcess:
+class ObjectDetectProcess:
     def __init__(
         self,
         name,
         detection_queue,
         out_events,
-        model_path,
-        model_shape,
-        tf_device=None,
+        model_config,
+        det_type=None,
+        det_device=None,
         num_threads=3,
     ):
         self.name = name
@@ -182,9 +162,9 @@ class EdgeTPUProcess:
         self.avg_inference_speed = mp.Value("d", 0.01)
         self.detection_start = mp.Value("d", 0.0)
         self.detect_process = None
-        self.model_path = model_path
-        self.model_shape = model_shape
-        self.tf_device = tf_device
+        self.model_config = model_config
+        self.det_type = det_type
+        self.det_device = det_device
         self.num_threads = num_threads
         self.start_or_restart()
 
@@ -210,9 +190,9 @@ class EdgeTPUProcess:
                 self.out_events,
                 self.avg_inference_speed,
                 self.detection_start,
-                self.model_path,
-                self.model_shape,
-                self.tf_device,
+                self.model_config,
+                self.det_type,
+                self.det_device,
                 self.num_threads,
             ),
         )
@@ -221,7 +201,7 @@ class EdgeTPUProcess:
 
 
 class RemoteObjectDetector:
-    def __init__(self, name, labels, detection_queue, event, model_shape):
+    def __init__(self, name, labels, detection_queue, event, model_config):
         self.labels = labels
         self.name = name
         self.fps = EventsPerSecond()
@@ -229,7 +209,9 @@ class RemoteObjectDetector:
         self.event = event
         self.shm = mp.shared_memory.SharedMemory(name=self.name, create=False)
         self.np_shm = np.ndarray(
-            (1, model_shape[0], model_shape[1], 3), dtype=np.uint8, buffer=self.shm.buf
+            (1, model_config.height, model_config.width, 3),
+            dtype=np.uint8,
+            buffer=self.shm.buf,
         )
         self.out_shm = mp.shared_memory.SharedMemory(
             name=f"out-{self.name}", create=False

frigate/object_processing.py

@@ -180,6 +180,7 @@ class TrackedObject:
             "frame_time": self.obj_data["frame_time"],
             "snapshot_time": snapshot_time,
             "label": self.obj_data["label"],
+            "sub_label": self.obj_data.get("sub_label"),
             "top_score": self.top_score,
             "false_positive": self.false_positive,
             "start_time": self.obj_data["start_time"],

frigate/output.py

@@ -366,15 +366,15 @@ def output_frames(config: FrigateConfig, video_output_queue):
 
     for camera, cam_config in config.cameras.items():
         width = int(
-            cam_config.live.height
+            cam_config.restream.jsmpeg.height
             * (cam_config.frame_shape[1] / cam_config.frame_shape[0])
         )
         converters[camera] = FFMpegConverter(
             cam_config.frame_shape[1],
             cam_config.frame_shape[0],
             width,
-            cam_config.live.height,
-            cam_config.live.quality,
+            cam_config.restream.jsmpeg.height,
+            cam_config.restream.jsmpeg.quality,
         )
         broadcasters[camera] = BroadcastThread(
             camera, converters[camera], websocket_server

frigate/record.py

@@ -101,13 +101,19 @@ class RecordingMaintainer(threading.Thread):
         for camera in grouped_recordings.keys():
             segment_count = len(grouped_recordings[camera])
             if segment_count > keep_count:
-                logger.warning(
-                    f"Too many recording segments in cache for {camera}. Keeping the {keep_count} most recent segments out of {segment_count}, discarding the rest..."
-                )
+                ####
+                # Need to find a way to tell if these are aging out based on retention settings or if the system is overloaded.
+                ####
+                # logger.warning(
+                #     f"Too many recording segments in cache for {camera}. Keeping the {keep_count} most recent segments out of {segment_count}, discarding the rest..."
+                # )
                 to_remove = grouped_recordings[camera][:-keep_count]
                 for f in to_remove:
                     cache_path = f["cache_path"]
-                    logger.warning(f"Discarding a recording segment: {cache_path}")
+                    ####
+                    # Need to find a way to tell if these are aging out based on retention settings or if the system is overloaded.
+                    ####
+                    # logger.warning(f"Discarding a recording segment: {cache_path}")
                     Path(cache_path).unlink(missing_ok=True)
                     self.end_time_cache.pop(cache_path, None)
                 grouped_recordings[camera] = grouped_recordings[camera][-keep_count:]
@@ -161,11 +167,21 @@ class RecordingMaintainer(threading.Thread):
                         f"{cache_path}",
                     ]
                     p = sp.run(ffprobe_cmd, capture_output=True)
-                    if p.returncode == 0:
+                    if p.returncode == 0 and p.stdout.decode():
                         duration = float(p.stdout.decode().strip())
+                    else:
+                        duration = -1
+
+                    # ensure duration is within expected length
+                    if 0 < duration < 600:
                         end_time = start_time + datetime.timedelta(seconds=duration)
                         self.end_time_cache[cache_path] = (end_time, duration)
                     else:
+                        if duration == -1:
+                            logger.warning(
+                                f"Failed to probe corrupt segment {f}: {p.returncode} - {p.stderr}"
+                            )
+
                         logger.warning(f"Discarding a corrupt recording segment: {f}")
                         Path(cache_path).unlink(missing_ok=True)
                         continue
@@ -270,12 +286,21 @@ class RecordingMaintainer(threading.Thread):
         file_path = os.path.join(directory, file_name)
 
         try:
+            if not os.path.exists(file_path):
                 start_frame = datetime.datetime.now().timestamp()
                 # copy then delete is required when recordings are stored on some network drives
                 shutil.copyfile(cache_path, file_path)
                 logger.debug(
                     f"Copied {file_path} in {datetime.datetime.now().timestamp()-start_frame} seconds."
                 )
+
+                try:
+                    segment_size = round(
+                        float(os.path.getsize(cache_path)) / 1000000, 1
+                    )
+                except OSError:
+                    segment_size = 0
+
                 os.remove(cache_path)
 
                 rand_id = "".join(
@@ -291,6 +316,7 @@ class RecordingMaintainer(threading.Thread):
                     motion=motion_count,
                     # TODO: update this to store list of active objects at some point
                     objects=active_count,
+                    segment_size=segment_size,
                 )
         except Exception as e:
             logger.error(f"Unable to store recording segment {cache_path}")

frigate/restream.py

@@ -0,0 +1,47 @@
+"""Controls go2rtc restream."""
+
+
+import logging
+import requests
+from frigate.util import escape_special_characters
+
+from frigate.config import FrigateConfig
+
+logger = logging.getLogger(__name__)
+
+
+def get_manual_go2rtc_stream(camera_url: str) -> str:
+    """Get a manual stream for go2rtc."""
+    return f"exec: /usr/lib/btbn-ffmpeg/bin/ffmpeg -i {camera_url} -c:v copy -c:a libopus -rtsp_transport tcp -f rtsp {{output}}"
+
+
+class RestreamApi:
+    """Control go2rtc relay API."""
+
+    def __init__(self, config: FrigateConfig) -> None:
+        self.config: FrigateConfig = config
+
+    def add_cameras(self) -> None:
+        """Add cameras to go2rtc."""
+        self.relays: dict[str, str] = {}
+
+        for cam_name, camera in self.config.cameras.items():
+            if not camera.restream.enabled:
+                continue
+
+            for input in camera.ffmpeg.inputs:
+                if "restream" in input.roles:
+                    if (
+                        input.path.startswith("rtsp")
+                        and not camera.restream.force_audio
+                    ):
+                        self.relays[cam_name] = escape_special_characters(input.path)
+                    else:
+                        # go2rtc only supports rtsp for direct relay, otherwise ffmpeg is used
+                        self.relays[cam_name] = get_manual_go2rtc_stream(
+                            escape_special_characters(input.path)
+                        )
+
+        for name, path in self.relays.items():
+            params = {"src": path, "name": name}
+            requests.put("http://127.0.0.1:1984/api/streams", params=params)

frigate/stats.py

@@ -14,7 +14,8 @@ from frigate.config import FrigateConfig
 from frigate.const import RECORD_DIR, CLIPS_DIR, CACHE_DIR
 from frigate.types import StatsTrackingTypes, CameraMetricsTypes
 from frigate.version import VERSION
-from frigate.edgetpu import EdgeTPUProcess
+from frigate.util import get_cpu_stats
+from frigate.object_detection import ObjectDetectProcess
 
 logger = logging.getLogger(__name__)
 
@@ -22,7 +23,8 @@ logger = logging.getLogger(__name__)
 def get_latest_version() -> str:
     try:
         request = requests.get(
-            "https://api.github.com/repos/blakeblackshear/frigate/releases/latest"
+            "https://api.github.com/repos/blakeblackshear/frigate/releases/latest",
+            timeout=10,
         )
     except:
         return "unknown"
@@ -36,7 +38,8 @@ def get_latest_version() -> str:
 
 
 def stats_init(
-    camera_metrics: dict[str, CameraMetricsTypes], detectors: dict[str, EdgeTPUProcess]
+    camera_metrics: dict[str, CameraMetricsTypes],
+    detectors: dict[str, ObjectDetectProcess],
 ) -> StatsTrackingTypes:
     stats_tracking: StatsTrackingTypes = {
         "camera_metrics": camera_metrics,
@@ -88,6 +91,9 @@ def stats_snapshot(stats_tracking: StatsTrackingTypes) -> dict[str, Any]:
     for name, camera_stats in camera_metrics.items():
         total_detection_fps += camera_stats["detection_fps"].value
         pid = camera_stats["process"].pid if camera_stats["process"] else None
+        ffmpeg_pid = (
+            camera_stats["ffmpeg_pid"].value if camera_stats["ffmpeg_pid"] else None
+        )
         cpid = (
             camera_stats["capture_process"].pid
             if camera_stats["capture_process"]
@@ -100,6 +106,7 @@ def stats_snapshot(stats_tracking: StatsTrackingTypes) -> dict[str, Any]:
             "detection_fps": round(camera_stats["detection_fps"].value, 2),
             "pid": pid,
             "capture_pid": cpid,
+            "ffmpeg_pid": ffmpeg_pid,
         }
 
     stats["detectors"] = {}
@@ -112,6 +119,8 @@ def stats_snapshot(stats_tracking: StatsTrackingTypes) -> dict[str, Any]:
         }
     stats["detection_fps"] = round(total_detection_fps, 2)
 
+    stats["cpu_usages"] = get_cpu_stats()
+
     stats["service"] = {
         "uptime": (int(time.time()) - stats_tracking["started"]),
         "version": VERSION,

frigate/storage.py

@@ -0,0 +1,172 @@
+"""Handle storage retention and usage."""
+
+import logging
+from pathlib import Path
+import shutil
+import threading
+
+from peewee import fn
+
+from frigate.config import FrigateConfig
+from frigate.const import RECORD_DIR
+from frigate.models import Event, Recordings
+
+logger = logging.getLogger(__name__)
+bandwidth_equation = Recordings.segment_size / (
+    Recordings.end_time - Recordings.start_time
+)
+
+
+class StorageMaintainer(threading.Thread):
+    """Maintain frigates recording storage."""
+
+    def __init__(self, config: FrigateConfig, stop_event) -> None:
+        threading.Thread.__init__(self)
+        self.name = "storage_maintainer"
+        self.config = config
+        self.stop_event = stop_event
+        self.camera_storage_stats: dict[str, dict] = {}
+
+    def calculate_camera_bandwidth(self) -> None:
+        """Calculate an average MB/hr for each camera."""
+        for camera in self.config.cameras.keys():
+            # cameras with < 50 segments should be refreshed to keep size accurate
+            # when few segments are available
+            if self.camera_storage_stats.get(camera, {}).get("needs_refresh", True):
+                self.camera_storage_stats[camera] = {
+                    "needs_refresh": (
+                        Recordings.select(fn.COUNT(Recordings.id))
+                        .where(
+                            Recordings.camera == camera, Recordings.segment_size != 0
+                        )
+                        .scalar()
+                        < 50
+                    )
+                }
+
+            # calculate MB/hr
+            try:
+                bandwidth = round(
+                    Recordings.select(fn.AVG(bandwidth_equation))
+                    .where(Recordings.camera == camera, Recordings.segment_size != 0)
+                    .limit(100)
+                    .scalar()
+                    * 3600,
+                    2,
+                )
+            except TypeError:
+                bandwidth = 0
+
+            self.camera_storage_stats[camera]["bandwidth"] = bandwidth
+            logger.debug(f"{camera} has a bandwidth of {bandwidth} MB/hr.")
+
+    def check_storage_needs_cleanup(self) -> bool:
+        """Return if storage needs cleanup."""
+        # currently runs cleanup if less than 1 hour of space is left
+        # disk_usage should not spin up disks
+        hourly_bandwidth = sum(
+            [b["bandwidth"] for b in self.camera_storage_stats.values()]
+        )
+        remaining_storage = round(shutil.disk_usage(RECORD_DIR).free / 1000000, 1)
+        logger.debug(
+            f"Storage cleanup check: {hourly_bandwidth} hourly with remaining storage: {remaining_storage}."
+        )
+        return remaining_storage < hourly_bandwidth
+
+    def reduce_storage_consumption(self) -> None:
+        """Remove oldest hour of recordings."""
+        logger.debug("Starting storage cleanup.")
+        deleted_segments_size = 0
+        hourly_bandwidth = sum(
+            [b["bandwidth"] for b in self.camera_storage_stats.values()]
+        )
+
+        recordings: Recordings = Recordings.select().order_by(
+            Recordings.start_time.asc()
+        )
+        retained_events: Event = (
+            Event.select()
+            .where(
+                Event.retain_indefinitely == True,
+                Event.has_clip,
+            )
+            .order_by(Event.start_time.asc())
+            .objects()
+        )
+
+        event_start = 0
+        deleted_recordings = set()
+        for recording in recordings.objects().iterator():
+            # check if 1 hour of storage has been reclaimed
+            if deleted_segments_size > hourly_bandwidth:
+                break
+
+            keep = False
+
+            # Now look for a reason to keep this recording segment
+            for idx in range(event_start, len(retained_events)):
+                event = retained_events[idx]
+
+                # if the event starts in the future, stop checking events
+                # and let this recording segment expire
+                if event.start_time > recording.end_time:
+                    keep = False
+                    break
+
+                # if the event is in progress or ends after the recording starts, keep it
+                # and stop looking at events
+                if event.end_time is None or event.end_time >= recording.start_time:
+                    keep = True
+                    break
+
+                # if the event ends before this recording segment starts, skip
+                # this event and check the next event for an overlap.
+                # since the events and recordings are sorted, we can skip events
+                # that end before the previous recording segment started on future segments
+                if event.end_time < recording.start_time:
+                    event_start = idx
+
+            # Delete recordings not retained indefinitely
+            if not keep:
+                deleted_segments_size += recording.segment_size
+                Path(recording.path).unlink(missing_ok=True)
+                deleted_recordings.add(recording.id)
+
+        # check if need to delete retained segments
+        if deleted_segments_size < hourly_bandwidth:
+            logger.error(
+                f"Could not clear {hourly_bandwidth} currently {deleted_segments_size}, retained recordings must be deleted."
+            )
+            recordings = Recordings.select().order_by(Recordings.start_time.asc())
+
+            for recording in recordings.objects().iterator():
+                if deleted_segments_size > hourly_bandwidth:
+                    break
+
+                deleted_segments_size += recording.segment_size
+                Path(recording.path).unlink(missing_ok=True)
+                deleted_recordings.add(recording.id)
+
+        logger.debug(f"Expiring {len(deleted_recordings)} recordings")
+        # delete up to 100,000 at a time
+        max_deletes = 100000
+        deleted_recordings_list = list(deleted_recordings)
+        for i in range(0, len(deleted_recordings_list), max_deletes):
+            Recordings.delete().where(
+                Recordings.id << deleted_recordings_list[i : i + max_deletes]
+            ).execute()
+
+    def run(self):
+        """Check every 5 minutes if storage needs to be cleaned up."""
+        while not self.stop_event.wait(300):
+
+            if not self.camera_storage_stats or True in [
+                r["needs_refresh"] for r in self.camera_storage_stats.values()
+            ]:
+                self.calculate_camera_bandwidth()
+                logger.debug(f"Default camera bandwidths: {self.camera_storage_stats}.")
+
+            if self.check_storage_needs_cleanup():
+                self.reduce_storage_consumption()
+
+        logger.info(f"Exiting storage maintainer...")

frigate/test/test_camera_pw.py

@@ -0,0 +1,38 @@
+"""Test camera user and password cleanup."""
+
+import unittest
+
+from frigate.util import clean_camera_user_pass, escape_special_characters
+
+
+class TestUserPassCleanup(unittest.TestCase):
+    def setUp(self) -> None:
+        self.rtsp_with_pass = "rtsp://user:password@192.168.0.2:554/live"
+        self.rtsp_with_special_pass = (
+            "rtsp://user:password`~!@#$%^&*()-_;',.<>:\"\{\}\[\]@@192.168.0.2:554/live"
+        )
+        self.rtsp_no_pass = "rtsp://192.168.0.3:554/live"
+
+    def test_cleanup(self):
+        """Test that user / pass are cleaned up."""
+        clean = clean_camera_user_pass(self.rtsp_with_pass)
+        assert clean != self.rtsp_with_pass
+        assert "user:password" not in clean
+
+    def test_no_cleanup(self):
+        """Test that nothing changes when no user / pass are defined."""
+        clean = clean_camera_user_pass(self.rtsp_no_pass)
+        assert clean == self.rtsp_no_pass
+
+    def test_special_char_password(self):
+        """Test that special characters in pw are escaped, but not others."""
+        escaped = escape_special_characters(self.rtsp_with_special_pass)
+        assert (
+            escaped
+            == "rtsp://user:password%60~%21%40%23%24%25%5E%26%2A%28%29-_%3B%27%2C.%3C%3E%3A%22%5C%7B%5C%7D%5C%5B%5C%5D%40@192.168.0.2:554/live"
+        )
+
+    def test_no_special_char_password(self):
+        """Test that no change is made to path with no special characters."""
+        escaped = escape_special_characters(self.rtsp_with_pass)
+        assert escaped == self.rtsp_with_pass

frigate/test/test_config.py

@@ -1,11 +1,13 @@
 import unittest
 import numpy as np
 from pydantic import ValidationError
+
 from frigate.config import (
     BirdseyeModeEnum,
     FrigateConfig,
     DetectorTypeEnum,
 )
+from frigate.util import load_config_with_no_duplicates
 
 
 class TestConfig(unittest.TestCase):
@@ -575,7 +577,7 @@ class TestConfig(unittest.TestCase):
                         "inputs": [
                             {
                                 "path": "rtsp://10.0.0.1:554/video",
-                                "roles": ["detect", "rtmp"],
+                                "roles": ["detect", "rtmp", "restream"],
                             },
                             {"path": "rtsp://10.0.0.1:554/record", "roles": ["record"]},
                         ]
@@ -837,7 +839,7 @@ class TestConfig(unittest.TestCase):
 
         config = {
             "mqtt": {"host": "mqtt"},
-            "rtmp": {"enabled": False},
+            "restream": {"enabled": False},
             "cameras": {
                 "back": {
                     "ffmpeg": {
@@ -1050,11 +1052,11 @@ class TestConfig(unittest.TestCase):
         assert runtime_config.cameras["back"].snapshots.height == 150
         assert runtime_config.cameras["back"].snapshots.enabled
 
-    def test_global_rtmp(self):
+    def test_global_restream(self):
 
         config = {
             "mqtt": {"host": "mqtt"},
-            "rtmp": {"enabled": True},
+            "restream": {"enabled": True},
             "cameras": {
                 "back": {
                     "ffmpeg": {
@@ -1072,9 +1074,32 @@ class TestConfig(unittest.TestCase):
         assert config == frigate_config.dict(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config
-        assert runtime_config.cameras["back"].rtmp.enabled
+        assert runtime_config.cameras["back"].restream.enabled
 
-    def test_default_rtmp(self):
+    def test_global_rtmp_disabled(self):
+
+        config = {
+            "mqtt": {"host": "mqtt"},
+            "cameras": {
+                "back": {
+                    "ffmpeg": {
+                        "inputs": [
+                            {
+                                "path": "rtsp://10.0.0.1:554/video",
+                                "roles": ["detect"],
+                            },
+                        ]
+                    },
+                }
+            },
+        }
+        frigate_config = FrigateConfig(**config)
+        assert config == frigate_config.dict(exclude_unset=True)
+
+        runtime_config = frigate_config.runtime_config
+        assert not runtime_config.cameras["back"].rtmp.enabled
+
+    def test_default_not_rtmp(self):
 
         config = {
             "mqtt": {"host": "mqtt"},
@@ -1095,7 +1120,57 @@ class TestConfig(unittest.TestCase):
         assert config == frigate_config.dict(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config
-        assert runtime_config.cameras["back"].rtmp.enabled
+        assert not runtime_config.cameras["back"].rtmp.enabled
+
+    def test_default_restream(self):
+
+        config = {
+            "mqtt": {"host": "mqtt"},
+            "cameras": {
+                "back": {
+                    "ffmpeg": {
+                        "inputs": [
+                            {
+                                "path": "rtsp://10.0.0.1:554/video",
+                                "roles": ["detect"],
+                            },
+                        ]
+                    }
+                }
+            },
+        }
+        frigate_config = FrigateConfig(**config)
+        assert config == frigate_config.dict(exclude_unset=True)
+
+        runtime_config = frigate_config.runtime_config
+        assert runtime_config.cameras["back"].restream.enabled
+
+    def test_global_restream_merge(self):
+
+        config = {
+            "mqtt": {"host": "mqtt"},
+            "restream": {"enabled": False},
+            "cameras": {
+                "back": {
+                    "ffmpeg": {
+                        "inputs": [
+                            {
+                                "path": "rtsp://10.0.0.1:554/video",
+                                "roles": ["detect"],
+                            },
+                        ]
+                    },
+                    "restream": {
+                        "enabled": True,
+                    },
+                }
+            },
+        }
+        frigate_config = FrigateConfig(**config)
+        assert config == frigate_config.dict(exclude_unset=True)
+
+        runtime_config = frigate_config.runtime_config
+        assert runtime_config.cameras["back"].restream.enabled
 
     def test_global_rtmp_merge(self):
 
@@ -1108,7 +1183,7 @@ class TestConfig(unittest.TestCase):
                         "inputs": [
                             {
                                 "path": "rtsp://10.0.0.1:554/video",
-                                "roles": ["detect"],
+                                "roles": ["detect", "rtmp"],
                             },
                         ]
                     },
@@ -1128,7 +1203,7 @@ class TestConfig(unittest.TestCase):
 
         config = {
             "mqtt": {"host": "mqtt"},
-            "rtmp": {"enabled": False},
+            "restream": {"enabled": False},
             "cameras": {
                 "back": {
                     "ffmpeg": {
@@ -1152,11 +1227,11 @@ class TestConfig(unittest.TestCase):
         runtime_config = frigate_config.runtime_config
         assert not runtime_config.cameras["back"].rtmp.enabled
 
-    def test_global_live(self):
+    def test_global_jsmpeg(self):
 
         config = {
             "mqtt": {"host": "mqtt"},
-            "live": {"quality": 4},
+            "restream": {"jsmpeg": {"quality": 4}},
             "cameras": {
                 "back": {
                     "ffmpeg": {
@@ -1174,7 +1249,7 @@ class TestConfig(unittest.TestCase):
         assert config == frigate_config.dict(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config
-        assert runtime_config.cameras["back"].live.quality == 4
+        assert runtime_config.cameras["back"].restream.jsmpeg.quality == 4
 
     def test_default_live(self):
 
@@ -1197,13 +1272,13 @@ class TestConfig(unittest.TestCase):
         assert config == frigate_config.dict(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config
-        assert runtime_config.cameras["back"].live.quality == 8
+        assert runtime_config.cameras["back"].restream.jsmpeg.quality == 8
 
     def test_global_live_merge(self):
 
         config = {
             "mqtt": {"host": "mqtt"},
-            "live": {"quality": 4, "height": 480},
+            "restream": {"jsmpeg": {"quality": 4, "height": 480}},
             "cameras": {
                 "back": {
                     "ffmpeg": {
@@ -1214,8 +1289,10 @@ class TestConfig(unittest.TestCase):
                             },
                         ]
                     },
-                    "live": {
+                    "restream": {
+                        "jsmpeg": {
                             "quality": 7,
+                        }
                     },
                 }
             },
@@ -1224,8 +1301,8 @@ class TestConfig(unittest.TestCase):
         assert config == frigate_config.dict(exclude_unset=True)
 
         runtime_config = frigate_config.runtime_config
-        assert runtime_config.cameras["back"].live.quality == 7
-        assert runtime_config.cameras["back"].live.height == 480
+        assert runtime_config.cameras["back"].restream.jsmpeg.quality == 7
+        assert runtime_config.cameras["back"].restream.jsmpeg.height == 480
 
     def test_global_timestamp_style(self):
 
@@ -1349,6 +1426,51 @@ class TestConfig(unittest.TestCase):
             ValidationError, lambda: frigate_config.runtime_config.cameras
         )
 
+    def test_fails_zone_defines_untracked_object(self):
+        config = {
+            "mqtt": {"host": "mqtt"},
+            "objects": {"track": ["person"]},
+            "cameras": {
+                "back": {
+                    "ffmpeg": {
+                        "inputs": [
+                            {
+                                "path": "rtsp://10.0.0.1:554/video",
+                                "roles": ["detect"],
+                            },
+                        ]
+                    },
+                    "zones": {
+                        "steps": {
+                            "coordinates": "0,0,0,0",
+                            "objects": ["car", "person"],
+                        },
+                    },
+                }
+            },
+        }
+
+        frigate_config = FrigateConfig(**config)
+
+        self.assertRaises(ValueError, lambda: frigate_config.runtime_config.cameras)
+
+    def test_fails_duplicate_keys(self):
+        raw_config = """
+        cameras:
+          test:
+            ffmpeg:
+              inputs:
+                - one
+                - two
+              inputs:
+                - three
+                - four
+        """
+
+        self.assertRaises(
+            ValueError, lambda: load_config_with_no_duplicates(raw_config)
+        )
+
     def test_object_filter_ratios_work(self):
         config = {
             "mqtt": {"host": "mqtt"},

frigate/test/test_http.py

@@ -13,6 +13,7 @@ from playhouse.shortcuts import model_to_dict
 from frigate.config import FrigateConfig
 from frigate.http import create_app
 from frigate.models import Event, Recordings
+from frigate.plus import PlusApi
 
 from frigate.test.const import TEST_DB, TEST_DB_CLEANUPS
 
@@ -113,7 +114,7 @@ class TestHttp(unittest.TestCase):
 
     def test_get_event_list(self):
         app = create_app(
-            FrigateConfig(**self.minimal_config), self.db, None, None, None
+            FrigateConfig(**self.minimal_config), self.db, None, None, PlusApi()
         )
         id = "123456.random"
         id2 = "7890.random"
@@ -142,7 +143,7 @@ class TestHttp(unittest.TestCase):
 
     def test_get_good_event(self):
         app = create_app(
-            FrigateConfig(**self.minimal_config), self.db, None, None, None
+            FrigateConfig(**self.minimal_config), self.db, None, None, PlusApi()
         )
         id = "123456.random"
 
@@ -156,7 +157,7 @@ class TestHttp(unittest.TestCase):
 
     def test_get_bad_event(self):
         app = create_app(
-            FrigateConfig(**self.minimal_config), self.db, None, None, None
+            FrigateConfig(**self.minimal_config), self.db, None, None, PlusApi()
         )
         id = "123456.random"
         bad_id = "654321.other"
@@ -169,7 +170,7 @@ class TestHttp(unittest.TestCase):
 
     def test_delete_event(self):
         app = create_app(
-            FrigateConfig(**self.minimal_config), self.db, None, None, None
+            FrigateConfig(**self.minimal_config), self.db, None, None, PlusApi()
         )
         id = "123456.random"
 
@@ -184,7 +185,7 @@ class TestHttp(unittest.TestCase):
 
     def test_event_retention(self):
         app = create_app(
-            FrigateConfig(**self.minimal_config), self.db, None, None, None
+            FrigateConfig(**self.minimal_config), self.db, None, None, PlusApi()
         )
         id = "123456.random"
 
@@ -203,7 +204,7 @@ class TestHttp(unittest.TestCase):
 
     def test_set_delete_sub_label(self):
         app = create_app(
-            FrigateConfig(**self.minimal_config), self.db, None, None, None
+            FrigateConfig(**self.minimal_config), self.db, None, None, PlusApi()
         )
         id = "123456.random"
         sub_label = "sub"
@@ -231,7 +232,7 @@ class TestHttp(unittest.TestCase):
 
     def test_sub_label_list(self):
         app = create_app(
-            FrigateConfig(**self.minimal_config), self.db, None, None, None
+            FrigateConfig(**self.minimal_config), self.db, None, None, PlusApi()
         )
         id = "123456.random"
         sub_label = "sub"
@@ -253,7 +254,7 @@ class TestHttp(unittest.TestCase):
             self.db,
             None,
             None,
-            None,
+            PlusApi(),
         )
 
         with app.test_client() as client:
@@ -267,7 +268,7 @@ class TestHttp(unittest.TestCase):
             self.db,
             None,
             None,
-            None,
+            PlusApi(),
         )
         id = "123456.random"
 
@@ -284,7 +285,7 @@ class TestHttp(unittest.TestCase):
             self.db,
             None,
             None,
-            None,
+            PlusApi(),
         )
         mock_stats.return_value = self.test_stats
 

frigate/test/test_object_detector.py

@@ -0,0 +1,130 @@
+import unittest
+from unittest.mock import patch
+
+import numpy as np
+from frigate.config import DetectorTypeEnum, InputTensorEnum, ModelConfig
+import frigate.object_detection
+
+
+class TestLocalObjectDetector(unittest.TestCase):
+    @patch("frigate.object_detection.EdgeTpuTfl")
+    @patch("frigate.object_detection.CpuTfl")
+    def test_localdetectorprocess_given_type_cpu_should_call_cputfl_init(
+        self, mock_cputfl, mock_edgetputfl
+    ):
+        test_cfg = ModelConfig()
+        test_cfg.path = "/test/modelpath"
+        test_obj = frigate.object_detection.LocalObjectDetector(
+            det_type=DetectorTypeEnum.cpu, model_config=test_cfg, num_threads=6
+        )
+
+        assert test_obj is not None
+        mock_edgetputfl.assert_not_called()
+        mock_cputfl.assert_called_once_with(model_config=test_cfg, num_threads=6)
+
+    @patch("frigate.object_detection.EdgeTpuTfl")
+    @patch("frigate.object_detection.CpuTfl")
+    def test_localdetectorprocess_given_type_edgtpu_should_call_edgtpu_init(
+        self, mock_cputfl, mock_edgetputfl
+    ):
+        test_cfg = ModelConfig()
+        test_cfg.path = "/test/modelpath"
+
+        test_obj = frigate.object_detection.LocalObjectDetector(
+            det_type=DetectorTypeEnum.edgetpu,
+            det_device="usb",
+            model_config=test_cfg,
+        )
+
+        assert test_obj is not None
+        mock_cputfl.assert_not_called()
+        mock_edgetputfl.assert_called_once_with(det_device="usb", model_config=test_cfg)
+
+    @patch("frigate.object_detection.CpuTfl")
+    def test_detect_raw_given_tensor_input_should_return_api_detect_raw_result(
+        self, mock_cputfl
+    ):
+        TEST_DATA = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
+        TEST_DETECT_RESULT = np.ndarray([1, 2, 4, 8, 16, 32])
+        test_obj_detect = frigate.object_detection.LocalObjectDetector(
+            det_device=DetectorTypeEnum.cpu
+        )
+
+        mock_det_api = mock_cputfl.return_value
+        mock_det_api.detect_raw.return_value = TEST_DETECT_RESULT
+
+        test_result = test_obj_detect.detect_raw(TEST_DATA)
+
+        mock_det_api.detect_raw.assert_called_once_with(tensor_input=TEST_DATA)
+        assert test_result is mock_det_api.detect_raw.return_value
+
+    @patch("frigate.object_detection.CpuTfl")
+    def test_detect_raw_given_tensor_input_should_call_api_detect_raw_with_transposed_tensor(
+        self, mock_cputfl
+    ):
+        TEST_DATA = np.zeros((1, 32, 32, 3), np.uint8)
+        TEST_DETECT_RESULT = np.ndarray([1, 2, 4, 8, 16, 32])
+
+        test_cfg = ModelConfig()
+        test_cfg.input_tensor = InputTensorEnum.nchw
+
+        test_obj_detect = frigate.object_detection.LocalObjectDetector(
+            det_device=DetectorTypeEnum.cpu, model_config=test_cfg
+        )
+
+        mock_det_api = mock_cputfl.return_value
+        mock_det_api.detect_raw.return_value = TEST_DETECT_RESULT
+
+        test_result = test_obj_detect.detect_raw(TEST_DATA)
+
+        mock_det_api.detect_raw.assert_called_once()
+        assert (
+            mock_det_api.detect_raw.call_args.kwargs["tensor_input"].shape
+            == np.zeros((1, 3, 32, 32)).shape
+        )
+
+        assert test_result is mock_det_api.detect_raw.return_value
+
+    @patch("frigate.object_detection.CpuTfl")
+    @patch("frigate.object_detection.load_labels")
+    def test_detect_given_tensor_input_should_return_lfiltered_detections(
+        self, mock_load_labels, mock_cputfl
+    ):
+        TEST_DATA = np.zeros((1, 32, 32, 3), np.uint8)
+        TEST_DETECT_RAW = [
+            [2, 0.9, 5, 4, 3, 2],
+            [1, 0.5, 8, 7, 6, 5],
+            [0, 0.4, 2, 4, 8, 16],
+        ]
+        TEST_DETECT_RESULT = [
+            ("label-3", 0.9, (5, 4, 3, 2)),
+            ("label-2", 0.5, (8, 7, 6, 5)),
+        ]
+        TEST_LABEL_FILE = "/test_labels.txt"
+        mock_load_labels.return_value = [
+            "label-1",
+            "label-2",
+            "label-3",
+            "label-4",
+            "label-5",
+        ]
+
+        test_obj_detect = frigate.object_detection.LocalObjectDetector(
+            det_device=DetectorTypeEnum.cpu,
+            model_config=ModelConfig(),
+            labels=TEST_LABEL_FILE,
+        )
+
+        mock_load_labels.assert_called_once_with(TEST_LABEL_FILE)
+
+        mock_det_api = mock_cputfl.return_value
+        mock_det_api.detect_raw.return_value = TEST_DETECT_RAW
+
+        test_result = test_obj_detect.detect(tensor_input=TEST_DATA, threshold=0.5)
+
+        mock_det_api.detect_raw.assert_called_once()
+        assert (
+            mock_det_api.detect_raw.call_args.kwargs["tensor_input"].shape
+            == np.zeros((1, 32, 32, 3)).shape
+        )
+        assert test_result == TEST_DETECT_RESULT

frigate/test/test_restream.py

@@ -0,0 +1,64 @@
+"""Test restream.py."""
+
+from unittest import TestCase, main
+from unittest.mock import patch
+
+from frigate.config import FrigateConfig
+from frigate.restream import RestreamApi
+
+
+class TestRestream(TestCase):
+    def setUp(self) -> None:
+        """Setup the tests."""
+        self.config = {
+            "mqtt": {"host": "mqtt"},
+            "restream": {"enabled": False},
+            "cameras": {
+                "back": {
+                    "ffmpeg": {
+                        "inputs": [
+                            {
+                                "path": "rtsp://10.0.0.1:554/video",
+                                "roles": ["detect", "restream"],
+                            },
+                        ]
+                    },
+                    "restream": {
+                        "enabled": True,
+                    },
+                },
+                "front": {
+                    "ffmpeg": {
+                        "inputs": [
+                            {
+                                "path": "http://10.0.0.1:554/video/stream",
+                                "roles": ["detect", "restream"],
+                            },
+                        ]
+                    },
+                    "restream": {
+                        "enabled": True,
+                    },
+                },
+            },
+        }
+
+    @patch("frigate.restream.requests")
+    def test_rtsp_stream(self, mock_requests) -> None:
+        """Test that the normal rtsp stream is sent plainly."""
+        frigate_config = FrigateConfig(**self.config)
+        restream = RestreamApi(frigate_config)
+        restream.add_cameras()
+        assert restream.relays["back"].startswith("rtsp")
+
+    @patch("frigate.restream.requests")
+    def test_http_stream(self, mock_requests) -> None:
+        """Test that the http stream is sent via ffmpeg."""
+        frigate_config = FrigateConfig(**self.config)
+        restream = RestreamApi(frigate_config)
+        restream.add_cameras()
+        assert not restream.relays["front"].startswith("rtsp")
+
+
+if __name__ == "__main__":
+    main(verbosity=2)

frigate/test/test_storage.py

@@ -0,0 +1,239 @@
+import datetime
+import json
+import logging
+import os
+import unittest
+from unittest.mock import MagicMock, patch
+
+from peewee import DoesNotExist
+from peewee_migrate import Router
+from playhouse.sqlite_ext import SqliteExtDatabase
+from playhouse.sqliteq import SqliteQueueDatabase
+from playhouse.shortcuts import model_to_dict
+
+from frigate.config import FrigateConfig
+from frigate.http import create_app
+from frigate.models import Event, Recordings
+from frigate.storage import StorageMaintainer
+
+from frigate.test.const import TEST_DB, TEST_DB_CLEANUPS
+
+
+class TestHttp(unittest.TestCase):
+    def setUp(self):
+        # setup clean database for each test run
+        migrate_db = SqliteExtDatabase("test.db")
+        del logging.getLogger("peewee_migrate").handlers[:]
+        router = Router(migrate_db)
+        router.run()
+        migrate_db.close()
+        self.db = SqliteQueueDatabase(TEST_DB)
+        models = [Event, Recordings]
+        self.db.bind(models)
+
+        self.minimal_config = {
+            "mqtt": {"host": "mqtt"},
+            "cameras": {
+                "front_door": {
+                    "ffmpeg": {
+                        "inputs": [
+                            {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
+                        ]
+                    },
+                    "detect": {
+                        "height": 1080,
+                        "width": 1920,
+                        "fps": 5,
+                    },
+                }
+            },
+        }
+        self.double_cam_config = {
+            "mqtt": {"host": "mqtt"},
+            "cameras": {
+                "front_door": {
+                    "ffmpeg": {
+                        "inputs": [
+                            {"path": "rtsp://10.0.0.1:554/video", "roles": ["detect"]}
+                        ]
+                    },
+                    "detect": {
+                        "height": 1080,
+                        "width": 1920,
+                        "fps": 5,
+                    },
+                },
+                "back_door": {
+                    "ffmpeg": {
+                        "inputs": [
+                            {"path": "rtsp://10.0.0.2:554/video", "roles": ["detect"]}
+                        ]
+                    },
+                    "detect": {
+                        "height": 1080,
+                        "width": 1920,
+                        "fps": 5,
+                    },
+                },
+            },
+        }
+
+    def tearDown(self):
+        if not self.db.is_closed():
+            self.db.close()
+
+        try:
+            for file in TEST_DB_CLEANUPS:
+                os.remove(file)
+        except OSError:
+            pass
+
+    def test_segment_calculations(self):
+        """Test that the segment calculations are correct."""
+        config = FrigateConfig(**self.double_cam_config)
+        storage = StorageMaintainer(config, MagicMock())
+
+        time_keep = datetime.datetime.now().timestamp()
+        rec_fd_id = "1234567.frontdoor"
+        rec_bd_id = "1234568.backdoor"
+        _insert_mock_recording(
+            rec_fd_id,
+            time_keep,
+            time_keep + 10,
+            camera="front_door",
+            seg_size=4,
+            seg_dur=10,
+        )
+        _insert_mock_recording(
+            rec_bd_id,
+            time_keep + 10,
+            time_keep + 20,
+            camera="back_door",
+            seg_size=8,
+            seg_dur=20,
+        )
+        storage.calculate_camera_bandwidth()
+        assert storage.camera_storage_stats == {
+            "front_door": {"bandwidth": 1440, "needs_refresh": True},
+            "back_door": {"bandwidth": 2880, "needs_refresh": True},
+        }
+
+    def test_segment_calculations_with_zero_segments(self):
+        """Ensure segment calculation does not fail when migrating from previous version."""
+        config = FrigateConfig(**self.minimal_config)
+        storage = StorageMaintainer(config, MagicMock())
+
+        time_keep = datetime.datetime.now().timestamp()
+        rec_fd_id = "1234567.frontdoor"
+        _insert_mock_recording(
+            rec_fd_id,
+            time_keep,
+            time_keep + 10,
+            camera="front_door",
+            seg_size=0,
+            seg_dur=10,
+        )
+        storage.calculate_camera_bandwidth()
+        assert storage.camera_storage_stats == {
+            "front_door": {"bandwidth": 0, "needs_refresh": True},
+        }
+
+    def test_storage_cleanup(self):
+        """Ensure that all recordings are cleaned up when necessary."""
+        config = FrigateConfig(**self.minimal_config)
+        storage = StorageMaintainer(config, MagicMock())
+
+        id = "123456.keep"
+        time_keep = datetime.datetime.now().timestamp()
+        _insert_mock_event(id, time_keep, time_keep + 30, True)
+        rec_k_id = "1234567.keep"
+        rec_k2_id = "1234568.keep"
+        rec_k3_id = "1234569.keep"
+        _insert_mock_recording(rec_k_id, time_keep, time_keep + 10)
+        _insert_mock_recording(rec_k2_id, time_keep + 10, time_keep + 20)
+        _insert_mock_recording(rec_k3_id, time_keep + 20, time_keep + 30)
+
+        id2 = "7890.delete"
+        time_delete = datetime.datetime.now().timestamp() - 360
+        _insert_mock_event(id2, time_delete, time_delete + 30, False)
+        rec_d_id = "78901.delete"
+        rec_d2_id = "78902.delete"
+        rec_d3_id = "78903.delete"
+        _insert_mock_recording(rec_d_id, time_delete, time_delete + 10)
+        _insert_mock_recording(rec_d2_id, time_delete + 10, time_delete + 20)
+        _insert_mock_recording(rec_d3_id, time_delete + 20, time_delete + 30)
+
+        storage.calculate_camera_bandwidth()
+        storage.reduce_storage_consumption()
+        with self.assertRaises(DoesNotExist):
+            assert Recordings.get(Recordings.id == rec_k_id)
+            assert Recordings.get(Recordings.id == rec_k2_id)
+            assert Recordings.get(Recordings.id == rec_k3_id)
+            Recordings.get(Recordings.id == rec_d_id)
+            Recordings.get(Recordings.id == rec_d2_id)
+            Recordings.get(Recordings.id == rec_d3_id)
+
+    def test_storage_cleanup_keeps_retained(self):
+        """Ensure that all recordings are cleaned up when necessary."""
+        config = FrigateConfig(**self.minimal_config)
+        storage = StorageMaintainer(config, MagicMock())
+
+        id = "123456.keep"
+        time_keep = datetime.datetime.now().timestamp()
+        _insert_mock_event(id, time_keep, time_keep + 30, True)
+        rec_k_id = "1234567.keep"
+        rec_k2_id = "1234568.keep"
+        rec_k3_id = "1234569.keep"
+        _insert_mock_recording(rec_k_id, time_keep, time_keep + 10)
+        _insert_mock_recording(rec_k2_id, time_keep + 10, time_keep + 20)
+        _insert_mock_recording(rec_k3_id, time_keep + 20, time_keep + 30)
+
+        time_delete = datetime.datetime.now().timestamp() - 7200
+        for i in range(0, 59):
+            _insert_mock_recording(
+                f"{123456 + i}.delete", time_delete, time_delete + 600
+            )
+
+        storage.calculate_camera_bandwidth()
+        storage.reduce_storage_consumption()
+        assert Recordings.get(Recordings.id == rec_k_id)
+        assert Recordings.get(Recordings.id == rec_k2_id)
+        assert Recordings.get(Recordings.id == rec_k3_id)
+
+
+def _insert_mock_event(id: str, start: int, end: int, retain: bool) -> Event:
+    """Inserts a basic event model with a given id."""
+    return Event.insert(
+        id=id,
+        label="Mock",
+        camera="front_door",
+        start_time=start,
+        end_time=end,
+        top_score=100,
+        false_positive=False,
+        zones=list(),
+        thumbnail="",
+        region=[],
+        box=[],
+        area=0,
+        has_clip=True,
+        has_snapshot=True,
+        retain_indefinitely=retain,
+    ).execute()
+
+
+def _insert_mock_recording(
+    id: str, start: int, end: int, camera="front_door", seg_size=8, seg_dur=10
+) -> Event:
+    """Inserts a basic recording model with a given id."""
+    return Recordings.insert(
+        id=id,
+        camera=camera,
+        path=f"/recordings/{id}",
+        start_time=start,
+        end_time=end,
+        duration=seg_dur,
+        motion=True,
+        objects=True,
+        segment_size=seg_size,
+    ).execute()

frigate/types.py

@@ -3,7 +3,7 @@ from multiprocessing.queues import Queue
 from multiprocessing.sharedctypes import Synchronized
 from multiprocessing.context import Process
 
-from frigate.edgetpu import EdgeTPUProcess
+from frigate.object_detection import ObjectDetectProcess
 
 
 class CameraMetricsTypes(TypedDict):
@@ -26,6 +26,6 @@ class CameraMetricsTypes(TypedDict):
 
 class StatsTrackingTypes(TypedDict):
     camera_metrics: dict[str, CameraMetricsTypes]
-    detectors: dict[str, EdgeTPUProcess]
+    detectors: dict[str, ObjectDetectProcess]
     started: int
     latest_frigate_version: str

frigate/util.py

@@ -1,25 +1,27 @@
 import copy
 import datetime
-import hashlib
-import json
 import logging
-import math
-import signal
 import subprocess as sp
-import threading
-import time
+import json
+import re
+import signal
 import traceback
+import urllib.parse
+import yaml
+
 from abc import ABC, abstractmethod
+from collections import Counter
 from collections.abc import Mapping
 from multiprocessing import shared_memory
 from typing import AnyStr
 
 import cv2
-import matplotlib.pyplot as plt
 import numpy as np
 import os
 import psutil
 
+from frigate.const import REGEX_CAMERA_USER_PASS
+
 logger = logging.getLogger(__name__)
 
 
@@ -47,6 +49,33 @@ def deep_merge(dct1: dict, dct2: dict, override=False, merge_lists=False) -> dic
     return merged
 
 
+def load_config_with_no_duplicates(raw_config) -> dict:
+    """Get config ensuring duplicate keys are not allowed."""
+
+    # https://stackoverflow.com/a/71751051
+    class PreserveDuplicatesLoader(yaml.loader.Loader):
+        pass
+
+    def map_constructor(loader, node, deep=False):
+        keys = [loader.construct_object(node, deep=deep) for node, _ in node.value]
+        vals = [loader.construct_object(node, deep=deep) for _, node in node.value]
+        key_count = Counter(keys)
+        data = {}
+        for key, val in zip(keys, vals):
+            if key_count[key] > 1:
+                raise ValueError(
+                    f"Config input {key} is defined multiple times for the same field, this is not allowed."
+                )
+            else:
+                data[key] = val
+        return data
+
+    PreserveDuplicatesLoader.add_constructor(
+        yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG, map_constructor
+    )
+    return yaml.load(raw_config, PreserveDuplicatesLoader)
+
+
 def draw_timestamp(
     frame,
     timestamp,
@@ -479,6 +508,16 @@ def yuv_region_2_rgb(frame, region):
         raise
 
 
+def yuv_region_2_bgr(frame, region):
+    try:
+        yuv_cropped_frame = yuv_crop_and_resize(frame, region)
+        return cv2.cvtColor(yuv_cropped_frame, cv2.COLOR_YUV2BGR_I420)
+    except:
+        print(f"frame.shape: {frame.shape}")
+        print(f"region: {region}")
+        raise
+
+
 def intersection(box_a, box_b):
     return (
         max(box_a[0], box_b[0]),
@@ -625,6 +664,69 @@ def load_labels(path, encoding="utf-8"):
             return {index: line.strip() for index, line in enumerate(lines)}
 
 
+def clean_camera_user_pass(line: str) -> str:
+    """Removes user and password from line."""
+    # todo also remove http password like reolink
+    return re.sub(REGEX_CAMERA_USER_PASS, "://*:*@", line)
+
+
+def escape_special_characters(path: str) -> str:
+    """Cleans reserved characters to encodings for ffmpeg."""
+    try:
+        found = re.search(REGEX_CAMERA_USER_PASS, path).group(0)[3:-1]
+        pw = found[(found.index(":") + 1) :]
+        return path.replace(pw, urllib.parse.quote_plus(pw))
+    except AttributeError:
+        # path does not have user:pass
+        return path
+
+
+def get_cpu_stats() -> dict[str, dict]:
+    """Get cpu usages for each process id"""
+    usages = {}
+    # -n=2 runs to ensure extraneous values are not included
+    top_command = ["top", "-b", "-n", "2"]
+
+    p = sp.run(
+        top_command,
+        encoding="ascii",
+        capture_output=True,
+    )
+
+    if p.returncode != 0:
+        logger.error(p.stderr)
+        return usages
+    else:
+        lines = p.stdout.split("\n")
+
+        for line in lines:
+            stats = list(filter(lambda a: a != "", line.strip().split(" ")))
+            try:
+                usages[stats[0]] = {
+                    "cpu": stats[8],
+                    "mem": stats[9],
+                }
+            except:
+                continue
+
+        return usages
+
+
+def ffprobe_stream(path: str) -> sp.CompletedProcess:
+    """Run ffprobe on stream."""
+    ffprobe_cmd = [
+        "ffprobe",
+        "-print_format",
+        "json",
+        "-show_entries",
+        "stream=codec_long_name,width,height,bit_rate,duration,display_aspect_ratio,avg_frame_rate",
+        "-loglevel",
+        "quiet",
+        path,
+    ]
+    return sp.run(ffprobe_cmd, capture_output=True)
+
+
 class FrameManager(ABC):
     @abstractmethod
     def create(self, name, size) -> AnyStr:

frigate/video.py

@@ -11,11 +11,11 @@ import time
 from collections import defaultdict
 
 import numpy as np
-from cv2 import cv2, reduce
+import cv2
 from setproctitle import setproctitle
 
-from frigate.config import CameraConfig, DetectConfig
-from frigate.edgetpu import RemoteObjectDetector
+from frigate.config import CameraConfig, DetectConfig, PixelFormatEnum
+from frigate.object_detection import RemoteObjectDetector
 from frigate.log import LogPipe
 from frigate.motion import MotionDetector
 from frigate.objects import ObjectTracker
@@ -29,7 +29,9 @@ from frigate.util import (
     intersection,
     intersection_over_union,
     listen,
+    yuv_crop_and_resize,
     yuv_region_2_rgb,
+    yuv_region_2_bgr,
 )
 
 logger = logging.getLogger(__name__)
@@ -89,13 +91,20 @@ def filtered(obj, objects_to_track, object_filters):
     return False
 
 
-def create_tensor_input(frame, model_shape, region):
+def create_tensor_input(frame, model_config, region):
+    if model_config.input_pixel_format == PixelFormatEnum.rgb:
         cropped_frame = yuv_region_2_rgb(frame, region)
+    elif model_config.input_pixel_format == PixelFormatEnum.bgr:
+        cropped_frame = yuv_region_2_bgr(frame, region)
+    else:
+        cropped_frame = yuv_crop_and_resize(frame, region)
 
-    # Resize to 300x300 if needed
-    if cropped_frame.shape != (model_shape[0], model_shape[1], 3):
+    # Resize if needed
+    if cropped_frame.shape != (model_config.height, model_config.width, 3):
         cropped_frame = cv2.resize(
-            cropped_frame, dsize=model_shape, interpolation=cv2.INTER_LINEAR
+            cropped_frame,
+            dsize=(model_config.height, model_config.width),
+            interpolation=cv2.INTER_LINEAR,
         )
 
     # Expand dimensions since the model expects images to have shape: [1, height, width, 3]
@@ -340,7 +349,7 @@ def capture_camera(name, config: CameraConfig, process_info):
 def track_camera(
     name,
     config: CameraConfig,
-    model_shape,
+    model_config,
     labelmap,
     detection_queue,
     result_connection,
@@ -378,7 +387,7 @@ def track_camera(
         motion_contour_area,
     )
     object_detector = RemoteObjectDetector(
-        name, labelmap, detection_queue, result_connection, model_shape
+        name, labelmap, detection_queue, result_connection, model_config
     )
 
     object_tracker = ObjectTracker(config.detect)
@@ -389,7 +398,7 @@ def track_camera(
         name,
         frame_queue,
         frame_shape,
-        model_shape,
+        model_config,
         config.detect,
         frame_manager,
         motion_detector,
@@ -440,19 +449,30 @@ def intersects_any(box_a, boxes):
 
 
 def detect(
-    object_detector, frame, model_shape, region, objects_to_track, object_filters
+    detect_config: DetectConfig,
+    object_detector,
+    frame,
+    model_config,
+    region,
+    objects_to_track,
+    object_filters,
 ):
-    tensor_input = create_tensor_input(frame, model_shape, region)
+    tensor_input = create_tensor_input(frame, model_config, region)
 
     detections = []
     region_detections = object_detector.detect(tensor_input)
     for d in region_detections:
         box = d[2]
         size = region[2] - region[0]
-        x_min = int((box[1] * size) + region[0])
-        y_min = int((box[0] * size) + region[1])
-        x_max = int((box[3] * size) + region[0])
-        y_max = int((box[2] * size) + region[1])
+        x_min = int(max(0, (box[1] * size) + region[0]))
+        y_min = int(max(0, (box[0] * size) + region[1]))
+        x_max = int(min(detect_config.width - 1, (box[3] * size) + region[0]))
+        y_max = int(min(detect_config.height - 1, (box[2] * size) + region[1]))
+
+        # ignore objects that were detected outside the frame
+        if (x_min >= detect_config.width - 1) or (y_min >= detect_config.height - 1):
+            continue
+
         width = x_max - x_min
         height = y_max - y_min
         area = width * height
@@ -476,7 +496,7 @@ def process_frames(
     camera_name: str,
     frame_queue: mp.Queue,
     frame_shape,
-    model_shape,
+    model_config,
     detect_config: DetectConfig,
     frame_manager: FrameManager,
     motion_detector: MotionDetector,
@@ -560,7 +580,7 @@ def process_frames(
             # combine motion boxes with known locations of existing objects
             combined_boxes = reduce_boxes(motion_boxes + tracked_object_boxes)
 
-            region_min_size = max(model_shape[0], model_shape[1])
+            region_min_size = max(model_config.height, model_config.width)
             # compute regions
             regions = [
                 calculate_region(
@@ -620,9 +640,10 @@ def process_frames(
             for region in regions:
                 detections.extend(
                     detect(
+                        detect_config,
                         object_detector,
                         frame,
-                        model_shape,
+                        model_config,
                         region,
                         objects_to_track,
                         object_filters,
@@ -647,6 +668,7 @@ def process_frames(
 
                     # apply non-maxima suppression to suppress weak, overlapping bounding boxes
                     # o[2] is the box of the object: xmin, ymin, xmax, ymax
+                    # apply max/min to ensure values do not exceed the known frame size
                     boxes = [
                         (
                             o[2][0],
@@ -678,9 +700,10 @@ def process_frames(
 
                             selected_objects.extend(
                                 detect(
+                                    detect_config,
                                     object_detector,
                                     frame,
-                                    model_shape,
+                                    model_config,
                                     region,
                                     objects_to_track,
                                     object_filters,

frigate/watchdog.py

@@ -5,7 +5,7 @@ import time
 import os
 import signal
 
-from frigate.edgetpu import EdgeTPUProcess
+from frigate.object_detection import ObjectDetectProcess
 from frigate.util import restart_frigate
 from multiprocessing.synchronize import Event
 
@@ -13,7 +13,7 @@ logger = logging.getLogger(__name__)
 
 
 class FrigateWatchdog(threading.Thread):
-    def __init__(self, detectors: dict[str, EdgeTPUProcess], stop_event: Event):
+    def __init__(self, detectors: dict[str, ObjectDetectProcess], stop_event: Event):
         threading.Thread.__init__(self)
         self.name = "frigate_watchdog"
         self.detectors = detectors

migrations/012_add_segment_size.py

@@ -0,0 +1,46 @@
+"""Peewee migrations -- 012_add_segment_size.py.
+
+Some examples (model - class or model name)::
+
+    > Model = migrator.orm['model_name']            # Return model in current state by name
+
+    > migrator.sql(sql)                             # Run custom SQL
+    > migrator.python(func, *args, **kwargs)        # Run python code
+    > migrator.create_model(Model)                  # Create a model (could be used as decorator)
+    > migrator.remove_model(model, cascade=True)    # Remove a model
+    > migrator.add_fields(model, **fields)          # Add fields to a model
+    > migrator.change_fields(model, **fields)       # Change fields
+    > migrator.remove_fields(model, *field_names, cascade=True)
+    > migrator.rename_field(model, old_field_name, new_field_name)
+    > migrator.rename_table(model, new_table_name)
+    > migrator.add_index(model, *col_names, unique=False)
+    > migrator.drop_index(model, *col_names)
+    > migrator.add_not_null(model, *field_names)
+    > migrator.drop_not_null(model, *field_names)
+    > migrator.add_default(model, field_name, default)
+
+"""
+
+import datetime as dt
+import peewee as pw
+from playhouse.sqlite_ext import *
+from decimal import ROUND_HALF_EVEN
+from frigate.models import Recordings
+
+try:
+    import playhouse.postgres_ext as pw_pext
+except ImportError:
+    pass
+
+SQL = pw.SQL
+
+
+def migrate(migrator, database, fake=False, **kwargs):
+    migrator.add_fields(
+        Recordings,
+        segment_size=pw.FloatField(default=0),
+    )
+
+
+def rollback(migrator, database, fake=False, **kwargs):
+    migrator.remove_fields(Recordings, ["segment_size"])

process_clip.py

@@ -16,7 +16,7 @@ import cv2
 import numpy as np
 
 from frigate.config import FrigateConfig
-from frigate.edgetpu import LocalObjectDetector
+from frigate.object_detection import LocalObjectDetector
 from frigate.motion import MotionDetector
 from frigate.object_processing import CameraState
 from frigate.objects import ObjectTracker
@@ -117,13 +117,12 @@ class ProcessClip:
         detection_enabled = mp.Value("d", 1)
         motion_enabled = mp.Value("d", True)
         stop_event = mp.Event()
-        model_shape = (self.config.model.height, self.config.model.width)
 
         process_frames(
             self.camera_name,
             self.frame_queue,
             self.frame_shape,
-            model_shape,
+            self.config.model,
             self.camera_config.detect,
             self.frame_manager,
             motion_detector,

web/.eslintignore

@@ -1,2 +0,0 @@
-dist/*
-node_modules/*

web/.eslintrc

@@ -1,22 +1,33 @@
 {
   "env": {
     "browser": true,
-    "es2021": true
+    "es2021": true,
+    "vitest-globals/env": true
   },
-  "extends": ["eslint:recommended", "preact", "prettier"],
+  "extends": ["eslint:recommended", "plugin:vitest-globals/recommended", "preact", "prettier"],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaFeatures": {
       "jsx": true
     },
-    "ecmaVersion": 12,
+    "ecmaVersion": "latest",
     "sourceType": "module"
   },
+  "settings": {
+    "jest": {
+      "version": 27
+    }
+  },
+  "ignorePatterns": ["*.d.ts"],
   "rules": {
     "indent": ["error", 2, { "SwitchCase": 1 }],
     "comma-dangle": [
       "error",
-      { "objects": "always-multiline", "arrays": "always-multiline", "imports": "always-multiline" }
+      {
+        "objects": "always-multiline",
+        "arrays": "always-multiline",
+        "imports": "always-multiline"
+      }
     ],
     "no-unused-vars": ["error", { "argsIgnorePattern": "^_", "varsIgnorePattern": "^_" }],
     "no-console": "error"

web/.gitignore

@@ -22,3 +22,4 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
+.npm

web/__test__/handlers.js

@@ -19,7 +19,7 @@ export const handlers = [
             record: { enabled: true },
             detect: { width: 1280, height: 720 },
             snapshots: {},
-            live: { height: 720 },
+            restream: { enabled: true, jsmpeg: { height: 720 } },
             ui: { dashboard: true, order: 0 },
           },
           side: {
@@ -28,7 +28,7 @@ export const handlers = [
             record: { enabled: false },
             detect: { width: 1280, height: 720 },
             snapshots: {},
-            live: { height: 720 },
+            restream: { enabled: true, jsmpeg: { height: 720 } },
             ui: { dashboard: true, order: 1 },
           },
         },
@@ -39,9 +39,10 @@ export const handlers = [
     return res(
       ctx.status(200),
       ctx.json({
+        cpu_usages: { 74: {cpu: 6, mem: 6}, 64: { cpu: 5, mem: 5 }, 54: { cpu: 4, mem: 4 }, 71: { cpu: 3, mem: 3}, 60: {cpu: 2, mem: 2}, 72: {cpu: 1, mem: 1} },
         detection_fps: 0.0,
         detectors: { coral: { detection_start: 0.0, inference_speed: 8.94, pid: 52 } },
-        front: { camera_fps: 5.0, capture_pid: 64, detection_fps: 0.0, pid: 54, process_fps: 0.0, skipped_fps: 0.0 },
+        front: { camera_fps: 5.0, capture_pid: 64, detection_fps: 0.0, pid: 54, process_fps: 0.0, skipped_fps: 0.0, ffmpeg_pid: 72 },
         side: {
           camera_fps: 6.9,
           capture_pid: 71,
@@ -49,6 +50,7 @@ export const handlers = [
           pid: 60,
           process_fps: 0.0,
           skipped_fps: 0.0,
+          ffmpeg_pid: 74,
         },
         service: { uptime: 34812, version: '0.8.1-d376f6b' },
       })
@@ -68,6 +70,7 @@ export const handlers = [
           top_score: Math.random(),
           zones: ['front_patio'],
           thumbnail: '/9j/4aa...',
+          camera: 'camera_name',
         }))
       )
     );

web/__test__/test-setup.ts

@@ -0,0 +1,36 @@
+import '@testing-library/jest-dom';
+import 'regenerator-runtime/runtime';
+// This creates a fake indexeddb so there is no need to mock idb-keyval
+import "fake-indexeddb/auto";
+import { setupServer } from 'msw/node';
+import { handlers } from './handlers';
+import { vi } from 'vitest';
+
+// This configures a request mocking server with the given request handlers.
+export const server = setupServer(...handlers);
+
+Object.defineProperty(window, 'matchMedia', {
+  writable: true,
+  value: (query) => ({
+    matches: false,
+    media: query,
+    onchange: null,
+    addEventListener: vi.fn(),
+    removeEventListener: vi.fn(),
+    dispatchEvent: vi.fn(),
+  }),
+});
+
+vi.mock('../src/env');
+
+// Establish API mocking before all tests.
+beforeAll(() => server.listen());
+
+// Reset any request handlers that we may add during the tests,
+// so they don't affect other tests.
+afterEach(() => {
+  server.resetHandlers();
+});
+
+// Clean up after the tests are finished.
+afterAll(() => server.close());

web/babel.config.js

@@ -1,4 +0,0 @@
-module.exports = {
-  presets: ['@babel/preset-env', ['@babel/typescript', { jsxPragma: 'h' }]],
-  plugins: [['@babel/plugin-transform-react-jsx', { pragma: 'h' }]],
-};

web/config/server.js

@@ -1,6 +0,0 @@
-// src/mocks/server.js
-import { setupServer } from 'msw/node';
-import { handlers } from './handlers';
-
-// This configures a request mocking server with the given request handlers.
-export const server = setupServer(...handlers);

web/config/setupTests.js

@@ -1,29 +0,0 @@
-import 'regenerator-runtime/runtime';
-import '@testing-library/jest-dom/extend-expect';
-import { server } from './server.js';
-
-Object.defineProperty(window, 'matchMedia', {
-  writable: true,
-  value: (query) => ({
-    matches: false,
-    media: query,
-    onchange: null,
-    addEventListener: jest.fn(),
-    removeEventListener: jest.fn(),
-    dispatchEvent: jest.fn(),
-  }),
-});
-
-jest.mock('../src/env');
-
-// Establish API mocking before all tests.
-beforeAll(() => server.listen());
-
-// Reset any request handlers that we may add during the tests,
-// so they don't affect other tests.
-afterEach(() => {
-  server.resetHandlers();
-});
-
-// Clean up after the tests are finished.
-afterAll(() => server.close());

web/jest.config.js

@@ -1,198 +0,0 @@
-/*
- * For a detailed explanation regarding each configuration property, visit:
- * https://jestjs.io/docs/configuration
- */
-
-module.exports = {
-  // All imported modules in your tests should be mocked automatically
-  // automock: false,
-
-  // Stop running tests after `n` failures
-  // bail: 0,
-
-  // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "/tmp/jest_rs",
-
-  // Automatically clear mock calls, instances and results before every test
-  // clearMocks: true,
-
-  // Indicates whether the coverage information should be collected while executing the test
-  // collectCoverage: true,
-
-  // An array of glob patterns indicating a set of files for which coverage information should be collected
-  // collectCoverageFrom: undefined,
-
-  // The directory where Jest should output its coverage files
-  // coverageDirectory: 'coverage',
-
-  // An array of regexp pattern strings used to skip coverage collection
-  // coveragePathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // Indicates which provider should be used to instrument code for coverage
-  // coverageProvider: "babel",
-
-  // A list of reporter names that Jest uses when writing coverage reports
-  // coverageReporters: [
-  //   "json",
-  //   "text",
-  //   "lcov",
-  //   "clover"
-  // ],
-
-  // An object that configures minimum threshold enforcement for coverage results
-  // coverageThreshold: undefined,
-
-  // A path to a custom dependency extractor
-  // dependencyExtractor: undefined,
-
-  // Make calling deprecated APIs throw helpful error messages
-  // errorOnDeprecated: false,
-
-  // Force coverage collection from ignored files using an array of glob patterns
-  // forceCoverageMatch: [],
-
-  // A path to a module which exports an async function that is triggered once before all test suites
-  // globalSetup: undefined,
-
-  // A path to a module which exports an async function that is triggered once after all test suites
-  // globalTeardown: undefined,
-
-  // A set of global variables that need to be available in all test environments
-  // globals: {},
-
-  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
-  // maxWorkers: "50%",
-
-  // An array of directory names to be searched recursively up from the requiring module's location
-  // moduleDirectories: [
-  //   "node_modules"
-  // ],
-
-  // An array of file extensions your modules use
-  // moduleFileExtensions: [
-  //   "js",
-  //   "jsx",
-  //   "ts",
-  //   "tsx",
-  //   "json",
-  //   "node"
-  // ],
-
-  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-  moduleNameMapper: {
-    '\\.(scss|sass|css)$': '<rootDir>/src/__mocks__/styleMock.js',
-    '^testing-library$': '<rootDir>/config/testing-library',
-    '^react$': 'preact/compat',
-    '^react-dom$': 'preact/compat',
-  },
-
-  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
-  // modulePathIgnorePatterns: [],
-
-  // Activates notifications for test results
-  // notify: false,
-
-  // An enum that specifies notification mode. Requires { notify: true }
-  // notifyMode: "failure-change",
-
-  // A preset that is used as a base for Jest's configuration
-  // preset: undefined,
-
-  // Run tests from one or more projects
-  // projects: undefined,
-
-  // Use this configuration option to add custom reporters to Jest
-  // reporters: undefined,
-
-  // Automatically reset mock state before every test
-  resetMocks: true,
-
-  // Reset the module registry before running each individual test
-  // resetModules: false,
-
-  // A path to a custom resolver
-  // resolver: undefined,
-
-  // Automatically restore mock state and implementation before every test
-  // restoreMocks: false,
-
-  // The root directory that Jest should scan for tests and modules within
-  // rootDir: undefined,
-
-  // A list of paths to directories that Jest should use to search for files in
-  roots: ['<rootDir>'],
-
-  // Allows you to use a custom runner instead of Jest's default test runner
-  // runner: "jest-runner",
-
-  // The paths to modules that run some code to configure or set up the testing environment before each test
-  // setupFiles: [],
-
-  // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  // setupFilesAfterEnv: [],
-  setupFilesAfterEnv: ['<rootDir>/config/setupTests.js'],
-
-  // The number of seconds after which a test is considered as slow and reported as such in the results.
-  // slowTestThreshold: 5,
-
-  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
-  // snapshotSerializers: [],
-
-  // The test environment that will be used for testing
-  testEnvironment: 'jsdom',
-
-  // Options that will be passed to the testEnvironment
-  // testEnvironmentOptions: {},
-
-  // Adds a location field to test results
-  // testLocationInResults: false,
-
-  // The glob patterns Jest uses to detect test files
-  // testMatch: [
-  //   "**/__tests__/**/*.[jt]s?(x)",
-  //   "**/?(*.)+(spec|test).[tj]s?(x)"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
-  // testPathIgnorePatterns: [
-  //   "/node_modules/"
-  // ],
-
-  // The regexp pattern or array of patterns that Jest uses to detect test files
-  // testRegex: [],
-
-  // This option allows the use of a custom results processor
-  // testResultsProcessor: undefined,
-
-  // This option allows use of a custom test runner
-  // testRunner: "jest-circus/runner",
-
-  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
-  // testURL: "http://localhost",
-
-  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
-  // timers: 'fake',
-
-  // A map from regular expressions to paths to transformers
-  // transform: undefined,
-
-  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
-  // transformIgnorePatterns: [
-  //   "/node_modules/",
-  //   "\\.pnp\\.[^\\/]+$"
-  // ],
-
-  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
-  // unmockedModulePathPatterns: undefined,
-
-  // Indicates whether each individual test should be reported during the run
-  // verbose: undefined,
-
-  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
-  // watchPathIgnorePatterns: [],
-
-  // Whether to use watchman for file crawling
-  // watchman: true,
-};

web/package.json

@@ -2,50 +2,55 @@
   "name": "frigate",
   "private": true,
   "version": "0.0.0",
+  "type": "module",
   "scripts": {
     "dev": "vite --host",
-    "lint": "eslint ./ --ext .jsx,.js,.tsx,.ts",
     "build": "tsc && vite build --base=/BASE_PATH/",
-    "preview": "vite preview",
-    "test": "jest"
+    "lint": "eslint --ext .jsx,.js,.tsx,.ts --ignore-path .gitignore .",
+    "prettier:write": "prettier -u -w --ignore-path .gitignore \"*.{ts,tsx,js,jsx,css,html}\"",
+    "test": "vitest",
+    "coverage": "vitest run --coverage"
   },
   "dependencies": {
-    "@cycjimmy/jsmpeg-player": "^5.0.1",
-    "axios": "^0.26.0",
-    "date-fns": "^2.28.0",
-    "idb-keyval": "^6.1.0",
-    "immer": "^9.0.12",
-    "preact": "^10.6.6",
+    "@cycjimmy/jsmpeg-player": "^6.0.5",
+    "axios": "^1.1.3",
+    "date-fns": "^2.29.3",
+    "idb-keyval": "^6.2.0",
+    "immer": "^9.0.16",
+    "preact": "^10.11.2",
     "preact-async-route": "^2.2.1",
-    "preact-router": "^4.0.1",
-    "swr": "^1.2.2",
-    "video.js": "^7.17.0",
+    "preact-router": "^4.1.0",
+    "react": "npm:@preact/compat@^17.1.2",
+    "react-dom": "npm:@preact/compat@^17.1.2",
+    "swr": "^1.3.0",
+    "video.js": "^7.20.3",
     "videojs-playlist": "^5.0.0",
-    "videojs-seek-buttons": "^2.2.0"
+    "videojs-seek-buttons": "^3.0.1"
   },
   "devDependencies": {
-    "@babel/preset-env": "^7.16.11",
-    "@babel/preset-typescript": "^7.16.7",
-    "@preact/preset-vite": "^2.1.5",
-    "@tailwindcss/forms": "^0.5.0",
-    "@testing-library/jest-dom": "^5.16.2",
-    "@testing-library/preact": "^2.0.1",
-    "@testing-library/preact-hooks": "^1.1.0",
-    "@testing-library/user-event": "^13.5.0",
-    "@types/video.js": "^7.3.42",
-    "@typescript-eslint/eslint-plugin": "^5.18.0",
-    "@typescript-eslint/parser": "^5.18.0",
-    "autoprefixer": "^10.4.2",
-    "eslint": "^8.13.0",
+    "@preact/preset-vite": "^2.4.0",
+    "@tailwindcss/forms": "^0.5.3",
+    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/preact": "^3.2.2",
+    "@testing-library/user-event": "^14.4.3",
+    "@types/video.js": "^7.3.49",
+    "@typescript-eslint/eslint-plugin": "^5.42.1",
+    "@typescript-eslint/parser": "^5.42.1",
+    "@vitest/coverage-c8": "^0.25.1",
+    "@vitest/ui": "^0.25.1",
+    "autoprefixer": "^10.4.13",
+    "eslint": "^8.27.0",
     "eslint-config-preact": "^1.3.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-jest": "^26.1.4",
-    "jest": "^27.5.1",
-    "msw": "^0.38.2",
-    "postcss": "^8.4.7",
-    "prettier": "^2.5.1",
-    "tailwindcss": "^3.0.23",
-    "typescript": "^4.5.4",
-    "vite": "^2.8.0"
+    "eslint-plugin-vitest-globals": "^1.2.0",
+    "fake-indexeddb": "^4.0.0",
+    "jsdom": "^20.0.2",
+    "msw": "^0.48.1",
+    "postcss": "^8.4.19",
+    "prettier": "^2.7.1",
+    "tailwindcss": "^3.2.3",
+    "typescript": "^4.8.4",
+    "vite": "^3.2.3",
+    "vitest": "^0.25.1"
   }
 }

web/src/Sidebar.jsx

@@ -65,7 +65,7 @@ function CameraSection({ sortedCameras }) {
     <Fragment>
       <Separator />
       {sortedCameras.map(([camera]) => (
-        <Destination key={camera} href={`/cameras/${camera}`} text={camera} />
+        <Destination key={camera} href={`/cameras/${camera}`} text={camera.replaceAll('_', ' ')} />
       ))}
       <Separator />
     </Fragment>
@@ -83,7 +83,7 @@ function RecordingSection({ sortedCameras }) {
             key={camera}
             path={`/recording/${camera}/:date?/:hour?/:seconds?`}
             href={`/recording/${camera}`}
-            text={camera}
+            text={camera.replaceAll('_', ' ')}
           />
         );
       })}

web/src/__tests__/App.test.jsx

@@ -1,19 +1,12 @@
 import { h } from 'preact';
-import * as IDB from 'idb-keyval';
-import * as PreactRouter from 'preact-router';
-import App from '../App';
+import App from '../app';
 import { render, screen } from 'testing-library';
 
 describe('App', () => {
-  beforeEach(() => {
-    jest.spyOn(IDB, 'get').mockImplementation(() => Promise.resolve(undefined));
-    jest.spyOn(IDB, 'set').mockImplementation(() => Promise.resolve(true));
-    jest.spyOn(PreactRouter, 'Router').mockImplementation(() => <div data-testid="router" />);
-  });
-
-  test('shows a loading indicator while loading', async () => {
+  // eslint-disable-next-line jest/no-disabled-tests
+  test.skip('loads the camera dashboard', async () => {
     render(<App />);
-    await screen.findByTestId('app');
-    expect(screen.queryByLabelText('Loading…')).toBeInTheDocument();
+    await screen.findByText('Cameras');
+    expect(screen.queryByText('front')).toBeInTheDocument();
   });
 });

web/src/__tests__/AppBar.test.jsx

@@ -1,14 +1,14 @@
 import { h } from 'preact';
 import * as Context from '../context';
 import AppBar from '../AppBar';
-import { fireEvent, render, screen } from 'testing-library';
+import { fireEvent, render, screen } from '@testing-library/preact';
 
 describe('AppBar', () => {
   beforeEach(() => {
-    jest.spyOn(Context, 'useDarkMode').mockImplementation(() => ({
-      setDarkMode: jest.fn(),
+    vi.spyOn(Context, 'useDarkMode').mockImplementation(() => ({
+      setDarkMode: vi.fn(),
     }));
-    jest.spyOn(Context, 'DarkModeProvider').mockImplementation(({ children }) => {
+    vi.spyOn(Context, 'DarkModeProvider').mockImplementation(({ children }) => {
       return <div>{children}</div>;
     });
   });
@@ -30,8 +30,8 @@ describe('AppBar', () => {
   });
 
   test('sets dark mode on MenuItem select', async () => {
-    const setDarkModeSpy = jest.fn();
-    jest.spyOn(Context, 'useDarkMode').mockImplementation(() => ({
+    const setDarkModeSpy = vi.fn();
+    vi.spyOn(Context, 'useDarkMode').mockImplementation(() => ({
       setDarkMode: setDarkModeSpy,
     }));
     render(

web/src/__tests__/Sidebar.test.jsx

@@ -1,15 +1,12 @@
 import { h } from 'preact';
-import * as Context from '../context';
+import { DrawerProvider }  from '../context';
 import Sidebar from '../Sidebar';
 import { render, screen } from 'testing-library';
 
 describe('Sidebar', () => {
-  beforeEach(() => {
-    jest.spyOn(Context, 'useDrawer').mockImplementation(() => ({ showDrawer: true, setShowDrawer: () => {} }));
-  });
-
-  test('does not render cameras by default', async () => {
-    const { findByText } = render(<Sidebar />);
+  // eslint-disable-next-line jest/no-disabled-tests
+  test.skip('does not render cameras by default', async () => {
+    const { findByText } = render(<DrawerProvider><Sidebar /></DrawerProvider>);
     await findByText('Cameras');
     expect(screen.queryByRole('link', { name: 'front' })).not.toBeInTheDocument();
     expect(screen.queryByRole('link', { name: 'side' })).not.toBeInTheDocument();

web/src/api/__tests__/index.test.jsx

@@ -5,7 +5,7 @@ import { render, screen } from 'testing-library';
 
 describe('useApiHost', () => {
   beforeEach(() => {
-    jest.spyOn(Mqtt, 'MqttProvider').mockImplementation(({ children }) => children);
+    vi.spyOn(Mqtt, 'MqttProvider').mockImplementation(({ children }) => children);
   });
 
   test('is set from the baseUrl', async () => {

web/src/api/__tests__/mqtt.test.jsx

@@ -22,10 +22,10 @@ describe('MqttProvider', () => {
   let createWebsocket, wsClient;
   beforeEach(() => {
     wsClient = {
-      close: jest.fn(),
-      send: jest.fn(),
+      close: vi.fn(),
+      send: vi.fn(),
     };
-    createWebsocket = jest.fn((url) => {
+    createWebsocket = vi.fn((url) => {
       wsClient.args = [url];
       return new Proxy(
         {},
@@ -34,7 +34,7 @@ describe('MqttProvider', () => {
             return wsClient[prop];
           },
           set(_target, prop, value) {
-            wsClient[prop] = typeof value === 'function' ? jest.fn(value) : value;
+            wsClient[prop] = typeof value === 'function' ? vi.fn(value) : value;
             if (prop === 'onopen') {
               wsClient[prop]();
             }
@@ -110,7 +110,7 @@ describe('MqttProvider', () => {
   });
 
   test('prefills the recordings/detect/snapshots state from config', async () => {
-    jest.spyOn(Date, 'now').mockReturnValue(123456);
+    vi.spyOn(Date, 'now').mockReturnValue(123456);
     const config = {
       cameras: {
         front: { name: 'front', detect: { enabled: true }, record: { enabled: false }, snapshots: { enabled: true } },

web/src/app.css

@@ -0,0 +1,25 @@
+#app {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.preact:hover {
+  filter: drop-shadow(0 0 2em #673ab8aa);
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}

web/src/app.tsx

@@ -11,7 +11,7 @@ import useSWR from 'swr';
 
 export default function App() {
   const { data: config } = useSWR('config');
-  const cameraComponent = config && config.ui.use_experimental ? Routes.getCameraV2 : Routes.getCamera;
+  const cameraComponent = config && config.ui?.use_experimental ? Routes.getCameraV2 : Routes.getCamera;
 
   return (
     <DarkModeProvider>

web/src/assets/preact.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="27.68" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 296"><path fill="#673AB8" d="m128 0l128 73.9v147.8l-128 73.9L0 221.7V73.9z"></path><path fill="#FFF" d="M34.865 220.478c17.016 21.78 71.095 5.185 122.15-34.704c51.055-39.888 80.24-88.345 63.224-110.126c-17.017-21.78-71.095-5.184-122.15 34.704c-51.055 39.89-80.24 88.346-63.224 110.126Zm7.27-5.68c-5.644-7.222-3.178-21.402 7.573-39.253c11.322-18.797 30.541-39.548 54.06-57.923c23.52-18.375 48.303-32.004 69.281-38.442c19.922-6.113 34.277-5.075 39.92 2.148c5.644 7.223 3.178 21.403-7.573 39.254c-11.322 18.797-30.541 39.547-54.06 57.923c-23.52 18.375-48.304 32.004-69.281 38.441c-19.922 6.114-34.277 5.076-39.92-2.147Z"></path><path fill="#FFF" d="M220.239 220.478c17.017-21.78-12.169-70.237-63.224-110.126C105.96 70.464 51.88 53.868 34.865 75.648c-17.017 21.78 12.169 70.238 63.224 110.126c51.055 39.889 105.133 56.485 122.15 34.704Zm-7.27-5.68c-5.643 7.224-19.998 8.262-39.92 2.148c-20.978-6.437-45.761-20.066-69.28-38.441c-23.52-18.376-42.74-39.126-54.06-57.923c-10.752-17.851-13.218-32.03-7.575-39.254c5.644-7.223 19.999-8.261 39.92-2.148c20.978 6.438 45.762 20.067 69.281 38.442c23.52 18.375 42.739 39.126 54.06 57.923c10.752 17.85 13.218 32.03 7.574 39.254Z"></path><path fill="#FFF" d="M127.552 167.667c10.827 0 19.603-8.777 19.603-19.604c0-10.826-8.776-19.603-19.603-19.603c-10.827 0-19.604 8.777-19.604 19.603c0 10.827 8.777 19.604 19.604 19.604Z"></path></svg>

web/src/components/CameraImage.jsx

@@ -14,6 +14,7 @@ export default function CameraImage({ camera, onload, searchParams = '', stretch
   const [{ width: availableWidth }] = useResizeObserver(containerRef);
 
   const { name } = config ? config.cameras[camera] : '';
+  const enabled = config ? config.cameras[camera].enabled : 'True';
   const { width, height } = config ? config.cameras[camera].detect : { width: 1, height: 1 };
   const aspectRatio = width / height;
 
@@ -45,12 +46,18 @@ export default function CameraImage({ camera, onload, searchParams = '', stretch
 
   return (
     <div className="relative w-full" ref={containerRef}>
+      {
+        (enabled) ?
           <canvas data-testid="cameraimage-canvas" height={scaledHeight} ref={canvasRef} width={scaledWidth} />
-      {!hasLoaded ? (
+          : <div class="text-center pt-6">Camera is disabled in config, no stream or snapshot available!</div>
+      }
+      {
+        (!hasLoaded && enabled) ? (
           <div className="absolute inset-0 flex justify-center" style={`height: ${scaledHeight}px`}>
             <ActivityIndicator />
           </div>
-      ) : null}
+        ) : null
+      }
     </div >
   );
 }

web/src/components/HistoryViewer/HistoryVideo.tsx

@@ -57,14 +57,14 @@ export const HistoryVideo = ({
     }
 
     video.src({
-      src: `${apiHost}/vod/event/${id}/index.m3u8`,
+      src: `${apiHost}/vod/event/${id}/master.m3u8`,
       type: 'application/vnd.apple.mpegurl',
     });
     video.poster(`${apiHost}/api/events/${id}/snapshot.jpg`);
     if (videoIsPlaying) {
       video.play();
     }
-  }, [video, id]);
+  }, [video, id, apiHost, videoIsPlaying]);
 
   useEffect(() => {
     const video = videoRef.current;

web/src/components/JSMpegPlayer.jsx

@@ -5,7 +5,7 @@ import JSMpeg from '@cycjimmy/jsmpeg-player';
 
 export default function JSMpegPlayer({ camera, width, height }) {
   const playerRef = useRef();
-  const url = `${baseUrl.replace(/^http/, 'ws')}live/${camera}`;
+  const url = `${baseUrl.replace(/^http/, 'ws')}live/jsmpeg/${camera}`;
 
   useEffect(() => {
     const video = new JSMpeg.VideoElement(

web/src/components/MsePlayer.jsx

@@ -0,0 +1,78 @@
+import { h } from 'preact';
+import { baseUrl } from '../api/baseUrl';
+import { useEffect } from 'preact/hooks';
+
+export default function MsePlayer({ camera, width, height }) {
+  const url = `${baseUrl.replace(/^http/, 'ws')}live/mse/api/ws?src=${camera}`;
+
+  useEffect(() => {
+    const video = document.querySelector('#video');
+
+    // support api_path
+    const ws = new WebSocket(url);
+    ws.binaryType = 'arraybuffer';
+    let mediaSource,
+      sourceBuffer,
+      queueBuffer = [];
+
+    ws.onopen = () => {
+      mediaSource = new MediaSource();
+      video.src = URL.createObjectURL(mediaSource);
+      mediaSource.onsourceopen = () => {
+        mediaSource.onsourceopen = null;
+        URL.revokeObjectURL(video.src);
+        ws.send(JSON.stringify({ type: 'mse' }));
+      };
+    };
+
+    ws.onmessage = (ev) => {
+      if (typeof ev.data === 'string') {
+        const data = JSON.parse(ev.data);
+
+        if (data.type === 'mse') {
+          sourceBuffer = mediaSource.addSourceBuffer(data.value);
+          sourceBuffer.mode = 'segments'; // segments or sequence
+          sourceBuffer.onupdateend = () => {
+            if (!sourceBuffer.updating && queueBuffer.length > 0) {
+              try {
+                sourceBuffer.appendBuffer(queueBuffer.shift());
+              } catch (e) {
+                // console.warn(e);
+              }
+            }
+          };
+        }
+      } else if (sourceBuffer.updating || queueBuffer.length > 0) {
+        queueBuffer.push(ev.data);
+      } else {
+        try {
+          sourceBuffer.appendBuffer(ev.data);
+        } catch (e) {
+          // console.warn(e);
+        }
+      }
+
+      if (video.seekable.length > 0) {
+        const delay = video.seekable.end(video.seekable.length - 1) - video.currentTime;
+        if (delay < 1) {
+          video.playbackRate = 1;
+        } else if (delay > 10) {
+          video.playbackRate = 10;
+        } else if (delay > 2) {
+          video.playbackRate = Math.floor(delay);
+        }
+      }
+    };
+
+    video.onpause = () => {
+      ws.close();
+      video.src = null;
+    }
+  }, [url]);
+
+  return (
+    <div>
+      <video id="video" autoplay playsinline controls muted width={width} height={height} />
+    </div>
+  );
+}

web/src/components/RecordingPlaylist.jsx

@@ -44,12 +44,12 @@ export default function RecordingPlaylist({ camera, recordings, selectedDate })
     <div className="flex absolute inset-y-0 right-0 w-9/12 md:w-1/2 lg:w-3/5 max-w-md text-base text-white font-sans">
       <div
         onClick={toggle}
-        className={`absolute ${openClass} cursor-pointer items-center self-center rounded-tl-lg rounded-bl-lg border border-r-0 w-6 h-20 py-7 bg-gray-800 bg-opacity-70`}
+        className={`absolute ${openClass} cursor-pointer items-center self-center rounded-tl-lg rounded-bl-lg border border-r-0 w-6 h-20 py-7 bg-gray-800 bg-opacity-70 z-10`}
       >
         {active ? <Menu /> : <MenuOpen />}
       </div>
       <div
-        className={`w-full h-full bg-gray-800 bg-opacity-70 border-l overflow-x-hidden overflow-y-auto${
+        className={`w-full h-full bg-gray-800 bg-opacity-70 border-l overflow-x-hidden overflow-y-auto z-10${
           active ? '' : ' hidden'
         }`}
       >

web/src/components/Tabs.jsx

@@ -27,12 +27,14 @@ export function Tabs({ children, selectedIndex: selectedIndexProp, onChange, cla
   );
 }
 
-export function TextTab({ selected, text, onClick }) {
-  const selectedStyle = selected
+export function TextTab({ selected, text, onClick, disabled }) {
+  const selectedStyle = disabled
+    ? 'text-gray-400 dark:text-gray-600 bg-transparent'
+    : selected
       ? 'text-white bg-blue-500 dark:text-black dark:bg-white'
       : 'text-black dark:text-white bg-transparent';
   return (
-    <button onClick={onClick} className={`rounded-full px-4 py-2 ${selectedStyle}`}>
+    <button onClick={onClick} disabled={disabled} className={`rounded-full px-4 py-2 ${selectedStyle}`}>
       <span>{text}</span>
     </button>
   );

web/src/components/WebRtcPlayer.jsx

@@ -0,0 +1,72 @@
+import { h } from 'preact';
+import { baseUrl } from '../api/baseUrl';
+import { useEffect } from 'preact/hooks';
+
+export default function WebRtcPlayer({ camera, width, height }) {
+  const url = `${baseUrl.replace(/^http/, 'ws')}live/webrtc/api/ws?src=${camera}`;
+
+  useEffect(() => {
+    const ws = new WebSocket(url);
+    ws.onopen = () => {
+      pc.createOffer().then((offer) => {
+        pc.setLocalDescription(offer).then(() => {
+          const msg = { type: 'webrtc/offer', value: pc.localDescription.sdp };
+          ws.send(JSON.stringify(msg));
+        });
+      });
+    };
+    ws.onmessage = (ev) => {
+      const msg = JSON.parse(ev.data);
+
+      if (msg.type === 'webrtc/candidate') {
+        pc.addIceCandidate({ candidate: msg.value, sdpMid: '' });
+      } else if (msg.type === 'webrtc/answer') {
+        pc.setRemoteDescription({ type: 'answer', sdp: msg.value });
+      }
+    };
+
+    const pc = new RTCPeerConnection({
+      iceServers: [{ urls: 'stun:stun.l.google.com:19302' }],
+    });
+    pc.onicecandidate = (ev) => {
+      if (ev.candidate !== null) {
+        ws.send(
+          JSON.stringify({
+            type: 'webrtc/candidate',
+            value: ev.candidate.toJSON().candidate,
+          })
+        );
+      }
+    };
+    pc.ontrack = (ev) => {
+      const video = document.getElementById('video');
+
+      // when audio track not exist in Chrome
+      if (ev.streams.length === 0) return;
+      // when audio track not exist in Firefox
+      if (ev.streams[0].id[0] === '{') return;
+      // when stream already init
+      if (video.srcObject !== null) return;
+
+      video.srcObject = ev.streams[0];
+    };
+
+    // Safari don't support "offerToReceiveVideo"
+    // so need to create transeivers manually
+    pc.addTransceiver('video', { direction: 'recvonly' });
+    pc.addTransceiver('audio', { direction: 'recvonly' });
+
+    return () => {
+      const video = document.getElementById('video');
+      video.srcObject = null;
+      pc.close();
+      ws.close();
+    };
+  }, [url]);
+
+  return (
+    <div>
+      <video id="video" autoplay playsinline controls muted width={width} height={height} />
+    </div>
+  );
+}

web/src/components/__tests__/AppBar.test.jsx

@@ -1,7 +1,7 @@
 import { h } from 'preact';
 import { DrawerProvider } from '../../context';
 import AppBar from '../AppBar';
-import { fireEvent, render, screen } from 'testing-library';
+import { fireEvent, render, screen } from '@testing-library/preact';
 import { useRef } from 'preact/hooks';
 
 function Title() {
@@ -20,7 +20,7 @@ describe('AppBar', () => {
 
   describe('overflow menu', () => {
     test('is not rendered if a ref is not provided', async () => {
-      const handleOverflow = jest.fn();
+      const handleOverflow = vi.fn();
       render(
         <DrawerProvider>
           <AppBar title={Title} onOverflowClick={handleOverflow} />
@@ -44,7 +44,7 @@ describe('AppBar', () => {
     });
 
     test('is rendered with click handler and ref', async () => {
-      const handleOverflow = jest.fn();
+      const handleOverflow = vi.fn();
 
       function Wrapper() {
         const ref = useRef(null);
@@ -60,7 +60,7 @@ describe('AppBar', () => {
     });
 
     test('calls the handler when clicked', async () => {
-      const handleOverflow = jest.fn();
+      const handleOverflow = vi.fn();
 
       function Wrapper() {
         const ref = useRef(null);
@@ -94,7 +94,7 @@ describe('AppBar', () => {
     });
 
     test('hides when scrolled downward', async () => {
-      jest.spyOn(window, 'requestAnimationFrame').mockImplementation((cb) => cb());
+      vi.spyOn(window, 'requestAnimationFrame').mockImplementation((cb) => cb());
       render(
         <DrawerProvider>
           <AppBar title={Title} />
@@ -111,7 +111,7 @@ describe('AppBar', () => {
     });
 
     test('reappears when scrolled upward', async () => {
-      jest.spyOn(window, 'requestAnimationFrame').mockImplementation((cb) => cb());
+      vi.spyOn(window, 'requestAnimationFrame').mockImplementation((cb) => cb());
       render(
         <DrawerProvider>
           <AppBar title={Title} />