Preparing for beta 3, cleaned up the mode/bit-rate code in speexdec,
[speexdsp.git] / src / speexenc.1
1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.29.
2 .TH SPEEXENC "1" "November 2002" "speexenc (Speex encoder) version 1.0beta3-cvs (compiled Nov  9 2002)" "User Commands"
3 .SH NAME
4 speexenc \- manual page for speexenc (Speex encoder) version 1.0beta3-cvs (compiled Nov  9 2002)
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\-\-vbr\fR
41 Enable variable bit-rate (VBR)
42 .TP
43 \fB\-\-comp\fR n
44 Set encoding complexity (0-10), default 3
45 .TP
46 \fB\-\-nframes\fR n
47 Number of frames per Ogg packet (1-10), default 1
48 .TP
49 \fB\-\-comment\fR
50 Add the given string as an extra comment. This may be
51 used multiple times.
52 .TP
53 \fB\-\-author\fR
54 Author of this track.
55 .TP
56 \fB\-\-title\fR
57 Title for this track.
58 .TP
59 \fB\-h\fR, \fB\-\-help\fR
60 This help
61 .TP
62 \fB\-v\fR, \fB\-\-version\fR
63 Version information
64 .TP
65 \fB\-V\fR
66 Verbose mode (show bit-rate)
67 .SS "Raw input options:"
68 .TP
69 \fB\-\-rate\fR
70 Sampling rate for raw input
71 .TP
72 \fB\-\-le\fR
73 Raw input is little-endian
74 .TP
75 \fB\-\-be\fR
76 Raw input is big-endian
77 .TP
78 \fB\-\-8bit\fR
79 Raw input is 8-bit unsigned
80 .TP
81 \fB\-\-16bit\fR
82 Raw input is 16-bit signed
83 .TP
84 \fB\-\-stereo\fR
85 Consider raw input as stereo
86 .PP
87 Default raw PCM input is 16-bit, little-endian, mono
88 .PP
89 More information is available from the Speex site: http://www.speex.org
90 .PP
91 Please report bugs to the mailing list `speex-dev@xiph.org'.
92 .SH COPYRIGHT
93 Copyright \(co 2002 Jean-Marc Valin