589d119efce92a92431b9360f131c41150ae8e91
[opus.git] / README
1 This is a prototype codec and for now it has limited functionality. 
2
3 To build from a distribution tarball, you only need to do the following:
4
5 % ./configure --disable-shared
6 % make
7
8 To build from the git repository, the following steps are necessary
9
10 0) Clone the repository:
11
12 % git clone git://git.xiph.org/users/jm/ietfcodec.git
13 % cd ietfcodec
14
15 1) Get the celt and silk submodules:
16
17 % git submodule update --init
18
19 2) Compiling
20
21 % ./autogen.sh
22 % ./configure --disable-shared
23 % make
24
25
26 Once you have compiled the codec, there will be a test_opus executable in
27 the src/ directory. This can be in the following way:
28
29 % ./test_opus 48000 1 960 80 input.sw output.sw
30
31 The arguments are:
32 1) The sampling rate (only 48000 supported for now)
33 2) The number of channels (only mono supported for now)
34 3) The frame size in samples (480 and 960 supported)
35 4) Number of compressed bytes per frame (80 here means 32 kb/s)
36 5) Input PCM file (16-bit, machine endian)
37 6) Output PCM file after encoding and decoding (16-bit machine endian)
38