aboutsummaryrefslogtreecommitdiffhomepage
path: root/DOCS/man/en/options.rst
diff options
context:
space:
mode:
authorGravatar wm4 <wm4@nowhere>2013-07-08 21:55:44 +0200
committerGravatar wm4 <wm4@nowhere>2013-07-08 21:55:44 +0200
commit31f685040bd2152d541ed16cf441c6b5e7e430fd (patch)
treeb8351b2847231bbc15d883a622ac972945cce6b4 /DOCS/man/en/options.rst
parent73c76de91edbf8a55eb725196ff54583e3428510 (diff)
parent7a71a2cc483d17bed94408d5aee6fba6893558cb (diff)
Merge branch 'master' into remove_old_demuxers
Conflicts: DOCS/man/en/changes.rst DOCS/man/en/options.rst
Diffstat (limited to 'DOCS/man/en/options.rst')
-rw-r--r--DOCS/man/en/options.rst1759
1 files changed, 923 insertions, 836 deletions
diff --git a/DOCS/man/en/options.rst b/DOCS/man/en/options.rst
index 9c7aac61ce..915602aaca 100644
--- a/DOCS/man/en/options.rst
+++ b/DOCS/man/en/options.rst
@@ -1,4 +1,4 @@
---ad=<[+|-]family1:(*|decoder1),[+|-]family2:(*|decoder2),...[-]>
+``--ad=<[+|-]family1:(*|decoder1),[+|-]family2:(*|decoder2),...[-]>``
Specify a priority list of audio decoders to be used, according to their
family and decoder name. Entries like ``family:*`` prioritize all decoders
of the given family. When determining which decoder to use, the first
@@ -6,47 +6,47 @@
the next decoder is used. Finally, it tries all other decoders that are not
explicitly selected or rejected by the option.
- ``-`` at the end of the list suppresses fallback to other available
+ ``-`` at the end of the list suppresses fallback on other available
decoders not on the ``--ad`` list. ``+`` in front of an entry forces the
- decoder. Both of these shouldn't normally be used, because they break
+ decoder. Both of these should not normally be used, because they break
normal decoder auto-selection!
``-`` in front of an entry disables selection of the decoder.
- *EXAMPLE*:
+ .. admonition:: Examples
- ``--ad=lavc:mp3float``
- Prefer the FFmpeg/Libav ``mp3float`` decoder over all other mp3
- decoders.
+ ``--ad=lavc:mp3float``
+ Prefer the FFmpeg/Libav ``mp3float`` decoder over all other mp3
+ decoders.
- ``--ad=spdif:ac3,lavc:*``
- Always prefer spdif AC3 over FFmpeg/Libav over anything else.
+ ``--ad=spdif:ac3,lavc:*``
+ Always prefer spdif AC3 over FFmpeg/Libav over anything else.
- ``--ad=help``
- List all available decoders.
+ ``--ad=help``
+ List all available decoders.
---ad-lavc-ac3drc=<level>
- Select the Dynamic Range Compression level for AC-3 audio streams. <level>
- 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.
+``--ad-lavc-ac3drc=<level>``
+ Select the Dynamic Range Compression level for AC-3 audio streams.
+ ``<level>`` 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.
---ad-lavc-downmix=<yes|no>
+``--ad-lavc-downmix=<yes|no>``
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 ``--channels`` option.
Useful for playing surround audio on a stereo system.
---ad-lavc-o=<key>=<value>[,<key>=<value>[,...]]
+``--ad-lavc-o=<key>=<value>[,<key>=<value>[,...]]``
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.
---ad-spdif-dtshd=<yes|no>, --dtshd, --no-dtshd
+``--ad-spdif-dtshd=<yes|no>``, ``--dtshd``, ``--no-dtshd``
When using DTS passthrough, output any DTS-HD track as-is.
- With ``ad-spdif-dtshd=no`` (the default) only the DTS Core parts will be
+ With ``ad-spdif-dtshd=no`` (the default), only the DTS Core parts will be
output.
DTS-HD tracks can be sent over HDMI but not over the original
@@ -54,73 +54,77 @@
``--dtshd`` and ``--no-dtshd`` are deprecated aliases.
---af=<filter1[=parameter1:parameter2:...],filter2,...>
+``--af=<filter1[=parameter1:parameter2:...],filter2,...>``
Specify a list of audio filters to apply to the audio stream. See
- `audio_filters` for details and descriptions of the available filters.
+ `AUDIO FILTERS`_ for details and descriptions of the available filters.
The option variants ``--af-add``, ``--af-pre``, ``--af-del`` and
``--af-clr`` exist to modify a previously specified list, but you
- shouldn't need these for typical use.
+ should not need these for typical use.
---aid=<ID|auto|no>
+``--aid=<ID|auto|no>``
Select audio channel. ``auto`` selects the default, ``no`` disables audio.
See also ``--alang``.
---alang=<languagecode[,languagecode,...]>
+``--alang=<languagecode[,languagecode,...]>``
Specify a priority list of audio languages to use. Different container
- formats employ different language codes. DVDs use ISO 639-1 two letter
- language codes, Matroska, MPEG-TS and NUT use ISO 639-2 three letter
- language codes while OGM uses a free-form identifier. mpv prints the
+ 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. mpv prints the
available languages when run in verbose (``-v``) mode. See also ``--aid``.
- *EXAMPLE*:
+ .. admonition:: Examples
- ``mpv dvd://1 --alang=hu,en``
- Chooses the Hungarian language track on a DVD and falls back on
- English if Hungarian is not available.
- ``mpv --alang=jpn example.mkv``
- Plays a Matroska file in Japanese.
+ ``mpv dvd://1 --alang=hu,en``
+ Chooses the Hungarian language track on a DVD and falls back on
+ English if Hungarian is not available.
+ ``mpv --alang=jpn example.mkv``
+ Plays a Matroska file in Japanese.
---ao=<driver1[:suboption1[=value]:...],driver2,...[,]>
+``--ao=<driver1[:suboption1[=value]:...],driver2,...[,]>``
Specify a priority list of audio output drivers to be used. For
- interactive use you'd normally specify a single one to use, but in
+ interactive use one would normally specify a single one to use, but in
configuration files specifying a list of fallbacks may make sense. See
- `audio_outputs` for details and descriptions of available drivers.
+ `AUDIO OUTPUT DRIVERS`_ for details and descriptions of available drivers.
---ar, --no-ar
+``--ar``, ``--no-ar``
Enable/disable AppleIR remote support. Enabled by default.
---aspect=<ratio>
+``--aspect=<ratio>``
Override movie aspect ratio, in case aspect information is incorrect or
missing in the file being played. See also ``--no-aspect``.
- *EXAMPLE*:
+ .. admonition:: Examples
- - ``--aspect=4:3`` or ``--aspect=1.3333``
- - ``--aspect=16:9`` or ``--aspect=1.7777``
+ - ``--aspect=4:3`` or ``--aspect=1.3333``
+ - ``--aspect=16:9`` or ``--aspect=1.7777``
---ass, --no-ass
+``--ass``, ``--no-ass``
Render ASS subtitles natively (enabled by default).
If ``--no-ass`` is specified, all tags and style declarations are stripped
- and ignored on display. The subtitle renderer uses the font style as
+ and ignored on display. The subtitle renderer uses the font style as
specified by the ``--sub-text-`` options instead.
- *NOTE*: Using ``--no-ass`` 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.
+ .. note::
+
+ Using ``--no-ass`` 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.
---ass-force-style=<[Style.]Param=Value[,...]>
+``--ass-force-style=<[Style.]Param=Value[,...]>``
Override some style or script info parameters.
- *EXAMPLE*:
+ .. admonition:: Examples
+
+ - ``--ass-force-style=FontName=Arial,Default.Bold=1``
+ - ``--ass-force-style=PlayResY=768``
- - ``--ass-force-style=FontName=Arial,Default.Bold=1``
- - ``--ass-force-style=PlayResY=768``
+ .. note::
- *NOTE*: Using this option may lead to incorrect subtitle rendering.
+ Using this option may lead to incorrect subtitle rendering.
---ass-hinting=<type>
- Set hinting type. <type> can be:
+``--ass-hinting=<type>``
+ Set font hinting type. <type> can be:
:0: no hinting
:1: FreeType autohinter, light mode
@@ -129,29 +133,31 @@
The default value is 0 (no hinting).
---ass-line-spacing=<value>
+``--ass-line-spacing=<value>``
Set line spacing value for SSA/ASS renderer.
---ass-styles=<filename>
+``--ass-styles=<filename>``
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 ``[V4
Styles]`` / ``[V4+ Styles]`` section of SSA/ASS.
- *NOTE*: Using this option may lead to incorrect subtitle rendering.
+ .. note::
---ass-style-override=<yes|no>
+ Using this option may lead to incorrect subtitle rendering.
+
+``--ass-style-override=<yes|no>``
Control whether user style overrides should be applied.
:yes: Apply all the ``--ass-*`` style override options. Changing the default
- for any of these options can lead to incorrect subtitle rendering.
- (Default.)
+ for any of these options can lead to incorrect subtitle rendering
+ (default).
:no: Render subtitles as forced by subtitle scripts.
---ass-use-margins
+``--ass-use-margins``
Enables placing toptitles and subtitles in black borders when they are
available.
---ass-vsfilter-aspect-compat
+``--ass-vsfilter-aspect-compat``
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.
@@ -162,37 +168,37 @@
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
+ 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).
Enabled by default.
---audio-demuxer=<[+]name>
- Force audio demuxer type when using ``--audiofile``. Use a '+' before the
- name to force it, this will skip some checks! Give the demuxer name as
- printed by ``--audio-demuxer=help``. ``--audio-demuxer=audio`` forces MP3.
+``--audio-demuxer=<[+]name>``
+ Use this audio demuxer type when using ``--audiofile``. Use a '+' before the
+ name to force it; this will skip some checks. Give the demuxer name as
+ printed by ``--audio-demuxer=help``.
---audio-display=<no|attachment>
+``--audio-display=<no|attachment>``
Setting this option to ``attachment`` (default) will display image
attachments when playing audio files. It will display the first image
- found, and additional images are available as video streams.
+ found, and additional images are available as video tracks.
Setting this option to ``no`` disables display of video entirely when
playing audio files.
This option has no influence on files with normal video tracks.
---audiofile=<filename>
+``--audiofile=<filename>``
Play audio from an external file (WAV, MP3 or Ogg Vorbis) while viewing a
movie.
---audiofile-cache=<kBytes>
+``--audiofile-cache=<kBytes>``
Enables caching for the stream used by ``--audiofile``, using the
specified amount of memory.
---autofit=<[W[xH]]>
- Set the initial window size to a maximum size specified by WxH, without
+``--autofit=<[W[xH]]>``
+ Set the initial window size to a maximum size specified by ``WxH``, without
changing the window's aspect ratio. The size is measured in pixels, or if
a number is followed by a percentage sign (``%``), in percents of the
screen size.
@@ -209,47 +215,51 @@
See ``--geometry`` for details how this is handled with multi-monitor
setups.
- Use ``--autofit-larger`` instead if you don't want the window to get larger.
+ Use ``--autofit-larger`` instead if you do not want the window to get
+ larger.
+
Use ``--geometry`` if you want to force both window width and height to a
specific size.
- *NOTE*: Generally only supported by GUI VOs. Ignored for encoding.
+ .. note::
- *EXAMPLE*:
+ Generally only supported by GUI VOs. Ignored for encoding.
- ``70%``
- Make the window width 70% of the screen size, keeping aspect ratio.
- ``1000``
- Set the window width to 1000 pixels, keeping aspect ratio.
- ``70%:60%``
- Make the window as large as possible, without being wider than 70% of
- the screen width, or higher than 60% of the screen height.
+ .. admonition:: Examples
---autofit-larger=<[W[xH]]>
+ ``70%``
+ Make the window width 70% of the screen size, keeping aspect ratio.
+ ``1000``
+ Set the window width to 1000 pixels, keeping aspect ratio.
+ ``70%:60%``
+ Make the window as large as possible, without being wider than 70%
+ of the screen width, or higher than 60% of the screen height.
+
+``--autofit-larger=<[W[xH]]>``
This option behaves exactly like ``--autofit``, except the window size is
only changed if the window would be larger than the specified size.
- *EXAMPLE*:
+ .. admonition:: Example
- ``90%x80%``
- 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.
+ ``90%x80%``
+ 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.
---autosub, --no-autosub
+``--autosub``, ``--no-autosub``
Load additional subtitle files matching the video filename. Enabled by
default. See also ``--autosub-match``.
---autosub-match=<exact|fuzzy|all>
+``--autosub-match=<exact|fuzzy|all>``
Adjust matching fuzziness when searching for subtitles:
:exact: exact match
:fuzzy: Load all subs containing movie name.
:all: Load all subs in the current and ``--sub-paths`` directories.
- (Default: exact.)
+ (default: exact)
---autosync=<factor>
+``--autosync=<factor>``
Gradually adjusts the A/V sync based on audio delay measurements.
Specifying ``--autosync=0``, the default, will cause frame timing to be
based entirely on audio delay measurements. Specifying ``--autosync=1``
@@ -263,37 +273,39 @@
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.
---bandwidth=<Bytes>
+``--bandwidth=<bytes>``
Specify the maximum bandwidth for network streaming (for servers that are
able to send content in different bitrates). Useful if you want to watch
live streamed media behind a slow connection. With Real RTSP streaming, it
is also used to set the maximum delivery bandwidth allowing faster cache
filling and stream dumping.
- *NOTE*: probably broken/useless.
+ .. note::
+
+ Probably broken/useless.
---untimed
+``--untimed``
Do not sleep when outputting video frames. Useful for benchmarks when used
- with --no-audio.
+ with ``--no-audio.``
---bluray-angle=<ID>
+``--bluray-angle=<ID>``
Some Blu-ray discs contain scenes that can be viewed from multiple angles.
- Here you can tell mpv which angles to use (default: 1).
+ This option tells mpv which angle to use (default: 1).
---bluray-device=<path>
+``--bluray-device=<path>``
(Blu-ray only)
Specify the Blu-ray disc location. Must be a directory with Blu-ray
structure.
---border, --no-border
+``--border``, ``--no-border``
Play movie with window border and decorations. Since this is on by
default, use ``--no-border`` to disable the standard window decorations.
---brightness=<-100-100>
+``--brightness=<-100-100>``
Adjust the brightness of the video signal (default: 0). Not supported by
all video output drivers.
---cache=<kBytes|no|auto>
+``--cache=<kBytes|no|auto>``
Set the size of the cache in kilobytes, disable it with ``no``, or
automatically enable it if needed with ``auto`` (default: ``auto``).
With ``auto``, the cache will usually be enabled for network streams,
@@ -309,7 +321,7 @@
seeking back. Likewise, when starting a file the cache will be at 100%,
because no space is reserved for seeking back yet.
---cache-pause=<no|percentage>
+``--cache-pause=<no|percentage>``
If the cache percentage goes below the specified value, pause and wait
until the percentage set by ``--cache-min`` is reached, then resume
playback (default: 10). If ``no`` is specified, this behavior is disabled.
@@ -318,12 +330,12 @@
instead of ``Paused``, and the OSD uses a clock symbol instead of the
normal paused symbol.
---cache-min=<percentage>
- Playback will start when the cache has been filled up to <percentage> of
+``--cache-min=<percentage>``
+ Playback will start when the cache has been filled up to ``<percentage>`` of
the total (default: 20).
---cache-seek-min=<percentage>
- If a seek is to be made to a position within <percentage> of the cache
+``--cache-seek-min=<percentage>``
+ If a seek is to be made to a position within ``<percentage>`` 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:
50).
@@ -334,15 +346,15 @@
on the situation, either of these might be slower than the other method.
This option allows control over this.
---cdda=<option1:option2>
+``--cdda=<option1:option2>``
This option can be used to tune the CD Audio reading feature of mpv.
Available options are:
- speed=<value>
+ ``speed=<value>``
Set CD spin speed.
- paranoia=<0-2>
+ ``paranoia=<0-2>``
Set paranoia level. Values other than 0 seem to break playback of
anything but the first track.
@@ -350,31 +362,31 @@
:1: overlap checking only
:2: full data correction and verification
- generic-dev=<value>
+ ``generic-dev=<value>``
Use specified generic SCSI device.
- sector-size=<value>
+ ``sector-size=<value>``
Set atomic read size.
- overlap=<value>
+ ``overlap=<value>``
Force minimum overlap search during verification to <value> sectors.
- toc-bias
+ ``toc-bias``
Assume that the beginning offset of track 1 as reported in the TOC
- will be addressed as LBA 0. Some Toshiba drives need this for getting
- track boundaries correct.
+ will be addressed as LBA 0. Some discs need this for getting track
+ boundaries correctly.
- toc-offset=<value>
- Add <value> sectors to the values reported when addressing tracks. May
- be negative.
+ ``toc-offset=<value>``
+ Add ``<value>`` sectors to the values reported when addressing tracks.
+ May be negative.
- (no-)skip
+ ``(no-)skip``
(Never) accept imperfect data reconstruction.
---cdrom-device=<path>
+``--cdrom-device=<path>``
Specify the CD-ROM device (default: ``/dev/cdrom``).
---channels=<number|layout>
+``--channels=<number|layout>``
Request the number of playback channels (default: 2). mpv asks the
decoder to decode the audio into as many channels as specified. Then it is
up to the decoder to fulfill the requirement. This is usually only
@@ -382,8 +394,10 @@
libavcodec downmixes the audio into the requested number of channels if
possible.
- *NOTE*: This option is honored by codecs (AC-3 only), filters (surround)
- and audio output drivers (OSS at least).
+ .. note::
+
+ This option is honored by codecs (AC-3 only), filters (surround) and
+ audio output drivers (OSS at least).
The ``--channels`` option either takes a channel number or an explicit
channel layout. Channel numbers refer to default layouts, e.g. 2 channels
@@ -393,11 +407,11 @@
lists speaker names, which can be used to express arbitrary channel
layouts (e.g. ``fl-fr-lfe`` is 2.1).
---chapter=<start[-end]>
+``--chapter=<start[-end]>``
Specify which chapter to start playing at. Optionally specify which
chapter to end playing at. Also see ``--start``.
---chapter-merge-threshold=<number>
+``--chapter-merge-threshold=<number>``
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
@@ -406,7 +420,7 @@
the start of the next one then keep playing video normally over the
chapter change instead of doing a seek.
---colormatrix=<colorspace>
+``--colormatrix=<colorspace>``
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
@@ -416,12 +430,12 @@
options --colormatrix-input-range and --colormatrix-output-range.
These options are not always supported. Different video outputs provide
- varying degrees of support. The opengl and vdpau video output drivers usually
- offer full support. The xv output can set the color space if the system
- video driver supports it, but not input and output levels. The scale video
- filter can configure color space and input levels, but only if the output
- format is RGB (if the video output driver supports RGB output, you can
- force this with ``-vf scale,format=rgba``).
+ varying degrees of support. The ``opengl`` and ``vdpau`` video output
+ drivers usually offer full support. The ``xv`` output can set the color
+ space if the system video driver supports it, but not input and output
+ levels. The ``scale`` video filter can configure color space and input
+ levels, but only if the output format is RGB (if the video output driver
+ supports RGB output, you can force this with ``-vf scale,format=rgba``).
If this option is set to ``auto`` (which is the default), the video's
color space flag will be used. If that flag is unset, the color space
@@ -437,10 +451,10 @@
:BT.709: ITU-R BT.709 (HD)
:SMPTE-240M: SMPTE-240M
---colormatrix-input-range=<color-range>
+``--colormatrix-input-range=<color-range>``
YUV color levels used with YUV to RGB conversion. This option is only
- necessary when playing broken files, which don't follow standard color
- levels or which are flagged wrong. If the video doesn't specify its
+ necessary when playing broken files which do not follow standard color
+ levels or which are flagged wrong. If the video does not specify its
color range, it is assumed to be limited range.
The same limitations as with --colormatrix apply.
@@ -451,14 +465,14 @@
:limited: limited range (16-235 for luma, 16-240 for chroma)
:full: full range (0-255 for both luma and chroma)
---colormatrix-output-range=<color-range>
+``--colormatrix-output-range=<color-range>``
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 level RGB. Providing full range output to a
+ 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 grey blacks and dim whites.
- The same limitations as with --colormatrix apply.
+ The same limitations as with ``--colormatrix`` apply.
Available color ranges are:
@@ -466,12 +480,17 @@
:limited: limited range (16-235 per component), studio levels
:full: full range (0-255 per component), PC levels
---colorkey=<number>
- Changes the colorkey to an RGB value of your choice. 0x000000 is black and
- 0xffffff is white. Only supported by the xv (see ``--vo=xv:ck``) video
- output driver. See also ``--no-colorkey``.
+ .. note::
+
+ It is advisable to use your graphics driver's color range option
+ instead, if available.
---consolecontrols, --no-consolecontrols
+``--colorkey=<number>``
+ Changes the colorkey to an RGB value of your choice. ``0x000000`` is black
+ and ``0xffffff`` is white. Only supported by the ``xv`` (see
+ ``--vo=xv:ck``) video output driver. See also ``--no-colorkey``.
+
+``--consolecontrols``, ``--no-consolecontrols``
``--no-consolecontrols`` prevents the player from reading key events from
standard input. Useful when reading data from standard input. This is
automatically enabled when ``-`` is found on the command line. There are
@@ -480,64 +499,62 @@
or intend to read from stdin later on via the loadfile or loadlist slave
commands.
---contrast=<-100-100>
+``--contrast=<-100-100>``
Adjust the contrast of the video signal (default: 0). Not supported by all
video output drivers.
---cookies, --no-cookies
+``--cookies``, ``--no-cookies``
(network only)
Support cookies when making HTTP requests. Disabled by default.
---cookies-file=<filename>
+``--cookies-file=<filename>``
(network only)
- Read HTTP cookies from <filename>. The file is
- assumed to be in Netscape format.
-
---correct-pts, --no-correct-pts
- Switches mpv to a mode where timestamps for video frames are
- calculated differently and video filters which add new frames or modify
- timestamps of existing ones are supported. Now enabled automatically for
- most common file formats. The more accurate timestamps can be visible for
- example when playing subtitles timed to scene changes with the ``--ass``
- option. Without ``--correct-pts`` the subtitle timing will typically be
- off by some frames. This option does not work correctly with some demuxers
- and codecs.
-
---cursor-autohide=<number|no|always>
+ Read HTTP cookies from <filename>. The file is assumed to be in Netscape
+ format.
+
+``--correct-pts``, ``--no-correct-pts``
+ Switches mpv to a mode where timestamps for video frames are calculated
+ differently and video filters which add new frames or modify timestamps of
+ existing ones are supported. Now enabled automatically for most common file
+ formats. The more accurate timestamps can be visible for example when
+ playing subtitles timed to scene changes with the ``--ass`` option. Without
+ ``--correct-pts``, the subtitle timing will typically be off by some frames.
+ This option does not work correctly with some demuxers and codecs.
+
+``--cursor-autohide=<number|no|always>``
Make mouse cursor automatically hide after given number of milliseconds.
- ``no`` will disable cursor autohide. ``always`` means the cursor
- will stay hidden. Supported by video output drivers which use X11 or
- OS X Cocoa.
+ ``no`` will disable cursor autohide. ``always`` means the cursor will stay
+ hidden.
---audio-delay=<sec>
- audio delay in seconds (positive or negative float value). Negative values
+``--audio-delay=<sec>``
+ Audio delay in seconds (positive or negative float value). Negative values
delay the audio, and positive values delay the video.
---demuxer=<[+]name>
- Force demuxer type. Use a '+' before the name to force it, this will skip
- some checks! Give the demuxer name as printed by ``--demuxer=help``.
+``--demuxer=<[+]name>``
+ Force demuxer type. Use a '+' before the name to force it; this will skip
+ some checks. Give the demuxer name as printed by ``--demuxer=help``.
---demuxer-lavf-analyzeduration=<value>
+``--demuxer-lavf-analyzeduration=<value>``
Maximum length in seconds to analyze the stream properties.
---demuxer-lavf-probescore=<1-100>
+``--demuxer-lavf-probescore=<1-100>``
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.)
---demuxer-lavf-allow-mimetype=<yes|no>
- Allow deriving the format from the HTTP mimetype (default: yes). Set
- this to no in case playing things from http mysteriously fails, even
+``--demuxer-lavf-allow-mimetype=<yes|no>``
+ 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.
- This is default in order to reduce latency when opening http streams.
+ This is default in order to reduce latency when opening HTTP streams.
---demuxer-lavf-format=<value>
+``--demuxer-lavf-format=<value>``
Force a specific libavformat demuxer.
---demuxer-lavf-o=<key>=<value>[,<key>=<value>[,...]]
+``--demuxer-lavf-o=<key>=<value>[,<key>=<value>[,...]]``
Pass AVOptions to libavformat demuxer.
Note, a patch to make the *o=* unneeded and pass all unknown options
@@ -545,18 +562,20 @@
be found in the FFmpeg manual. Note that some options may conflict
with mpv options.
- *EXAMPLE*: ``--demuxer-lavf-o=fflags=+ignidx``
+ .. admonition:: Example
+
+ ``--demuxer-lavf-o=fflags=+ignidx``
---demuxer-lavf-probesize=<value>
+``--demuxer-lavf-probesize=<value>``
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.
---demuxer-lavf-cryptokey=<hexstring>
+``--demuxer-lavf-cryptokey=<hexstring>``
Encryption key the demuxer should use. This is the raw binary data of
the key converted to a hexadecimal string.
---demuxer-mkv-subtitle-preroll, --mkv-subtitle-preroll
+``--demuxer-mkv-subtitle-preroll``, ``--mkv-subtitle-preroll``
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
@@ -576,122 +595,124 @@
See also ``--hr-seek-demuxer-offset`` 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,
+ but makes seeking much slower, as it has to decode audio and video data
instead of just skipping over it.
``--mkv-subtitle-preroll`` is a deprecated alias.
---demuxer-rawaudio-channels=<value>
+``--demuxer-rawaudio-channels=<value>``
Number of channels (or channel layout) if ``--demuxer=rawaudio`` is used
(default: stereo).
---demuxer-rawaudio-format=<value>
+``--demuxer-rawaudio-format=<value>``
Sample format for ``--demuxer=rawaudio`` (default: s16le).
---demuxer-rawaudio-rate=<value>
+``--demuxer-rawaudio-rate=<value>``
Sample rate for ``--demuxer=rawaudio`` (default: 44KHz).
---demuxer-rawvideo-fps=<value>
+``--demuxer-rawvideo-fps=<value>``
Rate in frames per second for ``--demuxer=rawvideo`` (default: 25.0).
---demuxer-rawvideo-w=<value>, --demuxer-rawvideo-h=<value>
+``--demuxer-rawvideo-w=<value>``, ``--demuxer-rawvideo-h=<value>``
Image dimension in pixels for ``--demuxer=rawvideo``.
- *EXAMPLE*:
+ .. admonition:: Example
- - ``mpv sample-720x576.yuv --demuxer=rawvideo --demuxer-rawvideo=w=720:h=576``
- Play a raw YUV sample.
+ - ``mpv sample-720x576.yuv --demuxer=rawvideo --demuxer-rawvideo=w=720:h=576``
+ Play a raw YUV sample.
---demuxer-rawvideo-format=<value>
+``--demuxer-rawvideo-format=<value>``
Colorspace (fourcc) in hex or string for ``--demuxer=rawvideo``
(default: YV12).
---demuxer-rawvideo-mp-format=<value>
+``--demuxer-rawvideo-mp-format=<value>``
Colorspace by internal video format for ``--demuxer=rawvideo``. Use
``--demuxer-rawvideo-mp-format=help`` for a list of possible formats.
---demuxer-rawvideo-codec=<value>
+``--demuxer-rawvideo-codec=<value>``
Set the video codec instead of selecting the rawvideo codec when using
``--demuxer=rawvideo``. This uses the same values as codec names in
- ``--vd`` (but it doesn't accept decoder names).
+ ``--vd`` (but it does not accept decoder names).
---demuxer-rawvideo-size=<value>
+``--demuxer-rawvideo-size=<value>``
Frame size in bytes when using ``--demuxer=rawvideo``.
---doubleclick-time=<milliseconds>
+``--doubleclick-time=<milliseconds>``
Time in milliseconds to recognize two consecutive button presses as a
double-click (default: 300).
---dvbin=<options>
+``--dvbin=<options>``
Pass the following parameters to the DVB input module, in order to
override the default ones:
:card=<1-4>: Specifies using card number 1-4 (default: 1).
:file=<filename>: Instructs mpv to read the channels list from
- <filename>. Default is
+ ``<filename>``. Default is
``~/.mpv/channels.conf.{sat,ter,cbl,atsc}`` (based
on your card type) or ``~/.mpv/channels.conf`` as a
last resort.
:timeout=<1-30>: Maximum number of seconds to wait when trying to tune a
frequency before giving up (default: 30).
---dvd-device=<path>
+``--dvd-device=<path>``
Specify the DVD device or .iso filename (default: ``/dev/dvd``). You can
also specify a directory that contains files previously copied directly
from a DVD (with e.g. vobcopy).
---dvd-speed=<speed>
+``--dvd-speed=<speed>``
Try to limit DVD speed (default: 0, no change). DVD base speed is 1385
- kB/s, so a 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
+ 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. ``--dvd-speed=8`` selects 11080 kB/s.
- *NOTE*: You need write access to the DVD device to change the speed.
+ .. note::
+
+ You need write access to the DVD device to change the speed.
---dvdangle=<ID>
- Some DVD discs contain scenes that can be viewed from multiple angles.
- Here you can tell mpv which angles to use (default: 1).
+``--dvdangle=<ID>``
+ Some DVDs contain scenes that can be viewed from multiple angles.
+ This option tells mpv which angle to use (default: 1).
---edition=<ID>
+``--edition=<ID>``
(Matroska files only)
Specify the edition (set of chapters) to use, where 0 is the first. If set
to -1 (the default), mpv will choose the first edition declared as a
default, or if there is no default, the first edition defined.
---embeddedfonts, --no-embeddedfonts
+``--embeddedfonts``, ``--no-embeddedfonts``
Use fonts embedded in Matroska container files and ASS scripts (default:
enabled). These fonts can be used for SSA/ASS subtitle rendering
(``--ass`` option).
---end=<time>
+``--end=<time>``
Stop at given absolute time. Use ``--length`` if the time should be relative
to ``--start``. See ``--start`` for valid option values and examples.
---no-extbased, --extbased
- ``--no-extbased`` disables extension-based demuxer selection. By default, when the file type
- (demuxer) cannot be detected reliably (the file has no header or it is not
- reliable enough), the filename extension is used to select the demuxer.
- Always falls back on content-based demuxer selection.
+``--no-extbased``, ``--extbased``
+ ``--no-extbased`` disables extension-based demuxer selection. By default,
+ when the file type (demuxer) cannot be detected reliably (the file has no
+ header or it is not reliable enough), the filename extension is used to
+ select the demuxer. Always falls back on content-based demuxer selection.
---field-dominance=<auto|top|bottom>
+``--field-dominance=<auto|top|bottom>``
Set first field for interlaced content. Useful for deinterlacers that
double the framerate: ``--vf=yadif=1`` and ``--vo=vdpau:deint``.
:auto: (default) If the decoder does not export the appropriate
- information, it falls back to ``top`` (top field first).
+ information, it falls back on ``top`` (top field first).
:top: top field first
:bottom: bottom field first
---no-fixed-vo, --fixed-vo
+``--no-fixed-vo``, ``--fixed-vo``
``--no-fixed-vo`` enforces closing and reopening the video window for
multiple files (one (un)initialization for all files).
---flip
+``--flip``
Flip image upside-down.
---force-rgba-osd-rendering
+``--force-rgba-osd-rendering``
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 ``vdpau``,
@@ -699,77 +720,90 @@
depending on GPU drivers and hardware. For other VOs, this just makes
rendering slower.
---force-window-position
+``--force-window-position``
Forcefully move mpv's 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.
---sub-forced-only
+``--sub-forced-only``
Display only forced subtitles for the DVD subtitle stream selected by e.g.
``--slang``.
---forceidx
+``--forceidx``
Force index rebuilding. Useful for files with broken index (A/V desync,
etc). This will enable seeking in files where seeking was not possible.
- *NOTE*: This option only works if the underlying media supports seeking
- (i.e. not with stdin, pipe, etc).
+ .. note::
---format=<format>
+ This option only works if the underlying media supports seeking
+ (i.e. not with stdin, pipe, etc).
+
+``--format=<format>``
Select the sample format used for output from the audio filter layer to
- the sound card. The values that <format> can adopt are listed below in the
- description of the ``format`` audio filter.
+ the sound card. The values that ``<format>`` can adopt are listed below in
+ the description of the ``format`` audio filter.
---fps=<float>
+``--fps=<float>``
Override video framerate. Useful if the original value is wrong or missing.
- *NOTE*: Works in ``--no-correct-pts`` mode only.
+ .. note::
+
+ Works in ``--no-correct-pts`` mode only.
---framedrop=<no|yes|hard>
+``--framedrop=<no|yes|hard>``
Skip displaying some frames to maintain A/V sync on slow systems. Video
filters are not applied to such frames. For B-frames even decoding is
skipped completely. May produce unwatchably choppy output. With ``hard``,
decoding and output of any frame can be skipped, and will lead to an even
worse playback experience.
- *NOTE*: Practical use of this feature is questionable. Disabled by default.
+ .. note::
---frames=<number>
- Play/convert only first <number> video frames, then quit. For audio only,
- run <number> iteration of the playback loop, which is most likely not what
- you want. (This behavior also applies to the corner case when there are
- less video frames than <number>, and audio is longer than the video.)
+ Practical use of this feature is questionable. Disabled by default.
---fullscreen, --fs
- Fullscreen playback (centers movie, and paints black bands around it).
+``--frames=<number>``
+ Play/convert only first ``<number>`` video frames, then quit. For audio
+ only, run ``<number>`` iteration of the playback loop, which is most likely
+ not what you want. (This behavior also applies to the corner case when there
+ are fewer video frames than ``<number>``, and audio is longer than the
+ video.)
+``--fullscreen``, ``--fs``
+ Fullscreen playback.
---fs-screen=<all|current|0-32>
+``--fs-screen=<all|current|0-32>``
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 ``default`` is provided mpv will fallback to using the behaviour
+ multiple displays), this option tells mpv which screen to go fullscreen to.
+ If ``default`` is provided mpv will fallback on using the behaviour
depending on what the user provided with the ``screen`` option.
- *NOTE (X11)*: this option does not work properly with all window managers.
- ``all`` in particular will usually only work with ``--fstype=-fullscreen``
- or ``--fstype=none``, and even then only with some window managers.
+ .. admonition:: Note (X11)
- *NOTE (OSX)*: ``all`` doesn't work on OSX and will behave like ``current``.
+ This option does not work properly with all window managers.
+ ``all`` in particular will usually only work with
+ ``--fstype=-fullscreen`` or ``--fstype=none``, and even then only with
+ some window managers.
+
+ .. admonition:: Note (OS X)
+
+ ``all`` does not work on OSX and will behave like ``current``.
See also ``--screen``.
---fsmode-dontuse=<0-31>
- OBSOLETE, use the ``--fs`` option.
+``--fsmode-dontuse=<0-31>``
+ *OBSOLETE*, use the ``--fs`` option.
Try this option if you still experience fullscreen problems.
---fstype=<type1,type2,...>
+``--fstype=<type1,type2,...>``
(X11 only)
Specify a priority list of fullscreen modes to be used. You can negate the
modes by prefixing them with '-'. If you experience problems like the
- fullscreen window being covered by other windows try using a different
+ fullscreen window being covered by other windows, try using a different
order.
- *NOTE*: See ``--fstype=help`` for a full list of available modes.
+ .. note::
+
+ See ``--fstype=help`` for a full list of available modes.
The available types are:
@@ -790,53 +824,55 @@
stays_on_top
Use ``_NETWM_STATE_STAYS_ON_TOP`` hint if available.
- *EXAMPLE*:
+ .. admonition:: Examples
- ``--fstype=layer,stays_on_top,above,fullscreen``
- Default order, will be used as a fallback if incorrect or
- unsupported modes are specified.
- ``--fstype=fullscreen``
- Fixes fullscreen switching on OpenBox 1.x.
+ ``--fstype=layer,stays_on_top,above,fullscreen``
+ Default order, will be used as a fallback if incorrect or
+ unsupported modes are specified.
+ ``--fstype=fullscreen``
+ Fixes fullscreen switching on OpenBox 1.x.
---native-fs
+``--native-fs``
(OS X only)
- Use OSX's Mission Control's fullscreen feature instead of the custom one
+ Use OS X Mission Control's fullscreen feature instead of the custom one
provided by mpv. This can potentially break a lot of stuff like
``--geometry`` and is disabled by default. On the other hand it provides
a more 'OS X-like' user experience.
---gamma=<-100-100>
+``--gamma=<-100-100>``
Adjust the gamma of the video signal (default: 0). Not supported by all
video output drivers.
---gapless-audio
+``--gapless-audio``
Try to play consecutive audio files with no silence or disruption at the
point of file change. 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's played from a remote network location or because you
+ 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.
- *NOTE*: 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 samplerate then the
- following files may get resampled to the same low samplerate, resulting in
- reduced sound quality. If you play files with different parameters,
- consider using options such as ``--srate`` and ``--format`` to explicitly
- select what the shared output format will be.
-
---geometry=<[W[xH]][+-x+-y]>, --geometry=<x:y>
- Adjust the initial window position or size. W and H set the window size in
- pixels. x and y set the window position, measured in pixels from the
- top-left of the screen to the top-left of the image being displayed. If a
- percentage sign (``%``) 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 ``--geometry`` 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".
+ .. note::
+
+ 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 ``--srate`` and ``--format`` to
+ explicitly select what the shared output format will be.
+
+``--geometry=<[W[xH]][+-x+-y]>``, ``--geometry=<x:y>``
+ Adjust the initial window position or size. ``W`` and ``H`` set the window
+ size in pixels. ``x`` and ``y`` 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 (``%``) 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 ``--geometry`` 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".
If an external window is specified using the ``--wid`` option, this
option is ignored.
@@ -844,74 +880,84 @@
The coordinates are relative to the screen given with ``--screen`` for the
video output drivers that fully support ``--screen``.
- *NOTE*: Generally only supported by GUI VOs. Ignored for encoding.
-
- *NOTE (OSX)*: On Mac OSX the origin of the screen coordinate system is
- located on the the bottom-left corner. For instance, ``0:0`` will place the
- window at the bottom-left of the screen.
-
- *NOTE (X11)*: this option does not work properly with all window managers.
-
- *EXAMPLE*:
-
- ``50:40``
- Places the window at x=50, y=40.
- ``50%:50%``
- Places the window in the middle of the screen.
- ``100%:100%``
- Places the window at the bottom right corner of the screen.
- ``50%``
- Sets the window width to half the screen width. Window height is set so
- that the window has the video aspect ratio.
- ``50%x50%``
- 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 ``--no-keepaspect``).
- ``50%+10+10``
- Sets the window to half the screen widths, and positions it 10 pixels
- below/left of the top left corner of the screen.
+ .. note::
+
+ Generally only supported by GUI VOs. Ignored for encoding.
+
+ .. admonition: Note (OS X)
+
+ On Mac OSX 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.
+
+ .. admonition:: Note (X11)
+
+ This option does not work properly with all window managers.
+
+ .. admonition:: Examples
+
+ ``50:40``
+ Places the window at x=50, y=40.
+ ``50%:50%``
+ Places the window in the middle of the screen.
+ ``100%:100%``
+ Places the window at the bottom right corner of the screen.
+ ``50%``
+ Sets the window width to half the screen width. Window height is set
+ so that the window has the video aspect ratio.
+ ``50%x50%``
+ 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 ``--no-keepaspect``).
+ ``50%+10+10``
+ Sets the window to half the screen widths, and positions it 10
+ pixels below/left of the top left corner of the screen.
See also ``--autofit`` and ``--autofit-larger`` for fitting the window into
a given size without changing aspect ratio.
---grabpointer, --no-grabpointer
+``--grabpointer``, ``--no-grabpointer``
``--no-grabpointer`` tells the player to not grab the mouse pointer after a
video mode change (``--vm``). Useful for multihead setups.
---heartbeat-cmd
+``--heartbeat-cmd``
Command that is executed every 30 seconds during playback via *system()* -
i.e. using the shell. The time between the commands can be customized with
the ``--heartbeat-interval`` option.
- *NOTE*: 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 ``--no-video`` but works with
- ``-vo=null``).
+ .. note::
+
+ 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 ``--no-video`` but works with
+ ``-vo=null``).
This can be "misused" to disable screensavers that do not support the
proper X API (see also ``--stop-screensaver``). If you think this is too
complicated, ask the author of the screensaver program to support the
proper X APIs.
- *EXAMPLE for xscreensaver*: ``mpv --heartbeat-cmd="xscreensaver-command
- -deactivate" file``
+ .. admonition:: Example for xscreensaver
+
+ ``mpv --heartbeat-cmd="xscreensaver-command -deactivate" file``
+
+ .. admonition:: Example for GNOME screensaver
- *EXAMPLE for GNOME screensaver*: ``mpv
- --heartbeat-cmd="gnome-screensaver-command -p" file``
+ ``mpv --heartbeat-cmd="gnome-screensaver-command -p" file``
---heartbeat-interval=<sec>
+``--heartbeat-interval=<sec>``
Time between ``--heartbeat-cmd`` invocations in seconds (default: 30).
---help
+``--help``
Show short summary of options.
---hr-seek=<no|absolute|yes>
+``--hr-seek=<no|absolute|yes>``
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's possible to explicitly override that
+ 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.
:no: Never use precise seeks.
@@ -920,12 +966,12 @@
the default behavior of arrow keys (default).
:yes: Use precise seeks whenever possible.
---hr-seek-demuxer-offset=<seconds>
+``--hr-seek-demuxer-offset=<seconds>``
This option exists to work around failures to do precise seeks (as in
``--hr-seek``) 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
+ 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
@@ -933,79 +979,81 @@
the earlier demuxer position and the real target may be unnecessarily
decoded.
---http-header-fields=<field1,field2>
+``--http-header-fields=<field1,field2>``
Set custom HTTP fields when accessing HTTP stream.
- *EXAMPLE*:
+ .. admonition:: Example
- ``mpv --http-header-fields='Field1: value1','Field2: value2' http://localhost:1234``
+ ``mpv --http-header-fields='Field1: value1','Field2: value2' http://localhost:1234``
- Will generate HTTP request:
+ Will generate HTTP request::
- | GET / HTTP/1.0
- | Host: localhost:1234
- | User-Agent: MPlayer
- | Icy-MetaData: 1
- | Field1: value1
- | Field2: value2
- | Connection: close
+ GET / HTTP/1.0
+ Host: localhost:1234
+ User-Agent: MPlayer
+ Icy-MetaData: 1
+ Field1: value1
+ Field2: value2
+ Connection: close
---hue=<-100-100>
+``--hue=<-100-100>``
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.
---hwdec=<api>
+``--hwdec=<api>``
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 to software decoding.
+ hardware decoding is not possible, mpv will fall back on software decoding.
- <api> can be one of the following:
+ ``<api>`` can be one of the following:
:no: always use software decoding (default)
:vdpau: works with nvidia drivers only, requires ``--vo=vdpau``
:vda: OSX
:crystalhd: Broadcom Crystal HD
---hwdec-codecs=<codec1,codec2,...|all>
+``--hwdec-codecs=<codec1,codec2,...|all>``
Allow hardware decoding for a given list of codecs only. The default is the
special value ``all``, which always allows all codecs.
- This is usually only needed with broken GPUs, where fallback to software
- decoding doesn't work properly.
+ This is usually only needed with broken GPUs, where fallback on software
+ decoding does not work properly.
- *EXAMPLE*:
+ .. admonition:: Example
- - ``mpv --hwdec=vdpau --vo=vdpau --hwdec-codecs=h264,mpeg2video``
- Enable vdpau decoding for h264 and mpeg2 only.
+ ``mpv --hwdec=vdpau --vo=vdpau --hwdec-codecs=h264,mpeg2video``
+ Enable vdpau decoding for h264 and mpeg2 only.
---identify
+``--identify``
Deprecated. Use ``TOOLS/mpv_identify.sh``.
---idle
+``--idle``
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
+ Mostly useful in slave mode, where mpv can be controlled through input
commands (see also ``--slave-broken``).
---idx
+``--idx``
Rebuilds index of files if no index was found, allowing seeking. Useful
- with broken/incomplete downloads, or badly created files. Now this is done
+ with broken/incomplete downloads or badly created files. Now this is done
automatically by the demuxers used for most video formats, meaning that
this switch has no effect in the typical case. See also ``--forceidx``.
- *NOTE*: This option only works if the underlying media supports seeking
- (i.e. not with stdin, pipe, etc).
+ .. note::
---ignore-start
+ This option only works if the underlying media supports seeking
+ (i.e. not with stdin, pipe, etc).
+
+``--ignore-start``
Matters with the builtin AVI demuxer only, which is not enabled by default.
Ignore the specified starting time for streams in AVI files. This
nullifies stream delays.
---include=<configuration-file>
+``--include=<configuration-file>``
Specify configuration file to be parsed after the default ones.
---initial-audio-sync, --no-initial-audio-sync
- When starting a video file or after events such as seeking mpv will by
+``--initial-audio-sync``, ``--no-initial-audio-sync``
+ 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
@@ -1013,99 +1061,102 @@
their start timestamps differ, and then video timing is gradually adjusted
if necessary to reach correct synchronization later.
---input-conf=<filename>
+``--input-conf=<filename>``
Specify input configuration file other than the default
``~/.mpv/input.conf``.
---input-ar-delay
- Delay in milliseconds before we start to autorepeat a key (0 to
- disable).
+``--input-ar-delay``
+ Delay in milliseconds before we start to autorepeat a key (0 to disable).
---input-ar-rate
+``--input-ar-rate``
Number of key presses to generate per second on autorepeat.
---no-input-default-bindings
+``--no-input-default-bindings``
Disable mpv default (builtin) key bindings.
---input-keylist
+``--input-keylist``
Prints all keys that can be bound to commands.
---input-cmdlist
+``--input-cmdlist``
Prints all commands that can be bound to keys.
---input-js-dev
+``--input-js-dev``
Specifies the joystick device to use (default: ``/dev/input/js0``).
---input-file=<filename>
+``--input-file=<filename>``
Read commands from the given file. Mostly useful with a FIFO.
See also ``--slave-broken``.
- *NOTE*: When the given file is a FIFO mpv opens both ends so you
- can do several `echo "seek 10" > mp_pipe` and the pipe will stay
- valid.
+ .. note::
+
+ When the given file is a FIFO mpv opens both ends, so you can do several
+ `echo "seek 10" > mp_pipe` and the pipe will stay valid.
---input-test
+``--input-test``
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).
+ like any other binding). See `INPUT.CONF`_.
---joystick, --no-joystick
+``--joystick``, ``--no-joystick``
Enable/disable joystick support. Enabled by default.
---no-keepaspect, --keepaspect
- --no-keepaspect will always stretch the video to window size, and will
+``--no-keepaspect``, ``--keepaspect``
+ ``--no-keepaspect`` 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.)
---keep-open
+``--keep-open``
Do not terminate when playing or seeking beyond the end of the file.
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).
- *NOTE*: this option is not respected when using ``--frames``, ``--end``,
- ``--length``, or when passing a chapter range to ``--chapter``. Explicitly
- skipping to the next file or skipping beyond the last chapter will terminate
- playback as well, even if ``--keep-open`` is given.
+ .. note::
+
+ This option is not respected when using ``--frames``, ``--end``,
+ ``--length``, or when passing a chapter range to ``--chapter``.
+ Explicitly skipping to the next file or skipping beyond the last
+ chapter will terminate playback as well, even if ``--keep-open`` is
+ given.
---key-fifo-size=<2-65000>
+``--key-fifo-size=<2-65000>``
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.
---length=<relative time>
+``--length=<relative time>``
Stop after a given time relative to the start time.
See ``--start`` for valid option values and examples.
---lirc, --no-lirc
+``--lirc``, ``--no-lirc``
Enable/disable LIRC support. Enabled by default.
---lircconf=<filename>
+``--lircconf=<filename>``
(LIRC only)
Specifies a configuration file for LIRC (default: ``~/.lircrc``).
---list-options
+``--list-options``
Prints all available options.
---list-properties
+``--list-properties``
Print a list of the available properties.
---loop=<number|inf|no>
- Loops playback <number> times. ``inf`` means forever and ``no`` disables
- looping. If several files are specified on command line, the whole playlist
+``--loop=<number|inf|no>``
+ Loops playback ``<number>`` times. ``inf`` means forever and ``no`` disables
+ looping. If several files are specified on command line, the entire playlist
is looped.
---mc=<seconds/frame>
+``--mc=<seconds/frame>``
Maximum A-V sync correction per frame (in seconds)
---media-keys, --no-media-keys
+``--media-keys``, ``--no-media-keys``
OSX only: Enabled by default. Enables/disable media keys support.
---mf=<option1:option2:...>
+``--mf=<option1:option2:...>``
Used when decoding from multiple PNG or JPEG files with ``mf://``.
Available options are:
@@ -1113,60 +1164,64 @@
:fps=<value>: output fps (default: 25)
:type=<value>: input file type (available: jpeg, png, tga, sgi)
---mixer=<device>
+``--mixer=<device>``
Use a mixer device different from the default ``/dev/mixer``. For ALSA
this is the mixer name.
---mixer-channel=<name[,index]>
+``--mixer-channel=<name[,index]>``
(``--ao=oss`` and ``--ao=alsa`` only)
This option will tell mpv to use a different channel for controlling
volume than the default PCM. Options for OSS include **vol, pcm, line**.
For a complete list of options look for ``SOUND_DEVICE_NAMES`` in
- ``/usr/include/linux/soundcard.h``. For ALSA you can use the names e.g.
- alsamixer displays, like **Master, Line, PCM**.
+ ``/usr/include/linux/soundcard.h``. For ALSA, you can use the names e.g.
+ "``amixer scontrols``" displays, like **Master, Line, PCM**.
- *NOTE*: ALSA mixer channel names followed by a number must be specified in
- the <name,number> format, i.e. a channel labeled 'PCM 1' in alsamixer must
- be converted to PCM,1.
+ .. note::
---monitoraspect=<ratio>
+ ALSA mixer channel names followed by a number must be specified in the
+ <name,number> format, i.e. a channel labeled 'PCM 1' in alsamixer must
+ be converted to PCM,1.
+
+``--monitoraspect=<ratio>``
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
``--monitorpixelaspect`` setting if enabled.
+
See also ``--monitorpixelaspect`` and ``--aspect``.
- *EXAMPLE*:
+ .. admonition:: Examples
- - ``--monitoraspect=4:3`` or ``--monitoraspect=1.3333``
- - ``--monitoraspect=16:9`` or ``--monitoraspect=1.7777``
+ - ``--monitoraspect=4:3`` or ``--monitoraspect=1.3333``
+ - ``--monitoraspect=16:9`` or ``--monitoraspect=1.7777``
---monitorpixelaspect=<ratio>
+``--monitorpixelaspect=<ratio>``
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 ``--monitoraspect`` and ``--aspect``.
---mouse-movements
+``--mouse-movements``
Permit mpv to receive pointer events reported by the video output
driver. Necessary to select the buttons in DVD menus. Supported for
X11-based VOs (x11, xv, etc) and the gl, direct3d and corevideo VOs.
---mouseinput, --no-mouseinput
- Enabled by default. Disable mouse button press/release input
- (mozplayerxp's context menu relies on this option).
+``--mouseinput``, ``--no-mouseinput``
+ ``--no-mouseinput`` disables mouse button press/release input.
---no-msgcolor
+``--no-msgcolor``
Disable colorful console output on terminals.
---msglevel=<module1=level1:module2=level2:...>
- Control verbosity directly for each module. The *all* module changes the
+``--msglevel=<module1=level1:module2=level2:...>``
+ Control verbosity directly for each module. The ``all`` module changes the
verbosity of all the modules not explicitly specified on the command line.
See ``--msglevel=help`` for a list of all modules.
- *NOTE*: Some messages are printed before the command line is parsed and
- are therefore not affected by ``--msglevel``. To control these messages
- you have to use the ``MPV_VERBOSE`` environment variable; see its
- description below for details.
+ .. note::
+
+ Some messages are printed before the command line is parsed and are
+ therefore not affected by ``--msglevel``. To control these messages,
+ you have to use the ``MPV_VERBOSE`` environment variable; see
+ `ENVIRONMENT VARIABLES`_ for details.
Available levels:
@@ -1182,34 +1237,34 @@
:8: debug level 3
:9: debug level 4
---msgmodule
+``--msgmodule``
Prepend module name in front of each console message.
---mute=<auto|yes|no>
+``--mute=<auto|yes|no>``
Set startup audio mute status. ``auto`` (default) will not change the mute
status. Also see ``--volume``.
---name
+``--name``
Set the window class name for X11-based video output methods.
---native-keyrepeat
+``--native-keyrepeat``
Use system settings for keyrepeat delay and rate, instead of
``--input-ar-delay`` and ``--input-ar-rate``. (Whether this applies
depends on the VO backend and how it handles keyboard input. Does not
apply to terminal input.)
---no-aspect
+``--no-aspect``
Ignore aspect ratio information from video file and assume the video has
square pixels. See also ``--aspect``.
---no-cache
+``--no-cache``
Turn off input stream caching. See ``--cache``.
---no-colorkey
+``--no-colorkey``
Disables colorkeying. Only supported by the xv (see ``--vo=xv:ck``) video
output driver.
---no-config
+``--no-config``
Do not load default configuration files. This prevents loading of
``~/.mpv/config`` and ``~/.mpv/input.conf``, as well as loading the
same files from system wide configuration directories.
@@ -1217,41 +1272,43 @@
Loading of some configuration files is not affected by this option, such
as configuration files for DVB code and fontconfig.
- *NOTE*: Files explicitly requested by command line options, like
- ``--include`` or ``--use-filedir-conf``, will still be loaded.
+ .. note::
+
+ Files explicitly requested by command line options, like
+ ``--include`` or ``--use-filedir-conf``, will still be loaded.
---no-idx
+``--no-idx``
Do not use index present in the file even if one is present.
---no-audio
+``--no-audio``
Do not play sound. With some demuxers this may not work. In those cases
you can try ``--ao=null`` instead.
---no-resume-playback
+``--no-resume-playback``
Do not restore playback position from ``~/.mpv/watch_later/``.
See ``quit_watch_later`` input command.
---no-sub
- Don't select any subtitle when the file is loaded.
+``--no-sub``
+ Do not select any subtitle when the file is loaded.
---no-sub-visibility
+``--no-sub-visibility``
Disable display of subtitles, but still select and decode them.
---no-video
+``--no-video``
Do not play video. With some demuxers this may not work. In those cases
you can try ``--vo=null`` instead.
---ontop
+``--ontop``
Makes the player window stay on top of other windows. Supported by video
output drivers which use X11, as well as corevideo.
---ordered-chapters, --no-ordered-chapters
+``--ordered-chapters``, ``--no-ordered-chapters``
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.
---no-osd-bar, --osd-bar
+``--no-osd-bar``, ``--osd-bar``
Disable display of the OSD bar. This will make some things (like seeking)
use OSD text messages instead of the bar.
@@ -1259,71 +1316,75 @@
prefixes, see ``Input command prefixes``. If you want to disable the OSD
completely, use ``--osd-level=0``.
---osd-bar-align-x=<-1-1>
+``--osd-bar-align-x=<-1-1>``
Position of the OSD bar. -1 is far left, 0 is centered, 1 is far right.
---osd-bar-align-y=<-1-1>
+``--osd-bar-align-y=<-1-1>``
Position of the OSD bar. -1 is top, 0 is centered, 1 is bottom.
---osd-bar-w=<1-100>
+``--osd-bar-w=<1-100>``
Width of the OSD bar, in percentage of the screen width (default: 75).
A value of 0.5 means the bar is half the screen wide.
---osd-bar-h=<0.1-50>
+``--osd-bar-h=<0.1-50>``
Height of the OSD bar, in percentage of the screen height (default: 3.125).
---osd-back-color=<#RRGGBB>, --sub-text-back-color=<#RRGGBB>
+``--osd-back-color=<#RRGGBB>``, ``--sub-text-back-color=<#RRGGBB>``
See ``--osd-color``. Color used for OSD/sub text background.
---osd-blur=<0..20.0>, --sub-text-blur=<0..20.0>
+``--osd-blur=<0..20.0>``, ``--sub-text-blur=<0..20.0>``
Gaussian blur factor. 0 means no blur applied (default).
---osd-border-color=<#RRGGBB>, --sub-text-border-color=<#RRGGBB>
+``--osd-border-color=<#RRGGBB>``, ``--sub-text-border-color=<#RRGGBB>``
See ``--osd-color``. Color used for the OSD/sub font border.
- *NOTE*: ignored when ``--osd-back-color``/``--sub-text-back-color`` is
- specified (or more exactly: when that option is not set to completely
- transparent).
+ .. note::
---osd-border-size=<size>, --sub-text-border-size=<size>
+ ignored when ``--osd-back-color``/``--sub-text-back-color`` is
+ specified (or more exactly: when that option is not set to completely
+ transparent).
+
+``--osd-border-size=<size>``, ``--sub-text-border-size=<size>``
Size of the OSD/sub font border in scaled pixels (see ``--osd-font-size``
for details). A value of 0 disables borders.
Default: 2.5.
---osd-color=<#RRGGBB|#AARRGGBB>, --sub-text-color=<#RRGGBB|#AARRGGBB>
+``--osd-color=<#RRGGBB|#AARRGGBB>``, ``--sub-text-color=<#RRGGBB|#AARRGGBB>``
Specify the color used for OSD/unstyled text subtitles.
The color is specified as a RGB hex triplet, and each 2-digit group
- expresses a color value in the range 0 (``00``) to 255 (`FF`).
+ expresses a color value in the range 0 (``00``) to 255 (``FF``).
For example, ``#FF0000`` is red. This is similar to web colors.
You can specify transparency by specifying an alpha value in the form
``#AARRGGBB``. 0 is fully transparent, while ``FF`` is opaque (opaque is
default with the shorter color specification).
- *EXAMPLE*:
+ .. admonition:: Examples
- - ``--osd-color='#FF0000'`` set OSD to opaque red
- - ``--osd-color='#C0808080'`` set OSD to 50% gray with 75% alpha
+ - ``--osd-color='#FF0000'`` set OSD to opaque red
+ - ``--osd-color='#C0808080'`` set OSD to 50% gray with 75% alpha
---osd-duration=<time>
+``--osd-duration=<time>``
Set the duration of the OSD messages in ms (default: 1000).
---osd-font=<pattern>, --sub-text-font=<pattern>
+``--osd-font=<pattern>``, ``--sub-text-font=<pattern>``
Specify font to use for OSD and for subtitles that do not themselves
- specify a particular font. The default is ``Sans``.
+ specify a particular font. The default is ``sans-serif``.
+
+ .. admonition:: Examples
- *EXAMPLE*:
+ - ``--osd-font='Bitstream Vera Sans'``
+ - ``--osd-font='Bitstream Vera Sans:style=Bold'`` (fontconfig pattern)
- - ``--osd-font='Bitstream Vera Sans'``
- - ``--osd-font='Bitstream Vera Sans:style=Bold'`` (fontconfig pattern)
+ .. note::
- *NOTE*: the ``--sub-text-font`` option (and most other ``--sub-text-``
- options) are ignored when ASS-subtitles are rendered, unless the
- ``--no-ass`` option is specified.
+ The ``--sub-text-font`` option (and most other ``--sub-text-``
+ options) are ignored when ASS-subtitles are rendered, unless the
+ ``--no-ass`` option is specified.
---osd-font-size=<size>, --sub-text-font-size=<size>
+``--osd-font-size=<size>``, ``--sub-text-font-size=<size>``
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
@@ -1331,10 +1392,10 @@
Default: 45.
---osd-fractions
+``--osd-fractions``
Show OSD times with fractions of seconds.
---osd-level=<0-3>
+``--osd-level=<0-3>``
Specifies which mode the OSD should start in.
:0: subtitles only
@@ -1342,7 +1403,7 @@
:2: volume + seek + timer + percentage
:3: volume + seek + timer + percentage + total time
---osd-margin-x=<size>, --sub-text-margin-x=<size>
+``--osd-margin-x=<size>, --sub-text-margin-x=<size>``
Left and right screen margin for the OSD/subs in scaled pixels (see
``--osd-font-size`` for details).
@@ -1351,7 +1412,7 @@
Default: 25.
---osd-margin-y=<size>, --sub-text-margin-y=<size>
+``--osd-margin-y=<size>, --sub-text-margin-y=<size>``
Top and bottom screen margin for the OSD/subs in scaled pixels (see
``--osd-font-size`` for details).
@@ -1361,38 +1422,39 @@
Default: 10.
---osd-scale=<factor>
+``--osd-scale=<factor>``
OSD font size multiplicator, multiplied with ``--osd-font-size`` value.
---osd-shadow-color=<#RRGGBB>, --sub-text-shadow-color=<#RRGGBB>
+``--osd-shadow-color=<#RRGGBB>, --sub-text-shadow-color=<#RRGGBB>``
See ``--osd-color``. Color used for OSD/sub text shadow.
---osd-shadow-offset=<size>, --sub-text-shadow-offset=<size>
+``--osd-shadow-offset=<size>, --sub-text-shadow-offset=<size>``
Displacement of the OSD/sub text shadow in scaled pixels (see
``--osd-font-size`` for details). A value of 0 disables shadows.
Default: 0.
---osd-spacing=<size>, --sub-text-spacing=<size>
+``--osd-spacing=<size>, --sub-text-spacing=<size>``
Horizontal OSD/sub font spacing in scaled pixels (see ``--osd-font-size``
for details). This value is added to the normal letter spacing. Negative
values are allowed.
Default: 0.
---osd-status-msg=<string>
+``--osd-status-msg=<string>``
Show a custom string during playback instead of the standard status text.
This overrides the status text used for ``--osd-level=3``, when using the
``show_progress`` command (by default mapped to ``P``), or in some
- non-default cases when seeking. Expands properties. See property_expansion_.
+ non-default cases when seeking. Expands properties. See
+ `Property Expansion`_.
---panscan=<0.0-1.0>
+``--panscan=<0.0-1.0>``
Enables pan-and-scan functionality (cropping the sides of e.g. a 16:9
movie 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.
---panscanrange=<-19.0-99.0>
+``--panscanrange=<-19.0-99.0>``
(experimental)
Change the range of the pan-and-scan functionality (default: 1). Positive
values mean multiples of the default range. Negative numbers mean you can
@@ -1400,68 +1462,70 @@
allows a zoom factor of up to 4. This feature is experimental. Do not
report bugs unless you are using ``--vo=opengl``.
---playing-msg=<string>
+``--playing-msg=<string>``
Print out a string after starting playback. The string is expanded for
properties, e.g. ``--playing-msg=file: ${filename}`` will print the string
``file:`` followed by a space and the currently played filename.
- See property_expansion_.
+ See `Property Expansion`_.
---status-msg=<string>
+``--status-msg=<string>``
Print out a custom string during playback instead of the standard status
- line. Expands properties. See property_expansion_.
+ line. Expands properties. See `Property Expansion`_.
---stream-capture=<filename>
+``--stream-capture=<filename>``
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 changing the filename with the ``stream-capture`` slave property.
+ stopped by changing the filename with the ``stream-capture`` 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.
---stream-dump=<filename>
- Same as ``--stream-capture``, but don't start playback. Instead, the full
+``--stream-dump=<filename>``
+ Same as ``--stream-capture``, but do not start playback. Instead, the entire
file is dumped.
---playlist=<filename>
+``--playlist=<filename>``
Play files according to a playlist file (ASX, Winamp, SMIL, or
one-file-per-line format).
- *WARNING*: The way mpv parses and 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 ``--playlist`` with untrusted
- sources. Do NOT use ``--playlist`` with random internet sources or files
- you don't trust!
+ .. warning::
- FIXME: This needs to be clarified and documented thoroughly.
+ The way mpv parses and 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 ``--playlist`` with untrusted
+ sources. Do NOT use ``--playlist`` with random internet sources or files
+ you do not trust!
---pp=<quality>
+ FIXME: This needs to be clarified and documented thoroughly.
+
+``--pp=<quality>``
See also ``--vf=pp``.
---pphelp
+``--pphelp``
See also ``--vf=pp``.
---priority=<prio>
+``--priority=<prio>``
(Windows only.)
Set process priority for mpv according to the predefined priorities
available under Windows.
- Possible values of <prio>:
+ Possible values of ``<prio>``:
idle|belownormal|normal|abovenormal|high|realtime
- *WARNING*: Using realtime priority can cause system lockup.
+ .. warning:: Using realtime priority can cause system lockup.
---profile=<profile1,profile2,...>
+``--profile=<profile1,profile2,...>``
Use the given profile(s), ``--profile=help`` displays a list of the
defined profiles.
---pts-association-mode=<auto|decode|sort>
+``--pts-association-mode=<auto|decode|sort>``
Select the method used to determine which container packet timestamp
corresponds to a particular output frame from the video decoder. Normally
- you shouldn't need to change this option.
+ you should not need to change this option.
:auto: Try to pick a working mode from the ones below automatically
(default)
@@ -1469,7 +1533,7 @@
:sort: Maintain a buffer of unused pts values and use the lowest value
for the frame.
---pvr=<option1:option2:...>
+``--pvr=<option1:option2:...>``
This option tunes 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
@@ -1480,7 +1544,7 @@
Available options are:
- aspect=<0-3>
+ ``aspect=<0-3>``
Specify input aspect ratio:
:0: 1:1
@@ -1488,34 +1552,34 @@
:2: 16:9
:3: 2.21:1
- arate=<32000-48000>
+ ``arate=<32000-48000>``
Specify encoding audio rate (default: 48000 Hz, available: 32000,
44100 and 48000 Hz).
- alayer=<1-3>
+ ``alayer=<1-3>``
Specify MPEG audio layer encoding (default: 2).
- abitrate=<32-448>
+ ``abitrate=<32-448>``
Specify audio encoding bitrate in kbps (default: 384).
- amode=<value>
+ ``amode=<value>``
Specify audio encoding mode. Available preset values are 'stereo',
'joint_stereo', 'dual' and 'mono' (default: stereo).
- vbitrate=<value>
+ ``vbitrate=<value>``
Specify average video bitrate encoding in Mbps (default: 6).
- vmode=<value>
+ ``vmode=<value>``
Specify video encoding mode:
:vbr: Variable BitRate (default)
:cbr: Constant BitRate
- vpeak=<value>
+ ``vpeak=<value>``
Specify peak video bitrate encoding in Mbps (only useful for VBR
encoding, default: 9.6).
- fmt=<value>
+ ``fmt=<value>``
Choose an MPEG format for encoding:
:ps: MPEG-2 Program Stream (default)
@@ -1525,13 +1589,13 @@
:svcd: Super Video CD compatible stream
:dvd: DVD compatible stream
---quiet
+``--quiet``
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. \\r).
+ handle carriage return (i.e. ``\r``).
---quvi-format=<best|default|...>
+``--quvi-format=<best|default|...>``
Video format/quality that is directly passed to libquvi (default: ``best``).
This is used when opening links to streaming sites like YouTube. The
interpretation of this value is highly specific to the streaming site and
@@ -1539,78 +1603,84 @@
libquvi 0.4.x:
- The only well defined values that work on all sites are ``best``
- (best quality/highest bandwidth, default), and ``default`` (lowest quality).
+ The only well-defined values that work on all sites are ``best``
+ (best quality/highest bandwidth, default), and ``default`` (lowest
+ quality).
- The quvi command line tool can be used to find out which formats are
- supported for a given URL: ``quvi --query-formats URL``.
+ The quvi command line tool can be used to find out which formats are
+ supported for a given URL: ``quvi --query-formats URL``.
libquvi 0.9.x:
- The following explanations are relevant:
- ``http://quvi.sourceforge.net/doc/0.9/glossary_termino.html#m_stream_id``
+ The following explanations are relevant:
+ `<http://quvi.sourceforge.net/doc/0.9/glossary_termino.html#m_stream_id>`_
- With 0.9.x, the ``quvi-format`` property can be used at runtime to cycle
- through the list of formats. Unfortunately, this resets the playback
- position and is slow too.
+ With 0.9.x, the ``quvi-format`` property can be used at runtime to cycle
+ through the list of formats. Unfortunately, this resets the playback
+ position and is slow too.
---radio=<option1:option2:...>
+``--radio=<option1:option2:...>``
These options set various parameters of the radio capture module. For
- listening to radio with mpv use ``radio://<frequency>`` (if channels
+ listening to radio with mpv, use ``radio://<frequency>`` (if channels
option is not given) or ``radio://<channel_number>`` (if channels option
is given) as a movie URL. You can see allowed frequency range by running
mpv with ``-v``. To start the grabbing subsystem, use
``radio://<frequency or channel>/capture``. If the capture keyword is not
- given you can listen to radio using the line-in cable only. Using capture
+ given, you can listen to radio using the line-in cable only. Using capture
to listen is not recommended due to synchronization problems, which makes
this process uncomfortable.
Available options are:
- device=<value>
+ ``device=<value>``
Radio device to use (default: ``/dev/radio0`` for Linux and
``/dev/tuner0`` for \*BSD).
- driver=<value>
+ ``driver=<value>``
Radio driver to use (default: v4l2 if available, otherwise v4l).
Currently, v4l and v4l2 drivers are supported.
- volume=<0..100>
- sound volume for radio device (default 100)
+ ``volume=<0..100>``
+ Sound volume for radio device (default 100).
- channels=<frequency>-<name>,<frequency>-<name>,...
- Set channel list. Use _ for spaces in names (or play with quoting ;-).
- The channel names will then be written using OSD and the slave
- commands radio_step_channel and radio_set_channel will be usable for a
- remote control (see LIRC). If given, number in movie URL will be
+ ``channels=<frequency>-<name>,<frequency>-<name>,...``
+ Set channel list. Use _ for spaces in names (or play with quoting ;-) ).
+ The channel names will then be written using OSD, and the slave
+ commands ``radio_step_channel`` and ``radio_set_channel`` will be usable
+ for a remote control (see LIRC). If given, number in movie URL will be
treated as channel position in channel list.
- *EXAMPLE*: ``radio://1``, ``radio://104.4``, ``radio_set_channel 1``
+ .. admonition:: Example
+
+ ``radio://1``, ``radio://104.4``, ``radio_set_channel 1``
- adevice=<value> (radio capture only)
- Name of device to capture sound from. Without such a name capture will
- be disabled, even if the capture keyword appears in the URL. For ALSA
- devices use it in the form ``hw=<card>.<device>``. If the device name
- contains a '=', the module will use ALSA to capture, otherwise OSS.
+ ``adevice=<value>`` (radio capture only)
+ Name of device to capture sound from. Without such a name, capture will
+ be disabled, even if the ``capture`` keyword appears in the URL.
+ For ALSA devices, use it in the form ``hw=<card>.<device>``. If the
+ device name contains a '=', the module will use ALSA to capture,
+ otherwise OSS.
- arate=<value> (radio capture only)
+ ``arate=<value>`` (radio capture only)
Rate in samples per second (default: 44100).
- *NOTE*: When using audio capture set also ``--rawaudio=rate=<value>``
- option with the same value as arate. If you have problems with sound
- speed (runs too quickly), try to play with different rate values (e.g.
- 48000, 44100, 32000,...).
+ .. note::
+
+ When using audio capture set also ``--rawaudio=rate=<value>`` option
+ with the same value as arate. If you have problems with sound speed
+ (runs too quickly), try to play with different rate values (e.g.
+ 48000, 44100, 32000,...).
- achannels=<value> (radio capture only)
+ ``achannels=<value>`` (radio capture only)
Number of audio channels to capture.
---really-quiet
+``--really-quiet``
Display even less output and status messages than with ``--quiet``.
---referrer=<string>
+``--referrer=<string>``
Specify a referrer path or URL for HTTP requests.
---reset-on-next-file=<all|option1,option2,...>
+``--reset-on-next-file=<all|option1,option2,...>``
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's, which tries to reset all settings
@@ -1624,29 +1694,31 @@
config file or command line.
In some cases, this might not work as expected. For example, ``--volume``
- will only be reset the volume if it's explicitly set in the config file
- or the command line.
+ will only be reset if it is explicitly set in the config file or the
+ command line.
The special name ``all`` resets as many options as possible.
- *EXAMPLE*:
+ .. admonition:: Examples
- - ``--reset-on-next-file=fullscreen,speed`` Reset fullscreen and playback
- speed settings if they were changed during playback.
- - ``--reset-on-next-file=all`` Try to reset all settings that were changed
- during playback.
- - ``--reset-on-next-file=""`` Don't reset pause mode.
+ - ``--reset-on-next-file=fullscreen,speed``
+ Reset fullscreen and playback speed settings if they were changed
+ during playback.
+ - ``--reset-on-next-file=all``
+ Try to reset all settings that were changed during playback.
+ - ``--reset-on-next-file=""``
+ Do not reset pause mode.
---reuse-socket
+``--reuse-socket``
(udp:// only)
Allows a socket to be reused by other processes as soon as it is closed.
---saturation=<-100-100>
+``--saturation=<-100-100>``
Adjust the saturation of the video signal (default: 0). You can get
grayscale output with this option. Not supported by all video output
drivers.
---save-position-on-quit
+``--save-position-on-quit``
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 affects any form of stopping playback (quitting, going to the
@@ -1655,51 +1727,53 @@
This behavior is disabled by default, but is always available when quitting
the player with Shift+Q.
---sb=<n>
+``--sb=<n>``
Seek to byte position. Useful for playback from CD-ROM images or VOB files
with junk at the beginning. See also ``--start``.
---screen=<default|0-32>
+``--screen=<default|0-32>``
In multi-monitor configurations (i.e. a single desktop that spans across
- multiple displays) this option tells mpv which screen to display the
+ multiple displays), this option tells mpv which screen to display the
movie on.
- This option doesn't always work. In these cases, try to use ``--geometry``
+ This option does not always work. In these cases, try to use ``--geometry``
to position the window explicitly.
- *NOTE (X11)*: this option does not work properly with all window managers.
+ .. admonition:: Note (X11)
+
+ This option does not work properly with all window managers.
See also ``--fs-screen``.
---screenshot-format=<type>
+``--screenshot-format=<type>``
Set the image file type used for saving screenshots.
Available choices:
- :png: PNG
- :ppm: PPM
- :pgm: PGM
- :pgmyuv: PGM with YV12 pixel format
- :tga: TARGA
- :jpg: JPEG (default)
- :jpeg: JPEG (same as jpg, but with .jpeg file ending)
+ :png: PNG
+ :ppm: PPM
+ :pgm: PGM
+ :pgmyuv: PGM with YV12 pixel format
+ :tga: TARGA
+ :jpg: JPEG (default)
+ :jpeg: JPEG (same as jpg, but with .jpeg file ending)
---screenshot-jpeg-quality=<0-100>
+``--screenshot-jpeg-quality=<0-100>``
Set the JPEG quality level. Higher means better quality. The default is 90.
---screenshot-png-compression=<0-9>
+``--screenshot-png-compression=<0-9>``
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
+ 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.
---screenshot-png-filter=<0-5>
+``--screenshot-png-filter=<0-5>``
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.
---screenshot-template=<template>
+``--screenshot-template=<template>``
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 screeshot.
@@ -1710,7 +1784,7 @@
specify a directory location where screenshots should be saved.
If the final screenshot filename points to an already existing file, the
- file won't be overwritten. The screenshot will either not be saved, or if
+ file will not be overwritten. The screenshot will either not be saved, or if
the template contains ``%n``, saved using different, newly generated
filename.
@@ -1719,11 +1793,11 @@
``%[#][0X]n``
A sequence number, padded with zeros to length X (default: 04). E.g.
passing the format ``%04n`` will yield ``0012`` on the 12th screenshot.
- The number is incremented every time a screenshot is taken, or if the
+ The number is incremented every time a screenshot is taken or if the
file already exists. The length ``X`` must be in the range 0-9. With
- the optional # sign mpv will use the lowest available number. For
+ 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 won't be 0004 and 0005, but
+ the first two, the next two screenshots will not be 0004 and 0005, but
0001 and 0002 again.
``%f``
Filename of the currently played video.
@@ -1737,10 +1811,14 @@
``%P``
Similar to ``%p``, 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. (Note that 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.)
+ part of the playback time.
+
+ .. note::
+
+ 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.)
``%tX``
Specify the current local date/time using the format ``X``. This format
specifier uses the UNIX ``strftime()`` function internally, and inserts
@@ -1749,96 +1827,100 @@
multiple ``%tX`` specifiers to build a full date/time string.
``%{prop[:fallback text]}``
Insert the value of the slave property 'prop'. E.g. ``%{filename}`` is
- the same as ``%f``. If the property doesn't exist or is not available,
+ the same as ``%f``. If the property does not exist or is not available,
an error text is inserted, unless a fallback is specified.
``%%``
Replaced with the ``%`` character itself.
---screenh=<pixels>
+``--screenh=<pixels>``
Specify the screen height for video output drivers which do not know the
- screen resolution, like x11 and TV-out.
+ screen resolution, like ``x11`` and TV-out.
---screenw=<pixels>
+``--screenw=<pixels>``
Specify the screen width for video output drivers which do not know the
- screen resolution, like x11 and TV-out.
+ screen resolution, like ``x11`` and TV-out.
---show-profile=<profile>
+``--show-profile=<profile>``
Show the description and content of a profile.
---shuffle
+``--shuffle``
Play files in random order.
---sid=<ID|auto|no>
- Display the subtitle stream specified by <ID> (0-31). ``auto`` selects the
- default, ``no`` disables subtitles.
+``--sid=<ID|auto|no>``
+ Display the subtitle stream specified by ``<ID>`` (0-31). ``auto`` selects
+ the default, ``no`` disables subtitles.
+
See also ``--slang``, ``--no-sub``.
---slang=<languagecode[,languagecode,...]>
+``--slang=<languagecode[,languagecode,...]>``
Specify a priority list of subtitle languages to use. Different container
formats employ different language codes. DVDs use ISO 639-1 two letter
language codes, Matroska uses ISO 639-2 three letter language codes while
OGM uses a free-form identifier. mpv prints the available languages
when run in verbose (``-v``) mode. See also ``--sid``.
- *EXAMPLE*:
+ .. admonition:: Examples
- - ``mpv dvd://1 --slang=hu,en`` chooses the Hungarian subtitle track on
- a DVD and falls back on English if Hungarian is not available.
- - ``mpv --slang=jpn example.mkv`` plays a Matroska file with Japanese
- subtitles.
+ - ``mpv dvd://1 --slang=hu,en`` chooses the Hungarian subtitle track on
+ a DVD and falls back on English if Hungarian is not available.
+ - ``mpv --slang=jpn example.mkv`` plays a Matroska file with Japanese
+ subtitles.
---slave-broken
+``--slave-broken``
Switches on the old slave mode. This is for testing only, and incompatible
- to the removed --slave switch.
-
- *NOTE*: 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 --slave-broken switch. Instead, a new, saner
- protocol should be developed (and will, if there is enough interest).
-
- This affects smplayer, smplayer2, mplayerosx, and others.
-
---softsleep
+ to the removed ``--slave`` switch.
+
+ .. attention::
+ 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 ``--slave-broken``
+ switch. Instead, a new, saner protocol should be developed (and will be,
+ if there is enough interest).
+
+ This affects most third-party GUI frontends.
+
+``--softsleep``
Time frames by repeatedly checking the current time instead of asking
the kernel to wake up mpv at the correct time. Useful if your kernel
timing is imprecise and you cannot use the RTC either. Comes at the
price of higher CPU consumption.
---softvol=<mode>
- Control whether to use the volume controls of the audio output driver, or
+``--softvol=<mode>``
+ Control whether to use the volume controls of the audio output driver or
the internal mpv volume filter.
:no: prefer audio driver controls, use the volume filter only if
absolutely needed
:yes: always use the volume filter
- :auto: prefer the volume filter if the audio driver uses the system mixer (default)
+ :auto: prefer the volume filter if the audio driver uses the system mixer
+ (default)
The intention of ``auto`` 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.
---softvol-max=<10.0-10000.0>
+``--softvol-max=<10.0-10000.0>``
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.
---speed=<0.01-100>
+``--speed=<0.01-100>``
Slow down or speed up playback by the factor given as parameter.
---srate=<Hz>
+``--srate=<Hz>``
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.
---start=<relative time>
+``--start=<relative time>``
Seek to given time position.
The general format for absolute times is ``[[hh:]mm:]ss[.ms]``. If the time
@@ -1848,23 +1930,23 @@
``#c`` seeks to chapter number c. (Chapters start from 1.)
- *EXAMPLE*:
-
- ``--start=56``
- Seeks to 56 seconds.
- ``--start=01:10:00``
- Seeks to 1 hour 10 min.
- ``--start=50%``
- Seeks to the middle of the file.
- ``--start=30 --end=40``
- Seeks to 30 seconds, plays 10 seconds, and exits.
- ``--start=-3:20 --length=10``
- Seeks to 3 minutes and 20 seconds before the end of the file, plays
- 10 seconds, and exits.
- ``--start='#2' --end='#4'``
- Plays chapters 2 and 3, and exits.
-
---ssf=<mode>
+ .. admonition:: Examples
+
+ ``--start=56``
+ Seeks to 56 seconds.
+ ``--start=01:10:00``
+ Seeks to 1 hour 10 min.
+ ``--start=50%``
+ Seeks to the middle of the file.
+ ``--start=30 --end=40``
+ Seeks to 30 seconds, plays 10 seconds, and exits.
+ ``--start=-3:20 --length=10``
+ Seeks to 3 minutes and 20 seconds before the end of the file, plays
+ 10 seconds, and exits.
+ ``--start='#2' --end='#4'``
+ Plays chapters 2 and 3, and exits.
+
+``--ssf=<mode>``
Specifies software scaler parameters.
:lgb=<0-100>: gaussian blur filter (luma)
@@ -1874,79 +1956,86 @@
:chs=<h>: chroma horizontal shifting
:cvs=<v>: chroma vertical shifting
- *EXAMPLE*: ``--vf=scale --ssf=lgb=3.0``
+ .. admonition:: Example
---sstep=<sec>
+ ``--vf=scale --ssf=lgb=3.0``
+
+``--sstep=<sec>``
Skip <sec> seconds after every frame.
- *NOTE*: without ``--hr-seek``, skipping will snap to keyframes.
+ .. note::
+
+ Without ``--hr-seek``, skipping will snap to keyframes.
---stop-screensaver, --no-stop-screensaver
+``--stop-screensaver``, ``--no-stop-screensaver``
Turns off the screensaver (or screen blanker and similar mechanisms) at
- startup and turns it on again on exit. (Default: yes)
+ startup and turns it on again on exit (default: yes).
This is not supported on all video outputs or platforms. Sometimes it is
- implemented, but doesn't work (happens often on GNOME). You might be able
+ implemented, but does not work (happens often on GNOME). You might be able
to to work this around using ``--heartbeat-cmd`` instead.
---sub=<subtitlefile1,subtitlefile2,...>
+``--sub=<subtitlefile1,subtitlefile2,...>``
Use/display these subtitle files. Only one file can be displayed at the
same time.
---sub-fix-timing, --no-sub-fix-timing
+``--sub-fix-timing``, ``--no-sub-fix-timing``
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.
---sub-demuxer=<[+]name>
+``--sub-demuxer=<[+]name>``
Force subtitle demuxer type for ``--sub``. Give the demuxer name as
printed by ``--sub-demuxer=help``.
---sub-paths=<path1:path2:...>
- Specify extra directories where to search for subtitles matching the
- video. Multiple directories can be separated by ":" (";" on Windows).
+``--sub-paths=<path1:path2:...>``
+ 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.
- *EXAMPLE*: Assuming that ``/path/to/movie/movie.avi`` is played and
- ``--sub-paths=sub:subtitles:/tmp/subs`` is specified, mpv searches for
- subtitle files in these directories:
+ .. admonition:: Example
+
+ Assuming that ``/path/to/movie/movie.avi`` is played and
+ ``--sub-paths=sub:subtitles:/tmp/subs`` is specified, mpv searches for
+ subtitle files in these directories:
- - ``/path/to/movie/``
- - ``/path/to/movie/sub/``
- - ``/path/to/movie/subtitles/``
- - ``/tmp/subs/``
- - ``~/.mpv/sub/``
+ - ``/path/to/movie/``
+ - ``/path/to/movie/sub/``
+ - ``/path/to/movie/subtitles/``
+ - ``/tmp/subs/``
+ - ``~/.mpv/sub/``
---subcp=<codepage>
+``--subcp=<codepage>``
If your system supports ``iconv(3)``, you can use this option to specify
the subtitle codepage.
- *EXAMPLE*:
- - ``--subcp=latin2``
- - ``--subcp=cp1250``
+ .. admonition:: Examples
- If the player was compiled with ENCA support you can use special syntax
- to use that.
+ - ``--subcp=latin2``
+ - ``--subcp=cp1250``
- ``--subcp=enca:<language>:<fallback codepage>``
+ If the player was compiled with ENCA support, you can use special syntax
+ to use that::
+
+ --subcp=enca:<language>:<fallback codepage>
You can specify your language using a two letter language code to make
ENCA detect the codepage automatically. If unsure, enter anything (if the
language is invalid, mpv will complain and list valid languages).
Fallback codepage specifies the codepage to use if autodetection fails.
- *EXAMPLE*:
+ .. admonition:: Examples
- - ``--subcp=enca:cs:latin2`` guess the encoding, assuming the subtitles
- are Czech, fall back on latin 2, if the detection fails.
- - ``--subcp=enca:pl:cp1250`` guess the encoding for Polish, fall back on
- cp1250.
- - ``--subcp=enca:pl`` guess the encoding for Polish, fall back on UTF-8.
- - ``--subcp=enca`` try universal detection, fall back on UTF-8.
+ - ``--subcp=enca:cs:latin2`` guess the encoding, assuming the subtitles
+ are Czech, fall back on latin 2, if the detection fails.
+ - ``--subcp=enca:pl:cp1250`` guess the encoding for Polish, fall back on
+ cp1250.
+ - ``--subcp=enca:pl`` guess the encoding for Polish, fall back on UTF-8.
+ - ``--subcp=enca`` try universal detection, fall back on UTF-8.
- If the player was compiled with libguess support you can use it with:
+ If the player was compiled with libguess support, you can use it with:
``--subcp=guess:<language>:<fallback codepage>``
@@ -1955,57 +2044,67 @@
it will be printed only if the conversion code is somehow called, for
example when loading an external subtitle).
---sub-delay=<sec>
- Delays subtitles by <sec> seconds. Can be negative.
+``--sub-delay=<sec>``
+ Delays subtitles by ``<sec>`` seconds. Can be negative.
---subfps=<rate>
+``--subfps=<rate>``
Specify the framerate of the subtitle file (default: movie fps).
- *NOTE*: <rate> > movie fps speeds the subtitles up for frame-based
- subtitle files and slows them down for time-based ones.
+ .. note::
+
+ ``<rate>`` > movie fps speeds the subtitles up for frame-based
+ subtitle files and slows them down for time-based ones.
Also see ``--sub-speed`` option.
---sub-gauss=<0.0-3.0>
+``--sub-gauss=<0.0-3.0>``
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.
- *NOTE*: never applied to text subtitles.
+ .. note::
---sub-gray
+ Never applied to text subtitles.
+
+``--sub-gray``
Convert image subtitles to grayscale. Can help making yellow DVD/Vobsubs
look nicer.
- *NOTE*: never affects text subtitles.
+ .. note::
+
+ Never applied to text subtitles.
---sub-pos=<0-100>
+``--sub-pos=<0-100>``
Specify the position of subtitles on the screen. The value is the vertical
position of the subtitle in % of the screen height.
- *NOTE*: this affects ASS subtitles as well, and may lead to incorrect
- subtitle rendering. Use with care, or use ``--sub-text-margin-y`` instead.
+ .. note::
---sub-scale=<0-100>
+ This affects ASS subtitles as well, and may lead to incorrect subtitle
+ rendering. Use with care, or use ``--sub-text-margin-y`` instead.
+
+``--sub-scale=<0-100>``
Factor for the text subtitle font size (default: 1).
- *NOTE*: this affects ASS subtitles as well, and may lead to incorrect
- subtitle rendering. Use with care, or use ``--sub-text-font-size`` instead.
+ .. note::
+
+ This affects ASS subtitles as well, and may lead to incorrect subtitle
+ rendering. Use with care, or use ``--sub-text-font-size`` instead.
---sub-speed=<0.1-10.0>
+``--sub-speed=<0.1-10.0>``
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.
- *EXAMPLE*:
+ .. admonition:: Examples
- - ``--sub-speed=25/23.976`` play frame based subtitles, which have been
- loaded assuming a framerate of 23.976, at 25 FPS.
+ - ``--sub-speed=25/23.976`` plays frame based subtitles which have been
+ loaded assuming a framerate of 23.976 at 25 FPS.
---sws=<n>
+``--sws=<n>``
Specify the software scaler algorithm to be used with ``--vf=scale``. This
also affects video output drivers which lack hardware acceleration,
- e.g. x11. See also ``--vf=scale``.
+ e.g. ``x11``. See also ``--vf=scale``.
Available types are:
@@ -2021,120 +2120,131 @@
:9: lanczos
:10: natural bicubic spline
- *NOTE*: Some ``--sws`` options are tunable. The description of the scale
- video filter has further information.
+ .. note::
---term-osd, --no-term-osd
+ Some ``--sws`` options are tunable. The description of the ``scale``
+ video filter has further information.
+
+``--term-osd, --no-term-osd``
Display OSD messages on the console when no video output is available.
Enabled by default.
---term-osd-esc=<string>
+``--term-osd-esc=<string>``
Specify the escape sequence to use before writing an OSD message on the
console. The escape sequence should move the pointer to the beginning of
the line used for the OSD and clear it (default: ``^[[A\r^[[K``).
---title=<string>
+``--title=<string>``
Set the window title. Properties are expanded on playback start.
- (See property_expansion_.)
+ (See `Property Expansion`_.)
+
+ .. warning::
- *NOTE*: There is a danger of this causing significant CPU usage,
- depending on the properties used and the window manager.
+ There is a danger of this causing significant CPU usage, depending on
+ the properties used and the window manager.
---tv=<option1:option2:...>
+``--tv=<option1:option2:...>``
This option tunes various properties of the TV capture module. For
watching TV with mpv, use ``tv://`` or ``tv://<channel_number>`` or
- even ``tv://<channel_name>`` (see option channels for channel_name below)
- as a movie URL. You can also use ``tv:///<input_id>`` to start watching a
- movie from a composite or S-Video input (see option input for details).
+ even ``tv://<channel_name>`` (see option ``channels`` for ``channel_name``
+ below) as a movie URL. You can also use ``tv:///<input_id>`` to start
+ watching a movie from a composite or S-Video input (see option ``input`` for
+ details).
Available options are:
- noaudio
+ ``noaudio``
no sound
- automute=<0-255> (v4l and v4l2 only)
+ ``automute=<0-255> (v4l and v4l2 only)``
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).
- driver=<value>
+ ``driver=<value>``
See ``--tv=driver=help`` for a list of compiled-in TV input drivers.
available: dummy, v4l2 (default: autodetect)
- device=<value>
+ ``device=<value>``
Specify TV device (default: ``/dev/video0``).
- input=<value>
+ ``input=<value>``
Specify input (default: 0 (TV), see console output for available
inputs).
- freq=<value>
+ ``freq=<value>``
Specify the frequency to set the tuner to (e.g. 511.250). Not
compatible with the channels parameter.
- outfmt=<value>
+ ``outfmt=<value>``
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.
+ by the V4L driver (YV12, UYVY, YUY2, I420) or an arbitrary format given
+ as hex value.
- width=<value>
+ ``width=<value>``
output window width
- height=<value>
+ ``height=<value>``
output window height
- fps=<value>
+ ``fps=<value>``
framerate at which to capture video (frames per second)
- buffersize=<value>
+ ``buffersize=<value>``
maximum size of the capture buffer in megabytes (default: dynamical)
- norm=<value>
+ ``norm=<value>``
See the console output for a list of all available norms, also see the
- normid option below.
+ ``normid`` option below.
- normid=<value> (v4l2 only)
+ ``normid=<value> (v4l2 only)``
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.
- channel=<value>
+ ``channel=<value>``
Set tuner to <value> channel.
- chanlist=<value>
+ ``chanlist=<value>``
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
- channels=<chan>-<name>[=<norm>],<chan>-<name>[=<norm>],...
+ ``channels=<chan>-<name>[=<norm>],<chan>-<name>[=<norm>],...``
Set names for channels.
- *NOTE*: 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
- tv_step_channel, tv_set_channel and tv_last_channel will be usable for
- a remote control (see LIRC). Not compatible with the frequency
- parameter.
+ .. note::
+
+ 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
+ ``tv_step_channel``, ``tv_set_channel`` and ``tv_last_channel``
+ will be usable for a remote control (see LIRC). Not compatible with
+ the ``frequency`` parameter.
+
+ .. note::
+
+ The channel number will then be the position in the 'channels'
+ list, beginning with 1.
- *NOTE*: The channel number will then be the position in the 'channels'
- list, beginning with 1.
+ .. admonition:: Examples
- *EXAMPLE*: ``tv://1``, ``tv://TV1``, ``tv_set_channel 1``,
- ``tv_set_channel TV1``
+ ``tv://1``, ``tv://TV1``, ``tv_set_channel 1``,
+ ``tv_set_channel TV1``
- [brightness|contrast|hue|saturation]=<-100-100>
+ ``[brightness|contrast|hue|saturation]=<-100-100>``
Set the image equalizer on the card.
- audiorate=<value>
+ ``audiorate=<value>``
Set input audio sample rate.
- forceaudio
+ ``forceaudio``
Capture audio even if there are no audio sources reported by v4l.
- alsa
+ ``alsa``
Capture from ALSA.
- amode=<0-3>
+ ``amode=<0-3>``
Choose an audio mode:
:0: mono
@@ -2142,45 +2252,43 @@
:2: language 1
:3: language 2
- forcechan=<1-2>
+ ``forcechan=<1-2>``
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.
- adevice=<value>
+ ``adevice=<value>``
Set an audio device. <value> should be ``/dev/xxx`` for OSS and a
hardware ID for ALSA. You must replace any ':' by a '.' in the
hardware ID for ALSA.
- audioid=<value>
+ ``audioid=<value>``
Choose an audio output of the capture card, if it has more than one.
- [volume|bass|treble|balance]=<0-65535> (v4l1)
-
- [volume|bass|treble|balance]=<0-100> (v4l2)
+ ``[volume|bass|treble|balance]=<0-100>``
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.
- gain=<0-100> (v4l2)
+ ``gain=<0-100>``
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.
- immediatemode=<bool>
+ ``immediatemode=<bool>``
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.
- mjpeg
+ ``mjpeg``
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).
- decimation=<1|2|4>
+ ``decimation=<1|2|4>``
choose the size of the picture that will be compressed by hardware
MJPEG compression:
@@ -2199,87 +2307,65 @@
- 176x144 PAL
- 176x120 NTSC
- quality=<0-100>
+ ``quality=<0-100>``
Choose the quality of the JPEG compression (< 60 recommended for full
size).
- hidden_video_renderer (dshow only)
- Terminate stream with video renderer instead of Null renderer
- (default: off). Will help if video freezes but audio does not.
-
- *NOTE*: May not work with ``--vo=directx`` and ``--vf=crop``
- combination.
-
- hidden_vp_renderer (dshow only)
- Terminate VideoPort pin stream with video renderer instead of removing
- it from the graph (default: off). Useful if your card has a VideoPort
- pin and video is choppy.
-
- *NOTE*: May not work with ``--vo=directx`` and ``--vf=crop``
- combination.
-
- system_clock (dshow only)
- Use the system clock as sync source instead of the default graph clock
- (usually the clock from one of the live sources in graph).
-
- normalize_audio_chunks (dshow only)
- Create audio chunks with a time length equal to video frame time
- length (default: off). Some audio cards create audio chunks about 0.5s
- in size, resulting in choppy video when using immediatemode=0.
-
---tvscan=<option1:option2:...>
- Tune the TV channel scanner. mpv will also print value for "-tv
- channels=" option, including existing and just found channels.
+``--tvscan=<option1:option2:...>``
+ Tune the TV channel scanner. mpv will also print value for
+ ``--tv=channels=`` option, including existing and just found channels.
Available suboptions are:
- autostart
+ ``autostart``
Begin channel scanning immediately after startup (default: disabled).
- period=<0.1-2.0>
+ ``period=<0.1-2.0>``
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.
- threshold=<1-100>
+ ``threshold=<1-100>``
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.
---use-filedir-conf
+``--use-filedir-conf``
Look for a file-specific configuration file in the same directory as the
- file that is being played.
+ file that is being played. See `File-specific Configuration Files`_.
- *WARNING*: May be dangerous if playing from untrusted media.
+ .. warning::
---user-agent=<string>
- Use <string> as user agent for HTTP streaming.
+ May be dangerous if playing from untrusted media.
--v
+``--user-agent=<string>``
+ Use ``<string>`` as user agent for HTTP streaming.
+
+``-v``
Increment verbosity level, one level for each ``-v`` found on the command
line.
---vd=<[+|-]family1:(*|decoder1),[+|-]family2:(*|decoder2),...[-]>
+``--vd=<[+|-]family1:(*|decoder1),[+|-]family2:(*|decoder2),...[-]>``
Specify a priority list of video decoders to be used, according to their
family and name. See ``--ad`` for further details. Both of these options
- use the same syntax and semantics, the only difference is that they
+ use the same syntax and semantics; the only difference is that they
operate on different codec lists.
- *NOTE*: See ``--vd=help`` for a full list of available decoders.
+ .. note::
---vd-lavc-bitexact
- Only use bit-exact algorithms in all decoding steps (for codec
- testing).
+ See ``--vd=help`` for a full list of available decoders.
---vd-lavc-fast (MPEG-2, MPEG-4, and H.264 only)
- Enable optimizations which do not comply to the specification and
- might 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.
+``--vd-lavc-bitexact``
+ Only use bit-exact algorithms in all decoding steps (for codec testing).
---vd-lavc-o=<key>=<value>[,<key>=<value>[,...]]
- Pass AVOptions to libavcodec decoder. Note, a patch to make the o=
+``--vd-lavc-fast`` (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.
+
+``--vd-lavc-o=<key>=<value>[,<key>=<value>[,...]]``
+ 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.
@@ -2287,72 +2373,73 @@
mechanism, like ``bug``, ``gray``, ``idct``, ``ec``, ``vismv``,
``skip_top`` (was ``st``), ``skip_bottom`` (was ``sb``), ``debug``.
- *EXAMPLE*: ``--vd--lavc-o=debug=pict``
+ .. admonition:: Example
+
+ ``--vd--lavc-o=debug=pict``
---vd-lavc-skiploopfilter=<skipvalue> (H.264 only)
+``--vd-lavc-skiploopfilter=<skipvalue> (H.264 only)``
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 no visible quality loss.
+ 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.
- <skipvalue> can be one of the following:
+ ``<skipvalue>`` can be one of the following:
:none: Never skip.
:default: Skip useless processing steps (e.g. 0 size packets in AVI).
:nonref: Skip frames that are not referenced (i.e. not used for
- decoding other frames, the error cannot "build up").
+ decoding other frames, the error cannot "build up").
:bidir: Skip B-Frames.
:nonkey: Skip all frames except keyframes.
:all: Skip all frames.
---vd-lavc-skipidct=<skipvalue> (MPEG-1/2 only)
- Skips the IDCT step. This degrades quality a lot of in almost all
- cases (see skiploopfilter for available skip values).
+``--vd-lavc-skipidct=<skipvalue> (MPEG-1/2 only)``
+ Skips the IDCT step. This degrades quality a lot in almost all cases
+ (see skiploopfilter for available skip values).
---vd-lavc-skipframe=<skipvalue>
+``--vd-lavc-skipframe=<skipvalue>``
Skips decoding of frames completely. Big speedup, but jerky motion and
- sometimes bad artifacts (see skiploopfilter for available skip
- values).
+ sometimes bad artifacts (see skiploopfilter for available skip values).
---vd-lavc-threads=<0-16>
+``--vd-lavc-threads=<0-16>``
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)
+ machine and use that, up to the maximum of 16 (default: 0).
---version, -V
+``--version, -V``
Print version string and exit.
---vf=<filter1[=parameter1:parameter2:...],filter2,...>
+``--vf=<filter1[=parameter1:parameter2:...],filter2,...>``
Specify a list of video filters to apply to the video stream. See
- `video_filters` for details and descriptions of the available filters.
+ `VIDEO FILTERS`_ for details and descriptions of the available filters.
The option variants ``--vf-add``, ``--vf-pre``, ``--vf-del`` and
``--vf-clr`` exist to modify a previously specified list, but you
- shouldn't need these for typical use.
+ should not need these for typical use.
---vid=<ID|auto|no>
+``--vid=<ID|auto|no>``
Select video channel. ``auto`` selects the default, ``no`` disables video.
---vo=<driver1[:suboption1[=value]:...],driver2,...[,]>
+``--vo=<driver1[:suboption1[=value]:...],driver2,...[,]>``
Specify a priority list of video output drivers to be used. For
- interactive use you'd normally specify a single one to use, but in
- configuration files specifying a list of fallbacks may make sense. See
- `video_outputs` for details and descriptions of available drivers.
+ interactive use, one would normally specify a single one to use, but in
+ configuration files, specifying a list of fallbacks may make sense. See
+ `VIDEO OUTPUT DRIVERS`_ for details and descriptions of available drivers.
---volstep=<0-100>
- Set the step size of mixer volume changes in percent of the whole range
+``--volstep=<0-100>``
+ Set the step size of mixer volume changes in percent of the full range
(default: 3).
---volume=<-1-100>
+``--volume=<-1-100>``
Set the startup volume. A value of -1 (the default) will not change the
volume. See also ``--softvol``.
---wid=<ID>
- (X11 and win32 only)
+``--wid=<ID>``
+ (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 win32. If a VO is selected that supports
+ "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.
- See ``--slave-broken``.
+ See also ``--slave-broken``.