diff options
| author | Gregory Maxwell <greg@xiph.org> | 2011-09-09 17:11:43 -0400 |
|---|---|---|
| committer | Gregory Maxwell <greg@xiph.org> | 2011-09-09 17:11:43 -0400 |
| commit | 3bcf36789811b9da9e07e1f9b5f3204fda0ec960 (patch) | |
| tree | 17ac158fe560359647e207f353f9cc0d798c58eb /README | |
| parent | ee83c16e7a28c56f33a9523cff3cfb8ba9965cb1 (diff) | |
| download | opus-3bcf36789811b9da9e07e1f9b5f3204fda0ec960.tar.gz | |
Documentation updates.
Diffstat (limited to 'README')
| -rw-r--r-- | README | 17 |
1 files changed, 10 insertions, 7 deletions
@@ -20,18 +20,20 @@ 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. +the top directory. -Usage: ./test_opus [-e | -d] <application (0/1)> <sampling rate (Hz)> <channels -(1/2)> <bits per second> [options] <input> <output> +Usage: test_opus [-e] <application> <sampling rate (Hz)> <channels (1/2)> + <bits per second> [options] <input> <output> + test_opus -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 +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 test_opus propritary framing. |