Adding a missing "else"
[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
6 (e.g., to compile for a fixed-point architecture), simply edit the options
7 in the Makefile.
8
9 An up-to-date implementation conforming to this standard is available in a
10 Git repository at https://git.xiph.org/opus.git or on a website at:
11 https://opus-codec.org/
12 However, although that implementation is expected to remain conformant
13 with the standard, it is the code in this RFC that shall remain normative.
14 To build from the git repository instead of using this RFC, follow these
15 steps:
16
17 1) Clone the repository (latest implementation of this standard at the time
18 of publication)
19
20 % git clone https://git.xiph.org/opus.git
21 % cd opus
22
23 2) Compile
24
25 % ./autogen.sh
26 % ./configure
27 % make
28
29 Once you have compiled the codec, there will be a opus_demo executable in
30 the top directory.
31
32 Usage: opus_demo [-e] <application> <sampling rate (Hz)> <channels (1/2)>
33          <bits per second> [options] <input> <output>
34        opus_demo -d <sampling rate (Hz)> <channels (1/2)> [options]
35          <input> <output>
36
37 mode: voip | audio | restricted-lowdelay
38 options:
39 -e                   : only runs the encoder (output the bit-stream)
40 -d                   : only runs the decoder (reads the bit-stream as input)
41 -cbr                 : enable constant bitrate; default: variable bitrate
42 -cvbr                : enable constrained variable bitrate; default: unconstrained
43 -bandwidth <NB|MB|WB|SWB|FB> : audio bandwidth (from narrowband to fullband);
44                                default: sampling rate
45 -framesize <2.5|5|10|20|40|60> : frame size in ms; default: 20
46 -max_payload <bytes> : maximum payload size in bytes, default: 1024
47 -complexity <comp>   : complexity, 0 (lowest) ... 10 (highest); default: 10
48 -inbandfec           : enable SILK inband FEC
49 -forcemono           : force mono encoding, even for stereo input
50 -dtx                 : enable SILK DTX
51 -loss <perc>         : simulate packet loss, in percent (0-100); default: 0
52
53 input and output are little endian signed 16-bit PCM files or opus bitstreams
54 with simple opus_demo proprietary framing.