aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 17 insertions, 14 deletions
diff --git a/README.md b/README.md
index c405e75..63f5944 100644
--- a/README.md
+++ b/README.md
@@ -16,46 +16,49 @@ dependencies and models automatically.
```bash
git clone https://git.historia.vg/git/producer
./producer.sh setup
-./producer.sh process recording.wav
+./producer.sh recording.wav
```
First run installs the runtime into `lib/runtime/` and may take a few minutes.
+The `process` keyword is optional; `./producer.sh process recording.wav` is
+equivalent.
The master WAV is always **mono, 32-bit PCM**, at 48 kHz (default) or 44.1
kHz; stereo inputs must be downmixed to mono first. MP3 is encoded as
constant bitrate at 192 kb/s by default. Loudness is normalized to **-19
-LUFS with a -1.5 dBTP true-peak ceiling**. A diagnostic report for each run
-is written to a `logs/` directory next to the outputs, not beside the audio.
+LUFS with a -1.5 dBTP true-peak ceiling**.
### Examples
-```bash
# Optional MP3 alongside the WAV
-./producer.sh process recording.wav --mp3
+./producer.sh recording.wav --mp3
# Other sound profiles
-./producer.sh process recording.wav --profile narrator
-./producer.sh process recording.wav --profile radio
+./producer.sh recording.wav --profile narrator
+./producer.sh recording.wav --profile radio
# Process several files at once
-./producer.sh process take1.wav take2.wav --mp3
+./producer.sh take1.wav take2.wav --mp3
# Write outputs somewhere else
-./producer.sh process recording.wav --output-dir delivery --mp3
+./producer.sh recording.wav --output-dir delivery --mp3
# Skip AI noise removal (FFT fallback or none at all)
-./producer.sh process recording.wav --denoiser fft
-./producer.sh process recording.wav --no-denoise
+./producer.sh recording.wav --denoiser fft
+./producer.sh recording.wav --no-denoise
# LibriVox-style delivery file: 44.1 kHz, 128 kbps CBR, -19 LUFS, mono
-./producer.sh process recording.wav \
+./producer.sh recording.wav \
--sample-rate 44100 --mp3 --mp3-bitrate 128 \
--target-lufs -19 --true-peak-db -1.5
```
All of these settings are configurable; run `./producer.sh config` to see every
-setting and its default, or `--help` on any command for the flags. A fully
-documented example config lives at `lib/project/examples/voice.toml`.
+setting and its default, or `--help` on any command for the flags. A
+`config.toml` in the same directory as `producer.sh` is loaded automatically:
+`./producer.sh config` then shows those resolved values, and an explicit
+`--config FILE` or any CLI flag still overrides it. The shipped `config.toml`
+documents every setting.
## Profiles