Minor draft distribution update

This commit is contained in:
Jean-Marc Valin 2011-03-09 13:24:24 -05:00
parent ebf9c03229
commit 080620047c
4 changed files with 15 additions and 12 deletions

View file

@ -13,10 +13,6 @@ notice, this list of conditions and the following disclaimer.
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
- Neither the name of the Xiph.org Foundation nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

20
README
View file

@ -26,13 +26,17 @@ 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:
% ./test_opus 48000 1 960 80 input.sw output.sw
% ./test_opus <mode (0/1/2)> <sampling rate (Hz)> <channels> <bits per second> [options] <input> <output>
The arguments are:
1) The sampling rate (only 48000 supported for now)
2) The number of channels (only mono supported for now)
3) The frame size in samples (480 and 960 supported)
4) Number of compressed bytes per frame (80 here means 32 kb/s)
5) Input PCM file (16-bit, machine endian)
6) Output PCM file after encoding and decoding (16-bit machine endian)
mode: 0 for audo, 1 for voice, 2 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
-max_payload <bytes> : maximum payload size in bytes, default: 1024
-complexity <comp> : complexity, 0 (lowest) ... 10 (highest); default: 10
-inbandfec : enable SILK inband FEC
-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)

View file

@ -3,6 +3,7 @@
echo packaging source code
rm -rf opus_source
cat opus_sources.mk celt_sources.mk silk_sources.mk opus_headers.txt celt_headers.txt silk_headers.txt | grep '\.[ch]' | sed -e 's/^.*=//' -e 's/\\//' > all_files.txt
cat opus_extra.txt >> all_files.txt
tar czf tmp_draft.tar.gz `cat all_files.txt`
mkdir opus_source

2
opus_extra.txt Normal file
View file

@ -0,0 +1,2 @@
README
COPYING