Ubuntu Manpage: mpv - a media player

NAME

       mpv - a media player

SYNOPSIS

       mpv [options] [file|URL|PLAYLIST|-]
       mpv [options] files

DESCRIPTION

       mpv  is  a media player based on MPlayer and mplayer2. It supports a wide variety of video
       file formats, audio and video codecs, and subtitle types.  Special  input  URL  types  are
       available  to  read  input  from  a variety of sources other than disk files. Depending on
       platform, a variety of different video and audio output methods are supported.

       Usage examples to get you started quickly can be found at the end of this man page.

INTERACTIVE CONTROL

mpv has a fully configurable, command-driven control layer which allows you to control mpv
using keyboard, mouse, or remote control (there is no LIRC support - configure remotes as
input devices instead).

See the --input- options for ways to customize it.

The following listings are not necessarily complete. See etc/input.conf for a list of
default bindings. User input.conf files and Lua scripts can define additional key
bindings.

Keyboard Control
LEFT and RIGHT
Seek backward/forward 5 seconds. Shift+arrow does a 1 second exact seek (see
--hr-seek).

UP and DOWN
Seek forward/backward 1 minute. Shift+arrow does a 5 second exact seek (see
--hr-seek).

Ctrl+LEFT and Ctrl+RIGHT
Seek to the previous/next subtitle. Subject to some restrictions and might not
always work; see sub-seek command.

[ and ]
Decrease/increase current playback speed by 10%.

{ and }
Halve/double current playback speed.

BACKSPACE
Reset playback speed to normal.

< and >
Go backward/forward in the playlist.

ENTER Go forward in the playlist.

p / SPACE
Pause (pressing again unpauses).

. Step forward. Pressing once will pause, every consecutive press will play one frame
and then go into pause mode again.

, Step backward. Pressing once will pause, every consecutive press will play one
frame in reverse and then go into pause mode again.

q Stop playing and quit.

Q Like q, but store the current playback position. Playing the same file later will
resume at the old playback position if possible.

/ and *
Decrease/increase volume.

9 and 0
Decrease/increase volume.

m Mute sound.

_ Cycle through the available video tracks.

# Cycle through the available audio tracks.

f Toggle fullscreen (see also --fs).

ESC Exit fullscreen mode.

T Toggle stay-on-top (see also --ontop).

w and e
Decrease/increase pan-and-scan range.

o (also P)
Show progression bar, elapsed time and total duration on the OSD.

O Toggle OSD states between normal and playback time/duration.

v Toggle subtitle visibility.

j and J
Cycle through the available subtitles.

x and z
Adjust subtitle delay by +/- 0.1 seconds.

l Set/clear A-B loop points. See ab-loop command for details.

L Toggle infinite looping.

Ctrl + and Ctrl -
Adjust audio delay (A/V sync) by +/- 0.1 seconds.

u Switch between applying no style overrides to SSA/ASS subtitles, and overriding
them almost completely with the normal subtitle style. See --sub-ass-override for
more info.

V Toggle subtitle VSFilter aspect compatibility mode. See
--sub-ass-vsfilter-aspect-compat for more info.

r and t
Move subtitles up/down.

s Take a screenshot.

S Take a screenshot, without subtitles. (Whether this works depends on VO driver
support.)

Ctrl s Take a screenshot, as the window shows it (with subtitles, OSD, and scaled video).

PGUP and PGDWN
Seek to the beginning of the previous/next chapter. In most cases, "previous" will
actually go to the beginning of the current chapter; see --chapter-seek-threshold.

Shift+PGUP and Shift+PGDWN
Seek backward or forward by 10 minutes. (This used to be mapped to PGUP/PGDWN
without Shift.)

d Activate/deactivate deinterlacer.

A Cycle aspect ratio override.

(The following keys are valid only when using a video output that supports the
corresponding adjustment, or the software equalizer (--vf=eq).)

1 and 2
Adjust contrast.

3 and 4
Adjust brightness.

5 and 6
Adjust gamma.

7 and 8
Adjust saturation.

Alt+0 (and command+0 on OSX)
Resize video window to half its original size.

Alt+1 (and command+1 on OSX)
Resize video window to its original size.

Alt+2 (and command+2 on OSX)
Resize video window to double its original size.

command + f (OSX only)
Toggle fullscreen (see also --fs).

(The following keys are valid if you have a keyboard with multimedia keys.)

PAUSE Pause.

STOP Stop playing and quit.

PREVIOUS and NEXT
Seek backward/forward 1 minute.

If you miss some older key bindings, look at etc/restore-old-bindings.conf in the mpv git
repository.

Mouse Control
button 3 and button 4
Seek backward/forward 1 minute.

button 5 and button 6
Decrease/increase volume.

USAGE

Command line arguments starting with - are interpreted as options, everything else as
filenames or URLs. All options except flag options (or choice options which include yes)
require a parameter in the form --option=value.

One exception is the lone - (without anything else), which means media data will be read
from stdin. Also, -- (without anything else) will make the player interpret all following
arguments as filenames, even if they start with -. (To play a file named -, you need to
use ./-.)

Every flag option has a no-flag counterpart, e.g. the opposite of the --fs option is
--no-fs. --fs=yes is same as --fs, --fs=no is the same as --no-fs.

If an option is marked as (XXX only), it will only work in combination with the XXX option
or if XXX is compiled in.

Legacy option syntax
The --option=value syntax is not strictly enforced, and the alternative legacy syntax
-option value and --option value will also work. This is mostly for compatibility with
MPlayer. Using these should be avoided. Their semantics can change any time in the future.

For example, the alternative syntax will consider an argument following the option a
filename. mpv -fs no will attempt to play a file named no, because --fs is a flag option
that requires no parameter. If an option changes and its parameter becomes optional, then
a command line using the alternative syntax will break.

Currently, the parser makes no difference whether an option starts with -- or a single -.
This might also change in the future, and --option value might always interpret value as
filename in order to reduce ambiguities.

Escaping spaces and other special characters
Keep in mind that the shell will partially parse and mangle the arguments you pass to mpv.
For example, you might need to quote or escape options and filenames:
mpv "filename with spaces.mkv" --title="window title"

It gets more complicated if the suboption parser is involved. The suboption parser puts
several options into a single string, and passes them to a component at once, instead of
using multiple options on the level of the command line.

The suboption parser can quote strings with " and [...]. Additionally, there is a special
form of quoting with %n% described below.

For example, assume the hypothetical foo filter can take multiple options:
mpv test.mkv --vf=foo:option1=value1:option2:option3=value3,bar

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 '--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 " quotes.

The [...] form of quotes wraps everything between [ and ]. It's useful with shells that
don't interpret these characters in the middle of an argument (like bash). These quotes
are balanced (since mpv 0.9.0): the [ and ] nest, and the quote terminates on the last ]
that has no matching [ within the string. (For example, [a[b]c] results in a[b]c.)

The fixed-length quoting syntax is intended for use with external scripts and programs.

It is started with % and has the following format:

%n%string_of_length_n

Examples

mpv '--vf=foo:option1=%11%quoted text' test.avi

Or in a script:

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 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.

Paths
Some care must be taken when passing arbitrary paths and filenames to mpv. For example,
paths starting with - will be interpreted as options. Likewise, if a path contains the
sequence ://, the string before that might be interpreted as protocol prefix, even though
:// can be part of a legal UNIX path. To avoid problems with arbitrary paths, you should
be sure that absolute paths passed to mpv start with /, and prefix relative paths with ./.

Using the file:// pseudo-protocol is discouraged, because it involves strange URL
unescaping rules.

The name - itself is interpreted as stdin, and will cause mpv to disable console controls.
(Which makes it suitable for playing data piped to stdin.)

The special argument -- can be used to stop mpv from interpreting the following arguments
as options.

When using the client API, you should strictly avoid using mpv_command_string for invoking
the loadfile command, and instead prefer e.g. mpv_command to avoid the need for filename
escaping.

For paths passed to suboptions, the situation is further complicated by the need to escape
special characters. To work this around, the path can be additionally wrapped in the
fixed-length syntax, e.g. %n%string_of_length_n (see above).

Some mpv options interpret paths starting with ~. Currently, the prefix ~~/ expands to the
mpv configuration directory (usually ~/.config/mpv/). ~/ expands to the user's home
directory. (The trailing / is always required.) There are the following paths as well:

┌─────────────┬──────────────────────────────────┐
│Name │ Meaning │
├─────────────┼──────────────────────────────────┤
│~~home/ │ same as ~~/ │
├─────────────┼──────────────────────────────────┤
│~~global/ │ the global config path, if │
│ │ available (not on win32) │
├─────────────┼──────────────────────────────────┤
│~~osxbundle/ │ the OSX bundle resource path │
│ │ (OSX only) │
├─────────────┼──────────────────────────────────┤
│~~desktop/ │ the path to the desktop (win32, │
│ │ OSX) │
└─────────────┴──────────────────────────────────┘

Per-File Options
When playing multiple files, any option given on the command line usually affects all
files. Example:

mpv --a file1.mkv --b file2.mkv --c

┌──────────┬────────────────┐
│File │ Active options │
├──────────┼────────────────┤
│file1.mkv │ --a --b --c │
├──────────┼────────────────┤
│file2.mkv │ --a --b --c │
└──────────┴────────────────┘

(This is different from MPlayer and mplayer2.)

Also, if any option is changed at runtime (via input commands), they are not reset when a
new file is played.

Sometimes, it is useful to change options per-file. This can be achieved by adding the
special per-file markers --{ and --}. (Note that you must escape these on some shells.)
Example:

mpv --a file1.mkv --b --\{ --c file2.mkv --d file3.mkv --e --\} file4.mkv --f

┌──────────┬─────────────────────────┐
│File │ Active options │
├──────────┼─────────────────────────┤
│file1.mkv │ --a --b --f │
├──────────┼─────────────────────────┤
│file2.mkv │ --a --b --f --c --d --e │
├──────────┼─────────────────────────┤
│file3.mkv │ --a --b --f --c --d --e │
├──────────┼─────────────────────────┤
│file4.mkv │ --a --b --f │
└──────────┴─────────────────────────┘

Additionally, any file-local option changed at runtime is reset when the current file
stops playing. If option --c is changed during playback of file2.mkv, it is reset when
advancing to file3.mkv. This only affects file-local options. The option --a is never
reset here.

List Options
Some options which store lists of option values can have action suffixes. For example, you
can set a ,-separated list of filters with --vf, but the option also allows you to append
filters with --vf-append.

Options for filenames do not use , as separator, but : (Unix) or ; (Windows).

┌────────┬──────────────────────────────────┐
│Suffix │ Meaning │
├────────┼──────────────────────────────────┤
│-add │ Append 1 or more items (may │
│ │ become alias for -append) │
├────────┼──────────────────────────────────┤
│-append │ Append single item (avoids need │
│ │ for escaping) │
├────────┼──────────────────────────────────┤
│-clr │ Clear the option │
├────────┼──────────────────────────────────┤
│-del │ Delete an existing item by │
│ │ integer index │
├────────┼──────────────────────────────────┤
│-pre │ Prepend 1 or more items │
├────────┼──────────────────────────────────┤
│-set │ Set a list of items │
└────────┴──────────────────────────────────┘

Although some operations allow specifying multiple ,-separated items, using this is
strongly discouraged and deprecated, except for -set.

Without suffix, the action taken is normally -set.

Some options (like --sub-file, --audio-file, --opengl-shader) are aliases for the proper
option with -append action. For example, --sub-file is an alias for --sub-files-append.

Playing DVDs
DVDs can be played with the dvd://[title] syntax. The optional title specifier is a number
which selects between separate video streams on the DVD. If no title is given (dvd://)
then the longest title is selected automatically by the library. This is usually what you
want. mpv does not support DVD menus.

DVDs which have been copied on to a hard drive or other mounted filesystem (by e.g. the
dvdbackup tool) are accommodated by specifying the path to the local copy:
--dvd-device=PATH. Alternatively, running mpv PATH should auto-detect a DVD directory
tree and play the longest title.

NOTE:
DVD library choices

mpv uses a different default DVD library than MPlayer. MPlayer uses libdvdread by
default, and mpv uses libdvdnav by default. Both libraries are developed in parallel,
but libdvdnav is intended to support more sophisticated DVD features such as menus and
multi-angle playback. mpv uses libdvdnav for files specified as either dvd://... or
dvdnav://.... To use libdvdread, which will produce behavior more like MPlayer, specify
dvdread://... instead. Some users have experienced problems when using libdvdnav, in
which playback gets stuck in a DVD menu stream. These problems are reported to go away
when auto-selecting the title (dvd:// rather than dvd://1) or when using libdvdread
(e.g. dvdread://0). There are also outstanding bugs in libdvdnav with seeking backwards
and forwards in a video stream. Specify dvdread://... to fix such problems.

NOTE:
DVD subtitles

DVDs use image-based subtitles. Image subtitles are implemented as a bitmap video
stream which can be superimposed over the main movie. mpv's subtitle styling and
positioning options and keyboard shortcuts generally do not work with image-based
subtitles. Exceptions include options like --stretch-dvd-subs and
--stretch-image-subs-to-screen.

CONFIGURATION FILES

Location and Syntax
You can put all of the options in configuration files which will be read every time mpv is
run. The system-wide configuration file 'mpv.conf' is in your configuration directory
(e.g. /etc/mpv or /usr/local/etc/mpv), the user-specific one is ~/.config/mpv/mpv.conf.
For details and platform specifics (in particular Windows paths) see the FILES section.

User-specific options override system-wide options and options given on the command line
override either. The syntax of the configuration files is option=value. Everything after a
# is considered a comment. Options that work without values can be enabled by setting them
to yes and disabled by setting them to no. Even suboptions can be specified in this way.

Example configuration file

# Use opengl video output by default.
vo=opengl
# Use quotes for text that can contain spaces:
status-msg="Time: ${time-pos}"

Escaping spaces and special characters
This is done like with command line options. The shell is not involved here, but option
values still need to be quoted as a whole if it contains certain characters like spaces. A
config entry can be quoted with ", as well as with the fixed-length syntax (%n%) mentioned
before. This is like passing the exact contents of the quoted string as 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.)

Putting Command Line Options into the Configuration File
Almost all command line options can be put into the configuration file. Here is a small
guide:

┌──────────────────┬──────────────────────────┐
│Option │ Configuration file entry │
├──────────────────┼──────────────────────────┤
│--flag │ flag │
├──────────────────┼──────────────────────────┤
│-opt val │ opt=val │
├──────────────────┼──────────────────────────┤
│--opt=val │ opt=val │
├──────────────────┼──────────────────────────┤
│-opt "has spaces" │ opt="has spaces" │
└──────────────────┴──────────────────────────┘

File-specific Configuration Files
You can also write file-specific configuration files. If you wish to have a configuration
file for a file called 'video.avi', create a file named 'video.avi.conf' with the
file-specific options in it and put it in ~/.config/mpv/. You can also put the
configuration file in the same directory as the file to be played. Both require you to set
the --use-filedir-conf option (either on the command line or in your global config file).
If a file-specific configuration file is found in the same directory, no file-specific
configuration is loaded from ~/.config/mpv. In addition, the --use-filedir-conf option
enables directory-specific configuration files. For this, mpv first tries to load a
mpv.conf from the same directory as the file played and then tries to load any
file-specific configuration.

Profiles
To ease working with different configurations, profiles can be defined in the
configuration files. A profile starts with its name in square brackets, e.g. [my-profile].
All following options will be part of the profile. A description (shown by --profile=help)
can be defined with the profile-desc option. To end the profile, start another one or use
the profile name default to continue with normal options.

Example mpv config file with profiles

# normal top-level option
fullscreen=yes

# a profile that can be enabled with --profile=big-cache
[big-cache]
cache=123400
demuxer-readahead-secs=20

[slow]
profile-desc="some profile name"
# reference a builtin profile
profile=opengl-hq

[fast]
vo=vdpau

# using a profile again extends it
[slow]
framedrop=no
# you can also include other profiles
profile=big-cache

Auto profiles
Some profiles are loaded automatically. The following example demonstrates this:

Auto profile loading

[protocol.dvd]
profile-desc="profile for dvd:// streams"
alang=en

[extension.flv]
profile-desc="profile for .flv files"
vf=flip

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).

This feature is very limited, and there are no other auto profiles.

TAKING SCREENSHOTS

       Screenshots  of  the  currently played file can be taken using the 'screenshot' input mode
       command, which is by default bound to the s key.  Files  named  mpv-shotNNNN.jpg  will  be
       saved  in  the  working  directory,  using  the  first available number - no files will be
       overwritten. In pseudo-GUI mode, the screenshot will be saved somewhere else.  See  PSEUDO
       GUI MODE.

       A  screenshot  will  usually  contain  the unscaled video contents at the end of the video
       filter chain and subtitles. By default, S takes screenshots  without  subtitles,  while  s
       includes subtitles.

       Unlike  with  MPlayer,  the screenshot video filter is not required. This filter was never
       required in mpv, and has been removed.

TERMINAL STATUS LINE

During playback, mpv shows the playback status on the terminal. It looks like something
like this:
AV: 00:03:12 / 00:24:25 (13%) A-V: -0.000

The status line can be overridden with the --term-status-msg option.

The following is a list of things that can show up in the status line. Input properties,
that can be used to get the same information manually, are also listed.

• AV: or V: (video only) or A: (audio only)

• The current time position in HH:MM:SS format (playback-time property)

• The total file duration (absent if unknown) (length property)

• Playback speed, e.g. `` x2.0``. Only visible if the speed is not normal. This is the
user-requested speed, and not the actual speed (usually they should be the same, unless
playback is too slow). (speed property.)

• Playback percentage, e.g. (13%). How much of the file has been played. Normally
calculated out of playback position and duration, but can fallback to other methods
(like byte position) if these are not available. (percent-pos property.)

• The audio/video sync as A-V: 0.000. This is the difference between audio and video
time. Normally it should be 0 or close to 0. If it's growing, it might indicate a
playback problem. (avsync property.)

• Total A/V sync change, e.g. ct: -0.417. Normally invisible. Can show up if there is
audio "missing", or not enough frames can be dropped. Usually this will indicate a
problem. (total-avsync-change property.)

• Encoding state in {...}, only shown in encoding mode.

• Display sync state. If display sync is active (display-sync-active property), this shows
DS: 2.500/13, where the first number is average number of vsyncs per video frame (e.g.
2.5 when playing 24Hz videos on 60Hz screens), which might jitter if the ratio doesn't
round off, or there are mistimed frames (vsync-ratio), and the second number of
estimated number of vsyncs which took too long (vo-delayed-frame-count property). The
latter is a heuristic, as it's generally not possible to determine this with certainty.

• Dropped frames, e.g. Dropped: 4. Shows up only if the count is not 0. Can grow if the
video framerate is higher than that of the display, or if video rendering is too slow.
May also be incremented on "hiccups" and when the video frame couldn't be displayed on
time. (vo-drop-frame-count property.) If the decoder drops frames, the number of
decoder-dropped frames is appended to the display as well, e.g.: Dropped: 4/34. This
happens only if decoder frame dropping is enabled with the --framedrop options.
(drop-frame-count property.)

• Cache state, e.g. Cache: 2s+134KB. Visible if the stream cache is enabled. The first
value shows the amount of video buffered in the demuxer in seconds, the second value
shows additional data buffered in the stream cache in kilobytes. (demuxer-cache-duration
and cache-used properties.)

PROTOCOLS

http://..., https://, ...
Many network protocols are supported, but the protocol prefix must always be specified.
mpv will never attempt to guess whether a filename is actually a network address. A
protocol prefix is always required.

Note that not all prefixes are documented here. Undocumented prefixes are 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 can also prefix it with lavf:// or
ffmpeg://.

ytdl://...
By default, the youtube-dl hook script (enabled by default for mpv CLI) only looks at
http URLs. Prefixing an URL with ytdl:// forces it to be always processed by the
script. This can also be used to invoke special youtube-dl functionality like playing a
video by ID or invoking search.

Keep in mind that you can't pass youtube-dl command line options by this, and you have
to use --ytdl-raw-options instead.

-
Play data from stdin.

smb://PATH
Play a path from Samba share.

bd://[title][/device] --bluray-device=PATH
Play a Blu-ray disc. Currently, this does not accept ISO files. Instead, you must mount
the ISO file as filesystem, and point --bluray-device to the mounted directory
directly.

title can be: longest or first (selects the default playlist); mpls/<number> (selects
<number>.mpls playlist); <number> (select playlist with the same index). You can list
the available playlists with --msg-level=bd=v.

dvd://[title|[starttitle]-endtitle][/device] --dvd-device=PATH
Play a DVD. DVD menus are not supported. If no title is given, the longest title is
auto-selected.

dvdnav:// is an old alias for dvd:// and does exactly the same thing.

dvdread://...:
Play a DVD using the old libdvdread code. This is what MPlayer and older mpv versions
use for dvd://. Use is discouraged. It's provided only for compatibility and for
transition, and to work around outstanding dvdnav bugs (see "DVD library choices"
above).

tv://[channel][/input_id] --tv-...
Analogue TV via V4L. Also useful for webcams. (Linux only.)

pvr:// --pvr-...
PVR. (Linux only.)

dvb://[cardnumber@]channel --dvbin-...
Digital TV via DVB. (Linux only.)

mf://[filemask|@listfile] --mf-...
Play a series of images as video.

cdda://[device] --cdrom-device=PATH --cdda-...
Play CD.

lavf://...
Access any FFmpeg/Libav libavformat protocol. Basically, this passed the string after
the // directly to libavformat.

av://type:options
This is intended for using libavdevice inputs. type is the libavdevice demuxer name,
and options is the (pseudo-)filename passed to the demuxer.

For example, mpv av://lavfi:mandelbrot makes use of the libavfilter wrapper included in
libavdevice, and will use the mandelbrot source filter to generate input data.

avdevice:// is an alias.

file://PATH
A local path as URL. Might be useful in some special use-cases. Note that PATH itself
should start with a third / to make the path an absolute path.

fd://123
Read data from the given file descriptor (for example 123). This is similar to piping
data to stdin via -, but can use an arbitrary file descriptor.

fdclose://123
Like fd://, but the file descriptor is closed after use. When using this you need to
ensure that the same fd URL will only be used once.

edl://[edl specification as in edl-mpv.rst]
Stitch together parts of multiple files and play them.

null://
Simulate an empty file. If opened for writing, it will discard all data. The null
demuxer will specifically pass autoprobing if this protocol is used (while it's not
automatically invoked for empty files).

memory://data
Use the data part as source data.

hex://data
Like memory://, but the string is interpreted as hexdump.

PSEUDO GUI MODE

       mpv has no official GUI, other than the OSC (ON SCREEN CONTROLLER), which is  not  a  full
       GUI  and is not meant to be. However, to compensate for the lack of expected GUI behavior,
       mpv will in some cases start with some settings changed to behave slightly more like a GUI
       mode.

       Currently this happens only in the following cases:

       • if  started  using  the  mpv.desktop  file  on  Linux  (e.g.  started from menus 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)

       • started out of the bundle on OSX

       • if you manually use --player-operation-mode=pseudo-gui on the command line

       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:

          [builtin-pseudo-gui]
          terminal=no
          force-window=yes
          idle=once
          screenshot-directory=~~desktop/
          [pseudo-gui]
          player-operation-mode=pseudo-gui

       WARNING:
          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.

OPTIONS

Track Selection
--alang=<languagecode[,languagecode,...]>
Specify a priority list of audio languages to use. Different container formats
employ different language codes. DVDs use ISO 639-1 two-letter language codes,
Matroska, MPEG-TS and NUT use ISO 639-2 three-letter language codes, while OGM uses
a free-form identifier. See also --aid.

Examples

• mpv dvd://1 --alang=hu,en chooses the Hungarian language track on a DVD and
falls back on English if Hungarian is not available.

• mpv --alang=jpn example.mkv plays a Matroska file with Japanese audio.

--slang=<languagecode[,languagecode,...]>
Specify a priority list of subtitle languages to use. Different container formats
employ different language codes. DVDs use ISO 639-1 two letter language codes,
Matroska uses ISO 639-2 three letter language codes while OGM uses a free-form
identifier. See also --sid.

Examples

• mpv dvd://1 --slang=hu,en chooses the Hungarian subtitle track on a DVD and
falls back on English if Hungarian is not available.

• mpv --slang=jpn example.mkv plays a Matroska file with Japanese subtitles.

--aid=<ID|auto|no>
Select audio track. auto selects the default, no disables audio. See also --alang.
mpv normally prints available audio tracks on the terminal when starting playback
of a file.

--audio is an alias for --aid.

--aid=no or --audio=no or --no-audio disables audio playback. (The latter variant
does not work with the client API.)

--sid=<ID|auto|no>
Display the subtitle stream specified by <ID>. auto selects the default, no
disables subtitles.

--sub is an alias for --sid.

--sid=no or --sub=no or --no-sub disables subtitle decoding. (The latter variant
does not work with the client API.)

--vid=<ID|auto|no>
Select video channel. auto selects the default, no disables video.

--video is an alias for --vid.

--vid=no or --video=no or --no-video disables video playback. (The latter variant
does not work with the client API.)

If video is disabled, mpv will try to download the audio only if media is streamed
with youtube-dl, because it saves bandwidth. This is done by setting the
ytdl_format to "bestaudio/best" in the ytdl_hook.lua script.

Note that with external tracks (added with --sub-files and similar options), there
will be streams with duplicate IDs. In this case, the first stream in order is
selected.

--edition=<ID|auto>
(Matroska files only) Specify the edition (set of chapters) to use, where 0 is the
first. If set to auto (the default), mpv will choose the first edition declared as
a default, or if there is no default, the first edition defined.

--track-auto-selection=<yes|no>
Enable the default track auto-selection (default: yes). Enabling this will make the
player select streams according to --aid, --alang, and others. If it is disabled,
no tracks are selected. In addition, the player will not exit if no tracks are
selected, and wait instead (this wait mode is similar to pausing, but the pause
option is not set).

This is useful with --lavfi-complex: you can start playback in this mode, and then
set select tracks at runtime by setting the filter graph. Note that if
--lavfi-complex is set before playback is started, the referenced tracks are always
selected.

Playback Control
--start=<relative time>
Seek to given time position.

The general format for absolute times is [[hh:]mm:]ss[.ms]. If the time is given
with a prefix of + or -, the seek is relative from the start or end of the file.
(Since mpv 0.14, the start of the file is always considered 0.)

pp% seeks to percent position pp (0-100).

#c seeks to chapter number c. (Chapters start from 1.)

Examples

--start=+56, --start=+00:56
Seeks to the start time + 56 seconds.

--start=-56, --start=-00:56
Seeks to the end time - 56 seconds.

--start=01:10:00
Seeks to 1 hour 10 min.

--start=50%
Seeks to the middle of the file.

--start=30 --end=40
Seeks to 30 seconds, plays 10 seconds, and exits.

--start=-3:20 --length=10
Seeks to 3 minutes and 20 seconds before the end of the file, plays 10
seconds, and exits.

--start='#2' --end='#4'
Plays chapters 2 and 3, and exits.

--end=<time>
Stop at given absolute time. Use --length if the time should be relative to
--start. See --start for valid option values and examples.

--length=<relative time>
Stop after a given time relative to the start time. See --start for valid option
values and examples.

--rebase-start-time=<yes|no>
Whether to move the file start time to 00:00:00 (default: yes). This is less
awkward for files which start at a random timestamp, such as transport streams. On
the other hand, if there are timestamp resets, the resulting behavior can be rather
weird. For this reason, and in case you are actually interested in the real
timestamps, this behavior can be disabled with no.

--speed=<0.01-100>
Slow down or speed up playback by the factor given as parameter.

If --audio-pitch-correction (on by default) is used, playing with a speed higher
than normal automatically inserts the scaletempo audio filter.

--pause
Start the player in paused state.

--shuffle
Play files in random order.

--chapter=<start[-end]>
Specify which chapter to start playing at. Optionally specify which chapter to end
playing at.

AUDIO OUTPUT DRIVERS

Audio output drivers are interfaces to different audio output facilities. The syntax is:

--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.

NOTE:
See --ao=help for a list of compiled-in audio output drivers. The driver --ao=alsa is
preferred. --ao=pulse is preferred on systems where PulseAudio is used. On BSD systems,
--ao=oss or --ao=sndio may work (the latter being experimental).

Available audio output drivers are:

alsa (Linux only)
ALSA audio output driver

See ALSA audio output options for options specific to this AO.

WARNING:
To get multichannel/surround audio, use --audio-channels=auto. The default for
this option is auto-safe, which makes this audio otuput explicitly reject
multichannel output, as there is no way to detect whether a certain channel
layout is actually supported.

You can also try using the upmix plugin. This setup enables multichannel audio
on the default device with automatic upmixing with shared access, so playing
stereo and multichannel audio at the same time will work as expected.

oss OSS audio output driver

The following global options are supported by this audio output:

--oss-mixer-device
Sets the audio mixer device (default: /dev/mixer).

--oss-mixer-channel
Sets the audio mixer channel (default: pcm). Other valid values include vol,
pcm, line. For a complete list of options look for SOUND_DEVICE_NAMES in
/usr/include/linux/soundcard.h.

jack JACK (Jack Audio Connection Kit) audio output driver.

The following global options are supported by this audio output:

--jack-port=<name>
Connects to the ports with the given name (default: physical ports).

--jack-name=<client>
Client name that is passed to JACK (default: mpv). Useful if you want to
have certain connections established automatically.

--jack-autostart=<yes|no>
Automatically start jackd if necessary (default: disabled). Note that this
tends to be unreliable and will flood stdout with server messages.

--jack-connect=<yes|no>
Automatically create connections to output ports (default: enabled). When
enabled, the maximum number of output channels will be limited to the number
of available output ports.

--jack-std-channel-layout=<waveext|any>
Select the standard channel layout (default: waveext). JACK itself has no
notion of channel layouts (i.e. assigning which speaker a given channel is
supposed to map to) - it just takes whatever the application outputs, and
reroutes it to whatever the user defines. This means the user and the
application are in charge of dealing with the channel layout. waveext uses
WAVE_FORMAT_EXTENSIBLE order, which, even though it was defined by
Microsoft, is the standard on many systems. The value any makes JACK accept
whatever comes from the audio filter chain, regardless of channel layout and
without reordering. This mode is probably not very useful, other than for
debugging or when used with fixed setups.

coreaudio (Mac OS X only)
Native Mac OS X audio output driver using AudioUnits and the CoreAudio sound
server.

Automatically redirects to coreaudio_exclusive when playing compressed formats.

The following global options are supported by this audio output:

--coreaudio-change-physical-format=<yes|no>
Change the physical format to one similar to the requested audio format
(default: no). This has the advantage that multichannel audio output will
actually work. The disadvantage is that it will change the system-wide audio
settings. This is equivalent to changing the Format setting in the Audio
Devices dialog in the Audio MIDI Setup utility. Note that this does not
affect the selected speaker setup.

--coreaudio-spdif-hack=<yes|no>
Try to pass through AC3/DTS data as PCM. This is useful for drivers which do
not report AC3 support. It converts the AC3 data to float, and assumes the
driver will do the inverse conversion, which means a typical A/V receiver
will pick it up as compressed IEC framed AC3 stream, ignoring that it's
marked as PCM. This disables normal AC3 passthrough (even if the device
reports it as supported). Use with extreme care.

coreaudio_exclusive (Mac OS X only)
Native Mac OS X audio output driver using direct device access and exclusive mode
(bypasses the sound server).

openal Experimental OpenAL audio output driver

NOTE:
This driver is not very useful. Playing multi-channel audio with it is slow.

pulse PulseAudio audio output driver

The following global options are supported by this audio output:

--pulse-host=<host>
Specify the host to use. An empty <host> string uses a local connection,
"localhost" uses network transfer (most likely not what you want).

--pulse-buffer=<1-2000|native>
Set the audio buffer size in milliseconds. A higher value buffers more data,
and has a lower probability of buffer underruns. A smaller value makes the
audio stream react faster, e.g. to playback speed changes. Default: 250.

--pulse-latency-hacks=<yes|no>
Enable hacks to workaround PulseAudio timing bugs (default: no). If enabled,
mpv will do elaborate latency calculations on its own. If disabled, it will
use PulseAudio automatically updated timing information. Disabling this
might help with e.g. networked audio or some plugins, while enabling it
might help in some unknown situations (it used to be required to get good
behavior on old PulseAudio versions).

If you have stuttering video when using pulse, try to enable this option.
(Or try to update PulseAudio.)

sdl SDL 1.2+ audio output driver. Should work on any platform supported by SDL 1.2, but
may require the SDL_AUDIODRIVER environment variable to be set appropriately for
your system.

NOTE:
This driver is for compatibility with extremely foreign environments, such as
systems where none of the other drivers are available.

The following global options are supported by this audio output:

--sdl-buflen=<length>
Sets the audio buffer length in seconds. Is used only as a hint by the sound
system. Playing a file with -v will show the requested and obtained exact
buffer size. A value of 0 selects the sound system default.

--sdl-bufcnt=<count>
Sets the number of extra audio buffers in mpv. Usually needs not be changed.

null 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:

--ao-null-untimed
Do not simulate timing of a perfect audio device. This means audio decoding
will go as fast as possible, instead of timing it to the system clock.

--ao-null-buffer
Simulated buffer length in seconds.

--ao-null-outburst
Simulated chunk size in samples.

--ao-null-speed
Simulated audio playback speed as a multiplier. Usually, a real audio device
will not go exactly as fast as the system clock. It will deviate just a
little, and this option helps to simulate this.

--ao-null-latency
Simulated device latency. This is additional to EOF.

--ao-null-broken-eof
Simulate broken audio drivers, which always add the fixed device latency to
the reported audio playback position.

--ao-null-broken-delay
Simulate broken audio drivers, which don't report latency correctly.

--ao-null-channel-layouts
If not empty, this is a , separated list of channel layouts the AO allows.
This can be used to test channel layout selection.

pcm Raw PCM/WAVE file writer audio output

The following global options are supported by this audio output:

--ao-pcm-waveheader=<yes|no>
Include or do not include the WAVE header (default: included). When not
included, raw PCM will be generated.

--ao-pcm-file=<filename>
Write the sound to <filename> instead of the default audiodump.wav. If
no-waveheader is specified, the default is audiodump.pcm.

--ao-pcm-append=<yes|no>
Append to the file, instead of overwriting it. Always use this with the
no-waveheader option - with waveheader it's broken, because it will write a
WAVE header every time the file is opened.

rsound Audio output to an RSound daemon. Use --audio-device=rsound/<hostname> to set the
host name (with <hostname> replaced, without the < >).

NOTE:
Completely useless, unless you intend to run RSound. Not to be confused with
RoarAudio, which is something completely different.

sndio Audio output to the OpenBSD sndio sound system

NOTE:
Experimental. There are known bugs and issues.

(Note: only supports mono, stereo, 4.0, 5.1 and 7.1 channel layouts.)

wasapi Audio output to the Windows Audio Session API.

VIDEO OUTPUT DRIVERS

Video output drivers are interfaces to different video output facilities. The syntax is:

--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.

NOTE:
See --vo=help for a list of compiled-in video output drivers.

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:

xv (X11 only)
Uses the XVideo extension to enable hardware-accelerated display. This is the most
compatible VO on X, but may be low-quality, and has issues with OSD and subtitle
display.

NOTE:
This driver is for compatibility with old systems.

The following global options are supported by this video output:

--xv-adaptor=<number>
Select a specific XVideo adapter (check xvinfo results).

--xv-port=<number>
Select a specific XVideo port.

--xv-ck=<cur|use|set>
Select the source from which the color key is taken (default: cur).

cur The default takes the color key currently set in Xv.

use Use but do not set the color key from mpv (use the --colorkey option
to change it).

set Same as use but also sets the supplied color key.

--xv-ck-method=<none|man|bg|auto>
Sets the color key drawing method (default: man).

none Disables color-keying.

man Draw the color key manually (reduces flicker in some cases).

bg Set the color key as window background.

auto Let Xv draw the color key.

--xv-colorkey=<number>
Changes the color key to an RGB value of your choice. 0x000000 is black and
0xffffff is white.

--xv-buffers=<number>
Number of image buffers to use for the internal ringbuffer (default: 2).
Increasing this will use more memory, but might help with the X server not
responding quickly enough if video FPS is close to or higher than the
display refresh rate.

x11 (X11 only)
Shared memory video output driver without hardware acceleration that works whenever
X11 is present.

NOTE:
This is a fallback only, and should not be normally used.

vdpau (X11 only)
Uses the VDPAU interface to display and optionally also decode video. Hardware
decoding is used with --hwdec=vdpau.

NOTE:
Earlier versions of mpv (and MPlayer, mplayer2) provided sub-options to tune
vdpau post-processing, like deint, sharpen, denoise, chroma-deint, pullup,
hqscaling. These sub-options are deprecated, and you should use the vdpaupp
video filter instead.

The following global options are supported by this video output:

--vo-vdpau-sharpen=<-1-1>
(Deprecated. See note about vdpaupp.)

For positive values, apply a sharpening algorithm to the video, for negative
values a blurring algorithm (default: 0).

--vo-vdpau-denoise=<0-1>
(Deprecated. See note about vdpaupp.)

Apply a noise reduction algorithm to the video (default: 0; no noise
reduction).

--vo-vdpau-deint=<-4-4>
(Deprecated. See note about vdpaupp.)

Select deinterlacing mode (default: 0). In older versions (as well as
MPlayer/mplayer2) you could use this option to enable deinterlacing. This
doesn't work anymore, and deinterlacing is enabled with either the d key (by
default mapped to the command cycle deinterlace), or the --deinterlace
option. Also, to select the default deint mode, you should use something
like --vf-defaults=vdpaupp:deint-mode=temporal instead of this sub-option.

0 Pick the vdpaupp video filter default, which corresponds to 3.

1 Show only first field.

2 Bob deinterlacing.

3 Motion-adaptive temporal deinterlacing. May lead to A/V desync with
slow video hardware and/or high resolution.

4 Motion-adaptive temporal deinterlacing with edge-guided spatial
interpolation. Needs fast video hardware.

--vo-vdpau-chroma-deint
(Deprecated. See note about vdpaupp.)

Makes temporal deinterlacers operate both on luma and chroma (default). Use
no-chroma-deint to solely use luma and speed up advanced deinterlacing.
Useful with slow video memory.

--vo-vdpau-pullup
(Deprecated. See note about vdpaupp.)

Try to apply inverse telecine, needs motion adaptive temporal deinterlacing.

--vo-vdpau-hqscaling=<0-9>
(Deprecated. See note about vdpaupp.)

0 Use default VDPAU scaling (default).

1-9 Apply high quality VDPAU scaling (needs capable hardware).

--vo-vdpau-fps=<number>
Override autodetected display refresh rate value (the value is needed for
framedrop to allow video playback rates higher than display refresh rate,
and for vsync-aware frame timing adjustments). Default 0 means use
autodetected value. A positive value is interpreted as a refresh rate in Hz
and overrides the autodetected value. A negative value disables all timing
adjustment and framedrop logic.

--vo-vdpau-composite-detect
NVIDIA's current VDPAU implementation behaves somewhat differently under a
compositing window manager and does not give accurate frame timing
information. With this option enabled, the player tries to detect whether a
compositing window manager is active. If one is detected, the player
disables timing adjustments as if the user had specified fps=-1 (as they
would be based on incorrect input). This means timing is somewhat less
accurate than without compositing, but with the composited mode behavior of
the NVIDIA driver, there is no hard playback speed limit even without the
disabled logic. Enabled by default, use --vo-vdpau-composite-detect=no to
disable.

--vo-vdpau-queuetime-windowed=<number> and queuetime-fs=<number>
Use VDPAU's presentation queue functionality to queue future video frame
changes at most this many milliseconds in advance (default: 50). See below
for additional information.

--vo-vdpau-output-surfaces=<2-15>
Allocate this many output surfaces to display video frames (default: 3). See
below for additional information.

--vo-vdpau-colorkey=<#RRGGBB|#AARRGGBB>
Set the VDPAU presentation queue background color, which in practice is the
colorkey used if VDPAU operates in overlay mode (default: #020507, some
shade of black). If the alpha component of this value is 0, the default
VDPAU colorkey will be used instead (which is usually green).

--vo-vdpau-force-yuv
Never accept RGBA input. This means mpv will insert a filter to convert to a
YUV format before the VO. Sometimes useful to force availability of certain
YUV-only features, like video equalizer or deinterlacing.

Using the VDPAU frame queuing functionality controlled by the queuetime options
makes mpv's frame flip timing less sensitive to system CPU load and allows mpv to
start decoding the next frame(s) slightly earlier, which can reduce jitter caused
by individual slow-to-decode frames. However, the NVIDIA graphics drivers can make
other window behavior such as window moves choppy if VDPAU is using the blit queue
(mainly happens if you have the composite extension enabled) and this feature is
active. If this happens on your system and it bothers you then you can set the
queuetime value to 0 to disable this feature. The settings to use in windowed and
fullscreen mode are separate because there should be no reason to disable this for
fullscreen mode (as the driver issue should not affect the video itself).

You can queue more frames ahead by increasing the queuetime values and the
output_surfaces count (to ensure enough surfaces to buffer video for a certain time
ahead you need at least as many surfaces as the video has frames during that time,
plus two). This could help make video smoother in some cases. The main downsides
are increased video RAM requirements for the surfaces and laggier display response
to user commands (display changes only become visible some time after they're
queued). The graphics driver implementation may also have limits on the length of
maximum queuing time or number of queued surfaces that work well or at all.

direct3d (Windows only)
Video output driver that uses the Direct3D interface.

NOTE:
This driver is for compatibility with systems that don't provide proper OpenGL
drivers, and where ANGLE does not perform well.

NOTE:
Before to 0.21.0, direct3d_shaders and direct3d were different, with direct3d
not using shader by default. Now both use shaders by default, and
direct3d_shaders is a deprecated alias. Use the --vo-direct3d-prefer-stretchrect
or the --vo-direct3d-disable-shaders options to get the old behavior of
direct3d.

The following global options are supported by this video output:

--vo-direct3d-prefer-stretchrect
Use IDirect3DDevice9::StretchRect over other methods if possible.

--vo-direct3d-disable-stretchrect
Never render the video using IDirect3DDevice9::StretchRect.

--vo-direct3d-disable-textures
Never render the video using D3D texture rendering. Rendering with textures
+ shader will still be allowed. Add disable-shaders to completely disable
video rendering with textures.

--vo-direct3d-disable-shaders
Never use shaders when rendering video.

--vo-direct3d-only-8bit
Never render YUV video with more than 8 bits per component. Using this flag
will force software conversion to 8-bit.

--vo-direct3d-disable-texture-align
Normally texture sizes are always aligned to 16. With this option enabled,
the video texture will always have exactly the same size as the video
itself.

Debug options. These might be incorrect, might be removed in the future, might
crash, might cause slow downs, etc. Contact the developers if you actually need any
of these for performance or proper operation.

--vo-direct3d-force-power-of-2
Always force textures to power of 2, even if the device reports
non-power-of-2 texture sizes as supported.

--vo-direct3d-texture-memory=<mode>
Only affects operation with shaders/texturing enabled, and (E)OSD. Possible
values:

default (default)
Use D3DPOOL_DEFAULT, with a D3DPOOL_SYSTEMMEM texture for locking. If
the driver supports D3DDEVCAPS_TEXTURESYSTEMMEMORY, D3DPOOL_SYSTEMMEM
is used directly.

default-pool
Use D3DPOOL_DEFAULT. (Like default, but never use a shadow-texture.)

default-pool-shadow
Use D3DPOOL_DEFAULT, with a D3DPOOL_SYSTEMMEM texture for locking.
(Like default, but always force the shadow-texture.)

managed
Use D3DPOOL_MANAGED.

scratch
Use D3DPOOL_SCRATCH, with a D3DPOOL_SYSTEMMEM texture for locking.

--vo-direct3d-swap-discard
Use D3DSWAPEFFECT_DISCARD, which might be faster. Might be slower too, as
it must(?) clear every frame.

--vo-direct3d-exact-backbuffer
Always resize the backbuffer to window size.

opengl OpenGL video output driver. It supports extended scaling methods, dithering and
color management.

See OpenGL renderer options for options specific to this VO.

By default, it tries to use fast and fail-safe settings. Use the opengl-hq profile
to use this driver with defaults set to high quality rendering. (This profile is
also the replacement for --vo=opengl-hq.) The profile can be applied with
--profile=opengl-hq and its contents can be viewed with --show-profile=opengl-hq.

Requires at least OpenGL 2.1.

Some features are available with OpenGL 3 capable graphics drivers only (or if the
necessary extensions are available).

OpenGL ES 2.0 and 3.0 are supported as well.

Hardware decoding over OpenGL-interop is supported to some degree. Note that in
this mode, some corner case might not be gracefully handled, and color space
conversion and chroma upsampling is generally in the hand of the hardware decoder
APIs.

opengl makes use of FBOs by default. Sometimes you can achieve better quality or
performance by changing the --opengl-fbo-format option to rgb16f, rgb32f or rgb.
Known problems include Mesa/Intel not accepting rgb16, Mesa sometimes not being
compiled with float texture support, and some OS X setups being very slow with
rgb16 but fast with rgb32f. If you have problems, you can also try enabling the
--opengl-dumb-mode=yes option.

sdl SDL 2.0+ Render video output driver, depending on system with or without hardware
acceleration. Should work on all platforms supported by SDL 2.0. For tuning, refer
to your copy of the file SDL_hints.h.

NOTE:
This driver is for compatibility with systems that don't provide proper graphics
drivers, or which support GLES only.

The following global options are supported by this video output:

--sdl-sw
Continue even if a software renderer is detected.

--sdl-switch-mode
Instruct SDL to switch the monitor video mode when going fullscreen.

vaapi Intel VA API video output driver with support for hardware decoding. Note that
there is absolutely no reason to use this, other than compatibility. This is low
quality, and has issues with OSD.

NOTE:
This driver is for compatibility with crappy systems. You can use vaapi hardware
decoding with --vo=opengl too.

The following global options are supported by this video output:

--vo-vaapi-scaling=<algorithm>

default
Driver default (mpv default as well).

fast Fast, but low quality.

hq Unspecified driver dependent high-quality scaling, slow.

nla non-linear anamorphic scaling

--vo-vaapi-deint-mode=<mode>
Select deinterlacing algorithm. Note that by default deinterlacing is
initially always off, and needs to be enabled with the d key (default key
binding for cycle deinterlace).

This option doesn't apply if libva supports video post processing (vpp). In
this case, the default for deint-mode is no, and enabling deinterlacing via
user interaction using the methods mentioned above actually inserts the
vavpp video filter. If vpp is not actually supported with the libva backend
in use, you can use this option to forcibly enable VO based deinterlacing.

no Don't allow deinterlacing (default for newer libva).

first-field
Show only first field.

bob bob deinterlacing (default for older libva).

--vo-vaapi-scaled-osd=<yes|no>
If enabled, then the OSD is rendered at video resolution and scaled to
display resolution. By default, this is disabled, and the OSD is rendered at
display resolution if the driver supports it.

null Produces no video output. Useful for benchmarking.

Usually, it's better to disable video with --no-video instead.

The following global options are supported by this video output:

--vo-null-fps=<value>
Simulate display FPS. This artificially limits how many frames the VO
accepts per second.

caca Color ASCII art video output driver that works on a text console.

NOTE:
This driver is a joke.

tct Color Unicode art video output driver that works on a text console. Depends on
support of true color by modern terminals to display the images at full color
range. On Windows it requires an ansi terminal such as mintty.

--vo-tct-algo=<algo>
Select how to write the pixels to the terminal.

half-blocks
Uses unicode LOWER HALF BLOCK character to achieve higher vertical
resolution. (Default.)

plain Uses spaces. Causes vertical resolution to drop twofolds, but in
theory works in more places.

--vo-tct-width=<width> --vo-tct-height=<height>
Assume the terminal has the specified character width and/or height. These
default to 80x25 if the terminal size cannot be determined.

--vo-tct-256=<yes|no> (default: no)
Use 256 colors - for terminals which don't support true color.

image Output each frame into an image file in the current directory. Each file takes the
frame number padded with leading zeros as name.

The following global options are supported by this video output:

--vo-image-format=<format>
Select the image file format.

jpg JPEG files, extension .jpg. (Default.)

jpeg JPEG files, extension .jpeg.

png PNG files.

--vo-image-png-compression=<0-9>
PNG compression factor (speed vs. file size tradeoff) (default: 7)

--vo-image-png-filter=<0-5>
Filter applied prior to PNG compression (0 = none; 1 = sub; 2 = up; 3 =
average; 4 = Paeth; 5 = mixed) (default: 5)

--vo-image-jpeg-quality=<0-100>
JPEG quality factor (default: 90)

--vo-image-jpeg-optimize=<0-100>
JPEG optimization factor (default: 100)

--vo-image-outdir=<dirname>
Specify the directory to save the image files to (default: ./).

wayland (Wayland only)
Wayland shared memory video output as fallback for opengl.

NOTE:
This driver is for compatibility with systems that don't provide working OpenGL
drivers.

The following global options are supported by this video output:

--vo-wayland-alpha
Use a buffer format that supports videos and images with alpha information

--vo-wayland-rgb565
Use RGB565 as buffer format. This format is implemented on most platforms,
especially on embedded where it is far more efficient then RGB8888.

--vo-wayland-triple-buffering
Use 3 buffers instead of 2. This can lead to more fluid playback, but uses
more memory.

opengl-cb
For use with libmpv direct OpenGL embedding; useless in any other contexts. (See
<mpv/opengl_cb.h>.)

This also supports many of the options the opengl VO has.

rpi (Raspberry Pi)
Native video output on the Raspberry Pi using the MMAL API.

This is deprecated. Use --vo=opengl instead, which is the default and provides the
same functionality. The rpi VO will be removed in mpv 0.23.0. Its functionality was
folded into --vo=opengl, which now uses RPI hardware decoding by treating it as a
hardware overlay (without applying GL filtering). Also to be changed in 0.23.0: the
--fs flag will be reset to "no" by default (like on the other platforms).

The following deprecated global options are supported by this video output:

--rpi-display=<number>
Select the display number on which the video overlay should be shown
(default: 0).

--rpi-layer=<number>
Select the dispmanx layer on which the video overlay should be shown
(default: -10). Note that mpv will also use the 2 layers above the selected
layer, to handle the window background and OSD. Actual video rendering will
happen on the layer above the selected layer.

--rpi-background=<yes|no>
Whether to render a black background behind the video (default: no).
Normally it's better to kill the console framebuffer instead, which gives
better performance.

--rpi-osd=<yes|no>
Enabled by default. If disabled with no, no OSD layer is created. This also
means there will be no subtitles rendered.

drm (Direct Rendering Manager)
Video output driver using Kernel Mode Setting / Direct Rendering Manager. Should
be used when one doesn't want to install full-blown graphical environment (e.g. no
X). Does not support hardware acceleration (if you need this, check the drm backend
for opengl VO).

The following global options are supported by this video output:

--drm-connector=[<gpu_number>.]<name>
Select the connector to use (usually this is a monitor.) If <name> is empty
or auto, mpv renders the output on the first available connector. Use
--drm-connector=help to get list of available connectors. When using
multiple graphic cards, use the <gpu_number> argument to disambiguate.
(default: empty)

--drm-mode=<number>
Mode ID to use (resolution, bit depth and frame rate). (default: 0)

AUDIO FILTERS

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.

NOTE:
To get a full list of available audio filters, see --af=help.

Also, keep in mind that most actual filters are available via the lavfi wrapper, which
gives you access to most of libavfilter's filters. This includes all filters that have
been ported from MPlayer to libavfilter.

The --vf description describes how libavfilter can be used and how to workaround
deprecated mpv filters.

See --vf group of options for info on how --af-defaults, --af-add, --af-pre, --af-del,
--af-clr, and possibly others work.

Available filters are:

lavrresample[=option1:option2:...]
This filter uses libavresample (or libswresample, depending on the build) to change
sample rate, sample format, or channel layout of the audio stream. This filter is
automatically enabled if the audio output does not support the audio configuration
of the file being played.

It supports only the following sample formats: u8, s16, s32, float.

filter-size=<length>
Length of the filter with respect to the lower sampling rate. (default: 16)

phase-shift=<count>
Log2 of the number of polyphase entries. (..., 10->1024, 11->2048, 12->4096,
...) (default: 10->1024)

cutoff=<cutoff>
Cutoff frequency (0.0-1.0), default set depending upon filter length.

linear If set then filters will be linearly interpolated between polyphase entries.
(default: no)

no-detach
Do not detach if input and output audio format/rate/channels match. (If you
just want to set defaults for this filter that will be used even by
automatically inserted lavrresample instances, you should prefer setting
them with --af-defaults=lavrresample:....)

normalize=<yes|no|auto>
Whether to normalize when remixing channel layouts (default: auto). auto
uses the value set by --audio-normalize-downmix.

o=<string>
Set AVOptions on the SwrContext or AVAudioResampleContext. These should be
documented by FFmpeg or Libav.

lavcac3enc[=options]
Encode multi-channel audio to AC-3 at runtime using libavcodec. Supports 16-bit
native-endian input format, maximum 6 channels. The output is big-endian when
outputting a raw AC-3 stream, native-endian when outputting to S/PDIF. If the input
sample rate is not 48 kHz, 44.1 kHz or 32 kHz, it will be resampled to 48 kHz.

tospdif=<yes|no>
Output raw AC-3 stream if no, output to S/PDIF for pass-through if yes
(default).

bitrate=<rate>
The bitrate use for the AC-3 stream. Set it to 384 to get 384 kbps.

The default is 640. Some receivers might not be able to handle this.

Valid values: 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320,
384, 448, 512, 576, 640.

The special value auto selects a default bitrate based on the input channel
number:

1ch 96

2ch 192

3ch 224

4ch 384

5ch 448

6ch 448

minch=<n>
If the input channel number is less than <minch>, the filter will detach
itself (default: 3).

encoder=<name>
Select the libavcodec encoder used. Currently, this should be an AC-3
encoder, and using another codec will fail horribly.

equalizer=g1:g2:g3:...:g10
10 octave band graphic equalizer, implemented using 10 IIR band-pass filters. This
means that it works regardless of what type of audio is being played back. The
center frequencies for the 10 bands are:

┌────┬────────────┐
│No. │ frequency │
└────┴────────────┘

│0 │ 31.25 Hz │
├────┼────────────┤
│1 │ 62.50 Hz │
├────┼────────────┤
│2 │ 125.00 Hz │
├────┼────────────┤
│3 │ 250.00 Hz │
├────┼────────────┤
│4 │ 500.00 Hz │
├────┼────────────┤
│5 │ 1.00 kHz │
├────┼────────────┤
│6 │ 2.00 kHz │
├────┼────────────┤
│7 │ 4.00 kHz │
├────┼────────────┤
│8 │ 8.00 kHz │
├────┼────────────┤
│9 │ 16.00 kHz │
└────┴────────────┘

If the sample rate of the sound being played is lower than the center frequency for
a frequency band, then that band will be disabled. A known bug with this filter is
that the characteristics for the uppermost band are not completely symmetric if the
sample rate is close to the center frequency of that band. This problem can be
worked around by upsampling the sound using a resampling filter before it reaches
this filter.

<g1>:<g2>:<g3>:...:<g10>
floating point numbers representing the gain in dB for each frequency band
(-12-12)

Example

mpv --af=equalizer=11:11:10:5:0:-12:0:5:12:12 media.avi
Would amplify the sound in the upper and lower frequency region while
canceling it almost completely around 1 kHz.

channels=nch[:routes]
Can be used for adding, removing, routing and copying audio channels. If only <nch>
is given, the default routing is used. It works as follows: If the number of output
channels is greater than the number of input channels, empty channels are inserted
(except when mixing from mono to stereo; then the mono channel is duplicated). If
the number of output channels is less than the number of input channels, the
exceeding channels are truncated.

<nch> number of output channels (1-8)

<routes>
List of , separated routes, in the form from1-to1,from2-to2,.... Each pair
defines where to route each channel. There can be at most 8 routes. Without
this argument, the default routing is used. Since , is also used to separate
filters, you must quote this argument with [...] or similar.

Examples

mpv --af=channels=4:[0-1,1-0,2-2,3-3] media.avi
Would change the number of channels to 4 and set up 4 routes that swap
channel 0 and channel 1 and leave channel 2 and 3 intact. Observe that
if media containing two channels were played back, channels 2 and 3 would
contain silence but 0 and 1 would still be swapped.

mpv --af=channels=6:[0-0,0-1,0-2,0-3] media.avi
Would change the number of channels to 6 and set up 4 routes that copy
channel 0 to channels 0 to 3. Channel 4 and 5 will contain silence.

NOTE:
You should probably not use this filter. If you want to change the output
channel layout, try the format filter, which can make mpv automatically up- and
downmix standard channel layouts.

format=format:srate:channels:out-format:out-srate:out-channels
Does not do any format conversion itself. Rather, it may cause the filter system to
insert necessary conversion filters before or after this filter if needed. It is
primarily useful for controlling the audio format going into other filters. To
specify the format for audio output, see --audio-format, --audio-samplerate, and
--audio-channels. This filter is able to force a particular format, whereas
--audio-* may be overridden by the ao based on output compatibility.

All parameters are optional. The first 3 parameters restrict what the filter
accepts as input. They will therefore cause conversion filters to be inserted
before this one. The out- parameters tell the filters or audio outputs following
this filter how to interpret the data without actually doing a conversion. Setting
these will probably just break things unless you really know you want this for some
reason, such as testing or dealing with broken media.

<format>
Force conversion to this format. Use --af=format=format=help to get a list
of valid formats.

<srate>
Force conversion to a specific sample rate. The rate is an integer, 48000
for example.

<channels>
Force mixing to a specific channel layout. See --audio-channels option for
possible values.

<out-format>

<out-srate>

<out-channels>

NOTE: this filter used to be named force. The old format filter used to do
conversion itself, unlike this one which lets the filter system handle the
conversion.

volume[=<volumedb>[:...]]
Implements software volume control. Use this filter with caution since it can
reduce the signal to noise ratio of the sound. In most cases it is best to use the
Master volume control of your sound card or the volume knob on your amplifier.

WARNING: This filter is deprecated. Use the top-level options like --volume and
--replaygain... instead.

NOTE: This filter is not reentrant and can therefore only be enabled once for every
audio stream.

<volumedb>
Sets the desired gain in dB for all channels in the stream from -200 dB to
+60 dB, where -200 dB mutes the sound completely and +60 dB equals a gain of
1000 (default: 0).

replaygain-track
Adjust volume gain according to the track-gain replaygain value stored in
the file metadata.

replaygain-album
Like replaygain-track, but using the album-gain value instead.

replaygain-preamp
Pre-amplification gain in dB to apply to the selected replaygain gain
(default: 0).

replaygain-clip=yes|no
Prevent clipping caused by replaygain by automatically lowering the gain
(default). Use replaygain-clip=no to disable this.

replaygain-fallback
Gain in dB to apply if the file has no replay gain tags. This option is
always applied if the replaygain logic is somehow inactive. If this is
applied, no other replaygain options are applied.

softclip
Turns soft clipping on. Soft-clipping can make the sound more smooth if very
high volume levels are used. Enable this option if the dynamic range of the
loudspeakers is very low.

WARNING: This feature creates distortion and should be considered a last
resort.

s16 Force S16 sample format if set. Lower quality, but might be faster in some
situations.

detach Remove the filter if the volume is not changed at audio filter config time.
Useful with replaygain: if the current file has no replaygain tags, then the
filter will be removed if this option is enabled. (If --softvol=yes is used
and the player volume controls are used during playback, a different volume
filter will be inserted.)

Example

mpv --af=volume=10.1 media.avi
Would amplify the sound by 10.1 dB and hard-clip if the sound level is
too high.

pan=n:[<matrix>]
Mixes channels arbitrarily. Basically a combination of the volume and the channels
filter that can be used to down-mix many channels to only a few, e.g. stereo to
mono, or vary the "width" of the center speaker in a surround sound system. This
filter is hard to use, and will require some tinkering before the desired result is
obtained. The number of options for this filter depends on the number of output
channels. An example how to downmix a six-channel file to two channels with this
filter can be found in the examples section near the end.

<n> Number of output channels (1-8).

<matrix>
A list of values [L00,L01,L02,...,L10,L11,L12,...,Ln0,Ln1,Ln2,...], where
each element Lij means how much of input channel i is mixed into output
channel j (range 0-1). So in principle you first have n numbers saying what
to do with the first input channel, then n numbers that act on the second
input channel etc. If you do not specify any numbers for some input
channels, 0 is assumed. Note that the values are separated by ,, which is
already used by the option parser to separate filters. This is why you must
quote the value list with [...] or similar.

Examples

mpv --af=pan=1:[0.5,0.5] media.avi
Would downmix from stereo to mono.

mpv --af=pan=3:[1,0,0.5,0,1,0.5] media.avi
Would give 3 channel output leaving channels 0 and 1 intact, and mix
channels 0 and 1 into output channel 2 (which could be sent to a
subwoofer for example).

NOTE:
If you just want to force remixing to a certain output channel layout, it is
easier to use the format filter. For example, mpv '--af=format=channels=5.1'
'--audio-channels=5.1' would always force remixing audio to 5.1 and output it
like this.

This filter supports the following af-command commands:

set-matrix
Set the <matrix> argument dynamically. This can be used to change the mixing
matrix at runtime, without reinitializing the entire filter chain.

scaletempo[=option1:option2:...]
Scales audio tempo without altering pitch, optionally synced to playback speed
(default).

This works by playing 'stride' ms of audio at normal speed then consuming
'stride*scale' ms of input audio. It pieces the strides together by blending
'overlap'% of stride with audio following the previous stride. It optionally
performs a short statistical analysis on the next 'search' ms of audio to determine
the best overlap position.

scale=<amount>
Nominal amount to scale tempo. Scales this amount in addition to speed.
(default: 1.0)

stride=<amount>
Length in milliseconds to output each stride. Too high of a value will cause
noticeable skips at high scale amounts and an echo at low scale amounts.
Very low values will alter pitch. Increasing improves performance. (default:
60)

overlap=<percent>
Percentage of stride to overlap. Decreasing improves performance. (default:
.20)

search=<amount>
Length in milliseconds to search for best overlap position. Decreasing
improves performance greatly. On slow systems, you will probably want to set
this very low. (default: 14)

speed=<tempo|pitch|both|none>
Set response to speed change.

tempo Scale tempo in sync with speed (default).

pitch Reverses effect of filter. Scales pitch without altering tempo. Add
this to your input.conf to step by musical semi-tones:

[ multiply speed 0.9438743126816935
] multiply speed 1.059463094352953

WARNING:
Loses sync with video.

both Scale both tempo and pitch.

none Ignore speed changes.

Examples

mpv --af=scaletempo --speed=1.2 media.ogg
Would play media at 1.2x normal speed, with audio at normal pitch.
Changing playback speed would change audio tempo to match.

mpv --af=scaletempo=scale=1.2:speed=none --speed=1.2 media.ogg
Would play media at 1.2x normal speed, with audio at normal pitch, but
changing playback speed would have no effect on audio tempo.

mpv --af=scaletempo=stride=30:overlap=.50:search=10 media.ogg
Would tweak the quality and performance parameters.

mpv --af=scaletempo=scale=1.2:speed=pitch audio.ogg
Would play media at 1.2x normal speed, with audio at normal pitch.
Changing playback speed would change pitch, leaving audio tempo at 1.2x.

rubberband
High quality pitch correction with librubberband. This can be used in place of
scaletempo, and will be used to adjust audio pitch when playing at speed different
from normal. It can also be used to adjust audio pitch without changing playback
speed.

<pitch-scale>
Sets the pitch scaling factor. Frequencies are multiplied by this value.

This filter has a number of additional sub-options. You can list them with mpv
--af=rubberband=help. This will also show the default values for each option. The
options are not documented here, because they are merely passed to librubberband.
Look at the librubberband documentation to learn what each option does:
http://breakfastquay.com/rubberband/code-doc/classRubberBand_1_1RubberBandStretcher.html
(The mapping of the mpv rubberband filter sub-option names and values to those of
librubberband follows a simple pattern: "Option" + Name + Value.)

This filter supports the following af-command commands:

set-pitch
Set the <pitch-scale> argument dynamically. This can be used to change the
playback pitch at runtime. Note that speed is controlled using the standard
speed property, not af-command.

lavfi=graph
Filter audio using FFmpeg's libavfilter.

<graph>
Libavfilter graph. See lavfi video filter for details - the graph syntax is
the same.

WARNING:
Don't forget to quote libavfilter graphs as described in the lavfi video
filter section.

o=<string>
AVOptions.

VIDEO FILTERS

       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. 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> ]

              or for the special "toggle" syntax (see vf command):
                 "@"<label-name>

              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.

       --vf-defaults=<filter1[=parameter1:parameter2:...],filter2,...>
              Set defaults for each filter.

       NOTE:
          To   get   a   full   list   of   available   video   filters,   see   --vf=help    and
          http://ffmpeg.org/ffmpeg-filters.html .

          Also,  keep in mind that most actual filters are available via the lavfi wrapper, which
          gives you access to most of libavfilter's filters. This includes all filters that  have
          been ported from MPlayer to libavfilter.

          Most  builtin filters are deprecated in some ways, unless they're only available in mpv
          (such as filters which deal with mpv specifics, or which are implemented in mpv only).

          If a filter is not builtin, the lavfi-bridge will be automatically tried.  This  bridge
          does  not  support  help  output,  and  does not verify parameters before the filter is
          actually used. Although the mpv syntax is rather similar to libavfilter's, it's not the
          same.  (Which means not everything accepted by vf_lavfi's graph option will be accepted
          by --vf.)

          You can also prefix the filter name with lavfi- to force the wrapper.  This is  helpful
          if  the  filter  name  collides  with  a  deprecated  mpv  builtin  filter. For example
          --vf=lavfi-scale=args would  use  libavfilter's  scale  filter  over  mpv's  deprecated
          builtin one.

       Video filters are managed in lists. There are a few commands to manage the filter list.

       --vf-add=<filter1[,filter2,...]>
              Appends the filters given as arguments to the filter list.

       --vf-pre=<filter1[,filter2,...]>
              Prepends the filters given as arguments to the filter list.

       --vf-del=<index1[,index2,...]>
              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-clr
              Completely empties the filter list.

       With filters that support it, you can access parameters by their name.

       --vf=<filter>=help
              Prints the parameter names and parameter value ranges for a particular filter.

       --vf=<filter=named_parameter1=value1[:named_parameter2=value2:...]>
              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:

       crop[=w:h:x:y]
              Crops  the  given  part  of the image and discards the rest. Useful to remove black
              bands from widescreen videos.

              <w>,<h>
                     Cropped width and height, defaults to original width and height.

              <x>,<y>
                     Position of the cropped picture, defaults to center.

       expand[=w:h:x:y:aspect:round]
              Expands (not scales) video resolution to the given value and  places  the  unscaled
              original at coordinates x, y.

              <w>,<h>
                     Expanded  width,height (default: original width,height). Negative values for
                     w and h are treated as offsets to the original size.

                        Example

                        expand=0:-50:0:0
                               Adds a 50 pixel border to the bottom of the picture.

              <x>,<y>
                     position of original image on the expanded image (default: center)

              <aspect>
                     Expands to fit an aspect instead of a resolution (default: 0).

                        Example

                        expand=800::::4/3
                               Expands to 800x600, unless the source  is  higher  resolution,  in
                               which case it expands to fill a 4/3 aspect.

              <round>
                     Rounds up to make both width and height divisible by <r> (default: 1).

       flip   Flips the image upside down.

       mirror Mirrors the image on the Y axis.

       rotate[=0|90|180|270]
              Rotates the image by a multiple of 90 degrees clock-wise.

       scale[=w:h:param:param2:chr-drop:noup:arnd
              Scales  the  image  with  the software scaler (slow) and performs a YUV<->RGB color
              space conversion (see also --sws).

              All parameters are optional.

              <w>:<h>
                     scaled width/height (default: original width/height)

                     0      scaled d_width/d_height

                     -1     original width/height

                     -2     Calculate w/h using the other  dimension  and  the  prescaled  aspect
                            ratio.

                     -3     Calculate  w/h  using  the  other  dimension  and the original aspect
                            ratio.

                     -(n+8) Like -n above, but rounding the dimension to the closest multiple  of
                            16.

              <param>[:<param2>] (see also --sws)
                     Set  some  scaling  parameters depending on the type of scaler selected with
                     --sws:

                        --sws=2 (bicubic):  B (blurring) and C (ringing)
                            0.00:0.60 default
                            0.00:0.75 VirtualDub's "precise bicubic"
                            0.00:0.50 Catmull-Rom spline
                            0.33:0.33 Mitchell-Netravali spline
                            1.00:0.00 cubic B-spline

                        --sws=7 (Gaussian): sharpness (0 (soft) - 100 (sharp))

                        --sws=9 (Lanczos):  filter length (1-10)

              <chr-drop>
                     chroma skipping

                     0      Use all available input lines for chroma (default).

                     1      Use only every 2. input line for chroma.

                     2      Use only every 4. input line for chroma.

                     3      Use only every 8. input line for chroma.

              <noup> Disallow upscaling past the original dimensions.

                     0      Allow upscaling (default).

                     1      Disallow upscaling if one dimension exceeds its original value.

                     2      Disallow upscaling if both dimensions exceed their original values.

              <arnd> Accurate rounding for the vertical scaler, which may  be  faster  or  slower
                     than the default rounding.

                     no     Disable accurate rounding (default).

                     yes    Enable accurate rounding.

       dsize[=w:h:aspect-method:r:aspect]
              Changes  the  intended  display  aspect  at an arbitrary point in the filter chain.
              Aspect can be given as a fraction (4/3) or floating point number (1.33). Note  that
              this  filter  does  not  do  any scaling itself; it just affects what later scalers
              (software or hardware) will do when auto-scaling to the correct aspect.

              <w>,<h>
                     New aspect ratio given by a display  width  and  height.  Unlike  older  mpv
                     versions or MPlayer, this does not set the display size.

                     Can also be these special values:

                     0      original display width and height

                     -1     original video width and height (default)

                     -2     Calculate  w/h  using  the  other  dimension and the original display
                            aspect ratio.

                     -3     Calculate w/h using the other dimension and the original video aspect
                            ratio.

                        Example

                        dsize=800:-2
                               Specifies  a display resolution of 800x600 for a 4/3 aspect video,
                               or 800x450 for a 16/9 aspect video.

              <aspect-method>
                     Modifies width and height according to original aspect ratios.

                     -1     Ignore original aspect ratio (default).

                     0      Keep display aspect ratio by using <w> and <h> as maximum resolution.

                     1      Keep display aspect ratio by using <w> and <h> as minimum resolution.

                     2      Keep video aspect ratio by using <w> and <h> as maximum resolution.

                     3      Keep video aspect ratio by using <w> and <h> as minimum resolution.

                        Example

                        dsize=800:600:0
                               Specifies a display resolution of at most 800x600, or smaller,  in
                               order to keep aspect.

              <r>    Rounds up to make both width and height divisible by <r> (default: 1).

              <aspect>
                     Force an aspect ratio.

       format=fmt=<value>:colormatrix=<value>:...
              Restricts  the  color  space for the next filter without doing any conversion.  Use
              together with the scale filter for a real conversion.

              NOTE:
                 For a list of available formats, see format=fmt=help.

              <fmt>  Format name, e.g. rgb15, bgr24, 420p, etc. (default: don't change).

              <outfmt>
                     Format name that should be substituted for the output. If they do  not  have
                     the same bytes per pixel and chroma subsampling, it will fail.

              <colormatrix>
                     Controls the YUV to RGB color space conversion when playing video. There are
                     various standards. Normally, BT.601 should be used for SD video, and  BT.709
                     for HD video. (This is done by default.) Using incorrect color space results
                     in slightly under or over saturated and shifted colors.

                     These options are not always  supported.  Different  video  outputs  provide
                     varying  degrees  of  support.  The  opengl  and  vdpau video output drivers
                     usually offer full support. The xv output can set the  color  space  if  the
                     system  video driver supports it, but not input and output levels. The scale
                     video filter can configure color space and input levels,  but  only  if  the
                     output  format  is  RGB (if the video output driver supports RGB output, you
                     can force this with -vf scale,format=rgba).

                     If this option is set to auto (which is  the  default),  the  video's  color
                     space  flag  will  be  used.  If that flag is unset, the color space will be
                     selected automatically. This is done using a simple heuristic that  attempts
                     to distinguish SD and HD video. If the video is larger than 1279x576 pixels,
                     BT.709 (HD) will be used; otherwise BT.601 (SD) is selected.

                     Available color spaces are:

                     auto   automatic selection (default)

                     bt.601 ITU-R BT.601 (SD)

                     bt.709 ITU-R BT.709 (HD)

                     bt.2020-ncl
                            ITU-R BT.2020 non-constant luminance system

                     bt.2020-cl
                            ITU-R BT.2020 constant luminance system

                     smpte-240m
                            SMPTE-240M

              <colorlevels>
                     YUV color levels used with YUV  to  RGB  conversion.  This  option  is  only
                     necessary  when  playing  broken  files  which  do not follow standard color
                     levels or which are flagged wrong. If the video does not specify  its  color
                     range, it is assumed to be limited range.

                     The same limitations as with <colormatrix> apply.

                     Available color ranges are:

                     auto   automatic selection (normally limited range) (default)

                     limited
                            limited range (16-235 for luma, 16-240 for chroma)

                     full   full range (0-255 for both luma and chroma)

              <primaries>
                     RGB  primaries the source file was encoded with. Normally this should be set
                     in the file header, but when playing broken or mistagged files this  can  be
                     used to override the setting.

                     This option only affects video output drivers that perform color management,
                     for example opengl with the target-prim or icc-profile suboptions set.

                     If this option is set to auto (which is the default), the video's  primaries
                     flag  will  be used. If that flag is unset, the color space will be selected
                     automatically, using the following heuristics: If the <colormatrix>  is  set
                     or  determined  as  BT.2020 or BT.709, the corresponding primaries are used.
                     Otherwise, if the video height is exactly 576 (PAL), BT.601-625 is used.  If
                     it's  exactly 480 or 486 (NTSC), BT.601-525 is used. If the video resolution
                     is anything else, BT.709 is used.

                     Available primaries are:

                     auto   automatic selection (default)

                     bt.601-525
                            ITU-R BT.601 (SD) 525-line systems (NTSC, SMPTE-C)

                     bt.601-625
                            ITU-R BT.601 (SD) 625-line systems (PAL, SECAM)

                     bt.709 ITU-R BT.709 (HD) (same primaries as sRGB)

                     bt.2020
                            ITU-R BT.2020 (UHD)

                     apple  Apple RGB

                     adobe  Adobe RGB (1998)

                     prophoto
                            ProPhoto RGB (ROMM)

                     cie1931
                            CIE 1931 RGB

                     dci-p3 DCI-P3 (Digital Cinema)

                     v-gamut
                            Panasonic V-Gamut primaries

              <gamma>
                     Gamma function the source file was encoded with. Normally this should be set
                     in  the  file header, but when playing broken or mistagged files this can be
                     used to override the setting.

                     This option only affects video output drivers that perform color management.

                     If this option is set to auto (which is the default), the gamma will be  set
                     to  BT.1886  for  YCbCr  content,  sRGB  for  RGB content and Linear for XYZ
                     content.

                     Available gamma functions are:

                     auto   automatic selection (default)

                     bt.1886
                            ITU-R BT.1886 (EOTF corresponding to BT.601/BT.709/BT.2020)

                     srgb   IEC 61966-2-4 (sRGB)

                     linear Linear light

                     gamma1.8
                            Pure power curve (gamma 1.8)

                     gamma2.2
                            Pure power curve (gamma 2.2)

                     gamma2.8
                            Pure power curve (gamma 2.8)

                     prophoto
                            ProPhoto RGB (ROMM) curve

                     pq     ITU-R BT.2100 PQ (Perceptual quantizer) curve

                     hlg    ITU-R BT.2100 HLG (Hybrid Log-gamma) curve

                     v-log  Panasonic V-Log transfer curve

                     s-log1 Sony S-Log1 transfer curve

                     s-log2 Sony S-Log2 transfer curve

              <sig-peak>
                     Reference peak illumination for the video file,  relative  to  the  signal's
                     reference  white  level. This is mostly interesting for HDR, but it can also
                     be used tone map SDR content to  simulate  a  different  exposure.  Normally
                     inferred from tags such as MaxCLL or mastering metadata.

                     The default of 0.0 will default to the source's nominal peak luminance.

              <light>
                        Light  type  of the scene. This is mostly correctly inferred based on the
                        gamma function, but it can be useful to override this  when  viewing  raw
                        camera  footage (e.g. V-Log), which is normally scene-referred instead of
                        display-referred.

                        Available light types are:

                     auto   Automatic selection (default)

                     display
                            Display-referred light (most content)

                     hlg    Scene-referred using the HLG OOTF (e.g. HLG content)

                     709-1886
                            Scene-referred using the BT709+BT1886 interaction

                     gamma1.2
                            Scene-referred using a pure power OOTF (gamma=1.2)

              <stereo-in>
                     Set the stereo mode the video is assumed to be encoded in.  Takes  the  same
                     values as the --video-stereo-mode option.

              <stereo-out>
                     Set  the stereo mode the video should be displayed as. Takes the same values
                     as the --video-stereo-mode option.

              <rotate>
                     Set the rotation the video is assumed to be encoded with  in  degrees.   The
                     special value -1 uses the input format.

              <dw>, <dh>
                     Set the display size. Note that setting the display size such that the video
                     is scaled in both directions instead of just changing the aspect ratio is an
                     implementation detail, and might change later.

              <dar>  Set the display aspect ratio of the video frame. This is a float, but values
                     such as [16:9] can be passed too ([...] for quoting to  prevent  the  option
                     parser from interpreting the : character).

              <spherical-type>
                     Type of the spherical projection:

                     auto   As indicated by the file (default)

                     none   Normal video

                     equirect
                            Equirectangular

                     unknown
                            Unknown projection

              <spherical-yaw>, <spherical-pitch>, <spherical-roll>
                     Reference angle in degree, if spherical video is used.

       noformat[=fmt]
              Restricts the color space for the next filter without doing any conversion.  Unlike
              the format filter, this will allow any color space except the one you specify.

              NOTE:
                 For a list of available formats, see noformat=fmt=help.

              <fmt>  Format name, e.g. rgb15, bgr24, 420p, etc. (default: 420p).

       lavfi=graph[:sws-flags[:o=opts]]
              Filter video using FFmpeg's libavfilter.

              <graph>
                     The libavfilter graph string. The filter must have a single video input  pad
                     and a single video output pad.

                     See https://ffmpeg.org/ffmpeg-filters.html for syntax and available filters.

                     WARNING:
                        If  you  want to use the full filter syntax with this option, you have to
                        quote the filter graph in order to prevent mpv's syntax  and  the  filter
                        graph syntax from clashing.

                        Examples

                        -vf lavfi=[gradfun=20:30,vflip]
                               gradfun  filter  with  nonsense  parameters,  followed  by a vflip
                               filter. (This demonstrates how libavfilter takes a graph  and  not
                               just  a  single  filter.) The filter graph string is quoted with [
                               and ]. This requires no additional quoting or escaping  with  some
                               shells  (like  bash), while others (like zsh) require additional "
                               quotes around the option string.

                        '--vf=lavfi="gradfun=20:30,vflip"'
                               Same as before, but uses quoting that  should  be  safe  with  all
                               shells.  The  outer  '  quotes  make  sure that the shell does not
                               remove the " quotes needed by mpv.

                        '--vf=lavfi=graph="gradfun=radius=30:strength=20,vflip"'
                               Same as before, but uses named parameters for everything.

              <sws-flags>
                     If libavfilter inserts filters for  pixel  format  conversion,  this  option
                     gives the flags which should be passed to libswscale. This option is numeric
                     and takes a bit-wise combination of SWS_ flags.

                     See http://git.videolan.org/?p=ffmpeg.git;a=blob;f=libswscale/swscale.h.

              <o>    Set AVFilterGraph options. These should be documented by FFmpeg.

                        Example

                        '--vf=lavfi=yadif:o="threads=2,thread_type=slice"'
                               forces a specific threading configuration.

       pullup[=jl:jr:jt:jb:sb:mp]
              Pulldown  reversal  (inverse  telecine)   filter,   capable   of   handling   mixed
              hard-telecine,  24000/1001 fps progressive, and 30000/1001 fps progressive content.
              The pullup filter makes use of future  context  in  making  its  decisions.  It  is
              stateless  in  the  sense  that  it  does not lock onto a pattern to follow, but it
              instead looks forward to the following fields in  order  to  identify  matches  and
              rebuild progressive frames.

              jl, jr, jt, and jb
                     These  options  set  the amount of "junk" to ignore at the left, right, top,
                     and bottom of the image, respectively. Left/right are in units of 8  pixels,
                     while  top/bottom  are  in units of 2 lines. The default is 8 pixels on each
                     side.

              sb (strict breaks)
                     Setting this option to 1 will reduce the chances  of  pullup  generating  an
                     occasional  mismatched  frame,  but it may also cause an excessive number of
                     frames to be dropped during high motion sequences.  Conversely,  setting  it
                     to -1 will make pullup match fields more easily. This may help process video
                     with slight blurring between the  fields,  but  may  also  cause  interlaced
                     frames in the output.

              mp (metric plane)
                     This  option  may be set to u or v to use a chroma plane instead of the luma
                     plane for doing pullup's computations. This may  improve  accuracy  on  very
                     clean source material, but more likely will decrease accuracy, especially if
                     there is chroma noise (rainbow effect) or  any  grayscale  video.  The  main
                     purpose  of  setting  mp  to  a  chroma plane is to reduce CPU load and make
                     pullup usable in realtime on slow machines.

       yadif=[mode:interlaced-only]
              Yet another deinterlacing filter

              <mode>

                     frame  Output 1 frame for each frame.

                     field  Output 1 frame for each field (default).

                     frame-nospatial
                            Like frame but skips spatial interlacing check.

                     field-nospatial
                            Like field but skips spatial interlacing check.

              <interlaced-only>

                     no     Deinterlace all frames.

                     yes    Only deinterlace frames marked as interlaced (default).

              This filter is automatically inserted when using the d key (or any other  key  that
              toggles  the deinterlace property or when using the --deinterlace switch), assuming
              the video output does not have native deinterlacing support.

              If you just want to set the default mode, put this  filter  and  its  options  into
              --vf-defaults instead, and enable deinterlacing with d or --deinterlace.

              Also,  note  that  the  d  key is stupid enough to insert a deinterlacer twice when
              inserting yadif with --vf, so using the above methods is recommended.

       sub=[=bottom-margin:top-margin]
              Moves subtitle rendering to an arbitrary  point  in  the  filter  chain,  or  force
              subtitle  rendering  in  the  video  filter  as  opposed  to using video output OSD
              support.

              <bottom-margin>
                     Adds a black band at the bottom of the frame. The SSA/ASS renderer can place
                     subtitles there (with --sub-use-margins).

              <top-margin>
                     Black band on the top for toptitles  (with --sub-use-margins).

                 Examples

                 --vf=sub,eq
                        Moves  sub  rendering  before  the eq filter. This will put both subtitle
                        colors and video under the influence of the video equalizer settings.

       stereo3d[=in:out]
              Stereo3d converts between different stereoscopic image formats.

              <in>   Stereoscopic image format of input. Possible values:

                     sbsl or side_by_side_left_first
                            side by side parallel (left eye left, right eye right)

                     sbsr or side_by_side_right_first
                            side by side crosseye (right eye left, left eye right)

                     abl or above_below_left_first
                            above-below (left eye above, right eye below)

                     abr or above_below_right_first
                            above-below (right eye above, left eye below)

                     ab2l or above_below_half_height_left_first
                            above-below with half height resolution (left eye  above,  right  eye
                            below)

                     ab2r or above_below_half_height_right_first
                            above-below  with  half  height resolution (right eye above, left eye
                            below)

              <out>  Stereoscopic image format of output.  Possible  values  are  all  the  input
                     formats as well as:

                     arcg or anaglyph_red_cyan_gray
                            anaglyph  red/cyan gray (red filter on left eye, cyan filter on right
                            eye)

                     arch or anaglyph_red_cyan_half_color
                            anaglyph red/cyan half colored (red filter on left eye,  cyan  filter
                            on right eye)

                     arcc or anaglyph_red_cyan_color
                            anaglyph red/cyan color (red filter on left eye, cyan filter on right
                            eye)

                     arcd or anaglyph_red_cyan_dubois
                            anaglyph red/cyan color optimized with the  least-squares  projection
                            of Dubois (red filter on left eye, cyan filter on right eye)

                     agmg or anaglyph_green_magenta_gray
                            anaglyph green/magenta gray (green filter on left eye, magenta filter
                            on right eye)

                     agmh or anaglyph_green_magenta_half_color
                            anaglyph green/magenta  half  colored  (green  filter  on  left  eye,
                            magenta filter on right eye)

                     agmc or anaglyph_green_magenta_color
                            anaglyph  green/magenta  colored  (green  filter on left eye, magenta
                            filter on right eye)

                     aybg or anaglyph_yellow_blue_gray
                            anaglyph yellow/blue gray (yellow filter on left eye, blue filter  on
                            right eye)

                     aybh or anaglyph_yellow_blue_half_color
                            anaglyph  yellow/blue  half  colored (yellow filter on left eye, blue
                            filter on right eye)

                     aybc or anaglyph_yellow_blue_color
                            anaglyph yellow/blue colored (yellow filter on left eye, blue  filter
                            on right eye)

                     irl or interleave_rows_left_first
                            Interleaved rows (left eye has top row, right eye starts on next row)

                     irr or interleave_rows_right_first
                            Interleaved rows (right eye has top row, left eye starts on next row)

                     ml or mono_left
                            mono output (left eye only)

                     mr or mono_right
                            mono output (right eye only)

       gradfun[=strength[:radius|:size=<size>]]
              Fix the banding artifacts that are sometimes introduced into nearly flat regions by
              truncation to 8-bit color depth. Interpolates the gradients that  should  go  where
              the bands are, and dithers them.

              <strength>
                     Maximum  amount  by  which  the  filter  will change any one pixel. Also the
                     threshold for detecting nearly flat regions (default: 1.5).

              <radius>
                     Neighborhood to fit the  gradient  to.  Larger  radius  makes  for  smoother
                     gradients,  but also prevents the filter from modifying pixels near detailed
                     regions (default: disabled).

              <size> size of the filter in percent of the image diagonal size. This  is  used  to
                     calculate the final radius size (default: 1).

       vapoursynth=file:buffered-frames:concurrent-frames
              Loads  a  VapourSynth  filter script. This is intended for streamed processing: mpv
              actually provides a source filter, instead of  using  a  native  VapourSynth  video
              source.  The  mpv  source  will answer frame requests only within a small window of
              frames (the size of this window is controlled with the buffered-frames  parameter),
              and  requests  outside  of that will return errors. As such, you can't use the full
              power of VapourSynth, but you can use certain filters.

              If you just want to play video generated by a  VapourSynth  (i.e.  using  a  native
              VapourSynth  video  source), it's better to use vspipe and a FIFO to feed the video
              to mpv. The same applies if the filter script requires  random  frame  access  (see
              buffered-frames parameter).

              This  filter  is  experimental.  If it turns out that it works well and is used, it
              will be ported to libavfilter. Otherwise, it will be just removed.

              file   Filename of the script source. Currently, this is always  a  python  script.
                     The  variable  video_in  is  set to the mpv video source, and it is expected
                     that the script reads video from it. (Otherwise, mpv will decode  no  video,
                     and  the video packet queue will overflow, eventually leading to audio being
                     stopped.) The script is also expected to pass through timestamps  using  the
                     _DurationNum and _DurationDen frame properties.

                        Example:

                            import vapoursynth as vs
                            core = vs.get_core()
                            core.std.AddBorders(video_in, 10, 10, 20, 20).set_output()

                     WARNING:
                        The  script  will  be  reloaded  on every seek. This is done to reset the
                        filter properly on discontinuities.

              buffered-frames
                     Maximum number of decoded video frames that should be  buffered  before  the
                     filter  (default: 4). This specifies the maximum number of frames the script
                     can request in reverse direction.  E.g. if buffered-frames=5, and the script
                     just  requested  frame 15, it can still request frame 10, but frame 9 is not
                     available anymore.  If it requests frame 30, mpv will decode 15 more frames,
                     and keep only frames 25-30.

                     The  actual  number  of  buffered  frames  also  depends on the value of the
                     concurrent-frames option. Currently, both option values  are  multiplied  to
                     get the final buffer size.

                     (Normally,  VapourSynth  source  filters must provide random access, but mpv
                     was made for playback, and does not provide frame-exact random  access.  The
                     way  this  video  filter  works  is a compromise to make simple filters work
                     anyway.)

              concurrent-frames
                     Number of frames  that  should  be  requested  in  parallel.  The  level  of
                     concurrency  depends  on  the filter and how quickly mpv can decode video to
                     feed the filter. This value should probably be proportional to the number of
                     cores  on your machine. Most time, making it higher than the number of cores
                     can actually make it slower.

                     By default, this uses the special value auto, which sets the option  to  the
                     number of detected logical CPU cores.

              The following variables are defined by mpv:

              video_in
                     The  mpv video source as vapoursynth clip. Note that this has no length set,
                     which confuses many filters. Using Trim on the clip with a high dummy length
                     can turn it into a finite clip.

              video_in_dw, video_in_dh
                     Display  size  of  the  video. Can be different from video size if the video
                     does not use square pixels (e.g. DVD).

              container_fps
                     FPS value as reported by file headers. This value can be wrong or completely
                     broken  (e.g.  0  or  NaN).  Even if the value is correct, if another filter
                     changes the real FPS (by dropping or inserting frames), the  value  of  this
                     variable  might  not  be  useful.  Note  that  the --fps command line option
                     overrides this value.

                     Useful for some filters which insist on having a FPS.

              display_fps
                     Refresh rate of the current display. Note that this value can be 0.

       vapoursynth-lazy
              The same as vapoursynth, but doesn't load Python scripts. Instead, a custom backend
              using  Lua and the raw VapourSynth API is used. The syntax is completely different,
              and absolutely no convenience features  are  provided.  There's  no  type  checking
              either, and you can trigger crashes.

                 Example:

                     video_out = invoke("morpho", "Open", {clip = video_in})

              The  special  variable video_in is the mpv video source, while the special variable
              video_out is used to read video from. The 1st argument is the plugin (queried  with
              getPluginByNs),  the  2nd  is the filter name, and the 3rd argument is a table with
              the arguments. Positional  arguments  are  not  supported.  The  types  must  match
              exactly.  Since  Lua is terrible and can't distinguish integers and floats, integer
              arguments must be prefixed with i_, in which case the prefix  is  removed  and  the
              argument  is  cast  to an integer. Should the argument's name start with i_, you're
              out of luck.

              Clips (VSNodeRef) are passed as  light  userdata,  so  trying  to  pass  any  other
              userdata type will result in hard crashes.

       vavpp  VA-AP-API  video  post  processing.  Works  with  --vo=vaapi  and --vo=opengl only.
              Currently deinterlaces. This filter is automatically inserted if  deinterlacing  is
              requested  (either  using  the  d  key,  by  default  mapped  to  the command cycle
              deinterlace, or the --deinterlace option).

              deint=<method>
                     Select the deinterlacing algorithm.

                     no     Don't perform deinterlacing.

                     first-field
                            Show only first field.

                     bob    bob deinterlacing (default).

                     weave, motion-adaptive, motion-compensated
                            Advanced  deinterlacing  algorithms.  Whether  these  actually   work
                            depends  on  the  GPU hardware, the GPU drivers, driver bugs, and mpv
                            bugs.

              <interlaced-only>

                     no     Deinterlace all frames.

                     yes    Only deinterlace frames marked as interlaced (default).

              reversal-bug=<yes|no>

                     no     Use the API as it was interpreted by older Mesa drivers.  While  this
                            interpretation  was  more  obvious  and  inuitive,  it was apparently
                            wrong, and not shared by Intel driver developers.

                     yes    Use Intel interpretation of surface forward and backwards  references
                            (default).  This is what Intel drivers and newer Mesa drivers expect.
                            Matters only for the advanced deinterlacing algorithms.

       vdpaupp
              VDPAU video post processing. Works  with  --vo=vdpau  and  --vo=opengl  only.  This
              filter  is automatically inserted if deinterlacing is requested (either using the d
              key, by default mapped to the  command  cycle  deinterlace,  or  the  --deinterlace
              option).  When  enabling  deinterlacing,  it  is  always  preferred  over  software
              deinterlacer filters if the vdpau VO is used,  and  also  if  opengl  is  used  and
              hardware decoding was activated at least once (i.e. vdpau was loaded).

              sharpen=<-1-1>
                     For positive values, apply a sharpening algorithm to the video, for negative
                     values a blurring algorithm (default: 0).

              denoise=<0-1>
                     Apply a noise reduction  algorithm  to  the  video  (default:  0;  no  noise
                     reduction).

              deint=<yes|no>
                     Whether  deinterlacing is enabled (default: no). If enabled, it will use the
                     mode selected with deint-mode.

              deint-mode=<first-field|bob|temporal|temporal-spatial>
                     Select deinterlacing mode (default: temporal).

                     Note that there's currently a mechanism that allows the vdpau VO  to  change
                     the  deint-mode  of  auto-inserted vdpaupp filters. To avoid confusion, it's
                     recommended not to use the --vo=vdpau suboptions related to filtering.

                     first-field
                            Show only first field.

                     bob    Bob deinterlacing.

                     temporal
                            Motion-adaptive temporal deinterlacing. May lead to A/V  desync  with
                            slow video hardware and/or high resolution.

                     temporal-spatial
                            Motion-adaptive   temporal  deinterlacing  with  edge-guided  spatial
                            interpolation. Needs fast video hardware.

              chroma-deint
                     Makes temporal deinterlacers operate both on luma and chroma (default).  Use
                     no-chroma-deint  to  solely  use  luma  and speed up advanced deinterlacing.
                     Useful with slow video memory.

              pullup Try to apply inverse telecine, needs motion adaptive temporal deinterlacing.

              interlaced-only=<yes|no>
                     If yes (default), only deinterlace frames marked as interlaced.

              hqscaling=<0-9>

                     0      Use default VDPAU scaling (default).

                     1-9    Apply high quality VDPAU scaling (needs capable hardware).

       d3d11vpp
              Direct3D 11 video post processing. Currently requires D3D11 hardware  decoding  for
              use.

              deint=<yes|no>
                     Whether deinterlacing is enabled (default: no).

              interlaced-only=<yes|no>
                     If yes (default), only deinterlace frames marked as interlaced.

              mode=<blend|bob|adaptive|mocomp|ivctc|none>
                     Tries  to select a video processor with the given processing capability.  If
                     a video processor supports multiple capabilities,  it  is  not  clear  which
                     algorithm  is  actually selected. none always falls back. On most if not all
                     hardware, this option will probably do nothing, because  a  video  processor
                     usually supports all modes or none.

       buffer=<num>
              Buffer  <num>  frames  in the filter chain. This filter is probably pretty useless,
              except for debugging. (Note that this won't  help  to  smooth  out  latencies  with
              decoding,  because  the  filter will never output a frame if the buffer isn't full,
              except on EOF.)

ENCODING

       You can encode files from one format/codec to another using this facility.

       --o=<filename>
              Enables encoding mode and specifies the output file name.

       --of=<format>
              Specifies the output format (overrides autodetection by the file name extension  of
              the  file  specified by -o). This can be a comma separated list of possible formats
              to try. See --of=help for a full list of supported formats.

       --ofopts=<options>
              Specifies the output format options for libavformat.  See --ofopts=help for a  full
              list of supported options.

              Options are managed in lists. There are a few commands to manage the options list.

              --ofopts-add=<options1[,options2,...]>
                     Appends the options given as arguments to the options list.

              --ofopts-pre=<options1[,options2,...]>
                     Prepends the options given as arguments to the options list.

              --ofopts-del=<index1[,index2,...]>
                     Deletes the options at the given indexes. Index numbers start at 0, negative
                     numbers address the end of the list (-1 is the last).

              --ofopts-clr
                     Completely empties the options list.

       --ofps=<float value>
              Specifies the output format time base (default: 24000). Low values  like  25  limit
              video fps by dropping frames.

       --oautofps
              Sets  the  output  format  time  base  to the guessed frame rate of the input video
              (simulates MEncoder behavior, useful for AVI; may cause frame  drops).   Note  that
              not  all  codecs  and  not all formats support VFR encoding, and some which do have
              bugs when a target bitrate is specified - use --ofps or  --oautofps  to  force  CFR
              encoding in these cases.

       --omaxfps=<float value>
              Specifies  the minimum distance of adjacent frames (default: 0, which means unset).
              Content of lower frame rate is not readjusted to this frame rate; content of higher
              frame rate is decimated to this frame rate.

       --oharddup
              If  set, the frame rate given by --ofps is attained not by skipping time codes, but
              by duplicating frames (constant frame rate mode).

       --oneverdrop
              If set, frames are never dropped. Instead, time codes of video  are  readjusted  to
              always  increase.  This  may  cause  AV  desync, though; to work around this, use a
              high-fps time base using --ofps and absolutely avoid --oautofps.

       --oac=<codec>
              Specifies the output audio codec. This can be a comma separated  list  of  possible
              codecs to try. See --oac=help for a full list of supported codecs.

       --oaoffset=<value>
              Shifts  audio data by the given time (in seconds) by adding/removing samples at the
              start.

       --oacopts=<options>
              Specifies the output audio codec options for libavcodec.  See --oacopts=help for  a
              full list of supported options.

                 Example

                 --oac=libmp3lame --oacopts=b=128000
                        selects 128 kbps MP3 encoding.

              Options are managed in lists. There are a few commands to manage the options list.

              --oacopts-add=<options1[,options2,...]>
                     Appends the options given as arguments to the options list.

              --oacopts-pre=<options1[,options2,...]>
                     Prepends the options given as arguments to the options list.

              --oacopts-del=<index1[,index2,...]>
                     Deletes the options at the given indexes. Index numbers start at 0, negative
                     numbers address the end of the list (-1 is the last).

              --oacopts-clr
                     Completely empties the options list.

       --oafirst
              Force the audio stream to become the first stream in the output.  By  default,  the
              order is unspecified.

       --ovc=<codec>
              Specifies  the  output  video codec. This can be a comma separated list of possible
              codecs to try. See --ovc=help for a full list of supported codecs.

       --ovoffset=<value>
              Shifts video data by the given time (in seconds) by shifting the pts values.

       --ovcopts <options>
              Specifies the output video codec options for libavcodec.  See --ovcopts=help for  a
              full list of supported options.

                 Examples

                 "--ovc=mpeg4 --ovcopts=qscale=5"
                        selects constant quantizer scale 5 for MPEG-4 encoding.

                 "--ovc=libx264 --ovcopts=crf=23"
                        selects VBR quality factor 23 for H.264 encoding.

              Options are managed in lists. There are a few commands to manage the options list.

              --ovcopts-add=<options1[,options2,...]>
                     Appends the options given as arguments to the options list.

              --ovcopts-pre=<options1[,options2,...]>
                     Prepends the options given as arguments to the options list.

              --ovcopts-del=<index1[,index2,...]>
                     Deletes the options at the given indexes. Index numbers start at 0, negative
                     numbers address the end of the list (-1 is the last).

              --ovcopts-clr
                     Completely empties the options list.

       --ovfirst
              Force the video stream to become the first stream in the output.  By  default,  the
              order is unspecified.

       --ocopyts
              Copies  input  pts  to  the  output  video  (not supported by some output container
              formats, e.g. AVI). Discontinuities are still fixed.  By default, audio pts are set
              to  playback time and video pts are synchronized to match audio pts, as some output
              formats do not support anything else.

       --orawts
              Copies input pts to the output  video  (not  supported  by  some  output  container
              formats,  e.g.  AVI).  In  this mode, discontinuities are not fixed and all pts are
              passed through as-is. Never seek backwards or use  multiple  input  files  in  this
              mode!

       --no-ometadata
              Turns off copying of metadata from input files to output files when encoding (which
              is enabled by default).

COMMAND INTERFACE

The mpv core can be controlled with commands and properties. A number of ways to interact
with the player use them: key bindings (input.conf), OSD (showing information with
properties), JSON IPC, the client API (libmpv), and the classic slave mode.

input.conf
The input.conf file consists of a list of key bindings, for example:

s screenshot # take a screenshot with the s key
LEFT seek 15 # map the left-arrow key to seeking forward by 15 seconds

Each line maps a key to an input command. Keys are specified with their literal value
(upper case if combined with Shift), or a name for special keys. For example, a maps to
the a key without shift, and A maps to a with shift.

The file is located in the mpv configuration directory (normally at
~/.config/mpv/input.conf depending on platform). The default bindings are defined here:

https://github.com/mpv-player/mpv/blob/master/etc/input.conf

A list of special keys can be obtained with
mpv --input-keylist

In general, keys can be combined with Shift, Ctrl and Alt:

ctrl+q quit

mpv can be started in input test mode, which displays key bindings and the commands
they're bound to on the OSD, instead of executing the commands:

mpv --input-test --force-window --idle

(Only closing the window will make mpv exit, pressing normal keys will merely display the
binding, even if mapped to quit.)

General Input Command Syntax
[Shift+][Ctrl+][Alt+][Meta+]<key> [{<section>}] [<prefixes>] <command> (<argument>)* [;
<command>]

Note that by default, the right Alt key can be used to create special characters, and thus
does not register as a modifier. The option --no-input-right-alt-gr changes this behavior.

Newlines always start a new binding. # starts a comment (outside of quoted string
arguments). To bind commands to the # key, SHARP can be used.

<key> is either the literal character the key produces (ASCII or Unicode character), or a
symbolic name (as printed by --input-keylist).

<section> (braced with { and }) is the input section for this command.

Arguments are separated by whitespace. This applies even to string arguments. For this
reason, string arguments should be quoted with ". Inside quotes, C-style escaping can be
used.

You can bind multiple commands to one key. For example:
a show-text "command 1" ; show-text "command 2"

It's also possible to bind a command to a sequence of keys:
a-b-c show-text "command run after a, b, c have been pressed"

(This is not shown in the general command syntax.)

If a or a-b or b are already bound, this will run the first command that matches, and the
multi-key command will never be called. Intermediate keys can be remapped to ignore in
order to avoid this issue. The maximum number of (non-modifier) keys for combinations is
currently 4.

List of Input Commands
ignore Use this to "block" keys that should be unbound, and do nothing. Useful for
disabling default bindings, without disabling all bindings with
--no-input-default-bindings.

The second argument consists of flags controlling the seek mode:

relative (default)
Seek relative to current position (a negative value seeks backwards).

absolute
Seek to a given time (a negative value starts from the end of the file).

absolute-percent
Seek to a given percent position.

relative-percent
Seek relative to current position in percent.

keyframes
Always restart playback at keyframe boundaries (fast).

exact Always do exact/hr/precise seeks (slow).

Multiple flags can be combined, e.g.: absolute+keyframes.

By default, keyframes is used for relative seeks, and exact is used for absolute
seeks.

Before mpv 0.9, the keyframes and exact flags had to be passed as 3rd parameter
(essentially using a space instead of +). The 3rd parameter is still parsed, but is
considered deprecated.

revert-seek [mode]
Undoes the seek command, and some other commands that seek (but not necessarily all
of them). Calling this command once will jump to the playback position before the
seek. Calling it a second time undoes the revert-seek command itself. This only
works within a single file.

The first argument is optional, and can change the behavior:

mark Mark the current time position. The next normal revert-seek command will
seek back to this point, no matter how many seeks happened since last time.

Using it without any arguments gives you the default behavior.

frame-step
Play one frame, then pause. Does nothing with audio-only playback.

frame-back-step
Go back by one frame, then pause. Note that this can be very slow (it tries to be
precise, not fast), and sometimes fails to behave as expected. How well this works
depends on whether precise seeking works correctly (e.g. see the
--hr-seek-demuxer-offset option). Video filters or other video post-processing that
modifies timing of frames (e.g. deinterlacing) should usually work, but might make
backstepping silently behave incorrectly in corner cases. Using
--hr-seek-framedrop=no should help, although it might make precise seeking slower.

This does not work with audio-only playback.

set <property> <value>
Set the given property to the given value.

add <property> [<value>]
Add the given value to the property. On overflow or underflow, clamp the property
to the maximum. If <value> is omitted, assume 1.

cycle <property> [up|down]
Cycle the given property. up and down set the cycle direction. On overflow, set the
property back to the minimum, on underflow set it to the maximum. If up or down is
omitted, assume up.

multiply <property> <factor>
Multiplies the value of a property with the numeric factor.

screenshot [subtitles|video|window|single|each-frame]
Take a screenshot.

Multiple flags are available (some can be combined with +):

<subtitles> (default)
Save the video image, in its original resolution, and with subtitles. Some
video outputs may still include the OSD in the output under certain
circumstances.

<video>
Like subtitles, but typically without OSD or subtitles. The exact behavior
depends on the selected video output.

<window>
Save the contents of the mpv window. Typically scaled, with OSD and
subtitles. The exact behavior depends on the selected video output, and if
no support is available, this will act like video.

<each-frame>
Take a screenshot each frame. Issue this command again to stop taking
screenshots. Note that you should disable frame-dropping when using this
mode - or you might receive duplicate images in cases when a frame was
dropped. This flag can be combined with the other flags, e.g.
video+each-frame.

Older mpv versions required passing single and each-frame as second argument (and
did not have flags). This syntax is still understood, but deprecated and might be
removed in the future.

Setting the async flag will make encoding and writing the actual image file
asynchronous in most cases. (each-frame mode ignores this flag currently.)
Requesting async screenshots too early or too often could lead to the same
filenames being chosen, and overwriting each others in undefined order.

screenshot-to-file <filename> [subtitles|video|window]
Take a screenshot and save it to a given file. The format of the file will be
guessed by the extension (and --screenshot-format is ignored - the behavior when
the extension is missing or unknown is arbitrary).

The second argument is like the first argument to screenshot.

If the file already exists, it's overwritten.

Like all input command parameters, the filename is subject to property expansion as
described in Property Expansion.

The async flag has an effect on this command (see screenshot command).

playlist-next [weak|force]
Go to the next entry on the playlist.

weak (default)
If the last file on the playlist is currently played, do nothing.

force Terminate playback if there are no more files on the playlist.

playlist-prev [weak|force]
Go to the previous entry on the playlist.

weak (default)
If the first file on the playlist is currently played, do nothing.

force Terminate playback if the first file is being played.

loadfile <file> [replace|append|append-play [options]]
Load the given file and play it.

Second argument:

<replace> (default)
Stop playback of the current file, and play the new file immediately.

<append>
Append the file to the playlist.

<append-play>
Append the file, and if nothing is currently playing, start playback.
(Always starts with the added file, even if the playlist was not empty
before running this command.)

The third argument is a list of options and values which should be set while the
file is playing. It is of the form opt1=value1,opt2=value2,... Not all options can
be changed this way. Some options require a restart of the player.

loadlist <playlist> [replace|append]
Load the given playlist file (like --playlist).

playlist-clear
Clear the playlist, except the currently played file.

playlist-remove current|<index>
Remove the playlist entry at the given index. Index values start counting with 0.
The special value current removes the current entry. Note that removing the current
entry also stops playback and starts playing the next entry.

playlist-move <index1> <index2>
Move the playlist entry at index1, so that it takes the place of the entry index2.
(Paradoxically, the moved playlist entry will not have the index value index2 after
moving if index1 was lower than index2, because index2 refers to the target entry,
not the index the entry will have after moving.)

playlist-shuffle
Shuffle the playlist. This is similar to what is done on start if the --shuffle
option is used.

run command arg1 arg2 ...
Run the given command. Unlike in MPlayer/mplayer2 and earlier versions of mpv
(0.2.x and older), this doesn't call the shell. Instead, the command is run
directly, with each argument passed separately. Each argument is expanded like in
Property Expansion. Note that there is a static limit of (as of this writing) 9
arguments (this limit could be raised on demand).

The program is run in a detached way. mpv doesn't wait until the command is
completed, but continues playback right after spawning it.

To get the old behavior, use /bin/sh and -c as the first two arguments.

Example

run "/bin/sh" "-c" "echo ${title} > /tmp/playing"

This is not a particularly good example, because it doesn't handle
escaping, and a specially prepared file might allow an attacker to
execute arbitrary shell commands. It is recommended to write a small
shell script, and call that with run.

quit [<code>]
Exit the player. If an argument is given, it's used as process exit code.

quit-watch-later [<code>]
Exit player, and store current playback position. Playing that file later will seek
to the previous position on start. The (optional) argument is exactly as in the
quit command.

sub-add <file> [<flags> [<title> [<lang>]]]
Load the given subtitle file. It is selected as current subtitle after loading.

The flags args is one of the following values:

<select>
Select the subtitle immediately.

<auto>
Don't select the subtitle. (Or in some special situations, let the default
stream selection mechanism decide.)

<cached>
Select the subtitle. If a subtitle with the same filename was already added,
that one is selected, instead of loading a duplicate entry. (In this case,
title/language are ignored, and if the was changed since it was loaded, these
changes won't be reflected.)

The title argument sets the track title in the UI.

The lang argument sets the track language, and can also influence stream selection
with flags set to auto.

sub-remove [<id>]
Remove the given subtitle track. If the id argument is missing, remove the current
track. (Works on external subtitle files only.)

sub-reload [<id>]
Reload the given subtitle tracks. If the id argument is missing, reload the current
track. (Works on external subtitle files only.)

This works by unloading and re-adding the subtitle track.

sub-step <skip>
Change subtitle timing such, that the subtitle event after the next <skip> subtitle
events is displayed. <skip> can be negative to step backwards.

sub-seek <skip>
Seek to the next (skip set to 1) or the previous (skip set to -1) subtitle. This
is similar to sub-step, except that it seeks video and audio instead of adjusting
the subtitle delay.

For embedded subtitles (like with Matroska), this works only with subtitle events
that have already been displayed, or are within a short prefetch range.

print-text <string>
Print text to stdout. The string can contain properties (see Property Expansion).

show-text <string> [<duration>|- [<level>]]
Show text on the OSD. The string can contain properties, which are expanded as
described in Property Expansion. This can be used to show playback time, filename,
and so on.

<duration>
The time in ms to show the message for. By default, it uses the same value
as --osd-duration.

<level>
The minimum OSD level to show the text at (see --osd-level).

expand-text <string>
Property-expand the argument and return the expanded string. This can be used only
through the client API or from a script using mp.command_native. (see Property
Expansion).

show-progress
Show the progress bar, the elapsed time and the total duration of the file on the
OSD.

write-watch-later-config
Write the resume config file that the quit-watch-later command writes, but continue
playback normally.

stop Stop playback and clear playlist. With default settings, this is essentially like
quit. Useful for the client API: playback can be stopped without terminating the
player.

mouse <x> <y> [<button> [single|double]]
Send a mouse event with given coordinate (<x>, <y>).

Second argument:

<button>
The button number of clicked mouse button. This should be one of 0-19. If
<button> is omitted, only the position will be updated.

Third argument:

<single> (default)
The mouse event represents regular single click.

<double>
The mouse event represents double-click.

keypress <key_name>
Send a key event through mpv's input handler, triggering whatever behavior is
configured to that key. key_name uses the input.conf naming scheme for keys and
modifiers. Useful for the client API: key events can be sent to libmpv to handle
internally.

keydown <key_name>
Similar to keypress, but sets the KEYDOWN flag so that if the key is bound to a
repeatable command, it will be run repeatedly with mpv's key repeat timing until
the keyup command is called.

keyup [<key_name>]
Set the KEYUP flag, stopping any repeated behavior that had been triggered.
key_name is optional. If key_name is not given or is an empty string, KEYUP will be
set on all keys. Otherwise, KEYUP will only be set on the key specified by
key_name.

audio-add <file> [<flags> [<title> [<lang>]]]
Load the given audio file. See sub-add command.

audio-remove [<id>]
Remove the given audio track. See sub-remove command.

audio-reload [<id>]
Reload the given audio tracks. See sub-reload command.

rescan-external-files [<mode>]
Rescan external files according to the current --sub-auto and --audio-file-auto
settings. This can be used to auto-load external files after the file was loaded.

The mode argument is one of the following:

<reselect> (default)
Select the default audio and subtitle streams, which typically selects
external files with the highest preference. (The implementation is not
perfect, and could be improved on request.)

<keep-selection>
Do not change current track selections.

Input Commands that are Possibly Subject to Change
af set|add|toggle|del|clr filter1=params,filter2,...
Change audio filter chain. See vf command.

vf set|add|toggle|del|clr filter1=params,filter2,...
Change video filter chain.

The first argument decides what happens:

set Overwrite the previous filter chain with the new one.

add Append the new filter chain to the previous one.

toggle Check if the given filter (with the exact parameters) is already in the
video chain. If yes, remove the filter. If no, add the filter. (If several
filters are passed to the command, this is done for each filter.)

A special variant is combining this with labels, and using @name without
filter name and parameters as filter entry. This toggles the enable/disable
flag.

del Remove the given filters from the video chain. Unlike in the other cases,
the second parameter is a comma separated list of filter names or integer
indexes. 0 would denote the first filter. Negative indexes start from the
last filter, and -1 denotes the last filter.

clr Remove all filters. Note that like the other sub-commands, this does not
control automatically inserted filters.

The argument is always needed. E.g. in case of clr use vf clr "".

You can assign labels to filter by prefixing them with @name: (where name is a
user-chosen arbitrary identifier). Labels can be used to refer to filters by name
in all of the filter chain modification commands. For add, using an already used
label will replace the existing filter.

The vf command shows the list of requested filters on the OSD after changing the
filter chain. This is roughly equivalent to show-text ${vf}. Note that
auto-inserted filters for format conversion are not shown on the list, only what
was requested by the user.

Normally, the commands will check whether the video chain is recreated
successfully, and will undo the operation on failure. If the command is run before
video is configured (can happen if the command is run immediately after opening a
file and before a video frame is decoded), this check can't be run. Then it can
happen that creating the video chain fails.

Example for input.conf

• a vf set flip turn video upside-down on the a key

• b vf set "" remove all video filters on b

• c vf toggle lavfi=gradfun toggle debanding on c

Example how to toggle disabled filters at runtime

• Add something vf-add=@deband:!lavfi=[gradfun] to mpv.conf. The @deband: is the
label, and deband is an arbitrary, user-given name for this filter entry. The
! before the filter name disables the filter by default. Everything after this
is the normal filter name and the filter parameters.

• Add a vf toggle @deband to input.conf. This toggles the "disabled" flag for
the filter identified with deband.

cycle-values ["!reverse"] <property> <value1> <value2> ...
Cycle through a list of values. Each invocation of the command will set the given
property to the next value in the list. The command maintains an internal counter
which value to pick next, and which is initially 0. It is reset to 0 once the last
value is reached.

The internal counter is associated using the property name and the value list. If
multiple commands (bound to different keys) use the same name and value list, they
will share the internal counter.

The special argument !reverse can be used to cycle the value list in reverse.
Compared with a command that just lists the value in reverse, this command will
actually share the internal counter with the forward-cycling key binding (as long
as the rest of the arguments are the same).

Note that there is a static limit of (as of this writing) 10 arguments (this limit
could be raised on demand).

enable-section <section> [flags]
Enable all key bindings in the named input section.

The enabled input sections form a stack. Bindings in sections on the top of the
stack are preferred to lower sections. This command puts the section on top of the
stack. If the section was already on the stack, it is implicitly removed
beforehand. (A section cannot be on the stack more than once.)

The flags parameter can be a combination (separated by +) of the following flags:

<exclusive>
All sections enabled before the newly enabled section are disabled. They
will be re-enabled as soon as all exclusive sections above them are removed.
In other words, the new section shadows all previous sections.

<allow-hide-cursor>
This feature can't be used through the public API.

<allow-vo-dragging>
Same.

disable-section <section>
Disable the named input section. Undoes enable-section.

define-section <section> <contents> [default|force]
Create a named input section, or replace the contents of an already existing input
section. The contents parameter uses the same syntax as the input.conf file (except
that using the section syntax in it is not allowed), including the need to separate
bindings with a newline character.

If the contents parameter is an empty string, the section is removed.

The section with the name default is the normal input section.

In general, input sections have to be enabled with the enable-section command, or
they are ignored.

The last parameter has the following meaning:

<default> (also used if parameter omitted)
Use a key binding defined by this section only if the user hasn't already
bound this key to a command.

<force>
Always bind a key. (The input section that was made active most recently
wins if there are ambiguities.)

This command can be used to dispatch arbitrary keys to a script or a client API
user. If the input section defines script-binding commands, it is also possible to
get separate events on key up/down, and relatively detailed information about the
key state. The special key name unmapped can be used to match any unmapped key.

overlay-add <id> <x> <y> <file> <offset> <fmt> <w> <h> <stride>
Add an OSD overlay sourced from raw data. This might be useful for scripts and
applications controlling mpv, and which want to display things on top of the video
window.

Overlays are usually displayed in screen resolution, but with some VOs, the
resolution is reduced to that of the video's. You can read the osd-width and
osd-height properties. At least with --vo-xv and anamorphic video (such as DVD),
osd-par should be read as well, and the overlay should be aspect-compensated.

id is an integer between 0 and 63 identifying the overlay element. The ID can be
used to add multiple overlay parts, update a part by using this command with an
already existing ID, or to remove a part with overlay-remove. Using a previously
unused ID will add a new overlay, while reusing an ID will update it.

x and y specify the position where the OSD should be displayed.

file specifies the file the raw image data is read from. It can be either a numeric
UNIX file descriptor prefixed with @ (e.g. @4), or a filename. The file will be
mapped into memory with mmap(), copied, and unmapped before the command returns
(changed in mpv 0.18.1).

It is also possible to pass a raw memory address for use as bitmap memory by
passing a memory address as integer prefixed with an & character. Passing the
wrong thing here will crash the player. This mode might be useful for use with
libmpv. The offset parameter is simply added to the memory address (since mpv
0.8.0, ignored before).

offset is the byte offset of the first pixel in the source file. (The current
implementation always mmap's the whole file from position 0 to the end of the
image, so large offsets should be avoided. Before mpv 0.8.0, the offset was
actually passed directly to mmap, but it was changed to make using it easier.)

fmt is a string identifying the image format. Currently, only bgra is defined. This
format has 4 bytes per pixels, with 8 bits per component. The least significant 8
bits are blue, and the most significant 8 bits are alpha (in little endian, the
components are B-G-R-A, with B as first byte). This uses premultiplied alpha: every
color component is already multiplied with the alpha component. This means the
numeric value of each component is equal to or smaller than the alpha component.
(Violating this rule will lead to different results with different VOs: numeric
overflows resulting from blending broken alpha values is considered something that
shouldn't happen, and consequently implementations don't ensure that you get
predictable behavior in this case.)

w, h, and stride specify the size of the overlay. w is the visible width of the
overlay, while stride gives the width in bytes in memory. In the simple case, and
with the bgra format, stride==4*w. In general, the total amount of memory accessed
is stride * h. (Technically, the minimum size would be stride * (h - 1) + w * 4,
but for simplicity, the player will access all stride * h bytes.)

NOTE:
Before mpv 0.18.1, you had to do manual "double buffering" when updating an
overlay by replacing it with a different memory buffer. Since mpv 0.18.1, the
memory is simply copied and doesn't reference any of the memory indicated by the
command's arguments after the commend returns. If you want to use this command
before mpv 0.18.1, reads the old docs to see how to handle this correctly.

overlay-remove <id>
Remove an overlay added with overlay-add and the same ID. Does nothing if no
overlay with this ID exists.

script-message <arg1> <arg2> ...
Send a message to all clients, and pass it the following list of arguments. What
this message means, how many arguments it takes, and what the arguments mean is
fully up to the receiver and the sender. Every client receives the message, so be
careful about name clashes (or use script-message-to).

script-message-to <target> <arg1> <arg2> ...
Same as script-message, but send it only to the client named <target>. Each client
(scripts etc.) has a unique name. For example, Lua scripts can get their name via
mp.get_script_name().

script-binding <name>
Invoke a script-provided key binding. This can be used to remap key bindings
provided by external Lua scripts.

The argument is the name of the binding.

It can optionally be prefixed with the name of the script, using / as separator,
e.g. script-binding scriptname/bindingname.

For completeness, here is how this command works internally. The details could
change any time. On any matching key event, script-message-to or script-message is
called (depending on whether the script name is included), with the following
arguments:

1. The string key-binding.

2. The name of the binding (as established above).

3. The key state as string (see below).

4. The key name (since mpv 0.15.0).

The key state consists of 2 letters:

1. One of d (key was pressed down), u (was released), r (key is still down, and was
repeated; only if key repeat is enabled for this binding), p (key was pressed;
happens if up/down can't be tracked).

2. Whether the event originates from the mouse, either m (mouse button) or -
(something else).

ab-loop
Cycle through A-B loop states. The first command will set the A point (the
ab-loop-a property); the second the B point, and the third will clear both points.

drop-buffers
Drop audio/video/demuxer buffers, and restart from fresh. Might help with
unseekable streams that are going out of sync. This command might be changed or
removed in the future.

screenshot-raw [subtitles|video|window]
Return a screenshot in memory. This can be used only through the client API. The
MPV_FORMAT_NODE_MAP returned by this command has the w, h, stride fields set to
obvious contents. The format field is set to bgr0 by default. This format is
organized as B8G8R8X8 (where B is the LSB). The contents of the padding X are
undefined. The data field is of type MPV_FORMAT_BYTE_ARRAY with the actual image
data. The image is freed as soon as the result mpv_node is freed. As usual with
client API semantics, you are not allowed to write to the image data.

vf-command <label> <cmd> <args>
Send a command to the filter with the given <label>. Use all to send it to all
filters at once. The command and argument string is filter specific. Currently,
this only works with the lavfi filter - see the libavfilter documentation for which
commands a filter supports.

Note that the <label> is a mpv filter label, not a libavfilter filter name.

af-command <label> <cmd> <args>
Same as vf-command, but for audio filters.

apply-profile <name>
Apply the contents of a named profile. This is like using profile=name in a config
file, except you can map it to a key binding to change it at runtime.

There is no such thing as "unapplying" a profile - applying a profile merely sets
all option values listed within the profile.

load-script <path>
Load a script, similar to the --script option.

Undocumented commands: tv-last-channel (TV/DVB only), ao-reload (experimental/internal).

Hooks
Hooks are synchronous events between player core and a script or similar. This applies to
client API (including the Lua scripting interface). Normally, events are supposed to be
asynchronous, and the hook API provides an awkward and obscure way to handle events that
require stricter coordination. There are no API stability guarantees made. Not following
the protocol exactly can make the player freeze randomly. Basically, nobody should use
this API.

There are two special commands involved. Also, the client must listen for client messages
(MPV_EVENT_CLIENT_MESSAGE in the C API).

hook-add <hook-name> <id> <priority>
Subscribe to the hook identified by the first argument (basically, the name of
event). The id argument is an arbitrary integer chosen by the user. priority is
used to sort all hook handlers globally across all clients. Each client can
register multiple hook handlers (even for the same hook-name). Once the hook is
registered, it cannot be unregistered.

When a specific event happens, all registered handlers are run serially. This uses
a protocol every client has to follow explicitly. When a hook handler is run, a
client message (MPV_EVENT_CLIENT_MESSAGE) is sent to the client which registered
the hook. This message has the following arguments:

1. the string hook_run

2. the id argument the hook was registered with as string (this can be used to
correctly handle multiple hooks registered by the same client, as long as the id
argument is unique in the client)

3. something undefined, used by the hook mechanism to track hook execution
(currently, it's the hook-name, but this might change without warning)

Upon receiving this message, the client can handle the event. While doing this, the
player core will still react to requests, but playback will typically be stopped.

When the client is done, it must continue the core's hook execution by running the
hook-ack command.

hook-ack <string>
Run the next hook in the global chain of hooks. The argument is the 3rd argument of
the client message that starts hook execution for the current client.

The following hooks are currently defined:

on_load
Called when a file is to be opened, before anything is actually done. For example,
you could read and write the stream-open-filename property to redirect an URL to
something else (consider support for streaming sites which rarely give the user a
direct media URL), or you could set per-file options with by setting the property
file-local-options/<option name>. The player will wait until all hooks are run.

on_preloaded
Called after a file has been opened, and before tracks are selected and decoders
are created. This has some usefulness if an API users wants to select tracks
manually, based on the set of available tracks. It's also useful to initialize
--lavfi-complex in a specific way by API, without having to "probe" the available
streams at first.

Note that this does not yet apply default track selection. Which operations exactly
can be done and not be done, and what information is available and what is not yet
available yet, is all subject to change.

on_unload
Run before closing a file, and before actually uninitializing everything. It's not
possible to resume playback in this state.

Input Command Prefixes
These prefixes are placed between key name and the actual command. Multiple prefixes can
be specified. They are separated by whitespace.

osd-auto
Use the default behavior for this command. This is the default for input.conf
commands. Some libmpv/scripting/IPC APIs do not use this as default, but use no-osd
instead.

no-osd Do not use any OSD for this command.

osd-bar
If possible, show a bar with this command. Seek commands will show the progress
bar, property changing commands may show the newly set value.

osd-msg
If possible, show an OSD message with this command. Seek command show the current
playback time, property changing commands show the newly set value as text.

osd-msg-bar
Combine osd-bar and osd-msg.

raw Do not expand properties in string arguments. (Like "${property-name}".) This is
the default for some libmpv/scripting/IPC APIs.

expand-properties
All string arguments are expanded as described in Property Expansion. This is the
default for input.conf commands.

repeatable
For some commands, keeping a key pressed doesn't run the command repeatedly. This
prefix forces enabling key repeat in any case.

async Allow asynchronous execution (if possible). Note that only a few commands will
support this (usually this is explicitly documented). Some commands are
asynchronous by default (or rather, their effects might manifest after completion
of the command). The semantics of this flag might change in the future. Set it only
if you don't rely on the effects of this command being fully realized when it
returns.

All of the osd prefixes are still overridden by the global --osd-level settings.

Input Sections
Input sections group a set of bindings, and enable or disable them at once. In
input.conf, each key binding is assigned to an input section, rather than actually having
explicit text sections.

See also: enable-section and disable-section commands.

Predefined bindings:

default
Bindings without input section are implicitly assigned to this section. It is
enabled by default during normal playback.

encode Section which is active in encoding mode. It is enabled exclusively, so that
bindings in the default sections are ignored.

Properties
Properties are used to set mpv options during runtime, or to query arbitrary information.
They can be manipulated with the set/add/cycle commands, and retrieved with show-text, or
anything else that uses property expansion. (See Property Expansion.)

The property name is annotated with RW to indicate whether the property is generally
writable.

If an option is referenced, the property will normally take/return exactly the same values
as the option. In these cases, properties are merely a way to change an option at runtime.

Property list
NOTE:
Most options can be set as runtime via properties as well. Just remove the leading --
from the option name. These are not documented. Only properties which do not exist as
option with the same name, or which have very different behavior from the options are
documented below.

audio-speed-correction, video-speed-correction
Factor multiplied with speed at which the player attempts to play the file. Usually
it's exactly 1. (Display sync mode will make this useful.)

OSD formatting will display it in the form of +1.23456%, with the number being (raw
- 1) * 100 for the given raw property value.

display-sync-active
Return whether --video-sync=display is actually active.

filename
Currently played file, with path stripped. If this is an URL, try to undo percent
encoding as well. (The result is not necessarily correct, but looks better for
display purposes. Use the path property to get an unmodified filename.)

This has a sub-property:

filename/no-ext
Like the filename property, but if the text contains a ., strip all text
after the last .. Usually this removes the file extension.

file-size
Length in bytes of the source file/stream. (This is the same as ${stream-end}. For
ordered chapters and such, the size of the currently played segment is returned.)

estimated-frame-count
Total number of frames in current file.

NOTE:
This is only an estimate. (It's computed from two unreliable quantities: fps and
stream length.)

estimated-frame-number
Number of current frame in current stream.

NOTE:
This is only an estimate. (It's computed from two unreliable quantities: fps and
possibly rounded timestamps.)

path Full path of the currently played file. Usually this is exactly the same string you
pass on the mpv command line or the loadfile command, even if it's a relative path.
If you expect an absolute path, you will have to determine it yourself, for example
by using the working-directory property.

media-title
If the currently played file has a title tag, use that.

Otherwise, if the media type is DVD, return the volume ID of DVD.

Otherwise, return the filename property.

file-format
Symbolic name of the file format. In some cases, this is a comma-separated list of
format names, e.g. mp4 is mov,mp4,m4a,3gp,3g2,mj2 (the list may grow in the future
for any format).

current-demuxer
Name of the current demuxer. (This is useless.)

(Renamed from demuxer.)

stream-path
Filename (full path) of the stream layer filename. (This is probably useless. It
looks like this can be different from path only when using e.g. ordered chapters.)

stream-pos
Raw byte position in source stream. Technically, this returns the position of the
most recent packet passed to a decoder.

stream-end
Raw end position in bytes in source stream.

duration
Duration of the current file in seconds. If the duration is unknown, the property
is unavailable. Note that the file duration is not always exactly known, so this is
an estimate.

This replaces the length property, which was deprecated after the mpv 0.9 release.
(The semantics are the same.)

avsync Last A/V synchronization difference. Unavailable if audio or video is disabled.

total-avsync-change
Total A-V sync correction done. Unavailable if audio or video is disabled.

decoder-frame-drop-count
Video frames dropped by decoder, because video is too far behind audio (when using
--framedrop=decoder). Sometimes, this may be incremented in other situations, e.g.
when video packets are damaged, or the decoder doesn't follow the usual rules.
Unavailable if video is disabled.

drop-frame-count is a deprecated alias.

frame-drop-count
Frames dropped by VO (when using --framedrop=vo).

vo-drop-frame-count is a deprecated alias.

mistimed-frame-count
Number of video frames that were not timed correctly in display-sync mode for the
sake of keeping A/V sync. This does not include external circumstances, such as
video rendering being too slow or the graphics driver somehow skipping a vsync. It
does not include rounding errors either (which can happen especially with bad
source timestamps). For example, using the display-desync mode should never change
this value from 0.

vsync-ratio
For how many vsyncs a frame is displayed on average. This is available if
display-sync is active only. For 30 FPS video on a 60 Hz screen, this will be 2.
This is the moving average of what actually has been scheduled, so 24 FPS on 60 Hz
will never remain exactly on 2.5, but jitter depending on the last frame displayed.

vo-delayed-frame-count
Estimated number of frames delayed due to external circumstances in display-sync
mode. Note that in general, mpv has to guess that this is happening, and the guess
can be inaccurate.

percent-pos (RW)
Position in current file (0-100). The advantage over using this instead of
calculating it out of other properties is that it properly falls back to estimating
the playback position from the byte position, if the file duration is not known.

time-pos (RW)
Position in current file in seconds.

time-start
Deprecated. Always returns 0. Before mpv 0.14, this used to return the start time
of the file (could affect e.g. transport streams). See --rebase-start-time option.

time-remaining
Remaining length of the file in seconds. Note that the file duration is not always
exactly known, so this is an estimate.

audio-pts (R)
Current audio playback position in current file in seconds. Unlike time-pos, this
updates more often than once per frame. For audio-only files, it is mostly
equivalent to time-pos, while for video-only files this property is not available.

playtime-remaining
time-remaining scaled by the current speed.

playback-time (RW)
Position in current file in seconds. Unlike time-pos, the time is clamped to the
range of the file. (Inaccurate file durations etc. could make it go out of range.
Useful on attempts to seek outside of the file, as the seek target time is
considered the current position during seeking.)

chapter (RW)
Current chapter number. The number of the first chapter is 0.

edition (RW)
Current MKV edition number. Setting this property to a different value will restart
playback. The number of the first edition is 0.

disc-titles
Number of BD/DVD titles.

This has a number of sub-properties. Replace N with the 0-based edition index.

disc-titles/count
Number of titles.

disc-titles/id
Title ID as integer. Currently, this is the same as the title index.

disc-titles/length
Length in seconds. Can be unavailable in a number of cases (currently it
works for libdvdnav only).

When querying the property with the client API using MPV_FORMAT_NODE, or with Lua
mp.get_property_native, this will return a mpv_node with the following contents:

MPV_FORMAT_NODE_ARRAY
MPV_FORMAT_NODE_MAP (for each edition)
"id" MPV_FORMAT_INT64
"length" MPV_FORMAT_DOUBLE

disc-title-list
List of BD/DVD titles.

disc-title (RW)
Current BD/DVD title number. Writing works only for dvdnav:// and bd:// (and
aliases for these).

chapters
Number of chapters.

editions
Number of MKV editions.

edition-list
List of editions, current entry marked. Currently, the raw property value is
useless.

This has a number of sub-properties. Replace N with the 0-based edition index.

edition-list/count
Number of editions. If there are no editions, this can be 0 or 1 (1 if
there's a useless dummy edition).

edition-list/N/id
Edition ID as integer. Use this to set the edition property. Currently,
this is the same as the edition index.

edition-list/N/default
yes if this is the default edition, no otherwise.

edition-list/N/title
Edition title as stored in the file. Not always available.

When querying the property with the client API using MPV_FORMAT_NODE, or with Lua
mp.get_property_native, this will return a mpv_node with the following contents:

MPV_FORMAT_NODE_ARRAY
MPV_FORMAT_NODE_MAP (for each edition)
"id" MPV_FORMAT_INT64
"title" MPV_FORMAT_STRING
"default" MPV_FORMAT_FLAG

angle (RW)
Current DVD angle.

metadata
Metadata key/value pairs.

If the property is accessed with Lua's mp.get_property_native, this returns a table
with metadata keys mapping to metadata values. If it is accessed with the client
API, this returns a MPV_FORMAT_NODE_MAP, with tag keys mapping to tag values.

For OSD, it returns a formatted list. Trying to retrieve this property as a raw
string doesn't work.

This has a number of sub-properties:

metadata/by-key/<key>
Value of metadata entry <key>.

metadata/list/count
Number of metadata entries.

metadata/list/N/key
Key name of the Nth metadata entry. (The first entry is 0).

metadata/list/N/value
Value of the Nth metadata entry.

metadata/<key>
Old version of metadata/by-key/<key>. Use is discouraged, because the
metadata key string could conflict with other sub-properties.

The layout of this property might be subject to change. Suggestions are welcome how
exactly this property should work.

When querying the property with the client API using MPV_FORMAT_NODE, or with Lua
mp.get_property_native, this will return a mpv_node with the following contents:

MPV_FORMAT_NODE_MAP
(key and string value for each metadata entry)

filtered-metadata
Like metadata, but includes only fields listed in the --display-tags option. This
is the same set of tags that is printed to the terminal.

chapter-metadata
Metadata of current chapter. Works similar to metadata property. It also allows the
same access methods (using sub-properties).

Per-chapter metadata is very rare. Usually, only the chapter name (title) is set.

For accessing other information, like chapter start, see the chapter-list property.

vf-metadata/<filter-label>
Metadata added by video filters. Accessed by the filter label, which, if not
explicitly specified using the @filter-label: syntax, will be <filter-name>NN.

Works similar to metadata property. It allows the same access methods (using
sub-properties).

An example of this kind of metadata are the cropping parameters added by
--vf=lavfi=cropdetect.

af-metadata/<filter-label>
Equivalent to vf-metadata/<filter-label>, but for audio filters.

idle-active
Return yes if no file is loaded, but the player is staying around because of the
--idle option.

(Renamed from idle.)

core-idle
Return yes if the playback core is paused, otherwise no. This can be different
pause in special situations, such as when the player pauses itself due to low
network cache.

This also returns yes if playback is restarting or if nothing is playing at all. In
other words, it's only no if there's actually video playing. (Behavior since mpv
0.7.0.)

cache Network cache fill state (0-100.0).

cache-size (RW)
Network cache size in KB. This is similar to --cache. This allows setting the cache
size at runtime. Currently, it's not possible to enable or disable the cache at
runtime using this property, just to resize an existing cache.

This does not include the backbuffer size (changed after mpv 0.10.0).

Note that this tries to keep the cache contents as far as possible. To make this
easier, the cache resizing code will allocate the new cache while the old cache is
still allocated.

Don't use this when playing DVD or Blu-ray.

cache-free (R)
Total free cache size in KB.

cache-used (R)
Total used cache size in KB.

cache-speed (R)
Current I/O read speed between the cache and the lower layer (like network). This
gives the number bytes per seconds over a 1 second window (using the type
MPV_FORMAT_INT64 for the client API).

cache-idle (R)
Returns yes if the cache is idle, which means the cache is filled as much as
possible, and is currently not reading more data.

demuxer-cache-duration
Approximate duration of video buffered in the demuxer, in seconds. The guess is
very unreliable, and often the property will not be available at all, even if data
is buffered.

demuxer-cache-time
Approximate time of video buffered in the demuxer, in seconds. Same as
demuxer-cache-duration but returns the last timestamp of buffered data in demuxer.

demuxer-cache-idle
Returns yes if the demuxer is idle, which means the demuxer cache is filled to the
requested amount, and is currently not reading more data.

demuxer-via-network
Returns yes if the stream demuxed via the main demuxer is most likely played via
network. What constitutes "network" is not always clear, might be used for other
types of untrusted streams, could be wrong in certain cases, and its definition
might be changing. Also, external files (like separate audio files or streams) do
not influence the value of this property (currently).

demuxer-start-time (R)
Returns the start time reported by the demuxer in fractional seconds.

paused-for-cache
Returns yes when playback is paused because of waiting for the cache.

cache-buffering-state
Return the percentage (0-100) of the cache fill status until the player will
unpause (related to paused-for-cache).

eof-reached
Returns yes if end of playback was reached, no otherwise. Note that this is usually
interesting only if --keep-open is enabled, since otherwise the player will
immediately play the next file (or exit or enter idle mode), and in these cases the
eof-reached property will logically be cleared immediately after it's set.

seeking
Returns yes if the player is currently seeking, or otherwise trying to restart
playback. (It's possible that it returns yes while a file is loaded, or when
switching ordered chapter segments. This is because the same underlying code is
used for seeking and resyncing.)

mixer-active
Return yes if the audio mixer is active, no otherwise.

This option is relatively useless. Before mpv 0.18.1, it could be used to infer
behavior of the volume property.

ao-volume (RW)
System volume. This property is available only if mpv audio output is currently
active, and only if the underlying implementation supports volume control. What
this option does depends on the API. For example, on ALSA this usually changes
system-wide audio, while with PulseAudio this controls per-application volume.

ao-mute (RW)
Similar to ao-volume, but controls the mute state. May be unimplemented even if
ao-volume works.

audio-codec
Audio codec selected for decoding.

audio-codec-name
Audio codec.

audio-params
Audio format as output by the audio decoder. This has a number of sub-properties:

audio-params/format
The sample format as string. This uses the same names as used in other
places of mpv.

audio-params/samplerate
Samplerate.

audio-params/channels
The channel layout as a string. This is similar to what the --audio-channels
accepts.

audio-params/hr-channels
As channels, but instead of the possibly cryptic actual layout sent to the
audio device, return a hopefully more human readable form. (Usually only
audio-out-params/hr-channels makes sense.)

audio-params/channel-count
Number of audio channels. This is redundant to the channels field described
above.

When querying the property with the client API using MPV_FORMAT_NODE, or with Lua
mp.get_property_native, this will return a mpv_node with the following contents:

MPV_FORMAT_NODE_MAP
"format" MPV_FORMAT_STRING
"samplerate" MPV_FORMAT_INT64
"channels" MPV_FORMAT_STRING
"channel-count" MPV_FORMAT_INT64
"hr-channels" MPV_FORMAT_STRING

audio-out-params
Same as audio-params, but the format of the data written to the audio API.

colormatrix (R)
Redirects to video-params/colormatrix. This parameter (as well as similar ones) can
be overridden with the format video filter.

colormatrix-input-range (R)
See colormatrix.

colormatrix-primaries (R)
See colormatrix.

hwdec (RW)
Reflects the --hwdec option.

Writing to it may change the currently used hardware decoder, if possible.
(Internally, the player may reinitialize the decoder, and will perform a seek to
refresh the video properly.) You can watch the other hwdec properties to see
whether this was successful.

Unlike in mpv 0.9.x and before, this does not return the currently active hardware
decoder. Since mpv 0.18.0, hwdec-current is available for this purpose.

hwdec-current
Return the current hardware decoding in use. If decoding is active, return one of
the values used by the hwdec option/property. no indicates software decoding. If no
decoder is loaded, the property is unavailable.

hwdec-interop
This returns the currently loaded hardware decoding/output interop driver. This is
known only once the VO has opened (and possibly later). With some VOs (like
opengl), this might be never known in advance, but only when the decoder attempted
to create the hw decoder successfully. (Using --opengl-hwdec-interop can load it
eagerly.) If there are multiple drivers loaded, they will be separated by ,.

If no VO is active or no interop driver is known, this property is unavailable.

This does not necessarily use the same values as hwdec. There can be multiple
interop drivers for the same hardware decoder, depending on platform and VO.

This is somewhat similar to the --opengl-hwdec-interop option, but it returns the
actually loaded backend, not the value of this option.

video-format
Video format as string.

video-codec
Video codec selected for decoding.

width, height
Video size. This uses the size of the video as decoded, or if no video frame has
been decoded yet, the (possibly incorrect) container indicated size.

video-params
Video parameters, as output by the decoder (with overrides like aspect etc.
applied). This has a number of sub-properties:

video-params/pixelformat
The pixel format as string. This uses the same names as used in other places
of mpv.

video-params/average-bpp
Average bits-per-pixel as integer. Subsampled planar formats use a different
resolution, which is the reason this value can sometimes be odd or
confusing. Can be unavailable with some formats.

video-params/plane-depth
Bit depth for each color component as integer. This is only exposed for
planar or single-component formats, and is unavailable for other formats.

video-params/w, video-params/h
Video size as integers, with no aspect correction applied.

video-params/dw, video-params/dh
Video size as integers, scaled for correct aspect ratio.

video-params/aspect
Display aspect ratio as float.

video-params/par
Pixel aspect ratio.

video-params/colormatrix
The colormatrix in use as string. (Exact values subject to change.)

video-params/colorlevels
The colorlevels as string. (Exact values subject to change.)

video-params/primaries
The primaries in use as string. (Exact values subject to change.)

video-params/gamma
The gamma function in use as string. (Exact values subject to change.)

video-params/sig-peak
The video file's tagged signal peak as float.

video-params/light
The light type in use as a string. (Exact values subject to change.)

video-params/chroma-location
Chroma location as string. (Exact values subject to change.)

video-params/rotate
Intended display rotation in degrees (clockwise).

video-params/stereo-in
Source file stereo 3D mode. (See --video-stereo-mode option.)

When querying the property with the client API using MPV_FORMAT_NODE, or with Lua
mp.get_property_native, this will return a mpv_node with the following contents:

MPV_FORMAT_NODE_MAP
"pixelformat" MPV_FORMAT_STRING
"w" MPV_FORMAT_INT64
"h" MPV_FORMAT_INT64
"dw" MPV_FORMAT_INT64
"dh" MPV_FORMAT_INT64
"aspect" MPV_FORMAT_DOUBLE
"par" MPV_FORMAT_DOUBLE
"colormatrix" MPV_FORMAT_STRING
"colorlevels" MPV_FORMAT_STRING
"primaries" MPV_FORMAT_STRING
"gamma" MPV_FORMAT_STRING
"sig-peak" MPV_FORMAT_DOUBLE
"light" MPV_FORMAT_STRING
"chroma-location" MPV_FORMAT_STRING
"rotate" MPV_FORMAT_INT64
"stereo-in" MPV_FORMAT_STRING

dwidth, dheight
Video display size. This is the video size after filters and aspect scaling have
been applied. The actual video window size can still be different from this, e.g.
if the user resized the video window manually.

These have the same values as video-out-params/dw and video-out-params/dh.

video-dec-params
Exactly like video-params, but no overrides applied.

video-out-params
Same as video-params, but after video filters have been applied. If there are no
video filters in use, this will contain the same values as video-params. Note that
this is still not necessarily what the video window uses, since the user can change
the window size, and all real VOs do their own scaling independently from the
filter chain.

Has the same sub-properties as video-params.

video-frame-info
Approximate information of the current frame. Note that if any of these are used on
OSD, the information might be off by a few frames due to OSD redrawing and frame
display being somewhat disconnected, and you might have to pause and force a
redraw.

Sub-properties:

video-frame-info/picture-type video-frame-info/interlaced video-frame-info/tff
video-frame-info/repeat

container-fps
Container FPS. This can easily contain bogus values. For videos that use modern
container formats or video codecs, this will often be incorrect.

(Renamed from fps.)

estimated-vf-fps
Estimated/measured FPS of the video filter chain output. (If no filters are used,
this corresponds to decoder output.) This uses the average of the 10 past frame
durations to calculate the FPS. It will be inaccurate if frame-dropping is involved
(such as when framedrop is explicitly enabled, or after precise seeking). Files
with imprecise timestamps (such as Matroska) might lead to unstable results.

window-scale (RW)
Window size multiplier. Setting this will resize the video window to the values
contained in dwidth and dheight multiplied with the value set with this property.
Setting 1 will resize to original video size (or to be exact, the size the video
filters output). 2 will set the double size, 0.5 halves the size.

window-minimized
Return whether the video window is minimized or not.

display-names
Names of the displays that the mpv window covers. On X11, these are the xrandr
names (LVDS1, HDMI1, DP1, VGA1, etc.). On Windows, these are the GDI names
(\.DISPLAY1, \.DISPLAY2, etc.) and the first display in the list will be the one
that Windows considers associated with the window (as determined by the
MonitorFromWindow API.)

display-fps (RW)
The refresh rate of the current display. Currently, this is the lowest FPS of any
display covered by the video, as retrieved by the underlying system APIs (e.g.
xrandr on X11). It is not the measured FPS. It's not necessarily available on all
platforms. Note that any of the listed facts may change any time without a warning.

estimated-display-fps
Only available if display-sync mode (as selected by --video-sync) is active.
Returns the actual rate at which display refreshes seem to occur, measured by
system time.

vsync-jitter
Estimated deviation factor of the vsync duration.

video-aspect (RW)
Video aspect, see --video-aspect.

If video is active, this reports the effective aspect value, instead of the value
of the --video-aspect option.

osd-width, osd-height
Last known OSD width (can be 0). This is needed if you want to use the overlay-add
command. It gives you the actual OSD size, which can be different from the window
size in some cases.

osd-par
Last known OSD display pixel aspect (can be 0).

program (W)
Switch TS program (write-only).

dvb-channel (W)
Pair of integers: card,channel of current DVB stream. Can be switched to switch to
another channel on the same card.

dvb-channel-name (RW)
Name of current DVB program. On write, a channel-switch to the named channel on
the same card is performed. Can also be used for channel switching.

sub-text
Return the current subtitle text. Formatting is stripped. If a subtitle is
selected, but no text is currently visible, or the subtitle is not text-based (i.e.
DVD/BD subtitles), an empty string is returned.

This property is experimental and might be removed in the future.

tv-brightness, tv-contrast, tv-saturation, tv-hue (RW)
TV stuff.

playlist-pos (RW)
Current position on playlist. The first entry is on position 0. Writing to the
property will restart playback at the written entry.

playlist-pos-1 (RW)
Same as playlist-pos, but 1-based.

playlist-count
Number of total playlist entries.

playlist
Playlist, current entry marked. Currently, the raw property value is useless.

This has a number of sub-properties. Replace N with the 0-based playlist entry
index.

playlist/count
Number of playlist entries (same as playlist-count).

playlist/N/filename
Filename of the Nth entry.

playlist/N/current, playlist/N/playing
yes if this entry is currently playing (or being loaded). Unavailable or no
otherwise. When changing files, current and playing can be different,
because the currently playing file hasn't been unloaded yet; in this case,
current refers to the new selection. (Since mpv 0.7.0.)

playlist/N/title
Name of the Nth entry. Only available if the playlist file contains such
fields, and only if mpv's parser supports it for the given playlist format.

When querying the property with the client API using MPV_FORMAT_NODE, or with Lua
mp.get_property_native, this will return a mpv_node with the following contents:

MPV_FORMAT_NODE_ARRAY
MPV_FORMAT_NODE_MAP (for each playlist entry)
"filename" MPV_FORMAT_STRING
"current" MPV_FORMAT_FLAG (might be missing; since mpv 0.7.0)
"playing" MPV_FORMAT_FLAG (same)
"title" MPV_FORMAT_STRING (optional)

track-list
List of audio/video/sub tracks, current entry marked. Currently, the raw property
value is useless.

This has a number of sub-properties. Replace N with the 0-based track index.

track-list/count
Total number of tracks.

track-list/N/id
The ID as it's used for -sid/--aid/--vid. This is unique within tracks of
the same type (sub/audio/video), but otherwise not.

track-list/N/type
String describing the media type. One of audio, video, sub.

track-list/N/src-id
Track ID as used in the source file. Not always available.

track-list/N/title
Track title as it is stored in the file. Not always available.

track-list/N/lang
Track language as identified by the file. Not always available.

track-list/N/albumart
yes if this is a video track that consists of a single picture, no or
unavailable otherwise. This is used for video tracks that are really
attached pictures in audio files.

track-list/N/default
yes if the track has the default flag set in the file, no otherwise.

track-list/N/forced
yes if the track has the forced flag set in the file, no otherwise.

track-list/N/codec
The codec name used by this track, for example h264. Unavailable in some
rare cases.

track-list/N/external
yes if the track is an external file, no otherwise. This is set for separate
subtitle files.

track-list/N/external-filename
The filename if the track is from an external file, unavailable otherwise.

track-list/N/selected
yes if the track is currently decoded, no otherwise.

track-list/N/ff-index
The stream index as usually used by the FFmpeg utilities. Note that this can
be potentially wrong if a demuxer other than libavformat (--demuxer=lavf) is
used. For mkv files, the index will usually match even if the default
(builtin) demuxer is used, but there is no hard guarantee.

track-list/N/decoder-desc
If this track is being decoded, the human-readable decoder name,

track-list/N/demux-w, track-list/N/demux-h
Video size hint as indicated by the container. (Not always accurate.)

track-list/N/demux-channel-count
Number of audio channels as indicated by the container. (Not always accurate
- in particular, the track could be decoded as a different number of
channels.)

track-list/N/demux-channels
Channel layout as indicated by the container. (Not always accurate.)

track-list/N/demux-samplerate
Audio sample rate as indicated by the container. (Not always accurate.)

track-list/N/demux-fps
Video FPS as indicated by the container. (Not always accurate.)

track-list/N/audio-channels (deprecated)
Deprecated alias for track-list/N/demux-channel-count.

track-list/N/replaygain-track-peak, track-list/N/replaygain-track-gain
Per-track replaygain values. Only available for audio tracks with
corresponding information stored in the source file.

track-list/N/replaygain-album-peak, track-list/N/replaygain-album-gain
Per-album replaygain values. If the file has per-track but no per-album
information, the per-album values will be copied from the per-track values
currently. It's possible that future mpv versions will make these properties
unavailable instead in this case.

When querying the property with the client API using MPV_FORMAT_NODE, or with Lua
mp.get_property_native, this will return a mpv_node with the following contents:

MPV_FORMAT_NODE_ARRAY
MPV_FORMAT_NODE_MAP (for each track)
"id" MPV_FORMAT_INT64
"type" MPV_FORMAT_STRING
"src-id" MPV_FORMAT_INT64
"title" MPV_FORMAT_STRING
"lang" MPV_FORMAT_STRING
"albumart" MPV_FORMAT_FLAG
"default" MPV_FORMAT_FLAG
"forced" MPV_FORMAT_FLAG
"selected" MPV_FORMAT_FLAG
"external" MPV_FORMAT_FLAG
"external-filename" MPV_FORMAT_STRING
"codec" MPV_FORMAT_STRING
"ff-index" MPV_FORMAT_INT64
"decoder-desc" MPV_FORMAT_STRING
"demux-w" MPV_FORMAT_INT64
"demux-h" MPV_FORMAT_INT64
"demux-channel-count" MPV_FORMAT_INT64
"demux-channels" MPV_FORMAT_STRING
"demux-samplerate" MPV_FORMAT_INT64
"demux-fps" MPV_FORMAT_DOUBLE
"audio-channels" MPV_FORMAT_INT64
"replaygain-track-peak" MPV_FORMAT_DOUBLE
"replaygain-track-gain" MPV_FORMAT_DOUBLE
"replaygain-album-peak" MPV_FORMAT_DOUBLE
"replaygain-album-gain" MPV_FORMAT_DOUBLE

chapter-list
List of chapters, current entry marked. Currently, the raw property value is
useless.

This has a number of sub-properties. Replace N with the 0-based chapter index.

chapter-list/count
Number of chapters.

chapter-list/N/title
Chapter title as stored in the file. Not always available.

chapter-list/N/time
Chapter start time in seconds as float.

When querying the property with the client API using MPV_FORMAT_NODE, or with Lua
mp.get_property_native, this will return a mpv_node with the following contents:

MPV_FORMAT_NODE_ARRAY
MPV_FORMAT_NODE_MAP (for each chapter)
"title" MPV_FORMAT_STRING
"time" MPV_FORMAT_DOUBLE

af, vf (RW)
See --vf/--af and the vf/af command.

When querying the property with the client API using MPV_FORMAT_NODE, or with Lua
mp.get_property_native, this will return a mpv_node with the following contents:

MPV_FORMAT_NODE_ARRAY
MPV_FORMAT_NODE_MAP (for each filter entry)
"name" MPV_FORMAT_STRING
"label" MPV_FORMAT_STRING [optional]
"enabled" MPV_FORMAT_FLAG [optional]
"params" MPV_FORMAT_NODE_MAP [optional]
"key" MPV_FORMAT_STRING
"value" MPV_FORMAT_STRING

It's also possible to write the property using this format.

seekable
Return whether it's generally possible to seek in the current file.

partially-seekable
Return yes if the current file is considered seekable, but only because the cache
is active. This means small relative seeks may be fine, but larger seeks may fail
anyway. Whether a seek will succeed or not is generally not known in advance.

If this property returns true, seekable will also return true.

playback-abort
Return whether playback is stopped or is to be stopped. (Useful in obscure
situations like during on_load hook processing, when the user can stop playback,
but the script has to explicitly end processing.)

cursor-autohide (RW)
See --cursor-autohide. Setting this to a new value will always update the cursor,
and reset the internal timer.

osd-sym-cc
Inserts the current OSD symbol as opaque OSD control code (cc). This makes sense
only with the show-text command or options which set OSD messages. The control
code is implementation specific and is useless for anything else.

osd-ass-cc
${osd-ass-cc/0} disables escaping ASS sequences of text in OSD, ${osd-ass-cc/1}
enables it again. By default, ASS sequences are escaped to avoid accidental
formatting, and this property can disable this behavior. Note that the properties
return an opaque OSD control code, which only makes sense for the show-text command
or options which set OSD messages.

Example

• --osd-status-msg='This is ${osd-ass-cc/0}{\\b1}bold text'

• show-text "This is ${osd-ass-cc/0}{\b1}bold text"

Any ASS override tags as understood by libass can be used.

Note that you need to escape the \ character, because the string is processed for C
escape sequences before passing it to the OSD code.

A list of tags can be found here: http://docs.aegisub.org/latest/ASS_Tags/

vo-configured
Return whether the VO is configured right now. Usually this corresponds to whether
the video window is visible. If the --force-window option is used, this is usually
always returns yes.

vo-passes
Contains introspection about the VO's active render passes and their execution
times. Not implemented by all VOs.

This is further subdivided into two frame types, vo-passes/fresh for fresh frames
(which have to be uploaded, scaled, etc.) and vo-passes/redraw for redrawn frames
(which only have to be re-painted). The number of passes for any given subtype can
change from frame to frame, and should not be relied upon.

Each frame type has a number of further sub-properties. Replace TYPE with the frame
type, N with the 0-based pass index, and M with the 0-based sample index.

vo-passes/TYPE/count
Number of passes.

vo-passes/TYPE/N/desc
Human-friendy description of the pass.

vo-passes/TYPE/N/last
Last measured execution time, in nanoseconds.

vo-passes/TYPE/N/avg
Average execution time of this pass, in nanoseconds. The exact timeframe
varies, but it should generally be a handful of seconds.

vo-passes/TYPE/N/peak
The peak execution time (highest value) within this averaging range, in
nanoseconds.

vo-passes/TYPE/N/count
The number of samples for this pass.

vo-passes/TYPE/N/samples/M
The raw execution time of a specific sample for this pass, in nanoseconds.

When querying the property with the client API using MPV_FORMAT_NODE, or with Lua
mp.get_property_native, this will return a mpv_node with the following contents:

MPV_FORMAT_NODE_MAP
"TYPE" MPV_FORMAT_NODE_ARRAY
MPV_FORMAT_NODE_MAP
"desc" MPV_FORMAT_STRING
"last" MPV_FORMAT_INT64
"avg" MPV_FORMAT_INT64
"peak" MPV_FORMAT_INT64
"count" MPV_FORMAT_INT64
"samples" MPV_FORMAT_NODE_ARRAY
MP_FORMAT_INT64

Note that directly accessing this structure via subkeys is not supported, the only
access is through aforementioned MPV_FORMAT_NODE.

video-bitrate, audio-bitrate, sub-bitrate
Bitrate values calculated on the packet level. This works by dividing the bit size
of all packets between two keyframes by their presentation timestamp distance.
(This uses the timestamps are stored in the file, so e.g. playback speed does not
influence the returned values.) In particular, the video bitrate will update only
per keyframe, and show the "past" bitrate. To make the property more UI friendly,
updates to these properties are throttled in a certain way.

The unit is bits per second. OSD formatting turns these values in kilobits (or
megabits, if appropriate), which can be prevented by using the raw property value,
e.g. with ${=video-bitrate}.

Note that the accuracy of these properties is influenced by a few factors. If the
underlying demuxer rewrites the packets on demuxing (done for some file formats),
the bitrate might be slightly off. If timestamps are bad or jittery (like in
Matroska), even constant bitrate streams might show fluctuating bitrate.

How exactly these values are calculated might change in the future.

In earlier versions of mpv, these properties returned a static (but bad) guess
using a completely different method.

packet-video-bitrate, packet-audio-bitrate, packet-sub-bitrate
Old and deprecated properties for video-bitrate, audio-bitrate, sub-bitrate. They
behave exactly the same, but return a value in kilobits. Also, they don't have any
OSD formatting, though the same can be achieved with e.g. ${=video-bitrate}.

These properties shouldn't be used anymore.

audio-device-list
Return the list of discovered audio devices. This is mostly for use with the client
API, and reflects what --audio-device=help with the command line player returns.

When querying the property with the client API using MPV_FORMAT_NODE, or with Lua
mp.get_property_native, this will return a mpv_node with the following contents:

MPV_FORMAT_NODE_ARRAY
MPV_FORMAT_NODE_MAP (for each device entry)
"name" MPV_FORMAT_STRING
"description" MPV_FORMAT_STRING

The name is what is to be passed to the --audio-device option (and often a rather
cryptic audio API-specific ID), while description is human readable free form text.
The description is set to the device name (minus mpv-specific <driver>/ prefix) if
no description is available or the description would have been an empty string.

The special entry with the name set to auto selects the default audio output driver
and the default device.

The property can be watched with the property observation mechanism in the client
API and in Lua scripts. (Technically, change notification is enabled the first time
this property is read.)

audio-device (RW)
Set the audio device. This directly reads/writes the --audio-device option, but on
write accesses, the audio output will be scheduled for reloading.

Writing this property while no audio output is active will not automatically enable
audio. (This is also true in the case when audio was disabled due to
reinitialization failure after a previous write access to audio-device.)

This property also doesn't tell you which audio device is actually in use.

How these details are handled may change in the future.

current-vo
Current video output driver (name as used with --vo).

current-ao
Current audio output driver (name as used with --ao).

audio-out-detected-device
Return the audio device selected by the AO driver (only implemented for some
drivers: currently only coreaudio).

working-directory
Return the working directory of the mpv process. Can be useful for JSON IPC users,
because the command line player usually works with relative paths.

protocol-list
List of protocol prefixes potentially recognized by the player. They are returned
without trailing :// suffix (which is still always required). In some cases, the
protocol will not actually be supported (consider https if ffmpeg is not compiled
with TLS support).

decoder-list
List of decoders supported. This lists decoders which can be passed to --vd and
--ad.

family Decoder driver. Usually lavc for libavcodec.

codec Canonical codec name, which identifies the format the decoder can handle.

driver The name of the decoder itself. Often, this is the same as codec. Sometimes
it can be different. It is used to distinguish multiple decoders for the
same codec.

description
Human readable description of the decoder and codec.

When querying the property with the client API using MPV_FORMAT_NODE, or with Lua
mp.get_property_native, this will return a mpv_node with the following contents:

MPV_FORMAT_NODE_ARRAY
MPV_FORMAT_NODE_MAP (for each decoder entry)
"family" MPV_FORMAT_STRING
"codec" MPV_FORMAT_STRING
"driver" MPV_FORMAT_STRING
"description" MPV_FORMAT_STRING

encoder-list
List of libavcodec encoders. This has the same format as decoder-list. The encoder
names (driver entries) can be passed to --ovc and --oac (without the lavc: prefix
required by --vd and --ad).

mpv-version
Return the mpv version/copyright string. Depending on how the binary was built, it
might contain either a release version, or just a git hash.

mpv-configuration
Return the configuration arguments which were passed to the build system (typically
the way ./waf configure ... was invoked).

ffmpeg-version
Return the contents of the av_version_info() API call. This is a string which
identifies the build in some way, either through a release version number, or a git
hash. This applies to Libav as well (the property is still named the same.) This
property is unavailable if mpv is linked against older FFmpeg and Libav versions.

options/<name> (RW)
Read-only access to value of option --<name>. Most options can be changed at
runtime by writing to this property. Note that many options require reloading the
file for changes to take effect. If there is an equivalent property, prefer setting
the property instead.

There shouldn't be any reason to access options/<name> instead of <name>, except in
situations in which the properties have different behavior or conflicting
semantics.

file-local-options/<name>
Similar to options/<name>, but when setting an option through this property, the
option is reset to its old value once the current file has stopped playing. Trying
to write an option while no file is playing (or is being loaded) results in an
error.

(Note that if an option is marked as file-local, even options/ will access the
local value, and the old value, which will be restored on end of playback, cannot
be read or written until end of playback.)

option-info/<name>
Additional per-option information.

This has a number of sub-properties. Replace <name> with the name of a top-level
option. No guarantee of stability is given to any of these sub-properties - they
may change radically in the feature.

option-info/<name>/name
Returns the name of the option.

option-info/<name>/type
Return the name of the option type, like String or Integer. For many
complex types, this isn't very accurate.

option-info/<name>/set-from-commandline
Return yes if the option was set from the mpv command line, no otherwise.
What this is set to if the option is e.g. changed at runtime is left
undefined (meaning it could change in the future).

option-info/<name>/set-locally
Return yes if the option was set per-file. This is the case with
automatically loaded profiles, file-dir configs, and other cases. It means
the option value will be restored to the value before playback start when
playback ends.

option-info/<name>/default-value
The default value of the option. May not always be available.

option-info/<name>/min, option-info/<name>/max
Integer minimum and maximum values allowed for the option. Only available if
the options are numeric, and the minimum/maximum has been set internally.
It's also possible that only one of these is set.

option-info/<name>/choices
If the option is a choice option, the possible choices. Choices that are
integers may or may not be included (they can be implied by min and max).
Note that options which behave like choice options, but are not actual
choice options internally, may not have this info available.

property-list
Return the list of top-level properties.

profile-list
Return the list of profiles and their contents. This is highly
implementation-specific, and may change any time. Currently, it returns an array of
options for each profile. Each option has a name and a value, with the value
currently always being a string. Note that the options array is not a map, as order
matters and duplicate entries are possible. Recursive profiles are not expanded,
and show up as special profile options.

Inconsistencies between options and properties
You can access (almost) all options as properties, though there are some caveats with some
properties (due to historical reasons):

vid, aid, sid
While playback is active, you can set existing tracks only. (The option allows
setting any track ID, and which tracks to enable is chosen at loading time.)

Option changes at runtime are affected by this as well.

video-aspect
While video is active, always returns the effective aspect ratio. Setting a special
value (like no, values <= 0) will make the property set this as option, and return
whatever actual aspect was derived from the option setting.

display-fps
If a VO is created, this will return either the actual display FPS, or an invalid
value, instead of the option value.

vf, af If you set the properties during playback, and the filter chain fails to
reinitialize, the new value will be rejected. Setting the option or setting the
property outside of playback will always succeed/fail in the same way. Also, there
are no vf-add etc. properties, but you can use the vf/af group of commands to
achieve the same.

Option changes at runtime are affected by this as well.

edition
While a file is loaded, the property will always return the effective edition, and
setting the auto value will show somewhat strange behavior (the property eventually
switching to whatever is the default edition).

playlist
The property is read-only and returns the current internal playlist. The option is
for loading playlist during command line parsing. For client API uses, you should
use the loadlist command instead.

window-scale
Might verify the set value when setting while a window is created.

audio-file, sub-file, external-file
These options/properties are actually lists of filenames. To make the command-line
interface easier, each --audio-file=... option appends the full string to the
internal list. However, when used as properties, every time you set the property as
a string the internal list will be replaced with a single entry containing the
string you set. , or other separators are never used. You have to use
MPV_FORMAT_NODE_ARRAY (or corresponding API, e.g. mp.set_property_native() with a
table in Lua) to set multiple entries.

Strictly speaking, option access via API (e.g. mpv_set_option_string()) has the
same problem, and it's only a difference between CLI/API.

playlist-pos, chapter
These properties behave different from the deprecated options with the same names.

profile, include
These are write-only, and will perform actions as they are written to, exactly as
if they were used on the mpv CLI commandline. Their only use is when using libmpv
before mpv_initialize(), which in turn is probably only useful in encoding mode.
Normal libmpv users should use other mechanisms, such as the apply-profile command,
and the mpv_load_config_file API function. Avoid these properties.

Property Expansion
All string arguments to input commands as well as certain options (like
--term-playing-msg) are subject to property expansion. Note that property expansion does
not work in places where e.g. numeric parameters are expected. (For example, the add
command does not do property expansion. The set command is an exception and not a general
rule.)

Example for input.conf

i show-text Filename: ${filename}
shows the filename of the current file when pressing the i key

Within input.conf, property expansion can be inhibited by putting the raw prefix in front
of commands.

The following expansions are supported:

${NAME}
Expands to the value of the property NAME. If retrieving the property fails, expand
to an error string. (Use ${NAME:} with a trailing : to expand to an empty string
instead.) If NAME is prefixed with =, expand to the raw value of the property (see
section below).

${NAME:STR}
Expands to the value of the property NAME, or STR if the property cannot be
retrieved. STR is expanded recursively.

${?NAME:STR}
Expands to STR (recursively) if the property NAME is available.

${!NAME:STR}
Expands to STR (recursively) if the property NAME cannot be retrieved.

${?NAME==VALUE:STR}
Expands to STR (recursively) if the property NAME expands to a string equal to
VALUE. You can prefix NAME with = in order to compare the raw value of a property
(see section below). If the property is unavailable, or other errors happen when
retrieving it, the value is never considered equal. Note that VALUE can't contain
any of the characters : or }. Also, it is possible that escaping with " or % might
be added in the future, should the need arise.

${!NAME==VALUE:STR}
Same as with the ? variant, but STR is expanded if the value is not equal. (Using
the same semantics as with ?.)

$$ Expands to $.

$} Expands to }. (To produce this character inside recursive expansion.)

$> Disable property expansion and special handling of $ for the rest of the string.

In places where property expansion is allowed, C-style escapes are often accepted as well.
Example:

• \n becomes a newline character

• \\ expands to \

Raw and Formatted Properties
Normally, properties are formatted as human-readable text, meant to be displayed on OSD or
on the terminal. It is possible to retrieve an unformatted (raw) value from a property by
prefixing its name with =. These raw values can be parsed by other programs and follow the
same conventions as the options associated with the properties.

Examples

• ${time-pos} expands to 00:14:23 (if playback position is at 14 minutes 23 seconds)

• ${=time-pos} expands to 863.4 (same time, plus 400 milliseconds - milliseconds are
normally not shown in the formatted case)

Sometimes, the difference in amount of information carried by raw and formatted property
values can be rather big. In some cases, raw values have more information, like higher
precision than seconds with time-pos. Sometimes it is the other way around, e.g. aid shows
track title and language in the formatted case, but only the track number if it is raw.

ON SCREEN CONTROLLER

       The On Screen Controller (short: OSC) is a minimal GUI integrated with mpv to offer  basic
       mouse-controllability.  It  is  intended  to  make interaction easier for new users and to
       enable precise and direct seeking.

       The OSC is enabled by default if mpv was compiled with Lua support.  It  can  be  disabled
       entirely using the --osc=no option.

   Using the OSC
       By  default, the OSC will show up whenever the mouse is moved inside the player window and
       will hide if the mouse is not moved outside the OSC for 0.5 seconds or if the mouse leaves
       the window.

   The Interface
          +---------+----------+------------------------------------------+----------+
          | pl prev | pl next  |  title                                   |    cache |
          +------+--+---+------+---------+-----------+------+-------+-----+-----+----+
          | play | skip | skip | time    |  seekbar  | time | audio | sub | vol | fs |
          |      | back | frwd | elapsed |           | left |       |     |     |    |
          +------+------+------+---------+-----------+------+-------+-----+-----+----+

       pl prev

                               ┌──────────────┬────────────────────────────────┐
                               │left-click    │ play previous file in playlist │
                               ├──────────────┼────────────────────────────────┤
                               │right-click   │ show playlist                  │
                               ├──────────────┼────────────────────────────────┤
                               │shift+L-click │ show playlist                  │
                               └──────────────┴────────────────────────────────┘

       pl next

                                 ┌──────────────┬────────────────────────────┐
                                 │left-click    │ play next file in playlist │
                                 ├──────────────┼────────────────────────────┤
                                 │right-click   │ show playlist              │
                                 ├──────────────┼────────────────────────────┤
                                 │shift+L-click │ show playlist              │
                                 └──────────────┴────────────────────────────┘

       title
              Displays current media-title, filename, or custom title

                               ┌────────────┬──────────────────────────────────┐
                               │left-click  │ show   playlist   position   and │
                               │            │ length and full title            │
                               ├────────────┼──────────────────────────────────┤
                               │right-click │ show filename                    │
                               └────────────┴──────────────────────────────────┘

       cache
              Shows current cache fill status

       play

                                       ┌───────────┬───────────────────┐
                                       │left-click │ toggle play/pause │
                                       └───────────┴───────────────────┘

       skip back

                              ┌──────────────┬──────────────────────────────────┐
                              │left-click    │ go to  beginning  of  chapter  / │
                              │              │ previous chapter                 │
                              ├──────────────┼──────────────────────────────────┤
                              │right-click   │ show chapters                    │
                              ├──────────────┼──────────────────────────────────┤
                              │shift+L-click │ show chapters                    │
                              └──────────────┴──────────────────────────────────┘

       skip frwd

                                     ┌──────────────┬────────────────────┐
                                     │left-click    │ go to next chapter │
                                     ├──────────────┼────────────────────┤
                                     │right-click   │ show chapters      │
                                     ├──────────────┼────────────────────┤
                                     │shift+L-click │ show chapters      │
                                     └──────────────┴────────────────────┘

       time elapsed
              Shows current playback position timestamp

                                ┌───────────┬──────────────────────────────────┐
                                │left-click │ toggle displaying timecodes with │
                                │           │ milliseconds                     │
                                └───────────┴──────────────────────────────────┘

       seekbar
              Indicates current playback position and position of chapters

                                        ┌───────────┬──────────────────┐
                                        │left-click │ seek to position │
                                        └───────────┴──────────────────┘

       time left
              Shows remaining playback time timestamp

                                ┌───────────┬──────────────────────────────────┐
                                │left-click │ toggle   between    total    and │
                                │           │ remaining time                   │
                                └───────────┴──────────────────────────────────┘

       audio and sub
              Displays selected track and amount of available tracks

                              ┌──────────────┬──────────────────────────────────┐
                              │left-click    │ cycle audio/sub tracks forward   │
                              ├──────────────┼──────────────────────────────────┤
                              │right-click   │ cycle audio/sub tracks backwards │
                              ├──────────────┼──────────────────────────────────┤
                              │shift+L-click │ show available audio/sub tracks  │
                              └──────────────┴──────────────────────────────────┘

       vol

                                        ┌────────────┬────────────────┐
                                        │left-click  │ toggle mute    │
                                        ├────────────┼────────────────┤
                                        │mouse wheel │ volume up/down │
                                        └────────────┴────────────────┘

       fs

                                       ┌───────────┬───────────────────┐
                                       │left-click │ toggle fullscreen │
                                       └───────────┴───────────────────┘

   Key Bindings
       These  key  bindings are active by default if nothing else is already bound to these keys.
       In case of collision, the function needs to be bound to a different key.  See  the  Script
       Commands section.

                                ┌────┬──────────────────────────────────┐
                                │del │ Cycles  visibility between never │
                                │    │ / auto (mouse-move) / always     │
                                └────┴──────────────────────────────────┘

   Configuration
       The OSC offers limited configuration through a config file lua-settings/osc.conf placed in
       mpv's user dir and through the --script-opts command-line option. Options provided through
       the command-line will override those from the config file.

   Config Syntax
       The config file must exactly follow the following syntax:

          # this is a comment
          optionA=value1
          optionB=value2

       # can only be used at the beginning of a line and there may be no spaces around the  =  or
       anywhere else.

   Command-line Syntax
       To avoid collisions with other scripts, all options need to be prefixed with osc-.

       Example:

          --script-opts=osc-optionA=value1,osc-optionB=value2

   Configurable Options
       layout Default: bottombar

              The  layout  for  the  OSC.  Currently  available  are: box, slimbox, bottombar and
              topbar. Default pre-0.21.0 was 'box'.

       seekbarstyle
              Default: bar

              Sets the style of the seekbar, slider (diamond marker), knob  (circle  marker  with
              guide), or bar (fill).  Default pre-0.21.0 was 'slider'.

       deadzonesize
              Default: 0.5

              Size of the deadzone. The deadzone is an area that makes the mouse act like leaving
              the window. Movement there won't make the OSC show up and it will hide  immediately
              if  the  mouse  enters it. The deadzone starts at the window border opposite to the
              OSC and the size controls how much of the window it will span. Values  between  0.0
              and 1.0, where 0 means the OSC will always popup with mouse movement in the window,
              and 1 means the OSC will only show up when the mouse hovers it. Default  pre-0.21.0
              was 0.

       minmousemove
              Default: 0

              Minimum  amount  of pixels the mouse has to move between ticks to make the OSC show
              up. Default pre-0.21.0 was 3.

       showwindowed
              Default: yes

              Enable the OSC when windowed

       showfullscreen
              Default: yes

              Enable the OSC when fullscreen

       scalewindowed
              Default: 1.0

              Scale factor of the OSC when windowed.

       scalefullscreen
              Default: 1.0

              Scale factor of the OSC when fullscreen

       scaleforcedwindow
              Default: 2.0

              Scale factor of the OSC when rendered on a forced (dummy) window

       vidscale
              Default: yes

              Scale the OSC with the video no tries to keep the OSC size constant as much as  the
              window size allows

       valign Default: 0.8

              Vertical alignment, -1 (top) to 1 (bottom)

       halign Default: 0.0

              Horizontal alignment, -1 (left) to 1 (right)

       barmargin
              Default: 0

              Margin from bottom (bottombar) or top (topbar), in pixels

       boxalpha
              Default: 80

              Alpha of the background box, 0 (opaque) to 255 (fully transparent)

       hidetimeout
              Default: 500

              Duration in ms until the OSC hides if no mouse movement, must not be negative

       fadeduration
              Default: 200

              Duration of fade out in ms, 0 = no fade

       title  Default: ${media-title}

              String  that  supports property expansion that will be displayed as OSC title.  ASS
              tags are escaped, and newlines and trailing slashes are stripped.

       tooltipborder
              Default: 1

              Size of the tooltip outline when using bottombar or topbar layouts

       timetotal
              Default: no

              Show total time instead of time remaining

       timems Default: no

              Display timecodes with milliseconds

       visibility
              Default: auto (auto hide/show on mouse move)

              Also supports never and always

       boxmaxchars
              Default: 80

              Max chars for the osc title at the box layout. mpv does not measure the text  width
              on  screen  and  so  it  needs  to  limit  it  by  number  of chars. The default is
              conservative to allow wide fonts to be used without overflow.  However,  with  many
              common fonts a bigger number can be used. YMMV.

   Script Commands
       The OSC script listens to certain script commands. These commands can bound in input.conf,
       or sent by other scripts.

       osc-message
              Show a message on screen using the OSC. First argument is the message,  second  the
              duration in seconds.

       osc-visibility
              Controls  visibility  mode  never / auto (on mouse move) / always and also cycle to
              cycle between the modes

       Example

       You could put this into input.conf to hide the OSC with the a key and  to  set  auto  mode
       (the default) with b:

          a script-message osc-visibility never
          b script-message osc-visibility auto

       osc-playlist, osc-chapterlist, osc-tracklist
              Shows  a  limited view of the respective type of list using the OSC. First argument
              is duration in seconds.

LUA SCRIPTING

       mpv can load Lua scripts. Scripts passed to the --script option, or found in  the  scripts
       subdirectory  of  the mpv configuration directory (usually ~/.config/mpv/scripts/) will be
       loaded on program start. mpv also appends the scripts subdirectory to  the  end  of  Lua's
       path  so  you  can  import scripts from there too. Since it's added to the end, don't name
       scripts you want to import the same as Lua libraries because they will be overshadowed  by
       them.

       mpv  provides the built-in module mp, which contains functions to send commands to the mpv
       core and to retrieve information about playback state, user  settings,  file  information,
       and so on.

       These scripts can be used to control mpv in a similar way to slave mode.  Technically, the
       Lua code uses the client API internally.

   Example
       A script which leaves fullscreen mode when the player is paused:

          function on_pause_change(name, value)
              if value == true then
                  mp.set_property("fullscreen", "no")
              end
          end
          mp.observe_property("pause", "bool", on_pause_change)

   Details on the script initialization and lifecycle
       Your script will be loaded by the player at program start from the  scripts  configuration
       subdirectory,  or  from a path specified with the --script option. Some scripts are loaded
       internally (like --osc). Each script runs in its own thread. Your script is first run  "as
       is",  and  once  that  is  done,  the event loop is entered. This event loop will dispatch
       events received by mpv and call your own event handlers which  you  have  registered  with
       mp.register_event, or timers added with mp.add_timeout or similar.

       When the player quits, all scripts will be asked to terminate. This happens via a shutdown
       event, which by default will make the event loop  return.  If  your  script  got  into  an
       endless  loop,  mpv will probably behave fine during playback, but it won't terminate when
       quitting, because it's waiting on your script.

       Internally, the C code will call the  Lua  function  mp_event_loop  after  loading  a  Lua
       script. This function is normally defined by the default prelude loaded before your script
       (see player/lua/defaults.lua in the mpv sources).  The event loop will wait for events and
       dispatch  events  registered with mp.register_event. It will also handle timers added with
       mp.add_timeout and similar (by waiting with a timeout).

       Since mpv 0.6.0, the player will wait until the script is fully loaded  before  continuing
       normal  operation.  The  player  considers  a  script as fully loaded as soon as it starts
       waiting for mpv events (or it exits). In practice this means the player will more or  less
       hang  until  the  script returns from the main chunk (and mp_event_loop is called), or the
       script calls mp_event_loop or  mp.dispatch_events  directly.  This  is  done  to  make  it
       possible  for a script to fully setup event handlers etc. before playback actually starts.
       In older mpv versions, this happened asynchronously.

   mp functions
       The mp module is preloaded, although it can be  loaded  manually  with  require  'mp'.  It
       provides the core client API.

       mp.command(string)
              Run  the  given  command.  This is similar to the commands used in input.conf.  See
              List of Input Commands.

              By default, this will show something on the OSD (depending on the command),  as  if
              it  was  used  in input.conf. See Input Command Prefixes how to influence OSD usage
              per command.

              Returns true on success, or nil, error on error.

       mp.commandv(arg1, arg2, ...)
              Similar to mp.command, but pass each command argument as separate  parameter.  This
              has  the  advantage  that you don't have to care about quoting and escaping in some
              cases.

              Example:

                 mp.command("loadfile " .. filename .. " append")
                 mp.commandv("loadfile", filename, "append")

              These two commands are equivalent, except that the  first  version  breaks  if  the
              filename contains spaces or certain special characters.

              Note  that  properties  are  not  expanded.   You  can  use  either mp.command, the
              expand-properties prefix, or the mp.get_property family of functions.

              Unlike mp.command, this will not  use  OSD  by  default  either  (except  for  some
              OSD-specific commands).

       mp.command_native(table [,def])
              Similar to mp.commandv, but pass the argument list as table. This has the advantage
              that in at least some cases, arguments can be passed as native types.

              Returns a result table on success (usually empty), or def, error on error.  def  is
              the second parameter provided to the function, and is nil if it's missing.

       mp.get_property(name [,def])
              Return  the value of the given property as string. These are the same properties as
              used in input.conf. See Properties for a list of properties. The returned string is
              formatted similar to ${=name} (see Property Expansion).

              Returns  the string on success, or def, error on error. def is the second parameter
              provided to the function, and is nil if it's missing.

       mp.get_property_osd(name [,def])
              Similar to mp.get_property, but return the property value formatted for  OSD.  This
              is the same string as printed with ${name} when used in input.conf.

              Returns  the string on success, or def, error on error. def is the second parameter
              provided to  the  function,  and  is  an  empty  string  if  it's  missing.  Unlike
              get_property(),  assigning  the  return value to a variable will always result in a
              string.

       mp.get_property_bool(name [,def])
              Similar to mp.get_property, but return the property value as Boolean.

              Returns a Boolean on success, or def, error on error.

       mp.get_property_number(name [,def])
              Similar to mp.get_property, but return the property value as number.

              Note that while Lua does not distinguish between integers and floats, mpv internals
              do.  This  function  simply  request  a double float from mpv, and mpv will usually
              convert integer property values to float.

              Returns a number on success, or def, error on error.

       mp.get_property_native(name [,def])
              Similar to mp.get_property, but return the property value using the best  Lua  type
              for  the  property.  Most time, this will return a string, Boolean, or number. Some
              properties (for example chapter-list) are returned as tables.

              Returns a value on success, or def, error on  error.  Note  that  nil  might  be  a
              possible, valid value too in some corner cases.

       mp.set_property(name, value)
              Set  the  given  property  to  the  given  string  value.  See  mp.get_property and
              Properties for more information about properties.

              Returns true on success, or nil, error on error.

       mp.set_property_bool(name, value)
              Similar to mp.set_property, but set the given property to the given Boolean value.

       mp.set_property_number(name, value)
              Similar to mp.set_property, but set the given property to the given numeric value.

              Note that while Lua does not distinguish between integers and floats, mpv internals
              do.  This  function will test whether the number can be represented as integer, and
              if so, it will pass an integer value to mpv, otherwise a double float.

       mp.set_property_native(name, value)
              Similar to mp.set_property, but set the given property using its native type.

              Since there are several data types which cannot represented natively in  Lua,  this
              might  not  always work as expected. For example, while the Lua wrapper can do some
              guesswork to decide whether a Lua table is an array or a map, this would fail  with
              empty  tables.  Also, there are not many properties for which it makes sense to use
              this, instead of set_property, set_property_bool, set_property_number.   For  these
              reasons,  this  function  should probably be avoided for now, except for properties
              that use tables natively.

       mp.get_time()
              Return the current mpv internal time in seconds as a number. This is basically  the
              system time, with an arbitrary offset.

       mp.add_key_binding(key, name|fn [,fn [,flags]])
              Register  callback  to  be  run on a key binding. The binding will be mapped to the
              given key, which is a string describing the physical key. This uses  the  same  key
              names  as  in input.conf, and also allows combinations (e.g. ctrl+a). If the key is
              empty or nil, no physical key is registered, but the  user  still  can  create  own
              bindings (see below).

              After  calling  this  function, key presses will cause the function fn to be called
              (unless the user remapped the key with another binding).

              The name argument should be a short symbolic string. It allows the  user  to  remap
              the  key  binding  via input.conf using the script-message command, and the name of
              the key binding (see below for an example). The name should be unique across  other
              bindings  in the same script - if not, the previous binding with the same name will
              be overwritten. You can omit the name, in which case a  random  name  is  generated
              internally.

              The  last  argument is used for optional flags. This is a table, which can have the
              following entries:

                 repeatable
                        If set to true, enables key repeat for this specific binding.

                 complex
                        If set to true, then fn is called on both key up and down events (as well
                        as  key  repeat, if enabled), with the first argument being a table. This
                        table has an event entry, which is  set  to  one  of  the  strings  down,
                        repeat,  up  or  press  (the  latter if key up/down can't be tracked). It
                        further has an is_mouse entry, which tells whether the event  was  caused
                        by a mouse button.

              Internally, key bindings are dispatched via the script-message-to or script-binding
              input commands and mp.register_script_message.

              Trying to map multiple commands to a key will essentially prefer a random  binding,
              while  the  other  bindings  are  not  called.  It  is guaranteed that user defined
              bindings in the central input.conf are preferred  over  bindings  added  with  this
              function (but see mp.add_forced_key_binding).

              Example:

                 function something_handler()
                     print("the key was pressed")
                 end
                 mp.add_key_binding("x", "something", something_handler)

              This will print the message the key was pressed when x was pressed.

              The  user can remap these key bindings. Then the user has to put the following into
              their input.conf to remap the command to the y key:

                 y script-binding something

              This will print the message when the key y is pressed. (x will still  work,  unless
              the user remaps it.)

              You  can  also  explicitly  send a message to a named script only. Assume the above
              script was using the filename fooscript.lua:

                 y script-binding fooscript/something

       mp.add_forced_key_binding(...)
              This works almost the same as mp.add_key_binding, but registers the key binding  in
              a  way  that  will  overwrite  the  user's  custom  bindings  in  their input.conf.
              (mp.add_key_binding overwrites default key bindings only,  but  not  those  by  the
              user's input.conf.)

       mp.remove_key_binding(name)
              Remove  a  key  binding added with mp.add_key_binding or mp.add_forced_key_binding.
              Use the same name as you used when adding the bindings. It's not possible to remove
              bindings for which you omitted the name.

       mp.register_event(name, fn)
              Call a specific function when an event happens. The event name is a string, and the
              function fn is a Lua function value.

              Some events have associated data. This is put  into  a  Lua  table  and  passed  as
              argument  to  fn. The Lua table by default contains a name field, which is a string
              containing the event name. If the event has an error associated, the error field is
              set to a string describing the error, on success it's not set.

              If  multiple  functions  are  registered  for  the  same  event,  they  are  run in
              registration order, which the first registered  function  running  before  all  the
              other ones.

              Returns true if such an event exists, false otherwise.

              See Events and List of events for details.

       mp.unregister_event(fn)
              Undo  mp.register_event(..., fn). This removes all event handlers that are equal to
              the fn parameter. This uses normal Lua == comparison, so be  careful  when  dealing
              with closures.

       mp.observe_property(name, type, fn)
              Watch  a  property  for changes. If the property name is changed, then the function
              fn(name) will be called. type can be nil, or be set to one of none,  native,  bool,
              string, or number.  none is the same as nil. For all other values, the new value of
              the property will be passed as second argument to fn, using  mp.get_property_<type>
              to  retrieve  it. This means if type is for example string, fn is roughly called as
              in fn(name, mp.get_property_string(name)).

              If possible, change events are coalesced. If a property is changed a bunch of times
              in  a  row,  only the last change triggers the change function. (The exact behavior
              depends on timing and other things.)

              In some cases the function is not called even if  the  property  changes.   Whether
              this can happen depends on the property.

              If  the  type  is  none  or nil, sporadic property change events are possible. This
              means the change function fn can be called even if the  property  doesn't  actually
              change.

       mp.unobserve_property(fn)
              Undo  mp.observe_property(...,  fn).  This  removes  all property handlers that are
              equal to the fn parameter. This uses normal Lua == comparison, so be  careful  when
              dealing with closures.

       mp.add_timeout(seconds, fn)
              Call the given function fn when the given number of seconds has elapsed.  Note that
              the number of seconds can be fractional. For now, the timer's resolution may be  as
              low as 50 ms, although this will be improved in the future.

              This is a one-shot timer: it will be removed when it's fired.

              Returns a timer object. See mp.add_periodic_timer for details.

       mp.add_periodic_timer(seconds, fn)
              Call the given function periodically. This is like mp.add_timeout, but the timer is
              re-added after the function fn is run.

              Returns a timer object. The timer object provides the following methods:

                     stop() Disable the timer. Does nothing if the  timer  is  already  disabled.
                            This  will  remember  the current elapsed time when stopping, so that
                            resume() essentially unpauses the timer.

                     kill() Disable the timer. Resets the elapsed time. resume() will restart the
                            timer.

                     resume()
                            Restart  the  timer. If the timer was disabled with stop(), this will
                            resume at the time it was stopped. If the  timer  was  disabled  with
                            kill(),  or  if  it's  a  previously fired one-shot timer (added with
                            add_timeout()), this starts the timer from the beginning,  using  the
                            initially configured timeout.

                     is_enabled()
                            Whether  the  timer  is  currently enabled or was previously disabled
                            (e.g. by stop() or kill()).

                     timeout (RW)
                            This field contains the current timeout period.  This  value  is  not
                            updated  as  time  progresses.  It's  only used to calculate when the
                            timer should fire next when the timer expires.

                            If you write this, you can call t:kill() ; t:resume()  to  reset  the
                            current timeout to the new one. (t:stop() won't use the new timeout.)

                     oneshot (RW)
                            Whether the timer is periodic (false) or fires just once (true). This
                            value is used when the timer expires (but before the  timer  callback
                            function fn is run).

              Note  that  these are method, and you have to call them using : instead of . (Refer
              to http://www.lua.org/manual/5.2/manual.html#3.4.9 .)

              Example:

                 seconds = 0
                 timer = mp.add_periodic_timer(1, function()
                     print("called every second")
                     # stop it after 10 seconds
                     seconds = seconds + 1
                     if seconds >= 10 then
                         timer:kill()
                     end
                 end)

       mp.get_opt(key)
              Return a setting from the --script-opts option. It's up to the user and the  script
              how  this mechanism is used. Currently, all scripts can access this equally, so you
              should be careful about collisions.

       mp.get_script_name()
              Return the name of the current script. The name is usually made of the filename  of
              the script, with directory and file extension removed. If there are several scripts
              which would have the same name, it's made unique by appending a number.

                 Example

                        The script /path/to/fooscript.lua becomes fooscript.

       mp.osd_message(text [,duration])
              Show an OSD message on the screen. duration is in seconds, and  is  optional  (uses
              --osd-duration by default).

   Advanced mp functions
       These also live in the mp module, but are documented separately as they are useful only in
       special situations.

       mp.suspend()
              This function has been deprecated in mpv 0.21.0 and does nothing starting with  mpv
              0.23.0 (no replacement).

       mp.resume()
              This  function has been deprecated in mpv 0.21.0 and does nothing starting with mpv
              0.23.0 (no replacement).

       mp.resume_all()
              This function has been deprecated in mpv 0.21.0 and does nothing starting with  mpv
              0.23.0 (no replacement).

       mp.get_wakeup_pipe()
              Calls  mpv_get_wakeup_pipe()  and  returns  the  read  end of the wakeup pipe. (See
              client.h for details.)

       mp.get_next_timeout()
              Return the relative time  in  seconds  when  the  next  timer  (mp.add_timeout  and
              similar) expires. If there is no timer, return nil.

       mp.dispatch_events([allow_wait])
              This can be used to run custom event loops. If you want to have direct control what
              the Lua script does (instead of being called by the default event  loop),  you  can
              set  the global variable mp_event_loop to your own function running the event loop.
              From your event loop, you should call mp.dispatch_events() to dequeue and  dispatch
              mpv events.

              If  the allow_wait parameter is set to true, the function will block until the next
              event is received or the next timer expires. Otherwise (and  this  is  the  default
              behavior),  it  returns  as  soon  as  the  event  loop  is  emptied. It's strongly
              recommended  to  use  mp.get_next_timeout()  and  mp.get_wakeup_pipe()  if   you're
              interested in properly working notification of new events and working timers.

       mp.register_idle(fn)
              Register  an  event  loop  idle handler. Idle handlers are called before the script
              goes to sleep after handling all new events. This can be used for example to  delay
              processing  of  property  change events: if you're observing multiple properties at
              once, you might not want to act on each property change, but only when  all  change
              notifications have been received.

       mp.unregister_idle(fn)
              Undo  mp.register_idle(fn). This removes all idle handlers that are equal to the fn
              parameter. This uses normal Lua == comparison, so  be  careful  when  dealing  with
              closures.

       mp.enable_messages(level)
              Set  the  minimum  log level of which mpv message output to receive. These messages
              are normally printed to the terminal. By calling this function,  you  can  set  the
              minimum  log level of messages which should be received with the log-message event.
              See the description of this event for details.  The level is a string, see  msg.log
              for allowed log levels.

       mp.register_script_message(name, fn)
              This is a helper to dispatch script-message or script-message-to invocations to Lua
              functions. fn is called if script-message or script-message-to (with this script as
              destination)  is  run with name as first parameter. The other parameters are passed
              to fn.  If a message with the given name is already registered, it's overwritten.

              Used by mp.add_key_binding, so be careful about name collisions.

       mp.unregister_script_message(name)
              Undo a previous registration with mp.register_script_message. Does nothing  if  the
              name wasn't registered.

   mp.msg functions
       This  module  allows  outputting  messages to the terminal, and can be loaded with require
       'mp.msg'.

       msg.log(level, ...)
              The level parameter is the message priority. It's a string and one of fatal, error,
              warn,  info,  v,  debug. The user's settings will determine which of these messages
              will be visible. Normally, all messages are visible, except v and debug.

              The parameters after that are all converted to  strings.  Spaces  are  inserted  to
              separate multiple parameters.

              You don't need to add newlines.

       msg.fatal(...),    msg.error(...),    msg.warn(...),    msg.info(...),   msg.verbose(...),
       msg.debug(...)
              All of these are shortcuts and equivalent to the corresponding msg.log(level,  ...)
              call.

   mp.options functions
       mpv comes with a built-in module to manage options from config-files and the command-line.
       All you have to do is to supply a table with default options to the read_options function.
       The  function  will  overwrite the default values with values found in the config-file and
       the command-line (in that order).

       options.read_options(table [, identifier])
              A table with key-value pairs. The type of  the  default  values  is  important  for
              converting  the  values  read from the config file or command-line back. Do not use
              nil as a default value!

              The identifier is used to identify the config-file and  the  command-line  options.
              These  needs  to  unique  to  avoid  collisions  with  other  scripts.  Defaults to
              mp.get_script_name().

       Example implementation:

          require 'mp.options'
          local options = {
              optionA = "defaultvalueA",
              optionB = -0.5,
              optionC = true,
          }
          read_options(options, "myscript")
          print(options.optionA)

       The config file will be stored  in  lua-settings/identifier.conf  in  mpv's  user  folder.
       Comment lines can be started with # and stray spaces are not removed.  Boolean values will
       be represented with yes/no.

       Example config:

          # comment
          optionA=Hello World
          optionB=9999
          optionC=no

       Command-line options are read from the --script-opts parameter. To avoid  collisions,  all
       keys have to be prefixed with identifier-.

       Example command-line:

          --script-opts=myscript-optionA=TEST,myscript-optionB=0,myscript-optionC=yes

   mp.utils functions
       This built-in module provides generic helper functions for Lua, and have strictly speaking
       nothing to do with mpv or video/audio playback. They are provided  for  convenience.  Most
       compensate for Lua's scarce standard library.

       Be warned that any of these functions might disappear any time. They are not strictly part
       of the guaranteed API.

       utils.getcwd()
              Returns the directory that mpv was launched from. On error, nil, error is returned.

       utils.readdir(path [, filter])
              Enumerate all entries at the given path on  the  filesystem,  and  return  them  as
              array.  Each  entry  is a directory entry (without the path).  The list is unsorted
              (in whatever order the operating system returns it).

              If the filter argument is given, it must be one of the following strings:

                 files  List regular files only. This excludes directories, special  files  (like
                        UNIX device files or FIFOs), and dead symlinks. It includes UNIX symlinks
                        to regular files.

                 dirs   List directories only, or symlinks to directories.  .  and  ..   are  not
                        included.

                 normal Include the results of both files and dirs. (This is the default.)

                 all    List  all entries, even device files, dead symlinks, FIFOs, and the . and
                        .. entries.

              On error, nil, error is returned.

       utils.split_path(path)
              Split a path into directory component and filename component, and return them.  The
              first return value is always the directory. The second return value is the trailing
              part of the path, the directory entry.

       utils.join_path(p1, p2)
              Return the concatenation of the 2 paths. Tries to be clever. For example, if `p2 is
              an absolute path, p2 is returned without change.

       utils.subprocess(t)
              Runs  an  external process and waits until it exits. Returns process status and the
              captured output.

              The parameter t is a table. The function reads the following entries:

                 args   Array of strings. The first array entry is the executable.  This  can  be
                        either  an absolute path, or a filename with no path components, in which
                        case the PATH environment variable is used to resolve the executable. The
                        other array elements are passed as command line arguments.

                 cancellable
                        Optional.  If  set  to true (default), then if the user stops playback or
                        goes to the next file while the process is running, the process  will  be
                        killed.

                 max_size
                        Optional. The maximum size in bytes of the data that can be captured from
                        stdout. (Default: 16 MB.)

              The function returns a table as result with the following entries:

                 status The raw exit status of the process. It will be negative on error.

                 stdout Captured output stream as string, limited to max_size.

                 error  nil on success. The string killed if the process  was  terminated  in  an
                        unusual way. The string init if the process could not be started.

                        On  Windows,  killed is only returned when the process has been killed by
                        mpv as a result of cancellable being set to true.

                 killed_by_us
                        Set to true if the process  has  been  killed  by  mpv  as  a  result  of
                        cancellable being set to true.

       utils.subprocess_detached(t)
              Runs an external process and detaches it from mpv's control.

              The parameter t is a table. The function reads the following entries:

                 args   Array of strings of the same semantics as the args used in the subprocess
                        function.

              The function returns nil.

       utils.parse_json(str [, trail])
              Parses the given string argument as JSON, and returns it as a Lua table. On  error,
              returns nil, error. (Currently, error is just a string reading error, because there
              is no fine-grained error reporting of any kind.)

              The  returned  value  uses  similar  conventions  as  mp.get_property_native()   to
              distinguish empty objects and arrays.

              If  the  trail  parameter  is  true  (or  any  value  equal to true), then trailing
              non-whitespace text is tolerated by the function, and the trailing text is returned
              as  3rd return value. (The 3rd return value is always there, but with trail set, no
              error is raised.)

       utils.format_json(v)
              Format the given Lua table (or value) as a JSON string and  return  it.  On  error,
              returns  nil,  error.  (Errors usually only happen on value types incompatible with
              JSON.)

              The  argument  value  uses  similar  conventions  as  mp.set_property_native()   to
              distinguish empty objects and arrays.

       utils.to_string(v)
              Turn the given value into a string. Formats tables and their contents. This doesn't
              do anything special; it is only needed because Lua is terrible.

   Events
       Events are notifications from player core to scripts. You can register  an  event  handler
       with mp.register_event.

       Note  that all scripts (and other parts of the player) receive events equally, and there's
       no such thing as blocking other scripts from receiving events.

       Example:

          function my_fn(event)
              print("start of playback!")
          end

          mp.register_event("file-loaded", my_fn)

   List of events
       start-file
              Happens right before a new file is loaded. When you receive  this,  the  player  is
              loading the file (or possibly already done with it).

       end-file
              Happens  after  a  file was unloaded. Typically, the player will load the next file
              right away, or quit if this was the last file.

              The event has the reason field, which takes one of these values:

              eof    The file has ended. This can (but doesn't have to) include incomplete  files
                     or broken network connections under circumstances.

              stop   Playback was ended by a command.

              quit   Playback was ended by sending the quit command.

              error  An  error  happened.  In this case, an error field is present with the error
                     string.

              redirect
                     Happens with playlists and similar. Details see MPV_END_FILE_REASON_REDIRECT
                     in the C API.

              unknown
                     Unknown. Normally doesn't happen, unless the Lua API is out of sync with the
                     C API. (Likewise, it could happen that your script gets reason strings  that
                     did not exist yet at the time your script was written.)

       file-loaded
              Happens after a file was loaded and begins playback.

       seek   Happens  on  seeking.  (This  might include cases when the player seeks internally,
              even without user interaction. This includes  e.g.  segment  changes  when  playing
              ordered chapters Matroska files.)

       playback-restart
              Start of playback after seek or after file was loaded.

       idle   Idle  mode is entered. This happens when playback ended, and the player was started
              with --idle or --force-window. This mode is implicitly ended when the start-file or
              shutdown events happen.

       tick   Called  after  a  video  frame  was displayed. This is a hack, and you should avoid
              using it. Use timers instead and maybe  watch  pausing/unpausing  events  to  avoid
              wasting CPU when the player is paused.

       shutdown
              Sent  when  the  player  quits,  and  the script should terminate. Normally handled
              automatically. See Details on the script initialization and lifecycle.

       log-message
              Receives messages enabled with mp.enable_messages. The message data is contained in
              the  table  passed as first parameter to the event handler.  The table contains, in
              addition to the default event fields, the following fields:

              prefix The module prefix, identifies the sender of the message. This  is  what  the
                     terminal player puts in front of the message text when using the --v option,
                     and is also what is used for --msg-level.

              level  The log level as string. See msg.log for possible  log  level  names.   Note
                     that  later  versions  of  mpv might add new levels or remove (undocumented)
                     existing ones.

              text   The log message. The text will end with a newline  character.  Sometimes  it
                     can contain multiple lines.

              Keep  in  mind that these messages are meant to be hints for humans. You should not
              parse them, and prefix/level/text of messages might change any time.

       get-property-reply
              Undocumented (not useful for Lua scripts).

       set-property-reply
              Undocumented (not useful for Lua scripts).

       command-reply
              Undocumented (not useful for Lua scripts).

       client-message
              Undocumented (used internally).

       video-reconfig
              Happens on video output or filter reconfig.

       audio-reconfig
              Happens on audio output or filter reconfig.

       The following events also happen,  but  are  deprecated:  tracks-changed,  track-switched,
       pause, unpause, metadata-update, chapter-change. Use mp.observe_property() instead.

   Extras
       This  documents  experimental  features, or features that are "too special" to guarantee a
       stable interface.

       mp.add_hook(type, priority, fn)
              Add a hook callback for type (a string identifying a certain kind of  hook).  These
              hooks  allow  the  player  to  call  script  functions  and  wait  for their result
              (normally, the Lua scripting interface is asynchronous from the point  of  view  of
              the player core). priority is an arbitrary integer that allows ordering among hooks
              of the same kind. Using the value 50 is recommended as neutral default value. fn is
              the function that will be called during execution of the hook.

              See  Hooks  for  currently  existing hooks and what they do - only the hook list is
              interesting;  handling  hook  execution  is  done  by  the  Lua   script   function
              automatically.

JAVASCRIPT

       JavaScript  support  in  mpv  is  near  identical  to its Lua support. Use this section as
       reference on differences and availability of APIs, but otherwise you should refer  to  the
       Lua documentation for API details and general scripting in mpv.

   Example
       JavaScript code which leaves fullscreen mode when the player is paused:

          function on_pause_change(name, value) {
              if (value == true)
                  mp.set_property("fullscreen", "no");
          }
          mp.observe_property("pause", "bool", on_pause_change);

   Similarities with Lua
       mpv  tries  to  load a script file as JavaScript if it has a .js extension, but otherwise,
       the documented Lua options, script directories, loading, etc  apply  to  JavaScript  files
       too.

       Script initialization and lifecycle is the same as with Lua, and most of the Lua functions
       at the modules mp, mp.utils and mp.msg are available to JavaScript with identical  APIs  -
       including      running      commands,      getting/setting     properties,     registering
       events/key-bindings/property-changes/hooks, etc.

   Differences from Lua
       No need to load modules. mp, mp.utils and mp.msg are preloaded, and you can use  e.g.  var
       cwd  =  mp.utils.getcwd();  without prior setup.  mp.options is currently not implemented,
       but mp.get_opt(...) is.

       Errors are slightly different. Where the Lua APIs return nil  for  error,  the  JavaScript
       ones  return  undefined.  Where  Lua  returns  something,  error  JavaScript  returns only
       something - and makes error available via mp.last_error(). Note  that  only  some  of  the
       functions have this additional error value - typically the same ones which have it in Lua.

       Standard APIs are preferred. For instance setTimeout and JSON.stringify are available, but
       mp.add_timeout and mp.utils.format_json are not.

       No standard library. This means that interaction with anything outside of mpv  is  limited
       to  the  available  APIs, typically via mp.utils. However, some file functions were added,
       and CommonJS require is available too - where the loaded modules have the same  privileges
       as normal scripts.

   Language features - ECMAScript 5
       The  scripting  backend  which  mpv  currently  uses  is  MuJS  - a compatible minimal ES5
       interpreter. As such, String.substring is implemented for instance, while the  common  but
       non-standard  String.substr is not. Please consult the MuJS pages on language features and
       platform support - http://mujs.com .

   Unsupported Lua APIs and their JS alternatives
       mp.add_timeout(seconds, fn)  JS: id = setTimeout(fn, ms)

       mp.add_periodic_timer(seconds, fn)  JS: id = setInterval(fn, ms)

       mp.register_idle(fn)  JS: id = setTimeout(fn)

       mp.unregister_idle(fn)  JS:  clearTimeout(id)

       utils.parse_json(str [, trail])  JS: JSON.parse(str)

       utils.format_json(v)  JS: JSON.stringify(v)

       utils.to_string(v)  see dump below.

       mp.suspend() JS: none (deprecated).

       mp.resume() JS: none (deprecated).

       mp.resume_all() JS: none (deprecated).

       mp.get_next_timeout() see event loop below.

       mp.dispatch_events([allow_wait]) see event loop below.

       mp.options module is not implemented currently for JS.

   Scripting APIs - identical to Lua
       (LE) - Last-Error, indicates that mp.last_error() can be used after the call to  test  for
       success  (empty  string)  or  failure (non empty reason string).  Otherwise, where the Lua
       APIs return nil on error, JS returns undefined.

       mp.command(string) (LE)

       mp.commandv(arg1, arg2, ...) (LE)

       mp.command_native(table [,def]) (LE)

       mp.get_property(name [,def]) (LE)

       mp.get_property_osd(name [,def]) (LE)

       mp.get_property_bool(name [,def]) (LE)

       mp.get_property_number(name [,def]) (LE)

       mp.get_property_native(name [,def]) (LE)

       mp.set_property(name, value) (LE)

       mp.set_property_bool(name, value) (LE)

       mp.set_property_number(name, value) (LE)

       mp.set_property_native(name, value) (LE)

       mp.get_time()

       mp.add_key_binding(key, name|fn [,fn [,flags]])

       mp.add_forced_key_binding(...)

       mp.remove_key_binding(name)

       mp.register_event(name, fn)

       mp.unregister_event(fn)

       mp.observe_property(name, type, fn)

       mp.unobserve_property(fn)

       mp.get_opt(key)

       mp.get_script_name()

       mp.osd_message(text [,duration])

       mp.get_wakeup_pipe()

       mp.enable_messages(level)

       mp.register_script_message(name, fn)

       mp.unregister_script_message(name)

       mp.msg.log(level, ...)

       mp.msg.fatal(...)

       mp.msg.error(...)

       mp.msg.warn(...)

       mp.msg.info(...)

       mp.msg.verbose(...)

       mp.msg.debug(...)

       mp.utils.getcwd() (LE)

       mp.utils.readdir(path [, filter]) (LE)

       mp.utils.split_path(path)

       mp.utils.join_path(p1, p2)

       mp.utils.subprocess(t)

       mp.utils.subprocess_detached(t)

       mp.add_hook(type, priority, fn)

   Additional utilities
       mp.last_error()
              If used after an API call which updates last error, returns an empty string if  the
              API call succeeded, or a non-empty error reason string otherwise.

       Error.stack (string)
              When  using  try  {  ... } catch(e) { ... }, then e.stack is the stack trace of the
              error - if it was created using the Error(...) constructor.

       print (global)
              A convenient alias to mp.msg.info.

       dump (global)
              Like print but also expands objects and arrays recursively.

       mp.utils.getenv(name)
              Returns the value of the host  environment  variable  name,  or  undefined  if  the
              variable is not defined.

       mp.utils.get_user_path(path)
              Expands  (mpv)  meta  paths like ~/x, ~~/y, ~~desktop/z etc.  read_file, write_file
              and require already use this internaly.

       mp.utils.read_file(fname [,max])
              Returns the content of file fname as string. If max is provided and  not  negative,
              limit the read to max bytes.

       mp.utils.write_file(fname, str)
              (Over)write  file  fname with text content str. fname must be prefixed with file://
              as    simple    protection    against    accidental    arguments    switch,    e.g.
              mp.utils.write_file("file://~/abc.txt", "hello world").

       Note: read_file and write_file throw on errors, allow text content only.

       mp.get_time_ms()
              Same as mp.get_time() but in ms instead of seconds.

       mp.get_script_file()
              Returns the file name of the current script.

       exit() (global)
              Make  the script exit at the end of the current event loop iteration.  Note: please
              reomve added key bindings before calling exit().

       mp.utils.compile_js(fname, content_str)
              Compiles the JS code content_str as file name fname (without loading anything  from
              the  filesystem),  and  returns  it  as  a  function.  Very  similar  to a Function
              constructor, but shows at stack traces as fname.

   Timers (global)
       The standard HTML/node.js timers are available:

       id = setTimeout(fn [,duration [,arg1 [,arg2...]]])

       id = setTimeout(code_string [,duration])

       clearTimeout(id)

       id = setInterval(fn [,duration [,arg1 [,arg2...]]])

       id = setInterval(code_string [,duration])

       clearInterval(id)

       setTimeout and setInterval return id, and later call fn  (or  execute  code_string)  after
       duration ms. Interval also repeat every duration.

       duration  has  a  minimum  and  default value of 0, code_string is a plain string which is
       evaluated as JS code, and [,arg1 [,arg2..]] are  used  as  arguments  (if  provided)  when
       calling back fn.

       The clear...(id) functions cancel timer id, and are irreversible.

       Note:  timers  always  call  back  asynchronously,  e.g. setTimeout(fn) will never call fn
       before returning. fn will be called either at the end of this event loop iteration or at a
       later  event  loop iteration. This is true also for intervals - which also never call back
       twice at the same event loop iteration.

       Additionally, timers are processed after the event queue is empty, so it's  valid  to  use
       setTimeout(fn) instead of Lua's mp.register_idle(fn).

   CommonJS modules and require(id)
       CommonJS  Modules  are a standard system where scripts can export common functions for use
       by other scripts. A module is a script which  adds  properties  (functions,  etc)  to  its
       invisible   exports   object,   which  another  script  can  access  by  loading  it  with
       require(module-id) - which returns that exports object.

       Modules and require are supported, standard compliant, and generally similar  to  node.js.
       However,  most  node.js modules won't run due to missing modules such as fs, process, etc,
       but some node.js modules with minimal dependencies do work. In general, this  is  for  mpv
       modules and not a node.js replacement.

       A  .js  file  extension  is  always  added to id, e.g. require("./foo") will load the file
       ./foo.js and return its exports object.

       An id is relative (to the script which  require'd  it)  if  it  starts  with  ./  or  ../.
       Otherwise, it's considered a "top-level id" (CommonJS term).

       Top  level  id  is  evaluated  as absolute filesystem path if possible (e.g. /x/y or ~/x).
       Otherwise, it's searched at scripts/modules.js/ in mpv config  dirs  -  in  normal  config
       search  order.  E.g.  require("x") is searched as file x.js at those dirs, and id foo/x is
       searched as file foo/x.js.

       No global variable, but a module's this at its top lexical scope is the  global  object  -
       also  in  strict  mode.  If you have a module which needs global as the global object, you
       could do this.global = this; before require.

       Functions and variables declared at a module don't pollute the global object.

   The event loop
       The event loop poll/dispatch mpv events as long as the queue is not empty, then  processes
       the timers, then waits for the next event, and repeats this forever.

       You  could put this code at your script to replace the built-in event loop, and also print
       every event which mpv sends to your script:

          function mp_event_loop() {
              var wait = 0;
              do {
                  var e = mp.wait_event(wait);
                  dump(e);  // there could be a lot of prints...
                  if (e.event != "none") {
                      mp.dispatch_event(e);
                      wait = 0;
                  } else {
                      wait = mp.process_timers() / 1000;
                  }
              } while (mp.keep_running);
          }

       mp_event_loop is a name which mpv tries to call after  the  script  loads.   The  internal
       implementation is similar to this (without dump though..).

       e  = mp.wait_event(wait) returns when the next mpv event arrives, or after wait seconds if
       positive and no mpv events arrived. wait value of 0 returns immediately (with  e.event  ==
       "none" if the queue is empty).

       mp.dispatch_event(e)  calls  back  the  handlers registered for e.event, if there are such
       (event handlers, property observers, script messages, etc).

       mp.process_timers() calls back the already-added, non-canceled due timers, and returns the
       duration in ms till the next due timer (possibly 0), or -1 if there are no pending timers.
       Must not be called recursively.

       Note: exit() is also registered for the shutdown event, and its implementation is a simple
       mp.keep_running = false.

JSON IPC

mpv can be controlled by external programs using the JSON-based IPC protocol. It can be
enabled by specifying the path to a unix socket or a named pipe using the option
--input-ipc-server. Clients can connect to this socket and send commands to the player or
receive events from it.

WARNING:
This is not intended to be a secure network protocol. It is explicitly insecure: there
is no authentication, no encryption, and the commands themselves are insecure too. For
example, the run command is exposed, which can run arbitrary system commands. The
use-case is controlling the player locally. This is not different from the MPlayer
slave protocol.

Socat example
You can use the socat tool to send commands (and receive replies) from the shell. Assuming
mpv was started with:

mpv file.mkv --input-ipc-server=/tmp/mpvsocket

Then you can control it using socat:

> echo '{ "command": ["get_property", "playback-time"] }' | socat - /tmp/mpvsocket
{"data":190.482000,"error":"success"}

In this case, socat copies data between stdin/stdout and the mpv socket connection.

See the --idle option how to make mpv start without exiting immediately or playing a file.

It's also possible to send input.conf style text-only commands:

> echo 'show-text ${playback-time}' | socat - /tmp/mpvsocket

But you won't get a reply over the socket. (This particular command shows the playback
time on the player's OSD.)

Command Prompt example
Unfortunately, it's not as easy to test the IPC protocol on Windows, since Windows ports
of socat (in Cygwin and MSYS2) don't understand named pipes. In the absence of a simple
tool to send and receive from bidirectional pipes, the echo command can be used to send
commands, but not receive replies from the command prompt.

Assuming mpv was started with:

mpv file.mkv --input-ipc-server=\\.\pipe\mpvsocket

You can send commands from a command prompt:

echo show-text ${playback-time} >\\.\pipe\mpvsocket

To be able to simultaneously read and write from the IPC pipe, like on Linux, it's
necessary to write an external program that uses overlapped file I/O (or some wrapper like
.NET's NamedPipeClientStream.)

Protocol
Clients can execute commands on the player by sending JSON messages of the following form:

{ "command": ["command_name", "param1", "param2", ...] }

where command_name is the name of the command to be executed, followed by a list of
parameters. Parameters must be formatted as native JSON values (integers, strings,
booleans, ...). Every message must be terminated with \n. Additionally, \n must not appear
anywhere inside the message. In practice this means that messages should be minified
before being sent to mpv.

mpv will then send back a reply indicating whether the command was run correctly, and an
additional field holding the command-specific return data (it can also be null).

{ "error": "success", "data": null }

mpv will also send events to clients with JSON messages of the following form:

{ "event": "event_name" }

where event_name is the name of the event. Additional event-specific fields can also be
present. See List of events for a list of all supported events.

Because events can occur at any time, it may be difficult at times to determine which
response goes with which command. Commands may optionally include a request_id which, if
provided in the command request, will be copied verbatim into the response. mpv does not
intrepret the request_id in any way; it is solely for the use of the requester.

For example, this request:

{ "command": ["get_property", "time-pos"], "request_id": 100 }

Would generate this response:

{ "error": "success", "data": 1.468135, "request_id": 100 }

All commands, replies, and events are separated from each other with a line break
character (\n).

If the first character (after skipping whitespace) is not {, the command will be
interpreted as non-JSON text command, as they are used in input.conf (or
mpv_command_string() in the client API). Additionally, lines starting with # and empty
lines are ignored.

Currently, embedded 0 bytes terminate the current line, but you should not rely on this.

Commands
In addition to the commands described in List of Input Commands, a few extra commands can
also be used as part of the protocol:

client_name
Return the name of the client as string. This is the string ipc-N with N being an
integer number.

get_time_us
Return the current mpv internal time in microseconds as a number. This is basically
the system time, with an arbitrary offset.

get_property
Return the value of the given property. The value will be sent in the data field of
the replay message.

Example:

{ "command": ["get_property", "volume"] }
{ "data": 50.0, "error": "success" }

get_property_string
Like get_property, but the resulting data will always be a string.

Example:

{ "command": ["get_property_string", "volume"] }
{ "data": "50.000000", "error": "success" }

set_property
Set the given property to the given value. See Properties for more information
about properties.

Example:

{ "command": ["set_property", "pause", true] }
{ "error": "success" }

set_property_string
Like set_property, but the argument value must be passed as string.

Example:

{ "command": ["set_property_string", "pause", "yes"] }
{ "error": "success" }

observe_property
Watch a property for changes. If the given property is changed, then an event of
type property-change will be generated

Example:

{ "command": ["observe_property", 1, "volume"] }
{ "error": "success" }
{ "event": "property-change", "id": 1, "data": 52.0, "name": "volume" }

WARNING:
If the connection is closed, the IPC client is destroyed internally, and the
observed properties are unregistered. This happens for example when sending
commands to a socket with separate socat invocations. This can make it seem
like property observation does not work. You must keep the IPC connection open
to make it work.

observe_property_string
Like observe_property, but the resulting data will always be a string.

Example:

{ "command": ["observe_property_string", 1, "volume"] }
{ "error": "success" }
{ "event": "property-change", "id": 1, "data": "52.000000", "name": "volume" }

unobserve_property
Undo observe_property or observe_property_string. This requires the numeric id
passed to the observed command as argument.

Example:

{ "command": ["unobserve_property", 1] }
{ "error": "success" }

request_log_messages
Enable output of mpv log messages. They will be received as events. The parameter
to this command is the log-level (see mpv_request_log_messages C API function).

Log message output is meant for humans only (mostly for debugging). Attempting to
retrieve information by parsing these messages will just lead to breakages with
future mpv releases. Instead, make a feature request, and ask for a proper event
that returns the information you need.

enable_event, disable_event
Enables or disables the named event. Mirrors the mpv_request_event C API function.
If the string all is used instead of an event name, all events are enabled or
disabled.

By default, most events are enabled, and there is not much use for this command.

get_version
Returns the client API version the C API of the remote mpv instance provides.

CHANGELOG

       There is no real changelog, but you can look at the following things:

       • The release changelog, which should contain most  user-visible  changes,  including  new
         features and bug fixes:

         https://github.com/mpv-player/mpv/releases

       • The git log, which is the "real" changelog

       • The  files  client-api-changes.rst and interface-changes.rst in the DOCS sub directoryon
         the git repository, which document API and user interface changes  (the  latter  usually
         documents breaking changes only, rather than additions).

       • The file mplayer-changes.rst in the DOCS sub directory on the git repository, which used
         to be in place of this section. It documents some changes that happened  since  mplayer2
         forked off MPlayer. (Not updated anymore.)

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).

       Since  libmpv  merely allows access to underlying mechanisms that can control mpv, further
       documentation is spread over a few places:

       • https://github.com/mpv-player/mpv/blob/master/libmpv/client.h

       • http://mpv.io/manual/master/#options

       • http://mpv.io/manual/master/#list-of-input-commands

       • http://mpv.io/manual/master/#properties

       • https://github.com/mpv-player/mpv-examples/tree/master/libmpv

C PLUGINS

       You can write C plugins for mpv. These use the libmpv API, although they do  not  use  the
       libmpv library itself.

       Currently,  they must be explicitly enabled at build time with --enable-cplugins. They are
       available on Linux/BSD platforms only.

   C plugins location
       C plugins are put into the mpv scripts directory in its config directory  (see  the  FILES
       section  for  details).  They must have a .so file extension.  They can also be explicitly
       loaded with the --script option.

   API
       A C plugin must export the following function:

          int mpv_open_cplugin(mpv_handle *handle)

       The plugin function will be called on loading time. This function does not return as  long
       as  your  plugin  is loaded (it runs in its own thread). The handle will be deallocated as
       soon as the plugin function returns.

       The return value is interpreted as error status. A value of 0 is interpreted  as  success,
       while  -1  signals  an error. In the latter case, the player prints an uninformative error
       message that loading failed.

       Return values other than 0 and -1 are reserved, and trigger undefined behavior.

       Within the plugin function, you can call libmpv API functions. The handle  is  created  by
       mpv_create_client() (or actually an internal equivalent), and belongs to you. You can call
       mpv_wait_event() to wait for things happening, and so on.

       Note that the player might block until your plugin calls mpv_wait_event()  for  the  first
       time. This gives you a chance to install initial hooks etc.  before playback begins.

       The details are quite similar to Lua scripts.

   Linkage to libmpv
       The  current implementation requires that your plugins are not linked against libmpv. What
       your plugins uses are not symbols from a libmpv binary, but  symbols  from  the  mpv  host
       binary.

   Examples
       See:

       • https://github.com/mpv-player/mpv-examples/tree/master/cplugins

ENVIRONMENT VARIABLES

There are a number of environment variables that can be used to control the behavior of
mpv.

HOME, XDG_CONFIG_HOME
Used to determine mpv config directory. If XDG_CONFIG_HOME is not set,
$HOME/.config/mpv is used.

$HOME/.mpv is always added to the list of config search paths with a lower
priority.

XDG_CONFIG_DIRS
If set, XDG-style system configuration directories are used. Otherwise, the UNIX
convention (PREFIX/etc/mpv/) is used.

MPV_HOME
Directory where mpv looks for user settings. Overrides HOME, and mpv will try to
load the config file as $MPV_HOME/mpv.conf.

MPV_VERBOSE (see also -v and --msg-level)
Set the initial verbosity level across all message modules (default: 0). This is
an integer, and the resulting verbosity corresponds to the number of --v options
passed to the command line.

MPV_LEAK_REPORT
If set to 1, enable internal talloc leak reporting.

LADSPA_PATH
Specifies the search path for LADSPA plugins. If it is unset, fully qualified path
names must be used.

DISPLAY
Standard X11 display name to use.

FFmpeg/Libav:
This library accesses various environment variables. However, they are not
centrally documented, and documenting them is not our job. Therefore, this list is
incomplete.

Notable environment variables:

http_proxy
URL to proxy for http:// and https:// URLs.

no_proxy
List of domain patterns for which no proxy should be used. List entries are
separated by ,. Patterns can include *.

libdvdcss:

DVDCSS_CACHE
Specify a directory in which to store title key values. This will speed up
descrambling of DVDs which are in the cache. The DVDCSS_CACHE directory is
created if it does not exist, and a subdirectory is created named after the
DVD's title or manufacturing date. If DVDCSS_CACHE is not set or is empty,
libdvdcss will use the default value which is ${HOME}/.dvdcss/ under Unix
and the roaming application data directory (%APPDATA%) under Windows. The
special value "off" disables caching.

DVDCSS_METHOD
Sets the authentication and decryption method that libdvdcss will use to
read scrambled discs. Can be one of title, key or disc.

key is the default method. libdvdcss will use a set of calculated player
keys to try to get the disc key. This can fail if the drive does not
recognize any of the player keys.

disc is a fallback method when key has failed. Instead of using player
keys, libdvdcss will crack the disc key using a brute force
algorithm. This process is CPU intensive and requires 64 MB of memory
to store temporary data.

title is the fallback when all other methods have failed. It does not rely
on a key exchange with the DVD drive, but rather uses a crypto attack
to guess the title key. On rare cases this may fail because there is
not enough encrypted data on the disc to perform a statistical
attack, but on the other hand it is the only way to decrypt a DVD
stored on a hard disc, or a DVD with the wrong region on an RPC2
drive.

DVDCSS_RAW_DEVICE
Specify the raw device to use. Exact usage will depend on your operating
system, the Linux utility to set up raw devices is raw(8) for instance.
Please note that on most operating systems, using a raw device requires
highly aligned buffers: Linux requires a 2048 bytes alignment (which is the
size of a DVD sector).

DVDCSS_VERBOSE
Sets the libdvdcss verbosity level.

0 Outputs no messages at all.

1 Outputs error messages to stderr.

2 Outputs error messages and debug messages to stderr.

DVDREAD_NOKEYS
Skip retrieving all keys on startup. Currently disabled.

HOME FIXME: Document this.

EXIT CODES

       Normally mpv returns 0 as exit code after  finishing  playback  successfully.   If  errors
       happen, the following exit codes can be returned:

          1      Error  initializing  mpv. This is also returned if unknown options are passed to
                 mpv.

          2      The file passed to mpv couldn't be played. This is  somewhat  fuzzy:  currently,
                 playback  of  a file is considered to be successful if initialization was mostly
                 successful, even if playback fails immediately after initialization.

          3      There were some files that could be played, and some files which couldn't (using
                 the definition of success from above).

          4      Quit  due  to  a signal, Ctrl+c in a VO window (by default), or from the default
                 quit key bindings in encoding mode.

       Note that quitting the player manually will always lead to exit  code  0,  overriding  the
       exit  code  that would be returned normally. Also, the quit input command can take an exit
       code: in this case, that exit code is returned.

FILES

For Windows-specifics, see FILES ON WINDOWS section.

/etc/mpv/mpv.conf
mpv system-wide settings (depends on --prefix passed to configure - mpv in default
configuration will use /usr/local/etc/mpv/ as config directory, while most Linux
distributions will set it to /etc/mpv/).

~/.config/mpv/mpv.conf
mpv user settings (see CONFIGURATION FILES section)

~/.config/mpv/input.conf
key bindings (see INPUT.CONF section)

~/.config/mpv/fonts.conf
Fontconfig fonts.conf that is customized for mpv. You should include system
fonts.conf in this file or mpv would not know about fonts that you already have in
the system.

Only available when libass is built with fontconfig.

~/.config/mpv/subfont.ttf
fallback subtitle font

~/.config/mpv/fonts/
Font files in this directory are used by mpv/libass for subtitles. Useful if you do
not want to install fonts to your system. Note that files in this directory are
loaded into memory before being used by mpv. If you have a lot of fonts, consider
using fonts.conf (see above) to include additional fonts, which is more
memory-efficient.

~/.config/mpv/scripts/
All files in this directory are loaded as if they were passed to the --script
option. They are loaded in alphabetical order, and sub-directories and files with
no .lua extension are ignored. The --load-scripts=no option disables loading these
files.

~/.config/mpv/watch_later/
Contains temporary config files needed for resuming playback of files with the
watch later feature. See for example the Q key binding, or the quit-watch-later
input command.

Each file is a small config file which is loaded if the corresponding media file is
loaded. It contains the playback position and some (not necessarily all) settings
that were changed during playback. The filenames are hashed from the full paths of
the media files. It's in general not possible to extract the media filename from
this hash. However, you can set the --write-filename-in-watch-later-config option,
and the player will add the media filename to the contents of the resume config
file.

~/.config/mpv/lua-settings/osc.conf
This is loaded by the OSC script. See the ON SCREEN CONTROLLER docs for details.

Other files in this directory are specific to the corresponding scripts as well,
and the mpv core doesn't touch them.

Note that the environment variables $XDG_CONFIG_HOME and $MPV_HOME can override the
standard directory ~/.config/mpv/.

Also, the old config location at ~/.mpv/ is still read, and if the XDG variant does not
exist, will still be preferred.

FILES ON WINDOWS

On win32 (if compiled with MinGW, but not Cygwin), the default config file locations are
different. They are generally located under %APPDATA%/mpv/. For example, the path to
mpv.conf is %APPDATA%/mpv/mpv.conf, which maps to a system and user-specific path, for
example
C:\users\USERNAME\AppData\Roaming\mpv\mpv.conf

You can find the exact path by running echo %APPDATA%\mpv\mpv.conf in cmd.exe.

Other config files (such as input.conf) are in the same directory. See the FILES section
above.

The environment variable $MPV_HOME completely overrides these, like on UNIX.

If a directory named portable_config next to the mpv.exe exists, all config will be loaded
from this directory only. Watch later config files are written to this directory as well.
(This exists on Windows only and is redundant with $MPV_HOME. However, since Windows is
very scripting unfriendly, a wrapper script just setting $MPV_HOME, like you could do it
on other systems, won't work. portable_config is provided for convenience to get around
this restriction.)

Config files located in the same directory as mpv.exe are loaded with lower priority. Some
config files are loaded only once, which means that e.g. of 2 input.conf files located in
two config directories, only the one from the directory with higher priority will be
loaded.

A third config directory with the lowest priority is the directory named mpv in the same
directory as mpv.exe. This used to be the directory with the highest priority, but is now
discouraged to use and might be removed in the future.

Note that mpv likes to mix / and \ path separators for simplicity. kernel32.dll accepts
this, but cmd.exe does not.

COPYRIGHT

       GPLv2+

                                                                                           MPV(1)