audio-decode 1.3.1 → 2.0.0

package/.github/workflows/test.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: test
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test

package/.travis.yml

@@ -1,13 +1,13 @@
-sudo: false
-language: node_js
-node_js:
-  - 'node'
-  - '6'
-  - '5'
-  - '4'
-matrix:
-  fast_finish: true
-  allow_failures:
-    - node_js: "4"
-    - node_js: "5"
-
+sudo: false
+language: node_js
+node_js:
+  - 'node'
+  - '6'
+  - '5'
+  - '4'
+matrix:
+  fast_finish: true
+  allow_failures:
+    - node_js: "4"
+    - node_js: "5"
+

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+Copyright (c) 2018 Dmitry Ivanov <df.creative@gmail.com>
+
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.
+

package/audio-decode.js

@@ -0,0 +1,63 @@
+/**
+ * Web-Audio-API decoder
+ * @module  audio-decode
+ */
+
+import getType from 'audio-type';
+import AudioBufferShim from 'audio-buffer';
+
+const AudioBuffer = globalThis.AudioBuffer || AudioBufferShim
+
+export default async function audioDecode (buf) {
+	if (!buf) throw Error('No decode target')
+	buf = new Uint8Array(buf.buffer || buf)
+
+	let type = getType(buf);
+
+	if (!type) throw Error('Cannot detect audio format');
+
+	if (!decoders[type]) throw Error('Missing decoder for ' + type + ' format')
+
+	return decoders[type](buf)
+};
+
+export const decoders = {
+	async oga(buf) {
+		let { OggVorbisDecoder } = await import('@wasm-audio-decoders/ogg-vorbis')
+		const decoder = new OggVorbisDecoder()
+		await decoder.ready;
+		return (decoders.oga = async buf => buf && createBuffer(await decoder.decodeFile(buf)))(buf)
+	},
+	async mp3(buf) {
+		const { MPEGDecoder } = await import('mpg123-decoder')
+		const decoder = new MPEGDecoder()
+		await decoder.ready;
+		return (decoders.mp3 = buf => buf && createBuffer(decoder.decode(buf)))(buf)
+	},
+	async flac(buf) {
+		const { FLACDecoder } = await import('@wasm-audio-decoders/flac')
+		const decoder = new FLACDecoder()
+		await decoder.ready;
+		return (decoders.mp3 = async buf => buf && createBuffer(await decoder.decode(buf)))(buf)
+	},
+	async opus(buf) {
+		const { OggOpusDecoder } = await import('ogg-opus-decoder')
+		const decoder = new OggOpusDecoder()
+		await decoder.ready;
+		return (decoders.opus = async buf => buf && createBuffer(await decoder.decodeFile(buf)))(buf)
+	},
+	async wav(buf) {
+		let {decode} = await import('node-wav')
+		return (decoders.wav = buf => buf && createBuffer(decode(buf)) )(buf)
+	}
+}
+
+function createBuffer({channelData, sampleRate}) {
+	let audioBuffer = new AudioBuffer({
+		sampleRate,
+		length: channelData[0].length,
+		numberOfChannels: channelData.length
+	})
+	for (let ch = 0; ch < channelData.length; ch++) audioBuffer.getChannelData(ch).set(channelData[ch])
+	return audioBuffer
+}

package/package.json

@@ -1,32 +1,26 @@
 {
   "name": "audio-decode",
-  "version": "1.3.1",
+  "version": "2.0.0",
   "description": "Decode audio data in node or browser",
-  "main": "index.js",
+  "main": "audio-decode.js",
+  "type": "module",
   "dependencies": {
-    "audio-buffer-utils": "^5.0.1",
-    "audio-context": "^1.0.1",
-    "audio-type": "^1.0.2",
-    "av": "^0.4.9",
-    "is-buffer": "^1.1.4",
-    "mp3": "^0.1.0",
-    "to-array-buffer": "^2.0.0",
-    "typedarray-to-buffer": "^3.1.2",
-    "wav-decoder": "^1.1.0"
+    "@wasm-audio-decoders/flac": "^0.1.3",
+    "@wasm-audio-decoders/ogg-vorbis": "^0.0.1",
+    "audio-buffer": "^5.0.0",
+    "audio-type": "^2.0.0",
+    "mpg123-decoder": "^0.4.3",
+    "node-wav": "^0.0.2",
+    "ogg-opus-decoder": "^1.5.3"
   },
-  "optionalDependencies": {},
   "devDependencies": {
     "audio-lena": "^2.0.0",
-    "audio-play": "^2.1.0",
-    "audio-speaker": "^1.4.3",
-    "tape": "^4.6.3"
+    "audio-speaker": "^1.5.0",
+    "tst": "^7.1.1"
   },
   "browser": "./browser.js",
   "scripts": {
-    "test": "node test.js",
-    "test:browser": "budo test.js",
-    "preversion": "npm run lint && npm run test",
-    "lint": "eslint *.js --ignore-pattern test*"
+    "test": "node test.js"
   },
   "repository": {
     "type": "git",
@@ -37,9 +31,15 @@
     "audio",
     "dsp",
     "decode",
+    "audio decode",
+    "audio decoder",
+    "web audio decoder",
     "codec",
     "mp3",
     "wav",
+    "ogg",
+    "vorbis",
+    "opus",
     "web-audio"
   ],
   "author": "ΔY <dfcreative@gmail.com>",

package/readme.md

@@ -1,59 +1,47 @@
-# audio-decode [![Build Status](https://travis-ci.org/audiojs/audio-decode.svg?branch=master)](https://travis-ci.org/audiojs/audio-decode) [![unstable](https://img.shields.io/badge/stability-unstable-green.svg)](http://github.com/badges/stability-badges) [![Greenkeeper badge](https://badges.greenkeeper.io/audiojs/audio-decode.svg)](https://greenkeeper.io/)
-
-Convert `mp3`/`wav` audio data to [AudioBuffer](https://github.com/audiojs/audio-buffer).
-
-[![npm install audio-decode](https://nodei.co/npm/audio-decode.png?mini=true)](https://npmjs.org/package/audio-decode/)
-
-```js
-const decode = require('audio-decode');
-const buffer = require('audio-lena/mp3');
-
-//as a callback
-decode(buffer, (err, audioBuffer) => {});
-
-//as a promise
-decode(buffer).then(audioBuffer => {}, err => {});
-```
-
-## API
-
-**`let promise = decode(source, {context}?, (err, audioBuffer)=>{}?)`**
-
-Decode `source`, based on `options` and fire `callback` when done, or resolve a promise if no callback passed. Source type can be: _ArrayBuffer_, _ArrayBufferView_, _Buffer_, _Blob_, _File_ or data-uri string.
-
-`options` may include `context` property for web-audio-api context (browser-only). By default new [audio-context](https://npmjs.org/package/audio-context) is created.
-
-## Supported formats
-
-Browser version uses [decodeAudioData](https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/decodeAudioData) method, in node the [aurora](https://npmjs.org/package/av) is used.
-
-Shipped by default:
-
-* _wav_ via [wav-decoder](https://github.com/mohayonao/wav-decoder)
-* _mp3_ via [aurora mp3](https://github.com/audiocogs/mp3.js)
-
-To enable additional format, install it as a dependency `npm install --save flac.js` and require once `require('flac.js')`.
-
-Additional formats available:
-
-* _flac_ via [flac.js](https://github.com/audiocogs/flac.js)
-* _alac_ via [alac.js](https://github.com/audiocogs/alac.js)
-* _aac_ via [aac.js](https://github.com/audiocogs/aac.js)
-* _vorbis_ via [vorbis.js](https://github.com/audiocogs/vorbis.js)
-* _ogg_ via [ogg.js](https://github.com/audiocogs/ogg.js)
-* _opus_ via [opus.js](https://github.com/audiocogs/opus.js)
-
-
-## Credits
-
-* [@mohayonao](https://github.com/mohayonao/) for [wav-decoder](https://github.com/mohayonao/wav-decoder).
-* [@devongovett](https://github.com/devongovett) and [@jensnockert](https://github.com/jensnockert) for [aurora.js](https://github.com/audiocogs/aurora.js).
-* [@jamen](https://github.com/jamen) as originator of this package.
-
-## Related
-
-* [context.decodeAudioData](https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/decodeAudioData) web-audio-api
-
-## License
-
-[MIT](LICENSE) &copy; <a href="https://github.com/audiojs">audiojs</a>.
+# audio-decode [![test](https://github.com/audiojs/audio-decode/actions/workflows/test.js.yml/badge.svg)](https://github.com/audiojs/audio-decode/actions/workflows/test.js.yml) [![stable](https://img.shields.io/badge/stability-unstable-green.svg)](http://github.com/badges/stability-badges)
+
+Decode audio data from supported format to [AudioBuffer](https://github.com/audiojs/audio-buffer).
+
+Supported formats:
+
+* [x] `wav`
+* [x] `mp3`
+* [x] `ogg vorbis`
+* [x] `flac`
+* [x] `opus`
+* [ ] `alac`
+* [ ] `aac`
+* [ ] `m4a`
+
+[![npm install audio-decode](https://nodei.co/npm/audio-decode.png?mini=true)](https://npmjs.org/package/audio-decode/)
+
+```js
+import decodeAudio from 'audio-decode';
+import buffer from 'audio-lena/mp3';
+
+let audioBuffer = await decode(buffer);
+```
+
+`buffer` type can be: _ArrayBuffer_, _Uint8Array_ or _Buffer_.
+
+Decoder's code is lazy, first run loads decoder's sources and compiles module, subsequent runs are fast.
+
+To get more granular control over individual decoders, use `decoders`:
+
+```js
+import decode, {decoders} from 'audio-decode';
+
+await decoders.mp3(); // load & compile decoder
+const audioBuffer = await decoders.mp3(mp3buf); // decode
+```
+
+## See also
+
+* [Wasm-audio-decoders](https://github.com/eshaz/wasm-audio-decoders) – best in class compact & fast WASM audio decoders.
+* [AudioDecoder](https://developer.mozilla.org/en-US/docs/Web/API/AudioDecoder) – native decoders API, hope one day will be fixed or alternatively polyfilled.
+* [decodeAudioData](https://github.com/eshaz/wasm-audio-decoders) – default in-browser decoding method.
+
+## License
+
+[MIT](LICENSE)&nbsp;&nbsp;•&nbsp;&nbsp;<a href="https://github.com/krishnized/license/">🕉</a>
+

package/test.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<script type="importmap">
+ {
+  "imports": {
+    "tst": "./node_modules/tst/tst.js",
+    "audio-type": "./node_modules/audio-type/audio-type.js",
+    "audio-buffer": "./node_modules/audio-buffer/index.js",
+    "audio-lena/wav.js": "./node_modules/audio-lena/wav.js",
+    "audio-lena/mp3.js": "./node_modules/audio-lena/mp3.js",
+    "audio-lena/ogg.js": "./node_modules/audio-lena/ogg.js",
+    "audio-lena/flac.js": "./node_modules/audio-lena/flac.js"
+  }
+ }
+</script>
+<script src="./test.js" type="module"></script>

package/test.js

@@ -1,109 +1,68 @@
-'use strict';
-
-const decode = require('./');
-const wav = require('audio-lena/wav');
-const mp3 = require('audio-lena/mp3');
-const raw = require('audio-lena/raw');
-const context = require('audio-context')();
-const play = require('audio-play');
-const t = require('tape');
-const isBrowser = require('is-browser')
-
-
-//as a callback
-t('wav buffer', function (t) {
-	decode(wav, (err, audioBuffer) => {
-		try {
-			play(audioBuffer, {end: 1}, () => t.end());
-		} catch (e) {
-			throw e;
-		}
-	});
-});
-
-t('mp3 buffer', function (t) {
-	decode(mp3, (err, audioBuffer) => {
-		try {
-			play(audioBuffer, {end: 1}, () => {
-				t.end()
-			});
-		} catch (e) {
-			throw e;
-		}
-	});
-});
-
-t('mp3 base64', t => {
-	decode(require('audio-lena/mp3-base64'), (err, buf) => {
-		if (err) t.fail(err)
-		t.end()
-	})
-})
-
-t('mp3 datauri', t => {
-	decode(require('audio-lena/mp3-datauri'), (err, buf) => {
-		if (err) t.fail(err)
-		t.end()
-	})
-})
-
-isBrowser && t('File', t => {
-	decode(new File([mp3], 'lena.mp3'), (err, audioBuffer) => {
-		try {
-			play(audioBuffer, {end: 1}, () => {
-				t.end()
-			});
-		} catch (e) {
-			throw e;
-		}
-	});
-})
-
-isBrowser && t('Blob', t => {
-	decode(new Blob([mp3]), (err, audioBuffer) => {
-		try {
-			play(audioBuffer, {end: 1}, () => {
-				t.end()
-			});
-		} catch (e) {
-			throw e;
-		}
-	});
-})
-
-t.skip('raw floats', function (t) {
-	decode(raw, (err, audioBuffer) => {
-		play(audioBuffer, {end: 1}, () => {
-			t.end()
-		});
-	})
-})
-
-t('promise', t => {
-	decode(wav).then(audioBuffer => {
-		play(audioBuffer, {end: 1}, () => {
-			t.end()
-		});
-	}, err => {
-		t.fail(err)
-	});
-})
-
-t('decode error', t => {
-	decode(new Float32Array(10)).then(data => {
-		t.fail(data)
-	}, err => {
-		t.ok(err)
-	})
-
-	decode(null).then(data => {
-		t.fail(data)
-	}, err => {
-		t.ok(err)
-	})
-
-	decode(require('audio-lena/mp3-base64') + 'xxx', (err, buf) => {
-		t.ok(err)
-		t.end()
-	})
-})
+
+import decode, {decoders} from './audio-decode.js';
+import wav from 'audio-lena/wav.js';
+import mp3 from 'audio-lena/mp3.js';
+import ogg from 'audio-lena/ogg.js';
+import flac from 'audio-lena/flac.js';
+import t, { is, throws } from 'tst';
+
+
+//as a callback
+t('wav buffer', async function (t) {
+	console.time('wav first')
+	await decoders.wav()
+	console.timeEnd('wav first')
+
+	console.time('wav second')
+	let audioBuffer = await decode(wav)
+	console.timeEnd('wav second')
+	is(audioBuffer.duration | 0, 12, 'wav duration')
+});
+
+t('mp3 buffer', async function (t) {
+	console.time('mp3 first')
+	await decoders.mp3()
+	console.timeEnd('mp3 first')
+
+	console.time('mp3 second')
+	let audioBuffer = await decode(mp3)
+	console.timeEnd('mp3 second')
+	is(audioBuffer.duration | 0, 12, 'mp3 duration')
+});
+
+t('ogg buffer', async function (t) {
+	console.time('ogg first')
+	let audioBuffer = await decode(ogg)
+	console.timeEnd('ogg first')
+	is(audioBuffer.duration | 0, 12, 'ogg duration')
+
+	console.time('ogg second')
+	audioBuffer = await decode(ogg)
+	console.timeEnd('ogg second')
+	is(audioBuffer.duration | 0, 12, 'ogg duration')
+});
+
+t('flac buffer', async function (t) {
+	console.time('flac first')
+	let audioBuffer = await decode(flac)
+	console.timeEnd('flac first')
+	is(audioBuffer.duration | 0, 12, 'flac duration')
+
+	console.time('flac second')
+	audioBuffer = await decode(flac)
+	console.timeEnd('flac second')
+	is(audioBuffer.duration | 0, 12, 'flac duration')
+});
+
+t('malformed data', async t => {
+	let log = []
+	try {
+		let x = await decode(new Float32Array(10))
+	} catch (e) { log.push('arr')}
+
+	try {
+		let x = await decode(null)
+	} catch (e) { log.push('null')}
+
+	is(log, ['arr', 'null'])
+})

package/.npmignore

@@ -1,2 +0,0 @@
-node_modules
-*.log

package/browser.js

@@ -1,48 +0,0 @@
-/**
- * Web-Audio-API decoder fn style
- *
- * @module  audio-decode
- */
-'use strict';
-
-const getContext = require('audio-context')
-const toAB = require('to-array-buffer')
-
-module.exports = decode;
-
-function decode (buffer, opts, cb) {
-	if (opts instanceof Function) {
-		cb = opts;
-		opts = {};
-	}
-
-	if (!opts) opts = {};
-
-	let ctx = opts.context || getContext();
-
-	//blob/file cases
-	if (buffer instanceof Blob) buffer = new File([buffer], 'decode')
-	if (buffer instanceof File) {
-		return new Promise((resolve, reject) => {
-			try {
-				let reader = new FileReader()
-				reader.readAsArrayBuffer(buffer)
-				reader.onload = () => {
-					return resolve(decode(reader.result, opts, cb))
-				}
-			} catch (e) {
-				reject(e)
-			}
-		})
-	}
-
-	if (!(buffer instanceof ArrayBuffer)) {
-		buffer = toAB(buffer)
-	}
-
-	return ctx.decodeAudioData(buffer, (buf) => {
-		cb && cb(null, buf);
-	}, (err) => {
-		cb && cb(err);
-	});
-}

package/index.js

@@ -1,67 +0,0 @@
-/**
- * Web-Audio-API decoder
- *
- * @module  audio-decode
- */
-'use strict';
-
-const getType = require('audio-type');
-const WavDecoder = require('wav-decoder');
-const util = require('audio-buffer-utils');
-const toArrayBuffer = require('to-array-buffer')
-const toBuffer = require('typedarray-to-buffer')
-const isBuffer = require('is-buffer');
-const AV = require('av');
-require('mp3');
-
-module.exports = (buffer, opts, cb) => {
-	if (opts instanceof Function) {
-		cb = opts;
-		opts = {};
-	}
-
-	if (!opts) opts = {};
-	if (!cb) cb = (() => {});
-
-	if (!isBuffer(buffer)) {
-		if (ArrayBuffer.isView(buffer)) buffer = toBuffer(buffer)
-		else {
-			buffer = Buffer.from(toArrayBuffer(buffer));
-		}
-	}
-
-	let type = getType(buffer);
-
-	if (!type) {
-		let err = Error('Cannot detect audio format of buffer');
-		cb(err);
-		return Promise.reject(err);
-	}
-
-	if (type === 'wav') {
-		return WavDecoder.decode(buffer).then(audioData => {
-			let audioBuffer = util.create(audioData.channelData, audioData.numberOfChannels, audioData.sampleRate);
-			cb(null, audioBuffer);
-			return Promise.resolve(audioBuffer);
-		}, err => {
-			cb(err);
-			return Promise.reject(err);
-		});
-	}
-
-	return new Promise((resolve, reject) => {
-		//handle other codecs by AV
-		let asset = AV.Asset.fromBuffer(buffer);
-
-		asset.on('error', err => {
-			cb(err)
-			reject(err)
-		})
-
-		asset.decodeToBuffer((buffer) => {
-			let data = util.create(buffer, asset.format.channelsPerFrame, asset.format.sampleRate)
-			cb(null, data);
-			resolve(data)
-		});
-	});
-};