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