Nightingale is an ML-powered Karaoke app transforming any song into a karaoke experience. It targets music enthusiasts by automating vocal separation, lyric transcription with timestamps, and playback customization, simplifying karaoke creation from personal libraries or streaming sources within a self-contained binary.

How It Works

Nightingale employs a multi-stage ML pipeline using UVR Karaoke/Demucs for vocal isolation and WhisperX for word-level lyric transcription/alignment. It supports multiple ASR engines (Whisper, Parakeet v3) and alignment backends, including experimental GPU acceleration and CJK language support. Built with Tauri (Rust+React), it communicates with a persistent local analyzer via TCP sockets, ensuring ML model initializations occur only once for reduced per-song overhead and efficient caching.

Quick Start & Requirements

• Installation: Download the latest release binary for macOS, Windows, or Linux.
• Prerequisites: No manual installation of Python, ffmpeg, or ML models required; they are auto-downloaded on first launch. Build-from-source requires Rust 1.85+, Node.js 20+, pnpm, and Linux dev libraries.
• Setup: First launch guides data folder selection and auto-installs environments/models. Video backgrounds are pre-downloaded.
• Docs: Links to docs/self-hosted, docs/usdx available.

Highlighted Details

• Self-Contained: Single binary auto-downloads all dependencies (Python, PyTorch, ffmpeg, ML models).
• Flexible Integration: Supports local folders, Jellyfin, Navidrome, self-hosted web, and Docker.
• Advanced Lyrics: Word-level alignment, CJK support with romanization, lyrics editor, LRCLIB fetching.
• Extensible ML: Pluggable ASR/alignment engines with experimental GPU acceleration.
• Rich Playback: Real-time pitch scoring, key/tempo adjustment, audio-reactive visuals, gamepad support.

Maintenance & Community

Developed by a single individual. Support via Patreon and Ko-fi. No specific community channels (Discord/Slack) mentioned.

Licensing & Compatibility

Licensed under GPL-3.0-or-later. This strong copyleft license may restrict linking with proprietary or closed-source software.

Limitations & Caveats

Linux lacks auto-updates; manual installation is needed. macOS requires manual Gatekeeper bypass (xattr -cr). UltraStar Deluxe support and some advanced alignment backends are experimental.