debian man page for aubioonset

AUBIOONSET(1)						      General Commands Manual						     AUBIOONSET(1)

NAME
       aubioonset -- a command line tool for real time onset extraction

SYNOPSIS
       aubioonset [options] [-i soundfile]

DESCRIPTION
       aubioonset attempts to detect onset times, the beginning of discreted sound events, in audio signals.

       When  started  without  an  input file argument (--input), aubioonset creates jack input and output ports. When an input file is given, the
       results are given on the console.

OPTIONS
       This program follows the usual GNU command line syntax, with long options starting with two dashes (`-').  A summary of options is included
       below.

       -i   --input filein
		 Run analysis on this audio file. Most common uncompressed formats are supported.

       -o   --output fileout
		 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 sam-
		 ple.

       -O   --onset mode
		 The onset detection function to run. Available functions are complexdomain, hfc, phase, specdiff, energy, kl and mkl. By default,
		 both Kullback Liebler (kl) and complex domain are used in parallel.

       -t   --threshold value
		 Set  the  threshold  value for the onset peak picking. Typical values are within 0.001 and 0.900. Default is 0.1. Lower threshold
		 values imply more onsets detected. Try 0.3 in case of over-detections.

       -j   --jack
		 Run in jack mode (default when started without input file) and creates a midi output.

       -v   --verbose
		 Show results on the console (default).

       -h   --help
		 Show summary of options.

BUGS
       For now the program has only been tested on audio signals sampled at 44.1 kHz.

SEE ALSO
       aubiotrack(1) aubionotes(1) aubiocut(1) aubiopitch(1)

AUTHOR
       This manual page was written by Paul Brossier (piem@altern.org). 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.

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

																     AUBIOONSET(1)