209 lines
4.5 KiB
Groff
209 lines
4.5 KiB
Groff
.\" Text automatically generated by txt2man
|
|
.TH AUBIO 1 "22 July 2023" "aubio 0.4.9" "aubio User's manual"
|
|
.SH NAME
|
|
\fBaubio \fP- a command line tool to extract information from sound files
|
|
\fB
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.fam C
|
|
|
|
\fBaubio\fP [\fB-h\fP] [\fB-V\fP] <command> \.\.\.
|
|
|
|
.fam T
|
|
.fi
|
|
.fam T
|
|
.fi
|
|
.SH COMMANDS
|
|
|
|
The general syntax is "\fBaubio\fP <command> <soundfile> [options]". The following
|
|
commands are available:
|
|
.TP
|
|
.B
|
|
onset
|
|
get onset times
|
|
.TP
|
|
.B
|
|
pitch
|
|
extract fundamental frequency
|
|
.TP
|
|
.B
|
|
beat
|
|
get locations of beats
|
|
.TP
|
|
.B
|
|
tempo
|
|
get overall tempo in bpm
|
|
.TP
|
|
.B
|
|
notes
|
|
get midi-like notes
|
|
.TP
|
|
.B
|
|
mfcc
|
|
extract mel-frequency cepstrum coefficients
|
|
.TP
|
|
.B
|
|
melbands
|
|
extract mel-frequency energies per band
|
|
.PP
|
|
For a list of available commands, use "\fBaubio\fP \fB-h\fP". For more info about each
|
|
command, use "\fBaubio\fP <command> \fB--help\fP".
|
|
.SH GENERAL OPTIONS
|
|
|
|
These options can be used before any command has been specified.
|
|
.TP
|
|
.B
|
|
\fB-h\fP, \fB--help\fP
|
|
show help message and exit
|
|
.TP
|
|
.B
|
|
\fB-V\fP, \fB--version\fP
|
|
show version
|
|
.SH COMMON OPTIONS
|
|
|
|
The following options can be used with all commands:
|
|
.TP
|
|
.B
|
|
<source_uri>, \fB-i\fP <source_uri>, \fB--input\fP <source_uri>
|
|
input sound file to
|
|
analyse (required)
|
|
.TP
|
|
.B
|
|
\fB-r\fP <freq>, \fB--samplerate\fP <freq>
|
|
samplerate at which the file should be
|
|
represented (default: 0, e.g. samplerate of the input sound)
|
|
.TP
|
|
.B
|
|
\fB-H\fP <size>, \fB--hopsize\fP <size>
|
|
overlap size, number of samples between two
|
|
consecutive analysis (default: 256)
|
|
.TP
|
|
.B
|
|
\fB-B\fP <size>, \fB--bufsize\fP <size>
|
|
buffer size, number of samples used for each
|
|
analysis, (e.g. FFT length, default: 512)
|
|
.TP
|
|
.B
|
|
\fB-h\fP, \fB--help\fP
|
|
show help message and exit
|
|
.TP
|
|
.B
|
|
\fB-T\fP format, \fB--time-format\fP format
|
|
select time values output format (samples,
|
|
ms, seconds) (default: seconds)
|
|
.TP
|
|
.B
|
|
\fB-v\fP, \fB--verbose\fP
|
|
be verbose (increment verbosity by 1, default: 1)
|
|
.TP
|
|
.B
|
|
\fB-q\fP, \fB--quiet\fP
|
|
be quiet (set verbosity to 0)
|
|
.SH ONSET
|
|
|
|
The following additional options can be used with the "onset" subcommand.
|
|
.TP
|
|
.B
|
|
\fB-m\fP <method>, \fB--method\fP <method>
|
|
onset novelty function
|
|
<default|energy|hfc|complex|phase|specdiff|kl|mkl|specflux> (default:
|
|
default)
|
|
.TP
|
|
.B
|
|
\fB-t\fP <threshold>, \fB--threshold\fP <threshold>
|
|
threshold (default: unset)
|
|
.TP
|
|
.B
|
|
\fB-s\fP <value>, \fB--silence\fP <value>
|
|
silence threshold, in dB (default: \fB-70\fP)
|
|
.TP
|
|
.B
|
|
\fB-M\fP <value>, \fB--minioi\fP <value>
|
|
minimum Inter-Onset Interval (default: 12ms)
|
|
.SH PITCH
|
|
|
|
The following additional options can be used with the "pitch" subcommand.
|
|
.TP
|
|
.B
|
|
\fB-m\fP <method>, \fB--method\fP <method>
|
|
pitch detection method
|
|
<default|yinfft|yin|mcomb|fcomb|schmitt> (default: default, e.g. yinfft)
|
|
.TP
|
|
.B
|
|
\fB-t\fP <threshold>, \fB--threshold\fP <threshold>
|
|
tolerance (default: unset)
|
|
.TP
|
|
.B
|
|
\fB-s\fP <value>, \fB--silence\fP <value>
|
|
silence threshold, in dB (default: \fB-70\fP)
|
|
.PP
|
|
The default buffer size for the beat algorithm is 2048. The default hop size
|
|
is 256.
|
|
.SH BEAT
|
|
|
|
The "beat" command accepts all common options and no additional options.
|
|
.PP
|
|
The default buffer size for the beat algorithm is 1024. The default hop size
|
|
is 512.
|
|
.SH TEMPO
|
|
|
|
The "tempo" command accepts all common options and no additional options.
|
|
.PP
|
|
The default buffer size for the beat algorithm is 1024. The default hop size
|
|
is 512.
|
|
.SH NOTES
|
|
|
|
The following additional options can be used with the "notes" subcommand.
|
|
.TP
|
|
.B
|
|
\fB-s\fP <value>, \fB--silence\fP <value>
|
|
silence threshold, in dB (default: \fB-70\fP)
|
|
.TP
|
|
.B
|
|
\fB-d\fP <value>, \fB--release-drop\fP <value>
|
|
release drop level, in dB. If the level
|
|
drops more than this amount since the last note started, the note will be
|
|
turned off (default: 10).
|
|
.SH MFCC
|
|
|
|
The "mfcc" command accepts all common options and no additional options.
|
|
.SH MELBANDS
|
|
|
|
The "melbands" command accepts all common options and no additional options.
|
|
.SH EXAMPLES
|
|
|
|
Extract onsets using a minimum inter-onset interval of 30ms:
|
|
.PP
|
|
.nf
|
|
.fam C
|
|
aubio onset /path/to/input_file -M 30ms
|
|
|
|
.fam T
|
|
.fi
|
|
Extract pitch with method "mcomb" and a silence threshold of \fB-90dB\fP:
|
|
.PP
|
|
.nf
|
|
.fam C
|
|
aubio pitch /path/to/input_file -m mcomb -s -90.0
|
|
|
|
.fam T
|
|
.fi
|
|
Extract MFCC using the standard Slaney implementation:
|
|
.PP
|
|
.nf
|
|
.fam C
|
|
aubio mfcc /path/to/input_file -r 44100
|
|
|
|
|
|
.fam T
|
|
.fi
|
|
.SH SEE ALSO
|
|
|
|
\fBaubiocut\fP(1)
|
|
.SH AUTHOR
|
|
|
|
This manual page was written by Paul Brossier <piem@aubio.org>. Permission is
|
|
granted to copy, distribute and/or modify this document under the terms of
|
|
the GNU General Public License as published by the Free Software Foundation,
|
|
either version 3 of the License, or (at your option) any later version.
|