Makes the CELT init() functions behave just like the Opus ones.
[opus.git] / README.draft
1 To build this source code, simply type:
2
3 % make
4
5 If this does not work, or if you want to change the default configuration (e.g., 
6 to compile for a fixed-point architecture), simply edit the options in the
7 Makefile.
8
9 To build from the git repository instead of using this draft, follow these
10 steps:
11
12 1) Clone the repository:
13
14 % git clone git://git.opus-codec.org/opus.git
15 % cd opus
16
17 2) Compile
18
19 % ./autogen.sh
20 % ./configure
21 % make
22
23 Once you have compiled the codec, there will be a test_opus executable in
24 the src/ directory.
25
26 Usage: ./test_opus [-e | -d] <application (0/1)> <sampling rate (Hz)> <channels 
27 (1/2)> <bits per second>  [options] <input> <output>
28
29 mode: 0 for VoIP, 1 for audio:
30 options:
31 -e                   : only runs the encoder (output the bit-stream)
32 -d                   : only runs the decoder (reads the bit-stream as input)
33 -cbr                 : enable constant bitrate; default: variable bitrate
34 -cvbr                : enable constrained variable bitrate;
35                        default: unconstrained
36 -bandwidth <NB|MB|WB|SWB|FB> : audio bandwidth (from narrowband to fullband);
37                                default: sampling rate
38 -framesize <2.5|5|10|20|40|60> : frame size in ms; default: 20
39 -max_payload <bytes> : maximum payload size in bytes, default: 1024
40 -complexity <comp>   : complexity, 0 (lowest) ... 10 (highest); default: 10
41 -inbandfec           : enable SILK inband FEC
42 -forcemono           : force mono encoding, even for stereo input
43 -dtx                 : enable SILK DTX
44 -loss <perc>         : simulate packet loss, in percent (0-100); default: 0
45
46 input and output are 16-bit PCM files (machine endian)