draft copyediting
[opus.git] / README
1 To build from a distribution tarball, you only need to do the following:
2
3 % ./configure
4 % make
5
6 To build from the git repository, the following steps are necessary:
7
8 1) Clone the repository:
9
10 % git clone git://git.opus-codec.org/opus.git
11 % cd opus
12
13 1) Compiling
14
15 % ./autogen.sh
16 % ./configure
17 % make
18
19
20 Once you have compiled the codec, there will be a opus_demo executable in
21 the top directory.
22
23 Usage: opus_demo [-e] <application> <sampling rate (Hz)> <channels (1/2)>
24          <bits per second> [options] <input> <output>
25        opus_demo -d <sampling rate (Hz)> <channels (1/2)> [options]
26          <input> <output>
27
28 mode: voip | audio | restricted-lowdelay
29 options:
30 -e                   : only runs the encoder (output the bit-stream)
31 -d                   : only runs the decoder (reads the bit-stream as input)
32 -cbr                 : enable constant bitrate; default: variable bitrate
33 -cvbr                : enable constrained variable bitrate; default: unconstrained
34 -bandwidth <NB|MB|WB|SWB|FB> : audio bandwidth (from narrowband to fullband);
35                                default: sampling rate
36 -framesize <2.5|5|10|20|40|60> : frame size in ms; default: 20
37 -max_payload <bytes> : maximum payload size in bytes, default: 1024
38 -complexity <comp>   : complexity, 0 (lowest) ... 10 (highest); default: 10
39 -inbandfec           : enable SILK inband FEC
40 -forcemono           : force mono encoding, even for stereo input
41 -dtx                 : enable SILK DTX
42 -loss <perc>         : simulate packet loss, in percent (0-100); default: 0
43
44 input and output are little-endian signed 16-bit PCM files or opus bitstreams
45 with simple opus_demo proprietary framing.