Skip to content

Latest commit

 

History

History
84 lines (66 loc) · 4.5 KB

README.md

File metadata and controls

84 lines (66 loc) · 4.5 KB
Raw

Sushi Build Status

Automatic shifter for SRT and ASS subtitle based on audio streams.

Purpose

Imagine you've got a subtitle file synced to one video file, but you want to use these subtitles with some other video you've got via totally legal means. The common example is TV vs. BD releases, PAL vs. NTSC video and releases in different countries. In a lot of cases, subtitles won't match right away and you need to sync them.

The purpose of this script is to avoid all the hassle of manual syncing. It attempts to synchronize subtitles by finding similarities in audio streams. The script is very fast and can be used right when you want to watch something.

Downloads

The latest Windows binary release can always be found in the releases section. You need the 7z archive in the top entry.

How it works

You need to provide two audio files and a subtitle file that matches one of those files. For every line of the subtitles, the script will extract corresponding audio from the source audio stream and will try to find the closest similar pattern in the destination audio stream, obtaining a shift value which is later applied to the subtitles.

Detailed explanation of Sushi workflow and description of command-line arguments can be found in the wiki.

Usage

The minimal command line looks like this:

python sushi.py --src hdtv.wav --dst bluray.wav --script subs.ass

Output file name is optional - "{destination_path}.sushi.{subtitles_format}" is used by default. See the usage page of the wiki for further examples.

Do note that WAV is not the only format Sushi can work with. It can process audio/video files directly and decode various audio formats, provided that ffmpeg is available. For additional info refer to the Demuxing part of the wiki.

Requirements

Sushi should work on Windows, Linux and OS X. Please open an issue if it doesn't. To run it, you have to have the following installed:

  1. Python 2.7.x
  2. NumPy (1.8 or newer)
  3. OpenCV 2.4.x (on Windows putting this file in the same folder as Sushi should be enough, assuming you use x86 Python)
  4. FFmpeg (only if demuxing is used)
  5. MkvExtract (optional for faster timecodes extraction when demuxing)
  6. SCXvid-standalone (only if keyframes are made by Sushi)

The provided Windows binaries include Python, NumPy and OpenCV so you don't have to install them if you use the binary distribution. You still have to download other applications yourself if you want to use Sushi's demuxing capabilities.

Installation on Mac OS X

No binary packages are provided for OS X right now so you'll have to use the script form. Assuming you have python 2, pip and homebrew installed, run the following:

brew tap homebrew/science
brew install git opencv
pip install numpy
git clone https://github.com/tp7/sushi
# create a symlink if you want to run sushi globally
ln -s `pwd`/sushi/sushi.py /usr/local/bin/sushi
# install some optional dependencies
brew install ffmpeg mkvtoolnix

If you don't have pip, you can install numpy with homebrew, but that will probably add a few more dependencies.

brew tap homebrew/python
brew install numpy

Installation on Linux

If you have apt-get available, the installation process is trivial.

sudo apt-get update
sudo apt-get install git python python-numpy python-opencv
git clone https://github.com/tp7/sushi
ln -s `pwd`/sushi/sushi.py /usr/local/bin/sushi

Limitations

This script will never be able to property handle frame-by-frame typesetting. If underlying video stream changes (e.g. has different telecine pattern), you might get incorrect output.

This script cannot improve bad timing. If original lines are mistimed, they will be mistimed in the output file too.

In short, while this might be safe for immediate viewing, you probably shouldn't use it to blindly shift subtitles for permanent storing.