onkey README

README проекта с github.com/dsmurrell/onkey. Одним файлом markdown: README.md.

OnKey

Learn to sing the songs you love. · singonkey.app

Saving shower singers from themselves since 2026.

OnKey's singing lane: note bars scroll towards the playhead and the singer's pitch is drawn over them, green where it's on the note
Me singing along to a song OnKey learned from one play. The full demo, with sound.

OnKey is a free, open-source singing trainer for the Mac. Play a song in Spotify, Apple Music, or YouTube in a browser, and sing along. The first time, you get the lyrics, and OnKey learns the singer's melody when the song ends. After that, the notes scroll towards you, your pitch is drawn over them, and you get a score with a report on every line.

OnKey doesn't provide, stream or download music. Your own music app plays it.

Install

You need a Mac with Apple Silicon (M1 or later) and macOS 14.2 or later.

Download OnKey.dmg (from the latest release), open it and drag OnKey to Applications.

Setup asks for the microphone, to hear you, and for system audio recording, to hear the music app. It also asks whether OnKey may follow Spotify and Apple Music: choose Listen only and it follows songs by their sound alone. Getting started walks through it, and the FAQ answers the usual questions.

How it works

When a song ends, OnKey learns it on your Mac: a model separates the lead vocal from the music, CREPE tracks the singer's pitch, and the GAME note model turns it into one bar per syllable. On later plays it finds its place from the music itself and tracks your voice live. Singing an octave down counts, and being a touch late isn't punished. How it works and Scoring have the details.

Privacy

OnKey never saves the music it listens to. It analyses the sound in memory as it plays. Your recordings and the songs it learns stay on your Mac (a take sung over speakers can contain some of the music). There's no account, no analytics and no crash reporting.

These requests do go out:

Settings has a switch for Shazam, for lyrics and for the update check. Privacy lists everything OnKey keeps and sends, and scripts/release-hosts.txt lists every web address in a release.

Using OnKey fairly

OnKey is for practising at home, with music you're entitled to play. Please:

Rights holders can reach me at [email protected] (LEGAL.md).

Help

Use Report a problem in the app (Settings, the Help menu, or a take's page). It saves a zip of numbers and logs on your Mac, with no audio and no recordings of you, for you to attach to an issue if you want to. Troubleshooting covers the common problems. Questions, or a song that's out of step? Ask in OnKey's Discord, or email [email protected].

Building from source

If you'd rather not trust my build, you can build your own. You need an Apple Silicon Mac with the Xcode command line tools, Rust, Node, and Python 3:

git clone https://github.com/dsmurrell/onkey && cd onkey
npm install && npm --prefix ui install
python3 -m venv .venv && .venv/bin/pip install -r scripts/requirements-models.txt
PYTHON=.venv/bin/python scripts/fetch-models.sh   # downloads the models and checks them by SHA-256
npx tauri build

Your build runs on your own Mac. The one thing it can't do is ask Shazam to name a new song, which needs my Apple signature. Spotify and Apple Music say what's playing themselves, so that only affects YouTube and Listen only. CONTRIBUTING.md has the details, the tests, and how to check a release's checksums. My releases are signed with my Apple Developer ID and notarised by Apple (spctl -a -vv /Applications/OnKey.app shows who signed it).

Licence and credits

MIT. See LICENSE. Modified versions can't be called OnKey or use its icon. If you build on OnKey's code, a credit linking back here is appreciated.

OnKey learns songs with CREPE, GAME, wav2vec 2.0 and UVR's MDX-Net Karaoke 2. The credits list each one, and THIRD_PARTY_NOTICES.md has the full notices and licence texts.

OnKey is made by Daniel Murrell.

onkey (dsmurrell/onkey)

Ищем в базе…

428 ·GitHub
Что это такое?OnKey — бесплатный приложение с открытым исходным кодом для тренировки пения на Mac. Вы включаете песню в Spotify, Apple Music или YouTube, подпеваете, и после одного прослушивания приложение запоминает мелодию певца. Потом оно показывает ноты, плывущие к вам, а поверх них — вашу высоту голоса и счёт.
Это нативное приложение для Mac или оно само стримит и воспроизводит музыку?Это нативное настольное приложение для macOS, написанное на Tauri и Rust. Музыку оно сама не предоставляет, не стримит и не скачивает. Песню воспроизводит ваше приложение Spotify, Apple Music или браузер, а OnKey только слушает.
Какой Mac нужен для работы?Нужен Mac с чипом Apple Silicon (M1 или новее) и macOS 14.2 или новее. Интел-маки и Windows не поддерживаются.
Можно с его помощью скачать музыку или получить саму дорожку?Нет. OnKey никогда не сохраняет и не предоставляет анализируемую музыку, он только слушает то, что уже играет в ваших приложениях. Для караоке-мероприятий приложение просит использовать лицензированные сервисы, а не полагаться на него.
Какие данные OnKey отправляет, пока я им пользуюсь?Ваш голос и звук музыки никогда не покидают ваш Mac. Наружу уходят только короткая звуковая подпись Shazam для распознавания неизвестных песен, название и исполнитель песни в LRCLIB для текстов и в iTunes для длительности и обложек, а также ежедневная проверка обновлений на GitHub. Аккаунтов и аналитики нет.
Как OnKey на самом деле узнаёт мелодию песни?После окончания песни приложение отделяет ведущий вокал от музыки, запускает CREPE, чтобы отслеживать высоту голоса певца, и с помощью модели нот GAME превращает это в одну полосу ноты на каждый слог. Всё это происходит на вашем Mac.
Штрафует ли оно за пение в другой октаве или чуть не в такт?Нет. Пение на октаву ниже оригинала засчитывается, а небольшое опоздание не наказывается, согласно описанию подсчёта очков.
Можно ли поделиться записью своего пения?Да. Через встроенную функцию «Поделиться» создаётся короткое видео с линией вашего голоса и высоты без звука музыки. Его можно опубликовать в Instagram, добавив трек из их собственной лицензированной музыкальной библиотеки.
Какие модели ИИ отвечают за мелодию и отслеживание вокала?OnKey использует CREPE и GAME для определения высоты и нот, wav2vec 2.0 и модель MDX-Net Karaoke 2 из UVR для разделения вокала.
Какие есть похожие проекты?stemkit, ultimatevocalremovergui, SCM, openspot-music-app, lipflow, speech-swift, tendedero, DockDoor
Автор
dsmurrell
Размер
7.8 MB
Звёзды
428
Возраст
1 мес
Коммиты · 90 дней