summaryrefslogtreecommitdiffstats
path: root/libraries/aubio/man/aubioquiet.1
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/aubio/man/aubioquiet.1')
-rw-r--r--libraries/aubio/man/aubioquiet.192
1 files changed, 92 insertions, 0 deletions
diff --git a/libraries/aubio/man/aubioquiet.1 b/libraries/aubio/man/aubioquiet.1
new file mode 100644
index 0000000000..b8f8ac340a
--- /dev/null
+++ b/libraries/aubio/man/aubioquiet.1
@@ -0,0 +1,92 @@
+.\" Text automatically generated by txt2man
+.TH AUBIOQUIET 1 "22 July 2023" "aubio 0.4.9" "aubio User's manual"
+.SH NAME
+\fBaubioquiet \fP- a command line tool to extracts quiet and loud regions from a file
+\fB
+.SH SYNOPSIS
+.nf
+.fam C
+
+\fBaubioquiet\fP \fIsource\fP
+\fBaubioquiet\fP [[\fB-i\fP] \fIsource\fP]
+ [\fB-r\fP \fIrate\fP] [\fB-B\fP \fIwin\fP] [\fB-H\fP \fIhop\fP]
+ [\fB-T\fP \fItime-format\fP]
+ [\fB-s\fP \fIsil\fP]
+ [\fB-v\fP] [\fB-h\fP]
+
+.fam T
+.fi
+.fam T
+.fi
+.SH DESCRIPTION
+
+\fBaubioquiet\fP will print a timestamp each time it detects a new silent region or
+a new loud region in a sound file.
+.PP
+When started with an input \fIsource\fP (\fB-i\fP/\fB--input\fP), the detected timestamps are
+printed on the console, in seconds.
+.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 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-s\fP, \fB--silence\fP \fIsil\fP
+Set the silence threshold, in dB, under which the pitch
+will not be detected. Defaults to \fB-90.0\fP.
+.TP
+.B
+\fB-T\fP, \fB--timeformat\fP format
+Set time format (samples, ms, seconds). Defaults to
+seconds.
+.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.
+.SH EXAMPLE OUTPUT
+
+.SS NOISY: 28.775330
+
+.SS QUIET: 28.914648
+
+
+.SH SEE ALSO
+
+\fBaubioonset\fP(1),
+\fBaubiopitch\fP(1),
+\fBaubiotrack\fP(1),
+\fBaubionotes\fP(1),
+\fBaubiomfcc\fP(1),
+and
+\fBaubiocut\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, Version 3 any later version published
+by the Free Software Foundation.