source: doc/aubioonset.sgml @ 823fa09

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

remove intro in manual pages
remove intro in manual pages

  • Property mode set to 100644
File size: 5.9 KB
Line 
1<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
2
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:
7
8manpage.1: manpage.sgml
9        docbook-to-man $< > $@
10
11   
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.
16
17  -->
18
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@altern.org</email>">
28  <!ENTITY dhusername  "Paul Brossier">
29  <!ENTITY dhucpackage "<refentrytitle>AUBIOONSET</refentrytitle>">
30  <!ENTITY dhpackage   "aubioonset">
31
32  <!ENTITY debian      "<productname>Debian</productname>">
33  <!ENTITY gnu         "<acronym>GNU</acronym>">
34  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
35]>
36
37<refentry>
38  <refentryinfo>
39    <address>
40      &dhemail;
41    </address>
42    <author>
43      &dhfirstname;
44      &dhsurname;
45    </author>
46    <copyright>
47      <year>2003</year>
48      <holder>&dhusername;</holder>
49    </copyright>
50    &dhdate;
51  </refentryinfo>
52  <refmeta>
53    &dhucpackage;
54
55    &dhsection;
56  </refmeta>
57  <refnamediv>
58    <refname>&dhpackage;</refname>
59
60    <refpurpose>a command line tool for real time onset extraction</refpurpose>
61
62  </refnamediv>
63  <refsynopsisdiv>
64    <cmdsynopsis>
65      <command>&dhpackage; <parameter>[options] [-i soundfile]</parameter></command>
66    </cmdsynopsis>
67  </refsynopsisdiv>
68  <refsect1>
69    <title>DESCRIPTION</title>
70
71    <para><command>&dhpackage;</command> attempts to detect onset times, the
72    beginning of discreted sound events, in audio signals.</para>
73
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>
78
79  </refsect1>
80  <refsect1>
81    <title>OPTIONS</title>
82
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
85    below.</para>
86
87<variablelist>
88  <varlistentry>
89  <term><option>-i</option>
90  <option>--input filein</option></term>
91  <listitem>
92
93  <para>Run analysis on this audio file. Most common uncompressed formats are
94  supported.</para>
95
96  </listitem>
97  </varlistentry>
98  <varlistentry>
99  <term><option>-o</option>
100  <option>--output fileout</option></term>
101  <listitem>
102
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>
105
106  </listitem>
107  </varlistentry>
108  <varlistentry>
109  <term><option>-O</option>
110  <option>--onset mode</option></term>
111  <listitem>
112
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>
119
120  </listitem>
121  </varlistentry>
122  <varlistentry>
123  <term><option>-t</option>
124  <option>--threshold value</option></term>
125  <listitem>
126
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>
132
133  </listitem>
134  </varlistentry>
135  <varlistentry>
136  <term><option>-j</option>
137  <option>--jack</option></term>
138  <listitem>
139  <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
140  </listitem>
141  </varlistentry>
142  <varlistentry>
143  <term><option>-v</option>
144  <option>--verbose</option></term>
145  <listitem>
146  <para>Show results on the console (default).</para>
147  </listitem>
148  </varlistentry>
149  <varlistentry>
150  <term><option>-h</option>
151  <option>--help</option></term>
152  <listitem>
153  <para>Show summary of options.</para>
154  </listitem>
155  </varlistentry>
156</variablelist>
157
158  </refsect1>
159  <refsect1>
160  <title>BUGS</title>
161
162  <para>For now the program has only been tested on audio signals sampled at
163  44.1&nbsp;kHz.</para>
164
165  </refsect1>
166
167  <refsect1>
168    <title>SEE ALSO</title>
169
170    <para>
171    <command>aubiotrack</command>(1)
172    <command>aubionotes</command>(1)
173    <command>aubiocut</command>(1)
174    <command>aubiopitch</command>(1)
175    </para>
176
177  </refsect1>
178
179  <refsect1>
180    <title>AUTHOR</title>
181
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 2 any later version published
185    by the Free Software Foundation.</para>
186
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>
189
190  </refsect1>
191</refentry>
192
193<!-- Keep this comment at the end of the file
194Local variables:
195mode: sgml
196sgml-omittag:t
197sgml-shorttag:t
198sgml-minimize-attributes:nil
199sgml-always-quote-attributes:t
200sgml-indent-step:2
201sgml-indent-data:t
202sgml-parent-document:nil
203sgml-default-dtd-file:nil
204sgml-exposed-tags:nil
205sgml-local-catalogs:nil
206sgml-local-ecat-files:nil
207End:
208-->
209
210
Note: See TracBrowser for help on using the repository browser.