1 files changed, 129 insertions, 0 deletions
diff --git a/libraries/aubio/man/aubiotrack.1 b/libraries/aubio/man/aubiotrack.1
new file mode 100644
index 0000000000..46a623c530
--- /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.