Fixes two minor issues found in random testing at ridiculously low rate.
[opus.git] / README
diff --git a/README b/README
index b271f16..5387aea 100644 (file)
--- a/README
+++ b/README
@@ -19,19 +19,20 @@ To build from the git repository, the following steps are necessary:
 % make
 
 
-Once you have compiled the codec, there will be a test_opus executable in
-the src/ directory.
+Once you have compiled the codec, there will be a opus_demo executable in
+the top directory.
 
-Usage: ./test_opus [-e | -d] <application (0/1)> <sampling rate (Hz)> <channels 
-(1/2)> <bits per second>  [options] <input> <output>
+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: 0 for VoIP, 1 for audio:
+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
+-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
@@ -42,4 +43,5 @@ options:
 -dtx                 : enable SILK DTX
 -loss <perc>         : simulate packet loss, in percent (0-100); default: 0
 
-input and output are 16-bit PCM files (machine endian)
+input and output are 16-bit PCM files (machine endian) or opus bitstreams
+with simple opus_demo propritary framing.