Better error handling in the Opus API
[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 test_opus executable in
23 the src/ directory.
24
25 Usage: ./test_opus [-e | -d] <application (0/1)> <sampling rate (Hz)> <channels 
26 (1/2)> <bits per second>  [options] <input> <output>
27
28 mode: 0 for VoIP, 1 for audio:
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;
34                        default: unconstrained
35 -bandwidth <NB|MB|WB|SWB|FB> : audio bandwidth (from narrowband to fullband);
36                                default: sampling rate
37 -framesize <2.5|5|10|20|40|60> : frame size in ms; default: 20
38 -max_payload <bytes> : maximum payload size in bytes, default: 1024
39 -complexity <comp>   : complexity, 0 (lowest) ... 10 (highest); default: 10
40 -inbandfec           : enable SILK inband FEC
41 -forcemono           : force mono encoding, even for stereo input
42 -dtx                 : enable SILK DTX
43 -loss <perc>         : simulate packet loss, in percent (0-100); default: 0
44
45 input and output are 16-bit PCM files (machine endian)