aubioonset -- a command line tool for real time onset extraction




This manual page documents briefly the aubioonset command.

The library aubio provides a small set of functions to extract events and objects from audio, from live streams or still files. Onsets are used to label the beginning of notes, pitches to label their height.

aubionotes is still in an experimental state. Its aim is to segment notes with onsets, and label them with their detected pitch. When started without an input file argument (-i), aubionotes creates a jack input and a midi output. When an input file is given, it outputs the results on the console.


This program follows the usual GNU command line syntax, with long options starting with two dashes (`-'). A summary of options is included below.

-i --input filein

Run analysis on this audio file. Most common (uncompressed) formats are supported.

-o --output fileout

Save results in this file. The file will be created on the model of the input file. Results are marked by a very short wood-block sample.

-O --onset mode

The onset detection function to run. Available functions are complexdomain, hfc, phase, specdiff, energy, kl and mkl. By default, both Kullback Liebler (kl) and complex domain are used in parallel.

-t --threshold value

Set the threshold value for the onset peak picking. Typical values are within 0.001 and 0.900. Default is 0.1. The lower the more sensible. Try 0.3 in case of over-detections.

-j --jack

Run in jack mode (default when started without input file) and creates a midi output.

-h --help

Show summary of options.

-v --verbose

Show results on the console.


For now the program has been only tested on audio signals sampled at 44.1 kHz.


aubiocut(1) aubiotrack(1) aubionotes(1) aubiopitch(1)


This manual page was written by Paul Brossier (). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 any later version published by the Free Software Foundation.

On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.