doc/: rewrite manpages, use txt2man, add aubioquiet.txt, change rule in wscript
[aubio.git] / doc / aubioquiet.txt
1 NAME
2   aubioquiet - a command line tool to extracts quiet and loud regions from a file
3
4 SYNOPSIS
5
6   aubioquiet source
7   aubioquiet [[-i] source]
8              [-r rate] [-B win] [-H hop]
9              [-s sil]
10              [-v] [-h]
11
12 DESCRIPTION
13
14   aubioquiet will print a timestamp each time it detects a new silent region or
15   a new loud region in a sound file.
16
17   When started with an input source (-i/--input), the detected timestamps are
18   printed on the console, in seconds.
19
20 OPTIONS
21
22   This program follows the usual GNU command line syntax, with long options
23   starting with two dashes (--). A summary of options is included below.
24
25   -i, --input source  Run analysis on this audio file. Most uncompressed and
26   compressed are supported, depending on how aubio was built.
27
28   -r, --samplerate rate  Fetch the input source, resampled at the given
29   sampling rate. The rate should be specified in Hertz as an integer. If 0,
30   the sampling rate of the original source will be used. Defaults to 0.
31
32   -B, --bufsize win  The size of the buffer to analyze, that is the length
33   of the window used for spectral and temporal computations. Defaults to 512.
34
35   -H, --hopsize hop  The number of samples between two consecutive analysis.
36   Defaults to 256.
37
38   -s, --silence sil  Set the silence threshold, in dB, under which the pitch
39   will not be detected. Defaults to -90.0.
40
41   -h, --help  Print a short help message and exit.
42
43   -v, --verbose  Be verbose.
44
45 EXAMPLE OUTPUT
46
47   NOISY: 28.775330
48
49   QUIET: 28.914648
50
51
52 SEE ALSO
53
54   aubioonset(1),
55   aubiopitch(1),
56   aubiotrack(1),
57   aubionotes(1),
58   aubiomfcc(1),
59   and
60   aubiocut(1).
61
62 AUTHOR
63
64   This manual page was written by Paul Brossier <piem@aubio.org>. Permission
65   is granted to copy, distribute and/or modify this document under the terms
66   of the GNU General Public License, Version 3 any later version published
67   by the Free Software Foundation.