version bump
[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 opus_demo executable in
24 the top directory.
25
26 Usage: opus_demo [-e] <application> <sampling rate (Hz)> <channels (1/2)>
27          <bits per second> [options] <input> <output>
28        opus_demo -d <sampling rate (Hz)> <channels (1/2)> [options]
29          <input> <output>
30
31 mode: voip | audio | restricted-lowdelay
32 options:
33 -e                   : only runs the encoder (output the bit-stream)
34 -d                   : only runs the decoder (reads the bit-stream as input)
35 -cbr                 : enable constant bitrate; default: variable bitrate
36 -cvbr                : enable constrained variable bitrate; default: unconstrained
37 -bandwidth <NB|MB|WB|SWB|FB> : audio bandwidth (from narrowband to fullband);
38                                default: sampling rate
39 -framesize <2.5|5|10|20|40|60> : frame size in ms; default: 20
40 -max_payload <bytes> : maximum payload size in bytes, default: 1024
41 -complexity <comp>   : complexity, 0 (lowest) ... 10 (highest); default: 10
42 -inbandfec           : enable SILK inband FEC
43 -forcemono           : force mono encoding, even for stereo input
44 -dtx                 : enable SILK DTX
45 -loss <perc>         : simulate packet loss, in percent (0-100); default: 0
46
47 input and output are 16-bit PCM files (machine endian) or opus bitstreams
48 with simple opus_demo propritary framing.