sup2srt

Convert SUP graphic subtitles to text-based SRT format with Tesseract.

Disclaimer

Note: Code changes after the 1.0.6 release have been AI-assisted.

Requirements

• libtiff
• libtiffxx
• leptonica
• tesseract
• libav/ffmpeg
• CMake

Build

1. Clone the repo

   git clone https://github.com/retrontology/sup2srt
   

2. Enter the repo and create the build directory

   cd sup2srt
   mkdir build
   

3. Enter the build directory and prepare the build

   cd build
   cmake ..
   

4. Build the program

   make -j ${nproc}
   

Install (optional)

1. Install the program

   sudo make install
   

Usage

usage: sup2srt [-h] [-vST] [-t track] [-l language] [-o output] input
  -h:  	        Display this help menu
  -v:  	        Display program Version
  -V:  	        Verbose - output srt as it's being written
  -T:  	        Dump TIFF images extracted from the PGS file to disk
  -S:  	        Write SUP file extracted from mkv to disk (only used when an mkv or m2ts is input)
  -t track:  	Select track to extract from mkv. Can be multiple tracks separated by a comma (must be used when an mkv or m2ts is input)
  -l language:  Select Tesseract language according to ISO 639-2/T. If not specified and an mkv or m2ts is input, the program will try to use the track metadata. Must be used when a binary SUP file is input
  -o:  	        Output file (if not specified the file will be output to the same dir as the input).
  input:  	    file to parse SUP stream. Can either be a binary SUP file or an mkv/m2ts. If the file doesn't end in .mkv or .m2ts, it will assume it is a binary SUP file.


usage: sup2disk [-hv] [-t track] input
  -h:  	     Display this help menu
  -v:  	     Display program Version
  -t track:  Select track to extract from mkv. Can be multiple tracks separated by a comma (must be used when an mkv is input)
  input:  	 file to parse SUP stream. Must be an mkv  	

Docker Usage

Requirements

Install docker, podman or containerd.

Build the image

docker build -t sup2srt .

Optional: include additional Tesseract languages at build time:

docker build --build-arg TESSERACT_LANGS="eng spa deu" -t sup2srt .

To install all Tesseract languages, use TESSERACT_LANGS="all".

Language codes: https://github.com/tesseract-ocr/tessdata

Run sup2srt

The entrypoint runs sup2srt by default, so you can pass its arguments directly.

docker run --rm -v /path/to/media:/media sup2srt /media/movie-title/eng.sup -l eng

Run sup2disk

If the first argument is sup2disk, the entrypoint runs that instead.

docker run --rm -v /path/to/media:/media sup2srt sup2disk /media/moviefolder/movie.mkv -t 4

Optional: match host file ownership

By default the container runs as UID:GID 1000:1000. If you need files on a bind mount to be owned by your host user, run with:

docker run --user $(id -u):$(id -g) -v /path/to/media:/media sup2srt /media/movie-title/eng.sup -l eng

Debug shell

Use --entrypoint /bin/bash to bypass the entrypoint.

docker run -it --entrypoint /bin/bash -v /path/to/media:/media sup2srt