doc/aubionotes.sgml

   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
   8 manpage.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>AUBIONOTES</refentrytitle>">
  30   <!ENTITY dhpackage   "aubionotes">
  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;</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> is still in an experimental state.
  75     Its aim is to extract the melody and output it as a midi stream with a
  76     minimal deleay. Pitch candidates are selected at each frame, onset and
  77     silences are used to segment the notes.</para>
  78
  79     <para>When started without an input file argument (<option>-i</option>),
  80     aubionotes creates a jack input and a midi output. When an input file is
  81     given, it outputs the results on the console.</para>
  82
  83
  84   </refsect1>
  85   <refsect1>
  86     <title>OPTIONS</title>
  87
  88     <para>This program follows the usual GNU command line syntax, with long
  89     options starting with two dashes (`-').  A summary of options is included
  90     below.</para>
  91
  92 <variablelist>
  93   <varlistentry>
  94   <term><option>-i</option>
  95   <option>--input filein</option></term>
  96   <listitem>
  97 <para>Run analysis on this audio file. Most common (uncompressed) formats are
  98 supported.</para>
  99   </listitem>
 100   </varlistentry>
 101   <varlistentry>
 102   <term><option>-o</option>
 103   <option>--output fileout</option></term>
 104   <listitem>
 105
 106   <para>Save results in this file. The file will be created on the model of the
 107   input file. Results are marked by a very short wood-block sample.</para>
 108
 109   </listitem>
 110   </varlistentry>
 111   <varlistentry>
 112   <term><option>-P</option>
 113   <option>--pitch mode</option></term>
 114   <listitem>
 115
 116   <para>The pitch detection function to run. Available functions are
 117   <emphasis>mcomb</emphasis>, <emphasis>yin</emphasis>,
 118   <emphasis>fcomb</emphasis> and <emphasis>schmitt</emphasis>.</para>
 119
 120   </listitem>
 121   </varlistentry>
 122   <varlistentry>
 123   <term><option>-O</option>
 124   <option>--onset mode</option></term>
 125   <listitem>
 126
 127   <para>The onset detection function to run. Available functions are
 128   <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
 129   <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
 130   <emphasis>energy</emphasis>, <emphasis>kl</emphasis> and
 131   <emphasis>mkl</emphasis>. By default, both Kullback Liebler (kl) and complex
 132   domain are used in parallel.</para>
 133
 134   </listitem>
 135   </varlistentry>
 136   <varlistentry>
 137   <term><option>-t</option>
 138   <option>--threshold value</option></term>
 139   <listitem>
 140
 141   <para>Set the threshold value for the onset peak picking. Typical values are
 142   within <literal>0.001</literal> and <literal>0.900</literal>. Default is
 143   <literal>0.1</literal>. The <emphasis>lower</emphasis> the <emphasis>more
 144   sensible</emphasis>.  Try <literal>0.3</literal> in case of
 145   over-detections.</para>
 146
 147   </listitem>
 148   </varlistentry>
 149   <varlistentry>
 150   <term><option>-j</option>
 151   <option>--jack</option></term>
 152   <listitem>
 153 <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
 154   </listitem>
 155   </varlistentry>
 156   <varlistentry>
 157   <term><option>-h</option>
 158   <option>--help</option></term>
 159   <listitem>
 160 <para>Show summary of options.</para>
 161   </listitem>
 162   </varlistentry>
 163   <varlistentry>
 164   <term><option>-v</option>
 165   <option>--verbose</option></term>
 166   <listitem>
 167 <para>Show results on the console.</para>
 168
 169   </listitem>
 170   </varlistentry>
 171 </variablelist>
 172
 173   </refsect1>
 174   <refsect1>
 175     <title>SEE ALSO</title>
 176
 177     <para>
 178     <command>aubioonset</command>(1)
 179     <command>aubiotrack</command>(1)
 180     <command>aubionotes</command>(1)
 181     <command>aubiopitch</command>(1)
 182     </para>
 183
 184   </refsect1>
 185
 186 <refsect1>
 187 <title>BUGS</title>
 188
 189 <para>For now the program has been only tested on audio signals sampled at 44.1
 190 kHz. The pitch detectors are also way too cpu-intensive.</para>
 191
 192 </refsect1>
 193
 194   <refsect1>
 195     <title>AUTHOR</title>
 196
 197     <para>This manual page was written by &dhusername; (&dhemail;). Permission
 198     is granted to copy, distribute and/or modify this document under the terms
 199     of the &gnu; General Public License, Version 2 any later version published
 200     by the Free Software Foundation.</para>
 201
 202     <para>On Debian systems, the complete text of the GNU General Public
 203     License can be found in /usr/share/common-licenses/GPL.</para>
 204
 205   </refsect1>
 206 </refentry>
 207
 208 <!-- Keep this comment at the end of the file
 209 Local variables:
 210 mode: sgml
 211 sgml-omittag:t
 212 sgml-shorttag:t
 213 sgml-minimize-attributes:nil
 214 sgml-always-quote-attributes:t
 215 sgml-indent-step:2
 216 sgml-indent-data:t
 217 sgml-parent-document:nil
 218 sgml-default-dtd-file:nil
 219 sgml-exposed-tags:nil
 220 sgml-local-catalogs:nil
 221 sgml-local-ecat-files:nil
 222 End:
 223 -->
 224
 225