From: Paul Brossier Date: Wed, 1 Dec 2004 02:11:16 +0000 (+0000) Subject: updated docs X-Git-Tag: bzr2git~951 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=5a61c2970bd9f7d9d6f44dbe609bedf962fc9dba;p=aubio.git updated docs --- diff --git a/doc/Makefile.am b/doc/Makefile.am index 9306f746..6c682f18 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -35,8 +35,12 @@ doc-examples: doxygen examples.cfg cp aubio.css examples +man: + docbook-to-man aubionotes.sgml > aubionotes.1 + docbook-to-man aubioonset.sgml > aubioonset.1 + # Update docs for distribution #dist-hook: clean: - rm -rf devel user examples + rm -rf devel user examples *.1 diff --git a/doc/aubionotes.sgml b/doc/aubionotes.sgml new file mode 100644 index 00000000..638960d4 --- /dev/null +++ b/doc/aubionotes.sgml @@ -0,0 +1,185 @@ + 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"> + + AUBIO"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2003 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + an sound file onset detector + + + + &dhpackage; + + + + DESCRIPTION + + 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. + +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. + + + + + +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. + + + + + + +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) + + + + +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 + + 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/aubioonset.sgml b/doc/aubioonset.sgml new file mode 100644 index 00000000..d818de57 --- /dev/null +++ b/doc/aubioonset.sgml @@ -0,0 +1,186 @@ + 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"> + + AUBIO"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + &dhfirstname; + &dhsurname; + + + 2003 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + an sound file onset detector + + + + &dhpackage; + + + + DESCRIPTION + + 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. + +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. + + + + + +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. + + + + + + +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 + + aubionotes (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. + + + + + + + + diff --git a/examples/aubionotes.1 b/examples/aubionotes.1 deleted file mode 100644 index ec8baee4..00000000 --- a/examples/aubionotes.1 +++ /dev/null @@ -1,102 +0,0 @@ -.\" Hey, EMACS: -*- nroff -*- -.\" First parameter, NAME, should be all caps -.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection -.\" other parameters are allowed: see man(7), man(1) -.TH AUBIONOTES 1 "May 3, 2004" -.\" Please adjust this date whenever revising the man-page. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp insert n+1 empty lines -.\" for man-page-specific macros, see man(7) -.SH NAME -aubionotes \- detects notes in a sound file -.SH SYNOPSIS -.B aubionotes -.RI [ -i | --input -.RB < soundfilein > -.RI ] -.RI [ -o | --output -.RB < soundfileout > -.RI ] -.RI [ -t | --threshold -.RB < thres > -.RI ] -.RI [ -j | --jack ] -.RI [ -v | --verbose ] -.SH DESCRIPTION -This manual page documents briefly the -.B aubionotes -command. -.PP -The library \fBaubio\fP 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. - -\fBaubionotes\fP 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 (\fI\-i\fP), aubionotes creates a jack input and a midi -output. When an input file is given, it outputs the results on the console. - -.SH OPTIONS -This program follows the usual GNU command line syntax, with long -options starting with two dashes (`-'). -A summary of options is included below. -.TP -.B \-i, \-\-input filein -Run analysis on this audio file. Most common (uncompressed) formats are -supported. -.TP -.B \-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 very short wood-block sample. -.TP -.B \-t, \-\-threshold value -Set the threshold value for the onset peak picking. Typical values are within -\fI0.001\fP and \fI0.900\fP. Default is \fI0.1\fP. The \fBlower\fP the \fBmore -sensible\fP. Try \fI0.3\fP in case of over-detections. -.TP -.B \-j, \-\-jack -Run in jack mode (default when started without input file) and creates a midi output. -.TP -.B \-h, \-\-help -Show summary of options. -.TP -.B \-v, \-\-verbose -Show results on the console. - -.SH EXAMPLES -.TP -.I Analyse a file and save the notes times and pitches - -$ aubionotes -v -i myloop.wav 2> myloop.txt - -The results are expressed in seconds and midi pitch. - -.TP -.I Start as a jack client - -$ aubionotes -t 0.4 - -Note you will need to have \fIjackd\fP(1) running. Try connecting a midi -instrument to the aubio midi output. - -.SH LIMITATIONS -The audio feedback is still limited to playing a wood-block sound. -.SH BUGS -For now the program works only on audio signals sampled at 44.1 kHz. It is also -way too intensive. Hopefully this will be fixed in the next release. -.SH SEE ALSO -The source code is documented using -.IR doxygen (1), -available in the documentation package or at -.BR http://piem.homeip.net/~piem/aubio/doc/ . -.SH AUTHOR -This manual page was written by Paul Brossier , -for the Debian project (but may be used by others). diff --git a/examples/aubioonset.1 b/examples/aubioonset.1 deleted file mode 100644 index bcd45745..00000000 --- a/examples/aubioonset.1 +++ /dev/null @@ -1,103 +0,0 @@ -.\" Hey, EMACS: -*- nroff -*- -.\" First parameter, NAME, should be all caps -.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection -.\" other parameters are allowed: see man(7), man(1) -.TH AUBIOONSET 1 "May 3, 2004" -.\" Please adjust this date whenever revising the man-page. -.\" -.\" Some roff macros, for reference: -.\" .nh disable hyphenation -.\" .hy enable hyphenation -.\" .ad l left justify -.\" .ad b justify to both left and right margins -.\" .nf disable filling -.\" .fi enable filling -.\" .br insert line break -.\" .sp insert n+1 empty lines -.\" for man-page-specific macros, see man(7) -.SH NAME -aubioonset \- detects onset times in a sound file -.SH SYNOPSIS -.B aubioonset -.RI [ -i | --input -.RB < soundfilein > -.RI ] -.RI [ -o | --output -.RB < soundfileout > -.RI ] -.RI [ -t | --threshold -.RB < thres > -.RI ] -.RI [ -j | --jack ] -.RI [ -v | --verbose ] - -.SH DESCRIPTION -This manual page documents briefly the -.B aubioonset -command. -.PP -The \fBaubio\fP 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. - -\fBaubioonset\fP extract onsets from an audio input. It works online or -off-line: live as a jack client, or with an input sound file. When running on a -file, results can be printed to the console using the \fI\-v\fP flag. - -.SH OPTIONS -This program follows the usual GNU command line syntax, with long -options starting with two dashes (`-'). -A summary of options is included below. -.TP -.B \-i, \-\-input filein -Run analysis on this audio file. Most common (uncompressed) formats are -supported. -.TP -.B \-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 very short wood-block sample. -.TP -.B \-t, \-\-threshold value -Set the threshold value for the onset peak picking. Typical values are within -\fI0.001\fP and \fI0.900\fP. Default is \fI0.1\fP. The \fBlower\fP the \fBmore -sensible\fP. Try \fI0.3\fP in case of over-detections. -.TP -.B \-j, \-\-jack -Run in jack mode (default when started without input file). -.TP -.B \-h, \-\-help -Show summary of options. -.TP -.B \-v, \-\-verbose -Show results on the console. - -.SH EXAMPLES -.TP -.I Analyse a file and save the onsets times (in seconds) - -$ aubioonset -v -i myloop.wav 2> myloop.txt - -One can start a new project in \fIaudacity\fP(1), import myloop.wav as an audio -track, and myloop.txt as a label track. This allows to verify each onset -position, label them with text and select notes, bars and loops. - -.TP -.I Start as a jack client - -$ aubioonset -t 0.2 - -Note you will need to have \fIjackd\fP(1) running. - -.SH LIMITATIONS -The audio feedback in both case is still limited to playing a wood-block sound. -Midi messages will be sent in the near future. -.SH BUGS -For now the program works only on audio signals sampled at 44.1 kHz. -.SH SEE ALSO -The source code is documented using -.IR doxygen (1), -available in the documentation package or at -.BR http://piem.homeip.net/~piem/aubio/doc/ . -.SH AUTHOR -This manual page was written by Paul Brossier , -for the Debian project (but may be used by others). diff --git a/python/aubio/Makefile.am b/python/aubio/Makefile.am index ebeb669f..e25db817 100644 --- a/python/aubio/Makefile.am +++ b/python/aubio/Makefile.am @@ -7,3 +7,4 @@ pkgpython_PYTHON = __init__.py onsetcompare.py\ clean: rm -f *.pyc +distclean: clean diff --git a/python/aubio/Makefile.in b/python/aubio/Makefile.in index 37bb9a94..ccdaf8c1 100644 --- a/python/aubio/Makefile.in +++ b/python/aubio/Makefile.in @@ -333,6 +333,8 @@ uninstall-am: uninstall-info-am uninstall-pkgpythonPYTHON clean: rm -f *.pyc + +distclean: clean # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. .NOEXPORT: