🎤 Karaoke Transcriber

A command-line tool that converts any video file into a karaoke-style subtitled video using OpenAI Whisper and FFmpeg.

📖 About the Project

Karaoke Transcriber:

• Extracts audio from a video file
• Transcribes the speech using Whisper (openai-whisper)
• Generates .srt subtitles
• Burns the subtitles back into the video using FFmpeg
• Includes built-in options to:
  • Check environment dependencies before running (--check)
  • View the installed CLI version (--version)

This is ideal for:

• Karaoke/lyric video generation
• Captioning interviews, speeches, or educational content
• Language learning and accessibility

⚙️ Minimum Requirements

Ensure the following tools and libraries are installed on your system:

System Requirements

• Node.js (v16 or higher)
• Python 3
• FFmpeg

Python Dependencies

Install these via pip:

pip3 install openai-whisper srt

📦 Install via npm (Published Version)

Once the package is published, you can install it globally:

npm install -g karaoke-transcriber

Then use it from anywhere via:

karaoke-transcriber --input path/to/input.mp4 --output path/to/output.mp4

✅ Check system dependencies

karaoke-transcriber --check

This will run a diagnostic script to check for FFmpeg, Python 3, Whisper, and srt.

📌 View CLI version

karaoke-transcriber --version

🧪 Run Locally (Development)

Step 0: Create a virtual environment

python3 -m venv .venv
source .venv/bin/activate

Step 1: Clone the Repository

git clone https://github.com/rahulSheregar/karaoke-transcriber.git
cd karaoke-transcriber

Step 2: Install Python dependencies

pip install -e .

Step 3: Run the CLI

transcriber --input path/to/video.mp4 --output path/to/output.mp4

You can also run the environment check locally:

node dist/index.js --check

🗂 Project Structure

karaoke-transcriber/
│
├── dist/                 # Compiled JavaScript output
├── node_modules/         # npm dependencies
├── python_backend/
│   └── karaoke_gen.py    # Python script for processing audio/video
├── src/
│   └── index.ts          # TypeScript CLI entry point
│
├── check-env.js          # System dependency checker (optional)
├── package.json
├── tsconfig.json
├── pyproject.toml        # automate project builder
├── README.md

👤 Author

Created by Rahul Sheregar

• GitHub: @rahulSheregar

Contributor:

• Github: @chrisdedman