2 aubio - a command line tool to extract information from sound files
6 aubio [-h] [-V] <command> ...
10 The general syntax is "aubio <command> <soundfile> [options]". The following
11 commands are available:
14 pitch extract fundamental frequency
15 beat get locations of beats
16 tempo get overall tempo in bpm
17 notes get midi-like notes
18 mfcc extract mel-frequency cepstrum coefficients
19 melbands extract mel-frequency energies per band
21 For a list of available commands, use "aubio -h". For more info about each
22 command, use "aubio <command> --help".
26 These options can be used before any command has been specified.
28 -h, --help show help message and exit
30 -V, --version show version
34 The following options can be used with all commands:
36 <source_uri>, -i <source_uri>, --input <source_uri> input sound file to
39 -r <freq>, --samplerate <freq> samplerate at which the file should be
40 represented (default: 0, e.g. samplerate of the input sound)
42 -H <size>, --hopsize <size> overlap size, number of samples between two
43 consecutive analysis (default: 256)
45 -B <size>, --bufsize <size> buffer size, number of samples used for each
46 analysis, (e.g. FFT length, default: 512)
48 -h, --help show help message and exit
50 -T format, --time-format format select time values output format (samples,
51 ms, seconds) (default: seconds)
53 -v, --verbose be verbose (increment verbosity by 1, default: 1)
55 -q, --quiet be quiet (set verbosity to 0)
59 The following additional options can be used with the "onset" subcommand.
61 -m <method>, --method <method> onset novelty function
62 <default|energy|hfc|complex|phase|specdiff|kl|mkl|specflux> (default:
65 -t <threshold>, --threshold <threshold> threshold (default: unset)
67 -s <value>, --silence <value> silence threshold, in dB (default: -70)
69 -M <value>, --minioi <value> minimum Inter-Onset Interval (default: 12ms)
73 The following additional options can be used with the "pitch" subcommand.
75 -m <method>, --method <method> pitch detection method
76 <default|yinfft|yin|mcomb|fcomb|schmitt> (default: default, e.g. yinfft)
78 -t <threshold>, --threshold <threshold> tolerance (default: unset)
80 -s <value>, --silence <value> silence threshold, in dB (default: -70)
82 The default buffer size for the beat algorithm is 2048. The default hop size
87 The "beat" command accepts all common options and no additional options.
89 The default buffer size for the beat algorithm is 1024. The default hop size
94 The "tempo" command accepts all common options and no additional options.
96 The default buffer size for the beat algorithm is 1024. The default hop size
101 The following additional options can be used with the "notes" subcommand.
103 -s <value>, --silence <value> silence threshold, in dB (default: -70)
105 -d <value>, --release-drop <value> release drop level, in dB. If the level
106 drops more than this amount since the last note started, the note will be
107 turned off (default: 10).
111 The "mfcc" command accepts all common options and no additional options.
115 The "melbands" command accepts all common options and no additional options.
119 Extract onsets using a minimum inter-onset interval of 30ms:
121 aubio onset /path/to/input_file -M 30ms
123 Extract pitch with method "mcomb" and a silence threshold of -90dB:
125 aubio pitch /path/to/input_file -m mcomb -s -90.0
127 Extract MFCC using the standard Slaney implementation:
129 aubio mfcc /path/to/input_file -r 44100
138 This manual page was written by Paul Brossier <piem@aubio.org>. Permission is
139 granted to copy, distribute and/or modify this document under the terms of
140 the GNU General Public License as published by the Free Software Foundation,
141 either version 3 of the License, or (at your option) any later version.