Fixes a pretty bad stereo bug in test_opus
[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.opus-codec.org/opus.git
14 % cd opus
15
16 2) Compile
17
18 % ./autogen.sh
19 % ./configure
20 % make
21
22
23 Once you have compiled the codec, there will be a test_opus executable in
24 the src/ directory. This can be in the following way:
25
26 % ./test_opus <mode (0/1/2)> <sampling rate (Hz)> <channels> <bits per second>  [options] <input> <output>
27
28 mode: 0 for audo, 1 for voice, 2 for audio:
29 options:
30 -cbr                 : enable constant bitrate; default: VBR
31 -bandwidth <NB|MB|WB|SWB|FB>  : audio bandwidth (from narrowband to fullband); default: sampling rate
32 -framesize <2.5|5|10|20|40|60>  : frame size in ms; default: 20 
33 -max_payload <bytes> : maximum payload size in bytes, default: 1024
34 -complexity <comp>   : complexity, 0 (lowest) ... 10 (highest); default: 10
35 -inbandfec           : enable SILK inband FEC
36 -dtx                 : enable SILK DTX
37 -loss <perc>         : simulate packet loss, in percent (0-100); default: 0
38
39 input and output are 16-bit PCM files (machine endian)