ttml2ssa

Convert TTML/XML/DFXP/VTT/SRT subtitles used by Netflix, HBO, Disney+, Prime Video and others to SRT, SSA/ASS or VTT format.

Note: ttml2ssa is not a full-featured TTML-to-SRT converter and only works on a small subset of TTML documents. Namely, documents that follow the formats seen on the aforementioned streaming services.

Usage

positional arguments:
  input-files           subtitle files

optional arguments:
  -h, --help            show this help message and exit
  -o [output file], --output [output file]
                        output file with extension srt, ssa or ass
  -v, --version         displays the version of this application and exits
  --shift [ms]          increases all timestamps by the specified value. You
                        can use a negative number
  --scale-factor [number or label]
                        multiplies the timestamps by this mumber. You can use
                        also any of these labels: NTSC2PAL (23.976/25),
                        PAL2NTSC (25/23.976), NTSC2FILM (23.976/24), PAL2FILM
                        (25/24), FILM2NTSC (24/23.976), FILM2PAL (24/25)
  -l [language code], --lang [language code]
                        subtitle language code ('en', 'es', etc,). It's used
                        by the language filter
  -a [number], --video-aspect [number]
                        the aspect ratio of the video. It's used to calculate
                        the correct PlayResY and PlayResY options for the SSA
                        style. Default: 16/9
  --no-cosmetic-fix     disables a filter which makes some cosmetic changes,
                        like adding a space after the symbol '-' and the next
                        word
  --no-language-fix     disables a filter which can fix some wrong characters
                        in some specific languages
  --no-fix-amazon-errors
                        don't try to fix errors that may occur in subtitles
                        from Amazon
  -c [encoding], --charset [encoding]
                        the encoding of the input file
  --output-format [srt, ssa or vtt]
                        output format to use if an output file has not been
                        set
  -srt, --srt           equivalent to --output_format srt
  -vtt, --vtt           equivalent to --output_format vtt
  --no-italics          removes the italic tags from the dialog texts
  --no-top              all dialog will be displayed at the bottom of the
                        screen
  --ssa-fontname [font], -f [font]
                        the font name (default: arial)
  --ssa-fontsize [number], -fs [number]
                        the font size (default: 50)
  --ssa-primary-color [color], -pc [color]
                        the primary color in format AABBGGRR or color name
                        (default: white)
  --ssa-back-color [color], -bc [color]
                        the back color in format AABBGGRR or color name
                        (default: 40000000)
  --ssa-outline-color [color], -oc [color]
                        the outline color in format AABBGGRR or color name
                        (default: black)
  --ssa-bold, -b        the font will be in bold
  --ssa-italic, -i      the font will be in italic
  --no-timestamp-manipulation
                        no changes will be made on timestamps
  --no-fix-collisions   collisions on timestamps won't be fixed
  --no-remove-duplicated
                        duplicated texts won't be removed
  --min-sep-ms [ms]     minimum separation (in ms) between framestamps
                        (SSA/ASS output only)

If multiple subtitle files are supplied, the application will create the output files using the input filenames, replacing the extension with srt or ssa. Be carefull, if a file with the same output name already exists the application will overwrite it without asking.

If an output filename is specified with the -o option, then only the first of the input files will be converted, using the output filename.

Common use cases

Simple conversion:

ttml2ssa subtitle_from_netflix.xml -o subtitle.ssa

or

ttml2ssa subtitle_from_netflix.xml -o subtitle.srt

Shift everything forward by 2 secs:

ttml2ssa --shift 2000 subtitle_from_netflix.xml -o subtitle.srt

Convert from one frame rate to another:

ttml2ssa --scale-factor 23.976/25 subtitle_from_netflix.xml -o subtitle.srt

or

ttml2ssa --scale-factor NTSC2PAL subtitle_from_netflix.xml -o subtitle.srt

Those examples will convert a subtitle made for a movie at 23.976 frames per second for a version sped up to 25 fps (very common in Europe).

Convert two subtitles:

ttml2ssa subtitle1.xml subtitle2.xml

That will convert the subtitles to subtitle1.ssa and subtitle2.ssa

Convert all subtitles in a folder:

ttml2ssa *.xml

All files with extersion xml will be converted to ssa.

Library

ttml2ssa can also be used as a library for other applications.

Simple example:

from ttml2ssa import Ttml2Ssa

input_file = 'subtitle.xml'
ttml = Ttml2Ssa()
ttml.parse_subtitle_file(input_file)
ttml.write2file('output.srt') # Saves as SRT
ttml.write2file('output.ssa') # Saves as SSA

Without loading or writing files:

from ttml2ssa import Ttml2Ssa

ttml_document = 'THIS STRING SHOULD CONTAIN AN XML SUBTITLE DOCUMENT'
ttml = Ttml2Ssa()
ttml.parse_ttml_from_string(ttml_document)
result = ttml.generate_srt()
# or
result = ttml.generate_ssa()

Addon for Kodi

There's also an addon for Kodi (script.module.ttml2ssa), which other addons can use to convert subtitles to SRT or SSA. It provides a configuration dialog where the user can configure the SSA style and other stuff.

You can use it with something like this:

from ttml2ssa import Ttml2SsaAddon
...

ttml = Ttml2SsaAddon()
ttml.parse_subtitle_file(input_file)
# or
ttml.parse_ttml_from_string(subtitle_in_a_string)

ttml.write2file('output.srt')
# or
ttml.write2file('output.ssa')

# or
result = ttml.generate_srt()
# or
result = ttml.generate_ssa()

To open the ttml2ssa configuration dialog, you can add this to your addon settings.xml:

<setting label="SSA Settings" type="action" id="ssa_settings" option="close" action="Addon.OpenSettings(script.module.ttml2ssa)"/>

Authors

ttml2ssa by Paco8, based on ttml2srt by yuppity. License: LGPL-2.1