Mirror of opus
Find a file
Timothy B. Terriberry e4689464eb Addressing AD issues
Including a description of the PVQ encoder and decoder
2012-04-24 00:37:04 -04:00
celt s/FOUNDATION/COPYRIGHT OWNER/ in CELT code and "glue code" 2012-04-20 16:41:42 -04:00
doc Addressing AD issues 2012-04-24 00:37:04 -04:00
include s/FOUNDATION/COPYRIGHT OWNER/ in CELT code and "glue code" 2012-04-20 16:41:42 -04:00
silk Adds note on monic filter 2012-04-23 16:24:45 -04:00
src Fix negative write bug in opus_demo and add some fwrite() error handling. 2012-04-23 14:04:44 -04:00
tests s/FOUNDATION/COPYRIGHT OWNER/ in CELT code and "glue code" 2012-04-20 16:41:42 -04:00
win32 SILK fixes following last codec WG meeting 2011-12-13 14:47:31 -05:00
.gitignore renames the libcelt/ directory to celt/ 2011-09-13 18:21:18 -07:00
AUTHORS missing files 2011-02-14 21:18:08 -05:00
autogen.sh Tell automake to put object files in subdirectories. 2011-08-02 11:43:43 -07:00
celt_headers.txt Moves the main headers from src/ to include/ 2011-10-26 21:36:57 -04:00
celt_sources.mk Renaming the CELT plc.c file to celt_lpc.c to avoid MSVC conflicts with Skype's PLC.c 2011-10-04 13:31:54 -04:00
ChangeLog Build update 2010-07-08 11:52:49 -04:00
configure.ac Last updates for draft -11 2012-02-17 16:18:08 -05:00
COPYING s/FOUNDATION/COPYRIGHT OWNER/ in CELT code and "glue code" 2012-04-20 16:41:42 -04:00
INSTALL draft update, instructions 2010-07-08 13:40:07 -04:00
LICENSE_PLEASE_READ.txt Update licensing file with current IPR disclosures; remove outdated Skype text. 2011-08-16 00:07:44 -04:00
Makefile.am Test cleanups and renaming. 2011-10-27 06:27:13 -04:00
Makefile.draft Misc changes to address Robert Sparks' comments 2012-04-20 10:26:08 -04:00
NEWS Build update 2010-07-08 11:52:49 -04:00
opus-uninstalled.pc.in renames the libcelt/ directory to celt/ 2011-09-13 18:21:18 -07:00
opus.pc.in Add pkg-config support files. 2011-08-28 15:33:14 -04:00
opus.sln renames the libcelt/ directory to celt/ 2011-09-13 18:21:18 -07:00
opus_headers.txt Moves the main headers from src/ to include/ 2011-10-26 21:36:57 -04:00
opus_sources.mk Adds support for multi-stream encoding/decoding 2011-08-27 01:15:43 -04:00
README Renames test_opus to opus_demo and adds the test_opus_api, test_opus_encode, test_opus_decode test programs. 2011-10-26 19:59:49 -04:00
README.draft Misc changes to address Robert Sparks' comments 2012-04-20 10:26:08 -04:00
silk_headers.txt Removed all the silk_ prefixes in source file names (not symbols) 2011-09-16 01:16:53 -07:00
silk_sources.mk oops, forgot to update the source list 2011-10-28 21:20:13 -04:00

This is a prototype codec and for now it has limited functionality. 

To build from a distribution tarball, you only need to do the following:

% ./configure
% make

To build from the git repository, the following steps are necessary:

1) Clone the repository:

% git clone git://git.opus-codec.org/opus.git
% cd opus

1) Compiling

% ./autogen.sh
% ./configure
% make


Once you have compiled the codec, there will be a opus_demo executable in
the top directory.

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: 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
-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
-forcemono           : force mono encoding, even for stereo input
-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) or opus bitstreams
with simple opus_demo propritary framing.