summaryrefslogtreecommitdiffstats
path: root/libraries/aubio/man/aubiocut.1
blob: c9c887366faca975f1fa403e95f2af8c2566a0f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
.\" Text automatically generated by txt2man
.TH AUBIOCUT 1 "22 July 2023" "aubio 0.4.9" "aubio User's manual"
.SH NAME
\fBaubiocut \fP- a command line tool to slice sound files at onset or beat timestamps
\fB
.SH SYNOPSIS
.nf
.fam C

\fBaubiocut\fP \fIsource\fP
\fBaubiocut\fP [[\fB-i\fP] \fIsource\fP]
         [\fB-r\fP \fIrate\fP] [\fB-B\fP \fIwin\fP] [\fB-H\fP \fIhop\fP]
         [\fB-O\fP \fImethod\fP] [\fB-t\fP \fIthres\fP]
         [\fB-b\fP] [\fB-c\fP]
         [\fB-v\fP] [\fB-q\fP] [\fB-h\fP]

.fam T
.fi
.fam T
.fi
.SH OPTIONS

This program follows the usual GNU command line syntax, with long options
starting with two dashes (--). A summary of options is included below.
.TP
.B
\fB-i\fP, \fB--input\fP \fIsource\fP
Run analysis on this audio file. Most uncompressed and
compressed are supported, depending on how aubio was built.
.TP
.B
\fB-r\fP, \fB--samplerate\fP \fIrate\fP
Fetch the input \fIsource\fP, resampled at the given
sampling \fIrate\fP. The \fIrate\fP should be specified in Hertz as an integer. If set
to 0, the sampling \fIrate\fP of the original \fIsource\fP will be used. Defaults to 0.
.TP
.B
\fB-B\fP, \fB--bufsize\fP \fIwin\fP
The size of the buffer to analyze, that is the length
of the window used for spectral and temporal computations. Defaults to 512.
.TP
.B
\fB-H\fP, \fB--hopsize\fP \fIhop\fP
The number of samples between two consecutive analysis.
Defaults to 256.
.TP
.B
\fB-O\fP, \fB--onset\fP \fImethod\fP
The onset detection \fImethod\fP to use. See ONSET METHODS
below. Defaults to 'default'.
.TP
.B
\fB-b\fP, \fB--beat\fP
Use beat locations instead of onset locations.
.TP
.B
\fB-t\fP, \fB--onset-threshold\fP \fIthres\fP
Set the threshold value for the onset peak
picking. Values are typically in the range [0.001, 0.900]. Lower threshold
values imply more onsets detected. Increasing this threshold should reduce
the number of incorrect detections. Defaults to 0.3.
.TP
.B
\fB-c\fP, \fB--cut\fP
Cut input sound file at detected labels. A new sound files for
each slice will be created in the current directory.
.TP
.B
\fB-o\fP, \fB--output\fP directory
Specify the directory path where slices of the
original \fIsource\fP should be created.
.TP
.B
\fB--cut-until-nsamples\fP n
How many extra samples should be added at the end of
each slice (default 0).
.TP
.B
\fB--cut-until-nslices\fP n
How many extra slices should be added at the end of
each slice (default 0).
.TP
.B
\fB--create-first\fP
Alway create first slice.
.TP
.B
\fB-h\fP, \fB--help\fP
Print a short help message and exit.
.TP
.B
\fB-v\fP, \fB--verbose\fP
Be verbose.
.TP
.B
\fB-q\fP, \fB--quiet\fP
Be quiet.
.RE
.PP

.SH ONSET METHODS

Available methods: default, energy, hfc, complex, phase, specdiff, kl, mkl,
specflux.
.PP
See \fBaubioonset\fP(1) for details about these methods.
.RE
.PP

.SH SEE ALSO

\fBaubioonset\fP(1),
\fBaubiopitch\fP(1),
\fBaubiotrack\fP(1),
\fBaubionotes\fP(1),
\fBaubioquiet\fP(1),
and
\fBaubiomfcc\fP(1).
.SH AUTHOR

This manual page was written by Paul Brossier <piem@aubio.org>. Permission is
granted to copy, distribute and/or modify this document under the terms of
the GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.