add .ass output

whisperx/utils.py

@@ -1,5 +1,5 @@
 import zlib
-from typing import Iterator, TextIO
+from typing import Iterator, TextIO, Tuple, List
 
 
 def exact_div(x, y):
@@ -86,3 +86,138 @@ def write_srt(transcript: Iterator[dict], file: TextIO):
             file=file,
             flush=True,
         )
+
+
+def write_ass(transcript: Iterator[dict], file: TextIO,
+            color: str = None, underline=True,
+            prefmt: str = None, suffmt: str = None,
+            font: str = None, font_size: int = 24,
+            strip=True, **kwargs):
+    """
+    Credit: https://github.com/jianfch/stable-ts/blob/ff79549bd01f764427879f07ecd626c46a9a430a/stable_whisper/text_output.py
+        Generate Advanced SubStation Alpha (ASS) file from results to
+    display both phrase-level & word-level timestamp simultaneously by:
+     -using segment-level timestamps display phrases as usual
+     -using word-level timestamps change formats (e.g. color/underline) of the word in the displayed segment
+    Note: ass file is used in the same way as srt, vtt, etc.
+    Parameters
+    ----------
+    res: dict
+        results from modified model
+    ass_path: str
+        output path (e.g. caption.ass)
+    color: str
+        color code for a word at its corresponding timestamp
+        <bbggrr> reverse order hexadecimal RGB value (e.g. FF0000 is full intensity blue. Default: 00FF00)
+    underline: bool
+        whether to underline a word at its corresponding timestamp
+    prefmt: str
+        used to specify format for word-level timestamps (must be use with 'suffmt' and overrides 'color'&'underline')
+        appears as such in the .ass file:
+            Hi, {<prefmt>}how{<suffmt>} are you?
+        reference [Appendix A: Style override codes] in http://www.tcax.org/docs/ass-specs.htm
+    suffmt: str
+        used to specify format for word-level timestamps (must be use with 'prefmt' and overrides 'color'&'underline')
+        appears as such in the .ass file:
+            Hi, {<prefmt>}how{<suffmt>} are you?
+        reference [Appendix A: Style override codes] in http://www.tcax.org/docs/ass-specs.htm
+    font: str
+        word font (default: Arial)
+    font_size: int
+        word font size (default: 48)
+    kwargs:
+        used for format styles:
+        'Name', 'Fontname', 'Fontsize', 'PrimaryColour', 'SecondaryColour', 'OutlineColour', 'BackColour', 'Bold',
+        'Italic', 'Underline', 'StrikeOut', 'ScaleX', 'ScaleY', 'Spacing', 'Angle', 'BorderStyle', 'Outline',
+        'Shadow', 'Alignment', 'MarginL', 'MarginR', 'MarginV', 'Encoding'
+
+    """
+
+    fmt_style_dict = {'Name': 'Default', 'Fontname': 'Arial', 'Fontsize': '48', 'PrimaryColour': '&Hffffff',
+                    'SecondaryColour': '&Hffffff', 'OutlineColour': '&H0', 'BackColour': '&H0', 'Bold': '0',
+                    'Italic': '0', 'Underline': '0', 'StrikeOut': '0', 'ScaleX': '100', 'ScaleY': '100',
+                    'Spacing': '0', 'Angle': '0', 'BorderStyle': '1', 'Outline': '1', 'Shadow': '0',
+                    'Alignment': '2', 'MarginL': '10', 'MarginR': '10', 'MarginV': '10', 'Encoding': '0'}
+
+    for k, v in filter(lambda x: 'colour' in x[0].lower() and not str(x[1]).startswith('&H'), kwargs.items()):
+        kwargs[k] = f'&H{kwargs[k]}'
+
+    fmt_style_dict.update((k, v) for k, v in kwargs.items() if k in fmt_style_dict)
+
+    if font:
+        fmt_style_dict.update(Fontname=font)
+    if font_size:
+        fmt_style_dict.update(Fontsize=font_size)
+
+    fmts = f'Format: {", ".join(map(str, fmt_style_dict.keys()))}'
+
+    styles = f'Style: {",".join(map(str, fmt_style_dict.values()))}'
+
+    ass_str = f'[Script Info]\nScriptType: v4.00+\nPlayResX: 384\nPlayResY: 288\nScaledBorderAndShadow: yes\n\n' \
+            f'[V4+ Styles]\n{fmts}\n{styles}\n\n' \
+            f'[Events]\nFormat: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text\n\n'
+
+    if prefmt or suffmt:
+        if suffmt:
+            assert prefmt, 'prefmt must be used along with suffmt'
+        else:
+            suffmt = r'\r'
+    else:
+        if not color:
+            color = 'HFF00'
+        underline_code = r'\u1' if underline else ''
+
+        prefmt = r'{\1c&' + f'{color.upper()}&{underline_code}' + '}'
+        suffmt = r'{\r}'
+    
+    def secs_to_hhmmss(secs: Tuple[float, int]):
+        mm, ss = divmod(secs, 60)
+        hh, mm = divmod(mm, 60)
+        return f'{hh:0>1.0f}:{mm:0>2.0f}:{ss:0>2.2f}'
+
+
+    def dialogue(words: List[str], idx, start, end) -> str:
+        text = ''.join(f' {prefmt}{word}{suffmt}'
+                        # if not word.startswith(' ') or word == ' ' else
+                        # f' {prefmt}{word.strip()}{suffmt}')
+                       if curr_idx == idx else
+                       f' {word}'
+                       for curr_idx, word in enumerate(words))
+        return f"Dialogue: 0,{secs_to_hhmmss(start)},{secs_to_hhmmss(end)}," \
+               f"Default,,0,0,0,,{text.strip() if strip else text}"
+    
+
+    ass_arr = []
+
+    for segment in transcript:
+        curr_words = [wrd['text'] for wrd in segment['word-level']]
+        prev = segment['word-level'][0]['start']
+        for wdx, word in enumerate(segment['word-level']):
+            if word['start'] is not None:
+
+                # fill gap between previous word
+                if word['start'] > prev:
+                    filler_ts = {
+                    "words": curr_words,
+                    "start": prev,
+                    "end": word['start'],
+                    "idx": -1
+                    }
+                    ass_arr.append(filler_ts)
+
+                # highlight current word
+                f_word_ts = {
+                    "words": curr_words,
+                    "start": word['start'],
+                    "end": word['end'],
+                    "idx": wdx
+                }
+                ass_arr.append(f_word_ts)
+
+                prev = word['end']
+
+            
+
+    ass_str += '\n'.join(map(lambda x: dialogue(**x), ass_arr))
+
+    file.write(ass_str)