diff options
Diffstat (limited to 'DOCS/man/vf.rst')
| -rw-r--r-- | DOCS/man/vf.rst | 84 |
1 files changed, 58 insertions, 26 deletions
diff --git a/DOCS/man/vf.rst b/DOCS/man/vf.rst index e07360b24d..5c29cba0e9 100644 --- a/DOCS/man/vf.rst +++ b/DOCS/man/vf.rst @@ -44,23 +44,21 @@ The exact syntax is: the ``lavfi`` filter, which uses a very similar syntax as mpv (MPlayer historically) to specify filters and their parameters. +.. note:: + + ``--vf`` can only take a single track as input, even if the filter supports + dynamic input. Filters that require multiple inputs can't be used. + Use ``--lavfi-complex`` for such a use case. This also applies for ``--af``. + Filters can be manipulated at run time. You can use ``@`` labels as described above in combination with the ``vf`` command (see `COMMAND INTERFACE`_) to get more control over this. Initially disabled filters with ``!`` are useful for this as well. -You can also set defaults for each filter. The defaults are applied before the -normal filter parameters. This is deprecated and never worked for the -libavfilter bridge. - -``--vf-defaults=<filter1[=parameter1:parameter2:...],filter2,...>`` - Set defaults for each filter. (Deprecated. ``--af-defaults`` is deprecated - as well.) - .. note:: To get a full list of available video filters, see ``--vf=help`` and - http://ffmpeg.org/ffmpeg-filters.html . + https://ffmpeg.org/ffmpeg-filters.html . Also, keep in mind that most actual filters are available via the ``lavfi`` wrapper, which gives you access to most of libavfilter's filters. This @@ -110,11 +108,6 @@ filter list. from the list if it was present. Matching of filters works as described in ``--vf-remove``. -``--vf-del=filter`` - Sort of like ``--vf-remove``, but also accepts an index number. Index - numbers start at 0, negative numbers address the end of the list (-1 is the - last). Deprecated. - ``--vf-clr`` Completely empties the filter list. @@ -141,6 +134,11 @@ Available mpv-only filters are: For a list of available formats, use ``--vf=format=fmt=help``. + .. note:: + + Conversion between hardware formats is supported in some cases. + eg: ``cuda`` to ``vulkan``, or ``vaapi`` to ``vulkan``. + ``<convert=yes|no>`` Force conversion of color parameters (default: no). @@ -164,6 +162,9 @@ Available mpv-only filters are: If input and output video parameters are the same, conversion is always skipped. + When converting between hardware formats, this parameter has no effect, + and the only conversion that is done is the format conversion. + .. admonition:: Examples ``mpv test.mkv --vf=format:colormatrix=ycgco`` @@ -203,10 +204,13 @@ Available mpv-only filters are: Available color spaces are: :auto: automatic selection (default) - :bt.601: ITU-R BT.601 (SD) - :bt.709: ITU-R BT.709 (HD) - :bt.2020-ncl: ITU-R BT.2020 non-constant luminance system - :bt.2020-cl: ITU-R BT.2020 constant luminance system + :bt.601: ITU-R Rec. BT.601 (SD) + :bt.709: ITU-R Rec. BT.709 (HD) + :bt.2020-ncl: ITU-R Rec. BT.2020 (non-constant luminance) + :bt.2020-cl: ITU-R Rec. BT.2020 (constant luminance) + :bt.2100-pq: ITU-R Rec. BT.2100 ICtCp PQ variant + :bt.2100-hlg: ITU-R Rec. BT.2100 ICtCp HLG variant + :dolbyvision: Dolby Vision :smpte-240m: SMPTE-240M ``<colorlevels>`` @@ -308,6 +312,18 @@ Available mpv-only filters are: :709-1886: Scene-referred using the BT709+BT1886 interaction :gamma1.2: Scene-referred using a pure power OOTF (gamma=1.2) + ``<dolbyvision=yes|no>`` + Whether or not to include Dolby Vision metadata (default: yes). If + disabled, any Dolby Vision metadata will be stripped from frames. + + ``<hdr10plus=yes|no>`` + Whether or not to include HDR10+ metadata (default: yes). If + disabled, any HDR10+ metadata will be stripped from frames. + + ``<film-grain=yes|no>`` + Whether or not to include film grain metadata (default: yes). If + disabled, any film grain metadata will be stripped from frames. + ``<stereo-in>`` Set the stereo mode the video is assumed to be encoded in. Use ``--vf=format:stereo-in=help`` to list all available modes. Check with @@ -389,7 +405,7 @@ Available mpv-only filters are: option gives the flags which should be passed to libswscale. This option is numeric and takes a bit-wise combination of ``SWS_`` flags. - See ``http://git.videolan.org/?p=ffmpeg.git;a=blob;f=libswscale/swscale.h``. + See ``https://git.videolan.org/?p=ffmpeg.git;a=blob;f=libswscale/swscale.h``. ``<o>`` Set AVFilterGraph options. These should be documented by FFmpeg. @@ -457,7 +473,7 @@ Available mpv-only filters are: :: import vapoursynth as vs - core = vs.get_core() + from vapoursynth import core core.std.AddBorders(video_in, 10, 10, 20, 20).set_output() .. warning:: @@ -560,13 +576,19 @@ Available mpv-only filters are: completely broken (e.g. 0 or NaN). Even if the value is correct, if another filter changes the real FPS (by dropping or inserting frames), the value of this variable will not be useful. Note that - the ``--fps`` command line option overrides this value. + the ``--container-fps-override`` command line option overrides this value. Useful for some filters which insist on having a FPS. ``display_fps`` Refresh rate of the current display. Note that this value can be 0. + ``display_res`` + Resolution of the current display. This is an integer array with the + first entry corresponding to the width and the second entry coresponding + to the height. These values can be 0. Note that this will not respond to + monitor changes and may not work on all platforms. + ``vavpp`` VA-API video post processing. Requires the system to support VA-API, i.e. Linux/BSD only. Works with ``--vo=vaapi`` and ``--vo=gpu`` only. @@ -598,7 +620,7 @@ Available mpv-only filters are: ``reversal-bug=<yes|no>`` :no: Use the API as it was interpreted by older Mesa drivers. While - this interpretation was more obvious and inuitive, it was + this interpretation was more obvious and intuitive, it was apparently wrong, and not shared by Intel driver developers. :yes: Use Intel interpretation of surface forward and backwards references (default). This is what Intel drivers and newer Mesa @@ -738,17 +760,27 @@ Available mpv-only filters are: which leads to lost frames. ``print=yes|no`` - Print computed fingerprints the the terminal (default: no). This is + Print computed fingerprints to the terminal (default: no). This is mostly for testing and such. Scripts should use ``vf-metadata`` to read information from this filter instead. ``gpu=...`` - Convert video to RGB using the OpenGL renderer normally used with - ``--vo=gpu``. This requires that the EGL implementation supports off-screen - rendering on the default display. (This is the case with Mesa.) + Convert video to RGB using the Vulkan or OpenGL renderer normally used with + ``--vo=gpu``. In case of OpenGL, this requires that the EGL implementation + supports off-screen rendering on the default display. (This is the case with + Mesa.) Sub-options: + ``api=<type>`` + The value ``type`` selects the rendering API. You can also pass + ``help`` to get a complete list of compiled in backends. + + egl + EGL (default if available) + vulkan + Vulkan + ``w=<pixels>``, ``h=<pixels>`` Size of the output in pixels (default: 0). If not positive, this will use the size of the first filtered input frame. |