From 3269dcec2f1b48046740a150e2797651f847aa54 Mon Sep 17 00:00:00 2001
From: Kat Walsh <kat@wikimedia.org>
Date: Mon, 15 Aug 2011 22:43:51 -0400
Subject: Updated README files to reflect current output of tool and tweaked
 punctuation and wording. Corrected typo in test_opus
 ("constraint"->"constrained").

---
 README | 21 ++++++++++++++-------
 1 file changed, 14 insertions(+), 7 deletions(-)

(limited to 'README')

diff --git a/README b/README
index a6be1406..b271f163 100644
--- a/README
+++ b/README
@@ -5,7 +5,7 @@ To build from a distribution tarball, you only need to do the following:
 % ./configure
 % make
 
-To build from the git repository, the following steps are necessary
+To build from the git repository, the following steps are necessary:
 
 1) Clone the repository:
 
@@ -20,18 +20,25 @@ To build from the git repository, the following steps are necessary
 
 
 Once you have compiled the codec, there will be a test_opus executable in
-the src/ directory. This can be in the following way:
+the src/ directory.
 
-% ./test_opus <mode (0/1/2)> <sampling rate (Hz)> <channels> <bits per second>  [options] <input> <output>
+Usage: ./test_opus [-e | -d] <application (0/1)> <sampling rate (Hz)> <channels 
+(1/2)> <bits per second>  [options] <input> <output>
 
-mode: 0 for audo, 1 for voice, 2 for audio:
+mode: 0 for VoIP, 1 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 
+-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
 
-- 
cgit v1.2.3