summaryrefslogtreecommitdiffstats
path: root/libraries/aubio/man/aubiocut.1
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/aubio/man/aubiocut.1')
-rw-r--r--libraries/aubio/man/aubiocut.1124
1 files changed, 124 insertions, 0 deletions
diff --git a/libraries/aubio/man/aubiocut.1 b/libraries/aubio/man/aubiocut.1
new file mode 100644
index 0000000000..c9c887366f
--- /dev/null
+++ b/libraries/aubio/man/aubiocut.1
@@ -0,0 +1,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.