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@aubio.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 extraction of musical notes.</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 detect notes in audio
  72     signals, segmenting consecutive events using onset detection, and
  73     determining their pitch using a fundamental frequency extraction algorithm.
  74     </para>
  75
  76     <para>When started without an input file argument
  77     (<option>--input</option>), <command>&dhpackage;</command> creates a jack
  78     input and a MIDI output. When an input file is given, the results are given
  79     on the console.</para>
  80
  81   </refsect1>
  82   <refsect1>
  83     <title>OPTIONS</title>
  84
  85     <para>This program follows the usual GNU command line syntax, with long
  86     options starting with two dashes (`-').  A summary of options is included
  87     below.</para>
  88
  89 <variablelist>
  90   <varlistentry>
  91   <term><option>-i</option>
  92   <option>--input filein</option></term>
  93   <listitem>
  94
  95   <para>Run analysis on this audio file. Most common uncompressed formats are
  96   supported.</para>
  97
  98   </listitem>
  99   </varlistentry>
 100   <varlistentry>
 101   <term><option>-o</option>
 102   <option>--output fileout</option></term>
 103   <listitem>
 104
 105   <para>Save results in this file. The file will be created on the model of the
 106   input file. Results are marked by a short wood-block sample.</para>
 107
 108   </listitem>
 109   </varlistentry>
 110   <varlistentry>
 111   <term><option>-P</option>
 112   <option>--pitch mode</option></term>
 113   <listitem>
 114
 115   <para>The pitch detection function to run. Available functions are
 116   <emphasis>yinfft</emphasis>, <emphasis>yin</emphasis>,
 117   <emphasis>mcomb</emphasis>, <emphasis>fcomb</emphasis>, and
 118   <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>. <emphasis>Lower</emphasis> threshold values imply
 144   <emphasis>more</emphasis> onsets detected. Try <literal>0.3</literal> in
 145   case of 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>-v</option>
 158   <option>--verbose</option></term>
 159   <listitem>
 160   <para>Show results on the console (default).</para>
 161   </listitem>
 162   </varlistentry>
 163   <varlistentry>
 164   <term><option>-h</option>
 165   <option>--help</option></term>
 166   <listitem>
 167   <para>Show summary of options.</para>
 168   </listitem>
 169   </varlistentry>
 170 </variablelist>
 171
 172   </refsect1>
 173   <refsect1>
 174   <title>BUGS</title>
 175
 176   <para>For now the program has only been tested on audio signals sampled at
 177   44.1&nbsp;kHz.</para>
 178
 179   </refsect1>
 180
 181   <refsect1>
 182     <title>SEE ALSO</title>
 183
 184     <para>
 185     <command>aubioonset</command>(1)
 186     <command>aubiotrack</command>(1)
 187     <command>aubiocut</command>(1)
 188     <command>aubiopitch</command>(1)
 189     </para>
 190
 191   </refsect1>
 192
 193   <refsect1>
 194     <title>AUTHOR</title>
 195
 196     <para>This manual page was written by &dhusername; (&dhemail;). Permission
 197     is granted to copy, distribute and/or modify this document under the terms
 198     of the &gnu; General Public License, Version 3 any later version published
 199     by the Free Software Foundation.</para>
 200
 201     <para>On Debian systems, the complete text of the GNU General Public
 202     License can be found in /usr/share/common-licenses/GPL.</para>
 203
 204   </refsect1>
 205 </refentry>
 206
 207 <!-- Keep this comment at the end of the file
 208 Local variables:
 209 mode: sgml
 210 sgml-omittag:t
 211 sgml-shorttag:t
 212 sgml-minimize-attributes:nil
 213 sgml-always-quote-attributes:t
 214 sgml-indent-step:2
 215 sgml-indent-data:t
 216 sgml-parent-document:nil
 217 sgml-default-dtd-file:nil
 218 sgml-exposed-tags:nil
 219 sgml-local-catalogs:nil
 220 sgml-local-ecat-files:nil
 221 End:
 222 -->
 223
 224