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…

26.7K ·GitHub
Ultimatevocalremovergui
What is this?UVR is a free desktop app that removes vocals from audio files using state-of-the-art AI source-separation models — handy for karaoke tracks, instrumentals and sampling.
Is this a desktop app I install, or a Python library I import into my own code?It is a standalone desktop GUI application, not a code library. The downloads bundle the interface together with Python, PyTorch and every other dependency, so there is nothing to install first.
How do I get it installed?Download a bundle from the README links — a Windows installer or a macOS dmg with separate M1 and Intel builds — and just run it. On Debian or Arch-based Linux you install it manually from the repo inside a Python virtual environment.
Which audio formats can I feed it?WAV files work out of the box, but converting any other format requires FFmpeg to be installed. Adding the Rubber Band library unlocks the Time Stretch and Change Pitch tools.
Are there any install gotchas I should know about?On Windows you must install to the main C:\ drive or it becomes unstable, macOS may need Gatekeeper bypass commands and can take 5-10 minutes to start the first time, and memory allocation errors are fixed by lowering the Segment or Window size.
Will it work on my Mac, or is it Windows-only?It runs on Windows 10 and newer, macOS Big Sur and above (both Apple Silicon and Intel), plus Debian and Arch-based Linux via manual install. It is 64-bit only — Windows 7 or lower, Pentium or Celeron CPUs and older budget Macs are not supported.
Is it free, and can I use the models in my own app?The code is MIT-licensed and the project is 100% free. The one catch: third-party developers who use UVR's models in their own applications must credit UVR and its developers.
Do I need a powerful GPU to run it?A GPU is optional but speeds things up a lot: GPU conversion needs at least an Nvidia GTX 1060 6GB, and 8GB+ of VRAM is recommended. AMD Radeon support is limited (Windows has a DirectML build), while Mac M1 chips get MPS acceleration.
Which AI models does it ship with?Several architectures are included: MDX-Net, VR Architecture and Demucs. The core developers trained every model in the package themselves — the only exceptions are the Demucs v3 and v4 4-stem models.
Do I get the instrumental too, or just the vocals stripped out?You get the instrumental as well — the models separate the source into vocals and the rest of the mix, so both come out of a conversion.
What else can it do besides splitting vocals?It has built-in Time Stretch and Change Pitch tools (powered by Rubber Band), remembers your settings between sessions, and v5.6 brought faster model loading and audio import/export.
I already have an older UVR — do I have to reinstall everything?No — you can install an update package over your existing copy, download the update straight from the application, or grab the standalone patch.
What are similar projects?stemkit, demucs, spleeter, stemdeck, Retrieval-based-Voice-Conversion-WebUI, audiocraft, pyannote-audio, so-vits-svc
Which topics is it in?karaoke, audio-processing, music, ffmpeg, neural-network, audio, nvidia, pytorch, deep-learning, gpu, gui, machine-learning
Creator
Anjok07
Size
547.8 MB
Stars
26.7K
Updated
CommitOct 06Releasev5.6Sep 26
Age
6y
Commits · 90 Days