blob: 589d119efce92a92431b9360f131c41150ae8e91 [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 Valin05dd36a2010-10-18 12:50:49 -040029% ./test_opus 48000 1 960 80 input.sw output.sw
Jean-Marc Valin4468c752010-07-08 13:40:07 -040030
31The arguments are:
321) The sampling rate (only 48000 supported for now)
332) The number of channels (only mono supported for now)
343) The frame size in samples (480 and 960 supported)
Jean-Marc Valin78a4b582010-07-08 15:51:49 -0400354) Number of compressed bytes per frame (80 here means 32 kb/s)
365) Input PCM file (16-bit, machine endian)
376) Output PCM file after encoding and decoding (16-bit machine endian)
38