summaryrefslogtreecommitdiffstats
path: root/DOCS
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2012-11-01 02:12:47 +0100
committerwm4 <wm4@nowhere>2012-11-01 02:12:47 +0100
commit84829a4ea1903e5db5782b72861fabc503a589cb (patch)
tree26b4acbaf6dd4b255278dcc67f28bd83357c3b86 /DOCS
parente45dd051c304dec189d0d4d792a89c2988c3fa71 (diff)
parentf4069259cf7ffd24ac2a5b64e26a386185e94c7b (diff)
downloadmpv-84829a4ea1903e5db5782b72861fabc503a589cb.tar.bz2
mpv-84829a4ea1903e5db5782b72861fabc503a589cb.tar.xz
Merge branch 'osd_changes' into master
Conflicts: DOCS/man/en/options.rst
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/man/en/ao.rst2
-rw-r--r--DOCS/man/en/changes.rst23
-rw-r--r--DOCS/man/en/input.rst63
-rw-r--r--DOCS/man/en/mpv.rst91
-rw-r--r--DOCS/man/en/options.rst236
-rw-r--r--DOCS/man/en/vf.rst10
-rw-r--r--DOCS/man/en/vo.rst11
-rw-r--r--DOCS/tech-overview.txt3
8 files changed, 123 insertions, 316 deletions
diff --git a/DOCS/man/en/ao.rst b/DOCS/man/en/ao.rst
index 412d9ac939..ae0432784f 100644
--- a/DOCS/man/en/ao.rst
+++ b/DOCS/man/en/ao.rst
@@ -94,7 +94,7 @@ dsound (Windows only)
null
Produces no audio output but maintains video playback speed. Use
- ``--nosound`` for benchmarking.
+ ``--no-audio`` for benchmarking.
pcm
raw PCM/wave file writer audio output
diff --git a/DOCS/man/en/changes.rst b/DOCS/man/en/changes.rst
index 6e96cde115..5febb3afd2 100644
--- a/DOCS/man/en/changes.rst
+++ b/DOCS/man/en/changes.rst
@@ -43,24 +43,27 @@ General changes for mplayer2 to mpv
decades old hardware
* Removal of support for dead platforms
* Generally improved MS Windows support (dealing with unicode filenames,
- improved ``vo_direct3d``, improve window handling)
+ improved ``--vo=direct3d``, improved window handling)
* Better OSD rendering (using libass). This has full unicode support, and
languages like Arabic should be better supported.
* Cleaned up terminal output (nicer status line, less useless noise)
* Support for playing URLs of popular streaming sites directly
(e.g. ``mpv https://www.youtube.com/watch?v=...``)
-* Improved OpenGL output (``vo_opengl``)
+* Improved OpenGL output (``--vo=opengl-hq``)
* Make ``--softvol`` default (**mpv** is not a mixer control panel)
* Improved support for .cue files
-* Screenshot improvements (can save screenshots as JPG, configurable filenames)
+* Screenshot improvements (can save screenshots as JPG or PNG, configurable
+ filenames, support for taking screenshots with or without subtitles)
* Removal of teletext support
-* Replace image VOs (``vo_jpeg`` etc.) with ``vo_image``
-* Remove ``vo_gif89a``, ``vo_md5sum``, ``vo_yuv4mpeg`` (the plan is to merge
- divverent's encoding branch, which provides support for all of these)
+* Replace image VOs (``--vo=jpeg`` etc.) with ``--vo=image``
* Do not lose settings when playing a new file in the same player instance
* New location for config files, new name for the binary. (Planned change.)
* Slave mode compatibility broken (see below)
* Encoding functionality (replacement for mencoder)
+ (Remove ``--vo=gif89a``, ``--vo=md5sum``, ``--vo=yuv4mpeg``, as encoding can
+ handle these use cases.)
+* Image subtitles (DVDs etc.) are rendered in color and use more correct
+ positioning
* General code cleanups
* Many more changes
@@ -80,7 +83,7 @@ Command line switches
know about this change.
(The new syntax was introduced in mplayer2.)
-* In general, negating a switch like ``-noopt`` now has to be written as
+* In general, negating switches like ``-noopt`` now have to be written as
``-no-opt``, or better ``--no-opt``.
* Per-file options are not the default anymore. You can explicitly specify
file local options. See ``Usage`` section.
@@ -151,8 +154,8 @@ Other
mplayer. A proper slave mode application needed tons of code and hacks to get
it right. The main problem is that slave mode is a bad and incomplete
interface, and to get around that, applications parsed output messages
- intended for users. It's hard to know just which messages are parsed by some
- slave mode application, and as such it's virtually impossible to improve
+ intended for users. It's hard to know which messages exactly are parsed by
+ slave mode applications. This makes it virtually impossible to improve
terminal output intended for users without possibly breaking something.
This is absolutely insane, and **mpv** will not try to keep slave mode
@@ -164,7 +167,7 @@ Policy for removed features
Features are a good thing, because they make users happy. As such, it is
attempted to preserve useful features as far as possible. But if a feature is
-likely to be not used by many, and causes otherwise problems, it will be
+likely to be not used by many, and causes problems otherwise, it will be
removed. Developers should not be burdened with fixing or cleaning up code that
has no actual use.
diff --git a/DOCS/man/en/input.rst b/DOCS/man/en/input.rst
index 74c4929684..2f6e0b1e09 100644
--- a/DOCS/man/en/input.rst
+++ b/DOCS/man/en/input.rst
@@ -14,16 +14,24 @@ with shift.
A list of special keys can be obtained with
-| **mplayer** --input=keylist
+| **mpv** --input=keylist
In general, keys can be combined with ``Shift``, ``Ctrl`` and ``Alt``:
| ctrl+q quit
+**mpv** can be started in input test mode, which displays key bindings and the
+commands they're bound to on the OSD, instead of running the commands:
+
+| **mpv** --input=test --demuxer=rawvideo --rawvideo=w=1280:h=720 /dev/zero
+
+(Commands which normally close the player will not work in this mode, and you
+must kill **mpv** externally to make it exit.)
+
General input command syntax
----------------------------
-`[Shift+][Ctrl+][Alt+][Meta+]<key> [<prefix>] <command> (<argument>)*`
+`[Shift+][Ctrl+][Alt+][Meta+]<key> [<prefixes>] <command> (<argument>)*`
Newlines always start a new binding. ``#`` starts a comment (outside of quoted
string arguments). To bind commands to the ``#`` key, ``SHARP`` can be used.
@@ -45,7 +53,7 @@ ignore
disabling default bindings, without disabling all bindings with
``--input=default-bindings=no``.
-seek <seconds> [relative|absolute|absolute-percent] [default-precise|exact|keyframes]
+seek <seconds> [relative|absolute|absolute-percent|- [default-precise|exact|keyframes]]
Change the playback position. By default, seeks by a relative amount of
seconds.
@@ -56,7 +64,7 @@ seek <seconds> [relative|absolute|absolute-percent] [default-precise|exact|keyfr
absolute
Seek to a given time.
absolute-percent
- Seek to agiven percent position.
+ Seek to a given percent position.
The third argument defines how exact the seek is:
@@ -87,28 +95,31 @@ cycle <property> [up|down]
speed_mult <value>
Multiply the ``speed`` property by the given value.
-screenshot [single|each-frame] [video|window]
+screenshot [subtitles|video|window|- [single|each-frame]]
Take a screenshot.
First argument:
+ <subtitles> (default)
+ Save the video image, in its original resolution, and with subtitles.
+ Some video outputs may still include the OSD in the output under certain
+ circumstances.
+ <video>
+ Like ``subtitles``, but typically without OSD or subtitles. The exact
+ behavior depends on the selected video output.
+ <window>
+ Save the contents of the mpv window. Typically scaled, with OSD and
+ subtitles. The exact behavior depends on the selected video output, and
+ if no support is available, this will act like ``video``.
+
+ Second argument:
+
<single> (default)
Take a single screenshot.
<each-frame>
Take a screenshot each frame. Issue this command again to stop taking
screenshots.
- Second argument:
-
- <video> (default)
- Save the video image, in its original resolution. Typically without
- OSD or subtitles, but the exact behavior depends on the selected video
- output.
- <window>
- Save the contents of the mplayer window. Typically scaled, with OSD and
- subtitles. The exact behavior depends on the selected video output, and
- if not support is available, this will act like ``video``.
-
playlist_next [weak|force]
Go to the next entry on the playlist.
@@ -164,7 +175,7 @@ print_text "<string>"
Print text to stdout. The string can contain properties, which are expanded
like in ``--playing-msg``.
-show_text "<string>" [<duration>] [<level>]
+show_text "<string>" [<duration>|- [<level>]]
Show text on the OSD. The string can contain properties, which are expanded
like in ``--playing-msg``. This can be used to show playback time, filename,
and so on.
@@ -204,9 +215,9 @@ osd-bar
If possible, show a bar with this command. Seek commands will show the
progress bar, property changing commands may show the newly set value.
osd-msg
- If possible, show an OSD message with this command. The seek command shows
- the current playback time (like ``show_progress``), property changing
- commands show the newly set value as text.
+ If possible, show an OSD message with this command. Seek command show
+ the current playback time, property changing commands show the newly set
+ value as text.
osd-msg-bar
Combine osd-bar and osd-msg.
@@ -220,7 +231,7 @@ pausing_keep_force. (Should these be made official?)
Properties
----------
-Properties are used to set mplayer options during runtime, or to query arbitrary
+Properties are used to set mpv options during runtime, or to query arbitrary
information. They can be manipulated with the ``set``/``add``/``cycle``
commands, and retrieved with ``show_text``, or anything else that uses property
expansion. (See ``--playing-msg`` how properties are expanded.)
@@ -253,7 +264,7 @@ edition x current MKV edition number
titles number of DVD titles
chapters number of chapters
editions number of MKV editions
-angle current DVD angle
+angle x current DVD angle
metadata metadata key/value pairs
metadata/<key> value of metedata entry <key>
pause x pause status (bool)
@@ -303,8 +314,8 @@ sub-scale x subtitle font size multiplicator
ass-use-margins x see ``--ass-use-margins``
ass-vsfilter-aspect-compat x see ``--ass-vsfilter-aspect-compat``
ass-style-override x see ``--ass-style-override``
-tv-brightness
-tv-contrast
-tv-saturation
-tv-hue
+tv-brightness x
+tv-contrast x
+tv-saturation x
+tv-hue x
=========================== = ==================================================
diff --git a/DOCS/man/en/mpv.rst b/DOCS/man/en/mpv.rst
index 6de386fdf9..96ccb10691 100644
--- a/DOCS/man/en/mpv.rst
+++ b/DOCS/man/en/mpv.rst
@@ -18,9 +18,6 @@ Synopsis
| **mpv** \mf://[filemask|\@listfile] [-mf options] [options]
| **mpv** [cdda|cddb]://track[-endtrack][:speed][/device] [options]
| **mpv** [file|mms[t]|http|http\_proxy|rt[s]p|ftp|udp|unsv|icyx|noicyx|smb]:// [user:pass\@]URL[:port] [options]
-| **mpv** \sdp://file [options]
-| **mpv** \mpst://host[:port]/URL [options]
-| **mpv** \tivo://host/[list|llist|fsid] [options]
DESCRIPTION
@@ -48,13 +45,11 @@ keyboard control
LEFT and RIGHT
Seek backward/forward 10 seconds. Shift+arrow does a 1 second exact seek
- (see ``--hr-seek``; currently modifier keys like shift only work if used in
- an X output window).
+ (see ``--hr-seek``).
UP and DOWN
Seek forward/backward 1 minute. Shift+arrow does a 5 second exact seek (see
- ``--hr-seek``; currently modifier keys like shift only work if used in an X
- output window).
+ ``--hr-seek``).
PGUP and PGDWN
Seek forward/backward 10 minutes.
@@ -149,20 +144,15 @@ V
Toggle subtitle VSFilter aspect compatibility mode. See
``--ass-vsfilter-aspect-compat`` for more info.
-C (``--capture`` only)
- Start/stop capturing the primary stream.
-
r and t
Move subtitles up/down.
-i (``--edlout`` mode only)
- Set start or end of an EDL skip and write it out to the given file.
-
s
Take a screenshot.
S
- Start/stop taking screenshots.
+ Take a screenshot, without subtitles. (Whether this works depends on VO
+ driver support.)
I
Show filename on the OSD.
@@ -173,7 +163,7 @@ P
! and @
Seek to the beginning of the previous/next chapter.
-D (``--vo=vdpau``, ``--vf=yadif``, ``--vf=kerndeint`` only)
+D (``--vo=vdpau``, ``--vf=yadif`` only)
Activate/deactivate deinterlacer.
A
@@ -183,8 +173,7 @@ c
Change YUV colorspace.
(The following keys are valid only when using a video output that supports the
-corresponding adjustment, the software equalizer (``--vf=eq`` or ``--vf=eq2``)
-or hue filter (``--vf=hue``).)
+corresponding adjustment, or the software equalizer (``--vf=eq2``).)
1 and 2
Adjust contrast.
@@ -304,7 +293,7 @@ affects all files. Example:
| file2.mkv | --a --b --c |
+-----------+-------------------------+
-Also, if any option is changed at runtime (via slave commands), they aren't
+Also, if any option is changed at runtime (via input commands), they aren't
reset when a new file is played.
Sometimes, it's useful to change options per-file. This can be achieved by
@@ -340,9 +329,8 @@ your configuration directory (e.g. ``/etc/mpv`` or
User specific options override system-wide options and options given on the
command line override either. The syntax of the configuration files is
``option=<value>``, everything after a *#* is considered a comment. Options
-that work without values can be enabled by setting them to *yes* or *1* or
-*true* and disabled by setting them to *no* or *0* or *false*. Even suboptions
-can be specified in this way.
+that work without values can be enabled by setting them to *yes* and disabled by
+setting them to *no*. Even suboptions can be specified in this way.
You can also write file-specific configuration files. If you wish to have a
configuration file for a file called 'movie.avi', create a file named
@@ -358,8 +346,8 @@ as the file played and then tries to load any file-specific configuration.
*EXAMPLE MPV CONFIGURATION FILE:*
-| # Use gl3 video output by default.
-| vo=gl3
+| # Use opengl video output by default.
+| vo=opengl
| # I love practicing handstands while watching videos.
| flip=yes
| # Decode multiple files from PNG,
@@ -415,12 +403,13 @@ Taking screenshots
==================
Screenshots of the currently played file can be taken using the 'screenshot'
-slave mode command, which is by default bound to the ``s`` key. Files named
-``shotNNNN.png`` will be saved in the working directory, using the first
+input mode command, which is by default bound to the ``s`` key. Files named
+``shotNNNN.jpg`` will be saved in the working directory, using the first
available number - no files will be overwritten.
A screenshot will usually contain the unscaled video contents at the end of the
-video filter chain. Some video output drivers will include subtitles and OSD in
+video filter chain and subtitles. By default the ``S`` takes screenshots without
+subtitles. Some video output drivers will always include subtitles and OSD in
the video frame as well - this is because of technical restrictions.
The ``screenshot`` video filter is normally not required when using a
@@ -442,10 +431,6 @@ ENVIRONMENT VARIABLES
There are a number of environment variables that can be used to control the
behavior of mpv.
-``MPV_CHARSET`` (see also ``--msgcharset``)
- Convert console messages to the specified charset (default: autodetect). A
- value of "noconv" means no conversion.
-
``MPV_HOME``
Directory where mpv looks for user settings.
@@ -519,29 +504,6 @@ libdvdcss:
``HOME``
FIXME: Document this.
-libao2:
- ``AUDIOSERVER``
- Specifies the Network Audio System server to which the nas audio
- output driver should connect and the transport that should be used. If
- unset DISPLAY is used instead. The transport can be one of tcp and
- unix. Syntax is ``tcp/<somehost>:<someport>``,
- ``<somehost>:<instancenumber>`` or ``[unix]:<instancenumber>``. The
- NAS base port is 8000 and <instancenumber> is added to that.
-
- *EXAMPLES*:
-
- ``AUDIOSERVER=somehost:0``
- Connect to NAS server on somehost using default port and
- transport.
- ``AUDIOSERVER=tcp/somehost:8000``
- Connect to NAS server on somehost listening on TCP port 8000.
- ``AUDIOSERVER=(unix)?:0``
- Connect to NAS server instance 0 on localhost using unix domain
- sockets.
-
- ``DISPLAY``
- FIXME: Document this.
-
osdep:
``TERM``
FIXME: Document this.
@@ -550,9 +512,6 @@ libvo:
``DISPLAY``
FIXME: Document this.
- ``FRAMEBUFFER``
- FIXME: Document this.
-
``HOME``
FIXME: Document this.
@@ -639,7 +598,7 @@ Play DVD video from a directory with VOB files:
``mpv dvd://1 --dvd-device=/path/to/directory/``
Stream from HTTP:
- ``mpv http://mpv.hq/example.avi``
+ ``mpv http://example.com/example.avi``
Stream using RTSP:
``mpv rtsp://server.example.com/streamName``
@@ -647,24 +606,6 @@ Stream using RTSP:
input from standard V4L:
``mpv tv:// --tv=driver=v4l:width=640:height=480:outfmt=i420 --vc=rawi420 --vo=xv``
-Play DTS-CD with passthrough:
- ``mpv --ac=hwdts --rawaudio=format=0x2001 --cdrom-device=/dev/cdrom cdda://``
-
- You can also use ``--afm=hwac3`` instead of ``--ac=hwdts``. Adjust
- ``/dev/cdrom`` to match the CD-ROM device on your system. If your external
- receiver supports decoding raw DTS streams, you can directly play it via
- ``cdda://`` without setting format, hwac3 or hwdts.
-
-Play a 6-channel AAC file with only two speakers:
- ``mpv --rawaudio=format=0xff --demuxer=rawaudio --af=pan=2:.32:.32:.39:.06:.06:.39:.17:-.17:-.17:.17:.33:.33 adts_he-aac160_51.aac``
-
- You might want to play a bit with the pan values (e.g multiply with a
- value) to increase volume or avoid clipping.
-
-checkerboard invert with geq filter:
- ``mpv --vf=geq='128+(p(X\,Y)-128)*(0.5-gt(mod(X/SW\,128)\,64))*(0.5-gt(mod(Y/SH\,128)\,64))*4'``
-
-
AUTHORS
=======
diff --git a/DOCS/man/en/options.rst b/DOCS/man/en/options.rst
index e226cb7cb7..56d8305c95 100644
--- a/DOCS/man/en/options.rst
+++ b/DOCS/man/en/options.rst
@@ -19,16 +19,6 @@
*NOTE*: See ``--ac=help`` for a full list of available codecs.
- *EXAMPLE*:
-
- :``--ac=mp3acm``: Force the l3codeca.acm MP3 codec.
- :``--ac=mad,``: Try libmad first, then fall back on others.
- :``--ac=hwac3,a52,``: Try hardware AC-3 passthrough, software AC-3, then
- others.
- :``--ac=hwdts,``: Try hardware DTS passthrough, then fall back on
- others.
- :``--ac=-ffmp3,``: Skip FFmpeg's MP3 decoder.
-
--af=<filter1[=parameter1:parameter2:...],filter2,...>
Specify a list of audio filters to apply to the audio stream. See
:ref:`audio_filters` for details and descriptions of the available filters.
@@ -80,7 +70,6 @@
*EXAMPLE*:
:``--afm=ffmpeg``: Try FFmpeg's libavcodec codecs first.
- :``--afm=acm,dshow``: Try Win32 codecs first.
--aid=<ID|auto|no>
Select audio channel. ``auto`` selects the default, ``no`` disables audio.
@@ -125,9 +114,9 @@
features in other subtitle formats by conversion to ASS markup. Enabled by
default if the player was compiled with libass support.
- *NOTE*: Some of the other subtitle options were written for the old
- non-libass subtitle rendering system and may not work the same way or at
- all with libass rendering enabled.
+ *NOTE*: With ``--ass``, some of the ASS subtitle options work for non-ASS
+ text subtitles only, because ASS subtitles include their own styling
+ information.
--ass-border-color=<value>
Sets the border (outline) color for text subtitles. The color format is
@@ -158,8 +147,6 @@
:1: FreeType autohinter, light mode
:2: FreeType autohinter, normal mode
:3: font native hinter
- :0-3 + 4: The same, but hinting will only be performed if the OSD is
- rendered at screen resolution and will therefore not be scaled.
The default value is 0 (no hinting).
@@ -242,6 +229,8 @@
is also used to set the maximum delivery bandwidth allowing faster cache
filling and stream dumping.
+ *NOTE*: probably broken/useless.
+
--untimed
Do not sleep when outputting video frames. Useful for benchmarks when used
with --no-audio.
@@ -319,7 +308,7 @@
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>
@@ -392,12 +381,6 @@
:BT.601: ITU-R BT.601 (SD)
:BT.709: ITU-R BT.709 (HD)
:SMPTE-240M: SMPTE-240M
- :sd: alias for BT.601
- :hd: alias for BT.709
- :0: compatibility alias for auto (do not use)
- :1: compatibility alias for BT.601 (do not use)
- :2: compatibility alias for BT.709 (do not use)
- :3: compatibility alias for SMPTE-240M (do not use)
--colormatrix-input-range=<color-range>
YUV color levels used with YUV to RGB conversion. This option is only
@@ -489,10 +472,6 @@
``--display=xtest.localdomain:0``
---double, --no-double
- Double buffering. The option to disable this exists mostly for debugging
- purposes and should not normally be used.
-
--doubleclick-time
Time in milliseconds to recognize two consecutive button presses as a
double-click (default: 300).
@@ -542,6 +521,8 @@
EDL entries later. See http://www.mplayerhq.hu/DOCS/HTML/en/edl.html for
details.
+ *NOTE*: broken.
+
--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
@@ -569,14 +550,6 @@
reliable enough), the filename extension is used to select the demuxer.
Always falls back on content-based demuxer selection.
---ffactor=<number>
- Resample the font alphamap. Can be:
-
- :0: plain white fonts
- :0.75: very narrow black outline (default)
- :1: narrow black outline
- :10: bold black outline
-
--field-dominance=<-1-1>
Set first field for interlaced content. Useful for deinterlacers that
double the framerate: ``--vf=tfields=1``, ``--vf=yadif=1`` and
@@ -597,15 +570,6 @@
--flip
Flip image upside-down.
---flip-hebrew
- Turns on flipping subtitles using FriBiDi.
-
---flip-hebrew-commas, --no-flip-hebrew-commas
- Enabled by default.
- Change FriBiDi's assumptions about the placements of commas in subtitles.
- Use this if commas in subtitles are shown at the start of a sentence
- instead of at the end.
-
--font=<pattern-or-filename>
Specify font to use for OSD and for subtitles that do not themselves
specify a particular font. See also ``--subfont``. With fontconfig enabled
@@ -643,6 +607,8 @@
--fps=<float>
Override video framerate. Useful if the original value is wrong or missing.
+ *NOTE*: Works in ``--no-correct-pts`` mode only.
+
--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
@@ -650,15 +616,11 @@
decoding and output of any frame can be skipped, and will lead to an even
worse playback experience.
- Practical use of this feature is questionable. Disabled by default.
+ *NOTE*: Practical use of this feature is questionable. Disabled by default.
--frames=<number>
Play/convert only first <number> frames, then quit.
---fribidi-charset=<name>
- Specifies the character set that will be passed to FriBiDi when decoding
- non-UTF-8 subtitles (default: ISO8859-8).
-
--fullscreen
--fs
Fullscreen playback (centers movie, and paints black bands around it).
@@ -761,7 +723,7 @@
Command that is executed every 30 seconds during playback via *system()* -
i.e. using the shell.
- *NOTE*: mpv uses this command without any checking, it is your
+ *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
@@ -779,7 +741,7 @@
--heartbeat-cmd="gnome-screensaver-command -p" file``
--help
- Show short summary of options and key bindings.
+ Show short summary of options.
--hr-seek=<no|absolute|yes>
Select when to use precise seeks that are not limited to keyframes. Such
@@ -831,14 +793,7 @@
drivers.
--identify
- Shorthand for ``--msglevel=identify=4``. Show file parameters in an easily
- parseable format. Also prints more detailed information about subtitle and
- audio track languages and IDs. In some cases you can get more information
- by using ``--msglevel=identify=6``. For example, for a DVD or Blu-ray it
- will list the chapters and time length of each title, as well as a disk
- ID. Combine this with ``--frames=0`` to suppress all video output. The
- wrapper script ``TOOLS/midentify.sh`` suppresses the other mpv output
- and (hopefully) shellescapes the filenames.
+ Deprecated. Use ``TOOLS/mpv_identify.sh``.
--idle
Makes mpv wait idly instead of quitting when there is no file to play.
@@ -898,7 +853,7 @@
ar-rate
Number of key presses to generate per second on autorepeat.
- (no)default-bindings
+ (no-)default-bindings
Use the key bindings that mpv ships with by default.
keylist
@@ -1308,7 +1263,7 @@
values mean multiples of the default range. Negative numbers mean you can
zoom in up to a factor of ``--panscanrange=+1``. E.g. ``--panscanrange=-3``
allows a zoom factor of up to 4. This feature is experimental. Do not
- report bugs unless you are using ``--vo=gl``.
+ report bugs unless you are using ``--vo=opengl``.
--passwd=<password>
Used with some network protocols. Specify password for HTTP authentication.
@@ -1337,7 +1292,7 @@
$$
Expands to ``$``.
$}
- Expands to ``}``. (To produce this character inside rexursive
+ Expands to ``}``. (To produce this character inside recursive
expansion.)
$>
Disable property expansion and special handling of ``$`` for the rest
@@ -1359,19 +1314,12 @@
sources. Do NOT use ``--playlist`` with random internet sources or files
you don't trust!
- *NOTE*: This option is considered an entry so options found after it will
- apply only to the elements of this playlist.
-
FIXME: This needs to be clarified and documented thoroughly.
--pp=<quality>
- This option only works when decoding video with Win32 DirectShow DLLs with
- internal postprocessing routines. See also ``--vf=pp``. Set the DLL
- postprocess level. The valid range of ``--pp`` values varies by codec, it
- is mostly 0-6, where 0=disable, 6=slowest/best.
+ See also ``--vf=pp``.
--pphelp
- Show a summary about the available postprocess filters and their usage.
See also ``--vf=pp``.
--prefer-ipv4
@@ -1573,18 +1521,6 @@
images may cover the movie window, though. May not work with all video
output drivers.
---rtsp-destination
- Used with ``rtsp://`` URLs to force the destination IP address to be
- bound. This option may be useful with some RTSP server which do not send
- RTP packets to the right interface. If the connection to the RTSP server
- fails, use ``-v`` to see which IP address mpv tries to bind to and try
- to force it to one assigned to your computer instead.
-
---rtsp-port
- Used with ``rtsp://`` URLs to force the client's port number. This option
- may be useful if you are behind a router and want to forward the RTSP
- stream from the server to a specific client.
-
--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
@@ -1665,9 +1601,9 @@
insert the number of the current month as number. You have to use
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, nothing
- is inserted, unless a fallback is specified.
+ 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,
+ an error text is inserted, unless a fallback is specified.
``%%``
Replaced with the ``%`` character itself.
@@ -1741,10 +1677,10 @@
:yes: always use the volume filter
:auto: prefer the volume filter if the audio driver uses the system mixer (default)
- The intention with ``auto`` is to avoid changing system mixer settings with
- default settings. mpv is a video player, not a mixer panel. On the other
- hand, mixer controls should be used for sound servers like PulseAudio, which
- provide per-application volume.
+ 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>
Set the maximum amplification level in percent (default: 200). A value of
@@ -1755,30 +1691,6 @@
--speed=<0.01-100>
Slow down or speed up playback by the factor given as parameter.
---spuaa=<mode>
- Antialiasing/scaling mode for DVD/VOBsub. A value of 16 may be added to
- <mode> in order to force scaling even when original and scaled frame size
- already match. This can be employed to e.g. smooth subtitles with gaussian
- blur. Available modes are:
-
- :0: none (fastest, very ugly)
- :1: approximate (broken?)
- :2: full (slow)
- :3: bilinear (default, fast and not too bad)
- :4: uses swscaler gaussian blur (looks very good)
-
---spualign=<-1-2>
- Specify how SPU (DVD/VOBsub) subtitles should be aligned.
-
- :-1: Original position
- :0: Align at top (original behavior, default).
- :1: Align at center.
- :2: Align at bottom.
-
---spugauss=<0.0-3.0>
- Variance parameter of gaussian used by ``--spuaa=4``. Higher means more
- blur (default: 1.0).
-
--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
@@ -1806,11 +1718,12 @@
:chs=<h>: chroma horizontal shifting
:cvs=<v>: chroma vertical shifting
- *EXAMPLE*: ``--vf=scale=-ssf=lgb=3.0``
+ *EXAMPLE*: ``--vf=scale --ssf=lgb=3.0``
--sstep=<sec>
- Skip <sec> seconds after every frame. Since mpv will only seek to
- the next keyframe unless you use ``--hr-seek`` this may be inexact.
+ Skip <sec> seconds after every frame.
+
+ *NOTE*: without ``--hr-seek``, skipping will snap to keyframes.
--stereo=<mode>
Select type of MP2/MP3 stereo output.
@@ -1829,15 +1742,6 @@
Use/display these subtitle files. Only one file can be displayed at the
same time.
---sub-bg-alpha=<0-255>
- Specify the alpha channel value for subtitles and OSD backgrounds. Big
- values mean more transparency. 0 means completely transparent.
-
---sub-bg-color=<0-255>
- Specify the color value for subtitles and OSD backgrounds. Currently
- subtitles are grayscale so this value is equivalent to the intensity of
- the color. 255 means white and 0 black.
-
--sub-demuxer=<[+]name>
Force subtitle demuxer type for ``--subfile``. Using a '+' before the name
will force it, this will skip some checks! Give the demuxer name as
@@ -1899,42 +1803,17 @@
Delays subtitles by <sec> seconds. Can be negative.
--subfile=<filename>
- (BETA CODE)
- Currently useless. Same as ``--audiofile``, but for subtitle streams
- (OggDS?).
+ Open the given file with a demuxer, and use its subtitle streams. Same as
+ ``--audiofile``, but for subtitle streams.
+
+ Use ``--sub`` for normal text subtitle files.
--subfont=<pattern-or-filename>
Sets the subtitle font (see ``--font``). If no ``--subfont`` is given,
``--font`` is used for subtitles too.
---subfont-autoscale=<0-3>
- Sets the autoscale mode.
-
- *NOTE*: 0 means that text scale and OSD scale are font heights in points.
-
- The mode can be:
-
- :0: no autoscale
- :1: proportional to movie height
- :2: proportional to movie width
- :3: proportional to movie diagonal (default)
-
---subfont-blur=<0-8>
- Sets the font blur radius (default: 2).
-
---subfont-encoding=<value>
- Sets the font encoding. When set to 'unicode', all the glyphs from the
- font file will be rendered and unicode will be used (default: unicode).
-
---subfont-osd-scale=<0-100>
- Sets the autoscale coefficient of the OSD elements (default: 4).
-
---subfont-outline=<0-8>
- Sets the font outline thickness (default: 2).
-
--subfont-text-scale=<0-100>
- Sets the subtitle text autoscale coefficient as percentage of the screen
- size (default: 3.5).
+ Factor for the text subtitle and OSD font size (default: 6).
--subfps=<rate>
Specify the framerate of the subtitle file (default: movie fps).
@@ -1947,10 +1826,6 @@
position of the subtitle in % of the screen height.
Can be useful with ``--vf=expand``.
---subwidth=<10-100>
- Specify the maximum width of subtitles on the screen. Useful for TV-out.
- The value is the width of the subtitle in % of the screen width.
-
--sws=<n>
Specify the software scaler algorithm to be used with the ``--zoom``
option. This affects video output drivers which lack hardware
@@ -1982,8 +1857,9 @@
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
- Set the window title. Properties are expanded (see ``--playing-msg``).
+--title=<string>
+ Set the window title. Properties are expanded on playback start
+ (see ``--playing-msg``).
--tv=<option1:option2:...>
This option tunes various properties of the TV capture module. For
@@ -2196,9 +2072,6 @@