Using the maximum frequency response of pitch taps instead of maxabs
[opus.git] / README.draft
index 400180f..2215966 100644 (file)
@@ -2,14 +2,20 @@ To build this source code, simply type:
 
 % make
 
-If this does not work, or if you want to change the default configuration (e.g., 
-to compile for a fixed-point architecture), simply edit the options in the
-Makefile.
-
-To build from the git repository instead of using this draft, follow these
+If this does not work, or if you want to change the default configuration
+(e.g., to compile for a fixed-point architecture), simply edit the options
+in the Makefile.
+
+An up-to-date implementation conforming to this standard is available in a
+Git repository at git://git.xiph.org/opus.git or on a website at:
+http://opus-codec.org/
+However, although that implementation is expected to remain conformant 
+with the standard, it is the code in this RFC that shall remain normative. 
+To build from the git repository instead of using this RFC, follow these
 steps:
 
-1) Clone the repository:
+1) Clone the repository (latest implementation of this standard at the time 
+of publication)
 
 % git clone git://git.opus-codec.org/opus.git
 % cd opus
@@ -20,19 +26,20 @@ steps:
 % ./configure
 % 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
@@ -43,4 +50,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 little endian signed 16-bit PCM files or opus bitstreams
+with simple opus_demo proprietary framing.