decibri 5.4.0 → 5.5.0

package/CHANGELOG.md

@@ -9,6 +9,32 @@ For other decibri packages, see:
 - Rust core: [crates/decibri/CHANGELOG.md](../../crates/decibri/CHANGELOG.md)
 - Python package: [bindings/python/CHANGELOG.md](../../bindings/python/CHANGELOG.md)
 
+## [5.5.0] - 2026-08-10
+
+### Breaking changes
+
+- **The `RangeError` thrown for a `channels` count below 1 carries the message `channels must be at least 1`.** It carried `channels must be between 1 and 32`, naming an upper bound that neither `Microphone` nor `Speaker` enforces. Code that matches the message text exactly stops matching and has to be updated to the new text. Nothing else about the error moves: it is still a `RangeError`, thrown for the same input, `channels: 0` on either constructor or `open()`.
+- **`Speaker` accepts a `channels` count above 32.** It threw `RangeError: channels must be between 1 and 32` from the constructor. It now accepts any count above zero, offers the count to the device when playback starts, and a device that cannot serve it emits a `DecibriError` with code `SPEAKER_CHANNELS_UNSUPPORTED` on the `'error'` event, or rejects `writeAsync()` with it. Code that relied on the constructor throwing to reject an unsupported output channel count has to handle the failure asynchronously instead, on `'error'` or the rejection. `new Speaker({ channels: 0 })` still throws a `RangeError` from the constructor, and a count above 16383 still carries `STREAM_OPEN_FAILED` naming that limit. How many channels a device serves depends on the `sampleRate` asked for as well as the count.
+- **An output channel count above the device's reported figure carries `SPEAKER_CHANNELS_UNSUPPORTED`.** It carried `STREAM_OPEN_FAILED`. Code branching on `STREAM_OPEN_FAILED` to detect an unsupported output channel count has to match `SPEAKER_CHANNELS_UNSUPPORTED` as well, and cannot drop `STREAM_OPEN_FAILED`, because a device that reports no figure at all keeps `STREAM_OPEN_FAILED` for the same condition. `STREAM_OPEN_FAILED` is otherwise unchanged and remains the code for an output open that failed for any other reason.
+- **The browser `Microphone` rejects a `channels` count above 1.** It accepted 1 to 32 and delivered the first channel only, with nothing to indicate the rest were dropped. A count above 1 now throws `RangeError: multichannel capture is not supported; channels must be 1 (mono)`, and a count below 1 throws `RangeError: channels must be at least 1` where it threw a `TypeError`. Code passing a count above 1 to the browser entry has to pass 1 and mix down its own sources, or read the single channel it was already receiving. `channels: 1` is unchanged, as is every other browser `Microphone` option. Both class and message now match the Node entry's for the same values, so the two entries reject the same input the same way.
+- The browser `Speaker` is unchanged. It still accepts 1 to 32 channels, the range the Web Audio specification requires an implementation to support, and keeps its own `channels must be between 1 and 32, got <n>` message, which that range does enforce.
+
+### Added
+
+- Error code `SPEAKER_CHANNELS_UNSUPPORTED` on `DecibriError`, for an output device that cannot serve the requested `channels`. The message names the count asked for, the count the device reports (the figure `SpeakerInfo.maxOutputChannels` carries) and the platform's own message.
+- `referenceChannels` on the `aec` option object: the channel count of the far-end reference pushed through `pushAecReference`. Default 1 (mono). With a count above 1 the pushed samples are read as interleaved frames and each frame is averaged to one mono sample before the canceller sees it. The collapse is opt-in: a caller pushing a multichannel reference must declare the count, and an undeclared multichannel push keeps its current behaviour, cancelling nothing and reporting no error. The declared count must match the pushed buffer: a mismatch is not detected and raises no error, and shows up only as `aecMetrics().delaySamples` staying `null` with no fault reported. A count below 1 throws a `RangeError`; the only ceiling is the option's own 16-bit carrier. A mono reference against playback through more than one loudspeaker has a cancellation ceiling: the canceller models one room response applied to the channel average, so a placement where the per-loudspeaker echo paths differ leaves a residual that adaptation does not remove.
+- Each of the four platform packages (`@decibri/decibri-win32-x64-msvc`, `@decibri/decibri-darwin-arm64`, `@decibri/decibri-linux-x64-gnu`, `@decibri/decibri-linux-arm64-gnu`) now includes `THIRD-PARTY-NOTICES.md`, the third-party license notices for the ONNX Runtime dynamic libraries the package carries and for the third-party material incorporated into them, with a source-availability statement for the MPL-2.0-licensed Eigen code they contain.
+- `models/THIRD-PARTY-NOTICES.md`, carrying the origin, version and license text for the two bundled ONNX models together with the training-data attribution the denoise checkpoint requires. It ships beside the weights it covers. `models/README.md` alongside it documents each model's tensor interface and points at the notice.
+
+### Changed
+
+- ONNX Runtime telemetry is disabled on the environment decibri commits when it initializes the runtime, where it was left at ONNX Runtime's own default of enabled. This covers every path that reaches the runtime: `vad: 'silero'` and the ACE `denoise` stage. Set `DECIBRI_ORT_TELEMETRY=1` in the environment before first use to leave it enabled; every other value, an empty value, and an absent variable leave it disabled. Two limits apply on Windows and decibri can close neither. ONNX Runtime logs one process-information event while the environment is being created, before the setting is applied, and logs it once per process, so that event is emitted whichever way the setting is left. The runtime also assigns its telemetry state from the Windows tracing session through an ETW callback, so the platform can re-enable telemetry after decibri has disabled it. On other platforms ONNX Runtime's telemetry provider does nothing. The browser build has no ONNX Runtime and is unaffected. No option, event, method or error text changes.
+
+### Fixed
+
+- The bundled Silero VAD model is documented as v6.2, the version that ships. The `model` field on `VadOptions`, the `vad` option on `MicrophoneOptions`, the README and the notice beside the model named v5. Which model file ships is unchanged.
+- The Silero VAD tensor specification in `models/README.md` names the tensors the model exposes: `input`, `state` and `sr` in, `output` and `stateN` out. It described a four-input form carrying separate `h` and `c` LSTM tensors.
+
 ## [5.4.0] - 2026-08-04
 
 ### Added

package/README.md

@@ -152,7 +152,7 @@ Creates a Writable stream for speaker playback.
 | Option | Type | Default | Description |
 | --- | --- | --- | --- |
 | `sampleRate` | number | 16000 | Playback sample rate (1000 to 384000) |
-| `channels` | number | 1 | Output channels (1 to 32) |
+| `channels` | number | 1 | Output channels (1 or more, up to what the device supports) |
 | `dtype` | `'int16'` \| `'float32'` | `'int16'` | Sample encoding of incoming data |
 | `device` | number, string, or `{ id: string }` | system default | Output device index, case-insensitive name substring, or stable per-host ID |
 
@@ -293,7 +293,7 @@ mic.on('silence', () => console.log('silent'));
 
 ### Silero mode
 
-ML-based detection using the Silero VAD v5 model. More accurate than energy mode, especially in noisy environments.
+ML-based detection using the Silero VAD v6.2 model. More accurate than energy mode, especially in noisy environments.
 
 ```javascript
 const mic = new Microphone({ vad: { model: 'silero', threshold: 0.5 } });
@@ -337,6 +337,14 @@ setTimeout(() => mic.stop(), 5000);
 
 VAD reads the signal before the chain, so `vadScore` and the `'speech'` / `'silence'` events are unaffected by which conditioning stages you enable. The conditioning chain runs in the native Node.js capture path; the browser build does not include it.
 
+## ONNX Runtime telemetry
+
+Silero mode (`vad: 'silero'`) and the ACE `denoise` stage run on ONNX Runtime, which carries its own telemetry, separate from anything decibri does. Decibri disables it on the environment it commits when it initializes the runtime. Set `DECIBRI_ORT_TELEMETRY=1` in the environment before first use to leave it enabled; every other value, an empty value, and an absent variable leave it disabled.
+
+Two limits apply on Windows and decibri can close neither, so decibri does not claim that no telemetry is emitted. ONNX Runtime logs one process-information event while the environment is being created, before the setting is applied, and logs it once per process, so that event is emitted whichever way the setting is left. The runtime also assigns its telemetry state from the Windows tracing session through an ETW callback, so the platform can re-enable telemetry after decibri has disabled it. On other platforms ONNX Runtime's telemetry provider does nothing.
+
+Neither ONNX Runtime nor this setting applies to the browser build, which has no ONNX Runtime.
+
 ## API: File (offline source)
 
 Everything a `Microphone` does to live audio, `File` does to audio you already have: the same conditioning options, the same Readable stream of conditioned chunks (finite: it ends at EOF), and the same opt-in `vad`. Because a `File` is a complete recording, it can also analyze the whole recording for speech.

package/examples/decibri.browser.js

@@ -70,7 +70,7 @@ var decibri = (function() {
 	var require_decibri_browser = /* @__PURE__ */ __commonJSMin(((exports, module) => {
 		const { Emitter } = require_emitter();
 		const { WORKLET_SOURCE } = require_worklet_inline();
-		const VERSION = "5.4.0";
+		const VERSION = "5.5.0";
 		/**
 		* Browser microphone capture.
 		*
@@ -132,6 +132,8 @@ var decibri = (function() {
 				this._noiseSuppression = options.noiseSuppression ?? true;
 				this._workletUrl = options.workletUrl;
 				if (this._sampleRate < 1e3 || this._sampleRate > 384e3) throw new RangeError("sample rate must be between 1000 and 384000");
+				if (this._channels < 1) throw new RangeError("channels must be at least 1");
+				if (this._channels > 1) throw new RangeError("multichannel capture is not supported; channels must be 1 (mono)");
 				if (this._channels < 1 || this._channels > 32) throw new TypeError(`channels must be between 1 and 32, got ${this._channels}`);
 				if (this._framesPerBuffer < 64 || this._framesPerBuffer > 65536) throw new TypeError(`frames per buffer must be between 64 and 65536, got ${this._framesPerBuffer}`);
 				if (this._dtype !== "int16" && this._dtype !== "float32") throw new TypeError("dtype must be 'int16' or 'float32'");

package/index.d.ts

@@ -324,6 +324,17 @@ export interface DecibriOptions {
    * when `aec` names a model.
    */
   aecReferenceSampleRate?: number
+  /**
+   * Number of channels in the far-end reference pushed through
+   * `pushAecReference`, at least 1. Absent means the reference is mono;
+   * when it names a count above 1, the core collapses each interleaved
+   * frame to one mono sample before the canceller sees it. The declared
+   * count must match the pushed buffer: a mismatch is not detected and
+   * raises no error, and shows up only as `aecMetrics().delaySamples`
+   * staying `null` with no fault reported. Consulted only when `aec`
+   * names a model.
+   */
+  aecReferenceChannels?: number
 }
 
 /** Options passed from JS constructor for output. */

package/index.js

@@ -77,8 +77,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-android-arm64')
         const bindingPackageVersion = require('@decibri/decibri-android-arm64/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -93,8 +93,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-android-arm-eabi')
         const bindingPackageVersion = require('@decibri/decibri-android-arm-eabi/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -114,8 +114,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-win32-x64-gnu')
         const bindingPackageVersion = require('@decibri/decibri-win32-x64-gnu/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -130,8 +130,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-win32-x64-msvc')
         const bindingPackageVersion = require('@decibri/decibri-win32-x64-msvc/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -147,8 +147,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-win32-ia32-msvc')
         const bindingPackageVersion = require('@decibri/decibri-win32-ia32-msvc/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -163,8 +163,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-win32-arm64-msvc')
         const bindingPackageVersion = require('@decibri/decibri-win32-arm64-msvc/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -182,8 +182,8 @@ function requireNative() {
     try {
       const binding = require('@decibri/decibri-darwin-universal')
       const bindingPackageVersion = require('@decibri/decibri-darwin-universal/package.json').version
-      if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-        throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+      if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+        throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
       }
       return binding
     } catch (e) {
@@ -198,8 +198,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-darwin-x64')
         const bindingPackageVersion = require('@decibri/decibri-darwin-x64/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -214,8 +214,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-darwin-arm64')
         const bindingPackageVersion = require('@decibri/decibri-darwin-arm64/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -234,8 +234,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-freebsd-x64')
         const bindingPackageVersion = require('@decibri/decibri-freebsd-x64/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -250,8 +250,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-freebsd-arm64')
         const bindingPackageVersion = require('@decibri/decibri-freebsd-arm64/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -271,8 +271,8 @@ function requireNative() {
         try {
           const binding = require('@decibri/decibri-linux-x64-musl')
           const bindingPackageVersion = require('@decibri/decibri-linux-x64-musl/package.json').version
-          if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -287,8 +287,8 @@ function requireNative() {
         try {
           const binding = require('@decibri/decibri-linux-x64-gnu')
           const bindingPackageVersion = require('@decibri/decibri-linux-x64-gnu/package.json').version
-          if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -305,8 +305,8 @@ function requireNative() {
         try {
           const binding = require('@decibri/decibri-linux-arm64-musl')
           const bindingPackageVersion = require('@decibri/decibri-linux-arm64-musl/package.json').version
-          if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -321,8 +321,8 @@ function requireNative() {
         try {
           const binding = require('@decibri/decibri-linux-arm64-gnu')
           const bindingPackageVersion = require('@decibri/decibri-linux-arm64-gnu/package.json').version
-          if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -339,8 +339,8 @@ function requireNative() {
         try {
           const binding = require('@decibri/decibri-linux-arm-musleabihf')
           const bindingPackageVersion = require('@decibri/decibri-linux-arm-musleabihf/package.json').version
-          if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -355,8 +355,8 @@ function requireNative() {
         try {
           const binding = require('@decibri/decibri-linux-arm-gnueabihf')
           const bindingPackageVersion = require('@decibri/decibri-linux-arm-gnueabihf/package.json').version
-          if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -373,8 +373,8 @@ function requireNative() {
         try {
           const binding = require('@decibri/decibri-linux-loong64-musl')
           const bindingPackageVersion = require('@decibri/decibri-linux-loong64-musl/package.json').version
-          if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -389,8 +389,8 @@ function requireNative() {
         try {
           const binding = require('@decibri/decibri-linux-loong64-gnu')
           const bindingPackageVersion = require('@decibri/decibri-linux-loong64-gnu/package.json').version
-          if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -407,8 +407,8 @@ function requireNative() {
         try {
           const binding = require('@decibri/decibri-linux-riscv64-musl')
           const bindingPackageVersion = require('@decibri/decibri-linux-riscv64-musl/package.json').version
-          if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -423,8 +423,8 @@ function requireNative() {
         try {
           const binding = require('@decibri/decibri-linux-riscv64-gnu')
           const bindingPackageVersion = require('@decibri/decibri-linux-riscv64-gnu/package.json').version
-          if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+            throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
           }
           return binding
         } catch (e) {
@@ -440,8 +440,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-linux-ppc64-gnu')
         const bindingPackageVersion = require('@decibri/decibri-linux-ppc64-gnu/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -456,8 +456,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-linux-s390x-gnu')
         const bindingPackageVersion = require('@decibri/decibri-linux-s390x-gnu/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -476,8 +476,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-openharmony-arm64')
         const bindingPackageVersion = require('@decibri/decibri-openharmony-arm64/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -492,8 +492,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-openharmony-x64')
         const bindingPackageVersion = require('@decibri/decibri-openharmony-x64/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {
@@ -508,8 +508,8 @@ function requireNative() {
       try {
         const binding = require('@decibri/decibri-openharmony-arm')
         const bindingPackageVersion = require('@decibri/decibri-openharmony-arm/package.json').version
-        if (bindingPackageVersion !== '5.4.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 5.4.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '5.5.0' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
+          throw new Error(`Native binding package version mismatch, expected 5.5.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {

package/models/README.md

@@ -1,66 +1,42 @@
 # Models
 
 This directory holds the third-party model files decibri bundles, together with
-the license notices each one requires. These notices ship inside the published
-npm and PyPI packages alongside the model weights, so the attribution travels
-with the files it covers.
+the tensor interface each one exposes. The license notice every model requires
+is in `THIRD-PARTY-NOTICES.md` beside this file, and ships alongside the weights
+it covers inside the published npm and PyPI packages.
 
 ## silero_vad.onnx
 
-- **Name:** Silero VAD v5
-- **License:** MIT
-- **Source:** https://github.com/snakers4/silero-vad
-- **Size:** ~2.2 MB
+- **Model:** Silero VAD v6.2
+- **Source:** https://github.com/snakers4/silero-vad (release `v6.2`)
+- **Size:** ~2.2 MB (2,327,524 bytes)
 - **Purpose:** Voice Activity Detection. Determines whether an audio frame contains human speech
 
 ### Input/Output Specification
 
+Verified from the model file (ONNX IR version 8, opset 16, exported with spox).
+All tensors are fp32 except `sr`, which is i64. The batch, sample-count and
+state dimensions are declared dynamic; the shapes below are what the model takes
+and produces at batch 1.
+
 **Inputs:**
-- `input`: f32[batch, window_size]: audio samples (512 at 16kHz, 256 at 8kHz)
-- `sr`: i64[batch]: sample rate
-- `h`: f32[2, batch, 64]: LSTM hidden state
-- `c`: f32[2, batch, 64]: LSTM cell state
+- `input`: f32[batch, context_size + window_size]: audio samples. Each call is fed the previous window's last `context_size` samples followed by the current window (64 + 512 = 576 at 16 kHz, 32 + 256 = 288 at 8 kHz), where `context_size` is `window_size / 8`.
+- `state`: f32[2, batch, 128]: combined LSTM hidden and cell state
+- `sr`: i64 scalar: sample rate
 
 **Outputs:**
 - `output`: f32[batch, 1]: speech probability (0.0 to 1.0)
-- `hn`: f32[2, batch, 64]: updated hidden state
-- `cn`: f32[2, batch, 64]: updated cell state
-
-Note: Exact tensor names may differ. Verified at build time from the model file.
-
-### License Notice
-
-This model is a third-party artifact, not proprietary to decibri. It is
-distributed under the MIT License, reproduced in full below.
-
-```text
-MIT License
+- `stateN`: f32[2, batch, 128]: updated state
 
-Copyright (c) 2020-present Silero Team
-
-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.
-```
+Streaming contract: the model carries no state of its own between calls. Initialize
+`state` to zeros and the audio context to zeros at the start of a stream, feed each
+call's `stateN` back as the next call's `state`, and carry the last `context_size`
+samples of each window forward as the next call's context. Feeding a bare window
+with no context prepended scores even loud speech at the non-speech floor.
 
 ## fastenhancer_t.onnx
 
-- **Name:** FastEnhancer-T (tiny tier), VoiceBank-DEMAND checkpoint, waveform variant
-- **License:** MIT
+- **Model:** FastEnhancer-T (tiny tier), VoiceBank-DEMAND checkpoint, waveform variant
 - **Source:** https://github.com/aask1357/fastenhancer (release `onnx-vd-v1.0.0`)
 - **Size:** ~122 KB (125,036 bytes)
 - **Purpose:** Single-channel speech enhancement (denoise). Maps a window of noisy speech samples to a hop of cleaned speech samples, frame by frame, for streaming use.
@@ -89,61 +65,3 @@ receives audio samples with no spectral processing of its own. The three cache
 tensors hold the model's overlap-add and recurrent state. Initialize them to
 zeros at the start of a stream and feed each call's `cache_out` values back as
 the next call's `cache_in` values.
-
-### License Notice
-
-This model is a third-party artifact, not proprietary to decibri. The model
-code and weights are distributed under the MIT License, reproduced in full
-below.
-
-```text
-MIT License
-
-Copyright (c) 2025 AHN Sung Hwan
-
-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.
-```
-
-### Training-Data Attribution
-
-The bundled checkpoint is trained on the VoiceBank-DEMAND noisy speech dataset,
-which pairs clean speech from the CSTR VCTK Corpus with noise from the DEMAND
-database. Each source dataset requires attribution:
-
-- **VoiceBank-DEMAND.** Valentini-Botinhao, Cassia. (2017). Noisy speech
-  database for training speech enhancement algorithms and TTS models, 2016
-  [sound]. University of Edinburgh, School of Informatics, Centre for Speech
-  Technology Research (CSTR). Licensed under Creative Commons Attribution 4.0
-  International (CC BY 4.0), https://creativecommons.org/licenses/by/4.0/.
-  https://doi.org/10.7488/ds/2117
-
-- **CSTR VCTK Corpus (version 0.92).** Yamagishi, Junichi; Veaux, Christophe;
-  MacDonald, Kirsten. (2019). CSTR VCTK Corpus: English Multi-speaker Corpus
-  for CSTR Voice Cloning Toolkit (version 0.92) [sound]. University of
-  Edinburgh, Centre for Speech Technology Research (CSTR). Licensed under the
-  Open Data Commons Attribution License (ODC-By) v1.0,
-  https://opendatacommons.org/licenses/by/1-0/.
-  https://doi.org/10.7488/ds/2645
-
-- **DEMAND.** Thiemann, Joachim; Ito, Nobutaka; Vincent, Emmanuel. (2013).
-  DEMAND: a collection of multi-channel recordings of acoustic noise in
-  diverse environments. Licensed under Creative Commons
-  Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0),
-  https://creativecommons.org/licenses/by-sa/3.0/.
-  https://doi.org/10.5281/zenodo.1227121

package/models/THIRD-PARTY-NOTICES.md

@@ -0,0 +1,110 @@
+# Third-Party Notices
+
+This directory redistributes the model files listed below, together with the
+license notices they require. The notices ship inside the published npm and
+PyPI packages alongside the model weights they cover, so the attribution
+travels with the files. `README.md` beside this file documents each model's
+tensor interface.
+
+## Silero VAD
+
+- **Name:** Silero VAD
+- **Version:** v6.2
+- **License:** MIT
+- **Source:** https://github.com/snakers4/silero-vad (release `v6.2`)
+- **Files covered:** `silero_vad.onnx`
+
+### License Notice
+
+This model is a third-party artifact, not proprietary to decibri. It is
+distributed under the MIT License, reproduced in full below.
+
+```text
+MIT License
+
+Copyright (c) 2020-present Silero Team
+
+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.
+```
+
+## FastEnhancer
+
+- **Name:** FastEnhancer-T (tiny tier), VoiceBank-DEMAND checkpoint, waveform variant
+- **Version:** `onnx-vd-v1.0.0`
+- **License:** MIT
+- **Source:** https://github.com/aask1357/fastenhancer (release `onnx-vd-v1.0.0`)
+- **Files covered:** `fastenhancer_t.onnx`
+
+### License Notice
+
+This model is a third-party artifact, not proprietary to decibri. The model
+code and weights are distributed under the MIT License, reproduced in full
+below.
+
+```text
+MIT License
+
+Copyright (c) 2025 AHN Sung Hwan
+
+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.
+```
+
+### Training-Data Attribution
+
+The bundled checkpoint is trained on the VoiceBank-DEMAND noisy speech dataset,
+which pairs clean speech from the CSTR VCTK Corpus with noise from the DEMAND
+database. Each source dataset requires attribution:
+
+- **VoiceBank-DEMAND.** Valentini-Botinhao, Cassia. (2017). Noisy speech
+  database for training speech enhancement algorithms and TTS models, 2016
+  [sound]. University of Edinburgh, School of Informatics, Centre for Speech
+  Technology Research (CSTR). Licensed under Creative Commons Attribution 4.0
+  International (CC BY 4.0), https://creativecommons.org/licenses/by/4.0/.
+  https://doi.org/10.7488/ds/2117
+
+- **CSTR VCTK Corpus (version 0.92).** Yamagishi, Junichi; Veaux, Christophe;
+  MacDonald, Kirsten. (2019). CSTR VCTK Corpus: English Multi-speaker Corpus
+  for CSTR Voice Cloning Toolkit (version 0.92) [sound]. University of
+  Edinburgh, Centre for Speech Technology Research (CSTR). Licensed under the
+  Open Data Commons Attribution License (ODC-By) v1.0,
+  https://opendatacommons.org/licenses/by/1-0/.
+  https://doi.org/10.7488/ds/2645
+
+- **DEMAND.** Thiemann, Joachim; Ito, Nobutaka; Vincent, Emmanuel. (2013).
+  DEMAND: a collection of multi-channel recordings of acoustic noise in
+  diverse environments. Licensed under Creative Commons
+  Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0),
+  https://creativecommons.org/licenses/by-sa/3.0/.
+  https://doi.org/10.5281/zenodo.1227121

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "decibri",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "description": "Cross-platform audio capture, playback, and processing for Node.js and browsers",
   "main": "src/decibri.js",
   "types": "src/decibri.d.ts",
@@ -72,10 +72,10 @@
     "MIGRATION.md"
   ],
   "optionalDependencies": {
-    "@decibri/decibri-win32-x64-msvc": "5.4.0",
-    "@decibri/decibri-darwin-arm64": "5.4.0",
-    "@decibri/decibri-linux-x64-gnu": "5.4.0",
-    "@decibri/decibri-linux-arm64-gnu": "5.4.0"
+    "@decibri/decibri-win32-x64-msvc": "5.5.0",
+    "@decibri/decibri-darwin-arm64": "5.5.0",
+    "@decibri/decibri-linux-x64-gnu": "5.5.0",
+    "@decibri/decibri-linux-arm64-gnu": "5.5.0"
   },
   "devDependencies": {
     "@napi-rs/cli": "^3.7.0"

package/src/browser/decibri-browser.js

@@ -6,7 +6,7 @@ const { WORKLET_SOURCE } = require('./worklet-inline.js');
 // Browser build version. Keep in sync with package.json on each release; the
 // browser bundle cannot read package.json at runtime the way the Node wrapper
 // does, so this is a maintained constant.
-const VERSION = '5.4.0';
+const VERSION = '5.5.0';
 
 /**
  * Browser microphone capture.
@@ -105,6 +105,19 @@ class Microphone extends Emitter {
     if (this._sampleRate < 1000 || this._sampleRate > 384000) {
       throw new RangeError('sample rate must be between 1000 and 384000');
     }
+    // Mono only: the worklet reads a single channel. The classes and the
+    // messages are the node entry's, so the same value is rejected the same
+    // way in both runtimes.
+    if (this._channels < 1) {
+      throw new RangeError('channels must be at least 1');
+    }
+    if (this._channels > 1) {
+      throw new RangeError('multichannel capture is not supported; channels must be 1 (mono)');
+    }
+    // The Web Audio specification's floor, as on the browser Speaker: an
+    // implementation is required to support up to 32 channels and says nothing
+    // above that. Deliberately unlike the native surface, which bounds channels
+    // below only.
     if (this._channels < 1 || this._channels > 32) {
       throw new TypeError(`channels must be between 1 and 32, got ${this._channels}`);
     }

package/src/browser/decibri-output-browser.js

@@ -104,6 +104,12 @@ class Speaker {
     if (this._sampleRate < 1000 || this._sampleRate > 384000) {
       throw new TypeError(`sample rate must be between 1000 and 384000, got ${this._sampleRate}`);
     }
+    // The 32 is the Web Audio specification's floor: an implementation is
+    // required to support up to 32 channels and the specification says nothing
+    // above that, so 32 is what a browser can be relied on to accept. The
+    // native surface bounds output channels below only and leaves the maximum
+    // to the device; the two differ deliberately, because they are answering to
+    // different things.
     if (this._channels < 1 || this._channels > 32) {
       throw new TypeError(`channels must be between 1 and 32, got ${this._channels}`);
     }

package/src/browser/index.d.ts

@@ -47,9 +47,12 @@ export interface MicrophoneOptions {
   sampleRate?: number;
 
   /**
-   * Number of input channels.
+   * Number of input channels. Mono only: the only accepted value is `1`, and a
+   * value greater than `1` throws a `RangeError` (multichannel capture is not
+   * supported) rather than being silently downmixed. The option is kept for
+   * forward compatibility: a future release may accept a value greater than `1`
+   * by delivering true interleaved multichannel.
    * @default 1
-   * @range 1–32
    */
   channels?: number;
 

package/src/decibri-output.js

@@ -67,9 +67,13 @@ class Speaker extends Writable {
       throw new RangeError('sample rate must be between 1000 and 384000');
     }
 
+    // Bounded below only. How many output channels can be carried is the
+    // device's answer, so any count above zero is passed through and a device
+    // that refuses it throws a DecibriError with code
+    // 'SPEAKER_CHANNELS_UNSUPPORTED' naming the count the device reports.
     const channels = options.channels ?? 1;
-    if (channels < 1 || channels > 32) {
-      throw new RangeError('channels must be between 1 and 32');
+    if (channels < 1) {
+      throw new RangeError('channels must be at least 1');
     }
 
     const dtype = options.dtype ?? 'int16';

package/src/decibri.d.ts

@@ -42,7 +42,7 @@ export interface VersionInfo {
 export interface VadOptions {
   /**
    * Which detector to run.
-   * - `'silero'`: Silero VAD v5 ML model (more accurate, ~1ms inference)
+   * - `'silero'`: Silero VAD v6.2 ML model (more accurate, ~1ms inference)
    * - `'energy'`: RMS energy threshold (lightweight, no model)
    */
   model: 'silero' | 'energy';
@@ -105,6 +105,32 @@ export interface AecOptions {
    * @range 1000 to 384000
    */
   referenceSampleRate?: number;
+
+  /**
+   * Number of channels in the far-end reference pushed through
+   * `pushAecReference`, frame-interleaved. When it names a count above 1,
+   * decibri averages each frame to one mono sample before the canceller sees
+   * it: a multichannel reference pushed without declaring the count cancels
+   * nothing and reports no error, so the collapse is decibri's rather than
+   * the caller's.
+   *
+   * The declared count must match the buffer actually pushed. The reference
+   * arrives as flat PCM whose true channel count is not recoverable from its
+   * length, so a mismatch is not detected and raises no error: the frames
+   * are misread, nothing is cancelled, and the observable signature is
+   * `aecMetrics().delaySamples` staying `null` while the canceller reports
+   * no fault.
+   *
+   * The canceller itself reads one mono reference. Against playback through
+   * more than one loudspeaker that is a cancellation ceiling: the echo
+   * reaching the microphone is the sum of different room responses driven by
+   * different signals, and a single-reference canceller models one response
+   * applied to their average, so a placement where those paths differ leaves
+   * a residual that no amount of adaptation removes.
+   * @default 1 (mono)
+   * @range at least 1; no upper bound
+   */
+  referenceChannels?: number;
 }
 
 /**
@@ -211,7 +237,7 @@ export interface MicrophoneOptions extends ReadableOptions {
   /**
    * Voice activity detection. One of:
    * - `false`: disabled (default)
-   * - `'silero'`: Silero VAD v5 ML model (more accurate, ~1ms inference)
+   * - `'silero'`: Silero VAD v6.2 ML model (more accurate, ~1ms inference)
    * - `'energy'`: RMS energy threshold (lightweight)
    * - a `VadOptions` config object `{ model, threshold?, holdoffMs? }` to tune
    *   the threshold and holdoff for the chosen model
@@ -371,8 +397,14 @@ export declare class Microphone extends Readable {
    * Queue far-end reference audio for the echo canceller: the audio being
    * played out, pushed as it is played, in played order. Accepts the same
    * input shapes `Speaker.write` accepts (a `Buffer`, any TypedArray, or a
-   * `DataView` of PCM bytes in this microphone's `dtype`), mono, at the
-   * declared `referenceSampleRate` (the capture rate when unset).
+   * `DataView` of PCM bytes in this microphone's `dtype`), at the declared
+   * `referenceSampleRate` (the capture rate when unset), interleaved at the
+   * declared `referenceChannels` (mono when unset). With `referenceChannels`
+   * above 1, each frame is averaged to one mono sample before the canceller
+   * sees it. The declared count must match this buffer's actual
+   * interleaving: a mismatch is not detected and raises no error, and shows
+   * up only as `aecMetrics().delaySamples` staying `null` with no fault
+   * reported.
    *
    * Never blocks and never throws on a full queue: samples that do not fit
    * are discarded and counted by `aecMetrics().referenceDropped`. Silence
@@ -810,9 +842,11 @@ export interface SpeakerOptions extends WritableOptions {
   sampleRate?: number;
 
   /**
-   * Number of output channels.
+   * Number of output channels. The maximum is the device's: a count the device
+   * cannot serve throws a `DecibriError` with code
+   * `'SPEAKER_CHANNELS_UNSUPPORTED'` naming the count the device reports.
    * @default 1
-   * @range 1–32
+   * @range 1 or more
    */
   channels?: number;
 

package/src/decibri.js

@@ -151,7 +151,7 @@ class Microphone extends Readable {
     // additive. The `channels` option is kept for that forward compatibility.
     const channels = options.channels ?? 1;
     if (channels < 1) {
-      throw new RangeError('channels must be between 1 and 32');
+      throw new RangeError('channels must be at least 1');
     }
     if (channels > 1) {
       throw new RangeError('multichannel capture is not supported; channels must be 1 (mono)');
@@ -345,8 +345,8 @@ class Microphone extends Readable {
     // ── Validate AEC ─────────────────────────────────────────────────────────
 
     // Echo cancellation: the 'tau' shorthand names the model, or an
-    // { model, tailMs, suppression, referenceSampleRate } object tunes it;
-    // absence leaves it off. The model name is deliberately NOT checked
+    // { model, tailMs, suppression, referenceSampleRate, referenceChannels }
+    // object tunes it; absence leaves it off. The model name is deliberately NOT checked
     // against a list here: the canceller owns the accepted set, so the native
     // layer parses it (AecModel::from_str) and an unknown name is rejected by
     // the native constructor with the canceller's own message (a DecibriError
@@ -360,11 +360,12 @@ class Microphone extends Readable {
     let aecTailMs;
     let aecSuppression;
     let aecReferenceSampleRate;
+    let aecReferenceChannels;
     if (aec !== undefined) {
       if (typeof aec === 'string') {
         aecModel = aec;
       } else if (aec !== null && typeof aec === 'object' && !Array.isArray(aec)) {
-        const { model, tailMs, suppression, referenceSampleRate } = aec;
+        const { model, tailMs, suppression, referenceSampleRate, referenceChannels } = aec;
         if (typeof model !== 'string') {
           throw new TypeError(
             `Invalid aec model: ${JSON.stringify(model)}. Expected a model name string such as 'tau'.`
@@ -397,9 +398,18 @@ class Microphone extends Readable {
           }
           aecReferenceSampleRate = referenceSampleRate;
         }
+        if (referenceChannels !== undefined) {
+          if (typeof referenceChannels !== 'number' || Number.isNaN(referenceChannels)) {
+            throw new TypeError('aec referenceChannels must be a number');
+          }
+          if (referenceChannels < 1) {
+            throw new RangeError('aec referenceChannels must be at least 1');
+          }
+          aecReferenceChannels = referenceChannels;
+        }
       } else {
         throw new TypeError(
-          `Invalid aec value: ${JSON.stringify(aec)}. Expected a model name such as 'tau', or a config object { model, tailMs, suppression, referenceSampleRate }.`
+          `Invalid aec value: ${JSON.stringify(aec)}. Expected a model name such as 'tau', or a config object { model, tailMs, suppression, referenceSampleRate, referenceChannels }.`
         );
       }
     }
@@ -443,6 +453,7 @@ class Microphone extends Readable {
         aecTailMs,
         aecSuppression,
         aecReferenceSampleRate,
+        aecReferenceChannels,
       },
     };
   }
@@ -605,8 +616,15 @@ class Microphone extends Readable {
    * Queue far-end reference audio for the echo canceller: the audio being
    * played out, pushed as it is played, in played order. Accepts the same
    * input shapes `Speaker.write` accepts (a `Buffer`, any TypedArray, or a
-   * `DataView` of PCM bytes in this microphone's `dtype`), mono, at the
-   * declared `referenceSampleRate` (the capture rate when unset).
+   * `DataView` of PCM bytes in this microphone's `dtype`), at the declared
+   * `referenceSampleRate` (the capture rate when unset), interleaved at the
+   * declared `referenceChannels` (mono when unset). With `referenceChannels`
+   * above 1, each frame is averaged to one mono sample before the canceller
+   * sees it; a multichannel reference pushed without declaring the count
+   * cancels nothing and reports no error. The declared count must match this
+   * buffer's actual interleaving: a mismatch is not detected and raises no
+   * error, and shows up only as `aecMetrics().delaySamples` staying `null`
+   * with no fault reported.
    *
    * Never blocks and never throws on a full queue: samples that do not fit
    * are discarded and counted by `aecMetrics().referenceDropped`, and the

package/src/errors.js

@@ -75,7 +75,7 @@ class OrtPathError extends OrtError {
 // the core ever sees it).
 const RANGE_PREFIXES = [
   'sample rate must be between',
-  'channels must be between',
+  'channels must be at least',
   'multichannel capture is not supported',
   'frames per buffer must be between',
   'agc target level must be between',
@@ -83,6 +83,7 @@ const RANGE_PREFIXES = [
   'flac compression level must be between',
   'aec tailMs must be between',
   'aec referenceSampleRate must be between',
+  'aec referenceChannels must be at',
   'Silero VAD only supports',
   'VAD threshold must be between',
   'echo cancellation only supports',
@@ -125,6 +126,7 @@ const BASE_CODES = [
   ['audio stream is already running', 'ALREADY_RUNNING'],
   ['Failed to open audio stream', 'STREAM_OPEN_FAILED'],
   ['Failed to start audio stream', 'STREAM_START_FAILED'],
+  ['the output device does not support', 'SPEAKER_CHANNELS_UNSUPPORTED'],
   ['Microphone permission denied.', 'PERMISSION_DENIED'],
   ['Microphone stream is closed', 'MICROPHONE_STREAM_CLOSED'],
   ['Speaker stream is closed', 'SPEAKER_STREAM_CLOSED'],