SOUND-GAMBIT(1)

📦 version 0.7, in arch rolling

🎀 sound-gambit(1) — Audio File Peak Limiter 🎀

okay bestie, welcome to the sound-gambit(1) manual page — yes, from the User Commands section — for sound-gambit, the Audio File Peak Limiter. It's giving "make it louder but keep the peaks in line" main character energy, and it has options. Let's go. 💅✨

🌸 NAME 🌸

sound-gambit — Audio File Peak Limiter

🌈 SYNOPSIS 🌈

sound-gambit [ OPTIONS ] <src> <dst>

That's the whole shape of it: OPTIONS, a source <src>, and a destination <dst>. Slay. 🫶

💖 DESCRIPTION 💖

sound-gambit is an Audio File Digital Peak Limiter. This utility takes a given input file, applies a digital peak look-ahead limiter, and constrains the output level to the given threshold. No cap, that's the whole job. ✨

🦋 OPTIONS 🦋

  • -a, --auto-gain — specify gain relative to peak
  • -i, --input-gain <db> — input gain in dB (default 0)
  • -T, --true-peak — oversample, use true-peak threshold
  • -t, --threshold <dBFS> — threshold in dBFS/dBTP (default -1)
  • -r, --release-time <ms> — release-time in ms (default 10)
  • -h, --help — display this help and exit
  • -v, --verbose — show processing information
  • -V, --version — print version information and exit

Okay, now the details, because this is where the magic lives: 💜

Your target file will have the same properties as the source file — sample-rate, channels, bit-depth — and file meta-data is copied. 📋

🚨 important vibe check: the algorithm does not work in-place. Input and Output files must be distinct.

Reading via standard-I/O is supported — use - as file-name. 🧚

Prior to processing, additional input-gain can be applied. The allowed range is -10 to +30 dB. 🎚️

When auto-gain is enabled, input-gain is relative to the given threshold, and specifies the amount of effective gain-reduction to be applied. If input-gain is zero, the file is only normalized to the given threshold. Periodt. 💅

The threshold range is -10 to 0 dBFS, and the limiter will not allow a single sample above this level. Not one. Zero. Nada. 😤

The release-time can be set from 1 ms to 1 second. The limiter allows short release times even on signals that contain high level low frequency signals. Any gain reduction caused by those will have an automatically extended hold time in order to avoid the limiter following the shape of the waveform and create excessive distortion. Short superimposed peaks will still have the release time as set by this control. That's the iconic part. 🌈

The algorithm is based on Fons Adriaensen's zita-audiotools. 👑

🌟 EXAMPLES 🌟

Try these, bestie — they eat:

sound-gambit -i 3 -t -1.2 my-music.wav my-louder-music.wav
ffmpeg -i file.mp3 -f wav - | sound-gambit -v -T - output.wav

🧚 REPORTING BUGS 🧚

Report bugs to <https://github.com/x42/sound-gambit/issues>

Website: <https://github.com/x42/sound-gambit/>

Copyright © GPL 2021 Robin Gareus <robin@gareus.org>

that's the whole page, bestie! this sound-gambit(1) manual is serving version 0.6-1-g779... from March 2022. go make something loud but legal 💜🎀

📦 where this page comes from