source: doc/aubiocut.txt

Last change on this file was 43885a7, checked in by Paul Brossier <piem@piem.org>, 9 months ago

[man] document aubiocut --create-first

  • Property mode set to 100644
File size: 2.6 KB
Line 
1NAME
2  aubiocut - a command line tool to slice sound files at onset or beat timestamps
3
4SYNOPSIS
5
6  aubiocut source
7  aubiocut [[-i] source]
8           [-r rate] [-B win] [-H hop]
9           [-O method] [-t thres]
10           [-b] [-c]
11           [-v] [-q] [-h]
12
13OPTIONS
14
15  This program follows the usual GNU command line syntax, with long options
16  starting with two dashes (--). A summary of options is included below.
17
18  -i, --input source  Run analysis on this audio file. Most uncompressed and
19  compressed are supported, depending on how aubio was built.
20
21  -r, --samplerate rate  Fetch the input source, resampled at the given
22  sampling rate. The rate should be specified in Hertz as an integer. If set
23  to 0, the sampling rate of the original source will be used. Defaults to 0.
24
25  -B, --bufsize win  The size of the buffer to analyze, that is the length
26  of the window used for spectral and temporal computations. Defaults to 512.
27
28  -H, --hopsize hop  The number of samples between two consecutive analysis.
29  Defaults to 256.
30
31  -O, --onset method  The onset detection method to use. See ONSET METHODS
32  below. Defaults to 'default'.
33
34  -b, --beat  Use beat locations instead of onset locations.
35
36  -t, --onset-threshold thres  Set the threshold value for the onset peak
37  picking. Values are typically in the range [0.001, 0.900]. Lower threshold
38  values imply more onsets detected. Increasing this threshold should reduce
39  the number of incorrect detections. Defaults to 0.3.
40
41  -c, --cut  Cut input sound file at detected labels. A new sound files for
42  each slice will be created in the current directory.
43
44  -o, --output directory  Specify the directory path where slices of the
45  original source should be created.
46
47  --cut-until-nsamples n  How many extra samples should be added at the end of
48  each slice (default 0).
49
50  --cut-until-nslices n  How many extra slices should be added at the end of
51  each slice (default 0).
52
53  --create-first  Alway create first slice.
54
55  -h, --help  Print a short help message and exit.
56
57  -v, --verbose  Be verbose.
58
59  -q, --quiet  Be quiet.
60
61
62ONSET METHODS
63
64  Available methods: default, energy, hfc, complex, phase, specdiff, kl, mkl,
65  specflux.
66
67  See aubioonset(1) for details about these methods.
68
69
70SEE ALSO
71
72  aubioonset(1),
73  aubiopitch(1),
74  aubiotrack(1),
75  aubionotes(1),
76  aubioquiet(1),
77  and
78  aubiomfcc(1).
79
80AUTHOR
81
82  This manual page was written by Paul Brossier <piem@aubio.org>. Permission is
83  granted to copy, distribute and/or modify this document under the terms of
84  the GNU General Public License as published by the Free Software Foundation,
85  either version 3 of the License, or (at your option) any later version.
Note: See TracBrowser for help on using the repository browser.