Merge commit '390c89225d'
[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
6 % make
7
8 To build from the git repository, the following steps are necessary:
9
10 1) Clone the repository:
11
12 % git clone git://git.opus-codec.org/opus.git
13 % cd opus
14
15 1) Compiling
16
17 % ./autogen.sh
18 % ./configure
19 % make
20
21
22 Once you have compiled the codec, there will be a opus_demo executable in
23 the top directory.
24
25 Usage: opus_demo [-e] <application> <sampling rate (Hz)> <channels (1/2)>
26          <bits per second> [options] <input> <output>
27        opus_demo -d <sampling rate (Hz)> <channels (1/2)> [options]
28          <input> <output>
29
30 mode: voip | audio | restricted-lowdelay
31 options:
32 -e                   : only runs the encoder (output the bit-stream)
33 -d                   : only runs the decoder (reads the bit-stream as input)
34 -cbr                 : enable constant bitrate; default: variable bitrate
35 -cvbr                : enable constrained variable bitrate; 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) or opus bitstreams
47 with simple opus_demo propritary framing.