Skip to content

Browser and NodeJS Web Assembly audio decoder libraries that are highly optimized for size and performance.

Notifications You must be signed in to change notification settings

lineCode/wasm-audio-decoders

 
 

Repository files navigation

WASM Audio Decoders

WASM Audio Decoders is a collection of Web Assembly audio decoder libraries that are highly optimized for browser use. Each module supports synchronous decoding on the main thread as well as asynchronous (threaded) decoding through a built in Web Worker implementation.

Web Assembly is a binary instruction format for a stack-based virtual machine that allows for near native code execution speed inside of a web browser. In practice, these decoders are just as fast, and in some cases faster, than the browser implementation.

Decoders

Each decoder is built with inline WASM to reduce bundling complexity with transpilers like Webpack. The inlined WASM is encoded using yEnc for efficient binary encoding and is gzip compressed for reduced file size.

Pre-built minified JS files are available from NPM and in each decoder's dist folder.

Decodes MPEG Layer I/II/III into PCM

  • 71.3 KiB minified bundle size
  • Browser and NodeJS support
  • Built in Web Worker support
  • Based on mpg123
  • Install using NPM

Decodes Ogg Opus data into PCM

  • 108.4 KiB minified bundle size
  • Browser and NodeJS support
  • Built in Web Worker support
  • Multichannel decoding (up to 8 channels)
  • Based on libopusfile
  • Install using NPM

Decodes raw Opus audio frames into PCM

  • 83.0 KiB minified bundle size
  • Browser and NodeJS support
  • Built in Web Worker support
  • Multichannel decoding (up to 255 channels)
  • Based on libopus
  • Install using NPM

Developing

Prerequisites

  1. Install Emscripten by following these instructions.
    • This repository has been tested with Emscripten 2.0.34.

Building

  1. Make sure to source the Emscripten path in the terminal you want build in.
    • i.e. $ source path/to/emsdk/emsdk_env.sh
  2. Run git submodule update --init to clone down the git sub-modules.
  3. Run npm i to install the build tool dependencies.
  4. Run make clean and make to build the libraries.
    • You can run make -j8 where 8 is the number of CPU cores on your system to speed up the build.
  5. The builds will be located in each library's dist folder:
    • opus-decoder: src/opus-decoder/dist/
    • ogg-opus-decoder: src/ogg-opus-decoder/dist/
    • mpg123-decoder: src/mpg123-decoder/dist/

Testing

  1. Run npm i to install the build tool and test dependencies.
  2. Run npm run test to run the test suite.

Attributions

  • OggOpusDecoder was originally based on AnthumChris/opus-stream-decoder.
    • This version has been optimized for size and for simple bundling in web applications:
      • Everything is bundled in a single minified Javascript file for ease of use.
      • WASM binary is encoded inline using yEnc binary encoding and compressed using DEFLATE to significantly reduce bundle size.
      • WASM compiler, minifier, and bundler options are tuned for best possible size and performance.
  • tiny-inflate is included from foliojs/tiny-inflate and is used to decompress the WASM binary.

Licensing

The source code that originates in this project is licensed under the MIT license. Please note that any external source code included by repository, such as the decoding libraries included as git submodules and compiled into the dist files, may have different licensing terms.

About

Browser and NodeJS Web Assembly audio decoder libraries that are highly optimized for size and performance.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C 57.6%
  • JavaScript 37.0%
  • Makefile 5.4%