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