diff options
Diffstat (limited to 'DOCS/man/options.rst')
| -rw-r--r-- | DOCS/man/options.rst | 89 |
1 files changed, 67 insertions, 22 deletions
diff --git a/DOCS/man/options.rst b/DOCS/man/options.rst index f384123f6d..e3eb46495b 100644 --- a/DOCS/man/options.rst +++ b/DOCS/man/options.rst @@ -1092,7 +1092,7 @@ Video You can get the list of allowed codecs with ``mpv --vd=help``. Remove the prefix, e.g. instead of ``lavc:h264`` use ``h264``. - By default, this is set to ``h264,vc1,wmv3,hevc,mpeg2video,vp9``. Note that + By default, this is set to ``h264,vc1,hevc,vp9``. Note that the hardware acceleration special codecs like ``h264_vdpau`` are not relevant anymore, and in fact have been removed from Libav in this form. @@ -1326,8 +1326,10 @@ Audio Since mpv 0.18.1, this always controls the internal mixer (aka "softvol"). ``--replaygain=<no|track|album>`` - Adjust volume gain according to the track-gain or album-gain replaygain - value stored in the file metadata (default: no replaygain). + Adjust volume gain according to replaygain values stored in the file + metadata. With ``--replaygain=no`` (the default), perform no adjustment. + With ``--replaygain=track``, apply track gain. With ``--replaygain=album``, + apply album gain if present and fall back to track gain otherwise. ``--replaygain-preamp=<db>`` Pre-amplification gain in dB to apply to the selected replaygain gain @@ -3988,8 +3990,8 @@ Network DVB --- -``--dvbin-card=<1-4>`` - Specifies using card number 1-4 (default: 1). +``--dvbin-card=<0-15>`` + Specifies using card number 0-15 (default: 0). ``--dvbin-file=<filename>`` Instructs mpv to read the channels list from ``<filename>``. The default is @@ -5073,7 +5075,7 @@ The following video options are currently all specific to ``--vo=gpu`` and The user should independently guarantee this before using these signal formats for display. -``--target-peak=<nits>`` +``--target-peak=<auto|nits>`` Specifies the measured peak brightness of the output display, in cd/m^2 (AKA nits). The interpretation of this brightness depends on the configured ``--target-trc``. In all cases, it imposes a limit on the signal values @@ -5085,9 +5087,9 @@ The following video options are currently all specific to ``--vo=gpu`` and above 100 essentially causes the display to be treated as if it were an HDR display in disguise. (See the note below) - By default, the chosen peak defaults to an appropriate value based on the - TRC in use. For SDR curves, it defaults to 100. For HDR curves, it - defaults to 100 * the transfer function's nominal peak. + In ``auto`` mode (the default), the chosen peak is an appropriate value + based on the TRC in use. For SDR curves, it uses 100. For HDR curves, it + uses 100 * the transfer function's nominal peak. .. note:: @@ -5164,6 +5166,14 @@ The following video options are currently all specific to ``--vo=gpu`` and linear Specifies the scale factor to use while stretching. Defaults to 1.0. +``--tone-mapping-max-boost=<1.0..10.0>`` + Upper limit for how much the tone mapping algorithm is allowed to boost + the average brightness by over-exposing the image. The default value of 1.0 + allows no additional brightness boost. A value of 2.0 would allow + over-exposing by a factor of 2, and so on. Raising this setting can help + reveal details that would otherwise be hidden in dark scenes, but raising + it too high will make dark scenes appear unnaturally bright. + ``--hdr-compute-peak=<auto|yes|no>`` Compute the HDR peak and frame average brightness per-frame instead of relying on tagged metadata. These values are averaged over local regions as @@ -5174,17 +5184,50 @@ The following video options are currently all specific to ``--vo=gpu`` and The special value ``auto`` (default) will enable HDR peak computation automatically if compute shaders and SSBOs are supported. -``--tone-mapping-desaturate=<value>`` - Apply desaturation for highlights. The parameter essentially controls the - steepness of the desaturation curve. The higher the parameter, the more - aggressively colors will be desaturated. This setting helps prevent - unnaturally blown-out colors for super-highlights, by (smoothly) turning - into white instead. This makes images feel more natural, at the cost of - reducing information about out-of-range colors. - - The default of 0.5 provides a good balance. This value is weaker than the - ACES ODT curves' recommendation, but works better for most content in - practice. A setting of 0.0 disables this option. +``--hdr-peak-decay-rate=<1.0..1000.0>`` + The decay rate used for the HDR peak detection algorithm (default: 100.0). + This is only relevant when ``--hdr-compute-peak`` is enabled. Higher values + make the peak decay more slowly, leading to more stable values at the cost + of more "eye adaptation"-like effects (although this is mitigated somewhat + by ``--hdr-scene-threshold``). A value of 1.0 (the lowest possible) disables + all averaging, meaning each frame's value is used directly as measured, + but doing this is not recommended for "noisy" sources since it may lead + to excessive flicker. (In signal theory terms, this controls the time + constant "tau" of an IIR low pass filter) + +``--hdr-scene-threshold-low=<0.0..100.0>``, ``--hdr-scene-threshold-high=<0.0..100.0>`` + The lower and upper thresholds (in dB) for a brightness difference + to be considered a scene change (default: 5.5 low, 10.0 high). This is only + relevant when ``--hdr-compute-peak`` is enabled. Normally, small + fluctuations in the frame brightness are compensated for by the peak + averaging mechanism, but for large jumps in the brightness this can result + in the frame remaining too bright or too dark for up to several seconds, + depending on the value of ``--hdr-peak-decay-rate``. To counteract this, + when the brightness between the running average and the current frame + exceeds the low threshold, mpv will make the averaging filter more + aggressive, up to the limit of the high threshold (at which point the + filter becomes instant). + +``--tone-mapping-desaturate=<0.0..1.0>`` + Apply desaturation for highlights (default: 0.75). The parameter controls + the strength of the desaturation curve. A value of 0.0 completely disables + it, while a value of 1.0 means that overly bright colors will tend towards + white. (This is not always the case, especially not for highlights that are + near primary colors) + + Values in between apply progressively more/less aggressive desaturation. + This setting helps prevent unnaturally oversaturated colors for + super-highlights, by (smoothly) turning them into less saturated (per + channel tone mapped) colors instead. This makes images feel more natural, + at the cost of chromatic distortions for out-of-range colors. The default + value of 0.75 provides a good balance. Setting this to 0.0 preserves the + chromatic accuracy of the tone mapping process. + +``--tone-mapping-desaturate-exponent=<0.0..20.0>`` + This setting controls the exponent of the desaturation curve, which + controls how bright a color needs to be in order to start being + desaturated. The default of 1.5 provides a reasonable balance. Decreasing + this exponent makes the curve more aggressive. ``--gamut-warning`` If enabled, mpv will mark all clipped/out-of-gamut pixels that exceed a @@ -5245,12 +5288,14 @@ The following video options are currently all specific to ``--vo=gpu`` and Size of the 3D LUT generated from the ICC profile in each dimension. Default is 64x64x64. Sizes may range from 2 to 512. -``--icc-contrast=<0-1000000>`` +``--icc-contrast=<0-1000000|inf>`` Specifies an upper limit on the target device's contrast ratio. This is detected automatically from the profile if possible, but for some profiles it might be missing, causing the contrast to be assumed as infinite. As a result, video may appear darker than intended. This only affects BT.1886 - content. The default of 0 means no limit. + content. The default of 0 means no limit if the detected contrast is less + than 100000, and limits to 1000 otherwise. Use ``--icc-contrast=inf`` to + preserve the infinite contrast (most likely when using OLED displays). ``--blend-subtitles=<yes|video|no>`` Blend subtitles directly onto upscaled video frames, before interpolation |