From 8d0b707fc22ca261192cef02524fe4b111ac10ad Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Tue, 27 Sep 2005 19:21:51 +0000 Subject: [PATCH] added and updated manpages added and updated manpages --- doc/Makefile.am | 7 +- doc/aubiocut.sgml | 260 ++++++++++++++++++++++++++++++++++++++++++++ doc/aubionotes.sgml | 29 +++-- doc/aubioonset.sgml | 20 ++-- doc/aubiopitch.sgml | 249 ++++++++++++++++++++++++++++++++++++++++++ doc/aubiotrack.sgml | 210 +++++++++++++++++++++++++++++++++++ 6 files changed, 754 insertions(+), 21 deletions(-) create mode 100644 doc/aubiocut.sgml create mode 100644 doc/aubiopitch.sgml create mode 100644 doc/aubiotrack.sgml diff --git a/doc/Makefile.am b/doc/Makefile.am index c158529f..afca8885 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,8 +1,11 @@ EXTRA_DIST = devel.cfg examples.cfg user.cfg aubio.css \ aubionotes.sgml aubioonset.sgml \ - aubioonset.1 aubionotes.1 + aubiocut.sgml aubiopitch.sgml aubiotrack.sgml \ + aubioonset.1 aubionotes.1 \ + aubiocut.1 aubiopitch.1 aubiotrack.1 -man_MANS = aubionotes.1 aubioonset.1 +man_MANS = aubionotes.1 aubioonset.1 \ + aubiocut.1 aubiopitch.1 aubiotrack.1 CLEANFILES = $(man_MANS) all: diff --git a/doc/aubiocut.sgml b/doc/aubiocut.sgml new file mode 100644 index 00000000..ef143f64 --- /dev/null +++ b/doc/aubiocut.sgml @@ -0,0 +1,260 @@ + 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. + + --> + + + Paul"> + Brossier"> + + December 1, 2004"> + + 1"> + piem@altern.org"> + + AUBIOCUT"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2003 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + a command line tool for real time wav to midi + conversion + + + + + &dhpackage; [options] -i soundfile + + + + 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. + + + + OPTIONS + +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 + + + + + + + input sound file + + + + + + + onset detection mode [default=dual] complexdomain|hfc|phase|specdiff|energy|kl|mkl|dual + + + + + + + buffer size [default=1024] + + + + + + + overlap size [default=512] + + + + + + + pitch threshold (for yin) [default=0.1] + + + + + + + silence threshold [default=-70] + + + + + + + number of seconds to take back [default=system] + default system delay is 2*hopsize/samplerate + + + + + + + use local minima after peak detection + + + + + + + cut input sound file at detected labels (best used with option -L) + + + + + + + derivate onset detection function + + + + + + + outputs silence locations instead of onset locations + + + + + + + zero-crossing threshold for slicing [default=0.00008] + + + + + + + draw plot + + + + + + + save plot to output.{ps,png} + + + + + + + make lots of noise [default] + + + + + + + be quiet + + + + + + + NOT IMPLEMENTED output beat locations + + + + + + + SEE ALSO + + + aubioonset(1) + aubiotrack(1) + aubionotes(1) + aubiopitch(1) + + + + + + AUTHOR + + 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 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. + + + + + + + diff --git a/doc/aubionotes.sgml b/doc/aubionotes.sgml index 84226cc1..e26268df 100644 --- a/doc/aubionotes.sgml +++ b/doc/aubionotes.sgml @@ -71,23 +71,23 @@ 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. + &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. -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. 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. @@ -174,7 +174,12 @@ supported. SEE ALSO - aubioonset (1) + + aubioonset(1) + aubiotrack(1) + aubionotes(1) + aubiopitch(1) + diff --git a/doc/aubioonset.sgml b/doc/aubioonset.sgml index 92f62719..25f023f0 100644 --- a/doc/aubioonset.sgml +++ b/doc/aubioonset.sgml @@ -159,13 +159,6 @@ supported. - - SEE ALSO - - aubionotes (1) - - - BUGS @@ -174,6 +167,19 @@ kHz. + + SEE ALSO + + + aubiocut(1) + aubiotrack(1) + aubionotes(1) + aubiopitch(1) + + + + + AUTHOR diff --git a/doc/aubiopitch.sgml b/doc/aubiopitch.sgml new file mode 100644 index 00000000..ef526fd9 --- /dev/null +++ b/doc/aubiopitch.sgml @@ -0,0 +1,249 @@ + 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. + + --> + + + Paul"> + Brossier"> + + December 1, 2004"> + + 1"> + piem@altern.org"> + + AUBIOPITCH"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2003 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + a command line tool for real time wav to midi + conversion + + + + + &dhpackage; [options] -i soundfile + + + + DESCRIPTION + + 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. + + + + OPTIONS + + This program follows the usual GNU command line syntax, with long + options starting with two dashes (`-'). A summary of options is included + below. + + + + + + + input sound file + + + + + + + pitch detection mode [default=mcomb] mcomb|yin|fcomb|schmitt + + + + + + + output pitch in units [default=Hz] freq|midi|cent|bin + + + + + + + buffer size [default=1024] + + + + + + + overlap size [default=512] + + + + + + + pitch threshold (for yin) [default=0.1] + + + + + + + silence threshold [default=-70] + + + + + + + number of seconds to take back [default=system] + default system delay is 2*hopsize/samplerate + + + + + + + use local minima after peak detection + + + + + + + cut input sound file at detected labels (best used with option -L) + + + + + + + NOT IMPLEMENTED output notes + + + + + + + NOT IMPLEMENTED draw plot + + + + + + + NOT IMPLEMENTED save plot to output.{ps,png} + + + + + + + make lots of noise [default] + + + + + + + be quiet + + + + + + + show this help message and exit + + + + + + + + SEE ALSO + + + aubionotes(1) + aubioonset(1) + aubiocut(1) + aubiotrack(1) + + + + + + AUTHOR + + 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 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. + + + + + + + diff --git a/doc/aubiotrack.sgml b/doc/aubiotrack.sgml new file mode 100644 index 00000000..b41dead1 --- /dev/null +++ b/doc/aubiotrack.sgml @@ -0,0 +1,210 @@ + 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. + + --> + + + Paul"> + Brossier"> + + December 1, 2004"> + + 1"> + piem@altern.org"> + + AUBIOTRACK"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2003 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + a command line tool for real time beat tracking + + + + + &dhpackage; [options] + + + + DESCRIPTION + + This manual page documents briefly the &dhpackage; command. + + &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. + + + + OPTIONS + +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. + + + + + + + + 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. + + + + + + + + + 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. + + + + + + + + + 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. + + + + + + + +Run in jack mode (default when started without input file) and creates a midi output. + + + + + + +Show summary of options. + + + + + + +Show results on the console. + + + + + + + + SEE ALSO + + + aubioonset(1) + aubiocut(1) + aubionotes(1) + aubiopitch(1) + + + + + +BUGS + +For now the program has been only tested on audio signals sampled at 44.1 +kHz. + + + + + AUTHOR + + 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 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. + + + + + + + + -- 2.26.2