RepoMirrors
/
mpv
mirror of https://github.com/mpv-player/mpv
1
0
Fork 0
Code Issues Releases Wiki Activity

DOCS/man/options: clarify subtitle scale options 

The current documentation of sub-scale-by-window and sub-scale-with-window
doesn't sufficiently convey what these options do exactly. Specifically,
the described effects of disabling one option is only true when the other
option is not disabled. The "clarification" of sub-scale-with-window option
only adds more confusion, when the effect of that option is already told
in more detail before (it scaled with window instead of video).

Clarify this by listing the effects of all combinations of these options.
This commit is contained in:
nanahi 2024-06-10 11:42:38 -04:00 committed by Kacper Michajłow
parent 42e9f302df
commit b59ac04db9
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
DOCS/man/options.rst
View File

@ -2387,27 +2387,28 @@ Subtitles
``--sub-scale-by-window=<yes|no>``
Whether to scale subtitles with the window size (default: yes). If this is
disabled, changing the window size won't change the subtitle font size.
disabled while ``--sub-scale-with-window`` is set to yes, changing the window
size won't change the subtitle font size.
Affects plain text subtitles only (or ASS if ``--sub-ass-override`` is set
high enough).
``--sub-scale-with-window=<yes|no>``
Make the subtitle font size relative to the window, instead of the video.
This is useful if you always want the same font size, even if the video
doesn't cover the window fully, e.g. because screen aspect and window
aspect mismatch (and the player adds black bars).
Default: yes.
This option is misnamed. The difference to the confusingly similar sounding
option ``--sub-scale-by-window`` is that ``--sub-scale-with-window`` still
scales with the approximate window size, while the other option disables
this scaling.
Make the subtitle font size relative to the window (default: yes). If this is
disabled while ``--sub-scale-by-window`` is set to yes, the subtitle font
size is scaled relative to the video size instead.
Affects plain text subtitles only (or ASS if ``--sub-ass-override`` is set
high enough).
.. note::
By default, the subtitle font size is scaled with the window size.
To make the font size constant, set only ``--sub-scale-by-window`` to no.
To make the font size scale with video size instead, set only
``--sub-scale-with-window`` to no.
It's not meaningful to set both options to no.
``--sub-ass-scale-with-window=<yes|no>``
Like ``--sub-scale-with-window``, but affects subtitles in ASS format only.
Like ``--sub-scale``, this can break ASS subtitles.