source: doc/aubiopitch.sgml @ 08f6688

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since 08f6688 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: 6.7 KB
RevLine 
[8d0b707]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>AUBIOPITCH</refentrytitle>">
30  <!ENTITY dhpackage   "aubiopitch">
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>aubionotes</command> attempts to label each fram of the
75    input sound file with a pitch. When no pitch candidate is found, the
76    output is 0. Results can be printed in Hertz or in MIDI pitch.  A plotting
77    module is available via the Gnuplot Python package. 4 functions are
78    available.</para>
79
80  </refsect1>
81  <refsect1>
82    <title>OPTIONS</title>
83
84    <para>This program follows the usual GNU command line syntax, with long
85    options starting with two dashes (`-').  A summary of options is included
86    below.</para>
87
88<variablelist>
89  <varlistentry>
90  <term><option>-i</option>
91  <option>--input filein</option></term>
92  <listitem>
93  <para>input sound file</para>
94  </listitem>
95  </varlistentry>
96  <varlistentry>
97  <term><option>-m</option>
98  <option>--mode pitch_detection_mode</option></term>
99  <listitem>
100  <para>pitch detection mode [default=mcomb] mcomb|yin|fcomb|schmitt</para>
101  </listitem>
102  </varlistentry>
103  <varlistentry>
104  <term><option>-u</option>
105  <option>--units unitmode</option></term>
106  <listitem>
107  <para>output pitch in units [default=Hz] freq|midi|cent|bin</para>
108  </listitem>
109  </varlistentry>
110  <varlistentry>
111  <term><option>-B</option>
112  <option>--bufsize=BUFSIZE</option></term>
113  <listitem>
114  <para>buffer size [default=1024]</para>
115  </listitem>
116  </varlistentry>
117  <varlistentry>
118  <term><option>-H</option>
119  <option>--hopsize=HOPSIZE</option></term>
120  <listitem>
121  <para>overlap size [default=512]</para>
122  </listitem>
123  </varlistentry>
124  <varlistentry>
125  <term><option>-t</option>
126  <option>--threshold=THRESHOLD</option></term>
127  <listitem>
128  <para>pitch threshold (for yin) [default=0.1]</para>
129  </listitem>
130  </varlistentry>
131  <varlistentry>
132  <term><option>-s</option>
133  <option>--silence=SILENCE</option></term>
134  <listitem>
135  <para>silence threshold [default=-70]</para>
136  </listitem>
137  </varlistentry>
138  <varlistentry>
139  <term><option>-D</option>
140  <option>--delay=DELAY</option></term>
141  <listitem>
142  <para>number of seconds to take back [default=system]
143  default system delay is 2*hopsize/samplerate</para>
144  </listitem>
145  </varlistentry>
146  <varlistentry>
147  <term><option>-L</option>
148  <option>--localmin</option></term>
149  <listitem>
150  <para>use local minima after peak detection</para>
151  </listitem>
152  </varlistentry>
153  <varlistentry>
154  <term><option>-c</option>
155  <option>--cut</option></term>
156  <listitem>
157  <para>cut input sound file at detected labels (best used with option -L)</para>
158  </listitem>
159  </varlistentry>
160  <varlistentry>
161  <term><option>-n</option>
162  <option>--note</option></term>
163  <listitem>
164  <para>NOT IMPLEMENTED output notes</para>
165  </listitem>
166  </varlistentry>
167  <varlistentry>
168  <term><option>-p</option>
169  <option>--plot</option></term>
170  <listitem>
171  <para>NOT IMPLEMENTED draw plot</para>
172  </listitem>
173  </varlistentry>
174  <varlistentry>
175  <term><option>-O</option>
176  <option>--outplot=OUTPLOT</option></term>
177  <listitem>
178  <para>NOT IMPLEMENTED save plot to output.{ps,png}</para>
179  </listitem>
180  </varlistentry>
181  <varlistentry>
182  <term><option>-v</option>
183  <option>--verbose</option></term>
184  <listitem>
185  <para>make lots of noise [default]</para>
186  </listitem>
187  </varlistentry>
188  <varlistentry>
189  <term><option>-q</option>
190  <option>--quiet</option></term>
191  <listitem>
192  <para>be quiet</para>
193  </listitem>
194  </varlistentry>
195  <varlistentry>
196  <term><option>-h</option>
197  <option>--help</option></term>
198  <listitem>
199  <para>show this help message and exit</para>
200  </listitem>
201  </varlistentry>
202</variablelist>
203
204
205</refsect1>
206  <refsect1>
207    <title>SEE ALSO</title>
208
209    <para>
210    <command>aubionotes</command>(1)
211    <command>aubioonset</command>(1)
212    <command>aubiocut</command>(1)
213    <command>aubiotrack</command>(1)
214    </para>
215
216  </refsect1>
217
218  <refsect1>
219    <title>AUTHOR</title>
220
221    <para>This manual page was written by &dhusername; (&dhemail;). Permission
222    is granted to copy, distribute and/or modify this document under the terms
223    of the &gnu; General Public License, Version 2 any later version published
224    by the Free Software Foundation.</para>
225
226    <para>On Debian systems, the complete text of the GNU General Public
227    License can be found in /usr/share/common-licenses/GPL.</para>
228
229  </refsect1>
230</refentry>
231
232<!-- Keep this comment at the end of the file
233Local variables:
234mode: sgml
235sgml-omittag:t
236sgml-shorttag:t
237sgml-minimize-attributes:nil
238sgml-always-quote-attributes:t
239sgml-indent-step:2
240sgml-indent-data:t
241sgml-parent-document:nil
242sgml-default-dtd-file:nil
243sgml-exposed-tags:nil
244sgml-local-catalogs:nil
245sgml-local-ecat-files:nil
246End:
247-->
248
249
Note: See TracBrowser for help on using the repository browser.