summaryrefslogtreecommitdiffstats
path: root/DOCS/man/mpv.rst
diff options
context:
space:
mode:
Diffstat (limited to 'DOCS/man/mpv.rst')
-rw-r--r--DOCS/man/mpv.rst72
1 files changed, 33 insertions, 39 deletions
diff --git a/DOCS/man/mpv.rst b/DOCS/man/mpv.rst
index 5a80319a78..f4876ac00e 100644
--- a/DOCS/man/mpv.rst
+++ b/DOCS/man/mpv.rst
@@ -143,11 +143,11 @@ Ctrl + and Ctrl -
u
Switch between applying no style overrides to SSA/ASS subtitles, and
overriding them almost completely with the normal subtitle style. See
- ``--ass-style-override`` for more info.
+ ``--sub-ass-style-override`` for more info.
V
Toggle subtitle VSFilter aspect compatibility mode. See
- ``--ass-vsfilter-aspect-compat`` for more info.
+ ``--sub-ass-vsfilter-aspect-compat`` for more info.
r and t
Move subtitles up/down.
@@ -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,11 +558,7 @@ 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``,
+The profile name follows the schema ``type.name``, where type can be
``protocol`` for the input/output protocol in use (see ``--list-protocols``),
and ``extension`` for the extension of the path of the currently played file
(*not* the file format).
@@ -688,7 +681,7 @@ PROTOCOLS
``mf://[filemask|@listfile]`` ``--mf-...``
Play a series of images as video.
-``cdda://track[-endtrack][:speed][/device]`` ``--cdrom-device=PATH`` ``--cdda-...``
+``cdda://[device]`` ``--cdrom-device=PATH`` ``--cdda-...``
Play CD.
``lavf://...``
@@ -743,24 +736,32 @@ Currently this happens only in the following cases:
or file associations provided by desktop environments)
- if started from explorer.exe on Windows (technically, if it was started on
Windows, and all of the stdout/stderr/stdin handles are unset)
-- manually adding ``--profile=pseudo-gui`` to the command line
+- started out of the bundle on OSX
+- if you manually use ``--player-operation-mode=pseudo-gui`` on the command line
-This mode implicitly adds ``--profile=pseudo-gui`` to the command line, with
-the ``pseudo-gui`` profile being predefined with the following contents:
+This mode applies options from the builtin profile ``builtin-pseudo-gui``, but
+only if these haven't been set in the user's config file or on the command line.
+Also, for compatibility with the old pseudo-gui behavior, the options in the
+``pseudo-gui`` profile are applied unconditionally. In addition, the profile
+makes sure to enable the pseudo-GUI mode, so that ``--profile=pseudo-gui``
+works like in older mpv releases. The profiles are currently defined as follows:
::
- [pseudo-gui]
+ [builtin-pseudo-gui]
terminal=no
force-window=yes
idle=once
screenshot-directory=~~desktop/
+ [pseudo-gui]
+ player-operation-mode=pseudo-gui
-This follows the mpv config file format. To customize pseudo-GUI mode, you can
-put your own ``pseudo-gui`` profile into your ``mpv.conf``. This profile will
-enhance the default profile, rather than overwrite it.
+.. warning::
-The profile always overrides other settings in ``mpv.conf``.
+ Currently, you can extend the ``pseudo-gui`` profile in the config file the
+ normal way. This is deprecated. In future mpv releases, the behavior might
+ change, and not apply your additional settings, and/or use a different
+ profile name.
.. include:: options.rst
@@ -785,14 +786,7 @@ The profile always overrides other settings in ``mpv.conf``.
.. include:: changes.rst
-
-EMBEDDING INTO OTHER PROGRAMS (LIBMPV)
-======================================
-
-mpv can be embedded into other programs as video/audio playback backend. The
-recommended way to do so is using libmpv. See ``libmpv/client.h`` in the mpv
-source code repository. This provides a C API. Bindings for other languages
-might be available (see wiki).
+.. include:: libmpv.rst
ENVIRONMENT VARIABLES
=====================