ref: 992beaa9bea5d3cd1aae961f80f581d2003bcc79
dir: /doc/aubioonset.sgml/
<!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>AUBIOONSET</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>a command line tool for real time onset extraction</refpurpose> </refnamediv> <refsynopsisdiv> <cmdsynopsis> <command>&dhpackage; <parameter>[options] [-i soundfile]</parameter></command> </cmdsynopsis> </refsynopsisdiv> <refsect1> <title>DESCRIPTION</title> <para><command>&dhpackage;</command> attempts to detect onset times, the beginning of discreted sound events, in audio signals.</para> <para>When started without an input file argument (<option>--input</option>), <command>&dhpackage;</command> creates jack input and output ports. When an input file is given, the results are given 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 short wood-block sample.</para> </listitem> </varlistentry> <varlistentry> <term><option>-O</option> <option>--onset mode</option></term> <listitem> <para>The onset detection function to run. Available functions are <emphasis>complexdomain</emphasis>, <emphasis>hfc</emphasis>, <emphasis>phase</emphasis>, <emphasis>specdiff</emphasis>, <emphasis>energy</emphasis>, <emphasis>kl</emphasis> and <emphasis>mkl</emphasis>. By default, both Kullback Liebler (kl) and complex domain are used in parallel.</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>. <emphasis>Lower</emphasis> threshold values imply <emphasis>more</emphasis> onsets detected. Try <literal>0.3</literal> in case of over-detections.</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>-v</option> <option>--verbose</option></term> <listitem> <para>Show results on the console (default).</para> </listitem> </varlistentry> <varlistentry> <term><option>-h</option> <option>--help</option></term> <listitem> <para>Show summary of options.</para> </listitem> </varlistentry> </variablelist> </refsect1> <refsect1> <title>BUGS</title> <para>For now the program has only been tested on audio signals sampled at 44.1 kHz.</para> </refsect1> <refsect1> <title>SEE ALSO</title> <para> <command>aubiotrack</command>(1) <command>aubionotes</command>(1) <command>aubiocut</command>(1) <command>aubiopitch</command>(1) </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: -->