summaryrefslogtreecommitdiffstats
path: root/DOCS/man/en/options.rst
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2013-07-08 21:55:44 +0200
committerwm4 <wm4@nowhere>2013-07-08 21:55:44 +0200
commit31f685040bd2152d541ed16cf441c6b5e7e430fd (patch)
treeb8351b2847231bbc15d883a622ac972945cce6b4 /DOCS/man/en/options.rst
parent73c76de91edbf8a55eb725196ff54583e3428510 (diff)
parent7a71a2cc483d17bed94408d5aee6fba6893558cb (diff)
downloadmpv-31f685040bd2152d541ed16cf441c6b5e7e430fd.tar.bz2
mpv-31f685040bd2152d541ed16cf441c6b5e7e430fd.tar.xz
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