Labyricorn/voicebox
1
0
Fork 0
mirror of https://github.com/jamiepine/voicebox.git synced 2026-09-29 15:15:27 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs links

Browse Source
This commit is contained in:
James Pine
2026-03-16 05:33:33 -07:00
parent 4a8a9eac14
commit faa825290f
3 changed files with 72 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+49 -49
View File
@@ -27,10 +27,10 @@
<p align="center"> <p align="center">
<a href="https://voicebox.sh">voicebox.sh</a> • <a href="https://voicebox.sh">voicebox.sh</a> •
<a href="https://docs.voicebox.sh">Docs</a> •
<a href="#download">Download</a> • <a href="#download">Download</a> •
<a href="#features">Features</a> • <a href="#features">Features</a> •
<a href="#api">API</a> • <a href="#api">API</a>
<a href="#roadmap">Roadmap</a>
</p> </p>
<br/> <br/>
@@ -76,12 +76,12 @@ Voicebox is a **local-first voice cloning studio** — a free and open-source al
## Download ## Download
| Platform | Download | | Platform | Download |
|----------|----------| | --------------------- | ------------------------------------------------------ |
| macOS (Apple Silicon) | [Download DMG](https://voicebox.sh/download/mac-arm) | | macOS (Apple Silicon) | [Download DMG](https://voicebox.sh/download/mac-arm) |
| macOS (Intel) | [Download DMG](https://voicebox.sh/download/mac-intel) | | macOS (Intel) | [Download DMG](https://voicebox.sh/download/mac-intel) |
| Windows | [Download MSI](https://voicebox.sh/download/windows) | | Windows | [Download MSI](https://voicebox.sh/download/windows) |
| Docker | `docker compose up` | | Docker | `docker compose up` |
> **[View all binaries →](https://github.com/jamiepine/voicebox/releases/latest)** > **[View all binaries →](https://github.com/jamiepine/voicebox/releases/latest)**
@@ -95,12 +95,12 @@ Voicebox is a **local-first voice cloning studio** — a free and open-source al
Four TTS engines with different strengths, switchable per-generation: Four TTS engines with different strengths, switchable per-generation:
| Engine | Languages | Strengths | | Engine | Languages | Strengths |
|--------|-----------|-----------| | --------------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| **Qwen3-TTS** (0.6B / 1.7B) | 10 | High-quality multilingual cloning, delivery instructions ("speak slowly", "whisper") | | **Qwen3-TTS** (0.6B / 1.7B) | 10 | High-quality multilingual cloning, delivery instructions ("speak slowly", "whisper") |
| **LuxTTS** | English | Lightweight (~1GB VRAM), 48kHz output, 150x realtime on CPU | | **LuxTTS** | English | Lightweight (~1GB VRAM), 48kHz output, 150x realtime on CPU |
| **Chatterbox Multilingual** | 23 | Broadest language coverage — Arabic, Danish, Finnish, Greek, Hebrew, Hindi, Malay, Norwegian, Polish, Swahili, Swedish, Turkish and more | | **Chatterbox Multilingual** | 23 | Broadest language coverage — Arabic, Danish, Finnish, Greek, Hebrew, Hindi, Malay, Norwegian, Polish, Swahili, Swedish, Turkish and more |
| **Chatterbox Turbo** | English | Fast 350M model with paralinguistic emotion/sound tags | | **Chatterbox Turbo** | English | Fast 350M model with paralinguistic emotion/sound tags |
### Emotions & Paralinguistic Tags ### Emotions & Paralinguistic Tags
@@ -112,16 +112,16 @@ Type `/` in the text input to insert expressive tags that the model synthesizes
8 audio effects powered by Spotify's `pedalboard` library. Apply after generation, preview in real time, build reusable presets. 8 audio effects powered by Spotify's `pedalboard` library. Apply after generation, preview in real time, build reusable presets.
| Effect | Description | | Effect | Description |
|--------|-------------| | ---------------- | --------------------------------------------- |
| Pitch Shift | Up or down by up to 12 semitones | | Pitch Shift | Up or down by up to 12 semitones |
| Reverb | Configurable room size, damping, wet/dry mix | | Reverb | Configurable room size, damping, wet/dry mix |
| Delay | Echo with adjustable time, feedback, and mix | | Delay | Echo with adjustable time, feedback, and mix |
| Chorus / Flanger | Modulated delay for metallic or lush textures | | Chorus / Flanger | Modulated delay for metallic or lush textures |
| Compressor | Dynamic range compression | | Compressor | Dynamic range compression |
| Gain | Volume adjustment (-40 to +40 dB) | | Gain | Volume adjustment (-40 to +40 dB) |
| High-Pass Filter | Remove low frequencies | | High-Pass Filter | Remove low frequencies |
| Low-Pass Filter | Remove high frequencies | | Low-Pass Filter | Remove high frequencies |
Ships with 4 built-in presets (Robotic, Radio, Echo Chamber, Deep Voice) and supports custom presets. Effects can be assigned per-profile as defaults. Ships with 4 built-in presets (Robotic, Radio, Echo Chamber, Deep Voice) and supports custom presets. Effects can be assigned per-profile as defaults.
@@ -186,14 +186,14 @@ Multi-voice timeline editor for conversations, podcasts, and narratives.
### GPU Support ### GPU Support
| Platform | Backend | Notes | | Platform | Backend | Notes |
|----------|---------|-------| | ------------------------ | -------------- | ---------------------------------------------- |
| macOS (Apple Silicon) | MLX (Metal) | 4-5x faster via Neural Engine | | macOS (Apple Silicon) | MLX (Metal) | 4-5x faster via Neural Engine |
| Windows / Linux (NVIDIA) | PyTorch (CUDA) | Auto-downloads CUDA binary from within the app | | Windows / Linux (NVIDIA) | PyTorch (CUDA) | Auto-downloads CUDA binary from within the app |
| Linux (AMD) | PyTorch (ROCm) | Auto-configures HSA_OVERRIDE_GFX_VERSION | | Linux (AMD) | PyTorch (ROCm) | Auto-configures HSA_OVERRIDE_GFX_VERSION |
| Windows (any GPU) | DirectML | Universal Windows GPU support | | Windows (any GPU) | DirectML | Universal Windows GPU support |
| Intel Arc | IPEX/XPU | Intel discrete GPU acceleration | | Intel Arc | IPEX/XPU | Intel discrete GPU acceleration |
| Any | CPU | Works everywhere, just slower | | Any | CPU | Works everywhere, just slower |
--- ---
@@ -224,30 +224,30 @@ Full API documentation available at `http://localhost:17493/docs`.
## Tech Stack ## Tech Stack
| Layer | Technology | | Layer | Technology |
|-------|------------| | ------------- | ------------------------------------------------- |
| Desktop App | Tauri (Rust) | | Desktop App | Tauri (Rust) |
| Frontend | React, TypeScript, Tailwind CSS | | Frontend | React, TypeScript, Tailwind CSS |
| State | Zustand, React Query | | State | Zustand, React Query |
| Backend | FastAPI (Python) | | Backend | FastAPI (Python) |
| TTS Engines | Qwen3-TTS, LuxTTS, Chatterbox, Chatterbox Turbo | | TTS Engines | Qwen3-TTS, LuxTTS, Chatterbox, Chatterbox Turbo |
| Effects | Pedalboard (Spotify) | | Effects | Pedalboard (Spotify) |
| Transcription | Whisper / Whisper Turbo (PyTorch or MLX) | | Transcription | Whisper / Whisper Turbo (PyTorch or MLX) |
| Inference | MLX (Apple Silicon) / PyTorch (CUDA/ROCm/XPU/CPU) | | Inference | MLX (Apple Silicon) / PyTorch (CUDA/ROCm/XPU/CPU) |
| Database | SQLite | | Database | SQLite |
| Audio | WaveSurfer.js, librosa | | Audio | WaveSurfer.js, librosa |
--- ---
## Roadmap ## Roadmap
| Feature | Description | | Feature | Description |
|---------|-------------| | ----------------------- | ---------------------------------------------- |
| **Real-time Streaming** | Stream audio as it generates, word by word | | **Real-time Streaming** | Stream audio as it generates, word by word |
| **Voice Design** | Create new voices from text descriptions | | **Voice Design** | Create new voices from text descriptions |
| **More Models** | XTTS, Bark, and other open-source voice models | | **More Models** | XTTS, Bark, and other open-source voice models |
| **Plugin Architecture** | Extend with custom models and effects | | **Plugin Architecture** | Extend with custom models and effects |
| **Mobile Companion** | Control Voicebox from your phone | | **Mobile Companion** | Control Voicebox from your phone |
--- ---
landing/src/components/Footer.tsx
+10
View File
@@ -50,6 +50,16 @@ export function Footer() {
<div> <div>
<h4 className="text-sm font-semibold mb-3">Resources</h4> <h4 className="text-sm font-semibold mb-3">Resources</h4>
<ul className="space-y-2 text-sm text-muted-foreground"> <ul className="space-y-2 text-sm text-muted-foreground">
<li>
<Link
href="https://docs.voicebox.sh"
target="_blank"
rel="noopener noreferrer"
className="hover:text-foreground transition-colors"
>
Documentation
</Link>
</li>
<li> <li>
<Link <Link
href={GITHUB_REPO} href={GITHUB_REPO}
landing/src/components/Navbar.tsx
+13 -5
View File
@@ -32,9 +32,9 @@ export function Navbar() {
return ( return (
<nav className="fixed inset-x-0 top-0 z-50 border-b border-border/50 bg-background/80 backdrop-blur-xl"> <nav className="fixed inset-x-0 top-0 z-50 border-b border-border/50 bg-background/80 backdrop-blur-xl">
<div className="mx-auto flex max-w-7xl items-center justify-between px-6 py-3"> <div className="mx-auto grid max-w-7xl grid-cols-3 items-center px-6 py-3">
{/* Logo + wordmark */} {/* Logo + wordmark */}
<a href="/" className="flex items-center gap-2.5"> <a href="/" className="flex items-center gap-2.5 justify-self-start">
<Image <Image
src="/voicebox-logo-app.webp" src="/voicebox-logo-app.webp"
alt="Voicebox" alt="Voicebox"
@@ -45,8 +45,8 @@ export function Navbar() {
<span className="text-[15px] font-semibold text-foreground">Voicebox</span> <span className="text-[15px] font-semibold text-foreground">Voicebox</span>
</a> </a>
{/* Nav links */} {/* Nav links - centered */}
<div className="hidden sm:flex items-center gap-1"> <div className="hidden sm:flex items-center gap-1 justify-self-center">
<a <a
href="#features" href="#features"
className="rounded-md px-3 py-1.5 text-sm font-medium text-muted-foreground transition-colors hover:text-foreground" className="rounded-md px-3 py-1.5 text-sm font-medium text-muted-foreground transition-colors hover:text-foreground"
@@ -65,6 +65,14 @@ export function Navbar() {
> >
Download Download
</a> </a>
<a
href="https://docs.voicebox.sh"
target="_blank"
rel="noopener noreferrer"
className="rounded-md px-3 py-1.5 text-sm font-medium text-muted-foreground transition-colors hover:text-foreground"
>
Docs
</a>
</div> </div>
{/* GitHub star button */} {/* GitHub star button */}
@@ -72,7 +80,7 @@ export function Navbar() {
href={GITHUB_REPO} href={GITHUB_REPO}
target="_blank" target="_blank"
rel="noopener noreferrer" rel="noopener noreferrer"
className="flex items-center gap-2 rounded-lg border border-border/60 bg-card/60 px-3 py-1.5 text-sm text-muted-foreground transition-colors hover:text-foreground hover:border-border" className="flex items-center gap-2 justify-self-end rounded-lg border border-border/60 bg-card/60 px-3 py-1.5 text-sm text-muted-foreground transition-colors hover:text-foreground hover:border-border"
> >
<Github className="h-4 w-4" /> <Github className="h-4 w-4" />
<span className="text-[13px] font-medium">Star</span> <span className="text-[13px] font-medium">Star</span>