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