History

sub: add (sub/osd)-border-style; renaming sub options

Misaki Kasumi committed 2 years ago

Commit f2e71461 parent c0f5d239 files · +98 −70Browse files

Showing the changes to DOCS (2 of 9 files). Show all

Unified · Split

2 files
  1. DOCS/interface-changes/sub-border-style.txt +6 −0
  2. DOCS/man/options.rst +59 −36
DOCS/interface-changes/sub-border-style.txt+6−0
@@ -0,0 +1,6 @@
1+add `--sub-border-style` and `--osd-border-style` options
2+the border style does not depend on `--(sub/osd)-border-color` and `--(sub/osd)-shadow-color`; now it depends solely on `--(sub/osd)-border-style`
3+make `--(sub/osd)-border-color` an alias of `--(sub/osd)-outline-color`
4+make `--(sub/osd)-border-size` an alias of `--(sub/osd)-outline-size`
5+make `--(sub/osd)-shadow-color` an alias of `--(sub/osd)-back-color`; they cannot both be set now
6+make `--osd-bar-border-size` an alias of `--osd-bar-outline-size`
DOCS/man/options.rst+59−36
@@ -2832,10 +2832,6 @@ Subtitles · 2831 unmodified lines
28322832
28332833 Default: 55.
28342834
2835−``--sub-back-color=<color>``
2836− See ``--sub-color``. Color used for sub text background. You can use
2837− ``--sub-shadow-offset`` to change its size relative to the text.
2838−
28392835 ``--sub-blur=<0..20.0>``
28402836 Gaussian blur factor applied to the sub font border.
28412837 0 means no blur applied (default).
@@ -2846,15 +2842,48 @@ Subtitles · 4 unmodified lines
28462842 ``--sub-italic=<yes|no>``
28472843 Format text on italic.
28482844
2849−``--sub-border-color=<color>``
2850− See ``--sub-color``. Color used for the sub font border.
2845+``--sub-outline-color=<color>``
2846+ See ``--sub-color``. Color used for the sub font outline.
2847+
2848+ ``--sub-border-color`` is an alias for ``--sub-outline-color``.
2849+
2850+``--sub-back-color=<color>``
2851+ See ``--sub-color``. Color used for sub text background.
2852+
2853+ ``--sub-shadow-color`` is an alias for ``--sub-back-color``.
2854+
2855+``--sub-outline-size=<size>``
2856+ Size of the sub font outline in scaled pixels (see ``--sub-font-size``
2857+ for details). A value of 0 disables outlines.
28512858
2852−``--sub-border-size=<size>``
2853− Size of the sub font border in scaled pixels (see ``--sub-font-size``
2854− for details). A value of 0 disables borders.
2859+ ``--sub-border-size`` is an alias for ``--sub-outline-size``.
28552860
28562861 Default: 3.
28572862
2863+``--sub-border-style=<outline-and-shadow|opaque-box|background-box>``
2864+ The style of the border.
2865+
2866+ - ``outline-and-shadow``: draw outline and shadow.
2867+ The size of the outline is determined by ``--sub-outline-size``,
2868+ and the offset of the shadow is determined by ``--sub-shadow-offset``.
2869+ The outline is colored by ``--sub-outline-color``,
2870+ and the shadow is colored by ``--sub-back-color``.
2871+ This corresponds to ``BorderStyle=1`` in the ASS spec.
2872+ - ``opaque-box``: draw outline and shadow as opaque boxes that tightly wrap each lines of text.
2873+ The margin of the outline opaque box is determined by ``--sub-outline-size``,
2874+ and the offset of the shadow opaque box is determined by ``--sub-shadow-offset``.
2875+ The outline opaque box is colored by ``--sub-outline-color``,
2876+ and the shadow opaque box is colored by ``--sub-back-color``.
2877+ Despite its name, the opaque box can be semi-transparent.
2878+ This corresponds to ``BorderStyle=3`` in the ASS spec.
2879+ - ``background-box``: draw a background box that bounds all lines of text.
2880+ The background box is colored by ``--sub-back-color``,
2881+ and the margin of the background box is determined by ``--sub-shadow-offset``.
2882+ The behavior of the outline is the same as the ``outline-and-shadow`` style.
2883+ This corresponds to ``BorderStyle=4``, which is a libass-specific extension.
2884+
2885+ Default: ``outline-and-shadow``.
2886+
28582887 ``--sub-color=<color>``
28592888 Specify the color used for unstyled text subtitles.
28602889
@@ -2924,15 +2953,6 @@ Subtitles · 63 unmodified lines
29242953 if ``--sub-ass-override`` is not set to ``no``.
29252954 Default: ``no``.
29262955
2927−``--sub-shadow-color=<color>``
2928− See ``--sub-color``. Color used for sub text shadow.
2929−
2930− .. note::
2931−
2932− ignored when ``--sub-back-color`` is
2933− specified (or more exactly: when that option is not set to completely
2934− transparent).
2935−
29362956 ``--sub-shadow-offset=<size>``
29372957 Displacement of the sub text shadow in scaled pixels (see
29382958 ``--sub-font-size`` for details). A value of 0 disables shadows.
@@ -4411,14 +4431,13 @@ OSD · 1472 unmodified lines
44114431 ``--osd-bar-h=<0.1-50>``
44124432 Height of the OSD bar, in percentage of the screen height (default: 3.125).
44134433
4414−``--osd-bar-border-size=<size>``
4415− Size of the border of the OSD bar in scaled pixels (see ``--sub-font-size``
4434+``--osd-bar-outline-size=<size>``
4435+ Size of the outline of the OSD bar in scaled pixels (see ``--sub-font-size``
44164436 for details).
44174437
4418− Default: 0.5.
4438+ ``--osd-bar-border-size`` is an alias for ``--osd-bar-outline-size``.
44194439
4420−``--osd-back-color=<color>``
4421− See ``--sub-color``. Color used for OSD text background.
4440+ Default: 0.5.
44224441
44234442 ``--osd-blur=<0..20.0>``
44244443 Gaussian blur factor applied to the OSD font border.
@@ -4430,15 +4449,27 @@ OSD · 5 unmodified lines
44304449 ``--osd-italic=<yes|no>``
44314450 Format text on italic.
44324451
4433−``--osd-border-color=<color>``
4434− See ``--sub-color``. Color used for the OSD font border.
4452+``--osd-outline-color=<color>``
4453+ See ``--sub-color``. Color used for the OSD font outline.
4454+
4455+ ``--osd-border-color`` is an alias for ``--osd-outline-color``.
4456+
4457+``--osd-back-color=<color>``
4458+ See ``--sub-color``. Color used for OSD text background.
4459+
4460+ ``--osd-shadow-color`` is an alias for ``--osd-back-color``.
44354461
4436−``--osd-border-size=<size>``
4437− Size of the OSD font border in scaled pixels (see ``--sub-font-size``
4438− for details). A value of 0 disables borders.
4462+``--osd-outline-size=<size>``
4463+ Size of the OSD font outline in scaled pixels (see ``--sub-font-size``
4464+ for details). A value of 0 disables outlines.
4465+
4466+ ``--osd-border-size`` is an alias for ``--osd-outline-size``.
44394467
44404468 Default: 3.
44414469
4470+``--osd-border-style=<outline-and-shadow|opaque-box|background-box>``
4471+ See ``--sub-border-style``. Style used for OSD text border.
4472+
44424473 ``--osd-color=<color>``
44434474 Specify the color used for OSD.
44444475 See ``--sub-color`` for details.
@@ -4495,14 +4526,6 @@ OSD · 50 unmodified lines
44954526 respect the value of this option when deciding whether the elements
44964527 are scaled with window size or not.
44974528
4498−``--osd-shadow-color=<color>``
4499− See ``--sub-color``. Color used for OSD shadow.
4500−
4501− .. note::
4502−
4503− Ignored when ``--osd-back-color`` is specified (or more exactly: when
4504− that option is not set to completely transparent).
4505−
45064529 ``--osd-shadow-offset=<size>``
45074530 Displacement of the OSD shadow in scaled pixels (see
45084531 ``--sub-font-size`` for details). A value of 0 disables shadows.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t