decibri 3.0.0 → 3.1.0
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 +43 -0
- package/index.d.ts +26 -2
- package/index.js +52 -52
- package/package.json +5 -5
- package/src/decibri-output.js +1 -1
- package/src/decibri.js +63 -1
package/README.md
CHANGED
|
@@ -60,6 +60,49 @@ Requires Node.js >= 18. TypeScript definitions are bundled.
|
|
|
60
60
|
|
|
61
61
|
---
|
|
62
62
|
|
|
63
|
+
## Using from Rust
|
|
64
|
+
|
|
65
|
+
Most users want the npm package above. If you're building a Rust
|
|
66
|
+
application directly against the [`decibri`](https://crates.io/crates/decibri) crate on crates.io:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
cargo add decibri
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
The `vad` feature (enabled by default) uses ONNX Runtime via the
|
|
73
|
+
[`ort`](https://crates.io/crates/ort) crate. From 3.1.0 onwards, `ort` is
|
|
74
|
+
configured with `load-dynamic` by default, meaning ONNX Runtime is loaded
|
|
75
|
+
from a shared library at runtime. Choose one of:
|
|
76
|
+
|
|
77
|
+
- **Zero-config builds.** Opt into the download-binaries mode:
|
|
78
|
+
|
|
79
|
+
```toml
|
|
80
|
+
decibri = { version = "3.1", features = ["ort-download-binaries"], default-features = false }
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
Add back any other features you need (`capture`, `output`, `vad`,
|
|
84
|
+
`denoise`, `gain`). ORT is downloaded during `cargo build` and embedded
|
|
85
|
+
in your binary (the 3.0.x behaviour).
|
|
86
|
+
|
|
87
|
+
- **Production deployments with bundled ORT.** Take default features,
|
|
88
|
+
then either set `ORT_DYLIB_PATH=/path/to/libonnxruntime.{so,dylib,dll}`
|
|
89
|
+
before first use, or call `ort::init_from(path).commit()` at startup.
|
|
90
|
+
ONNX Runtime is initialized once per process. If your app creates
|
|
91
|
+
multiple `SileroVad` instances with different paths, the first one
|
|
92
|
+
wins and later paths are silently ignored. Pick one path and reuse it.
|
|
93
|
+
|
|
94
|
+
If you only need capture, output, or DSP (no Silero VAD), you won't pull
|
|
95
|
+
in `ort` at all:
|
|
96
|
+
|
|
97
|
+
```toml
|
|
98
|
+
decibri = { version = "3.1", features = ["capture", "output"], default-features = false }
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
See the [`ort` crate linking docs](https://ort.pyke.io/setup/linking)
|
|
102
|
+
for runtime-loading details.
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
63
106
|
## Quick Start
|
|
64
107
|
|
|
65
108
|
### Capture audio
|
package/index.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ export declare class DecibriBridge {
|
|
|
10
10
|
/** Whether the microphone is currently capturing. */
|
|
11
11
|
get isOpen(): boolean
|
|
12
12
|
/**
|
|
13
|
-
* Latest VAD speech probability (0.0
|
|
13
|
+
* Latest VAD speech probability (0.0 to 1.0). Updated by pump thread.
|
|
14
14
|
* Returns 0.0 if VAD is not active.
|
|
15
15
|
*/
|
|
16
16
|
get vadProbability(): number
|
|
@@ -40,7 +40,31 @@ export declare class DecibriOutputBridge {
|
|
|
40
40
|
static version(): VersionInfoJs
|
|
41
41
|
}
|
|
42
42
|
|
|
43
|
-
/**
|
|
43
|
+
/**
|
|
44
|
+
* Options passed from JS constructor.
|
|
45
|
+
*
|
|
46
|
+
* Note on `ort_library_path` (exposed to JS as `ortLibraryPath`): this is an
|
|
47
|
+
* internal plumbing field used by the JS wrapper in
|
|
48
|
+
* `npm/decibri/src/decibri.js`. The wrapper auto-resolves the bundled ORT
|
|
49
|
+
* dylib path via `require.resolve('@decibri/decibri-<platform>')` and passes
|
|
50
|
+
* the absolute path through to here so Rust's `ort::init_from` can load the
|
|
51
|
+
* correct library for the user's platform.
|
|
52
|
+
*
|
|
53
|
+
* The field is hidden from the auto-generated TypeScript definitions via
|
|
54
|
+
* `#[napi(skip_typescript)]` so TS/JS consumers do not see `ortLibraryPath`
|
|
55
|
+
* on the public options surface. It is still marshaled at runtime, so the
|
|
56
|
+
* JS wrapper can pass it through. Rationale: adding a typed public option
|
|
57
|
+
* later is non-breaking; removing one is breaking, so we default to not
|
|
58
|
+
* exposing it until a concrete use case arises.
|
|
59
|
+
*
|
|
60
|
+
* Users who need to override ORT resolution (e.g. point at a system ORT, or
|
|
61
|
+
* A/B between bundled and custom builds) should set the `ORT_DYLIB_PATH`
|
|
62
|
+
* environment variable before Node starts. That's the supported public
|
|
63
|
+
* mechanism.
|
|
64
|
+
*
|
|
65
|
+
* If this field is `None` (the default when not injected by the wrapper),
|
|
66
|
+
* Rust calls `ort::init()` which honours `ORT_DYLIB_PATH`.
|
|
67
|
+
*/
|
|
44
68
|
export interface DecibriOptions {
|
|
45
69
|
sampleRate?: number
|
|
46
70
|
channels?: number
|
package/index.js
CHANGED
|
@@ -77,8 +77,8 @@ function requireNative() {
|
|
|
77
77
|
try {
|
|
78
78
|
const binding = require('@decibri/decibri-android-arm64')
|
|
79
79
|
const bindingPackageVersion = require('@decibri/decibri-android-arm64/package.json').version
|
|
80
|
-
if (bindingPackageVersion !== '3.
|
|
81
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
80
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
81
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
82
82
|
}
|
|
83
83
|
return binding
|
|
84
84
|
} catch (e) {
|
|
@@ -93,8 +93,8 @@ function requireNative() {
|
|
|
93
93
|
try {
|
|
94
94
|
const binding = require('@decibri/decibri-android-arm-eabi')
|
|
95
95
|
const bindingPackageVersion = require('@decibri/decibri-android-arm-eabi/package.json').version
|
|
96
|
-
if (bindingPackageVersion !== '3.
|
|
97
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
96
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
97
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
98
98
|
}
|
|
99
99
|
return binding
|
|
100
100
|
} catch (e) {
|
|
@@ -114,8 +114,8 @@ function requireNative() {
|
|
|
114
114
|
try {
|
|
115
115
|
const binding = require('@decibri/decibri-win32-x64-gnu')
|
|
116
116
|
const bindingPackageVersion = require('@decibri/decibri-win32-x64-gnu/package.json').version
|
|
117
|
-
if (bindingPackageVersion !== '3.
|
|
118
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
117
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
118
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
119
119
|
}
|
|
120
120
|
return binding
|
|
121
121
|
} catch (e) {
|
|
@@ -130,8 +130,8 @@ function requireNative() {
|
|
|
130
130
|
try {
|
|
131
131
|
const binding = require('@decibri/decibri-win32-x64-msvc')
|
|
132
132
|
const bindingPackageVersion = require('@decibri/decibri-win32-x64-msvc/package.json').version
|
|
133
|
-
if (bindingPackageVersion !== '3.
|
|
134
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
133
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
134
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
135
135
|
}
|
|
136
136
|
return binding
|
|
137
137
|
} catch (e) {
|
|
@@ -147,8 +147,8 @@ function requireNative() {
|
|
|
147
147
|
try {
|
|
148
148
|
const binding = require('@decibri/decibri-win32-ia32-msvc')
|
|
149
149
|
const bindingPackageVersion = require('@decibri/decibri-win32-ia32-msvc/package.json').version
|
|
150
|
-
if (bindingPackageVersion !== '3.
|
|
151
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
150
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
151
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
152
152
|
}
|
|
153
153
|
return binding
|
|
154
154
|
} catch (e) {
|
|
@@ -163,8 +163,8 @@ function requireNative() {
|
|
|
163
163
|
try {
|
|
164
164
|
const binding = require('@decibri/decibri-win32-arm64-msvc')
|
|
165
165
|
const bindingPackageVersion = require('@decibri/decibri-win32-arm64-msvc/package.json').version
|
|
166
|
-
if (bindingPackageVersion !== '3.
|
|
167
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
166
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
167
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
168
168
|
}
|
|
169
169
|
return binding
|
|
170
170
|
} catch (e) {
|
|
@@ -182,8 +182,8 @@ function requireNative() {
|
|
|
182
182
|
try {
|
|
183
183
|
const binding = require('@decibri/decibri-darwin-universal')
|
|
184
184
|
const bindingPackageVersion = require('@decibri/decibri-darwin-universal/package.json').version
|
|
185
|
-
if (bindingPackageVersion !== '3.
|
|
186
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
185
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
186
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
187
187
|
}
|
|
188
188
|
return binding
|
|
189
189
|
} catch (e) {
|
|
@@ -198,8 +198,8 @@ function requireNative() {
|
|
|
198
198
|
try {
|
|
199
199
|
const binding = require('@decibri/decibri-darwin-x64')
|
|
200
200
|
const bindingPackageVersion = require('@decibri/decibri-darwin-x64/package.json').version
|
|
201
|
-
if (bindingPackageVersion !== '3.
|
|
202
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
201
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
202
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
203
203
|
}
|
|
204
204
|
return binding
|
|
205
205
|
} catch (e) {
|
|
@@ -214,8 +214,8 @@ function requireNative() {
|
|
|
214
214
|
try {
|
|
215
215
|
const binding = require('@decibri/decibri-darwin-arm64')
|
|
216
216
|
const bindingPackageVersion = require('@decibri/decibri-darwin-arm64/package.json').version
|
|
217
|
-
if (bindingPackageVersion !== '3.
|
|
218
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
217
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
218
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
219
219
|
}
|
|
220
220
|
return binding
|
|
221
221
|
} catch (e) {
|
|
@@ -234,8 +234,8 @@ function requireNative() {
|
|
|
234
234
|
try {
|
|
235
235
|
const binding = require('@decibri/decibri-freebsd-x64')
|
|
236
236
|
const bindingPackageVersion = require('@decibri/decibri-freebsd-x64/package.json').version
|
|
237
|
-
if (bindingPackageVersion !== '3.
|
|
238
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
237
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
238
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
239
239
|
}
|
|
240
240
|
return binding
|
|
241
241
|
} catch (e) {
|
|
@@ -250,8 +250,8 @@ function requireNative() {
|
|
|
250
250
|
try {
|
|
251
251
|
const binding = require('@decibri/decibri-freebsd-arm64')
|
|
252
252
|
const bindingPackageVersion = require('@decibri/decibri-freebsd-arm64/package.json').version
|
|
253
|
-
if (bindingPackageVersion !== '3.
|
|
254
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
253
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
254
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
255
255
|
}
|
|
256
256
|
return binding
|
|
257
257
|
} catch (e) {
|
|
@@ -271,8 +271,8 @@ function requireNative() {
|
|
|
271
271
|
try {
|
|
272
272
|
const binding = require('@decibri/decibri-linux-x64-musl')
|
|
273
273
|
const bindingPackageVersion = require('@decibri/decibri-linux-x64-musl/package.json').version
|
|
274
|
-
if (bindingPackageVersion !== '3.
|
|
275
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
274
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
275
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
276
276
|
}
|
|
277
277
|
return binding
|
|
278
278
|
} catch (e) {
|
|
@@ -287,8 +287,8 @@ function requireNative() {
|
|
|
287
287
|
try {
|
|
288
288
|
const binding = require('@decibri/decibri-linux-x64-gnu')
|
|
289
289
|
const bindingPackageVersion = require('@decibri/decibri-linux-x64-gnu/package.json').version
|
|
290
|
-
if (bindingPackageVersion !== '3.
|
|
291
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
290
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
291
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
292
292
|
}
|
|
293
293
|
return binding
|
|
294
294
|
} catch (e) {
|
|
@@ -305,8 +305,8 @@ function requireNative() {
|
|
|
305
305
|
try {
|
|
306
306
|
const binding = require('@decibri/decibri-linux-arm64-musl')
|
|
307
307
|
const bindingPackageVersion = require('@decibri/decibri-linux-arm64-musl/package.json').version
|
|
308
|
-
if (bindingPackageVersion !== '3.
|
|
309
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
308
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
309
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
310
310
|
}
|
|
311
311
|
return binding
|
|
312
312
|
} catch (e) {
|
|
@@ -321,8 +321,8 @@ function requireNative() {
|
|
|
321
321
|
try {
|
|
322
322
|
const binding = require('@decibri/decibri-linux-arm64-gnu')
|
|
323
323
|
const bindingPackageVersion = require('@decibri/decibri-linux-arm64-gnu/package.json').version
|
|
324
|
-
if (bindingPackageVersion !== '3.
|
|
325
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
324
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
325
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
326
326
|
}
|
|
327
327
|
return binding
|
|
328
328
|
} catch (e) {
|
|
@@ -339,8 +339,8 @@ function requireNative() {
|
|
|
339
339
|
try {
|
|
340
340
|
const binding = require('@decibri/decibri-linux-arm-musleabihf')
|
|
341
341
|
const bindingPackageVersion = require('@decibri/decibri-linux-arm-musleabihf/package.json').version
|
|
342
|
-
if (bindingPackageVersion !== '3.
|
|
343
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
342
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
343
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
344
344
|
}
|
|
345
345
|
return binding
|
|
346
346
|
} catch (e) {
|
|
@@ -355,8 +355,8 @@ function requireNative() {
|
|
|
355
355
|
try {
|
|
356
356
|
const binding = require('@decibri/decibri-linux-arm-gnueabihf')
|
|
357
357
|
const bindingPackageVersion = require('@decibri/decibri-linux-arm-gnueabihf/package.json').version
|
|
358
|
-
if (bindingPackageVersion !== '3.
|
|
359
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
358
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
359
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
360
360
|
}
|
|
361
361
|
return binding
|
|
362
362
|
} catch (e) {
|
|
@@ -373,8 +373,8 @@ function requireNative() {
|
|
|
373
373
|
try {
|
|
374
374
|
const binding = require('@decibri/decibri-linux-loong64-musl')
|
|
375
375
|
const bindingPackageVersion = require('@decibri/decibri-linux-loong64-musl/package.json').version
|
|
376
|
-
if (bindingPackageVersion !== '3.
|
|
377
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
376
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
377
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
378
378
|
}
|
|
379
379
|
return binding
|
|
380
380
|
} catch (e) {
|
|
@@ -389,8 +389,8 @@ function requireNative() {
|
|
|
389
389
|
try {
|
|
390
390
|
const binding = require('@decibri/decibri-linux-loong64-gnu')
|
|
391
391
|
const bindingPackageVersion = require('@decibri/decibri-linux-loong64-gnu/package.json').version
|
|
392
|
-
if (bindingPackageVersion !== '3.
|
|
393
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
392
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
393
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
394
394
|
}
|
|
395
395
|
return binding
|
|
396
396
|
} catch (e) {
|
|
@@ -407,8 +407,8 @@ function requireNative() {
|
|
|
407
407
|
try {
|
|
408
408
|
const binding = require('@decibri/decibri-linux-riscv64-musl')
|
|
409
409
|
const bindingPackageVersion = require('@decibri/decibri-linux-riscv64-musl/package.json').version
|
|
410
|
-
if (bindingPackageVersion !== '3.
|
|
411
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
410
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
411
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
412
412
|
}
|
|
413
413
|
return binding
|
|
414
414
|
} catch (e) {
|
|
@@ -423,8 +423,8 @@ function requireNative() {
|
|
|
423
423
|
try {
|
|
424
424
|
const binding = require('@decibri/decibri-linux-riscv64-gnu')
|
|
425
425
|
const bindingPackageVersion = require('@decibri/decibri-linux-riscv64-gnu/package.json').version
|
|
426
|
-
if (bindingPackageVersion !== '3.
|
|
427
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
426
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
427
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
428
428
|
}
|
|
429
429
|
return binding
|
|
430
430
|
} catch (e) {
|
|
@@ -440,8 +440,8 @@ function requireNative() {
|
|
|
440
440
|
try {
|
|
441
441
|
const binding = require('@decibri/decibri-linux-ppc64-gnu')
|
|
442
442
|
const bindingPackageVersion = require('@decibri/decibri-linux-ppc64-gnu/package.json').version
|
|
443
|
-
if (bindingPackageVersion !== '3.
|
|
444
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
443
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
444
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
445
445
|
}
|
|
446
446
|
return binding
|
|
447
447
|
} catch (e) {
|
|
@@ -456,8 +456,8 @@ function requireNative() {
|
|
|
456
456
|
try {
|
|
457
457
|
const binding = require('@decibri/decibri-linux-s390x-gnu')
|
|
458
458
|
const bindingPackageVersion = require('@decibri/decibri-linux-s390x-gnu/package.json').version
|
|
459
|
-
if (bindingPackageVersion !== '3.
|
|
460
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
459
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
460
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
461
461
|
}
|
|
462
462
|
return binding
|
|
463
463
|
} catch (e) {
|
|
@@ -476,8 +476,8 @@ function requireNative() {
|
|
|
476
476
|
try {
|
|
477
477
|
const binding = require('@decibri/decibri-openharmony-arm64')
|
|
478
478
|
const bindingPackageVersion = require('@decibri/decibri-openharmony-arm64/package.json').version
|
|
479
|
-
if (bindingPackageVersion !== '3.
|
|
480
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
479
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
480
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
481
481
|
}
|
|
482
482
|
return binding
|
|
483
483
|
} catch (e) {
|
|
@@ -492,8 +492,8 @@ function requireNative() {
|
|
|
492
492
|
try {
|
|
493
493
|
const binding = require('@decibri/decibri-openharmony-x64')
|
|
494
494
|
const bindingPackageVersion = require('@decibri/decibri-openharmony-x64/package.json').version
|
|
495
|
-
if (bindingPackageVersion !== '3.
|
|
496
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
495
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
496
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
497
497
|
}
|
|
498
498
|
return binding
|
|
499
499
|
} catch (e) {
|
|
@@ -508,8 +508,8 @@ function requireNative() {
|
|
|
508
508
|
try {
|
|
509
509
|
const binding = require('@decibri/decibri-openharmony-arm')
|
|
510
510
|
const bindingPackageVersion = require('@decibri/decibri-openharmony-arm/package.json').version
|
|
511
|
-
if (bindingPackageVersion !== '3.
|
|
512
|
-
throw new Error(`Native binding package version mismatch, expected 3.
|
|
511
|
+
if (bindingPackageVersion !== '3.1.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
|
|
512
|
+
throw new Error(`Native binding package version mismatch, expected 3.1.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
|
|
513
513
|
}
|
|
514
514
|
return binding
|
|
515
515
|
} catch (e) {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "decibri",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.1.0",
|
|
4
4
|
"description": "Cross-platform audio capture, output, and processing for Node.js and browsers",
|
|
5
5
|
"main": "src/decibri.js",
|
|
6
6
|
"types": "src/decibri.d.ts",
|
|
@@ -69,10 +69,10 @@
|
|
|
69
69
|
"README.md"
|
|
70
70
|
],
|
|
71
71
|
"optionalDependencies": {
|
|
72
|
-
"@decibri/decibri-win32-x64-msvc": "3.
|
|
73
|
-
"@decibri/decibri-darwin-arm64": "3.
|
|
74
|
-
"@decibri/decibri-linux-x64-gnu": "3.
|
|
75
|
-
"@decibri/decibri-linux-arm64-gnu": "3.
|
|
72
|
+
"@decibri/decibri-win32-x64-msvc": "3.1.0",
|
|
73
|
+
"@decibri/decibri-darwin-arm64": "3.1.0",
|
|
74
|
+
"@decibri/decibri-linux-x64-gnu": "3.1.0",
|
|
75
|
+
"@decibri/decibri-linux-arm64-gnu": "3.1.0"
|
|
76
76
|
},
|
|
77
77
|
"devDependencies": {
|
|
78
78
|
"@napi-rs/cli": "^3.0.0"
|
package/src/decibri-output.js
CHANGED
|
@@ -50,7 +50,7 @@ class DecibriOutput extends Writable {
|
|
|
50
50
|
} else if (typeof options.device === 'number') {
|
|
51
51
|
const devices = DecibriOutputBridge.devices();
|
|
52
52
|
if (options.device < 0 || options.device >= devices.length) {
|
|
53
|
-
throw new RangeError('device index out of range
|
|
53
|
+
throw new RangeError('device index out of range. Call DecibriOutput.devices() to list available devices');
|
|
54
54
|
}
|
|
55
55
|
resolvedDevice = options.device;
|
|
56
56
|
}
|
package/src/decibri.js
CHANGED
|
@@ -5,6 +5,61 @@ const path = require('path');
|
|
|
5
5
|
const fs = require('fs');
|
|
6
6
|
const { DecibriBridge } = require('../index.js');
|
|
7
7
|
|
|
8
|
+
// ─── Bundled ONNX Runtime path resolution ────────────────────────────────────
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Map (process.platform, process.arch) → { pkg: npm platform package name,
|
|
12
|
+
* file: bundled ORT dylib filename }
|
|
13
|
+
*
|
|
14
|
+
* Dylib filenames are unversioned across all platforms for consistency. The
|
|
15
|
+
* release workflow (.github/workflows/release.yml) copies Microsoft's
|
|
16
|
+
* versioned upstream tarball file (e.g. libonnxruntime.1.24.4.dylib) into the
|
|
17
|
+
* platform package with the unversioned name listed here.
|
|
18
|
+
*
|
|
19
|
+
* If you add a new platform, update this table AND the matching platform job
|
|
20
|
+
* in release.yml.
|
|
21
|
+
*/
|
|
22
|
+
const PLATFORM_DYLIB = {
|
|
23
|
+
'darwin-arm64': { pkg: '@decibri/decibri-darwin-arm64', file: 'libonnxruntime.dylib' },
|
|
24
|
+
'linux-x64': { pkg: '@decibri/decibri-linux-x64-gnu', file: 'libonnxruntime.so' },
|
|
25
|
+
'linux-arm64': { pkg: '@decibri/decibri-linux-arm64-gnu', file: 'libonnxruntime.so' },
|
|
26
|
+
'win32-x64': { pkg: '@decibri/decibri-win32-x64-msvc', file: 'onnxruntime.dll' },
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* Resolve the absolute path to the bundled ONNX Runtime shared library for
|
|
31
|
+
* this platform.
|
|
32
|
+
*
|
|
33
|
+
* Returns a string path on success. Returns undefined when:
|
|
34
|
+
* - the platform/arch pair is not in PLATFORM_DYLIB (unsupported target);
|
|
35
|
+
* - the platform package is not installed (MODULE_NOT_FOUND from
|
|
36
|
+
* require.resolve, e.g. during pre-publish development);
|
|
37
|
+
* - any other path-resolution error occurs.
|
|
38
|
+
*
|
|
39
|
+
* When this returns undefined, the Rust layer falls back to the
|
|
40
|
+
* ORT_DYLIB_PATH environment variable via ort::init(); if that is also
|
|
41
|
+
* missing, the first Silero VAD construction fails with a decibri-specific
|
|
42
|
+
* error message telling the user what to do.
|
|
43
|
+
*
|
|
44
|
+
* This function deliberately does NOT check that the dylib file exists on
|
|
45
|
+
* disk. If the platform package was installed but is missing the dylib,
|
|
46
|
+
* that's a packaging bug that should surface loudly via the Rust error path,
|
|
47
|
+
* not be silently masked here.
|
|
48
|
+
*/
|
|
49
|
+
function resolveBundledOrtPath() {
|
|
50
|
+
const entry = PLATFORM_DYLIB[`${process.platform}-${process.arch}`];
|
|
51
|
+
if (!entry) return undefined;
|
|
52
|
+
try {
|
|
53
|
+
// require.resolve on the package name gives us the absolute path of its
|
|
54
|
+
// main entry (the .node binary). path.dirname() yields the package dir
|
|
55
|
+
// where the bundled ORT dylib sits alongside.
|
|
56
|
+
const nodeBinaryPath = require.resolve(entry.pkg);
|
|
57
|
+
return path.join(path.dirname(nodeBinaryPath), entry.file);
|
|
58
|
+
} catch (_) {
|
|
59
|
+
return undefined;
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
|
|
8
63
|
// ─── RMS helper ──────────────────────────────────────────────────────────────
|
|
9
64
|
|
|
10
65
|
function computeRMS(chunk, format) {
|
|
@@ -76,7 +131,7 @@ class Decibri extends Readable {
|
|
|
76
131
|
} else if (typeof options.device === 'number') {
|
|
77
132
|
const devices = DecibriBridge.devices();
|
|
78
133
|
if (options.device < 0 || options.device >= devices.length) {
|
|
79
|
-
throw new RangeError('device index out of range
|
|
134
|
+
throw new RangeError('device index out of range. Call Decibri.devices() to list available devices');
|
|
80
135
|
}
|
|
81
136
|
resolvedDevice = options.device;
|
|
82
137
|
}
|
|
@@ -89,11 +144,17 @@ class Decibri extends Readable {
|
|
|
89
144
|
}
|
|
90
145
|
|
|
91
146
|
let modelPath = undefined;
|
|
147
|
+
let ortLibraryPath = undefined;
|
|
92
148
|
if (vadMode === 'silero' && options.vad) {
|
|
93
149
|
modelPath = options.modelPath || path.join(__dirname, '..', 'models', 'silero_vad.onnx');
|
|
94
150
|
if (!fs.existsSync(modelPath)) {
|
|
95
151
|
throw new Error(`Silero VAD model not found at ${modelPath}. Ensure the models/ directory is included in your installation.`);
|
|
96
152
|
}
|
|
153
|
+
// Internal plumbing: inject the bundled ORT dylib path into the napi
|
|
154
|
+
// constructor. If resolution fails (unknown platform, platform package
|
|
155
|
+
// not installed), leaves ortLibraryPath as undefined and lets Rust fall
|
|
156
|
+
// through to ORT_DYLIB_PATH or surface a decibri-specific init error.
|
|
157
|
+
ortLibraryPath = resolveBundledOrtPath();
|
|
97
158
|
}
|
|
98
159
|
|
|
99
160
|
// ── Store config ───────────────────────────────────────────────────────
|
|
@@ -117,6 +178,7 @@ class Decibri extends Readable {
|
|
|
117
178
|
device: resolvedDevice,
|
|
118
179
|
vadMode: (options.vad && vadMode === 'silero') ? 'silero' : 'energy',
|
|
119
180
|
modelPath,
|
|
181
|
+
ortLibraryPath,
|
|
120
182
|
});
|
|
121
183
|
}
|
|
122
184
|
|