Skip to content

MatthewCallis/aurora.js

 
 

Repository files navigation

Aurora.js

Aurora.js is a framework that makes writing audio decoders in JavaScript easier. It handles common tasks for you such as dealing with binary data, and the decoding pipeline from source to demuxer to decoder, and finally to the audio hardware itself by abstracting browser audio APIs. Aurora contains two high level APIs for inspecting and playing back decoded audio, and it is easily extendible to support more sources, demuxers, decoders, and audio devices.

Check out the documentation to learn more about using and extending Aurora.

Demo

We have written several decoders using Aurora.js, whose demos you can find here and whose source code can be found on our Github page.

Authors

Aurora.js was written by @jensnockert and @devongovett of Audiocogs.

Building

Currently, the importer module is used to build Aurora.js. You can run the development server by first installing importer with npm, and then running it like this:

npm install importer -g
importer browser.coffee -p 8080

You can also build a static version like this:

importer browser.coffee aurora.js

By itself, Aurora will play LPCM, uLaw and aLaw files in a number of containers. Be sure to add additional codec support by including some of our other decoders such as FLAC.js, ALAC.js, and MP3.js.

If you want to build Aurora without the default codecs, you can use the "browser_slim.coffee" profile:

importer browser_slim.coffee aurora.js

This can help shave off approx. 30 KB from the joined file, or 20 KB when minified.

License

Aurora.js is released under the MIT license.

About

JavaScript audio decoding framework

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CoffeeScript 95.0%
  • JavaScript 3.5%
  • Other 1.5%