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>AUBIO</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>The library <emphasis>aubio</emphasis> provides a small set of functions
  75 to extract events and objects from audio, from live streams or still files.
  76 Onsets are used to label the beginning of notes, pitches to label their
  77 height.</para>
  78
  79 <para><command>aubionotes</command> is still in an experimental state. Its aim
  80 is to segment notes with onsets, and label them with their detected pitch. When
  81 started without an input file argument (<option>-i</option>), aubionotes
  82 creates a jack input and a midi output. When an input file is given, it outputs
  83 the results on the console.</para>
  84
  85   </refsect1>
  86   <refsect1>
  87     <title>OPTIONS</title>
  88
  89 <para>This program follows the usual GNU command line syntax, with long options
  90 starting with two dashes (`-').  A summary of options is included 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 <para>Save results in this file. The file will be created on the model of the
 106 input file. Results are marked by a very short wood-block sample.</para>
 107   </listitem>
 108   </varlistentry>
 109   <varlistentry>
 110   <term><option>-t</option>
 111   <option>--threshold value</option></term>
 112   <listitem>
 113 <para>Set the threshold value for the onset peak picking. Typical values are within
 114 <literal>0.001</literal> and <literal>0.900</literal>. Default is <literal>0.1</literal>. The <emphasis>lower</emphasis> the <emphasis>more
 115 sensible</emphasis>.  Try <literal>0.3</literal> in case of over-detections.</para>
 116   </listitem>
 117   </varlistentry>
 118   <varlistentry>
 119   <term><option>-O</option>
 120   <option>--onset value</option></term>
 121   <listitem>
 122
 123   <para>The onset detection function to run. Can be one of
 124   <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
 125   <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
 126   <emphasis>energy</emphasis>. By default (<emphasis>fixme</emphasis>), both
 127   complex domain and HFC are used in parallel.</para>
 128
 129   </listitem>
 130   </varlistentry>
 131   <varlistentry>
 132   <term><option>-j</option>
 133   <option>--jack</option></term>
 134   <listitem>
 135 <para>Run in jack mode (default when started without input file) and creates a midi output.</para>
 136   </listitem>
 137   </varlistentry>
 138   <varlistentry>
 139   <term><option>-h</option>
 140   <option>--help</option></term>
 141   <listitem>
 142 <para>Show summary of options.</para>
 143   </listitem>
 144   </varlistentry>
 145   <varlistentry>
 146   <term><option>-v</option>
 147   <option>--verbose</option></term>
 148   <listitem>
 149 <para>Show results on the console.</para>
 150
 151   </listitem>
 152   </varlistentry>
 153 </variablelist>
 154
 155   </refsect1>
 156   <refsect1>
 157     <title>SEE ALSO</title>
 158
 159     <para><emphasis>aubioonset</emphasis> (1)</para>
 160
 161   </refsect1>
 162
 163 <refsect1>
 164 <title>BUGS</title>
 165
 166 <para>For now the program has been only tested on audio signals sampled at 44.1
 167 kHz. The pitch detectors are also way too cpu-intensive.</para>
 168
 169 </refsect1>
 170
 171   <refsect1>
 172     <title>AUTHOR</title>
 173
 174     <para>This manual page was written by &dhusername; (&dhemail;). Permission
 175     is granted to copy, distribute and/or modify this document under the terms
 176     of the &gnu; General Public License, Version 2 any later version published
 177     by the Free Software Foundation.</para>
 178
 179     <para>On Debian systems, the complete text of the GNU General Public
 180     License can be found in /usr/share/common-licenses/GPL.</para>
 181
 182   </refsect1>
 183 </refentry>
 184
 185 <!-- Keep this comment at the end of the file
 186 Local variables:
 187 mode: sgml
 188 sgml-omittag:t
 189 sgml-shorttag:t
 190 sgml-minimize-attributes:nil
 191 sgml-always-quote-attributes:t
 192 sgml-indent-step:2
 193 sgml-indent-data:t
 194 sgml-parent-document:nil
 195 sgml-default-dtd-file:nil
 196 sgml-exposed-tags:nil
 197 sgml-local-catalogs:nil
 198 sgml-local-ecat-files:nil
 199 End:
 200 -->
 201
 202