Skip to content

Commit 740d932

Browse files
NickM-27NateMeyerblakeblackshear
authored
Add ffmpeg presets docs and update nvidia-smi docs (blakeblackshear#4928)
* Add tables for ffmpeg presets and how to use them * Make it clear that ffmepg processes may not show when nvidia-smi is run inside the container * Add specific example of mixed input arg presets * Update docs/docs/configuration/ffmpeg_presets.md Co-authored-by: Nate Meyer <[email protected]> * typos Co-authored-by: Nate Meyer <[email protected]> Co-authored-by: Blake Blackshear <[email protected]>
1 parent e645c8e commit 740d932

File tree

2 files changed

+75
-4
lines changed

2 files changed

+75
-4
lines changed

‎docs/docs/configuration/ffmpeg_presets.md

+68-3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,71 @@ title: FFmpeg presets
55

66
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).
77

8-
<!--
9-
TODO: Use [markdown-magic](https://github.com/DavidWells/markdown-magic) to generate this list from the source code.
10-
-->
8+
### Hwaccel Presets
9+
10+
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.
11+
12+
See [the hwaccel docs](/configuration/hardware_acceleration.md) for more info on how to setup hwaccel for your GPU / iGPU.
13+
14+
| Preset | Usage | Other Notes |
15+
| --------------------- | ---------------------------- | ----------------------------------------------------- |
16+
| preset-rpi-32-h264 | 32 bit Rpi with h264 stream | |
17+
| preset-rpi-64-h264 | 64 bit Rpi with h264 stream | |
18+
| preset-vaapi | Intel & AMD VAAPI | Check hwaccel docs to ensure correct driver is chosen |
19+
| preset-intel-qsv-h264 | Intel QSV with h264 stream | If issues occur recommend using vaapi preset instead |
20+
| preset-intel-qsv-h265 | Intel QSV with h265 stream | If issues occur recommend using vaapi preset instead |
21+
| preset-nvidia-h264 | Nvidia GPU with h264 stream | |
22+
| preset-nvidia-h265 | Nvidia GPU with h265 stream | |
23+
| preset-nvidia-mjpeg | Nvidia GPU with mjpeg stream | Recommend restreaming mjpeg and using nvidia-h264 |
24+
25+
### Input Args Presets
26+
27+
Input args presets help make the config more readable and handle use cases for different types of streams to ensure maximum compatibility.
28+
29+
See [the camera specific docs](/configuration/camera_specific.md) for more info on non-standard cameras and recommendations for using them in frigate.
30+
31+
| Preset | Usage | Other Notes |
32+
| ------------------------- | ----------------------- | --------------------------------------------------- |
33+
| preset-http-jpeg-generic | HTTP Live Jpeg | Recommend restreaming live jpeg instead |
34+
| preset-http-mjpeg-generic | HTTP Mjpeg Stream | Recommend restreaming mjpeg stream instead |
35+
| preset-http-reolink | Reolink HTTP-FLV Stream | Only for reolink http, not when restreaming as rtsp |
36+
| preset-rtmp-generic | RTMP Stream | |
37+
| preset-rtsp-generic | RTSP Stream | This is the default when nothing is specified |
38+
| preset-rtsp-udp | RTSP Stream via UDP | Use when camera is UDP only |
39+
| preset-rtsp-blue-iris | Blue Iris RTSP Stream | Use when consuming a stream from Blue Iris |
40+
41+
:::caution
42+
43+
It is important to be mindful of input args when using restream because you can have a mix of protocols. `http` and `rtmp` presets cannot be used with `rtsp` streams. For example, when using a reolink cam with the rtsp restream as a source for record the preset-http-reolink will cause a crash. In this case presets will need to be set at the stream level. See the example below.
44+
45+
:::
46+
47+
```yaml
48+
cameras:
49+
reolink_cam:
50+
ffmpeg:
51+
inputs:
52+
- path: http://192.168.0.139/flv?port=1935&app=bcs&stream=channel0_ext.bcs&user=admin&password={FRIGATE_CAM_PASSWORD}
53+
input_args: preset-http-reolink
54+
roles:
55+
- detect
56+
- path: rtsp://192.168.0.10:8554/garage
57+
input_args: preset-rtsp-generic
58+
roles:
59+
- record
60+
- path: http://192.168.0.139/flv?port=1935&app=bcs&stream=channel0_main.bcs&user=admin&password={FRIGATE_CAM_PASSWORD}
61+
roles:
62+
- restream
63+
```
64+
65+
### Output Args Presets
66+
67+
Output args presets help make the config more readable and handle use cases for different types of streams to ensure consistent recordings.
68+
69+
| Preset | Usage | Other Notes |
70+
| --------------------------- | --------------------------------- | --------------------------------------------- |
71+
| preset-record-generic | Record WITHOUT audio | This is the default when nothing is specified |
72+
| preset-record-generic-audio | Record WITH audio | Use this to enable audio in recordings |
73+
| preset-record-mjpeg | Record an mjpeg stream | Recommend restreaming mjpeg stream instead |
74+
| preset-record-jpeg | Record live jpeg | Recommend restreaming live jpeg instead |
75+
| preset-record-ubiquiti | Record ubiquiti stream with audio | Recordings with ubiquiti non-standard audio |

‎docs/docs/configuration/hardware_acceleration.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,15 @@ ffmpeg:
9393
```
9494

9595
If everything is working correctly, you should see a significant improvement in performance.
96-
Verify that hardware decoding is working by running `docker exec -it frigate nvidia-smi`, which should show the ffmpeg
96+
Verify that hardware decoding is working by running `nvidia-smi`, which should show the ffmpeg
9797
processes:
9898

99+
:::note
100+
101+
nvidia-smi may not show ffmpeg processes when run inside the container [due to docker limitations](https://github.com/NVIDIA/nvidia-docker/issues/179#issuecomment-645579458)
102+
103+
:::
104+
99105
```
100106
+-----------------------------------------------------------------------------+
101107
| NVIDIA-SMI 455.38 Driver Version: 455.38 CUDA Version: 11.1 |

0 commit comments

Comments
 (0)