1AUBIO(1) aubio User's manual AUBIO(1)
2
6 aubio - a command line tool to extract information from sound files
7
9 aubio [-h] [-V] <command> ...
10
13 The general syntax is "aubio <command> <soundfile> [options]". The fol‐
14 lowing commands are available:
15 onset get onset times
17 pitch extract fundamental frequency
19 beat get locations of beats
21 tempo get overall tempo in bpm
23 notes get midi-like notes
25 mfcc extract mel-frequency cepstrum coefficients
27 melbands
29 extract mel-frequency energies per band
30 For a list of available commands, use "aubio -h". For more info about
32 each command, use "aubio <command> --help".
33
35 These options can be used before any command has been specified.
36 -h, --help
38 show help message and exit
39 -V, --version
41 show version
42
44 The following options can be used with all commands:
45 <source_uri>, -i <source_uri>, --input <source_uri>
47 input sound file to analyse (required)
48 -r <freq>, --samplerate <freq>
50 samplerate at which the file should be represented (default: 0,
51 e.g. samplerate of the input sound)
52 -H <size>, --hopsize <size>
54 overlap size, number of samples between two consecutive analysis
55 (default: 256)
56 -B <size>, --bufsize <size>
58 buffer size, number of samples used for each analysis, (e.g. FFT
59 length, default: 512)
60 -h, --help
62 show help message and exit
63 -T format, --time-format format
65 select time values output format (samples, ms, seconds)
66 (default: seconds)
67 -v, --verbose
69 be verbose (increment verbosity by 1, default: 1)
70 -q, --quiet
72 be quiet (set verbosity to 0)
73
75 The following additional options can be used with the "onset" subcom‐
76 mand.
77 -m <method>, --method <method>
79 onset novelty function <default|energy|hfc|complex|phase|specd‐
80 iff|kl|mkl|specflux> (default: default)
81 -t <threshold>, --threshold <threshold>
83 threshold (default: unset)
84 -s <value>, --silence <value>
86 silence threshold, in dB (default: -70)
87 -M <value>, --minioi <value>
89 minimum Inter-Onset Interval (default: 12ms)
90
92 The following additional options can be used with the "pitch" subcom‐
93 mand.
94 -m <method>, --method <method>
96 pitch detection method <default|yinfft|yin|mcomb|fcomb|schmitt>
97 (default: default, e.g. yinfft)
98 -t <threshold>, --threshold <threshold>
100 tolerance (default: unset)
101 -s <value>, --silence <value>
103 silence threshold, in dB (default: -70)
104 The default buffer size for the beat algorithm is 2048. The default hop
106 size is 256.
107
109 The "beat" command accepts all common options and no additional
110 options.
111 The default buffer size for the beat algorithm is 1024. The default hop
113 size is 512.
114
116 The "tempo" command accepts all common options and no additional
117 options.
118 The default buffer size for the beat algorithm is 1024. The default hop
120 size is 512.
121
123 The "note" command accepts all common options and no additional
124 options.
125
127 The "mfcc" command accepts all common options and no additional
128 options.
129
131 The "melbands" command accepts all common options and no additional
132 options.
133
135 Extract onsets using a minimum inter-onset interval of 30ms:
136 aubio onset /path/to/input_file -M 30ms
138 Extract pitch with method "mcomb" and a silence threshold of -90dB:
140 aubio pitch /path/to/input_file -m mcomb -s -90.0
142 Extract MFCC using the standard Slaney implementation:
144 aubio mfcc /path/to/input_file -r 44100
146
150 aubiocut(1)
151
153 This manual page was written by Paul Brossier <piem@aubio.org>. Permis‐
154 sion is granted to copy, distribute and/or modify this document under
155 the terms of the GNU General Public License as published by the Free
156 Software Foundation, either version 3 of the License, or (at your
157 option) any later version.
158aubio 0.4.6 24 July 2018 AUBIO(1)