@audio/quality 1.0.0 → 1.0.1
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/index.d.ts +76 -0
- package/package.json +6 -3
package/index.d.ts
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
/** Objective audio quality metrics — reference-vs-output comparison. */
|
|
2
|
+
|
|
3
|
+
export interface SegSnrOptions {
|
|
4
|
+
/** frame size, default 512 */
|
|
5
|
+
frameSize?: number
|
|
6
|
+
/** hop size, default frameSize/2 */
|
|
7
|
+
hopSize?: number
|
|
8
|
+
/** per-frame energy floor below which a frame is skipped as silent, default 1e-5 */
|
|
9
|
+
floor?: number
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export interface LsdOptions {
|
|
13
|
+
/** frame size, default 1024 */
|
|
14
|
+
frameSize?: number
|
|
15
|
+
/** hop size, default frameSize/2 */
|
|
16
|
+
hopSize?: number
|
|
17
|
+
/** fraction trimmed off each edge before comparing, default 0 */
|
|
18
|
+
trim?: number
|
|
19
|
+
/** per-frame energy floor below which a frame is skipped, default 1e-5 */
|
|
20
|
+
floor?: number
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export interface SpectralSimOptions {
|
|
24
|
+
/** frame size, default 1024 */
|
|
25
|
+
frameSize?: number
|
|
26
|
+
/** hop size, default frameSize/2 */
|
|
27
|
+
hopSize?: number
|
|
28
|
+
/** fraction trimmed off each edge before comparing, default 0.1 */
|
|
29
|
+
trim?: number
|
|
30
|
+
/** per-frame energy floor below which a frame is skipped, default 1e-5 */
|
|
31
|
+
floor?: number
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export interface ModulationDepthOptions {
|
|
35
|
+
/** envelope-follower window, default 2048 */
|
|
36
|
+
envWindow?: number
|
|
37
|
+
/** envelope-follower hop, default 256 */
|
|
38
|
+
envHop?: number
|
|
39
|
+
/** fraction trimmed off each edge, default 0.1 */
|
|
40
|
+
trim?: number
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
/** Global SNR, dB: 10*log10(sum(clean^2) / sum((clean-out)^2)). Infinity if out === clean exactly. */
|
|
44
|
+
export function snr(clean: Float32Array, out: Float32Array): number
|
|
45
|
+
|
|
46
|
+
/** Segmental SNR, dB: per-frame SNR clamped to [-10, 35], silent frames skipped (PESQ-style). */
|
|
47
|
+
export function segSnr(clean: Float32Array, out: Float32Array, options?: SegSnrOptions): number
|
|
48
|
+
|
|
49
|
+
/** Frame-averaged log-spectral distance, dB. ~1 dB transparent, 2-4 dB audible colouration, >5 dB degraded. */
|
|
50
|
+
export function lsd(a: Float32Array, b: Float32Array, options?: LsdOptions): number
|
|
51
|
+
|
|
52
|
+
/** Frame-averaged cosine similarity of magnitude spectra. 1 = identical. */
|
|
53
|
+
export function spectralSim(a: Float32Array, b: Float32Array, options?: SpectralSimOptions): number
|
|
54
|
+
|
|
55
|
+
/** Noise-floor RMS drop, dB, over [from, to). Positive = suppression worked. */
|
|
56
|
+
export function nrr(noisy: Float32Array, out: Float32Array, from?: number, to?: number): number
|
|
57
|
+
|
|
58
|
+
/** Clean-signal RMS drop, dB, over [from, to). Should be near 0. */
|
|
59
|
+
export function speechAttenuation(clean: Float32Array, out: Float32Array, from?: number, to?: number): number
|
|
60
|
+
|
|
61
|
+
/** Single-frequency energy via the Goertzel algorithm, 20% edges trimmed. Positional sample rate. */
|
|
62
|
+
export function goertzelEnergy(data: Float32Array, freq: number, sr: number): number
|
|
63
|
+
|
|
64
|
+
/** Ratio of min/max partial energies across freqs. 1 = balanced, 0 = one partial destroyed. Positional sample rate. */
|
|
65
|
+
export function chordBalance(data: Float32Array, freqs: number[], sr: number): number
|
|
66
|
+
|
|
67
|
+
/** Chord energy retained relative to a reference. 1 = no loss. Positional sample rate. */
|
|
68
|
+
export function chordRetention(data: Float32Array, ref: Float32Array, freqs: number[], sr: number): number
|
|
69
|
+
|
|
70
|
+
/** Per-partial AM depth — catches hop-rate beating ("crumble") that lsd misses. 0 = stable, ~0.3+ = obvious tremolo. Positional sample rate. */
|
|
71
|
+
export function modulationDepth(
|
|
72
|
+
data: Float32Array,
|
|
73
|
+
freqs: number[],
|
|
74
|
+
sr: number,
|
|
75
|
+
options?: ModulationDepthOptions
|
|
76
|
+
): number
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@audio/quality",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Objective audio quality metrics — SNR, segmental SNR, log-spectral distance, spectral similarity, noise-reduction ratio, per-partial modulation depth",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"sideEffects": false,
|
|
@@ -10,7 +10,8 @@
|
|
|
10
10
|
"./package.json": "./package.json"
|
|
11
11
|
},
|
|
12
12
|
"files": [
|
|
13
|
-
"index.js"
|
|
13
|
+
"index.js",
|
|
14
|
+
"index.d.ts"
|
|
14
15
|
],
|
|
15
16
|
"dependencies": {
|
|
16
17
|
"fourier-transform": "^2.2.0"
|
|
@@ -38,5 +39,7 @@
|
|
|
38
39
|
},
|
|
39
40
|
"publishConfig": {
|
|
40
41
|
"access": "public"
|
|
41
|
-
}
|
|
42
|
+
},
|
|
43
|
+
"types": "index.d.ts",
|
|
44
|
+
"funding": "https://github.com/sponsors/audiojs"
|
|
42
45
|
}
|