summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/man/ao.rst11
-rw-r--r--DOCS/man/mpv.rst30
-rw-r--r--DOCS/man/options.rst60
-rw-r--r--DOCS/man/vo.rst17
4 files changed, 49 insertions, 69 deletions
diff --git a/DOCS/man/ao.rst b/DOCS/man/ao.rst
index 979da9ee0e..0e45b1e96e 100644
--- a/DOCS/man/ao.rst
+++ b/DOCS/man/ao.rst
@@ -4,14 +4,11 @@ AUDIO OUTPUT DRIVERS
Audio output drivers are interfaces to different audio output facilities. The
syntax is:
-``--ao=<driver1[:suboption1[=value]:...],driver2,...[,]>``
+``--ao=<driver1,driver2,...[,]>``
Specify a priority list of audio output drivers to be used.
If the list has a trailing ',', mpv will fall back on drivers not contained
-in the list. Suboptions are optional and can mostly be omitted.
-
-You can also set defaults for each driver. The defaults are applied before the
-normal driver parameters.
+in the list.
``--ao-defaults=<driver1[:parameter1:parameter2:...],driver2,...>``
Set defaults for each driver.
@@ -173,8 +170,8 @@ Available audio output drivers are:
changed.
``null``
- Produces no audio output but maintains video playback speed. Use
- ``--ao=null:untimed`` for benchmarking.
+ Produces no audio output but maintains video playback speed. You can use
+ ``--ao=null --ao-null-untimed`` for benchmarking.
The following global options are supported by this audio output:
diff --git a/DOCS/man/mpv.rst b/DOCS/man/mpv.rst
index bbfc6d4b7c..4d2a20bce1 100644
--- a/DOCS/man/mpv.rst
+++ b/DOCS/man/mpv.rst
@@ -268,15 +268,16 @@ command line.
The suboption parser can quote strings with ``"`` and ``[...]``.
Additionally, there is a special form of quoting with ``%n%`` described below.
-For example, the ``opengl`` VO can take multiple options:
+For example, assume the hypothetical ``foo`` filter can take multiple options:
- ``mpv test.mkv --vo=opengl:scale=lanczos:icc-profile=file.icc,xv``
+ ``mpv test.mkv --vf=foo:option1=value1:option2:option3=value3,bar``
-This passes ``scale=lanczos`` and ``icc-profile=file.icc`` to ``opengl``,
-and also specifies ``xv`` as fallback VO. If the icc-profile path contains
-spaces or characters like ``,`` or ``:``, you need to quote them:
+This passes ``option1`` and ``option3`` to the ``foo`` filter, with ``option2``
+as flag (implicitly ``option2=yes``), and adds a ``bar`` filter after that. If
+an option contains spaces or characters like ``,`` or ``:``, you need to quote
+them:
- ``mpv '--vo=opengl:icc-profile="file with spaces.icc",xv'``
+ ``mpv '--vf=foo:option1="option value with spaces",bar'``
Shells may actually strip some quotes from the string passed to the commandline,
so the example quotes the string twice, ensuring that mpv receives the ``"``
@@ -297,11 +298,11 @@ It is started with ``%`` and has the following format::
.. admonition:: Examples
- ``mpv --ao=pcm:file=%10%C:test.wav test.avi``
+ ``mpv '--vf=foo:option1=%11%quoted text' test.avi``
Or in a script:
- ``mpv --ao=pcm:file=%`expr length "$NAME"`%"$NAME" test.avi``
+ ``mpv --vf=foo:option1=%`expr length "$NAME"`%"$NAME" test.avi``
Suboptions passed to the client API are also subject to escaping. Using
``mpv_set_option_string()`` is exactly like passing ``--name=data`` to the
@@ -309,8 +310,7 @@ command line (but without shell processing of the string). Some options
support passing values in a more structured way instead of flat strings, and
can avoid the suboption parsing mess. For example, ``--vf`` supports
``MPV_FORMAT_NODE``, which lets you pass suboptions as a nested data structure
-of maps and arrays. (``--vo`` supports this in the same way, although this
-fact is undocumented.)
+of maps and arrays.
Paths
-----
@@ -528,7 +528,8 @@ profile name ``default`` to continue with normal options.
[slow]
profile-desc="some profile name"
- vo=opengl:scale=ewa_lanczos:scale-radius=16
+ # reference a builtin profile
+ profile=opengl-hq
[fast]
vo=vdpau
@@ -549,10 +550,6 @@ Some profiles are loaded automatically. The following example demonstrates this:
::
- [vo.vdpau]
- # Use hardware decoding
- hwdec=vdpau
-
[protocol.dvd]
profile-desc="profile for dvd:// streams"
alang=en
@@ -561,9 +558,6 @@ Some profiles are loaded automatically. The following example demonstrates this:
profile-desc="profile for .flv files"
vf=flip
- [ao.alsa]
- device=spdif
-
The profile name follows the schema ``type.name``, where type can be ``vo``
to match the value the ``--vo`` option is set to, ``ao`` for ``--ao``,
``protocol`` for the input/output protocol in use (see ``--list-protocols``),
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst
index 062dc307c0..8a28181ea9 100644
--- a/DOCS/man/options.rst
+++ b/DOCS/man/options.rst
@@ -511,11 +511,9 @@ Program Behavior
Video
-----
-``--vo=<driver1[:suboption1[=value]:...],driver2,...[,]>``
- Specify a priority list of video output drivers to be used. For
- interactive use, one would normally specify a single one to use, but in
- configuration files, specifying a list of fallbacks may make sense. See
- `VIDEO OUTPUT DRIVERS`_ for details and descriptions of available drivers.
+``--vo=<driver>``
+ Specify the video output backend to be used. See `VIDEO OUTPUT DRIVERS`_ for
+ details and descriptions of available drivers.
``--vd=<[+|-]family1:(*|decoder1),[+|-]family2:(*|decoder2),...[-]>``
Specify a priority list of video decoders to be used, according to their
@@ -596,11 +594,11 @@ Video
:vaapi-copy: copies video back into system RAM (Linux with Intel GPUs only)
:videotoolbox: requires ``--vo=opengl`` (OS X 10.8 and up only)
:videotoolbox-copy: copies video back into system RAM (OS X 10.8 and up only)
- :dxva2: requires ``--vo=opengl:backend=angle`` or
-
- ``--vo=opengl:backend=dxinterop`` (Windows only)
+ :dxva2: requires ``--vo=opengl`` with ``--opengl-backend=angle`` or
+ ``--opengl-backend=dxinterop`` (Windows only)
:dxva2-copy: copies video back to system RAM (Windows only)
- :d3d11va: requires ``--vo=opengl:backend=angle`` (Windows only)
+ :d3d11va: requires ``--vo=opengl`` with ``--opengl-backend=angle``
+ (Windows only)
:d3d11va-copy: copies video back to system RAM (Windows only)
:mediacodec: copies video back to system RAM (Android only)
:rpi: requires ``--vo=rpi`` (Raspberry Pi only - default if available)
@@ -622,7 +620,7 @@ Video
The ``vaapi`` mode, if used with ``--vo=opengl``, requires Mesa 11 and most
likely works with Intel GPUs only. It also requires the opengl EGL backend
(automatically used if available). You can also try the old GLX backend by
- forcing it with ``--vo=opengl:backend=x11``, but the vaapi/GLX interop is
+ forcing it with ``--opengl-backend=x11``, but the vaapi/GLX interop is
said to be slower than ``vaapi-copy``.
Most video filters will not work with hardware decoding as they are
@@ -847,8 +845,7 @@ Video
disable deinterlacing just because the ``--deinterlace`` was not set.
``--field-dominance=<auto|top|bottom>``
- Set first field for interlaced content. Useful for deinterlacers that
- double the framerate: ``--vf=yadif=field`` and ``--vo=vdpau:deint``.
+ Set first field for interlaced content.
:auto: (default) If the decoder does not export the appropriate
information, it falls back on ``top`` (top field first).
@@ -1008,6 +1005,19 @@ Audio
manually. For example ``name/foobar`` forces the AO ``name`` to use the
device ``foobar``.
+ .. admonition:: Example for ALSA
+
+ MPlayer and mplayer2 required you to replace any ',' with '.' and
+ any ':' with '=' in the ALSA device name. For example, to use the
+ device named ``dmix:default``, you had to do:
+
+ ``-ao alsa:device=dmix=default``
+
+ In mpv you could instead use:
+
+ ``--audio-device=alsa/dmix:default``
+
+
``--audio-exclusive=<yes|no>``
Enable exclusive output mode. In this mode, the system is usually locked
out, and only mpv will be able to output audio.
@@ -1025,11 +1035,9 @@ Audio
``current-ao`` and ``audio-device-list`` properties to make high-level
decisions about how to continue.
-``--ao=<driver1[:suboption1[=value]:...],driver2,...[,]>``
- Specify a priority list of audio output drivers to be used. For
- interactive use one would normally specify a single one to use, but in
- configuration files specifying a list of fallbacks may make sense. See
- `AUDIO OUTPUT DRIVERS`_ for details and descriptions of available drivers.
+``--ao=<driver>``
+ Specify the audio output drivers to be used. See `AUDIO OUTPUT DRIVERS`_ for
+ details and descriptions of available drivers.
``--af=<filter1[=parameter1:parameter2:...],filter2,...>``
Specify a list of audio filters to apply to the audio stream. See
@@ -3612,23 +3620,7 @@ ALSA audio output options
``--alsa-device=<device>``
- Sets the device name. For ac3 output via S/PDIF, use an "iec958" or
- "spdif" device, unless you really know how to set it correctly.
-
- .. note::
-
- MPlayer and mplayer2 required you to replace any ',' with '.' and
- any ':' with '=' in the ALSA device name. mpv does not do this anymore.
- Instead, quote the device name:
-
- ``--ao=alsa:device=[plug:surround50]``
-
- Note that the ``[`` and ``]`` simply quote the device name. With some
- shells (like zsh), you have to quote the option string to prevent the
- shell from interpreting the brackets instead of passing them to mpv.
-
- Actually, you should use the ``--audio-device`` option, instead of
- setting the device directly.
+ Deprecated, use ``--audio-device`` (requires ``alsa/`` prefix).
``--alsa-resample=yes``
Enable ALSA resampling plugin. (This is disabled by default, because
diff --git a/DOCS/man/vo.rst b/DOCS/man/vo.rst
index a3645617ae..57698d3cc8 100644
--- a/DOCS/man/vo.rst
+++ b/DOCS/man/vo.rst
@@ -4,14 +4,11 @@ VIDEO OUTPUT DRIVERS
Video output drivers are interfaces to different video output facilities. The
syntax is:
-``--vo=<driver1[:suboption1[=value]:...],driver2,...[,]>``
+``--vo=<driver1,driver2,...[,]>``
Specify a priority list of video output drivers to be used.
-If the list has a trailing ',', mpv will fall back on drivers not contained
-in the list. Suboptions are optional and can mostly be omitted.
-
-You can also set defaults for each driver. The defaults are applied before the
-normal driver parameters.
+If the list has a trailing ``,``, mpv will fall back on drivers not contained
+in the list.
``--vo-defaults=<driver1[:parameter1:parameter2:...],driver2,...>``
Set defaults for each driver.
@@ -22,10 +19,10 @@ normal driver parameters.
See ``--vo=help`` for a list of compiled-in video output drivers.
- The recommended output driver is ``--vo=opengl``. All other drivers are
- for compatibility or special purposes. By default, ``--vo=opengl`` is used,
- but if that appears not to work, it fallback to other drivers (in the same
- order as listed by ``--vo=help``).
+ The recommended output driver is ``--vo=opengl``, which is the default. All
+ other drivers are for compatibility or special purposes. If the default
+ does not work, it will fallback to other drivers (in the same order as
+ listed by ``--vo=help``).
Available video output drivers are: