From 403e9dd73f79f60cdf7ff2426d0e8dfc43bf0601 Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Sat, 7 Dec 2013 22:10:40 -0500 Subject: [PATCH] doc/: rewrite manpages, use txt2man, add aubioquiet.txt, change rule in wscript --- doc/aubiocut.sgml | 324 ---------------------------------------------------- doc/aubiocut.txt | 74 ++++++++++++ doc/aubiomfcc.sgml | 166 --------------------------- doc/aubiomfcc.txt | 63 ++++++++++ doc/aubionotes.sgml | 224 ------------------------------------ doc/aubionotes.txt | 102 +++++++++++++++++ doc/aubioonset.sgml | 210 ---------------------------------- doc/aubioonset.txt | 149 ++++++++++++++++++++++++ doc/aubiopitch.sgml | 291 ---------------------------------------------- doc/aubiopitch.txt | 132 +++++++++++++++++++++ doc/aubioquiet.txt | 67 +++++++++++ doc/aubiotrack.sgml | 199 -------------------------------- doc/aubiotrack.txt | 86 ++++++++++++++ wscript | 21 ++-- 14 files changed, 686 insertions(+), 1422 deletions(-) delete mode 100644 doc/aubiocut.sgml create mode 100644 doc/aubiocut.txt delete mode 100644 doc/aubiomfcc.sgml create mode 100644 doc/aubiomfcc.txt delete mode 100644 doc/aubionotes.sgml create mode 100644 doc/aubionotes.txt delete mode 100644 doc/aubioonset.sgml create mode 100644 doc/aubioonset.txt delete mode 100644 doc/aubiopitch.sgml create mode 100644 doc/aubiopitch.txt create mode 100644 doc/aubioquiet.txt delete mode 100644 doc/aubiotrack.sgml create mode 100644 doc/aubiotrack.txt diff --git a/doc/aubiocut.sgml b/doc/aubiocut.sgml deleted file mode 100644 index 7f91cfa7..00000000 --- a/doc/aubiocut.sgml +++ /dev/null @@ -1,324 +0,0 @@ - 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@aubio.org"> - - AUBIOCUT"> - - - Debian"> - GNU"> - GPL"> -]> - - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - 2003 - &dhusername; - - &dhdate; - - - &dhucpackage; - - &dhsection; - - - &dhpackage; - - a command line tool to extract onsets and tempo from sound files. - - - - - &dhpackage; [options] -i soundfile - - - - DESCRIPTION - - &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. - - - - - - - input sound file - - - - - - - onset detection mode [default=dual] complexdomain|hfc|phase|specdiff|energy|kl|mkl|dual - - - - - - - detect beats and output beat locations - - - - - - - buffer size [default=512] - - - - - - - overlap size [default=256] - - - - - - - onset peak picking threshold [default=0.3] - - - - - - - onset peak picking DC component [default=1.] - - - - - - - silence threshold [default=-70] - - - - - - - minimum inter onset interval [default=0.048s] - - - - - - - number of seconds to take back [default=system] - default system delay is 3*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] - - - - - - - print detection function - - - - - - - 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. - - - - - - - draw plot - - - - - - - do not plot detected onsets, only detection functions - - - - - - - define horizontal plot size [default=1.] - - - - - - - define vertical plot size [default=1.] - - - - - - - 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) - 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 3 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/aubiocut.txt b/doc/aubiocut.txt new file mode 100644 index 00000000..eb7916c6 --- /dev/null +++ b/doc/aubiocut.txt @@ -0,0 +1,74 @@ +NAME + aubiocut - a command line tool to slice sound files at onset or beat timestamps + +SYNOPSIS + + aubiocut source + aubiocut [[-i] source] + [-r rate] [-B win] [-H hop] + [-O method] [-t thres] + [-b] [-c] + [-v] [-q] [-h] + +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 source Run analysis on this audio file. Most uncompressed and + compressed are supported, depending on how aubio was built. + + -r, --samplerate rate Fetch the input source, resampled at the given + sampling rate. The rate should be specified in Hertz as an integer. If 0, + the sampling rate of the original source will be used. Defaults to 0. + + -B, --bufsize win The size of the buffer to analyze, that is the length + of the window used for spectral and temporal computations. Defaults to 512. + + -H, --hopsize hop The number of samples between two consecutive analysis. + Defaults to 256. + + -O, --onset method The onset detection method to use. See ONSET METHODS + below. Defaults to 'default'. + + -b, --beat Use beat locations instead of onset locations. + + -t, --onset-threshold thres Set the threshold value for the onset peak + picking. Typical values are typically within 0.001 and 0.900. Defaults to + 0.1. Lower threshold values imply more onsets detected. Try 0.5 in case of + over-detections. Defaults to 0.3. + + -c, --cut Cut input sound file at detected labels. A new sound files for + each slice will be created in the current directory. + + -h, --help Print a short help message and exit. + + -v, --verbose Be verbose. + + -q, --quiet Be quiet. + + +ONSET METHODS + + Available methods: default, energy, hfc, complex, phase, specdiff, kl, mkl, + specflux. + + See aubioonset(1) for details about these methods. + + +SEE ALSO + + aubioonset(1), + aubiopitch(1), + aubiotrack(1), + aubionotes(1), + aubioquiet(1), + and + aubiomfcc(1). + +AUTHOR + + This manual page was written by Paul Brossier . Permission is + granted to copy, distribute and/or modify this document under the terms of + the GNU General Public License as published by the Free Software Foundation, + either version 3 of the License, or (at your option) any later version. diff --git a/doc/aubiomfcc.sgml b/doc/aubiomfcc.sgml deleted file mode 100644 index 43e75333..00000000 --- a/doc/aubiomfcc.sgml +++ /dev/null @@ -1,166 +0,0 @@ - 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@aubio.org"> - - AUBIOMFCC"> - - - Debian"> - GNU"> - GPL"> -]> - - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - 2003 - &dhusername; - - &dhdate; - - - &dhucpackage; - - &dhsection; - - - &dhpackage; - - a command line tool for real time mfcc extraction - - - - - &dhpackage; [options] [-i soundfile] - - - - DESCRIPTION - - &dhpackage; extracts Mel-Frequency Cepstrum - Coefficients (MFCC) 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. - - - - - - - - Run analysis on this audio file. Most common uncompressed formats are - supported. - - - - - - - - Run in jack mode (default when started without input file) and creates a midi output. - - - - - - - Show results on the console (default). - - - - - - - Show summary of options. - - - - - - - SEE ALSO - - - aubiotrack(1) - aubionotes(1) - aubiocut(1) - aubiopitch(1) - aubioonset(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 3 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/aubiomfcc.txt b/doc/aubiomfcc.txt new file mode 100644 index 00000000..9084c4a0 --- /dev/null +++ b/doc/aubiomfcc.txt @@ -0,0 +1,63 @@ +NAME + aubiomfcc - a command line tool to compute Mel-frequency Cepstrum Coefficients + +SYNOPSIS + + aubiomfcc source + aubiomfcc [[-i] source] + [-r rate] [-B win] [-H hop] + [-v] [-h] + +DESCRIPTION + + aubiomfcc compute the Mel Frequency Cepstrum Coefficients (MFCC). + + When started with an input source (-i/--input), the coefficients are given on + the console, prefixed by their timestamps in seconds. + +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 source Run analysis on this audio file. Most uncompressed and + compressed are supported, depending on how aubio was built. + + -r, --samplerate rate Fetch the input source, resampled at the given + sampling rate. The rate should be specified in Hertz as an integer. If 0, + the sampling rate of the original source will be used. Defaults to 0. + + -B, --bufsize win The size of the buffer to analyze, that is the length + of the window used for spectral and temporal computations. Defaults to 512. + + -H, --hopsize hop The number of samples between two consecutive analysis. + Defaults to 256. + + -h, --help Print a short help message and exit. + + -v, --verbose Be verbose. + +REFERENCES + + Using the default parameters, the filter coefficients will be computed + according to Malcolm Slaney's Auditory Toolbox, available at the following + url: + + http://cobweb.ecn.purdue.edu/~malcolm/interval/1998-010/ (see file mfcc.m) + +SEE ALSO + + aubioonset(1), + aubiopitch(1), + aubiotrack(1), + aubionotes(1), + aubioquiet(1), + and + aubiocut(1). + +AUTHOR + + This manual page was written by Paul Brossier . Permission is + granted to copy, distribute and/or modify this document under the terms of + the GNU General Public License as published by the Free Software Foundation, + either version 3 of the License, or (at your option) any later version. diff --git a/doc/aubionotes.sgml b/doc/aubionotes.sgml deleted file mode 100644 index 779d7fc3..00000000 --- a/doc/aubionotes.sgml +++ /dev/null @@ -1,224 +0,0 @@ - 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@aubio.org"> - - AUBIONOTES"> - - - Debian"> - GNU"> - GPL"> -]> - - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - 2003 - &dhusername; - - &dhdate; - - - &dhucpackage; - - &dhsection; - - - &dhpackage; - - a command line tool for real time extraction of musical notes. - - - - - &dhpackage; [options] [-i soundfile] - - - - DESCRIPTION - - &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. - - - - 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 short wood-block sample. - - - - - - - - - The pitch detection function to run. Available functions are - yinfft, yin, - mcomb, fcomb, and - schmitt. - - - - - - - - - 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. Lower threshold values imply - more onsets detected. Try 0.3 in - case of over-detections. - - - - - - - - Run in jack mode (default when started without input file) and creates a midi output. - - - - - - - Show results on the console (default). - - - - - - - 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) - aubiocut(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 3 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.txt b/doc/aubionotes.txt new file mode 100644 index 00000000..190fc72e --- /dev/null +++ b/doc/aubionotes.txt @@ -0,0 +1,102 @@ +NAME + aubionotes - a command line tool to extract musical notes + +SYNOPSIS + + aubionotes source + aubionotes [[-i] source] + [-r rate] [-B win] [-H hop] + [-O method] [-t thres] + [-p method] [-u unit] [-l thres] + [-s sil] + [-j] [-v] [-h] + +DESCRIPTION + + aubionotes attempts to detect notes by looking for note onsets and pitches. + Consecutive events are segmented using onset detection, while a fundamental + frequency extraction algorithm determines their pitch. + + When started with an input source (-i/--input), the detected notes are + printed on standard output, in seconds and midi note number. + + When started without an input source, or with the jack option (-j/--jack), + aubionotes starts in jack mode. + +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 source Run analysis on this audio file. Most uncompressed and + compressed are supported, depending on how aubio was built. + + -r, --samplerate rate Fetch the input source, resampled at the given + sampling rate. The rate should be specified in Hertz as an integer. If 0, + the sampling rate of the original source will be used. Defaults to 0. + + -B, --bufsize win The size of the buffer to analyze, that is the length + of the window used for spectral and temporal computations. Defaults to 512. + + -H, --hopsize hop The number of samples between two consecutive analysis. + Defaults to 256. + + -O, --onset method The onset detection method to use. See ONSET METHODS + below. Defaults to 'default'. + + -t, --onset-threshold thres Set the threshold value for the onset peak + picking. Typical values are typically within 0.001 and 0.900. Defaults to + 0.1. Lower threshold values imply more onsets detected. Try 0.5 in case of + over-detections. Defaults to 0.3. + + -p, --pitch method The pitch detection method to use. See PITCH METHODS + below. Defaults to 'default'. + + -u, --pitch-unit unit The unit to be used to print frequencies. Possible + values include midi, bin, cent, and Hz. Defaults to 'Hz'. + + -l, --pitch-tolerance thres Set the tolerance for the pitch detection + algorithm. Typical values range between 0.2 and 0.9. Pitch candidates found + with a confidence less than this threshold will not be selected. The higher + the threshold, the more confidence in the candidates. Defaults to unset. + + -s, --silence sil Set the silence threshold, in dB, under which the pitch + will not be detected. A value of -20.0 would eliminate most onsets but the + loudest ones. A value of -90.0 would select all onsets. Defaults to -90.0. + + -j, --jack Use Jack input/output. You will need a Jack connection + controller to feed aubio some signal and listen to its output. + + -h, --help Print a short help message and exit. + + -v, --verbose Be verbose. + +ONSET METHODS + + Available methods: default, energy, hfc, complex, phase, specdiff, kl, mkl, + specflux. + + See aubioonset(1) for details about these methods. + +PITCH METHODS + + Available methods: default, schmitt, fcomb, mcomb, specacf, yin, yinfft. + + See aubiopitch(1) for details about these methods. + +SEE ALSO + + aubioonset(1), + aubiopitch(1), + aubiotrack(1), + aubioquiet(1), + aubiomfcc(1), + and + aubiocut(1). + +AUTHOR + + This manual page was written by Paul Brossier . Permission is + granted to copy, distribute and/or modify this document under the terms of + the GNU General Public License as published by the Free Software Foundation, + either version 3 of the License, or (at your option) any later version. diff --git a/doc/aubioonset.sgml b/doc/aubioonset.sgml deleted file mode 100644 index 7d325897..00000000 --- a/doc/aubioonset.sgml +++ /dev/null @@ -1,210 +0,0 @@ - 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@aubio.org"> - - AUBIOONSET"> - - - Debian"> - GNU"> - GPL"> -]> - - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - 2003 - &dhusername; - - &dhdate; - - - &dhucpackage; - - &dhsection; - - - &dhpackage; - - a command line tool for real time onset extraction - - - - - &dhpackage; [options] [-i soundfile] - - - - DESCRIPTION - - &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. - - - - - - - - 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 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. Lower threshold values imply - more onsets detected. Try 0.3 in - case of over-detections. - - - - - - - - Run in jack mode (default when started without input file) and creates a midi output. - - - - - - - Show results on the console (default). - - - - - - - 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 &dhusername; (&dhemail;). Permission - is granted to copy, distribute and/or modify this document under the terms - of the &gnu; General Public License, Version 3 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.txt b/doc/aubioonset.txt new file mode 100644 index 00000000..1b71682a --- /dev/null +++ b/doc/aubioonset.txt @@ -0,0 +1,149 @@ +NAME + aubioonset - a command line tool to extract musical onset times + +SYNOPSIS + + aubioonset source + aubioonset [[-i] source] [-o sink] + [-r rate] [-B win] [-H hop] + [-O method] [-t thres] + [-s sil] [-m] + [-j] [-v] [-h] + +DESCRIPTION + + aubioonset attempts to detect onset times, the beginning of discrete sound + events, in audio signals. + + When started with an input source (-i/--input), the detected onset times are + given on the console, in seconds. + + When started without an input source, or with the jack option (-j/--jack), + aubioonset starts in jack mode. + +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 source Run analysis on this audio file. Most uncompressed and + compressed are supported, depending on how aubio was built. + + -o, --output sink Save results in this file. The file will be created on + the model of the input file. Onset times are marked by a short wood-block + like sound. + + -r, --samplerate rate Fetch the input source, resampled at the given + sampling rate. The rate should be specified in Hertz as an integer. If 0, + the sampling rate of the original source will be used. Defaults to 0. + + -B, --bufsize win The size of the buffer to analyze, that is the length + of the window used for spectral and temporal computations. Defaults to 512. + + -H, --hopsize hop The number of samples between two consecutive analysis. + Defaults to 256. + + -O, --onset method The onset detection method to use. See ONSET METHODS + below. Defaults to 'default'. + + -t, --onset-threshold thres Set the threshold value for the onset peak + picking. Typical values are typically within 0.001 and 0.900. Defaults to + 0.1. Lower threshold values imply more onsets detected. Try 0.5 in case of + over-detections. Defaults to 0.3. + + -s, --silence sil Set the silence threshold, in dB, under which the pitch + will not be detected. A value of -20.0 would eliminate most onsets but the + loudest ones. A value of -90.0 would select all onsets. Defaults to -90.0. + + -m, --mix-input Mix source signal to the output signal before writing to + sink. + + -j, --jack Use Jack input/output. You will need a Jack connection + controller to feed aubio some signal and listen to its output. + + -h, --help Print a short help message and exit. + + -v, --verbose Be verbose. + +ONSET METHODS + + Available methods are: + + default Default distance, currently hfc + + Default: 'default' (currently set to hfc) + + energy Energy based distance + + This function calculates the local energy of the input spectral frame. + + hfc High-Frequency content + + This method computes the High Frequency Content (HFC) of the input + spectral frame. The resulting function is efficient at detecting + percussive onsets. + + Paul Masri. Computer modeling of Sound for Transformation and Synthesis of + Musical Signal. PhD dissertation, University of Bristol, UK, 1996. + + complex Complex domain onset detection function + + This function uses information both in frequency and in phase to determine + changes in the spectral content that might correspond to musical onsets. + It is best suited for complex signals such as polyphonic recordings. + + Christopher Duxbury, Mike E. Davies, and Mark B. Sandler. Complex domain + onset detection for musical signals. In Proceedings of the Digital Audio + Effects Conference, DAFx-03, pages 90-93, London, UK, 2003. + + phase Phase based onset detection function + + This function uses information both in frequency and in phase to determine + changes in the spectral content that might correspond to musical onsets. It + is best suited for complex signals such as polyphonic recordings. + + Juan-Pablo Bello, Mike P. Davies, and Mark B. Sandler. Phase-based note + onset detection for music signals. In Proceedings of the IEEE International + Conference on Acoustics Speech and Signal Processing, pages 441­444, + Hong-Kong, 2003. + + specdiff Spectral difference onset detection function + + Jonhatan Foote and Shingo Uchihashi. The beat spectrum: a new approach to + rhythm analysis. In IEEE International Conference on Multimedia and Expo + (ICME 2001), pages 881­884, Tokyo, Japan, August 2001. + + kl Kulback-Liebler onset detection function + + Stephen Hainsworth and Malcom Macleod. Onset detection in music audio + signals. In Proceedings of the International Computer Music Conference + (ICMC), Singapore, 2003. + + mkl Modified Kulback-Liebler onset detection function + + Paul Brossier, ``Automatic annotation of musical audio for interactive + systems'', Chapter 2, Temporal segmentation, PhD thesis, Centre for + Digital music, Queen Mary University of London, London, UK, 2006. + + specflux Spectral flux + + Simon Dixon, Onset Detection Revisited, in ``Proceedings of the 9th + International Conference on Digital Audio Effects'' (DAFx-06), Montreal, + Canada, 2006. + +SEE ALSO + + aubiopitch(1), + aubiotrack(1), + aubionotes(1), + aubioquiet(1), + aubiomfcc(1), + and + aubiocut(1). + +AUTHOR + + This manual page was written by Paul Brossier . Permission is + granted to copy, distribute and/or modify this document under the terms of + the GNU General Public License as published by the Free Software Foundation, + either version 3 of the License, or (at your option) any later version. diff --git a/doc/aubiopitch.sgml b/doc/aubiopitch.sgml deleted file mode 100644 index 9173ad9b..00000000 --- a/doc/aubiopitch.sgml +++ /dev/null @@ -1,291 +0,0 @@ - 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@aubio.org"> - - AUBIOPITCH"> - - - Debian"> - GNU"> - GPL"> -]> - - - -
- &dhemail; -
- - &dhfirstname; - &dhsurname; - - - 2003 - &dhusername; - - &dhdate; - - - &dhucpackage; - - &dhsection; - - - &dhpackage; - - a command line tool to extract pitch candidates from sound files. - - - - - &dhpackage; [options] -i soundfile - - - - DESCRIPTION - - &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. - - - - 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=0] - - - - - - - temporal smoothing using a median filter of N frames [default=0] - - - - - - - maximum pitch values to look for (Hz) [default=20000] - - - - - - - minimum pitch values to look for (Hz) [default=20] - - - - - - - NOT IMPLEMENTED output notes - - - - - - - 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. - - - - - - - draw plot of the pitch track - - - - - - - draw plot of the ground truth pitch track - - - - - - - define horizontal plot size [default=1.] - - - - - - - define vertical plot size [default=1.] - - - - - - - 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 &dhusername; (&dhemail;). Permission - is granted to copy, distribute and/or modify this document under the terms - of the &gnu; General Public License, Version 3 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/aubiopitch.txt b/doc/aubiopitch.txt new file mode 100644 index 00000000..af17d79c --- /dev/null +++ b/doc/aubiopitch.txt @@ -0,0 +1,132 @@ +NAME + aubiopitch - a command line tool to extract musical pitch + +SYNOPSIS + + aubiopitch source + aubiopitch [[-i] source] [-o sink] + [-r rate] [-B win] [-H hop] + [-p method] [-u unit] [-l thres] + [-s sil] + [-v] [-h] [-j] + +DESCRIPTION + + aubiopitch attempts to detect the pitch, the perceived height of a musical + note. + + When started with an input source (-i/--input), the detected pitch are + printed on the console, prefixed by a timestamp in seconds. If no pitch + candidate is found, the output is 0. + + When started without an input source, or with the jack option (-j/--jack), + aubiopitch starts in jack mode. + +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 source Run analysis on this audio file. Most uncompressed and + compressed are supported, depending on how aubio was built. + + -o, --output sink Save results in this file. The file will be created on + the model of the input file. The detected frequency is played at the + detected loudness. + + -r, --samplerate rate Fetch the input source, resampled at the given + sampling rate. The rate should be specified in Hertz as an integer. If 0, + the sampling rate of the original source will be used. Defaults to 0. + + -B, --bufsize win The size of the buffer to analyze, that is the length + of the window used for spectral and temporal computations. Defaults to 2048. + + -H, --hopsize hop The number of samples between two consecutive analysis. + Defaults to 256. + + -p, --pitch method The pitch detection method to use. See PITCH METHODS + below. Defaults to 'default'. + + -u, --pitch-unit unit The unit to be used to print frequencies. Possible + values include midi, bin, cent, and Hz. Defaults to 'Hz'. + + -l, --pitch-tolerance thres Set the tolerance for the pitch detection + algorithm. Typical values range between 0.2 and 0.9. Pitch candidates found + with a confidence less than this threshold will not be selected. The higher + the threshold, the more confidence in the candidates. Defaults to unset. + + -s, --silence sil Set the silence threshold, in dB, under which the onset + will not be detected. A value of -20.0 would eliminate most onsets but the + loudest ones. A value of -90.0 would select all onsets. Defaults to -90.0. + + -m, --mix-input Mix source signal to the output signal before writing to + sink. + + -j, --jack Use Jack input/output. You will need a Jack connection + controller to feed aubio some signal and listen to its output. + + -h, --help Print a short help message and exit. + + -v, --verbose Be verbose. + +PITCH METHODS + + Available methods are: + + default use the default method + + Currently, the default method is set to yinfft. + + schmitt Schmitt trigger + + This pitch extraction method implements a Schmitt trigger to estimate the + period of a signal. It is computationally very inexpensive, but also very + sensitive to noise. + + fcomb a fast harmonic comb filter + + This pitch extraction method implements a fast harmonic comb filter to + determine the fundamental frequency of a harmonic sound. + + mcomb multiple-comb filter + + This fundamental frequency estimation algorithm implements spectral + flattening, multi-comb filtering and peak histogramming. + + specacf Spectral auto-correlation function + + yin YIN algorithm + + This algorithm was developped by A. de Cheveigne and H. Kawahara and + was first published in: + + De Cheveigné, A., Kawahara, H. (2002) "YIN, a fundamental frequency + estimator for speech and music", J. Acoust. Soc. Am. 111, 1917-1930. + + yinfft Yinfft algorithm + + This algorithm was derived from the YIN algorithm. In this implementation, a + Fourier transform is used to compute a tapered square difference function, + which allows spectral weighting. Because the difference function is tapered, + the selection of the period is simplified. + + Paul Brossier, Automatic annotation of musical audio for interactive systems, + Chapter 3, Pitch Analysis, PhD thesis, Centre for Digital music, Queen Mary + University of London, London, UK, 2006. + +SEE ALSO + + aubioonset(1), + aubiotrack(1), + aubionotes(1), + aubioquiet(1), + aubiomfcc(1), + and + aubiocut(1). + +AUTHOR + + This manual page was written by Paul Brossier . Permission is + granted to copy, distribute and/or modify this document under the terms of + the GNU General Public License as published by the Free Software Foundation, + either version 3 of the License, or (at your option) any later version. diff --git a/doc/aubioquiet.txt b/doc/aubioquiet.txt new file mode 100644 index 00000000..eb11ae04 --- /dev/null +++ b/doc/aubioquiet.txt @@ -0,0 +1,67 @@ +NAME + aubioquiet - a command line tool to extracts quiet and loud regions from a file + +SYNOPSIS + + aubioquiet source + aubioquiet [[-i] source] + [-r rate] [-B win] [-H hop] + [-s sil] + [-v] [-h] + +DESCRIPTION + + aubioquiet will print a timestamp each time it detects a new silent region or + a new loud region in a sound file. + + When started with an input source (-i/--input), the detected timestamps are + printed on the console, in seconds. + +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 source Run analysis on this audio file. Most uncompressed and + compressed are supported, depending on how aubio was built. + + -r, --samplerate rate Fetch the input source, resampled at the given + sampling rate. The rate should be specified in Hertz as an integer. If 0, + the sampling rate of the original source will be used. Defaults to 0. + + -B, --bufsize win The size of the buffer to analyze, that is the length + of the window used for spectral and temporal computations. Defaults to 512. + + -H, --hopsize hop The number of samples between two consecutive analysis. + Defaults to 256. + + -s, --silence sil Set the silence threshold, in dB, under which the pitch + will not be detected. Defaults to -90.0. + + -h, --help Print a short help message and exit. + + -v, --verbose Be verbose. + +EXAMPLE OUTPUT + + NOISY: 28.775330 + + QUIET: 28.914648 + + +SEE ALSO + + aubioonset(1), + aubiopitch(1), + aubiotrack(1), + aubionotes(1), + aubiomfcc(1), + and + aubiocut(1). + +AUTHOR + + This manual page was written by Paul Brossier . Permission + is granted to copy, distribute and/or modify this document under the terms + of the GNU General Public License, Version 3 any later version published + by the Free Software Foundation. diff --git a/doc/aubiotrack.sgml b/doc/aubiotrack.sgml deleted file mode 100644 index 74ad3bf1..00000000 --- a/doc/aubiotrack.sgml +++ /dev/null @@ -1,199 +0,0 @@ - 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@aubio.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] [-i soundfile] - - - - DESCRIPTION - - &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. - - 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. - - - - - - - - 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 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. - - - - - - - - Run in jack mode (default when started without input file) and creates a midi output. - - - - - - - Show results on the console (default). - - - - - - - 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) - aubionotes(1) - aubiocut(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 3 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.txt b/doc/aubiotrack.txt new file mode 100644 index 00000000..1e7eb72b --- /dev/null +++ b/doc/aubiotrack.txt @@ -0,0 +1,86 @@ +NAME + aubiotrack - a command line tool to extract musical beats from audio signals + +SYNOPSIS + + aubiotrack source + aubiotrack [[-i] source] [-o sink] + [-r rate] [-B win] [-H hop] + [-s sil] [-m] + [-j] [-v] [-h] + +DESCRIPTION + + aubiotrack attempts to detect beats, the time where one would intuitively be + tapping his foot. + + When started with an input source (-i/--input), the detected beats are given + on the console, in seconds. + + When started without an input source, or with the jack option (-j/--jack), + aubiotrack starts in jack mode. + +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 source Run analysis on this audio file. Most uncompressed and + compressed are supported, depending on how aubio was built. + + -o, --output sink Save results in this file. The file will be created on the + model of the input file. Beats are marked by a short wood-block like sound. + + -r, --samplerate rate Fetch the input source, resampled at the given + sampling rate. The rate should be specified in Hertz as an integer. If 0, + the sampling rate of the original source will be used. Defaults to 0. + + -B, --bufsize win The size of the buffer to analyze, that is the length + of the window used for spectral and temporal computations. Defaults to 512. + + -H, --hopsize hop The number of samples between two consecutive analysis. + Defaults to 256. + + -s, --silence sil Set the silence threshold, in dB, under which the pitch + will not be detected. A value of -20.0 would eliminate most onsets but the + loudest ones. A value of -90.0 would select all onsets. Defaults to -90.0. + + -m, --mix-input Mix source signal to the output signal before writing to + sink. + + -j, --jack Use Jack input/output. You will need a Jack connection + controller to feed aubio some signal and listen to its output. + + -h, --help Print a short help message and exit. + + -v, --verbose Be verbose. + +BEAT TRACKING METHODS + + Aubio currently implements one the causal beat tracking algorithm designed by + Matthew Davies and described in the following articles: + + Matthew E. P. Davies and Mark D. Plumbley. Causal tempo tracking of audio. + In Proceedings of the International Symposium on Music Information Retrieval + (ISMIR), pages 164­169, Barcelona, Spain, 2004. + + Matthew E. P. Davies, Paul Brossier, and Mark D. Plumbley. Beat tracking + towards automatic musical accompaniment. In Proceedings of the Audio + Engeeniring Society 118th Convention, Barcelona, Spain, May 2005. + +SEE ALSO + + aubioonset(1), + aubiopitch(1), + aubionotes(1), + aubioquiet(1), + aubiomfcc(1), + and + aubiocut(1). + +AUTHOR + + This manual page was written by Paul Brossier . Permission is + granted to copy, distribute and/or modify this document under the terms of + the GNU General Public License as published by the Free Software Foundation, + either version 3 of the License, or (at your option) any later version. diff --git a/wscript b/wscript index b2698abe..34d64f2c 100644 --- a/wscript +++ b/wscript @@ -212,11 +212,11 @@ def configure(ctx): ctx.define('AUBIO_PREFIX', ctx.env['PREFIX']) ctx.define('PACKAGE', APPNAME) - # check if docbook-to-man is installed, optional + # check if txt2man is installed, optional try: - ctx.find_program('docbook-to-man', var='DOCBOOKTOMAN') + ctx.find_program('txt2man', var='TXT2MAN') except ctx.errors.ConfigurationError: - ctx.to_log('docbook-to-man was not found (ignoring)') + ctx.to_log('txt2man was not found (ignoring)') def build(bld): bld.env['VERSION'] = VERSION @@ -233,19 +233,24 @@ def build(bld): bld( source = 'aubio.pc.in' ) # build manpages from sgml files - if bld.env['DOCBOOKTOMAN']: + if bld.env['TXT2MAN']: from waflib import TaskGen if 'MANDIR' not in bld.env: bld.env['MANDIR'] = bld.env['PREFIX'] + '/share/man' + rule_str = '${TXT2MAN} -t `basename ${TGT} | cut -f 1 -d . | tr a-z A-Z`' + rule_str += ' -r ${PACKAGE}\\ ${VERSION} -P ${PACKAGE}' + rule_str += ' -v ${PACKAGE}\\ User\\\'s\\ manual' + rule_str += ' -s 1 ${SRC} > ${TGT}' TaskGen.declare_chain( - name = 'docbooktoman', - rule = '${DOCBOOKTOMAN} ${SRC} > ${TGT}', - ext_in = '.sgml', + name = 'txt2man', + rule = rule_str, + #rule = '${TXT2MAN} -p -P aubio -s 1 -r aubio-0.4.0 ${SRC} > ${TGT}', + ext_in = '.txt', ext_out = '.1', reentrant = False, install_path = '${MANDIR}/man1', ) - bld( source = bld.path.ant_glob('doc/*.sgml') ) + bld( source = bld.path.ant_glob('doc/*.txt') ) """ bld(rule = 'doxygen ${SRC}', source = 'web.cfg') #, target = 'doc/web/index.html') -- 2.11.0