Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,93 @@
|
|
| 1 |
---
|
| 2 |
license: mit
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
license: mit
|
| 3 |
+
tags:
|
| 4 |
+
- rvc
|
| 5 |
+
- voice-conversion
|
| 6 |
+
- real-time
|
| 7 |
+
- audio
|
| 8 |
+
- windows
|
| 9 |
+
- cuda
|
| 10 |
---
|
| 11 |
+
|
| 12 |
+
# RVC-Realtime-GUI
|
| 13 |
+
|
| 14 |
+
**A self-contained Windows desktop application for low-latency, real-time RVC voice conversion.**
|
| 15 |
+
|
| 16 |
+
This release is a focused real-time inference client derived from
|
| 17 |
+
[RVC-WebUI](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI).
|
| 18 |
+
It is designed for live microphone use, virtual audio routing, and audio-file
|
| 19 |
+
playback through a compact CustomTkinter interface.
|
| 20 |
+
|
| 21 |
+
Source code: [niel-blue/RVC-Realtime-GUI](https://github.com/niel-blue/RVC-Realtime-GUI)
|
| 22 |
+
|
| 23 |
+
## Download
|
| 24 |
+
|
| 25 |
+
Open the **Files and versions** tab and download the archive that matches your
|
| 26 |
+
NVIDIA GPU.
|
| 27 |
+
|
| 28 |
+
| Package | Status | Use it when |
|
| 29 |
+
| --- | --- | --- |
|
| 30 |
+
| `RVC-Realtime-GUI_cu128_260728.7z` | Current standard build | You use a current NVIDIA GPU, including Blackwell-compatible environments. |
|
| 31 |
+
| CUDA 11.8 package | Coming soon | You use an older NVIDIA GPU that cannot use the CUDA 12.8 build. |
|
| 32 |
+
|
| 33 |
+
Extract the archive to a short local path, for example `C:\RVC-Realtime-GUI`.
|
| 34 |
+
Do not run it from inside the archive.
|
| 35 |
+
|
| 36 |
+
## Quick start
|
| 37 |
+
|
| 38 |
+
1. Extract the downloaded archive.
|
| 39 |
+
2. Open the `models` folder.
|
| 40 |
+
3. Start the app with `RVC-Realtime-GUI-CUDA128.bat`.
|
| 41 |
+
4. Choose a model, audio devices, and press **Start**.
|
| 42 |
+
|
| 43 |
+
The package already contains its Python runtime, PyTorch/CUDA stack, FFmpeg,
|
| 44 |
+
and inference assets. No separate Python, CUDA Toolkit, FFmpeg, or RVC-WebUI
|
| 45 |
+
installation is required.
|
| 46 |
+
|
| 47 |
+
## Adding models
|
| 48 |
+
|
| 49 |
+
Create one folder per model under `models`:
|
| 50 |
+
|
| 51 |
+
```text
|
| 52 |
+
models/
|
| 53 |
+
MyVoice/
|
| 54 |
+
MyVoice.pth
|
| 55 |
+
added_MyVoice.index
|
| 56 |
+
preview.png
|
| 57 |
+
```
|
| 58 |
+
|
| 59 |
+
- The **folder name** is shown as the model name in the app.
|
| 60 |
+
- Put the model `.pth` and its `added_*.index` file in the same folder.
|
| 61 |
+
- An optional `.png`, `.jpg`, or `.jpeg` image in that folder is shown as the
|
| 62 |
+
model preview.
|
| 63 |
+
|
| 64 |
+
Restart the app or use **Reload** after adding or changing a model.
|
| 65 |
+
|
| 66 |
+
## Features
|
| 67 |
+
|
| 68 |
+
- Real-time RVC inference with CUDA Graph warm-up
|
| 69 |
+
- WASAPI and native ASIO audio-device routing
|
| 70 |
+
- Separate input, output, and monitor devices
|
| 71 |
+
- Model gallery with previews and model-specific general settings
|
| 72 |
+
- Audio-file input through bundled FFmpeg
|
| 73 |
+
- WAV recording: separate input/output files, mixed recording, or split L/R
|
| 74 |
+
- Japanese and English interface
|
| 75 |
+
- Runtime log viewer, log export, and recording status display
|
| 76 |
+
|
| 77 |
+
## Notes
|
| 78 |
+
|
| 79 |
+
- This release is for **Windows and NVIDIA GPUs**.
|
| 80 |
+
- Start with conservative chunk and buffer settings, then lower latency only
|
| 81 |
+
after confirming stable audio on your device chain.
|
| 82 |
+
- ASIO and WASAPI can differ substantially by driver and virtual-audio setup.
|
| 83 |
+
- RVC models are not interchangeable with this package unless they are valid
|
| 84 |
+
RVC `.pth` models. Use only voices and audio material you are authorized to
|
| 85 |
+
use.
|
| 86 |
+
|
| 87 |
+
## License and attribution
|
| 88 |
+
|
| 89 |
+
RVC-Realtime-GUI is based on
|
| 90 |
+
[RVC-Project/Retrieval-based-Voice-Conversion-WebUI](https://github.com/RVC-Project/Retrieval-based-Voice-Conversion-WebUI).
|
| 91 |
+
See the included `LICENSE` and `NOTICE.md` files, and the
|
| 92 |
+
[source repository](https://github.com/niel-blue/RVC-Realtime-GUI), for
|
| 93 |
+
attribution and license details.
|