diff --git a/docs/docs/configuration/authentication.md b/docs/docs/configuration/authentication.md index 94d46dba07..13638c511b 100644 --- a/docs/docs/configuration/authentication.md +++ b/docs/docs/configuration/authentication.md @@ -22,7 +22,9 @@ The following ports are available to access the Frigate web UI. ## Onboarding -On startup, an admin user and password are generated and printed in the logs. It is recommended to set a new password for the admin account after logging in for the first time under Settings > Users. +On startup, an admin user and password are generated and printed in the logs. It is recommended to set a new password for the admin account after logging in for the first time. + +On a new install the [setup wizard](../guides/getting_started.md#configuring-frigate) offers this as its first step, along with creating accounts for anyone else who needs access. You can also do both at any time under . ## Resetting admin password diff --git a/docs/docs/configuration/cameras.md b/docs/docs/configuration/cameras.md index 72305d27ad..d880ba1020 100644 --- a/docs/docs/configuration/cameras.md +++ b/docs/docs/configuration/cameras.md @@ -9,7 +9,7 @@ import NavPath from "@site/src/components/NavPath"; ## Adding a camera with the Add Camera Wizard -The Add Camera Wizard is the recommended way to add a camera. Click **Add Camera** in . The wizard connects to your camera, tests each stream, and writes the camera's configuration for you, including the [go2rtc](go2rtc.md) restream and the live view stream mapping, so a standard setup needs no hand-written YAML. +The Add Camera Wizard is the recommended way to add a camera. Click **Add Camera** in , or use it from the [setup wizard](../guides/getting_started.md#configuring-frigate) on a new install. The wizard connects to your camera, tests each stream, and writes the camera's configuration for you, including the [go2rtc](go2rtc.md) restream and the live view stream mapping, so a standard setup needs no hand-written YAML. ### Step 1: Name and connection diff --git a/docs/docs/guides/getting_started.md b/docs/docs/guides/getting_started.md index dc67684857..d882e4f4a9 100644 --- a/docs/docs/guides/getting_started.md +++ b/docs/docs/guides/getting_started.md @@ -4,6 +4,7 @@ title: Getting started --- import ConfigTabs from "@site/src/components/ConfigTabs"; +import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import NavPath from "@site/src/components/NavPath"; @@ -132,21 +133,68 @@ services: - "8554:8554" # RTSP feeds ``` -Now you should be able to start Frigate by running `docker compose up -d` from within the folder containing `docker-compose.yml`. On startup, an admin user and password will be created and outputted in the logs. You can see this by running `docker logs frigate`. Frigate should now be accessible at `https://server_ip:8971` where you can login with the `admin` user and finish configuration using the Settings UI. +Now you should be able to start Frigate by running `docker compose up -d` from within the folder containing `docker-compose.yml`. On startup, an admin user and password will be created and outputted in the logs. You can see this by running `docker logs frigate`. Frigate should now be accessible at `https://server_ip:8971` where you can login with the `admin` user. With no cameras configured yet, the setup wizard runs on first login and walks you through the rest. ## Configuring Frigate This section assumes that you already have an environment setup as described in [Installation](../frigate/installation.md). You should also configure your cameras according to the [camera setup guide](/frigate/camera_setup). Pay particular attention to the section on choosing a detect resolution. -### Step 1: Start Frigate + + +The first time you open Frigate with no cameras configured, the setup wizard walks you through the basics. Every step can be skipped, everything it sets can be changed later in Settings, and once you finish or dismiss it, it doesn't come back. + +:::note + +Frigate only sees hardware that has been passed into the container. If you plan to use a GPU, a Coral, or another accelerator, add the device to your `docker-compose.yml` and restart before running the wizard, otherwise it won't appear in the detection or hardware acceleration steps. The Manual tab shows the device entries for an Intel or AMD GPU and for a Coral, and the [hardware acceleration](../configuration/hardware_acceleration_video.md) and [object detectors](../configuration/object_detectors.md) docs cover the rest. + +::: + +**Account** + +Set a password for the `admin` account to replace the generated one from the logs, and add accounts for anyone else who needs access. This step is hidden if you have turned authentication off. + +**Add a camera** + +Opens the [Add Camera Wizard](../configuration/cameras.md#adding-a-camera-with-the-add-camera-wizard), which connects to the camera, tests each stream, and writes its configuration for you. You can add more than one before moving on. + +**Object detection** + +Lists the detection hardware Frigate found on your system, such as a Coral, an Intel GPU or NPU, or a discrete GPU, and configures the one you pick. NVIDIA and AMD GPUs need a model before detection can start, so the wizard offers your Frigate+ models if you have them, or lets you finish setup and add one later under . + +**Hardware acceleration** + +Offers only the decoding methods your hardware supports. Auto picks one based on that hardware and the codec your camera sends, so a mixed h264 and h265 setup gets the right preset per camera. + +**Recording** + +Choose whether to record only when something is detected or around the clock, and how long to keep it. + +The last screen summarizes what was set up. If a step changed something that needs a restart, the button restarts Frigate and returns you to the Live view once it is back. + +The wizard configures the essentials only. Motion masks are not included and should be set up afterward, once you can identify the areas of the frame that trigger unwanted motion. See the [masks documentation](../configuration/masks.md). Zones, tracked object types, notifications, and MQTT are also configured in Settings. + + + + +On a new install the setup wizard opens first. Click **Skip setup and configure manually** on its welcome screen to dismiss it, and the steps below apply. The wizard won't come back once dismissed. + +**Step 1: Start Frigate** At this point you should be able to start Frigate and a basic config will be created automatically. -### Step 2: Add a camera +**Step 2: Add a camera** Click the **Add Camera** button in to use the camera setup wizard to get your first camera added into Frigate. See [Adding a camera with the Add Camera Wizard](../configuration/cameras.md#adding-a-camera-with-the-add-camera-wizard) for a walkthrough of each step. -### Step 3: Configure hardware acceleration (recommended) +**Step 3: Configure hardware acceleration (recommended)** Now that you have a working camera configuration, set up hardware acceleration to minimize the CPU required to decode your video streams. See the [hardware acceleration](../configuration/hardware_acceleration_video.md) docs for examples applicable to your hardware. @@ -190,7 +238,7 @@ cameras: -### Step 4: Configure detectors +**Step 4: Configure detectors** By default, Frigate will use a single OpenVINO detector running on the CPU. @@ -299,7 +347,7 @@ More details on available detectors can be found [here](../configuration/object_ Restart Frigate and you should start seeing detections for `person`. If you want to track other objects, they can be configured in or via the [configuration file reference](../configuration/advanced/reference.md). -### Step 5: Setup motion masks +**Step 5: Setup motion masks** Now that you have optimized your configuration for decoding the video stream, you will want to check to see where to implement motion masks. Click on the camera from the main dashboard, then select the gear icon in the top right, enable the [Debug view](/usage/live#the-single-camera-view), and finally enable the switch for Motion Boxes. Watch for areas that continuously trigger unwanted motion to be detected. Common areas to mask include camera timestamps and trees that frequently blow in the wind. The goal is to avoid wasting object detection cycles looking at these areas. @@ -336,7 +384,7 @@ cameras: coordinates: "0,461,3,0,1919,0,1919,843,1699,492,1344,458,1346,336,973,317,869,375,866,432" ``` -### Step 6: Enable recordings +**Step 6: Enable recordings** In order to review activity in the Frigate UI, recordings need to be enabled. @@ -385,7 +433,10 @@ If you only plan to use Frigate for recording, it is still recommended to define By default, Frigate will retain video of all tracked objects for 10 days. The full set of options for recording can be found [here](../configuration/advanced/reference.md). -### Step 7: Complete config + + + +### Complete config At this point you have a complete config with basic functionality. diff --git a/docs/static/frigate-api.yaml b/docs/static/frigate-api.yaml index 658f5e58a0..5d0e0adbe0 100644 --- a/docs/static/frigate-api.yaml +++ b/docs/static/frigate-api.yaml @@ -4053,6 +4053,58 @@ paths: security: - frigateAdminAuth: [] x-required-role: admin + /hardware/hwaccel: + get: + tags: + - Hardware + summary: Hwaccel Recommendation + description: |- + **Access:** Admin role required. + + Get the hardware decoding this system can do. + + Args: + detector: Hardware key of the detection hardware in use, which biases + the recommendation toward that hardware's GPU + codecs: Comma separated codecs of the streams that will be decoded, + used to drop families that cannot decode one of them + + Returns: + The recommended family (empty when none fits) and every usable family + operationId: hwaccel_recommendation_hardware_hwaccel_get + parameters: + - name: detector + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Detector + - name: codecs + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Codecs + responses: + '200': + description: Successful Response + content: + application/json: + schema: + $ref: '#/components/schemas/HwaccelRecommendation' + '422': + description: Validation Error + content: + application/json: + schema: + $ref: '#/components/schemas/HTTPValidationError' + security: + - frigateAdminAuth: [] + x-required-role: admin /events: get: tags: @@ -8670,6 +8722,43 @@ components: - label title: HardwareUnit description: One physical piece of hardware. + HwaccelFamily: + properties: + key: + type: string + title: Family key + description: Stable identifier for this kind of hardware decoding. + presets: + additionalProperties: + type: string + type: object + title: Presets + description: The ffmpeg preset for each codec this family decodes, or + a single 'any' preset when it decodes every codec. + type: object + required: + - key + - presets + title: HwaccelFamily + description: A kind of hardware decoding, and the presets that drive it. + HwaccelRecommendation: + properties: + recommended: + type: string + title: Recommended family + description: Key of the family that fits this system best, or an empty + string when none does. + available: + items: + $ref: '#/components/schemas/HwaccelFamily' + type: array + title: Available families + description: Every family this system's hardware can use, best first. + type: object + required: + - recommended + title: HwaccelRecommendation + description: The hardware decoding this system can do. Last24HoursReview: properties: reviewed_alert: diff --git a/frigate/api/hardware.py b/frigate/api/hardware.py index aba5a88a46..37244e8306 100644 --- a/frigate/api/hardware.py +++ b/frigate/api/hardware.py @@ -7,6 +7,7 @@ from fastapi import APIRouter, Depends from frigate.api.auth import require_role from frigate.api.defs.tags import Tags from frigate.detectors.hardware import DetectionHardware, hardware_prober +from frigate.util.hwaccel import HwaccelRecommendation, hwaccel_options logger = logging.getLogger(__name__) @@ -28,3 +29,29 @@ def probe_hardware(refresh: bool = False) -> list[DetectionHardware]: Every kind of detection hardware that was found """ return hardware_prober.probe(refresh=refresh) + + +@router.get( + "/hardware/hwaccel", + response_model=HwaccelRecommendation, + dependencies=[Depends(require_role(["admin"]))], +) +def hwaccel_recommendation( + detector: str | None = None, codecs: str | None = None +) -> HwaccelRecommendation: + """Get the hardware decoding this system can do. + + Args: + detector: Hardware key of the detection hardware in use, which biases + the recommendation toward that hardware's GPU + codecs: Comma separated codecs of the streams that will be decoded, + used to drop families that cannot decode one of them + + Returns: + The recommended family (empty when none fits) and every usable family + """ + wanted = { + codec.strip().lower() for codec in (codecs or "").split(",") if codec.strip() + } + recommended, available = hwaccel_options(detector, wanted) + return HwaccelRecommendation(recommended=recommended, available=available) diff --git a/frigate/test/test_hwaccel_recommendation.py b/frigate/test/test_hwaccel_recommendation.py new file mode 100644 index 0000000000..e334296ad3 --- /dev/null +++ b/frigate/test/test_hwaccel_recommendation.py @@ -0,0 +1,225 @@ +"""Tests for the hardware decoding recommendation.""" + +import os +import tempfile +import unittest +from unittest.mock import patch + +from frigate.detectors.hardware import DetectionHardware +from frigate.util import hwaccel + + +def found(key: str) -> DetectionHardware: + """A probe result carrying only the fields the recommendation reads.""" + return DetectionHardware( + key=key, + detector=key.partition(":")[0], + name=key, + units=[], + count=0, + unlimited=True, + ) + + +class HwaccelRecommendationTestCase(unittest.TestCase): + """Points every read at an empty fixture tree, so nothing is found by default.""" + + def setUp(self): + self.root = tempfile.TemporaryDirectory() + self.addCleanup(self.root.cleanup) + + self.proc_root = os.path.join(self.root.name, "proc") + os.makedirs(self.proc_root) + patcher = patch.object(hwaccel, "PROC_ROOT", self.proc_root) + patcher.start() + self.addCleanup(patcher.stop) + + drm = patch.object(hwaccel, "enumerate_drm_devices", return_value={}) + self.drm = drm.start() + self.addCleanup(drm.stop) + + def options(self, keys=(), detector_key=None, codecs=None): + """Run the recommendation against a fixed set of hardware keys.""" + with patch.object( + hwaccel.hardware_prober, + "probe", + return_value=[found(key) for key in keys], + ): + return hwaccel.hwaccel_options(detector_key, codecs) + + def recommend(self, keys=(), detector_key=None, codecs=None) -> str: + """The recommended family key.""" + return self.options(keys, detector_key, codecs)[0] + + def available(self, keys=(), detector_key=None, codecs=None) -> list[str]: + """The keys of the usable families, best first.""" + return [family.key for family in self.options(keys, detector_key, codecs)[1]] + + def presets(self, keys=(), detector_key=None, codecs=None) -> dict: + """The presets each usable family provides.""" + return { + family.key: family.presets + for family in self.options(keys, detector_key, codecs)[1] + } + + def write_cpuinfo(self, model_name: str) -> None: + with open(os.path.join(self.proc_root, "cpuinfo"), "w") as f: + f.write(f"processor\t: 0\nmodel name\t: {model_name}\n") + + def write_device_tree(self) -> None: + os.makedirs(os.path.join(self.proc_root, "device-tree"), exist_ok=True) + with open(os.path.join(self.proc_root, "device-tree", "compatible"), "w") as f: + f.write("raspberrypi,5-model-b\x00brcm,bcm2712\x00") + + +class TestPriority(HwaccelRecommendationTestCase): + def test_nothing_found_recommends_nothing(self): + self.assertEqual(self.recommend(), "") + + def test_nvidia_wins_over_intel(self): + self.assertEqual(self.recommend(["onnx:nvidia", "openvino:GPU"]), "nvidia") + + def test_a_jetson_uses_its_own_family(self): + self.assertEqual(self.recommend(["tensorrt"]), "jetson") + + def test_a_rockchip_uses_rkmpp(self): + self.assertEqual(self.recommend(["rknn"]), "rkmpp") + + def test_an_amd_gpu_uses_vaapi(self): + self.assertEqual(self.recommend(["onnx:amd"]), "vaapi") + + +class TestDetectorBias(HwaccelRecommendationTestCase): + def test_a_chosen_intel_gpu_beats_a_present_nvidia(self): + self.assertEqual( + self.recommend(["onnx:nvidia", "openvino:GPU"], "openvino:GPU"), "vaapi" + ) + + def test_a_chosen_npu_decodes_through_the_igpu(self): + self.assertEqual( + self.recommend(["openvino:NPU", "openvino:GPU"], "openvino:NPU"), "vaapi" + ) + + def test_an_npu_without_an_igpu_falls_through(self): + self.assertEqual(self.recommend(["openvino:NPU"], "openvino:NPU"), "") + + def test_a_cpu_choice_still_recommends_the_present_gpu(self): + self.assertEqual(self.recommend(["cpu", "openvino:GPU"], "cpu"), "vaapi") + + +class TestIntelGeneration(HwaccelRecommendationTestCase): + def test_the_xe_driver_prefers_qsv(self): + self.drm.return_value = {"0000:00:02.0": "xe"} + self.assertEqual(self.recommend(["openvino:GPU"], codecs={"h264"}), "intel-qsv") + + def test_gen13_prefers_qsv(self): + self.write_cpuinfo("13th Gen Intel(R) Core(TM) i5-13500") + self.assertEqual(self.recommend(["openvino:GPU"], codecs={"h264"}), "intel-qsv") + + def test_a_core_ultra_prefers_qsv(self): + self.write_cpuinfo("Intel(R) Core(TM) Ultra 7 155H") + self.assertEqual(self.recommend(["openvino:GPU"], codecs={"h264"}), "intel-qsv") + + def test_gen13_prefers_qsv_for_mixed_codecs(self): + # each camera resolves the family to its own codec + self.write_cpuinfo("13th Gen Intel(R) Core(TM) i5-13500") + self.assertEqual( + self.recommend(["openvino:GPU"], codecs={"h264", "h265"}), "intel-qsv" + ) + + def test_gen12_prefers_vaapi(self): + self.write_cpuinfo("12th Gen Intel(R) Core(TM) i5-12400") + self.assertEqual(self.recommend(["openvino:GPU"], codecs={"h264"}), "vaapi") + + def test_gen12_still_offers_qsv(self): + self.write_cpuinfo("12th Gen Intel(R) Core(TM) i5-12400") + self.assertEqual(self.available(["openvino:GPU"]), ["vaapi", "intel-qsv"]) + + def test_an_older_model_string_prefers_vaapi(self): + self.write_cpuinfo("Intel(R) Core(TM) i7-8700K CPU @ 3.70GHz") + self.assertEqual(self.recommend(["openvino:GPU"], codecs={"h264"}), "vaapi") + + def test_missing_cpuinfo_prefers_vaapi(self): + self.assertEqual(self.recommend(["openvino:GPU"], codecs={"h264"}), "vaapi") + + def test_qsv_is_not_offered_before_gen8(self): + self.write_cpuinfo("7th Gen Intel(R) Core(TM) i5-7500") + self.assertEqual(self.available(["openvino:GPU"]), ["vaapi"]) + + +class TestUnknownCodecs(HwaccelRecommendationTestCase): + def test_a_codec_agnostic_family_wins_when_no_codec_is_known(self): + # a qsv preset would have to guess a codec for cameras added later + self.drm.return_value = {"0000:00:02.0": "xe"} + self.assertEqual(self.recommend(["openvino:GPU"]), "vaapi") + + def test_hardware_with_no_agnostic_family_still_recommends(self): + self.assertEqual(self.recommend(["tensorrt"]), "jetson") + + +class TestAvailableFamilies(HwaccelRecommendationTestCase): + def test_nothing_found_offers_nothing(self): + self.assertEqual(self.available(), []) + + def test_only_families_the_hardware_can_use_are_offered(self): + self.assertEqual(self.available(["onnx:nvidia"]), ["nvidia"]) + + def test_a_pi_does_not_offer_desktop_gpu_families(self): + self.write_device_tree() + self.assertEqual(self.available(), ["rpi"]) + + def test_an_intel_system_does_not_offer_the_pi_family(self): + offered = self.available(["openvino:GPU"]) + + self.assertIn("vaapi", offered) + self.assertNotIn("rpi", offered) + self.assertNotIn("nvidia", offered) + + def test_every_gpu_present_is_offered(self): + offered = self.available(["onnx:nvidia", "openvino:GPU"]) + + self.assertEqual(offered[0], "nvidia") + self.assertIn("vaapi", offered) + + def test_a_gpu_wins_over_the_pi_fallback(self): + self.write_device_tree() + self.assertEqual(self.recommend(["onnx:nvidia"]), "nvidia") + + def test_the_recommendation_is_always_offered(self): + recommended, families = self.options(["openvino:GPU"], codecs={"h264"}) + + self.assertIn(recommended, [family.key for family in families]) + + +class TestCodecCoverage(HwaccelRecommendationTestCase): + def test_a_family_carries_a_preset_per_codec(self): + self.assertEqual( + self.presets(["tensorrt"])["jetson"], + {"h264": "preset-jetson-h264", "h265": "preset-jetson-h265"}, + ) + + def test_a_codec_agnostic_family_carries_one_preset(self): + self.assertEqual( + self.presets(["onnx:nvidia"])["nvidia"], {"any": "preset-nvidia"} + ) + + def test_hevc_is_treated_as_h265(self): + self.assertEqual(self.available(["tensorrt"], codecs={"hevc"}), ["jetson"]) + + def test_a_family_that_cannot_decode_a_codec_is_dropped(self): + # a jetson decodes h264 and h265 only, so an mjpeg camera rules it out + self.assertEqual(self.available(["tensorrt"], codecs={"mjpeg"}), []) + + def test_codec_agnostic_families_survive_any_codec(self): + self.assertEqual( + self.available(["onnx:nvidia"], codecs={"mjpeg", "h265"}), ["nvidia"] + ) + + def test_a_dropped_family_hands_off_to_the_next_hardware(self): + self.assertEqual( + self.recommend(["tensorrt", "onnx:nvidia"], codecs={"mjpeg"}), "nvidia" + ) + + +if __name__ == "__main__": + unittest.main() diff --git a/frigate/util/config.py b/frigate/util/config.py index b63f3c9872..fe1218b5c9 100644 --- a/frigate/util/config.py +++ b/frigate/util/config.py @@ -79,10 +79,20 @@ def redact_credential(obj: dict[str, Any], key: str) -> None: def find_config_file() -> str: + """Return the path of the config file to use. + + Both .yml and .yaml are supported, so fall back to the other extension when + the configured path does not exist. If neither exists the configured path is + returned so a new config is created with the default .yml extension. + """ config_path = os.environ.get("CONFIG_FILE", DEFAULT_CONFIG_FILE) if not os.path.isfile(config_path): - config_path = config_path.replace("yml", "yaml") + base, ext = os.path.splitext(config_path) + alternate = f"{base}.yaml" if ext == ".yml" else f"{base}.yml" + + if os.path.isfile(alternate): + return alternate return config_path diff --git a/frigate/util/hwaccel.py b/frigate/util/hwaccel.py new file mode 100644 index 0000000000..88ce16ce73 --- /dev/null +++ b/frigate/util/hwaccel.py @@ -0,0 +1,273 @@ +"""Recommendation of ffmpeg hwaccel presets from the hardware on the system. + +Every check is a filesystem read, like the detection hardware probes, so this +is cheap enough to serve from the API process. + +Presets are grouped into families because some of them only decode the codec +they name. A family hides that: callers pick the family their hardware needs +and resolve it per camera against that camera's detect stream. +""" + +import logging +import re + +from pydantic import BaseModel, Field + +from frigate.const import ( + FFMPEG_HWACCEL_NVIDIA, + FFMPEG_HWACCEL_RKMPP, + FFMPEG_HWACCEL_VAAPI, +) +from frigate.detectors.hardware import hardware_prober +from frigate.util.services import enumerate_drm_devices + +logger = logging.getLogger(__name__) + +# root the /proc reads use, so tests can point them at a fixture tree +PROC_ROOT = "/proc" + +ANY_CODEC = "any" + +# a Raspberry Pi has no detection hardware of its own, so it gets a key here +RASPBERRY_PI = "raspberrypi" + +# ffprobe names h265 streams hevc +CODEC_ALIASES = {"hevc": "h265"} + +# e.g. "13th Gen Intel(R) Core(TM) i5-13500" +INTEL_GEN_PATTERN = re.compile(r"(\d+)th Gen") +# Core Ultra dropped the generation prefix and is newer than all of them +INTEL_ULTRA_PATTERN = re.compile(r"Core\(TM\) Ultra") +INTEL_GEN_LATEST = 99 + +# per the hwaccel docs, gen13+ and Arc prefer qsv while older is safest on +# vaapi, and qsv is not supported at all before gen8 +INTEL_QSV_MIN_GEN = 13 +INTEL_QSV_SUPPORTED_GEN = 8 + +# decode capable detection hardware, in recommendation priority order +DECODE_HARDWARE = ( + "onnx:nvidia", + "tensorrt", + "rknn", + "openvino:GPU", + "onnx:amd", + RASPBERRY_PI, +) + + +class HwaccelFamily(BaseModel): + """A kind of hardware decoding, and the presets that drive it.""" + + key: str = Field( + title="Family key", + description="Stable identifier for this kind of hardware decoding.", + ) + presets: dict[str, str] = Field( + title="Presets", + description="The ffmpeg preset for each codec this family decodes, or a single 'any' preset when it decodes every codec.", + ) + + +class HwaccelRecommendation(BaseModel): + """The hardware decoding this system can do.""" + + recommended: str = Field( + title="Recommended family", + description="Key of the family that fits this system best, or an empty string when none does.", + ) + available: list[HwaccelFamily] = Field( + default_factory=list, + title="Available families", + description="Every family this system's hardware can use, best first.", + ) + + +FAMILY_NVIDIA = HwaccelFamily(key="nvidia", presets={ANY_CODEC: FFMPEG_HWACCEL_NVIDIA}) +FAMILY_VAAPI = HwaccelFamily(key="vaapi", presets={ANY_CODEC: FFMPEG_HWACCEL_VAAPI}) +FAMILY_RKMPP = HwaccelFamily(key="rkmpp", presets={ANY_CODEC: FFMPEG_HWACCEL_RKMPP}) +FAMILY_QSV = HwaccelFamily( + key="intel-qsv", + presets={"h264": "preset-intel-qsv-h264", "h265": "preset-intel-qsv-h265"}, +) +FAMILY_JETSON = HwaccelFamily( + key="jetson", + presets={"h264": "preset-jetson-h264", "h265": "preset-jetson-h265"}, +) +FAMILY_RPI = HwaccelFamily( + key="rpi", + presets={"h264": "preset-rpi-64-h264", "h265": "preset-rpi-64-h265"}, +) + + +def _read(path: str) -> str | None: + """Read a small file, returning None if it cannot be read.""" + try: + with open(path) as f: + return f.read().strip() + except OSError: + return None + + +def _intel_generation() -> int | None: + """The Intel platform generation, or None when it cannot be determined.""" + # the xe driver only binds to the newest platforms (Arc and later iGPUs) + if "xe" in enumerate_drm_devices().values(): + return INTEL_GEN_LATEST + + cpuinfo = _read(f"{PROC_ROOT}/cpuinfo") or "" + + for line in cpuinfo.splitlines(): + if not line.startswith("model name"): + continue + + match = INTEL_GEN_PATTERN.search(line) + + if match: + return int(match.group(1)) + + if INTEL_ULTRA_PATTERN.search(line): + return INTEL_GEN_LATEST + + break + + return None + + +def _is_raspberry_pi() -> bool: + compatible = _read(f"{PROC_ROOT}/device-tree/compatible") or "" + return "raspberrypi" in compatible + + +def _intel_families(generation: int | None) -> list[HwaccelFamily]: + """vaapi drives every Intel GPU, qsv only those from gen8 on.""" + if generation is not None and generation < INTEL_QSV_SUPPORTED_GEN: + return [FAMILY_VAAPI] + + if generation is not None and generation >= INTEL_QSV_MIN_GEN: + return [FAMILY_QSV, FAMILY_VAAPI] + + return [FAMILY_VAAPI, FAMILY_QSV] + + +def _families(key: str, generation: int | None) -> list[HwaccelFamily]: + """Every family that can decode on this hardware, best first.""" + if key == "onnx:nvidia": + return [FAMILY_NVIDIA] + + if key == "tensorrt": + return [FAMILY_JETSON] + + if key == "rknn": + return [FAMILY_RKMPP] + + if key == "onnx:amd": + return [FAMILY_VAAPI] + + if key == RASPBERRY_PI: + return [FAMILY_RPI] + + if key == "openvino:GPU": + return _intel_families(generation) + + return [] + + +def _decodes(family: HwaccelFamily, codecs: set[str]) -> bool: + """Whether a family can decode every codec that is in use.""" + if ANY_CODEC in family.presets: + return True + + return all(codec in family.presets for codec in codecs) + + +def _decode_hardware(detector_key: str | None) -> list[str]: + """Decode capable hardware on this system, best first. + + Args: + detector_key: Hardware key of the detection hardware in use, whose GPU + is preferred over any other + + Returns: + The hardware keys that can decode video, in recommendation order + """ + present = {found.key for found in hardware_prober.probe()} + + if _is_raspberry_pi(): + present.add(RASPBERRY_PI) + + # an Intel NPU decodes through the iGPU next to it + if detector_key == "openvino:NPU": + detector_key = "openvino:GPU" + + ordered = [key for key in DECODE_HARDWARE if key in present] + + if detector_key in ordered: + ordered.remove(detector_key) + ordered.insert(0, detector_key) + + return ordered + + +def hwaccel_options( + detector_key: str | None = None, codecs: set[str] | None = None +) -> tuple[str, list[HwaccelFamily]]: + """Get the hardware decoding this system can do. + + Args: + detector_key: Hardware key of the detection hardware in use, which + biases the recommendation toward that hardware's GPU + codecs: Codecs of the streams that will be decoded, used to drop + families that cannot decode one of them + + Returns: + The recommended family key (empty when none fits) and every usable + family, best first + """ + wanted = {CODEC_ALIASES.get(codec, codec) for codec in codecs or set()} + hardware = _decode_hardware(detector_key) + generation = _intel_generation() if "openvino:GPU" in hardware else None + + available: list[HwaccelFamily] = [] + recommended = "" + + for key in hardware: + usable = [ + family for family in _families(key, generation) if _decodes(family, wanted) + ] + + if usable and not recommended: + recommended = _recommend(usable, bool(wanted)) + + for family in usable: + if family.key not in {entry.key for entry in available}: + available.append(family) + + return recommended, available + + +def _recommend(families: list[HwaccelFamily], codecs_known: bool) -> str: + """Pick the family to default to out of the ones this hardware can use.""" + if not codecs_known: + # a codec specific family would have to guess a codec for cameras + # that do not exist yet + for family in families: + if ANY_CODEC in family.presets: + return family.key + + return families[0].key + + +def recommend_hwaccel( + detector_key: str | None = None, codecs: set[str] | None = None +) -> str: + """Recommend a hardware decoding family for this system. + + Args: + detector_key: Hardware key of the detection hardware in use + codecs: Codecs of the streams that will be decoded + + Returns: + The key of the family that fits, or an empty string when none does + """ + return hwaccel_options(detector_key, codecs)[0] diff --git a/web/e2e/helpers/api-mocker.ts b/web/e2e/helpers/api-mocker.ts index cc062abf79..0663250c4e 100644 --- a/web/e2e/helpers/api-mocker.ts +++ b/web/e2e/helpers/api-mocker.ts @@ -43,6 +43,11 @@ export interface ApiMockOverrides { configRaw?: string; configSchema?: Record; hardware?: unknown[]; + hwaccel?: { + recommended: string; + available?: { key: string; presets: Record }[]; + }; + users?: { username: string; role: string }[]; } export class ApiMocker { @@ -185,6 +190,27 @@ export class ApiMocker { route.fulfill({ json: overrides?.hardware ?? DETECTION_HARDWARE }), ); + // Hwaccel preset recommendation + await this.page.route("**/api/hardware/hwaccel**", (route) => + route.fulfill({ + json: { + recommended: "", + available: [], + ...(overrides?.hwaccel ?? {}), + }, + }), + ); + + // Users. GET lists them; POST/PUT (create, password) just succeed, so + // tests assert on the intercepted request body instead of a response. + await this.page.route("**/api/users**", (route) => + route.request().method() === "GET" + ? route.fulfill({ + json: overrides?.users ?? [{ username: "admin", role: "admin" }], + }) + : route.fulfill({ json: { message: "ok" } }), + ); + // Go2RTC streams await this.page.route("**/api/go2rtc/streams**", (route) => route.fulfill({ json: {} }), diff --git a/web/e2e/helpers/setup-wizard.ts b/web/e2e/helpers/setup-wizard.ts new file mode 100644 index 0000000000..41cffdece4 --- /dev/null +++ b/web/e2e/helpers/setup-wizard.ts @@ -0,0 +1,51 @@ +/** + * Shared setup-wizard e2e helpers. + * + * The wizard shows when config has no cameras, so a first run is mocked by + * serving a camera-less config until the returned callback is fired. Firing + * it is only needed by tests that care what the rest of the app sees; the + * wizard itself tracks added cameras from the camera dialog's own callback. + */ + +import type { Page } from "@playwright/test"; +import { expect } from "../fixtures/frigate-test"; +import { configFactory } from "../fixtures/mock-data/config"; +import type { ApiMockOverrides } from "./api-mocker"; + +export async function installFirstRun( + frigateApp: { installDefaults: (o?: ApiMockOverrides) => Promise }, + page: Page, + overrides?: ApiMockOverrides, +): Promise<() => void> { + await frigateApp.installDefaults(overrides); + + const full = configFactory(overrides?.config); + let cameras: unknown = {}; + + await page.route("**/api/config", (route) => { + if (route.request().method() === "GET") { + return route.fulfill({ json: { ...full, cameras } }); + } + return route.fulfill({ json: { success: true } }); + }); + + return () => { + cameras = full.cameras; + }; +} + +export async function gotoDetectorStep(page: Page) { + await page.getByRole("button", { name: "Get Started" }).click(); + + // the account step sits between welcome and camera whenever auth is on, + // which the default mock config has it + await expect( + page.getByRole("heading", { name: "Secure your account" }), + ).toBeVisible(); + await page.getByRole("button", { name: "Skip" }).click(); + + await expect(page.getByText("Add Your First Camera")).toBeVisible(); + await page.getByRole("button", { name: "Skip" }).click(); + + await expect(page.getByText("Object Detection")).toBeVisible(); +} diff --git a/web/e2e/specs/setup/wizard-account.spec.ts b/web/e2e/specs/setup/wizard-account.spec.ts new file mode 100644 index 0000000000..df5e08995c --- /dev/null +++ b/web/e2e/specs/setup/wizard-account.spec.ts @@ -0,0 +1,196 @@ +/** + * Setup wizard account step -- HIGH tier. + * + * Covers the step's placement and gating, the password and user payloads it + * sends, the copy it shows when nobody is signed in (the internal port), and + * that skipping it writes nothing. + */ + +import { test, expect } from "../../fixtures/frigate-test"; +import type { Page } from "@playwright/test"; +import { installFirstRun } from "../../helpers/setup-wizard"; + +type Sent = { + method: string; + url: string; + body: Record | null; +}; + +async function captureUserCalls(page: Page): Promise { + const sent: Sent[] = []; + + await page.route("**/api/users**", (route) => { + const request = route.request(); + + if (request.method() === "GET") { + return route.fulfill({ json: [{ username: "admin", role: "admin" }] }); + } + + sent.push({ + method: request.method(), + url: request.url(), + body: request.postDataJSON(), + }); + return route.fulfill({ json: { message: "ok" } }); + }); + + return sent; +} + +async function gotoAccountStep(page: Page) { + await page.getByRole("button", { name: "Get Started" }).click(); + await expect( + page.getByRole("heading", { name: "Secure your account" }), + ).toBeVisible(); +} + +test.describe("setup wizard account @high @mobile", () => { + test("sets the admin password without an old password", async ({ + frigateApp, + page, + }) => { + await installFirstRun(frigateApp, page); + const sent = await captureUserCalls(page); + + await frigateApp.gotoAndWait("/", "text=Welcome to Frigate"); + await gotoAccountStep(page); + + await page.getByRole("button", { name: "Change password" }).click(); + + const dialog = page.getByRole("dialog"); + await expect(dialog).toBeVisible(); + // the dialog is in set-password mode, so it asks for no current password + await expect( + dialog.getByPlaceholder("Enter your current password"), + ).toBeHidden(); + await dialog + .getByPlaceholder("Enter new password", { exact: true }) + .fill("a-long-enough-password"); + await dialog + .getByPlaceholder("Re-enter new password") + .fill("a-long-enough-password"); + await dialog.getByRole("button", { name: "Save" }).click(); + + await expect(page.getByText("Password set")).toBeVisible(); + + const passwordCall = sent.find((call) => call.method === "PUT"); + expect(passwordCall?.url).toContain("/users/admin/password"); + // admins are exempt from the current-password check, so it must not be sent + expect(passwordCall?.body).toEqual({ password: "a-long-enough-password" }); + }); + + test("creates a user with a role", async ({ frigateApp, page }) => { + await installFirstRun(frigateApp, page); + const sent = await captureUserCalls(page); + + await frigateApp.gotoAndWait("/", "text=Welcome to Frigate"); + await gotoAccountStep(page); + + await page.getByRole("button", { name: "Add user" }).click(); + + await page.getByPlaceholder("Enter username").fill("family"); + await page + .getByPlaceholder("Enter password") + .fill("a-long-enough-password"); + await page + .getByPlaceholder("Confirm Password") + .fill("a-long-enough-password"); + await page.getByRole("button", { name: "Save" }).click(); + + const createCall = sent.find((call) => call.method === "POST"); + expect(createCall?.body).toEqual({ + username: "family", + password: "a-long-enough-password", + role: "viewer", + }); + }); + + test("shows anonymous copy when nobody is signed in", async ({ + frigateApp, + page, + }) => { + await installFirstRun(frigateApp, page, { + profile: { username: "anonymous", role: "admin", allowed_cameras: null }, + }); + await captureUserCalls(page); + + await frigateApp.gotoAndWait("/", "text=Welcome to Frigate"); + await gotoAccountStep(page); + + await expect(page.getByText("doesn't require a login")).toBeVisible(); + await expect(page.getByText("You're signed in as")).toBeHidden(); + }); + + test("is absent when native auth is disabled", async ({ + frigateApp, + page, + }) => { + await installFirstRun(frigateApp, page, { + config: { auth: { enabled: false } } as never, + }); + await captureUserCalls(page); + + await frigateApp.gotoAndWait("/", "text=Welcome to Frigate"); + await page.getByRole("button", { name: "Get Started" }).click(); + + // straight from welcome to the camera step, with no gap in the indicator + await expect(page.getByText("Add Your First Camera")).toBeVisible(); + await expect( + page.getByRole("heading", { name: "Secure your account" }), + ).toBeHidden(); + }); + + test("skipping sends nothing", async ({ frigateApp, page }) => { + await installFirstRun(frigateApp, page); + const sent = await captureUserCalls(page); + + await frigateApp.gotoAndWait("/", "text=Welcome to Frigate"); + await gotoAccountStep(page); + await page.getByRole("button", { name: "Skip" }).click(); + + await expect(page.getByText("Add Your First Camera")).toBeVisible(); + expect(sent).toHaveLength(0); + }); + test("an account change alone needs no restart", async ({ + frigateApp, + page, + }) => { + await installFirstRun(frigateApp, page); + await captureUserCalls(page); + + await frigateApp.gotoAndWait("/", "text=Welcome to Frigate"); + await gotoAccountStep(page); + + await page.getByRole("button", { name: "Change password" }).click(); + const dialog = page.getByRole("dialog"); + await dialog + .getByPlaceholder("Enter new password", { exact: true }) + .fill("a-long-enough-password"); + await dialog + .getByPlaceholder("Re-enter new password") + .fill("a-long-enough-password"); + await dialog.getByRole("button", { name: "Save" }).click(); + await expect(page.getByText("Password set")).toBeVisible(); + await page.getByRole("button", { name: "Next" }).click(); + + await expect(page.getByText("Add Your First Camera")).toBeVisible(); + await page.getByRole("button", { name: "Skip" }).click(); + + // every remaining step is passed without writing config: Skip on the + // detector, then Auto on hwaccel, which has nothing to derive and so + // saves nothing, then Skip on recording + await expect(page.getByText("Object Detection")).toBeVisible(); + await page.getByRole("button", { name: "Skip" }).click(); + await expect(page.getByText("Hardware Acceleration")).toBeVisible(); + await page.getByRole("button", { name: "Next" }).click(); + await page.getByRole("button", { name: "Skip" }).click(); + + await expect(page.getByText("You're done!")).toBeVisible(); + await expect( + page.getByRole("button", { name: "Go to Live View" }), + ).toBeVisible(); + await expect( + page.getByText("Frigate needs to restart to apply your settings"), + ).toBeHidden(); + }); +}); diff --git a/web/e2e/specs/setup/wizard-hardware.spec.ts b/web/e2e/specs/setup/wizard-hardware.spec.ts new file mode 100644 index 0000000000..a4b57c4444 --- /dev/null +++ b/web/e2e/specs/setup/wizard-hardware.spec.ts @@ -0,0 +1,255 @@ +/** + * Setup wizard hardware tests -- HIGH tier. + * + * Covers the detector step's probed radio list and the models: payload it + * writes, the model-required deferral for onnx hardware, the hwaccel step's + * Auto option writing the preset derived from the chosen hardware, and the + * completion screen only restarting when a saved step requires it. + */ + +import { test, expect } from "../../fixtures/frigate-test"; +import type { Page } from "@playwright/test"; +import { gotoDetectorStep, installFirstRun } from "../../helpers/setup-wizard"; + +const NVIDIA_HARDWARE = [ + { + key: "onnx:nvidia", + detector: "onnx", + name: "NVIDIA GeForce RTX 3060", + units: [{ device: "onnx:0", label: "NVIDIA GeForce RTX 3060" }], + count: 1, + unlimited: true, + }, + { + key: "cpu", + detector: "cpu", + name: "CPU", + units: [{ device: "cpu", label: "CPU" }], + count: 1, + unlimited: true, + }, +]; + +type SavedConfig = { + config_data?: { + models?: { devices: string[]; path?: string }[]; + detect?: { enabled?: boolean }; + ffmpeg?: { hwaccel_args?: string | string[] }; + }; +}; + +async function captureSaves(page: Page): Promise { + const saves: SavedConfig[] = []; + await page.route("**/api/config/set**", (route) => { + saves.push(route.request().postDataJSON() as SavedConfig); + return route.fulfill({ json: { success: true, require_restart: true } }); + }); + return saves; +} + +async function captureRestarts(page: Page): Promise { + const calls: string[] = []; + await page.route("**/api/restart", (route) => { + calls.push(route.request().url()); + return route.fulfill({ json: { success: true, message: "Restarting" } }); + }); + return calls; +} + +test.describe("setup wizard hardware @high @mobile", () => { + test("lists probed hardware and writes a models config", async ({ + frigateApp, + page, + }) => { + await installFirstRun(frigateApp, page, { + hwaccel: { + recommended: "vaapi", + available: [ + { key: "vaapi", presets: { any: "preset-vaapi" } }, + { + key: "intel-qsv", + presets: { + h264: "preset-intel-qsv-h264", + h265: "preset-intel-qsv-h265", + }, + }, + ], + }, + }); + const saves = await captureSaves(page); + + await frigateApp.gotoAndWait("/", "text=Welcome to Frigate"); + await gotoDetectorStep(page); + + // the default hardware mock reports two Corals, an Intel GPU, and the CPU + await expect( + page.getByRole("radio", { name: /Coral EdgeTPU \(PCIe\) \(2\)/ }), + ).toBeChecked(); + await expect(page.getByText("Recommended")).toBeVisible(); + + await page.getByRole("button", { name: "Next" }).click(); + + await expect(page.getByText("Hardware Acceleration")).toBeVisible(); + + const detectorSave = saves.find((save) => save.config_data?.models); + expect(detectorSave?.config_data?.models).toEqual([ + { devices: ["edgetpu:pci:0"] }, + ]); + expect(detectorSave?.config_data?.detect).toEqual({ enabled: true }); + + // VAAPI decodes any codec, so one global value covers every camera + await expect(page.getByText("Will use VAAPI (Intel/AMD)")).toBeVisible(); + await page.getByRole("button", { name: "Next" }).click(); + + const hwaccelSave = saves.find((save) => save.config_data?.ffmpeg); + expect(hwaccelSave?.config_data?.ffmpeg).toEqual({ + hwaccel_args: "preset-vaapi", + }); + + // the saved steps only take effect after a restart + const restarts = await captureRestarts(page); + await page.getByRole("button", { name: "Skip" }).click(); + await expect(page.getByText("You're done!")).toBeVisible(); + + await expect( + page.getByText("Frigate needs to restart to apply your settings"), + ).toBeVisible(); + await page.getByRole("button", { name: "Apply & Restart" }).click(); + + await expect(page.getByText("Starting Frigate...")).toBeVisible(); + expect(restarts).toHaveLength(1); + }); + + test("defers model setup for onnx hardware without Frigate+", async ({ + frigateApp, + page, + }) => { + await installFirstRun(frigateApp, page, { + hardware: NVIDIA_HARDWARE, + }); + const saves = await captureSaves(page); + + await frigateApp.gotoAndWait("/", "text=Welcome to Frigate"); + await gotoDetectorStep(page); + + await expect( + page.getByRole("radio", { name: /NVIDIA GeForce RTX 3060/ }), + ).toBeChecked(); + + await page + .getByRole("button", { name: "Continue without detection" }) + .click(); + + // advances without touching the config + await expect(page.getByText("Hardware Acceleration")).toBeVisible(); + expect(saves.filter((save) => save.config_data?.models)).toHaveLength(0); + + // nothing derived and nothing saved, so finishing needs no restart + const restarts = await captureRestarts(page); + await expect(page.getByText("No supported video card found")).toBeVisible(); + await page.getByRole("button", { name: "Next" }).click(); + await page.getByRole("button", { name: "Skip" }).click(); + await expect(page.getByText("You're done!")).toBeVisible(); + + await expect( + page.getByText("Frigate needs to restart to apply your settings"), + ).toBeHidden(); + await page.getByRole("button", { name: "Go to Live View" }).click(); + + // hands off without restarting, and the wizard does not come back + await expect(page.getByText("Welcome to Frigate")).toBeHidden(); + expect(restarts).toHaveLength(0); + }); + + test("offers only the presets the hardware supports", async ({ + frigateApp, + page, + }) => { + await installFirstRun(frigateApp, page, { + hardware: NVIDIA_HARDWARE, + hwaccel: { + recommended: "nvidia", + available: [{ key: "nvidia", presets: { any: "preset-nvidia" } }], + }, + }); + await captureSaves(page); + + await frigateApp.gotoAndWait("/", "text=Welcome to Frigate"); + await gotoDetectorStep(page); + await page + .getByRole("button", { name: "Continue without detection" }) + .click(); + await expect(page.getByText("Hardware Acceleration")).toBeVisible(); + + // an NVIDIA box has no business being offered Rockchip or Pi decoding + await expect( + page.getByRole("radio", { name: "CUDA (NVIDIA)" }), + ).toBeVisible(); + await expect( + page.getByRole("radio", { name: /Raspberry Pi/ }), + ).toBeHidden(); + await expect(page.getByRole("radio", { name: /Rockchip/ })).toBeHidden(); + + // Auto and None are always available + await expect(page.getByRole("radio", { name: "Auto" })).toBeVisible(); + await expect( + page.getByRole("radio", { name: "None (software decoding)" }), + ).toBeVisible(); + }); + + test("a codec specific family falls back to h264 with no cameras", async ({ + frigateApp, + page, + }) => { + await installFirstRun(frigateApp, page, { + hwaccel: { + recommended: "jetson", + available: [ + { + key: "jetson", + presets: { + h264: "preset-jetson-h264", + h265: "preset-jetson-h265", + }, + }, + ], + }, + }); + const saves = await captureSaves(page); + + await frigateApp.gotoAndWait("/", "text=Welcome to Frigate"); + await gotoDetectorStep(page); + await page.getByRole("button", { name: "Next" }).click(); + await expect(page.getByText("Hardware Acceleration")).toBeVisible(); + + await expect( + page.getByRole("radio", { name: "NVIDIA Jetson" }), + ).toBeVisible(); + await page.getByRole("button", { name: "Next" }).click(); + + // no camera was added, so there is no codec to match + const hwaccelSave = saves.find((save) => save.config_data?.ffmpeg); + expect(hwaccelSave?.config_data?.ffmpeg).toEqual({ + hwaccel_args: "preset-jetson-h264", + }); + }); + + test("None writes an explicit empty hwaccel list", async ({ + frigateApp, + page, + }) => { + await installFirstRun(frigateApp, page); + const saves = await captureSaves(page); + + await frigateApp.gotoAndWait("/", "text=Welcome to Frigate"); + await gotoDetectorStep(page); + await page.getByRole("button", { name: "Next" }).click(); + await expect(page.getByText("Hardware Acceleration")).toBeVisible(); + + await page.getByRole("radio", { name: "None (software decoding)" }).click(); + await page.getByRole("button", { name: "Next" }).click(); + + const hwaccelSave = saves.find((save) => save.config_data?.ffmpeg); + expect(hwaccelSave?.config_data?.ffmpeg).toEqual({ hwaccel_args: [] }); + }); +}); diff --git a/web/public/locales/en/views/setup.json b/web/public/locales/en/views/setup.json new file mode 100644 index 0000000000..00992397cf --- /dev/null +++ b/web/public/locales/en/views/setup.json @@ -0,0 +1,114 @@ +{ + "setupWizard": { + "steps": { + "welcome": "Welcome", + "account": "Account", + "camera": "Add Camera", + "hwaccel": "Acceleration", + "detector": "Detection", + "recording": "Recording", + "complete": "Done" + }, + "welcome": { + "title": "Welcome to Frigate", + "description": "Let's get your security cameras set up. We'll walk through camera connection, hardware settings, and recording.", + "getStarted": "Get Started", + "skipSetup": "Skip setup and configure manually" + }, + "account": { + "title": "Secure your account", + "descriptionSignedIn": "You're signed in as {{username}} using the temporary password from the Frigate logs. Set one you'll remember.", + "descriptionAnonymous": "You're accessing Frigate on a port that doesn't require a login. Set a password for the admin account so you can sign in on the secured port.", + "passwordSet": "Password set", + "changePassword": "Change password", + "addUser": "Add user", + "usersFailed": "Could not load the user list. You can still set the admin password.", + "userFailed": "Failed to add the user. Please try again." + }, + "camera": { + "title": "Add Your First Camera", + "description": "Connect a camera to start monitoring. You can also add more cameras later in Settings.", + "addCamera": "Add Camera", + "addAnother": "Add Another Camera", + "cameraAdded": "Camera added successfully", + "retry": "Try Again" + }, + "hwaccel": { + "title": "Hardware Acceleration", + "description": "Speed up video decoding with your GPU.", + "detecting": "Checking your hardware...", + "auto": "Auto", + "autoResolved": "Will use {{family}} for your cameras.", + "autoNone": "No supported video card found. Frigate will decide at startup.", + "recommendFailed": "Hardware detection is unavailable. Frigate will decide at startup.", + "families": { + "nvidia": "CUDA (NVIDIA)", + "vaapi": "VAAPI (Intel/AMD)", + "intel-qsv": "QuickSync (Intel)", + "rkmpp": "RKMPP (Rockchip)", + "jetson": "NVIDIA Jetson", + "rpi": "V4L2 (Raspberry Pi)", + "none": "None (software decoding)" + } + }, + "detector": { + "title": "Object Detection", + "description": "Choose the hardware Frigate uses to detect people and objects.", + "detecting": "Checking for detection hardware...", + "probeFailed": "Hardware detection is unavailable. You can configure detection later in Settings.", + "recommended": "Recommended", + "modelRequired": "{{name}} needs a detection model before it can run. Pick a Frigate+ model, or finish setup and add one under Settings > Detection models.", + "plusModelPlaceholder": "Select a Frigate+ model", + "continueWithout": "Continue without detection" + }, + "recording": { + "title": "Recordings", + "description": "Save video from your cameras so you can watch it later.", + "enableRecording": "Enable recordings", + "retentionDays": "Keep recordings for (days)", + "storageEstimate": "With {{free}} GB free, {{cameras}} camera(s) recording around the clock fills the disk in roughly {{days}} days.", + "noCameras": "You haven't added cameras yet. Recording will apply when you add cameras in Settings.", + "modeLabel": "What to record", + "modes": { + "events": { + "label": "Only when something is detected", + "description": "Saves video around people, cars, and other objects Frigate detects. Uses far less disk space." + }, + "continuous": { + "label": "All the time", + "description": "Saves video around the clock, so you can go back to any moment. Uses much more disk space." + } + }, + "retentionHint": { + "events": "Video of anything Frigate detects is kept this long, then deleted automatically.", + "continuous": "All video is kept this long, then deleted automatically." + } + }, + "complete": { + "title": "You're done!", + "description": "Your Frigate system is configured. Here's what we set up:", + "configured": "Configured", + "notConfigured": "Not configured", + "configureInSettings": "Configure in Settings", + "camera": "Camera", + "hwaccel": "Hardware Acceleration", + "detector": "Object Detection", + "recording": "Recording", + "goToLiveView": "Go to Live View", + "applyAndRestart": "Apply & Restart", + "restartNotice": "Frigate needs to restart to apply your settings. This takes about 30 seconds.", + "nextSteps": "Next steps: Set up motion masks, zones, and notifications in Settings.", + "restarting": "Starting Frigate...", + "restartingDescription": "This takes about 30 seconds." + }, + "actions": { + "next": "Next", + "back": "Back", + "skip": "Skip", + "saving": "Saving..." + }, + "errors": { + "saveFailed": "Failed to save configuration. Please try again." + } + } +} diff --git a/web/src/App.tsx b/web/src/App.tsx index 550bc36c81..f6d43188ff 100644 --- a/web/src/App.tsx +++ b/web/src/App.tsx @@ -6,7 +6,7 @@ import Sidebar from "@/components/navigation/Sidebar"; import { isDesktop, isMobile } from "react-device-detect"; import Statusbar from "./components/Statusbar"; import Bottombar from "./components/navigation/Bottombar"; -import { Suspense, lazy } from "react"; +import { Suspense, lazy, useContext, useEffect, useState } from "react"; import { Redirect } from "./components/navigation/Redirect"; import { cn } from "./lib/utils"; import { isPWA } from "./utils/isPWA"; @@ -15,6 +15,9 @@ import useSWR from "swr"; import { FrigateConfig } from "./types/frigateConfig"; import ActivityIndicator from "@/components/indicators/activity-indicator"; import { isRedirectingToLogin } from "@/api/auth-redirect"; +import { AuthContext } from "@/context/auth-context"; +import { useIsAdmin } from "@/hooks/use-is-admin"; +import { isSetupDismissed } from "@/utils/setupWizard"; const Live = lazy(() => import("@/pages/Live")); const Events = lazy(() => import("@/pages/Events")); @@ -30,6 +33,7 @@ const Chat = lazy(() => import("@/pages/Chat")); const Logs = lazy(() => import("@/pages/Logs")); const AccessDenied = lazy(() => import("@/pages/AccessDenied")); const Replay = lazy(() => import("@/pages/Replay")); +const SetupWizard = lazy(() => import("@/pages/SetupWizard")); function App() { const { data: config } = useSWR("config", { @@ -52,6 +56,24 @@ function DefaultAppView() { revalidateOnFocus: false, }); + // decided once per load: adding the first camera part way through the + // wizard must not pull the wizard out from under the user + const [showWizard, setShowWizard] = useState(); + const { auth } = useContext(AuthContext); + const isAdmin = useIsAdmin(); + + useEffect(() => { + // every step writes through admin only endpoints, and the role isn't + // known until the profile resolves + if (config && !auth.isLoading && showWizard === undefined) { + setShowWizard( + isAdmin && + Object.keys(config.cameras ?? {}).length === 0 && + !isSetupDismissed(), + ); + } + }, [config, auth.isLoading, isAdmin, showWizard]); + // Compute required roles for main routes, ensuring we have config first // to prevent race condition where custom roles are temporarily unavailable const mainRouteRoles = config?.auth?.roles @@ -68,6 +90,21 @@ function DefaultAppView() { ); } + // Show setup wizard for first-time users + if (showWizard) { + return ( +
+ + } + > + + +
+ ); + } + return (
{isDesktop && } diff --git a/web/src/components/settings/CameraWizardDialog.tsx b/web/src/components/settings/CameraWizardDialog.tsx index a033f3a693..f1cd4d8788 100644 --- a/web/src/components/settings/CameraWizardDialog.tsx +++ b/web/src/components/settings/CameraWizardDialog.tsx @@ -74,11 +74,14 @@ const STEPS = [ type CameraWizardDialogProps = { open: boolean; onClose: () => void; + // lets callers reuse what was probed here instead of probing again + onCameraAdded?: (camera: { name: string; detectCodec?: string }) => void; }; export default function CameraWizardDialog({ open, onClose, + onCameraAdded, }: CameraWizardDialogProps) { const { t } = useTranslation(["views/settings"]); const { mutate: updateConfig } = useSWR("config"); @@ -271,6 +274,13 @@ export default function CameraWizardDialog({ .put("config/set", requestBody) .then((response) => { if (response.status === 200) { + onCameraAdded?.({ + name: finalCameraName, + detectCodec: wizardData.streams?.find((stream) => + stream.roles.includes("detect"), + )?.testResult?.videoCodec, + }); + // Configure go2rtc streams for all streams if (wizardData.streams && wizardData.streams.length > 0) { const go2rtcStreams: Record = {}; @@ -393,7 +403,7 @@ export default function CameraWizardDialog({ setIsLoading(false); }); }, - [updateConfig, t, onClose], + [updateConfig, t, onClose, onCameraAdded], ); return ( diff --git a/web/src/components/setup/SetupAccount.tsx b/web/src/components/setup/SetupAccount.tsx new file mode 100644 index 0000000000..b4c6a8ecfd --- /dev/null +++ b/web/src/components/setup/SetupAccount.tsx @@ -0,0 +1,194 @@ +import ActivityIndicator from "@/components/indicators/activity-indicator"; +import CreateUserDialog from "@/components/overlay/CreateUserDialog"; +import SetPasswordDialog from "@/components/overlay/SetPasswordDialog"; +import { Button } from "@/components/ui/button"; +import { AuthContext } from "@/context/auth-context"; +import axios from "axios"; +import { useCallback, useContext, useState } from "react"; +import { useTranslation } from "react-i18next"; +import { FaCircleCheck } from "react-icons/fa6"; +import { toast } from "sonner"; +import useSWR from "swr"; + +type User = { + username: string; + role: string; +}; + +type SetupAccountProps = { + onNext: () => void; + onBack: () => void; + onSkip: () => void; +}; + +export default function SetupAccount({ + onNext, + onBack, + onSkip, +}: SetupAccountProps) { + const { t } = useTranslation(["views/setup"]); + const { auth } = useContext(AuthContext); + + const { + data: users, + isLoading, + error: usersError, + mutate: mutateUsers, + } = useSWR("users", { revalidateOnFocus: false }); + + // the internal port has no signed in user, so the built-in admin is the + // account being secured + const adminUsername = auth.isAuthenticated + ? (auth.user?.username ?? "admin") + : "admin"; + + const [showPassword, setShowPassword] = useState(false); + const [passwordError, setPasswordError] = useState(null); + const [passwordSaving, setPasswordSaving] = useState(false); + const [passwordSet, setPasswordSet] = useState(false); + const [showCreate, setShowCreate] = useState(false); + + const handleSavePassword = useCallback( + (password: string) => { + setPasswordSaving(true); + axios + .put(`users/${adminUsername}/password`, { password }) + .then(() => { + setShowPassword(false); + setPasswordError(null); + setPasswordSet(true); + }) + .catch((error) => { + setPasswordError( + error.response?.data?.message || + error.response?.data?.detail || + t("setupWizard.errors.saveFailed"), + ); + }) + .finally(() => setPasswordSaving(false)); + }, + [adminUsername, t], + ); + + const handleCreateUser = useCallback( + (username: string, password: string, role: string) => + axios + .post("users", { username, password, role }) + .then(() => { + setShowCreate(false); + mutateUsers(); + }) + .catch((error) => { + toast.error( + error.response?.data?.message || + error.response?.data?.detail || + t("setupWizard.account.userFailed"), + ); + }), + [mutateUsers, t], + ); + + const otherUsers = (users ?? []).filter( + (user) => user.username !== adminUsername, + ); + + return ( +
+
+

+ {t("setupWizard.account.title")} +

+

+ {auth.isAuthenticated + ? t("setupWizard.account.descriptionSignedIn", { + username: adminUsername, + }) + : t("setupWizard.account.descriptionAnonymous")} +

+
+ +
+
+
+ {adminUsername} + {passwordSet && ( + + + {t("setupWizard.account.passwordSet")} + + )} +
+ +
+ + {otherUsers.map((user) => ( +
+ {user.username} + {user.role} +
+ ))} +
+ + {isLoading && } + + {usersError && ( +

+ {t("setupWizard.account.usersFailed")} +

+ )} + +
+ +
+ +
+ +
+ + +
+
+ + {/* no username prop: passing one puts the dialog in current-password + mode, which the admin is exempt from and an anonymous internal port + user has no way to satisfy */} + { + setShowPassword(false); + setPasswordError(null); + }} + /> + + setShowCreate(false)} + /> +
+ ); +} diff --git a/web/src/components/setup/SetupCamera.tsx b/web/src/components/setup/SetupCamera.tsx new file mode 100644 index 0000000000..0276d62427 --- /dev/null +++ b/web/src/components/setup/SetupCamera.tsx @@ -0,0 +1,109 @@ +import CameraWizardDialog from "@/components/settings/CameraWizardDialog"; +import { Button } from "@/components/ui/button"; +import { useCallback, useState } from "react"; +import { useTranslation } from "react-i18next"; +import { FaCircleCheck } from "react-icons/fa6"; + +type SetupCameraProps = { + onNext: ( + cameraNames?: string[], + detectCodecs?: Record, + ) => void; + onBack: () => void; +}; + +export default function SetupCamera({ onNext, onBack }: SetupCameraProps) { + const { t } = useTranslation(["views/setup"]); + const [showWizard, setShowWizard] = useState(false); + const [addedCameras, setAddedCameras] = useState([]); + const [detectCodecs, setDetectCodecs] = useState>({}); + const handleClose = useCallback(() => { + setShowWizard(false); + }, []); + + // the dialog fires this once its config write has succeeded, which is the + // only reliable signal that a camera was added + const handleCameraAdded = useCallback( + ({ name, detectCodec }: { name: string; detectCodec?: string }) => { + setAddedCameras((previous) => + previous.includes(name) ? previous : [...previous, name], + ); + + if (detectCodec) { + setDetectCodecs((previous) => ({ ...previous, [name]: detectCodec })); + } + }, + [], + ); + + const handleNext = useCallback(() => { + onNext(addedCameras, detectCodecs); + }, [onNext, addedCameras, detectCodecs]); + + const handleSkip = useCallback(() => { + onNext(); + }, [onNext]); + + return ( + <> +
+
+

+ {t("setupWizard.camera.title")} +

+

+ {t("setupWizard.camera.description")} +

+
+ + {addedCameras.length > 0 && ( +
+ {addedCameras.map((name) => ( +
+ {name} + +
+ ))} +
+ )} + +
+ +
+ +
+ +
+ {addedCameras.length > 0 ? ( + + ) : ( + + )} +
+
+
+ + + ); +} diff --git a/web/src/components/setup/SetupComplete.tsx b/web/src/components/setup/SetupComplete.tsx new file mode 100644 index 0000000000..15a005fec2 --- /dev/null +++ b/web/src/components/setup/SetupComplete.tsx @@ -0,0 +1,209 @@ +import Logo from "@/components/Logo"; +import ActivityIndicator from "@/components/indicators/activity-indicator"; +import { Button } from "@/components/ui/button"; +import { useCallback, useEffect, useRef, useState } from "react"; +import { useTranslation } from "react-i18next"; +import { toast } from "sonner"; +import axios from "axios"; +import { FaCircleCheck } from "react-icons/fa6"; +import { dismissSetup } from "@/utils/setupWizard"; + +type ConfiguredItem = { + key: string; + label: string; + value: string | null; +}; + +type SetupCompleteProps = { + cameraNames: string[]; + configuredSteps: { + camera: boolean; + hwaccel: boolean; + detector: boolean; + recording: boolean; + }; + restartRequired: boolean; + onBack: () => void; +}; + +export default function SetupComplete({ + cameraNames, + configuredSteps, + restartRequired, + onBack, +}: SetupCompleteProps) { + const { t } = useTranslation(["views/setup"]); + const [restarting, setRestarting] = useState(false); + const [finishing, setFinishing] = useState(false); + const pollRef = useRef | null>(null); + + const cameraItems: ConfiguredItem[] = + configuredSteps.camera && cameraNames.length > 0 + ? cameraNames.map((name) => ({ + key: `camera-${name}`, + label: t("setupWizard.complete.camera"), + value: name, + })) + : [ + { + key: "camera", + label: t("setupWizard.complete.camera"), + value: null, + }, + ]; + + const items: ConfiguredItem[] = [ + ...cameraItems, + { + key: "hwaccel", + label: t("setupWizard.complete.hwaccel"), + value: configuredSteps.hwaccel + ? t("setupWizard.complete.configured") + : null, + }, + { + key: "detector", + label: t("setupWizard.complete.detector"), + value: configuredSteps.detector + ? t("setupWizard.complete.configured") + : null, + }, + { + key: "recording", + label: t("setupWizard.complete.recording"), + value: configuredSteps.recording + ? t("setupWizard.complete.configured") + : null, + }, + ]; + + useEffect(() => { + return () => { + if (pollRef.current) { + clearInterval(pollRef.current); + } + }; + }, []); + + const handleFinish = useCallback(async () => { + setFinishing(true); + dismissSetup(); + + try { + // camera adds were applied live, so nothing is waiting on a restart + if (!restartRequired) { + window.location.href = window.baseUrl || "/"; + return; + } + + setRestarting(true); + + await axios.post("restart"); + + let retries = 0; + const maxRetries = 60; // 2 minutes max + pollRef.current = setInterval(async () => { + retries++; + if (retries > maxRetries) { + if (pollRef.current) { + clearInterval(pollRef.current); + } + window.location.href = window.baseUrl || "/"; + return; + } + try { + const resp = await axios.get("version", { timeout: 2000 }); + if (resp.status === 200) { + if (pollRef.current) { + clearInterval(pollRef.current); + } + window.location.href = window.baseUrl || "/"; + } + } catch { + // not back yet + } + }, 2000); + } catch { + setRestarting(false); + setFinishing(false); + toast.error(t("setupWizard.errors.saveFailed")); + } + }, [restartRequired, t]); + + if (restarting) { + return ( +
+ + +
+

+ {t("setupWizard.complete.restarting")} +

+

+ {t("setupWizard.complete.restartingDescription")} +

+
+
+ ); + } + + return ( +
+
+

+ {t("setupWizard.complete.title")} +

+

+ {t("setupWizard.complete.description")} +

+
+ +
+ {items.map((item) => ( +
+ {item.label} +
+ {item.value && } + + {item.value ?? t("setupWizard.complete.notConfigured")} + +
+
+ ))} +
+ +

+ {t("setupWizard.complete.nextSteps")} +

+ + {restartRequired && ( +

+ {t("setupWizard.complete.restartNotice")} +

+ )} + +
+ +
+ +
+
+
+ ); +} diff --git a/web/src/components/setup/SetupDetector.tsx b/web/src/components/setup/SetupDetector.tsx new file mode 100644 index 0000000000..15f24cdf11 --- /dev/null +++ b/web/src/components/setup/SetupDetector.tsx @@ -0,0 +1,273 @@ +import ActivityIndicator from "@/components/indicators/activity-indicator"; +import type { FrigatePlusModel } from "@/components/config-form/theme/fields/ModelSourcePicker"; +import { Button } from "@/components/ui/button"; +import { RadioGroup, RadioGroupItem } from "@/components/ui/radio-group"; +import { + Select, + SelectContent, + SelectItem, + SelectTrigger, + SelectValue, +} from "@/components/ui/select"; +import { useDocDomain } from "@/hooks/use-doc-domain"; +import type { FrigateConfig } from "@/types/frigateConfig"; +import type { DetectionHardware } from "@/types/hardware"; +import { recommendedDetectorCount } from "@/utils/detectionHardware"; +import axios from "axios"; +import { useCallback, useMemo, useState } from "react"; +import { useTranslation } from "react-i18next"; +import { LuExternalLink } from "react-icons/lu"; +import { toast } from "sonner"; +import useSWR from "swr"; + +// these ship no default model, so configuring one without a model leaves the +// detector unable to start +const MODEL_REQUIRED_DETECTORS = ["onnx", "tensorrt"]; + +const CPU_FALLBACK: DetectionHardware[] = [ + { + key: "cpu", + detector: "cpu", + name: "CPU", + units: [{ device: "cpu", label: "CPU" }], + count: 1, + unlimited: true, + }, +]; + +type SetupDetectorProps = { + cameraCount: number; + onNext: (hardwareKey: string) => void; + onBack: () => void; + onSkip: (hardwareKey?: string) => void; +}; + +export default function SetupDetector({ + cameraCount, + onNext, + onBack, + onSkip, +}: SetupDetectorProps) { + const { t } = useTranslation(["views/setup", "common"]); + const { getLocaleDocUrl } = useDocDomain(); + + const { + data: hardware, + isLoading, + error: probeError, + } = useSWR("hardware/probe", { + revalidateOnFocus: false, + }); + + const { data: config } = useSWR("config", { + revalidateOnFocus: false, + }); + const plusEnabled = Boolean(config?.plus?.enabled); + + // the cpu is always probed, so an empty list means the probe failed + const options = useMemo( + () => (hardware && hardware.length > 0 ? hardware : CPU_FALLBACK), + [hardware], + ); + + // the prober orders accelerators ahead of the cpu + const recommendedKey = options[0].key; + const [selectedKey, setSelectedKey] = useState(); + const selected = + options.find((entry) => entry.key === (selectedKey ?? recommendedKey)) ?? + options[0]; + + const needsModel = MODEL_REQUIRED_DETECTORS.includes(selected.detector); + + const { data: plusModels } = useSWR( + plusEnabled && needsModel ? "/plus/models" : null, + { + fetcher: async (url) => { + const res = await axios.get(url, { withCredentials: true }); + return res.data; + }, + }, + ); + const [plusModelId, setPlusModelId] = useState(""); + + const compatiblePlusModels = useMemo( + () => + (plusModels ?? []).filter((model) => + model.supportedDetectors.includes(selected.detector), + ), + [plusModels, selected.detector], + ); + + const [saving, setSaving] = useState(false); + + const buildDevices = useCallback( + (entry: DetectionHardware): string[] => { + const first = entry.units[0]?.device; + + if (!first) { + return []; + } + + if (!entry.unlimited) { + return [first]; + } + + // repeating a device runs an extra inference process on it + const count = recommendedDetectorCount(Math.max(cameraCount, 1)); + return Array.from({ length: count }, () => first); + }, + [cameraCount], + ); + + const handleSave = useCallback(async () => { + if (needsModel && !plusModelId) { + onSkip(selected.key); + return; + } + + setSaving(true); + try { + const model: Record = { + devices: buildDevices(selected), + }; + + if (needsModel) { + model.path = `plus://${plusModelId}`; + } + + await axios.put("config/set", { + config_data: { + models: [model], + detect: { enabled: true }, + }, + requires_restart: 1, + }); + onNext(selected.key); + } catch { + toast.error(t("setupWizard.errors.saveFailed")); + } finally { + setSaving(false); + } + }, [needsModel, plusModelId, selected, buildDevices, onNext, onSkip, t]); + + if (isLoading) { + return ( +
+ +

+ {t("setupWizard.detector.detecting")} +

+
+ ); + } + + return ( +
+
+

+ {t("setupWizard.detector.title")} +

+

+ {t("setupWizard.detector.description")} +

+
+ + {probeError && ( +

+ {t("setupWizard.detector.probeFailed")} +

+ )} + + { + setSelectedKey(value); + setPlusModelId(""); + }} + > + {options.map((entry) => ( +
+ + +
+ ))} + + + {needsModel && ( +
+

+ {t("setupWizard.detector.modelRequired", { name: selected.name })} +

+ {plusEnabled ? ( + + ) : ( + + {t("readTheDocumentation", { ns: "common" })} + + + )} +
+ )} + +
+ +
+ + +
+
+
+ ); +} diff --git a/web/src/components/setup/SetupHwAccel.tsx b/web/src/components/setup/SetupHwAccel.tsx new file mode 100644 index 0000000000..a003ab2488 --- /dev/null +++ b/web/src/components/setup/SetupHwAccel.tsx @@ -0,0 +1,258 @@ +import ActivityIndicator from "@/components/indicators/activity-indicator"; +import { Button } from "@/components/ui/button"; +import { RadioGroup, RadioGroupItem } from "@/components/ui/radio-group"; +import type { HwaccelFamily, HwaccelRecommendation } from "@/types/hardware"; +import axios from "axios"; +import { useCallback, useMemo, useState } from "react"; +import { useTranslation } from "react-i18next"; +import { toast } from "sonner"; +import useSWR from "swr"; + +const AUTO = "auto"; +const NONE = "none"; + +const ANY_CODEC = "any"; + +// ffprobe names h265 streams hevc +const CODEC_ALIASES: Record = { hevc: "h265" }; + +function normalizeCodec(codec: string): string { + const lower = codec.toLowerCase(); + return CODEC_ALIASES[lower] ?? lower; +} + +type SetupHwAccelProps = { + detectorHardwareKey?: string; + // camera name -> detect stream codec, the only stream hwaccel applies to + detectCodecs: Record; + // saved tells the wizard whether finishing needs a restart + onNext: (saved: boolean) => void; + onBack: () => void; + onSkip: () => void; +}; + +export default function SetupHwAccel({ + detectorHardwareKey, + detectCodecs, + onNext, + onBack, + onSkip, +}: SetupHwAccelProps) { + const { t } = useTranslation(["views/setup"]); + + const cameraCodecs = useMemo( + () => + Object.entries(detectCodecs).map(([camera, codec]) => ({ + camera, + codec: normalizeCodec(codec), + })), + [detectCodecs], + ); + + const query = useMemo(() => { + const params = new URLSearchParams(); + + if (detectorHardwareKey) { + params.set("detector", detectorHardwareKey); + } + + const codecs = [...new Set(cameraCodecs.map((entry) => entry.codec))]; + + if (codecs.length > 0) { + params.set("codecs", codecs.join(",")); + } + + return params.toString(); + }, [detectorHardwareKey, cameraCodecs]); + + const { + data: recommendation, + isLoading, + error: recommendError, + } = useSWR( + query ? `hardware/hwaccel?${query}` : "hardware/hwaccel", + { revalidateOnFocus: false }, + ); + + const [selected, setSelected] = useState(AUTO); + const [saving, setSaving] = useState(false); + + const families = useMemo( + () => recommendation?.available ?? [], + [recommendation], + ); + const derived = recommendation?.recommended ?? ""; + + /** The config a family should be saved as, or null when it writes nothing. */ + const configFor = useCallback( + (family: HwaccelFamily | undefined): Record | null => { + if (!family) { + return null; + } + + const shared = family.presets[ANY_CODEC]; + + if (shared) { + return { ffmpeg: { hwaccel_args: shared } }; + } + + const perCamera = cameraCodecs + .map((entry) => ({ ...entry, preset: family.presets[entry.codec] })) + .filter((entry) => entry.preset); + + if (perCamera.length === 0) { + const fallback = Object.values(family.presets)[0]; + return fallback ? { ffmpeg: { hwaccel_args: fallback } } : null; + } + + const presets = new Set(perCamera.map((entry) => entry.preset)); + + if (presets.size === 1 && perCamera.length === cameraCodecs.length) { + return { ffmpeg: { hwaccel_args: [...presets][0] } }; + } + + // the global stays on auto so cameras added later resolve at startup + // instead of inheriting one camera's codec + return { + cameras: Object.fromEntries( + perCamera.map((entry) => [ + entry.camera, + { ffmpeg: { hwaccel_args: entry.preset } }, + ]), + ), + }; + }, + [cameraCodecs], + ); + + const handleSave = useCallback(async () => { + const key = selected === AUTO ? derived : selected; + + const configData = + selected === NONE + ? // an empty string would make config/set delete the key, reviving + // the "auto" default + { ffmpeg: { hwaccel_args: [] } } + : configFor(families.find((family) => family.key === key)); + + // nothing to write leaves the config default of "auto" in place + if (!configData) { + onNext(false); + return; + } + + setSaving(true); + try { + await axios.put("config/set", { + config_data: configData, + requires_restart: 1, + }); + onNext(true); + } catch { + toast.error(t("setupWizard.errors.saveFailed")); + } finally { + setSaving(false); + } + }, [selected, derived, families, configFor, onNext, t]); + + if (isLoading) { + return ( +
+ +

+ {t("setupWizard.hwaccel.detecting")} +

+
+ ); + } + + const radioClass = (value: string) => + selected === value + ? "bg-selected from-selected/50 to-selected/90 text-selected" + : "bg-secondary from-secondary/50 to-secondary/90 text-secondary"; + + return ( +
+
+

+ {t("setupWizard.hwaccel.title")} +

+

+ {t("setupWizard.hwaccel.description")} +

+
+ + +
+
+ + +
+

+ {derived + ? t("setupWizard.hwaccel.autoResolved", { + family: t(`setupWizard.hwaccel.families.${derived}`), + }) + : recommendError + ? t("setupWizard.hwaccel.recommendFailed") + : t("setupWizard.hwaccel.autoNone")} +

+
+ + {families.map((family) => ( +
+ + +
+ ))} + +
+ + +
+ + +
+ +
+ + +
+
+
+ ); +} diff --git a/web/src/components/setup/SetupRecording.tsx b/web/src/components/setup/SetupRecording.tsx new file mode 100644 index 0000000000..2927b6be7d --- /dev/null +++ b/web/src/components/setup/SetupRecording.tsx @@ -0,0 +1,189 @@ +import { Button } from "@/components/ui/button"; +import { Input } from "@/components/ui/input"; +import { Label } from "@/components/ui/label"; +import { RadioGroup, RadioGroupItem } from "@/components/ui/radio-group"; +import { Switch } from "@/components/ui/switch"; +import { useCallback, useState } from "react"; +import { useTranslation } from "react-i18next"; +import { toast } from "sonner"; +import axios from "axios"; +import useSWR from "swr"; + +const EVENTS = "events"; +const CONTINUOUS = "continuous"; + +const MODES = [EVENTS, CONTINUOUS] as const; + +type SetupRecordingProps = { + cameraNames: string[]; + onNext: () => void; + onBack: () => void; + onSkip: () => void; +}; + +export default function SetupRecording({ + cameraNames, + onNext, + onBack, + onSkip, +}: SetupRecordingProps) { + const { t } = useTranslation(["views/setup"]); + const [enabled, setEnabled] = useState(true); + const [mode, setMode] = useState(EVENTS); + const [retentionDays, setRetentionDays] = useState(10); + const [saving, setSaving] = useState(false); + + const { data: stats } = useSWR("stats", { revalidateOnFocus: false }); + + const storageInfo = stats?.service?.storage?.["/tmp/frigate/recordings"]; + const freeGb = storageInfo ? Math.round(storageInfo.free / 1024) : null; + const cameraCount = cameraNames.length; + // Rough estimate: ~2 Mbps per camera continuous recording + const estimatedDays = + freeGb && cameraCount > 0 + ? Math.round((freeGb * 1024) / ((2 * 0.125 * 86400) / 1024) / cameraCount) + : null; + + const handleSave = useCallback(async () => { + setSaving(true); + try { + const record: Record = { enabled }; + + if (enabled) { + record.alerts = { retain: { days: retentionDays } }; + record.detections = { retain: { days: retentionDays } }; + // written even when off, so switching modes back turns it off again + record.continuous = { days: mode === CONTINUOUS ? retentionDays : 0 }; + } + + await axios.put("config/set", { + config_data: { record }, + requires_restart: 1, + }); + onNext(); + } catch { + toast.error(t("setupWizard.errors.saveFailed")); + } finally { + setSaving(false); + } + }, [enabled, mode, retentionDays, onNext, t]); + + return ( +
+
+

+ {t("setupWizard.recording.title")} +

+

+ {t("setupWizard.recording.description")} +

+
+ + {cameraCount === 0 && ( +

+ {t("setupWizard.recording.noCameras")} +

+ )} + +
+ + +
+ + {enabled && ( + <> +
+ + + {MODES.map((option) => ( +
+
+ + +
+

+ {t(`setupWizard.recording.modes.${option}.description`)} +

+
+ ))} + +
+ +
+ + + setRetentionDays(Math.max(1, parseInt(e.target.value) || 1)) + } + /> +

+ {t(`setupWizard.recording.retentionHint.${mode}`)} +

+
+ + {mode === CONTINUOUS && + freeGb !== null && + estimatedDays !== null && + cameraCount > 0 && ( +

+ {t("setupWizard.recording.storageEstimate", { + free: freeGb, + days: estimatedDays, + cameras: cameraCount, + })} +

+ )} + + )} + +
+ +
+ + +
+
+
+ ); +} diff --git a/web/src/components/setup/SetupWelcome.tsx b/web/src/components/setup/SetupWelcome.tsx new file mode 100644 index 0000000000..cea818db65 --- /dev/null +++ b/web/src/components/setup/SetupWelcome.tsx @@ -0,0 +1,37 @@ +import Logo from "@/components/Logo"; +import { Button } from "@/components/ui/button"; +import { useTranslation } from "react-i18next"; + +type SetupWelcomeProps = { + onNext: () => void; + onSkip: () => void; +}; + +export default function SetupWelcome({ onNext, onSkip }: SetupWelcomeProps) { + const { t } = useTranslation(["views/setup"]); + + return ( +
+ +
+

+ {t("setupWizard.welcome.title")} +

+

+ {t("setupWizard.welcome.description")} +

+
+
+ + +
+
+ ); +} diff --git a/web/src/pages/SetupWizard.tsx b/web/src/pages/SetupWizard.tsx new file mode 100644 index 0000000000..cc76572aa7 --- /dev/null +++ b/web/src/pages/SetupWizard.tsx @@ -0,0 +1,284 @@ +import StepIndicator from "@/components/indicators/StepIndicator"; +import SetupAccount from "@/components/setup/SetupAccount"; +import SetupCamera from "@/components/setup/SetupCamera"; +import SetupComplete from "@/components/setup/SetupComplete"; +import SetupDetector from "@/components/setup/SetupDetector"; +import SetupHwAccel from "@/components/setup/SetupHwAccel"; +import SetupRecording from "@/components/setup/SetupRecording"; +import SetupWelcome from "@/components/setup/SetupWelcome"; +import { Button } from "@/components/ui/button"; +import { Card, CardContent } from "@/components/ui/card"; +import { useTheme } from "@/context/theme-provider"; +import { FrigateConfig } from "@/types/frigateConfig"; +import { dismissSetup } from "@/utils/setupWizard"; +import { useCallback, useMemo, useReducer } from "react"; +import { useTranslation } from "react-i18next"; +import { LuMoon, LuSun } from "react-icons/lu"; +import useSWR from "swr"; + +type StepKey = + | "welcome" + | "account" + | "camera" + | "detector" + | "hwaccel" + | "recording" + | "complete"; + +const STEP_KEYS: StepKey[] = [ + "welcome", + "account", + "camera", + "detector", + "hwaccel", + "recording", + "complete", +]; + +type WizardState = { + currentStep: number; + cameraNames: string[]; + detectorHardwareKey?: string; + // camera name -> detect stream codec + detectCodecs: Record; + // camera adds apply live, so they don't count toward needing a restart + restartRequired: boolean; + configuredSteps: { + camera: boolean; + hwaccel: boolean; + detector: boolean; + recording: boolean; + }; +}; + +type WizardAction = + | { type: "NEXT_STEP" } + | { type: "PREV_STEP" } + | { + type: "CAMERAS_ADDED"; + cameraNames: string[]; + detectCodecs: Record; + } + | { + type: "STEP_CONFIGURED"; + step: keyof WizardState["configuredSteps"]; + savedConfig: boolean; + } + | { type: "DETECTOR_DONE"; configured: boolean; hardwareKey?: string } + | { type: "SKIP_STEP" }; + +const initialState: WizardState = { + currentStep: 0, + cameraNames: [], + detectCodecs: {}, + restartRequired: false, + configuredSteps: { + camera: false, + hwaccel: false, + detector: false, + recording: false, + }, +}; + +function wizardReducer(state: WizardState, action: WizardAction): WizardState { + switch (action.type) { + case "NEXT_STEP": + return { ...state, currentStep: state.currentStep + 1 }; + case "PREV_STEP": + return { + ...state, + currentStep: Math.max(0, state.currentStep - 1), + }; + case "CAMERAS_ADDED": + return { + ...state, + currentStep: state.currentStep + 1, + cameraNames: action.cameraNames, + detectCodecs: action.detectCodecs, + configuredSteps: { ...state.configuredSteps, camera: true }, + }; + case "STEP_CONFIGURED": + return { + ...state, + currentStep: state.currentStep + 1, + restartRequired: state.restartRequired || action.savedConfig, + configuredSteps: { ...state.configuredSteps, [action.step]: true }, + }; + case "DETECTOR_DONE": + return { + ...state, + currentStep: state.currentStep + 1, + detectorHardwareKey: action.hardwareKey ?? state.detectorHardwareKey, + restartRequired: state.restartRequired || action.configured, + configuredSteps: { + ...state.configuredSteps, + detector: state.configuredSteps.detector || action.configured, + }, + }; + case "SKIP_STEP": + return { ...state, currentStep: state.currentStep + 1 }; + default: + return state; + } +} + +export default function SetupWizard() { + const { t } = useTranslation(["views/setup", "common"]); + const [state, dispatch] = useReducer(wizardReducer, initialState); + const { theme, systemTheme, setTheme } = useTheme(); + + const { data: config } = useSWR("config", { + revalidateOnFocus: false, + }); + + // with native auth off there are no users to manage, so the step would lie + const steps = useMemo( + () => + config?.auth?.enabled === false + ? STEP_KEYS.filter((key) => key !== "account") + : STEP_KEYS, + [config], + ); + const stepLabels = useMemo( + () => steps.map((key) => `setupWizard.steps.${key}`), + [steps], + ); + + const isDark = (theme === "system" ? systemTheme : theme) === "dark"; + + const handleSkipSetup = useCallback(() => { + dismissSetup(); + window.location.href = window.baseUrl || "/"; + }, []); + + const handleCameraNext = useCallback( + (cameraNames?: string[], detectCodecs?: Record) => { + if (cameraNames && cameraNames.length > 0) { + dispatch({ + type: "CAMERAS_ADDED", + cameraNames, + detectCodecs: detectCodecs ?? {}, + }); + } else { + dispatch({ type: "SKIP_STEP" }); + } + }, + [], + ); + + const handleHwAccelNext = useCallback((saved: boolean) => { + dispatch({ type: "STEP_CONFIGURED", step: "hwaccel", savedConfig: saved }); + }, []); + + const handleDetectorNext = useCallback((hardwareKey: string) => { + dispatch({ type: "DETECTOR_DONE", configured: true, hardwareKey }); + }, []); + + const handleDetectorSkip = useCallback((hardwareKey?: string) => { + dispatch({ type: "DETECTOR_DONE", configured: false, hardwareKey }); + }, []); + + const handleRecordingNext = useCallback(() => { + dispatch({ type: "STEP_CONFIGURED", step: "recording", savedConfig: true }); + }, []); + + const handleBack = useCallback(() => { + dispatch({ type: "PREV_STEP" }); + }, []); + + const handleSkipStep = useCallback(() => { + dispatch({ type: "SKIP_STEP" }); + }, []); + + const renderStep = () => { + switch (steps[state.currentStep]) { + case "welcome": + return ( + dispatch({ type: "NEXT_STEP" })} + onSkip={handleSkipSetup} + /> + ); + case "account": + return ( + + ); + case "camera": + return ; + case "detector": + return ( + + ); + case "hwaccel": + return ( + + ); + case "recording": + return ( + + ); + case "complete": + return ( + + ); + default: + return null; + } + }; + + return ( +
+ + + + + + +
{renderStep()}
+ + +
+ ); +} diff --git a/web/src/types/hardware.ts b/web/src/types/hardware.ts index e77de8cd93..254e27ce6c 100644 --- a/web/src/types/hardware.ts +++ b/web/src/types/hardware.ts @@ -11,3 +11,14 @@ export type DetectionHardware = { count: number; unlimited: boolean; }; + +export type HwaccelFamily = { + key: string; + // keyed by codec, or a single "any" preset when it decodes every codec + presets: Record; +}; + +export type HwaccelRecommendation = { + recommended: string; + available: HwaccelFamily[]; +}; diff --git a/web/src/utils/setupWizard.ts b/web/src/utils/setupWizard.ts new file mode 100644 index 0000000000..50e6734b59 --- /dev/null +++ b/web/src/utils/setupWizard.ts @@ -0,0 +1,19 @@ +// dismissing the setup wizard is per-device UI state, so it lives in the +// browser rather than in the config the wizard exists to write +const DISMISSED_KEY = "frigate-setup-dismissed"; + +export function isSetupDismissed(): boolean { + try { + return localStorage.getItem(DISMISSED_KEY) === "true"; + } catch { + return false; + } +} + +export function dismissSetup(): void { + try { + localStorage.setItem(DISMISSED_KEY, "true"); + } catch { + // storage can be unavailable; showing the wizard again beats failing here + } +}