<refnamediv>
<refname>&dhpackage;</refname>
- <refpurpose>a command line tool for real time wav to midi
- conversion</refpurpose>
+ <refpurpose>a command line tool to extract onsets and tempo from sound files.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
- <para>This manual page documents briefly the <command>&dhpackage;</command> command. </para>
-
- <para><command>&dhpackage;</command> takes an input sound file and produce
- small file sliced at onset locations. The slices can then be sent to a
- player, a sequencer, a sampler, or wherever else. The files can be cut at
- onset times or at silences.</para>
+ <para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
+
+ <para>The <emphasis>aubio</emphasis> library 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>&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>
+ <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>-h</option>
- <option>--help</option></term>
- <listitem>
- <para>show this help message and exit</para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term><option>-i</option>
<option>--input filein</option></term>
<listitem>
</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>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-p</option>
- <option>--plot</option></term>
+ <term><option>-f</option>
+ <option>--function</option></term>
<listitem>
- <para>draw plot</para>
+ <para>print detection function</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-x</option>
- <option>--xsize=SIZE</option></term>
+ <term><option>-q</option>
+ <option>--quiet</option></term>
<listitem>
- <para>define horizontal plot size [default=1.]</para>
+ <para>be quiet</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-y</option>
- <option>--ysize=SIZE</option></term>
+ <term><option>-h</option>
+ <option>--help</option></term>
<listitem>
- <para>define vertical plot size [default=1.]</para>
+ <para>Show a summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-f</option>
- <option>--function</option></term>
+ <term><option>-v</option>
+ <option>--verbose</option></term>
<listitem>
- <para>print detection function</para>
+ <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>-n</option>
- <option>--no-onsets</option></term>
+ <term><option>-p</option>
+ <option>--plot</option></term>
<listitem>
- <para>do not plot detected onsets, only detection functions</para>
+ <para>draw plot</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-O</option>
- <option>--outplot=OUTPLOT</option></term>
+ <term><option>-n</option>
+ <option>--no-onsets</option></term>
<listitem>
- <para>save plot to output.{eps,ps,png,svg}</para>
+ <para>do not plot detected onsets, only detection functions</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-v</option>
- <option>--verbose</option></term>
+ <term><option>-x</option>
+ <option>--xsize=SIZE</option></term>
<listitem>
- <para>make lots of noise [default]</para>
+ <para>define horizontal plot size [default=1.]</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-q</option>
- <option>--quiet</option></term>
+ <term><option>-y</option>
+ <option>--ysize=SIZE</option></term>
<listitem>
- <para>be quiet</para>
+ <para>define vertical plot size [default=1.]</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-b</option>
- <option>--beat</option></term>
+ <term><option>-O</option>
+ <option>--outplot=OUTPLOT</option></term>
<listitem>
- <para>detect beats and output beat locations</para>
+ <para>save plot to output.{ps,eps,png,svg} instead of displaying it</para>
</listitem>
</varlistentry>
-</variablelist>
+ </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>
<refsect1>
<title>SEE ALSO</title>
<refnamediv>
<refname>&dhpackage;</refname>
- <refpurpose>a command line tool for real time wav to midi
- conversion</refpurpose>
+ <refpurpose>a command line tool for real time extraction of musical notes.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>&dhpackage;</command>
+ <command>&dhpackage; <parameter>[options] [-i soundfile]</parameter></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
- <para><command>&dhpackage;</command> is still in an experimental state.
- Its aim is to extract the melody and output it as a midi stream with a
- minimal deleay. Pitch candidates are selected at each frame, onset and
- silences are used to segment the notes.</para>
-
- <para>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>
+ <para>The <emphasis>aubio</emphasis> library 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>&dhpackage;</command> attempts to detect notes in audio
+ signals, segmenting consecutive events using onset detection, and
+ determining their pitch using a fundamental frequency extraction algorithm.
+ </para>
+
+ <para>When started without an input file argument
+ (<option>--input</option>), <command>&dhpackage;</command> creates a jack
+ input and a MIDI output. When an input file is given, the results are given
+ on the console.</para>
</refsect1>
<refsect1>
<term><option>-i</option>
<option>--input filein</option></term>
<listitem>
-<para>Run analysis on this audio file. Most common (uncompressed) formats are
-supported.</para>
+
+ <para>Run analysis on this audio file. Most common uncompressed formats are
+ supported.</para>
+
</listitem>
</varlistentry>
<varlistentry>
<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>
+ input file. Results are marked by a short wood-block sample.</para>
</listitem>
</varlistentry>
<listitem>
<para>The pitch detection function to run. Available functions are
- <emphasis>mcomb</emphasis>, <emphasis>yin</emphasis>,
- <emphasis>fcomb</emphasis> and <emphasis>schmitt</emphasis>.</para>
+ <emphasis>yinfft</emphasis>, <emphasis>yin</emphasis>,
+ <emphasis>mcomb</emphasis>, <emphasis>fcomb</emphasis>, and
+ <emphasis>schmitt</emphasis>.</para>
</listitem>
</varlistentry>
<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>lower</emphasis> the <emphasis>more
- sensible</emphasis>. Try <literal>0.3</literal> in case of
- over-detections.</para>
+ <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>
<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>
+
<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>
+ <term><option>-v</option>
+ <option>--verbose</option></term>
<listitem>
-<para>Show summary of options.</para>
+ <para>Show results on the console (default).</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-v</option>
- <option>--verbose</option></term>
+ <term><option>-h</option>
+ <option>--help</option></term>
<listitem>
-<para>Show results on the console.</para>
-
+ <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>aubioonset</command>(1)
<command>aubiotrack</command>(1)
- <command>aubionotes</command>(1)
+ <command>aubiocut</command>(1)
<command>aubiopitch</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. The pitch detectors are also way too cpu-intensive.</para>
-
-</refsect1>
-
<refsect1>
<title>AUTHOR</title>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>&dhpackage;</command>
+ <command>&dhpackage; <parameter>[options] [-i soundfile]</parameter></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
-<para>The library <emphasis>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>The <emphasis>aubio</emphasis> library 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>
+ <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>
+ <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>
+
+ <para>Run analysis on this audio file. Most common uncompressed formats are
+ supported.</para>
+
</listitem>
</varlistentry>
<varlistentry>
<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>
+ input file. Results are marked by a short wood-block sample.</para>
</listitem>
</varlistentry>
<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>lower</emphasis> the <emphasis>more
- sensible</emphasis>. Try <literal>0.3</literal> in case of
- over-detections.</para>
+ <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>
<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>
+
<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>
+ <term><option>-v</option>
+ <option>--verbose</option></term>
<listitem>
-<para>Show summary of options.</para>
+ <para>Show results on the console (default).</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-v</option>
- <option>--verbose</option></term>
+ <term><option>-h</option>
+ <option>--help</option></term>
<listitem>
-<para>Show results on the console.</para>
-
+ <para>Show summary of options.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
-<refsect1>
-<title>BUGS</title>
+ <refsect1>
+ <title>BUGS</title>
-<para>For now the program has been only tested on audio signals sampled at 44.1
-kHz.</para>
+ <para>For now the program has only been tested on audio signals sampled at
+ 44.1 kHz.</para>
-</refsect1>
+ </refsect1>
<refsect1>
<title>SEE ALSO</title>
- <para>
- <command>aubiocut</command>(1)
- <command>aubiotrack</command>(1)
- <command>aubionotes</command>(1)
- <command>aubiopitch</command>(1)
- </para>
-
+ <para>
+ <command>aubiotrack</command>(1)
+ <command>aubionotes</command>(1)
+ <command>aubiocut</command>(1)
+ <command>aubiopitch</command>(1)
+ </para>
</refsect1>
-->
-
<refnamediv>
<refname>&dhpackage;</refname>
- <refpurpose>a command line tool for real time wav to midi
- conversion</refpurpose>
+ <refpurpose>a command line tool to extract pitch candidates from sound files.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
- <para><command>aubionotes</command> attempts to label each fram of the
- input sound file with a pitch. When no pitch candidate is found, the
- output is 0. Results can be printed in Hertz or in MIDI pitch. A plotting
- module is available via the Gnuplot Python package. 4 functions are
- available.</para>
+ <para>The <emphasis>aubio</emphasis> library 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>&dhpackage;</command> attempts to extract fundamental
+ frequency in sound files. When no pitch candidate is found, the output is
+ 0. Five fundamental frequency extraction methods are available. Results can
+ be printed in Hertz or in MIDI pitch.</para>
+
+ <para>A plotting module is available via the Gnuplot Python package.</para>
</refsect1>
<refsect1>
</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>
</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>
- <varlistentry>
- <term><option>-v</option>
- <option>--verbose</option></term>
+ <term><option>-x</option>
+ <option>--xsize=SIZE</option></term>
<listitem>
- <para>make lots of noise [default]</para>
+ <para>define horizontal plot size [default=1.]</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-q</option>
- <option>--quiet</option></term>
+ <term><option>-y</option>
+ <option>--ysize=SIZE</option></term>
<listitem>
- <para>be quiet</para>
+ <para>define vertical plot size [default=1.]</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-h</option>
- <option>--help</option></term>
+ <term><option>-O</option>
+ <option>--outplot=OUTPLOT</option></term>
<listitem>
- <para>show this help message and exit</para>
+ <para>save plot to output.{ps,eps,png,svg} instead of displaying it</para>
</listitem>
</varlistentry>
-</variablelist>
+ </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>
<refsect1>
<title>SEE ALSO</title>
<para>
- <command>aubionotes</command>(1)
<command>aubioonset</command>(1)
- <command>aubiocut</command>(1)
<command>aubiotrack</command>(1)
+ <command>aubionotes</command>(1)
+ <command>aubiocut</command>(1)
</para>
</refsect1>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>&dhpackage; <parameter>[options]</parameter></command>
+ <command>&dhpackage; <parameter>[options] [-i soundfile]</parameter></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<para>This manual page documents briefly the <command>&dhpackage;</command> command.</para>
+ <para>The <emphasis>aubio</emphasis> library 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>&dhpackage;</command> attempts to tap the beat and detect
beat locations in musical sounds. When started with an input file argument
(<option>-i</option>), aubiotrack print the beat locations in second
- detected in the file. Without an input file is given, aubiotrack will start
- as a jack client and play a woodblock sound at predicted beat
- locations.</para>
+ detected in the file.</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>
+ <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>
+
+ <para>Run analysis on this audio file. Most common uncompressed formats are
+ supported.</para>
+
</listitem>
</varlistentry>
<varlistentry>
<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>
+ input file. Results are marked by a short wood-block sample.</para>
</listitem>
</varlistentry>
<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>lower</emphasis> the <emphasis>more
- sensible</emphasis>. Try <literal>0.3</literal> in case of
- over-detections.</para>
+ <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>
<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>
+
<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>
+ <term><option>-v</option>
+ <option>--verbose</option></term>
<listitem>
-<para>Show summary of options.</para>
+ <para>Show results on the console (default).</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-v</option>
- <option>--verbose</option></term>
+ <term><option>-h</option>
+ <option>--help</option></term>
<listitem>
-<para>Show results on the console.</para>
-
+ <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>aubioonset</command>(1)
- <command>aubiocut</command>(1)
<command>aubionotes</command>(1)
+ <command>aubiocut</command>(1)
<command>aubiopitch</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>
-->
-
projects / aubio.git / commitdiff