aboutsummaryrefslogtreecommitdiff
path: root/README.draft
diff options
context:
space:
mode:
Diffstat (limited to 'README.draft')
-rw-r--r--README.draft18
1 files changed, 10 insertions, 8 deletions
diff --git a/README.draft b/README.draft
index 400180f5..8dbe48d8 100644
--- a/README.draft
+++ b/README.draft
@@ -20,19 +20,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 +44,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.