.\" Man page generated from reStructuredText.
.
.TH MPV 1 "" "" "multimedia"
.SH NAME
mpv \- a media player
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
\fBmpv\fP [options] [file|URL|\-]
\fBmpv\fP [options] \-\-playlist=PLAYLIST
\fBmpv\fP [options] files
.fi
.sp
.SH DESCRIPTION
.sp
\fBmpv\fP 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.
.sp
Usage examples to get you started quickly can be found at the end of this man
page.
.SH INTERACTIVE CONTROL
.sp
mpv has a fully configurable, command\-driven control layer which allows you
to control mpv using keyboard, mouse, joystick or remote control (with
LIRC). See the \fB\-\-input\-\fP options for ways to customize it.
.SS Keyboard Control
.INDENT 0.0
.TP
.B LEFT and RIGHT
Seek backward/forward 5 seconds. Shift+arrow does a 1 second exact seek
(see \fB\-\-hr\-seek\fP).
.TP
.B UP and DOWN
Seek forward/backward 1 minute. Shift+arrow does a 5 second exact seek (see
\fB\-\-hr\-seek\fP).
.TP
.B [ and ]
Decrease/increase current playback speed by 10%.
.TP
.B { and }
Halve/double current playback speed.
.TP
.B BACKSPACE
Reset playback speed to normal.
.TP
.B < and >
Go backward/forward in the playlist.
.TP
.B ENTER
Go forward in the playlist, even over the end.
.TP
.B p / SPACE
Pause (pressing again unpauses).
.TP
.B \&.
Step forward. Pressing once will pause, every consecutive press will
play one frame and then go into pause mode again.
.UNINDENT
.INDENT 0.0
.TP
.B ,
Step backward. Pressing once will pause, every consecutive press will
play one frame in reverse and then go into pause mode again.
.TP
.B q
Stop playing and quit.
.TP
.B Q
Like \fBq\fP, but store the current playback position. Playing the same file
later will resume at the old playback position if possible.
.TP
.B / and *
Decrease/increase volume.
.TP
.B 9 and 0
Decrease/increase volume.
.TP
.B m
Mute sound.
.TP
.B _
Cycle through the available video tracks.
.TP
.B #
Cycle through the available audio tracks.
.TP
.B f
Toggle fullscreen (see also \fB\-\-fs\fP).
.TP
.B ESC
Exit fullscreen mode.
.TP
.B T
Toggle stay\-on\-top (see also \fB\-\-ontop\fP).
.TP
.B w and e
Decrease/increase pan\-and\-scan range.
.TP
.B o (also P)
Show progression bar, elapsed time and total duration on the OSD.
.TP
.B O
Toggle OSD states: none / seek / seek + timer / seek + timer + total time.
.TP
.B d
Toggle frame dropping states: none / skip display / skip decoding (see
\fB\-\-framedrop\fP).
.TP
.B v
Toggle subtitle visibility.
.TP
.B j and J
Cycle through the available subtitles.
.TP
.B x and z
Adjust subtitle delay by +/\- 0.1 seconds.
.TP
.B Ctrl + and Ctrl \-
Adjust audio delay by +/\- 0.1 seconds.
.TP
.B V
Toggle subtitle VSFilter aspect compatibility mode. See
\fB\-\-ass\-vsfilter\-aspect\-compat\fP for more info.
.TP
.B r and t
Move subtitles up/down.
.TP
.B s
Take a screenshot.
.TP
.B S
Take a screenshot, without subtitles. (Whether this works depends on VO
driver support.)
.TP
.B I
Show filename on the OSD.
.TP
.B 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
\fB\-\-chapter\-seek\-threshold\fP\&.
.TP
.B Shift+PGUP and Shift+PGDWN
Seek backward or forward by 10 minutes. (This used to be mapped to
PGUP/PGDWN without Shift.)
.TP
.B D
Activate/deactivate deinterlacer.
.UNINDENT
.sp
(The following keys are valid only when using a video output that supports the
corresponding adjustment, or the software equalizer (\fB\-\-vf=eq\fP).)
.INDENT 0.0
.TP
.B 1 and 2
Adjust contrast.
.TP
.B 3 and 4
Adjust brightness.
.TP
.B 5 and 6
Adjust gamma.
.TP
.B 7 and 8
Adjust saturation.
.UNINDENT
.sp
(The following keys are valid only on OS X.)
.INDENT 0.0
.TP
.B command + 0
Resize video window to half its original size.
(On other platforms, you can bind keys to change the \fBwindow\-scale\fP
property.)
.TP
.B command + 1
Resize video window to its original size.
.TP
.B command + 2
Resize video window to double its original size.
.TP
.B command + f
Toggle fullscreen (see also \fB\-\-fs\fP).
.TP
.B command + [ and command + ]
Set video window alpha.
.UNINDENT
.sp
(The following keys are valid if you have a keyboard with multimedia keys.)
.INDENT 0.0
.TP
.B PAUSE
Pause.
.TP
.B STOP
Stop playing and quit.
.TP
.B PREVIOUS and NEXT
Seek backward/forward 1 minute.
.UNINDENT
.sp
(The following keys are only valid if you compiled with TV or DVB input
support.)
.INDENT 0.0
.TP
.B h and k
Select previous/next channel.
.UNINDENT
.SS Mouse Control
.INDENT 0.0
.TP
.B button 3 and button 4
Seek backward/forward 1 minute.
.TP
.B button 5 and button 6
Decrease/increase volume.
.UNINDENT
.SH USAGE
.sp
Every \fIflag\fP option has a \fIno\-flag\fP counterpart, e.g. the opposite of the
\fB\-\-fs\fP option is \fB\-\-no\-fs\fP\&. \fB\-\-fs=yes\fP is same as \fB\-\-fs\fP, \fB\-\-fs=no\fP
is the same as \fB\-\-no\-fs\fP\&.
.sp
If an option is marked as \fI(XXX only)\fP, it will only work in combination with
the \fIXXX\fP option or if \fIXXX\fP is compiled in.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The suboption parser (used for example for \fB\-\-ao=pcm\fP suboptions)
supports a special kind of string\-escaping intended for use with external
GUIs.
.UNINDENT
.UNINDENT
.sp
It has the following format:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
%n%string_of_length_n
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.IP "Examples"
.sp
\fBmpv \-\-ao=pcm:file=%10%C:test.wav test.avi\fP
.sp
Or in a script:
.sp
\fBmpv \-\-ao=pcm:file=%\(gaexpr length "$NAME"\(ga%"$NAME" test.avi\fP
.UNINDENT
.UNINDENT
.SS Paths
.sp
Some care must be taken when passing arbitrary paths and filenames to mpv. For
example, paths starting with \fB\-\fP will be interpreted as options. Likewise,
if a path contains the sequence \fB://\fP, the string before that might be
interpreted as protocol prefix, even though \fB://\fP 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 \fB/\fP, and relative paths with \fB\&./\fP\&.
.sp
The name \fB\-\fP itself is interpreted as stdin, and will cause mpv to disable
console controls. (Which makes it suitable for playing data piped to stdin.)
.sp
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 \fB%n%string_of_length_n\fP syntax (see above).
.sp
Some mpv options interpret paths starting with \fB~\fP\&. Currently, the prefix
\fB~~/\fP expands to the mpv configuration directory (usually \fB~/.config/mpv/\fP).
\fB~/\fP expands to the user\(aqs home directory. (The trailing \fB/\fP is always
required.)
.SS Per\-File Options
.sp
When playing multiple files, any option given on the command line usually
affects all files. Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mpv \-\-a file1.mkv \-\-b file2.mkv \-\-c
.ft P
.fi
.UNINDENT
.UNINDENT
.TS
center;
|l|l|.
_
T{
File
T}	T{
Active options
T}
_
T{
file1.mkv
T}	T{
\fB\-\-a \-\-b \-\-c\fP
T}
_
T{
file2.mkv
T}	T{
\fB\-\-a \-\-b \-\-c\fP
T}
_
.TE
.sp
(This is different from MPlayer and mplayer2.)
.sp
Also, if any option is changed at runtime (via input commands), they are not
reset when a new file is played.
.sp
Sometimes, it is useful to change options per\-file. This can be achieved by
adding the special per\-file markers \fB\-\-{\fP and \fB\-\-}\fP\&. (Note that you must
escape these on some shells.) Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mpv \-\-a file1.mkv \-\-b \-\-\e{ \-\-c file2.mkv \-\-d file3.mkv \-\-e \-\-\e} file4.mkv \-\-f
.ft P
.fi
.UNINDENT
.UNINDENT
.TS
center;
|l|l|.
_
T{
File
T}	T{
Active options
T}
_
T{
file1.mkv
T}	T{
\fB\-\-a \-\-b \-\-f\fP
T}
_
T{
file2.mkv
T}	T{
\fB\-\-a \-\-b \-\-f \-\-c \-\-d \-\-e\fP
T}
_
T{
file3.mkv
T}	T{
\fB\-\-a \-\-b \-\-f \-\-c \-\-d \-\-e\fP
T}
_
T{
file4.mkv
T}	T{
\fB\-\-a \-\-b \-\-f\fP
T}
_
.TE
.sp
Additionally, any file\-local option changed at runtime is reset when the current
file stops playing. If option \fB\-\-c\fP is changed during playback of
\fBfile2.mkv\fP, it is reset when advancing to \fBfile3.mkv\fP\&. This only affects
file\-local options. The option \fB\-\-a\fP is never reset here.
.SH CONFIGURATION FILES
.SS Location and Syntax
.sp
You can put all of the options in configuration files which will be read every
time mpv is run. The system\-wide configuration file \(aqmpv.conf\(aq is in your
configuration directory (\fB/etc/mpv\fP), the user\-specific one is
\fB~/.config/mpv/mpv.conf\fP\&.
User\-specific options override system\-wide options and options given on the
command line override either. The syntax of the configuration files is
\fBoption=<value>\fP; everything after a \fI#\fP is considered a comment. Options
that work without values can be enabled by setting them to \fIyes\fP and disabled by
setting them to \fIno\fP\&. Even suboptions can be specified in this way.
.INDENT 0.0
.INDENT 3.5
.IP "Example configuration file"
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Use opengl video output by default.
vo=opengl
# Use quotes for text that can contain spaces:
status\-msg="Time: ${time\-pos}"
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Putting Command Line Options into the Configuration File
.sp
Almost all command line options can be put into the configuration file. Here
is a small guide:
.TS
center;
|l|l|.
_
T{
Option
T}	T{
Configuration file entry
T}
_
T{
\fB\-\-flag\fP
T}	T{
\fBflag\fP
T}
_
T{
\fB\-opt val\fP
T}	T{
\fBopt=val\fP
T}
_
T{
\fB\-\-opt=val\fP
T}	T{
\fBopt=val\fP
T}
_
T{
\fB\-opt "has spaces"\fP
T}	T{
\fBopt="has spaces"\fP
T}
_
.TE
.SS File\-specific Configuration Files
.sp
You can also write file\-specific configuration files. If you wish to have a
configuration file for a file called \(aqvideo.avi\(aq, create a file named
\(aqvideo.avi.conf\(aq with the file\-specific options in it and put it in
\fB~/.config/mpv/\fP\&. You can also put the configuration file in the same directory
as the file to be played, as long as you give the \fB\-\-use\-filedir\-conf\fP
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 \fB~/.config/mpv\fP\&. In addition, the
\fB\-\-use\-filedir\-conf\fP 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.
.SS Profiles
.sp
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. \fB[my\-profile]\fP\&. All following options will be part of the profile. A
description (shown by \fB\-\-profile=help\fP) can be defined with the
\fBprofile\-desc\fP option. To end the profile, start another one or use the
profile name \fBdefault\fP to continue with normal options.
.INDENT 0.0
.INDENT 3.5
.IP "Example mpv profile"
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
[vo.vdpau]
# Use hardware decoding (might break playback of some h264 files)
hwdec=vdpau

[protocol.dvd]
profile\-desc="profile for dvd:// streams"
vf=pp=hb/vb/dr/al/fd
alang=en

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

[ao.alsa]
device=spdif
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SH TAKING SCREENSHOTS
.sp
Screenshots of the currently played file can be taken using the \(aqscreenshot\(aq
input mode command, which is by default bound to the \fBs\fP key. Files named
\fBshotNNNN.jpg\fP will be saved in the working directory, using the first
available number \- no files will be overwritten.
.sp
A screenshot will usually contain the unscaled video contents at the end of the
video filter chain and subtitles. By default, \fBS\fP takes screenshots without
subtitles, while \fBs\fP includes subtitles.
.sp
The \fBscreenshot\fP video filter is not required when using a recommended GUI
video output driver. It should normally not be added to the config file, as
taking screenshots is handled by the VOs, and adding the screenshot filter will
break hardware decoding. (The filter may still be useful for taking screenshots
at a certain point within the video chain when using multiple video filters.)
.SH TERMINAL STATUS LINE
.sp
During playback, mpv shows the playback status on the terminal. It looks like
something like this:
.INDENT 0.0
.INDENT 3.5
\fBAV: 00:03:12 / 00:24:25 (13%) A\-V: \-0.000\fP
.UNINDENT
.UNINDENT
.sp
The status line can be overridden with the \fB\-\-term\-status\-msg\fP option.
.sp
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.
.INDENT 0.0
.IP \(bu 2
\fBAV:\fP or \fBV:\fP (video only) or \fBA:\fP (audio only)
.IP \(bu 2
The current time position in \fBHH:MM:SS\fP format (\fBplayback\-time\fP property)
.IP \(bu 2
The total file duration (or \fB00:00:00\fP if unknown) (\fBlength\fP property)
.IP \(bu 2
Playback speed, e.g. \(ga\(ga x2.0\(ga\(ga. 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). (\fBspeed\fP property.)
.IP \(bu 2
Playback percentage, e.g. \fB(13%)\fP\&. 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.
(\fBpercent\-pos\fP property.)
.IP \(bu 2
The audio/video sync as \fBA\-V:  0.000\fP\&. This is the difference between
audio and video time. Normally it should be 0 or close to 0. If it\(aqs growing,
it might indicate a playback problem. (\fBavsync\fP property.)
.IP \(bu 2
Total A/V sync change, e.g. \fBct: \-0.417\fP\&. Normally invisible. Can show up
if there is audio "missing", or not enough frames can be dropped. Usually
this will indicate a problem. (\fBtotal\-avsync\-change\fP property.)
.IP \(bu 2
Encoding state in \fB{...}\fP, only shown in encoding mode.
.IP \(bu 2
Decoder\-dropped video frames, e.g. \fBSD: 2\fP\&. Shows up only if the count is
not 0. Normally should never show up, unless \fB\-\-framedrop\fP is set to enable
this mode, and your CPU is too slow. (\fBdrop\-frame\-count\fP property.)
.IP \(bu 2
VO\-dropped video frames, e.g. \fBD: 4\fP\&. 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. Also can be incremented on "hiccups" and when
the video frame couldn\(aqt be displayed on time. (\fBvo\-drop\-frame\-count\fP
property.)
.IP \(bu 2
Cache state, e.g. \fBCache:  2s+134KB\fP\&. 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 \fIadditional\fP data buffered in the stream cache in
kilobytes. (\fBdemuxer\-cache\-duration\fP and \fBcached\-used\fP properties.)
.UNINDENT
.SH PROTOCOLS
.INDENT 0.0
.TP
.B \fBhttp://...\fP, \fBhttps://\fP, ...
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.
.TP
.B \fB\-\fP
Play data from stdin.
.TP
.B \fBsmb://PATH\fP
Play a path from  Samba share.
.TP
.B \fBbd://[title][/device]\fP \fB\-\-bluray\-device=PATH\fP
Play a Blu\-Ray disc. Currently, this does not accept ISO files. Instead,
you must mount the ISO file as filesystem, and point \fB\-\-bluray\-device\fP
to the mounted directly.
.TP
.B \fBbdnav://[title][/device]\fP
Play a Blu\-Ray disc, with navigation features enabled. This feature is
permanently experimental.
.TP
.B \fBdvd://[title|[starttitle]\-endtitle][/device]\fP \fB\-\-dvd\-device=PATH\fP
Play a DVD. If you want dvdnav menus, use \fBdvd://menu\fP\&. If no title
is given, the longest title is auto\-selected.
.sp
\fBdvdnav://\fP is an old alias for \fBdvd://\fP and does exactly the same
thing.
.TP
.B \fBdvdread://...:\fP
Play a DVD using the old libdvdread code. This is what MPlayer and older
mpv versions use for \fBdvd://\fP\&. Use is discouraged. It\(aqs provided only
for compatibility and for transition.
.TP
.B \fBtv://[channel][/input_id]\fP \fB\-\-tv\-...\fP
Analogue TV via V4L. Also useful for webcams. (Linux only.)
.TP
.B \fBpvr://\fP \fB\-\-pvr\-...\fP
PVR. (Linux only.)
.TP
.B \fBdvb://[cardnumber@]channel\fP \fB\-\-dvbin\-...\fP
Digital TV via DVB. (Linux only.)
.TP
.B \fBmf://[filemask|@listfile]\fP \fB\-\-mf\-...\fP
Play a series of images as video.
.TP
.B \fBcdda://track[\-endtrack][:speed][/device]\fP \fB\-\-cdrom\-device=PATH\fP \fB\-\-cdda\-...\fP
Play CD.
.TP
.B \fBlavf://...\fP
Access any FFmpeg/Libav libavformat protocol. Basically, this passed the
string after the \fB//\fP directly to libavformat.
.TP
.B \fBav://type:options\fP
This is intended for using libavdevice inputs. \fBtype\fP is the libavdevice
demuxer name, and \fBoptions\fP is the (pseudo\-)filename passed to the
demuxer.
.sp
For example, \fBmpv av://lavfi:mandelbrot\fP makes use of the libavfilter
wrapper included in libavdevice, and will use the \fBmandelbrot\fP source
filter to generate input data.
.sp
\fBavdevice://\fP is an alias.
.TP
.B \fBfile://PATH\fP
A local path as URL. Might be useful in some special use\-cases. Note that
\fBPATH\fP itself should start with a third \fB/\fP to make the path an
absolute path.
.TP
.B \fBedl://[edl specification as in edl\-mpv.rst]\fP
Stitch together parts of multiple files and play them.
.TP
.B \fBnull://\fP
Simulate an empty file.
.TP
.B \fBmemory://data\fP
Use the \fBdata\fP part as source data.
.UNINDENT
.SH OPTIONS
.SS Track Selection
.INDENT 0.0
.TP
.B \fB\-\-alang=<languagecode[,languagecode,...]>\fP
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 \fB\-\-aid\fP\&.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.TP
.B \fBmpv dvd://1 \-\-alang=hu,en\fP
Chooses the Hungarian language track on a DVD and falls back on
English if Hungarian is not available.
.TP
.B \fBmpv \-\-alang=jpn example.mkv\fP
Plays a Matroska file in Japanese.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-slang=<languagecode[,languagecode,...]>\fP
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 \fB\-\-sid\fP\&.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.IP \(bu 2
\fBmpv dvd://1 \-\-slang=hu,en\fP chooses the Hungarian subtitle track on
a DVD and falls back on English if Hungarian is not available.
.IP \(bu 2
\fBmpv \-\-slang=jpn example.mkv\fP plays a Matroska file with Japanese
subtitles.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-aid=<ID|auto|no>\fP
Select audio track. \fBauto\fP selects the default, \fBno\fP disables audio.
See also \fB\-\-alang\fP\&. mpv normally prints available audio tracks on the
terminal when starting playback of a file.
.TP
.B \fB\-\-sid=<ID|auto|no>\fP
Display the subtitle stream specified by \fB<ID>\fP\&. \fBauto\fP selects
the default, \fBno\fP disables subtitles.
.sp
See also \fB\-\-slang\fP, \fB\-\-no\-sub\fP\&.
.TP
.B \fB\-\-vid=<ID|auto|no>\fP
Select video channel. \fBauto\fP selects the default, \fBno\fP disables video.
.TP
.B \fB\-\-edition=<ID|auto>\fP
(Matroska files only)
Specify the edition (set of chapters) to use, where 0 is the first. If set
to \fBauto\fP (the default), mpv will choose the first edition declared as a
default, or if there is no default, the first edition defined.
.UNINDENT
.SS Playback Control
.INDENT 0.0
.TP
.B \fB\-\-start=<relative time>\fP
Seek to given time position.
.sp
The general format for absolute times is \fB[[hh:]mm:]ss[.ms]\fP\&. If the time
is given with a prefix of \fB+\fP or \fB\-\fP, the seek is relative from the start
or end of the file.
.sp
\fBpp%\fP seeks to percent position pp (0\-100).
.sp
\fB#c\fP seeks to chapter number c. (Chapters start from 1.)
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.TP
.B \fB\-\-start=+56\fP, \fB\-\-start=+00:56\fP
Seeks to the start time + 56 seconds.
.TP
.B \fB\-\-start=\-56\fP, \fB\-\-start=\-00:56\fP
Seeks to the end time \- 56 seconds.
.TP
.B \fB\-\-start=01:10:00\fP
Seeks to 1 hour 10 min.
.TP
.B \fB\-\-start=50%\fP
Seeks to the middle of the file.
.TP
.B \fB\-\-start=30 \-\-end=40\fP
Seeks to 30 seconds, plays 10 seconds, and exits.
.TP
.B \fB\-\-start=\-3:20 \-\-length=10\fP
Seeks to 3 minutes and 20 seconds before the end of the file, plays
10 seconds, and exits.
.TP
.B \fB\-\-start=\(aq#2\(aq \-\-end=\(aq#4\(aq\fP
Plays chapters 2 and 3, and exits.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-end=<time>\fP
Stop at given absolute time. Use \fB\-\-length\fP if the time should be relative
to \fB\-\-start\fP\&. See \fB\-\-start\fP for valid option values and examples.
.TP
.B \fB\-\-length=<relative time>\fP
Stop after a given time relative to the start time.
See \fB\-\-start\fP for valid option values and examples.
.TP
.B \fB\-\-speed=<0.01\-100>\fP
Slow down or speed up playback by the factor given as parameter.
.TP
.B \fB\-\-loop=<N|inf|no>\fP
Loops playback \fBN\fP times. A value of \fB1\fP plays it one time (default),
\fB2\fP two times, etc. \fBinf\fP means forever. \fBno\fP is the same as \fB1\fP and
disables looping. If several files are specified on command line, the
entire playlist is looped.
.TP
.B \fB\-\-pause\fP
Start the player in paused state.
.TP
.B \fB\-\-shuffle\fP
Play files in random order.
.TP
.B \fB\-\-chapter=<start[\-end]>\fP
Specify which chapter to start playing at. Optionally specify which
chapter to end playing at. Also see \fB\-\-start\fP\&.
.TP
.B \fB\-\-playlist=<filename>\fP
Play files according to a playlist file (Supports some common formats.If
no format is detected, t will be treated as list of files, separated by
newline characters. Note that XML playlist formats are not supported.)
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The way mpv uses playlist files is not safe against maliciously
constructed files. Such files may trigger harmful actions.
This has been the case for all mpv and MPlayer versions, but
unfortunately this fact was not well documented earlier, and some people
have even misguidedly recommended use of \fB\-\-playlist\fP with untrusted
sources. Do NOT use \fB\-\-playlist\fP with random internet sources or files
you do not trust!
.sp
The main problem is that playlists can point to arbitrary network
addresses (including local addresses inside of your LAN), and thus
can\(aqt be considered secure. Playlists also can contain entries using
other protocols, such as local files, or (most severely), special
protocols like \fBavdevice://\fP, which are inherently unsafe.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-chapter\-merge\-threshold=<number>\fP
Threshold for merging almost consecutive ordered chapter parts in
milliseconds (default: 100). Some Matroska files with ordered chapters
have inaccurate chapter end timestamps, causing a small gap between the
end of one chapter and the start of the next one when they should match.
If the end of one playback part is less than the given threshold away from
the start of the next one then keep playing video normally over the
chapter change instead of doing a seek.
.TP
.B \fB\-\-chapter\-seek\-threshold=<seconds>\fP
Distance in seconds from the beginning of a chapter within which a backward
chapter seek will go to the previous chapter (default: 5.0). Past this
threshold, a backward chapter seek will go to the beginning of the current
chapter instead. A negative value means always go back to the previous
chapter.
.TP
.B \fB\-\-hr\-seek=<no|absolute|yes>\fP
Select when to use precise seeks that are not limited to keyframes. Such
seeks require decoding video from the previous keyframe up to the target
position and so can take some time depending on decoding performance. For
some video formats, precise seeks are disabled. This option selects the
default choice to use for seeks; it is possible to explicitly override that
default in the definition of key bindings and in slave mode commands.
.INDENT 7.0
.TP
.B no
Never use precise seeks.
.TP
.B absolute
Use precise seeks if the seek is to an absolute position in the
file, such as a chapter seek, but not for relative seeks like
the default behavior of arrow keys (default).
.TP
.B yes
Use precise seeks whenever possible.
.UNINDENT
.TP
.B \fB\-\-hr\-seek\-demuxer\-offset=<seconds>\fP
This option exists to work around failures to do precise seeks (as in
\fB\-\-hr\-seek\fP) caused by bugs or limitations in the demuxers for some file
formats. Some demuxers fail to seek to a keyframe before the given target
position, going to a later position instead. The value of this option is
subtracted from the time stamp given to the demuxer. Thus, if you set this
option to 1.5 and try to do a precise seek to 60 seconds, the demuxer is
told to seek to time 58.5, which hopefully reduces the chance that it
erroneously goes to some time later than 60 seconds. The downside of
setting this option is that precise seeks become slower, as video between
the earlier demuxer position and the real target may be unnecessarily
decoded.
.TP
.B \fB\-\-hr\-seek\-framedrop=<yes|no>\fP
Allow the video decoder to drop frames during seek, if these frames are
before the seek target. If this is enabled, precise seeking can be faster,
but if you\(aqre using video filters which modify timestamps or add new
frames, it can lead to precise seeking skipping the target frame. This
e.g. can break frame backstepping when deinterlacing is enabled.
.sp
Default: \fByes\fP
.TP
.B \fB\-\-index=<mode>\fP
Controls how to seek in files. Note that if the index is missing from a
file, it will be built on the fly by default, so you don\(aqt need to change
this. But it might help with some broken files.
.INDENT 7.0
.TP
.B default
use an index if the file has one, or build it if missing
.TP
.B recreate
don\(aqt read or use the file\(aqs index
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option only works if the underlying media supports seeking
(i.e. not with stdin, pipe, etc).
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-load\-unsafe\-playlists\fP
Load URLs from playlists which are considered unsafe (default: no). This
includes special protocols and anything that doesn\(aqt refer to normal files.
Local files and HTTP links on the other hand are always considered safe.
.sp
Note that \fB\-\-playlist\fP always loads all entries, so you use that instead
if you really have the need for this functionality.
.TP
.B \fB\-\-loop\-file=<N|inf|no>\fP
Loop a single file N times. \fBinf\fP means forever, \fBno\fP means normal
playback. For compatibility, \fB\-\-loop\-file\fP and \fB\-\-loop\-file=yes\fP are
also accepted, and are the same as \fB\-\-loop\-file=inf\fP\&.
.sp
The difference to \fB\-\-loop\fP is that this doesn\(aqt loop the playlist, just
the file itself. If the playlist contains only a single file, the difference
between the two option is that this option performs a seek on loop, instead
of reloading the file.
.TP
.B \fB\-\-ordered\-chapters\fP, \fB\-\-no\-ordered\-chapters\fP
Enabled by default.
Disable support for Matroska ordered chapters. mpv will not load or
search for video segments from other files, and will also ignore any
chapter order specified for the main file.
.TP
.B \fB\-\-ordered\-chapters\-files=<playlist\-file>\fP
Loads the given file as playlist, and tries to use the files contained in
it as reference files when opening a Matroska file that uses ordered
chapters. This overrides the normal mechanism for loading referenced
files by scanning the same directory the main file is located in.
.sp
Useful for loading ordered chapter files that are not located on the local
filesystem, or if the referenced files are in different directories.
.sp
Note: a playlist can be as simple as a text file containing filenames
separated by newlines.
.TP
.B \fB\-\-sstep=<sec>\fP
Skip <sec> seconds after every frame.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Without \fB\-\-hr\-seek\fP, skipping will snap to keyframes.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Program Behavior
.INDENT 0.0
.TP
.B \fB\-\-help\fP
Show short summary of options.
.TP
.B \fB\-v\fP
Increment verbosity level, one level for each \fB\-v\fP found on the command
line.
.TP
.B \fB\-\-version, \-V\fP
Print version string and exit.
.TP
.B \fB\-\-no\-config\fP
Do not load default configuration files. This prevents loading of both the
user\-level and system\-wide \fBmpv.conf\fP and \fBinput.conf\fP files. Other
configuration files are blocked as well, such as resume playback files.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Files explicitly requested by command line options, like
\fB\-\-include\fP or \fB\-\-use\-filedir\-conf\fP, will still be loaded.
.UNINDENT
.UNINDENT
.sp
Also see \fB\-\-config\-dir\fP\&.
.TP
.B \fB\-\-list\-options\fP
Prints all available options.
.TP
.B \fB\-\-list\-properties\fP
Print a list of the available properties.
.TP
.B \fB\-\-list\-protocols\fP
Print a list of the supported protocols.
.TP
.B \fB\-\-config\-dir=<path>\fP
Force a different configuration directory. If this is set, the given
directory is used to load configuration files, and all other configuration
directories are ignored. This means the global mpv configuration directory
as well as per\-user directories are ignored, and overrides through
environment variables (\fBMPV_HOME\fP) are also ignored.
.sp
Note that the \fB\-\-no\-config\fP option takes precedence over this option.
.TP
.B \fB\-\-save\-position\-on\-quit\fP
Always save the current playback position on quit. When this file is
played again later, the player will seek to the old playback position on
start. This does not happen if playback of a file is stopped in any other
way than quitting. For example, going to the next file in the playlist
will not save the position, and start playback at beginning the next time
the file is played.
.sp
This behavior is disabled by default, but is always available when quitting
the player with Shift+Q.
.TP
.B \fB\-\-dump\-stats=<filename>\fP
Write certain statistics to the given file. The file is truncated on
opening. The file will contain raw samples, each with a timestamp. To
make this file into a readable, the script \fBTOOLS/stats\-conv.py\fP can be
used (which currently displays it as a graph).
.sp
This option is useful for debugging only.
.TP
.B \fB\-\-idle\fP
Makes mpv wait idly instead of quitting when there is no file to play.
Mostly useful in slave mode, where mpv can be controlled through input
commands (see also \fB\-\-slave\-broken\fP).
.TP
.B \fB\-\-include=<configuration\-file>\fP
Specify configuration file to be parsed after the default ones.
.TP
.B \fB\-\-load\-scripts=<yes|no>\fP
If set to \fBno\fP, don\(aqt auto\-load scripts from the \fBlua\fP configuration
subdirectory (usually \fB~/.config/mpv/lua/\fP).
(Default: \fByes\fP)
.TP
.B \fB\-\-lua=<filename>\fP
Load a Lua script. You can load multiple scripts by separating them with
commas (\fB,\fP).
.TP
.B \fB\-\-lua\-opts=key1=value1,key2=value2,...\fP
Set options for scripts. A Lua script can query an option by key. If an
option is used and what semantics the option value has depends entirely on
the loaded Lua scripts. Values not claimed by any scripts are ignored.
.TP
.B \fB\-\-merge\-files\fP
Pretend that all files passed to mpv are concatenated into a single, big
file. This uses timeline/EDL support internally. Note that this won\(aqt work
for ordered chapter files or quvi\-resolved URLs (such as YouTube links).
.sp
This option is interpreted at program start, and doesn\(aqt affect for
example files or playlists loaded with the \fBloadfile\fP or \fBloadlist\fP
commands.
.TP
.B \fB\-\-no\-resume\-playback\fP
Do not restore playback position from the \fBwatch_later\fP configuration
subdirectory (usually \fB~/.config/mpv/watch_later/\fP).
See \fBquit_watch_later\fP input command.
.TP
.B \fB\-\-profile=<profile1,profile2,...>\fP
Use the given profile(s), \fB\-\-profile=help\fP displays a list of the
defined profiles.
.TP
.B \fB\-\-reset\-on\-next\-file=<all|option1,option2,...>\fP
Normally, mpv will try to keep all settings when playing the next file on
the playlist, even if they were changed by the user during playback. (This
behavior is the opposite of MPlayer\(aqs, which tries to reset all settings
when starting next file.)
.sp
Default: Do not reset anything.
.sp
This can be changed with this option. It accepts a list of options, and
mpv will reset the value of these options on playback start to the initial
value. The initial value is either the default value, or as set by the
config file or command line.
.sp
In some cases, this might not work as expected. For example, \fB\-\-volume\fP
will only be reset if it is explicitly set in the config file or the
command line.
.sp
The special name \fBall\fP resets as many options as possible.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.IP \(bu 2
\fB\-\-reset\-on\-next\-file=pause\fP
Reset pause mode when switching to the next file.
.IP \(bu 2
\fB\-\-reset\-on\-next\-file=fullscreen,speed\fP
Reset fullscreen and playback speed settings if they were changed
during playback.
.IP \(bu 2
\fB\-\-reset\-on\-next\-file=all\fP
Try to reset all settings that were changed during playback.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-write\-filename\-in\-watch\-later\-config\fP
Prepend the watch later config files with the name of the file they refer
to. This is simply written as comment on the top of the file.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
This option may expose privacy\-sensitive information and is thus
disabled by default.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-show\-profile=<profile>\fP
Show the description and content of a profile.
.TP
.B \fB\-\-use\-filedir\-conf\fP
Look for a file\-specific configuration file in the same directory as the
file that is being played. See \fI\%File\-specific Configuration Files\fP\&.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
May be dangerous if playing from untrusted media.
.UNINDENT
.UNINDENT
.UNINDENT
.SS Video
.INDENT 0.0
.TP
.B \fB\-\-vo=<driver1[:suboption1[=value]:...],driver2,...[,]>\fP
Specify a priority list of video output drivers to be used. For
interactive use, one would normally specify a single one to use, but in
configuration files, specifying a list of fallbacks may make sense. See
\fI\%VIDEO OUTPUT DRIVERS\fP for details and descriptions of available drivers.
.TP
.B \fB\-\-vd=<[+|\-]family1:(*|decoder1),[+|\-]family2:(*|decoder2),...[\-]>\fP
Specify a priority list of video decoders to be used, according to their
family and name. See \fB\-\-ad\fP for further details. Both of these options
use the same syntax and semantics; the only difference is that they
operate on different codec lists.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
See \fB\-\-vd=help\fP for a full list of available decoders.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-vf=<filter1[=parameter1:parameter2:...],filter2,...>\fP
Specify a list of video filters to apply to the video stream. See
\fI\%VIDEO FILTERS\fP for details and descriptions of the available filters.
The option variants \fB\-\-vf\-add\fP, \fB\-\-vf\-pre\fP, \fB\-\-vf\-del\fP and
\fB\-\-vf\-clr\fP exist to modify a previously specified list, but you
should not need these for typical use.
.TP
.B \fB\-\-no\-video\fP
Do not play video. With some demuxers this may not work. In those cases
you can try \fB\-\-vo=null\fP instead.
.TP
.B \fB\-\-untimed\fP
Do not sleep when outputting video frames. Useful for benchmarks when used
with \fB\-\-no\-audio.\fP
.TP
.B \fB\-\-framedrop=<mode>\fP
Skip displaying some frames to maintain A/V sync on slow systems, or
playing high framerate video on video outputs that have an upper framerate
limit.
.sp
The argument selects the drop methods, and can be one of the following:
.INDENT 7.0
.TP
.B <no>
Disable any framedropping.
.TP
.B <vo>
Drop late frames on video output (default). This still decodes and
filters all frames, but doesn\(aqt render them on the VO. It tries to query
the display FPS (X11 only, not correct on multi\-monitor systems), or
assumes infinite display FPS if that fails. Drops are indicated in
the terminal status line as \fBD:\fP field. If the decoder is too slow,
in theory all frames would have to be dropped (because all frames are
too late) \- to avoid this, frame dropping stops if the effective
framerate is below 10 FPS.
.TP
.B <decoder>
Old, decoder\-based framedrop mode. (This is the same as \fB\-\-framedrop=yes\fP
in mpv 0.5.x and before.) This tells the decoder to skip frames (unless
they are needed to decode future frames). May help with slow systems,
but can produce unwatchably choppy output, or even freeze the display
complete. Not recommended.
The \fB\-\-vd\-lavc\-framedrop\fP option controls what frames to drop.
.TP
.B <decoder+vo>
Enable both modes. Not recommended.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fB\-\-vo=vdpau\fP has its own code for the \fBvo\fP framedrop mode. Slight
differences to other VOs are possible.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-display\-fps=<fps>\fP
Set the maximum assumed display FPS used with \fB\-\-framedrop\fP\&. By default
a detected value is used (X11 only, not correct on multi\-monitor systems),
or infinite display FPS if that fails. Infinite FPS means only frames too
late are dropped. If a correct FPS is provided, frames that are predicted
to be too late are dropped too.
.TP
.B \fB\-\-hwdec=<api>\fP
Specify the hardware video decoding API that should be used if possible.
Whether hardware decoding is actually done depends on the video codec. If
hardware decoding is not possible, mpv will fall back on software decoding.
.sp
\fB<api>\fP can be one of the following:
.INDENT 7.0
.TP
.B no
always use software decoding (default)
.TP
.B auto
see below
.TP
.B vdpau
requires \fB\-\-vo=vdpau\fP or \fB\-\-vo=opengl\fP (Linux only)
.TP
.B vaapi
requires \fB\-\-vo=opengl\fP or \fB\-\-vo=vaapi\fP (Linux with Intel GPUs only)
.TP
.B vaapi\-copy
copies video back into system RAM (Linux with Intel GPUs only)
.TP
.B vda
requires \fB\-\-vo=opengl\fP (OS X only)
.UNINDENT
.sp
\fBauto\fP tries to automatically enable hardware decoding using the first
available method. This still depends what VO you are using. For example,
if you are not using \fB\-\-vo=vdpau\fP, vdpau decoding will never be enabled.
Also note that if the first found method doesn\(aqt actually work, it will
always fall back to software decoding, instead of trying the next method.
.sp
The \fBvaapi\-copy\fP function allows you to use vaapi with any VO. Because
this copies the decoded video back to system RAM, it\(aqs quite inefficient.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When using this switch, hardware decoding is still only done for some
codecs. See \fB\-\-hwdec\-codecs\fP to enable hardware decoding for more
codecs.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-panscan=<0.0\-1.0>\fP
Enables pan\-and\-scan functionality (cropping the sides of e.g. a 16:9
video to make it fit a 4:3 display without black bands). The range
controls how much of the image is cropped. May not work with all video
output drivers.
.TP
.B \fB\-\-video\-aspect=<ratio>\fP
Override video aspect ratio, in case aspect information is incorrect or
missing in the file being played. See also \fB\-\-no\-video\-aspect\fP\&.
.sp
Two values have special meaning:
.INDENT 7.0
.TP
.B 0
disable aspect ratio handling, pretend the video has square pixels
.TP
.B \-1
use the video stream or container aspect (default)
.UNINDENT
.sp
But note that handling of these special values might change in the future.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.IP \(bu 2
\fB\-\-video\-aspect=4:3\fP  or \fB\-\-video\-aspect=1.3333\fP
.IP \(bu 2
\fB\-\-video\-aspect=16:9\fP or \fB\-\-video\-aspect=1.7777\fP
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-no\-video\-aspect\fP
Ignore aspect ratio information from video file and assume the video has
square pixels. See also \fB\-\-video\-aspect\fP\&.
.TP
.B \fB\-\-video\-unscaled\fP
Disable scaling of the video. If the window is larger than the video,
black bars are added. Otherwise, the video is cropped. The video still
can be influenced by the other \fB\-\-video\-...\fP options. (If the
\fB\-\-video\-zoom\fP option is set to a value other than \fB1\fP, scaling is
enabled, but the video isn\(aqt automatically scaled to the window size.)
.sp
The video and monitor aspects aspect will be ignored. Aspect correction
would require to scale the video in the X or Y direction, but this option
disables scaling, disabling all aspect correction.
.sp
Note that the scaler algorithm may still be used, even if the video isn\(aqt
scaled. For example, this can influence chroma conversion.
.sp
This option is disabled if the \fB\-\-no\-keepaspect\fP option is used.
.TP
.B \fB\-\-video\-pan\-x=<value>\fP, \fB\-\-video\-pan\-y=<value>\fP
Moves the displayed video rectangle by the given value in the X or Y
direction. The unit is in fractions of the size of the scaled video (the
full size, even if parts of the video are not visible due to panscan or
other options).
.sp
For example, displaying a 1280x720 video fullscreen on a 1680x1050 screen
with \fB\-\-video\-pan\-x=\-0.1\fP would move the video 168 pixels to the left
(making 128 pixels of the source video invisible).
.sp
This option is disabled if the \fB\-\-no\-keepaspect\fP option is used.
.TP
.B \fB\-\-video\-rotate=<0\-359|no>\fP
Rotate the video clockwise, in degrees. Currently supports 90° steps only.
If \fBno\fP is given, the video is never rotated, even if the file has
rotation metadata. (The rotation value is added to the rotation metadata,
which means the value \fB0\fP would rotate the video according to the
rotation metadata.)
.TP
.B \fB\-\-video\-stereo\-mode=<mode>\fP
Set the stereo 3D output mode (default: \fBmono\fP). This is done by inserting
the \fBstereo3d\fP conversion filter.
.sp
The mode \fBmono\fP is an alias to \fBml\fP, which refers to the left frame in
2D. This is the default, which means mpv will try to show 3D movies in 2D,
instead of the mangled 3D image not intended for consumption (such as
showing the left and right frame side by side, etc.).
.sp
The pseudo\-mode \fBnone\fP disables automatic conversion completely.
.sp
Use \fB\-\-video\-stereo\-mode=help\fP to list all available modes. Check with
the \fBstereo3d\fP filter documentation to see what the names mean. Note that
some names refer to modes not supported by \fBstereo3d\fP \- these modes can
appear in files, but can\(aqt be handled properly by mpv.
.TP
.B \fB\-\-video\-zoom=<value>\fP
Adjust the video display scale factor by the given value. The unit is in
fractions of the (scaled) window video size.
.sp
For example, given a 1280x720 video shown in a 1280x720 window,
\fB\-\-video\-zoom=\-0.1\fP would make the video by 128 pixels smaller in
X direction, and 72 pixels in Y direction.
.sp
This option is disabled if the \fB\-\-no\-keepaspect\fP option is used.
.TP
.B \fB\-\-video\-align\-x=<\-1\-1>\fP, \fB\-\-video\-align\-y=<\-1\-1>\fP
Moves the video rectangle within the black borders, which are usually added
to pad the video to screen if video and screen aspect ratios are different.
\fB\-\-video\-align\-y=\-1\fP would move the video to the top of the screen
(leaving a border only on the bottom), a value of \fB0\fP centers it
(default), and a value of \fB1\fP would put the video at the bottom of the
screen.
.sp
If video and screen aspect match perfectly, these options do nothing.
.sp
This option is disabled if the \fB\-\-no\-keepaspect\fP option is used.
.TP
.B \fB\-\-correct\-pts\fP, \fB\-\-no\-correct\-pts\fP
\fB\-\-no\-correct\-pts\fP switches mpv to a mode where video timing is
determined using a fixed framerate value (either using the \fB\-\-fps\fP
option, or using file information). Sometimes, files with very broken
timestamps can be played somewhat well in this mode. Note that video
filters, subtitle rendering and audio synchronization can be completely
broken in this mode.
.TP
.B \fB\-\-fps=<float>\fP
Override video framerate. Useful if the original value is wrong or missing.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Works in \fB\-\-no\-correct\-pts\fP mode only.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-deinterlace=<yes|no|auto>\fP
Enable or disable interlacing (default: auto, which usually means no).
Interlaced video shows ugly comb\-like artifacts, which are visible on
fast movement. Enabling this typically inserts the yadif video filter in
order to deinterlace the video, or lets the video output apply deinterlacing
if supported.
.sp
This behaves exactly like the \fBdeinterlace\fP input property (usually
mapped to \fBShift+D\fP).
.sp
\fBauto\fP is a technicality. Strictly speaking, the default for this option
is deinterlacing disabled, but the \fBauto\fP case is needed if \fByadif\fP was
added to the filter chain manually with \fB\-\-vf\fP\&. Then the core shouldn\(aqt
disable deinterlacing just because the \fB\-\-deinterlace\fP was not set.
.TP
.B \fB\-\-field\-dominance=<auto|top|bottom>\fP
Set first field for interlaced content. Useful for deinterlacers that
double the framerate: \fB\-\-vf=yadif=field\fP and \fB\-\-vo=vdpau:deint\fP\&.
.INDENT 7.0
.TP
.B auto
(default) If the decoder does not export the appropriate
information, it falls back on \fBtop\fP (top field first).
.TP
.B top
top field first
.TP
.B bottom
bottom field first
.UNINDENT
.TP
.B \fB\-\-frames=<number>\fP
Play/convert only first \fB<number>\fP video frames, then quit.
.sp
\fB\-\-frames=0\fP loads the file, but immediately quits before initializing
playback. (Might be useful for scripts which just want to determine some
file properties.)
.sp
For audio\-only playback, any value greater than 0 will quit playback
immediately after initialization. The value 0 works as with video.
.TP
.B \fB\-\-hwdec\-codecs=<codec1,codec2,...|all>\fP
Allow hardware decoding for a given list of codecs only. The special value
\fBall\fP always allows all codecs.
.sp
You can get the list of allowed codecs with \fBmpv \-\-vd=help\fP\&. Remove the
prefix, e.g. instead of \fBlavc:h264\fP use \fBh264\fP\&.
.sp
By default this is set to \fBh264,vc1,wmv3\fP\&. Note that the hardware
acceleration special codecs like \fBh264_vdpau\fP are not relevant anymore,
and in fact have been removed from Libav in this form.
.sp
This is usually only needed with broken GPUs, where a codec is reported
as supported, but decoding causes more problems than it solves.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fBmpv \-\-hwdec=vdpau \-\-vo=vdpau \-\-hwdec\-codecs=h264,mpeg2video\fP
Enable vdpau decoding for h264 and mpeg2 only.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-quvi\-format=<best|default|...>\fP
Video format/quality that is directly passed to libquvi (default: \fBbest\fP).
This is used when opening links to streaming sites like YouTube. The
interpretation of this value is highly specific to the streaming site and
the video.
.sp
libquvi 0.4.x:
.INDENT 7.0
.INDENT 3.5
The only well\-defined values that work on all sites are \fBbest\fP
(best quality/highest bandwidth, default), and \fBdefault\fP (lowest
quality).
.sp
The quvi command line tool can be used to find out which formats are
supported for a given URL: \fBquvi \-\-query\-formats URL\fP\&.
.UNINDENT
.UNINDENT
.sp
libquvi 0.9.x:
.INDENT 7.0
.INDENT 3.5
The following explanations are relevant:
\fI\%http://quvi.sourceforge.net/r/api/0.9/glossary_termino.html#m_stream_id\fP
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-vd\-lavc\-check\-hw\-profile=<yes|no>\fP
Check hardware decoder profile (default: yes). If \fBno\fP is set, the
highest profile of the hardware decoder is unconditionally selected, and
decoding is forced even if the profile of the video is higher than that.
The result is most likely broken decoding, but may also help if the
detected or reported profiles are somehow incorrect.
.TP
.B \fB\-\-vd\-lavc\-bitexact\fP
Only use bit\-exact algorithms in all decoding steps (for codec testing).
.TP
.B \fB\-\-vd\-lavc\-fast\fP (MPEG\-2, MPEG\-4, and H.264 only)
Enable optimizations which do not comply with the format specification and
potentially cause problems, like simpler dequantization, simpler motion
compensation, assuming use of the default quantization matrix, assuming YUV
4:2:0 and skipping a few checks to detect damaged bitstreams.
.TP
.B \fB\-\-vd\-lavc\-o=<key>=<value>[,<key>=<value>[,...]]\fP
Pass AVOptions to libavcodec decoder. Note, a patch to make the \fBo=\fP
unneeded and pass all unknown options through the AVOption system is
welcome. A full list of AVOptions can be found in the FFmpeg manual.
.sp
Some options which used to be direct options can be set with this
mechanism, like \fBbug\fP, \fBgray\fP, \fBidct\fP, \fBec\fP, \fBvismv\fP,
\fBskip_top\fP (was \fBst\fP), \fBskip_bottom\fP (was \fBsb\fP), \fBdebug\fP\&.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.sp
\fB\-\-vd\-\-lavc\-o=debug=pict\fP
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-vd\-lavc\-show\-all=<yes|no>\fP
Show even broken/corrupt frames (default: no). If this option is set to
no, libavcodec won\(aqt output frames that were either decoded before an
initial keyframe was decoded, or frames that are recognized as corrupted.
.TP
.B \fB\-\-vd\-lavc\-skiploopfilter=<skipvalue> (H.264 only)\fP
Skips the loop filter (AKA deblocking) during H.264 decoding. Since
the filtered frame is supposed to be used as reference for decoding
dependent frames, this has a worse effect on quality than not doing
deblocking on e.g. MPEG\-2 video. But at least for high bitrate HDTV,
this provides a big speedup with little visible quality loss.
.sp
\fB<skipvalue>\fP can be one of the following:
.INDENT 7.0
.TP
.B none
Never skip.
.TP
.B default
Skip useless processing steps (e.g. 0 size packets in AVI).
.TP
.B nonref
Skip frames that are not referenced (i.e. not used for
decoding other frames, the error cannot "build up").
.TP
.B bidir
Skip B\-Frames.
.TP
.B nonkey
Skip all frames except keyframes.
.TP
.B all
Skip all frames.
.UNINDENT
.TP
.B \fB\-\-vd\-lavc\-skipidct=<skipvalue> (MPEG\-1/2 only)\fP
Skips the IDCT step. This degrades quality a lot in almost all cases
(see skiploopfilter for available skip values).
.TP
.B \fB\-\-vd\-lavc\-skipframe=<skipvalue>\fP
Skips decoding of frames completely. Big speedup, but jerky motion and
sometimes bad artifacts (see skiploopfilter for available skip values).
.TP
.B \fB\-\-vd\-lavc\-framedrop=<skipvalue>\fP
Set framedropping mode used with \fB\-\-framedrop\fP (see skiploopfilter for
available skip values).
.TP
.B \fB\-\-vd\-lavc\-threads=<0\-16>\fP
Number of threads to use for decoding. Whether threading is actually
supported depends on codec. 0 means autodetect number of cores on the
machine and use that, up to the maximum of 16 (default: 0).
.UNINDENT
.SS Audio
.INDENT 0.0
.TP
.B \fB\-\-ao=<driver1[:suboption1[=value]:...],driver2,...[,]>\fP
Specify a priority list of audio output drivers to be used. For
interactive use one would normally specify a single one to use, but in
configuration files specifying a list of fallbacks may make sense. See
\fI\%AUDIO OUTPUT DRIVERS\fP for details and descriptions of available drivers.
.TP
.B \fB\-\-af=<filter1[=parameter1:parameter2:...],filter2,...>\fP
Specify a list of audio filters to apply to the audio stream. See
\fI\%AUDIO FILTERS\fP for details and descriptions of the available filters.
The option variants \fB\-\-af\-add\fP, \fB\-\-af\-pre\fP, \fB\-\-af\-del\fP and
\fB\-\-af\-clr\fP exist to modify a previously specified list, but you
should not need these for typical use.
.TP
.B \fB\-\-ad=<[+|\-]family1:(*|decoder1),[+|\-]family2:(*|decoder2),...[\-]>\fP
Specify a priority list of audio decoders to be used, according to their
family and decoder name. Entries like \fBfamily:*\fP prioritize all decoders
of the given family. When determining which decoder to use, the first
decoder that matches the audio format is selected. If that is unavailable,
the next decoder is used. Finally, it tries all other decoders that are not
explicitly selected or rejected by the option.
.sp
\fB\-\fP at the end of the list suppresses fallback on other available
decoders not on the \fB\-\-ad\fP list. \fB+\fP in front of an entry forces the
decoder. Both of these should not normally be used, because they break
normal decoder auto\-selection!
.sp
\fB\-\fP in front of an entry disables selection of the decoder.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.TP
.B \fB\-\-ad=lavc:mp3float\fP
Prefer the FFmpeg/Libav \fBmp3float\fP decoder over all other MP3
decoders.
.TP
.B \fB\-\-ad=spdif:ac3,lavc:*\fP
Always prefer spdif AC3 over FFmpeg/Libav over anything else.
.TP
.B \fB\-\-ad=help\fP
List all available decoders.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-volume=<\-1\-100>\fP
Set the startup volume. A value of \-1 (the default) will not change the
volume. See also \fB\-\-softvol\fP\&.
.TP
.B \fB\-\-audio\-delay=<sec>\fP
Audio delay in seconds (positive or negative float value). Positive values
delay the audio, and negative values delay the video.
.TP
.B \fB\-\-no\-audio\fP
Do not play sound. With some demuxers this may not work. In those cases
you can try \fB\-\-ao=null\fP instead.
.TP
.B \fB\-\-mute=<auto|yes|no>\fP
Set startup audio mute status. \fBauto\fP (default) will not change the mute
status. Also see \fB\-\-volume\fP\&.
.TP
.B \fB\-\-softvol=<mode>\fP
Control whether to use the volume controls of the audio output driver or
the internal mpv volume filter.
.INDENT 7.0
.TP
.B no
prefer audio driver controls, use the volume filter only if
absolutely needed
.TP
.B yes
always use the volume filter
.TP
.B auto
prefer the volume filter if the audio driver uses the system mixer
(default)
.UNINDENT
.sp
The intention of \fBauto\fP is to avoid changing system mixer settings from
within mpv with default settings. mpv is a video player, not a mixer panel.
On the other hand, mixer controls are enabled for sound servers like
PulseAudio, which provide per\-application volume.
.TP
.B \fB\-\-audio\-demuxer=<[+]name>\fP
Use this audio demuxer type when using \fB\-\-audio\-file\fP\&. Use a \(aq+\(aq before
the name to force it; this will skip some checks. Give the demuxer name as
printed by \fB\-\-audio\-demuxer=help\fP\&.
.TP
.B \fB\-\-ad\-lavc\-ac3drc=<level>\fP
Select the Dynamic Range Compression level for AC\-3 audio streams.
\fB<level>\fP is a float value ranging from 0 to 1, where 0 means no
compression and 1 (which is the default) means full compression (make loud
passages more silent and vice versa). Values up to 2 are also accepted, but
are purely experimental. This option only shows an effect if the AC\-3 stream
contains the required range compression information.
.TP
.B \fB\-\-ad\-lavc\-downmix=<yes|no>\fP
Whether to request audio channel downmixing from the decoder (default: yes).
Some decoders, like AC\-3, AAC and DTS, can remix audio on decoding. The
requested number of output channels is set with the \fB\-\-audio\-channels\fP option.
Useful for playing surround audio on a stereo system.
.TP
.B \fB\-\-ad\-lavc\-threads=<0\-16>\fP
Number of threads to use for decoding. Whether threading is actually
supported depends on codec. As of this writing, it\(aqs supported for some
lossless codecs only. 0 means autodetect number of cores on the
machine and use that, up to the maximum of 16 (default: 1).
.TP
.B \fB\-\-ad\-lavc\-o=<key>=<value>[,<key>=<value>[,...]]\fP
Pass AVOptions to libavcodec decoder. Note, a patch to make the o=
unneeded and pass all unknown options through the AVOption system is
welcome. A full list of AVOptions can be found in the FFmpeg manual.
.TP
.B \fB\-\-ad\-spdif\-dtshd=<yes|no>\fP, \fB\-\-dtshd\fP, \fB\-\-no\-dtshd\fP
When using DTS pass\-through, output any DTS\-HD track as\-is.
With \fBad\-spdif\-dtshd=no\fP (the default), only the DTS Core parts will be
output.
.sp
DTS\-HD tracks can be sent over HDMI but not over the original
coax/TOSLINK S/PDIF system.
.sp
Some receivers don\(aqt accept DTS core\-only when \fB\-\-ad\-spdif\-dtshd=yes\fP is
used, even though they accept DTS\-HD.
.sp
\fB\-\-dtshd\fP and \fB\-\-no\-dtshd\fP are deprecated aliases.
.TP
.B \fB\-\-audio\-channels=<number|layout>\fP
Request a channel layout for audio output (default: stereo). This  will ask
the AO to open a device with the given channel layout. It\(aqs up to the AO
to accept this layout, or to pick a fallback or to error out if the
requested layout is not supported.
.sp
The \fB\-\-audio\-channels\fP option either takes a channel number or an explicit
channel layout. Channel numbers refer to default layouts, e.g. 2 channels
refer to stereo, 6 refers to 5.1.
.sp
See \fB\-\-audio\-channels=help\fP output for defined default layouts. This also
lists speaker names, which can be used to express arbitrary channel
layouts (e.g. \fBfl\-fr\-lfe\fP is 2.1).
.sp
You can use \fB\-\-audio\-channels=empty\fP to disable this. In this case, the AO
use the channel layout as the audio filter chain indicates.
.sp
This will also request the channel layout from the decoder. If the decoder
does not support the layout, it will fall back to its native channel layout.
(You can use \fB\-\-ad\-lavc\-downmix=no\fP to make the decoder always output
its native layout.) Note that only some decoders support remixing audio.
Some that do include AC\-3, AAC or DTS audio.
.sp
If the channel layout of the media file (i.e. the decoder) and the AO\(aqs
channel layout don\(aqt match, mpv will attempt to insert a conversion filter.
.TP
.B \fB\-\-audio\-display=<no|attachment>\fP
Setting this option to \fBattachment\fP (default) will display image
attachments when playing audio files. It will display the first image
found, and additional images are available as video tracks.
.sp
Setting this option to \fBno\fP disables display of video entirely when
playing audio files.
.sp
This option has no influence on files with normal video tracks.
.TP
.B \fB\-\-audio\-file=<filename>\fP
Play audio from an external file while viewing a video. Each use of this
option will add a new audio track. The details are similar to how
\fB\-\-sub\-file\fP works.
.TP
.B \fB\-\-audio\-format=<format>\fP
Select the sample format used for output from the audio filter layer to
the sound card. The values that \fB<format>\fP can adopt are listed below in
the description of the \fBformat\fP audio filter.
.TP
.B \fB\-\-audio\-samplerate=<Hz>\fP
Select the output sample rate to be used (of course sound cards have
limits on this). If the sample frequency selected is different from that
of the current media, the lavrresample audio filter will be inserted into
the audio filter layer to compensate for the difference.
.TP
.B \fB\-\-gapless\-audio=<no|yes|weak\fP
Try to play consecutive audio files with no silence or disruption at the
point of file change. Default: \fBweak\fP\&.
.INDENT 7.0
.TP
.B no
Disable gapless audio.
.TP
.B yes
The audio device is opened using parameters chosen according to the
first file played and is then kept open for gapless playback. This
means that if the first file for example has a low sample rate, then
the following files may get resampled to the same low sample rate,
resulting in reduced sound quality. If you play files with different
parameters, consider using options such as \fB\-\-audio\-samplerate\fP
and \fB\-\-audio\-format\fP to explicitly select what the shared output
format will be.
.TP
.B weak
Normally, the audio device is kept open (using the format it was
first initialized with). If the audio format the decoder output
changes, the audio device is closed and reopened. This means that
you will normally get gapless audio with files that were encoded
using the same settings, but might not be gapless in other cases.
(Unlike with \fByes\fP, you don\(aqt have to worry about corner cases
like the first file setting a very low quality output format, and
ruining the playback of higher quality files that follow.)
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This feature is implemented in a simple manner and relies on audio
output device buffering to continue playback while moving from one file
to another. If playback of the new file starts slowly, for example
because it is played from a remote network location or because you have
specified cache settings that require time for the initial cache fill,
then the buffered audio may run out before playback of the new file
can start.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-initial\-audio\-sync\fP, \fB\-\-no\-initial\-audio\-sync\fP
When starting a video file or after events such as seeking, mpv will by
default modify the audio stream to make it start from the same timestamp
as video, by either inserting silence at the start or cutting away the
first samples. Disabling this option makes the player behave like older
mpv versions did: video and audio are both started immediately even if
their start timestamps differ, and then video timing is gradually adjusted
if necessary to reach correct synchronization later.
.TP
.B \fB\-\-softvol\-max=<10.0\-10000.0>\fP
Set the maximum amplification level in percent (default: 200). A value of
200 will allow you to adjust the volume up to a maximum of double the
current level. With values below 100 the initial volume (which is 100%)
will be above the maximum, which e.g. the OSD cannot display correctly.
.INDENT 7.0
.INDENT 3.5
.IP "Note"
.sp
The maximum value of \fB\-\-volume\fP as well as the \fBvolume\fP property
is always 100. Likewise, the volume OSD bar always goes from 0 to 100.
This means that with \fB\-\-softvol\-max=200\fP, \fB\-\-volume=100\fP sets
maximum amplification, i.e. amplify by 200%. The default volume (no
change in volume) will be \fB50\fP in this case.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-volume\-restore\-data=<string>\fP
Used internally for use by playback resume (e.g. with \fBquit_watch_later\fP).
Restoring value has to be done carefully, because different AOs as well as
softvol can have different value ranges, and we don\(aqt want to restore
volume if setting the volume changes it system wide. The normal options
(like \fB\-\-volume\fP) would always set the volume. This option was added for
restoring volume in a safer way (by storing the method used to set the
volume), and is not generally useful. Its semantics are considered private
to mpv.
.sp
Do not use.
.TP
.B \fB\-\-audio\-buffer=<seconds>\fP
Set the audio output minimum buffer. The audio device might actually create
a larger buffer if it pleases. If the device creates a smaller buffer,
additional audio is buffered in an additional software buffer.
.sp
Making this larger will make soft\-volume and other filters react slower,
introduce additional issues on playback speed change, and block the
player on audio format changes. A smaller buffer might lead to audio
dropouts.
.sp
This option should be used for testing only. If a non\-default value helps
significantly, the mpv developers should be contacted.
.sp
Default: 0.2 (200 ms).
.UNINDENT
.SS Subtitles
.INDENT 0.0
.TP
.B \fB\-\-no\-sub\fP
Do not select any subtitle when the file is loaded.
.TP
.B \fB\-\-sub\-demuxer=<[+]name>\fP
Force subtitle demuxer type for \fB\-\-sub\-file\fP\&. Give the demuxer name as
printed by \fB\-\-sub\-demuxer=help\fP\&.
.TP
.B \fB\-\-sub\-delay=<sec>\fP
Delays subtitles by \fB<sec>\fP seconds. Can be negative.
.TP
.B \fB\-\-sub\-file=subtitlefile\fP
Add a subtitle file to the list of external subtitles.
.sp
If you use \fB\-\-sub\-file\fP only once, this subtitle file is displayed by
default.
.sp
If \fB\-\-sub\-file\fP is used multiple times, the subtitle to use can be
switched at runtime by cycling subtitle tracks. It\(aqs possible to show
two subtitles at once: use \fB\-\-sid\fP to select the first subtitle index,
and \fB\-\-secondary\-sid\fP to select the second index. (The index is printed
on the terminal output after the \fB\-\-sid=\fP in the list of streams.)
.TP
.B \fB\-\-secondary\-sid=<ID|auto|no>\fP
Select a secondary subtitle stream. This is similar to \fB\-\-sid\fP\&. If a
secondary subtitle is selected, it will be rendered as toptitle (i.e. on
the top of the screen) alongside the normal subtitle, and provides a way
to render two subtitles at once.
.sp
there are some caveats associated with this feature. For example, bitmap
subtitles will always be rendered in their usual position, so selecting a
bitmap subtitle as secondary subtitle will result in overlapping subtitles.
Secondary subtitles are never shown on the terminal if video is disabled.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Styling and interpretation of any formatting tags is disabled for the
secondary subtitle. Internally, the same mechanism as \fB\-\-no\-sub\-ass\fP
is used to strip the styling.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If the main subtitle stream contains formatting tags which display the
subtitle at the top of the screen, it will overlap with the secondary
subtitle. To prevent this, you could use \fB\-\-no\-sub\-ass\fP to disable
styling in the main subtitle stream.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-sub\-scale=<0\-100>\fP
Factor for the text subtitle font size (default: 1).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This affects ASS subtitles as well, and may lead to incorrect subtitle
rendering. Use with care, or use \fB\-\-sub\-text\-font\-size\fP instead.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-sub\-scale\-with\-window=yes|no\fP
Make the subtitle font size relative to the window, instead of the video.
This is useful if you always want the same font size, even if the video
doesn\(aqt covert the window fully, e.g. because screen aspect and window
aspect mismatch (and the player adds black bars).
.sp
Like \fB\-\-sub\-scale\fP, this can break ASS subtitles.
.TP
.B \fB\-\-embeddedfonts\fP, \fB\-\-no\-embeddedfonts\fP
Use fonts embedded in Matroska container files and ASS scripts (default:
enabled). These fonts can be used for SSA/ASS subtitle rendering.
.TP
.B \fB\-\-sub\-pos=<0\-100>\fP
Specify the position of subtitles on the screen. The value is the vertical
position of the subtitle in % of the screen height.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This affects ASS subtitles as well, and may lead to incorrect subtitle
rendering. Use with care, or use \fB\-\-sub\-text\-margin\-y\fP instead.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-sub\-speed=<0.1\-10.0>\fP
Multiply the subtitle event timestamps with the given value. Can be used
to fix the playback speed for frame\-based subtitle formats. Works for
external text subtitles only.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.sp
\fI\-\-sub\-speed=25/23.976\(ga\fP plays frame based subtitles which have been
loaded assuming a framerate of 23.976 at 25 FPS.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-ass\-force\-style=<[Style.]Param=Value[,...]>\fP
Override some style or script info parameters.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.IP \(bu 2
\fB\-\-ass\-force\-style=FontName=Arial,Default.Bold=1\fP
.IP \(bu 2
\fB\-\-ass\-force\-style=PlayResY=768\fP
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Using this option may lead to incorrect subtitle rendering.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-ass\-hinting=none|light|normal|native\fP
Set font hinting type. <type> can be:
.INDENT 7.0
.TP
.B none
no hinting (default)
.TP
.B light
FreeType autohinter, light mode
.TP
.B normal
FreeType autohinter, normal mode
.TP
.B native
font native hinter
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Warning"
.sp
Enabling hinting can lead to mispositioned text (in situations it\(aqs
supposed to match up with video background), or reduce the smoothness
of animations with some badly authored ASS scripts. It is recommended
to not use this option, unless really needed.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-ass\-line\-spacing=<value>\fP
Set line spacing value for SSA/ASS renderer.
.TP
.B \fB\-\-ass\-shaper=simple|complex\fP
Set the text layout engine used by libass.
.INDENT 7.0
.TP
.B simple
uses Fribidi only, fast, doesn\(aqt render some languages correctly
.TP
.B complex
uses HarfBuzz, slower, wider language support
.UNINDENT
.sp
\fBcomplex\fP is the default. If libass hasn\(aqt been compiled against HarfBuzz,
libass silently reverts to \fBsimple\fP\&.
.TP
.B \fB\-\-ass\-styles=<filename>\fP
Load all SSA/ASS styles found in the specified file and use them for
rendering text subtitles. The syntax of the file is exactly like the \fB[V4
Styles]\fP / \fB[V4+ Styles]\fP section of SSA/ASS.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Using this option may lead to incorrect subtitle rendering.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-ass\-style\-override=<yes|no|force>\fP
Control whether user style overrides should be applied.
.INDENT 7.0
.TP
.B yes
Apply all the \fB\-\-ass\-*\fP style override options. Changing the default
for any of these options can lead to incorrect subtitle rendering
(default).
.TP
.B signfs
like \fByes\fP, but apply \fB\-\-sub\-scale\fP only to signs
.TP
.B no
Render subtitles as forced by subtitle scripts.
.TP
.B force
Try to force the font style as defined by the \fB\-\-sub\-text\-*\fP
options. Requires a modified libass, can break rendering easily.
Probably more reliable than \fBforce\fP\&.
.UNINDENT
.TP
.B \fB\-\-ass\-use\-margins\fP
Enables placing toptitles and subtitles in black borders when they are
available.
.TP
.B \fB\-\-ass\-vsfilter\-aspect\-compat=<yes|no>\fP
Stretch SSA/ASS subtitles when playing anamorphic videos for compatibility
with traditional VSFilter behavior. This switch has no effect when the
video is stored with square pixels.
.sp
The renderer historically most commonly used for the SSA/ASS subtitle
formats, VSFilter, had questionable behavior that resulted in subtitles
being stretched too if the video was stored in anamorphic format that
required scaling for display.  This behavior is usually undesirable and
newer VSFilter versions may behave differently. However, many existing
scripts compensate for the stretching by modifying things in the opposite
direction.  Thus, if such scripts are displayed "correctly", they will not
appear as intended.  This switch enables emulation of the old VSFilter
behavior (undesirable but expected by many existing scripts).
.sp
Enabled by default.
.TP
.B \fB\-\-ass\-vsfilter\-blur\-compat=<yes|no>\fP
Scale \fB\eblur\fP tags by video resolution instead of script resolution
(enabled by default). This is bug in VSFilter, which according to some,
can\(aqt be fixed anymore in the name of compatibility.
.sp
Note that this uses the actual video resolution for calculating the
offset scale factor, not what the video filter chain or the video output
use.
.TP
.B \fB\-\-ass\-vsfilter\-color\-compat=<basic|full|force\-601|no>\fP
Mangle colors like (xy\-)vsfilter do (default: basic). Historically, VSFilter
was not color space aware. This was no problem as long as the color space
used for SD video (BT.601) was used. But when everything switched to HD
(BT.709), VSFilter was still converting RGB colors to BT.601, rendered
them into the video frame, and handled the frame to the video output, which
would use BT.709 for conversion to RGB. The result were mangled subtitle
colors. Later on, bad hacks were added on top of the ASS format to control
how colors are to be mangled.
.INDENT 7.0
.TP
.B basic
Handle only BT.601\->BT.709 mangling, if the subtitles seem to
indicate that this is required (default).
.TP
.B full
Handle the full \fBYCbCr Matrix\fP header with all video color spaces
supported by libass and mpv. This might lead to bad breakages in
corner cases and is not strictly needed for compatibility
(hopefully), which is why this is not default.
.TP
.B force\-601
Force BT.601\->BT.709 mangling, regardless of subtitle headers
or video color space.
.TP
.B no
Disable color mangling completely. All colors are RGB.
.UNINDENT
.sp
Choosing anything other than \fBno\fP will make the subtitle color depend on
the video color space, and it\(aqs for example in theory not possible to reuse
a subtitle script with another video file. The \fB\-\-ass\-style\-override\fP
option doesn\(aqt affect how this option is interpreted.
.TP
.B \fB\-\-quvi\-fetch\-subtitles=<yes|no>\fP
Toggles fetching of subtitles from streaming sites with libquvi. Disabled
by default, because it\(aqs unreliable and slow. Note that when enabled,
subtitles will always be fetched, even if subtitles are explicitly
disabled with \fB\-\-no\-sub\fP (because you might want to enable subtitles
at runtime).
.sp
Supported when using libquvi 0.9.x.
.TP
.B \fB\-\-stretch\-dvd\-subs=<yes|no>\fP
Stretch DVD subtitles when playing anamorphic videos for better looking
fonts on badly mastered DVDs. This switch has no effect when the
video is stored with square pixels \- which for DVD input cannot be the case
though.
.sp
Many studios tend to use bitmap fonts designed for square pixels when
authoring DVDs, causing the fonts to look stretched on playback on DVD
players. This option fixes them, however at the price of possibly
misaligning some subtitles (e.g. sign translations).
.sp
Disabled by default.
.TP
.B \fB\-\-sub\-ass\fP, \fB\-\-no\-sub\-ass\fP
Render ASS subtitles natively (enabled by default).
.sp
If \fB\-\-no\-sub\-ass\fP is specified, all tags and style declarations are
stripped and ignored on display. The subtitle renderer uses the font style
as specified by the \fB\-\-sub\-text\-\fP options instead.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Using \fB\-\-no\-sub\-ass\fP may lead to incorrect or completely broken
rendering of ASS/SSA subtitles. It can sometimes be useful to forcibly
override the styling of ASS subtitles, but should be avoided in general.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Try using \fB\-\-ass\-style\-override=force\fP instead.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-sub\-auto=<no|exact|fuzzy|all>\fP, \fB\-\-no\-sub\-auto\fP
Load additional subtitle files matching the video filename. The parameter
specifies how external subtitle files are matched. \fBexact\fP is enabled by
default.
.INDENT 7.0
.TP
.B no
Don\(aqt automatically load external subtitle files.
.TP
.B exact
Load the media filename with subtitle file extension (default).
.TP
.B fuzzy
Load all subs containing media filename.
.TP
.B all
Load all subs in the current and \fB\-\-sub\-paths\fP directories.
.UNINDENT
.TP
.B \fB\-\-sub\-codepage=<codepage>\fP
If your system supports \fBiconv(3)\fP, you can use this option to specify
the subtitle codepage. By default, ENCA will be used to guess the charset.
If mpv is not compiled with ENCA, \fBUTF\-8:UTF\-8\-BROKEN\fP is the default,
which means it will try to use UTF\-8, otherwise the \fBUTF\-8\-BROKEN\fP
pseudo codepage (see below).
.sp
The default value for this option is \fBauto\fP, whose actual effect depends
on whether ENCA is compiled.
.INDENT 7.0
.INDENT 3.5
.IP "Warning"
.sp
If you force the charset, even subtitles that are known to be
UTF\-8 will be recoded, which is perhaps not what you expect. Prefix
codepages with \fButf8:\fP if you want the codepage to be used only if the
input is not valid UTF\-8.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.IP \(bu 2
\fB\-\-sub\-codepage=utf8:latin2\fP Use Latin 2 if input is not UTF\-8.
.IP \(bu 2
\fB\-\-sub\-codepage=cp1250\fP Always force recoding to cp1250.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The pseudo codepage \fBUTF\-8\-BROKEN\fP is used internally. When it
is the codepage, subtitles are interpreted as UTF\-8 with "Latin 1" as
fallback for bytes which are not valid UTF\-8 sequences. iconv is
never involved in this mode.
.sp
If the player was compiled with ENCA support, you can control it with the
following syntax:
.sp
\fB\-\-sub\-codepage=enca:<language>:<fallback codepage>\fP
.sp
Language is specified using a two letter code to help ENCA detect
the codepage automatically. If an invalid language code is
entered, mpv will complain and list valid languages.  (Note
however that this list will only be printed when the conversion code is actually
called, for example when loading an external subtitle). The
fallback codepage is used if autodetection fails.  If no fallback
is specified, \fBUTF\-8\-BROKEN\fP is used.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.IP \(bu 2
\fB\-\-sub\-codepage=enca:pl:cp1250\fP guess the encoding, assuming the subtitles
are Polish, fall back on cp1250
.IP \(bu 2
\fB\-\-sub\-codepage=enca:pl\fP guess the encoding for Polish, fall back on UTF\-8.
.IP \(bu 2
\fB\-\-sub\-codepage=enca\fP try universal detection, fall back on UTF\-8.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
If the player was compiled with libguess support, you can use it with:
.sp
\fB\-\-sub\-codepage=guess:<language>:<fallback codepage>\fP
.sp
libguess always needs a language. There is no universal detection
mode. Use \fB\-\-sub\-codepage=guess:help\fP to get a list of
languages subject to the same caveat as with ENCA above.
.TP
.B \fB\-\-sub\-fix\-timing\fP, \fB\-\-no\-sub\-fix\-timing\fP
By default, external text subtitles are preprocessed to remove minor gaps
or overlaps between subtitles (if the difference is smaller than 200 ms,
the gap or overlap is removed). This does not affect image subtitles,
subtitles muxed with audio/video, or subtitles in the ASS format.
.TP
.B \fB\-\-sub\-forced\-only\fP
Display only forced subtitles for the DVD subtitle stream selected by e.g.
\fB\-\-slang\fP\&.
.TP
.B \fB\-\-sub\-fps=<rate>\fP
Specify the framerate of the subtitle file (default: video fps).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fB<rate>\fP > video fps speeds the subtitles up for frame\-based
subtitle files and slows them down for time\-based ones.
.UNINDENT
.UNINDENT
.sp
Also see \fB\-\-sub\-speed\fP option.
.TP
.B \fB\-\-sub\-gauss=<0.0\-3.0>\fP
Apply Gaussian blur to image subtitles (default: 0). This can help making
pixelated DVD/Vobsubs look nicer. A value other than 0 also switches to
software subtitle scaling. Might be slow.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Never applied to text subtitles.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-sub\-gray\fP
Convert image subtitles to grayscale. Can help making yellow DVD/Vobsubs
look nicer.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Never applied to text subtitles.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-sub\-paths=<path1:path2:...>\fP
Specify extra directories to search for subtitles matching the video.
Multiple directories can be separated by ":" (";" on Windows).
Paths can be relative or absolute. Relative paths are interpreted relative
to video file directory.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.sp
Assuming that \fB/path/to/video/video.avi\fP is played and
\fB\-\-sub\-paths=sub:subtitles:/tmp/subs\fP is specified, mpv searches for
subtitle files in these directories:
.INDENT 0.0
.IP \(bu 2
\fB/path/to/video/\fP
.IP \(bu 2
\fB/path/to/video/sub/\fP
.IP \(bu 2
\fB/path/to/video/subtitles/\fP
.IP \(bu 2
\fB/tmp/subs/\fP
.IP \(bu 2
the \fBsub\fP configuration subdirectory (usually \fB~/.config/mpv/sub/\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-sub\-visibility\fP, \fB\-\-no\-sub\-visibility\fP
Can be used to disable display of subtitles, but still select and decode
them.
.TP
.B \fB\-\-sub\-clear\-on\-seek\fP
(Obscure, rarely useful.) Can be used to play broken mkv files with
duplicate ReadOrder fields. ReadOrder is the first field in a
Matroska\-style ASS subtitle packets. It should be unique, and libass
uses it for fast elimination of duplicates. This option disables caching
of subtitles across seeks, so after a seek libass can\(aqt eliminate subtitle
packets with the same ReadOrder as earlier packets.
.UNINDENT
.SS Window
.INDENT 0.0
.TP
.B \fB\-\-title=<string>\fP
Set the window title. Properties are expanded on playback start.
(See \fI\%Property Expansion\fP\&.)
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
There is a danger of this causing significant CPU usage, depending on
the properties used and the window manager. Changing the window title
is often a slow operation, and if the title changes every frame,
playback can be ruined.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-screen=<default|0\-32>\fP
In multi\-monitor configurations (i.e. a single desktop that spans across
multiple displays), this option tells mpv which screen to display the
video on.
.INDENT 7.0
.INDENT 3.5
.IP "Note (X11)"
.sp
This option does not work properly with all window managers. In these
cases, you can try to use \fB\-\-geometry\fP to position the window
explicitly. It\(aqs also possible that the window manager provides native
features to control which screens application windows should use.
.UNINDENT
.UNINDENT
.sp
See also \fB\-\-fs\-screen\fP\&.
.TP
.B \fB\-\-fullscreen\fP, \fB\-\-fs\fP
Fullscreen playback.
.TP
.B \fB\-\-fs\-screen=<all|current|0\-32>\fP
In multi\-monitor configurations (i.e. a single desktop that spans across
multiple displays), this option tells mpv which screen to go fullscreen to.
If \fBdefault\fP is provided mpv will fallback on using the behavior
depending on what the user provided with the \fBscreen\fP option.
.INDENT 7.0
.INDENT 3.5
.IP "Note (X11)"
.sp
This option does works properly only with window managers which
understand the EWMH \fB_NET_WM_FULLSCREEN_MONITORS\fP hint.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Note (OS X)"
.sp
\fBall\fP does not work on OS X and will behave like \fBcurrent\fP\&.
.UNINDENT
.UNINDENT
.sp
See also \fB\-\-screen\fP\&.
.TP
.B \fB\-\-keep\-open\fP
Do not terminate when playing or seeking beyond the end of the file, and
there is not next file to be played (and \fB\-\-loop\fP is not used).
Instead, pause the player. When trying to seek beyond end of the file, the
player will pause at an arbitrary playback position (or, in corner cases,
not redraw the window at all).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This option is not respected when using \fB\-\-frames\fP, \fB\-\-end\fP,
\fB\-\-length\fP, or when passing a chapter range to \fB\-\-chapter\fP\&.
Explicitly skipping to the next file or skipping beyond the last
chapter will terminate playback as well, even if \fB\-\-keep\-open\fP is
given.
.UNINDENT
.UNINDENT
.sp
Since mpv 0.6.0, this doesn\(aqt pause if there is a next file in the playlist,
or the playlist is looped. Approximately, this will pause when the player
would normally exit, but in practice there are corner cases in which this
is not the case (e.g. \fBmpv \-\-keep\-open file.mkv /dev/null\fP will play
file.mkv normally, then fail to open \fB/dev/null\fP, then exit).
.TP
.B \fB\-\-force\-window\fP
Create a video output window even if there is no video. This can be useful
when pretending that mpv is a GUI application. Currently, the window
always has the size 640x480, and is subject to \fB\-\-geometry\fP,
\fB\-\-autofit\fP, and similar options.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The window is created only after initialization (to make sure default
window placement still works if the video size is different from the
\fB\-\-force\-window\fP default window size). This can be a problem if
initialization doesn\(aqt work perfectly, such as when opening URLs with
bad network connection, or opening broken video files.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-ontop\fP
Makes the player window stay on top of other windows.
.TP
.B \fB\-\-border\fP, \fB\-\-no\-border\fP
Play video with window border and decorations. Since this is on by
default, use \fB\-\-no\-border\fP to disable the standard window decorations.
.TP
.B \fB\-\-geometry=<[W[xH]][+\-x+\-y]>\fP, \fB\-\-geometry=<x:y>\fP
Adjust the initial window position or size. \fBW\fP and \fBH\fP set the window
size in pixels. \fBx\fP and \fBy\fP set the window position, measured in pixels
from the top\-left corner of the screen to the top\-left corner of the image
being displayed. If a percentage sign (\fB%\fP) is given after the argument,
it turns the value into a percentage of the screen size in that direction.
Positions are specified similar to the standard X11 \fB\-\-geometry\fP option
format, in which e.g. +10\-50 means "place 10 pixels from the left border and
50 pixels from the lower border" and "\-\-20+\-10" means "place 20 pixels
beyond the right and 10 pixels beyond the top border".
.sp
If an external window is specified using the \fB\-\-wid\fP option, this
option is ignored.
.sp
The coordinates are relative to the screen given with \fB\-\-screen\fP for the
video output drivers that fully support \fB\-\-screen\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Generally only supported by GUI VOs. Ignored for encoding.
.UNINDENT
.UNINDENT
.\" admonition: Note (OS X)
.\" 
.\" On Mac OS X the origin of the screen coordinate system is located on the
.\" bottom-left corner. For instance, ``0:0`` will place the window at the
.\" bottom-left of the screen.
.
.INDENT 7.0
.INDENT 3.5
.IP "Note (X11)"
.sp
This option does not work properly with all window managers.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.TP
.B \fB50:40\fP
Places the window at x=50, y=40.
.TP
.B \fB50%:50%\fP
Places the window in the middle of the screen.
.TP
.B \fB100%:100%\fP
Places the window at the bottom right corner of the screen.
.TP
.B \fB50%\fP
Sets the window width to half the screen width. Window height is set
so that the window has the video aspect ratio.
.TP
.B \fB50%x50%\fP
Forces the window width and height to half the screen width and
height. Will show black borders to compensate for the video aspect
ration (with most VOs and without \fB\-\-no\-keepaspect\fP).
.TP
.B \fB50%+10+10\fP
Sets the window to half the screen widths, and positions it 10
pixels below/left of the top left corner of the screen.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
See also \fB\-\-autofit\fP and \fB\-\-autofit\-larger\fP for fitting the window into
a given size without changing aspect ratio.
.TP
.B \fB\-\-autofit=<[W[xH]]>\fP
Set the initial window size to a maximum size specified by \fBWxH\fP, without
changing the window\(aqs aspect ratio. The size is measured in pixels, or if
a number is followed by a percentage sign (\fB%\fP), in percents of the
screen size.
.sp
This option never changes the aspect ratio of the window. If the aspect
ratio mismatches, the window\(aqs size is reduced until it fits into the
specified size.
.sp
Window position is not taken into account, nor is it modified by this
option (the window manager still may place the window differently depending
on size). Use \fB\-\-geometry\fP to change the window position. Its effects
are applied after this option.
.sp
See \fB\-\-geometry\fP for details how this is handled with multi\-monitor
setups.
.sp
Use \fB\-\-autofit\-larger\fP instead if you just want to limit the maximum size
of the window, rather than always forcing a window size.
.sp
Use \fB\-\-geometry\fP if you want to force both window width and height to a
specific size.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Generally only supported by GUI VOs. Ignored for encoding.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.TP
.B \fB70%\fP
Make the window width 70% of the screen size, keeping aspect ratio.
.TP
.B \fB1000\fP
Set the window width to 1000 pixels, keeping aspect ratio.
.TP
.B \fB70%:60%\fP
Make the window as large as possible, without being wider than 70%
of the screen width, or higher than 60% of the screen height.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-autofit\-larger=<[W[xH]]>\fP
This option behaves exactly like \fB\-\-autofit\fP, except the window size is
only changed if the window would be larger than the specified size.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fB90%x80%\fP
If the video is larger than 90% of the screen width or 80% of the
screen height, make the window smaller until either its width is 90%
of the screen, or its height is 80% of the screen.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-autosync=<factor>\fP
Gradually adjusts the A/V sync based on audio delay measurements.
Specifying \fB\-\-autosync=0\fP, the default, will cause frame timing to be
based entirely on audio delay measurements. Specifying \fB\-\-autosync=1\fP
will do the same, but will subtly change the A/V correction algorithm. An
uneven video framerate in a video which plays fine with \fB\-\-no\-audio\fP can
often be helped by setting this to an integer value greater than 1. The
higher the value, the closer the timing will be to \fB\-\-no\-audio\fP\&. Try
\fB\-\-autosync=30\fP to smooth out problems with sound drivers which do not
implement a perfect audio delay measurement. With this value, if large A/V
sync offsets occur, they will only take about 1 or 2 seconds to settle
out. This delay in reaction time to sudden A/V offsets should be the only
side\-effect of turning this option on, for all sound drivers.
.TP
.B \fB\-\-cursor\-autohide=<number|no|always>\fP
Make mouse cursor automatically hide after given number of milliseconds.
\fBno\fP will disable cursor autohide. \fBalways\fP means the cursor will stay
hidden.
.TP
.B \fB\-\-cursor\-autohide\-fs\-only\fP
If this option is given, the cursor is always visible in windowed mode. In
fullscreen mode, the cursor is shown or hidden according to
\fB\-\-cursor\-autohide\fP\&.
.TP
.B \fB\-\-no\-fixed\-vo\fP, \fB\-\-fixed\-vo\fP
\fB\-\-no\-fixed\-vo\fP enforces closing and reopening the video window for
multiple files (one (un)initialization for each file).
.TP
.B \fB\-\-force\-rgba\-osd\-rendering\fP
Change how some video outputs render the OSD and text subtitles. This
does not change appearance of the subtitles and only has performance
implications. For VOs which support native ASS rendering (like \fBvdpau\fP,
\fBopengl\fP, \fBdirect3d\fP), this can be slightly faster or slower,
depending on GPU drivers and hardware. For other VOs, this just makes
rendering slower.
.TP
.B \fB\-\-force\-window\-position\fP
Forcefully move mpv\(aqs video output window to default location whenever
there is a change in video parameters, video stream or file. This used to
be the default behavior. Currently only affects X11 VOs.
.TP
.B \fB\-\-fs\-missioncontrol\fP
(OS X only)
Use OS X Mission Control\(aqs fullscreen feature instead of the custom one
provided by mpv. This can potentially break a lot of stuff like
\fB\-\-geometry\fP and is disabled by default. On the other hand it provides
a more \(aqOS X\-like\(aq user experience.
.TP
.B \fB\-\-heartbeat\-cmd=<command>\fP
Command that is executed every 30 seconds during playback via \fIsystem()\fP \-
i.e. using the shell. The time between the commands can be customized with
the \fB\-\-heartbeat\-interval\fP option. The command is not run while playback
is paused.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
mpv uses this command without any checking. It is your responsibility to
ensure it does not cause security problems (e.g. make sure to use full
paths if "." is in your path like on Windows). It also only works when
playing video (i.e. not with \fB\-\-no\-video\fP but works with
\fB\-vo=null\fP).
.UNINDENT
.UNINDENT
.sp
This can be "misused" to disable screensavers that do not support the
proper X API (see also \fB\-\-stop\-screensaver\fP). If you think this is too
complicated, ask the author of the screensaver program to support the
proper X APIs. Note that the \fB\-\-stop\-screensaver\fP does not influence the
heartbeat code at all.
.INDENT 7.0
.INDENT 3.5
.IP "Example for xscreensaver"
.sp
\fBmpv \-\-heartbeat\-cmd="xscreensaver\-command \-deactivate" file\fP
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Example for GNOME screensaver"
.sp
\fBmpv \-\-heartbeat\-cmd="gnome\-screensaver\-command \-p" file\fP
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-heartbeat\-interval=<sec>\fP
Time between \fB\-\-heartbeat\-cmd\fP invocations in seconds (default: 30).
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This does not affect the normal screensaver operation in any way.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-no\-keepaspect\fP, \fB\-\-keepaspect\fP
\fB\-\-no\-keepaspect\fP will always stretch the video to window size, and will
disable the window manager hints that force the window aspect ratio.
(Ignored in fullscreen mode.)
.TP
.B \fB\-\-monitoraspect=<ratio>\fP
Set the aspect ratio of your monitor or TV screen. A value of 0 disables a
previous setting (e.g. in the config file). Overrides the
\fB\-\-monitorpixelaspect\fP setting if enabled.
.sp
See also \fB\-\-monitorpixelaspect\fP and \fB\-\-video\-aspect\fP\&.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.IP \(bu 2
\fB\-\-monitoraspect=4:3\fP  or \fB\-\-monitoraspect=1.3333\fP
.IP \(bu 2
\fB\-\-monitoraspect=16:9\fP or \fB\-\-monitoraspect=1.7777\fP
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-monitorpixelaspect=<ratio>\fP
Set the aspect of a single pixel of your monitor or TV screen (default:
1). A value of 1 means square pixels (correct for (almost?) all LCDs). See
also \fB\-\-monitoraspect\fP and \fB\-\-video\-aspect\fP\&.
.TP
.B \fB\-\-stop\-screensaver\fP, \fB\-\-no\-stop\-screensaver\fP
Turns off the screensaver (or screen blanker and similar mechanisms) at
startup and turns it on again on exit (default: yes). The screensaver is
always re\-enabled when the player is paused.
.sp
This is not supported on all video outputs or platforms. Sometimes it is
implemented, but does not work (happens often on GNOME). You might be able
to to work this around using \fB\-\-heartbeat\-cmd\fP instead.
.TP
.B \fB\-\-wid=<ID>\fP
(X11 and Windows only)
This tells mpv to attach to an existing window. The ID is interpreted as
"Window" on X11, and as HWND on Windows. If a VO is selected that supports
this option, a new window will be created and the given window will be set
as parent. The window will always be resized to cover the parent window
fully, and will add black bars to compensate for the video aspect ratio.
.sp
See also \fB\-\-slave\-broken\fP\&.
.TP
.B \fB\-\-no\-window\-dragging\fP
Don\(aqt move the window when clicking on it and moving the mouse pointer.
.TP
.B \fB\-\-x11\-name\fP
Set the window class name for X11\-based video output methods.
.TP
.B \fB\-\-x11\-netwm=no\fP
(X11 only)
Disable use of the NetWM protocol when switching to or from fullscreen.
This may or may not help with broken window managers. This provides some
functionality that was implemented by the now removed \fB\-\-fstype\fP option.
Actually, it is not known to the developers to which degree this option
was needed, so feedback is welcome.
.sp
By default, NetWM support is autodetected, and using this option forces
autodetection to fail.
.UNINDENT
.SS Disc Devices
.INDENT 0.0
.TP
.B \fB\-\-cdrom\-device=<path>\fP
Specify the CD\-ROM device (default: \fB/dev/cdrom\fP).
.TP
.B \fB\-\-dvd\-device=<path>\fP
Specify the DVD device or .iso filename (default: \fB/dev/dvd\fP). You can
also specify a directory that contains files previously copied directly
from a DVD (with e.g. vobcopy).
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.sp
\fBmpv dvd:// \-\-dvd\-device=/path/to/dvd/\fP
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-bluray\-device=<path>\fP
(Blu\-ray only)
Specify the Blu\-ray disc location. Must be a directory with Blu\-ray
structure.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.sp
\fBmpv bd:// \-\-bluray\-device=/path/to/bd/\fP
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-bluray\-angle=<ID>\fP
Some Blu\-ray discs contain scenes that can be viewed from multiple angles.
This option tells mpv which angle to use (default: 1).
.TP
.B \fB\-\-cdda\-...\fP
These options can be used to tune the CD Audio reading feature of mpv.
.TP
.B \fB\-\-cdda\-speed=<value>\fP
Set CD spin speed.
.TP
.B \fB\-\-cdda\-paranoia=<0\-2>\fP
Set paranoia level. Values other than 0 seem to break playback of
anything but the first track.
.INDENT 7.0
.TP
.B 0
disable checking (default)
.TP
.B 1
overlap checking only
.TP
.B 2
full data correction and verification
.UNINDENT
.TP
.B \fB\-\-cdda\-sector\-size=<value>\fP
Set atomic read size.
.TP
.B \fB\-\-cdda\-overlap=<value>\fP
Force minimum overlap search during verification to <value> sectors.
.TP
.B \fB\-\-cdda\-toc\-bias\fP
Assume that the beginning offset of track 1 as reported in the TOC
will be addressed as LBA 0. Some discs need this for getting track
boundaries correctly.
.TP
.B \fB\-\-cdda\-toc\-offset=<value>\fP
Add \fB<value>\fP sectors to the values reported when addressing tracks.
May be negative.
.TP
.B \fB\-\-cdda\-skip=<es|no\fP
(Never) accept imperfect data reconstruction.
.TP
.B \fB\-\-dvd\-speed=<speed>\fP
Try to limit DVD speed (default: 0, no change). DVD base speed is 1385
kB/s, so an 8x drive can read at speeds up to 11080 kB/s. Slower speeds
make the drive more quiet. For watching DVDs, 2700 kB/s should be quiet and
fast enough. mpv resets the speed to the drive default value on close.
Values of at least 100 mean speed in kB/s. Values less than 100 mean
multiples of 1385 kB/s, i.e. \fB\-\-dvd\-speed=8\fP selects 11080 kB/s.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
You need write access to the DVD device to change the speed.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-dvd\-angle=<ID>\fP
Some DVDs contain scenes that can be viewed from multiple angles.
This option tells mpv which angle to use (default: 1).
.UNINDENT
.SS Equalizer
.INDENT 0.0
.TP
.B \fB\-\-brightness=<\-100\-100>\fP
Adjust the brightness of the video signal (default: 0). Not supported by
all video output drivers.
.TP
.B \fB\-\-contrast=<\-100\-100>\fP
Adjust the contrast of the video signal (default: 0). Not supported by all
video output drivers.
.TP
.B \fB\-\-saturation=<\-100\-100>\fP
Adjust the saturation of the video signal (default: 0). You can get
grayscale output with this option. Not supported by all video output
drivers.
.TP
.B \fB\-\-gamma=<\-100\-100>\fP
Adjust the gamma of the video signal (default: 0). Not supported by all
video output drivers.
.TP
.B \fB\-\-hue=<\-100\-100>\fP
Adjust the hue of the video signal (default: 0). You can get a colored
negative of the image with this option. Not supported by all video output
drivers.
.TP
.B \fB\-\-colormatrix=<colorspace>\fP
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.
.sp
The color space conversion is additionally influenced by the related
options \-\-colormatrix\-input\-range and \-\-colormatrix\-output\-range.
.sp
These options are not always supported. Different video outputs provide
varying degrees of support. The \fBopengl\fP and \fBvdpau\fP video output
drivers usually offer full support. The \fBxv\fP output can set the color
space if the system video driver supports it, but not input and output
levels. The \fBscale\fP 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 \fB\-vf scale,format=rgba\fP).
.sp
If this option is set to \fBauto\fP (which is the default), the video\(aqs
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.
.sp
Available color spaces are:
.INDENT 7.0
.TP
.B auto
automatic selection (default)
.TP
.B BT.601
ITU\-R BT.601 (SD)
.TP
.B BT.709
ITU\-R BT.709 (HD)
.TP
.B BT.2020\-NCL
ITU\-R BT.2020 non\-constant luminance system
.TP
.B BT.2020\-CL
ITU\-R BT.2020 constant luminance system
.TP
.B SMPTE\-240M
SMPTE\-240M
.UNINDENT
.TP
.B \fB\-\-colormatrix\-input\-range=<color\-range>\fP
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.
.sp
The same limitations as with \-\-colormatrix apply.
.sp
Available color ranges are:
.INDENT 7.0
.TP
.B auto
automatic selection (normally limited range) (default)
.TP
.B limited
limited range (16\-235 for luma, 16\-240 for chroma)
.TP
.B full
full range (0\-255 for both luma and chroma)
.UNINDENT
.TP
.B \fB\-\-colormatrix\-output\-range=<color\-range>\fP
RGB color levels used with YUV to RGB conversion. Normally, output devices
such as PC monitors use full range color levels. However, some TVs and
video monitors expect studio RGB levels. Providing full range output to a
device expecting studio level input results in crushed blacks and whites,
the reverse in dim gray blacks and dim whites.
.sp
The same limitations as with \fB\-\-colormatrix\fP apply.
.sp
Available color ranges are:
.INDENT 7.0
.TP
.B auto
automatic selection (equals to full range) (default)
.TP
.B limited
limited range (16\-235 per component), studio levels
.TP
.B full
full range (0\-255 per component), PC levels
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
It is advisable to use your graphics driver\(aqs color range option
instead, if available.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-colormatrix\-primaries=<primaries>\fP
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. By default, when unset, BT.709 is used for
all files except those tagged with a BT.2020 color matrix.
.sp
This option only affects video output drivers that perform color
management, for example \fBopengl\fP with the \fBsrgb\fP or \fBicc\-profile\fP
suboptions set.
.sp
If this option is set to \fBauto\fP (which is the default), the video\(aqs
primaries flag will be used. If that flag is unset, the color space will
be selected automatically, using the following heuristics: If the
\fB\-\-colormatrix\fP 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\(aqs exactly 480 or 486 (NTSC),
BT.601\-525 is used. If the video resolution is anything else, BT.709 is
used.
.sp
Available primaries are:
.INDENT 7.0
.TP
.B auto
automatic selection (default)
.TP
.B BT.601\-525
ITU\-R BT.601 (SD) 525\-line systems (NTSC, SMPTE\-C)
.TP
.B BT.601\-625
ITU\-R BT.601 (SD) 625\-line systems (PAL, SECAM)
.TP
.B BT.709
ITU\-R BT.709 (HD) (same primaries as sRGB)
.TP
.B BT.2020
ITU\-R BT.2020 (UHD)
.UNINDENT
.UNINDENT
.SS Demuxer
.INDENT 0.0
.TP
.B \fB\-\-demuxer=<[+]name>\fP
Force demuxer type. Use a \(aq+\(aq before the name to force it; this will skip
some checks. Give the demuxer name as printed by \fB\-\-demuxer=help\fP\&.
.TP
.B \fB\-\-demuxer\-lavf\-analyzeduration=<value>\fP
Maximum length in seconds to analyze the stream properties.
.TP
.B \fB\-\-demuxer\-lavf\-probescore=<1\-100>\fP
Minimum required libavformat probe score. Lower values will require
less data to be loaded (makes streams start faster), but makes file
format detection less reliable. Can be used to force auto\-detected
libavformat demuxers, even if libavformat considers the detection not
reliable enough. (Default: 26.)
.TP
.B \fB\-\-demuxer\-lavf\-allow\-mimetype=<yes|no>\fP
Allow deriving the format from the HTTP MIME type (default: yes). Set
this to no in case playing things from HTTP mysteriously fails, even
though the same files work from local disk.
.sp
This is default in order to reduce latency when opening HTTP streams.
.TP
.B \fB\-\-demuxer\-lavf\-format=<name>\fP
Force a specific libavformat demuxer.
.TP
.B \fB\-\-demuxer\-lavf\-genpts\-mode=<no|lavf>\fP
Mode for deriving missing packet PTS values from packet DTS. \fBlavf\fP
enables libavformat\(aqs \fBgenpts\fP option. \fBno\fP disables it. This used
to be enabled by default, but then it was deemed as not needed anymore.
Enabling this might help with timestamp problems, or make them worse.
.TP
.B \fB\-\-demuxer\-lavf\-o=<key>=<value>[,<key>=<value>[,...]]\fP
Pass AVOptions to libavformat demuxer.
.sp
Note, a patch to make the \fIo=\fP unneeded and pass all unknown options
through the AVOption system is welcome. A full list of AVOptions can
be found in the FFmpeg manual. Note that some options may conflict
with mpv options.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.sp
\fB\-\-demuxer\-lavf\-o=fflags=+ignidx\fP
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-demuxer\-lavf\-probesize=<value>\fP
Maximum amount of data to probe during the detection phase. In the
case of MPEG\-TS this value identifies the maximum number of TS packets
to scan.
.TP
.B \fB\-\-demuxer\-lavf\-buffersize=<value>\fP
Size of the stream read buffer allocated for libavformat in bytes
(default: 32768). Lowering the size could lower latency. Note that
libavformat might reallocate the buffer internally, or not fully use all
of it.
.TP
.B \fB\-\-demuxer\-lavf\-cryptokey=<hexstring>\fP
Encryption key the demuxer should use. This is the raw binary data of
the key converted to a hexadecimal string.
.TP
.B \fB\-\-demuxer\-mkv\-subtitle\-preroll\fP, \fB\-\-mkv\-subtitle\-preroll\fP
Try harder to show embedded soft subtitles when seeking somewhere. Normally,
it can happen that the subtitle at the seek target is not shown due to how
some container file formats are designed. The subtitles appear only if
seeking before or exactly to the position a subtitle first appears. To
make this worse, subtitles are often timed to appear a very small amount
before the associated video frame, so that seeking to the video frame
typically does not demux the subtitle at that position.
.sp
Enabling this option makes the demuxer start reading data a bit before the
seek target, so that subtitles appear correctly. Note that this makes
seeking slower, and is not guaranteed to always work. It only works if the
subtitle is close enough to the seek target.
.sp
Works with the internal Matroska demuxer only. Always enabled for absolute
and hr\-seeks, and this option changes behavior with relative or imprecise
seeks only.
.sp
See also \fB\-\-hr\-seek\-demuxer\-offset\fP option. This option can achieve a
similar effect, but only if hr\-seek is active. It works with any demuxer,
but makes seeking much slower, as it has to decode audio and video data
instead of just skipping over it.
.sp
\fB\-\-mkv\-subtitle\-preroll\fP is a deprecated alias.
.TP
.B \fB\-\-demuxer\-rawaudio\-channels=<value>\fP
Number of channels (or channel layout) if \fB\-\-demuxer=rawaudio\fP is used
(default: stereo).
.TP
.B \fB\-\-demuxer\-rawaudio\-format=<value>\fP
Sample format for \fB\-\-demuxer=rawaudio\fP (default: s16le).
Use \fB\-\-demuxer\-rawaudio\-format=help\fP to get a list of all formats.
.TP
.B \fB\-\-demuxer\-rawaudio\-rate=<value>\fP
Sample rate for \fB\-\-demuxer=rawaudio\fP (default: 44 kHz).
.TP
.B \fB\-\-demuxer\-rawvideo\-fps=<value>\fP
Rate in frames per second for \fB\-\-demuxer=rawvideo\fP (default: 25.0).
.TP
.B \fB\-\-demuxer\-rawvideo\-w=<value>\fP, \fB\-\-demuxer\-rawvideo\-h=<value>\fP
Image dimension in pixels for \fB\-\-demuxer=rawvideo\fP\&.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.sp
Play a raw YUV sample:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mpv sample\-720x576.yuv \-\-demuxer=rawvideo \e
\-\-demuxer\-rawvideo=w=720:h=576
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-demuxer\-rawvideo\-format=<value>\fP
Color space (fourcc) in hex or string for \fB\-\-demuxer=rawvideo\fP
(default: \fBYV12\fP).
.TP
.B \fB\-\-demuxer\-rawvideo\-mp\-format=<value>\fP
Color space by internal video format for \fB\-\-demuxer=rawvideo\fP\&. Use
\fB\-\-demuxer\-rawvideo\-mp\-format=help\fP for a list of possible formats.
.TP
.B \fB\-\-demuxer\-rawvideo\-codec=<value>\fP
Set the video codec instead of selecting the rawvideo codec when using
\fB\-\-demuxer=rawvideo\fP\&. This uses the same values as codec names in
\fB\-\-vd\fP (but it does not accept decoder names).
.TP
.B \fB\-\-demuxer\-rawvideo\-size=<value>\fP
Frame size in bytes when using \fB\-\-demuxer=rawvideo\fP\&.
.TP
.B \fB\-\-demuxer\-thread=<yes|no>\fP
Run the demuxer in a separate thread, and let it prefetch a certain amount
of packets (default: yes). Having this enabled may lead to smoother
playback, but on the other hand can add delays to seeking or track
switching.
.TP
.B \fB\-\-demuxer\-readahead\-secs=N\fP
If \fB\-\-demuxer\-thread\fP is enabled, this controls how much the demuxer
should buffer ahead in seconds (default: 0.2). As long as no packet has
a timestamp difference higher than the readahead amount relative to the
last packet returned to the decoder, the demuxer keeps reading.
.sp
(This value tends to be fuzzy, because many file formats don\(aqt store linear
timestamps.)
.TP
.B \fB\-\-demuxer\-readahead\-packets=N\fP
If \fB\-\-demuxer\-thread\fP is enabled, this controls how much the demuxer
should buffer ahead. As long as the number of packets in the packet queue
doesn\(aqt exceed \fB\-\-demuxer\-readahead\-packets\fP, and the total number of
bytes doesn\(aqt exceed \fB\-\-demuxer\-readahead\-bytes\fP, the thread keeps
reading ahead.
.sp
Note that if you set these options near the maximum, you might get a
packet queue overflow warning.
.sp
See \fB\-\-list\-options\fP for defaults and value range.
.TP
.B \fB\-\-demuxer\-readahead\-bytes=N\fP
See \fB\-\-demuxer\-readahead\-packets\fP\&.
.UNINDENT
.SS Input
.INDENT 0.0
.TP
.B \fB\-\-native\-keyrepeat\fP
Use system settings for keyrepeat delay and rate, instead of
\fB\-\-input\-ar\-delay\fP and \fB\-\-input\-ar\-rate\fP\&. (Whether this applies
depends on the VO backend and how it handles keyboard input. Does not
apply to terminal input.)
.TP
.B \fB\-\-input\-ar\-delay\fP
Delay in milliseconds before we start to autorepeat a key (0 to disable).
.TP
.B \fB\-\-input\-ar\-rate\fP
Number of key presses to generate per second on autorepeat.
.TP
.B \fB\-\-input\-conf=<filename>\fP
Specify input configuration file other than the default location in the mpv
configuration directory (usually \fB~/.config/mpv/input.conf\fP).
.TP
.B \fB\-\-no\-input\-default\-bindings\fP
Disable mpv default (built\-in) key bindings.
.TP
.B \fB\-\-input\-cmdlist\fP
Prints all commands that can be bound to keys.
.TP
.B \fB\-\-input\-doubleclick\-time=<milliseconds>\fP
Time in milliseconds to recognize two consecutive button presses as a
double\-click (default: 300).
.TP
.B \fB\-\-input\-keylist\fP
Prints all keys that can be bound to commands.
.TP
.B \fB\-\-input\-key\-fifo\-size=<2\-65000>\fP
Specify the size of the FIFO that buffers key events (default: 7). If it
is too small some events may be lost. The main disadvantage of setting it
to a very large value is that if you hold down a key triggering some
particularly slow command then the player may be unresponsive while it
processes all the queued commands.
.TP
.B \fB\-\-input\-test\fP
Input test mode. Instead of executing commands on key presses, mpv
will show the keys and the bound commands on the OSD. Has to be used
with a dummy video, and the normal ways to quit the player will not
work (key bindings that normally quit will be shown on OSD only, just
like any other binding). See \fI\%INPUT.CONF\fP\&.
.TP
.B \fB\-\-input\-file=<filename>\fP
Read commands from the given file. Mostly useful with a FIFO.
See also \fB\-\-slave\-broken\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
When the given file is a FIFO mpv opens both ends, so you can do several
\fIecho "seek 10" > mp_pipe\fP and the pipe will stay valid.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-input\-terminal\fP, \fB\-\-no\-input\-terminal\fP
\fB\-\-no\-input\-terminal\fP prevents the player from reading key events from
standard input. Useful when reading data from standard input. This is
automatically enabled when \fB\-\fP is found on the command line. There are
situations where you have to set it manually, e.g. if you open
\fB/dev/stdin\fP (or the equivalent on your system), use stdin in a playlist
or intend to read from stdin later on via the loadfile or loadlist slave
commands.
.TP
.B \fB\-\-input\-appleremote\fP, \fB\-\-no\-input\-appleremote\fP
Enable/disable AppleIR remote support. Enabled by default.
.TP
.B \fB\-\-input\-cursor\fP, \fB\-\-no\-input\-cursor\fP
Permit mpv to receive pointer events reported by the video output
driver. Necessary to use the OSC, or to select the buttons in DVD menus.
Support depends on the VO in use.
.TP
.B \fB\-\-input\-joystick\fP, \fB\-\-no\-input\-joystick\fP
Enable/disable joystick support. Disabled by default.
.TP
.B \fB\-\-input\-js\-dev\fP
Specifies the joystick device to use (default: \fB/dev/input/js0\fP).
.TP
.B \fB\-\-input\-lirc\fP, \fB\-\-no\-input\-lirc\fP
Enable/disable LIRC support. Enabled by default.
.TP
.B \fB\-\-input\-lirc\-conf=<filename>\fP
(LIRC only)
Specifies a configuration file for LIRC (default: \fB~/.lircrc\fP).
.TP
.B \fB\-\-input\-media\-keys\fP, \fB\-\-no\-input\-media\-keys\fP
OS X only: Enabled by default. Enables/disable media keys support.
.TP
.B \fB\-\-input\-right\-alt\-gr\fP, \fB\-\-no\-input\-right\-alt\-gr\fP
(Cocoa and Windows only)
Use the right Alt key as Alt Gr to produce special characters. If disabled,
count the right Alt as an Alt modifier key. Enabled by default.
.TP
.B \fB\-\-input\-x11\-keyboard=<yes|no>\fP
Disable all keyboard input on the X11 VO window. Generally useful for
embedding only.
.sp
On X11, a sub\-window with input enabled grabs all keyboard input as long
as it is 1. a child of a focused window, and 2. the mouse is inside of
the sub\-window. The can steal away all keyboard input from the
application embedding the mpv window, and on the other hand, the mpv
window will receive no input if the mouse is outside of the mpv window,
even though mpv has focus. Modern toolkits work around this weird X11
behavior, but naively embedding foreign windows breaks it.
.sp
The only way to handle this reasonably is using the XEmbed protocol, which
was designed to solve these problems. But Qt has questionable support, and
mpv doesn\(aqt implement it yet.
.sp
As a workaround, this option is disabled by default in libmpv. (Note that
\fBinput\-default\-bindings\fP is disabled by default in libmpv as well.)
.UNINDENT
.SS OSD
.INDENT 0.0
.TP
.B \fB\-\-osc\fP, \fB\-\-no\-osc\fP
Whether to load the on\-screen\-controller (default: yes).
.TP
.B \fB\-\-no\-osd\-bar\fP, \fB\-\-osd\-bar\fP
Disable display of the OSD bar. This will make some things (like seeking)
use OSD text messages instead of the bar.
.sp
You can configure this on a per\-command basis in input.conf using \fBosd\-\fP
prefixes, see \fBInput command prefixes\fP\&. If you want to disable the OSD
completely, use \fB\-\-osd\-level=0\fP\&.
.TP
.B \fB\-\-osd\-duration=<time>\fP
Set the duration of the OSD messages in ms (default: 1000).
.TP
.B \fB\-\-osd\-font=<pattern>\fP, \fB\-\-sub\-text\-font=<pattern>\fP
Specify font to use for OSD and for subtitles that do not themselves
specify a particular font. The default is \fBsans\-serif\fP\&.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.IP \(bu 2
\fB\-\-osd\-font=\(aqBitstream Vera Sans\(aq\fP
.IP \(bu 2
\fB\-\-osd\-font=\(aqBitstream Vera Sans:style=Bold\(aq\fP (fontconfig pattern)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The \fB\-\-sub\-text\-font\fP option (and most other \fB\-\-sub\-text\-\fP
options) are ignored when ASS\-subtitles are rendered, unless the
\fB\-\-no\-sub\-ass\fP option is specified.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-osd\-font\-size=<size>\fP, \fB\-\-sub\-text\-font\-size=<size>\fP
Specify the OSD/sub font size. The unit is the size in scaled pixels at a
window height of 720. The actual pixel size is scaled with the window
height: if the window height is larger or smaller than 720, the actual size
of the text increases or decreases as well.
.sp
Default: 45.
.TP
.B \fB\-\-osd\-msg1=<string>\fP
Show this string as message on OSD with OSD level 1 (visible by default).
The message will be visible by default, and as long no other message
covers it, and the OSD level isn\(aqt changed (see \fB\-\-osd\-level\fP).
Expands properties; see \fI\%Property Expansion\fP\&.
.TP
.B \fB\-\-osd\-msg2=<string>\fP
Similar as \fB\-\-osd\-msg1\fP, but for OSD level 2. If this is an empty string
(default), then the playback time is shown.
.TP
.B \fB\-\-osd\-msg3=<string>\fP
Similar as \fB\-\-osd\-msg1\fP, but for OSD level 3. If this is an empty string
(default), then the playback time, duration, and some more information is
shown.
.sp
This is also used for the \fBshow_progress\fP command (by default mapped to
\fBP\fP), or in some non\-default cases when seeking.
.sp
\fB\-\-osd\-status\-msg\fP is a legacy equivalent (but with a minor difference).
.TP
.B \fB\-\-osd\-status\-msg=<string>\fP
Show a custom string during playback instead of the standard status text.
This overrides the status text used for \fB\-\-osd\-level=3\fP, when using the
\fBshow_progress\fP command (by default mapped to \fBP\fP), or in some
non\-default cases when seeking. Expands properties. See
\fI\%Property Expansion\fP\&.
.sp
This option has been replaced with \fB\-\-osd\-msg3\fP\&. The only difference is
that this option implicitly includes \fB${osd\-sym\-cc}\fP\&. This option is
ignored if \fB\-\-osd\-msg3\fP is not empty.
.TP
.B \fB\-\-osd\-playing\-msg=<string>\fP
Show a message on OSD when playback starts. The string is expanded for
properties, e.g. \fB\-\-osd\-playing\-msg=\(aqfile: ${filename}\(aq\fP will show the
message \fBfile:\fP followed by a space and the currently played filename.
.sp
See \fI\%Property Expansion\fP\&.
.TP
.B \fB\-\-osd\-bar\-align\-x=<\-1\-1>\fP
Position of the OSD bar. \-1 is far left, 0 is centered, 1 is far right.
Fractional values (like 0.5) are allowed.
.TP
.B \fB\-\-osd\-bar\-align\-y=<\-1\-1>\fP
Position of the OSD bar. \-1 is top, 0 is centered, 1 is bottom.
Fractional values (like 0.5) are allowed.
.TP
.B \fB\-\-osd\-bar\-w=<1\-100>\fP
Width of the OSD bar, in percentage of the screen width (default: 75).
A value of 50 means the bar is half the screen wide.
.TP
.B \fB\-\-osd\-bar\-h=<0.1\-50>\fP
Height of the OSD bar, in percentage of the screen height (default: 3.125).
.TP
.B \fB\-\-osd\-back\-color=<color>\fP, \fB\-\-sub\-text\-back\-color=<color>\fP
See \fB\-\-osd\-color\fP\&. Color used for OSD/sub text background.
.TP
.B \fB\-\-osd\-blur=<0..20.0>\fP, \fB\-\-sub\-text\-blur=<0..20.0>\fP
Gaussian blur factor. 0 means no blur applied (default).
.TP
.B \fB\-\-osd\-border\-color=<color>\fP, \fB\-\-sub\-text\-border\-color=<color>\fP
See \fB\-\-osd\-color\fP\&. Color used for the OSD/sub font border.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
ignored when \fB\-\-osd\-back\-color\fP/\fB\-\-sub\-text\-back\-color\fP is
specified (or more exactly: when that option is not set to completely
transparent).
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-osd\-border\-size=<size>\fP, \fB\-\-sub\-text\-border\-size=<size>\fP
Size of the OSD/sub font border in scaled pixels (see \fB\-\-osd\-font\-size\fP
for details). A value of 0 disables borders.
.sp
Default: 2.5.
.TP
.B \fB\-\-osd\-color=<color>\fP, \fB\-\-sub\-text\-color=<color>\fP
Specify the color used for OSD/unstyled text subtitles.
.sp
The color is specified in the form \fBr/g/b\fP, where each color component
is specified as number in the range 0.0 to 1.0. It\(aqs also possible to
specify the transparency by using \fBr/g/b/a\fP, where the alpha value 0
means fully transparent, and 1.0 means opaque. If the alpha component is
not given, the color is 100% opaque.
.sp
Passing a single number to the option sets the OSD to gray, and the form
\fBgray/a\fP lets you specify alpha additionally.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.IP \(bu 2
\fB\-\-osd\-color=1.0/0.0/0.0\fP set OSD to opaque red
.IP \(bu 2
\fB\-\-osd\-color=1.0/0.0/0.0/0.75\fP set OSD to opaque red with 75% alpha
.IP \(bu 2
\fB\-\-osd\-color=0.5/0.75\fP set OSD to 50% gray with 75% alpha
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Alternatively, the color can be specified as a RGB hex triplet in the form
\fB#RRGGBB\fP, where each 2\-digit group expresses a color value in the
range 0 (\fB00\fP) to 255 (\fBFF\fP). For example, \fB#FF0000\fP is red.
This is similar to web colors.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.IP \(bu 2
\fB\-\-osd\-color=\(aq#FF0000\(aq\fP set OSD to opaque red
.IP \(bu 2
\fB\-\-osd\-color=\(aq#C0808080\(aq\fP set OSD to 50% gray with 75% alpha
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-osd\-fractions\fP
Show OSD times with fractions of seconds.
.TP
.B \fB\-\-osd\-level=<0\-3>\fP
Specifies which mode the OSD should start in.
.INDENT 7.0
.TP
.B 0
OSD completely disabled (subtitles only)
.TP
.B 1
enabled (shows up only on user interaction)
.TP
.B 2
enabled + current time visible by default
.TP
.B 3
enabled + \fB\-\-osd\-status\-msg\fP (current time and status by default)
.UNINDENT
.TP
.B \fB\-\-osd\-margin\-x=<size>, \-\-sub\-text\-margin\-x=<size>\fP
Left and right screen margin for the OSD/subs in scaled pixels (see
\fB\-\-osd\-font\-size\fP for details).
.sp
This option specifies the distance of the OSD to the left, as well as at
which distance from the right border long OSD text will be broken.
.sp
Default: 25.
.TP
.B \fB\-\-osd\-margin\-y=<size>, \-\-sub\-text\-margin\-y=<size>\fP
Top and bottom screen margin for the OSD/subs in scaled pixels (see
\fB\-\-osd\-font\-size\fP for details).
.sp
This option specifies the vertical margins of the OSD. This is also used
for unstyled text subtitles. If you just want to raise the vertical
subtitle position, use \fB\-\-sub\-pos\fP\&.
.sp
Default: 10.
.TP
.B \fB\-\-osd\-scale=<factor>\fP
OSD font size multiplier, multiplied with \fB\-\-osd\-font\-size\fP value.
.TP
.B \fB\-\-osd\-scale\-by\-window=yes|no\fP
Whether to scale the OSD with the window size (default: yes). If this is
disabled, \fB\-\-osd\-font\-size\fP and other OSD options that use scaled pixels
are always in actual pixels. The effect is that changing the window size
won\(aqt change the OSD font size.
.TP
.B \fB\-\-osd\-shadow\-color=<color>, \-\-sub\-text\-shadow\-color=<color>\fP
See \fB\-\-osd\-color\fP\&. Color used for OSD/sub text shadow.
.TP
.B \fB\-\-osd\-shadow\-offset=<size>, \-\-sub\-text\-shadow\-offset=<size>\fP
Displacement of the OSD/sub text shadow in scaled pixels (see
\fB\-\-osd\-font\-size\fP for details). A value of 0 disables shadows.
.sp
Default: 0.
.TP
.B \fB\-\-osd\-spacing=<size>, \-\-sub\-text\-spacing=<size>\fP
Horizontal OSD/sub font spacing in scaled pixels (see \fB\-\-osd\-font\-size\fP
for details). This value is added to the normal letter spacing. Negative
values are allowed.
.sp
Default: 0.
.UNINDENT
.SS Screenshot
.INDENT 0.0
.TP
.B \fB\-\-screenshot\-format=<type>\fP
Set the image file type used for saving screenshots.
.sp
Available choices:
.INDENT 7.0
.TP
.B png
PNG
.TP
.B ppm
PPM
.TP
.B pgm
PGM
.TP
.B pgmyuv
PGM with YV12 pixel format
.TP
.B tga
TARGA
.TP
.B jpg
JPEG (default)
.TP
.B jpeg
JPEG (same as jpg, but with .jpeg file ending)
.UNINDENT
.TP
.B \fB\-\-screenshot\-template=<template>\fP
Specify the filename template used to save screenshots. The template
specifies the filename without file extension, and can contain format
specifiers, which will be substituted when taking a screenshot.
By default the template is \fBshot%n\fP, which results in filenames like
\fBshot0012.png\fP for example.
.sp
The template can start with a relative or absolute path, in order to
specify a directory location where screenshots should be saved.
.sp
If the final screenshot filename points to an already existing file, the
file will not be overwritten. The screenshot will either not be saved, or if
the template contains \fB%n\fP, saved using different, newly generated
filename.
.sp
Allowed format specifiers:
.INDENT 7.0
.TP
.B \fB%[#][0X]n\fP
A sequence number, padded with zeros to length X (default: 04). E.g.
passing the format \fB%04n\fP will yield \fB0012\fP on the 12th screenshot.
The number is incremented every time a screenshot is taken or if the
file already exists. The length \fBX\fP must be in the range 0\-9. With
the optional # sign, mpv will use the lowest available number. For
example, if you take three screenshots\-\-0001, 0002, 0003\-\-and delete
the first two, the next two screenshots will not be 0004 and 0005, but
0001 and 0002 again.
.TP
.B \fB%f\fP
Filename of the currently played video.
.TP
.B \fB%F\fP
Same as \fB%f\fP, but strip the file extension, including the dot.
.TP
.B \fB%x\fP
Directory path of the currently played video. If the video is not on
the filesystem (but e.g. \fBhttp://\fP), this expand to an empty string.
.TP
.B \fB%X{fallback}\fP
Same as \fB%x\fP, but if the video file is not on the filesystem, return
the fallback string inside the \fB{...}\fP\&.
.TP
.B \fB%p\fP
Current playback time, in the same format as used in the OSD. The
result is a string of the form "HH:MM:SS". For example, if the video is
at the time position 5 minutes and 34 seconds, \fB%p\fP will be replaced
with "00:05:34".
.TP
.B \fB%P\fP
Similar to \fB%p\fP, but extended with the playback time in milliseconds.
It is formatted as "HH:MM:SS.mmm", with "mmm" being the millisecond
part of the playback time.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is a simple way for getting unique per\-frame timestamps. Frame
numbers would be more intuitive, but are not easily implementable
because container formats usually use time stamps for identifying
frames.)
.UNINDENT
.UNINDENT
.TP
.B \fB%wX\fP
Specify the current playback time using the format string \fBX\fP\&.
\fB%p\fP is like \fB%wH:%wM:%wS\fP, and \fB%P\fP is like \fB%wH:%wM:%wS.%wT\fP\&.
.INDENT 7.0
.TP
.B Valid format specifiers:
.INDENT 7.0
.TP
.B \fB%wH\fP
hour (padded with 0 to two digits)
.TP
.B \fB%wh\fP
hour (not padded)
.TP
.B \fB%wM\fP
minutes (00\-59)
.TP
.B \fB%wm\fP
total minutes (includes hours, unlike \fB%wM\fP)
.TP
.B \fB%wS\fP
seconds (00\-59)
.TP
.B \fB%ws\fP
total seconds (includes hours and minutes)
.TP
.B \fB%wf\fP
like \fB%ws\fP, but as float
.TP
.B \fB%wT\fP
milliseconds (000\-999)
.UNINDENT
.UNINDENT
.TP
.B \fB%tX\fP
Specify the current local date/time using the format \fBX\fP\&. This format
specifier uses the UNIX \fBstrftime()\fP function internally, and inserts
the result of passing "%X" to \fBstrftime\fP\&. For example, \fB%tm\fP will
insert the number of the current month as number. You have to use
multiple \fB%tX\fP specifiers to build a full date/time string.
.TP
.B \fB%{prop[:fallback text]}\fP
Insert the value of the slave property \(aqprop\(aq. E.g. \fB%{filename}\fP is
the same as \fB%f\fP\&. If the property does not exist or is not available,
an error text is inserted, unless a fallback is specified.
.TP
.B \fB%%\fP
Replaced with the \fB%\fP character itself.
.UNINDENT
.TP
.B \fB\-\-screenshot\-jpeg\-quality=<0\-100>\fP
Set the JPEG quality level. Higher means better quality. The default is 90.
.TP
.B \fB\-\-screenshot\-png\-compression=<0\-9>\fP
Set the PNG compression level. Higher means better compression. This will
affect the file size of the written screenshot file and the time it takes
to write a screenshot. Too high compression might occupy enough CPU time to
interrupt playback. The default is 7.
.TP
.B \fB\-\-screenshot\-png\-filter=<0\-5>\fP
Set the filter applied prior to PNG compression. 0 is none, 1 is "sub", 2 is
"up", 3 is "average", 4 is "Paeth", and 5 is "mixed". This affects the level
of compression that can be achieved. For most images, "mixed" achieves the
best compression ratio, hence it is the default.
.UNINDENT
.SS Software Scaler
.INDENT 0.0
.TP
.B \fB\-\-sws\-scaler=<name>\fP
Specify the software scaler algorithm to be used with \fB\-\-vf=scale\fP\&. This
also affects video output drivers which lack hardware acceleration,
e.g. \fBx11\fP\&. See also \fB\-\-vf=scale\fP\&.
.sp
To get a list of available scalers, run \fB\-\-sws\-scaler=help\fP\&.
.sp
Default: \fBbicubic\fP\&.
.TP
.B \fB\-\-sws\-lgb=<0\-100>\fP
Software scaler Gaussian blur filter (luma). See \fB\-\-sws\-scaler\fP\&.
.TP
.B \fB\-\-sws\-cgb=<0\-100>\fP
Software scaler Gaussian blur filter (chroma). See \fB\-\-sws\-scaler\fP\&.
.TP
.B \fB\-\-sws\-ls=<\-100\-100>\fP
Software scaler sharpen filter (luma). See \fB\-\-sws\-scaler\fP\&.
.TP
.B \fB\-\-sws\-cs=<\-100\-100>\fP
Software scaler sharpen filter (chroma). See \fB\-\-sws\-scaler\fP\&.
.TP
.B \fB\-\-sws\-chs=<h>\fP
Software scaler chroma horizontal shifting. See \fB\-\-sws\-scaler\fP\&.
.TP
.B \fB\-\-sws\-cvs=<v>\fP
Software scaler chroma vertical shifting. See \fB\-\-sws\-scaler\fP\&.
.UNINDENT
.SS Terminal
.INDENT 0.0
.TP
.B \fB\-\-quiet\fP
Make console output less verbose; in particular, prevents the status line
(i.e. AV: 3.4 (00:00:03.37) / 5320.6 ...) from being displayed.
Particularly useful on slow terminals or broken ones which do not properly
handle carriage return (i.e. \fB\er\fP).
.sp
Also see \fB\-\-really\-quiet\fP and \fB\-\-msg\-level\fP\&.
.TP
.B \fB\-\-really\-quiet\fP
Display even less output and status messages than with \fB\-\-quiet\fP\&.
.TP
.B \fB\-\-no\-terminal\fP, \fB\-\-terminal\fP
Disable any use of the terminal and stdin/stdout/stderr. This completely
silences any message output.
.sp
Unlike \fB\-\-really\-quiet\fP, this disables input and terminal initialization
as well.
.TP
.B \fB\-\-no\-msg\-color\fP
Disable colorful console output on terminals.
.TP
.B \fB\-\-msg\-level=<module1=level1:module2=level2:...>\fP
Control verbosity directly for each module. The \fBall\fP module changes the
verbosity of all the modules not explicitly specified on the command line.
.sp
Run mpv with \fB\-\-msg\-level=all=trace\fP to see all messages mpv outputs. You
can use the module names printed in the output (prefixed to each line in
\fB[...]\fP) to limit the output to interesting modules.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Some messages are printed before the command line is parsed and are
therefore not affected by \fB\-\-msg\-level\fP\&. To control these messages,
you have to use the \fBMPV_VERBOSE\fP environment variable; see
\fI\%ENVIRONMENT VARIABLES\fP for details.
.UNINDENT
.UNINDENT
.sp
Available levels:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B no
complete silence
.TP
.B fatal
fatal messages only
.TP
.B error
error messages
.TP
.B warn
warning messages
.TP
.B info
informational messages
.TP
.B status
status messages (default)
.TP
.B v
verbose messages
.TP
.B debug
debug messages
.TP
.B trace
very noisy debug messages
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-term\-osd, \-\-no\-term\-osd\fP, \fB\-\-term\-osd=force\fP
Display OSD messages on the console when no video output is available.
Enabled by default.
.sp
\fBforce\fP enables terminal OSD even if a video window is created.
.TP
.B \fB\-\-term\-osd\-bar\fP, \fB\-\-no\-term\-osd\-bar\fP
Enable printing a progress bar under the status line on the terminal.
(Disabled by default.)
.TP
.B \fB\-\-term\-osd\-bar\-chars=<string>\fP
Customize the \fB\-\-term\-osd\-bar\fP feature. The string is expected to
consist of 5 characters (start, left space, position indicator,
right space, end). You can use Unicode characters, but note that double\-
width characters will not be treated correctly.
.sp
Default: \fB[\-+\-]\fP\&.
.TP
.B \fB\-\-term\-playing\-msg=<string>\fP
Print out a string after starting playback. The string is expanded for
properties, e.g. \fB\-\-term\-playing\-msg=\(aqfile: ${filename}\(aq\fP will print the string
\fBfile:\fP followed by a space and the currently played filename.
.sp
See \fI\%Property Expansion\fP\&.
.TP
.B \fB\-\-term\-status\-msg=<string>\fP
Print out a custom string during playback instead of the standard status
line. Expands properties. See \fI\%Property Expansion\fP\&.
.TP
.B \fB\-\-msg\-module\fP
Prepend module name to each console message.
.TP
.B \fB\-\-msg\-time\fP
Prepend timing information to each console message.
.UNINDENT
.SS TV
.INDENT 0.0
.TP
.B \fB\-\-tv\-...\fP
These options tune various properties of the TV capture module. For
watching TV with mpv, use \fBtv://\fP or \fBtv://<channel_number>\fP or
even \fBtv://<channel_name>\fP (see option \fBtv\-channels\fP for \fBchannel_name\fP
below) as a media URL. You can also use \fBtv:///<input_id>\fP to start
watching a video from a composite or S\-Video input (see option \fBinput\fP for
details).
.TP
.B \fB\-\-tv\-device=<value>\fP
Specify TV device (default: \fB/dev/video0\fP).
.TP
.B \fB\-\-tv\-channel=<value>\fP
Set tuner to <value> channel.
.TP
.B \fB\-\-no\-tv\-audio\fP
no sound
.TP
.B \fB\-\-tv\-automute=<0\-255> (v4l and v4l2 only)\fP
If signal strength reported by device is less than this value, audio
and video will be muted. In most cases automute=100 will be enough.
Default is 0 (automute disabled).
.TP
.B \fB\-\-tv\-driver=<value>\fP
See \fB\-\-tv=driver=help\fP for a list of compiled\-in TV input drivers.
available: dummy, v4l2 (default: autodetect)
.TP
.B \fB\-\-tv\-input=<value>\fP
Specify input (default: 0 (TV), see console output for available
inputs).
.TP
.B \fB\-\-tv\-freq=<value>\fP
Specify the frequency to set the tuner to (e.g. 511.250). Not
compatible with the channels parameter.
.TP
.B \fB\-\-tv\-outfmt=<value>\fP
Specify the output format of the tuner with a preset value supported
by the V4L driver (YV12, UYVY, YUY2, I420) or an arbitrary format given
as hex value.
.TP
.B \fB\-\-tv\-width=<value>\fP
output window width
.TP
.B \fB\-\-tv\-height=<value>\fP
output window height
.TP
.B \fB\-\-tv\-fps=<value>\fP
framerate at which to capture video (frames per second)
.TP
.B \fB\-\-tv\-buffersize=<value>\fP
maximum size of the capture buffer in megabytes (default: dynamical)
.TP
.B \fB\-\-tv\-norm=<value>\fP
See the console output for a list of all available norms, also see the
\fBnormid\fP option below.
.TP
.B \fB\-\-tv\-normid=<value> (v4l2 only)\fP
Sets the TV norm to the given numeric ID. The TV norm depends on the
capture card. See the console output for a list of available TV norms.
.TP
.B \fB\-\-tv\-chanlist=<value>\fP
available: argentina, australia, china\-bcast, europe\-east,
europe\-west, france, ireland, italy, japan\-bcast, japan\-cable,
newzealand, russia, southafrica, us\-bcast, us\-cable, us\-cable\-hrc
.TP
.B \fB\-\-tv\-channels=<chan>\-<name>[=<norm>],<chan>\-<name>[=<norm>],...\fP
Set names for channels.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If <chan> is an integer greater than 1000, it will be treated as
frequency (in kHz) rather than channel name from frequency table.
Use _ for spaces in names (or play with quoting ;\-) ). The channel
names will then be written using OSD, and the slave commands
\fBtv_step_channel\fP, \fBtv_set_channel\fP and \fBtv_last_channel\fP
will be usable for a remote control (see LIRC). Not compatible with
the \fBfrequency\fP parameter.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
The channel number will then be the position in the \(aqchannels\(aq
list, beginning with 1.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.sp
\fBtv://1\fP, \fBtv://TV1\fP, \fBtv_set_channel 1\fP,
\fBtv_set_channel TV1\fP
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-tv\-[brightness|contrast|hue|saturation]=<\-100\-100>\fP
Set the image equalizer on the card.
.TP
.B \fB\-\-tv\-audiorate=<value>\fP
Set input audio sample rate.
.TP
.B \fB\-\-tv\-forceaudio\fP
Capture audio even if there are no audio sources reported by v4l.
.TP
.B \fB\-\-tv\-alsa\fP
Capture from ALSA.
.TP
.B \fB\-\-tv\-amode=<0\-3>\fP
Choose an audio mode:
.INDENT 7.0
.TP
.B 0
mono
.TP
.B 1
stereo
.TP
.B 2
language 1
.TP
.B 3
language 2
.UNINDENT
.TP
.B \fB\-\-tv\-forcechan=<1\-2>\fP
By default, the count of recorded audio channels is determined
automatically by querying the audio mode from the TV card. This option
allows forcing stereo/mono recording regardless of the amode option
and the values returned by v4l. This can be used for troubleshooting
when the TV card is unable to report the current audio mode.
.TP
.B \fB\-\-tv\-adevice=<value>\fP
Set an audio device. <value> should be \fB/dev/xxx\fP for OSS and a
hardware ID for ALSA. You must replace any \(aq:\(aq by a \(aq.\(aq in the
hardware ID for ALSA.
.TP
.B \fB\-\-tv\-audioid=<value>\fP
Choose an audio output of the capture card, if it has more than one.
.TP
.B \fB\-\-tv\-[volume|bass|treble|balance]=<0\-100>\fP
These options set parameters of the mixer on the video capture card.
They will have no effect, if your card does not have one. For v4l2 50
maps to the default value of the control, as reported by the driver.
.TP
.B \fB\-\-tv\-gain=<0\-100>\fP
Set gain control for video devices (usually webcams) to the desired
value and switch off automatic control. A value of 0 enables automatic
control. If this option is omitted, gain control will not be modified.
.TP
.B \fB\-\-tv\-immediatemode=<bool>\fP
A value of 0 means capture and buffer audio and video together. A
value of 1 (default) means to do video capture only and let the audio
go through a loopback cable from the TV card to the sound card.
.TP
.B \fB\-\-tv\-mjpeg\fP
Use hardware MJPEG compression (if the card supports it). When using
this option, you do not need to specify the width and height of the
output window, because mpv will determine it automatically from
the decimation value (see below).
.TP
.B \fB\-\-tv\-decimation=<1|2|4>\fP
choose the size of the picture that will be compressed by hardware
MJPEG compression:
.INDENT 7.0
.TP
.B 1
full size
.INDENT 7.0
.IP \(bu 2
704x576 PAL
.IP \(bu 2
704x480 NTSC
.UNINDENT
.TP
.B 2
medium size
.INDENT 7.0
.IP \(bu 2
352x288 PAL
.IP \(bu 2
352x240 NTSC
.UNINDENT
.TP
.B 4
small size
.INDENT 7.0
.IP \(bu 2
176x144 PAL
.IP \(bu 2
176x120 NTSC
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-tv\-quality=<0\-100>\fP
Choose the quality of the JPEG compression (< 60 recommended for full
size).
.TP
.B \fB\-\-tv\-scan\-autostart\fP
Begin channel scanning immediately after startup (default: disabled).
.TP
.B \fB\-\-tv\-scan\-period=<0.1\-2.0>\fP
Specify delay in seconds before switching to next channel (default:
0.5). Lower values will cause faster scanning, but can detect inactive
TV channels as active.
.TP
.B \fB\-\-tv\-scan\-threshold=<1\-100>\fP
Threshold value for the signal strength (in percent), as reported by
the device (default: 50). A signal strength higher than this value will
indicate that the currently scanning channel is active.
.UNINDENT
.SS Cache
.INDENT 0.0
.TP
.B \fB\-\-cache=<kBytes|no|auto>\fP
Set the size of the cache in kilobytes, disable it with \fBno\fP, or
automatically enable it if needed with \fBauto\fP (default: \fBauto\fP).
With \fBauto\fP, the cache will usually be enabled for network streams,
using the size set by \fB\-\-cache\-default\fP\&.
.sp
May be useful when playing files from slow media, but can also have
negative effects, especially with file formats that require a lot of
seeking, such as MP4.
.sp
Note that half the cache size will be used to allow fast seeking back. This
is also the reason why a full cache is usually reported as 50% full. The
cache fill display does not include the part of the cache reserved for
seeking back. Likewise, when starting a file the cache will be at 100%,
because no space is reserved for seeking back yet.
.TP
.B \fB\-\-cache\-default=<kBytes|no>\fP
Set the size of the cache in kilobytes (default: 25000 KB). Using \fBno\fP
will not automatically enable the cache e.g. when playing from a network
stream. Note that using \fB\-\-cache\fP will always override this option.
.TP
.B \fB\-\-cache\-initial=<kBytes>\fP
Playback will start when the cache has been filled up with this many
kilobytes of data (default: 0).
.TP
.B \fB\-\-cache\-seek\-min=<kBytes>\fP
If a seek is to be made to a position within \fB<kBytes>\fP of the cache
size from the current position, mpv will wait for the cache to be
filled to this position rather than performing a stream seek (default:
500).
.sp
This matters for small forward seeks. With slow streams (especially HTTP
streams) there is a tradeoff between skipping the data between current
position and seek destination, or performing an actual seek. Depending
on the situation, either of these might be slower than the other method.
This option allows control over this.
.TP
.B \fB\-\-cache\-file=<TMP|path>\fP
Create a cache file on the filesystem.
.sp
There are two ways of using this:
.INDENT 7.0
.IP 1. 3
Passing a path (a filename). The file will always be overwritten. When
the general cache is enabled, this file cache will be used to store
whatever is read from the source stream.
.sp
This will always overwrite the cache file, and you can\(aqt use an existing
cache file to resume playback of a stream. (Technically, mpv wouldn\(aqt
even know which blocks in the file are valid and which not.)
.sp
The resulting file will not necessarily contain all data of the source
stream. For example, if you seek, the parts that were skipped over are
never read and consequently are not written to the cache. The skipped over
parts are filled with zeros. This means that the cache file doesn\(aqt
necessarily correspond to a full download of the source stream.
.sp
Both of these issues could be improved if there is any user interest.
.sp
\fBWARNING:\fP
.INDENT 3.0
.INDENT 3.5
Causes random corruption when used with ordered chapters or
with \fB\-\-audio\-file\fP\&.
.UNINDENT
.UNINDENT
.IP 2. 3
Passing the string \fBTMP\fP\&. This will not be interpreted as filename.
Instead, an invisible temporary file is created. It depends on your
C library where this file is created (usually \fB/tmp/\fP), and whether
filename is visible (the \fBtmpfile()\fP function is used). On some
systems, automatic deletion of the cache file might not be guaranteed.
.sp
If you want to use a file cache, this mode is recommended, because it
doesn\(aqt break ordered chapters or \fB\-\-audio\-file\fP\&. These modes open
multiple cache streams, and using the same file for them obviously
clashes.
.UNINDENT
.sp
Also see \fB\-\-cache\-file\-size\fP\&.
.TP
.B \fB\-\-cache\-file\-size=<kBytes>\fP
Maximum size of the file created with \fB\-\-cache\-file\fP\&. For read accesses
above this size, the cache is simply not used.
.sp
Keep in mind that some use\-cases, like playing ordered chapters with cache
enabled, will actually create multiple cache files, each of which will
use up to this much disk space.
.sp
(Default: 1048576, 1 GB.)
.TP
.B \fB\-\-no\-cache\fP
Turn off input stream caching. See \fB\-\-cache\fP\&.
.TP
.B \fB\-\-cache\-secs=<seconds>\fP
How many seconds of audio/video to prefetch if the cache is active. This
overrides the \fB\-\-demuxer\-readahead\-secs\fP option if and only if the cache
is enabled. (Default: 2.)
.TP
.B \fB\-\-cache\-pause\fP, \fB\-\-no\-cache\-pause\fP
Whether the player should automatically pause when the cache runs low,
and unpause once more data is available ("buffering").
.UNINDENT
.SS Network
.INDENT 0.0
.TP
.B \fB\-\-user\-agent=<string>\fP
Use \fB<string>\fP as user agent for HTTP streaming.
.TP
.B \fB\-\-cookies\fP, \fB\-\-no\-cookies\fP
Support cookies when making HTTP requests. Disabled by default.
.TP
.B \fB\-\-cookies\-file=<filename>\fP
Read HTTP cookies from <filename>. The file is assumed to be in Netscape
format.
.TP
.B \fB\-\-http\-header\-fields=<field1,field2>\fP
Set custom HTTP fields when accessing HTTP stream.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mpv \-\-http\-header\-fields=\(aqField1: value1\(aq,\(aqField2: value2\(aq \e
http://localhost:1234
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Will generate HTTP request:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
GET / HTTP/1.0
Host: localhost:1234
User\-Agent: MPlayer
Icy\-MetaData: 1
Field1: value1
Field2: value2
Connection: close
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-tls\-ca\-file=<filename>\fP
Certificate authority database file for use with TLS. (Silently fails with
older FFmpeg or Libav versions.)
.TP
.B \fB\-\-tls\-verify\fP
Verify peer certificates when using TLS (e.g. with \fBhttps://...\fP).
(Silently fails with older FFmpeg or Libav versions.)
.TP
.B \fB\-\-referrer=<string>\fP
Specify a referrer path or URL for HTTP requests.
.TP
.B \fB\-\-rtsp\-transport=<lavf|udp|tcp|http>\fP
Select RTSP transport method (default: tcp). This selects the underlying
network transport when playing \fBrtsp://...\fP URLs. The value \fBlavf\fP
leaves the decision to libavformat.
.TP
.B \fB\-\-hls\-bitrate=<no|min|max>\fP
If HLS streams are played, this option controls what streams are selected
by default. The option allows the following parameters:
.INDENT 7.0
.TP
.B no
Don\(aqt do anything special. Typically, this will simply pick the
first audio/video streams it can find. (Default.)
.TP
.B min
Pick the streams with the lowest bitrate.
.TP
.B max
Same, but highest bitrate.
.UNINDENT
.sp
The bitrate as used is sent by the server, and there\(aqs no guarantee it\(aqs
actually meaningful.
.UNINDENT
.SS DVB
.INDENT 0.0
.TP
.B \fB\-\-dvbin\-card=<1\-4>\fP
Specifies using card number 1\-4 (default: 1).
.TP
.B \fB\-\-dvbin\-file=<filename>\fP
Instructs mpv to read the channels list from \fB<filename>\fP\&. The default is
in the mpv configuration directory (usually \fB~/.config/mpv\fP) with the
filename \fBchannels.conf.{sat,ter,cbl,atsc}\fP (based on your card type) or
\fBchannels.conf\fP as a last resort.
.TP
.B \fB\-\-dvbin\-timeout=<1\-30>\fP
Maximum number of seconds to wait when trying to tune a frequency before
giving up (default: 30).
.UNINDENT
.SS PVR
.INDENT 0.0
.TP
.B \fB\-\-pvr\-...\fP
These options tune various encoding properties of the PVR capture module.
It has to be used with any hardware MPEG encoder based card supported by
the V4L2 driver. The Hauppauge WinTV PVR\-150/250/350/500 and all IVTV
based cards are known as PVR capture cards. Be aware that only Linux
2.6.18 kernel and above is able to handle MPEG stream through V4L2 layer.
For hardware capture of an MPEG stream and watching it with mpv, use
\fBpvr://\fP as media URL.
.TP
.B \fB\-\-pvr\-aspect=<0\-3>\fP
Specify input aspect ratio:
.INDENT 7.0
.TP
.B 0
1:1
.TP
.B 1
4:3 (default)
.TP
.B 2
16:9
.TP
.B 3
2.21:1
.UNINDENT
.TP
.B \fB\-\-pvr\-arate=<32000\-48000>\fP
Specify encoding audio rate (default: 48000 Hz, available: 32000,
44100 and 48000 Hz).
.TP
.B \fB\-\-pvr\-alayer=<1\-3>\fP
Specify MPEG audio layer encoding (default: 2).
.TP
.B \fB\-\-pvr\-abitrate=<32\-448>\fP
Specify audio encoding bitrate in kbps (default: 384).
.TP
.B \fB\-\-pvr\-amode=<value>\fP
Specify audio encoding mode. Available preset values are \(aqstereo\(aq,
\(aqjoint_stereo\(aq, \(aqdual\(aq and \(aqmono\(aq (default: stereo).
.TP
.B \fB\-\-pvr\-vbitrate=<value>\fP
Specify average video bitrate encoding in Mbps (default: 6).
.TP
.B \fB\-\-pvr\-vmode=<value>\fP
Specify video encoding mode:
.INDENT 7.0
.TP
.B vbr
Variable Bit Rate (default)
.TP
.B cbr
Constant Bit Rate
.UNINDENT
.TP
.B \fB\-\-pvr\-vpeak=<value>\fP
Specify peak video bitrate encoding in Mbps (only useful for VBR
encoding, default: 9.6).
.TP
.B \fB\-\-pvr\-fmt=<value>\fP
Choose an MPEG format for encoding:
.INDENT 7.0
.TP
.B ps
MPEG\-2 Program Stream (default)
.TP
.B ts
MPEG\-2 Transport Stream
.TP
.B mpeg1
MPEG\-1 System Stream
.TP
.B vcd
Video CD compatible stream
.TP
.B svcd
Super Video CD compatible stream
.TP
.B dvd
DVD compatible stream
.UNINDENT
.UNINDENT
.SS Miscellaneous
.INDENT 0.0
.TP
.B \fB\-\-mc=<seconds/frame>\fP
Maximum A\-V sync correction per frame (in seconds)
.TP
.B \fB\-\-mf\-fps=<value>\fP
Framerate used when decoding from multiple PNG or JPEG files with \fBmf://\fP
(default: 1).
.TP
.B \fB\-\-mf\-type=<value>\fP
Input file type for \fBmf://\fP (available: jpeg, png, tga, sgi). By default,
this is guessed from the file extension.
.TP
.B \fB\-\-stream\-capture=<filename>\fP
Allows capturing the primary stream (not additional audio tracks or other
kind of streams) into the given file. Capturing can also be started and
stopped by changing the filename with the \fBstream\-capture\fP slave property.
Generally this will not produce usable results for anything else than MPEG
or raw streams, unless capturing includes the file headers and is not
interrupted. Note that, due to cache latencies, captured data may begin and
end somewhat delayed compared to what you see displayed.
.TP
.B \fB\-\-stream\-dump=<filename>\fP
Same as \fB\-\-stream\-capture\fP, but do not start playback. Instead, the entire
file is dumped.
.TP
.B \fB\-\-stream\-lavf\-o=opt1=value1,opt2=value2,...\fP
Set AVOptions on streams opened with libavformat. Unknown or misspelled
options are silently ignored. (They are mentioned in the terminal output
in verbose mode, i.e. \fB\-\-v\fP\&. In general we can\(aqt print errors, because
other options such as e.g. user agent are not available with all protocols,
and printing errors for unknown options would end up being too noisy.)
.TP
.B \fB\-\-priority=<prio>\fP
(Windows only.)
Set process priority for mpv according to the predefined priorities
available under Windows.
.sp
Possible values of \fB<prio>\fP:
idle|belownormal|normal|abovenormal|high|realtime
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Using realtime priority can cause system lockup.
.UNINDENT
.UNINDENT
.TP
.B \fB\-\-pts\-association\-mode=<decode|sort|auto>\fP
Select the method used to determine which container packet timestamp
corresponds to a particular output frame from the video decoder. Normally
you should not need to change this option.
.INDENT 7.0
.TP
.B decoder
Use decoder reordering functionality. Unlike in classic MPlayer
and mplayer2, this includes a dTS fallback. (Default.)
.TP
.B sort
Maintain a buffer of unused pts values and use the lowest value
for the frame.
.TP
.B auto
Try to pick a working mode from the ones above automatically.
.UNINDENT
.sp
You can also try to use \fB\-\-no\-correct\-pts\fP for files with completely
broken timestamps.
.TP
.B \fB\-\-media\-title=<string>\fP
Force the contents of the \fBmedia\-title\fP property to this value. Useful
for scripts which want to set a title, without overriding the user\(aqs
setting in \fB\-\-title\fP\&.
.TP
.B \fB\-\-slave\-broken\fP
Switches on the old slave mode. This is for testing only, and incompatible
to the removed \fB\-\-slave\fP switch.
.sp
\fBATTENTION!:\fP
.INDENT 7.0
.INDENT 3.5
Changes incompatible to slave mode applications have been made. In
particular, the status line output was changed, which is used by some
applications to determine the current playback position. This switch
has been renamed to prevent these applications from working with this
version of mpv, because it would lead to buggy and confusing behavior
only. Moreover, the slave mode protocol is so horribly bad that it
should not be used for new programs, nor should existing programs
attempt to adapt to the changed output and use the \fB\-\-slave\-broken\fP
switch. Instead, a new, saner protocol should be developed (and will be,
if there is enough interest).
.sp
This affects most third\-party GUI frontends.
.UNINDENT
.UNINDENT
.UNINDENT
.SH AUDIO OUTPUT DRIVERS
.sp
Audio output drivers are interfaces to different audio output facilities. The
syntax is:
.INDENT 0.0
.TP
.B \fB\-\-ao=<driver1[:suboption1[=value]:...],driver2,...[,]>\fP
Specify a priority list of audio output drivers to be used.
.UNINDENT
.sp
If the list has a trailing \(aq,\(aq, mpv will fall back on drivers not contained
in the list. Suboptions are optional and can mostly be omitted.
.sp
You can also set defaults for each driver. The defaults are applied before the
normal driver parameters.
.INDENT 0.0
.TP
.B \fB\-\-ao\-defaults=<driver1[:parameter1:parameter2:...],driver2,...>\fP
Set defaults for each driver.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
See \fB\-\-ao=help\fP for a list of compiled\-in audio output drivers. The
driver \fB\-\-ao=alsa\fP is preferred. \fB\-\-ao=pulse\fP is preferred on systems
where PulseAudio is used. On Windows, \fB\-\-ao=wasapi\fP is preferred,
though it might cause trouble sometimes, in which case \fB\-\-ao=dsound\fP
should be used. On BSD systems, \fB\-\-ao=oss\fP or \fI\-\-ao=sndio\(ga\fP may work
(the latter being experimental). On OS X systems, use \fB\-\-ao=coreaudio\fP\&.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.IP \(bu 2
\fB\-\-ao=alsa,oss,\fP Try the ALSA driver, then the OSS driver, then others.
.IP \(bu 2
\fB\-\-ao=alsa:no\-block:device=[hw:0,3]\fP Sets noblock\-mode and the
device\-name as first card, fourth device.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Available audio output drivers are:
.INDENT 0.0
.TP
.B \fBalsa\fP (Linux only)
ALSA audio output driver
.INDENT 7.0
.TP
.B \fBdevice=<device>\fP
Sets the device name. For ac3 output via S/PDIF, use an "iec958" or
"spdif" device, unless you really know how to set it correctly.
.TP
.B \fBno\-block\fP
Sets noblock\-mode.
.TP
.B \fBresample=yes\fP
Enable ALSA resampling plugin. (This is disabled by default, because
some drivers report incorrect audio delay in some cases.)
.TP
.B \fBmixer\-device=<device>\fP
Set the mixer device used with \fB\-\-no\-softvol\fP (default: \fBdefault\fP).
.TP
.B \fBmixer\-name=<name>\fP
Set the name of the mixer element (default: \fBMaster\fP). This is for
example \fBPCM\fP or \fBMaster\fP\&.
.TP
.B \fBmixer\-index=<number>\fP
Set the index of the mixer channel (default: 0). Consider the output of
"\fBamixer scontrols\fP", then the index is the number that follows the
name of the element.
.TP
.B \fBnon\-interleaved\fP
Allow output of non\-interleaved formats (if the audio decoder uses
this format). Currently disabled by default, because some popular
ALSA plugins are utterly broken with non\-interleaved formats.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
MPlayer and mplayer2 required you to replace any \(aq,\(aq with \(aq.\(aq and
any \(aq:\(aq with \(aq=\(aq in the ALSA device name. mpv does not do this anymore.
Instead, quote the device name:
.INDENT 0.0
.INDENT 3.5
\fB\-\-ao=alsa:device=[plug:surround50]\fP
.UNINDENT
.UNINDENT
.sp
Note that the \fB[\fP and \fB]\fP simply quote the device name. With some
shells (like zsh), you have to quote the option string to prevent the
shell from interpreting the brackets instead of passing them to mpv.
.UNINDENT
.UNINDENT
.TP
.B \fBoss\fP
OSS audio output driver
.INDENT 7.0
.TP
.B \fB<dsp\-device>\fP
Sets the audio output device (default: \fB/dev/dsp\fP).
.TP
.B \fB<mixer\-device>\fP
Sets the audio mixer device (default: \fB/dev/mixer\fP).
.TP
.B \fB<mixer\-channel>\fP
Sets the audio mixer channel (default: \fBpcm\fP). Other valid values
include \fBvol, pcm, line\fP\&. For a complete list of options look for
\fBSOUND_DEVICE_NAMES\fP in \fB/usr/include/linux/soundcard.h\fP\&.
.UNINDENT
.TP
.B \fBjack\fP
JACK (Jack Audio Connection Kit) audio output driver
.INDENT 7.0
.TP
.B \fBport=<name>\fP
Connects to the ports with the given name (default: physical ports).
.TP
.B \fBname=<client>\fP
Client name that is passed to JACK (default: \fBmpv\fP). Useful
if you want to have certain connections established automatically.
.TP
.B \fB(no\-)autostart\fP
Automatically start jackd if necessary (default: disabled). Note that
this tends to be unreliable and will flood stdout with server messages.
.TP
.B \fB(no\-)connect\fP
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.
.TP
.B \fBstd\-channel\-layout=alsa|waveext|any\fP
Select the standard channel layout (default: alsa). 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. \fBalsa\fP uses the old MPlayer layout, which is inspired by
ALSA\(aqs standard layouts. In this mode, ao_jack will refuse to play 3
or 7 channels (because these do not really have a defined meaning in
MPlayer). \fBwaveext\fP uses WAVE_FORMAT_EXTENSIBLE order, which, even
though it was defined by Microsoft, is the standard on many systems.
The value \fBany\fP 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.
.UNINDENT
.TP
.B \fBcoreaudio\fP (Mac OS X only)
Native Mac OS X audio output driver using the AudioUnits and the CoreAudio
sound server.
.INDENT 7.0
.TP
.B \fBdevice_id=<id>\fP
ID of output device to use (0 = default device)
.TP
.B \fBhelp\fP
List all available output devices with their IDs.
.UNINDENT
.TP
.B \fBcoreaudio_device\fP (Mac OS X only)
Native Mac OS X audio output driver using direct device access and
exclusive mode (bypasses the sound server).
.sp
Supports only compressed formats (AC3 and DTS).
.INDENT 7.0
.TP
.B \fBdevice_id=<id>\fP
ID of output device to use (0 = default device)
.TP
.B \fBhelp\fP
List all available output devices with their IDs.
.UNINDENT
.TP
.B \fBopenal\fP
Experimental OpenAL audio output driver
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This driver is not very useful. Playing multi\-channel audio with
it is slow.
.UNINDENT
.UNINDENT
.TP
.B \fBpulse\fP
PulseAudio audio output driver
.INDENT 7.0
.TP
.B \fB[<host>][:<output sink>]\fP
Specify the host and optionally output sink to use. An empty <host>
string uses a local connection, "localhost" uses network transfer
(most likely not what you want).
.TP
.B \fBbuffer=<1\-2000|native>\fP
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.
.TP
.B \fBlatency\-hacks=<yes|no>\fP
Enable hacks to workaround PulseAudio timing bugs (default: yes). 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.
.UNINDENT
.TP
.B \fBportaudio\fP
PortAudio audio output driver. This works on all platforms, and has
extensive MS Windows support.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This driver is not very useful. It was added in the hope of
providing portable audio API across all platforms, but turned
out semi\-broken and underfeatured.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fBdevice\fP
Specify the subdevice to use. Giving \fBhelp\fP as device name lists all
devices found by PortAudio. Devices can be given as numeric values,
starting from \fB1\fP\&.
.UNINDENT
.TP
.B \fBdsound\fP (Windows only)
DirectX DirectSound audio output driver
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This driver is for compatibility with old systems.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fBdevice=<devicenum>\fP
Sets the device number to use. Playing a file with \fB\-v\fP will show a
list of available devices.
.TP
.B \fBbuffersize=<ms>\fP
DirectSound buffer size in milliseconds (default: 200).
.UNINDENT
.TP
.B \fBsdl\fP
SDL 1.2+ audio output driver. Should work on any platform supported by SDL
1.2, but may require the \fBSDL_AUDIODRIVER\fP environment variable to be set
appropriately for your system.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This driver is for compatibility with extremely foreign
environments, such as systems where none of the other drivers
are available.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fBbuflen=<length>\fP
Sets the audio buffer length in seconds. Is used only as a hint by the
sound system. Playing a file with \fB\-v\fP will show the requested and
obtained exact buffer size. A value of 0 selects the sound system
default.
.TP
.B \fBbufcnt=<count>\fP
Sets the number of extra audio buffers in mpv. Usually needs not be
changed.
.UNINDENT
.TP
.B \fBnull\fP
Produces no audio output but maintains video playback speed. Use
\fB\-\-ao=null:untimed\fP for benchmarking.
.INDENT 7.0
.TP
.B \fBuntimed\fP
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.
.TP
.B \fBbuffer\fP
Simulated buffer length in seconds.
.TP
.B \fBoutburst\fP
Simulated chunk size in samples.
.TP
.B \fBspeed\fP
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 simulating this.
.TP
.B \fBlatency\fP
Simulated device latency. This is additional to EOF.
.TP
.B \fBbroken\-eof\fP
Simulate broken audio drivers, which always add the fixed device
latency to the reported audio playback position.
.UNINDENT
.TP
.B \fBpcm\fP
Raw PCM/WAVE file writer audio output
.INDENT 7.0
.TP
.B \fB(no\-)waveheader\fP
Include or do not include the WAVE header (default: included). When
not included, raw PCM will be generated.
.TP
.B \fBfile=<filename>\fP
Write the sound to \fB<filename>\fP instead of the default
\fBaudiodump.wav\fP\&. If \fBno\-waveheader\fP is specified, the default is
\fBaudiodump.pcm\fP\&.
.UNINDENT
.TP
.B \fBrsound\fP
Audio output to an RSound daemon
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Completely useless, unless you intend to run RSound. Not to be
confused with RoarAudio, which is something completely
different.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fBhost=<name/path>\fP
Set the address of the server (default: localhost).  Can be either a
network hostname for TCP connections or a Unix domain socket path
starting with \(aq/\(aq.
.TP
.B \fBport=<number>\fP
Set the TCP port used for connecting to the server (default: 12345).
Not used if connecting to a Unix domain socket.
.UNINDENT
.TP
.B \fBsndio\fP
Audio output to the OpenBSD sndio sound system
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Experimental. There are known bugs and issues.
.UNINDENT
.UNINDENT
.sp
(Note: only supports mono, stereo, 4.0, 5.1 and 7.1 channel
layouts.)
.INDENT 7.0
.TP
.B \fBdevice=<device>\fP
sndio device to use (default: \fB$AUDIODEVICE\fP, resp. \fBsnd0\fP).
.UNINDENT
.TP
.B \fBwasapi\fP
Audio output to the Windows Audio Session API.
.INDENT 7.0
.TP
.B \fBdevice=<id>\fP
Uses the requested endpoint instead of the system\(aqs default audio
endpoint. Both the number and the ID String are valid; the ID String
is guaranteed to not change unless the driver is uninstalled.
.sp
Also supports searching active devices by name. If more than one
device matches the name, refuses loading it.
.sp
To get a list of the valid devices, give \fBhelp\fP as the id. The
list is the same as the \fBlist\fP suboption, but stops the player
initialization.
.TP
.B \fBexclusive\fP
Requests exclusive, direct hardware access. By definition prevents
sound playback of any other program until mpv exits.
.TP
.B \fBlist\fP
Lists all audio endpoints (output devices) present in the system.
.UNINDENT
.UNINDENT
.SH VIDEO OUTPUT DRIVERS
.sp
Video output drivers are interfaces to different video output facilities. The
syntax is:
.INDENT 0.0
.TP
.B \fB\-\-vo=<driver1[:suboption1[=value]:...],driver2,...[,]>\fP
Specify a priority list of video output drivers to be used.
.UNINDENT
.sp
If the list has a trailing \(aq,\(aq, mpv will fall back on drivers not contained
in the list. Suboptions are optional and can mostly be omitted.
.sp
You can also set defaults for each driver. The defaults are applied before the
normal driver parameters.
.INDENT 0.0
.TP
.B \fB\-\-vo\-defaults=<driver1[:parameter1:parameter2:...],driver2,...>\fP
Set defaults for each driver.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
See \fB\-\-vo=help\fP for a list of compiled\-in video output drivers.
.sp
The recommended output drivers are \fB\-\-vo=vdpau\fP and \fB\-\-vo=opengl\-hq\fP\&.
All other drivers are just for compatibility or special purposes.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fB\-\-vo=opengl,xv,\fP
Try the \fBopengl\fP driver, then the \fBxv\fP driver, then others.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Available video output drivers are:
.INDENT 0.0
.TP
.B \fBxv\fP (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.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This driver is for compatibility with old systems.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fBadaptor=<number>\fP
Select a specific XVideo adapter (check xvinfo results).
.TP
.B \fBport=<number>\fP
Select a specific XVideo port.
.TP
.B \fBck=<cur|use|set>\fP
Select the source from which the color key is taken (default: cur).
.INDENT 7.0
.TP
.B cur
The default takes the color key currently set in Xv.
.TP
.B use
Use but do not set the color key from mpv (use the \fB\-\-colorkey\fP
option to change it).
.TP
.B set
Same as use but also sets the supplied color key.
.UNINDENT
.TP
.B \fBck\-method=<man|bg|auto>\fP
Sets the color key drawing method (default: man).
.INDENT 7.0
.TP
.B man
Draw the color key manually (reduces flicker in some cases).
.TP
.B bg
Set the color key as window background.
.TP
.B auto
Let Xv draw the color key.
.UNINDENT
.TP
.B \fBcolorkey=<number>\fP
Changes the color key to an RGB value of your choice. \fB0x000000\fP is
black and \fB0xffffff\fP is white.
.TP
.B \fBno\-colorkey\fP
Disables color\-keying.
.UNINDENT
.TP
.B \fBx11\fP (X11 only)
Shared memory video output driver without hardware acceleration that works
whenever X11 is present.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is a fallback only, and should not be normally used.
.UNINDENT
.UNINDENT
.TP
.B \fBvdpau\fP (X11 only)
Uses the VDPAU interface to display and optionally also decode video.
Hardware decoding is used with \fB\-\-hwdec=vdpau\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Earlier versions of mpv (and MPlayer, mplayer2) provided sub\-options
to tune vdpau post\-processing, like \fBdeint\fP, \fBsharpen\fP, \fBdenoise\fP,
\fBchroma\-deint\fP, \fBpullup\fP, \fBhqscaling\fP\&. These sub\-options are
deprecated, and you should use the \fBvdpaupp\fP video filter instead.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fBsharpen=<\-1\-1>\fP
(Deprecated. See note about \fBvdpaupp\fP\&.)
.sp
For positive values, apply a sharpening algorithm to the video, for
negative values a blurring algorithm (default: 0).
.TP
.B \fBdenoise=<0\-1>\fP
(Deprecated. See note about \fBvdpaupp\fP\&.)
.sp
Apply a noise reduction algorithm to the video (default: 0; no noise
reduction).
.TP
.B \fBdeint=<\-4\-4>\fP
(Deprecated. See note about \fBvdpaupp\fP\&.)
.sp
Select deinterlacing mode (default: 0). In older versions (as well as
MPlayer/mplayer2) you could use this option to enable deinterlacing.
This doesn\(aqt work anymore, and deinterlacing is enabled with either
the \fBD\fP key (by default mapped to the command \fBcycle deinterlace\fP),
or the \fB\-\-deinterlace\fP option. Also, to select the default deint mode,
you should use something like \fB\-\-vf\-defaults=vdpaupp:deint\-mode=temporal\fP
instead of this sub\-option.
.INDENT 7.0
.TP
.B 0
Pick the \fBvdpaupp\fP video filter default, which corresponds to 3.
.TP
.B 1
Show only first field.
.TP
.B 2
Bob deinterlacing.
.TP
.B 3
Motion\-adaptive temporal deinterlacing. May lead to A/V desync
with slow video hardware and/or high resolution.
.TP
.B 4
Motion\-adaptive temporal deinterlacing with edge\-guided spatial
interpolation. Needs fast video hardware.
.UNINDENT
.TP
.B \fBchroma\-deint\fP
(Deprecated. See note about \fBvdpaupp\fP\&.)
.sp
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.
.TP
.B \fBpullup\fP
(Deprecated. See note about \fBvdpaupp\fP\&.)
.sp
Try to apply inverse telecine, needs motion adaptive temporal
deinterlacing.
.TP
.B \fBhqscaling=<0\-9>\fP
(Deprecated. See note about \fBvdpaupp\fP\&.)
.INDENT 7.0
.TP
.B 0
Use default VDPAU scaling (default).
.TP
.B 1\-9
Apply high quality VDPAU scaling (needs capable hardware).
.UNINDENT
.TP
.B \fBfps=<number>\fP
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.
.TP
.B \fBcomposite\-detect\fP
NVIDIA\(aqs 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 \fBfps=\-1\fP (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 \fBno\-composite\-detect\fP to disable.
.TP
.B \fBqueuetime_windowed=<number>\fP and \fBqueuetime_fs=<number>\fP
Use VDPAU\(aqs presentation queue functionality to queue future video
frame changes at most this many milliseconds in advance (default: 50).
See below for additional information.
.TP
.B \fBoutput_surfaces=<2\-15>\fP
Allocate this many output surfaces to display video frames (default:
3). See below for additional information.
.TP
.B \fBcolorkey=<#RRGGBB|#AARRGGBB>\fP
Set the VDPAU presentation queue background color, which in practice
is the colorkey used if VDPAU operates in overlay mode (default:
\fB#020507\fP, 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).
.TP
.B \fBforce\-yuv\fP
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.
.UNINDENT
.sp
Using the VDPAU frame queuing functionality controlled by the queuetime
options makes mpv\(aqs 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).
.sp
You can queue more frames ahead by increasing the queuetime values and the
\fBoutput_surfaces\fP 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\(aqre 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.
.TP
.B \fBdirect3d_shaders\fP (Windows only)
Video output driver that uses the Direct3D interface.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This driver is for compatibility with systems that don\(aqt provide
proper OpenGL drivers.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fBprefer\-stretchrect\fP
Use \fBIDirect3DDevice9::StretchRect\fP over other methods if possible.
.TP
.B \fBdisable\-stretchrect\fP
Never render the video using \fBIDirect3DDevice9::StretchRect\fP\&.
.TP
.B \fBdisable\-textures\fP
Never render the video using D3D texture rendering. Rendering with
textures + shader will still be allowed. Add \fBdisable\-shaders\fP to
completely disable video rendering with textures.
.TP
.B \fBdisable\-shaders\fP
Never use shaders when rendering video.
.TP
.B \fBonly\-8bit\fP
Never render YUV video with more than 8 bits per component.
Using this flag will force software conversion to 8\-bit.
.TP
.B \fBdisable\-texture\-align\fP
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.
.UNINDENT
.sp
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.
.INDENT 7.0
.TP
.B \fBforce\-power\-of\-2\fP
Always force textures to power of 2, even if the device reports
non\-power\-of\-2 texture sizes as supported.
.TP
.B \fBtexture\-memory=N\fP
Only affects operation with shaders/texturing enabled, and (E)OSD.
Values for N:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B 0
default, will often use an additional shadow texture + copy
.TP
.B 1
use \fBD3DPOOL_MANAGED\fP
.TP
.B 2
use \fBD3DPOOL_DEFAULT\fP
.TP
.B 3
use \fBD3DPOOL_SYSTEMMEM\fP, but without shadow texture
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBswap\-discard\fP
Use \fBD3DSWAPEFFECT_DISCARD\fP, which might be faster.
Might be slower too, as it must(?) clear every frame.
.TP
.B \fBexact\-backbuffer\fP
Always resize the backbuffer to window size.
.UNINDENT
.TP
.B \fBdirect3d\fP (Windows only)
Same as \fBdirect3d_shaders\fP, but with the options \fBdisable\-textures\fP
and \fBdisable\-shaders\fP forced.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This driver is for compatibility with old systems.
.UNINDENT
.UNINDENT
.TP
.B \fBopengl\fP
OpenGL video output driver. It supports extended scaling methods, dithering
and color management.
.sp
By default, it tries to use fast and fail\-safe settings. Use the alias
\fBopengl\-hq\fP to use this driver with defaults set to high quality
rendering.
.sp
Requires at least OpenGL 2.1 and the \fBGL_ARB_texture_rg\fP extension. For
older drivers, \fBopengl\-old\fP may work.
.sp
Some features are available with OpenGL 3 capable graphics drivers only
(or if the necessary extensions are available).
.sp
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.
.sp
\fBlscale=<filter>\fP
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \fBbilinear\fP
Bilinear hardware texture filtering (fastest, mid\-quality).
This is the default.
.TP
.B \fBlanczos2\fP
Lanczos scaling with radius=2. Provides good quality and speed.
.TP
.B \fBlanczos3\fP
Lanczos with radius=3.
.TP
.B \fBlanczos\fP
Generic Lanczos scaling filter. Set radius with \fBlradius\fP\&.
.TP
.B \fBspline36\fP
This is the default when using \fBopengl\-hq\fP\&.
.TP
.B \fBbicubic_fast\fP
Bicubic filter. Has a blurring effect on the image, even if no
scaling is done.
.TP
.B \fBsharpen3\fP
Unsharp masking (sharpening) with radius=3 and a default strength
of 0.5 (see \fBlparam1\fP).
.TP
.B \fBsharpen5\fP
Unsharp masking (sharpening) with radius=5 and a default strength
of 0.5 (see \fBlparam1\fP).
.TP
.B \fBmitchell\fP
Mitchell\-Netravali. The \fBb\fP and \fBc\fP parameters can be set with
\fBlparam1\fP and \fBlparam2\fP\&. Both are set to 1/3 by default.
.TP
.B \fBgaussian\fP
Gaussian filter with a parameter \fBp\fP for sharpness control.
\fBp\fP can be set to float number between 1(blurry) and 100(sharp)
and has a default value of about 28.8 (see \fBlparam1\fP).
.sp
Note that for extremely small value of \fBp\fP, a large filter radius
might be required to avoid unintended artifacts (see \fBlradius\fP).
.UNINDENT
.sp
There are some more filters. For a complete list, pass \fBhelp\fP as
value, e.g.:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mpv \-\-vo=opengl:lscale=help
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fBlparam1=<value>\fP
Set filter parameters. Ignored if the filter is not tunable. These are
unset by default, and use the filter specific default if applicable.
.TP
.B \fBlparam2=<value>\fP
See \fBlparam1\fP\&.
.TP
.B \fBlradius=<r>\fP
Set radius for filters listed below, must be a float number between 1.0
and 8.0. Defaults to be 2.0 if not specified.
.INDENT 7.0
.INDENT 3.5
\fBsinc\fP, \fBlanczos\fP, \fBblackman\fP, \fBgaussian\fP
.UNINDENT
.UNINDENT
.sp
Note that depending on filter implementation details and video scaling
ratio, the radius that actually being used might be different
(most likely being increased a bit).
.TP
.B \fBscaler\-resizes\-only\fP
Disable the scaler if the video image is not resized. In that case,
\fBbilinear\fP is used instead whatever is set with \fBlscale\fP\&. Bilinear
will reproduce the source image perfectly if no scaling is performed.
Note that this option never affects \fBcscale\fP, although the different
processing chain might do chroma scaling differently if \fBlscale\fP is
disabled.
.TP
.B \fBstereo=<value>\fP
Select a method for stereo display. You may have to use
\fB\-\-video\-aspect\fP to fix the aspect value. Experimental, do not expect
too much from it.
.INDENT 7.0
.TP
.B no
Normal 2D display
.TP
.B red\-cyan
Convert side by side input to full\-color red\-cyan stereo.
.TP
.B green\-magenta
Convert side by side input to full\-color green\-magenta stereo.
.TP
.B quadbuffer
Convert side by side input to quad buffered stereo. Only supported
by very few OpenGL cards.
.UNINDENT
.TP
.B \fBsrgb\fP
Convert and color correct the output to sRGB before displaying it on
the screen. This option enables linear light scaling. It also forces
the options \fBindirect\fP and \fBgamma\fP\&.
.sp
This option is equivalent to using \fBicc\-profile\fP with an sRGB ICC
profile, but it is implemented without a 3DLUT and does not require
LittleCMS 2. If both \fBsrgb\fP and \fBicc\-profile\fP are present, the
latter takes precedence, as they are somewhat redundant.
.sp
Note: When playing back BT.2020 content with this option enabled, out
of gamut colors will be numerically clipped, which can potentially
change the hue and/or luminance. If this is not desired, it is
recommended to use \fBicc\-profile\fP with an sRGB ICC profile instead,
when playing back wide\-gamut BT.2020 content.
.TP
.B \fBpbo\fP
Enable use of PBOs. This is slightly faster, but can sometimes lead to
sporadic and temporary image corruption (in theory, because reupload
is not retried when it fails), and perhaps actually triggers slower
paths with drivers that don\(aqt support PBOs properly.
.TP
.B \fBdither\-depth=<N|no|auto>\fP
Set dither target depth to N. Default: no.
.INDENT 7.0
.TP
.B no
Disable any dithering done by mpv.
.TP
.B auto
Automatic selection. If output bit depth cannot be detected,
8 bits per component are assumed.
.TP
.B 8
Dither to 8 bit output.
.UNINDENT
.sp
Note that the depth of the connected video display device can not be
detected. Often, LCD panels will do dithering on their own, which
conflicts with \fBopengl\fP\(aqs dithering and leads to ugly output.
.TP
.B \fBdither\-size\-fruit=<2\-8>\fP
Set the size of the dither matrix (default: 6). The actual size of
the matrix is \fB(2^N) x (2^N)\fP for an option value of \fBN\fP, so a
value of 6 gives a size of 64x64. The matrix is generated at startup
time, and a large matrix can take rather long to compute (seconds).
.sp
Used in \fBdither=fruit\fP mode only.
.TP
.B \fBdither=<fruit|ordered|no>\fP
Select dithering algorithm (default: fruit).
.TP
.B \fBtemporal\-dither\fP
Enable temporal dithering. (Only active if dithering is enabled in
general.) This changes between 8 different dithering pattern on each
frame by changing the orientation of the tiled dithering matrix.
Unfortunately, this can lead to flicker on LCD displays, since these
have a high reaction time.
.TP
.B \fBdebug\fP
Check for OpenGL errors, i.e. call \fBglGetError()\fP\&. Also request a
debug OpenGL context (which does nothing with current graphics drivers
as of this writing).
.TP
.B \fBswapinterval=<n>\fP
Interval in displayed frames between two buffer swaps.
1 is equivalent to enable VSYNC, 0 to disable VSYNC.
.TP
.B \fBno\-scale\-sep\fP
When using a separable scale filter for luma, usually two filter
passes are done. This is often faster. However, it forces
conversion to RGB in an extra pass, so it can actually be slower
if used with fast filters on small screen resolutions. Using
this options will make rendering a single operation.
Note that chroma scalers are always done as 1\-pass filters.
.TP
.B \fBcscale=<n>\fP
As \fBlscale\fP, but for chroma (2x slower with little visible effect).
Note that with some scaling filters, upscaling is always done in
RGB. If chroma is not subsampled, this option is ignored, and the
luma scaler is used instead. Setting this option is often useless.
.TP
.B \fBcparam1\fP, \fBcparam2\fP, \fBcradius\fP
Set filter parameters and radius for \fBcscale\fP\&.
.sp
See \fBlparam1\fP, \fBlparam2\fP and \fBlradius\fP\&.
.TP
.B \fBfancy\-downscaling\fP
When using convolution based filters, extend the filter size
when downscaling. Trades quality for reduced downscaling performance.
.TP
.B \fBno\-npot\fP
Force use of power\-of\-2 texture sizes. For debugging only.
Borders will be distorted due to filtering.
.TP
.B \fBglfinish\fP
Call \fBglFinish()\fP before and after swapping buffers (default: disabled).
Slower, but might help getting better results when doing framedropping.
The details depend entirely on the OpenGL driver.
.TP
.B \fBwaitvsync\fP
Call \fBglXWaitVideoSyncSGI\fP after each buffer swap (default: disabled).
This may or may not help with video timing accuracy and frame drop. It\(aqs
possible that this makes video output slower, or has no effect at all.
.sp
X11 only.
.TP
.B \fBsw\fP
Continue even if a software renderer is detected.
.TP
.B \fBbackend=<sys>\fP
The value \fBauto\fP (the default) selects the windowing backend. You
can also pass \fBhelp\fP to get a complete list of compiled in backends
(sorted by autoprobe order).
.INDENT 7.0
.TP
.B auto
auto\-select (default)
.TP
.B cocoa
Cocoa/OS X
.TP
.B win
Win32/WGL
.TP
.B x11
X11/GLX
.TP
.B wayland
Wayland/EGL
.UNINDENT
.TP
.B \fBindirect\fP
Do YUV conversion and scaling as separate passes. This will first render
the video into a video\-sized RGB texture, and draw the result on screen.
The luma scaler is used to scale the RGB image when rendering to screen.
The chroma scaler is used only on YUV conversion, and only if the video
is chroma\-subsampled (usually the case).
This mechanism is disabled on RGB input.
Specifying this option directly is generally useful for debugging only.
.TP
.B \fBfbo\-format=<fmt>\fP
Selects the internal format of textures used for FBOs. The format can
influence performance and quality of the video output. (FBOs are not
always used, and typically only when using extended scalers.)
\fBfmt\fP can be one of: rgb, rgba, rgb8, rgb10, rgb10_a2, rgb16, rgb16f,
rgb32f, rgba12, rgba16, rgba16f, rgba32f.
Default: rgb.
.TP
.B \fBgamma=<0.0..10.0>\fP
Set a gamma value. If gamma is adjusted in other ways (like with
the \fB\-\-gamma\fP option or key bindings and the \fBgamma\fP property), the
value is multiplied with the other gamma value.
.sp
Setting this value to 1.0 can be used to always enable gamma control.
(Disables delayed enabling.)
.TP
.B \fBicc\-profile=<file>\fP
Load an ICC profile and use it to transform linear RGB to screen output.
Needs LittleCMS 2 support compiled in. This option overrides the \fBsrgb\fP
property, as using both is somewhat redundant. It also enables linear
light scaling.
.TP
.B \fBicc\-profile\-auto\fP
Automatically select the ICC display profile currently specified by
the display settings of the operating system.
.sp
NOTE: Only implemented on OS X with Cocoa.
.TP
.B \fBicc\-cache=<file>\fP
Store and load the 3D LUT created from the ICC profile in this file.
This can be used to speed up loading, since LittleCMS 2 can take a while
to create the 3D LUT. Note that this file contains an uncompressed LUT.
Its size depends on the \fB3dlut\-size\fP, and can be very big.
.TP
.B \fBicc\-intent=<value>\fP
Specifies the ICC Intent used for transformations between color spaces.
This affects the rendering when using \fBicc\-profile\fP or \fBsrgb\fP and
also affects the way DCP XYZ content gets converted to RGB.
.INDENT 7.0
.TP
.B 0
perceptual
.TP
.B 1
relative colorimetric (default)
.TP
.B 2
saturation
.TP
.B 3
absolute colorimetric
.UNINDENT
.TP
.B \fBapprox\-gamma\fP
Approximate the actual gamma function as a pure power curve of
1.95. A number of video editing programs and studios apparently use this
for mastering instead of the true curve. Most notably, anything in the
Apple ecosystem uses this approximation \- including all programs
compatible with it. It\(aqs a sound idea to try enabling this flag first
when watching videos and shows to see if things look better that way.
.sp
This only affects the output when using either \fBicc\-profile\fP or \fBsrgb\fP\&.
.TP
.B \fB3dlut\-size=<r>x<g>x<b>\fP
Size of the 3D LUT generated from the ICC profile in each dimension.
Default is 128x256x64.
Sizes must be a power of two, and 512 at most.
.TP
.B \fBalpha=<blend|yes|no>\fP
Decides what to do if the input has an alpha component (default: blend).
.INDENT 7.0
.TP
.B blend
Blend the frame against a black background.
.TP
.B yes
Try to create a framebuffer with alpha component. This only makes sense
if the video contains alpha information (which is extremely rare). May
not be supported on all platforms. If alpha framebuffers are
unavailable, it silently falls back on a normal framebuffer. Note
that when using FBO indirections (such as with \fBopengl\-hq\fP), an FBO
format with alpha must be specified with the \fBfbo\-format\fP option.
.TP
.B no
Ignore alpha component.
.UNINDENT
.TP
.B \fBchroma\-location=<auto|center|left>\fP
Set the YUV chroma sample location. auto means use the bitstream
flags (default: auto).
.TP
.B \fBrectangle\-textures\fP
Force use of rectangle textures (default: no). Normally this shouldn\(aqt
have any advantages over normal textures. Note that hardware decoding
overrides this flag.
.UNINDENT
.TP
.B \fBopengl\-hq\fP
Same as \fBopengl\fP, but with default settings for high quality rendering.
.sp
This is equivalent to:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-vo=opengl:lscale=spline36:dither\-depth=auto:fbo\-format=rgba16
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that some cheaper LCDs do dithering that gravely interferes with
\fBopengl\fP\(aqs dithering. Disabling dithering with \fBdither\-depth=no\fP helps.
.sp
Unlike \fBopengl\fP, \fBopengl\-hq\fP makes use of FBOs by default. Sometimes you
can achieve better quality or performance by changing the \fBfbo\-format\fP
suboption to \fBrgb16f\fP, \fBrgb32f\fP or \fBrgb\fP\&. Known problems include
Mesa/Intel not accepting \fBrgb16\fP, Mesa sometimes not being compiled with
float texture support, and some OS X setups being very slow with \fBrgb16\fP
but fast with \fBrgb32f\fP\&.
.TP
.B \fBopengl\-old\fP
OpenGL video output driver, old version. Video size must be smaller
than the maximum texture size of your OpenGL implementation. Intended to
work even with the most basic OpenGL implementations, but also makes use
of newer extensions which allow support for more color spaces.
.sp
The code performs very few checks, so if a feature does not work, this
might be because it is not supported by your card and/or OpenGL
implementation, even if you do not get any error message. Use \fBglxinfo\fP
or a similar tool to display the supported OpenGL extensions.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This driver is for compatibility with old systems.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fB(no\-)ati\-hack\fP
ATI drivers may give a corrupted image when PBOs are used (when using
\fBforce\-pbo\fP). This option fixes this, at the expense of using a bit
more memory.
.TP
.B \fB(no\-)force\-pbo\fP
Always uses PBOs to transfer textures even if this involves an extra
copy. Currently this gives a little extra speed with NVIDIA drivers
and a lot more speed with ATI drivers. May need the \fBati\-hack\fP
suboption to work correctly.
.TP
.B \fB(no\-)scaled\-osd\fP
Scales the OSD and subtitles instead of rendering them at display size
(default: disabled).
.TP
.B \fBrectangle=<0,1,2>\fP
Select usage of rectangular textures, which saves video RAM, but often
is slower (default: 0).
.INDENT 7.0
.TP
.B 0
Use power\-of\-two textures (default).
.TP
.B 1
Use the \fBGL_ARB_texture_rectangle\fP extension.
.TP
.B 2
Use the \fBGL_ARB_texture_non_power_of_two\fP extension. In some
cases only supported in software and thus very slow.
.UNINDENT
.TP
.B \fBswapinterval=<n>\fP
Minimum interval between two buffer swaps, counted in displayed frames
(default: 1). 1 is equivalent to enabling VSYNC, 0 to disabling VSYNC.
Values below 0 will leave it at the system default. This limits the
framerate to (horizontal refresh rate / n). Requires
\fBGLX_SGI_swap_control\fP support to work. With some (most/all?)
implementations this only works in fullscreen mode.
.TP
.B \fBycbcr\fP
Use the \fBGL_MESA_ycbcr_texture\fP extension to convert YUV to RGB. In
most cases this is probably slower than doing software conversion to
RGB.
.TP
.B \fByuv=<n>\fP
Select the type of YUV to RGB conversion. The default is
auto\-detection deciding between values 0 and 2.
.INDENT 7.0
.TP
.B 0
Use software conversion. Compatible with all OpenGL versions.
Provides brightness, contrast and saturation control.
.TP
.B 1
Same as 2. This used to use NVIDIA\-specific extensions, which
did not provide any advantages over using fragment programs, except
possibly on very ancient graphics cards. It produced a gray\-ish
output, which is why it has been removed.
.TP
.B 2
Use a fragment program. Needs the \fBGL_ARB_fragment_program\fP
extension and at least three texture units. Provides brightness,
contrast, saturation and hue control.
.TP
.B 3
Use a fragment program using the \fBPOW\fP instruction. Needs the
\fBGL_ARB_fragment_program\fP extension and at least three texture
units. Provides brightness, contrast, saturation, hue and gamma
control. Gamma can also be set independently for red, green and
blue. Method 4 is usually faster.
.TP
.B 4
Use a fragment program with additional lookup. Needs the
\fBGL_ARB_fragment_program\fP extension and at least four texture
units. Provides brightness, contrast, saturation, hue and gamma
control. Gamma can also be set independently for red, green and
blue.
.TP
.B 5
Use ATI\-specific method (for older cards). This uses an
ATI\-specific extension (\fBGL_ATI_fragment_shader\fP \- not
\fBGL_ARB_fragment_shader\fP!). At least three texture units are
needed. Provides saturation and hue control. This method is fast
but inexact.
.TP
.B 6
Use a 3D texture to do conversion via lookup. Needs the
\fBGL_ARB_fragment_program extension\fP and at least four texture
units. Extremely slow (software emulation) on some (all?) ATI
cards since it uses a texture with border pixels. Provides
brightness, contrast, saturation, hue and gamma control. Gamma can
also be set independently for red, green and blue. Speed depends
more on GPU memory bandwidth than other methods.
.UNINDENT
.TP
.B \fBlscale=<n>\fP
Select the scaling function to use for luminance scaling. Only valid
for yuv modes 2, 3, 4 and 6.
.INDENT 7.0
.TP
.B 0
Use simple linear filtering (default).
.TP
.B 1
Use bicubic B\-spline filtering (better quality). Needs one
additional texture unit. Older cards will not be able to handle
this for chroma at least in fullscreen mode.
.TP
.B 2
Use cubic filtering in horizontal, linear filtering in vertical
direction. Works on a few more cards than method 1.
.TP
.B 3
Same as 1 but does not use a lookup texture. Might be faster on
some cards.
.TP
.B 4
Use experimental unsharp masking with 3x3 support and a default
strength of 0.5 (see \fBfilter\-strength\fP).
.TP
.B 5
Use experimental unsharp masking with 5x5 support and a default
strength of 0.5 (see \fBfilter\-strength\fP).
.UNINDENT
.TP
.B \fBcscale=<n>\fP
Select the scaling function to use for chrominance scaling. For
details see \fBlscale\fP\&.
.TP
.B \fBfilter\-strength=<value>\fP
Set the effect strength for the \fBlscale\fP/\fBcscale\fP filters that
support it.
.TP
.B \fBstereo=<value>\fP
Select a method for stereo display. You may have to use
\fB\-\-video\-aspect\fP to fix the aspect value. Experimental, do not expect
too much from it.
.INDENT 7.0
.TP
.B 0
Normal 2D display
.TP
.B 1
Convert side by side input to full\-color red\-cyan stereo.
.TP
.B 2
Convert side by side input to full\-color green\-magenta stereo.
.TP
.B 3
Convert side by side input to quad buffered stereo. Only supported
by very few OpenGL cards.
.UNINDENT
.UNINDENT
.sp
The following options are only useful if writing your own fragment programs.
.INDENT 7.0
.TP
.B \fBcustomprog=<filename>\fP
Load a custom fragment program from \fB<filename>\fP\&.
.TP
.B \fBcustomtex=<filename>\fP
Load a custom "gamma ramp" texture from \fB<filename>\fP\&. This can be used
in combination with \fByuv=4\fP or with the \fBcustomprog\fP option.
.TP
.B \fB(no\-)customtlin\fP
If enabled (default) use \fBGL_LINEAR\fP interpolation, otherwise use
\fBGL_NEAREST\fP for customtex texture.
.TP
.B \fB(no\-)customtrect\fP
If enabled, use \fBtexture_rectangle\fP for the \fBcustomtex\fP texture.
Default is disabled.
.TP
.B \fB(no\-)mipmapgen\fP
If enabled, mipmaps for the video are automatically generated. This
should be useful together with the \fBcustomprog\fP and the \fBTXB\fP
instruction to implement blur filters with a large radius. For most
OpenGL implementations, this is very slow for any non\-RGB formats.
Default is disabled.
.UNINDENT
.sp
Normally there is no reason to use the following options; they mostly
exist for testing purposes.
.INDENT 7.0
.TP
.B \fB(no\-)glfinish\fP
Call \fBglFinish()\fP before swapping buffers. Slower but in some cases
more correct output (default: disabled).
.TP
.B \fB(no\-)manyfmts\fP
Enables support for more (RGB and BGR) color formats (default: enabled).
Needs OpenGL version >= 1.2.
.TP
.B \fBslice\-height=<0\-...>\fP
Number of lines copied to texture in one piece (default: 0). 0 for
whole image.
.TP
.B \fBsw\fP
Continue even if a software renderer is detected.
.TP
.B \fBbackend=<sys>\fP
.INDENT 7.0
.TP
.B auto
auto\-select (default)
.TP
.B cocoa
Cocoa/OS X
.TP
.B win
Win32/WGL
.TP
.B x11
X11/GLX
.TP
.B wayland
Wayland/EGL
.UNINDENT
.UNINDENT
.TP
.B \fBsdl\fP
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 \fBSDL_hints.h\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This driver is for compatibility with systems that don\(aqt provide
proper graphics drivers, or which support GLES only.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fBsw\fP
Continue even if a software renderer is detected.
.TP
.B \fBswitch\-mode\fP
Instruct SDL to switch the monitor video mode when going fullscreen.
.UNINDENT
.TP
.B \fBvaapi\fP
Intel VA API video output driver with support for hardware decoding. Note
that there is absolutely no reason to use this, other than wanting to use
hardware decoding to save power on laptops, or possibly preventing video
tearing with some setups.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This driver is for compatibility with crappy systems. You can
use vaapi hardware decoding with \fB\-\-vo=opengl\fP too.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fBscaling=<algorithm>\fP
.INDENT 7.0
.TP
.B default
Driver default (mpv default as well).
.TP
.B fast
Fast, but low quality.
.TP
.B hq
Unspecified driver dependent high\-quality scaling, slow.
.TP
.B nla
\fBnon\-linear anamorphic scaling\fP
.UNINDENT
.TP
.B \fBdeint\-mode=<mode>\fP
Select deinterlacing algorithm. Note that by default deinterlacing is
initially always off, and needs to be enabled with the \fBD\fP key
(default key binding for \fBcycle deinterlace\fP).
.sp
This option doesn\(aqt apply if libva supports video post processing (vpp).
In this case, the default for \fBdeint\-mode\fP is \fBno\fP, and enabling
deinterlacing via user interaction using the methods mentioned above
actually inserts the \fBvavpp\fP 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.
.INDENT 7.0
.TP
.B no
Don\(aqt allow deinterlacing (default for newer libva).
.TP
.B first\-field
Show only first field (going by \fB\-\-field\-dominance\fP).
.TP
.B bob
bob deinterlacing (default for older libva).
.UNINDENT
.TP
.B \fBscaled\-osd=<yes|no>\fP
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.
.UNINDENT
.TP
.B \fBnull\fP
Produces no video output. Useful for benchmarking.
.TP
.B \fBcaca\fP
Color ASCII art video output driver that works on a text console.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This driver is a joke.
.UNINDENT
.UNINDENT
.TP
.B \fBimage\fP
Output each frame into an image file in the current directory. Each file
takes the frame number padded with leading zeros as name.
.INDENT 7.0
.TP
.B \fBformat=<format>\fP
Select the image file format.
.INDENT 7.0
.TP
.B jpg
JPEG files, extension .jpg. (Default.)
.TP
.B jpeg
JPEG files, extension .jpeg.
.TP
.B png
PNG files.
.TP
.B ppm
Portable bitmap format.
.TP
.B pgm
Portable graymap format.
.TP
.B pgmyuv
Portable graymap format, using the YV12 pixel format.
.TP
.B tga
Truevision TGA.
.UNINDENT
.TP
.B \fBpng\-compression=<0\-9>\fP
PNG compression factor (speed vs. file size tradeoff) (default: 7)
.TP
.B \fBpng\-filter=<0\-5>\fP
Filter applied prior to PNG compression (0 = none; 1 = sub; 2 = up;
3 = average; 4 = Paeth; 5 = mixed) (default: 5)
.TP
.B \fBjpeg\-quality=<0\-100>\fP
JPEG quality factor (default: 90)
.TP
.B \fB(no\-)jpeg\-progressive\fP
Specify standard or progressive JPEG (default: no).
.TP
.B \fB(no\-)jpeg\-baseline\fP
Specify use of JPEG baseline or not (default: yes).
.TP
.B \fBjpeg\-optimize=<0\-100>\fP
JPEG optimization factor (default: 100)
.TP
.B \fBjpeg\-smooth=<0\-100>\fP
smooth factor (default: 0)
.TP
.B \fBjpeg\-dpi=<1\->\fP
JPEG DPI (default: 72)
.TP
.B \fBoutdir=<dirname>\fP
Specify the directory to save the image files to (default: \fB\&./\fP).
.UNINDENT
.TP
.B \fBwayland\fP (Wayland only)
Wayland shared memory video output as fallback for \fBopengl\fP\&.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This driver is for compatibility with systems that don\(aqt provide
working OpenGL drivers.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fBalpha\fP
Use a buffer format that supports videos and images with alpha
information
.TP
.B \fBrgb565\fP
Use RGB565 as buffer format. This format is implemented on most
platforms, especially on embedded where it is far more efficient then
RGB8888.
.TP
.B \fBtriple\-buffering\fP
Use 3 buffers instead of 2. This can lead to more fluid playback, but
uses more memory.
.UNINDENT
.UNINDENT
.SH AUDIO FILTERS
.sp
Audio filters allow you to modify the audio stream and its properties. The
syntax is:
.INDENT 0.0
.TP
.B \fB\-\-af=<filter1[=parameter1:parameter2:...],filter2,...>\fP
Setup a chain of audio filters.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To get a full list of available audio filters, see \fB\-\-af=help\fP\&.
.UNINDENT
.UNINDENT
.sp
You can also set defaults for each filter. The defaults are applied before the
normal filter parameters.
.INDENT 0.0
.TP
.B \fB\-\-af\-defaults=<filter1[=parameter1:parameter2:...],filter2,...>\fP
Set defaults for each filter.
.UNINDENT
.sp
Audio filters are managed in lists. There are a few commands to manage the
filter list:
.INDENT 0.0
.TP
.B \fB\-\-af\-add=<filter1[,filter2,...]>\fP
Appends the filters given as arguments to the filter list.
.TP
.B \fB\-\-af\-pre=<filter1[,filter2,...]>\fP
Prepends the filters given as arguments to the filter list.
.TP
.B \fB\-\-af\-del=<index1[,index2,...]>\fP
Deletes the filters at the given indexes. Index numbers start at 0,
negative numbers address the end of the list (\-1 is the last).
.TP
.B \fB\-\-af\-clr\fP
Completely empties the filter list.
.UNINDENT
.sp
Available filters are:
.INDENT 0.0
.TP
.B \fBlavrresample[=option1:option2:...]\fP
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.
.sp
It supports only the following sample formats: u8, s16, s32, float.
.INDENT 7.0
.TP
.B \fBfilter\-size=<length>\fP
Length of the filter with respect to the lower sampling rate. (default:
16)
.TP
.B \fBphase\-shift=<count>\fP
Log2 of the number of polyphase entries. (..., 10\->1024, 11\->2048,
12\->4096, ...) (default: 10\->1024)
.TP
.B \fBcutoff=<cutoff>\fP
Cutoff frequency (0.0\-1.0), default set depending upon filter length.
.TP
.B \fBlinear\fP
If set then filters will be linearly interpolated between polyphase
entries. (default: no)
.TP
.B \fBno\-detach\fP
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 \fB\-\-af\-defaults=lavrresample:...\fP\&.)
.TP
.B \fBo=<string>\fP
Set AVOptions on the SwrContext or AVAudioResampleContext. These should
be documented by FFmpeg or Libav.
.UNINDENT
.TP
.B \fBlavcac3enc[=tospdif[:bitrate[:minchn]]]\fP
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.
.INDENT 7.0
.TP
.B \fBtospdif=<yes|no>\fP
Output raw AC\-3 stream if \fBno\fP, output to S/PDIF for
pass\-through if \fByes\fP (default).
.TP
.B \fBbitrate=<rate>\fP
The bitrate use for the AC\-3 stream. Set it to 384 to get 384 kbps.
.sp
The default is 640. Some receivers might not be able to handle this.
.sp
Valid values: 32, 40, 48, 56, 64, 80, 96, 112, 128,
160, 192, 224, 256, 320, 384, 448, 512, 576, 640.
.sp
The special value \fBauto\fP selects a default bitrate based on the
input channel number:
.INDENT 7.0
.TP
.B 1ch
96
.TP
.B 2ch
192
.TP
.B 3ch
224
.TP
.B 4ch
384
.TP
.B 5ch
448
.TP
.B 6ch
448
.UNINDENT
.TP
.B \fBminchn=<n>\fP
If the input channel number is less than \fB<minchn>\fP, the filter will
detach itself (default: 3).
.UNINDENT
.TP
.B \fBsweep[=speed]\fP
Produces a sine sweep.
.INDENT 7.0
.TP
.B \fB<0.0\-1.0>\fP
Sine function delta, use very low values to hear the sweep.
.UNINDENT
.TP
.B \fBsinesuppress[=freq:decay]\fP
Remove a sine at the specified frequency. Useful to get rid of the 50/60 Hz
noise on low quality audio equipment. It only works on mono input.
.INDENT 7.0
.TP
.B \fB<freq>\fP
The frequency of the sine which should be removed (in Hz) (default:
50)
.TP
.B \fB<decay>\fP
Controls the adaptivity (a larger value will make the filter adapt to
amplitude and phase changes quicker, a smaller value will make the
adaptation slower) (default: 0.0001). Reasonable values are around
0.001.
.UNINDENT
.TP
.B \fBbs2b[=option1:option2:...]\fP
Bauer stereophonic to binaural transformation using libbs2b. Improves the
headphone listening experience by making the sound similar to that from
loudspeakers, allowing each ear to hear both channels and taking into
account the distance difference and the head shadowing effect. It is
applicable only to 2\-channel audio.
.INDENT 7.0
.TP
.B \fBfcut=<300\-1000>\fP
Set cut frequency in Hz.
.TP
.B \fBfeed=<10\-150>\fP
Set feed level for low frequencies in 0.1*dB.
.TP
.B \fBprofile=<value>\fP
Several profiles are available for convenience:
.INDENT 7.0
.TP
.B default
will be used if nothing else was specified (fcut=700,
feed=45)
.TP
.B cmoy
Chu Moy circuit implementation (fcut=700, feed=60)
.TP
.B jmeier
Jan Meier circuit implementation (fcut=650, feed=95)
.UNINDENT
.UNINDENT
.sp
If \fBfcut\fP or \fBfeed\fP options are specified together with a profile, they
will be applied on top of the selected profile.
.TP
.B \fBhrtf[=flag]\fP
Head\-related transfer function: Converts multichannel audio to 2\-channel
output for headphones, preserving the spatiality of the sound.
.TS
center;
|l|l|.
_
T{
Flag
T}	T{
Meaning
T}
_
T{
m
T}	T{
matrix decoding of the rear channel
T}
_
T{
s
T}	T{
2\-channel matrix decoding
T}
_
T{
0
T}	T{
no matrix decoding (default)
T}
_
.TE
.TP
.B \fBequalizer=g1:g2:g3:...:g10\fP
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:
.TS
center;
|l|l|.
_
T{
No.
T}	T{
frequency
T}
_
T{
0
T}	T{
31.25  Hz
T}
_
T{
1
T}	T{
62.50  Hz
T}
_
T{
2
T}	T{
125.00  Hz
T}
_
T{
3
T}	T{
250.00  Hz
T}
_
T{
4
T}	T{
500.00  Hz
T}
_
T{
5
T}	T{
1.00 kHz
T}
_
T{
6
T}	T{
2.00 kHz
T}
_
T{
7
T}	T{
4.00 kHz
T}
_
T{
8
T}	T{
8.00 kHz
T}
_
T{
9
T}	T{
16.00 kHz
T}
_
.TE
.sp
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.
.INDENT 7.0
.TP
.B \fB<g1>:<g2>:<g3>:...:<g10>\fP
floating point numbers representing the gain in dB for each frequency
band (\-12\-12)
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fBmpv \-\-af=equalizer=11:11:10:5:0:\-12:0:5:12:12 media.avi\fP
Would amplify the sound in the upper and lower frequency region
while canceling it almost completely around 1 kHz.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBchannels=nch[:routes]\fP
Can be used for adding, removing, routing and copying audio channels. If
only \fB<nch>\fP 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.
.INDENT 7.0
.TP
.B \fB<nch>\fP
number of output channels (1\-8)
.TP
.B \fB<routes>\fP
List of \fB,\fP separated routes, in the form \fBfrom1\-to1,from2\-to2,...\fP\&.
Each pair defines where to route each channel. There can be at most
8 routes. Without this argument, the default routing is used. Since
\fB,\fP is also used to separate filters, you must quote this argument
with \fB[...]\fP or similar.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.TP
.B \fBmpv \-\-af=channels=4:[0\-1,1\-0,0\-2,1\-3] media.avi\fP
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.
.TP
.B \fBmpv \-\-af=channels=6:[0\-0,0\-1,0\-2,0\-3] media.avi\fP
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.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
You should probably not use this filter. If you want to change the
output channel layout, try the \fBformat\fP filter, which can make mpv
automatically up\- and downmix standard channel layouts.
.UNINDENT
.UNINDENT
.TP
.B \fBformat=format:srate:channels:out\-format:out\-srate:out\-channels\fP
Force a specific audio format/configuration without actually changing the
audio data. Keep in mind that the filter system might auto\-insert actual
conversion filters before or after this filter if needed.
.sp
All parameters are optional. The first 3 parameters restrict what the filter
accepts as input. The \fBout\-\fP parameters change the audio format, without
actually doing a conversion. The data will be \(aqreinterpreted\(aq by the
filters or audio outputs following this filter.
.INDENT 7.0
.TP
.B \fB<format>\fP
Force conversion to this format. Use \fB\-\-af=format=format=help\fP to get
a list of valid formats.
.TP
.B \fB<srate>\fP
Force conversion to a specific sample rate. The rate is an integer,
48000 for example.
.TP
.B \fB<channels>\fP
Force mixing to a specific channel layout. See \fB\-\-audio\-channels\fP option
for possible values.
.UNINDENT
.sp
\fB<out\-format>\fP
.sp
\fB<out\-srate>\fP
.sp
\fB<out\-channels>\fP
.sp
See also \fB\-\-audio\-format\fP, \fB\-\-audio\-samplerate\fP, and
\fB\-\-audio\-channels\fP for related options. Keep in mind that
\fB\-\-audio\-channels\fP does not actually force the number of
channels in most cases, while this filter can do this.
.sp
\fINOTE\fP: this filter used to be named \fBforce\fP\&. Also, unlike the old
\fBformat\fP filter, this does not do any actual conversion anymore.
Conversion is done by other, automatically inserted filters.
.TP
.B \fBconvert24\fP
Filter for internal use only. Converts between 24\-bit and 32\-bit sample
formats.
.TP
.B \fBconvertsign\fP
Filter for internal use only. Converts between signed/unsigned formats.
.TP
.B \fBvolume[=<volumedb>[:...]]\fP
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 \fIMaster\fP volume control of your sound card or the volume
knob on your amplifier.
.sp
\fINOTE\fP: This filter is not reentrant and can therefore only be enabled
once for every audio stream.
.INDENT 7.0
.TP
.B \fB<volumedb>\fP
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).
.TP
.B \fBreplaygain\-track\fP
Adjust volume gain according to the track\-gain replaygain value stored
in the file metadata.
.TP
.B \fBreplaygain\-album\fP
Like replaygain\-track, but using the album\-gain value instead.
.TP
.B \fBreplaygain\-preamp\fP
Pre\-amplification gain in dB to apply to the selected replaygain gain
(default: 0).
.TP
.B \fBreplaygain\-clip=yes|no\fP
Prevent clipping caused by replaygain by automatically lowering the
gain (default). Use \fBreplaygain\-clip=no\fP to disable this.
.TP
.B \fBsoftclip\fP
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.
.sp
\fIWARNING\fP: This feature creates distortion and should be considered a
last resort.
.TP
.B \fBs16\fP
Force S16 sample format if set. Lower quality, but might be faster
in some situations.
.TP
.B \fBdetach\fP
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 \fB\-\-softvol=yes\fP is used and the player volume controls are used
during playback, a different volume filter will be inserted.)
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fBmpv \-\-af=volume=10.1 media.avi\fP
Would amplify the sound by 10.1 dB and hard\-clip if the sound level
is too high.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBpan=n:[<matrix>]\fP
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.
.INDENT 7.0
.TP
.B \fB<n>\fP
Number of output channels (1\-8).
.TP
.B \fB<matrix>\fP
A list of values \fB[L00,L01,L02,...,L10,L11,L12,...,Ln0,Ln1,Ln2,...]\fP,
where each element \fBLij\fP 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 \fB,\fP, which is already used
by the option parser to separate filters. This is why you must quote
the value list with \fB[...]\fP or similar.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.TP
.B \fBmpv \-\-af=pan=1:[0.5,0.5] media.avi\fP
Would downmix from stereo to mono.
.TP
.B \fBmpv \-\-af=pan=3:[1,0,0.5,0,1,0.5] media.avi\fP
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).
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
If you just want to force remixing to a certain output channel layout,
it is easier to use the \fBformat\fP filter. For example,
\fBmpv \(aq\-\-af=format=channels=5.1\(aq \(aq\-\-audio\-channels=5.1\(aq\fP would always force
remixing audio to 5.1 and output it like this.
.UNINDENT
.UNINDENT
.TP
.B \fBsub[=fc:ch]\fP
Adds a subwoofer channel to the audio stream. The audio data used for
creating the subwoofer channel is an average of the sound in channel 0 and
channel 1. The resulting sound is then low\-pass filtered by a 4th order
Butterworth filter with a default cutoff frequency of 60Hz and added to a
separate channel in the audio stream.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Disable this filter when you are playing media with an LFE channel
(e.g. 5.1 surround sound), otherwise this filter will disrupt the sound
to the subwoofer.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fB<fc>\fP
cutoff frequency in Hz for the low\-pass filter (20 Hz to 300 Hz)
(default: 60 Hz) For the best result try setting the cutoff frequency
as low as possible. This will improve the stereo or surround sound
experience.
.TP
.B \fB<ch>\fP
Determines the channel number in which to insert the sub\-channel
audio. Channel number can be between 0 and 7 (default: 5). Observe
that the number of channels will automatically be increased to <ch> if
necessary.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fBmpv \-\-af=sub=100:4 \-\-audio\-channels=5 media.avi\fP
Would add a subwoofer channel with a cutoff frequency of 100 Hz to
output channel 4.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBcenter\fP
Creates a center channel from the front channels. May currently be low
quality as it does not implement a high\-pass filter for proper extraction
yet, but averages and halves the channels instead.
.INDENT 7.0
.TP
.B \fB<ch>\fP
Determines the channel number in which to insert the center channel.
Channel number can be between 0 and 7 (default: 5). Observe that the
number of channels will automatically be increased to \fB<ch>\fP if
necessary.
.UNINDENT
.TP
.B \fBsurround[=delay]\fP
Decoder for matrix encoded surround sound like Dolby Surround. Some files
with 2\-channel audio actually contain matrix encoded surround sound.
.INDENT 7.0
.TP
.B \fB<delay>\fP
delay time in ms for the rear speakers (0 to 1000) (default: 20) This
delay should be set as follows: If d1 is the distance from the
listening position to the front speakers and d2 is the distance from
the listening position to the rear speakers, then the delay should be
set to 15ms if d1 <= d2 and to 15 + 5*(d1\-d2) if d1 > d2.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fBmpv \-\-af=surround=15 \-\-audio\-channels=4 media.avi\fP
Would add surround sound decoding with 15 ms delay for the sound to
the rear speakers.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBdelay[=[ch1,ch2,...]]\fP
Delays the sound to the loudspeakers such that the sound from the
different channels arrives at the listening position simultaneously. It is
only useful if you have more than 2 loudspeakers.
.INDENT 7.0
.TP
.B \fB[ch1,ch2,...]\fP
The delay in ms that should be imposed on each channel (floating point
number between 0 and 1000).
.UNINDENT
.sp
To calculate the required delay for the different channels, do as follows:
.INDENT 7.0
.IP 1. 3
Measure the distance to the loudspeakers in meters in relation to your
listening position, giving you the distances s1 to s5 (for a 5.1
system). There is no point in compensating for the subwoofer (you will
not hear the difference anyway).
.IP 2. 3
Subtract the distances s1 to s5 from the maximum distance, i.e.
\fBs[i] = max(s) \- s[i]; i = 1...5\fP\&.
.IP 3. 3
Calculate the required delays in ms as \fBd[i] = 1000*s[i]/342; i =
1...5\fP\&.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fBmpv \-\-af=delay=[10.5,10.5,0,0,7,0] media.avi\fP
Would delay front left and right by 10.5 ms, the two rear channels
and the subwoofer by 0 ms and the center channel by 7 ms.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBexport=mmapped_file:nsamples]\fP
Exports the incoming signal to other processes using memory mapping
(\fBmmap()\fP). Memory mapped areas contain a header:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
int nch                      /* number of channels */
int size                     /* buffer size */
unsigned long long counter   /* Used to keep sync, updated every time
                                new data is exported. */
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The rest is payload (non\-interleaved) 16\-bit data.
.INDENT 7.0
.TP
.B \fB<mmapped_file>\fP
File to map data to (required)
.TP
.B \fB<nsamples>\fP
number of samples per channel (default: 512).
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fBmpv \-\-af=export=/tmp/mpv\-af_export:1024 media.avi\fP
Would export 1024 samples per channel to \fB/tmp/mpv\-af_export\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBextrastereo[=mul]\fP
(Linearly) increases the difference between left and right channels which
adds some sort of "live" effect to playback.
.INDENT 7.0
.TP
.B \fB<mul>\fP
Sets the difference coefficient (default: 2.5). 0.0 means mono sound
(average of both channels), with 1.0 sound will be unchanged, with
\-1.0 left and right channels will be swapped.
.UNINDENT
.TP
.B \fBdrc[=method:target]\fP
Applies dynamic range compression. This maximizes the volume by compressing
the audio signal\(aqs dynamic range. (Formerly called \fBvolnorm\fP\&.)
.INDENT 7.0
.TP
.B \fB<method>\fP
Sets the used method.
.INDENT 7.0
.TP
.B 1
Use a single sample to smooth the variations via the standard
weighted mean over past samples (default).
.TP
.B 2
Use several samples to smooth the variations via the standard
weighted mean over past samples.
.UNINDENT
.TP
.B \fB<target>\fP
Sets the target amplitude as a fraction of the maximum for the sample
type (default: 0.25).
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This filter can cause distortion with audio signals that have a very
large dynamic range.
.UNINDENT
.UNINDENT
.TP
.B \fBladspa=file:label:[<control0>,<control1>,...]\fP
Load a LADSPA (Linux Audio Developer\(aqs Simple Plugin API) plugin. This
filter is reentrant, so multiple LADSPA plugins can be used at once.
.INDENT 7.0
.TP
.B \fB<file>\fP
Specifies the LADSPA plugin library file.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
See also the note about the \fBLADSPA_PATH\fP variable in the
\fI\%ENVIRONMENT VARIABLES\fP section.
.UNINDENT
.UNINDENT
.TP
.B \fB<label>\fP
Specifies the filter within the library. Some libraries contain only
one filter, but others contain many of them. Entering \(aqhelp\(aq here
will list all available filters within the specified library, which
eliminates the use of \(aqlistplugins\(aq from the LADSPA SDK.
.TP
.B \fB[<control0>,<control1>,...]\fP
Controls are zero or more \fB,\fP separated floating point values that
determine the behavior of the loaded plugin (for example delay,
threshold or gain).
In verbose mode (add \fB\-v\fP to the mpv command line), all
available controls and their valid ranges are printed. This eliminates
the use of \(aqanalyseplugin\(aq from the LADSPA SDK.
Note that \fB,\fP is already used by the option parser to separate
filters, so you must quote the list of values with \fB[...]\fP or
similar.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fBmpv \-\-af=ladspa=\(aq/usr/lib/ladspa/delay.so\(aq:delay_5s:[0.5,0.2] media.avi\fP
Does something.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBkaraoke\fP
Simple voice removal filter exploiting the fact that voice is usually
recorded with mono gear and later \(aqcenter\(aq mixed onto the final audio
stream. Beware that this filter will turn your signal into mono. Works
well for 2 channel tracks; do not bother trying it on anything but 2
channel stereo.
.TP
.B \fBscaletempo[=option1:option2:...]\fP
Scales audio tempo without altering pitch, optionally synced to playback
speed (default).
.sp
This works by playing \(aqstride\(aq ms of audio at normal speed then consuming
\(aqstride*scale\(aq ms of input audio. It pieces the strides together by
blending \(aqoverlap\(aq% of stride with audio following the previous stride. It
optionally performs a short statistical analysis on the next \(aqsearch\(aq ms
of audio to determine the best overlap position.
.INDENT 7.0
.TP
.B \fBscale=<amount>\fP
Nominal amount to scale tempo. Scales this amount in addition to
speed. (default: 1.0)
.TP
.B \fBstride=<amount>\fP
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)
.TP
.B \fBoverlap=<percent>\fP
Percentage of stride to overlap. Decreasing improves performance.
(default: .20)
.TP
.B \fBsearch=<amount>\fP
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)
.TP
.B \fBspeed=<tempo|pitch|both|none>\fP
Set response to speed change.
.INDENT 7.0
.TP
.B tempo
Scale tempo in sync with speed (default).
.TP
.B pitch
Reverses effect of filter. Scales pitch without altering tempo.
Add \fB[ speed_mult 0.9438743126816935\fP and \fB] speed_mult
1.059463094352953\fP to your \fBinput.conf\fP to step by musical
semi\-tones.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Loses sync with video.
.UNINDENT
.UNINDENT
.TP
.B both
Scale both tempo and pitch.
.TP
.B none
Ignore speed changes.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.TP
.B \fBmpv \-\-af=scaletempo \-\-speed=1.2 media.ogg\fP
Would play media at 1.2x normal speed, with audio at normal
pitch. Changing playback speed would change audio tempo to match.
.TP
.B \fBmpv \-\-af=scaletempo=scale=1.2:speed=none \-\-speed=1.2 media.ogg\fP
Would play media at 1.2x normal speed, with audio at normal
pitch, but changing playback speed would have no effect on audio
tempo.
.TP
.B \fBmpv \-\-af=scaletempo=stride=30:overlap=.50:search=10 media.ogg\fP
Would tweak the quality and performance parameters.
.TP
.B \fBmpv \-\-af=format=float,scaletempo media.ogg\fP
Would make scaletempo use float code. Maybe faster on some
platforms.
.TP
.B \fBmpv \-\-af=scaletempo=scale=1.2:speed=pitch audio.ogg\fP
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.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBlavfi=graph\fP
Filter audio using FFmpeg\(aqs libavfilter.
.INDENT 7.0
.TP
.B \fB<graph>\fP
Libavfilter graph. See \fBlavfi\fP video filter for details \- the graph
syntax is the same.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
Don\(aqt forget to quote libavfilter graphs as described in the lavfi
video filter section.
.UNINDENT
.UNINDENT
.TP
.B \fBo=<string>\fP
AVOptions.
.UNINDENT
.UNINDENT
.SH VIDEO FILTERS
.sp
Video filters allow you to modify the video stream and its properties. The
syntax is:
.INDENT 0.0
.TP
.B \fB\-\-vf=<filter1[=parameter1:parameter2:...],filter2,...>\fP
Setup a chain of video filters.
.UNINDENT
.sp
You can also set defaults for each filter. The defaults are applied before the
normal filter parameters.
.INDENT 0.0
.TP
.B \fB\-\-vf\-defaults=<filter1[=parameter1:parameter2:...],filter2,...>\fP
Set defaults for each filter.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To get a full list of available video filters, see \fB\-\-vf=help\fP\&.
.UNINDENT
.UNINDENT
.sp
Video filters are managed in lists. There are a few commands to manage the
filter list.
.INDENT 0.0
.TP
.B \fB\-\-vf\-add=<filter1[,filter2,...]>\fP
Appends the filters given as arguments to the filter list.
.TP
.B \fB\-\-vf\-pre=<filter1[,filter2,...]>\fP
Prepends the filters given as arguments to the filter list.
.TP
.B \fB\-\-vf\-del=<index1[,index2,...]>\fP
Deletes the filters at the given indexes. Index numbers start at 0,
negative numbers address the end of the list (\-1 is the last).
.TP
.B \fB\-\-vf\-clr\fP
Completely empties the filter list.
.UNINDENT
.sp
With filters that support it, you can access parameters by their name.
.INDENT 0.0
.TP
.B \fB\-\-vf=<filter>=help\fP
Prints the parameter names and parameter value ranges for a particular
filter.
.TP
.B \fB\-\-vf=<filter=named_parameter1=value1[:named_parameter2=value2:...]>\fP
Sets a named parameter to the given value. Use on and off or yes and no to
set flag parameters.
.UNINDENT
.sp
Available filters are:
.INDENT 0.0
.TP
.B \fBcrop[=w:h:x:y]\fP
Crops the given part of the image and discards the rest. Useful to remove
black bands from widescreen videos.
.INDENT 7.0
.TP
.B \fB<w>,<h>\fP
Cropped width and height, defaults to original width and height.
.TP
.B \fB<x>,<y>\fP
Position of the cropped picture, defaults to center.
.UNINDENT
.TP
.B \fBexpand[=w:h:x:y:aspect:round]\fP
Expands (not scales) video resolution to the given value and places the
unscaled original at coordinates x, y.
.INDENT 7.0
.TP
.B \fB<w>,<h>\fP
Expanded width,height (default: original width,height). Negative
values for w and h are treated as offsets to the original size.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fBexpand=0:\-50:0:0\fP
Adds a 50 pixel border to the bottom of the picture.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB<x>,<y>\fP
position of original image on the expanded image (default: center)
.TP
.B \fB<aspect>\fP
Expands to fit an aspect instead of a resolution (default: 0).
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fBexpand=800::::4/3\fP
Expands to 800x600, unless the source is higher resolution, in
which case it expands to fill a 4/3 aspect.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB<round>\fP
Rounds up to make both width and height divisible by <r> (default: 1).
.UNINDENT
.TP
.B \fBflip\fP
Flips the image upside down.
.TP
.B \fBmirror\fP
Mirrors the image on the Y axis.
.TP
.B \fBrotate[=0|90|180|270]\fP
Rotates the image by a multiple of 90 degrees clock\-wise.
.TP
.B \fBscale[=w:h:param:param2:chr\-drop:noup:arnd\fP
Scales the image with the software scaler (slow) and performs a YUV<\->RGB
color space conversion (see also \fB\-\-sws\fP).
.sp
All parameters are optional.
.INDENT 7.0
.TP
.B \fB<w>,<h>\fP
scaled width/height (default: original width/height)
.INDENT 7.0
.TP
.B 0
scaled d_width/d_height
.TP
.B \-1
original width/height
.TP
.B \-2
Calculate w/h using the other dimension and the prescaled
aspect ratio.
.TP
.B \-3
Calculate w/h using the other dimension and the original
aspect ratio.
.TP
.B \-(n+8)
Like \-n above, but rounding the dimension to the closest
multiple of 16.
.UNINDENT
.TP
.B \fB<param>[:<param2>]\fP (see also \fB\-\-sws\fP)
Set some scaling parameters depending on the type of scaler selected
with \fB\-\-sws\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-sws=2 (bicubic):  B (blurring) and C (ringing)
    0.00:0.60 default
    0.00:0.75 VirtualDub\(aqs "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)
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B \fB<chr\-drop>\fP
chroma skipping
.INDENT 7.0
.TP
.B 0
Use all available input lines for chroma (default).
.TP
.B 1
Use only every 2. input line for chroma.
.TP
.B 2
Use only every 4. input line for chroma.
.TP
.B 3
Use only every 8. input line for chroma.
.UNINDENT
.TP
.B \fB<noup>\fP
Disallow upscaling past the original dimensions.
.INDENT 7.0
.TP
.B 0
Allow upscaling (default).
.TP
.B 1
Disallow upscaling if one dimension exceeds its original value.
.TP
.B 2
Disallow upscaling if both dimensions exceed their original values.
.UNINDENT
.TP
.B \fB<arnd>\fP
Accurate rounding for the vertical scaler, which may be faster or
slower than the default rounding.
.INDENT 7.0
.TP
.B 0
Disable accurate rounding (default).
.TP
.B 1
Enable accurate rounding.
.UNINDENT
.UNINDENT
.TP
.B \fBdsize[=w:h:aspect\-method:r:aspect]\fP
Changes the intended display size/aspect at an arbitrary point in the
filter chain. Aspect can be given as a fraction (4/3) or floating point
number (1.33). Alternatively, you may specify the exact display width and
height desired. Note that this filter does \fInot\fP do any scaling itself; it
just affects what later scalers (software or hardware) will do when
auto\-scaling to correct aspect.
.INDENT 7.0
.TP
.B \fB<w>,<h>\fP
New display width and height.
.sp
Can also be these special values:
.INDENT 7.0
.TP
.B 0
original display width and height
.TP
.B \-1
original video width and height (default)
.TP
.B \-2
Calculate w/h using the other dimension and the original display
aspect ratio.
.TP
.B \-3
Calculate w/h using the other dimension and the original video
aspect ratio.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fBdsize=800:\-2\fP
Specifies a display resolution of 800x600 for a 4/3 aspect
video, or 800x450 for a 16/9 aspect video.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB<aspect\-method>\fP
Modifies width and height according to original aspect ratios.
.INDENT 7.0
.TP
.B \-1
Ignore original aspect ratio (default).
.TP
.B 0
Keep display aspect ratio by using \fB<w>\fP and \fB<h>\fP as maximum
resolution.
.TP
.B 1
Keep display aspect ratio by using \fB<w>\fP and \fB<h>\fP as minimum
resolution.
.TP
.B 2
Keep video aspect ratio by using \fB<w>\fP and \fB<h>\fP as maximum
resolution.
.TP
.B 3
Keep video aspect ratio by using \fB<w>\fP and \fB<h>\fP as minimum
resolution.
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fBdsize=800:600:0\fP
Specifies a display resolution of at most 800x600, or smaller,
in order to keep aspect.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB<r>\fP
Rounds up to make both width and height divisible by \fB<r>\fP
(default: 1).
.TP
.B \fB<aspect>\fP
Force an aspect ratio.
.UNINDENT
.TP
.B \fBformat[=fmt[:outfmt]]\fP
Restricts the color space for the next filter without doing any conversion.
Use together with the scale filter for a real conversion.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For a list of available formats, see \fBformat=fmt=help\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fB<fmt>\fP
Format name, e.g. rgb15, bgr24, 420p, etc. (default: yuyv).
.TP
.B \fB<outfmt>\fP
Format name that should be substituted for the output. If this is not
100% compatible with the \fB<fmt>\fP value, it will crash.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.TS
center;
|l|l|.
_
T{
Valid
T}	T{
Invalid (will crash)
T}
_
T{
\fBformat=rgb24:bgr24\fP
T}	T{
\fBformat=rgb24:420p\fP
T}
_
T{
\fBformat=yuyv:uyvy\fP
T}	T{
T}
_
.TE
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBnoformat[=fmt]\fP
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.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
For a list of available formats, see \fBnoformat=fmt=help\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.TP
.B \fB<fmt>\fP
Format name, e.g. rgb15, bgr24, 420p, etc. (default: 420p).
.UNINDENT
.TP
.B \fBpp=[filter string]\fP
Enables the specified chain of post\-processing subfilters. Subfilters must
be separated by \(aq/\(aq and can be disabled by prepending a \(aq\-\(aq. Each
subfilter and some options have a short and a long name that can be used
interchangeably, i.e. \fBdr\fP/\fBdering\fP are the same.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
Unlike in MPlayer or in earlier versions, you must quote the pp string
if it contains \fB:\fP characters, e.g. \fB\(aq\-\-vf=pp=[...]\(aq\fP\&.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Warning"
.sp
This filter is most likely useless on modern HD video. It might be
helpful with old low\-resolution files.
.UNINDENT
.UNINDENT
.sp
All subfilters share common options to determine their scope:
.INDENT 7.0
.TP
.B \fBa/autoq\fP
Automatically switch the subfilter off if the CPU is too slow.
.TP
.B \fBc/chrom\fP
Do chrominance filtering, too (default).
.TP
.B \fBy/nochrom\fP
Do luminance filtering only (no chrominance).
.TP
.B \fBn/noluma\fP
Do chrominance filtering only (no luminance).
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
\fB\-\-vf=pp:help\fP shows a list of available subfilters.
.UNINDENT
.UNINDENT
.sp
Available subfilters are:
.INDENT 7.0
.TP
.B \fBhb/hdeblock[:difference[:flatness]]\fP
horizontal deblocking filter
.INDENT 7.0
.TP
.B <difference>
Difference factor where higher values mean more
deblocking (default: 32).
.TP
.B <flatness>
Flatness threshold where lower values mean more
deblocking (default: 39).
.UNINDENT
.TP
.B \fBvb/vdeblock[:difference[:flatness]]\fP
vertical deblocking filter
.INDENT 7.0
.TP
.B <difference>
Difference factor where higher values mean more
deblocking (default: 32).
.TP
.B <flatness>
Flatness threshold where lower values mean more
deblocking (default: 39).
.UNINDENT
.TP
.B \fBha/hadeblock[:difference[:flatness]]\fP
accurate horizontal deblocking filter
.INDENT 7.0
.TP
.B <difference>
Difference factor where higher values mean more
deblocking (default: 32).
.TP
.B <flatness>
Flatness threshold where lower values mean more
deblocking (default: 39).
.UNINDENT
.TP
.B \fBva/vadeblock[:difference[:flatness]]\fP
accurate vertical deblocking filter
.INDENT 7.0
.TP
.B <difference>
Difference factor where higher values mean more
deblocking (default: 32).
.TP
.B <flatness>
Flatness threshold where lower values mean more
deblocking (default: 39).
.UNINDENT
.UNINDENT
.sp
The horizontal and vertical deblocking filters share the difference and
flatness values so you cannot set different horizontal and vertical
thresholds.
.INDENT 7.0
.TP
.B \fBh1/x1hdeblock\fP
experimental horizontal deblocking filter
.TP
.B \fBv1/x1vdeblock\fP
experimental vertical deblocking filter
.TP
.B \fBdr/dering\fP
deringing filter
.TP
.B \fBtn/tmpnoise[:threshold1[:threshold2[:threshold3]]]\fP
temporal noise reducer
.INDENT 7.0
.TP
.B <threshold1>
larger \-> stronger filtering
.TP
.B <threshold2>
larger \-> stronger filtering
.TP
.B <threshold3>
larger \-> stronger filtering
.UNINDENT
.TP
.B \fBal/autolevels[:f/fullyrange]\fP
automatic brightness / contrast correction
.INDENT 7.0
.TP
.B f/fullyrange
Stretch luminance to (0\-255).
.UNINDENT
.TP
.B \fBlb/linblenddeint\fP
Linear blend deinterlacing filter that deinterlaces the given block by
filtering all lines with a (1 2 1) filter.
.TP
.B \fBli/linipoldeint\fP
Linear interpolating deinterlacing filter that deinterlaces the given
block by linearly interpolating every second line.
.TP
.B \fBci/cubicipoldeint\fP
Cubic interpolating deinterlacing filter deinterlaces the given block
by cubically interpolating every second line.
.TP
.B \fBmd/mediandeint\fP
Median deinterlacing filter that deinterlaces the given block by
applying a median filter to every second line.
.TP
.B \fBfd/ffmpegdeint\fP
FFmpeg deinterlacing filter that deinterlaces the given block by
filtering every second line with a (\-1 4 2 4 \-1) filter.
.TP
.B \fBl5/lowpass5\fP
Vertically applied FIR low\-pass deinterlacing filter that deinterlaces
the given block by filtering all lines with a (\-1 2 6 2 \-1) filter.
.TP
.B \fBfq/forceQuant[:quantizer]\fP
Overrides the quantizer table from the input with the constant
quantizer you specify.
.INDENT 7.0
.TP
.B <quantizer>
quantizer to use
.UNINDENT
.TP
.B \fBde/default\fP
default pp filter combination (hb:a,vb:a,dr:a)
.TP
.B \fBfa/fast\fP
fast pp filter combination (h1:a,v1:a,dr:a)
.TP
.B \fBac\fP
high quality pp filter combination (ha:a:128:7,va:a,dr:a)
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This filter is only available if FFmpeg/Libav has been compiled
with libpostproc enabled.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.TP
.B \fB\-\-vf=pp=hb/vb/dr/al\fP
horizontal and vertical deblocking, deringing and automatic
brightness/contrast
.TP
.B \fB\-\-vf=pp=de/\-al\fP
default filters without brightness/contrast correction
.TP
.B \fB\-\-vf=pp=[default/tmpnoise:1:2:3]\fP
Enable default filters & temporal denoiser.
.TP
.B \fB\-\-vf=pp=[hb:y/vb:a]\fP
Horizontal deblocking on luminance only, and switch vertical
deblocking on or off automatically depending on available CPU time.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBlavfi=graph[:sws\-flags[:o=opts]]\fP
Filter video using FFmpeg\(aqs libavfilter.
.INDENT 7.0
.TP
.B \fB<graph>\fP
The libavfilter graph string. The filter must have a single video input
pad and a single video output pad.
.sp
See \fI\%https://ffmpeg.org/ffmpeg\-filters.html\fP for syntax and available
filters.
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
If you want to use the full filter syntax with this option, you have
to quote the filter graph in order to prevent mpv\(aqs syntax and the
filter graph syntax from clashing.
.UNINDENT
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.TP
.B \fB\-vf lavfi=[gradfun=20:30,vflip]\fP
\fBgradfun\fP filter with nonsense parameters, followed by a
\fBvflip\fP filter. (This demonstrates how libavfilter takes a
graph and not just a single filter.) The filter graph string is
quoted with \fB[\fP and \fB]\fP\&. This requires no additional quoting
or escaping with some shells (like bash), while others (like
zsh) require additional \fB"\fP quotes around the option string.
.TP
.B \fB\(aq\-\-vf=lavfi="gradfun=20:30,vflip"\(aq\fP
Same as before, but uses quoting that should be safe with all
shells. The outer \fB\(aq\fP quotes make sure that the shell does not
remove the \fB"\fP quotes needed by mpv.
.TP
.B \fB\(aq\-\-vf=lavfi=graph="gradfun=radius=30:strength=20,vflip"\(aq\fP
Same as before, but uses named parameters for everything.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fB<sws\-flags>\fP
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 \fBSWS_\fP flags.
.sp
See \fBhttp://git.videolan.org/?p=ffmpeg.git;a=blob;f=libswscale/swscale.h\fP\&.
.TP
.B \fB<o>\fP
Set AVFilterGraph options. These should be documented by FFmpeg.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B \fB\(aq\-\-vf=lavfi=yadif:o="threads=2,thread_type=slice"\(aq\fP
forces a specific threading configuration.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBnoise[=<strength>[:averaged][:pattern][:temporal][:uniform][:hq]\fP
Adds noise.
.INDENT 7.0
.TP
.B \fBstrength\fP
Set the noise for all components. If you want different strength
values for luma and chroma, use libavfilter\(aqs noise filter directly
(using \fB\-\-vf=lavfi=[noise=...]\fP), or tell the libavfilter developers
to stop being stupid.
.TP
.B \fBaveraged\fP
averaged temporal noise (smoother, but a lot slower)
.TP
.B \fBpattern\fP
mix random noise with a (semi)regular pattern
.TP
.B \fBtemporal\fP
temporal noise (noise pattern changes between frames)
.TP
.B \fBuniform\fP
uniform noise (Gaussian otherwise)
.TP
.B \fBhq\fP
high quality (slightly better looking, slightly slower) \- not available
when using libavfilter
.UNINDENT
.TP
.B \fBhqdn3d[=luma_spatial:chroma_spatial:luma_tmp:chroma_tmp]\fP
This filter aims to reduce image noise producing smooth images and making
still images really still (This should enhance compressibility.).
.INDENT 7.0
.TP
.B \fB<luma_spatial>\fP
spatial luma strength (default: 4)
.TP
.B \fB<chroma_spatial>\fP
spatial chroma strength (default: 3)
.TP
.B \fB<luma_tmp>\fP
luma temporal strength (default: 6)
.TP
.B \fB<chroma_tmp>\fP
chroma temporal strength (default:
\fBluma_tmp*chroma_spatial/luma_spatial\fP)
.UNINDENT
.TP
.B \fBeq[=gamma:contrast:brightness:saturation:rg:gg:bg:weight]\fP
Software equalizer that uses lookup tables (slow), allowing gamma correction
in addition to simple brightness and contrast adjustment. The parameters are
given as floating point values.
.INDENT 7.0
.TP
.B \fB<0.1\-10>\fP
initial gamma value (default: 1.0)
.TP
.B \fB<\-2\-2>\fP
initial contrast, where negative values result in a negative image
(default: 1.0)
.TP
.B \fB<\-1\-1>\fP
initial brightness (default: 0.0)
.TP
.B \fB<0\-3>\fP
initial saturation (default: 1.0)
.TP
.B \fB<0.1\-10>\fP
gamma value for the red component (default: 1.0)
.TP
.B \fB<0.1\-10>\fP
gamma value for the green component (default: 1.0)
.TP
.B \fB<0.1\-10>\fP
gamma value for the blue component (default: 1.0)
.TP
.B \fB<0\-1>\fP
The weight parameter can be used to reduce the effect of a high gamma
value on bright image areas, e.g. keep them from getting overamplified
and just plain white. A value of 0.0 turns the gamma correction all
the way down while 1.0 leaves it at its full strength (default: 1.0).
.UNINDENT
.TP
.B \fBilpack[=mode]\fP
When interlaced video is stored in YUV 4:2:0 formats, chroma interlacing
does not line up properly due to vertical downsampling of the chroma
channels. This filter packs the planar 4:2:0 data into YUY2 (4:2:2) format
with the chroma lines in their proper locations, so that in any given
scanline, the luma and chroma data both come from the same field.
.INDENT 7.0
.TP
.B \fB<mode>\fP
Select the sampling mode.
.INDENT 7.0
.TP
.B 0
nearest\-neighbor sampling, fast but incorrect
.TP
.B 1
linear interpolation (default)
.UNINDENT
.UNINDENT
.TP
.B \fBunsharp[=lx:ly:la:cx:cy:ca]\fP
unsharp mask / Gaussian blur
.sp
\fBl\fP is for the luma component, \fBc\fP for the chroma component. \fBx\fP/\fBy\fP
is the filter size. \fBa\fP is the amount.
.INDENT 7.0
.TP
.B \fBlx\fP, \fBly\fP, \fBcx\fP, \fBcy\fP
width and height of the matrix, odd sized in both directions (min =
3:3, max = 13:11 or 11:13, usually something between 3:3 and 7:7)
.TP
.B \fBla\fP, \fBca\fP
Relative amount of sharpness/blur to add to the image (a sane range
should be \-1.5\-1.5).
.INDENT 7.0
.TP
.B <0
blur
.TP
.B >0
sharpen
.UNINDENT
.UNINDENT
.TP
.B \fBswapuv\fP
Swap U & V plane.
.TP
.B \fBpullup[=jl:jr:jt:jb:sb:mp]\fP
Pulldown reversal (inverse telecine) filter, capable of handling mixed
hard\-telecine, 24000/1001 fps progressive, and 30000/1001 fps progressive
content. The \fBpullup\fP 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.
.INDENT 7.0
.TP
.B \fBjl\fP, \fBjr\fP, \fBjt\fP, and \fBjb\fP
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.
.TP
.B \fBsb\fP (strict breaks)
Setting this option to 1 will reduce the chances of \fBpullup\fP
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 \fBpullup\fP match fields more
easily. This may help processing of video where there is slight
blurring between the fields, but may also cause there to be interlaced
frames in the output.
.TP
.B \fBmp\fP (metric plane)
This option may be set to \fBu\fP or \fBv\fP to use a chroma plane instead of the
luma plane for doing \fBpullup\fP\(aqs 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 \fBmp\fP to a chroma plane is to reduce
CPU load and make pullup usable in realtime on slow machines.
.UNINDENT
.TP
.B \fBdivtc[=options]\fP
Inverse telecine for deinterlaced video. If 3:2\-pulldown telecined video
has lost one of the fields or is deinterlaced using a method that keeps
one field and interpolates the other, the result is a juddering video that
has every fourth frame duplicated. This filter is intended to find and
drop those duplicates and restore the original film framerate. Two
different modes are available: One\-pass mode is the default and is
straightforward to use, but has the disadvantage that any changes in the
telecine phase (lost frames or bad edits) cause momentary judder until the
filter can resync again. Two\-pass mode avoids this by analyzing the entire
video beforehand so it will have forward knowledge about the phase changes
and can resync at the exact spot. These passes do \fInot\fP correspond to pass
one and two of the encoding process. You must run an extra pass using
\fBdivtc\fP pass one before the actual encoding throwing the resulting video
away. Then use \fBdivtc\fP pass two for the actual encoding. If you use
multiple encoder passes, use \fBdivtc\fP pass two for all of them.
.sp
The options are:
.INDENT 7.0
.TP
.B \fBpass=1|2\fP
Use two pass mode.
.TP
.B \fBfile=<filename>\fP
Set the two pass log filename (default: \fBframediff.log\fP).
.TP
.B \fBthreshold=<value>\fP
Set the minimum strength the telecine pattern must have for the filter
to believe in it (default: 0.5). This is used to avoid recognizing
false pattern from the parts of the video that are very dark or very
still.
.TP
.B \fBwindow=<numframes>\fP
Set the number of past frames to look at when searching for pattern
(default: 30). Longer window improves the reliability of the pattern
search, but shorter window improves the reaction time to the changes
in the telecine phase. This only affects the one\-pass mode. The
two\-pass mode currently uses fixed window that extends to both future
and past.
.TP
.B \fBphase=0|1|2|3|4\fP
Sets the initial telecine phase for one pass mode (default: 0). The
two\-pass mode can see the future, so it is able to use the correct
phase from the beginning, but one\-pass mode can only guess. It catches
the correct phase when it finds it, but this option can be used to fix
the possible juddering at the beginning. The first pass of the two
pass mode also uses this, so if you save the output from the first
pass, you get constant phase result.
.TP
.B \fBdeghost=<value>\fP
Set the deghosting threshold (0\-255 for one\-pass mode, \-255\-255 for
two\-pass mode, default 0). If nonzero, deghosting mode is used. This
is for video that has been deinterlaced by blending the fields
together instead of dropping one of the fields. Deghosting amplifies
any compression artifacts in the blended frames, so the parameter
value is used as a threshold to exclude those pixels from deghosting
that differ from the previous frame less than specified value. If two
pass mode is used, then negative value can be used to make the filter
analyze the whole video in the beginning of pass\-2 to determine
whether it needs deghosting or not and then select either zero or the
absolute value of the parameter. Specify this option for pass 2, it
makes no difference on pass 1.
.UNINDENT
.TP
.B \fBphase[=t|b|p|a|u|T|B|A|U][:v]\fP
Delay interlaced video by one field time so that the field order changes.
The intended use is to fix PAL videos that have been captured with the
opposite field order to the film\-to\-video transfer. The options are:
.INDENT 7.0
.TP
.B \fBt\fP
Capture field order top\-first, transfer bottom\-first. Filter will
delay the bottom field.
.TP
.B \fBb\fP
Capture bottom\-first, transfer top\-first. Filter will delay the top
field.
.TP
.B \fBp\fP
Capture and transfer with the same field order. This mode only exists
for the documentation of the other options to refer to, but if you
actually select it, the filter will faithfully do nothing ;\-)
.TP
.B \fBa\fP
Capture field order determined automatically by field flags, transfer
opposite. Filter selects among \fBt\fP and \fBb\fP modes on a frame by frame
basis using field flags. If no field information is available, then this
works just like \fBu\fP\&.
.TP
.B \fBu\fP
Capture unknown or varying, transfer opposite. Filter selects among
\fBt\fP and \fBb\fP on a frame by frame basis by analyzing the images and
selecting the alternative that produces best match between the fields.
.TP
.B \fBT\fP
Capture top\-first, transfer unknown or varying. Filter selects among
\fBt\fP and \fBp\fP using image analysis.
.TP
.B \fBB\fP
Capture bottom\-first, transfer unknown or varying. Filter selects
among \fBb\fP and \fBp\fP using image analysis.
.TP
.B \fBA\fP
Capture determined by field flags, transfer unknown or varying. Filter
selects among \fBt\fP, \fBb\fP and \fBp\fP using field flags and image
analysis. If no field information is available, then this works just
like \fBU\fP\&. This is the default mode.
.TP
.B \fBU\fP
Both capture and transfer unknown or varying. Filter selects among
\fBt\fP, \fBb\fP and \fBp\fP using image analysis only.
.TP
.B \fBv\fP
Verbose operation. Prints the selected mode for each frame and the
average squared difference between fields for \fBt\fP, \fBb\fP, and \fBp\fP
alternatives. (Ignored when libavfilter is used.)
.UNINDENT
.TP
.B \fByadif=[mode[:enabled=yes|no]]\fP
Yet another deinterlacing filter
.INDENT 7.0
.TP
.B \fB<mode>\fP
.INDENT 7.0
.TP
.B frame
Output 1 frame for each frame.
.TP
.B field
Output 1 frame for each field.
.TP
.B frame\-nospatial
Like \fBframe\fP but skips spatial interlacing check.
.TP
.B field\-nospatial
Like \fBfield\fP but skips spatial interlacing check.
.UNINDENT
.TP
.B \fB<enabled>\fP
.INDENT 7.0
.TP
.B yes
Filter is active (default).
.TP
.B no
Filter is not active, but can be activated with the \fBD\fP key
(or any other key that toggles the \fBdeinterlace\fP property).
.UNINDENT
.UNINDENT
.sp
This filter, is automatically inserted when using the \fBD\fP key (or any
other key that toggles the \fBdeinterlace\fP property or when using the
\fB\-\-deinterlace\fP switch), assuming the video output does not have native
deinterlacing support.
.sp
If you just want to set the default mode, put this filter and its options
into \fB\-\-vf\-defaults\fP instead, and enable deinterlacing with \fBD\fP or
\fB\-\-deinterlace\fP\&.
.sp
Also note that the \fBD\fP key is stupid enough to insert an interlacer twice
when inserting yadif with \fB\-\-vf\fP, so using the above methods is
recommended.
.TP
.B \fBdelogo[=x:y:w:h:t:show]\fP
Suppresses a TV station logo by a simple interpolation of the surrounding
pixels. Just set a rectangle covering the logo and watch it disappear (and
sometimes something even uglier appear \- your mileage may vary).
.INDENT 7.0
.TP
.B \fB<x>,<y>\fP
top left corner of the logo
.TP
.B \fB<w>,<h>\fP
width and height of the cleared rectangle
.TP
.B \fB<t>\fP
Thickness of the fuzzy edge of the rectangle (added to \fBw\fP and
\fBh\fP). When set to \-1, a green rectangle is drawn on the screen to
simplify finding the right \fBx\fP,\(ga\(gay\(ga\(ga,\(ga\(gaw\(ga\(ga,\(ga\(gah\(ga\(ga parameters.
.TP
.B \fBshow\fP
Draw a rectangle showing the area defined by x/y/w/h.
.UNINDENT
.TP
.B \fBscreenshot\fP
Optional filter for screenshot support. This is only needed if the video
output does not provide working direct screenshot support. Note that it is
not always safe to insert this filter by default. See \fI\%TAKING SCREENSHOTS\fP
for details.
.TP
.B \fBsub=[=bottom\-margin:top\-margin]\fP
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.
.INDENT 7.0
.TP
.B \fB<bottom\-margin>\fP
Adds a black band at the bottom of the frame. The SSA/ASS renderer can
place subtitles there (with \fB\-\-ass\-use\-margins\fP).
.TP
.B \fB<top\-margin>\fP
Black band on the top for toptitles  (with \fB\-\-ass\-use\-margins\fP).
.UNINDENT
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.TP
.B \fB\-\-vf=sub,eq\fP
Moves sub rendering before the eq filter. This will put both
subtitle colors and video under the influence of the video equalizer
settings.
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBstereo3d[=in:out]\fP
Stereo3d converts between different stereoscopic image formats.
.INDENT 7.0
.TP
.B \fB<in>\fP
Stereoscopic image format of input. Possible values:
.INDENT 7.0
.TP
.B \fBsbsl\fP or \fBside_by_side_left_first\fP
side by side parallel (left eye left, right eye right)
.TP
.B \fBsbsr\fP or \fBside_by_side_right_first\fP
side by side crosseye (right eye left, left eye right)
.TP
.B \fBabl\fP or \fBabove_below_left_first\fP
above\-below (left eye above, right eye below)
.TP
.B \fBabr\fP or \fBabove_below_right_first\fP
above\-below (right eye above, left eye below)
.TP
.B \fBab2l\fP or \fBabove_below_half_height_left_first\fP
above\-below with half height resolution (left eye above, right eye
below)
.TP
.B \fBab2r\fP or \fBabove_below_half_height_right_first\fP
above\-below with half height resolution (right eye above, left eye
below)
.UNINDENT
.TP
.B \fB<out>\fP
Stereoscopic image format of output. Possible values are all the input
formats as well as:
.INDENT 7.0
.TP
.B \fBarcg\fP or \fBanaglyph_red_cyan_gray\fP
anaglyph red/cyan gray (red filter on left eye, cyan filter on
right eye)
.TP
.B \fBarch\fP or \fBanaglyph_red_cyan_half_color\fP
anaglyph red/cyan half colored (red filter on left eye, cyan filter
on right eye)
.TP
.B \fBarcc\fP or \fBanaglyph_red_cyan_color\fP
anaglyph red/cyan color (red filter on left eye, cyan filter on
right eye)
.TP
.B \fBarcd\fP or \fBanaglyph_red_cyan_dubois\fP
anaglyph red/cyan color optimized with the least\-squares
projection of Dubois (red filter on left eye, cyan filter on right
eye)
.TP
.B \fBagmg\fP or \fBanaglyph_green_magenta_gray\fP
anaglyph green/magenta gray (green filter on left eye, magenta
filter on right eye)
.TP
.B \fBagmh\fP or \fBanaglyph_green_magenta_half_color\fP
anaglyph green/magenta half colored (green filter on left eye,
magenta filter on right eye)
.TP
.B \fBagmc\fP or \fBanaglyph_green_magenta_color\fP
anaglyph green/magenta colored (green filter on left eye, magenta
filter on right eye)
.TP
.B \fBaybg\fP or \fBanaglyph_yellow_blue_gray\fP
anaglyph yellow/blue gray (yellow filter on left eye, blue filter
on right eye)
.TP
.B \fBaybh\fP or \fBanaglyph_yellow_blue_half_color\fP
anaglyph yellow/blue half colored (yellow filter on left eye, blue
filter on right eye)
.TP
.B \fBaybc\fP or \fBanaglyph_yellow_blue_color\fP
anaglyph yellow/blue colored (yellow filter on left eye, blue
filter on right eye)
.TP
.B \fBirl\fP or \fBinterleave_rows_left_first\fP
Interleaved rows (left eye has top row, right eye starts on next
row)
.TP
.B \fBirr\fP or \fBinterleave_rows_right_first\fP
Interleaved rows (right eye has top row, left eye starts on next
row)
.TP
.B \fBml\fP or \fBmono_left\fP
mono output (left eye only)
.TP
.B \fBmr\fP or \fBmono_right\fP
mono output (right eye only)
.UNINDENT
.UNINDENT
.TP
.B \fBgradfun[=strength[:radius|:size=<size>]]\fP
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.
.INDENT 7.0
.TP
.B \fB<strength>\fP
Maximum amount by which the filter will change any one pixel. Also the
threshold for detecting nearly flat regions (default: 1.5).
.TP
.B \fB<radius>\fP
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).
.TP
.B \fB<size>\fP
size of the filter in percent of the image diagonal size. This is
used to calculate the final radius size (default: 1).
.UNINDENT
.TP
.B \fBdlopen=dll[:a0[:a1[:a2[:a3]]]]\fP
Loads an external library to filter the image. The library interface
is the \fBvf_dlopen\fP interface specified using \fBlibmpcodecs/vf_dlopen.h\fP\&.
.INDENT 7.0
.TP
.B \fBdll=<library>\fP
Specify the library to load. This may require a full file system path
in some cases. This argument is required.
.TP
.B \fBa0=<string>\fP
Specify the first parameter to pass to the library.
.TP
.B \fBa1=<string>\fP
Specify the second parameter to pass to the library.
.TP
.B \fBa2=<string>\fP
Specify the third parameter to pass to the library.
.TP
.B \fBa3=<string>\fP
Specify the fourth parameter to pass to the library.
.UNINDENT
.TP
.B \fBvapoursynth=file:buffered\-frames:concurrent\-frames\fP
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 \fBbuffered\-frames\fP parameter), and requests outside
of that will return errors. As such, you can\(aqt use the full power of
VapourSynth, but you can use certain filters.
.sp
If you just want to play video generated by a VapourSynth (i.e. using
a native VapourSynth video source), it\(aqs better to use \fBvspipe\fP and a
FIFO to feed the video to mpv. The same applies if the filter script
requires random frame access (see \fBbuffered\-frames\fP parameter).
.sp
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.
.INDENT 7.0
.TP
.B \fBfile\fP
Filename of the script source. Currently, this is always a python
script. The variable \fBvideo_in\fP 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 \fB_DurationNum\fP and
\fB_DurationDen\fP frame properties.
.INDENT 7.0
.INDENT 3.5
.IP "Example:"
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import vapoursynth as vs
core = vs.get_core()
core.std.AddBorders(video_in, 10, 10, 20, 20).set_output()
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBWARNING:\fP
.INDENT 7.0
.INDENT 3.5
The script will be reloaded on every seek. This is done to reset
the filter properly on discontinuities.
.UNINDENT
.UNINDENT
.TP
.B \fBbuffered\-frames\fP
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 requests backwards. E.g. if \fBbuffered\-frames=5\fP, 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.
.sp
The actual number of buffered frames also depends on the value of the
\fBconcurrent\-frames\fP option. Currently, both option values are
multiplied to get the final buffer size.
.sp
(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.)
.TP
.B \fBconcurrent\-frames\fP
Number of frames that should be requested in parallel (default: 2). 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.
.UNINDENT
.TP
.B \fBvavpp\fP
VA\-AP\-API video post processing. Works with \fB\-\-vo=vaapi\fP and \fB\-\-vo=opengl\fP
only. Currently deinterlaces. This filter is automatically inserted if
deinterlacing is requested (either using the \fBD\fP key, by default mapped to
the command \fBcycle deinterlace\fP, or the \fB\-\-deinterlace\fP option).
.INDENT 7.0
.TP
.B \fBdeint=<method>\fP
Select the deinterlacing algorithm.
.INDENT 7.0
.TP
.B no
Don\(aqt perform deinterlacing.
.TP
.B first\-field
Show only first field (going by \fB\-\-field\-dominance\fP).
.TP
.B bob
bob deinterlacing (default).
.UNINDENT
.UNINDENT
.TP
.B \fBvdpaupp\fP
VDPAU video post processing. Works with \fB\-\-vo=vdpau\fP and \fB\-\-vo=opengl\fP
only. This filter is automatically inserted if deinterlacing is requested
(either using the \fBD\fP key, by default mapped to the command
\fBcycle deinterlace\fP, or the \fB\-\-deinterlace\fP option). When enabling
deinterlacing, it is always preferred over software deinterlacer filters
if the \fBvdpau\fP VO is used, and also if \fBopengl\fP is used and hardware
decoding was activated at least once (i.e. vdpau was loaded).
.INDENT 7.0
.TP
.B \fBsharpen=<\-1\-1>\fP
For positive values, apply a sharpening algorithm to the video, for
negative values a blurring algorithm (default: 0).
.TP
.B \fBdenoise=<0\-1>\fP
Apply a noise reduction algorithm to the video (default: 0; no noise
reduction).
.TP
.B \fBdeint=<yes|no>\fP
Whether deinterlacing is enabled (default: no). If enabled, it will use
the mode selected with \fBdeint\-mode\fP\&.
.TP
.B \fBdeint\-mode=<first\-field|bob|temporal|temporal\-spatial>\fP
Select deinterlacing mode (default: temporal).
All modes respect \fB\-\-field\-dominance\fP\&.
.sp
Note that there\(aqs currently a mechanism that allows the \fBvdpau\fP VO to
change the \fBdeint\-mode\fP of auto\-inserted \fBvdpaupp\fP filters. To avoid
confusion, it\(aqs recommended not to use the \fB\-\-vo=vdpau\fP suboptions
related to filtering.
.INDENT 7.0
.TP
.B first\-field
Show only first field.
.TP
.B bob
Bob deinterlacing.
.TP
.B temporal
Motion\-adaptive temporal deinterlacing. May lead to A/V desync
with slow video hardware and/or high resolution.
.TP
.B temporal\-spatial
Motion\-adaptive temporal deinterlacing with edge\-guided spatial
interpolation. Needs fast video hardware.
.UNINDENT
.TP
.B \fBchroma\-deint\fP
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.
.TP
.B \fBpullup\fP
Try to apply inverse telecine, needs motion adaptive temporal
deinterlacing.
.TP
.B \fBhqscaling=<0\-9>\fP
.INDENT 7.0
.TP
.B 0
Use default VDPAU scaling (default).
.TP
.B 1\-9
Apply high quality VDPAU scaling (needs capable hardware).
.UNINDENT
.UNINDENT
.TP
.B \fBbuffer=<num>\fP
Buffer \fB<num>\fP frames in the filter chain. This filter is probably pretty
useless, except for debugging. (Note that this won\(aqt help smoothing out
latencies with decoding, because the filter will never output a frame if
the buffer isn\(aqt full, except on EOF.)
.UNINDENT
.SH ENCODING
.sp
You can encode files from one format/codec to another using this facility.
.INDENT 0.0
.TP
.B \fB\-\-o=<filename>\fP
Enables encoding mode and specifies the output file name.
.TP
.B \fB\-\-of=<format>\fP
Specifies the output format (overrides autodetection by the file name
extension of the file specified by \fB\-o\fP). This can be a comma separated
list of possible formats to try. See \fB\-\-of=help\fP for a full list of
supported formats.
.TP
.B \fB\-\-ofopts=<options>\fP
Specifies the output format options for libavformat.
See \fB\-\-ofopts=help\fP for a full list of supported options.
.sp
Options are managed in lists. There are a few commands to manage the
options list.
.INDENT 7.0
.TP
.B \fB\-\-ofopts\-add=<options1[,options2,...]>\fP
Appends the options given as arguments to the options list.
.TP
.B \fB\-\-ofopts\-pre=<options1[,options2,...]>\fP
Prepends the options given as arguments to the options list.
.TP
.B \fB\-\-ofopts\-del=<index1[,index2,...]>\fP
Deletes the options at the given indexes. Index numbers start at 0,
negative numbers address the end of the list (\-1 is the last).
.TP
.B \fB\-\-ofopts\-clr\fP
Completely empties the options list.
.UNINDENT
.TP
.B \fB\-\-ofps=<float value>\fP
Specifies the output format time base (default: 24000). Low values like 25
limit video fps by dropping frames.
.TP
.B \fB\-\-oautofps\fP
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 \fB\-\-ofps\fP or
\fB\-\-oautofps\fP to force CFR encoding in these cases.
.TP
.B \fB\-\-omaxfps=<float value>\fP
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.
.TP
.B \fB\-\-oharddup\fP
If set, the frame rate given by \fB\-\-ofps\fP is attained not by skipping time
codes, but by duplicating frames (constant frame rate mode).
.TP
.B \fB\-\-oneverdrop\fP
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 \fB\-\-ofps\fP and absolutely
avoid \fB\-\-oautofps\fP\&.
.TP
.B \fB\-\-oac=<codec>\fP
Specifies the output audio codec. This can be a comma separated list of
possible codecs to try. See \fB\-\-oac=help\fP for a full list of supported
codecs.
.TP
.B \fB\-\-oaoffset=<value>\fP
Shifts audio data by the given time (in seconds) by adding/removing
samples at the start.
.TP
.B \fB\-\-oacopts=<options>\fP
Specifies the output audio codec options for libavcodec.
See \fB\-\-oacopts=help\fP for a full list of supported options.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.INDENT 0.0
.TP
.B "\fB\-\-oac=libmp3lame \-\-oacopts=b=128000\fP"
selects 128 kbps MP3 encoding.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Options are managed in lists. There are a few commands to manage the
options list.
.INDENT 7.0
.TP
.B \fB\-\-oacopts\-add=<options1[,options2,...]>\fP
Appends the options given as arguments to the options list.
.TP
.B \fB\-\-oacopts\-pre=<options1[,options2,...]>\fP
Prepends the options given as arguments to the options list.
.TP
.B \fB\-\-oacopts\-del=<index1[,index2,...]>\fP
Deletes the options at the given indexes. Index numbers start at 0,
negative numbers address the end of the list (\-1 is the last).
.TP
.B \fB\-\-oacopts\-clr\fP
Completely empties the options list.
.UNINDENT
.TP
.B \fB\-\-oafirst\fP
Force the audio stream to become the first stream in the output. By default
the order is unspecified.
.TP
.B \fB\-\-ovc=<codec>\fP
Specifies the output video codec. This can be a comma separated list of
possible codecs to try. See \fB\-\-ovc=help\fP for a full list of supported
codecs.
.TP
.B \fB\-\-ovoffset=<value>\fP
Shifts video data by the given time (in seconds) by shifting the pts
values.
.TP
.B \fB\-\-ovcopts <options>\fP
Specifies the output video codec options for libavcodec.
See \-\-ovcopts=help for a full list of supported options.
.INDENT 7.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.TP
.B \fB"\-\-ovc=mpeg4 \-\-oacopts=qscale=5"\fP
selects constant quantizer scale 5 for MPEG\-4 encoding.
.TP
.B \fB"\-\-ovc=libx264 \-\-ovcopts=crf=23"\fP
selects VBR quality factor 23 for H.264 encoding.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Options are managed in lists. There are a few commands to manage the
options list.
.INDENT 7.0
.TP
.B \fB\-\-ovcopts\-add=<options1[,options2,...]>\fP
Appends the options given as arguments to the options list.
.TP
.B \fB\-\-ovcopts\-pre=<options1[,options2,...]>\fP
Prepends the options given as arguments to the options list.
.TP
.B \fB\-\-ovcopts\-del=<index1[,index2,...]>\fP
Deletes the options at the given indexes. Index numbers start at 0,
negative numbers address the end of the list (\-1 is the last).
.TP
.B \fB\-\-ovcopts\-clr\fP
Completely empties the options list.
.UNINDENT
.TP
.B \fB\-\-ovfirst\fP
Force the video stream to become the first stream in the output. By default
the order is unspecified.
.TP
.B \fB\-\-ocopyts\fP
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.
.TP
.B \fB\-\-orawts\fP
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!
.TP
.B \fB\-\-no\-ometadata\fP
Turns off copying of metadata from input files to output files when
encoding (which is enabled by default).
.UNINDENT
.SH INPUT.CONF
.sp
The input.conf file consists of a list of key bindings, for example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
s screenshot      # take a screenshot with the s key
LEFT seek 15      # map the left\-arrow key to seeking forward by 15 seconds
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Each line maps a key to an input command. Keys are specified with their literal
value (upper case if combined with \fBShift\fP), or a name for special keys. For
example, \fBa\fP maps to the \fBa\fP key without shift, and \fBA\fP maps to \fBa\fP
with shift.
.sp
The file is located in the mpv configuration directory (normally at
\fB~/.config/mpv/input.conf\fP depending on platform). The default bindings are
defined here:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
https://github.com/mpv\-player/mpv/blob/master/etc/input.conf
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
A list of special keys can be obtained with
.INDENT 0.0
.INDENT 3.5
\fBmpv \-\-input\-keylist\fP
.UNINDENT
.UNINDENT
.sp
In general, keys can be combined with \fBShift\fP, \fBCtrl\fP and \fBAlt\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ctrl+q quit
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBmpv\fP can be started in input test mode, which displays key bindings and the
commands they\(aqre bound to on the OSD, instead of executing the commands:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mpv \-\-input\-test \-\-force\-window \-\-idle
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
(Only closing the window will make \fBmpv\fP exit, pressing normal keys will
merely display the binding, even if mapped to quit.)
.SS General Input Command Syntax
.sp
\fB[Shift+][Ctrl+][Alt+][Meta+]<key> [{<section>}] [<prefixes>] <command> (<argument>)* [; <command>]\fP
.sp
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
\fB\-\-no\-input\-right\-alt\-gr\fP changes this behavior.
.sp
Newlines always start a new binding. \fB#\fP starts a comment (outside of quoted
string arguments). To bind commands to the \fB#\fP key, \fBSHARP\fP can be used.
.sp
\fB<key>\fP is either the literal character the key produces (ASCII or Unicode
character), or a symbolic name (as printed by \fB\-\-input\-keylist\fP).
.sp
\fB<section>\fP (braced with \fB{\fP and \fB}\fP) is the input section for this
command.
.sp
Arguments are separated by whitespace. This applies even to string arguments.
For this reason, string arguments should be quoted with \fB"\fP\&. Inside quotes,
C\-style escaping can be used.
.sp
You can bind multiple commands to one key. For example:
.nf
a show_text "command 1" ; show_text "command 2"
.fi
.sp
.sp
It\(aqs also possible to bind a command to a sequence of keys:
.nf
a\-b\-c show_text "command run after a, b, c have been pressed"
.fi
.sp
.sp
(This is not shown in the general command syntax.)
.sp
If \fBa\fP or \fBa\-b\fP or \fBb\fP 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 \fBignore\fP in order to avoid this issue. The maximum number
of (non\-modifier) keys for combinations is currently 4.
.SS List of Input Commands
.INDENT 0.0
.TP
.B \fBignore\fP
Use this to "block" keys that should be unbound, and do nothing. Useful for
disabling default bindings, without disabling all bindings with
\fB\-\-no\-input\-default\-bindings\fP\&.
.TP
.B \fBseek <seconds> [relative|absolute|absolute\-percent|\- [default\-precise|exact|keyframes]]\fP
Change the playback position. By default, seeks by a relative amount of
seconds.
.sp
The second argument sets the seek mode:
.INDENT 7.0
.TP
.B relative (default)
Seek relative to current position (a negative value seeks backwards).
.TP
.B absolute
Seek to a given time.
.TP
.B absolute\-percent
Seek to a given percent position.
.UNINDENT
.sp
The third argument defines how exact the seek is:
.INDENT 7.0
.TP
.B default\-precise (default)
Follow the default behavior as set by \fB\-\-hr\-seek\fP, which by default
does imprecise seeks (like \fBkeyframes\fP).
.TP
.B exact
Always do exact/hr/precise seeks (slow).
.TP
.B keyframes
Always restart playback at keyframe boundaries (fast).
.UNINDENT
.TP
.B \fBrevert_seek\fP
Undoes the \fBseek\fP 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
\fBrevert_seek\fP command itself.
.TP
.B \fBframe_step\fP
Play one frame, then pause. Does nothing with audio\-only playback.
.TP
.B \fBframe_back_step\fP
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 \fB\-\-hr\-seek\-demuxer\-offset\fP 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 \fB\-\-hr\-seek\-framedrop=no\fP should help, although it
might make precise seeking slower.
.sp
This does not work with audio\-only playback.
.TP
.B \fBset <property> "<value>"\fP
Set the given property to the given value.
.TP
.B \fBadd <property> [<value>]\fP
Add the given value to the property. On overflow or underflow, clamp the
property to the maximum. If \fB<value>\fP is omitted, assume \fB1\fP\&.
.TP
.B \fBcycle <property> [up|down]\fP
Cycle the given property. \fBup\fP and \fBdown\fP set the cycle direction. On
overflow, set the property back to the minimum, on underflow set it to the
maximum. If \fBup\fP or \fBdown\fP is omitted, assume \fBup\fP\&.
.TP
.B \fBmultiply <property> <factor>\fP
Multiplies the value of a property with the numeric factor.
.TP
.B \fBscreenshot [subtitles|video|window|\- [single|each\-frame]]\fP
Take a screenshot.
.sp
First argument:
.INDENT 7.0
.TP
.B <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.
.TP
.B <video>
Like \fBsubtitles\fP, but typically without OSD or subtitles. The exact
behavior depends on the selected video output.
.TP
.B <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 \fBvideo\fP\&.
.UNINDENT
.sp
Second argument:
.INDENT 7.0
.TP
.B <single> (default)
Take a single screenshot.
.TP
.B <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.
.UNINDENT
.TP
.B \fBscreenshot_to_file "<filename>" [subtitles|video|window]\fP
Take a screenshot and save it to a given file. The format of the file will
be guessed by the extension (and \fB\-\-screenshot\-format\fP is ignored \- the
behavior when the extension is missing or unknown is arbitrary).
.sp
The second argument is like the first argument to \fBscreenshot\fP\&.
.sp
This command tries to never overwrite files. If the file already exists,
it fails.
.sp
Like all input command parameters, the filename is subject to property
expansion as described in \fI\%Property Expansion\fP\&.
.TP
.B \fBplaylist_next [weak|force]\fP
Go to the next entry on the playlist.
.INDENT 7.0
.TP
.B weak (default)
If the last file on the playlist is currently played, do nothing.
.TP
.B force
Terminate playback if there are no more files on the playlist.
.UNINDENT
.TP
.B \fBplaylist_prev [weak|force]\fP
Go to the previous entry on the playlist.
.INDENT 7.0
.TP
.B weak (default)
If the first file on the playlist is currently played, do nothing.
.TP
.B force
Terminate playback if the first file is being played.
.UNINDENT
.TP
.B \fBloadfile "<file>" [replace|append [options]]\fP
Load the given file and play it.
.sp
Second argument:
.INDENT 7.0
.TP
.B <replace> (default)
Stop playback of the current file, and play the new file immediately.
.TP
.B <append>
Append the file to the playlist.
.TP
.B <append\-play>
Append the file, and if nothing is currently playing, start playback.
.UNINDENT
.sp
The third argument is a list of options and values which should be set
while the file is playing. It is of the form \fBopt1=value1,opt2=value2,..\fP\&.
Not all options can be changed this way. Some options require a restart
of the player.
.TP
.B \fBloadlist "<playlist>" [replace|append]\fP
Load the given playlist file (like \fB\-\-playlist\fP).
.TP
.B \fBplaylist_clear\fP
Clear the playlist, except the currently played file.
.TP
.B \fBplaylist_remove current|<index>\fP
Remove the playlist entry at the given index. Index values start counting
with 0. The special value \fBcurrent\fP removes the current entry. Note that
removing the current entry also stops playback and starts playing the next
entry.
.TP
.B \fBplaylist_move <index1> <index2>\fP
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.)
.TP
.B \fBrun "command" "arg1" "arg2" ...\fP
(Unix only)
Run the given command. Unlike in MPlayer/mplayer2 and earlier versions of
mpv (0.2.x and older), this doesn\(aqt call the shell. Instead, the command
is run directly, with each argument passed separately. Each argument is
expanded like in \fI\%Property Expansion\fP\&. Note that there is a static limit
of (as of this writing) 9 arguments (this limit could be raised on demand).
.sp
The program is run in a detached way. mpv doesn\(aqt wait until the command
is completed, but continues playback right after spawning it.
.sp
To get the old behavior, use \fB/bin/sh\fP and \fB\-c\fP as the first two
arguments.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.sp
\fBrun "/bin/sh" "\-c" "echo ${title} > /tmp/playing"\fP
.sp
This is not a particularly good example, because it doesn\(aqt 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 \fBrun\fP\&.
.UNINDENT
.UNINDENT
.TP
.B \fBquit [<code>]\fP
Exit the player. If an argument is given, it\(aqs used as process exit code.
.TP
.B \fBquit_watch_later [<code>]\fP
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 \fBquit\fP command.
.TP
.B \fBsub_add "<file>"\fP
Load the given subtitle file. It is selected as current subtitle after
loading.
.TP
.B \fBsub_remove [<id>]\fP
Remove the given subtitle track. If the \fBid\fP argument is missing, remove
the current track. (Works on external subtitle files only.)
.TP
.B \fBsub_reload [<id>]\fP
Reload the given subtitle tracks. If the \fBid\fP argument is missing, reload
the current track. (Works on external subtitle files only.)
.sp
This works by unloading and re\-adding the subtitle track.
.TP
.B \fBsub_step <skip>\fP
Change subtitle timing such, that the subtitle event after the next
\fB<skip>\fP subtitle events is displayed. \fB<skip>\fP can be negative to step
backwards.
.TP
.B \fBsub_seek <skip>\fP
Seek to the next (skip set to 1) or the previous (skip set to \-1) subtitle.
This is similar to \fBsub_step\fP, except that it seeks video and audio
instead of adjusting the subtitle delay.
.sp
Like with \fBsub_step\fP, this works with external text subtitles only. For
embedded text subtitles (like with Matroska), this works only with subtitle
events that have already been displayed.
.TP
.B \fBosd [<level>]\fP
Toggle OSD level. If \fB<level>\fP is specified, set the OSD mode
(see \fB\-\-osd\-level\fP for valid values).
.TP
.B \fBprint_text "<string>"\fP
Print text to stdout. The string can contain properties (see
\fI\%Property Expansion\fP).
.TP
.B \fBshow_text "<string>" [<duration>|\- [<level>]]\fP
Show text on the OSD. The string can contain properties, which are expanded
as described in \fI\%Property Expansion\fP\&. This can be used to show playback
time, filename, and so on.
.INDENT 7.0
.TP
.B <duration>
The time in ms to show the message for. By default, it uses the same
value as \fB\-\-osd\-duration\fP\&.
.TP
.B <level>
The minimum OSD level to show the text at (see \fB\-\-osd\-level\fP).
.UNINDENT
.TP
.B \fBshow_progress\fP
Show the progress bar, the elapsed time and the total duration of the file
on the OSD.
.TP
.B \fBdiscnav "<command>"\fP
Send a menu control command to the DVD/BD menu implementation. The following
commands are defined: \fBup\fP, \fBdown\fP, \fBleft\fP, \fBright\fP,
\fBmenu\fP (request to enter menu), \fBprev\fP (previous screen),
\fBselect\fP (activate current button), \fBmouse\fP (the mouse was clicked),
\fBmouse_move\fP (the mouse cursor changed position).
.sp
\fBmouse_move\fP will use the current mouse position.
.sp
Note that while the menu is active, the input section \fBdiscnav\-menu\fP will
be enabled, so different key bindings can be mapped for menu mode.
.TP
.B \fBwrite_watch_later_config\fP
Write the resume config file that the \fBquit_watch_later\fP command writes,
but continue playback normally.
.TP
.B \fBstop\fP
Stop playback and clear playlist. With default settings, this is
essentially like \fBquit\fP\&. Useful for the client API: playback can be
stopped without terminating the player.
.UNINDENT
.SS Input Commands that are Possibly Subject to Change
.INDENT 0.0
.TP
.B \fBaf set|add|toggle|del|clr "filter1=params,filter2,..."\fP
Change audio filter chain. See \fBvf\fP command.
.TP
.B \fBvf set|add|toggle|del|clr "filter1=params,filter2,..."\fP
Change video filter chain.
.sp
The first argument decides what happens:
.INDENT 7.0
.TP
.B set
Overwrite the previous filter chain with the new one.
.TP
.B add
Append the new filter chain to the previous one.
.TP
.B 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.)
.TP
.B 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. \fB0\fP would denote the first filter. Negative
indexes start from the last filter, and \fB\-1\fP denotes the last
filter.
.TP
.B clr
Remove all filters. Note that like the other sub\-commands, this does
not control automatically inserted filters.
.UNINDENT
.sp
You can assign labels to filter by prefixing them with \fB@name:\fP (where
\fBname\fP 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 \fBadd\fP, using an already used label will replace the existing filter.
.sp
The \fBvf\fP command shows the list of requested filters on the OSD after
changing the filter chain. This is roughly equivalent to
\fBshow_text ${vf}\fP\&. Note that auto\-inserted filters for format conversion
are not shown on the list, only what was requested by the user.
.sp
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\(aqt
be run. Then it can happen that creating the video chain fails.
.INDENT 7.0
.INDENT 3.5
.IP "Example for input.conf"
.INDENT 0.0
.IP \(bu 2
\fBa vf set flip\fP turn video upside\-down on the \fBa\fP key
.IP \(bu 2
\fBb vf set ""\fP remove all video filters on \fBb\fP
.IP \(bu 2
\fBc vf toggle lavfi=gradfun\fP toggle debanding on \fBc\fP
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBcycle_values ["!reverse"] <property> "<value1>" "<value2>" ...\fP
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.
.sp
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.
.sp
The special argument \fB!reverse\fP 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.
.sp
Note that there is a static limit of (as of this writing) 10 arguments
(this limit could be raised on demand).
.TP
.B \fBenable_section "<section>" [default|exclusive]\fP
Enable all key bindings in the named input section.
.sp
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.)
.sp
If \fBexclusive\fP is specified as second argument, all sections below the
newly enabled section are disabled. They will be re\-enabled as soon as
all exclusive sections above them are removed.
.TP
.B \fBdisable_section "<section>"\fP
Disable the named input section. Undoes \fBenable_section\fP\&.
.TP
.B \fBoverlay_add <id> <x> <y> "<file>" <offset> "<fmt>" <w> <h> <stride>\fP
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.
.sp
Overlays are usually displayed in screen resolution, but with some VOs,
the resolution is reduced to that of the video\(aqs. You can read the
\fBosd\-width\fP and \fBosd\-height\fP properties. At least with \fB\-\-vo\-xv\fP and
anamorphic video (such as DVD), \fBosd\-par\fP should be read as well, and the
overlay should be aspect\-compensated. (Future directions: maybe mpv should
take care of some of these things automatically, but it\(aqs hard to tell
where to draw the line.)
.sp
\fBid\fP 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
\fBoverlay_remove\fP\&. Using a previously unused ID will add a new overlay,
while reusing an ID will update it. (Future directions: there should be
something to ensure different programs wanting to create overlays don\(aqt
conflict with each others, should that ever be needed.)
.sp
\fBx\fP and \fBy\fP specify the position where the OSD should be displayed.
.sp
\fBfile\fP specifies the file the raw image data is read from. It can be
either a numeric UNIX file descriptor prefixed with \fB@\fP (e.g. \fB@4\fP),
or a filename. The file will be mapped into memory with \fBmmap()\fP\&. Some VOs
will pass the mapped pointer directly to display APIs (e.g. opengl or
vdpau), so no actual copying is involved. Truncating the source file while
the overlay is active will crash the player. You shouldn\(aqt change the data
while the overlay is active, because the data is essentially accessed at
random points. Instead, call \fBoverlay_add\fP again (preferably with a
different memory region to prevent tearing).
.sp
\fBoffset\fP is the offset of the first pixel in the source file. It is
passed directly to \fBmmap\fP and is subject to certain restrictions
(see \fBman mmap\fP for details). In particular, this value has to be a
multiple of the system\(aqs page size.
.sp
\fBfmt\fP is a string identifying the image format. Currently, only \fBbgra\fP
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\(aqt happen, and consequently implementations don\(aqt ensure that you
get predictable behavior in this case.)
.sp
\fBw\fP, \fBh\fP, and \fBstride\fP specify the size of the overlay. \fBw\fP is the
visible width of the overlay, while \fBstride\fP gives the width in bytes in
memory. In the simple case, and with the \fBbgra\fP format, \fBstride==4*w\fP\&.
In general, the total amount of memory accessed is \fBstride * h\fP\&.
(Technically, the minimum size would be \fBstride * (h \- 1) + w * 4\fP, but
for simplicity, the player will access all \fBstride * h\fP bytes.)
.INDENT 7.0
.INDENT 3.5
.IP "Warning"
.sp
When updating the overlay, you should prepare a second shared memory
region (e.g. make use of the offset parameter) and add this as overlay,
instead of reusing the same memory every time. Otherwise, you might
get the equivalent of tearing, when your application and mpv write/read
the buffer at the same time. Also, keep in mind that mpv might access
an overlay\(aqs memory at random times whenever it feels the need to do
so, for example when redrawing the screen.
.UNINDENT
.UNINDENT
.TP
.B \fBoverlay_remove <id>\fP
Remove an overlay added with \fBoverlay_add\fP and the same ID. Does nothing
if no overlay with this ID exists.
.TP
.B \fBscript_message "<arg1>" "<arg2>" ...\fP
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 \fBscript_message_to\fP).
.TP
.B \fBscript_message_to "<target>" "<arg1>" "<arg2>" ...\fP
Same as \fBscript_message\fP, but send it only to the client named
\fB<target>\fP\&. Each client (scripts etc.) has a unique name. For example,
Lua scripts can get their name via \fBmp.get_script_name()\fP\&.
.sp
(Scripts use this internally to dispatch key bindings, and this can also
be used in input.conf to reassign such bindings.)
.UNINDENT
.sp
Undocumented commands: \fBtv_last_channel\fP (TV/DVB only), \fBget_property\fP (?),
\fBvo_cmdline\fP (experimental).
.SS Input Command Prefixes
.sp
These prefixes are placed between key name and the actual command. Multiple
prefixes can be specified. They are separated by whitespace.
.INDENT 0.0
.TP
.B \fBosd\-auto\fP (default)
Use the default behavior for this command.
.TP
.B \fBno\-osd\fP
Do not use any OSD for this command.
.TP
.B \fBosd\-bar\fP
If possible, show a bar with this command. Seek commands will show the
progress bar, property changing commands may show the newly set value.
.TP
.B \fBosd\-msg\fP
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.
.TP
.B \fBosd\-msg\-bar\fP
Combine osd\-bar and osd\-msg.
.TP
.B \fBraw\fP
Do not expand properties in string arguments. (Like \fB"${property\-name}"\fP\&.)
.TP
.B \fBexpand\-properties\fP (default)
All string arguments are expanded as described in \fI\%Property Expansion\fP\&.
.UNINDENT
.sp
All of the osd prefixes are still overridden by the global \fB\-\-osd\-level\fP
settings.
.SS Input Sections
.sp
Input sections group a set of bindings, and enable or disable them at once.
In \fBinput.conf\fP, each key binding is assigned to an input section, rather
than actually having explicit text sections.
.sp
Also see \fBenable_section\fP and \fBdisable_section\fP commands.
.sp
Predefined bindings:
.INDENT 0.0
.TP
.B \fBdefault\fP
Bindings without input section are implicitly assigned to this section. It
is enabled by default during normal playback.
.TP
.B \fBencode\fP
Section which is active in encoding mode. It is enabled exclusively, so
that bindings in the \fBdefault\fP sections are ignored.
.UNINDENT
.SS Properties
.sp
Properties are used to set mpv options during runtime, or to query arbitrary
information. They can be manipulated with the \fBset\fP/\fBadd\fP/\fBcycle\fP
commands, and retrieved with \fBshow_text\fP, or anything else that uses property
expansion. (See \fI\%Property Expansion\fP\&.)
.sp
The property name is annotated with RW to indicate whether the property is
generally writable.
.sp
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.
.SS Property list
.INDENT 0.0
.TP
.B \fBosd\-level\fP (RW)
See \fB\-\-osd\-level\fP\&.
.TP
.B \fBosd\-scale\fP (RW)
OSD font size multiplier, see \fB\-\-osd\-scale\fP\&.
.TP
.B \fBloop\fP (RW)
See \fB\-\-loop\fP\&.
.TP
.B \fBloop\-file\fP (RW)
See \fB\-\-loop\-file\fP (uses \fByes\fP/\fBno\fP).
.TP
.B \fBspeed\fP (RW)
See \fB\-\-speed\fP\&.
.TP
.B \fBfilename\fP
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 \fBpath\fP property to get an
unmodified filename.)
.TP
.B \fBfile\-size\fP
Length in bytes of the source file/stream. (This is the same as
\fB${stream\-end}\fP\&. For ordered chapters and such, the
size of the currently played segment is returned.)
.TP
.B \fBestimated\-frame\-count\fP
Total number of frames in current file.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only an estimate. (It\(aqs computed from two unreliable
quantities: fps and stream length.)
.UNINDENT
.UNINDENT
.TP
.B \fBestimated\-frame\-number\fP
Number of current frame in current stream.
.sp
\fBNOTE:\fP
.INDENT 7.0
.INDENT 3.5
This is only an estimate. (It\(aqs computed from two unreliable
quantities: fps and possibly rounded timestamps.)
.UNINDENT
.UNINDENT
.TP
.B \fBpath\fP
Full path of the currently played file.
.TP
.B \fBmedia\-title\fP
If libquvi is used and libquvi returns a page title for the currently
played URL, return the page title.
.sp
Otherwise, if the currently played file has a \fBtitle\fP tag, use that.
.sp
Otherwise, if the media type is DVD, return the volume ID of DVD.
.sp
Otherwise, return the \fBfilename\fP property.
.TP
.B \fBdemuxer\fP
Name of the current demuxer. (This is useless.)
.TP
.B \fBstream\-path\fP
Filename (full path) of the stream layer filename. (This is probably
useless. It looks like this can be different from \fBpath\fP only when
using e.g. ordered chapters.)
.TP
.B \fBstream\-pos\fP (RW)
Raw byte position in source stream.
.TP
.B \fBstream\-end\fP
Raw end position in bytes in source stream.
.TP
.B \fBlength\fP
Length of the current file in seconds. If the length is unknown, the
property is unavailable. Note that the file duration is not always exactly
known, so this is an estimate.
.TP
.B \fBavsync\fP
Last A/V synchronization difference. Unavailable if audio or video is
disabled.
.TP
.B \fBtotal\-avsync\-change\fP
Total A\-V sync correction done. Unavailable if audio or video is
disabled.
.TP
.B \fBdrop\-frame\-count\fP
Frames dropped because they arrived too late. Doesn\(aqt necessarily indicate
actual frame\-drops, just the number of times the decoder was asked to drop.
Unavailable if video is disabled
.TP
.B \fBvo\-drop\-frame\-count\fP
Frames dropped by VO (when using \fB\-\-framedrop=vo\fP).
.TP
.B \fBpercent\-pos\fP (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.
.TP
.B \fBtime\-pos\fP (RW)
Position in current file in seconds.
.TP
.B \fBtime\-start\fP
Return the start time of the file. (Usually 0, but some kind of files,
especially transport streams, can have a different start time.)
.TP
.B \fBtime\-remaining\fP
Remaining length of the file in seconds. Note that the file duration is not
always exactly known, so this is an estimate.
.TP
.B \fBplaytime\-remaining\fP
\fBtime\-remaining\fP scaled by the the current \fBspeed\fP\&.
.TP
.B \fBplayback\-time\fP
Return the playback time, which is the time difference between start PTS and current PTS.
.TP
.B \fBchapter\fP (RW)
Current chapter number. The number of the first chapter is 0.
.TP
.B \fBedition\fP (RW)
Current MKV edition number. Setting this property to a different value will
restart playback. The number of the first edition is 0.
.TP
.B \fBdisc\-titles\fP
Number of BD/DVD titles.
.TP
.B \fBdisc\-title\fP (RW)
Current BD/DVD title number. Writing works only for \fBdvdnav://\fP and
\fBbd://\fP (and aliases for these).
.TP
.B \fBdisc\-menu\-active\fP
Return \fByes\fP if the BD/DVD menu is active, or \fBno\fP on normal video
playback. The property is unavailable when playing something that is not
a BD or DVD. Use the \fBdiscnav menu\fP command to actually enter or leave
menu mode.
.TP
.B \fBchapters\fP
Number of chapters.
.TP
.B \fBeditions\fP
Number of MKV editions.
.TP
.B \fBedition\-list\fP
List of editions, current entry marked. Currently, the raw property value
is useless.
.sp
This has a number of sub\-properties. Replace \fBN\fP with the 0\-based edition
index.
.INDENT 7.0
.TP
.B \fBedition\-list/count\fP
Number of editions. If there are no editions, this can be 0 or 1 (1
if there\(aqs a useless dummy edition).
.TP
.B \fBedition\-list/N/id\fP
Edition ID as integer. Use this to set the \fBedition\fP property.
Currently, this is the same as the edition index.
.TP
.B \fBedition\-list/N/default\fP
\fByes\fP if this is the default edition, \fBno\fP otherwise.
.TP
.B \fBedition\-list/N/title\fP
Edition title as stored in the file. Not always available.
.UNINDENT
.sp
When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
the following contents:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
MPV_FORMAT_NODE_ARRAY
    MPV_FORMAT_NODE_MAP (for each edition)
        "id"                MPV_FORMAT_INT64
        "title"             MPV_FORMAT_STRING
        "default"           MPV_FORMAT_FLAG
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B \fBangle\fP (RW)
Current DVD angle.
.TP
.B \fBmetadata\fP
Metadata key/value pairs.
.sp
If the property is accessed with Lua\(aqs \fBmp.get_property_native\fP, this
returns a table with metadata keys mapping to metadata values. If it is
accessed with the client API, this returns a \fBMPV_FORMAT_NODE_MAP\fP,
with tag keys mapping to tag values.
.sp
For OSD, it returns a formatted list. Trying to retrieve this property as
a raw string doesn\(aqt work.
.sp
This has a number of sub\-properties:
.INDENT 7.0
.TP
.B \fBmetadata/by\-key/<key>\fP
Value of metadata entry \fB<key>\fP\&.
.TP
.B \fBmetadata/list/count\fP
Number of metadata entries.
.TP
.B \fBmetadata/list/N/key\fP
Key name of the Nth metadata entry. (The first entry is \fB0\fP).
.TP
.B \fBmetadata/list/N/value\fP
Value of the Nth metadata entry.
.TP
.B \fBmetadata/<key>\fP
Old version of \fBmetadata/by\-key/<key>\fP\&. Use is discouraged, because
the metadata key string could conflict with other sub\-properties.
.UNINDENT
.sp
The layout of this property might be subject to change. Suggestions are
welcome how exactly this property should work.
.sp
When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
the following contents:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
MPV_FORMAT_NODE_MAP
    (key and string value for each metadata entry)
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B \fBchapter\-metadata\fP
Metadata of current chapter. Works similar to \fBmetadata\fP property. It
also allows the same access methods (using sub\-properties).
.sp
Per\-chapter metadata is very rare. Usually, only the chapter name
(\fBtitle\fP) is set.
.sp
For accessing other information, like chapter start, see the
\fBchapter\-list\fP property.
.TP
.B \fBvf\-metadata/<filter\-label>\fP
Metadata added by video filters. Accessed by the filter label,
which if not explicitly specified using the \fB@filter\-label:\fP syntax,
will be \fB<filter\-name>NN\fP\&.
.sp
Works similar to \fBmetadata\fP property. It allows the same access
methods (using sub\-properties).
.sp
An example of these kind of metadata are the cropping parameters
added by \fB\-\-vf=lavfi=cropdetect\fP\&.
.TP
.B \fBpause\fP (RW)
Pause status. This is usually \fByes\fP or \fBno\fP\&. See \fB\-\-pause\fP\&.
.TP
.B \fBcore\-idle\fP
Return \fByes\fP if the playback core is paused, otherwise \fBno\fP\&. This can
be different \fBpause\fP in special situations, such as when the player
pauses itself due to low network cache.
.TP
.B \fBcache\fP
Network cache fill state (0\-100.0).
.TP
.B \fBcache\-size\fP (RW)
Total network cache size in KB. This is similar to \fB\-\-cache\fP\&. This allows
to set the cache size at runtime. Currently, it\(aqs not possible to enable
or disable the cache at runtime using this property, just to resize an
existing cache.
.sp
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.
.sp
Don\(aqt use this when playing DVD or Blu\-ray.
.TP
.B \fBcache\-free\fP (R)
Total free cache size in KB.
.TP
.B \fBcache\-used\fP (R)
Total used cache size in KB.
.TP
.B \fBcache\-idle\fP (R)
Returns \fByes\fP if the cache is idle, which means the cache is filled as
much as possible, and is currently not reading more data.
.TP
.B \fBdemuxer\-cache\-duration\fP
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.
.TP
.B \fBdemuxer\-cache\-idle\fP
Returns \fByes\fP if the demuxer is idle, which means the demuxer cache is
filled to the requested amount, and is currently not reading more data.
.TP
.B \fBpaused\-for\-cache\fP
Returns \fByes\fP when playback is paused because of waiting for the cache.
.TP
.B \fBeof\-reached\fP
Returns \fByes\fP if end of playback was reached, \fBno\fP otherwise. Note
that this is usually interesting only if \fB\-\-keep\-open\fP is enabled,
since otherwise the player will immediately play the next file (or exit
or enter idle mode), and in these cases the \fBeof\-reached\fP property will
logically be cleared immediately after it\(aqs set.
.TP
.B \fBseeking\fP
Returns \fByes\fP if the player is currently seeking, or otherwise trying
to restart playback. (It\(aqs possible that it returns \fByes\fP while a file
is loaded, or when switching ordered chapter segments. This is because
the same underlying code is used for seeking and resyncing.)
.TP
.B \fBpts\-association\-mode\fP (RW)
See \fB\-\-pts\-association\-mode\fP\&.
.TP
.B \fBhr\-seek\fP (RW)
See \fB\-\-hr\-seek\fP\&.
.TP
.B \fBvolume\fP (RW)
Current volume (0\-100).
.TP
.B \fBmute\fP (RW)
Current mute status (\fByes\fP/\fBno\fP).
.TP
.B \fBaudio\-delay\fP (RW)
See \fB\-\-audio\-delay\fP\&.
.TP
.B \fBaudio\-format\fP
Audio format as string.
.TP
.B \fBaudio\-codec\fP
Audio codec selected for decoding.
.TP
.B \fBaudio\-bitrate\fP
Audio bitrate. This is probably a very bad guess in most cases.
.TP
.B \fBaudio\-samplerate\fP
Audio samplerate.
.TP
.B \fBaudio\-channels\fP
Number of audio channels. The OSD value of this property is actually the
channel layout, while the raw value returns the number of channels only.
.TP
.B \fBaid\fP (RW)
Current audio track (similar to \fB\-\-aid\fP).
.TP
.B \fBaudio\fP (RW)
Alias for \fBaid\fP\&.
.TP
.B \fBbalance\fP (RW)
Audio channel balance. (The implementation of this feature is rather odd.
It doesn\(aqt change the volumes of each channel, but instead sets up a pan
matrix to mix the the left and right channels.)
.TP
.B \fBfullscreen\fP (RW)
See \fB\-\-fullscreen\fP\&.
.TP
.B \fBdeinterlace\fP (RW)
See \fB\-\-deinterlace\fP\&.
.TP
.B \fBcolormatrix\fP (RW)
See \fB\-\-colormatrix\fP\&.
.TP
.B \fBcolormatrix\-input\-range\fP (RW)
See \fB\-\-colormatrix\-input\-range\fP\&.
.TP
.B \fBcolormatrix\-output\-range\fP (RW)
See \fB\-\-colormatrix\-output\-range\fP\&.
.TP
.B \fBcolormatrix\-primaries\fP (RW)
See \fB\-\-colormatrix\-primaries\fP\&.
.TP
.B \fBontop\fP (RW)
See \fB\-\-ontop\fP\&.
.TP
.B \fBborder\fP (RW)
See \fB\-\-border\fP\&.
.TP
.B \fBframedrop\fP (RW)
See \fB\-\-framedrop\fP\&.
.TP
.B \fBgamma\fP (RW)
See \fB\-\-gamma\fP\&.
.TP
.B \fBbrightness\fP (RW)
See \fB\-\-brightness\fP\&.
.TP
.B \fBcontrast\fP (RW)
See \fB\-\-contrast\fP\&.
.TP
.B \fBsaturation\fP (RW)
See \fB\-\-saturation\fP\&.
.TP
.B \fBhue\fP (RW)
See \fB\-\-hue\fP\&.
.TP
.B \fBhwdec\fP (RW)
Return the current hardware decoder that is used. This uses the same values
as the \fB\-\-hwdec\fP option. If software decoding is active, this returns
\fBno\fP\&. You can write this property. Then the \fB\-\-hwdec\fP option is set to
the new value, and video decoding will be reinitialized (internally, the
player will perform a seek to refresh the video properly).
.sp
Note that you don\(aqt know the success of the operation immediately after
writing this property. It happens with a delay as video is reinitialized.
.TP
.B \fBpanscan\fP (RW)
See \fB\-\-panscan\fP\&.
.TP
.B \fBvideo\-format\fP
Video format as string.
.TP
.B \fBvideo\-codec\fP
Video codec selected for decoding.
.TP
.B \fBvideo\-bitrate\fP
Video bitrate (a bad guess).
.TP
.B \fBwidth\fP, \fBheight\fP
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.
.TP
.B \fBvideo\-params\fP
Video parameters, as output by the decoder (with overrides like aspect
etc. applied). This has a number of sub\-properties:
.INDENT 7.0
.TP
.B \fBvideo\-params/pixelformat\fP
The pixel format as string. This uses the same names as used in other
places of mpv.
.TP
.B \fBvideo\-params/w\fP, \fBvideo\-params/h\fP
Video size as integers, with no aspect correction applied.
.TP
.B \fBvideo\-params/dw\fP, \fBvideo\-params/dh\fP
Video size as integers, scaled for correct aspect ratio.
.TP
.B \fBvideo\-params/aspect\fP
Display aspect ratio as float.
.TP
.B \fBvideo\-params/par\fP
Pixel aspect ratio.
.TP
.B \fBvideo\-params/colormatrix\fP
The colormatrix in use as string. (Exact values subject to change.)
.TP
.B \fBvideo\-params/colorlevels\fP
The colorlevels as string. (Exact values subject to change.)
.TP
.B \fBvideo\-params/primaries\fP
The primaries in use as string. (Exact values subject to change.)
.TP
.B \fBvideo\-params/chroma\-location\fP
Chroma location as string. (Exact values subject to change.)
.TP
.B \fBvideo\-params/rotate\fP
Intended display rotation in degrees (clockwise).
.UNINDENT
.sp
When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
the following contents:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
MPV_FORMAT_NODE_ARRAY
    MPV_FORMAT_NODE_MAP (for each track)
        "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
        "chroma\-location"   MPV_FORMAT_STRING
        "rotate"            MPV_FORMAT_INT64
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B \fBdwidth\fP, \fBdheight\fP
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.
.sp
These have the same values as \fBvideo\-out\-params/dw\fP and
\fBvideo\-out\-params/dh\fP\&.
.TP
.B \fBvideo\-out\-params\fP
Same as \fBvideo\-params\fP, but after video filters have been applied. If
there are no video filters in use, this will contain the same values as
\fBvideo\-params\fP\&. 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.
.sp
Has the same sub\-properties as \fBvideo\-params\fP\&.
.TP
.B \fBfps\fP
Container FPS. This can easily contain bogus values. For videos that use
modern container formats or video codecs, this will often be incorrect.
.TP
.B \fBestimated\-vf\-fps\fP
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.
.TP
.B \fBwindow\-scale\fP (RW)
Window size multiplier. Setting this will resize the video window to the
values contained in \fBdwidth\fP and \fBdheight\fP multiplied with the value
set with this property. Setting \fB1\fP will resize to original video size
(or to be exact, the size the video filters output). \fB2\fP will set the
double size, \fB0.5\fP halves the size.
.TP
.B \fBvideo\-aspect\fP (RW)
Video aspect, see \fB\-\-video\-aspect\fP\&.
.TP
.B \fBosd\-width\fP, \fBosd\-height\fP
Last known OSD width (can be 0). This is needed if you want to use the
\fBoverlay_add\fP command. It gives you the actual OSD size, which can be
different from the window size in some cases.
.TP
.B \fBosd\-par\fP
Last known OSD display pixel aspect (can be 0).
.TP
.B \fBvid\fP (RW)
Current video track (similar to \fB\-\-vid\fP).
.TP
.B \fBvideo\fP (RW)
Alias for \fBvid\fP\&.
.TP
.B \fBvideo\-align\-x\fP, \fBvideo\-align\-y\fP (RW)
See \fB\-\-video\-align\-x\fP and \fB\-\-video\-align\-y\fP\&.
.TP
.B \fBvideo\-pan\-x\fP, \fBvideo\-pan\-y\fP (RW)
See \fB\-\-video\-pan\-x\fP and \fB\-\-video\-pan\-y\fP\&.
.TP
.B \fBvideo\-zoom\fP (RW)
See \fB\-\-video\-zoom\fP\&.
.TP
.B \fBvideo\-unscaled\fP (W)
See \fB\-\-video\-unscaled\fP\&.
.TP
.B \fBprogram\fP (W)
Switch TS program (write\-only).
.TP
.B \fBsid\fP (RW)
Current subtitle track (similar to \fB\-\-sid\fP).
.TP
.B \fBsecondary\-sid\fP (RW)
Secondary subtitle track (see \fB\-\-secondary\-sid\fP).
.TP
.B \fBsub\fP (RW)
Alias for \fBsid\fP\&.
.TP
.B \fBsub\-delay\fP (RW)
See \fB\-\-sub\-delay\fP\&.
.TP
.B \fBsub\-pos\fP (RW)
See \fB\-\-sub\-pos\fP\&.
.TP
.B \fBsub\-visibility\fP (RW)
See \fB\-\-sub\-visibility\fP\&.
.TP
.B \fBsub\-forced\-only\fP (RW)
See \fB\-\-sub\-forced\-only\fP\&.
.TP
.B \fBsub\-scale\fP (RW)
Subtitle font size multiplier.
.TP
.B \fBass\-use\-margins\fP (RW)
See \fB\-\-ass\-use\-margins\fP\&.
.TP
.B \fBass\-vsfilter\-aspect\-compat\fP (RW)
See \fB\-\-ass\-vsfilter\-aspect\-compat\fP\&.
.TP
.B \fBass\-style\-override\fP (RW)
See \fB\-\-ass\-style\-override\fP\&.
.TP
.B \fBstream\-capture\fP (RW)
A filename, see \fB\-\-stream\-capture\fP\&. Setting this will start capture using
the given filename. Setting it to an empty string will stop it.
.TP
.B \fBtv\-brightness\fP, \fBtv\-contrast\fP, \fBtv\-saturation\fP, \fBtv\-hue\fP (RW)
TV stuff.
.TP
.B \fBplaylist\-pos\fP (RW)
Current position on playlist. The first entry is on position 0. Writing
to the property will restart playback at the written entry.
.TP
.B \fBplaylist\-count\fP
Number of total playlist entries.
.TP
.B \fBplaylist\fP
Playlist, current entry marked. Currently, the raw property value is
useless.
.sp
This has a number of sub\-properties. Replace \fBN\fP with the 0\-based playlist
entry index.
.INDENT 7.0
.TP
.B \fBplaylist/count\fP
Number of playlist entries (same as \fBplaylist\-count\fP).
.TP
.B \fBplaylist/N/filename\fP
Filename of the Nth entry.
.UNINDENT
.sp
When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
the following contents:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
MPV_FORMAT_NODE_ARRAY
    MPV_FORMAT_NODE_MAP (for each playlist entry)
        "filename"  MPV_FORMAT_STRING
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B \fBtrack\-list\fP
List of audio/video/sub tracks, current entry marked. Currently, the raw
property value is useless.
.sp
This has a number of sub\-properties. Replace \fBN\fP with the 0\-based track
index.
.INDENT 7.0
.TP
.B \fBtrack\-list/count\fP
Total number of tracks.
.TP
.B \fBtrack\-list/N/id\fP
The ID as it\(aqs used for \fB\-sid\fP/\fB\-\-aid\fP/\fB\-\-vid\fP\&. This is unique
within tracks of the same type (sub/audio/video), but otherwise not.
.TP
.B \fBtrack\-list/N/type\fP
String describing the media type. One of \fBaudio\fP, \fBvideo\fP, \fBsub\fP\&.
.TP
.B \fBtrack\-list/N/src\-id\fP
Track ID as used in the source file. Not always available.
.TP
.B \fBtrack\-list/N/title\fP
Track title as it is stored in the file. Not always available.
.TP
.B \fBtrack\-list/N/lang\fP
Track language as identified by the file. Not always available.
.TP
.B \fBtrack\-list/N/albumart\fP
\fByes\fP if this is a video track that consists of a single picture,
\fBno\fP or unavailable otherwise. This is used for video tracks that are
really attached pictures in audio files.
.TP
.B \fBtrack\-list/N/default\fP
\fByes\fP if the track has the default flag set in the file, \fBno\fP
otherwise.
.TP
.B \fBtrack\-list/N/codec\fP
The codec name used by this track, for example \fBh264\fP\&. Unavailable
in some rare cases.
.TP
.B \fBtrack\-list/N/external\fP
\fByes\fP if the track is an external file, \fBno\fP otherwise. This is
set for separate subtitle files.
.TP
.B \fBtrack\-list/N/external\-filename\fP
The filename if the track is from an external file, unavailable
otherwise.
.TP
.B \fBtrack\-list/N/selected\fP
\fByes\fP if the track is currently decoded, \fBno\fP otherwise.
.UNINDENT
.sp
When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
the following contents:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
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
        "external"          MPV_FORMAT_FLAG
        "external\-filename" MPV_FORMAT_STRING
        "codec"             MPV_FORMAT_STRING
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B \fBchapter\-list\fP
List of chapters, current entry marked. Currently, the raw property value
is useless.
.sp
This has a number of sub\-properties. Replace \fBN\fP with the 0\-based chapter
index.
.INDENT 7.0
.TP
.B \fBchapter\-list/count\fP
Number of chapters.
.TP
.B \fBchapter\-list/N/title\fP
Chapter title as stored in the file. Not always available.
.TP
.B \fBchapter\-list/N/time\fP
Chapter start time in seconds as float.
.UNINDENT
.sp
When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
the following contents:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
MPV_FORMAT_NODE_ARRAY
    MPV_FORMAT_NODE_MAP (for each chapter)
        "title" MPV_FORMAT_STRING
        "time"  MPV_FORMAT_DOUBLE
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B \fBaf\fP (RW)
See \fB\-\-af\fP and the \fBaf\fP command.
.TP
.B \fBvf\fP (RW)
See \fB\-\-vf\fP and the \fBvf\fP command.
.sp
When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
the following contents:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
MPV_FORMAT_NODE_ARRAY
    MPV_FORMAT_NODE_MAP (for each filter entry)
        "name"      MPV_FORMAT_STRING
        "label"     MPV_FORMAT_STRING [optional]
        "params"    MPV_FORMAT_NODE_MAP [optional]
            "key"   MPV_FORMAT_STRING
            "value" MPV_FORMAT_STRING
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
It\(aqs also possible to write the property using this format.
.TP
.B \fBseekable\fP
Return whether it\(aqs generally possible to seek in the current file.
.TP
.B \fBosd\-sym\-cc\fP
Inserts the current OSD symbol as opaque OSD control code (cc). This makes
sense only with the \fBshow_text\fP command or options which set OSD messages.
The control code is implementation specific and is useless for anything else.
.TP
.B \fBosd\-ass\-cc\fP
\fB${osd\-ass\-cc/0}\fP disables escaping ASS sequences of text in OSD,
\fB${osd\-ass\-cc/1}\fP 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 \fBshow_text\fP command or options
which set OSD messages.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.sp
\-\-osd\-status\-msg=\(aqThis is ${osd\-ass\-cc/0}{\eb1}bold text\(aq
.UNINDENT
.UNINDENT
.sp
Any ASS override tags as understood by libass can be used.
.sp
Note that you need to escape the \fB\e\fP character, because the string is
processed for C escape sequences before passing it to the OSD code.
.TP
.B \fBoptions/<name>\fP (RW)
Read\-only access to value of option \fB\-\-<name>\fP\&. 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.
.TP
.B \fBproperty\-list\fP
Return the list of top\-level properties.
.UNINDENT
.SS Property Expansion
.sp
All string arguments to input commands as well as certain options (like
\fB\-\-term\-playing\-msg\fP) are subject to property expansion.
.INDENT 0.0
.INDENT 3.5
.IP "Example for input.conf"
.INDENT 0.0
.TP
.B \fBi show_text "Filename: ${filename}"\fP
shows the filename of the current file when pressing the \fBi\fP key
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Within \fBinput.conf\fP, property expansion can be inhibited by putting the
\fBraw\fP prefix in front of commands.
.sp
The following expansions are supported:
.INDENT 0.0
.TP
.B \fB${NAME}\fP
Expands to the value of the property \fBNAME\fP\&. If retrieving the property
fails, expand to an error string. (Use \fB${NAME:}\fP with a trailing
\fB:\fP to expand to an empty string instead.)
If \fBNAME\fP is prefixed with \fB=\fP, expand to the raw value of the property
(see section below).
.TP
.B \fB${NAME:STR}\fP
Expands to the value of the property \fBNAME\fP, or \fBSTR\fP if the
property cannot be retrieved. \fBSTR\fP is expanded recursively.
.TP
.B \fB${?NAME:STR}\fP
Expands to \fBSTR\fP (recursively) if the property \fBNAME\fP is available.
.TP
.B \fB${!NAME:STR}\fP
Expands to \fBSTR\fP (recursively) if the property \fBNAME\fP cannot be
retrieved.
.TP
.B \fB${?NAME==VALUE:STR}\fP
Expands to \fBSTR\fP (recursively) if the property \fBNAME\fP expands to a
string equal to \fBVALUE\fP\&. You can prefix \fBNAME\fP with \fB=\fP 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 \fBVALUE\fP can\(aqt contain any of the characters \fB:\fP or \fB}\fP\&.
Also, it is possible that escaping with \fB"\fP or \fB%\fP might be added in
the future, should the need arise.
.TP
.B \fB${!NAME==VALUE:STR}\fP
Same as with the \fB?\fP variant, but \fBSTR\fP is expanded if the value is
not equal. (Using the same semantics as with \fB?\fP\&.)
.TP
.B \fB$$\fP
Expands to \fB$\fP\&.
.TP
.B \fB$}\fP
Expands to \fB}\fP\&. (To produce this character inside recursive
expansion.)
.TP
.B \fB$>\fP
Disable property expansion and special handling of \fB$\fP for the rest
of the string.
.UNINDENT
.sp
In places where property expansion is allowed, C\-style escapes are often
accepted as well. Example:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fB\en\fP becomes a newline character
.IP \(bu 2
\fB\e\e\fP expands to \fB\e\fP
.UNINDENT
.UNINDENT
.UNINDENT
.SS Raw and Formatted Properties
.sp
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 \fB=\fP\&. These raw values
can be parsed by other programs and follow the same conventions as the options
associated with the properties.
.INDENT 0.0
.INDENT 3.5
.IP "Examples"
.INDENT 0.0
.IP \(bu 2
\fB${time\-pos}\fP expands to \fB00:14:23\fP (if playback position is at 14
minutes 23 seconds)
.IP \(bu 2
\fB${=time\-pos}\fP expands to \fB863.4\fP (same time, plus 400 milliseconds \-
milliseconds are normally not shown in the formatted case)
.UNINDENT
.UNINDENT
.UNINDENT
.sp
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 \fBtime\-pos\fP\&. Sometimes
it is the other way around, e.g. \fBaid\fP shows track title and language in the
formatted case, but only the track number if it is raw.
.SH ON SCREEN CONTROLLER
.sp
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.
.sp
The OSC is enabled by default if mpv was compiled with lua support. It can be
disabled entirely using the \fB\-\-osc=no\fP option.
.SS Using the OSC
.sp
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.
.SS The Interface
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| playlist prev    |   title   |      playlist next |
+\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-+\-\-+\-\-\-\-\-\-+\-+\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+
| audio | skip | seek |      | seek | skip |  full  |
+\-\-\-\-\-\-\-+ back | back | play | frwd | frwd | screen |
| sub   |      |      |      |      |      |        |
+\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-+
|                     seekbar                       |
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| time passed    | cache status |    time remaining |
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
.ft P
.fi
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B playlist prev
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
play previous file in playlist
T}
_
T{
shift+L\-click
T}	T{
show playlist
T}
_
.TE
.TP
.B title
.nf
Displays current media\-title or filename
.fi
.sp
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
show playlist position and length and full title
T}
_
T{
right\-click
T}	T{
show filename
T}
_
.TE
.TP
.B playlist next
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
play next file in playlist
T}
_
T{
shift+L\-click
T}	T{
show playlist
T}
_
.TE
.TP
.B audio and sub
.nf
Displays selected track and amount of available tracks
.fi
.sp
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
cycle audio/sub tracks forward
T}
_
T{
right\-click
T}	T{
cycle audio/sub tracks backwards
T}
_
T{
shift+L\-click
T}	T{
show available audio/sub tracks
T}
_
.TE
.TP
.B skip back
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
go to beginning of chapter / previous chapter
T}
_
T{
shift+L\-click
T}	T{
show chapters
T}
_
.TE
.TP
.B seek back
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
skip back  5 seconds
T}
_
T{
right\-click
T}	T{
skip back 30 seconds
T}
_
T{
shift\-L\-click
T}	T{
skip back  1 frame
T}
_
.TE
.TP
.B play
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
toggle play/pause
T}
_
.TE
.TP
.B seek frwd
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
skip forward 10 seconds
T}
_
T{
right\-click
T}	T{
skip forward 60 seconds
T}
_
T{
shift\-L\-click
T}	T{
skip forward  1 frame
T}
_
.TE
.TP
.B skip frwd
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
go to next chapter
T}
_
T{
shift+L\-click
T}	T{
show chapters
T}
_
.TE
.TP
.B fullscreen
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
toggle fullscreen
T}
_
.TE
.TP
.B seekbar
.nf
Indicates current playback position and position of chapters
.fi
.sp
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
seek to position
T}
_
.TE
.TP
.B time passed
.nf
Shows current playback position timestamp
.fi
.sp
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
toggle displaying timecodes with milliseconds
T}
_
.TE
.TP
.B cache status
.nf
Shows current cache fill status (only visible when below 45%)
.fi
.sp
.TP
.B time remaining
.nf
Shows remaining playback time timestamp
.fi
.sp
.TS
center;
|l|l|.
_
T{
left\-click
T}	T{
toggle between total and remaining time
T}
_
.TE
.UNINDENT
.SS Key Bindings
.sp
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 \fI\%Script Commands\fP section.
.TS
center;
|l|l|.
_
T{
del
T}	T{
Hide the OSC permanently until mpv is restarted.
T}
_
.TE
.SS Configuration
.sp
The OSC offers limited configuration through a config file
\fBlua\-settings/osc.conf\fP placed in mpv\(aqs user dir and through the
\fB\-\-lua\-opts\fP command\-line option. Options provided through the command\-line
will override those from the config file.
.SS Config Syntax
.sp
The config file must exactly follow the following syntax:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# this is a comment
optionA=value1
optionB=value2
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fB#\fP can only be used at the beginning of a line and there may be no
spaces around the \fB=\fP or anywhere else.
.SS Command\-line Syntax
.sp
To avoid collisions with other scripts, all options need to be prefixed with
\fBosc\-\fP\&.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-lua\-opts=osc\-optionA=value1,osc\-optionB=value2
.ft P
.fi
.UNINDENT
.UNINDENT
.SS Configurable Options
.INDENT 0.0
.TP
.B \fBshowwindowed\fP
.nf
Default: yes
Show OSC when windowed?
.fi
.sp
.TP
.B \fBshowfullscreen\fP
.nf
Default: yes
Show OSC when fullscreen?
.fi
.sp
.TP
.B \fBscalewindowed\fP
.nf
Default: 1
Scaling of the controller when windowed
.fi
.sp
.TP
.B \fBscalefullscreen\fP
.nf
Default: 1
Scaling of the controller when fullscreen
.fi
.sp
.TP
.B \fBscaleforcedwindow\fP
.nf
Default: 2
Scaling of the controller when rendered on a forced (dummy) window
.fi
.sp
.TP
.B \fBvidscale\fP
.nf
Default: yes
Scale the controller with the video?
.fi
.sp
.TP
.B \fBvalign\fP
.nf
Default: 0.8
Vertical alignment, \-1 (top) to 1 (bottom)
.fi
.sp
.TP
.B \fBhalign\fP
.nf
Default: 0
Horizontal alignment, \-1 (left) to 1 (right)
.fi
.sp
.TP
.B \fBboxalpha\fP
.nf
Default: 80
Alpha of the background box, 0 (opaque) to 255 (fully transparent)
.fi
.sp
.TP
.B \fBhidetimeout\fP
.nf
Default: 500
Duration in ms until the OSC hides if no mouse movement, negative value
disables auto\-hide
.fi
.sp
.TP
.B \fBfadeduration\fP
.nf
Default: 200
Duration of fade out in ms, 0 = no fade
.fi
.sp
.TP
.B \fBdeadzonesize\fP
.nf
Default: 0
Size of the deadzone. The deadzone is an area that makes the mouse act
like leaving the window. Movement there won\(aqt 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 and 1.
.fi
.sp
.TP
.B \fBminmousemove\fP
.nf
Default: 3
Minimum amount of pixels the mouse has to move between ticks to make
the OSC show up
.fi
.sp
.TP
.B \fBseektooltip\fP
.nf
Default: yes
Display a tooltip over the seekbar indicating time at mouse position.
.fi
.sp
.UNINDENT
.SS Script Commands
.sp
The OSC script listens to certain script commands. These commands can bound
in \fBinput.conf\fP, or sent by other scripts.
.INDENT 0.0
.TP
.B \fBenable\-osc\fP
Undoes \fBdisable\-osc\fP or the effect of the \fBdel\fP key.
.TP
.B \fBdisable\-osc\fP
Hide the OSC permanently. This is also what the \fBdel\fP key does.
.UNINDENT
.sp
Example
.sp
You could put this into \fBinput.conf\fP to hide the OSC with the \fBa\fP key and
to unhide it with \fBb\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
a script_message disable\-osc
b script_message enable\-osc
.ft P
.fi
.UNINDENT
.UNINDENT
.SH LUA SCRIPTING
.sp
mpv can load Lua scripts. Scripts passed to the \fB\-\-lua\fP option, or found in
the \fBlua\fP subdirectory of the mpv configuration directory (usually
\fB~/.config/mpv/lua/\fP) will be loaded on program start. mpv also appends the
\fBlua\fP subdirectory to the end of Lua\(aqs path so you can import scripts from
there too. Since it\(aqs added to the end, don\(aqt name scripts you want to import
the same as Lua libraries because they will be overshadowed by them.
.sp
mpv provides the built\-in module \fBmp\fP, which provides functions to send
commands to the mpv core and to retrieve information about playback state, user
settings, file information, and so on.
.sp
These scripts can be used to control mpv in a similar way to slave mode.
Technically, the Lua code uses the client API internally.
.SS Example
.sp
A script which leaves fullscreen mode when the player is paused:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
function on_pause()
    mp.set_property("fullscreen", "no")
end
mp.register_event("pause", on_pause)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This script provides a pretty weird feature, but Lua scripting was made to
allow users implement features which are not going to be added to the mpv core.
.SS Mode of operation
.sp
Your script will be loaded by the player at program start from the \fBlua\fP
configuration subdirectory, from a path specified with the \fB\-\-lua\fP option, or
in some cases, internally (like \fB\-\-osc\fP). 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 \fBmp.register_event\fP, or
timers added with \fBmp.add_timeout\fP or similar.
.sp
When the player quits, all scripts will be asked to terminate. This happens via
a \fBshutdown\fP 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
(unless the player is suspended, see \fBmp.suspend\fP), but it won\(aqt terminate
when quitting, because it\(aqs waiting on your script.
.sp
Internally, the C code will call the Lua function \fBmp_event_loop\fP after
loading a Lua script. This function is normally defined by the default prelude
loaded before your script (see \fBplayer/lua/defaults.lua\fP in the mpv sources).
The event loop will wait for events and dispatch events registered with
\fBmp.register_event\fP\&. It will also handle timers added with \fBmp.add_timeout\fP
and similar (by waiting with a timeout).
.sp
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 \fBmp_event_loop\fP is called), or the script calls \fBmp_event_loop\fP or
\fBmp.dispatch_events\fP 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.
.SS mp functions
.sp
The \fBmp\fP module is preloaded, although it can be loaded manually with
\fBrequire \(aqmp\(aq\fP\&. It provides the core client API.
.INDENT 0.0
.TP
.B \fBmp.command(string)\fP
Run the given command. This is similar to the commands used in input.conf.
See \fI\%List of Input Commands\fP\&.
.sp
Returns \fBtrue\fP on success, or \fBnil, error\fP on error.
.TP
.B \fBmp.commandv(arg1, arg2, ...)\fP
Similar to \fBmp.command\fP, but pass each command argument as separate
parameter. This has the advantage that you don\(aqt have to care about
quoting and escaping in some cases.
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
mp.command("loadfile " .. filename .. " append")
mp.commandv("loadfile", filename, "append")
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
These two commands are equivalent, except that the first version breaks
if the filename contains spaces or certain special characters.
.sp
Note that properties are \fInot\fP expanded.  You can use either \fBmp.command\fP,
the \fBexpand\-properties\fP prefix, or the \fBmp.get_property\fP family of
functions.
.TP
.B \fBmp.get_property(name [,def])\fP
Return the value of the given property as string. These are the same
properties as used in input.conf. See \fI\%Properties\fP for a list of
properties. The returned string is formatted similar to \fB${=name}\fP
(see \fI\%Property Expansion\fP).
.sp
Returns the string on success, or \fBdef, error\fP on error. \fBdef\fP is the
second parameter provided to the function, and is nil if it\(aqs missing.
.TP
.B \fBmp.get_property_osd(name [,def])\fP
Similar to \fBmp.get_property\fP, but return the property value formatted for
OSD. This is the same string as printed with \fB${name}\fP when used in
input.conf.
.sp
Returns the string on success, or \fBdef, error\fP on error. \fBdef\fP is the
second parameter provided to the function, and is an empty string if it\(aqs
missing. Unlike \fBget_property()\fP, assigning the return value to a variable
will always result in a string.
.TP
.B \fBmp.get_property_bool(name [,def])\fP
Similar to \fBmp.get_property\fP, but return the property value as Boolean.
.sp
Returns a Boolean on success, or \fBdef, error\fP on error.
.TP
.B \fBmp.get_property_number(name [,def])\fP
Similar to \fBmp.get_property\fP, but return the property value as number.
.sp
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.
.sp
Returns a number on success, or \fBdef, error\fP on error.
.TP
.B \fBmp.get_property_native(name [,def])\fP
Similar to \fBmp.get_property\fP, 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 \fBchapter\-list\fP) are returned as
tables.
.sp
Returns a value on success, or \fBdef, error\fP on error. Note that \fBnil\fP
might be a possible, valid value too in some corner cases.
.TP
.B \fBmp.set_property(name, value)\fP
Set the given property to the given string value. See \fBmp.get_property\fP
and \fI\%Properties\fP for more information about properties.
.sp
Returns true on success, or \fBnil, error\fP on error.
.TP
.B \fBmp.set_property_bool(name, value)\fP
Similar to \fBmp.set_property\fP, but set the given property to the given
Boolean value.
.TP
.B \fBmp.set_property_number(name, value)\fP
Similar to \fBmp.set_property\fP, but set the given property to the given
numeric value.
.sp
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.
.TP
.B \fBmp.set_property_native(name, value)\fP
Similar to \fBmp.set_property\fP, but set the given property using its native
type.
.sp
Since there are several data types which can not 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
\fBset_property\fP, \fBset_property_bool\fP, \fBset_property_number\fP\&.
For these reasons, this function should probably be avoided for now, except
for properties that use tables natively.
.TP
.B \fBmp.get_time()\fP
Return the current mpv internal time in seconds as a number. This is
basically the system time, with an arbitrary offset.
.TP
.B \fBmp.add_key_binding(key, name|fn [,fn])\fP
Register callback to be run on a key binding. The binding will be mapped to
the given \fBkey\fP, which is a string describing the physical key. This uses
the same key names as in input.conf, and also allows combinations
(e.g. \fBctrl+a\fP).
.sp
After calling this function, key presses will cause the function \fBfn\fP to
be called (unless the user remapped the key with another binding).
.sp
The \fBname\fP argument should be a short symbolic string. It allows the user
to remap the key binding via input.conf using the \fBscript_message\fP
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.
.sp
Internally, key bindings are dispatched via the \fBscript_message_to\fP input
command and \fBmp.register_script_message\fP\&.
.sp
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 \fBmp.add_forced_key_binding\fP).
.sp
Example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
function something_handler()
    print("the key was pressed")
end
mp.add_key_binding("x", "something", something_handler)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will print the message \fBthe key was pressed\fP when \fBx\fP was pressed.
.sp
The user can remap these key bindings. Then the user has to put the
following into his input.conf to remap the command to the \fBy\fP key:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
y script_message something
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
This will print the message when the key \fBy\fP is pressed. (\fBx\fP will
still work, unless the user remaps it.)
.sp
You can also explicitly send a message to a named script only. Assume the
above script was using the filename \fBfooscript.lua\fP:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
y script_message_to fooscript something
.ft P
.fi
.UNINDENT
.UNINDENT
.TP
.B \fBmp.add_forced_key_binding(...)\fP
This works almost the same as \fBmp.add_key_binding\fP, but registers the
key binding in a way that will overwrite the user\(aqs custom bindings in his
input.conf. (\fBmp.add_key_binding\fP overwrites default key bindings only,
but not those by the user\(aqs input.conf.)
.TP
.B \fBmp.remove_key_binding(name)\fP
Remove a key binding added with \fBmp.add_key_binding\fP or
\fBmp.add_forced_key_binding\fP\&. Use the same name as you used when adding
the bindings. It\(aqs not possible to remove bindings for which you omitted
the name.
.TP
.B \fBmp.register_event(name, fn)\fP
Call a specific function when an event happens. The event name is a string,
and the function fn is a Lua function value.
.sp
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 \fBname\fP field,
which is a string containing the event name. If the event has an error
associated, the \fBerror\fP field is set to a string describing the error,
on success it\(aqs not set.
.sp
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.
.sp
Returns true if such an event exists, false otherwise.
.sp
See \fI\%Events\fP and \fI\%List of events\fP for details.
.TP
.B \fBmp.unregister_event(fn)\fP
Undo \fBmp.register_event(..., fn)\fP\&. This removes all event handlers that
are equal to the \fBfn\fP parameter. This uses normal Lua \fB==\fP comparison,
so be careful when dealing with closures.
.TP
.B \fBmp.observe_property(name, type, fn)\fP
Watch a property for changes. If the property \fBname\fP is changed, then
the function \fBfn(name)\fP will be called. \fBtype\fP can be \fBnil\fP, or be
set to one of \fBnone\fP, \fBnative\fP, \fBbool\fP, \fBstring\fP, or \fBnumber\fP\&.
\fBnone\fP is the same as \fBnil\fP\&. For all other values, the new value of
the property will be passed as second argument to \fBfn\fP, using
\fBmp.get_property_<type>\fP to retrieve it. This means if \fBtype\fP is for
example \fBstring\fP, \fBfn\fP is roughly called as in
\fBfn(name, mp.get_property_string(name))\fP\&.
.sp
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.)
.sp
In some cases the function is not called even if the property changes.
Whether this can happen depends on the property.
.sp
If the \fBtype\fP is \fBnone\fP or \fBnil\fP, sporadic property change events are
possible. This means the change function \fBfn\fP can be called even if the
property doesn\(aqt actually change.
.TP
.B \fBmp.unobserve_property(fn)\fP
Undo \fBmp.observe_property(..., fn)\fP\&. This removes all property handlers
that are equal to the \fBfn\fP parameter. This uses normal Lua \fB==\fP
comparison, so be careful when dealing with closures.
.TP
.B \fBmp.add_timeout(seconds, fn)\fP
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\(aqs
resolution may be as low as 50 ms, although this will be improved in the
future.
.sp
This is a one\-shot timer: it will be removed when it\(aqs fired.
.sp
Returns a timer object. See \fBmp.add_periodic_timer\fP for details.
.TP
.B \fBmp.add_periodic_timer(seconds, fn)\fP
Call the given function periodically. This is like \fBmp.add_timeout\fP, but
the timer is re\-added after the function fn is run.
.sp
Returns a timer object. The timer object provides the following methods:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \fBstop()\fP
Disable the timer. Does nothing if the timer is already disabled.
This will remember the current elapsed time when stopping, so that
\fBresume()\fP essentially unpauses the timer.
.TP
.B \fBkill()\fP
Disable the timer. Resets the elapsed time. \fBresume()\fP will
restart the timer.
.TP
.B \fBresume()\fP
Restart the timer. If the timer was disabled with \fBstop()\fP, this
will resume at the time it was stopped. If the timer was disabled
with \fBkill()\fP, or if it\(aqs a previously fired one\-shot timer (added
with \fBadd_timeout()\fP), this starts the timer from the beginning,
using the initially configured timeout.
.TP
.B \fBtimeout\fP (RW)
This field contains the current timeout period. This value is not
updated as time progresses. It\(aqs only used to calculate when the
timer should fire next when the timer expires.
.sp
If you write this, you can call \fBt:kill() ; t:resume()\fP to reset
the current timeout to the new one. (\fBt:stop()\fP won\(aqt use the
new timeout.)
.TP
.B \fBoneshot\fP (RW)
Whether the timer is periodic (\fBfalse\fP) or fires just once
(\fBtrue\fP). This value is used when the timer expires (but before
the timer callback function fn is run).
.UNINDENT
.UNINDENT
.UNINDENT
.TP
.B \fBmp.get_opt(key)\fP
Return a setting from the \fB\-\-lua\-opts\fP option. It\(aqs 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.
.TP
.B \fBmp.get_script_name()\fP
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 script which would have the same name, it\(aqs made unique
by appending a number.
.INDENT 7.0
.INDENT 3.5
.IP "Example"
.sp
The script \fB/path/to/fooscript.lua\fP becomes \fBfooscript\fP\&.
.UNINDENT
.UNINDENT
.TP
.B \fBmp.osd_message(text [,duration])\fP
Show an OSD message on the screen. \fBduration\fP is in seconds, and is
optional (uses \fB\-\-osd\-duration\fP by default).
.UNINDENT
.SS Advanced mp functions
.sp
These also live in the \fBmp\fP module, but are documented separately as they
are useful only in special situations.
.INDENT 0.0
.TP
.B \fBmp.suspend()\fP
Suspend the mpv main loop. There is a long\-winded explanation of this in
the C API function \fBmpv_suspend()\fP\&. In short, this prevents the player
from displaying the next video frame, so that you don\(aqt get blocked when
trying to access the player.
.sp
This is automatically called by the event handler.
.TP
.B \fBmp.resume()\fP
Undo one \fBmp.suspend()\fP call. \fBmp.suspend()\fP increments an internal
counter, and \fBmp.resume()\fP decrements it. When 0 is reached, the player
is actually resumed.
.TP
.B \fBmp.resume_all()\fP
This resets the internal suspend counter and resumes the player. (It\(aqs
like calling \fBmp.resume()\fP until the player is actually resumed.)
.sp
You might want to call this if you\(aqre about to do something that takes a
long time, but doesn\(aqt really need access to the player (like a network
operation). Note that you still can access the player at any time.
.TP
.B \fBmp.get_wakeup_pipe()\fP
Calls \fBmpv_get_wakeup_pipe()\fP and returns the read end of the wakeup
pipe. (See \fBclient.h\fP for details.)
.TP
.B \fBmp.get_next_timeout()\fP
Return the relative time in seconds when the next timer (\fBmp.add_timeout\fP
and similar) expires. If there is no timer, return \fBnil\fP\&.
.TP
.B \fBmp.dispatch_events([allow_wait])\fP
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 \fBmp_event_loop\fP to your
own function running the event loop. From your event loop, you should call
\fBmp.dispatch_events()\fP to dequeue and dispatch mpv events.
.sp
If the \fBallow_wait\fP parameter is set to \fBtrue\fP, 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\(aqs strongly recommended to use \fBmp.get_next_timeout()\fP and
\fBmp.get_wakeup_pipe()\fP if you\(aqre interested in properly working
notification of new events and working timers.
.sp
This function calls \fBmp.suspend()\fP and \fBmp.resume_all()\fP on its own.
.TP
.B \fBmp.enable_messages(level)\fP
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 \fBlog\-message\fP event. See the description of this event for details.
The level is a string, see \fBmsg.log\fP for allowed log levels.
.TP
.B \fBmp.register_script_message(name, fn)\fP
This is a helper to dispatch \fBscript_message\fP or \fBscript_message_to\fP
invocations to Lua functions. \fBfn\fP is called if \fBscript_message\fP or
\fBscript_message_to\fP (with this script as destination) is run
with \fBname\fP as first parameter. The other parameters are passed to \fBfn\fP\&.
If a message with the given name is already registered, it\(aqs overwritten.
.sp
Used by \fBmp.add_key_binding\fP, so be careful about name collisions.
.TP
.B \fBmp.unregister_script_message(name)\fP
Undo a previous registration with \fBmp.register_script_message\fP\&. Does
nothing if the \fBname\fP wasn\(aqt registered.
.UNINDENT
.SS mp.msg functions
.sp
This module allows outputting messages to the terminal, and can be loaded
with \fBrequire \(aqmp.msg\(aq\fP\&.
.INDENT 0.0
.TP
.B \fBmsg.log(level, ...)\fP
The level parameter is the message priority. It\(aqs a string and one of
\fBfatal\fP, \fBerror\fP, \fBwarn\fP, \fBinfo\fP, \fBv\fP, \fBdebug\fP\&. The user\(aqs
settings will determine which of these messages will be visible. Normally,
all messages are visible, except \fBv\fP and \fBdebug\fP\&.
.sp
The parameters after that are all converted to strings. Spaces are inserted
to separate multiple parameters.
.sp
You don\(aqt need to add newlines.
.TP
.B \fBmsg.fatal(...)\fP, \fBmsg.error(...)\fP, \fBmsg.warn(...)\fP, \fBmsg.info(...)\fP, \fBmsg.verbose(...)\fP, \fBmsg.debug(...)\fP
All of these are shortcuts and equivalent to the corresponding
\fBmsg.log(level, ...)\fP call.
.UNINDENT
.SS mp.options functions
.sp
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).
.INDENT 0.0
.TP
.B \fBoptions.read_options(table [, identifier])\fP
A \fBtable\fP 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 \fBnil\fP as a default value!
.sp
The \fBidentifier\fP is used to identify the config\-file and the command\-line
options. These needs to unique to avoid collisions with other scripts.
Defaults to \fBmp.get_script_name()\fP\&.
.UNINDENT
.sp
Example implementation:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
require \(aqmp.options\(aq
local options = {
    optionA = "defaultvalueA",
    optionB = \-0.5,
    optionC = true,
}
options.read_options(options, "myscript")
print(option.optionA)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The config file will be stored in \fBlua\-settings/identifier.conf\fP in mpv\(aqs user
folder. Comment lines can be started with # and stray spaces are not removed.
Boolean values will be represented with yes/no.
.sp
Example config:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# comment
optionA=Hello World
optionB=9999
optionC=no
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Command\-line options are read from the \fB\-\-lua\-opts\fP parameter. To avoid
collisions, all keys have to be prefixed with \fBidentifier\-\fP\&.
.sp
Example command\-line:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-lua\-opts=myscript\-optionA=TEST:myscript\-optionB=0:myscript\-optionC=yes
.ft P
.fi
.UNINDENT
.UNINDENT
.SS mp.utils options
.sp
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\(aqs scarce standard library.
.INDENT 0.0
.TP
.B \fButils.getcwd()\fP
Returns the directory that mpv was launched from. On error, \fBnil, error\fP
is returned.
.TP
.B \fButils.readdir(path [, filter])\fP
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).
.sp
If the \fBfilter\fP argument is given, it must be one of the following
strings:
.INDENT 7.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \fBfiles\fP
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.
.TP
.B \fBdirs\fP
List directories only, or symlinks to directories. \fB\&.\fP and \fB\&..\fP
are not included.
.TP
.B \fBnormal\fP
Include the results of both \fBfiles\fP and \fBdirs\fP\&. (This is the
default.)
.TP
.B \fBall\fP
List all entries, even device files, dead symlinks, FIFOs, and the
\fB\&.\fP and \fB\&..\fP entries.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
On error, \fBnil, error\fP is returned.
.TP
.B \fButils.split_path(path)\fP
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.
.TP
.B \fButils.join_path(p1, p2)\fP
Return the concatenation of the 2 paths. Tries to be clever. For example,
if \fB\(gap2\fP is an absolute path, p2 is returned without change.
.UNINDENT
.SS Events
.sp
Events are notifications from player core to scripts. You can register an
event handler with \fBmp.register_event\fP\&.
.sp
Note that all scripts (and other parts of the player) receive events equally,
and there\(aqs no such thing as blocking other scripts from receiving events.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
function my_fn(event)
    print("start of playback!")
end

mp.register_event("playback\-start", my_fn)
.ft P
.fi
.UNINDENT
.UNINDENT
.SS List of events
.INDENT 0.0
.TP
.B \fBstart\-file\fP
Happens right before a new file is loaded. When you receive this, the
player is loading the file (or possibly already done with it).
.TP
.B \fBend\-file\fP
Happens after a file was unloaded. Typically, the player will load the
next file right away, or quit if this was the last file.
.TP
.B \fBfile\-loaded\fP
Happens after a file was loaded and begins playback.
.TP
.B \fBseek\fP
Happens on seeking (including ordered chapter segment changes).
.TP
.B \fBplayback\-restart\fP
Start of playback after seek or after file was loaded.
.TP
.B \fBtracks\-changed\fP
The list of video/audio/sub tracks was updated. (This happens on playback
start, and very rarely during playback.)
.TP
.B \fBtrack\-switched\fP
A video/audio/subtitle track was switched on or off. This usually happens
when the user (or a script) changes the subtitle track and so on.
.TP
.B \fBidle\fP
Idle mode is entered. This happens when playback ended, and the player was
started with \fB\-\-idle\fP or \fB\-\-force\-window\fP\&. This mode is implicitly ended
when the \fBstart\-file\fP or \fBshutdown\fP events happen.
.TP
.B \fBpause\fP
Playback was paused. This also happens when for example the player is
paused on low network cache. Then the event type indicates the pause state
(like the property "pause" as opposed to the "core\-idle" property), and you
might receive multiple \fBpause\fP events in a row.
.TP
.B \fBunpause\fP
Playback was unpaused. See above for details.
.TP
.B \fBtick\fP
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.
.TP
.B \fBshutdown\fP
Sent when the player quits, and the script should terminate. Normally
handled automatically. See \fI\%Mode of operation\fP\&.
.TP
.B \fBlog\-message\fP
Receives messages enabled with \fBmp.enable_messages\fP\&. 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:
.INDENT 7.0
.TP
.B \fBprefix\fP
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
\fB\-\-v\fP option, and is also what is used for \fB\-\-msg\-level\fP\&.
.TP
.B \fBlevel\fP
The log level as string. See \fBmsg.log\fP for possible log level names.
Note that later versions of mpv might add new levels or remove
(undocumented) existing ones.
.TP
.B \fBtext\fP
The log message. Note that this is the direct output of a printf()
style output API. The text will contain embedded newlines, and it\(aqs
possible that a single message contains multiple lines, or that a
message contains a partial line.
.sp
It\(aqs safe to display messages only if they end with a newline character,
and to buffer them otherwise.
.UNINDENT
.sp
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.
.TP
.B \fBget\-property\-reply\fP
Undocumented (not useful for Lua scripts).
.TP
.B \fBset\-property\-reply\fP
Undocumented (not useful for Lua scripts).
.TP
.B \fBcommand\-reply\fP
Undocumented (not useful for Lua scripts).
.TP
.B \fBscript\-input\-dispatch\fP
Undocumented (used internally).
.TP
.B \fBclient\-message\fP
Undocumented (used internally).
.TP
.B \fBvideo\-reconfig\fP
Happens on video output or filter reconfig.
.TP
.B \fBaudio\-reconfig\fP
Happens on audio output or filter reconfig.
.TP
.B \fBmetadata\-update\fP
Metadata (like file tags) was updated.
.TP
.B \fBchapter\-change\fP
The current chapter possibly changed.
.UNINDENT
.SH CHANGES FROM OTHER VERSIONS OF MPLAYER
.sp
\fBmpv\fP is based on mplayer2, which in turn is based on the original MPlayer
(also called mplayer, mplayer\-svn, mplayer1). Many changes have been made, a
large part of which is incompatible or completely changes how the player
behaves. Although there are still many similarities to its ancestors, \fBmpv\fP
should generally be treated as a completely different program.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
These lists are incomplete.
.UNINDENT
.UNINDENT
.SS General Changes for MPlayer to mpv
.INDENT 0.0
.IP \(bu 2
Switch to GPLv2+. (Technically speaking, MPlayer as a whole seems to be
GPLv2\-only, while mplayer2 is GPLv3+ \- see \fBCopyright\fP file for details.)
.IP \(bu 2
Removal of the internal GUI, MEncoder, OSD menu, video kernel drivers for
Linux 2.4 (including VIDIX)
.IP \(bu 2
Large internal cleanups
.IP \(bu 2
Removal of support for dead platforms
.IP \(bu 2
New build system
.IP \(bu 2
No embedded copy of FFmpeg and other libraries
.IP \(bu 2
Better pause handling (do not unpause on a command)
.IP \(bu 2
Better MKV support (such as ordered chapters)
.IP \(bu 2
vo_vdpau improvements
.IP \(bu 2
Precise seeking support
.IP \(bu 2
Native OpenGL backend for OS X
.IP \(bu 2
General OS X improvements
.IP \(bu 2
Improvements in audio/video sync handling
.IP \(bu 2
Cleaned up terminal output
.IP \(bu 2
Gapless audio support (\fB\-\-gapless\-audio\fP)
.IP \(bu 2
Improved responsiveness on user input
.IP \(bu 2
Support for modifier keys (alt, shift, ctrl) in input.conf
.IP \(bu 2
OSS4 volume control
.IP \(bu 2
More correct color reproduction (color matrix generation)
.IP \(bu 2
Use libass for subtitle rendering by default (better quality)
.IP \(bu 2
Generally preferring FFmpeg/Libav over internal demuxers and decoders
.IP \(bu 2
Improvements when playing multiple files (\fB\-\-fixed\-vo\fP)
.IP \(bu 2
Screenshot improvements (instant screenshots without 1\-frame delay, allow
taking screenshots even with hardware decoding)
.IP \(bu 2
Improved support for PulseAudio
.IP \(bu 2
Generally improved MS Windows support (dealing with Unicode file names,
improved \fB\-\-vo=direct3d\fP, improved window handling)
.IP \(bu 2
Better OSD rendering (using libass). This has full Unicode support, and
languages like Arabic should be better supported.
.IP \(bu 2
Cleaned up terminal output (nicer status line, less useless noise)
.IP \(bu 2
Support for playing URLs of popular streaming sites directly
(e.g. \fBmpv https://www.youtube.com/watch?v=...\fP)
.IP \(bu 2
Improved OpenGL output (\fB\-\-vo=opengl\-hq\fP)
.IP \(bu 2
Make \fB\-\-softvol\fP default (\fBmpv\fP is not a mixer control panel)
.IP \(bu 2
Improved support for .cue files
.IP \(bu 2
Screenshot improvements (can save screenshots as JPEG or PNG, configurable
file names, support for taking screenshots with or without subtitles \- the
\fBscreenshot\fP video filter is not needed anymore, and should not be put
into the mpv config file)
.IP \(bu 2
Removal of teletext support
.IP \(bu 2
Removal of most built\-in demuxers, using libavformat instead
.IP \(bu 2
Removal of built\-in network support, using libavformat instead (also,
support https via libavformat)
.IP \(bu 2
Replace image VOs (\fB\-\-vo=jpeg\fP etc.) with \fB\-\-vo=image\fP
.IP \(bu 2
Do not lose settings when playing a new file in the same player instance
.IP \(bu 2
New location for config files, new name for the binary.
.IP \(bu 2
Slave mode compatibility broken (see below)
.IP \(bu 2
Encoding functionality (replacement for MEncoder, see \fBDOCS/encoding.rst\fP)
.IP \(bu 2
Remove \fB\-\-vo=gif89a\fP, \fB\-\-vo=md5sum\fP, \fB\-\-vo=yuv4mpeg\fP, as encoding can
handle these use cases. For yuv4mpeg, for example, use:
\fBmpv input.mkv \-o output.y4m \-\-no\-audio \-\-oautofps \-\-oneverdrop\fP\&.
.IP \(bu 2
Image subtitles (DVDs etc.) are rendered in color and use more correct
positioning (color can be disabled with \fB\-\-sub\-gray\fP)
.IP \(bu 2
Wayland support
.IP \(bu 2
Support for precise scrolling which scales the parameter of commands. If the
input doesn\(aqt support precise scrolling the scale factor stays 1.
.IP \(bu 2
OS X: Cocoa event loop is independent from MPlayer\(aqs event loop, so user
actions like accessing menus and live resizing do not block the playback.
.IP \(bu 2
OS X: Apple Remote support.
.IP \(bu 2
OS X: Media Keys support.
.IP \(bu 2
Windows: Added WASAPI audio output.
.IP \(bu 2
New OSD bar with chapter marks and not positioned in the middle of the video
(though this can be customized with the \fB\-\-osd\-bar\-align\-y\fP option).
.IP \(bu 2
Allow customizing whether a key binding for seeking shows the video time, the
OSD bar, or nothing (see section \fI\%Input Command Prefixes\fP).
.IP \(bu 2
Display list of chapters and audio/subtitle tracks on OSD (see section
\fI\%Properties\fP).
.IP \(bu 2
\fB\-\-keep\-open\fP option to stop the player from closing the window and
exiting after playback ends.
.IP \(bu 2
Re\-enable screensaver while the player is paused.
.IP \(bu 2
Matroska edition switching at runtime.
.IP \(bu 2
Support for libavfilter (for video\->video and audio\->audio). This allows
using most of FFmpeg\(aqs filters, which improve greatly on the old MPlayer
filters in features, performance, and correctness.
.IP \(bu 2
Improved downmixing and output of surround audio. Instead of using hardcoded
pan filters to do remixing, use libavresample. Channel maps are used to
identify the channel layout, so e.g. \fB3.0\fP and \fB2.1\fP audio can be
distinguished.
.IP \(bu 2
Allow resuming playback at a later point with \fBShift+q\fP, also see
\fBquit_watch_later\fP input command.
.IP \(bu 2
Support mapping multiple commands to one key.
.IP \(bu 2
Allow changing/adjusting video filters at runtime. (This is also used to make
the \fBD\fP key insert vf_yadif if deinterlacing is not supported otherwise.)
.IP \(bu 2
Native VAAPI support
.IP \(bu 2
OS X: VDA support using libavcodec hwaccel API instead of FFmpeg\(aqs decoder. Up
to 2\-2.5x reduction in CPU usage.
.IP \(bu 2
Make hardware decoding in general work with the \fBopengl\fP video output.
.IP \(bu 2
Lua scripting (see \fI\%LUA SCRIPTING\fP)
.IP \(bu 2
A client API, that allows embedding \fBmpv\fP into applications
(see \fBlibmpv/client.h\fP in the sources)
.IP \(bu 2
General bug fixes and removal of long\-standing issues
.IP \(bu 2
General code cleanups (including refactoring or rewrites of many parts)
.IP \(bu 2
Many more changes
.UNINDENT
.SS Detailed Listing of User\-visible Changes
.sp
This listing is about changed command line switches, slave commands, and similar
things. Completely removed features are not listed.
.SS Command Line Switches
.INDENT 0.0
.IP \(bu 2
There is a new command line syntax, which is generally preferred over the old
syntax. \fB\-optname optvalue\fP becomes \fB\-\-optname=optvalue\fP\&.
.sp
The old syntax will not be removed. However, the new syntax is mentioned in
all documentation and so on, and unlike the old syntax is not ambiguous,
so it is a good thing to know about this change.
.IP \(bu 2
In general, negating switches like \fB\-noopt\fP now have to be written as
\fB\-no\-opt\fP or \fB\-\-no\-opt\fP\&.
.IP \(bu 2
Per\-file options are not the default anymore. You can explicitly specify
file\-local options. See \fBUsage\fP section.
.IP \(bu 2
Many options have been renamed, removed or changed semantics. Some options
that are required for a good playback experience with MPlayer are now
superfluous or even worse than the defaults, so make sure to read the manual
before trying to use your existing configuration with \fBmpv\fP\&.
.IP \(bu 2
Table of renamed/replaced switches:
.INDENT 2.0
.INDENT 3.5
.TS
center;
|l|l|.
_
T{
Old
T}	T{
New
T}
_
T{
\fB\-no<opt>\fP
T}	T{
\fB\-\-no\-<opt>\fP (add a dash)
T}
_
T{
\fB\-a52drc level\fP
T}	T{
\fB\-\-ad\-lavc\-ac3drc=level\fP
T}
_
T{
\fB\-ac spdifac3\fP
T}	T{
\fB\-\-ad=spdif:ac3\fP (see \fB\-\-ad=help\fP)
T}
_
T{
\fB\-af volnorm\fP
T}	T{
\fB\-\-af=drc\fP (renamed)
T}
_
T{
\fB\-afm hwac3\fP
T}	T{
\fB\-\-ad=spdif:ac3,spdif:dts\fP
T}
_
T{
\fB\-ao alsa:device=hw=0.3\fP
T}	T{
\fB\-\-ao=alsa:device=[hw:0,3]\fP
T}
_
T{
\fB\-aspect\fP
T}	T{
\fB\-\-video\-aspect\fP
T}
_
T{
\fB\-ass\-bottom\-margin\fP
T}	T{
\fB\-\-vf=sub=bottom:top\fP
T}
_
T{
\fB\-ass\fP
T}	T{
\fB\-\-sub\-ass\fP
T}
_
T{
\fB\-audiofile\-cache\fP
T}	T{
(removed; the main cache settings are used)
T}
_
T{
\fB\-audiofile\fP
T}	T{
\fB\-\-audio\-file\fP
T}
_
T{
\fB\-benchmark\fP
T}	T{
\fB\-\-untimed\fP (no stats)
T}
_
T{
\fB\-capture\fP
T}	T{
\fB\-\-stream\-capture=<filename>\fP
T}
_
T{
\fB\-channels\fP
T}	T{
\fB\-\-audio\-channels\fP (changed semantics)
T}
_
T{
\fB\-cursor\-autohide\-delay\fP
T}	T{
\fB\-\-cursor\-autohide\fP
T}
_
T{
\fB\-delay\fP
T}	T{
\fB\-\-audio\-delay\fP
T}
_
T{
\fB\-dumpstream\fP
T}	T{
\fB\-\-stream\-dump=<filename>\fP
T}
_
T{
\fB\-dvdangle\fP
T}	T{
\fB\-\-dvd\-angle\fP
T}
_
T{
\fB\-endpos\fP
T}	T{
\fB\-\-length\fP
T}
_
T{
\fB\-font\fP
T}	T{
\fB\-\-osd\-font\fP
T}
_
T{
\fB\-forcedsubsonly\fP
T}	T{
\fB\-\-sub\-forced\-only\fP
T}
_
T{
\fB\-forceidx\fP
T}	T{
\fB\-\-index\fP
T}
_
T{
\fB\-format\fP
T}	T{
\fB\-\-audio\-format\fP
T}
_
T{
\fB\-fsmode\-dontuse\fP
T}	T{
(removed)
T}
_
T{
\fB\-fstype\fP
T}	T{
\fB\-\-x11\-netwm\fP (changed semantics)
T}
_
T{
\fB\-hardframedrop\fP
T}	T{
\fB\-\-framedrop=hard\fP
T}
_
T{
\fB\-identify\fP
T}	T{
(removed; use TOOLS/mpv_identify.sh)
T}
_
T{
\fB\-idx\fP
T}	T{
\fB\-\-index\fP
T}
_
T{
\fB\-lavdopts ...\fP
T}	T{
\fB\-\-vd\-lavc\-...\fP
T}
_
T{
\fB\-lavfdopts\fP
T}	T{
\fB\-\-demuxer\-lavf\-...\fP
T}
_
T{
\fB\-lircconf\fP
T}	T{
\fB\-\-input\-lirc\-conf\fP
T}
_
T{
\fB\-loop 0\fP
T}	T{
\fB\-\-loop=inf\fP
T}
_
T{
\fB\-mixer\-channel\fP
T}	T{
AO suboptions (\fBalsa\fP, \fBoss\fP)
T}
_
T{
\fB\-mixer\fP
T}	T{
AO suboptions (\fBalsa\fP, \fBoss\fP)
T}
_
T{
\fB\-mouse\-movements\fP
T}	T{
\fB\-\-input\-cursor\fP
T}
_
T{
\fB\-msgcolor\fP
T}	T{
\fB\-\-msg\-color\fP
T}
_
T{
\fB\-msglevel\fP
T}	T{
\fB\-\-msg\-level\fP (changed semantics)
T}
_
T{
\fB\-msgmodule\fP
T}	T{
\fB\-\-msg\-module\fP
T}
_
T{
\fB\-name\fP
T}	T{
\fB\-\-x11\-name\fP
T}
_
T{
\fB\-noar\fP
T}	T{
\fB\-\-no\-input\-appleremote\fP
T}
_
T{
\fB\-noautosub\fP
T}	T{
\fB\-\-no\-sub\-auto\fP
T}
_
T{
\fB\-noconsolecontrols\fP
T}	T{
\fB\-\-no\-input\-terminal\fP
T}
_
T{
\fB\-nojoystick\fP
T}	T{
\fB\-\-no\-input\-joystick\fP
T}
_
T{
\fB\-nosound\fP
T}	T{
\fB\-\-no\-audio\fP
T}
_
T{
\fB\-osdlevel\fP
T}	T{
\fB\-\-osd\-level\fP
T}
_
T{
\fB\-panscanrange\fP
T}	T{
\fB\-\-video\-zoom\fP, \fB\-\-video\-pan\-x/y\fP
T}
_
T{
\fB\-playing\-msg\fP
T}	T{
\fB\-\-term\-playing\-msg\fP
T}
_
T{
\fB\-pp ...\fP
T}	T{
\fB\(aq\-\-vf=pp=[...]\(aq\fP
T}
_
T{
\fB\-pphelp\fP
T}	T{
\fB\-\-vf=pp:help\fP
T}
_
T{
\fB\-rawaudio ...\fP
T}	T{
\fB\-\-demuxer\-rawaudio\-...\fP
T}
_
T{
\fB\-rawvideo ...\fP
T}	T{
\fB\-\-demuxer\-rawvideo\-...\fP
T}
_
T{
\fB\-spugauss\fP
T}	T{
\fB\-\-sub\-gauss\fP
T}
_
T{
\fB\-srate\fP
T}	T{
\fB\-\-audio\-samplerate\fP
T}
_
T{
\fB\-ss\fP
T}	T{
\fB\-\-start\fP
T}
_
T{
\fB\-ssf <sub>\fP
T}	T{
\fB\-\-sws\-...\fP
T}
_
T{
\fB\-stop\-xscreensaver\fP
T}	T{
\fB\-\-stop\-screensaver\fP
T}
_
T{
\fB\-sub\-fuzziness\fP
T}	T{
\fB\-\-sub\-auto\fP
T}
_
T{
\fB\-sub\fP
T}	T{
\fB\-\-sub\-file\fP
T}
_
T{
\fB\-subcp\fP
T}	T{
\fB\-\-sub\-codepage\fP
T}
_
T{
\fB\-subdelay\fP
T}	T{
\fB\-\-sub\-delay\fP
T}
_
T{
\fB\-subfile\fP
T}	T{
\fB\-\-sub\-file\fP
T}
_
T{
\fB\-subfont\-*\fP
T}	T{
\fB\-\-sub\-text\-*\fP, \fB\-\-osd\-*\fP
T}
_
T{
\fB\-subfont\-text\-scale\fP
T}	T{
\fB\-\-sub\-scale\fP
T}
_
T{
\fB\-subfont\fP
T}	T{
\fB\-\-sub\-text\-font\fP
T}
_
T{
\fB\-subfps\fP
T}	T{
\fB\-\-sub\-fps\fP
T}
_
T{
\fB\-subpos\fP
T}	T{
\fB\-\-sub\-pos\fP
T}
_
T{
\fB\-sws\fP
T}	T{
\fB\-\-sws\-scaler\fP
T}
_
T{
\fB\-tvscan\fP
T}	T{
\fB\-\-tv\-scan\fP
T}
_
T{
\fB\-use\-filename\-title\fP
T}	T{
\fB\-\-title=\(aq${filename}\(aq\fP
T}
_
T{
\fB\-vc ffh264vdpau\fP (etc.)
T}	T{
\fB\-\-hwdec=vdpau\fP
T}
_
T{
\fB\-vobsub\fP
T}	T{
\fB\-\-sub\-file\fP (pass the .idx file)
T}
_
T{
\fB\-x W\fP, \fB\-y H\fP
T}	T{
\fB\-\-geometry=WxH\fP + \fB\-\-no\-keepaspect\fP
T}
_
T{
\fB\-xineramascreen\fP
T}	T{
\fB\-\-screen\fP (different values)
T}
_
T{
\fB\-xy W\fP
T}	T{
\fB\-\-autofit=W\fP
T}
_
T{
\fB\-zoom\fP
T}	T{
Inverse available as \fB\-\-video\-unscaled\fP
T}
_
T{
\fBdvdnav://\fP
T}	T{
\fBdvdnav://menu\fP
T}
_
T{
\fBdvd://1\fP
T}	T{
\fBdvd://0\fP (0\-based offset)
T}
_
.TE
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fB\-opt val\fP becomes \fB\-\-opt=val\fP\&.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Quite some video filters, video outputs, audio filters, audio outputs, had
changes in their option parsing. These aren\(aqt mentioned in the table above.
.sp
Also, some video and audio filters have been removed, and you have to use
libavfilter (using \fB\-\-vf=lavfi=[...]\fP or \fB\-\-af=lavfi=[...]\fP) to get
them back.
.UNINDENT
.UNINDENT
.SS input.conf and Slave Commands
.INDENT 0.0
.IP \(bu 2
Table of renamed input commands:
.INDENT 2.0
.INDENT 3.5
This lists only commands that are not always gracefully handled by the
internal legacy translation layer. If an input.conf contains any legacy
commands, a warning will be printed when starting the player. The warnings
also show the replacement commands.
.sp
Properties containing \fB_\fP to separate words use \fB\-\fP instead.
.TS
center;
|l|l|.
_
T{
Old
T}	T{
New
T}
_
T{
\fBpt_step 1 [0|1]\fP
T}	T{
\fBplaylist_next [weak|force]\fP
(translation layer cannot deal with
whitespace)
T}
_
T{
\fBpt_step \-1 [0|1]\fP
T}	T{
\fBplaylist_prev [weak|force] (same)\fP
T}
_
T{
\fBswitch_ratio [<ratio>]\fP
T}	T{
\fBset video\-aspect <ratio>\fP
.sp
\fBset video\-aspect 0\fP (reset aspect)
T}
_
T{
\fBstep_property_osd <prop>\fP
\fB<step> <dir>\fP
T}	T{
\fBcycle <prop> <step>\fP (wraps),
\fBadd <prop> <step>\fP (clamps).
\fB<dir>\fP parameter unsupported. Use
a negative \fB<step>\fP instead.
T}
_
T{
\fBstep_property <prop>\fP
\fB<step> <dir>\fP
T}	T{
Prefix \fBcycle\fP or \fBadd\fP with
\fBno\-osd\fP: \fBno\-osd cycle <prop>\fP
\fB<step>\fP
T}
_
T{
\fBosd_show_property_text\fP
\fB<text>\fP
T}	T{
\fBshow_text <text>\fP
The property expansion format string
syntax slightly changed.
T}
_
T{
\fBosd_show_text\fP
T}	T{
Now does the same as
\fBosd_show_property_text\fP\&. Use the
\fBraw\fP prefix to disable property
expansion.
T}
_
T{
\fBshow_tracks\fP
T}	T{
\fBshow_text ${track\-list}\fP
T}
_
T{
\fBshow_chapters\fP
T}	T{
\fBshow_text ${chapter\-list}\fP
T}
_
T{
\fBaf_switch\fP, \fBaf_add\fP, ...
T}	T{
\fBaf set|add|...\fP
T}
_
T{
\fBtv_start_scan\fP
T}	T{
\fBset tv\-scan yes\fP
T}
_
T{
\fBtv_set_channel <val>\fP
T}	T{
\fBset tv\-channel <val>\fP
T}
_
T{
\fBtv_step_channel\fP
T}	T{
\fBcycle tv\-channel\fP
T}
_
T{
\fBdvb_set_channel <v1> <v2>\fP
T}	T{
\fBset dvb\-channel <v1>\-<v2>\fP
T}
_
T{
\fBdvb_step_channel\fP
T}	T{
\fBcycle dvb\-channel\fP
T}
_
T{
\fBtv_set_freq <val>\fP
T}	T{
\fBset tv\-freq <val>\fP
T}
_
T{
\fBtv_step_freq\fP
T}	T{
\fBcycle tv\-freq\fP
T}
_
T{
\fBtv_set_norm <norm>\fP
T}	T{
\fBset tv\-norm <norm>\fP
T}
_
T{
\fBtv_step_norm\fP
T}	T{
\fBcycle tv\-norm\fP
T}
_
.TE
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Due to lack of hardware and users using the TV/DVB/PVR features, and
due to the need to cleanup the related command code, it\(aqs possible
that the new commands are buggy or behave worse. This can be improved
if testers are available. Otherwise, some of the TV code will be
removed at some point.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SS Slave mode
.INDENT 0.0
.IP \(bu 2
Slave mode was removed. A proper slave mode application needed tons of code
and hacks to get
it right. The main problem is that slave mode is a bad and incomplete
interface, and to get around that, applications parsed output messages
intended for users. It is hard to know which messages exactly are parsed by
slave mode applications. This makes it virtually impossible to improve
terminal output intended for users without possibly breaking something.
.sp
This is absolutely insane, and since initial improvements to \fBmpv\fP quickly
made slave mode incompatible to most applications, it was removed as useless
cruft. The client API (see below) is provided instead.
.sp
\fB\-\-identify\fP was replaced by the \fBTOOLS/mpv_identify.sh\fP wrapper script.
.IP \(bu 2
For some time (until including release 0.4.x), mpv supported a
\fB\-\-slave\-broken\fP option. The following options are equivalent:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
\-\-input\-file=/dev/stdin \-\-input\-terminal=no
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Assuming the system supports \fB/dev/stdin\fP\&.
.sp
(The option was readded in 0.5.1 and sets exactly these options.)
.IP \(bu 2
A JSON RPC protocol giving access to the client API is planned, but nothing
has emerged yet.
.IP \(bu 2
\fBmpv\fP also provides a client API, which can be used to embed the player
by loading it as shared library. (See \fBlibmpv/client.h\fP in the sources.)
It might also be possible to implement a custom slave mode\-like protocol
using Lua scripting.
.UNINDENT
.SS Policy for Removed Features
.sp
\fBmpv\fP is in active development. If something is in the way of more important
development (such as fixing bugs or implementing new features), we sometimes
remove features. Usually this happens only with old features that either seem
to be useless, or are not used by anyone. Often these are obscure, or
"inherited", or were marked experimental, but never received any particular
praise by any users.
.sp
Sometimes, features are replaced by something new. The new code will be either
simpler or more powerful, but doesn\(aqt necessarily provide everything the old
feature did.
.sp
We can not exclude that we accidentally remove features that are actually
popular. Generally, we do not know how much a specific functionality is used.
If you miss a feature and think it should be re\-added, please open an issue
on the mpv bug tracker. Hopefully, a solution can be found. Often, it turns
out that re\-adding something is not much of a problem, or that there are
better alternatives.
.SS Why this Fork?
.sp
mplayer2 is practically dead, and mpv started out as a branch containing
new/experimental development. (Some of it was merged right \fIafter\fP the fork
was made public, seemingly as an acknowledgment that development, or at
least merging, should have been more active.)
.sp
MPlayer is focused on not breaking anything, but is stuck with a horrible
codebase resistant to cleanup. (Unless you do what mpv did \- merciless and
consequent pruning of bad, old code.) Cleanup and keeping broken things
conflict, so the kind of development mpv strives for can\(aqt be done within
MPlayer due to clashing development policies.
.sp
Additionally, mplayer2 already had lots of changes over MPlayer, which would
have needed to be backported to the MPlayer codebase. This would not only
have been hard (several years of diverging development), but also would have
been impossible due to the aforementioned MPlayer development policy.
.SH ENVIRONMENT VARIABLES
.sp
There are a number of environment variables that can be used to control the
behavior of mpv.
.INDENT 0.0
.TP
.B \fBHOME\fP, \fBXDG_CONFIG_HOME\fP
Used to determine mpv config directory. If \fBXDG_CONFIG_HOME\fP is not set,
\fB$HOME/.config/mpv\fP is used.
.sp
\fB$HOME/.mpv\fP is always added to the list of config search paths with a
lower priority.
.TP
.B \fBXDG_CONFIG_DIRS\fP
If set, XDG\-style system configuration directories are used. Otherwise,
the UNIX convention (\fBPREFIX/etc/mpv/\fP) is used.
.TP
.B \fBTERM\fP
Used to determine terminal type.
.TP
.B \fBMPV_HOME\fP
Directory where mpv looks for user settings. Overrides \fBHOME\fP, and mpv
will try to load the config file as \fB$MPV_HOME/mpv.conf\fP\&.
.TP
.B \fBMPV_VERBOSE\fP (see also \fB\-v\fP and \fB\-\-msg\-level\fP)
Set the initial verbosity level across all message modules (default: 0).
This is an integer, and the resulting verbosity corresponds to the number
of \fB\-\-v\fP options passed to the command line.
.TP
.B \fBMPV_LEAK_REPORT\fP
If set to \fB1\fP, enable internal talloc leak reporting. Note that this can
cause trouble with multithreading, so only developers should use this.
.TP
.B \fBLADSPA_PATH\fP
Specifies the search path for LADSPA plugins. If it is unset, fully
qualified path names must be used.
.TP
.B \fBDISPLAY\fP
Standard X11 display name to use.
.TP
.B 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.
.sp
Notable environment variables:
.INDENT 7.0
.TP
.B \fBhttp_proxy\fP
URL to proxy for \fBhttp://\fP and \fBhttps://\fP URLs.
.TP
.B \fBno_proxy\fP
List of domain patterns for which no proxy should be used.
List entries are separated by \fB,\fP\&. Patterns can include \fB*\fP\&.
.UNINDENT
.TP
.B libdvdcss:
.INDENT 7.0
.TP
.B \fBDVDCSS_CACHE\fP
Specify a directory in which to store title key values. This will
speed up descrambling of DVDs which are in the cache. The
\fBDVDCSS_CACHE\fP directory is created if it does not exist, and a
subdirectory is created named after the DVD\(aqs title or manufacturing
date. If \fBDVDCSS_CACHE\fP is not set or is empty, libdvdcss will use
the default value which is \fB${HOME}/.dvdcss/\fP under Unix and
the roaming application data directory (\fB%APPDATA%\fP) under
Windows. The special value "off" disables caching.
.TP
.B \fBDVDCSS_METHOD\fP
Sets the authentication and decryption method that libdvdcss will use
to read scrambled discs. Can be one of \fBtitle\fP, \fBkey\fP or \fBdisc\fP\&.
.INDENT 7.0
.TP
.B key
is the default method. libdvdcss will use a set of calculated
player keys to try and get the disc key. This can fail if the drive
does not recognize any of the player keys.
.TP
.B 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.
.TP
.B 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.
.UNINDENT
.TP
.B \fBDVDCSS_RAW_DEVICE\fP
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).
.TP
.B \fBDVDCSS_VERBOSE\fP
Sets the libdvdcss verbosity level.
.INDENT 7.0
.TP
.B 0
Outputs no messages at all.
.TP
.B 1
Outputs error messages to stderr.
.TP
.B 2
Outputs error messages and debug messages to stderr.
.UNINDENT
.TP
.B \fBDVDREAD_NOKEYS\fP
Skip retrieving all keys on startup. Currently disabled.
.TP
.B \fBHOME\fP
FIXME: Document this.
.UNINDENT
.UNINDENT
.SH EXIT CODES
.sp
Normally \fBmpv\fP returns 0 as exit code after finishing playback successfully.
If errors happen, the following exit codes can be returned:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B 1
Error initializing mpv. This is also returned if unknown options are
passed to mpv.
.TP
.B 2
The file passed to mpv couldn\(aqt 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.
.TP
.B 3
There were some files that could be played, and some files which
couldn\(aqt (using the definition of success from above).
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Note that quitting the player manually will always lead to exit code 0,
overriding the exit code that would be returned normally. Also, the \fBquit\fP
input command can take an exit code: in this case, that exit code is returned.
.SH FILES
.INDENT 0.0
.TP
.B \fB/etc/mpv/mpv.conf\fP
mpv system\-wide settings (depends on \fB\-\-prefix\fP passed to configure)
.TP
.B \fB~/.config/mpv/mpv.conf\fP
mpv user settings
.TP
.B \fB~/.config/mpv/input.conf\fP
key bindings (see \fI\%INPUT.CONF\fP section)
.TP
.B \fB~/.config/mpv/lua/\fP
All files in this directly are loaded as if they were passed to the
\fB\-\-lua\fP option. They are loaded in alphabetical order, and sub\-directories
and files with no \fB\&.lua\fP extension are ignored. The \fB\-\-load\-scripts=no\fP
option disables loading these files.
.UNINDENT
.sp
Note that the environment variables \fB$XDG_CONFIG_HOME\fP and \fB$MPV_HOME\fP can
override the standard directory \fB~/.config/mpv/\fP\&.
.sp
Also, the old config location at \fB~/.mpv/\fP is still read, and if the XDG
variant does not exist, will still be preferred.
.SH EXAMPLES OF MPV USAGE
.INDENT 0.0
.TP
.B Blu\-ray playback:
.INDENT 7.0
.IP \(bu 2
\fBmpv bd:////path/to/disc\fP
.IP \(bu 2
\fBmpv bd:// \-\-bluray\-device=/path/to/disc\fP
.UNINDENT
.TP
.B Play in Japanese with English subtitles:
\fBmpv dvd://1 \-\-alang=ja \-\-slang=en\fP
.TP
.B Play only chapters 5, 6, 7:
\fBmpv dvd://1 \-\-chapter=5\-7\fP
.TP
.B Play only titles 5, 6, 7:
\fBmpv dvd://5\-7\fP
.TP
.B Play a multi\-angle DVD:
\fBmpv dvd://1 \-\-dvd\-angle=2\fP
.TP
.B Play from a different DVD device:
\fBmpv dvd://1 \-\-dvd\-device=/dev/dvd2\fP
.TP
.B Play DVD video from a directory with VOB files:
\fBmpv dvd://1 \-\-dvd\-device=/path/to/directory/\fP
.TP
.B Stream from HTTP:
\fBmpv http://example.com/example.avi\fP
.TP
.B Stream using RTSP:
\fBmpv rtsp://server.example.com/streamName\fP
.TP
.B Play a libavfilter graph:
\fBmpv avdevice://lavfi:mandelbrot\fP
.UNINDENT
.SH AUTHORS
.sp
mpv is a MPlayer fork based on mplayer2, which in turn is a fork of MPlayer.
.sp
MPlayer was initially written by Arpad Gereoffy. See the \fBAUTHORS\fP file for
a list of some of the many other contributors.
.sp
MPlayer is (C) 2000\-2013 The MPlayer Team
.sp
This man page was written mainly by Gabucino, Jonas Jermann and Diego Biurrun.
.SH COPYRIGHT
GPLv2+
.\" Generated by docutils manpage writer.
.