debian man page for aubiopitch

AUBIOPITCH(1)						      General Commands Manual						     AUBIOPITCH(1)

NAME
       aubiopitch -- a command line tool to extract pitch candidates from sound files.

SYNOPSIS
       aubiopitch [options] -i soundfile

DESCRIPTION
       aubiopitch  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.

       A plotting module is available via the Gnuplot Python package.

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
		 input sound file

       -m   --mode pitch_detection_mode
		 pitch detection mode [default=mcomb] mcomb|yin|fcomb|schmitt

       -u   --units unitmode
		 output pitch in units [default=Hz] freq|midi|cent|bin

       -B   --bufsize=BUFSIZE
		 buffer size [default=1024]

       -H   --hopsize=HOPSIZE
		 overlap size [default=512]

       -t   --threshold=THRESHOLD
		 pitch threshold (for yin) [default=0.1]

       -s   --silence=SILENCE
		 silence threshold [default=-70]

       -D   --delay=DELAY
		 number of seconds to take back [default=0]

       -S   --smoothing=frames
		 temporal smoothing using a median filter of N frames [default=0]

       -M   --pitchmax=max
		 maximum pitch values to look for (Hz) [default=20000]

       -l   --pitchmin=min
		 minimum pitch values to look for (Hz) [default=20]

       -n   --note
		 NOT IMPLEMENTED output notes

       -q   --quiet
		 be quiet

       -h   --help
		 Show a summary of options.

       -v   --verbose
		 make lots of noise [default]

   Plotting options
       When the Python interface to Gnuplot is installed, the following additional options are available.

       -p   --plot
		 draw plot of the pitch track

       -T   --plottruth
		 draw plot of the ground truth pitch track

       -x   --xsize=SIZE
		 define horizontal plot size [default=1.]

       -y   --ysize=SIZE
		 define vertical plot size [default=1.]

       -O   --outplot=OUTPLOT
		 save plot to output.{ps,eps,png,svg} instead of displaying it

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

SEE ALSO
       aubioonset(1) aubiotrack(1) aubionotes(1) aubiocut(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.

																     AUBIOPITCH(1)