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 是一款免费的桌面软件,利用先进的 AI 音源分离模型从音频文件中去除人声——非常适合制作卡拉OK伴奏、纯音乐伴奏和采样。
这是需要安装的桌面软件,还是我要在自己代码里导入的 Python 库?它是一个独立的桌面图形界面应用,不是代码库。下载包把界面连同 Python、PyTorch 和其他所有依赖都打包在一起,所以不需要提前安装任何东西。
我怎么安装它?从 README 里的链接下载安装包——Windows 安装程序,或 macOS dmg(分 M1 版和 Intel 版)——然后直接运行就行。在基于 Debian 或 Arch 的 Linux 上,则需要在 Python 虚拟环境中从仓库手动安装。
它支持哪些音频格式?WAV 文件开箱即用,但要处理其他任何格式,需要先安装 FFmpeg。添加 Rubber Band 库后,还能解锁变速(Time Stretch)和变调(Change Pitch)这两个工具。
安装上有什么坑需要提前知道?在 Windows 上必须安装到主 C:\ 盘,否则会不稳定;macOS 可能需要用命令绕过 Gatekeeper,而且首次启动可能要等 5 到 10 分钟;如果出现内存分配错误,调低 Segment 或 Window size 就能解决。
我的 Mac 上能用吗,还是只有 Windows 能用?它支持 Windows 10 及更新版本、macOS Big Sur 及以上(Apple Silicon 和 Intel 芯片都行),另外在 Debian 和 Arch 系的 Linux 上可以手动安装使用。只有 64 位版本——Windows 7 或更低版本、Pentium 或 Celeron 处理器以及老款低端 Mac 都不支持。
它是免费的吗?我能把它的模型用在自己的应用里吗?代码采用 MIT 许可证,项目完全免费。唯一需要注意的是:第三方开发者如果在自己开发的软件中使用 UVR 的模型,必须注明 UVR 及其开发者的署名。
我需要很强的显卡才能运行吗?显卡不是必需的,但能大幅提升速度:用显卡转换至少需要 Nvidia GTX 1060 6GB,建议配备 8GB 以上显存。AMD Radeon 的支持比较有限(Windows 有 DirectML 版本),而 Mac 的 M1 芯片可以获得 MPS 加速。
它自带哪些 AI 模型?内置了几种架构:MDX-Net、VR Architecture 和 Demucs。包里的所有模型都由核心开发者亲自训练,唯一的例外是 Demucs v3 和 v4 的 4-stem 模型。
我能拿到伴奏吗,还是只能把人声去掉?伴奏也能拿到——模型会把音源分离成人声和其余混音,转换后两者都会输出。
除了分离人声,它还能做什么?它内置了变速(Time Stretch)和变调(Change Pitch)工具(由 Rubber Band 驱动),能记住你上次的使用设置,而且 v5.6 版本还加快了模型加载和音频导入导出的速度。
我已经装了旧版 UVR,还得全部重装吗?不用——你可以在现有版本上安装更新包,直接从软件内下载更新,或者获取独立补丁包。
Creator
Anjok07
Size
547.8 MB
Stars
26.7K
Age
6y
Commits · 90 Days