Skip to content

Commit c2bfb7c

Browse files
committed
docs: clarify LUFS terminology and fix normalise parameter comments
- Correct README "podcast/broadcast standard" to "common podcast target" (broadcast standards are -23/-24 LUFS, not -16) - Fix normalise.go comments: reference intermediate -processed path, not post-rename filename (LUFS rename happens in ProcessAudio) Signed-off-by: Martin Wimpress <code@wimpress.io>
1 parent 6a50038 commit c2bfb7c

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Raw microphone recordings into broadcast-ready audio in one command. No configur
66
jivetalking presenter1.flac presenter2.flac
77
```
88

9-
Your files emerge at -16 LUFS, the podcast/broadcast standard, with room rumble, background hiss, clicks, and harsh sibilance sorted automatically. Everything needed is embedded in the binary. This is not how audio tools usually work, and that is rather the point.
9+
Your files emerge at -16 LUFS, a common podcast target, with room rumble, background hiss, clicks, and harsh sibilance sorted automatically. Everything needed is embedded in the binary. This is not how audio tools usually work, and that is rather the point.
1010

1111
---
1212

internal/processor/normalise.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ type LoudnormMeasurement struct {
113113
// Instead, we read the Pass 2 output file here without writing, just to get measurements.
114114
//
115115
// Parameters:
116-
// - inputPath: Path to Pass 2 output file (the -LUFS-NN-processed file)
116+
// - inputPath: Path to Pass 2 output file (the -processed file, before LUFS rename)
117117
// - config: Filter configuration (contains loudnorm targets)
118118
// - progressCallback: Optional progress updates (pass 3)
119119
//
@@ -363,7 +363,7 @@ type NormalisationResult struct {
363363
// - Preserves natural dynamics while hitting target loudness
364364
//
365365
// Parameters:
366-
// - inputPath: Path to Pass 2 output file (the -LUFS-NN-processed file)
366+
// - inputPath: Path to Pass 2 output file (the -processed file, before LUFS rename)
367367
// - config: Filter configuration (contains loudnorm targets)
368368
// - outputMeasurements: Pass 2 measurements (for reference, not used for loudnorm)
369369
// - inputMeasurements: Pass 1 measurements (contains NoiseProfile and SpeechProfile for region capture)

0 commit comments

Comments
 (0)