@audio/denoise-detect 0.1.7 → 0.1.9

package/denoise.js

@@ -30,8 +30,8 @@ export const deesser = (data, params = {}) => {
   data.set(deesser_(data, {
     sampleRate: params.fs || 44100,
     mode: 'band',
-    freq: params.freq ?? 6000,
-    q: params.Q ?? 1.4,
+    fc: params.fc ?? params.freq ?? 6000,   // `freq`: former name
+    Q: params.Q ?? 1.4,
     threshold: params.threshold ?? -30,
     ratio: params.ratio ?? 4,
     attack: (params.attack ?? 0.001) * 1000,

package/index.d.ts

@@ -0,0 +1,71 @@
+/** Content-aware auto-selector — classifies the dominant noise type and dispatches to the matching method. */
+export type DenoiseMethod = 'dehum' | 'declick' | 'dewind' | 'deesser' | 'dereverb' | 'omlsa' | 'wiener'
+
+export interface ClassifyScores {
+  /** hit count (0-3) of mains harmonics with ≥50× line/off-line ratio */
+  hum: number
+  /** 50 or 60 */
+  humFreq: number
+  /** peak excess kurtosis of AR residual across scanned windows */
+  click: number
+  /** low/mid band power ratio */
+  lf: number
+  /** high/mid (sibilance) band power ratio */
+  hi: number
+  /** CV of the frame-energy floor — low = stationary noise bed */
+  stationarity: number
+}
+
+export interface Plan {
+  method: DenoiseMethod
+  /** empty when `force` skipped classification */
+  scores: ClassifyScores | Record<string, never>
+  /** present only when classification ran */
+  humFreq?: number
+}
+
+export interface DenoiseOptions {
+  /** sample rate (Hz), default 44100 */
+  fs?: number
+  /** skip classification, force a method */
+  force?: DenoiseMethod
+  /** return { out, plan } instead of just the cleaned buffer */
+  returnPlan?: boolean
+  /** additional per-method params, passed through to the dispatched method */
+  [param: string]: unknown
+}
+
+export interface DenoiseResult {
+  out: Float32Array
+  plan: Plan
+}
+
+/** Classify the dominant noise type and clean it with the matching method. */
+export default function denoise(data: Float32Array, params?: DenoiseOptions & { returnPlan?: false }): Float32Array
+export default function denoise(data: Float32Array, params: DenoiseOptions & { returnPlan: true }): DenoiseResult
+
+/** Run the classification sweep only (no cleaning). */
+export function classify(data: Float32Array, fs?: number): Plan
+
+export interface DeesserOptions {
+  /** sample rate (Hz), default 44100 */
+  fs?: number
+  /** center frequency (Hz), default 6000 */
+  fc?: number
+  /** @deprecated former name of `fc` */
+  freq?: number
+  /** notch Q, default 1.4 */
+  Q?: number
+  /** dB, default -30 */
+  threshold?: number
+  /** default 4 */
+  ratio?: number
+  /** seconds, default 0.001 */
+  attack?: number
+  /** seconds, default 0.05 */
+  release?: number
+  block?: number
+}
+
+/** De-esser adapter over @audio/dynamics-deesser (band mode). Processes in place; returns the same buffer. */
+export function deesser(data: Float32Array, params?: DeesserOptions): Float32Array

package/package.json

@@ -1,24 +1,29 @@
 {
   "name": "@audio/denoise-detect",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "denoise — content-aware auto-selector that classifies the dominant noise type",
   "type": "module",
   "sideEffects": false,
   "main": "denoise.js",
   "exports": {
-    ".": "./denoise.js",
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./denoise.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [
-    "denoise.js"
+    "denoise.js",
+    "index.d.ts"
   ],
+  "types": "index.d.ts",
   "dependencies": {
     "@audio/denoise-wiener": "^0.1.0",
     "@audio/denoise-omlsa": "^0.1.0",
     "@audio/denoise-dehum": "^0.1.0",
     "@audio/denoise-declick": "^0.1.0",
     "@audio/denoise-dewind": "^0.1.0",
-    "@audio/dynamics-deesser": "^0.2.3",
+    "@audio/dynamics-deesser": "^0.2.7",
     "@audio/denoise-dereverb": "^0.1.0",
     "@audio/lpc": "^1.0.0",
     "@audio/stft": "^1.0.3"
@@ -46,5 +51,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "funding": "https://github.com/sponsors/audiojs"
 }