source: doc/aubioonset.sgml @ 84941cb

<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
        docbook-to-man $< > $@

    
        The docbook-to-man binary is found in the docbook-to-man package.
        Please remember that if you create the nroff version in one of the
        debian/rules file targets (such as build), you will need to include
        docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Paul</firstname>">
  <!ENTITY dhsurname   "<surname>Brossier</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>December 1, 2004</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>piem@altern.org</email>">
  <!ENTITY dhusername  "Paul Brossier">
  <!ENTITY dhucpackage "<refentrytitle>AUBIO</refentrytitle>">
  <!ENTITY dhpackage   "aubioonset">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>an sound file onset detector</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>

<para>The library <emphasis remap='B'>aubio</emphasis> provides a small set of functions to extract events and
objects from audio, from live streams or still files. Onsets are used to label
the beginning of notes, pitches to label their height.</para>

<para><command>aubionotes</command> is still in an experimental state. Its aim is to segment notes
with onsets, and label them with their detected pitch. When started without an
input file argument (<option>-i</option>), aubionotes creates a jack input and a midi
output. When an input file is given, it outputs the results on the console.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

<para>This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.</para>
<variablelist>
  <varlistentry>
  <term><option>-i</option>
  <option>--input filein</option></term>
  <listitem>
<para>Run analysis on this audio file. Most common (uncompressed) formats are 
supported.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-o</option>
  <option>--output fileout</option></term>
  <listitem>
<para>Save results in this file. The file will be created on the model of the input
file. Results are marked by a very short wood-block sample.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-t</option>
  <option>--threshold value</option></term>
  <listitem>
<para>Set the threshold value for the onset peak picking. Typical values are within
<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
sensible</emphasis>.  Try <literal>0.3</literal> in case of over-detections.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-O</option>
  <option>--onset value</option></term>
  <listitem>

  <para>The onset detection function to run. Can be one of
  <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>,
  <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>,
  <emphasis>energy</emphasis>. By default (<emphasis>fixme</emphasis>), both
  complex domain and HFC are used in parallel.</para>

  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-j</option>
  <option>--jack</option></term>
  <listitem>
<para>Run in jack mode (default when started without input file) and creates a midi output.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-h</option>
  <option>--help</option></term>
  <listitem>
<para>Show summary of options.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-v</option>
  <option>--verbose</option></term>
  <listitem>
<para>Show results on the console.</para>

  </listitem>
  </varlistentry>
</variablelist>

  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para><command>aubionotes</command> (1)</para>

  </refsect1>

<refsect1>
<title>BUGS</title>

<para>For now the program has been only tested on audio signals sampled at 44.1
kHz.</para>

</refsect1>

  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; (&dhemail;). Permission
    is granted to copy, distribute and/or modify this document under the terms
    of the &gnu; General Public License, Version 2 any later version published
    by the Free Software Foundation.</para>

    <para>On Debian systems, the complete text of the GNU General Public
    License can be found in /usr/share/common-licenses/GPL.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->