From: Paul Brossier Date: Sat, 7 Oct 2006 21:46:54 +0000 (+0000) Subject: update the manual pages X-Git-Tag: bzr2git~538 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=beea3cfad02b018a96c83874f871cd152a48c1e6;p=aubio.git update the manual pages update the manual pages --- diff --git a/doc/aubiocut.sgml b/doc/aubiocut.sgml index bd8103f9..eae26f6e 100644 --- a/doc/aubiocut.sgml +++ b/doc/aubiocut.sgml @@ -57,8 +57,7 @@ manpage.1: manpage.sgml &dhpackage; - a command line tool for real time wav to midi - conversion + a command line tool to extract onsets and tempo from sound files. @@ -69,28 +68,33 @@ manpage.1: manpage.sgml DESCRIPTION - This manual page documents briefly the &dhpackage; command. - - &dhpackage; 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. + This manual page documents briefly the &dhpackage; command. + + The aubio 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. + + &dhpackage; attempts to detect onset times, the + beginning of discreted sound events, or beat locations, in audio + signals. + + When using the option, + &dhpackage; 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. + + 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. + This program follows the usual GNU command line syntax, with long + options starting with two dashes (`-'). A summary of options is included + below. - - - - - show this help message and exit - - @@ -106,6 +110,13 @@ starting with two dashes (`-'). A summary of options is included below. + + + + detect beats and output beat locations + + + @@ -191,71 +202,89 @@ starting with two dashes (`-'). A summary of options is included below. - - + + - draw plot + print detection function - - + + - define horizontal plot size [default=1.] + be quiet - - + + - define vertical plot size [default=1.] + Show a summary of options. - - + + - print detection function + make lots of noise [default] + + + + Plotting options + + When the Python interface to Gnuplot is installed, the following + additional options are available. + + - - + + - do not plot detected onsets, only detection functions + draw plot - - + + - save plot to output.{eps,ps,png,svg} + do not plot detected onsets, only detection functions - - + + - make lots of noise [default] + define horizontal plot size [default=1.] - - + + - be quiet + define vertical plot size [default=1.] - - + + - detect beats and output beat locations + 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 diff --git a/doc/aubionotes.sgml b/doc/aubionotes.sgml index e26268df..ef03ff22 100644 --- a/doc/aubionotes.sgml +++ b/doc/aubionotes.sgml @@ -57,13 +57,12 @@ manpage.1: manpage.sgml &dhpackage; - a command line tool for real time wav to midi - conversion + a command line tool for real time extraction of musical notes. - &dhpackage; + &dhpackage; [options] [-i soundfile] @@ -71,15 +70,20 @@ manpage.1: manpage.sgml This manual page documents briefly the &dhpackage; command. - &dhpackage; 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. - - When started without an input file argument (), - aubionotes creates a jack input and a midi output. When an input file is - given, it outputs the results on the console. + The aubio 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. + &dhpackage; attempts to detect notes in audio + signals, segmenting consecutive events using onset detection, and + determining their pitch using a fundamental frequency extraction algorithm. + + + When started without an input file argument + (), &dhpackage; creates a jack + input and a MIDI output. When an input file is given, the results are given + on the console. @@ -94,8 +98,10 @@ manpage.1: manpage.sgml -Run analysis on this audio file. Most common (uncompressed) formats are -supported. + + Run analysis on this audio file. Most common uncompressed formats are + supported. + @@ -104,7 +110,7 @@ supported. 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. + input file. Results are marked by a short wood-block sample. @@ -114,8 +120,9 @@ supported. The pitch detection function to run. Available functions are - mcomb, yin, - fcomb and schmitt. + yinfft, yin, + mcomb, fcomb, and + schmitt. @@ -140,9 +147,9 @@ supported. Set the threshold value for the onset peak picking. Typical values are within 0.001 and 0.900. Default is - 0.1. The lower the more - sensible. Try 0.3 in case of - over-detections. + 0.1. Lower threshold values imply + more onsets detected. Try 0.3 in + case of over-detections. @@ -150,47 +157,46 @@ supported. -Run in jack mode (default when started without input file) and creates a midi output. + Run in jack mode (default when started without input file) and creates a midi output. - - + + -Show summary of options. + Show results on the console (default). - - + + -Show results on the console. - + Show summary of options. + + 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) aubiopitch(1) - -BUGS - -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. - - - AUTHOR diff --git a/doc/aubioonset.sgml b/doc/aubioonset.sgml index 25f023f0..0e63c444 100644 --- a/doc/aubioonset.sgml +++ b/doc/aubioonset.sgml @@ -62,7 +62,7 @@ manpage.1: manpage.sgml - &dhpackage; + &dhpackage; [options] [-i soundfile] @@ -70,31 +70,36 @@ manpage.1: manpage.sgml This manual page documents briefly the &dhpackage; command. -The library aubio 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. + The aubio 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. -aubionotes 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 (), aubionotes -creates a jack input and a midi output. When an input file is given, it outputs -the results on the console. + &dhpackage; attempts to detect onset times, the + beginning of discreted sound events, in audio signals. + + When started without an input file argument + (), &dhpackage; 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. + This program follows the usual GNU command line syntax, with long + options starting with two dashes (`-'). A summary of options is included + below. -Run analysis on this audio file. Most common (uncompressed) formats are -supported. + + Run analysis on this audio file. Most common uncompressed formats are + supported. + @@ -103,7 +108,7 @@ supported. 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. + input file. Results are marked by a short wood-block sample. @@ -128,9 +133,9 @@ supported. Set the threshold value for the onset peak picking. Typical values are within 0.001 and 0.900. Default is - 0.1. The lower the more - sensible. Try 0.3 in case of - over-detections. + 0.1. Lower threshold values imply + more onsets detected. Try 0.3 in + case of over-detections. @@ -138,45 +143,43 @@ supported. -Run in jack mode (default when started without input file) and creates a midi output. + Run in jack mode (default when started without input file) and creates a midi output. - - + + -Show summary of options. + Show results on the console (default). - - + + -Show results on the console. - + Show summary of options. - -BUGS + + BUGS -For now the program has been only tested on audio signals sampled at 44.1 -kHz. + For now the program has only been tested on audio signals sampled at + 44.1 kHz. - + SEE ALSO - - aubiocut(1) - aubiotrack(1) - aubionotes(1) - aubiopitch(1) - - + + aubiotrack(1) + aubionotes(1) + aubiocut(1) + aubiopitch(1) + @@ -212,4 +215,3 @@ End: --> - diff --git a/doc/aubiopitch.sgml b/doc/aubiopitch.sgml index b54bcbb5..7727f1d6 100644 --- a/doc/aubiopitch.sgml +++ b/doc/aubiopitch.sgml @@ -57,8 +57,7 @@ manpage.1: manpage.sgml &dhpackage; - a command line tool for real time wav to midi - conversion + a command line tool to extract pitch candidates from sound files. @@ -71,11 +70,17 @@ manpage.1: manpage.sgml This manual page documents briefly the &dhpackage; command. - aubionotes 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. + The aubio 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. + + &dhpackage; 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. @@ -171,6 +176,36 @@ manpage.1: manpage.sgml + + + + be quiet + + + + + + + Show a summary of options. + + + + + + + make lots of noise [default] + + + + + + Plotting options + + When the Python interface to Gnuplot is installed, the following + additional options are available. + + + @@ -185,45 +220,46 @@ manpage.1: manpage.sgml - - - - save plot to output.{ps,eps,png,svg} instead of displaying it - - - - - + + - make lots of noise [default] + define horizontal plot size [default=1.] - - + + - be quiet + define vertical plot size [default=1.] - - + + - show this help message and exit + 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 - aubionotes(1) aubioonset(1) - aubiocut(1) aubiotrack(1) + aubionotes(1) + aubiocut(1) diff --git a/doc/aubiotrack.sgml b/doc/aubiotrack.sgml index b41dead1..971a437d 100644 --- a/doc/aubiotrack.sgml +++ b/doc/aubiotrack.sgml @@ -62,7 +62,7 @@ manpage.1: manpage.sgml - &dhpackage; [options] + &dhpackage; [options] [-i soundfile] @@ -70,27 +70,38 @@ manpage.1: manpage.sgml This manual page documents briefly the &dhpackage; command. + The aubio 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. + &dhpackage; attempts to tap the beat and detect beat locations in musical sounds. When started with an input file argument (), 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. + detected in the file. + + When started without an input file argument + (), &dhpackage; 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. + This program follows the usual GNU command line syntax, with long + options starting with two dashes (`-'). A summary of options is included + below. -Run analysis on this audio file. Most common (uncompressed) formats are -supported. + + Run analysis on this audio file. Most common uncompressed formats are + supported. + @@ -99,7 +110,7 @@ supported. 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. + input file. Results are marked by a short wood-block sample. @@ -124,9 +135,9 @@ supported. Set the threshold value for the onset peak picking. Typical values are within 0.001 and 0.900. Default is - 0.1. The lower the more - sensible. Try 0.3 in case of - over-detections. + 0.1. Lower threshold values imply + more onsets detected. Try 0.3 in + case of over-detections. @@ -134,47 +145,46 @@ supported. -Run in jack mode (default when started without input file) and creates a midi output. + Run in jack mode (default when started without input file) and creates a midi output. - - + + -Show summary of options. + Show results on the console (default). - - + + -Show results on the console. - + Show summary of options. + + BUGS + + For now the program has only been tested on audio signals sampled at + 44.1 kHz. + + + SEE ALSO aubioonset(1) - aubiocut(1) aubionotes(1) + aubiocut(1) aubiopitch(1) - -BUGS - -For now the program has been only tested on audio signals sampled at 44.1 -kHz. - - - AUTHOR @@ -207,4 +217,3 @@ End: --> -