Modern audio compression for the internet.
C C++ Objective-C M4 Assembly Makefile Other
Switch branches/tags
Clone or download
mark4o Work around VS2015 internal compiler error
The error was:
c:\projects\opus\celt\celt_encoder.c(1019): fatal error C1001: An internal error has occurred in the compiler. [C:\projects\opus\win32\VS2015\opus.vcxproj]
  (compiler file 'f:\dd\vctools\compiler\utc\src\p2\main.c', line 255)
   To work around this problem, try simplifying or changing the program near the locations listed above.
  Please choose the Technical Support command on the Visual C++
   Help menu, or open the Technical Support help file for more information

  Internal Compiler Error in C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\x86_amd64\CL.exe.  You will be prompted to send an error report to Microsoft later.
Latest commit 38fca4a Jul 29, 2018
Permalink
Failed to load latest commit information.
celt Work around VS2015 internal compiler error Jul 28, 2018
doc update draft version -10 Sep 19, 2017
include Fix opus_packet_parse() non-null arg attribute May 4, 2018
m4 Adding -D_FORTIFY_SOURCE=2 when possible Feb 22, 2018
scripts Add RNN for VAD and speech/music classification Oct 5, 2017
silk Silence compiler warnings Jul 22, 2018
src Fixing arithmetic problems for 16-bit CPUs in ambisonics_rate_allocat… Jul 28, 2018
tests Remove ambisonics experimental flag Jul 26, 2018
win32 win32: Add ambisonics sources to VS project Jul 27, 2018
.appveyor.yml appveyor: fix typoed appveyor command May 25, 2017
.gitattributes Force crlf line endings for VS2015 project files. Aug 11, 2017
.gitignore Support for Channel Mapping 253 Nov 7, 2017
.travis.yml Add more coverage to travis tests. Feb 14, 2017
AUTHORS More email address updates for AUTHORS. Aug 23, 2012
COPYING Remove trailing whitespace. Sep 16, 2013
ChangeLog Build update Jul 8, 2010
LICENSE_PLEASE_READ.txt Link to the new Microsoft patent license. Dec 5, 2012
Makefile.am Adding ENABLE_HARDENING Mar 27, 2018
Makefile.mips Adds opus_encode_regressions.c to the MIPS Makefile Oct 29, 2016
Makefile.unix Adds opus_encode_regressions.c to the UNIX Makefile Oct 29, 2016
NEWS Build update Jul 8, 2010
README README: Update to reflect RFC 7845 and 8251 May 7, 2018
README.draft Updating links for both https and new versions Oct 23, 2015
autogen.sh Add copyright notice to autogen.sh to make the Chromium people happy Nov 1, 2016
celt_headers.mk SSE2 implementation of the PVQ search Aug 10, 2016
celt_sources.mk Rename arm ne10 assembly optimization files. Sep 11, 2017
configure.ac Remove ambisonics experimental flag Jul 26, 2018
opus-uninstalled.pc.in Making opus-uninstalled.pc use the .la instead of the .a Dec 19, 2017
opus.m4 Fix common misspellings Sep 27, 2012
opus.pc.in Update URLs Jul 6, 2016
opus_headers.mk Add missing include to the list Nov 8, 2017
opus_sources.mk Support for Channel Mapping 253 Nov 7, 2017
releases.sha2 update checksums Jun 1, 2018
silk_headers.mk Optimize silk_biquad_alt_stride2() for ARM NEON May 17, 2017
silk_sources.mk Rename SSE 4.1 files to match their targets. Sep 11, 2017
update_version Drop the use of --always to git-describe Nov 27, 2013

README

== Opus audio codec ==

Opus is a codec for interactive speech and audio transmission over the Internet.

  Opus can handle a wide range of interactive audio applications, including
Voice over IP, videoconferencing, in-game  chat, and even remote live music
performances. It can scale from low bit-rate narrowband speech to very high
quality stereo music.

  Opus, when coupled with an appropriate container format, is also suitable
for non-realtime  stored-file applications such as music distribution, game
soundtracks, portable music players, jukeboxes, and other applications that
have historically used high latency formats such as MP3, AAC, or Vorbis.

                    Opus is specified by IETF RFC 6716:
                    https://tools.ietf.org/html/rfc6716

  The Opus format and this implementation of it are subject to the royalty-
free patent and copyright licenses specified in the file COPYING.

This package implements a shared library for encoding and decoding raw Opus
bitstreams. Raw Opus bitstreams should be used over RTP according to
 https://tools.ietf.org/html/rfc7587

The package also includes a number of test  tools used for testing the
correct operation of the library. The bitstreams read/written by these
tools should not be used for Opus file distribution: They include
additional debugging data and cannot support seeking.

Opus stored in files should use the Ogg encapsulation for Opus which is
described at:
 https://tools.ietf.org/html/rfc7845

An opus-tools package is available which provides encoding and decoding of
Ogg encapsulated Opus files and includes a number of useful features.

Opus-tools can be found at:
 https://git.xiph.org/?p=opus-tools.git
or on the main Opus website:
 https://opus-codec.org/

== Compiling libopus ==

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:

0) Set up a development environment:

On an Ubuntu or Debian family Linux distribution:

    % sudo apt-get install git autoconf automake libtool gcc make

On a Fedora/Redhat based Linux:

    % sudo dnf install git autoconf automake libtool gcc make

Or for older Redhat/Centos Linux releases:

    % sudo yum install git autoconf automake libtool gcc make

On Apple macOS, install Xcode and brew.sh, then in the Terminal enter:

    % brew install autoconf automake libtool

1) Clone the repository:

    % git clone https://git.xiph.org/opus.git
    % cd opus

2) Compiling the source

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

3) Install the codec libraries (optional)

    % sudo make install

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 little-endian signed 16-bit PCM files or opus
bitstreams with simple opus_demo proprietary framing.

== Testing ==

This package includes a collection of automated unit and system tests
which SHOULD be run after compiling the package especially the first
time it is run on a new platform.

To run the integrated tests:

    % make check

There is also collection of standard test vectors which are not
included in this package for size reasons but can be obtained from:
https://opus-codec.org/docs/opus_testvectors-rfc8251.tar.gz

To run compare the code to these test vectors:

    % curl -OL https://opus-codec.org/docs/opus_testvectors-rfc8251.tar.gz
    % tar -zxf opus_testvectors-rfc8251.tar.gz
    % ./tests/run_vectors.sh ./ opus_newvectors 48000

== Portability notes ==

This implementation uses floating-point by default but can be compiled to
use only fixed-point arithmetic by setting --enable-fixed-point (if using
autoconf) or by defining the FIXED_POINT macro (if building manually).
The fixed point implementation has somewhat lower audio quality and is
slower on platforms with fast FPUs, it is normally only used in embedded
environments.

The implementation can be compiled with either a C89 or a C99 compiler.
While it does not rely on any _undefined behavior_ as defined by C89 or
C99, it relies on common _implementation-defined behavior_ for two's
complement architectures:

o Right shifts of negative values are consistent with two's
  complement arithmetic, so that a>>b is equivalent to
  floor(a/(2^b)),

o For conversion to a signed integer of N bits, the value is reduced
  modulo 2^N to be within range of the type,

o The result of integer division of a negative value is truncated
  towards zero, and

o The compiler provides a 64-bit integer type (a C99 requirement
  which is supported by most C89 compilers).