Repository files navigation

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

Check out thedocumentation to learn more about using andextending Aurora.

We have written several decoders using Aurora.js, whose demos you can findhereand whose source code can be found on ourGithub page.

Aurora.js was written by@jensnockert and@devongovettofAudiocogs.

You can use Aurora.js both in the browser, as well as in Node.js. In the browser,you can either download a prebuiltreleaseor usebrowserify to build it into your ownapp bundle (see below for Node.js usage - it's the same for browserify).

<scriptsrc="aurora.js"></script><scriptsrc="mp3.js"></script><!-- more codecs here -->

To use Aurora.js in Node.js or a browserify build, you can install it fromnpm:

npm install av

Then, require the module and codecs you need:

varAV=require('av');require('mp3');// more codecs here...

For much more detailed information on how to use Aurora.js, check out thedocumentation.

We usebrowserify to build Aurora.js. To build Aurora.jsfor the browser yourself, use the following commands:

npm installmake browser

This will place a builtaurora.js file, as well as a source map in thebuild/ directory.

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:

• FLAC.js
• ALAC.js
• MP3.js
• AAC.js

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

make browser_slim

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

Aurora.js is released under the MIT license.