update readme

This commit is contained in:
jb-alvarado 2022-09-05 17:35:12 +02:00
parent c147e00b13
commit a80f474de5
3 changed files with 31 additions and 5 deletions

View File

@ -117,10 +117,13 @@ text:
out:
help_text: The final playout compression. Set the settings to your needs. 'mode'
has the options 'desktop', 'hls', 'null', 'stream'. Use 'stream' and adjust
'output_param:' settings when you want to stream to a rtmp/rtsp/srt/... server.
In production don't serve hls playlist with ffpapi, use nginx or another web server!
mode: hls
has the options 'desktop', 'hls', 'null', 'stream'. In 'custom_filter' it is possible
to define custom ffmpeg filters. They need to end with [c_v_out] for video filter,
and [c_a_out] for audio filter. Use 'stream' and adjust 'output_param:' settings when
you want to stream to a rtmp/rtsp/srt/... server. In production don't serve hls
playlist with ffpapi, use nginx or another web server!
mode: desktop
custom_filter:
output_param: >-
-c:v libx264
-crf 23

View File

@ -28,3 +28,26 @@ custom_filter: edgedetect=mode=colormix:high=0[c_v_out]
Check ffmpeg [filters](https://ffmpeg.org/ffmpeg-filters.html) documentation, and find out which other filters ffmpeg has.
### Where the filters applied in stream mode
The **custom filter** from **config -> processing** and from **playlist** got applied in the _decoder_ instance on every file:
```
+-------------------------------------+ PIPE +------------------------+
File -> | Decoder / Filtering / custom filter |------------| Encoder / text overlay | -> Output
Loop +-------------------------------------+ +------------------------+
```
The **custom filter** from **config -> out** got applied on the encoder side:
```
+---------------------+ PIPE +----------------------------------------+
File -> | Decoder / Filtering |------------| Encoder / text overlay / custom filter | -> Output
Loop +---------------------+ +----------------------------------------+
```
#### When which one to take
* If you want to use for every clip a different filter chain, you should use the custom filter parameter from **playlist**.
* When you want to use the same filter for every clip you can use the custom filter from **config -> processing**.
* If you need a global filter for all clips, which has movements, like a animated logo, or different lower thirds, you should use the custom filter from **config -> out**.

@ -1 +1 @@
Subproject commit 37ccb38b91b34095d06673952a913be3cf79eb0a
Subproject commit cb20817330c5fd837eec1ae5716aa60f28f2b973