Wideband quantization improved by adding a sub-frame gain, codebook
[speexdsp.git] / README
1 See INSTALL file for instruction on how to install Speex.
2
3 The Speex project aims to build an open-source patent-free voice codec. 
4 Unlike other codecs like MP3 and Ogg Vorbis, Speex is specially designed 
5 for compressing voice at low bit-rates for applications such as voice over 
6 IP (VoIP). In some sense, it is meant to be complementary to the Ogg 
7 Vorbis codec.
8
9 Although we aim at providing a patent-free codec, we strongly suggest you
10 have a look at patent issues if you are thinking about using Speex 
11 commercially. The speech coding field is a real patent minefield and
12 the scope and enforceability of all these patents is sometimes unclear,
13 not to mention that each country has different laws.
14
15 To use Speex:
16
17 % speexenc [-n or -w] input_file.sw compressed_file.spx
18
19 % speexdec compressed_file.spx output_file.sw
20
21 where -n is for narrowband (8 kHz sampling) and -w is wideband (16 kHz 
22 sampling).
23
24 All audio files are assumed to be raw (no header) 16-bit PCM files. To
25 convert a .wav file into this format:
26 % sox my_file.wav -t sw my_file.sw
27
28 Note that if the original sampling frequency of the wav is not 8 kHz or 16 kHz,
29 you will need to add "-r 8000" or "-r 16000" (without the quotes).
30
31 To create a .wav file:
32 % sox -t sw my_file.sw my_file.wav