summaryrefslogtreecommitdiff
path: root/src/speexenc.1
diff options
context:
space:
mode:
Diffstat (limited to 'src/speexenc.1')
-rw-r--r--src/speexenc.1105
1 files changed, 105 insertions, 0 deletions
diff --git a/src/speexenc.1 b/src/speexenc.1
new file mode 100644
index 0000000..9b0d6a7
--- /dev/null
+++ b/src/speexenc.1
@@ -0,0 +1,105 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.29.
+.TH SPEEXENC "1" "September 2003" "speexenc version 1.1" "User Commands"
+.SH NAME
+speexenc \- The reference implementation speex encoder.
+.SH SYNOPSIS
+.B speexenc
+[\fIoptions\fR] \fIinput_file output_file\fR
+.SH DESCRIPTION
+Encodes input_file using Speex. It can read the WAV or raw files.
+.SS "input_file can be:"
+.TP
+filename.wav
+wav file
+.TP
+filename.*
+Raw PCM file (any extension other than .wav)
+.TP
+-
+stdin
+.SS "output_file can be:"
+.TP
+filename.spx
+Speex file
+.TP
+-
+stdout
+.SH OPTIONS
+.TP
+\fB\-n\fR, \fB\-\-narrowband\fR
+Narrowband (8 kHz) input file
+.TP
+\fB\-w\fR, \fB\-\-wideband\fR
+Wideband (16 kHz) input file
+.HP
+\fB\-u\fR, \fB\-\-ultra\-wideband\fR "Ultra-wideband" (32 kHz) input file
+.TP
+\fB\-\-quality\fR n
+Encoding quality (0-10), default 8
+.TP
+\fB\-\-bitrate\fR n
+Encoding bit-rate (use bit-rate n or lower)
+.TP
+\fB\-\-vbr\fR
+Enable variable bit-rate (VBR)
+.TP
+\fB\-\-abr\fR rate
+Enable average bit-rate (ABR) at rate bps
+.TP
+\fB\-\-vad\fR
+Enable voice activity detection (VAD)
+.TP
+\fB\-\-dtx\fR
+Enable file-based discontinuous transmission (DTX)
+.TP
+\fB\-\-comp\fR n
+Set encoding complexity (0-10), default 3
+.TP
+\fB\-\-nframes\fR n
+Number of frames per Ogg packet (1-10), default 1
+.TP
+\fB\-\-comment\fR
+Add the given string as an extra comment. This may be
+used multiple times
+.TP
+\fB\-\-author\fR
+Author of this track
+.TP
+\fB\-\-title\fR
+Title for this track
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+This help
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Version information
+.TP
+\fB\-V\fR
+Verbose mode (show bit-rate)
+.SS "Raw input options:"
+.TP
+\fB\-\-rate\fR n
+Sampling rate for raw input
+.TP
+\fB\-\-stereo\fR
+Consider raw input as stereo
+.TP
+\fB\-\-le\fR
+Raw input is little-endian
+.TP
+\fB\-\-be\fR
+Raw input is big-endian
+.TP
+\fB\-\-8bit\fR
+Raw input is 8-bit unsigned
+.TP
+\fB\-\-16bit\fR
+Raw input is 16-bit signed
+.PP
+Default raw PCM input is 16-bit, little-endian, mono
+.PP
+More information is available from the Speex site: http://www.speex.org
+.PP
+Please report bugs to the mailing list `speex-dev@xiph.org'.
+.SH COPYRIGHT
+Copyright \(co 2002 Jean-Marc Valin