Removed accesses past array bounds.
[speexdsp.git] / src / speexenc.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.29.
2 .TH SPEEXENC "1" "September 2003" "speexenc version 1.1" "User Commands"
3 .SH NAME
4 speexenc \- manual page for speexenc version 1.1
5 .SH SYNOPSIS
6 .B speexenc
7 [\fIoptions\fR] \fIinput_file output_file\fR
8 .SH DESCRIPTION
9 Encodes input_file using Speex. It can read the WAV or raw files.
10 .SS "input_file can be:"
11 .TP
12 filename.wav
13 wav file
14 .TP
15 filename.*
16 Raw PCM file (any extension other than .wav)
17 .TP
18 -
19 stdin
20 .SS "output_file can be:"
21 .TP
22 filename.spx
23 Speex file
24 .TP
25 -
26 stdout
27 .SH OPTIONS
28 .TP
29 \fB\-n\fR, \fB\-\-narrowband\fR
30 Narrowband (8 kHz) input file
31 .TP
32 \fB\-w\fR, \fB\-\-wideband\fR
33 Wideband (16 kHz) input file
34 .HP
35 \fB\-u\fR, \fB\-\-ultra\-wideband\fR "Ultra-wideband" (32 kHz) input file
36 .TP
37 \fB\-\-quality\fR n
38 Encoding quality (0-10), default 3
39 .TP
40 \fB\-\-bitrate\fR n
41 Encoding bit-rate (use bit-rate n or lower)
42 .TP
43 \fB\-\-vbr\fR
44 Enable variable bit-rate (VBR)
45 .TP
46 \fB\-\-abr\fR rate
47 Enable average bit-rate (ABR) at rate bps
48 .TP
49 \fB\-\-vad\fR
50 Enable voice activity detection (VAD)
51 .TP
52 \fB\-\-dtx\fR
53 Enable file-based discontinuous transmission (DTX)
54 .TP
55 \fB\-\-comp\fR n
56 Set encoding complexity (0-10), default 3
57 .TP
58 \fB\-\-nframes\fR n
59 Number of frames per Ogg packet (1-10), default 1
60 .TP
61 \fB\-\-comment\fR
62 Add the given string as an extra comment. This may be
63 used multiple times
64 .TP
65 \fB\-\-author\fR
66 Author of this track
67 .TP
68 \fB\-\-title\fR
69 Title for this track
70 .TP
71 \fB\-h\fR, \fB\-\-help\fR
72 This help
73 .TP
74 \fB\-v\fR, \fB\-\-version\fR
75 Version information
76 .TP
77 \fB\-V\fR
78 Verbose mode (show bit-rate)
79 .SS "Raw input options:"
80 .TP
81 \fB\-\-rate\fR n
82 Sampling rate for raw input
83 .TP
84 \fB\-\-stereo\fR
85 Consider raw input as stereo
86 .TP
87 \fB\-\-le\fR
88 Raw input is little-endian
89 .TP
90 \fB\-\-be\fR
91 Raw input is big-endian
92 .TP
93 \fB\-\-8bit\fR
94 Raw input is 8-bit unsigned
95 .TP
96 \fB\-\-16bit\fR
97 Raw input is 16-bit signed
98 .PP
99 Default raw PCM input is 16-bit, little-endian, mono
100 .PP
101 More information is available from the Speex site: http://www.speex.org
102 .PP
103 Please report bugs to the mailing list `speex-dev@xiph.org'.
104 .SH COPYRIGHT
105 Copyright \(co 2002 Jean-Marc Valin