source: doc/aubiopitch.sgml @ ed631e9

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since ed631e9 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: 7.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@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 to extract pitch candidates 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 extract fundamental
72    frequency in sound files. When no pitch candidate is found, the output is
73    0. Five fundamental frequency extraction methods are available. Results can
74    be printed in Hertz or in MIDI pitch.</para>
75
76    <para>A plotting module is available via the Gnuplot Python package.</para>
77
78  </refsect1>
79  <refsect1>
80    <title>OPTIONS</title>
81
82    <para>This program follows the usual GNU command line syntax, with long
83    options starting with two dashes (`-').  A summary of options is included
84    below.</para>
85
86<variablelist>
87  <varlistentry>
88  <term><option>-i</option>
89  <option>--input filein</option></term>
90  <listitem>
91  <para>input sound file</para>
92  </listitem>
93  </varlistentry>
94  <varlistentry>
95  <term><option>-m</option>
96  <option>--mode pitch_detection_mode</option></term>
97  <listitem>
98  <para>pitch detection mode [default=mcomb] mcomb|yin|fcomb|schmitt</para>
99  </listitem>
100  </varlistentry>
101  <varlistentry>
102  <term><option>-u</option>
103  <option>--units unitmode</option></term>
104  <listitem>
105  <para>output pitch in units [default=Hz] freq|midi|cent|bin</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=0]</para>
141  </listitem>
142  </varlistentry>
143  <varlistentry>
144  <term><option>-S</option>
145  <option>--smoothing=frames</option></term>
146  <listitem>
147  <para>temporal smoothing using a median filter of N frames [default=0]</para>
148  </listitem>
149  </varlistentry>
150  <varlistentry>
151  <term><option>-M</option>
152  <option>--pitchmax=max</option></term>
153  <listitem>
154  <para>maximum pitch values to look for (Hz) [default=20000]</para>
155  </listitem>
156  </varlistentry>
157  <varlistentry>
158  <term><option>-l</option>
159  <option>--pitchmin=min</option></term>
160  <listitem>
161  <para>minimum pitch values to look for (Hz) [default=20]</para>
162  </listitem>
163  </varlistentry>
164  <varlistentry>
165  <term><option>-n</option>
166  <option>--note</option></term>
167  <listitem>
168  <para>NOT IMPLEMENTED output notes</para>
169  </listitem>
170  </varlistentry>
171  <varlistentry>
172  <term><option>-q</option>
173  <option>--quiet</option></term>
174  <listitem>
175  <para>be quiet</para>
176  </listitem>
177  </varlistentry>
178  <varlistentry>
179  <term><option>-h</option>
180  <option>--help</option></term>
181  <listitem>
182  <para>Show a summary of options.</para>
183  </listitem>
184  </varlistentry>
185  <varlistentry>
186  <term><option>-v</option>
187  <option>--verbose</option></term>
188  <listitem>
189  <para>make lots of noise [default]</para>
190  </listitem>
191  </varlistentry>
192  </variablelist>
193
194  <refsect2>
195    <title>Plotting options</title>
196
197  <para>When the Python interface to Gnuplot is installed, the following
198  additional options are available.</para>
199
200  <variablelist>
201  <varlistentry>
202  <term><option>-p</option>
203  <option>--plot</option></term>
204  <listitem>
205  <para>draw plot of the pitch track</para>
206  </listitem>
207  </varlistentry>
208  <varlistentry>
209  <term><option>-T</option>
210  <option>--plottruth</option></term>
211  <listitem>
212  <para>draw plot of the ground truth pitch track</para>
213  </listitem>
214  </varlistentry>
215  <varlistentry>
216  <term><option>-x</option>
217  <option>--xsize=SIZE</option></term>
218  <listitem>
219  <para>define horizontal plot size [default=1.]</para>
220  </listitem>
221  </varlistentry>
222  <varlistentry>
223  <term><option>-y</option>
224  <option>--ysize=SIZE</option></term>
225  <listitem>
226  <para>define vertical plot size [default=1.]</para>
227  </listitem>
228  </varlistentry>
229  <varlistentry>
230  <term><option>-O</option>
231  <option>--outplot=OUTPLOT</option></term>
232  <listitem>
233  <para>save plot to output.{ps,eps,png,svg} instead of displaying it</para>
234  </listitem>
235  </varlistentry>
236  </variablelist>
237  </refsect2>
238
239  </refsect1>
240  <refsect1>
241  <title>BUGS</title>
242
243  <para>For now the program has only been tested on audio signals sampled at
244  44.1&nbsp;kHz.</para>
245
246  </refsect1>
247
248  <refsect1>
249    <title>SEE ALSO</title>
250
251    <para>
252    <command>aubioonset</command>(1)
253    <command>aubiotrack</command>(1)
254    <command>aubionotes</command>(1)
255    <command>aubiocut</command>(1)
256    </para>
257
258  </refsect1>
259
260  <refsect1>
261    <title>AUTHOR</title>
262
263    <para>This manual page was written by &dhusername; (&dhemail;). Permission
264    is granted to copy, distribute and/or modify this document under the terms
265    of the &gnu; General Public License, Version 2 any later version published
266    by the Free Software Foundation.</para>
267
268    <para>On Debian systems, the complete text of the GNU General Public
269    License can be found in /usr/share/common-licenses/GPL.</para>
270
271  </refsect1>
272</refentry>
273
274<!-- Keep this comment at the end of the file
275Local variables:
276mode: sgml
277sgml-omittag:t
278sgml-shorttag:t
279sgml-minimize-attributes:nil
280sgml-always-quote-attributes:t
281sgml-indent-step:2
282sgml-indent-data:t
283sgml-parent-document:nil
284sgml-default-dtd-file:nil
285sgml-exposed-tags:nil
286sgml-local-catalogs:nil
287sgml-local-ecat-files:nil
288End:
289-->
290
291
Note: See TracBrowser for help on using the repository browser.