diff options
author | wm4 <wm4@nowhere> | 2017-03-25 17:07:40 +0100 |
---|---|---|
committer | wm4 <wm4@nowhere> | 2017-03-25 17:07:40 +0100 |
commit | 7d424b4ce45534ade52f38df68308498decc0171 (patch) | |
tree | f5ed0a3c98cab67ce50e76a0223031cb73eb39b8 /DOCS/man/vf.rst | |
parent | 29f9e44723104aac8ce91d0347a91fb206afba8d (diff) | |
download | mpv-7d424b4ce45534ade52f38df68308498decc0171.tar.bz2 mpv-7d424b4ce45534ade52f38df68308498decc0171.tar.xz |
command: add better runtime filter toggling method
Basically, see the example in input.rst.
This is better than the "old" vf-toggle method, because it doesn't
require the user to duplicate the filter string in mpv.conf and
input.conf.
Some aspects of this changes are untested, so enjoy your alpha testing.
Diffstat (limited to 'DOCS/man/vf.rst')
-rw-r--r-- | DOCS/man/vf.rst | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/DOCS/man/vf.rst b/DOCS/man/vf.rst index 9da20942f6..a3f7ee6dab 100644 --- a/DOCS/man/vf.rst +++ b/DOCS/man/vf.rst @@ -5,7 +5,37 @@ Video filters allow you to modify the video stream and its properties. The syntax is: ``--vf=<filter1[=parameter1:parameter2:...],filter2,...>`` - Setup a chain of video filters. + Setup a chain of video filters. This consists on the filter name, and an + option list of parameters after ``=``. The parameters are separated by + ``:`` (not ``,``, as that starts a new filter entry). + + Before the filter name, a label can be specified with ``@name:``, where + name is an arbitrary user-given name, which identifies the filter. This + is only needed if you want to toggle the filter at runtime. + + A ``!`` before the filter name means the filter is enabled by default. It + will be skipped on filter creation. This is also useful for runtime filter + toggling. + + See the ``vf`` command (and ``toggle`` sub-command) for further explanations + and examples. + + The general filter entry syntax is: + + ``["@"<label-name>":"] ["!"] <filter-name> [ "=" <filter-parameter-list> ]`` + + and the ``filter-parameter-list``: + + ``<filter-parameter> | <filter-parameter> "," <filter-parameter-list>`` + + and ``filter-parameter``: + + ``( <param-name> "=" <param-value> ) | <param-value>`` + + ``param-value`` can further be quoted in ``[`` / ``]`` in case the value + contains characters like ``,`` or ``=``. This is used in particular with + the ``lavfi`` filter, which uses a very similar syntax as mpv (MPlayer + historically) to specify filters and their parameters. You can also set defaults for each filter. The defaults are applied before the normal filter parameters. |