commas
[opus.git] / README
diff --git a/README b/README
index 33ee0d5..edbac57 100644 (file)
--- a/README
+++ b/README
@@ -1,19 +1,45 @@
-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.
+To build from a distribution tarball, you only need to do the following:
 
-To compile:
 % ./configure
 % make
 
-To test the encoder:
-% testcelt <rate> <channels> <frame size> <overlap> <bytes per packet> input.sw output.sw
+To build from the git repository, the following steps are necessary:
 
-where input.sw is a 16-bit (machine endian) audio file sampled at 
-44.1 kHz or 48 kHz. The output file is already decompressed. 
-the <rate> parameter is the number of bytes per packet to use.
+1) Clone the repository:
 
-Alternatively, there are now Ogg-based tools in tools/. Use 
-the --help option for details. These are quite similar to the
-speexenc/speexdec tools.
+% 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 opus_demo executable in
+the top directory.
+
+Usage: opus_demo [-e] <application> <sampling rate (Hz)> <channels (1/2)>
+         <bits per second> [options] <input> <output>
+       opus_demo -d <sampling rate (Hz)> <channels (1/2)> [options]
+         <input> <output>
+
+mode: voip | audio | restricted-lowdelay
+options:
+-e                   : only runs the encoder (output the bit-stream)
+-d                   : only runs the decoder (reads the bit-stream as input)
+-cbr                 : enable constant bitrate; default: variable bitrate
+-cvbr                : enable constrained variable bitrate; default: unconstrained
+-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
+-forcemono           : force mono encoding, even for stereo input
+-dtx                 : enable SILK DTX
+-loss <perc>         : simulate packet loss, in percent (0-100); default: 0
+
+input and output are little-endian signed 16-bit PCM files or opus bitstreams
+with simple opus_demo proprietary framing.