ref: 99d27b7be002e2ef4fde2f09e341584f1968bb48
dir: /doc/aubiopitch.sgml/
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Paul</firstname>">
<!ENTITY dhsurname "<surname>Brossier</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>December 1, 2004</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>piem@altern.org</email>">
<!ENTITY dhusername "Paul Brossier">
<!ENTITY dhucpackage "<refentrytitle>AUBIOPITCH</refentrytitle>">
<!ENTITY dhpackage "aubiopitch">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2003</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>a command line tool for real time wav to midi
conversion</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage; <parameter>[options] -i soundfile</parameter></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
<para><command>aubionotes</command> attempts to label each fram of the
input sound file with a pitch. When no pitch candidate is found, the
output is 0. Results can be printed in Hertz or in MIDI pitch. A plotting
module is available via the Gnuplot Python package. 4 functions are
available.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-'). A summary of options is included
below.</para>
<variablelist>
<varlistentry>
<term><option>-i</option>
<option>--input filein</option></term>
<listitem>
<para>input sound file</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-m</option>
<option>--mode pitch_detection_mode</option></term>
<listitem>
<para>pitch detection mode [default=mcomb] mcomb|yin|fcomb|schmitt</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-u</option>
<option>--units unitmode</option></term>
<listitem>
<para>output pitch in units [default=Hz] freq|midi|cent|bin</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-B</option>
<option>--bufsize=BUFSIZE</option></term>
<listitem>
<para>buffer size [default=1024]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-H</option>
<option>--hopsize=HOPSIZE</option></term>
<listitem>
<para>overlap size [default=512]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option>
<option>--threshold=THRESHOLD</option></term>
<listitem>
<para>pitch threshold (for yin) [default=0.1]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option>
<option>--silence=SILENCE</option></term>
<listitem>
<para>silence threshold [default=-70]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-D</option>
<option>--delay=DELAY</option></term>
<listitem>
<para>number of seconds to take back [default=system]
default system delay is 2*hopsize/samplerate</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-L</option>
<option>--localmin</option></term>
<listitem>
<para>use local minima after peak detection</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option>
<option>--cut</option></term>
<listitem>
<para>cut input sound file at detected labels (best used with option -L)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option>
<option>--note</option></term>
<listitem>
<para>NOT IMPLEMENTED output notes</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option>
<option>--plot</option></term>
<listitem>
<para>NOT IMPLEMENTED draw plot</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-O</option>
<option>--outplot=OUTPLOT</option></term>
<listitem>
<para>NOT IMPLEMENTED save plot to output.{ps,png}</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option>
<option>--verbose</option></term>
<listitem>
<para>make lots of noise [default]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option>
<option>--quiet</option></term>
<listitem>
<para>be quiet</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>
<option>--help</option></term>
<listitem>
<para>show this help message and exit</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<command>aubionotes</command>(1)
<command>aubioonset</command>(1)
<command>aubiocut</command>(1)
<command>aubiotrack</command>(1)
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; (&dhemail;). Permission
is granted to copy, distribute and/or modify this document under the terms
of the &gnu; General Public License, Version 2 any later version published
by the Free Software Foundation.</para>
<para>On Debian systems, the complete text of the GNU General Public
License can be found in /usr/share/common-licenses/GPL.</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->