- Created user-friendly quick reference card - Clear decision guide for choosing between engines - Quick start instructions for both engines - Feature comparison table - Troubleshooting tips and pro tips - Links to detailed documentation Makes it easy for users to understand and choose the right engine.
3.2 KiB
3.2 KiB
TTS Engine Quick Reference
🎯 Which Engine Should I Use?
Use Kokoro TTS (Default) if you want:
- ✅ Zero setup - works immediately
- ✅ High quality voices
- ✅ Many voices - 54 voices, 9 languages
- ✅ Multiple languages - English, French, Japanese, Spanish, etc.
Use Piper TTS if you want:
- ✅ Pitch control - adjust voice pitch per character
- ✅ Fast synthesis - quicker generation
- ✅ Lower memory - smaller models
- ⚠️ Manual setup required - one-time voice download
🚀 Quick Start
Kokoro TTS (No Setup)
- Start the app
- It just works! ✨
Piper TTS (3-Minute Setup)
- Install Piper:
cd backend && ./install_piper.sh - Download voices from: https://github.com/rhasspy/piper/releases/tag/v1.2.0
- Place
.onnxand.onnx.jsonfiles inbackend/piper_models/ - Done! See
backend/PIPER_SETUP.mdfor details
🎛️ How to Switch Engines
In the UI:
- Go to Voice Assignment screen
- Click "Kokoro TTS" or "Piper TTS" button
- Voice dropdown updates automatically
Via API:
curl -X POST http://localhost:8000/api/tts/engines \
-H "Content-Type: application/json" \
-d '{"engine": "piper"}'
Via Environment Variable:
# In backend/.env
TTS_ENGINE=piper # or kokoro
🎵 Pitch Control (Piper Only)
Adjust voice pitch per character in semitones:
+12 = Very high (one octave up)
+6 = Child-like
+3 = Slightly higher (feminine)
0 = Original voice
-3 = Slightly lower (masculine)
-6 = Deep voice
-12 = Very deep (one octave down)
Recommended:
- Female characters: +2 to +5
- Male characters: -2 to -5
- Children: +5 to +8
📊 Feature Comparison
| Feature | Kokoro | Piper |
|---|---|---|
| Setup | None | Manual |
| Quality | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐ |
| Speed | Medium | Fast |
| Voices | 54 | 5+ |
| Languages | 9 | English |
| Pitch Control | ❌ | ✅ |
| Memory | 500MB | 10-50MB |
🔧 Troubleshooting
"Voice preview failed"
- Kokoro: Check internet connection (first-time model download)
- Piper: Download voice models manually (see PIPER_SETUP.md)
"Voice model not found"
- Download
.onnxand.onnx.jsonfiles - Place in
backend/piper_models/ - Restart backend server
"Piper not found"
- Run
./install_piper.sh - Or install from: https://github.com/rhasspy/piper/releases
📚 Documentation
- Piper Setup:
backend/PIPER_SETUP.md - Piper Guide:
backend/PIPER_TTS_GUIDE.md - Status:
PIPER_STATUS.md - Full Details:
PIPER_TTS_INTEGRATION.md
💡 Pro Tips
- Start with Kokoro - Try it first, it's easier
- Try Piper for variety - Pitch control adds character depth
- Mix engines - Use Kokoro for most, Piper for special characters
- Download multiple voices - More variety in your audiobooks
- Test voices - Use preview button before generating full audiobook
🆘 Need Help?
- Check
backend/PIPER_SETUP.mdfor setup - Run
python test_piper_direct.pyto test Piper - Check backend logs for detailed errors
- Fall back to Kokoro if Piper has issues
Remember: Both engines work great! Kokoro is easier, Piper is more advanced. Choose based on your needs. 🎉