source: doc/aubionotes.txt @ 403e9dd

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchpitchshiftsamplertimestretchyinfft+
Last change on this file since 403e9dd was 403e9dd, checked in by Paul Brossier <piem@piem.org>, 6 years ago

doc/: rewrite manpages, use txt2man, add aubioquiet.txt, change rule in wscript

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