aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhistoria <historiavg@proton.me>2026-09-15 14:52:09 -0400
committerhistoria <historiavg@proton.me>2026-09-15 14:52:09 -0400
commit109c5add348b18763a10718f1d9bf4553d9ff3bd (patch)
tree43b7279b76619ef64a0edc9b593ab1b32b9eb8a3
parent9605a98c964c9c60c2bc6fb8cb69af988a7fdde1 (diff)
downloadproducer-109c5add348b18763a10718f1d9bf4553d9ff3bd.tar.gz
readme
-rw-r--r--README.md78
1 files changed, 3 insertions, 75 deletions
diff --git a/README.md b/README.md
index 075d6ae..d43e629 100644
--- a/README.md
+++ b/README.md
@@ -21,14 +21,9 @@ git clone https://git.historia.vg/git/producer
./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.
+First run installs the runtime into `lib/runtime/`
-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**.
+The master WAV is **mono, 32-bit PCM**. Loudness is normalized to **-19 LUFS with a -1.5 dBTP true-peak ceiling**. In `config.toml` you can edit the sample rate (48/44.1 kHz), MP3 bitrate, loudness, etc.
### Examples
```
@@ -39,33 +34,9 @@ LUFS with a -1.5 dBTP true-peak ceiling**.
./producer.sh recording.wav --profile narrator
./producer.sh recording.wav --profile radio
-# Settings that differ from the built-in profile are named 'custom'
-./producer.sh recording.wav --no-denoise # recording.custom.wav
-
# Process several files at once
./producer.sh take1.wav take2.wav --mp3
-# Write outputs somewhere else
-./producer.sh recording.wav --output-dir delivery --mp3
-
-# Skip AI noise removal (FFT fallback or none at all)
-./producer.sh recording.wav --denoiser fft
-./producer.sh recording.wav --no-denoise
-
-# Compare ClearVoice MossFormer2_SE_48K with DeepFilterNet3
-# (larger download; speech preservation depends on the recording)
-./producer.sh recording.wav --denoiser clearvoice
-./producer.sh setup --denoiser clearvoice --device cpu
-
-# Silence pauses without changing the timing (enabled in config.toml)
-./producer.sh recording.wav --pause-silence --no-trim-silence
-
-# Bypass pause silencing for an A/B comparison
-./producer.sh recording.wav --no-pause-silence --output-dir comparison
-
-# Optionally shorten long gaps between takes (a separate pacing edit)
-./producer.sh recording.wav --trim-silence --max-gap-s 1.5 --gap-pad-s 0.6
-
# LibriVox-style delivery file: 44.1 kHz, 128 kbps CBR, -19 LUFS, mono
./producer.sh recording.wav \
--sample-rate 44100 --mp3 --mp3-bitrate 128 \
@@ -95,52 +66,9 @@ it with Ctrl-C.
| `radio` | Stronger compression, more warmth/presence, tighter range |
| `cleanup-only` | Denoise + highpass only; no EQ, dynamics or normalization |
-## Speech starts and silent pauses
-
-Pause silencing detects speech on the **pre-denoise** audio with pinned Silero
-VAD v5.1 ONNX weights (a ~2.3 MB CPU-only download on first use). After
-EQ/dynamics, gaps outside protected speech fade to zero before loudness
-normalization, leaving the timeline unchanged unless you enable
-`--trim-silence`. Defaults protect 120 ms before and after detections, use
-10 ms fades, and require an 80 ms silent core; shorter gaps are left alone.
-Enable it in `config.toml` (`pause_silence = true`) or with `--pause-silence`.
-
-- `--pause-threshold 0.35`: lower = preserve more possible speech.
-- `--pause-pre-ms` / `--pause-post-ms`: padding around detected speech.
-- `--pause-min-ms` / `--pause-fade-ms`: silent core and fade lengths.
-- `--no-pause-silence`: bypass this stage; combine with `--no-denoise` to
- avoid all AI model/runtime downloads.
-
-The detector can miss whispers, breaths, or unusual speech; if it detects
-**no speech**, cleanup fails open with a warning instead of muting the file.
-Denoising and pause silencing are different jobs: this stage does not restore
-consonants a denoiser has already removed. Audition the result before
-committing:
-
-```bash
-./producer.sh preview recording.wav --start 10 --duration 30
-```
-
-Reports in the `logs/` directory next to `producer.sh` include the attenuated
-intervals for inspection.
-
-## Troubleshooting
-
-- **Bootstrap fails:** the first run needs `uv` or Python 3 with venv support
- and network access to PyPI. Install the missing tool and rerun.
-- **CUDA unavailable:** run `./producer.sh doctor`, check `nvidia-smi` and the
- driver, then retry `./producer.sh setup --device cuda`. Or use `--device cpu`.
-- **Sounds watery or thin:** lower the denoise strength (`--denoise-strength
- 0.65`) or compare profiles with `preview`.
-- **Word attacks sound soft or ramp up:** AI denoisers can soften consonant
- onsets. Try `--denoiser clearvoice` (larger non-causal model that sees more
- attack context), lower `--denoise-strength`, or compare against
- `--no-denoise` to locate the culprit.
-
## License
[0BSD](LICENSE).
Upstream components (ClearVoice, DeepFilterNet, Silero VAD, ONNX Runtime,
-PyTorch, FFmpeg, uv) carry their own licenses. Silero VAD is MIT-licensed:
-https://github.com/snakers4/silero-vad/tree/v5.1
+PyTorch, FFmpeg, uv) carry their own licenses.