ultimatevocalremovergui README

The project's README from github.com/Anjok07/ultimatevocalremovergui. As one markdown file: README.md.

Ultimate Vocal Remover GUI v5.6

Release Downloads

About

This application uses state-of-the-art source separation models to remove vocals from audio files. UVR's core developers trained all of the models provided in this package (except for the Demucs v3 and v4 4-stem models).

Installation

These bundles contain the UVR interface, Python, PyTorch, and other dependencies needed to run the application effectively. No prerequisites are required.

Windows Installation

Windows Manual Installation

Manual Windows Installation

  • Download and extract the repository here
  • Download and install Python here
    • Make sure to check "Add python.exe to PATH" during the install
  • Run the following commands from the extracted repo directory:
python.exe -m pip install -r requirements.txt

If you have a compatible Nvidia GPU, run the following command:

python.exe -m pip install --upgrade torch --extra-index-url https://download.pytorch.org/whl/cu117

If you do not have FFmpeg or Rubber Band installed and want to avoid going through the process of installing them the long way, follow the instructions below.

FFmpeg Installation

  • Download the precompiled build here
  • From the archive, extract the following file to the UVR application directory:
    • ffmpeg-5.1.2-essentials_build/bin/ffmpeg.exe

Rubber Band Installation

In order to use the Time Stretch or Change Pitch tool, you'll need Rubber Band.

  • Download the precompiled build here
  • From the archive, extract the following files to the UVR application directory:
    • rubberband-3.1.2-gpl-executable-windows/rubberband.exe
    • rubberband-3.1.2-gpl-executable-windows/sndfile.dll

MacOS Installation

MacOS Users: Having Trouble Opening UVR?

Due to Apples strict application security, you may need to follow these steps to open UVR.

First, run the following command via Terminal.app to allow applications to run from all sources (it's recommended that you re-enable this once UVR opens properly.)

sudo spctl --master-disable

Second, run the following command to bypass Notarization:

sudo xattr -rd com.apple.quarantine /Applications/Ultimate\ Vocal\ Remover.app
Manual MacOS Installation

Manual MacOS Installation

  • Download and save this repository here
  • Download and install Python 3.10 here
  • From the saved directory run the following -
pip3 install -r requirements.txt
  • If your Mac is running with an M1, please run the following command next. If not, skip this step. -
cp /Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages/_soundfile_data/libsndfile_arm64.dylib /Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages/_soundfile_data/libsndfile.dylib

FFmpeg Installation

  • Once everything is done installing, download the correct FFmpeg binary for your system here and place it into the main application directory.

Rubber Band Installation

In order to use the Time Stretch or Change Pitch tool, you'll need Rubber Band.

  • Download the precompiled build here
  • From the archive, extract the following files to the UVR/lib_v5 application directory:
    • rubberband-3.1.2-gpl-executable-macos/rubberband

This process has been tested on a MacBook Pro 2021 (using M1) and a MacBook Air 2017 and is confirmed to be working on both.

Linux Installation (Updated Instructions)

See Linux Installation Instructions

These installation instructions are for Debian & Arch-based Linux systems.


Step 1: Download the Repository

  • Download and save this repository from GitHub.
  • Extract the downloaded file to a directory of your choice.

Step 2: Install Dependencies

Use the following commands based on your system type:

For Debian-based systems (Ubuntu, Mint, etc.):

sudo apt update && sudo apt upgrade
sudo apt-get install -y ffmpeg python3-pip python3-tk

For Arch-based systems (EndeavourOS):

sudo pacman -Syu
sudo pacman -S ffmpeg python-pip tk

Setting up a virtual environment (venv) ensures that the program's dependencies do not interfere with system-wide Python packages.

  1. Navigate to the extracted repository directory:

    cd /path/to/ultimatevocalremovergui
    
  2. Create a virtual environment:

    python3 -m venv venv
    
  3. Activate the virtual environment:

    • For Debian-based and Arch-based systems:
      source venv/bin/activate
      
  4. Install dependencies in the virtual environment:

    pip install -r requirements.txt
    

Step 4: Run the Application

While the virtual environment is activated, start the application:

python UVR.py

Important Notes

  1. Avoid Modifying System Files:
    Previous instructions suggested deleting the /usr/lib/python3.11/EXTERNALLY-MANAGED file, which is dangerous and can break Python package management. Do NOT delete this file.

  2. Why Use Virtual Environments?
    Virtual environments isolate the program's dependencies, preventing conflicts with system Python packages. More information is available here.

  3. Known Issues and Discussions:


If you encounter issues, refer to the GitHub Issues page for help.

Other Application Notes

Performance:

Troubleshooting

Common Issues

MacOS Sonoma Left-click Bug

There's a known issue on MacOS Sonoma where left-clicks aren't registering correctly within the app. This was impacting all applications built with Tkinter on Sonoma and has since been resolved. Please download the latest version via the following link if you are still experiencing issues - link

This issue was being tracked here.

Issue Reporting

Please be as detailed as possible when posting a new issue.

If possible, click the "Settings Button" to the left of the "Start Processing" button and click the "Error Log" button for detailed error information that can be provided to us.

License

The Ultimate Vocal Remover GUI code is MIT-licensed.

Credits

Contributing

References

ultimatevocalremovergui (Anjok07/ultimatevocalremovergui)

Searching Database…

Что это такое?UVR — бесплатное приложение для компьютера, которое удаляет вокал из аудиофайлов с помощью современных ИИ-моделей разделения источников. Пригодится для караоке-минусовок, инструменталов и сэмплов.
Это программа, которую надо установить, или Python-библиотека для импорта в свой код?Это отдельное приложение с графическим интерфейсом, а не библиотека для кода. В скачиваемом пакете уже есть сам интерфейс, Python, PyTorch и все остальные зависимости — ничего предварительно устанавливать не нужно.
Как его установить?Скачайте пакет по ссылкам из README — установщик для Windows или dmg для macOS с отдельными сборками под M1 и Intel — и просто запустите его. На Linux (Debian или Arch) устанавливается вручную из репозитория внутри виртуального окружения Python.
Какие аудиоформаты он понимает?Файлы WAV работают сразу, а для любых других форматов понадобится установленный FFmpeg. Если добавить библиотеку Rubber Band, откроются инструменты Time Stretch и Change Pitch.
Есть ли подводные камни при установке?В Windows устанавливать нужно только на основной диск C:\, иначе программа работает нестабильно. На macOS может понадобиться обход Gatekeeper, а первый запуск может занять 5–10 минут. Ошибки нехватки памяти лечатся уменьшением размера Segment или Window.
Будет ли работать на Mac или это только для Windows?Работает на Windows 10 и новее, macOS Big Sur и выше (и на Apple Silicon, и на Intel), а на Debian и Arch-подобном Linux ставится вручную. Только 64-битные системы: Windows 7 и старше, процессоры Pentium и Celeron, а также старые недорогие Mac не поддерживаются.
Оно бесплатное? Могу ли я использовать модели в своём приложении?Код распространяется по лицензии MIT, проект полностью бесплатный. Есть один нюанс: сторонние разработчики, использующие модели UVR в своих приложениях, обязаны указывать авторство UVR и его разработчиков.
Нужна ли мощная видеокарта?Видеокарта не обязательна, но сильно ускоряет работу: для обработки на GPU нужна как минимум Nvidia GTX 1060 с 6 ГБ памяти, а лучше 8 ГБ и больше. Поддержка AMD Radeon ограничена (для Windows есть сборка на DirectML), зато чипы Mac M1 получают ускорение через MPS.
Какие ИИ-модели в него входят?В комплекте несколько архитектур: MDX-Net, VR Architecture и Demucs. Все модели в пакете обучены самими основными разработчиками проекта — исключение составляют только 4-стемные модели Demucs v3 и v4.
Минусовка тоже получится, или только вокал вырезается?Минусовка тоже остаётся — модели разделяют запись на вокал и остальную часть микса, так что на выходе получаются обе дорожки.
Что он умеет ещё, кроме разделения вокала?Есть встроенные инструменты Time Stretch и Change Pitch (на движке Rubber Band), программа запоминает ваши настройки между сеансами, а в версии v5.6 ускорились загрузка моделей и импорт/экспорт аудио.
У меня уже стоит старая версия UVR — придётся переустанавливать всё заново?Нет — можно установить пакет обновления поверх существующей копии, скачать обновление прямо из программы или взять отдельный патч.
Creator
Anjok07
Size
547.8 MB
Stars
26.7K
Age
6y
Commits · 90 Days