source: doc/aubionotes.txt @ 3d8a6c0

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretch
Last change on this file since 3d8a6c0 was 88e8f52, checked in by Paul Brossier <piem@piem.org>, 15 months ago

doc/aubionotes.txt: add yinfast to list of available pitch methods

  • Property mode set to 100644
File size: 3.8 KB
Line 
1NAME
2  aubionotes - a command line tool to extract musical notes
3
4SYNOPSIS
5
6  aubionotes source
7  aubionotes [[-i] source]
8             [-r rate] [-B win] [-H hop]
9             [-O method] [-t thres]
10             [-p method] [-u unit] [-l thres]
11             [-T time-format]
12             [-s sil]
13             [-j] [-v] [-h]
14
15DESCRIPTION
16
17  aubionotes attempts to detect notes by looking for note onsets and pitches.
18  Consecutive events are segmented using onset detection, while a fundamental
19  frequency extraction algorithm determines their pitch.
20
21  When started with an input source (-i/--input), the detected notes are
22  printed on standard output, in seconds and midi note number.
23
24  When started without an input source, or with the jack option (-j/--jack),
25  aubionotes starts in jack mode.
26
27OPTIONS
28
29  This program follows the usual GNU command line syntax, with long options
30  starting with two dashes (--). A summary of options is included below.
31
32  -i, --input source  Run analysis on this audio file. Most uncompressed and
33  compressed are supported, depending on how aubio was built.
34
35  -r, --samplerate rate  Fetch the input source, resampled at the given
36  sampling rate. The rate should be specified in Hertz as an integer. If 0,
37  the sampling rate of the original source will be used. Defaults to 0.
38
39  -B, --bufsize win  The size of the buffer to analyze, that is the length
40  of the window used for spectral and temporal computations. Defaults to 512.
41
42  -H, --hopsize hop  The number of samples between two consecutive analysis.
43  Defaults to 256.
44
45  -O, --onset method  The onset detection method to use. See ONSET METHODS
46  below. Defaults to 'default'.
47
48  -t, --onset-threshold thres  Set the threshold value for the onset peak
49  picking. Typical values are typically within 0.001 and 0.900. Defaults to
50  0.1. Lower threshold values imply more onsets detected. Try 0.5 in case of
51  over-detections. Defaults to 0.3.
52
53  -M, --minioi value  Set the minimum inter-onset interval, in seconds, the
54  shortest interval between two consecutive notes. Defaults to 0.030
55
56  -p, --pitch method  The pitch detection method to use. See PITCH METHODS
57  below. Defaults to 'default'.
58
59  -u, --pitch-unit unit  The unit to be used to print frequencies. Possible
60  values include midi, bin, cent, and Hz. Defaults to 'Hz'.
61
62  -l, --pitch-tolerance thres  Set the tolerance for the pitch detection
63  algorithm. Typical values range between 0.2 and 0.9. Pitch candidates found
64  with a confidence less than this threshold will not be selected. The higher
65  the threshold, the more confidence in the candidates. Defaults to unset.
66
67  -s, --silence sil  Set the silence threshold, in dB, under which the pitch
68  will not be detected. A value of -20.0 would eliminate most onsets but the
69  loudest ones. A value of -90.0 would select all onsets. Defaults to -90.0.
70
71  -T, --timeformat format  Set time format (samples, ms, seconds). Defaults to
72  seconds.
73
74  -j, --jack  Use Jack input/output. You will need a Jack connection
75  controller to feed aubio some signal and listen to its output.
76
77  -h, --help  Print a short help message and exit.
78
79  -v, --verbose  Be verbose.
80
81ONSET METHODS
82
83  Available methods: default, energy, hfc, complex, phase, specdiff, kl, mkl,
84  specflux.
85
86  See aubioonset(1) for details about these methods.
87
88PITCH METHODS
89
90  Available methods: default, schmitt, fcomb, mcomb, specacf, yin, yinfft,
91  yinfast.
92
93  See aubiopitch(1) for details about these methods.
94
95SEE ALSO
96
97  aubioonset(1),
98  aubiopitch(1),
99  aubiotrack(1),
100  aubioquiet(1),
101  aubiomfcc(1),
102  and
103  aubiocut(1).
104
105AUTHOR
106
107  This manual page was written by Paul Brossier <piem@aubio.org>. Permission is
108  granted to copy, distribute and/or modify this document under the terms of
109  the GNU General Public License as published by the Free Software Foundation,
110  either version 3 of the License, or (at your option) any later version.
Note: See TracBrowser for help on using the repository browser.