diff options
Diffstat (limited to 'DOCS/man/options.rst')
| -rw-r--r-- | DOCS/man/options.rst | 173 |
1 files changed, 79 insertions, 94 deletions
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst index bf98370eee..eab9f8fefd 100644 --- a/DOCS/man/options.rst +++ b/DOCS/man/options.rst @@ -134,11 +134,11 @@ Playback Control speed higher than normal automatically inserts the ``scaletempo`` audio filter. -``--loop=<N|inf|force|no>`` +``--loop=<N|inf|force|no>``, ``--loop`` Loops playback ``N`` times. A value of ``1`` plays it one time (default), ``2`` two times, etc. ``inf`` means forever. ``no`` is the same as ``1`` and disables looping. If several files are specified on command line, the - entire playlist is looped. + entire playlist is looped. ``--loop`` is the same as ``--loop=inf``. The ``force`` mode is like ``inf``, but does not skip playlist entries which have been marked as failing. This means the player might waste CPU @@ -267,6 +267,26 @@ Playback Control Note that ``--playlist`` always loads all entries, so you use that instead if you really have the need for this functionality. +``--access-references=<yes|no>`` + Follow any references in the file being opened (default: yes). Disabling + this is helpful if the file is automatically scanned (e.g. thumbnail + generation). If the thumbnail scanner for example encounters a playlist + file, which contains network URLs, and the scanner should not open these, + enabling this option will prevent it. This option also disables ordered + chapters, mov reference files, opening of archives, and a number of other + features. + + On older FFmpeg versions, this will not work in some cases. Some FFmpeg + demuxers might not respect this option. + + This option does not prevent opening of paired subtitle files and such. Use + ``--autoload-files=no`` to prevent this. + + This option does not always work if you open non-files (for example using + ``dvd://directory`` would open a whole bunch of files in the given + directory). Prefixing the filename with ``./`` if it doesn't start with + a ``/`` will avoid this. + ``--loop-file=<N|inf|no>`` Loop a single file N times. ``inf`` means forever, ``no`` means normal playback. For compatibility, ``--loop-file`` and ``--loop-file=yes`` are @@ -330,9 +350,10 @@ Program Behavior ``--help``, ``--h`` Show short summary of options. - You can also pass a shell pattern to this option, which will list all - matching top-level options, e.g. ``--h=*scale*`` for all options that - contain the word "scale". + You can also pass a string to this option, which will list all top-level + options which contain the string in the name, e.g. ``--h=scale`` for all + options that contain the word ``scale``. The special string ``*`` lists + all top-level options. ``-v`` Increment verbosity level, one level for each ``-v`` found on the command @@ -534,7 +555,7 @@ Video Specify the video output backend to be used. See `VIDEO OUTPUT DRIVERS`_ for details and descriptions of available drivers. -``--vd=<[+|-]family1:(*|decoder1),[+|-]family2:(*|decoder2),...[-]>`` +``--vd=<...>`` 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 @@ -703,8 +724,8 @@ Video mechanism in the opengl output path. To use this deinterlacing you must pass the option: ``vd-lavc-o=deint=[weave|bob|adaptive]``. Pass ``weave`` to not attempt any deinterlacing. - 10bit HEVC is available if the hardware supports it but it will be - rounded down to 8 bits. + 10 and 12bit HEVC is available if the hardware supports it and a + sufficiently new driver (> 375.xx) is used. ``cuda-copy`` has the same behaviour as ``cuda`` - including the ability to deinterlace inside the decoder. However, traditional deinterlacing @@ -1100,11 +1121,10 @@ Audio Possible codecs are ``ac3``, ``dts``, ``dts-hd``. Multiple codecs can be specified by separating them with ``,``. ``dts`` refers to low bitrate DTS core, while ``dts-hd`` refers to DTS MA (receiver and OS support varies). - You should only use either ``dts`` or ``dts-hd`` (if both are specified, - and ``dts`` comes first, only ``dts`` will be used). + If both ``dts`` and ``dts-hd`` are specified, it behaves equivalent to + specifying ``dts-hd`` only. - In general, all codecs in the ``spdif`` family listed with ``--ad=help`` - are supported in theory. + In earlier mpv versions .. admonition:: Warning @@ -1114,27 +1134,31 @@ Audio ``--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 - decoder that matches the audio format is selected. If that is unavailable, - the next decoder is used. Finally, it tries all other decoders that are not + decoder name. When determining which decoder to use, the first decoder that + matches the audio format is selected. If that is unavailable, the next + decoder is used. Finally, it tries all other decoders that are not explicitly selected or rejected by the option. + Specifying family names is deprecated. Entries like ``family:*`` prioritize + all decoders of the given family. + ``-`` 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 should not normally be used, because they break - normal decoder auto-selection! + normal decoder auto-selection! Both of these methods are deprecated. - ``-`` in front of an entry disables selection of the decoder. + ``-`` in front of an entry disables selection of the decoder. This is + deprecated. .. admonition:: Examples - ``--ad=lavc:mp3float`` + ``--ad=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=lavc:mp3float`` + Prefer the FFmpeg/Libav ``mp3float`` decoder over all other MP3 + decoders. (Using deprecated family syntax.) ``--ad=help`` List all available decoders. @@ -1734,66 +1758,31 @@ Subtitles :all: Load all subs in the current and ``--sub-paths`` directories. ``--sub-codepage=<codepage>`` - If your system supports ``iconv(3)``, you can use this option to specify - the subtitle codepage. By default, uchardet will be used to guess the - charset. If mpv is not compiled with uchardet, enca will be used. - If mpv is compiled with neither uchardet nor enca, ``UTF-8:UTF-8-BROKEN`` - is the default, which means it will try to use UTF-8, otherwise the - ``UTF-8-BROKEN`` pseudo codepage (see below). + You can use this option to specify the subtitle codepage. uchardet will be + used to guess the charset. (If mpv was not compiled with uchardet, then + ``utf-8`` is the effective default.) - The default value for this option is ``auto``, whose actual effect depends - on whether ENCA is compiled. + The default value for this option is ``auto``, which enables autodetection. - .. admonition:: Warning + The following steps are taken to determine the final codepage, in order: - If you force the charset, even subtitles that are known to be - UTF-8 will be recoded, which is perhaps not what you expect. Prefix - codepages with ``utf8:`` if you want the codepage to be used only if the - input is not valid UTF-8. + - if the specific codepage has a ``+``, use that codepage + - if the data looks like UTF-8, assume it is UTF-8 + - if ``--sub-codepage`` is set to a specific codepage, use that + - run uchardet, and if successful, use that + - otherwise, use ``UTF-8-BROKEN`` .. admonition:: Examples - - ``--sub-codepage=utf8:latin2`` Use Latin 2 if input is not UTF-8. - - ``--sub-codepage=cp1250`` Always force recoding to cp1250. - - The pseudo codepage ``UTF-8-BROKEN`` is used internally. When it - is the codepage, subtitles are interpreted as UTF-8 with "Latin 1" as - fallback for bytes which are not valid UTF-8 sequences. iconv is - never involved in this mode. + - ``--sub-codepage=latin2`` Use Latin 2 if input is not UTF-8. + - ``--sub-codepage=+cp1250`` Always force recoding to cp1250. - If the player was compiled with ENCA support, you can control it with the - following syntax: + The pseudo codepage ``UTF-8-BROKEN`` is used internally. If it's set, + subtitles are interpreted as UTF-8 with "Latin 1" as fallback for bytes + which are not valid UTF-8 sequences. iconv is never involved in this mode. - ``--sub-codepage=enca:<language>:<fallback codepage>`` - - Language is specified using a two letter code to help ENCA detect - the codepage automatically. If an invalid language code is - entered, mpv will complain and list valid languages. (Note - however that this list will only be printed when the conversion code is actually - called, for example when loading an external subtitle). The - fallback codepage is used if autodetection fails. If no fallback - is specified, ``UTF-8-BROKEN`` is used. - - .. admonition:: Examples - - - ``--sub-codepage=enca:pl:cp1250`` guess the encoding, assuming the subtitles - are Polish, fall back on cp1250 - - ``--sub-codepage=enca:pl`` guess the encoding for Polish, fall back on UTF-8. - - ``--sub-codepage=enca`` try universal detection, fall back on UTF-8. - - If the player was compiled with libguess support, you can use it with: - - ``--sub-codepage=guess:<language>:<fallback codepage>`` - - libguess always needs a language. There is no universal detection - mode. Use ``--sub-codepage=guess:help`` to get a list of - languages subject to the same caveat as with ENCA above. - - If the player was compiled with uchardet support you can use it with: - - ``--sub-codepage=uchardet`` - - This mode doesn't take language or fallback codepage. + This option changed in mpv 0.23.0. The old syntax is still emulated to some + degree. ``--sub-fix-timing``, ``--no-sub-fix-timing`` By default, subtitle timing is adjusted to remove minor gaps or overlaps @@ -2041,10 +2030,6 @@ Window See also ``--screen``. -``--fs-black-out-screens`` - - OS X only. Black out other displays when going fullscreen. - ``--keep-open=<yes|no|always>`` Do not terminate when playing or seeking beyond the end of the file, and there is not next file to be played (and ``--loop`` is not used). @@ -2182,7 +2167,7 @@ Window ``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``). + ratio (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. @@ -2305,7 +2290,7 @@ Window 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``). + ``--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 @@ -3797,21 +3782,7 @@ OpenGL renderer options ----------------------- The following video options are currently all specific to ``--vo=opengl`` and -``-vo=opengl-cb`` only, which are the only VOs that implement them. - -``--opengl-dumb-mode=<yes|no>`` - This mode is extremely restricted, and will disable most extended OpenGL - features. This includes high quality scalers and custom shaders! - - It is intended for hardware that does not support FBOs (including GLES, - which supports it insufficiently), or to get some more performance out of - bad or old hardware. - - This mode is forced automatically if needed, and this option is mostly - useful for debugging. It's also enabled automatically if nothing uses - features which require FBOs. - - This option might be silently removed in the future. +``--vo=opengl-cb`` only, which are the only VOs that implement them. ``--scale=<filter>`` @@ -4616,6 +4587,20 @@ The following video options are currently all specific to ``--vo=opengl`` and flipping GL front and backbuffers immediately (i.e. it doesn't call it in display-sync mode). +``--opengl-dumb-mode=<yes|no>`` + This mode is extremely restricted, and will disable most extended OpenGL + features. This includes high quality scalers and custom shaders! + + It is intended for hardware that does not support FBOs (including GLES, + which supports it insufficiently), or to get some more performance out of + bad or old hardware. + + This mode is forced automatically if needed, and this option is mostly + useful for debugging. It's also enabled automatically if nothing uses + features which require FBOs. + + This option might be silently removed in the future. + Miscellaneous ------------- |