Merge commit 'celt-repo/master'
[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 <mode (0/1/2)> <sampling rate (Hz)> <channels> <bits per second>  [options] <input> <output>
30
31 mode: 0 for audo, 1 for voice, 2 for audio:
32 options:
33 -cbr                 : enable constant bitrate; default: VBR
34 -bandwidth <NB|MB|WB|SWB|FB>  : audio bandwidth (from narrowband to fullband); default: sampling rate
35 -framesize <2.5|5|10|20|40|60>  : frame size in ms; default: 20 
36 -max_payload <bytes> : maximum payload size in bytes, default: 1024
37 -complexity <comp>   : complexity, 0 (lowest) ... 10 (highest); default: 10
38 -inbandfec           : enable SILK inband FEC
39 -dtx                 : enable SILK DTX
40 -loss <perc>         : simulate packet loss, in percent (0-100); default: 0
41
42 input and output are 16-bit PCM files (machine endian)