blob: f3e2880b02886cc0339a35894afd9efea203f9f0 [file] [log] [blame]
Jean-Marc Valin4468c752010-07-08 13:40:07 -04001This is a prototype codec and for now it has limited functionality.
Jean-Marc Valin7bab9a92010-06-29 23:59:04 -04002
Jean-Marc Valin4468c752010-07-08 13:40:07 -04003To build from a distribution tarball, you only need to do the following:
Jean-Marc Valin8ba2a772010-07-05 14:55:02 -04004
Jean-Marc Valin8ba2a772010-07-05 14:55:02 -04005% ./configure --disable-shared
Jean-Marc Valin8ba2a772010-07-05 14:55:02 -04006% make
7
Jean-Marc Valin4468c752010-07-08 13:40:07 -04008To build from the git repository, the following steps are necessary
9
100) Clone the repository:
11
12% git clone git://git.xiph.org/users/jm/ietfcodec.git
13% cd ietfcodec
14
151) Get the celt and silk submodules:
16
17% git submodule update --init
18
192) Compiling
20
21% ./autogen.sh
22% ./configure --disable-shared
23% make
24
25
Jean-Marc Valin05dd36a2010-10-18 12:50:49 -040026Once you have compiled the codec, there will be a test_opus executable in
Jean-Marc Valin4468c752010-07-08 13:40:07 -040027the src/ directory. This can be in the following way:
28
Jean-Marc Valin08062002011-03-09 13:24:24 -050029% ./test_opus <mode (0/1/2)> <sampling rate (Hz)> <channels> <bits per second> [options] <input> <output>
Jean-Marc Valin4468c752010-07-08 13:40:07 -040030
Jean-Marc Valin08062002011-03-09 13:24:24 -050031mode: 0 for audo, 1 for voice, 2 for audio:
32options:
33-cbr : enable constant bitrate; default: VBR
34-bandwidth <NB|MB|WB|SWB|FB> : audio bandwidth (from narrowband to fullband); default: sampling rate
35-framesize <2.5|5|10|20|40|60> : frame size in ms; default: 20
36-max_payload <bytes> : maximum payload size in bytes, default: 1024
37-complexity <comp> : complexity, 0 (lowest) ... 10 (highest); default: 10
38-inbandfec : enable SILK inband FEC
39-dtx : enable SILK DTX
40-loss <perc> : simulate packet loss, in percent (0-100); default: 0
Jean-Marc Valin78a4b582010-07-08 15:51:49 -040041
Jean-Marc Valin08062002011-03-09 13:24:24 -050042input and output are 16-bit PCM files (machine endian)