Skip to content
ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

113 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Nightingale

Karaoke from any song in your music library, powered by neural networks.


Nightingale scans your music folder, separates lead vocals from instrumentals using the UVR Karaoke model (or Demucs), transcribes lyrics with word-level timestamps via WhisperX, and plays it all back with synchronized highlighting, pitch scoring, key/tempo controls, profiles, and dynamic backgrounds.

Ships as a single binary. No manual installation of Python, ffmpeg, or ML models required โ€” everything is downloaded and bootstrapped automatically on first launch.

Features

Core

๐ŸŽค Stem Separation โ€” isolates lead vocals from instrumentals using the UVR Karaoke model (default) or Demucs, with adjustable guide vocal volume. The karaoke model preserves backing vocals in the instrumental for a more natural sound

๐Ÿ“ Word-Level Lyrics โ€” automatic transcription with alignment, or fetched from LRCLIB when available

๐ŸŽฏ Pitch Scoring โ€” real-time microphone input with pitch detection, star ratings, and per-song scoreboards

๐ŸŽš๏ธ Key & Tempo Shifts โ€” adjust song key and tempo after analysis, with cached playback variants for quick retries

๐Ÿ‘ค Profiles โ€” create and switch between player profiles; scores are tracked per profile

๐ŸŽฌ Video Files โ€” drop video files (.mp4, .mkv, etc.) into your music folder; vocals are separated from the audio track and the original video plays as a synchronized background

๐ŸŒŒ 7 Background Themes โ€” 5 GPU shader backgrounds (Plasma, Aurora, Waves, Nebula, Starfield), Pixabay video backgrounds with 5 flavors (Nature, Underwater, Space, City, Countryside), plus automatic source video playback for video files

๐Ÿงญ Sidebar + Library Filters โ€” quick filters, metadata cleanup buckets, artist/album groups, and an Analyze All action for bulk analysis

๐ŸŽ™๏ธ Mic Mirroring โ€” optionally route your live mic into playback for low-latency practice and monitoring

๐ŸŽฎ Gamepad Support โ€” full navigation and control via gamepad (D-pad, sticks, face buttons)

๐Ÿ“บ Adaptive UI Scaling โ€” scales to any resolution including 4K TVs

๐Ÿ“ฆ Self-Contained โ€” ffmpeg, uv, Python, PyTorch, and ML packages are downloaded automatically during setup. Video backgrounds are pre-downloaded so the first session is ready to go

Multi-Channel Audio I/O

๐Ÿ”Š Multi-Device, Multi-Channel Support โ€” connect professional audio interfaces (e.g. Allen & Heath QU-5D) with multiple input microphones and multiple output channels. Route guide vocals to individual in-ear monitors or headphones per singer while keeping instrumentals on the main speakers. Input channel selection UI lets you pick which device and channel each microphone uses

Playback Enhancements

๐Ÿ“Š Vocal Pitch Graph โ€” the original singer's pitch contour is plotted alongside your live microphone input, so you can visualize in real time how close you are to the target melody

Song Cards & Library UX

๐Ÿƒ Redesigned Song Cards โ€” explicit "Not Analyzed" / "Play" buttons replace the old click-anywhere behavior; audio/video type badges; thumbnail URLs for unanalyzed songs

๐Ÿ” Language Confidence Indicator โ€” a warning icon appears on songs whose auto-detected language confidence is below threshold; you can manually select and switch the language

โœ๏ธ Metadata & Lyrics Editing โ€” edit artist, title, album, and lyrics directly from the song card actions menu

๐ŸŒ Romanized Lyrics (AI) โ€” generate romanized (Latin-script) lyrics for non-Latin songs (Japanese โ†’ romaji, Hindi โ†’ roman, etc.) via OpenAI/Gemini. Addresses upstream issue #11

Library & File Management

๐Ÿ“‚ Folder / Tree View โ€” browse large music libraries organized by their on-disk folder structure with recursive navigation

๐Ÿค– AI Metadata Fixer โ€” batch-process filenames and metadata (artist, title, album) using OpenAI for songs collected from various sources. Includes a sneak-peek audio preview so you can verify corrections before applying

๐ŸŽต Song Sneak Peek โ€” preview a random 15-second clip of any song in the library or playlist view to decide whether to add or skip it

Playlists

๐Ÿ“‹ Per-Profile Playlists โ€” create, manage, and switch between multiple playlists per profile. Add songs from the library or song cards; analyze entire playlists in bulk

Settings & Import

โฌ‡๏ธ Download from URL โ€” paste a URL in settings to download and import songs directly into your library, so friends and family can quickly add their favorites during a karaoke night

Quick start

Download the latest release for your platform from the Releases page and run it. On first launch, Nightingale shows setup steps, lets you pick a data folder, then installs the Python environment and ML models automatically.

macOS

macOS quarantines files downloaded from the internet. Since Nightingale isn't signed with an Apple Developer ID, Gatekeeper will block it with a message like "app is damaged and can't be opened". To fix this, remove the quarantine attribute after moving the Nightingale.app to Applications:

xattr -cr /Applications/Nightingale.app

Supported formats

Audio: .mp3, .flac, .ogg, .wav, .m4a, .aac, .wma. Video: .mp4, .mkv, .avi, .webm, .mov, .m4v.

Controls

Navigation

Action Keyboard Gamepad
Move Arrow keys D-pad / Left stick
Confirm / Select Enter A (South)
Back / Cancel Escape B (East) / Start
Switch panel Tab โ€”
Search songs Type to filter โ€”

Playback

Action Keyboard Gamepad
Pause / Resume Space Start
Exit to menu Escape B (East)
Toggle guide vocals G โ€”
Guide volume up/down + / - โ€”
Cycle background theme T โ€”
Cycle video flavor F โ€”
Toggle microphone M โ€”
Next microphone N โ€”
Toggle mic mirroring R โ€”
Toggle fullscreen F11 โ€”
Skip Intro / Skip Outro On-screen buttons A (South)

How it works

Audio or video file
        โ”‚
        โ–ผ
  โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
  โ”‚  UVR Karaoke /  โ”‚  โ”€โ”€โ–ถ  vocals.mp3 + instrumental.mp3
  โ”‚  Demucs         โ”‚       (extracts audio track from videos)
  โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
        โ”‚
        โ–ผ
  โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
  โ”‚  LRCLIB         โ”‚  โ”€โ”€โ–ถ  Fetches synced lyrics if available
  โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
        โ”‚
        โ–ผ
  โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
  โ”‚  WhisperX       โ”‚  โ”€โ”€โ–ถ  Transcription + word-level alignment
  โ”‚  (large-v3)     โ”‚
  โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
        โ”‚
        โ–ผ
  โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
  โ”‚  Tauri App      โ”‚  โ”€โ”€โ–ถ  Plays instrumental + synced lyrics
  โ”‚  (Rust + React) โ”‚       with pitch scoring, key/tempo controls,
  โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜       mic mirroring, and dynamic backgrounds
                            (video files use source video when available)

Analysis results are cached using blake3 file hashes. Re-analysis only happens if the source file changes, the user triggers it manually, or you choose to shift key/tempo and create playback variants.

Hardware

The Python analyzer uses PyTorch and auto-detects the best backend:

Backend Device Notes
CUDA NVIDIA GPU Fastest
MPS Apple Silicon macOS; WhisperX alignment falls back to CPU
CPU Any Slowest but always works

The UVR Karaoke model uses ONNX Runtime and enables CUDA acceleration automatically on NVIDIA GPUs, or CoreML on Apple Silicon.

A song typically takes 2โ€“5 minutes on GPU, 10โ€“20 minutes on CPU.

Data storage

During setup, you can choose where Nightingale stores data (default: ~/.nightingale). Most runtime data is stored in that selected data folder, while config.json and nightingale.log remain in ~/.nightingale.

Typical selected data folder layout:

<selected-data-folder>/
โ”œโ”€โ”€ cache/               # Stems, transcripts, lyrics, shifted variants, covers, playable videos
โ”œโ”€โ”€ songs.db             # SQLite song library and analysis metadata
โ”œโ”€โ”€ profiles.json        # Player profiles and scores
โ”œโ”€โ”€ videos/              # Cached Pixabay video backgrounds
โ”œโ”€โ”€ sounds/              # Sound effects (celebration)
โ”œโ”€โ”€ vendor/
โ”‚   โ”œโ”€โ”€ ffmpeg           # Downloaded ffmpeg binary
โ”‚   โ”œโ”€โ”€ uv               # Downloaded uv binary
โ”‚   โ”œโ”€โ”€ python/          # Python 3.10 installed via uv
โ”‚   โ”œโ”€โ”€ venv/            # Virtual environment with ML packages
โ”‚   โ”œโ”€โ”€ analyzer/        # Extracted analyzer Python scripts
โ”‚   โ””โ”€โ”€ .ready           # Marker indicating setup is complete
โ””โ”€โ”€ models/
    โ”œโ”€โ”€ torch/           # Demucs model cache
    โ”œโ”€โ”€ huggingface/     # WhisperX model cache
    โ””โ”€โ”€ audio_separator/ # UVR Karaoke model cache

~/.nightingale/config.json stores app settings, including the selected data folder path.

Video backgrounds

Pixabay video backgrounds use the Pixabay API. The API key is embedded in release builds. For development, create a .env file at the project root:

PIXABAY_API_KEY=your_key_here

Building from source

Prerequisites

Tool Version
Rust 1.85+ (edition 2024)
Node.js 20+
pnpm latest
Linux only libwebkit2gtk-4.1-dev, libssl-dev, libayatana-appindicator3-dev, librsvg2-dev, libxdo-dev, libasound2-dev

Development

git clone <repo-url> nightingale
cd nightingale
cargo desktop dev

Release build

cargo desktop build

Supported platforms

Platform Target
Linux x86_64 x86_64-unknown-linux-gnu
Linux aarch64 aarch64-unknown-linux-gnu
macOS ARM aarch64-apple-darwin
macOS Intel x86_64-apple-darwin
Windows x86_64 x86_64-pc-windows-msvc

License

GPL-3.0-or-later โ€” see LICENSE.

About

Machine learning powered Karaoke app (with scores!)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages