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