source: doc/aubio.txt @ f012722

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchsampler
Last change on this file since f012722 was f012722, checked in by Paul Brossier <piem@piem.org>, 3 years ago

doc/aubio.txt: add simple manpage for aubio command line

  • Property mode set to 100644
File size: 3.5 KB
Line 
1NAME
2  aubio - a command line tool to extract information from sound files
3
4SYNOPSIS
5
6  aubio [-h] [-V] <command> ...
7
8COMMANDS
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  notes        get midi-like notes
17  mfcc         extract mel-frequency cepstrum coefficients
18  melbands     extract mel-frequency energies per band
19
20  For a list of available commands, use "aubio -h". For more info about each
21  command, use "aubio <command> --help".
22
23GENERAL OPTIONS
24
25  These options can be used before any command has been specified.
26
27  -h, --help  show help message and exit
28
29  -V, --version  show version
30
31COMMON OPTIONS
32
33  The following options can be used with all commands:
34
35  <source_uri>, -i <source_uri>, --input <source_uri>  input sound file to
36  analyse (required)
37
38  -r <freq>, --samplerate <freq>  samplerate at which the file should be
39  represented (default: 0, e.g. samplerate of the input sound)
40
41  -H <size>, --hopsize <size>  overlap size, number of samples between two
42  consecutive analysis (default: 256)
43
44  -B <size>, --bufsize <size>  buffer size, number of samples used for each
45  analysis, (e.g. FFT length, default: 512)
46
47  -h, --help  show help message and exit
48
49  -T format, --time-format format  select time values output format (samples,
50  ms, seconds) (default: seconds)
51
52  -v, --verbose  be verbose (increment verbosity by 1, default: 1)
53
54  -q, --quiet  be quiet (set verbosity to 0)
55
56ONSET
57
58  The following additional options can be used with the "onset" subcommand.
59
60  -m <method>, --method <method>  onset novelty function
61  <default|energy|hfc|complex|phase|specdiff|kl|mkl|specflux> (default:
62  default)
63
64  -t <threshold>, --threshold <threshold>  threshold (default: unset)
65
66  -s <value>, --silence <value>  silence threshold, in dB (default: -70)
67
68  -M <value>, --minioi <value>  minimum Inter-Onset Interval (default: 12ms)
69
70PITCH
71
72  The following additional options can be used with the "pitch" subcommand.
73
74  -m <method>, --method <method>  pitch detection method
75  <default|yinfft|yin|mcomb|fcomb|schmitt> (default: default, e.g. yinfft)
76
77  -t <threshold>, --threshold <threshold>  tolerance (default: unset)
78
79  -s <value>, --silence <value>  silence threshold, in dB (default: -70)
80
81  The default buffer size for the beat algorithm is 2048. The default hop size
82  is 256.
83
84BEAT
85
86  The "beat" command accepts all common options and no additional options.
87
88  The default buffer size for the beat algorithm is 1024. The default hop size
89  is 512.
90
91NOTES
92
93  The "note" command accepts all common options and no additional options.
94
95MFCC
96
97  The "mfcc" command accepts all common options and no additional options.
98
99MELBANDS
100
101  The "melbands" command accepts all common options and no additional options.
102
103EXAMPLES
104
105  Extract onsets using a minimum inter-onset interval of 30ms:
106
107    aubio onset /path/to/input_file -M 30ms
108
109  Extract pitch with method "mcomb" and a silence threshold of -90dB:
110
111    aubio pitch /path/to/input_file -m mcomb -s -90.0
112
113  Extract MFCC using the standard Slaney implementation:
114
115    aubio mfcc /path/to/input_file -r 44100
116
117
118SEE ALSO
119
120  aubiocut(1)
121
122AUTHOR
123
124  This manual page was written by Paul Brossier <piem@aubio.org>. Permission is
125  granted to copy, distribute and/or modify this document under the terms of
126  the GNU General Public License as published by the Free Software Foundation,
127  either version 3 of the License, or (at your option) any later version.
Note: See TracBrowser for help on using the repository browser.