opus-decoder

opus-decoder

opus-decoder is a Web Assembly Opus audio decoder based on libopus.

See the homepage of this repository for more Web Assembly audio decoders like this one.

Installing

• Install from NPM.

  npm i opus-decoder
  

  import { OpusDecoder } from 'opus-decoder';
  
  const decoder = new OpusDecoder();
  

• Or download the build and include it as a script.

  <script src="opus-decoder.min.js"></script>
  <script>
    const decoder = new OpusDecoder();
  </script>
  

Usage

1. Create a new instance and wait for the WASM to finish compiling. Decoding can be done on the main thread synchronously, or in a webworker asynchronously.

   Main thread synchronous decoding

   import { OpusDecoder } from 'opus-decoder';
   
   const decoder = new OpusDecoder();
   
   // wait for the WASM to be compiled
   await decoder.ready;
   

   Web Worker asynchronous decoding

   import { OpusDecoderWebWorker } from 'opus-decoder';
   
   const decoder = new OpusDecoderWebWorker();
   
   // wait for the WASM to be compiled
   await decoder.ready;
   

2. Begin decoding Opus frames.

   // Decode an individual Opus frame
   const {channelData, samplesDecoded, sampleRate} = decoder.decodeFrame(opusFrame);
   
   // Decode an array of individual Opus frames
   const {channelData, samplesDecoded, sampleRate} = decoder.decodeFrames(opusFrameArray);
   

3. When done decoding, reset the decoder to decode a new stream, or free up the memory being used by the WASM module if you have no more audio to decode.

   // `reset()` clears the decoder state and allows you do decode a new stream of Opus frames.
   decoder.reset();
   
   // `free()` de-allocates the memory used by the decoder. You will need to create a new instance after calling `free()` to start decoding again.
   decoder.free();
   

API

Decoded audio is always returned in the below structure.

{
    channelData: [
      leftAudio, // Float32Array of PCM samples for the left channel
      rightAudio // Float32Array of PCM samples for the right channel
    ],
    samplesDecoded: 1234, // number of PCM samples that were decoded
    sampleRate: 48000 // sample rate of the decoded PCM
}

Each Float32Array within channelData can be used directly in the WebAudio API for playback.

OpusDecoder

Class that decodes Opus frames synchronously on the main thread.

Getters

• decoder.ready async
  • Returns a promise that is resolved when the WASM is compiled and ready to use.

Methods

• decoder.decodeFrame(opusFrame)
  • opusFrame Uint8Array containing a single Opus frame.
  • Returns decoded audio.
• decoder.decodeFrames(opusFrames)
  • opusFrames Array of Uint8Arrays containing Opus frames.
  • Returns decoded audio.
• decoder.reset() async
  • Resets the decoder so that a new stream of Opus frames can be decoded.
• decoder.free()
  • De-allocates the memory used by the decoder.
  • After calling free(), the current instance is made unusable, and a new instance will need to be created to decode additional Opus frames.

OpusDecoderWebWorker

Class that decodes Opus frames asynchronously within a WebWorker. Decoding is performed in a separate, non-blocking thread. Each new instance spawns a new worker allowing you to run multiple workers for concurrent decoding of multiple streams.

Getters

• decoder.ready async
  • Returns a promise that is resolved when the WASM is compiled and ready to use.

Methods

• decoder.decodeFrame(opusFrame) async
  • opusFrame Uint8Array containing a single Opus frame.
  • Returns a promise that resolves with the decoded audio.
• decoder.decodeFrames(opusFrames) async
  • opusFrames Array of Uint8Arrays containing Opus frames.
  • Returns a promise that resolves with the decoded audio.
• decoder.reset() async
  • Resets the decoder so that a new stream of Opus frames can be decoded.
• decoder.free()
  • De-allocates the memory used by the decoder and terminates the WebWorker.
  • After calling free(), the current instance is made unusable, and a new instance will need to be created to decode additional Opus frames.