diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 5 insertions, 3 deletions
@@ -75,9 +75,9 @@ python audiobook.py --input-file the_odyssey.epub --output-file the_odyssey.mp3 | Flag | Example | Description | | ---------------------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--backend {audiocpp,qwen,faster}` | `audiocpp` | TTS server to use (default `audiocpp`). | +| `--backend {audiocpp,qwen,faster}` | `audiocpp` | TTS server to use. Required: there is no default backend. | | `--format {mp3,m4b,ogg,flac}` | `m4b` | Output format (default: the `AUDIO_FORMAT` setting in `app/converter/config.py`, `m4b`). | -| `--voice <name>` | `narrator` | Voice to request. For `faster` this is the key in `voices.json`. For the Qwen CustomVoice model this is the speaker (Ryan, Vivian, etc.) | +| `--voice <name>` | `Vivian` | Voice to request. For `faster` this is the key in `voices.json` (required). For the Qwen CustomVoice model this is the speaker (Ryan, Vivian, etc.). | | `--input <dir>` | `./input` | Directory containing the books to convert (default: the `INPUT_DIR` setting in `app/converter/config.py`, `./input`; relative paths resolve against the project root). | | `--output <dir>` | `./output` | Directory to write finished audiobooks to (default: the `OUTPUT_DIR` setting in `app/converter/config.py`, `./output`). | | `--input-file <file>` | `books/dune.epub` | Convert one specific book (`.txt`/`.pdf`/`.epub`) | @@ -88,7 +88,7 @@ python audiobook.py --input-file the_odyssey.epub --output-file the_odyssey.mp3 | `--language <lang>` | `English` | Output language for the synthesized speech. May add an accent even if the text is English. | | `--debug` | | Dump each chunk's raw audio and sent text to `debug/` and log every request. Forces the `DEBUG` setting in `app/converter/config.py` on for this run. | | `--api-url <url>` | `http://10.20.30.40:8080` | URL of a remote TTS server. Accepts `host:port` or a full `http(s)://` URL. | -| `--model <id>` | `qwen3_tts_1_7b_base_q8_0` | `audiocpp`: Choose the TTS model from `server.json` | +| `--model <id>` | `qwen3_tts_1_7b_base_q8_0` | `audiocpp`: Choose the TTS model from `server.json` (required on multi-model servers; auto-selected on single-model servers) | | `--option KEY=VALUE` | `emotion=neutral` | `audiocpp`: Some models support custom options with this (e.g. `emotion=neutral`) | | Flag | Example | Description | @@ -98,6 +98,8 @@ python audiobook.py --input-file the_odyssey.epub --output-file the_odyssey.mp3 | `--no-transcription` | | Skip auto-transcription of the reference audio. | Other options and defaults are configured in `app/converter/config.py` +(server URLs, output settings, etc.). The backend, model and voice are +always chosen per run — there are no config defaults for them. ## Manual TTS Backend Setup |