Installation

Install necessary dependencies:

$ apt-get install ffmpeg

or:

$ brew install ffmpeg

§ You may also need to install HomeBrew.

Install Subaligner via PyPI (pre-emptive NumPy):

$ pip install -U pip
$ pip install subaligner

Install dependencies for enabling translation:

$ pip install 'subaligner[translation]'

Pre-install additional dependencies before installing subaligner[stretch] or subaligner[dev]:

$ apt-get install espeak libespeak1 libespeak-dev espeak-data

or:

$ brew install espeak

Install dependencies for enabling forced alignment:

$ pip install 'subaligner[stretch]'

Install dependencies for setting up the development environment:

$ pip install 'subaligner[dev]'

Install all supported features:

$ pip install 'subaligner[harmony]'

Install Subaligner via pipx:

$ pipx install subaligner
$ pipx install 'subaligner[stretch]'
$ pipx install 'subaligner[dev]'

Install from GitHub via Pipenv:

$ pipenv install subaligner
$ pipenv install 'subaligner[stretch]'
$ pipenv install 'subaligner[dev]'

Use dockerised installation:

$ docker run -v `pwd`:`pwd` -w `pwd` -it baxtree/subaligner bash

The following builds are available on dockerhub for several Linux distributions: CentOS 7 (latest and VERSION.el7), CentOS 8 (VERSION.el8), Ubuntu 18 (VERSION.u18), Ubuntu 20 (VERSION.u20), Debian 10 (VERSION.deb10), Fedora 31 (VERSION.fed31) and ArchLinux (VERSION.arch).

You can also download the latest release on GitHub and follow the steps down below to create a virtual environment and set up all the dependencies:

Install Subaligner from source:

$ git clone git@github.com:baxtree/subaligner.git
$ cd subaligner
$ make install && source .venv/bin/activate

Subaligner CLI should be on your PATH now:

(.venv) $ subaligner --help
(.venv) $ subaligner_1pass --help
(.venv) $ subaligner_2pass --help
(.venv) $ subaligner_batch --help
(.venv) $ subaligner_convert --help
(.venv) $ subaligner_train --help
(.venv) $ subaligner_tune --help

On Windows:

docker pull baxtree/subaligner
docker run -v "/d/media":/media -w "/media" -it baxtree/subaligner bash

Assuming that your media assets are stored under “d:\media”, open built-in command prompt, PowerShell, or Windows Terminal and run the above. Docker Desktop is the only option at present for Windows users.