doc/: rewrite manpages, use txt2man, add aubioquiet.txt, change rule in wscript
[aubio.git] / doc / aubiomfcc.txt
1 NAME
2   aubiomfcc - a command line tool to compute Mel-frequency Cepstrum Coefficients
3
4 SYNOPSIS
5
6   aubiomfcc source
7   aubiomfcc [[-i] source]
8             [-r rate] [-B win] [-H hop]
9             [-v] [-h]
10
11 DESCRIPTION
12
13   aubiomfcc compute the Mel Frequency Cepstrum Coefficients (MFCC).
14
15   When started with an input source (-i/--input), the coefficients are given on
16   the console, prefixed by their timestamps in seconds.
17
18 OPTIONS
19
20   This program follows the usual GNU command line syntax, with long options
21   starting with two dashes (--). A summary of options is included below.
22
23   -i, --input source  Run analysis on this audio file. Most uncompressed and
24   compressed are supported, depending on how aubio was built.
25
26   -r, --samplerate rate  Fetch the input source, resampled at the given
27   sampling rate. The rate should be specified in Hertz as an integer. If 0,
28   the sampling rate of the original source will be used. Defaults to 0.
29
30   -B, --bufsize win  The size of the buffer to analyze, that is the length
31   of the window used for spectral and temporal computations. Defaults to 512.
32
33   -H, --hopsize hop  The number of samples between two consecutive analysis.
34   Defaults to 256.
35
36   -h, --help  Print a short help message and exit.
37
38   -v, --verbose  Be verbose.
39
40 REFERENCES
41
42   Using the default parameters, the filter coefficients will be computed
43   according to Malcolm Slaney's Auditory Toolbox, available at the following
44   url:
45
46   http://cobweb.ecn.purdue.edu/~malcolm/interval/1998-010/ (see file mfcc.m)
47
48 SEE ALSO
49
50   aubioonset(1),
51   aubiopitch(1),
52   aubiotrack(1),
53   aubionotes(1),
54   aubioquiet(1),
55   and
56   aubiocut(1).
57
58 AUTHOR
59
60   This manual page was written by Paul Brossier <piem@aubio.org>. Permission is
61   granted to copy, distribute and/or modify this document under the terms of
62   the GNU General Public License as published by the Free Software Foundation,
63   either version 3 of the License, or (at your option) any later version.