Updated README
[opus.git] / README
1 This is an attempt to write a low-latency audio codec. Don't bother with 
2 this unless you're interested in codec development. Certainly don't expect 
3 this to be ready any time soon. Oh, and don't complain if it sets your house
4 on fire.
5
6 To compile:
7 % ./configure
8 % make
9
10 To test the encoder:
11 % testcelt input.sw output.sw
12
13 where input.sw is a 16-bit (machine endian) *mono* audio file sampled at 
14 44.1 kHz or 48 kHz. The output file is already decompressed since we do not
15 currently produce compressed files. By default the bit-rate will be around 38 kbps, but replacing "mode1" by "mode2" in testcelt will encode at 58 kbps, which
16 is (sort of) suitable for music.