diff options
| -rw-r--r-- | libraries/aubio/aubio.SlackBuild | 31 | ||||
| -rw-r--r-- | libraries/aubio/man/aubio.1 | 208 | ||||
| -rw-r--r-- | libraries/aubio/man/aubiocut.1 | 124 | ||||
| -rw-r--r-- | libraries/aubio/man/aubiomfcc.1 | 89 | ||||
| -rw-r--r-- | libraries/aubio/man/aubionotes.1 | 149 | ||||
| -rw-r--r-- | libraries/aubio/man/aubioonset.1 | 223 | ||||
| -rw-r--r-- | libraries/aubio/man/aubiopitch.1 | 194 | ||||
| -rw-r--r-- | libraries/aubio/man/aubioquiet.1 | 92 | ||||
| -rw-r--r-- | libraries/aubio/man/aubiotrack.1 | 129 |
9 files changed, 1231 insertions, 8 deletions
diff --git a/libraries/aubio/aubio.SlackBuild b/libraries/aubio/aubio.SlackBuild index f034b00b6727..48e8c876be00 100644 --- a/libraries/aubio/aubio.SlackBuild +++ b/libraries/aubio/aubio.SlackBuild @@ -23,11 +23,16 @@ # OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF # ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# 20230722 bkw: BUILD=2 +# - fix conflict with Sphinx. +# - add prebuilt man pages (to avoid depending on txt2man, which isn't even +# in the SBo repo yet). + cd $(dirname $0) ; CWD=$(pwd) PRGNAM=aubio VERSION=${VERSION:-0.4.9} -BUILD=${BUILD:-1} +BUILD=${BUILD:-2} TAG=${TAG:-_SBo} PKGTYPE=${PKGTYPE:-tgz} @@ -39,9 +44,6 @@ if [ -z "$ARCH" ]; then esac fi -# If the variable PRINT_PACKAGE_NAME is set, then this script will report what -# the name of the created package would be, and then exit. This information -# could be useful to other scripts. if [ ! -z "${PRINT_PACKAGE_NAME}" ]; then echo "$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.$PKGTYPE" exit 0 @@ -76,9 +78,9 @@ cd $PRGNAM-$VERSION chown -R root:root . find -L . \ \( -perm 777 -o -perm 775 -o -perm 750 -o -perm 711 -o -perm 555 \ - -o -perm 511 \) -exec chmod 755 {} \; -o \ + -o -perm 511 \) -exec chmod 755 {} + -o \ \( -perm 666 -o -perm 664 -o -perm 640 -o -perm 600 -o -perm 444 \ - -o -perm 440 -o -perm 400 \) -exec chmod 644 {} \; + -o -perm 440 -o -perm 400 \) -exec chmod 644 {} + # Fix detecting ffmpeg sed -i "s|'HAVE_' + i in ctx.env.define_key|'HAVE_' + i in ctx.env|" \ @@ -87,6 +89,13 @@ sed -i "s|'HAVE_' + i in ctx.env.define_key|'HAVE_' + i in ctx.env|" \ # Fix the build system... sed -i "s|'\${DATAROOTDIR}' + '/doc/libaubio-doc|'\${DOCDIR}|" wscript || exit 1 +# 20230722 bkw: if Sphinx is missing, the build is OK. if it's +# installed, it gets audodetected, then the build fails later. Could +# fix with --disable-docs, but that also disables the rest of the +# docs. Also, since I've added prebuilt man pages, disable the man +# page generation. +sed -i -e '/^ *sphinx(bld)/d' -e '/^ *txt2man(bld)/d' wscript + CFLAGS="$SLKCFLAGS" \ CXXFLAGS="$SLKCFLAGS" \ ./waf configure \ @@ -107,8 +116,8 @@ cd .. cp -a $PRGNAM-$VERSION $PRGNAM-$VERSION-2 cd - -if $(python -c 'import numpy' 2>/dev/null); then - python setup.py install --root=$PKG +if $(python2 -c 'import numpy' 2>/dev/null); then + python2 setup.py install --root=$PKG fi if $(python3 -c 'import numpy' 2>/dev/null); then ( cd ../$PRGNAM-$VERSION-2 @@ -118,6 +127,12 @@ fi find $PKG -print0 | xargs -0 file | grep -e "executable" -e "shared object" | grep ELF \ | cut -f 1 -d : | xargs strip --strip-unneeded 2> /dev/null || true +# 20230722 bkw: prebuilt man pages. +mkdir -p $PKG/usr/man/man1 +for i in $CWD/man/*; do + gzip -9c < $i > $PKG/usr/man/man1/$( basename $i ).gz +done + mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION cp -a AUTHORS ChangeLog COPYING README.md VERSION \ $PKG/usr/doc/$PRGNAM-$VERSION diff --git a/libraries/aubio/man/aubio.1 b/libraries/aubio/man/aubio.1 new file mode 100644 index 000000000000..7076e42229b7 --- /dev/null +++ b/libraries/aubio/man/aubio.1 @@ -0,0 +1,208 @@ +.\" Text automatically generated by txt2man +.TH AUBIO 1 "22 July 2023" "aubio 0.4.9" "aubio User's manual" +.SH NAME +\fBaubio \fP- a command line tool to extract information from sound files +\fB +.SH SYNOPSIS +.nf +.fam C + +\fBaubio\fP [\fB-h\fP] [\fB-V\fP] <command> \.\.\. + +.fam T +.fi +.fam T +.fi +.SH COMMANDS + +The general syntax is "\fBaubio\fP <command> <soundfile> [options]". The following +commands are available: +.TP +.B +onset +get onset times +.TP +.B +pitch +extract fundamental frequency +.TP +.B +beat +get locations of beats +.TP +.B +tempo +get overall tempo in bpm +.TP +.B +notes +get midi-like notes +.TP +.B +mfcc +extract mel-frequency cepstrum coefficients +.TP +.B +melbands +extract mel-frequency energies per band +.PP +For a list of available commands, use "\fBaubio\fP \fB-h\fP". For more info about each +command, use "\fBaubio\fP <command> \fB--help\fP". +.SH GENERAL OPTIONS + +These options can be used before any command has been specified. +.TP +.B +\fB-h\fP, \fB--help\fP +show help message and exit +.TP +.B +\fB-V\fP, \fB--version\fP +show version +.SH COMMON OPTIONS + +The following options can be used with all commands: +.TP +.B +<source_uri>, \fB-i\fP <source_uri>, \fB--input\fP <source_uri> +input sound file to +analyse (required) +.TP +.B +\fB-r\fP <freq>, \fB--samplerate\fP <freq> +samplerate at which the file should be +represented (default: 0, e.g. samplerate of the input sound) +.TP +.B +\fB-H\fP <size>, \fB--hopsize\fP <size> +overlap size, number of samples between two +consecutive analysis (default: 256) +.TP +.B +\fB-B\fP <size>, \fB--bufsize\fP <size> +buffer size, number of samples used for each +analysis, (e.g. FFT length, default: 512) +.TP +.B +\fB-h\fP, \fB--help\fP +show help message and exit +.TP +.B +\fB-T\fP format, \fB--time-format\fP format +select time values output format (samples, +ms, seconds) (default: seconds) +.TP +.B +\fB-v\fP, \fB--verbose\fP +be verbose (increment verbosity by 1, default: 1) +.TP +.B +\fB-q\fP, \fB--quiet\fP +be quiet (set verbosity to 0) +.SH ONSET + +The following additional options can be used with the "onset" subcommand. +.TP +.B +\fB-m\fP <method>, \fB--method\fP <method> +onset novelty function +<default|energy|hfc|complex|phase|specdiff|kl|mkl|specflux> (default: +default) +.TP +.B +\fB-t\fP <threshold>, \fB--threshold\fP <threshold> +threshold (default: unset) +.TP +.B +\fB-s\fP <value>, \fB--silence\fP <value> +silence threshold, in dB (default: \fB-70\fP) +.TP +.B +\fB-M\fP <value>, \fB--minioi\fP <value> +minimum Inter-Onset Interval (default: 12ms) +.SH PITCH + +The following additional options can be used with the "pitch" subcommand. +.TP +.B +\fB-m\fP <method>, \fB--method\fP <method> +pitch detection method +<default|yinfft|yin|mcomb|fcomb|schmitt> (default: default, e.g. yinfft) +.TP +.B +\fB-t\fP <threshold>, \fB--threshold\fP <threshold> +tolerance (default: unset) +.TP +.B +\fB-s\fP <value>, \fB--silence\fP <value> +silence threshold, in dB (default: \fB-70\fP) +.PP +The default buffer size for the beat algorithm is 2048. The default hop size +is 256. +.SH BEAT + +The "beat" command accepts all common options and no additional options. +.PP +The default buffer size for the beat algorithm is 1024. The default hop size +is 512. +.SH TEMPO + +The "tempo" command accepts all common options and no additional options. +.PP +The default buffer size for the beat algorithm is 1024. The default hop size +is 512. +.SH NOTES + +The following additional options can be used with the "notes" subcommand. +.TP +.B +\fB-s\fP <value>, \fB--silence\fP <value> +silence threshold, in dB (default: \fB-70\fP) +.TP +.B +\fB-d\fP <value>, \fB--release-drop\fP <value> +release drop level, in dB. If the level +drops more than this amount since the last note started, the note will be +turned off (default: 10). +.SH MFCC + +The "mfcc" command accepts all common options and no additional options. +.SH MELBANDS + +The "melbands" command accepts all common options and no additional options. +.SH EXAMPLES + +Extract onsets using a minimum inter-onset interval of 30ms: +.PP +.nf +.fam C + aubio onset /path/to/input_file -M 30ms + +.fam T +.fi +Extract pitch with method "mcomb" and a silence threshold of \fB-90dB\fP: +.PP +.nf +.fam C + aubio pitch /path/to/input_file -m mcomb -s -90.0 + +.fam T +.fi +Extract MFCC using the standard Slaney implementation: +.PP +.nf +.fam C + aubio mfcc /path/to/input_file -r 44100 + + +.fam T +.fi +.SH SEE ALSO + +\fBaubiocut\fP(1) +.SH AUTHOR + +This manual page was written by Paul Brossier <piem@aubio.org>. 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/libraries/aubio/man/aubiocut.1 b/libraries/aubio/man/aubiocut.1 new file mode 100644 index 000000000000..c9c887366fac --- /dev/null +++ b/libraries/aubio/man/aubiocut.1 @@ -0,0 +1,124 @@ +.\" Text automatically generated by txt2man +.TH AUBIOCUT 1 "22 July 2023" "aubio 0.4.9" "aubio User's manual" +.SH NAME +\fBaubiocut \fP- a command line tool to slice sound files at onset or beat timestamps +\fB +.SH SYNOPSIS +.nf +.fam C + +\fBaubiocut\fP \fIsource\fP +\fBaubiocut\fP [[\fB-i\fP] \fIsource\fP] + [\fB-r\fP \fIrate\fP] [\fB-B\fP \fIwin\fP] [\fB-H\fP \fIhop\fP] + [\fB-O\fP \fImethod\fP] [\fB-t\fP \fIthres\fP] + [\fB-b\fP] [\fB-c\fP] + [\fB-v\fP] [\fB-q\fP] [\fB-h\fP] + +.fam T +.fi +.fam T +.fi +.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 +\fB-i\fP, \fB--input\fP \fIsource\fP +Run analysis on this audio file. Most uncompressed and +compressed are supported, depending on how aubio was built. +.TP +.B +\fB-r\fP, \fB--samplerate\fP \fIrate\fP +Fetch the input \fIsource\fP, resampled at the given +sampling \fIrate\fP. The \fIrate\fP should be specified in Hertz as an integer. If set +to 0, the sampling \fIrate\fP of the original \fIsource\fP will be used. Defaults to 0. +.TP +.B +\fB-B\fP, \fB--bufsize\fP \fIwin\fP +The size of the buffer to analyze, that is the length +of the window used for spectral and temporal computations. Defaults to 512. +.TP +.B +\fB-H\fP, \fB--hopsize\fP \fIhop\fP +The number of samples between two consecutive analysis. +Defaults to 256. +.TP +.B +\fB-O\fP, \fB--onset\fP \fImethod\fP +The onset detection \fImethod\fP to use. See ONSET METHODS +below. Defaults to 'default'. +.TP +.B +\fB-b\fP, \fB--beat\fP +Use beat locations instead of onset locations. +.TP +.B +\fB-t\fP, \fB--onset-threshold\fP \fIthres\fP +Set the threshold value for the onset peak +picking. Values are typically in the range [0.001, 0.900]. Lower threshold +values imply more onsets detected. Increasing this threshold should reduce +the number of incorrect detections. Defaults to 0.3. +.TP +.B +\fB-c\fP, \fB--cut\fP +Cut input sound file at detected labels. A new sound files for +each slice will be created in the current directory. +.TP +.B +\fB-o\fP, \fB--output\fP directory +Specify the directory path where slices of the +original \fIsource\fP should be created. +.TP +.B +\fB--cut-until-nsamples\fP n +How many extra samples should be added at the end of +each slice (default 0). +.TP +.B +\fB--cut-until-nslices\fP n +How many extra slices should be added at the end of +each slice (default 0). +.TP +.B +\fB--create-first\fP +Alway create first slice. +.TP +.B +\fB-h\fP, \fB--help\fP +Print a short help message and exit. +.TP +.B +\fB-v\fP, \fB--verbose\fP +Be verbose. +.TP +.B +\fB-q\fP, \fB--quiet\fP +Be quiet. +.RE +.PP + +.SH ONSET METHODS + +Available methods: default, energy, hfc, complex, phase, specdiff, kl, mkl, +specflux. +.PP +See \fBaubioonset\fP(1) for details about these methods. +.RE +.PP + +.SH SEE ALSO + +\fBaubioonset\fP(1), +\fBaubiopitch\fP(1), +\fBaubiotrack\fP(1), +\fBaubionotes\fP(1), +\fBaubioquiet\fP(1), +and +\fBaubiomfcc\fP(1). +.SH AUTHOR + +This manual page was written by Paul Brossier <piem@aubio.org>. 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/libraries/aubio/man/aubiomfcc.1 b/libraries/aubio/man/aubiomfcc.1 new file mode 100644 index 000000000000..e8f21ea7f052 --- /dev/null +++ b/libraries/aubio/man/aubiomfcc.1 @@ -0,0 +1,89 @@ +.\" Text automatically generated by txt2man +.TH AUBIOMFCC 1 "22 July 2023" "aubio 0.4.9" "aubio User's manual" +.SH NAME +\fBaubiomfcc \fP- a command line tool to compute Mel-Frequency Cepstrum Coefficients +\fB +.SH SYNOPSIS +.nf +.fam C + +\fBaubiomfcc\fP \fIsource\fP +\fBaubiomfcc\fP [[\fB-i\fP] \fIsource\fP] + [\fB-r\fP \fIrate\fP] [\fB-B\fP \fIwin\fP] [\fB-H\fP \fIhop\fP] + [\fB-T\fP \fItime-format\fP] + [\fB-v\fP] [\fB-h\fP] + +.fam T +.fi +.fam T +.fi +.SH DESCRIPTION + +\fBaubiomfcc\fP compute the Mel-Frequency Cepstrum Coefficients (MFCC). +.PP +MFCCs are coefficients that make up for the mel-frequency spectrum, a +representation of the short-term power spectrum of a sound. By default, 13 +coefficients are computed using 40 filters. +.PP +When started with an input \fIsource\fP (\fB-i\fP/\fB--input\fP), the coefficients are given on +the console, prefixed by their timestamps in seconds. +.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 +\fB-i\fP, \fB--input\fP \fIsource\fP +Run analysis on this audio file. Most uncompressed and +compressed are supported, depending on how aubio was built. +.TP +.B +\fB-r\fP, \fB--samplerate\fP \fIrate\fP +Fetch the input \fIsource\fP, resampled at the given +sampling \fIrate\fP. The \fIrate\fP should be specified in Hertz as an integer. If 0, +the sampling \fIrate\fP of the original \fIsource\fP will be used. Defaults to 0. +.TP +.B +\fB-B\fP, \fB--bufsize\fP \fIwin\fP +The size of the buffer to analyze, that is the length +of the window used for spectral and temporal computations. Defaults to 512. +.TP +.B +\fB-H\fP, \fB--hopsize\fP \fIhop\fP +The number of samples between two consecutive analysis. +Defaults to 256. +.TP +.B +\fB-T\fP, \fB--timeformat\fP format +Set time format (samples, ms, seconds). Defaults to +seconds. +.TP +.B +\fB-h\fP, \fB--help\fP +Print a short help message and exit. +.TP +.B +\fB-v\fP, \fB--verbose\fP +Be verbose. +.SH REFERENCES + +Using the default parameters, the filter coefficients will be computed +according to Malcolm Slaney's Auditory Toolbox, available at the following +url: +.PP +https://engineering.purdue.edu/~malcolm/interval/1998-010/ (see file mfcc.m) +.SH SEE ALSO + +\fBaubioonset\fP(1), +\fBaubiopitch\fP(1), +\fBaubiotrack\fP(1), +\fBaubionotes\fP(1), +\fBaubioquiet\fP(1), +and +\fBaubiocut\fP(1). +.SH AUTHOR + +This manual page was written by Paul Brossier <piem@aubio.org>. 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/libraries/aubio/man/aubionotes.1 b/libraries/aubio/man/aubionotes.1 new file mode 100644 index 000000000000..88c93620b2ca --- /dev/null +++ b/libraries/aubio/man/aubionotes.1 @@ -0,0 +1,149 @@ +.\" Text automatically generated by txt2man +.TH AUBIONOTES 1 "22 July 2023" "aubio 0.4.9" "aubio User's manual" +.SH NAME +\fBaubionotes \fP- a command line tool to extract musical notes +\fB +.SH SYNOPSIS +.nf +.fam C + +\fBaubionotes\fP \fIsource\fP +\fBaubionotes\fP [[\fB-i\fP] \fIsource\fP] + [\fB-r\fP \fIrate\fP] [\fB-B\fP \fIwin\fP] [\fB-H\fP \fIhop\fP] + [\fB-O\fP \fImethod\fP] [\fB-t\fP \fIthres\fP] [\fB-d\fP \fIdrop\fP] + [\fB-p\fP \fImethod\fP] [\fB-u\fP \fIunit\fP] [\fB-l\fP \fIthres\fP] + [\fB-T\fP \fItime-format\fP] + [\fB-s\fP \fIsil\fP] + [\fB-j\fP] [\fB-v\fP] [\fB-h\fP] + +.fam T +.fi +.fam T +.fi +.SH DESCRIPTION + +\fBaubionotes\fP 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. +.PP +When started with an input \fIsource\fP (\fB-i\fP/\fB--input\fP), the detected notes are +printed on standard output, in seconds and midi note number. +.PP +When started without an input \fIsource\fP, or with the jack option (\fB-j\fP/\fB--jack\fP), +\fBaubionotes\fP starts in jack mode. +.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 +\fB-i\fP, \fB--input\fP \fIsource\fP +Run analysis on this audio file. Most uncompressed and +compressed are supported, depending on how aubio was built. +.TP +.B +\fB-r\fP, \fB--samplerate\fP \fIrate\fP +Fetch the input \fIsource\fP, resampled at the given +sampling \fIrate\fP. The \fIrate\fP should be specified in Hertz as an integer. If 0, +the sampling \fIrate\fP of the original \fIsource\fP will be used. Defaults to 0. +.TP +.B +\fB-B\fP, \fB--bufsize\fP \fIwin\fP +The size of the buffer to analyze, that is the length +of the window used for spectral and temporal computations. Defaults to 512. +.TP +.B +\fB-H\fP, \fB--hopsize\fP \fIhop\fP +The number of samples between two consecutive analysis. +Defaults to 256. +.TP +.B +\fB-O\fP, \fB--onset\fP \fImethod\fP +The onset detection \fImethod\fP to use. See ONSET METHODS +below. Defaults to 'default'. +.TP +.B +\fB-t\fP, \fB--onset-threshold\fP \fIthres\fP +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. +.TP +.B +\fB-M\fP, \fB--minioi\fP value +Set the minimum inter-onset interval, in seconds, the +shortest interval between two consecutive notes. Defaults to 0.030 +.TP +.B +\fB-p\fP, \fB--pitch\fP \fImethod\fP +The pitch detection \fImethod\fP to use. See PITCH METHODS +below. Defaults to 'default'. +.TP +.B +\fB-u\fP, \fB--pitch\fP-\fIunit\fP \fIunit\fP +The \fIunit\fP to be used to print frequencies. Possible +values include midi, bin, cent, and Hz. Defaults to 'Hz'. +.TP +.B +\fB-l\fP, \fB--pitch-tolerance\fP \fIthres\fP +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. +.TP +.B +\fB-s\fP, \fB--silence\fP \fIsil\fP +Set the silence threshold, in dB, under which the pitch +will not be detected. A value of \fB-20.0\fP would eliminate most onsets but the +loudest ones. A value of \fB-90.0\fP would select all onsets. Defaults to \fB-90.0\fP. +.TP +.B +\fB-d\fP, \fB--release\fP-\fIdrop\fP +Set the release \fIdrop\fP threshold, in dB. If the level drops +more than this amount since the last note started, the note will be turned +off. Defaults to 10. +.TP +.B +\fB-T\fP, \fB--timeformat\fP format +Set time format (samples, ms, seconds). Defaults to +seconds. +.TP +.B +\fB-j\fP, \fB--jack\fP +Use Jack input/output. You will need a Jack connection +controller to feed aubio some signal and listen to its output. +.TP +.B +\fB-h\fP, \fB--help\fP +Print a short help message and exit. +.TP +.B +\fB-v\fP, \fB--verbose\fP +Be verbose. +.SH ONSET METHODS + +Available methods: default, energy, hfc, complex, phase, specdiff, kl, mkl, +specflux. +.PP +See \fBaubioonset\fP(1) for details about these methods. +.SH PITCH METHODS + +Available methods: default, schmitt, fcomb, mcomb, specacf, yin, yinfft, +yinfast. +.PP +See \fBaubiopitch\fP(1) for details about these methods. +.SH SEE ALSO + +\fBaubioonset\fP(1), +\fBaubiopitch\fP(1), +\fBaubiotrack\fP(1), +\fBaubioquiet\fP(1), +\fBaubiomfcc\fP(1), +and +\fBaubiocut\fP(1). +.SH AUTHOR + +This manual page was written by Paul Brossier <piem@aubio.org>. 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/libraries/aubio/man/aubioonset.1 b/libraries/aubio/man/aubioonset.1 new file mode 100644 index 000000000000..1edcc52d62e0 --- /dev/null +++ b/libraries/aubio/man/aubioonset.1 @@ -0,0 +1,223 @@ +.\" Text automatically generated by txt2man +.TH AUBIOONSET 1 "22 July 2023" "aubio 0.4.9" "aubio User's manual" +.SH NAME +\fBaubioonset \fP- a command line tool to extract musical onset times +\fB +.SH SYNOPSIS +.nf +.fam C + +\fBaubioonset\fP \fIsource\fP +\fBaubioonset\fP [[\fB-i\fP] \fIsource\fP] [\fB-o\fP \fIsink\fP] + [\fB-r\fP \fIrate\fP] [\fB-B\fP \fIwin\fP] [\fB-H\fP \fIhop\fP] + [\fB-O\fP \fImethod\fP] [\fB-t\fP \fIthres\fP] + [\fB-T\fP \fItime-format\fP] + [\fB-s\fP \fIsil\fP] [\fB-m\fP] [\fB-f\fP] + [\fB-j\fP] [\fB-N\fP \fImiditap-note\fP] [\fB-V\fP \fImiditap-velo\fP] + [\fB-v\fP] [\fB-h\fP] + +.fam T +.fi +.fam T +.fi +.SH DESCRIPTION + +\fBaubioonset\fP attempts to detect onset times, the beginning of discrete sound +events, in audio signals. +.PP +When started with an input \fIsource\fP (\fB-i\fP/\fB--input\fP), the detected onset times are +given on the console, in seconds. +.PP +When started without an input \fIsource\fP, or with the jack option (\fB-j\fP/\fB--jack\fP), +\fBaubioonset\fP starts in jack mode. +.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 +\fB-i\fP, \fB--input\fP \fIsource\fP +Run analysis on this audio file. Most uncompressed and +compressed are supported, depending on how aubio was built. +.TP +.B +\fB-o\fP, \fB--output\fP \fIsink\fP +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. +.TP +.B +\fB-r\fP, \fB--samplerate\fP \fIrate\fP +Fetch the input \fIsource\fP, resampled at the given +sampling \fIrate\fP. The \fIrate\fP should be specified in Hertz as an integer. If 0, +the sampling \fIrate\fP of the original \fIsource\fP will be used. Defaults to 0. +.TP +.B +\fB-B\fP, \fB--bufsize\fP \fIwin\fP +The size of the buffer to analyze, that is the length +of the window used for spectral and temporal computations. Defaults to 512. +.TP +.B +\fB-H\fP, \fB--hopsize\fP \fIhop\fP +The number of samples between two consecutive analysis. +Defaults to 256. +.TP +.B +\fB-O\fP, \fB--onset\fP \fImethod\fP +The onset detection \fImethod\fP to use. See ONSET METHODS +below. Defaults to 'default'. +.TP +.B +\fB-t\fP, \fB--onset-threshold\fP \fIthres\fP +Set the threshold value for the onset peak +picking. Values are typically in the range [0.001, 0.900]. Lower threshold +values imply more onsets detected. Increasing this threshold should reduce +the number of incorrect detections. Defaults to 0.3. +.TP +.B +\fB-M\fP, \fB--minioi\fP value +Set the minimum inter-onset interval, in seconds, the +shortest interval between two consecutive onsets. Defaults to 0.020 +.TP +.B +\fB-s\fP, \fB--silence\fP \fIsil\fP +Set the silence threshold, in dB, under which the onset +will not be detected. A value of \fB-20.0\fP would eliminate most onsets but the +loudest ones. A value of \fB-90.0\fP would select all onsets. Defaults to \fB-90.0\fP. +.TP +.B +\fB-T\fP, \fB--timeformat\fP format +Set time format (samples, ms, seconds). Defaults to +seconds. +.TP +.B +\fB-m\fP, \fB--mix-input\fP +Mix \fIsource\fP signal to the output signal before writing to +\fIsink\fP. +.TP +.B +\fB-f\fP, \fB--force-overwrite\fP +Overwrite output file if it already exists. +.TP +.B +\fB-j\fP, \fB--jack\fP +Use Jack input/output. You will need a Jack connection +controller to feed aubio some signal and listen to its output. +.TP +.B +\fB-N\fP, --\fImiditap-note\fP +Override note value for MIDI tap. Defaults to 69. +.TP +.B +\fB-V\fP, \fB--miditap-velop\fP +Override velocity value for MIDI tap. Defaults to 65. +.TP +.B +\fB-h\fP, \fB--help\fP +Print a short help message and exit. +.TP +.B +\fB-v\fP, \fB--verbose\fP +Be verbose. +.SH ONSET METHODS + +Available methods are: +.TP +.B +default +Default distance, currently hfc +.PP +Default: 'default' (currently set to hfc) +.TP +.B +energy +Energy based distance +.PP +This function calculates the local energy of the input spectral frame. +.TP +.B +hfc +High-Frequency content +.PP +This \fImethod\fP computes the High Frequency Content (HFC) of the input +spectral frame. The resulting function is efficient at detecting +percussive onsets. +.PP +Paul Masri. Computer modeling of Sound for Transformation and Synthesis of +Musical Signal. PhD dissertation, University of Bristol, UK, 1996. +.TP +.B +complex +Complex domain onset detection function +.PP +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. +.TP +.B +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. +.TP +.B +phase +Phase based onset detection function +.PP +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. +.TP +.B +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 441444, +Hong-Kong, 2003. +.TP +.B +specdiff +Spectral difference onset detection function +.PP +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 881884, Tokyo, Japan, August 2001. +.TP +.B +kl +Kulback-Liebler onset detection function +.PP +Stephen Hainsworth and Malcom Macleod. Onset detection in music audio +signals. In Proceedings of the International Computer Music Conference +(ICMC), Singapore, 2003. +.TP +.B +mkl +Modified Kulback-Liebler onset detection function +.PP +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. +.TP +.B +specflux +Spectral flux +.PP +Simon Dixon, Onset Detection Revisited, in ``Proceedings of the 9th +International Conference on Digital Audio Effects'' (DAFx-06), Montreal, +Canada, 2006. +.SH SEE ALSO + +\fBaubiopitch\fP(1), +\fBaubiotrack\fP(1), +\fBaubionotes\fP(1), +\fBaubioquiet\fP(1), +\fBaubiomfcc\fP(1), +and +\fBaubiocut\fP(1). +.SH AUTHOR + +This manual page was written by Paul Brossier <piem@aubio.org>. 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/libraries/aubio/man/aubiopitch.1 b/libraries/aubio/man/aubiopitch.1 new file mode 100644 index 000000000000..fe0fea2f77e8 --- /dev/null +++ b/libraries/aubio/man/aubiopitch.1 @@ -0,0 +1,194 @@ +.\" Text automatically generated by txt2man +.TH AUBIOPITCH 1 "22 July 2023" "aubio 0.4.9" "aubio User's manual" +.SH NAME +\fBaubiopitch \fP- a command line tool to extract musical pitch +\fB +.SH SYNOPSIS +.nf +.fam C + +\fBaubiopitch\fP \fIsource\fP +\fBaubiopitch\fP [[\fB-i\fP] \fIsource\fP] [\fB-o\fP \fIsink\fP] + [\fB-r\fP \fIrate\fP] [\fB-B\fP \fIwin\fP] [\fB-H\fP \fIhop\fP] + [\fB-p\fP \fImethod\fP] [\fB-u\fP \fIunit\fP] [\fB-l\fP \fIthres\fP] + [\fB-T\fP \fItime-format\fP] + [\fB-s\fP \fIsil\fP] [\fB-f\fP] + [\fB-v\fP] [\fB-h\fP] [\fB-j\fP] + +.fam T +.fi +.fam T +.fi +.SH DESCRIPTION + +\fBaubiopitch\fP attempts to detect the pitch, the perceived height of a musical +note. +.PP +When started with an input \fIsource\fP (\fB-i\fP/\fB--input\fP), the detected pitch are +printed on the console, prefixed by a timestamp in seconds. If no pitch +candidate is found, the output is 0. +.PP +When started without an input \fIsource\fP, or with the jack option (\fB-j\fP/\fB--jack\fP), +\fBaubiopitch\fP starts in jack mode. +.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 +\fB-i\fP, \fB--input\fP \fIsource\fP +Run analysis on this audio file. Most uncompressed and +compressed are supported, depending on how aubio was built. +.TP +.B +\fB-o\fP, \fB--output\fP \fIsink\fP +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. +.TP +.B +\fB-r\fP, \fB--samplerate\fP \fIrate\fP +Fetch the input \fIsource\fP, resampled at the given +sampling \fIrate\fP. The \fIrate\fP should be specified in Hertz as an integer. If 0, +the sampling \fIrate\fP of the original \fIsource\fP will be used. Defaults to 0. +.TP +.B +\fB-B\fP, \fB--bufsize\fP \fIwin\fP +The size of the buffer to analyze, that is the length +of the window used for spectral and temporal computations. Defaults to 2048. +.TP +.B +\fB-H\fP, \fB--hopsize\fP \fIhop\fP +The number of samples between two consecutive analysis. +Defaults to 256. +.TP +.B +\fB-p\fP, \fB--pitch\fP \fImethod\fP +The pitch detection \fImethod\fP to use. See PITCH METHODS +below. Defaults to 'default'. +.TP +.B +\fB-u\fP, \fB--pitch\fP-\fIunit\fP \fIunit\fP +The \fIunit\fP to be used to print frequencies. Possible +values include midi, bin, cent, and Hz. Defaults to 'Hz'. +.TP +.B +\fB-l\fP, \fB--pitch-tolerance\fP \fIthres\fP +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. +.TP +.B +\fB-s\fP, \fB--silence\fP \fIsil\fP +Set the silence threshold, in dB, under which the onset +will not be detected. A value of \fB-20.0\fP would eliminate most onsets but the +loudest ones. A value of \fB-90.0\fP would select all onsets. Defaults to \fB-90.0\fP. +.TP +.B +\fB-T\fP, \fB--timeformat\fP format +Set time format (samples, ms, seconds). Defaults to +seconds. +.TP +.B +\fB-m\fP, \fB--mix-input\fP +Mix \fIsource\fP signal to the output signal before writing to +\fIsink\fP. +.TP +.B +\fB-f\fP, \fB--force-overwrite\fP +Overwrite output file if it already exists. +.TP +.B +\fB-j\fP, \fB--jack\fP +Use Jack input/output. You will need a Jack connection +controller to feed aubio some signal and listen to its output. +.TP +.B +\fB-h\fP, \fB--help\fP +Print a short help message and exit. +.TP +.B +\fB-v\fP, \fB--verbose\fP +Be verbose. +.SH PITCH METHODS + +Available methods are: +.TP +.B +default +use the default \fImethod\fP +.PP +Currently, the default \fImethod\fP is set to yinfft. +.TP +.B +schmitt +Schmitt trigger +.PP +This pitch extraction \fImethod\fP implements a Schmitt trigger to estimate the +period of a signal. It is computationally very inexpensive, but also very +sensitive to noise. +.TP +.B +fcomb +a fast harmonic comb filter +.PP +This pitch extraction \fImethod\fP implements a fast harmonic comb filter to +determine the fundamental frequency of a harmonic sound. +.TP +.B +mcomb +multiple-comb filter +.PP +This fundamental frequency estimation algorithm implements spectral +flattening, multi-comb filtering and peak histogramming. +.TP +.B +specacf +Spectral auto-correlation function +.TP +.B +yin +YIN algorithm +.PP +This algorithm was developed by A. de Cheveigne and H. Kawahara and +was first published in: +.PP +De Cheveigné, A., Kawahara, H. (2002) "YIN, a fundamental frequency +estimator for speech and music", J. Acoust. Soc. Am. 111, 1917-1930. +.TP +.B +yinfft +Yinfft algorithm +.PP +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. +.PP +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. +.TP +.B +yinfast +YIN algorithm (accelerated) +.PP +An optimised implementation of the YIN algorithm, yielding results identical +to the original YIN algorithm, while reducing its computational cost from +\fBO\fP(n^2) to \fBO\fP(n \fBlog\fP(n)). +.SH SEE ALSO + +\fBaubioonset\fP(1), +\fBaubiotrack\fP(1), +\fBaubionotes\fP(1), +\fBaubioquiet\fP(1), +\fBaubiomfcc\fP(1), +and +\fBaubiocut\fP(1). +.SH AUTHOR + +This manual page was written by Paul Brossier <piem@aubio.org>. 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/libraries/aubio/man/aubioquiet.1 b/libraries/aubio/man/aubioquiet.1 new file mode 100644 index 000000000000..b8f8ac340a46 --- /dev/null +++ b/libraries/aubio/man/aubioquiet.1 @@ -0,0 +1,92 @@ +.\" Text automatically generated by txt2man +.TH AUBIOQUIET 1 "22 July 2023" "aubio 0.4.9" "aubio User's manual" +.SH NAME +\fBaubioquiet \fP- a command line tool to extracts quiet and loud regions from a file +\fB +.SH SYNOPSIS +.nf +.fam C + +\fBaubioquiet\fP \fIsource\fP +\fBaubioquiet\fP [[\fB-i\fP] \fIsource\fP] + [\fB-r\fP \fIrate\fP] [\fB-B\fP \fIwin\fP] [\fB-H\fP \fIhop\fP] + [\fB-T\fP \fItime-format\fP] + [\fB-s\fP \fIsil\fP] + [\fB-v\fP] [\fB-h\fP] + +.fam T +.fi +.fam T +.fi +.SH DESCRIPTION + +\fBaubioquiet\fP will print a timestamp each time it detects a new silent region or +a new loud region in a sound file. +.PP +When started with an input \fIsource\fP (\fB-i\fP/\fB--input\fP), the detected timestamps are +printed on the console, in seconds. +.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 +\fB-i\fP, \fB--input\fP \fIsource\fP +Run analysis on this audio file. Most uncompressed and +compressed are supported, depending on how aubio was built. +.TP +.B +\fB-r\fP, \fB--samplerate\fP \fIrate\fP +Fetch the input \fIsource\fP, resampled at the given +sampling \fIrate\fP. The \fIrate\fP should be specified in Hertz as an integer. If 0, +the sampling \fIrate\fP of the original \fIsource\fP will be used. Defaults to 0. +.TP +.B +\fB-B\fP, \fB--bufsize\fP \fIwin\fP +The size of the buffer to analyze, that is the length +of the window used for spectral and temporal computations. Defaults to 512. +.TP +.B +\fB-H\fP, \fB--hopsize\fP \fIhop\fP +The number of samples between two consecutive analysis. +Defaults to 256. +.TP +.B +\fB-s\fP, \fB--silence\fP \fIsil\fP +Set the silence threshold, in dB, under which the pitch +will not be detected. Defaults to \fB-90.0\fP. +.TP +.B +\fB-T\fP, \fB--timeformat\fP format +Set time format (samples, ms, seconds). Defaults to +seconds. +.TP +.B +\fB-h\fP, \fB--help\fP +Print a short help message and exit. +.TP +.B +\fB-v\fP, \fB--verbose\fP +Be verbose. +.SH EXAMPLE OUTPUT + +.SS NOISY: 28.775330 + +.SS QUIET: 28.914648 + + +.SH SEE ALSO + +\fBaubioonset\fP(1), +\fBaubiopitch\fP(1), +\fBaubiotrack\fP(1), +\fBaubionotes\fP(1), +\fBaubiomfcc\fP(1), +and +\fBaubiocut\fP(1). +.SH AUTHOR + +This manual page was written by Paul Brossier <piem@aubio.org>. 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/libraries/aubio/man/aubiotrack.1 b/libraries/aubio/man/aubiotrack.1 new file mode 100644 index 000000000000..46a623c53010 --- /dev/null +++ b/libraries/aubio/man/aubiotrack.1 @@ -0,0 +1,129 @@ +.\" Text automatically generated by txt2man +.TH AUBIOTRACK 1 "22 July 2023" "aubio 0.4.9" "aubio User's manual" +.SH NAME +\fBaubiotrack \fP- a command line tool to extract musical beats from audio signals +\fB +.SH SYNOPSIS +.nf +.fam C + +\fBaubiotrack\fP \fIsource\fP +\fBaubiotrack\fP [[\fB-i\fP] \fIsource\fP] [\fB-o\fP \fIsink\fP] + [\fB-r\fP \fIrate\fP] [\fB-B\fP \fIwin\fP] [\fB-H\fP \fIhop\fP] + [\fB-T\fP \fItime-format\fP] + [\fB-s\fP \fIsil\fP] [\fB-m\fP] + [\fB-j\fP] [\fB-N\fP \fImiditap-note\fP] [\fB-V\fP \fImiditap-velo\fP] + [\fB-v\fP] [\fB-h\fP] + +.fam T +.fi +.fam T +.fi +.SH DESCRIPTION + +\fBaubiotrack\fP attempts to detect beats, the time where one would intuitively be +tapping his foot. +.PP +When started with an input \fIsource\fP (\fB-i\fP/\fB--input\fP), the detected beats are given +on the console, in seconds. +.PP +When started without an input \fIsource\fP, or with the jack option (\fB-j\fP/\fB--jack\fP), +\fBaubiotrack\fP starts in jack mode. +.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 +\fB-i\fP, \fB--input\fP \fIsource\fP +Run analysis on this audio file. Most uncompressed and +compressed are supported, depending on how aubio was built. +.TP +.B +\fB-o\fP, \fB--output\fP \fIsink\fP +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. +.TP +.B +\fB-r\fP, \fB--samplerate\fP \fIrate\fP +Fetch the input \fIsource\fP, resampled at the given +sampling \fIrate\fP. The \fIrate\fP should be specified in Hertz as an integer. If 0, +the sampling \fIrate\fP of the original \fIsource\fP will be used. Defaults to 0. +.TP +.B +\fB-B\fP, \fB--bufsize\fP \fIwin\fP +The size of the buffer to analyze, that is the length +of the window used for spectral and temporal computations. Defaults to 512. +.TP +.B +\fB-H\fP, \fB--hopsize\fP \fIhop\fP +The number of samples between two consecutive analysis. +Defaults to 256. +.TP +.B +\fB-s\fP, \fB--silence\fP \fIsil\fP +Set the silence threshold, in dB, under which the pitch +will not be detected. A value of \fB-20.0\fP would eliminate most onsets but the +loudest ones. A value of \fB-90.0\fP would select all onsets. Defaults to \fB-90.0\fP. +.TP +.B +\fB-m\fP, \fB--mix-input\fP +Mix \fIsource\fP signal to the output signal before writing to +\fIsink\fP. +.TP +.B +\fB-f\fP, \fB--force-overwrite\fP +Overwrite output file if it already exists. +.TP +.B +\fB-j\fP, \fB--jack\fP +Use Jack input/output. You will need a Jack connection +controller to feed aubio some signal and listen to its output. +.TP +.B +\fB-N\fP, --\fImiditap-note\fP +Override note value for MIDI tap. Defaults to 69. +.TP +.B +\fB-V\fP, \fB--miditap-velop\fP +Override velocity value for MIDI tap. Defaults to 65. +.TP +.B +\fB-T\fP, \fB--timeformat\fP format +Set time format (samples, ms, seconds). Defaults to +seconds. +.TP +.B +\fB-h\fP, \fB--help\fP +Print a short help message and exit. +.TP +.B +\fB-v\fP, \fB--verbose\fP +Be verbose. +.SH BEAT TRACKING METHODS + +Aubio currently implements one the causal beat tracking algorithm designed by +Matthew Davies and described in the following articles: +.PP +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 164169, Barcelona, Spain, 2004. +.PP +Matthew E. P. Davies, Paul Brossier, and Mark D. Plumbley. Beat tracking +towards automatic musical accompaniment. In Proceedings of the Audio +Engineering Society 118th Convention, Barcelona, Spain, May 2005. +.SH SEE ALSO + +\fBaubioonset\fP(1), +\fBaubiopitch\fP(1), +\fBaubionotes\fP(1), +\fBaubioquiet\fP(1), +\fBaubiomfcc\fP(1), +and +\fBaubiocut\fP(1). +.SH AUTHOR + +This manual page was written by Paul Brossier <piem@aubio.org>. 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. |