<!-- 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 dhemail "<email>piem@aubio.org</email>">
<!ENTITY dhusername "Paul Brossier">
- <!ENTITY dhucpackage "<refentrytitle>AUBIO</refentrytitle>">
+ <!ENTITY dhucpackage "<refentrytitle>AUBIONOTES</refentrytitle>">
<!ENTITY dhpackage "aubionotes">
<!ENTITY debian "<productname>Debian</productname>">
<refnamediv>
<refname>&dhpackage;</refname>
- <refpurpose>a command line tool for real time wav to midi
- conversion</refpurpose>
+ <refpurpose>a command line tool for real time extraction of musical notes.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>&dhpackage;</command>
+ <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>The library <emphasis>aubio</emphasis> provides a small set of functions
-to extract events and objects from audio, from live streams or still files.
-Onsets are used to label the beginning of notes, pitches to label their
-height.</para>
-
-<para><command>aubionotes</command> is still in an experimental state. Its aim
-is to segment notes with onsets, and label them with their detected pitch. When
-started without an input file argument (<option>-i</option>), aubionotes
-creates a jack input and a midi output. When an input file is given, it outputs
-the results on the console.</para>
+ <para><command>&dhpackage;</command> attempts to detect notes in audio
+ signals, segmenting consecutive events using onset detection, and
+ determining their pitch using a fundamental frequency extraction algorithm.
+ </para>
+
+ <para>When started without an input file argument
+ (<option>--input</option>), <command>&dhpackage;</command> creates a jack
+ input and a MIDI output. When an input file is given, the results are given
+ on the console.</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>
+ <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>Run analysis on this audio file. Most common (uncompressed) formats are
-supported.</para>
+
+ <para>Run analysis on this audio file. Most common uncompressed formats are
+ supported.</para>
+
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o</option>
<option>--output fileout</option></term>
<listitem>
-<para>Save results in this file. The file will be created on the model of the
-input file. Results are marked by a very short wood-block sample.</para>
+
+ <para>Save results in this file. The file will be created on the model of the
+ input file. Results are marked by a short wood-block sample.</para>
+
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-t</option>
- <option>--threshold value</option></term>
+ <term><option>-P</option>
+ <option>--pitch mode</option></term>
<listitem>
-<para>Set the threshold value for the onset peak picking. Typical values are within
-<literal>0.001</literal> and <literal>0.900</literal>. Default is <literal>0.1</literal>. The <emphasis>lower</emphasis> the <emphasis>more
-sensible</emphasis>. Try <literal>0.3</literal> in case of over-detections.</para>
+
+ <para>The pitch detection function to run. Available functions are
+ <emphasis>yinfft</emphasis>, <emphasis>yin</emphasis>,
+ <emphasis>mcomb</emphasis>, <emphasis>fcomb</emphasis>, and
+ <emphasis>schmitt</emphasis>.</para>
+
</listitem>
</varlistentry>
<varlistentry>
<term><option>-O</option>
- <option>--onset value</option></term>
+ <option>--onset mode</option></term>
<listitem>
- <para>The onset detection function to run. Can be one of
+ <para>The onset detection function to run. Available functions are
<emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
<emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
- <emphasis>energy</emphasis>. By default (<emphasis>fixme</emphasis>), both
- complex domain and HFC are used in parallel.</para>
+ <emphasis>energy</emphasis>, <emphasis>kl</emphasis> and
+ <emphasis>mkl</emphasis>. By default, both Kullback Liebler (kl) and complex
+ domain are used in parallel.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-j</option>
- <option>--jack</option></term>
+ <term><option>-t</option>
+ <option>--threshold value</option></term>
<listitem>
-<para>Run in jack mode (default when started without input file) and creates a midi output.</para>
+
+ <para>Set the threshold value for the onset peak picking. Typical values are
+ within <literal>0.001</literal> and <literal>0.900</literal>. Default is
+ <literal>0.1</literal>. <emphasis>Lower</emphasis> threshold values imply
+ <emphasis>more</emphasis> onsets detected. Try <literal>0.3</literal> in
+ case of over-detections.</para>
+
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-h</option>
- <option>--help</option></term>
+ <term><option>-j</option>
+ <option>--jack</option></term>
<listitem>
-<para>Show summary of options.</para>
+ <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option>
<option>--verbose</option></term>
<listitem>
-<para>Show results on the console.</para>
-
+ <para>Show results on the console (default).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-h</option>
+ <option>--help</option></term>
+ <listitem>
+ <para>Show summary of options.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
- <title>SEE ALSO</title>
+ <title>BUGS</title>
- <para><emphasis>aubioonset</emphasis> (1)</para>
+ <para>For now the program has only been tested on audio signals sampled at
+ 44.1 kHz.</para>
</refsect1>
-<refsect1>
-<title>BUGS</title>
+ <refsect1>
+ <title>SEE ALSO</title>
-<para>For now the program has been only tested on audio signals sampled at 44.1
-kHz. The pitch detectors are also way too cpu-intensive.</para>
+ <para>
+ <command>aubioonset</command>(1)
+ <command>aubiotrack</command>(1)
+ <command>aubiocut</command>(1)
+ <command>aubiopitch</command>(1)
+ </para>
-</refsect1>
+ </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
+ of the &gnu; General Public License, Version 3 any later version published
by the Free Software Foundation.</para>
<para>On Debian systems, the complete text of the GNU General Public
projects / aubio.git / blobdiff