source: doc/aubiotrack.txt @ 10b11d6

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5pitchshiftsamplertimestretchyinfft+
Last change on this file since 10b11d6 was 664fd25, checked in by Paul Brossier <piem@piem.org>, 11 years ago

doc/: document -f --force-overwrite option

  • Property mode set to 100644
File size: 3.1 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             [-s sil] [-m]
10             [-j] [-v] [-h]
11
12DESCRIPTION
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
23OPTIONS
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  -f, --force-overwrite  Overwrite output file if it already exists.
52
53  -j, --jack  Use Jack input/output. You will need a Jack connection
54  controller to feed aubio some signal and listen to its output.
55
56  -h, --help  Print a short help message and exit.
57
58  -v, --verbose  Be verbose.
59
60BEAT TRACKING METHODS
61
62  Aubio currently implements one the causal beat tracking algorithm designed by
63  Matthew Davies and described in the following articles:
64
65  Matthew E. P. Davies and Mark D. Plumbley. Causal tempo tracking of audio.
66  In Proceedings of the International Symposium on Music Information Retrieval
67  (ISMIR), pages 164­169, Barcelona, Spain, 2004.
68
69  Matthew E. P. Davies, Paul Brossier, and Mark D. Plumbley. Beat tracking
70  towards automatic musical accompaniment. In Proceedings of the Audio
71  Engeeniring Society 118th Convention, Barcelona, Spain, May 2005.
72
73SEE ALSO
74
75  aubioonset(1),
76  aubiopitch(1),
77  aubionotes(1),
78  aubioquiet(1),
79  aubiomfcc(1),
80  and
81  aubiocut(1).
82
83AUTHOR
84
85  This manual page was written by Paul Brossier <piem@aubio.org>. Permission is
86  granted to copy, distribute and/or modify this document under the terms of
87  the GNU General Public License as published by the Free Software Foundation,
88  either version 3 of the License, or (at your option) any later version.
Note: See TracBrowser for help on using the repository browser.