9e1b53e3db117c3871c2062baa32ccc399109ebb
[opus.git] / README.draft
1 To build this source code, simply type:
2
3 % make
4
5 If this does not work, or to change the default configuration (e.g. compile for
6 a fixed-point architecture), simply edit the options in the Makefile
7
8 To build from the git repository instead of using this draft, the following 
9 steps are necessary
10
11 1) Clone the repository:
12
13 % git clone git://git.xiph.org/users/jm/ietfcodec.git
14 % cd ietfcodec
15
16 2) Get the celt and silk submodules:
17
18 % git submodule update --init
19
20 3) Compile
21
22 % ./autogen.sh
23 % ./configure --disable-shared
24 % make
25
26
27 Once you have compiled the codec, there will be a test_opus executable in
28 the src/ directory. This can be in the following way:
29
30 % ./test_opus <mode (0/1/2)> <sampling rate (Hz)> <channels> <bits per second>  [options] <input> <output>
31
32 mode: 0 for audo, 1 for voice, 2 for audio:
33 options:
34 -cbr                 : enable constant bitrate; default: VBR
35 -bandwidth <NB|MB|WB|SWB|FB>  : audio bandwidth (from narrowband to fullband); default: sampling rate
36 -framesize <2.5|5|10|20|40|60>  : frame size in ms; default: 20 
37 -max_payload <bytes> : maximum payload size in bytes, default: 1024
38 -complexity <comp>   : complexity, 0 (lowest) ... 10 (highest); default: 10
39 -inbandfec           : enable SILK inband FEC
40 -dtx                 : enable SILK DTX
41 -loss <perc>         : simulate packet loss, in percent (0-100); default: 0
42
43 input and output are 16-bit PCM files (machine endian)