1e7eb72b1bf346329f85ede53159674ce6f6444a
[aubio.git] / doc / aubiotrack.txt
1 NAME
2   aubiotrack - a command line tool to extract musical beats from audio signals
3
4 SYNOPSIS
5
6   aubiotrack source
7   aubiotrack [[-i] source] [-o sink]
8              [-r rate] [-B win] [-H hop]
9              [-s sil] [-m]
10              [-j] [-v] [-h]
11
12 DESCRIPTION
13
14   aubiotrack attempts to detect beats, the time where one would intuitively be
15   tapping his foot.
16
17   When started with an input source (-i/--input), the detected beats are given
18   on the console, in seconds.
19
20   When started without an input source, or with the jack option (-j/--jack),
21   aubiotrack starts in jack mode.
22
23 OPTIONS
24
25   This program follows the usual GNU command line syntax, with long options
26   starting with two dashes (--). A summary of options is included below.
27
28   -i, --input source  Run analysis on this audio file. Most uncompressed and
29   compressed are supported, depending on how aubio was built.
30
31   -o, --output sink  Save results in this file. The file will be created on the
32   model of the input file. Beats are marked by a short wood-block like sound.
33
34   -r, --samplerate rate  Fetch the input source, resampled at the given
35   sampling rate. The rate should be specified in Hertz as an integer. If 0,
36   the sampling rate of the original source will be used. Defaults to 0.
37
38   -B, --bufsize win  The size of the buffer to analyze, that is the length
39   of the window used for spectral and temporal computations. Defaults to 512.
40
41   -H, --hopsize hop  The number of samples between two consecutive analysis.
42   Defaults to 256.
43
44   -s, --silence sil  Set the silence threshold, in dB, under which the pitch
45   will not be detected. A value of -20.0 would eliminate most onsets but the
46   loudest ones. A value of -90.0 would select all onsets. Defaults to -90.0.
47
48   -m, --mix-input  Mix source signal to the output signal before writing to
49   sink.
50
51   -j, --jack  Use Jack input/output. You will need a Jack connection
52   controller to feed aubio some signal and listen to its output.
53
54   -h, --help  Print a short help message and exit.
55
56   -v, --verbose  Be verbose.
57
58 BEAT TRACKING METHODS
59
60   Aubio currently implements one the causal beat tracking algorithm designed by
61   Matthew Davies and described in the following articles:
62
63   Matthew E. P. Davies and Mark D. Plumbley. Causal tempo tracking of audio.
64   In Proceedings of the International Symposium on Music Information Retrieval
65   (ISMIR), pages 164­169, Barcelona, Spain, 2004.
66
67   Matthew E. P. Davies, Paul Brossier, and Mark D. Plumbley. Beat tracking
68   towards automatic musical accompaniment. In Proceedings of the Audio
69   Engeeniring Society 118th Convention, Barcelona, Spain, May 2005.
70
71 SEE ALSO
72
73   aubioonset(1),
74   aubiopitch(1),
75   aubionotes(1),
76   aubioquiet(1),
77   aubiomfcc(1),
78   and
79   aubiocut(1).
80
81 AUTHOR
82
83   This manual page was written by Paul Brossier <piem@aubio.org>. Permission is
84   granted to copy, distribute and/or modify this document under the terms of
85   the GNU General Public License as published by the Free Software Foundation,
86   either version 3 of the License, or (at your option) any later version.