1 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
3 <!-- Process this file with docbook-to-man to generate an nroff manual
4 page: `docbook-to-man manpage.sgml > manpage.1'. You may view
5 the manual page with: `docbook-to-man manpage.sgml | nroff -man |
6 less'. A typical entry in a Makefile or Makefile.am is:
8 manpage.1: manpage.sgml
12 The docbook-to-man binary is found in the docbook-to-man package.
13 Please remember that if you create the nroff version in one of the
14 debian/rules file targets (such as build), you will need to include
15 docbook-to-man in your Build-Depends control field.
19 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
20 <!ENTITY dhfirstname "<firstname>Paul</firstname>">
21 <!ENTITY dhsurname "<surname>Brossier</surname>">
22 <!-- Please adjust the date whenever revising the manpage. -->
23 <!ENTITY dhdate "<date>December 1, 2004</date>">
24 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
25 allowed: see man(7), man(1). -->
26 <!ENTITY dhsection "<manvolnum>1</manvolnum>">
27 <!ENTITY dhemail "<email>piem@aubio.org</email>">
28 <!ENTITY dhusername "Paul Brossier">
29 <!ENTITY dhucpackage "<refentrytitle>AUBIOONSET</refentrytitle>">
30 <!ENTITY dhpackage "aubioonset">
32 <!ENTITY debian "<productname>Debian</productname>">
33 <!ENTITY gnu "<acronym>GNU</acronym>">
34 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
48 <holder>&dhusername;</holder>
58 <refname>&dhpackage;</refname>
60 <refpurpose>a command line tool for real time onset extraction</refpurpose>
65 <command>&dhpackage; <parameter>[options] [-i soundfile]</parameter></command>
69 <title>DESCRIPTION</title>
71 <para><command>&dhpackage;</command> attempts to detect onset times, the
72 beginning of discreted sound events, in audio signals.</para>
74 <para>When started without an input file argument
75 (<option>--input</option>), <command>&dhpackage;</command> creates jack
76 input and output ports. When an input file is given, the results are given
77 on the console.</para>
81 <title>OPTIONS</title>
83 <para>This program follows the usual GNU command line syntax, with long
84 options starting with two dashes (`-'). A summary of options is included
89 <term><option>-i</option>
90 <option>--input filein</option></term>
93 <para>Run analysis on this audio file. Most common uncompressed formats are
99 <term><option>-o</option>
100 <option>--output fileout</option></term>
103 <para>Save results in this file. The file will be created on the model of the
104 input file. Results are marked by a short wood-block sample.</para>
109 <term><option>-O</option>
110 <option>--onset mode</option></term>
113 <para>The onset detection function to run. Available functions are
114 <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
115 <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
116 <emphasis>energy</emphasis>, <emphasis>kl</emphasis> and
117 <emphasis>mkl</emphasis>. By default, both Kullback Liebler (kl) and complex
118 domain are used in parallel.</para>
123 <term><option>-t</option>
124 <option>--threshold value</option></term>
127 <para>Set the threshold value for the onset peak picking. Typical values are
128 within <literal>0.001</literal> and <literal>0.900</literal>. Default is
129 <literal>0.1</literal>. <emphasis>Lower</emphasis> threshold values imply
130 <emphasis>more</emphasis> onsets detected. Try <literal>0.3</literal> in
131 case of over-detections.</para>
136 <term><option>-j</option>
137 <option>--jack</option></term>
139 <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
143 <term><option>-v</option>
144 <option>--verbose</option></term>
146 <para>Show results on the console (default).</para>
150 <term><option>-h</option>
151 <option>--help</option></term>
153 <para>Show summary of options.</para>
162 <para>For now the program has only been tested on audio signals sampled at
163 44.1 kHz.</para>
168 <title>SEE ALSO</title>
171 <command>aubiotrack</command>(1)
172 <command>aubionotes</command>(1)
173 <command>aubiocut</command>(1)
174 <command>aubiopitch</command>(1)
180 <title>AUTHOR</title>
182 <para>This manual page was written by &dhusername; (&dhemail;). Permission
183 is granted to copy, distribute and/or modify this document under the terms
184 of the &gnu; General Public License, Version 3 any later version published
185 by the Free Software Foundation.</para>
187 <para>On Debian systems, the complete text of the GNU General Public
188 License can be found in /usr/share/common-licenses/GPL.</para>
193 <!-- Keep this comment at the end of the file
198 sgml-minimize-attributes:nil
199 sgml-always-quote-attributes:t
202 sgml-parent-document:nil
203 sgml-default-dtd-file:nil
204 sgml-exposed-tags:nil
205 sgml-local-catalogs:nil
206 sgml-local-ecat-files:nil