Jean-Marc Valin | 4468c75 | 2010-07-08 13:40:07 -0400 | [diff] [blame] | 1 | This is a prototype codec and for now it has limited functionality. |
Jean-Marc Valin | 7bab9a9 | 2010-06-29 23:59:04 -0400 | [diff] [blame] | 2 | |
Jean-Marc Valin | 4468c75 | 2010-07-08 13:40:07 -0400 | [diff] [blame] | 3 | To build from a distribution tarball, you only need to do the following: |
Jean-Marc Valin | 8ba2a77 | 2010-07-05 14:55:02 -0400 | [diff] [blame] | 4 | |
Jean-Marc Valin | fe74125 | 2011-04-30 14:21:35 -0400 | [diff] [blame] | 5 | % ./configure |
Jean-Marc Valin | 8ba2a77 | 2010-07-05 14:55:02 -0400 | [diff] [blame] | 6 | % make |
| 7 | |
Kat Walsh | 3269dce | 2011-08-15 22:43:51 -0400 | [diff] [blame] | 8 | To build from the git repository, the following steps are necessary: |
Jean-Marc Valin | 4468c75 | 2010-07-08 13:40:07 -0400 | [diff] [blame] | 9 | |
Jean-Marc Valin | fe74125 | 2011-04-30 14:21:35 -0400 | [diff] [blame] | 10 | 1) Clone the repository: |
Jean-Marc Valin | 4468c75 | 2010-07-08 13:40:07 -0400 | [diff] [blame] | 11 | |
Jean-Marc Valin | fe74125 | 2011-04-30 14:21:35 -0400 | [diff] [blame] | 12 | % git clone git://git.opus-codec.org/opus.git |
| 13 | % cd opus |
Jean-Marc Valin | 4468c75 | 2010-07-08 13:40:07 -0400 | [diff] [blame] | 14 | |
Jean-Marc Valin | fe74125 | 2011-04-30 14:21:35 -0400 | [diff] [blame] | 15 | 1) Compiling |
Jean-Marc Valin | 4468c75 | 2010-07-08 13:40:07 -0400 | [diff] [blame] | 16 | |
| 17 | % ./autogen.sh |
Jean-Marc Valin | fe74125 | 2011-04-30 14:21:35 -0400 | [diff] [blame] | 18 | % ./configure |
Jean-Marc Valin | 4468c75 | 2010-07-08 13:40:07 -0400 | [diff] [blame] | 19 | % make |
| 20 | |
| 21 | |
Gregory Maxwell | a5ff49e | 2011-10-26 19:56:00 -0400 | [diff] [blame^] | 22 | Once you have compiled the codec, there will be a opus_demo executable in |
Gregory Maxwell | 3bcf367 | 2011-09-09 17:11:43 -0400 | [diff] [blame] | 23 | the top directory. |
Jean-Marc Valin | 4468c75 | 2010-07-08 13:40:07 -0400 | [diff] [blame] | 24 | |
Gregory Maxwell | a5ff49e | 2011-10-26 19:56:00 -0400 | [diff] [blame^] | 25 | Usage: opus_demo [-e] <application> <sampling rate (Hz)> <channels (1/2)> |
Gregory Maxwell | 3bcf367 | 2011-09-09 17:11:43 -0400 | [diff] [blame] | 26 | <bits per second> [options] <input> <output> |
Gregory Maxwell | a5ff49e | 2011-10-26 19:56:00 -0400 | [diff] [blame^] | 27 | opus_demo -d <sampling rate (Hz)> <channels (1/2)> [options] |
Gregory Maxwell | 3bcf367 | 2011-09-09 17:11:43 -0400 | [diff] [blame] | 28 | <input> <output> |
Jean-Marc Valin | 4468c75 | 2010-07-08 13:40:07 -0400 | [diff] [blame] | 29 | |
Gregory Maxwell | 3bcf367 | 2011-09-09 17:11:43 -0400 | [diff] [blame] | 30 | mode: voip | audio | restricted-lowdelay |
Jean-Marc Valin | 0806200 | 2011-03-09 13:24:24 -0500 | [diff] [blame] | 31 | options: |
Kat Walsh | 3269dce | 2011-08-15 22:43:51 -0400 | [diff] [blame] | 32 | -e : only runs the encoder (output the bit-stream) |
| 33 | -d : only runs the decoder (reads the bit-stream as input) |
| 34 | -cbr : enable constant bitrate; default: variable bitrate |
Gregory Maxwell | a5ff49e | 2011-10-26 19:56:00 -0400 | [diff] [blame^] | 35 | -cvbr : enable constrained variable bitrate; default: unconstrained |
Kat Walsh | 3269dce | 2011-08-15 22:43:51 -0400 | [diff] [blame] | 36 | -bandwidth <NB|MB|WB|SWB|FB> : audio bandwidth (from narrowband to fullband); |
| 37 | default: sampling rate |
| 38 | -framesize <2.5|5|10|20|40|60> : frame size in ms; default: 20 |
Jean-Marc Valin | 0806200 | 2011-03-09 13:24:24 -0500 | [diff] [blame] | 39 | -max_payload <bytes> : maximum payload size in bytes, default: 1024 |
| 40 | -complexity <comp> : complexity, 0 (lowest) ... 10 (highest); default: 10 |
| 41 | -inbandfec : enable SILK inband FEC |
Kat Walsh | 3269dce | 2011-08-15 22:43:51 -0400 | [diff] [blame] | 42 | -forcemono : force mono encoding, even for stereo input |
Jean-Marc Valin | 0806200 | 2011-03-09 13:24:24 -0500 | [diff] [blame] | 43 | -dtx : enable SILK DTX |
| 44 | -loss <perc> : simulate packet loss, in percent (0-100); default: 0 |
Jean-Marc Valin | 78a4b58 | 2010-07-08 15:51:49 -0400 | [diff] [blame] | 45 | |
Gregory Maxwell | 3bcf367 | 2011-09-09 17:11:43 -0400 | [diff] [blame] | 46 | input and output are 16-bit PCM files (machine endian) or opus bitstreams |
Gregory Maxwell | a5ff49e | 2011-10-26 19:56:00 -0400 | [diff] [blame^] | 47 | with simple opus_demo propritary framing. |