source: examples/aubioonset.1 @ 96fb8ad

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since 96fb8ad was 96fb8ad, checked in by Paul Brossier <piem@altern.org>, 19 years ago

import 0.1.7.1

  • Property mode set to 100644
File size: 3.2 KB
Line 
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 AUBIOONSET 1 "May  3, 2004"
6.\" Please adjust this date whenever revising the man-page.
7.\"
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)
18.SH NAME
19aubioonset \- detects onset times in a sound file
20.SH SYNOPSIS
21.B aubioonset
22.RI [ -i | --input
23.RB < soundfilein > 
24.RI ]
25.RI [ -o | --output 
26.RB < soundfileout > 
27.RI ]
28.RI [ -t | --threshold 
29.RB < thres > 
30.RI ]
31.RI [ -j | --jack ]
32.RI [ -v | --verbose ]
33
34.SH DESCRIPTION
35This manual page documents briefly the
36.B aubioonset
37command.
38.PP
39The \fBaubio\fP library provides a small set of functions to extract events and
40objects from audio, from live streams or still files. Onsets are used to label
41the beginning of notes.
42
43\fBaubioonset\fP extract onsets from an audio input. It works online or
44off-line: live as a jack client, or with an input sound file. When running on a
45file, results can be printed to the console using the \fI\-v\fP flag.
46
47.SH OPTIONS
48This program follows the usual GNU command line syntax, with long
49options starting with two dashes (`-').
50A summary of options is included below.
51.TP
52.B \-i, \-\-input filein
53Run analysis on this audio file. Most common (uncompressed) formats are
54supported.
55.TP
56.B \-o, \-\-output fileout
57Save results in this file. The file will be created on the model of the input
58file. Results are marked by a very short wood-block sample.
59.TP
60.B \-t, \-\-threshold value
61Set 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
63sensible\fP.  Try \fI0.3\fP in case of over-detections.
64.TP
65.B \-j, \-\-jack
66Run in jack mode (default when started without input file).
67.TP
68.B \-h, \-\-help
69Show summary of options.
70.TP
71.B \-v, \-\-verbose
72Show results on the console.
73
74.SH EXAMPLES
75.TP
76.I Analyse a file and save the onsets times (in seconds)
77
78$ aubioonset -v -i myloop.wav 2> myloop.txt
79
80One can start a new project in \fIaudacity\fP(1), import myloop.wav as an audio
81track, and myloop.txt as a label track. This allows to verify each onset
82position, label them with text and select notes, bars and loops.
83
84.TP
85.I Start as a jack client
86
87$ aubioonset -t 0.2
88
89Note you will need to have \fIjackd\fP(1) running.
90
91.SH LIMITATIONS
92The audio feedback in both case is still limited to playing a wood-block sound.
93Midi messages will be sent in the near future.
94.SH BUGS
95For now the program works only on audio signals sampled at 44.1 kHz.
96.SH SEE ALSO
97The source code is documented using
98.IR doxygen (1),
99available in the documentation package or at
100.BR http://piem.homeip.net/~piem/aubio/doc/ .
101.SH AUTHOR
102This manual page was written by Paul Brossier <piem@altern.org>,
103for the Debian project (but may be used by others).
Note: See TracBrowser for help on using the repository browser.