Skip to content

styles

CABIN_PRESET = [cabin_default, *get_complimenting_styles(cabin_default)] module-attribute

GJM_GANDHI_PRESET = [gandhi_default, *get_complimenting_styles(gandhi_default)] module-attribute

LATO_PRESET = [lato_default, *get_complimenting_styles(lato_default)] module-attribute

MERRIWEATHER_PRESET = [merriweather_default, *get_complimenting_styles(merriweather_default)] module-attribute

__all__ = ['gandhi_default', 'GJM_GANDHI_PRESET', 'cabin_default', 'CABIN_PRESET', 'lato_default', 'LATO_PRESET', 'merriweather_default', 'MERRIWEATHER_PRESET', 'edit_style', 'resize_preset', 'default_style_args', 'get_complimenting_styles'] module-attribute

cabin_default = Style(name='Default', fontname='Cabin', fontsize=85.0, outline=3.2, shadow=1.5, margin_l=180, margin_r=180, margin_v=50, **default_style_args) module-attribute

default_style_args: dict[str, Any] = {'bold': True, 'italic': False, 'underline': False, 'strike_out': False, 'scale_x': 100.0, 'scale_y': 100.0, 'spacing': 0.0, 'angle': 0.0, 'encoding': 1, 'alignment': 2, 'border_style': 1, 'primary_color': Color(r=255, g=255, b=255, a=0), 'secondary_color': Color(r=255, g=0, b=0, a=0), 'outline_color': Color(r=0, g=0, b=0, a=0), 'back_color': Color(r=0, g=0, b=0, a=160)} module-attribute

gandhi_default = Style(name='Default', fontname='Gandhi Sans', fontsize=75.0, outline=3.6, shadow=1.5, margin_l=180, margin_r=180, margin_v=55, **default_style_args) module-attribute

lato_default = Style(name='Default', fontname='Lato', fontsize=75.0, outline=3.2, shadow=1.5, margin_l=180, margin_r=180, margin_v=55, **default_style_args) module-attribute

merriweather_default = Style(name='Default', fontname='Merriweather', fontsize=78.0, outline=3.3, shadow=1.5, margin_l=180, margin_r=180, margin_v=55, **default_style_args) module-attribute

edit_style

Copies a style to set a new name and other arguments via kwargs

Source code in muxtools/subtitle/styles.py 
17
18
19
20
21
22
23
24
25
def edit_style(style: Style, name: str, **kwargs) -> Style:
    """
    Copies a style to set a new name and other arguments via kwargs
    """
    style = deepcopy(style)
    style.name = name
    for key, val in kwargs.items():
        setattr(style, key, val)
    return style

get_complimenting_styles

Generates colored Alt/Overlap and Flashback styles for a given style.

Source code in muxtools/subtitle/styles.py 
28
29
30
31
32
33
34
35
36
def get_complimenting_styles(style: Style) -> list[Style]:
    """
    Generates colored Alt/Overlap and Flashback styles for a given style.
    """
    return [
        edit_style(style, "Overlap", outline_color=Color(r=0x15, g=0x3E, b=0x74, a=0x00)),
        edit_style(style, "Alt", outline_color=Color(r=0x15, g=0x3E, b=0x74, a=0x00)),
        edit_style(style, "Flashback", outline_color=Color(r=0x12, g=0x3E, b=0x01, a=0x00)),
    ]

resize_preset

Resize a list of styles to match a resolution.

This assumes the passed styles are for a 1080p script.

Parameters:

Name Type Description Default
preset list[Style]

List of styles to resize

 required
target_height int | Document

Either a height integer or an ass document to get the height from

 360

Returns:

Type Description
list[Style]

A list of deepcopied styles. This doesn't edit the input styles.
Source code in muxtools/subtitle/styles.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def resize_preset(preset: list[Style], target_height: int | Document = 360) -> list[Style]:
    """
    Resize a list of styles to match a resolution.\n
    This assumes the passed styles are for a 1080p script.

    :param preset:          List of styles to resize
    :param target_height:   Either a height integer or an ass document to get the height from

    :return:                A list of deepcopied styles. This doesn't edit the input styles.
    """
    if isinstance(target_height, Document):
        target_height = int(target_height.info.get("PlayResY", 360))

    styles = list[Style]()
    multiplier = target_height / 1080
    for style in preset:
        style = deepcopy(style)
        setattr(style, "fontsize", int(getattr(style, "fontsize", 75.0) * multiplier))
        setattr(style, "margin_l", int(getattr(style, "margin_l", 180) * multiplier))
        setattr(style, "margin_r", int(getattr(style, "margin_r", 180) * multiplier))
        setattr(style, "margin_v", int(getattr(style, "margin_v", 55) * multiplier))
        setattr(style, "shadow", round(getattr(style, "shadow", 1.5) * multiplier, 1))
        setattr(style, "outline", round(getattr(style, "outline", 3.2) * multiplier, 1))
        styles.append(style)
    return styles