AUBIO(1)

🎀 AUBIO 🎀

okay so bestie, welcome to aubio(1) — the aubio User's manual, and honestly? it's giving "tiny command, big main character energy." it's a command line tool to extract information from sound files, and yes it absolutely ate. 💅

---

✨ NAME ✨

aubio — a command line tool to extract information from sound files 🎧

---

🌸 SYNOPSIS 🌸

aubio [-h] [-V] <command> ...

---

🦋 COMMANDS 🦋

the general syntax is literally aubio <command> <soundfile> [options]. here's what's on the menu, no cap:

• onset — get onset times
• pitch — extract fundamental frequency
• beat — get locations of beats
• tempo — get overall tempo in bpm
• notes — get midi-like notes
• mfcc — extract mel-frequency cepstrum coefficients
• melbands — extract mel-frequency energies per band

for a list of available commands, use aubio -h. for more info about each command, use aubio <command> --help. iykyk 💖

---

⭐ GENERAL OPTIONS ⭐

these options can be used before any command has been specified, bestie:

• -h, --help — show help message and exit
• -V, --version — show version

---

🎀 COMMON OPTIONS 🎀

the following options can be used with all commands — universal slay:

• <source_uri>, -i <source_uri>, --input <source_uri> — input sound file to analyse (required, like fr, you gotta give it a file 🙈)
• -r <freq>, --samplerate <freq> — samplerate at which the file should be represented (default: 0, e.g. samplerate of the input sound)
• -H <size>, --hopsize <size> — overlap size, number of samples between two consecutive analysis (default: 256)
• -B <size>, --bufsize <size> — buffer size, number of samples used for each analysis, (e.g. FFT length, default: 512)
• -h, --help — show help message and exit
• -T format, --time-format format — select time values output format (samples, ms, seconds) (default: seconds)
• -v, --verbose — be verbose (increment verbosity by 1, default: 1)
• -q, --quiet — be quiet (set verbosity to 0)

---

🔥 ONSET 🔥

the following additional options can be used with the onset subcommand:

• -m <method>, --method <method> — onset novelty function <default|energy|hfc|complex|phase|specdiff|kl|mkl|specflux> (default: default)
• -t <threshold>, --threshold <threshold> — threshold (default: unset)
• -s <value>, --silence <value> — silence threshold, in dB (default: -70)
• -M <value>, --minioi <value> — minimum Inter-Onset Interval (default: 12ms)

---

💜 PITCH 💜

the following additional options can be used with the pitch subcommand:

• -m <method>, --method <method> — pitch detection method <default|yinfft|yin|mcomb|fcomb|schmitt> (default: default, e.g. yinfft)
• -t <threshold>, --threshold <threshold> — tolerance (default: unset)
• -s <value>, --silence <value> — silence threshold, in dB (default: -70)

ok so heads up, the page says this right here in the PITCH section and we're keeping it exactly: the default buffer size for the beat algorithm is 2048. the default hop size is 256. that's what it says, so that's what you get 🫶

---

🌈 BEAT 🌈

the beat command accepts all common options and no additional options. it's low maintenance like that.

the default buffer size for the beat algorithm is 1024. the default hop size is 512.

---

⭐ TEMPO ⭐

the tempo command accepts all common options and no additional options.

the default buffer size for the beat algorithm is 1024. the default hop size is 512.

---

🍓 NOTES 🍓

the following additional options can be used with the notes subcommand:

• -s <value>, --silence <value> — silence threshold, in dB (default: -70)
• -d <value>, --release-drop <value> — release drop level, in dB. if the level drops more than this amount since the last note started, the note will be turned off (default: 10).

---

🧚 MFCC 🧚

the mfcc command accepts all common options and no additional options.

---

👑 MELBANDS 👑

the melbands command accepts all common options and no additional options.

---

💖 EXAMPLES 💖

extract onsets using a minimum inter-onset interval of 30ms:

aubio onset /path/to/input_file -M 30ms

extract pitch with method mcomb and a silence threshold of -90dB:

aubio pitch /path/to/input_file -m mcomb -s -90.0

extract MFCC using the standard Slaney implementation:

aubio mfcc /path/to/input_file -r 44100

---

🎧 SEE ALSO 🎧

• aubiocut(1)

---

💌 AUTHOR 💌

this manual page was written by Paul Brossier <piem@aubio.org>.

permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. (iconic licensing behavior, honestly 🫶)

---

so yeah, that's the whole thing — <rainbow>aubio 0.4.9, dated 29 March 2025 🌸 mwah, go analyse some sound files bestie, you got this 💅✨