source: doc/aubiocut.sgml @ 8bc4800

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchpitchshiftsamplertimestretchyinfft+
Last change on this file since 8bc4800 was 8bc4800, checked in by Paul Brossier <piem@piem.org>, 11 years ago

doc/*.sgml: bump to GPLv3, update email

  • Property mode set to 100644
File size: 8.7 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@aubio.org</email>">
28  <!ENTITY dhusername  "Paul Brossier">
29  <!ENTITY dhucpackage "<refentrytitle>AUBIOCUT</refentrytitle>">
30  <!ENTITY dhpackage   "aubiocut">
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 to extract onsets and tempo from sound files.</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, or beat locations, in audio
73    signals.</para>
74
75    <para>When using the <option>--cut</option> option,
76    <command>&dhpackage;</command> takes an input sound file and produce small
77    files sliced at onset locations (or silences). The slices can then be sent
78    for example to a player, a sequencer, or a sampler.</para>
79
80    <para>A plotting module is available via the Gnuplot Python package.</para>
81
82  </refsect1>
83  <refsect1>
84    <title>OPTIONS</title>
85
86    <para>This program follows the usual GNU command line syntax, with long
87    options starting with two dashes (`-').  A summary of options is included
88    below.</para>
89
90<variablelist>
91  <varlistentry>
92  <term><option>-i</option>
93  <option>--input filein</option></term>
94  <listitem>
95  <para>input sound file</para>
96  </listitem>
97  </varlistentry>
98  <varlistentry>
99  <term><option>-m</option>
100  <option>--mode onset_detection_mode</option></term>
101  <listitem>
102  <para>onset detection mode [default=dual] complexdomain|hfc|phase|specdiff|energy|kl|mkl|dual</para>
103  </listitem>
104  </varlistentry>
105  <varlistentry>
106  <term><option>-b</option>
107  <option>--beat</option></term>
108  <listitem>
109  <para>detect beats and output beat locations</para>
110  </listitem>
111  </varlistentry>
112  <varlistentry>
113  <term><option>-B</option>
114  <option>--bufsize=BUFSIZE</option></term>
115  <listitem>
116  <para>buffer size [default=512]</para>
117  </listitem>
118  </varlistentry>
119  <varlistentry>
120  <term><option>-H</option>
121  <option>--hopsize=HOPSIZE</option></term>
122  <listitem>
123  <para>overlap size [default=256]</para>
124  </listitem>
125  </varlistentry>
126  <varlistentry>
127  <term><option>-t</option>
128  <option>--threshold=THRESHOLD</option></term>
129  <listitem>
130  <para>onset peak picking threshold [default=0.3]</para>
131  </listitem>
132  </varlistentry>
133  <varlistentry>
134  <term><option>-C</option>
135  <option>--dcthreshold=DCTHRESHOLD</option></term>
136  <listitem>
137  <para>onset peak picking DC component [default=1.]</para>
138  </listitem>
139  </varlistentry>
140  <varlistentry>
141  <term><option>-s</option>
142  <option>--silence=SILENCE</option></term>
143  <listitem>
144  <para>silence threshold [default=-70]</para>
145  </listitem>
146  </varlistentry>
147  <varlistentry>
148  <term><option>-M</option>
149  <option>--mintol=MINIOI</option></term>
150  <listitem>
151  <para>minimum inter onset interval [default=0.048s]</para>
152  </listitem>
153  </varlistentry>
154  <varlistentry>
155  <term><option>-D</option>
156  <option>--delay=DELAY</option></term>
157  <listitem>
158  <para>number of seconds to take back [default=system]
159  default system delay is 3*hopsize/samplerate</para>
160  </listitem>
161  </varlistentry>
162  <varlistentry>
163  <term><option>-L</option>
164  <option>--localmin</option></term>
165  <listitem>
166  <para>use local minima after peak detection</para>
167  </listitem>
168  </varlistentry>
169  <varlistentry>
170  <term><option>-c</option>
171  <option>--cut</option></term>
172  <listitem>
173  <para>cut input sound file at detected labels (best used with option -L)</para>
174  </listitem>
175  </varlistentry>
176  <varlistentry>
177  <term><option>-d</option>
178  <option>--derivate</option></term>
179  <listitem>
180  <para>derivate onset detection function</para>
181  </listitem>
182  </varlistentry>
183  <varlistentry>
184  <term><option>-S</option>
185  <option>--silencecut</option></term>
186  <listitem>
187  <para>outputs silence locations instead of onset locations</para>
188  </listitem>
189  </varlistentry>
190  <varlistentry>
191  <term><option>-z</option>
192  <option>--zerocross=ZEROTHRES</option></term>
193  <listitem>
194  <para>zero-crossing threshold for slicing [default=0.00008]</para>
195  </listitem>
196  </varlistentry>
197  <varlistentry>
198  <term><option>-f</option>
199  <option>--function</option></term>
200  <listitem>
201  <para>print detection function</para>
202  </listitem>
203  </varlistentry>
204  <varlistentry>
205  <term><option>-q</option>
206  <option>--quiet</option></term>
207  <listitem>
208  <para>be quiet</para>
209  </listitem>
210  </varlistentry>
211  <varlistentry>
212  <term><option>-h</option>
213  <option>--help</option></term>
214  <listitem>
215  <para>Show a summary of options.</para>
216  </listitem>
217  </varlistentry>
218  <varlistentry>
219  <term><option>-v</option>
220  <option>--verbose</option></term>
221  <listitem>
222  <para>make lots of noise [default]</para>
223  </listitem>
224  </varlistentry>
225  </variablelist>
226
227  <refsect2>
228    <title>Plotting options</title>
229
230  <para>When the Python interface to Gnuplot is installed, the following
231  additional options are available.</para>
232
233  <variablelist>
234  <varlistentry>
235  <term><option>-p</option>
236  <option>--plot</option></term>
237  <listitem>
238  <para>draw plot</para>
239  </listitem>
240  </varlistentry>
241  <varlistentry>
242  <term><option>-n</option>
243  <option>--no-onsets</option></term>
244  <listitem>
245  <para>do not plot detected onsets, only detection functions</para>
246  </listitem>
247  </varlistentry>
248  <varlistentry>
249  <term><option>-x</option>
250  <option>--xsize=SIZE</option></term>
251  <listitem>
252  <para>define horizontal plot size [default=1.]</para>
253  </listitem>
254  </varlistentry>
255  <varlistentry>
256  <term><option>-y</option>
257  <option>--ysize=SIZE</option></term>
258  <listitem>
259  <para>define vertical plot size [default=1.]</para>
260  </listitem>
261  </varlistentry>
262  <varlistentry>
263  <term><option>-O</option>
264  <option>--outplot=OUTPLOT</option></term>
265  <listitem>
266  <para>save plot to output.{ps,eps,png,svg} instead of displaying it</para>
267  </listitem>
268  </varlistentry>
269  </variablelist>
270  </refsect2>
271
272  </refsect1>
273  <refsect1>
274  <title>BUGS</title>
275
276  <para>For now the program has only been tested on audio signals sampled at
277  44.1&nbsp;kHz.</para>
278
279  </refsect1>
280
281  <refsect1>
282    <title>SEE ALSO</title>
283
284    <para>
285    <command>aubioonset</command>(1)
286    <command>aubiotrack</command>(1)
287    <command>aubionotes</command>(1)
288    <command>aubiopitch</command>(1)
289    </para>
290
291  </refsect1>
292
293  <refsect1>
294    <title>AUTHOR</title>
295
296    <para>This manual page was written by &dhusername; (&dhemail;). Permission
297    is granted to copy, distribute and/or modify this document under the terms
298    of the &gnu; General Public License, Version 3 any later version published
299    by the Free Software Foundation.</para>
300
301    <para>On Debian systems, the complete text of the GNU General Public
302    License can be found in /usr/share/common-licenses/GPL.</para>
303
304  </refsect1>
305</refentry>
306
307<!-- Keep this comment at the end of the file
308Local variables:
309mode: sgml
310sgml-omittag:t
311sgml-shorttag:t
312sgml-minimize-attributes:nil
313sgml-always-quote-attributes:t
314sgml-indent-step:2
315sgml-indent-data:t
316sgml-parent-document:nil
317sgml-default-dtd-file:nil
318sgml-exposed-tags:nil
319sgml-local-catalogs:nil
320sgml-local-ecat-files:nil
321End:
322-->
323
324
Note: See TracBrowser for help on using the repository browser.