Skip to main content

A command line interface for Vosk. It generates subtitles (WebVTT files) from video and audio sources.

Project description

vosk-cli

Apache 2.0 License PyPI

This python package serves as an Vosk interface for Opencast. It allows to generate subtitles (WebVTT files) from Video and Audio sources via Vosk.

Installation

1. Install vosk-cli

To install the latest stable version of vosk-cli, run

pip install vosk-cli

Alternatively, to install the latest development version, clone this project and inside the project directory run

pip install .

2. Install dependencies

  • FFmpeg
  • ffprobe

Vosk-cli uses ffprobe to analyze and ffmpeg to preprocess input files. The easiest way to install ffmpeg is by using a package manager. If you want or need to install from source, visit FFmpeg.org/download.html and follow the instructions for your operating system.

3. Download the language model

Go to https://alphacephei.com/vosk/models and download at least the English language model. The larger models generally yield better results.

You can unzip the folder of the language model into any directory, but it is recommended to create and use a ./models folder in the project directory.

Usage

Now you are able to run vosk-cli -i <input_file_path> -o <output_file_path> -m <model_name_or_path>.

For example, if there is a video.mp4 file in your download folder and a model named vosk-model-en-us-0.22 in the ./models folder you created, you can run

vosk-cli -i ~/Downloads/video.mp4 -o text -m vosk-model-en-us-0.22

This will create a text.vtt file (which contains the transcribed captions) in your current directory.

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

vosk-cli-0.3.tar.gz (10.3 kB view details)

Uploaded Source

File details

Details for the file vosk-cli-0.3.tar.gz.

File metadata

  • Download URL: vosk-cli-0.3.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for vosk-cli-0.3.tar.gz
Algorithm Hash digest
SHA256 9416bb0aea7fed150312e81f0f271c94b0c6185ff5e02a7d064468193f30f20c
MD5 972a7006233286048d4df1a8bc57a6f4
BLAKE2b-256 062ff9f0bf023f42040ee305f311c924612cbd512d7c248c298ecc7805c0e5b1

See more details on using hashes here.

Supported by

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