@audio/denoise-detect 0.1.4 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# @audio/denoise-detect [](https://www.npmjs.com/package/@audio/denoise-detect) [](https://github.com/krishnized/license)
|
|
2
|
+
|
|
3
|
+
denoise — content-aware auto-selector that classifies the dominant noise type
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
npm install @audio/denoise-detect
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
import denoise from '@audio/denoise-detect'
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Content-aware auto-selector. Runs a single STFT classification sweep over the input and dispatches to the most suitable method.
|
|
14
|
+
|
|
15
|
+
```js
|
|
16
|
+
denoise(data) // → cleaned Float32Array
|
|
17
|
+
denoise(data, { returnPlan: true }) // → { out, plan }
|
|
18
|
+
denoise(data, { force: 'wiener' }) // skip classifier
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
| Param | Default | |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `fs` | `44100` | Sample rate |
|
|
24
|
+
| `force` | — | One of `'dehum' \| 'declick' \| 'dewind' \| 'deesser' \| 'dereverb' \| 'omlsa' \| 'wiener'` |
|
|
25
|
+
| `returnPlan` | `false` | Return `{ out, plan }` with classifier scores + chosen method |
|
|
26
|
+
|
|
27
|
+
**Routing (in priority order):**
|
|
28
|
+
1. tonal hum (Goertzel — ≥2 of first 3 harmonics show 50× line/off-line ratio at 50 or 60 Hz)
|
|
29
|
+
2. impulses (excess kurtosis of AR residual > 12)
|
|
30
|
+
3. sibilance (high/mid band power ratio > 8)
|
|
31
|
+
4. LF rumble (low/mid band power ratio > 3)
|
|
32
|
+
5. non-stationary noise (frame-energy CV > 0.6) → omlsa
|
|
33
|
+
6. otherwise → wiener
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
Part of [@audio/denoise](https://github.com/audiojs/denoise) — the denoise family umbrella. This README is generated from the umbrella docs.
|
|
38
|
+
|
|
39
|
+
MIT © [audiojs](https://github.com/audiojs)
|