ref: 8c7f80db180a96c10e0a542c77fbf2449bf16c39
dir: /doc/aubiocut.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@aubio.org</email>">
<!ENTITY dhusername "Paul Brossier">
<!ENTITY dhucpackage "<refentrytitle>AUBIOCUT</refentrytitle>">
<!ENTITY dhpackage "aubiocut">
<!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 to extract onsets and tempo from sound files.</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, or beat locations, in audio
signals.</para>
<para>When using the <option>--cut</option> option,
<command>&dhpackage;</command> takes an input sound file and produce small
files sliced at onset locations (or silences). The slices can then be sent
for example to a player, a sequencer, or a sampler.</para>
<para>A plotting module is available via the Gnuplot Python package.</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>input sound file</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-m</option>
<option>--mode onset_detection_mode</option></term>
<listitem>
<para>onset detection mode [default=dual] complexdomain|hfc|phase|specdiff|energy|kl|mkl|dual</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-b</option>
<option>--beat</option></term>
<listitem>
<para>detect beats and output beat locations</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-B</option>
<option>--bufsize=BUFSIZE</option></term>
<listitem>
<para>buffer size [default=512]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-H</option>
<option>--hopsize=HOPSIZE</option></term>
<listitem>
<para>overlap size [default=256]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option>
<option>--threshold=THRESHOLD</option></term>
<listitem>
<para>onset peak picking threshold [default=0.3]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-C</option>
<option>--dcthreshold=DCTHRESHOLD</option></term>
<listitem>
<para>onset peak picking DC component [default=1.]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option>
<option>--silence=SILENCE</option></term>
<listitem>
<para>silence threshold [default=-70]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-M</option>
<option>--mintol=MINIOI</option></term>
<listitem>
<para>minimum inter onset interval [default=0.048s]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-D</option>
<option>--delay=DELAY</option></term>
<listitem>
<para>number of seconds to take back [default=system]
default system delay is 3*hopsize/samplerate</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-L</option>
<option>--localmin</option></term>
<listitem>
<para>use local minima after peak detection</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-c</option>
<option>--cut</option></term>
<listitem>
<para>cut input sound file at detected labels (best used with option -L)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option>
<option>--derivate</option></term>
<listitem>
<para>derivate onset detection function</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-S</option>
<option>--silencecut</option></term>
<listitem>
<para>outputs silence locations instead of onset locations</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-z</option>
<option>--zerocross=ZEROTHRES</option></term>
<listitem>
<para>zero-crossing threshold for slicing [default=0.00008]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f</option>
<option>--function</option></term>
<listitem>
<para>print detection function</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option>
<option>--quiet</option></term>
<listitem>
<para>be quiet</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>
<option>--help</option></term>
<listitem>
<para>Show a summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option>
<option>--verbose</option></term>
<listitem>
<para>make lots of noise [default]</para>
</listitem>
</varlistentry>
</variablelist>
<refsect2>
<title>Plotting options</title>
<para>When the Python interface to Gnuplot is installed, the following
additional options are available.</para>
<variablelist>
<varlistentry>
<term><option>-p</option>
<option>--plot</option></term>
<listitem>
<para>draw plot</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option>
<option>--no-onsets</option></term>
<listitem>
<para>do not plot detected onsets, only detection functions</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-x</option>
<option>--xsize=SIZE</option></term>
<listitem>
<para>define horizontal plot size [default=1.]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-y</option>
<option>--ysize=SIZE</option></term>
<listitem>
<para>define vertical plot size [default=1.]</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-O</option>
<option>--outplot=OUTPLOT</option></term>
<listitem>
<para>save plot to output.{ps,eps,png,svg} instead of displaying it</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</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>aubioonset</command>(1)
<command>aubiotrack</command>(1)
<command>aubionotes</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 3 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:
-->