diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-15 05:47:21 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-15 05:47:21 +0000 |
| commit | 9b7158dffcaae74e2ba6d25f48fbbf469e4f4613 (patch) | |
| tree | dc33b97298f5d46676af5450212d6b708ea62075 | |
| parent | ef1e6c17c0d43ef6afc2440edc64afe7f04b2fab (diff) | |
automatic import of python-subaligner
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-subaligner.spec | 810 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 812 insertions, 0 deletions
@@ -0,0 +1 @@ +/subaligner-0.3.1.tar.gz diff --git a/python-subaligner.spec b/python-subaligner.spec new file mode 100644 index 0000000..8fdf08b --- /dev/null +++ b/python-subaligner.spec @@ -0,0 +1,810 @@ +%global _empty_manifest_terminate_build 0 +Name: python-subaligner +Version: 0.3.1 +Release: 1 +Summary: Automatically synchronize and translate subtitles with pretrained deep neural networks, forced alignments and transformers. +License: MIT +URL: https://subaligner.readthedocs.io/en/latest/ +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/9e/d6/186ad2893cae664cdec61e6789fadbecfa5d1b84700d74b30ce2de7a5a66/subaligner-0.3.1.tar.gz +BuildArch: noarch + +Requires: python3-zipp +Requires: python3-zict +Requires: python3-Werkzeug +Requires: python3-urllib3 +Requires: python3-tornado +Requires: python3-toolz +Requires: python3-toml +Requires: python3-termcolor +Requires: python3-tensorflow +Requires: python3-tblib +Requires: python3-six +Requires: python3-setuptools +Requires: python3-scikit-learn +Requires: python3-scipy +Requires: python3-rsa +Requires: python3-requests-oauthlib +Requires: python3-requests +Requires: python3-PyYAML +Requires: python3-pytz +Requires: python3-pystack-debugger +Requires: python3-pysubs2 +Requires: python3-pysrt +Requires: python3-pyprof2calltree +Requires: python3-pydotplus +Requires: python3-pydot-ng +Requires: python3-pydot +Requires: python3-pyasn1-modules +Requires: python3-pyasn1 +Requires: python3-py +Requires: python3-psutil +Requires: python3-pluggy +Requires: python3-pbr +Requires: python3-oauthlib +Requires: python3-numpy +Requires: python3-numba +Requires: python3-networkx +Requires: python3-mccabe +Requires: python3-Markdown +Requires: python3-locket +Requires: python3-librosa +Requires: python3-le-pycaption +Requires: python3-lazy-object-proxy +Requires: python3-kiwisolver +Requires: python3-Keras-Preprocessing +Requires: python3-Keras-Applications +Requires: python3-joblib +Requires: python3-isort +Requires: python3-idna +Requires: python3-hyperopt +Requires: python3-html5lib +Requires: python3-h5py +Requires: python3-HeapDict +Requires: python3-graphviz +Requires: python3-google-pasta +Requires: python3-google-auth-oauthlib +Requires: python3-filelock +Requires: python3-distributed +Requires: python3-decorator +Requires: python3-dask +Requires: python3-Cython +Requires: python3-cycler +Requires: python3-cloudpickle +Requires: python3-click +Requires: python3-chardet +Requires: python3-certifi +Requires: python3-cchardet +Requires: python3-captionstransformer +Requires: python3-cachetools +Requires: python3-bleach +Requires: python3-beautifulsoup4 +Requires: python3-astor +Requires: python3-pygments +Requires: python3-pylint +Requires: python3-parameterized +Requires: python3-typing-extensions +Requires: python3-types-setuptools +Requires: python3-types-requests +Requires: python3-mypy +Requires: python3-pex +Requires: python3-radish-bdd +Requires: python3-scikit-build +Requires: python3-line-profiler +Requires: python3-snakeviz +Requires: python3-twine +Requires: python3-pycodestyle +Requires: python3-tox +Requires: python3-coverage +Requires: python3-mock +Requires: python3-aeneas +Requires: python3-openai-whisper +Requires: python3-transformers +Requires: python3-torch +Requires: python3-sentencepiece +Requires: python3-pycountry +Requires: python3-docutils +Requires: python3-sphinx-rtd-theme +Requires: python3-sphinx +Requires: python3-docutils +Requires: python3-sphinx-rtd-theme +Requires: python3-sphinx +Requires: python3-aeneas +Requires: python3-openai-whisper +Requires: python3-transformers +Requires: python3-torch +Requires: python3-sentencepiece +Requires: python3-pycountry +Requires: python3-openai-whisper +Requires: python3-transformers +Requires: python3-torch +Requires: python3-sentencepiece +Requires: python3-pycountry +Requires: python3-aeneas +Requires: python3-openai-whisper +Requires: python3-transformers +Requires: python3-torch +Requires: python3-sentencepiece +Requires: python3-pycountry + +%description +<div align="center"> + <img src="./figures/subaligner.png" alt="subaligner" width="300" /> +</div> + +[](https://github.com/baxtree/subaligner/actions/workflows/ci-pipeline.yml?query=branch%3Amaster)  +[](https://www.python.org/downloads/release/python-3100/) [](https://www.python.org/downloads/release/python-390/) [](https://www.python.org/downloads/release/python-380/) +[](https://subaligner.readthedocs.io/en/latest/?badge=latest) +[](https://github.com/baxtree/subaligner/blob/master/LICENSE) +[](https://badge.fury.io/py/subaligner) +[](https://hub.docker.com/r/baxtree/subaligner/builds) +[](https://hub.docker.com/r/baxtree/subaligner) +[](https://doi.org/10.5281/zenodo.5603083) + +## Supported Formats +Subtitle: SubRip, TTML, WebVTT, (Advanced) SubStation Alpha, MicroDVD, MPL2, TMP, EBU STL, SAMI, SCC and SBV. + +Video/Audio: MP4, WebM, Ogg, 3GP, FLV, MOV, Matroska, MPEG TS, WAV, MP3, AAC, FLAC, etc. + +:information_source: <small style="line-height: 1.2;">Subaligner relies on file extensions as default hints to process a wide range of audiovisual or subtitle formats. It is recommended to use extensions widely acceppted by the community to ensure compatibility.</small> + +## Dependencies +Required by basic: [FFmpeg](https://www.ffmpeg.org/) +``` +$ apt-get install ffmpeg +``` +or +``` +$ brew install ffmpeg +``` + +## Basic Installation +``` +$ pip install -U pip && pip install -U setuptools +$ pip install subaligner +``` +or install from source: +``` +$ git clone git@github.com:baxtree/subaligner.git && cd subaligner +$ pip install -U pip && pip install -U setuptools +$ python setup.py install +``` +:information_source: <small style="line-height: 1.2;">It is highly recommended creating a virtual environment prior to installation.</small> + +## Installation with Optional Packages Supporting Additional Features +``` +# Install dependencies for enabling translation and transcription + +$ pip install 'subaligner[llm]' +``` +``` +# Install dependencies for enabling forced alignment + +$ pip install 'subaligner[stretch]' +``` +``` +# Install dependencies for setting up the development environment + +$ pip install 'subaligner[dev]' +``` +Note that both `subaligner[stretch]` and `subaligner[dev]` require additional dependencies to be pre-installed: +``` +$ apt-get install espeak libespeak1 libespeak-dev espeak-data +``` +or +``` +$ brew install espeak +``` +To install all supported features: +``` +$ pip install 'subaligner[harmony]' +``` + +## Container Support +If you prefer using a containerised environment over installing everything locally, run: + +``` +$ docker run -v `pwd`:`pwd` -w `pwd` -it baxtree/subaligner bash +``` +For users on Windows 10: [Docker Desktop](https://docs.docker.com/docker-for-windows/install/) is the only option at present. +Assuming your media assets are stored under `d:\media`, open built-in command prompt, PowerShell, or Windows Terminal and run: +``` +docker pull baxtree/subaligner +docker run -v "/d/media":/media -w "/media" -it baxtree/subaligner bash +``` + +## Usage +``` +# Single-stage alignment (high-level shift with lower latency) + +$ subaligner -m single -v video.mp4 -s subtitle.srt +$ subaligner -m single -v https://example.com/video.mp4 -s https://example.com/subtitle.srt -o subtitle_aligned.srt +``` +``` +# Dual-stage alignment (low-level shift with higher latency) + +$ subaligner -m dual -v video.mp4 -s subtitle.srt +$ subaligner -m dual -v https://example.com/video.mp4 -s https://example.com/subtitle.srt -o subtitle_aligned.srt +``` +``` +# Generate subtitles by transcribing audiovisual files +$ subaligner -m transcribe -v video.mp4 -ml eng -mr whisper -mf small -o subtitle_aligned.srt +$ subaligner -m transcribe -v video.mp4 -ml zho -mr whisper -mf medium -o subtitle_aligned.srt +``` +``` +# Alignment on segmented plain texts (double newlines as the delimiter) + +$ subaligner -m script -v test.mp4 -s subtitle.txt -o subtitle_aligned.srt +$ subaligner -m script -v https://example.com/video.mp4 -s https://example.com/subtitle.txt -o subtitle_aligned.srt +``` +``` +# Alignment on multiple subtitles against the single media file + +$ subaligner -m script -v test.mp4 -s subtitle_lang_1.txt -s subtitle_lang_2.txt +$ subaligner -m script -v test.mp4 -s subtitle_lang_1.txt subtitle_lang_2.txt +``` +``` +# Alignment on embedded subtitles + +$ subaligner -m single -v video.mkv -s embedded:stream_index=0 -o subtitle_aligned.srt +$ subaligner -m dual -v video.mkv -s embedded:stream_index=0 -o subtitle_aligned.srt +``` +``` +# Translative alignment with the ISO 639-3 language code pair (src,tgt) + +$ subaligner --languages +$ subaligner -m single -v video.mp4 -s subtitle.srt -t src,tgt +$ subaligner -m dual -v video.mp4 -s subtitle.srt -t src,tgt +$ subaligner -m script -v test.mp4 -s subtitle.txt -o subtitle_aligned.srt -t src,tgt +$ subaligner -m dual -v video.mp4 -tr helsinki-nlp -o subtitle_aligned.srt -t src,tgt +$ subaligner -m dual -v video.mp4 -tr facebook-mbart -tf large -o subtitle_aligned.srt -t src,tgt +$ subaligner -m dual -v video.mp4 -tr whisper -tf small -o subtitle_aligned.srt -t src,eng +``` +``` +# Transcribe audiovisual files and generate translated subtitles + +$ subaligner -m transcribe -v video.mp4 -ml src -mr whisper -mf small -tr helsinki-nlp -o subtitle_aligned.srt -t src,tgt +``` +``` +# Shift subtitle manually by offset in seconds + +$ subaligner -m shift --subtitle_path subtitle.srt -os 5.5 +$ subaligner -m shift --subtitle_path subtitle.srt -os -5.5 -o subtitle_shifted.srt +``` +``` +# Run batch alignment against directories + +$ subaligner_batch -m single -vd videos/ -sd subtitles/ -od aligned_subtitles/ +$ subaligner_batch -m dual -vd videos/ -sd subtitles/ -od aligned_subtitles/ +$ subaligner_batch -m dual -vd videos/ -sd subtitles/ -od aligned_subtitles/ -of ttml +``` +``` +# Run alignments with pipx + +$ pipx run subaligner -m single -v video.mp4 -s subtitle.srt +$ pipx run subaligner -m dual -v video.mp4 -s subtitle.srt +``` +``` +# Run the module as a script +$ python -m subaligner -m single -v video.mp4 -s subtitle.srt +$ python -m subaligner -m dual -v video.mp4 -s subtitle.srt +``` +``` +# Run alignments with the docker image + +$ docker pull baxtree/subaligner +$ docker run -v `pwd`:`pwd` -w `pwd` -it baxtree/subaligner subaligner -m single -v video.mp4 -s subtitle.srt +$ docker run -v `pwd`:`pwd` -w `pwd` -it baxtree/subaligner subaligner -m dual -v video.mp4 -s subtitle.srt +$ docker run -it baxtree/subaligner subaligner -m single -v https://example.com/video.mp4 -s https://example.com/subtitle.srt -o subtitle_aligned.srt +$ docker run -it baxtree/subaligner subaligner -m dual -v https://example.com/video.mp4 -s https://example.com/subtitle.srt -o subtitle_aligned.srt +``` +The aligned subtitle will be saved at `subtitle_aligned.srt`. For details on CLIs, run `subaligner -h` or `subaligner_batch -h`, `subaligner_convert -h`, `subaligner_train -h` and `subaligner_tune -h` for additional utilities. `subaligner_1pass` and `subaligner_2pass` are shortcuts for running `subaligner` with `-m single` and `-m dual` options, respectively. + + + +## Advanced Usage +You can train a new model with your own audiovisual files and subtitle files: +``` +$ subaligner_train -vd VIDEO_DIRECTORY -sd SUBTITLE_DIRECTORY -tod TRAINING_OUTPUT_DIRECTORY +``` +Then you can apply it to your subtitle synchronisation with the aforementioned commands. For more details on how to train and tune your own model, please refer to [Subaligner Docs](https://subaligner.readthedocs.io/en/latest/advanced_usage.html). + +## Anatomy +Subtitles can be out of sync with their companion audiovisual media files for a variety of causes including latency introduced by Speech-To-Text on live streams or calibration and rectification involving human intervention during post-production. + +A model has been trained with synchronised video and subtitle pairs and later used for predicating shifting offsets and directions under the guidance of a dual-stage aligning approach. + +First Stage (Global Alignment): + + +Second Stage (Parallelised Individual Alignment): + + +## Acknowledgement +This tool wouldn't be possible without the following packages: +[librosa](https://librosa.github.io/librosa/) +[tensorflow](https://www.tensorflow.org/) +[scikit-learn](https://scikit-learn.org) +[pycaption](https://pycaption.readthedocs.io) +[pysrt](https://github.com/byroot/pysrt) +[pysubs2](https://github.com/tkarabela/pysubs2) +[aeneas](https://www.readbeyond.it/aeneas/) +[transformers](https://huggingface.co/transformers/) +[openai-whisper](https://github.com/openai/whisper). + +Thanks to Alan Robinson and Nigel Megitt for their invaluable feedback. + + + + +%package -n python3-subaligner +Summary: Automatically synchronize and translate subtitles with pretrained deep neural networks, forced alignments and transformers. +Provides: python-subaligner +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-subaligner +<div align="center"> + <img src="./figures/subaligner.png" alt="subaligner" width="300" /> +</div> + +[](https://github.com/baxtree/subaligner/actions/workflows/ci-pipeline.yml?query=branch%3Amaster)  +[](https://www.python.org/downloads/release/python-3100/) [](https://www.python.org/downloads/release/python-390/) [](https://www.python.org/downloads/release/python-380/) +[](https://subaligner.readthedocs.io/en/latest/?badge=latest) +[](https://github.com/baxtree/subaligner/blob/master/LICENSE) +[](https://badge.fury.io/py/subaligner) +[](https://hub.docker.com/r/baxtree/subaligner/builds) +[](https://hub.docker.com/r/baxtree/subaligner) +[](https://doi.org/10.5281/zenodo.5603083) + +## Supported Formats +Subtitle: SubRip, TTML, WebVTT, (Advanced) SubStation Alpha, MicroDVD, MPL2, TMP, EBU STL, SAMI, SCC and SBV. + +Video/Audio: MP4, WebM, Ogg, 3GP, FLV, MOV, Matroska, MPEG TS, WAV, MP3, AAC, FLAC, etc. + +:information_source: <small style="line-height: 1.2;">Subaligner relies on file extensions as default hints to process a wide range of audiovisual or subtitle formats. It is recommended to use extensions widely acceppted by the community to ensure compatibility.</small> + +## Dependencies +Required by basic: [FFmpeg](https://www.ffmpeg.org/) +``` +$ apt-get install ffmpeg +``` +or +``` +$ brew install ffmpeg +``` + +## Basic Installation +``` +$ pip install -U pip && pip install -U setuptools +$ pip install subaligner +``` +or install from source: +``` +$ git clone git@github.com:baxtree/subaligner.git && cd subaligner +$ pip install -U pip && pip install -U setuptools +$ python setup.py install +``` +:information_source: <small style="line-height: 1.2;">It is highly recommended creating a virtual environment prior to installation.</small> + +## Installation with Optional Packages Supporting Additional Features +``` +# Install dependencies for enabling translation and transcription + +$ pip install 'subaligner[llm]' +``` +``` +# Install dependencies for enabling forced alignment + +$ pip install 'subaligner[stretch]' +``` +``` +# Install dependencies for setting up the development environment + +$ pip install 'subaligner[dev]' +``` +Note that both `subaligner[stretch]` and `subaligner[dev]` require additional dependencies to be pre-installed: +``` +$ apt-get install espeak libespeak1 libespeak-dev espeak-data +``` +or +``` +$ brew install espeak +``` +To install all supported features: +``` +$ pip install 'subaligner[harmony]' +``` + +## Container Support +If you prefer using a containerised environment over installing everything locally, run: + +``` +$ docker run -v `pwd`:`pwd` -w `pwd` -it baxtree/subaligner bash +``` +For users on Windows 10: [Docker Desktop](https://docs.docker.com/docker-for-windows/install/) is the only option at present. +Assuming your media assets are stored under `d:\media`, open built-in command prompt, PowerShell, or Windows Terminal and run: +``` +docker pull baxtree/subaligner +docker run -v "/d/media":/media -w "/media" -it baxtree/subaligner bash +``` + +## Usage +``` +# Single-stage alignment (high-level shift with lower latency) + +$ subaligner -m single -v video.mp4 -s subtitle.srt +$ subaligner -m single -v https://example.com/video.mp4 -s https://example.com/subtitle.srt -o subtitle_aligned.srt +``` +``` +# Dual-stage alignment (low-level shift with higher latency) + +$ subaligner -m dual -v video.mp4 -s subtitle.srt +$ subaligner -m dual -v https://example.com/video.mp4 -s https://example.com/subtitle.srt -o subtitle_aligned.srt +``` +``` +# Generate subtitles by transcribing audiovisual files +$ subaligner -m transcribe -v video.mp4 -ml eng -mr whisper -mf small -o subtitle_aligned.srt +$ subaligner -m transcribe -v video.mp4 -ml zho -mr whisper -mf medium -o subtitle_aligned.srt +``` +``` +# Alignment on segmented plain texts (double newlines as the delimiter) + +$ subaligner -m script -v test.mp4 -s subtitle.txt -o subtitle_aligned.srt +$ subaligner -m script -v https://example.com/video.mp4 -s https://example.com/subtitle.txt -o subtitle_aligned.srt +``` +``` +# Alignment on multiple subtitles against the single media file + +$ subaligner -m script -v test.mp4 -s subtitle_lang_1.txt -s subtitle_lang_2.txt +$ subaligner -m script -v test.mp4 -s subtitle_lang_1.txt subtitle_lang_2.txt +``` +``` +# Alignment on embedded subtitles + +$ subaligner -m single -v video.mkv -s embedded:stream_index=0 -o subtitle_aligned.srt +$ subaligner -m dual -v video.mkv -s embedded:stream_index=0 -o subtitle_aligned.srt +``` +``` +# Translative alignment with the ISO 639-3 language code pair (src,tgt) + +$ subaligner --languages +$ subaligner -m single -v video.mp4 -s subtitle.srt -t src,tgt +$ subaligner -m dual -v video.mp4 -s subtitle.srt -t src,tgt +$ subaligner -m script -v test.mp4 -s subtitle.txt -o subtitle_aligned.srt -t src,tgt +$ subaligner -m dual -v video.mp4 -tr helsinki-nlp -o subtitle_aligned.srt -t src,tgt +$ subaligner -m dual -v video.mp4 -tr facebook-mbart -tf large -o subtitle_aligned.srt -t src,tgt +$ subaligner -m dual -v video.mp4 -tr whisper -tf small -o subtitle_aligned.srt -t src,eng +``` +``` +# Transcribe audiovisual files and generate translated subtitles + +$ subaligner -m transcribe -v video.mp4 -ml src -mr whisper -mf small -tr helsinki-nlp -o subtitle_aligned.srt -t src,tgt +``` +``` +# Shift subtitle manually by offset in seconds + +$ subaligner -m shift --subtitle_path subtitle.srt -os 5.5 +$ subaligner -m shift --subtitle_path subtitle.srt -os -5.5 -o subtitle_shifted.srt +``` +``` +# Run batch alignment against directories + +$ subaligner_batch -m single -vd videos/ -sd subtitles/ -od aligned_subtitles/ +$ subaligner_batch -m dual -vd videos/ -sd subtitles/ -od aligned_subtitles/ +$ subaligner_batch -m dual -vd videos/ -sd subtitles/ -od aligned_subtitles/ -of ttml +``` +``` +# Run alignments with pipx + +$ pipx run subaligner -m single -v video.mp4 -s subtitle.srt +$ pipx run subaligner -m dual -v video.mp4 -s subtitle.srt +``` +``` +# Run the module as a script +$ python -m subaligner -m single -v video.mp4 -s subtitle.srt +$ python -m subaligner -m dual -v video.mp4 -s subtitle.srt +``` +``` +# Run alignments with the docker image + +$ docker pull baxtree/subaligner +$ docker run -v `pwd`:`pwd` -w `pwd` -it baxtree/subaligner subaligner -m single -v video.mp4 -s subtitle.srt +$ docker run -v `pwd`:`pwd` -w `pwd` -it baxtree/subaligner subaligner -m dual -v video.mp4 -s subtitle.srt +$ docker run -it baxtree/subaligner subaligner -m single -v https://example.com/video.mp4 -s https://example.com/subtitle.srt -o subtitle_aligned.srt +$ docker run -it baxtree/subaligner subaligner -m dual -v https://example.com/video.mp4 -s https://example.com/subtitle.srt -o subtitle_aligned.srt +``` +The aligned subtitle will be saved at `subtitle_aligned.srt`. For details on CLIs, run `subaligner -h` or `subaligner_batch -h`, `subaligner_convert -h`, `subaligner_train -h` and `subaligner_tune -h` for additional utilities. `subaligner_1pass` and `subaligner_2pass` are shortcuts for running `subaligner` with `-m single` and `-m dual` options, respectively. + + + +## Advanced Usage +You can train a new model with your own audiovisual files and subtitle files: +``` +$ subaligner_train -vd VIDEO_DIRECTORY -sd SUBTITLE_DIRECTORY -tod TRAINING_OUTPUT_DIRECTORY +``` +Then you can apply it to your subtitle synchronisation with the aforementioned commands. For more details on how to train and tune your own model, please refer to [Subaligner Docs](https://subaligner.readthedocs.io/en/latest/advanced_usage.html). + +## Anatomy +Subtitles can be out of sync with their companion audiovisual media files for a variety of causes including latency introduced by Speech-To-Text on live streams or calibration and rectification involving human intervention during post-production. + +A model has been trained with synchronised video and subtitle pairs and later used for predicating shifting offsets and directions under the guidance of a dual-stage aligning approach. + +First Stage (Global Alignment): + + +Second Stage (Parallelised Individual Alignment): + + +## Acknowledgement +This tool wouldn't be possible without the following packages: +[librosa](https://librosa.github.io/librosa/) +[tensorflow](https://www.tensorflow.org/) +[scikit-learn](https://scikit-learn.org) +[pycaption](https://pycaption.readthedocs.io) +[pysrt](https://github.com/byroot/pysrt) +[pysubs2](https://github.com/tkarabela/pysubs2) +[aeneas](https://www.readbeyond.it/aeneas/) +[transformers](https://huggingface.co/transformers/) +[openai-whisper](https://github.com/openai/whisper). + +Thanks to Alan Robinson and Nigel Megitt for their invaluable feedback. + + + + +%package help +Summary: Development documents and examples for subaligner +Provides: python3-subaligner-doc +%description help +<div align="center"> + <img src="./figures/subaligner.png" alt="subaligner" width="300" /> +</div> + +[](https://github.com/baxtree/subaligner/actions/workflows/ci-pipeline.yml?query=branch%3Amaster)  +[](https://www.python.org/downloads/release/python-3100/) [](https://www.python.org/downloads/release/python-390/) [](https://www.python.org/downloads/release/python-380/) +[](https://subaligner.readthedocs.io/en/latest/?badge=latest) +[](https://github.com/baxtree/subaligner/blob/master/LICENSE) +[](https://badge.fury.io/py/subaligner) +[](https://hub.docker.com/r/baxtree/subaligner/builds) +[](https://hub.docker.com/r/baxtree/subaligner) +[](https://doi.org/10.5281/zenodo.5603083) + +## Supported Formats +Subtitle: SubRip, TTML, WebVTT, (Advanced) SubStation Alpha, MicroDVD, MPL2, TMP, EBU STL, SAMI, SCC and SBV. + +Video/Audio: MP4, WebM, Ogg, 3GP, FLV, MOV, Matroska, MPEG TS, WAV, MP3, AAC, FLAC, etc. + +:information_source: <small style="line-height: 1.2;">Subaligner relies on file extensions as default hints to process a wide range of audiovisual or subtitle formats. It is recommended to use extensions widely acceppted by the community to ensure compatibility.</small> + +## Dependencies +Required by basic: [FFmpeg](https://www.ffmpeg.org/) +``` +$ apt-get install ffmpeg +``` +or +``` +$ brew install ffmpeg +``` + +## Basic Installation +``` +$ pip install -U pip && pip install -U setuptools +$ pip install subaligner +``` +or install from source: +``` +$ git clone git@github.com:baxtree/subaligner.git && cd subaligner +$ pip install -U pip && pip install -U setuptools +$ python setup.py install +``` +:information_source: <small style="line-height: 1.2;">It is highly recommended creating a virtual environment prior to installation.</small> + +## Installation with Optional Packages Supporting Additional Features +``` +# Install dependencies for enabling translation and transcription + +$ pip install 'subaligner[llm]' +``` +``` +# Install dependencies for enabling forced alignment + +$ pip install 'subaligner[stretch]' +``` +``` +# Install dependencies for setting up the development environment + +$ pip install 'subaligner[dev]' +``` +Note that both `subaligner[stretch]` and `subaligner[dev]` require additional dependencies to be pre-installed: +``` +$ apt-get install espeak libespeak1 libespeak-dev espeak-data +``` +or +``` +$ brew install espeak +``` +To install all supported features: +``` +$ pip install 'subaligner[harmony]' +``` + +## Container Support +If you prefer using a containerised environment over installing everything locally, run: + +``` +$ docker run -v `pwd`:`pwd` -w `pwd` -it baxtree/subaligner bash +``` +For users on Windows 10: [Docker Desktop](https://docs.docker.com/docker-for-windows/install/) is the only option at present. +Assuming your media assets are stored under `d:\media`, open built-in command prompt, PowerShell, or Windows Terminal and run: +``` +docker pull baxtree/subaligner +docker run -v "/d/media":/media -w "/media" -it baxtree/subaligner bash +``` + +## Usage +``` +# Single-stage alignment (high-level shift with lower latency) + +$ subaligner -m single -v video.mp4 -s subtitle.srt +$ subaligner -m single -v https://example.com/video.mp4 -s https://example.com/subtitle.srt -o subtitle_aligned.srt +``` +``` +# Dual-stage alignment (low-level shift with higher latency) + +$ subaligner -m dual -v video.mp4 -s subtitle.srt +$ subaligner -m dual -v https://example.com/video.mp4 -s https://example.com/subtitle.srt -o subtitle_aligned.srt +``` +``` +# Generate subtitles by transcribing audiovisual files +$ subaligner -m transcribe -v video.mp4 -ml eng -mr whisper -mf small -o subtitle_aligned.srt +$ subaligner -m transcribe -v video.mp4 -ml zho -mr whisper -mf medium -o subtitle_aligned.srt +``` +``` +# Alignment on segmented plain texts (double newlines as the delimiter) + +$ subaligner -m script -v test.mp4 -s subtitle.txt -o subtitle_aligned.srt +$ subaligner -m script -v https://example.com/video.mp4 -s https://example.com/subtitle.txt -o subtitle_aligned.srt +``` +``` +# Alignment on multiple subtitles against the single media file + +$ subaligner -m script -v test.mp4 -s subtitle_lang_1.txt -s subtitle_lang_2.txt +$ subaligner -m script -v test.mp4 -s subtitle_lang_1.txt subtitle_lang_2.txt +``` +``` +# Alignment on embedded subtitles + +$ subaligner -m single -v video.mkv -s embedded:stream_index=0 -o subtitle_aligned.srt +$ subaligner -m dual -v video.mkv -s embedded:stream_index=0 -o subtitle_aligned.srt +``` +``` +# Translative alignment with the ISO 639-3 language code pair (src,tgt) + +$ subaligner --languages +$ subaligner -m single -v video.mp4 -s subtitle.srt -t src,tgt +$ subaligner -m dual -v video.mp4 -s subtitle.srt -t src,tgt +$ subaligner -m script -v test.mp4 -s subtitle.txt -o subtitle_aligned.srt -t src,tgt +$ subaligner -m dual -v video.mp4 -tr helsinki-nlp -o subtitle_aligned.srt -t src,tgt +$ subaligner -m dual -v video.mp4 -tr facebook-mbart -tf large -o subtitle_aligned.srt -t src,tgt +$ subaligner -m dual -v video.mp4 -tr whisper -tf small -o subtitle_aligned.srt -t src,eng +``` +``` +# Transcribe audiovisual files and generate translated subtitles + +$ subaligner -m transcribe -v video.mp4 -ml src -mr whisper -mf small -tr helsinki-nlp -o subtitle_aligned.srt -t src,tgt +``` +``` +# Shift subtitle manually by offset in seconds + +$ subaligner -m shift --subtitle_path subtitle.srt -os 5.5 +$ subaligner -m shift --subtitle_path subtitle.srt -os -5.5 -o subtitle_shifted.srt +``` +``` +# Run batch alignment against directories + +$ subaligner_batch -m single -vd videos/ -sd subtitles/ -od aligned_subtitles/ +$ subaligner_batch -m dual -vd videos/ -sd subtitles/ -od aligned_subtitles/ +$ subaligner_batch -m dual -vd videos/ -sd subtitles/ -od aligned_subtitles/ -of ttml +``` +``` +# Run alignments with pipx + +$ pipx run subaligner -m single -v video.mp4 -s subtitle.srt +$ pipx run subaligner -m dual -v video.mp4 -s subtitle.srt +``` +``` +# Run the module as a script +$ python -m subaligner -m single -v video.mp4 -s subtitle.srt +$ python -m subaligner -m dual -v video.mp4 -s subtitle.srt +``` +``` +# Run alignments with the docker image + +$ docker pull baxtree/subaligner +$ docker run -v `pwd`:`pwd` -w `pwd` -it baxtree/subaligner subaligner -m single -v video.mp4 -s subtitle.srt +$ docker run -v `pwd`:`pwd` -w `pwd` -it baxtree/subaligner subaligner -m dual -v video.mp4 -s subtitle.srt +$ docker run -it baxtree/subaligner subaligner -m single -v https://example.com/video.mp4 -s https://example.com/subtitle.srt -o subtitle_aligned.srt +$ docker run -it baxtree/subaligner subaligner -m dual -v https://example.com/video.mp4 -s https://example.com/subtitle.srt -o subtitle_aligned.srt +``` +The aligned subtitle will be saved at `subtitle_aligned.srt`. For details on CLIs, run `subaligner -h` or `subaligner_batch -h`, `subaligner_convert -h`, `subaligner_train -h` and `subaligner_tune -h` for additional utilities. `subaligner_1pass` and `subaligner_2pass` are shortcuts for running `subaligner` with `-m single` and `-m dual` options, respectively. + + + +## Advanced Usage +You can train a new model with your own audiovisual files and subtitle files: +``` +$ subaligner_train -vd VIDEO_DIRECTORY -sd SUBTITLE_DIRECTORY -tod TRAINING_OUTPUT_DIRECTORY +``` +Then you can apply it to your subtitle synchronisation with the aforementioned commands. For more details on how to train and tune your own model, please refer to [Subaligner Docs](https://subaligner.readthedocs.io/en/latest/advanced_usage.html). + +## Anatomy +Subtitles can be out of sync with their companion audiovisual media files for a variety of causes including latency introduced by Speech-To-Text on live streams or calibration and rectification involving human intervention during post-production. + +A model has been trained with synchronised video and subtitle pairs and later used for predicating shifting offsets and directions under the guidance of a dual-stage aligning approach. + +First Stage (Global Alignment): + + +Second Stage (Parallelised Individual Alignment): + + +## Acknowledgement +This tool wouldn't be possible without the following packages: +[librosa](https://librosa.github.io/librosa/) +[tensorflow](https://www.tensorflow.org/) +[scikit-learn](https://scikit-learn.org) +[pycaption](https://pycaption.readthedocs.io) +[pysrt](https://github.com/byroot/pysrt) +[pysubs2](https://github.com/tkarabela/pysubs2) +[aeneas](https://www.readbeyond.it/aeneas/) +[transformers](https://huggingface.co/transformers/) +[openai-whisper](https://github.com/openai/whisper). + +Thanks to Alan Robinson and Nigel Megitt for their invaluable feedback. + + + + +%prep +%autosetup -n subaligner-0.3.1 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-subaligner -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon May 15 2023 Python_Bot <Python_Bot@openeuler.org> - 0.3.1-1 +- Package Spec generated @@ -0,0 +1 @@ +ec032e987b71a220369fe25b6fd36e7d subaligner-0.3.1.tar.gz |