1 .\" Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH AUBIONOTES 1 "May 3, 2004"
6 .\" Please adjust this date whenever revising the man-page.
8 .\" Some roff macros, for reference:
9 .\" .nh disable hyphenation
10 .\" .hy enable hyphenation
11 .\" .ad l left justify
12 .\" .ad b justify to both left and right margins
13 .\" .nf disable filling
14 .\" .fi enable filling
15 .\" .br insert line break
16 .\" .sp <n> insert n+1 empty lines
17 .\" for man-page-specific macros, see man(7)
19 aubionotes \- detects notes in a sound file
28 .RI [ -t | --threshold
32 .RI [ -v | --verbose ]
34 This manual page documents briefly the
38 The library \fBaubio\fP provides a small set of functions to extract events and
39 objects from audio, from live streams or still files. Onsets are used to label
40 the beginning of notes, pitches to label their height.
42 \fBaubionotes\fP is still in an experimental state. Its aim is to segment notes
43 with onsets, and label them with their detected pitch. When started without an
44 input file argument (\fI\-i\fP), aubionotes creates a jack input and a midi
45 output. When an input file is given, it outputs the results on the console.
48 This program follows the usual GNU command line syntax, with long
49 options starting with two dashes (`-').
50 A summary of options is included below.
52 .B \-i, \-\-input filein
53 Run analysis on this audio file. Most common (uncompressed) formats are
56 .B \-o, \-\-output fileout
57 Save results in this file. The file will be created on the model of the input
58 file. Results are marked by a very short wood-block sample.
60 .B \-t, \-\-threshold value
61 Set the threshold value for the onset peak picking. Typical values are within
62 \fI0.001\fP and \fI0.900\fP. Default is \fI0.1\fP. The \fBlower\fP the \fBmore
63 sensible\fP. Try \fI0.3\fP in case of over-detections.
66 Run in jack mode (default when started without input file) and creates a midi output.
69 Show summary of options.
72 Show results on the console.
76 .I Analyse a file and save the notes times and pitches
78 $ aubionotes -v -i myloop.wav 2> myloop.txt
80 The results are expressed in seconds and midi pitch.
83 .I Start as a jack client
87 Note you will need to have \fIjackd\fP(1) running. Try connecting a midi
88 instrument to the aubio midi output.
91 The audio feedback is still limited to playing a wood-block sound.
93 For now the program works only on audio signals sampled at 44.1 kHz. It is also
94 way too intensive. Hopefully this will be fixed in the next release.
96 The source code is documented using
98 available in the documentation package or at
99 .BR http://piem.homeip.net/~piem/aubio/doc/ .
101 This manual page was written by Paul Brossier <piem@altern.org>,
102 for the Debian project (but may be used by others).