teddybear082 commited on
Commit Β·
effa59f
1
Parent(s): 6d8882c
Enhance README with text preprocessing and duration update
Browse filesAdded text preprocessing option and updated voice duration guidelines.
README.md
CHANGED
|
@@ -13,6 +13,7 @@ Tested and working fully with [WingmanAI by Shipbit](https://www.wingman-ai.com/
|
|
| 13 |
- π³ **Docker Ready** - One-command deployment
|
| 14 |
- π» **Cross-platform** - Runs on Windows, macOS, and Linux
|
| 15 |
- β‘ **CPU Optimized** - No GPU required
|
|
|
|
| 16 |
|
| 17 |
## Quick Start
|
| 18 |
|
|
@@ -70,6 +71,9 @@ python server.py --port 8080 --voices-dir ./my_voices
|
|
| 70 |
|
| 71 |
# Enable streaming by default
|
| 72 |
python server.py --stream
|
|
|
|
|
|
|
|
|
|
| 73 |
```
|
| 74 |
|
| 75 |
### Option 3: Windows Executable
|
|
@@ -182,7 +186,7 @@ with client.audio.speech.with_streaming_response.create(
|
|
| 182 |
|
| 183 |
### Voice File Guidelines
|
| 184 |
|
| 185 |
-
- **Duration:** 3-
|
| 186 |
- **Quality:** Clean audio without background noise
|
| 187 |
- **Format:** WAV, MP3, or FLAC
|
| 188 |
- **Tip:** Use [Adobe Podcast Enhance](https://podcast.adobe.com/enhance) to clean noisy samples
|
|
@@ -198,16 +202,17 @@ The `voices/` directory includes 150+ community-contributed voices.
|
|
| 198 |
|
| 199 |
### Environment Variables
|
| 200 |
|
| 201 |
-
| Variable
|
| 202 |
-
| ---------------------------
|
| 203 |
-
| `POCKET_TTS_HOST`
|
| 204 |
-
| `POCKET_TTS_PORT`
|
| 205 |
-
| `POCKET_TTS_VOICES_DIR`
|
| 206 |
-
| `POCKET_TTS_MODEL_PATH`
|
| 207 |
-
| `POCKET_TTS_STREAM_DEFAULT`
|
| 208 |
-
| `
|
| 209 |
-
| `
|
| 210 |
-
| `
|
|
|
|
| 211 |
|
| 212 |
### Docker Compose Options
|
| 213 |
|
|
@@ -230,6 +235,7 @@ pocket-tts-openai_streaming_server/
|
|
| 230 |
β βββ services/ # Business logic
|
| 231 |
β βββ audio.py # Audio conversion
|
| 232 |
β βββ tts.py # TTS service
|
|
|
|
| 233 |
βββ static/ # Web UI assets
|
| 234 |
βββ templates/ # HTML templates
|
| 235 |
βββ voices/ # Voice files
|
|
|
|
| 13 |
- π³ **Docker Ready** - One-command deployment
|
| 14 |
- π» **Cross-platform** - Runs on Windows, macOS, and Linux
|
| 15 |
- β‘ **CPU Optimized** - No GPU required
|
| 16 |
+
- π€ **Text pre-processing** - Clean text for words and symbols TTS usually has difficulty with, automatically
|
| 17 |
|
| 18 |
## Quick Start
|
| 19 |
|
|
|
|
| 71 |
|
| 72 |
# Enable streaming by default
|
| 73 |
python server.py --stream
|
| 74 |
+
|
| 75 |
+
# Enable text preprocessing
|
| 76 |
+
python server.py --text-preprocess
|
| 77 |
```
|
| 78 |
|
| 79 |
### Option 3: Windows Executable
|
|
|
|
| 186 |
|
| 187 |
### Voice File Guidelines
|
| 188 |
|
| 189 |
+
- **Duration:** 3-15 seconds of clear speech works best
|
| 190 |
- **Quality:** Clean audio without background noise
|
| 191 |
- **Format:** WAV, MP3, or FLAC
|
| 192 |
- **Tip:** Use [Adobe Podcast Enhance](https://podcast.adobe.com/enhance) to clean noisy samples
|
|
|
|
| 202 |
|
| 203 |
### Environment Variables
|
| 204 |
|
| 205 |
+
| Variable | Default | Description |
|
| 206 |
+
| ------------------------------------| ---------- | -------------------------------------- |
|
| 207 |
+
| `POCKET_TTS_HOST` | `0.0.0.0` | Server bind address |
|
| 208 |
+
| `POCKET_TTS_PORT` | `49112` | Server port |
|
| 209 |
+
| `POCKET_TTS_VOICES_DIR` | `./voices` | Custom voices directory |
|
| 210 |
+
| `POCKET_TTS_MODEL_PATH` | - | Custom model path |
|
| 211 |
+
| `POCKET_TTS_STREAM_DEFAULT` | `true` | Enable streaming by default |
|
| 212 |
+
| `POCKET_TTS_TEXT_PREPROCESS_DEFAULT`| `true` | Enable text preprocessing by default |
|
| 213 |
+
| `POCKET_TTS_LOG_LEVEL` | `INFO` | Log level: DEBUG, INFO, WARNING, ERROR |
|
| 214 |
+
| `POCKET_TTS_LOG_DIR` | `./logs` | Log files directory |
|
| 215 |
+
| `HF_TOKEN` | - | Hugging Face token (for voice cloning) |
|
| 216 |
|
| 217 |
### Docker Compose Options
|
| 218 |
|
|
|
|
| 235 |
β βββ services/ # Business logic
|
| 236 |
β βββ audio.py # Audio conversion
|
| 237 |
β βββ tts.py # TTS service
|
| 238 |
+
| |-- preprocess.py # Text preprocessor
|
| 239 |
βββ static/ # Web UI assets
|
| 240 |
βββ templates/ # HTML templates
|
| 241 |
βββ voices/ # Voice files
|