@audio/amr-decode 1.0.0

package/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty
+percent (50%) or more of the outstanding shares, or (iii) beneficial
+ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source,
+and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation
+or translation of a Source form, including but not limited to compiled
+object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that
+is included in or attached to the work (an example is provided in the
+Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form,
+that is based on (or derived from) the Work and for which the editorial
+revisions, annotations, elaborations, or other modifications represent, as
+a whole, an original work of authorship. For the purposes of this License,
+Derivative Works shall not include works that remain separable from, or
+merely link (or bind by name) to the interfaces of, the Work and Derivative
+Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the
+purposes of this definition, "submitted" means any form of electronic,
+verbal, or written communication sent to the Licensor or its
+representatives, including but not limited to communication on electronic
+mailing lists, source code control systems, and issue tracking systems that
+are managed by, or on behalf of, the Licensor for the purpose of discussing
+and improving the Work, but excluding communication that is conspicuously
+marked or otherwise designated in writing by the copyright owner as "Not a
+Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on
+behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in
+this section) patent license to make, have made, use, offer to sell, sell,
+import, and otherwise transfer the Work, where such license applies only to
+those patent claims licensable by such Contributor that are necessarily
+infringed by their Contribution(s) alone or by combination of their
+Contribution(s) with the Work to which such Contribution(s) was submitted.
+If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or
+contributory patent infringement, then any patent licenses granted to You
+under this License for that Work shall terminate as of the date such
+litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and
+in Source or Object form, provided that You meet the following conditions:
+
+   1. You must give any other recipients of the Work or Derivative Works a
+copy of this License; and
+
+   2. You must cause any modified files to carry prominent notices stating
+that You changed the files; and
+
+   3. You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from
+the Source form of the Work, excluding those notices that do not pertain to
+any part of the Derivative Works; and
+
+   4. If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must include a
+readable copy of the attribution notices contained within such NOTICE file,
+excluding those notices that do not pertain to any part of the Derivative
+Works, in at least one of the following places: within a NOTICE text file
+distributed as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or, within a
+display generated by the Derivative Works, if and wherever such third-party
+notices normally appear. The contents of the NOTICE file are for
+informational purposes only and do not modify the License. You may add Your
+own attribution notices within Derivative Works that You distribute,
+alongside or as an addendum to the NOTICE text from the Work, provided that
+such additional attribution notices cannot be construed as modifying the
+License.
+
+You may add Your own copyright statement to Your modifications and may
+provide additional or different license terms and conditions for use,
+reproduction, or distribution of Your modifications, or for any such
+Derivative Works as a whole, provided Your use, reproduction, and
+distribution of the Work otherwise complies with the conditions stated in
+this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to
+the Licensor shall be under the terms and conditions of this License,
+without any additional terms or conditions. Notwithstanding the above,
+nothing herein shall supersede or modify the terms of any separate license
+agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor, except
+as required for reasonable and customary use in describing the origin of
+the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to
+in writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any
+warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or
+FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for
+determining the appropriateness of using or redistributing the Work and
+assume any risks associated with Your exercise of permissions under this
+License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether
+in tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to
+in writing, shall any Contributor be liable to You for damages, including
+any direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or
+inability to use the Work (including but not limited to damages for loss of
+goodwill, work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor has been
+advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the
+Work or Derivative Works thereof, You may choose to offer, and charge a fee
+for, acceptance of support, warranty, indemnity, or other liability
+obligations and/or rights consistent with this License. However, in
+accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if
+You agree to indemnify, defend, and hold each Contributor harmless for any
+liability incurred by, or claims asserted against, such Contributor by
+reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included
+on the same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain a
+ copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable
+ law or agreed to in writing, software distributed under the License is
+ distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the specific language
+ governing permissions and limitations under the License.

package/README.md

@@ -0,0 +1,65 @@
+# amr-decode
+
+Decode AMR-NB and AMR-WB audio to PCM float samples. [opencore-amr](https://sourceforge.net/projects/opencore-amr/) compiled to WASM — works in Node.js and browsers.
+
+Part of [audio-decode](https://github.com/audiojs/audio-decode).
+
+## Install
+
+```
+npm i @audio/amr-decode
+```
+
+## Usage
+
+```js
+import decode from '@audio/amr-decode'
+
+// AMR-NB or AMR-WB — auto-detected from file header
+let { channelData, sampleRate } = await decode(amrBuffer)
+// AMR-NB: 8000 Hz mono
+// AMR-WB: 16000 Hz mono
+```
+
+### Streaming
+
+```js
+import { decoder } from '@audio/amr-decode'
+
+let dec = await decoder()
+let result = dec.decode(chunk)
+dec.free()
+```
+
+## API
+
+### `decode(src): Promise<AudioData>`
+
+Whole-file decode. Accepts `Uint8Array` or `ArrayBuffer`. Auto-detects AMR-NB (`#!AMR\n`) vs AMR-WB (`#!AMR-WB\n`).
+
+### `decoder(): Promise<AMRDecoder>`
+
+Creates a decoder instance.
+
+- **`dec.decode(data)`** — decode chunk, returns `{ channelData, sampleRate }`
+- **`dec.flush()`** — flush (returns empty)
+- **`dec.free()`** — release WASM memory
+
+## Formats
+
+- AMR-NB — 8 kHz, modes 0–7 (4.75–12.2 kbps)
+- AMR-WB — 16 kHz, modes 0–8 (6.6–23.85 kbps)
+
+## Building WASM
+
+The WASM binary is prebuilt in `src/amr.wasm.cjs`. To rebuild:
+
+```
+npm run build
+```
+
+This auto-fetches opencore-amr 0.1.6 source and compiles with Emscripten.
+
+## License
+
+Apache-2.0 (opencore-amr) — [krishnized](https://github.com/krishnized/license)

package/amr-decode.d.ts

@@ -0,0 +1,16 @@
+interface AudioData {
+  channelData: Float32Array[];
+  sampleRate: number;
+}
+
+interface AMRDecoder {
+  decode(data: Uint8Array): AudioData;
+  flush(): AudioData;
+  free(): void;
+}
+
+/** Whole-file decode — auto-detects AMR-NB vs AMR-WB */
+export default function decode(src: ArrayBuffer | Uint8Array): Promise<AudioData>;
+
+/** Create decoder instance */
+export function decoder(): Promise<AMRDecoder>;

package/amr-decode.js

@@ -0,0 +1,148 @@
+/**
+ * AMR decoder — opencore-amr compiled to WASM
+ * Decodes AMR-NB (8kHz) and AMR-WB (16kHz) audio files
+ *
+ * let { channelData, sampleRate } = await decode(amrbuf)
+ */
+
+let _modP
+
+async function getMod() {
+	if (_modP) return _modP
+	let p = (async () => {
+		let createAMR
+		if (typeof process !== 'undefined' && process.versions?.node) {
+			let m = 'module'
+			let { createRequire } = await import(m)
+			createAMR = createRequire(import.meta.url)('./src/amr.wasm.cjs')
+		} else {
+			let mod = await import('./src/amr.wasm.cjs')
+			createAMR = mod.default || mod
+		}
+		return createAMR()
+	})()
+	_modP = p
+	try { return await p }
+	catch (e) { _modP = null; throw e }
+}
+
+/**
+ * Whole-file decode
+ * @param {Uint8Array|ArrayBuffer} src
+ * @returns {Promise<{channelData: Float32Array[], sampleRate: number}>}
+ */
+export default async function decode(src) {
+	let buf = src instanceof Uint8Array ? src : new Uint8Array(src)
+	let dec = await decoder()
+	try {
+		return dec.decode(buf)
+	} finally {
+		dec.free()
+	}
+}
+
+/**
+ * Create decoder instance
+ * @returns {Promise<{decode(chunk: Uint8Array): {channelData, sampleRate}, flush(), free()}>}
+ */
+export async function decoder() {
+	return new AMRDecoder(await getMod())
+}
+
+const EMPTY = Object.freeze({ channelData: [], sampleRate: 0 })
+
+// AMR-NB frame sizes (bytes, incl. header) indexed by mode 0-15
+const NB_SIZES = [13, 14, 16, 18, 20, 21, 27, 32, 6, 6, 6, 6, 1, 1, 1, 1]
+// AMR-WB frame sizes (bytes, incl. header) indexed by mode 0-15
+const WB_SIZES = [18, 24, 33, 37, 41, 47, 51, 59, 61, 6, 1, 1, 1, 1, 1, 1]
+
+class AMRDecoder {
+	constructor(mod) {
+		this.m = mod
+		this.done = false
+		this._ptr = 0
+		this._cap = 0
+	}
+
+	decode(data) {
+		if (this.done) throw Error('Decoder already freed')
+		if (!data?.length) return EMPTY
+
+		let buf = data instanceof Uint8Array ? data : new Uint8Array(data)
+
+		// detect AMR-NB "#!AMR\n" or AMR-WB "#!AMR-WB\n"
+		let isWB = false, off = 0
+		if (buf.length > 6 &&
+			buf[0] === 0x23 && buf[1] === 0x21 &&
+			buf[2] === 0x41 && buf[3] === 0x4D && buf[4] === 0x52) {
+			if (buf.length > 9 &&
+				buf[5] === 0x2D && buf[6] === 0x57 && buf[7] === 0x42 && buf[8] === 0x0A) {
+				isWB = true
+				off = 9
+			} else if (buf[5] === 0x0A) {
+				off = 6
+			}
+		}
+
+		if (!off) return EMPTY // no valid AMR header
+
+		let m = this.m
+		let sampleRate = isWB ? 16000 : 8000
+		let sizes = isWB ? WB_SIZES : NB_SIZES
+
+		let h = isWB ? m._amr_wb_create() : m._amr_nb_create()
+		let chunks = []
+
+		while (off < buf.length) {
+			let mode = (buf[off] >> 3) & 0x0F
+			let frameSize = sizes[mode]
+			if (!frameSize || off + frameSize > buf.length) break
+
+			let ptr = this._alloc(frameSize)
+			m.HEAPU8.set(buf.subarray(off, off + frameSize), ptr)
+
+			let n = isWB
+				? m._amr_wb_decode(h, ptr, frameSize)
+				: m._amr_nb_decode(h, ptr, frameSize)
+
+			let outPtr = isWB ? m._amr_wb_output() : m._amr_nb_output()
+			chunks.push(new Float32Array(m.HEAPF32.buffer, outPtr, n).slice())
+
+			off += frameSize
+		}
+
+		if (isWB) m._amr_wb_close(h)
+		else m._amr_nb_close(h)
+
+		if (!chunks.length) return EMPTY
+
+		let total = 0
+		for (let c of chunks) total += c.length
+		let out = new Float32Array(total)
+		let pos = 0
+		for (let c of chunks) { out.set(c, pos); pos += c.length }
+
+		return { channelData: [out], sampleRate }
+	}
+
+	flush() { return EMPTY }
+
+	free() {
+		if (this.done) return
+		this.done = true
+		if (this._ptr) {
+			this.m._free(this._ptr)
+			this._ptr = 0
+			this._cap = 0
+		}
+	}
+
+	_alloc(len) {
+		if (len > this._cap) {
+			if (this._ptr) this.m._free(this._ptr)
+			this._cap = len
+			this._ptr = this.m._malloc(len)
+		}
+		return this._ptr
+	}
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@audio/amr-decode",
+  "version": "1.0.0",
+  "description": "Decode AMR-NB/WB audio via opencore-amr WASM",
+  "type": "module",
+  "main": "amr-decode.js",
+  "types": "amr-decode.d.ts",
+  "exports": {
+    ".": "./amr-decode.js",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "bash build.sh",
+    "prepack": "npm run build",
+    "test": "node test.js"
+  },
+  "files": [
+    "amr-decode.js",
+    "amr-decode.d.ts",
+    "src/amr.wasm.cjs",
+    "LICENSE"
+  ],
+  "keywords": [
+    "amr",
+    "amr-nb",
+    "amr-wb",
+    "audio",
+    "decode",
+    "decoder",
+    "wasm",
+    "opencore-amr",
+    "speech"
+  ],
+  "publishConfig": { "access": "public" },
+  "license": "Apache-2.0",
+  "author": "audiojs",
+  "homepage": "https://github.com/audiojs/amr-decode#readme",
+  "bugs": "https://github.com/audiojs/amr-decode/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/audiojs/amr-decode.git"
+  },
+  "engines": {
+    "node": ">=16"
+  }
+}