source: doc/aubioonset.sgml @ 3ec9d9c

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

updated manpages

  • Property mode set to 100644
File size: 6.0 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;</command>
66    </cmdsynopsis>
67  </refsynopsisdiv>
68  <refsect1>
69    <title>DESCRIPTION</title>
70
71    <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
72
73<para>The library <emphasis>aubio</emphasis> provides a small set of functions
74to extract events and objects from audio, from live streams or still files.
75Onsets are used to label the beginning of notes, pitches to label their
76height.</para>
77
78<para><command>aubionotes</command> is still in an experimental state. Its aim
79is to segment notes with onsets, and label them with their detected pitch. When
80started without an input file argument (<option>-i</option>), aubionotes
81creates a jack input and a midi output. When an input file is given, it outputs
82the results on the console.</para>
83
84  </refsect1>
85  <refsect1>
86    <title>OPTIONS</title>
87
88<para>This program follows the usual GNU command line syntax, with long options
89starting with two dashes (`-').  A summary of options is included below.</para>
90
91<variablelist>
92  <varlistentry>
93  <term><option>-i</option>
94  <option>--input filein</option></term>
95  <listitem>
96<para>Run analysis on this audio file. Most common (uncompressed) formats are
97supported.</para>
98  </listitem>
99  </varlistentry>
100  <varlistentry>
101  <term><option>-o</option>
102  <option>--output fileout</option></term>
103  <listitem>
104
105  <para>Save results in this file. The file will be created on the model of the
106  input file. Results are marked by a very short wood-block sample.</para>
107
108  </listitem>
109  </varlistentry>
110  <varlistentry>
111  <term><option>-O</option>
112  <option>--onset mode</option></term>
113  <listitem>
114
115  <para>The onset detection function to run. Available functions are
116  <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
117  <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
118  <emphasis>energy</emphasis>, <emphasis>kl</emphasis> and
119  <emphasis>mkl</emphasis>. By default, both Kullback Liebler (kl) and complex
120  domain are used in parallel.</para>
121
122  </listitem>
123  </varlistentry>
124  <varlistentry>
125  <term><option>-t</option>
126  <option>--threshold value</option></term>
127  <listitem>
128
129  <para>Set the threshold value for the onset peak picking. Typical values are
130  within <literal>0.001</literal> and <literal>0.900</literal>. Default is
131  <literal>0.1</literal>. The <emphasis>lower</emphasis> the <emphasis>more
132  sensible</emphasis>.  Try <literal>0.3</literal> in case of
133  over-detections.</para>
134
135  </listitem>
136  </varlistentry>
137  <varlistentry>
138  <term><option>-j</option>
139  <option>--jack</option></term>
140  <listitem>
141<para>Run in jack mode (default when started without input file) and creates a midi output.</para>
142  </listitem>
143  </varlistentry>
144  <varlistentry>
145  <term><option>-h</option>
146  <option>--help</option></term>
147  <listitem>
148<para>Show summary of options.</para>
149  </listitem>
150  </varlistentry>
151  <varlistentry>
152  <term><option>-v</option>
153  <option>--verbose</option></term>
154  <listitem>
155<para>Show results on the console.</para>
156
157  </listitem>
158  </varlistentry>
159</variablelist>
160
161  </refsect1>
162  <refsect1>
163    <title>SEE ALSO</title>
164
165    <para><command>aubionotes</command> (1)</para>
166
167  </refsect1>
168
169<refsect1>
170<title>BUGS</title>
171
172<para>For now the program has been only tested on audio signals sampled at 44.1
173kHz.</para>
174
175</refsect1>
176
177  <refsect1>
178    <title>AUTHOR</title>
179
180    <para>This manual page was written by &dhusername; (&dhemail;). Permission
181    is granted to copy, distribute and/or modify this document under the terms
182    of the &gnu; General Public License, Version 2 any later version published
183    by the Free Software Foundation.</para>
184
185    <para>On Debian systems, the complete text of the GNU General Public
186    License can be found in /usr/share/common-licenses/GPL.</para>
187
188  </refsect1>
189</refentry>
190
191<!-- Keep this comment at the end of the file
192Local variables:
193mode: sgml
194sgml-omittag:t
195sgml-shorttag:t
196sgml-minimize-attributes:nil
197sgml-always-quote-attributes:t
198sgml-indent-step:2
199sgml-indent-data:t
200sgml-parent-document:nil
201sgml-default-dtd-file:nil
202sgml-exposed-tags:nil
203sgml-local-catalogs:nil
204sgml-local-ecat-files:nil
205End:
206-->
207
208
209
Note: See TracBrowser for help on using the repository browser.