Skip to main content

Automatic subtitles in your videos

This repository uses ffmpeg and OpenAI's Whisper to automatically generate and overlay subtitles on any video.

Installation

To get started, you'll need Python 3.7 or newer. Install the binary by running the following command:

pip install git+https://github.com/m1guelpf/auto-subtitle.git

You'll also need to install ffmpeg, which is available from most package managers:

# on Ubuntu or Debian
sudo apt update && sudo apt install ffmpeg

# on MacOS using Homebrew (https://brew.sh/)
brew install ffmpeg

# on Windows using Chocolatey (https://chocolatey.org/)
choco install ffmpeg

Usage

The following command will generate a subtitled/video.mp4 file contained the input video with overlayed subtitles.

auto_subtitle /path/to/video.mp4 -o subtitled/

The default setting (which selects the small model) works well for transcribing English. You can optionally use a bigger model for better results (especially with other languages). The available models are tiny, tiny.en, base, base.en, small, small.en, medium, medium.en, large.

auto_subtitle /path/to/video.mp4 --model medium

Adding --task translate will translate the subtitles into English:

auto_subtitle /path/to/video.mp4 --task translate

Run the following to view all available options:

auto_subtitle --help

License

This script is open-source and licensed under the MIT License. For more details, check the LICENSE file.

Metadata

Release files for auto-subtitle 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for auto-subtitle 1.0.1
File Size Uploaded Provenance
auto_subtitle-1.0.1.tar.gz 4.6 kB Without provenance Details

Release files / auto_subtitle-1.0.1.tar.gz

Download URL auto_subtitle-1.0.1.tar.gz
Size 4.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d9c7ddf952678c92a2c5a5466637ebeb7ccc37c92158bf0393390738d20464f2
BLAKE2b-256 checksum
How to use checksums
07224df7595ae0350f01884df5a1761af504a523998b9e4af7429005fe3d5000
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.9

Security for auto-subtitle 1.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

1.0.1 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page