summaryrefslogtreecommitdiff
path: root/src/speexenc.1
blob: 9b0d6a78c2beba1bcd0e9801859488a023297d53 (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
.\" 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