@audio/auditory 1.0.0

package/LICENSE

@@ -0,0 +1,40 @@
+Kṛṣnized
+
+This is a reminder that, in the absolute sense, all results of work belong to the Supreme.
+
+While software and intellectual property (IP) require a formal license to define authorship,
+responsibilities, or distribution limitations, these are temporary material designations.
+The origin and destination of all ideas, as well as the ultimate owner of all results,
+is the Supreme. The most meaningful action is to dedicate these results to the Supreme.
+This process is known as Karma-Yoga and is described in BG 3.9, BG 12.10 and BG 18.46.
+
+"Work done as a sacrifice for the Supreme must be performed;
+otherwise, work binds one to the material world."
+
+This license does not override or alter the terms specified by the material-level license below.
+
+ॐ
+
+---
+
+MIT License
+
+Copyright (c) Dmitry Iv
+
+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/README.md

@@ -0,0 +1,13 @@
+# @audio/auditory
+
+> Auditory filterbanks — psychoacoustic frequency decompositions.
+
+| Package | What |
+|---|---|
+| `@audio/auditory-bark` | Bark-scale filterbank |
+| `@audio/auditory-erb` | ERB-scale filterbank |
+| `@audio/auditory-mel` | Mel-scale filterbank |
+| `@audio/auditory-gammatone` | Gammatone filterbank |
+| `@audio/auditory-octave` | IEC 61260 octave/fractional-octave bank |
+
+Extracted from [filter](https://github.com/audiojs/filter).

package/index.d.ts

@@ -0,0 +1,44 @@
+type Buf = Float32Array | Float64Array | number[]
+interface BiquadCoef { b0: number; b1: number; b2: number; a1: number; a2: number }
+type SOS = BiquadCoef[]
+
+export interface GammatoneParams {
+  fc?: number        // center frequency Hz (default 1000)
+  fs?: number        // sample rate (default 44100)
+  order?: number     // filter order (default 4)
+  [key: string]: unknown
+}
+
+/** Gammatone auditory filter — 4th-order cochlear model, in-place */
+export function gammatone(data: Buf, params: GammatoneParams): Buf
+
+export interface BankOpts {
+  fmin?: number      // lowest band center Hz
+  fmax?: number      // highest band center Hz
+}
+
+export interface ErbBankOpts extends BankOpts {
+  density?: number   // bands per ERB (default 1)
+}
+
+export interface OctaveBand { fc: number; coefs: SOS }
+export interface ErbBand    { fc: number; erb: number }
+export interface BarkBand   { bark: number; fLow: number; fHigh: number; fc: number; coefs: SOS }
+
+/** IEC 61260 fractional-octave filter bank. fraction default 3 (1/3-octave), fs default 44100, fmin/fmax default 31.25/16000 Hz */
+export function octaveBank(fraction?: number, fs?: number, opts?: BankOpts): OctaveBand[]
+
+/** ERB-spaced gammatone filter bank (Glasberg & Moore). fs default 44100, fmin/fmax default 50/min(16000, fs/2) Hz */
+export function erbBank(fs?: number, opts?: ErbBankOpts): ErbBand[]
+
+/** Bark-scale critical-band filter bank (Zwicker). fs default 44100, fmin/fmax default 20/min(15500, fs/2) Hz. A caller-supplied fmin below 20 Hz is honored as band 1's fLow instead of being clamped up. */
+export function barkBank(fs?: number, opts?: BankOpts): BarkBand[]
+
+export interface MelBankOpts extends BankOpts {
+  nFilters?: number   // number of mel filters (default 26)
+}
+
+export interface MelBand { fc: number; fLow: number; fHigh: number; mel: number }
+
+/** Mel-frequency triangular filter bank */
+export function melBank(fs?: number, opts?: MelBankOpts): MelBand[]

package/index.js

@@ -0,0 +1,8 @@
+// @audio/auditory — auditory filterbanks umbrella re-exporting every @audio/auditory-* atom.
+// For smaller bundles, depend directly on the individual atom.
+
+export { default as barkBank } from '@audio/auditory-bark'
+export { default as erbBank } from '@audio/auditory-erb'
+export { default as melBank } from '@audio/auditory-mel'
+export { default as gammatone } from '@audio/auditory-gammatone'
+export { default as octaveBank } from '@audio/auditory-octave'

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@audio/auditory",
+  "version": "1.0.0",
+  "type": "module",
+  "sideEffects": false,
+  "description": "Auditory filterbanks — umbrella for @audio/auditory-* atoms (bark, ERB, mel, gammatone, octave)",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "workspaces": [
+    "packages/*"
+  ],
+  "scripts": {
+    "test": "node test.js",
+    "test:all": "npm test --workspaces --if-present && npm test",
+    "publish:all": "npm publish --workspaces && npm publish"
+  },
+  "dependencies": {
+    "@audio/auditory-bark": "^1.0.0",
+    "@audio/auditory-erb": "^1.0.0",
+    "@audio/auditory-mel": "^1.0.0",
+    "@audio/auditory-gammatone": "^1.0.0",
+    "@audio/auditory-octave": "^1.0.0"
+  },
+  "devDependencies": {
+    "tst": "^9.4.0"
+  },
+  "keywords": [
+    "audio",
+    "dsp",
+    "auditory",
+    "filterbank",
+    "bark",
+    "erb",
+    "mel",
+    "gammatone",
+    "octave-band"
+  ],
+  "license": "MIT",
+  "author": "Dmitry Iv. <dfcreative@gmail.com>",
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}