doc/aubioonset.txt: add documentation for -M, --minioi
[aubio.git] / doc / aubioonset.txt
1 NAME
2   aubioonset - a command line tool to extract musical onset times
3
4 SYNOPSIS
5
6   aubioonset source
7   aubioonset [[-i] source] [-o sink]
8              [-r rate] [-B win] [-H hop]
9              [-O method] [-t thres]
10              [-T time-format]
11              [-s sil] [-m] [-f]
12              [-j] [-v] [-h]
13
14 DESCRIPTION
15
16   aubioonset attempts to detect onset times, the beginning of discrete sound
17   events, in audio signals.
18
19   When started with an input source (-i/--input), the detected onset times are
20   given on the console, in seconds.
21
22   When started without an input source, or with the jack option (-j/--jack),
23   aubioonset starts in jack mode.
24
25 OPTIONS
26
27   This program follows the usual GNU command line syntax, with long options
28   starting with two dashes (--). A summary of options is included below.
29
30   -i, --input source  Run analysis on this audio file. Most uncompressed and
31   compressed are supported, depending on how aubio was built.
32
33   -o, --output sink  Save results in this file. The file will be created on
34   the model of the input file. Onset times are marked by a short wood-block
35   like sound.
36
37   -r, --samplerate rate  Fetch the input source, resampled at the given
38   sampling rate. The rate should be specified in Hertz as an integer. If 0,
39   the sampling rate of the original source will be used. Defaults to 0.
40
41   -B, --bufsize win  The size of the buffer to analyze, that is the length
42   of the window used for spectral and temporal computations. Defaults to 512.
43
44   -H, --hopsize hop  The number of samples between two consecutive analysis.
45   Defaults to 256.
46
47   -O, --onset method  The onset detection method to use. See ONSET METHODS
48   below. Defaults to 'default'.
49
50   -t, --onset-threshold thres  Set the threshold value for the onset peak
51   picking. Values are typically in the range [0.001, 0.900]. Lower threshold
52   values imply more onsets detected. Increasing this threshold should reduce
53   the number of incorrect detections. Defaults to 0.3.
54
55   -M, --minioi value  Set the minimum inter-onset interval, in millisecond,
56   the shortest interval between two consecutive onsets. Defaults to 12.
57
58   -s, --silence sil  Set the silence threshold, in dB, under which the onset
59   will not be detected. A value of -20.0 would eliminate most onsets but the
60   loudest ones. A value of -90.0 would select all onsets. Defaults to -90.0.
61
62   -T, --timeformat format  Set time format (samples, ms, seconds). Defaults to
63   seconds.
64
65   -m, --mix-input  Mix source signal to the output signal before writing to
66   sink.
67
68   -f, --force-overwrite  Overwrite output file if it already exists.
69
70   -j, --jack  Use Jack input/output. You will need a Jack connection
71   controller to feed aubio some signal and listen to its output.
72
73   -h, --help  Print a short help message and exit.
74
75   -v, --verbose  Be verbose.
76
77 ONSET METHODS
78
79   Available methods are:
80
81   default  Default distance, currently hfc
82
83   Default: 'default' (currently set to hfc)
84
85   energy  Energy based distance
86
87   This function calculates the local energy of the input spectral frame.
88
89   hfc  High-Frequency content
90
91   This method computes the High Frequency Content (HFC) of the input
92   spectral frame. The resulting function is efficient at detecting
93   percussive onsets.
94
95   Paul Masri. Computer modeling of Sound for Transformation and Synthesis of
96   Musical Signal. PhD dissertation, University of Bristol, UK, 1996.
97
98   complex  Complex domain onset detection function
99
100   This function uses information both in frequency and in phase to determine
101   changes in the spectral content that might correspond to musical onsets.
102   It is best suited for complex signals such as polyphonic recordings.
103
104   Christopher Duxbury, Mike E. Davies, and Mark B. Sandler.  Complex domain
105   onset detection for musical signals. In Proceedings of the Digital Audio
106   Effects Conference, DAFx-03, pages 90-93, London, UK, 2003.
107
108   phase  Phase based onset detection function
109
110   This function uses information both in frequency and in phase to determine
111   changes in the spectral content that might correspond to musical onsets. It
112   is best suited for complex signals such as polyphonic recordings.
113
114   Juan-Pablo Bello, Mike P. Davies, and Mark B. Sandler.  Phase-based note
115   onset detection for music signals. In Proceedings of the IEEE International
116   Conference on Acoustics Speech and Signal Processing, pages 441­444,
117   Hong-Kong, 2003.
118
119   specdiff  Spectral difference onset detection function
120
121   Jonhatan Foote and Shingo Uchihashi. The beat spectrum: a new approach to
122   rhythm analysis. In IEEE International Conference on Multimedia and Expo
123   (ICME 2001), pages 881­884, Tokyo, Japan, August 2001.
124
125   kl  Kulback-Liebler onset detection function
126
127   Stephen Hainsworth and Malcom Macleod. Onset detection in music audio
128   signals. In Proceedings of the International Computer Music Conference
129   (ICMC), Singapore, 2003.
130
131   mkl  Modified Kulback-Liebler onset detection function
132
133   Paul Brossier, ``Automatic annotation of musical audio for interactive
134   systems'', Chapter 2, Temporal segmentation, PhD thesis, Centre for
135   Digital music, Queen Mary University of London, London, UK, 2006.
136
137   specflux  Spectral flux
138
139   Simon Dixon, Onset Detection Revisited, in ``Proceedings of the 9th
140   International Conference on Digital Audio Effects'' (DAFx-06), Montreal,
141   Canada, 2006.
142
143 SEE ALSO
144
145   aubiopitch(1),
146   aubiotrack(1),
147   aubionotes(1),
148   aubioquiet(1),
149   aubiomfcc(1),
150   and
151   aubiocut(1).
152
153 AUTHOR
154
155   This manual page was written by Paul Brossier <piem@aubio.org>. Permission is
156   granted to copy, distribute and/or modify this document under the terms of
157   the GNU General Public License as published by the Free Software Foundation,
158   either version 3 of the License, or (at your option) any later version.