feat(logging): add high_crest_factor tip and improve level tips#37
Merged
flexiondotorg merged 1 commit intomainfrom Feb 6, 2026
Merged
feat(logging): add high_crest_factor tip and improve level tips#37flexiondotorg merged 1 commit intomainfrom
flexiondotorg merged 1 commit intomainfrom
Conversation
- Add tipHighCrestFactor to detect excessive peak-to-average (crest)
ratios
and prefer SpeechProfile.CrestFactor when available (fires > 20 dB).
- Update tip suppression rules:
- Do not suppress quiet tips when high_crest_factor also fired
(compound case).
- Suppress quiet tips when too_far_from_mic fires (root-cause).
- Clamp suggested gain increases to available peak headroom and annotate
messages when clamping occurs so users understand the headroom
constraint.
- Change quiet/too-quiet messages to recommend pop filter/handling
checks
when peaks are already near the ceiling (peak-to-average problem).
- Make clipping/near-clipping messages contextual:
- Compute and show suggested reduction in dB where appropriate.
- Emit a distinct message when clipping occurs but recording is
otherwise
very quiet (plosives/handling noise).
- Update and expand recording_tips_test.go to cover:
- crest-factor rule and speech-profile override behaviour
- gain clamping, clamped-message variants, and contextual clipping
cases
Signed-off-by: Martin Wimpress <martin@wimpress.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
and prefer SpeechProfile.CrestFactor when available (fires > 20 dB).
when peaks are already near the ceiling (peak-to-average problem).
very quiet (plosives/handling noise).