From 0009cb08c80740426f0593e246f6b8b5e488dfde Mon Sep 17 00:00:00 2001 From: Nicolas Mowen Date: Thu, 5 Jan 2023 15:00:43 -0700 Subject: [PATCH] Add tables for ffmpeg presets and how to use them --- docs/docs/configuration/ffmpeg_presets.md | 47 +++++++++++++++++++++-- 1 file changed, 44 insertions(+), 3 deletions(-) diff --git a/docs/docs/configuration/ffmpeg_presets.md b/docs/docs/configuration/ffmpeg_presets.md index 2308553ed..0a966d702 100644 --- a/docs/docs/configuration/ffmpeg_presets.md +++ b/docs/docs/configuration/ffmpeg_presets.md @@ -5,6 +5,47 @@ title: FFmpeg presets Some presets of FFmpeg args are provided by default to make the configuration easier. All presets can be seen in [this file](https://github.com/blakeblackshear/frigate/blob/master/frigate/ffmpeg_presets.py). - +### Hwaccel Presets + +It is highly recommended to use hwaccel presets in the config. These presets not only replace the longer args, but they also give frigate hints of what hardware is available and allows frigate to make other optimizations using the GPU such as when encoding the birdseye restream or when scaling a stream that has a size different than the native stream size. + +See [the hwaccel docs](/configuration/hardware_acceleration.md) for more info on how to setup hwaccel for your GPU / iGPU. + +| Preset | Usage | Other Notes | +| --------------------- | ---------------------------- | ----------------------------------------------------- | +| preset-rpi-32-h264 | 32 bit Rpi with h264 stream | | +| preset-rpi-64-h264 | 64 bit Rpi with h264 stream | | +| preset-vaapi | Intel & AMD VAAPI | Check hwaccel docs to ensure correct driver is chosen | +| preset-intel-qsv-h264 | Intel QSV with h264 stream | If issues occur recommend using vaapi preset instead | +| preset-intel-qsv-h265 | Intel QSV with h265 stream | If issues occur recommend using vaapi preset instead | +| preset-nvidia-h264 | Nvidia GPU with h264 stream | | +| preset-nvidia-h265 | Nvidia GPU with h265 stream | | +| preset-nvidia-mjpeg | Nvidia GPU with mjpeg stream | Recommend restreaming mjpeg and using nvidia-h264 | + +### Input Args Presets + +Input args presets help make the config more readable and handle usecases for differnet types of streams to ensure maximum compatibility. + +See [the camera specific docs](/configuration/camera_specific.md) for more info on non-standard cameras and recommendations for using them in frigate. + +| Preset | Usage | Other Notes | +| ------------------------- | ----------------------- | --------------------------------------------------- | +| preset-http-jpeg-generic | HTTP Live Jpeg | Recommend restreaming live jpeg instead | +| preset-http-mjpeg-generic | HTTP Mjpeg Stream | Recommend restreaming mjpeg stream instead | +| preset-http-reolink | Reolink HTTP-FLV Stream | Only for reolink http, not when restreaming as rtsp | +| preset-rtmp-generic | RTMP Stream | | +| preset-rtsp-generic | RTSP Stream | This is the default when nothing is specified | +| preset-rtsp-udp | RTSP Stream via UDP | Use when camera is UDP only | +| preset-rtsp-blue-iris | Blue Iris RTSP Stream | Use when consuming a strema from Blue Iris | + +### Output Args Presets + +Output args presets help make the config more readable and handle usecases for different types of streams to ensure consistent recordings. + +| Preset | Usage | Other Notes | +| --------------------------- | --------------------------------- | --------------------------------------------- | +| preset-record-generic | Record WITHOUT audio | This is the default when nothing is specified | +| preset-record-generic-audio | Record WITH audio | Use this to enable audio in recordings | +| preset-record-mjpeg | Record an mjpeg stream | Recommend restreaming mjpeg stream instead | +| preset-record-jpeg | Record live jpeg | Recommend restreaming live jpeg instead | +| preset-record-ubiquiti | Record ubiquiti stream with audio | Recordings with ubiquiti non-standard audio |