aubio(1) - f35

1AUBIO(1)                      aubio User's manual                     AUBIO(1)
2
3
4

NAME

6       aubio - a command line tool to extract information from sound files
7

SYNOPSIS

9       aubio [-h] [-V] <command> ...
10
11

COMMANDS

13       The general syntax is "aubio <command> <soundfile> [options]". The fol‐
14       lowing commands are available:
15
16       onset  get onset times
17
18       pitch  extract fundamental frequency
19
20       beat   get locations of beats
21
22       tempo  get overall tempo in bpm
23
24       notes  get midi-like notes
25
26       mfcc   extract mel-frequency cepstrum coefficients
27
28       melbands
29              extract mel-frequency energies per band
30
31       For a list of available commands, use "aubio -h". For more  info  about
32       each command, use "aubio <command> --help".
33

GENERAL OPTIONS

35       These options can be used before any command has been specified.
36
37       -h, --help
38              show help message and exit
39
40       -V, --version
41              show version
42

COMMON OPTIONS

44       The following options can be used with all commands:
45
46       <source_uri>, -i <source_uri>, --input <source_uri>
47              input sound file to analyse (required)
48
49       -r <freq>, --samplerate <freq>
50              samplerate  at which the file should be represented (default: 0,
51              e.g. samplerate of the input sound)
52
53       -H <size>, --hopsize <size>
54              overlap size, number of samples between two consecutive analysis
55              (default: 256)
56
57       -B <size>, --bufsize <size>
58              buffer size, number of samples used for each analysis, (e.g. FFT
59              length, default: 512)
60
61       -h, --help
62              show help message and exit
63
64       -T format, --time-format format
65              select time values output format  (samples,  ms,  seconds)  (de‐
66              fault: seconds)
67
68       -v, --verbose
69              be verbose (increment verbosity by 1, default: 1)
70
71       -q, --quiet
72              be quiet (set verbosity to 0)
73

ONSET

75       The  following  additional options can be used with the "onset" subcom‐
76       mand.
77
78       -m <method>, --method <method>
79              onset novelty function  <default|energy|hfc|complex|phase|specd‐
80              iff|kl|mkl|specflux> (default: default)
81
82       -t <threshold>, --threshold <threshold>
83              threshold (default: unset)
84
85       -s <value>, --silence <value>
86              silence threshold, in dB (default: -70)
87
88       -M <value>, --minioi <value>
89              minimum Inter-Onset Interval (default: 12ms)
90

PITCH

92       The  following  additional options can be used with the "pitch" subcom‐
93       mand.
94
95       -m <method>, --method <method>
96              pitch detection method  <default|yinfft|yin|mcomb|fcomb|schmitt>
97              (default: default, e.g. yinfft)
98
99       -t <threshold>, --threshold <threshold>
100              tolerance (default: unset)
101
102       -s <value>, --silence <value>
103              silence threshold, in dB (default: -70)
104
105       The default buffer size for the beat algorithm is 2048. The default hop
106       size is 256.
107

BEAT

109       The "beat" command accepts all common options  and  no  additional  op‐
110       tions.
111
112       The default buffer size for the beat algorithm is 1024. The default hop
113       size is 512.
114

TEMPO

116       The "tempo" command accepts all common options and  no  additional  op‐
117       tions.
118
119       The default buffer size for the beat algorithm is 1024. The default hop
120       size is 512.
121

NOTES

123       The following additional options can be used with the  "notes"  subcom‐
124       mand.
125
126       -s <value>, --silence <value>
127              silence threshold, in dB (default: -70)
128
129       -d <value>, --release-drop <value>
130              release  drop  level,  in  dB. If the level drops more than this
131              amount since the last note started, the note will be turned  off
132              (default: 10).
133

MFCC

135       The  "mfcc"  command  accepts  all common options and no additional op‐
136       tions.
137

MELBANDS

139       The "melbands" command accepts all common options and no additional op‐
140       tions.
141

EXAMPLES

143       Extract onsets using a minimum inter-onset interval of 30ms:
144
145           aubio onset /path/to/input_file -M 30ms
146
147       Extract pitch with method "mcomb" and a silence threshold of -90dB:
148
149           aubio pitch /path/to/input_file -m mcomb -s -90.0
150
151       Extract MFCC using the standard Slaney implementation:
152
153           aubio mfcc /path/to/input_file -r 44100
154
155
156

AUTHOR

161       This manual page was written by Paul Brossier <piem@aubio.org>. Permis‐
162       sion is granted to copy, distribute and/or modify this  document  under
163       the  terms  of  the GNU General Public License as published by the Free
164       Software Foundation, either version 3 of the License, or (at  your  op‐
165       tion) any later version.
166
167
168
169aubio 0.4.9                      21 July 2021                         AUBIO(1)