diff options
Diffstat (limited to 'DOCS/man/options.rst')
| -rw-r--r-- | DOCS/man/options.rst | 110 |
1 files changed, 70 insertions, 40 deletions
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst index c8e75556c0..9ebbdd797b 100644 --- a/DOCS/man/options.rst +++ b/DOCS/man/options.rst @@ -427,7 +427,6 @@ Program Behavior the player with Shift+Q. ``--watch-later-directory=<path>`` - The directory in which to store the "watch later" temporary files. The default is a subdirectory named "watch_later" underneath the @@ -540,19 +539,15 @@ Program Behavior If the script can't do anything with an URL, it will do nothing. - The `try_ytdl_first` script option accepts a boolean 'yes' or 'no', and if + The ``try_ytdl_first`` script option accepts a boolean 'yes' or 'no', and if 'yes' will try parsing the URL with youtube-dl first, instead of the default where it's only after mpv failed to open it. This mostly depends on whether most of your URLs need youtube-dl parsing. - The `exclude` script option accepts a ``|``-separated list of URL patterns + The ``exclude`` script option accepts a ``|``-separated list of URL patterns which mpv should not use with youtube-dl. The patterns are matched after the ``http(s)://`` part of the URL. - The `use_manifests` script option makes mpv use the master manifest URL for - formats like HLS and DASH, if available, allowing for video/audio selection - in runtime. It's disabled ("no") by default for performance reasons. - ``^`` matches the beginning of the URL, ``$`` matches its end, and you should use ``%`` before any of the characters ``^$()%|,.[]*+-?`` to match that character. @@ -567,6 +562,9 @@ Program Behavior See more lua patterns here: https://www.lua.org/manual/5.1/manual.html#5.4.1 + The ``use_manifests`` script option makes mpv use the master manifest URL for + formats like HLS and DASH, if available, allowing for video/audio selection + in runtime. It's disabled ("no") by default for performance reasons. ``--ytdl-format=<best|worst|mp4|webm|...>`` Video format/quality that is directly passed to youtube-dl. The possible @@ -751,7 +749,7 @@ Video likely works with Intel GPUs only. It also requires the opengl EGL backend. The ``cuda`` and ``cuda-copy`` modes provides deinterlacing in the decoder - which is useful as there is no other deinterlacing mechanism in the opengl + which is useful as there is no other deinterlacing mechanism in the gpu output path. To use this deinterlacing you must pass the option: ``vd-lavc-o=deint=[weave|bob|adaptive]``. Pass ``weave`` (or leave the option unset) to not attempt any @@ -780,6 +778,11 @@ Video codecs. See ``--hwdec-codecs`` to enable hardware decoding for more codecs. + .. note:: + + Most non-copy methods only work with the OpenGL GPU backend. Currently, + only the ``nvdec`` and ``cuda`` methods work with Vulkan. + .. admonition:: Quality reduction with hardware decoding In theory, hardware decoding does not reduce video quality (at least @@ -889,14 +892,18 @@ Video format, with likely no advantages. ``--cuda-decode-device=<auto|0..>`` - Choose the GPU device used for decoding when using the ``cuda`` hwdec. + Choose the GPU device used for decoding when using the ``cuda`` or + ``nvdec`` hwdecs with the OpenGL GPU backend. - By default, the device that is being used to provide OpenGL output will + By default, the device that is being used to provide ``gpu`` output will also be used for decoding (and in the vast majority of cases, only one GPU will be present). - Note that when using the ``cuda-copy`` hwdec, a different option must be - passed: ``--vd-lavc-o=gpu=<0..>``. + Note that when using the ``cuda-copy`` or ``nvdec-copy`` hwdec, a + different option must be passed: ``--vd-lavc-o=gpu=<0..>``. + + Note that this option is not available with the Vulkan GPU backend. With + Vulkan, decoding must always happen on the display device. ``--vaapi-device=<device file>`` Choose the DRM device for ``vaapi-copy``. This should be the path to a @@ -4246,11 +4253,6 @@ The following video options are currently all specific to ``--vo=gpu`` and will reproduce the source image perfectly if no scaling is performed. Enabled by default. Note that this option never affects ``--cscale``. -``--linear-scaling`` - Scale in linear light. It should only be used with a - ``--fbo-format`` that has at least 16 bit precision. This option - has no effect on HDR content. - ``--correct-downscaling`` When using convolution based filters, extend the filter size when downscaling. Increases quality, but reduces performance while downscaling. @@ -4259,6 +4261,32 @@ The following video options are currently all specific to ``--vo=gpu`` and better than without it) since it will extend the size to match only the milder of the scale factors between the axes. +``--linear-downscaling`` + Scale in linear light when downscaling. It should only be used with a + ``--fbo-format`` that has at least 16 bit precision. This option + has no effect on HDR content. + +``--linear-upscaling`` + Scale in linear light when upscaling. Like ``--linear-downscaling``, it + should only be used with a ``--fbo-format`` that has at least 16 bits + precisions. This is not usually recommended except for testing/specific + purposes. Users are advised to either enable ``--sigmoid-upscaling`` or + keep both options disabled (i.e. scaling in gamma light). + +``--sigmoid-upscaling`` + When upscaling, use a sigmoidal color transform to avoid emphasizing + ringing artifacts. This is incompatible with and replaces + ``--linear-upscaling``. (Note that sigmoidization also requires + linearization, so the ``LINEAR`` rendering step fires in both cases) + +``--sigmoid-center`` + The center of the sigmoid curve used for ``--sigmoid-upscaling``, must be a + float between 0.0 and 1.0. Defaults to 0.75 if not specified. + +``--sigmoid-slope`` + The slope of the sigmoid curve used for ``--sigmoid-upscaling``, must be a + float between 1.0 and 20.0. Defaults to 6.5 if not specified. + ``--interpolation`` Reduce stuttering caused by mismatches in the video fps and display refresh rate (also known as judder). @@ -4425,18 +4453,19 @@ The following video options are currently all specific to ``--vo=gpu`` and ``--spirv-compiler=<compiler>`` Controls which compiler is used to translate GLSL to SPIR-V. This is - (currently) only relevant for ``--gpu-api=vulkan``. The possible choices - are: + (currently) only relevant for ``--gpu-api=vulkan`` and `--gpu-api=d3d11`. + The possible choices are currently only: auto Use the first available compiler. (Default) shaderc Use libshaderc, which is an API wrapper around glslang. This is generally the most preferred, if available. - nvidia - Use nvidia's built-in compiler. Only works for nvidia GPUs. Can be - buggy, but also supports some features glslang does not. Only works - with vulkan. + + .. note:: + + This option is deprecated, since there is only one reasonable value. + It may be removed in the future. ``--glsl-shaders=<file-list>`` Custom GLSL hooks. These are a flexible way to add custom fragment shaders, @@ -4647,7 +4676,8 @@ The following video options are currently all specific to ``--vo=gpu`` and LINEAR (fixed) Linear light image, before scaling. This only fires when - ``--linear-scaling`` is in effect. + ``--linear-upscaling``, ``--linear-downscaling`` or + ``--sigmoid-upscaling`` is in effect. SIGMOID (fixed) Sigmoidized light, before scaling. This only fires when @@ -4704,18 +4734,6 @@ The following video options are currently all specific to ``--vo=gpu`` and remaining quantization artifacts. Higher numbers add more noise. (Default 48) -``--sigmoid-upscaling`` - When upscaling, use a sigmoidal color transform to avoid emphasizing - ringing artifacts. This also implies ``--linear-scaling``. - -``--sigmoid-center`` - The center of the sigmoid curve used for ``--sigmoid-upscaling``, must be a - float between 0.0 and 1.0. Defaults to 0.75 if not specified. - -``--sigmoid-slope`` - The slope of the sigmoid curve used for ``--sigmoid-upscaling``, must be a - float between 1.0 and 20.0. Defaults to 6.5 if not specified. - ``--sharpen=<value>`` If set to a value other than 0, enable an unsharp masking filter. Positive values will sharpen the image (but add more ringing and aliasing). Negative @@ -4813,6 +4831,15 @@ The following video options are currently all specific to ``--vo=gpu`` and OS X only. +``--cocoa-cb-sw-renderer=<yes|no|auto>`` + Use the Apple Software Renderer when using cocoa-cb (default: auto). If set + to ``no`` the software renderer is never used and instead fails when a the + usual pixel format could not be created, ``yes`` will always only use the + software renderer, and ``auto`` only falls back to the software renderer + when the usual pixel format couldn't be created. + + OS X only. + ``--macos-title-bar-style=<dark|ultradark|light|mediumlight|auto>`` Sets the styling of the title bar (default: dark). OS X and cocoa-cb only @@ -4936,9 +4963,12 @@ The following video options are currently all specific to ``--vo=gpu`` and Selects the internal format of textures used for FBOs. The format can influence performance and quality of the video output. ``fmt`` can be one of: rgb8, rgb10, rgb10_a2, rgb16, rgb16f, rgb32f, rgba12, rgba16, rgba16f, - rgba16hf, rgba32f. Default: ``auto``, which maps to rgba16 on desktop GL, - and rgba16f or rgb10_a2 on GLES (e.g. ANGLE), unless GL_EXT_texture_norm16 - is available. + rgba16hf, rgba32f. + + Default: ``auto``, which first attempts to utilize 16bit float + (rgba16f, rgba16hf), and falls back to rgba16 if those are not available. + Finally, attempts to utilize rgb10_a2 or rgba8 if all of the previous formats + are not available. ``--gamma-factor=<0.1..2.0>`` Set an additional raw gamma factor (default: 1.0). If gamma is adjusted in @@ -5103,7 +5133,7 @@ The following video options are currently all specific to ``--vo=gpu`` and desaturating everything. Developed by John Hable for use in video games. Use this when you care about detail preservation more than color/brightness accuracy. This is roughly equivalent to - ``--hdr-tone-mapping=reinhard --tone-mapping-param=0.24``. If possible, + ``--tone-mapping=reinhard --tone-mapping-param=0.24``. If possible, you should also enable ``--hdr-compute-peak`` for the best results. (Default) gamma |