diff options
Diffstat (limited to 'DOCS/man')
| -rw-r--r-- | DOCS/man/en/af.rst | 56 | ||||
| -rw-r--r-- | DOCS/man/en/changes.rst | 1 | ||||
| -rw-r--r-- | DOCS/man/en/input.rst | 20 | ||||
| -rw-r--r-- | DOCS/man/en/options.rst | 108 | ||||
| -rw-r--r-- | DOCS/man/en/vf.rst | 39 | ||||
| -rw-r--r-- | DOCS/man/en/vo.rst | 31 |
6 files changed, 170 insertions, 85 deletions
diff --git a/DOCS/man/en/af.rst b/DOCS/man/en/af.rst index a47a63b8e2..2eaeabed0c 100644 --- a/DOCS/man/en/af.rst +++ b/DOCS/man/en/af.rst @@ -29,55 +29,27 @@ filter list. Available filters are: -resample[=srate[:sloppy[:type]]] - Changes the sample rate of the audio stream. Can be used if you have a - fixed frequency sound card or if you are stuck with an old sound card that - is only capable of max 44.1kHz. This filter is automatically enabled if - necessary. It only supports 16-bit integer and float in native-endian - format as input. - - <srate> - output sample frequency in Hz. The valid range for this parameter is - 8000 to 192000. If the input and output sample frequency are the same - or if this parameter is omitted the filter is automatically unloaded. - A high sample frequency normally improves the audio quality, - especially when used in combination with other filters. - <sloppy> - Allow (1) or disallow (0) the output frequency to differ slightly from - the frequency given by <srate> (default: 1). Can be used if the - startup of the playback is extremely slow. - <type> - Select which resampling method to use. - - :0: linear interpolation (fast, poor quality especially when - upsampling) - :1: polyphase filterbank and integer processing - :2: polyphase filterbank and floating point processing - (slow, best quality) - - *EXAMPLE*: - - ``mpv --af=resample=44100:0:0`` - would set the output frequency of the resample filter to 44100Hz using - exact output frequency scaling and linear interpolation. - -lavcresample[=srate[:length[:linear[:count[:cutoff]]]]] +lavrresample[=option1:option2:...] Changes the sample rate of the audio stream to an integer <srate> in Hz. - It only supports the 16-bit native-endian format. + Can be used if you have a fixed frequency sound card or if you are stuck + with an old sound card that is only capable of max 44.1kHz. + + This filter is automatically enabled if necessary. It only supports the + 16-bit integer native-endian format. - <srate> - the output sample rate - <length> + srate=<srate> + the output sample rate (defaut: 44100) + length=<length> length of the filter with respect to the lower sampling rate (default: 16) - <linear> - if 1 then filters will be linearly interpolated between polyphase - entries - <count> + phase_shift=<count> log2 of the number of polyphase entries (..., 10->1024, 11->2048, 12->4096, ...) (default: 10->1024) - <cutoff> + cutoff=<cutoff> cutoff frequency (0.0-1.0), default set depending upon filter length + linear + if set then filters will be linearly interpolated between polyphase + entries (default: no) lavcac3enc[=tospdif[:bitrate[:minchn]]] Encode multi-channel audio to AC-3 at runtime using libavcodec. Supports diff --git a/DOCS/man/en/changes.rst b/DOCS/man/en/changes.rst index 7f09d942a0..1e5bb74a2c 100644 --- a/DOCS/man/en/changes.rst +++ b/DOCS/man/en/changes.rst @@ -121,6 +121,7 @@ Command line switches -ass-bottom-margin --vf=sub=bottom:top -vc ffh264vdpau (etc.) --hwdec=vdpau -ac spdifac3 --ad=spdif:ac3 (see --ad=help) + -afm hwac3 --ad=spdif:ac3,spdif:dts -x W, -y H --geometry=WxH + --no-keepaspect -xy W --autofit=W =================================== =================================== diff --git a/DOCS/man/en/input.rst b/DOCS/man/en/input.rst index 221d6cbfba..7938502573 100644 --- a/DOCS/man/en/input.rst +++ b/DOCS/man/en/input.rst @@ -79,6 +79,17 @@ seek <seconds> [relative|absolute|absolute-percent|- [default-precise|exact|keyf frame_step Play one frame, then pause. +frame_back_step + Go back by one frame, then pause. Note that this can be very slow (it tries + to be precise, not fast), and sometimes fails to behave as expected. How + well this works depends on whether precise seeking works correctly (e.g. + see the ``--hr-seek-demuxer-offset`` option). Video filters or other video + postprocessing that modifies timing of frames (e.g. deinterlacing) should + usually work, but might make backstepping silently behave incorrectly in + corner cases. + + This doesn't work with audio-only playback. + set <property> "<value>" Set the given property to the given value. @@ -305,17 +316,18 @@ contrast x see ``--contrast`` saturation x see ``--saturation`` hue x see ``--hue`` panscan x see ``--panscan`` -vsync x see ``--vsync`` video-format video format (string) video-codec video codec selected for decoding video-bitrate video bitrate -width video width +width video width (container or decoded size) height video height -fps FPS (may contain bogus values) +fps container FPS (may contain bogus values) +dwidth video width (after filters and aspect scaling) +dheight video height aspect x video aspect video x current video track (similar to ``--vid``) program x switch TS program (write-only) -sub x current subttitle track (similar to ``--sid``) +sub x current subtitle track (similar to ``--sid``) sub-delay x see ``--sub-delay`` sub-pos x see ``--sub-pos`` sub-visibility x whether current subtitle is rendered diff --git a/DOCS/man/en/options.rst b/DOCS/man/en/options.rst index 43482b5c70..c805e04002 100644 --- a/DOCS/man/en/options.rst +++ b/DOCS/man/en/options.rst @@ -103,9 +103,6 @@ configuration files specifying a list of fallbacks may make sense. See `audio_outputs` for details and descriptions of available drivers. ---ar, --no-ar - Enable/disable AppleIR remote support. Enabled by default. - --aspect=<ratio> Override movie aspect ratio, in case aspect information is incorrect or missing in the file being played. See also ``--no-aspect``. @@ -299,11 +296,6 @@ Some Blu-ray discs contain scenes that can be viewed from multiple angles. Here you can tell mpv which angles to use (default: 1). ---bluray-chapter=<ID> - (Blu-ray only) - Tells mpv which Blu-ray chapter to start the current title from - (default: 1). - --bluray-device=<path> (Blu-ray only) Specify the Blu-ray disc location. Must be a directory with Blu-ray @@ -324,6 +316,12 @@ from slow media, but can also have negative effects, especially with file formats that require a lot of seeking, such as mp4. See also ``--no-cache``. + Note that half the cache size will be used to allow fast seeking back. This + is also the reason why a full cache is usually reported as 50% full. The + cache fill display does not include the part of the cache reserved for + seeking back. Likewise, when starting a file the cache will be at 100%, + because no space is reserved for seeking back yet. + --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 @@ -651,7 +649,10 @@ *NOTE*: Practical use of this feature is questionable. Disabled by default. --frames=<number> - Play/convert only first <number> frames, then quit. + 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.) --fullscreen, --fs Fullscreen playback (centers movie, and paints black bands around it). @@ -786,7 +787,8 @@ --heartbeat-cmd Command that is executed every 30 seconds during playback via *system()* - - i.e. using the shell. + 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 @@ -805,6 +807,9 @@ *EXAMPLE for GNOME screensaver*: ``mpv --heartbeat-cmd="gnome-screensaver-command -p" file`` +--heartbeat-interval=<sec> + Time between ``--heartbeat-cmd`` invocations in seconds (default: 30). + --help Show short summary of options. @@ -875,7 +880,7 @@ --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 - commands (see also ``--slave``). + commands (see also ``--slave-broken``). --idx Rebuilds index of files if no index was found, allowing seeking. Useful @@ -907,10 +912,6 @@ Specify input configuration file other than the default ``~/.mpv/input.conf``. ---input-ar-dev=<device> - Device to be used for Apple IR Remote (default is autodetected, Linux - only). - --input-ar-delay Delay in milliseconds before we start to autorepeat a key (0 to disable). @@ -932,7 +933,7 @@ --input-file=<filename> Read commands from the given file. Mostly useful with a FIFO. - See also ``--slave``. + 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 @@ -1169,6 +1170,29 @@ :fps=<value>: output fps (default: 25) :type=<value>: input file type (available: jpeg, png, tga, sgi) +--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 + seeking before or exactly to the position a subtitle first appears. To + make this worse, subtitles are often timed to appear a very small amount + before the associated video frame, so that seeking to the video frame + typically does not demux the subtitle at that position. + + Enabling this option makes the demuxer start reading data a bit before the + seek target, so that subtitles appear correctly. Note that this makes + seeking slower, and is not guaranteed to always work. It only works if the + subtitle is close enough to the seek target. + + Works with the internal Matroska demuxer only. Always enabled for absolute + and hr-seeks, and this option changes behavior with relative or imprecise + seeks only. + + 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, + instead of just skipping over it. + --mixer=<device> Use a mixer device different from the default ``/dev/mixer``. For ALSA this is the mixer name. @@ -1248,6 +1272,12 @@ --name Set the window class name for X11-based video output methods. +--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.) + --avi-ni (Internal AVI demuxer which is not used by default only) Force usage of non-interleaved AVI parser (fixes playback of some bad AVI @@ -1312,15 +1342,25 @@ 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> + 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> + Height of the OSD bar, in percentage of the screen height (default: 3.125). + --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> + Gaussian blur factor. 0 means no blur applied (default). + --osd-border-color=<#RRGGBB>, --sub-text-border-color=<#RRGGBB> See ``--osd-color``. Color used for the OSD/sub font border. @@ -1452,7 +1492,7 @@ *WARNING*: works with the deprecated ``mp_http://`` protocol only. --playing-msg=<string> - Print out a string before starting playback. The string is expanded for + 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. @@ -1697,9 +1737,6 @@ *EXAMPLE*: - - ``mpv foreman.qcif --demuxer=rawvideo --rawvideo=qcif`` Play the - famous "foreman" sample video. - - ``mpv sample-720x576.yuv --demuxer=rawvideo --rawvideo=w=720:h=576`` Play a raw YUV sample. @@ -1709,6 +1746,30 @@ --referrer=<string> Specify a referrer path or URL for HTTP requests. +--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 + when starting next file.) + + This can be changed with this option. It accepts a list of options, and + mpv will reset the value of these options on playback start to the initial + value. The initial value is either the default value, or as set by the + config file or command line. + + 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. + + The special name ``all`` resets as many options as possible. + + *EXAMPLE*: + + - ``--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. + --reuse-socket (udp:// only) Allows a socket to be reused by other processes as soon as it is closed. @@ -2341,9 +2402,6 @@ Set the startup volume. A value of -1 (the default) will not change the volume. See also ``--softvol``. ---no-vsync - Tries to disable vsync. (Effective with some video outputs only.) - --wid=<ID> (X11 and win32 only) This tells mpv to attach to an existing window. The ID is interpreted as diff --git a/DOCS/man/en/vf.rst b/DOCS/man/en/vf.rst index 4e1e0b733b..846d3ffac6 100644 --- a/DOCS/man/en/vf.rst +++ b/DOCS/man/en/vf.rst @@ -367,6 +367,45 @@ pp[=filter1[:option1[:option2...]]/[-]filter2...] Horizontal deblocking on luminance only, and switch vertical deblocking on or off automatically depending on available CPU time. +lavfi=graph[:sws_flags] + Filter video using ffmpeg's libavfilter. + + <graph> + The libavfilter graph string. The filter must have a single video input + pad and a single video output pad. + + See ``https://ffmpeg.org/ffmpeg-filters.html`` for syntax and available + filters. + + *WARNING*: if you want to use the full filter syntax with this option, + you have to quote the filter graph in order to prevent mpv's syntax + and the filter graph syntax from clashing. + + *EXAMPLE*: + + ``-vf lavfi=[gradfun=20:30,vflip]`` + gradfun filter with nonsense parameters, followed by a vflip + filter. (This demonstrates how libavfilter takes a graph and not + just a single filter.) The filter graph string is quoted with + ``[`` and ``]``. This requires no additional quoting or escaping + with some shells (like bash), while others (like zsh) require + additional ``"`` quotes around the option string. + + ``'--vf=lavfi="gradfun=20:30,vflip"'`` + same as before, but uses quoting that should be safe with all + shells. The outer ``'`` quotes make sure that the shell doesn't + remove the ``"`` quotes needed by mpv. + + ``'--vf=lavfi=graph="gradfun=radius=30:strength=20,vflip"'`` + same as before, but uses named parameters for everything. + + <sws_flags> + If libavfilter inserts filters for pixel format conversion, this + option gives the flags which should be passed to libswscale. This + option is numeric and takes a bit-wise combination of ``SWS_`` flags. + + See ``http://git.videolan.org/?p=ffmpeg.git;a=blob;f=libswscale/swscale.h``. + noise[=luma[u][t|a][h][p]:chroma[u][t|a][h][p]] Adds noise. diff --git a/DOCS/man/en/vo.rst b/DOCS/man/en/vo.rst index e3b8723966..6e39e57793 100644 --- a/DOCS/man/en/vo.rst +++ b/DOCS/man/en/vo.rst @@ -319,12 +319,12 @@ opengl Enable use of PBOs. This is faster, but can sometimes lead to sporadic and temporary image corruption. - dither-depth=<n> - Positive non-zero values select the target bit depth. Default: 0. + dither-depth=<N|no|auto> + Set dither target depth to N. Default: no. - \-1 + no Disable any dithering done by mpv. - 0 + auto Automatic selection. If output bit depth can't be detected, 8 bits per component are assumed. 8 @@ -398,7 +398,8 @@ opengl Selects the internal format of textures used for FBOs. The format can influence performance and quality of the video output. (FBOs are not always used, and typically only when using extended scalers.) - fmt can be one of: rgb, rgba, rgb8, rgb10, rgb16, rgb16f, rgb32f + fmt can be one of: rgb, rgba, rgb8, rgb10, rgb16, rgb16f, rgb32f, + rgba12, rgba16, rgba16f, rgba32f. Default: rgb. gamma @@ -430,15 +431,23 @@ opengl dimension. Default is 128x256x64. Sizes must be a power of two, and 256 at most. + alpha + Try to create a framebuffer with alpha component. This only makes sense + if the video contains alpha information (which is extremely rare). May + not be supported on all platforms. If alpha framebuffers are + unavailable, it silently falls back to a normal framebuffer. Note + that when using FBO indirections (such as with ``opengl-hq``), a FBO + format with alpha must be specified with the ``fbo-format`` option. + opengl-hq Same as ``opengl``, but with default settings for high quality rendering. This is equivalent to: - | --vo=opengl:lscale=lanczos2:dither-depth=0:pbo:fbo-format=rgb16 + | --vo=opengl:lscale=lanczos2:dither-depth=auto:pbo:fbo-format=rgb16 Note that some cheaper LCDs do dithering that gravely interferes with - vo_opengl's dithering. Disabling dithering with ``dither-depth=-1`` helps. + vo_opengl's dithering. Disabling dithering with ``dither-depth=no`` helps. Unlike ``opengl``, ``opengl-hq`` makes use of FBOs by default. Sometimes you can achieve better quality or performance by changing the fbo-format @@ -465,7 +474,7 @@ opengl-old (no-)force-pbo Always uses PBOs to transfer textures even if this involves an extra copy. Currently this gives a little extra speed with NVidia drivers - and a lot more speed with ATI drivers. May need ``--no-slices`` and + and a lot more speed with ATI drivers. May need the ati-hack suboption to work correctly. (no-)scaled-osd Changes the way the OSD behaves when the size of the window changes @@ -617,12 +626,6 @@ opengl-old slice-height=<0-...> Number of lines copied to texture in one piece (default: 0). 0 for whole image. - - *NOTE*: If YUV colorspace is used (see `yuv` suboption), special rules - apply: If the decoder uses slice rendering (see ``--no-slices``), this - setting has no effect, the size of the slices as provided by the - decoder is used. If the decoder does not use slice rendering, the - default is 16. sw Continue even if a software renderer is detected. |