Query git for the repository revision and use that for the version string.
[opus.git] / README
diff --git a/README b/README
index 8ffe268..a6be140 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,38 @@
-This is an attempt to write a low-latency audio codec. Don't bother with 
-this unless you're interested in codec development. Certainly don't expect 
-this to be ready any time soon. Oh, and don't complain if it sets your house
-on fire.
+This is a prototype codec and for now it has limited functionality. 
+
+To build from a distribution tarball, you only need to do the following:
 
-To compile:
 % ./configure
 % make
 
-To test the encoder:
-% testcelt input.sw output.sw
+To build from the git repository, the following steps are necessary
+
+1) Clone the repository:
+
+% git clone git://git.opus-codec.org/opus.git
+% cd opus
+
+1) Compiling
+
+% ./autogen.sh
+% ./configure
+% make
+
+
+Once you have compiled the codec, there will be a test_opus executable in
+the src/ directory. This can be in the following way:
+
+% ./test_opus <mode (0/1/2)> <sampling rate (Hz)> <channels> <bits per second>  [options] <input> <output>
+
+mode: 0 for audo, 1 for voice, 2 for audio:
+options:
+-cbr                 : enable constant bitrate; default: VBR
+-bandwidth <NB|MB|WB|SWB|FB>  : audio bandwidth (from narrowband to fullband); default: sampling rate
+-framesize <2.5|5|10|20|40|60>  : frame size in ms; default: 20 
+-max_payload <bytes> : maximum payload size in bytes, default: 1024
+-complexity <comp>   : complexity, 0 (lowest) ... 10 (highest); default: 10
+-inbandfec           : enable SILK inband FEC
+-dtx                 : enable SILK DTX
+-loss <perc>         : simulate packet loss, in percent (0-100); default: 0
 
-where input.sw is a 16-bit (machine endian) *mono* audio file sampled at 
-44.1 kHz or 48 kHz. The output file is already decompressed since we do not
-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
-is (sort of) suitable for music.
+input and output are 16-bit PCM files (machine endian)