source: doc/aubiotrack.txt @ 3d2e481

sampler
Last change on this file since 3d2e481 was 7a83a47, checked in by Paul Brossier <piem@piem.org>, 8 years ago

doc/aubio*.txt: document -T/--timeformat option

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