| 1 | NAME |
|---|
| 2 | aubio - a command line tool to extract information from sound files |
|---|
| 3 | |
|---|
| 4 | SYNOPSIS |
|---|
| 5 | |
|---|
| 6 | aubio [-h] [-V] <command> ... |
|---|
| 7 | |
|---|
| 8 | COMMANDS |
|---|
| 9 | |
|---|
| 10 | The general syntax is "aubio <command> <soundfile> [options]". The following |
|---|
| 11 | commands are available: |
|---|
| 12 | |
|---|
| 13 | onset get onset times |
|---|
| 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 |
|---|
| 20 | |
|---|
| 21 | For a list of available commands, use "aubio -h". For more info about each |
|---|
| 22 | command, use "aubio <command> --help". |
|---|
| 23 | |
|---|
| 24 | GENERAL OPTIONS |
|---|
| 25 | |
|---|
| 26 | These options can be used before any command has been specified. |
|---|
| 27 | |
|---|
| 28 | -h, --help show help message and exit |
|---|
| 29 | |
|---|
| 30 | -V, --version show version |
|---|
| 31 | |
|---|
| 32 | COMMON OPTIONS |
|---|
| 33 | |
|---|
| 34 | The following options can be used with all commands: |
|---|
| 35 | |
|---|
| 36 | <source_uri>, -i <source_uri>, --input <source_uri> input sound file to |
|---|
| 37 | analyse (required) |
|---|
| 38 | |
|---|
| 39 | -r <freq>, --samplerate <freq> samplerate at which the file should be |
|---|
| 40 | represented (default: 0, e.g. samplerate of the input sound) |
|---|
| 41 | |
|---|
| 42 | -H <size>, --hopsize <size> overlap size, number of samples between two |
|---|
| 43 | consecutive analysis (default: 256) |
|---|
| 44 | |
|---|
| 45 | -B <size>, --bufsize <size> buffer size, number of samples used for each |
|---|
| 46 | analysis, (e.g. FFT length, default: 512) |
|---|
| 47 | |
|---|
| 48 | -h, --help show help message and exit |
|---|
| 49 | |
|---|
| 50 | -T format, --time-format format select time values output format (samples, |
|---|
| 51 | ms, seconds) (default: seconds) |
|---|
| 52 | |
|---|
| 53 | -v, --verbose be verbose (increment verbosity by 1, default: 1) |
|---|
| 54 | |
|---|
| 55 | -q, --quiet be quiet (set verbosity to 0) |
|---|
| 56 | |
|---|
| 57 | ONSET |
|---|
| 58 | |
|---|
| 59 | The following additional options can be used with the "onset" subcommand. |
|---|
| 60 | |
|---|
| 61 | -m <method>, --method <method> onset novelty function |
|---|
| 62 | <default|energy|hfc|complex|phase|specdiff|kl|mkl|specflux> (default: |
|---|
| 63 | default) |
|---|
| 64 | |
|---|
| 65 | -t <threshold>, --threshold <threshold> threshold (default: unset) |
|---|
| 66 | |
|---|
| 67 | -s <value>, --silence <value> silence threshold, in dB (default: -70) |
|---|
| 68 | |
|---|
| 69 | -M <value>, --minioi <value> minimum Inter-Onset Interval (default: 12ms) |
|---|
| 70 | |
|---|
| 71 | PITCH |
|---|
| 72 | |
|---|
| 73 | The following additional options can be used with the "pitch" subcommand. |
|---|
| 74 | |
|---|
| 75 | -m <method>, --method <method> pitch detection method |
|---|
| 76 | <default|yinfft|yin|mcomb|fcomb|schmitt> (default: default, e.g. yinfft) |
|---|
| 77 | |
|---|
| 78 | -t <threshold>, --threshold <threshold> tolerance (default: unset) |
|---|
| 79 | |
|---|
| 80 | -s <value>, --silence <value> silence threshold, in dB (default: -70) |
|---|
| 81 | |
|---|
| 82 | The default buffer size for the beat algorithm is 2048. The default hop size |
|---|
| 83 | is 256. |
|---|
| 84 | |
|---|
| 85 | BEAT |
|---|
| 86 | |
|---|
| 87 | The "beat" command accepts all common options and no additional options. |
|---|
| 88 | |
|---|
| 89 | The default buffer size for the beat algorithm is 1024. The default hop size |
|---|
| 90 | is 512. |
|---|
| 91 | |
|---|
| 92 | TEMPO |
|---|
| 93 | |
|---|
| 94 | The "tempo" command accepts all common options and no additional options. |
|---|
| 95 | |
|---|
| 96 | The default buffer size for the beat algorithm is 1024. The default hop size |
|---|
| 97 | is 512. |
|---|
| 98 | |
|---|
| 99 | NOTES |
|---|
| 100 | |
|---|
| 101 | The following additional options can be used with the "notes" subcommand. |
|---|
| 102 | |
|---|
| 103 | -s <value>, --silence <value> silence threshold, in dB (default: -70) |
|---|
| 104 | |
|---|
| 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). |
|---|
| 108 | |
|---|
| 109 | MFCC |
|---|
| 110 | |
|---|
| 111 | The "mfcc" command accepts all common options and no additional options. |
|---|
| 112 | |
|---|
| 113 | MELBANDS |
|---|
| 114 | |
|---|
| 115 | The "melbands" command accepts all common options and no additional options. |
|---|
| 116 | |
|---|
| 117 | EXAMPLES |
|---|
| 118 | |
|---|
| 119 | Extract onsets using a minimum inter-onset interval of 30ms: |
|---|
| 120 | |
|---|
| 121 | aubio onset /path/to/input_file -M 30ms |
|---|
| 122 | |
|---|
| 123 | Extract pitch with method "mcomb" and a silence threshold of -90dB: |
|---|
| 124 | |
|---|
| 125 | aubio pitch /path/to/input_file -m mcomb -s -90.0 |
|---|
| 126 | |
|---|
| 127 | Extract MFCC using the standard Slaney implementation: |
|---|
| 128 | |
|---|
| 129 | aubio mfcc /path/to/input_file -r 44100 |
|---|
| 130 | |
|---|
| 131 | |
|---|
| 132 | SEE ALSO |
|---|
| 133 | |
|---|
| 134 | aubiocut(1) |
|---|
| 135 | |
|---|
| 136 | AUTHOR |
|---|
| 137 | |
|---|
| 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. |
|---|
