From 4b567aeac8d1741b14bf2ee363a5434a4877565e Mon Sep 17 00:00:00 2001 From: wm4 Date: Wed, 31 Jan 2018 04:13:00 +0100 Subject: [PATCH] manpage: clarify some --vf options In particular, mention deprecated things. --- DOCS/man/af.rst | 3 ++- DOCS/man/vf.rst | 41 ++++++++++++++++++++++++++--------------- 2 files changed, 28 insertions(+), 16 deletions(-) diff --git a/DOCS/man/af.rst b/DOCS/man/af.rst index 5d190cc82b..93a25cd4bb 100644 --- a/DOCS/man/af.rst +++ b/DOCS/man/af.rst @@ -5,7 +5,8 @@ Audio filters allow you to modify the audio stream and its properties. The syntax is: ``--af=...`` - Setup a chain of audio filters. See ``--vf`` for the syntax. + Setup a chain of audio filters. See ``--vf`` (`VIDEO FILTERS`_) for the + full syntax. .. note:: diff --git a/DOCS/man/vf.rst b/DOCS/man/vf.rst index 13e80014c4..9537b09597 100644 --- a/DOCS/man/vf.rst +++ b/DOCS/man/vf.rst @@ -1,8 +1,11 @@ VIDEO FILTERS ============= -Video filters allow you to modify the video stream and its properties. The -syntax is: +Video filters allow you to modify the video stream and its properties. All of +the information described in this section applies to audio filters as well +(generally using the prefix ``--af`` instead of ``--vf``). + +The exact syntax is: ``--vf=`` Setup a chain of video filters. This consists on the filter name, and an @@ -41,11 +44,18 @@ syntax is: the ``lavfi`` filter, which uses a very similar syntax as mpv (MPlayer historically) to specify filters and their parameters. +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. +normal filter parameters. This is deprecated and never worked for the +libavfilter bridge. ``--vf-defaults=`` - Set defaults for each filter. + Set defaults for each filter. (Deprecated. ``--af-defaults`` is deprecated + as well.) .. note:: @@ -75,15 +85,20 @@ normal filter parameters. Video filters are managed in lists. There are a few commands to manage the filter list. -``--vf-add=`` - Appends the filters given as arguments to the filter list. +``--vf-add=filter`` + Appends the filter given as arguments to the filter list. (Passing multiple + filters is currently still possible, but deprecated.) -``--vf-pre=`` - Prepends the filters given as arguments to the filter list. +``--vf-pre=filter`` + Prepends the filters given as arguments to the filter list. (Passing + multiple filters is currently still possible, but deprecated.) -``--vf-del=`` - Deletes the filters at the given indexes. Index numbers start at 0, - negative numbers address the end of the list (-1 is the last). +``--vf-del=filter`` + Deletes the filter. The filter can even given the way it was added (filter + name and its full argument list), by label (prefixed with ``@``), or as + index number. Index numbers start at 0, negative numbers address the end of + the list (-1 is the last). (Passing multiple filters is currently still + possible, but deprecated.) ``--vf-clr`` Completely empties the filter list. @@ -94,10 +109,6 @@ With filters that support it, you can access parameters by their name. Prints the parameter names and parameter value ranges for a particular filter. -``--vf=`` - Sets a named parameter to the given value. Use on and off or yes and no to - set flag parameters. - Available mpv-only filters are: ``format=fmt=:colormatrix=:...``