source: doc/aubiocut.sgml @ e83c895

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

added and updated manpages
added and updated manpages

  • Property mode set to 100644
File size: 7.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>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 for real time wav to midi
61    conversion</refpurpose>
62
63  </refnamediv>
64  <refsynopsisdiv>
65    <cmdsynopsis>
66      <command>&dhpackage; <parameter>[options] -i soundfile</parameter></command>
67    </cmdsynopsis>
68  </refsynopsisdiv>
69  <refsect1>
70    <title>DESCRIPTION</title>
71
72    <para>This manual page documents briefly the <command>&dhpackage;</command> command. </para>
73   
74    <para><command>&dhpackage;</command> takes an input sound file and produce
75    small file sliced at onset locations. The slices can then be sent to a
76    player, a sequencer, a sampler, or wherever else. The files can be cut at
77    onset times or at silences.</para>
78
79  </refsect1>
80  <refsect1>
81    <title>OPTIONS</title>
82
83<para>This program follows the usual GNU command line syntax, with long options
84starting with two dashes (`-').  A summary of options is included below.</para>
85
86<variablelist>
87  <varlistentry>
88  <term><option>-h</option>
89  <option>--help</option></term>
90  <listitem>
91  <para>show this help message and exit</para>
92  </listitem>
93  </varlistentry>
94  <varlistentry>
95  <term><option>-i</option>
96  <option>--input filein</option></term>
97  <listitem>
98  <para>input sound file</para>
99  </listitem>
100  </varlistentry>
101  <varlistentry>
102  <term><option>-m</option>
103  <option>--mode onset_detection_mode</option></term>
104  <listitem>
105  <para>onset detection mode [default=dual] complexdomain|hfc|phase|specdiff|energy|kl|mkl|dual</para>
106  </listitem>
107  </varlistentry>
108  <varlistentry>
109  <term><option>-B</option>
110  <option>--bufsize=BUFSIZE</option></term>
111  <listitem>
112  <para>buffer size [default=1024]</para>
113  </listitem>
114  </varlistentry>
115  <varlistentry>
116  <term><option>-H</option>
117  <option>--hopsize=HOPSIZE</option></term>
118  <listitem>
119  <para>overlap size [default=512]</para>
120  </listitem>
121  </varlistentry>
122  <varlistentry>
123  <term><option>-t</option>
124  <option>--threshold=THRESHOLD</option></term>
125  <listitem>
126  <para>pitch threshold (for yin) [default=0.1]</para>
127  </listitem>
128  </varlistentry>
129  <varlistentry>
130  <term><option>-s</option>
131  <option>--silence=SILENCE</option></term>
132  <listitem>
133  <para>silence threshold [default=-70]</para>
134  </listitem>
135  </varlistentry>
136  <varlistentry>
137  <term><option>-D</option>
138  <option>--delay=DELAY</option></term>
139  <listitem>
140  <para>number of seconds to take back [default=system]
141  default system delay is 2*hopsize/samplerate</para>
142  </listitem>
143  </varlistentry>
144  <varlistentry>
145  <term><option>-L</option>
146  <option>--localmin</option></term>
147  <listitem>
148  <para>use local minima after peak detection</para>
149  </listitem>
150  </varlistentry>
151  <varlistentry>
152  <term><option>-c</option>
153  <option>--cut</option></term>
154  <listitem>
155  <para>cut input sound file at detected labels (best used with option -L)</para>
156  </listitem>
157  </varlistentry>
158  <varlistentry>
159  <term><option>-d</option>
160  <option>--derivate</option></term>
161  <listitem>
162  <para>derivate onset detection function</para>
163  </listitem>
164  </varlistentry>
165  <varlistentry>
166  <term><option>-S</option>
167  <option>--silencecut</option></term>
168  <listitem>
169  <para>outputs silence locations instead of onset locations</para>
170  </listitem>
171  </varlistentry>
172  <varlistentry>
173  <term><option>-z</option>
174  <option>--zerocross=ZEROTHRES</option></term>
175  <listitem>
176  <para>zero-crossing threshold for slicing [default=0.00008]</para>
177  </listitem>
178  </varlistentry>
179  <varlistentry>
180  <term><option>-p</option>
181  <option>--plot</option></term>
182  <listitem>
183  <para>draw plot</para>
184  </listitem>
185  </varlistentry>
186  <varlistentry>
187  <term><option>-O</option>
188  <option>--outplot=OUTPLOT</option></term>
189  <listitem>
190  <para>save plot to output.{ps,png}</para>
191  </listitem>
192  </varlistentry>
193  <varlistentry>
194  <term><option>-v</option>
195  <option>--verbose</option></term>
196  <listitem>
197  <para>make lots of noise [default]</para>
198  </listitem>
199  </varlistentry>
200  <varlistentry>
201  <term><option>-q</option>
202  <option>--quiet</option></term>
203  <listitem>
204  <para>be quiet</para>
205  </listitem>
206  </varlistentry>
207  <varlistentry>
208  <term><option>-b</option>
209  <option>--beat</option></term>
210  <listitem>
211  <para>NOT IMPLEMENTED output beat locations</para>
212  </listitem>
213  </varlistentry>
214</variablelist>
215
216</refsect1>
217  <refsect1>
218    <title>SEE ALSO</title>
219
220    <para>
221    <command>aubioonset</command>(1)
222    <command>aubiotrack</command>(1)
223    <command>aubionotes</command>(1)
224    <command>aubiopitch</command>(1)
225    </para>
226
227  </refsect1>
228
229  <refsect1>
230    <title>AUTHOR</title>
231
232    <para>This manual page was written by &dhusername; (&dhemail;). Permission
233    is granted to copy, distribute and/or modify this document under the terms
234    of the &gnu; General Public License, Version 2 any later version published
235    by the Free Software Foundation.</para>
236
237    <para>On Debian systems, the complete text of the GNU General Public
238    License can be found in /usr/share/common-licenses/GPL.</para>
239
240  </refsect1>
241</refentry>
242
243<!-- Keep this comment at the end of the file
244Local variables:
245mode: sgml
246sgml-omittag:t
247sgml-shorttag:t
248sgml-minimize-attributes:nil
249sgml-always-quote-attributes:t
250sgml-indent-step:2
251sgml-indent-data:t
252sgml-parent-document:nil
253sgml-default-dtd-file:nil
254sgml-exposed-tags:nil
255sgml-local-catalogs:nil
256sgml-local-ecat-files:nil
257End:
258-->
259
260
Note: See TracBrowser for help on using the repository browser.