Skip to main content

Generate SRT subtitles from audio/video files using WhisperX

Project description

subtitle-engine

Generate .srt subtitle files from audio or video files using WhisperX. Optionally generate a caption from the transcript with a local Ollama LLM.

Installation

Requires Python 3.12 or newer.

pip install subtitle-engine

Or install from source:

git clone https://github.com/leevipuntanen/subtitle-engine.git
cd subtitle-engine
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

Usage

# Basic usage — writes <input>.srt next to the source file
subeng video.mp4

# Specify output file
subeng video.mp4 --output subtitles.srt

# Use a different model or language
subeng video.mp4 --model medium --language fi

# Force CPU / CUDA
subeng video.mp4 --device cpu

# Speaker diarization (requires a Hugging Face token)
subeng video.mp4 --diarize --hf-token $HF_TOKEN

# Generate a caption from the transcript using Ollama
subeng video.mp4 --caption --ollama-model qwen3.5:0.6b

# Short-form subtitles (2-5 words per line, default)
subeng video.mp4 --preset shortform

# Long-form subtitles (10-14 words per line)
subeng video.mp4 --preset longform

Options

Option Description
--output, -o Output SRT file path
--model, -m WhisperX model: tiny, base, small (default), medium, large-v2, large-v3
--language, -l ISO language code, e.g. en, fi. Auto-detected if omitted.
--device, -d cpu or cuda. Auto-detected if omitted.
--batch-size, -b Inference batch size (default: 16)
--compute-type, -c int8 or float16. Auto-selected if omitted.
--diarize Enable speaker diarization
--hf-token Hugging Face token for diarization (or set HF_TOKEN env var)
--caption Generate a caption from the transcript via Ollama
--ollama-model Ollama model name (required with --caption)
--ollama-host Ollama API host (default: http://localhost:11434)
--preset, -p Subtitle style: shortform (2-5 words, default) or longform (10-14 words)

Development

Run the test suite:

pytest

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

subtitle_engine-0.1.3.2.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

subtitle_engine-0.1.3.2-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

Details for the file subtitle_engine-0.1.3.2.tar.gz.

File metadata

  • Download URL: subtitle_engine-0.1.3.2.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for subtitle_engine-0.1.3.2.tar.gz
Algorithm Hash digest
SHA256 1139ddf244066a24bec0376f6efd4a9cd2d4247a18a542ce3a5c648379426393
MD5 aefe607a08863e4a09fae5de080827e4
BLAKE2b-256 be3280608413b0253124c58c50d328e48ffb17ce79331e6eca8afb229e48ac3d

See more details on using hashes here.

File details

Details for the file subtitle_engine-0.1.3.2-py3-none-any.whl.

File metadata

File hashes

Hashes for subtitle_engine-0.1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e1334e4b3713f6f557b72033abecc629f28e969e00e9b01c971f30bc17c1a237
MD5 ca10c86b5015e3db2eba10df6b9bc9a3
BLAKE2b-256 1806e1aa6fadfdb211064178d0f13feffcdae9cda492ea18acb31e04d769e81a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page