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.rst115
1 files changed, 63 insertions, 52 deletions
diff --git a/DOCS/man/mpv.rst b/DOCS/man/mpv.rst
index e97422d..479458b 100644
--- a/DOCS/man/mpv.rst
+++ b/DOCS/man/mpv.rst
@@ -205,8 +205,11 @@ Shift+PGUP and Shift+PGDWN
Seek backward or forward by 10 minutes. (This used to be mapped to
PGUP/PGDWN without Shift.)
+b
+ Activate/deactivate debanding.
+
d
- Activate/deactivate deinterlacer.
+ Cycle the deinterlacing filter.
A
Cycle aspect ratio override.
@@ -218,18 +221,16 @@ Alt+LEFT, Alt+RIGHT, Alt+UP, Alt+DOWN
Move the video rectangle (panning).
Alt++ and Alt+-
- Combining ``Alt`` with the ``+`` or ``-`` keys changes video zoom.
+ Change video zoom.
Alt+BACKSPACE
Reset the pan/zoom settings.
F8
- Show the playlist and the current position in it (useful only if a UI window
- is used, broken on the terminal).
+ Show the playlist and the current position in it.
F9
- Show the list of audio and subtitle streams (useful only if a UI window is
- used, broken on the terminal).
+ Show the list of audio and subtitle streams.
i and I
Show/toggle an overlay displaying statistics about the currently playing
@@ -281,7 +282,7 @@ PREVIOUS and NEXT
Seek backward/forward 1 minute.
ZOOMIN and ZOOMOUT
- Changes video zoom.
+ Change video zoom.
If you miss some older key bindings, look at ``etc/restore-old-bindings.conf``
in the mpv git repository.
@@ -304,6 +305,23 @@ Wheel up/down
Wheel left/right
Seek forward/backward 10 seconds.
+Ctrl+Wheel up/down
+ Change video zoom.
+
+Context Menu
+-------------
+
+.. warning::
+
+ This feature is experimental. It may not work with all VOs. A libass based
+ fallback may be implemented in the future.
+
+Context Menu is a menu that pops up on the video window on user interaction
+(mouse right click, etc.).
+
+To use this feature, you need to fill the ``menu-data`` property with menu
+definition data, and add a keybinding to run the ``context-menu`` command,
+which can be done with a user script.
USAGE
=====
@@ -651,8 +669,9 @@ before. This is like passing the exact contents of the quoted string as a
command line option. C-style escapes are currently _not_ interpreted on this
level, although some options do this manually (this is a mess and should
probably be changed at some point). The shell is not involved here, so option
-values only need to be quoted to escape ``#`` and ``\``, ``"``, ``'`` or ``%``
-at the beginning of the value, and leading and trailing whitespace.
+values only need to be quoted to escape ``#`` anywhere in the value, ``"``,
+``'`` or ``%`` at the beginning of the value, and leading and trailing
+whitespace.
Putting Command Line Options into the Configuration File
--------------------------------------------------------
@@ -710,22 +729,24 @@ or at runtime with the ``apply-profile <name>`` command.
# a profile that can be enabled with --profile=big-cache
[big-cache]
cache=yes
- demuxer-max-bytes=123400KiB
+ demuxer-max-bytes=512MiB
demuxer-readahead-secs=20
- [slow]
- profile-desc="some profile name"
- # reference a builtin profile
- profile=high-quality
+ [network]
+ profile-desc="profile for content over network"
+ force-window=immediate
+ # you can also include other profiles
+ profile=big-cache
- [fast]
- vo=vdpau
+ [reduce-judder]
+ video-sync=display-resample
+ interpolation=yes
# using a profile again extends it
- [slow]
- framedrop=no
- # you can also include other profiles
- profile=big-cache
+ [network]
+ demuxer-max-back-bytes=512MiB
+ # reference a builtin profile
+ profile=fast
Runtime profiles
----------------
@@ -968,7 +989,7 @@ There are three choices for using mpv from other programs or scripts:
addition, terminal behavior itself may change any time. Compatibility
cannot be guaranteed.
- Your code should work even if you pass ``--no-terminal``. Do not attempt
+ Your code should work even if you pass ``--terminal=no``. Do not attempt
to simulate user input by sending terminal control codes to mpv's stdin.
If you need interactive control, using ``--input-ipc-server`` is
recommended. This gives you access to the `JSON IPC`_ over unix domain
@@ -1092,7 +1113,7 @@ this with ``--untimed``, but it will likely break, unless the stream has no
audio, and the input feeds data to the player at a constant rate.
Another common problem is with MJPEG streams. These do not signal the correct
-framerate. Using ``--untimed`` or ``--no-correct-pts --container-fps-override=60``
+framerate. Using ``--untimed`` or ``--correct-pts=no --container-fps-override=60``
might help.
For livestreams, data can build up due to pausing the stream, due to slightly
@@ -1121,10 +1142,10 @@ commands ``quit-watch-later`` (bound to Shift+Q by default) and
The difference between always quitting with a key bound to ``quit-watch-later``
and using ``--save-position-on-quit`` is that the latter will save the playback
-position even when mpv is closed with a method other than a keybinding, for
-example if you shutdown your system without closing mpv beforehand, unless of
-course mpv is terminated abruptly and doesn't have the time to save (e.g. with
-the KILL Unix signal).
+position even when mpv is closed with a method other than a keybinding, such as
+clicking the close button in the window title bar. However if mpv is terminated
+abruptly and doesn't have the time to save, then the position will not be saved.
+For example, if you shutdown your system without closing mpv beforehand.
mpv also stores options other than the playback position when they have been
modified after playback began, for example the volume and selected audio/subtitles,
@@ -1152,8 +1173,8 @@ PROTOCOLS
either aliases to documented protocols, or are just redirections to
protocols implemented and documented in FFmpeg.
- ``data:`` is supported in FFmpeg (not in Libav), but needs to be in the
- format ``data://``. This is done to avoid ambiguity with filenames. You
+ ``data:`` is supported, but needs to be in the format ``data://``.
+ This is done to avoid ambiguity with filenames. You
can also prefix it with ``lavf://`` or ``ffmpeg://``.
``ytdl://...``
@@ -1199,17 +1220,28 @@ PROTOCOLS
Digital TV via DVB. (Linux only.)
-``mf://[filemask|@listfile]`` ``--mf-...``
+``mf://[@listfile|filemask|glob|printf-format]`` ``--mf-...``
Play a series of images as video.
+ If the URL path begins with ``@``, it is interpreted as the path to a file
+ containing a list of image paths separated by newlines. If the URL path
+ contains ``,``, it is interpreted as a list of image paths separated by
+ ``,``. If the URL path does not contain ``%`` and if on POSIX platforms, is
+ interpreted as a glob, and ``*`` is automatically appended if it was not
+ specified. Otherwise, the printf sequences ``%[.][NUM]d``, where ``NUM`` is
+ one, two, or three decimal digits, and ``%%`` and are interpreted. For
+ example, ``mf://image-%d.jpg`` plays files like ``image-1.jpg``,
+ ``image-2.jpg`` and ``image-10.jpg``, provided that there are no big gaps
+ between the files.
+
``cdda://[device]`` ``--cdrom-device=PATH`` ``--cdda-...``
Play CD.
``lavf://...``
- Access any FFmpeg/Libav libavformat protocol. Basically, this passed the
+ Access any FFmpeg libavformat protocol. Basically, this passed the
string after the ``//`` directly to libavformat.
``av://type:options``
@@ -1357,27 +1389,6 @@ works like in older mpv releases:
change, and not apply your additional settings, and/or use a different
profile name.
-Linux desktop issues
-====================
-
-This subsection describes common problems on the Linux desktop. None of these
-problems exist on systems like Windows or macOS.
-
-Disabling Screensaver
----------------------
-
-By default, mpv tries to disable the OS screensaver during playback (only if
-a VO using the OS GUI API is active). ``--stop-screensaver=no`` disables this.
-
-A common problem is that Linux desktop environments ignore the standard
-screensaver APIs on which mpv relies. In particular, mpv uses the Screen Saver
-extension (XSS) on X11, and the idle-inhibit protocol on Wayland.
-
-Before mpv 0.33.0, the X11 backend ran ``xdg-screensaver reset`` in 10 second
-intervals when not paused in order to support screensaver inhibition in these
-environments. This functionality was removed in 0.33.0, but it is possible to
-call the ``xdg-screensaver`` command line program from a user script instead.
-
.. include:: options.rst
@@ -1445,7 +1456,7 @@ behavior of mpv.
``DISPLAY``
Standard X11 display name to use.
-FFmpeg/Libav:
+FFmpeg:
This library accesses various environment variables. However, they are not
centrally documented, and documenting them is not our job. Therefore, this
list is incomplete.