Skip to content
Snippets Groups Projects
Commit 3269dcec authored by Kat Walsh's avatar Kat Walsh Committed by Jean-Marc Valin
Browse files

Updated README files to reflect current output of tool and tweaked punctuation...

Updated README files to reflect current output of tool and tweaked punctuation and wording. Corrected typo in test_opus ("constraint"->"constrained").
parent 66ff26f3
No related branches found
No related tags found
No related merge requests found
...@@ -5,7 +5,7 @@ To build from a distribution tarball, you only need to do the following: ...@@ -5,7 +5,7 @@ To build from a distribution tarball, you only need to do the following:
% ./configure % ./configure
% make % 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: 1) Clone the repository:
...@@ -20,18 +20,25 @@ To build from the git repository, the following steps are necessary ...@@ -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 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: options:
-cbr : enable constant bitrate; default: VBR -e : only runs the encoder (output the bit-stream)
-bandwidth <NB|MB|WB|SWB|FB> : audio bandwidth (from narrowband to fullband); default: sampling rate -d : only runs the decoder (reads the bit-stream as input)
-framesize <2.5|5|10|20|40|60> : frame size in ms; default: 20 -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 -max_payload <bytes> : maximum payload size in bytes, default: 1024
-complexity <comp> : complexity, 0 (lowest) ... 10 (highest); default: 10 -complexity <comp> : complexity, 0 (lowest) ... 10 (highest); default: 10
-inbandfec : enable SILK inband FEC -inbandfec : enable SILK inband FEC
-forcemono : force mono encoding, even for stereo input
-dtx : enable SILK DTX -dtx : enable SILK DTX
-loss <perc> : simulate packet loss, in percent (0-100); default: 0 -loss <perc> : simulate packet loss, in percent (0-100); default: 0
......
...@@ -2,11 +2,12 @@ To build this source code, simply type: ...@@ -2,11 +2,12 @@ To build this source code, simply type:
% make % make
If this does not work, or to change the default configuration (e.g. compile for If this does not work, or if you want to change the default configuration (e.g.,
a fixed-point architecture), simply edit the options in the Makefile 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, the following To build from the git repository instead of using this draft, follow these
steps are necessary steps:
1) Clone the repository: 1) Clone the repository:
...@@ -19,20 +20,26 @@ steps are necessary ...@@ -19,20 +20,26 @@ steps are necessary
% ./configure % ./configure
% make % make
Once you have compiled the codec, there will be a test_opus executable in 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: options:
-cbr : enable constant bitrate; default: VBR -e : only runs the encoder (output the bit-stream)
-bandwidth <NB|MB|WB|SWB|FB> : audio bandwidth (from narrowband to fullband); default: sampling rate -d : only runs the decoder (reads the bit-stream as input)
-framesize <2.5|5|10|20|40|60> : frame size in ms; default: 20 -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 -max_payload <bytes> : maximum payload size in bytes, default: 1024
-complexity <comp> : complexity, 0 (lowest) ... 10 (highest); default: 10 -complexity <comp> : complexity, 0 (lowest) ... 10 (highest); default: 10
-inbandfec : enable SILK inband FEC -inbandfec : enable SILK inband FEC
-forcemono : force mono encoding, even for stereo input
-dtx : enable SILK DTX -dtx : enable SILK DTX
-loss <perc> : simulate packet loss, in percent (0-100); default: 0 -loss <perc> : simulate packet loss, in percent (0-100); default: 0
......
...@@ -49,7 +49,7 @@ void print_usage( char* argv[] ) ...@@ -49,7 +49,7 @@ void print_usage( char* argv[] )
fprintf(stderr, "-e : only runs the encoder (output the bit-stream)\n" ); fprintf(stderr, "-e : only runs the encoder (output the bit-stream)\n" );
fprintf(stderr, "-d : only runs the decoder (reads the bit-stream as input)\n" ); fprintf(stderr, "-d : only runs the decoder (reads the bit-stream as input)\n" );
fprintf(stderr, "-cbr : enable constant bitrate; default: variable bitrate\n" ); fprintf(stderr, "-cbr : enable constant bitrate; default: variable bitrate\n" );
fprintf(stderr, "-cvbr : enable constraint variable bitrate; default: unconstraint\n" ); fprintf(stderr, "-cvbr : enable constrained variable bitrate; default: unconstrained\n" );
fprintf(stderr, "-bandwidth <NB|MB|WB|SWB|FB> : audio bandwidth (from narrowband to fullband); default: sampling rate\n" ); fprintf(stderr, "-bandwidth <NB|MB|WB|SWB|FB> : audio bandwidth (from narrowband to fullband); default: sampling rate\n" );
fprintf(stderr, "-framesize <2.5|5|10|20|40|60> : frame size in ms; default: 20 \n" ); fprintf(stderr, "-framesize <2.5|5|10|20|40|60> : frame size in ms; default: 20 \n" );
fprintf(stderr, "-max_payload <bytes> : maximum payload size in bytes, default: 1024\n" ); fprintf(stderr, "-max_payload <bytes> : maximum payload size in bytes, default: 1024\n" );
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment