decibri 5.4.0 → 5.6.0

package/index.d.ts

@@ -33,8 +33,10 @@ export declare class DecibriBridge {
    * Queue far-end reference audio for the echo canceller. `buffer` is mono
    * PCM bytes in the bridge's configured format, at the declared reference
    * rate, in played order. Never blocks and never fails: a full queue
-   * discards and counts rather than erroring, and a push with no active
-   * stream (not started, stopped, or echo cancellation off) is a no-op.
+   * discards and counts rather than erroring. A push with no active stream
+   * (not started, or stopped) is discarded and counted into the
+   * `referenceDropped` metric when a canceller is configured; with echo
+   * cancellation off it is a no-op.
    */
   pushAecReference(buffer: Buffer): void
   /**
@@ -42,6 +44,11 @@ export declare class DecibriBridge {
    * reference queue's own counters, or `null` when no stream is active or
    * echo cancellation is off. Counters are returned as f64 (exact JS numbers
    * for any realistic count), matching the `overrunCount` getter.
+   *
+   * The top-level engine fields report the first delivered channel's
+   * canceller; `channels` carries every delivered channel's engine report in
+   * delivered order, one entry per channel, so the two agree on a
+   * single-channel stream.
    */
   aecMetrics(): AecMetricsJs | null
   /** List all available audio input devices. */
@@ -126,8 +133,9 @@ export declare class FileHandle {
    */
   static openAsync(path: string, options?: FileOptions | undefined | null): Promise<unknown>
   /**
-   * Wrap in-memory samples as an offline source. `samples` are mono f32 in
-   * [-1.0, 1.0]; `inputRate` is their native rate (raw samples carry no
+   * Wrap in-memory samples as an offline source. `samples` are f32 in
+   * [-1.0, 1.0], frame-interleaved at the options' `inputChannels` (1
+   * when unset); `inputRate` is their native rate (raw samples carry no
    * header). No I/O, so construction is synchronous.
    */
   static buffer(samples: Float32Array, inputRate: number, options?: FileOptions | undefined | null): FileHandle
@@ -173,6 +181,49 @@ export declare class FileHandle {
   get inputRate(): number
 }
 
+/**
+ * One delivered channel's canceller report inside `AecMetricsJs.channels`.
+ * Engine-level fields only: the reference queue's counters (`referenceDropped`,
+ * `referenceSilence`) describe the shared queue and stay on the top level.
+ */
+export interface AecChannelMetricsJs {
+  /**
+   * This channel's active delay alignment in samples, or `null` while its
+   * estimator is still searching. The offset from the reference frontier as
+   * the feeding established it, not a measurement of the room's echo path.
+   */
+  delaySamples?: number
+  /**
+   * This channel's smoothed echo-return-loss-enhancement estimate in dB.
+   * Not a quality ranking across channels: ERLE rises with echo distance,
+   * because a weaker echo is easier to reduce in ratio terms, so a far
+   * microphone routinely reports a higher figure than a near one while
+   * removing less echo in absolute terms. Compare a channel against its own
+   * history, not against its neighbours.
+   */
+  erleDb: number
+  /**
+   * Whether this channel's double-talk detector currently believes the
+   * near-end talker is active; its adaptation is held while true.
+   */
+  doubleTalk: boolean
+  /**
+   * Near-end samples this channel's canceller could find no far-end sample
+   * for while an alignment was active.
+   */
+  referenceStarved: number
+  /**
+   * Near-end samples this channel processed while no delay alignment was
+   * active: the searching span, not a transport failure.
+   */
+  acquisitionParked: number
+  /**
+   * Times this channel's canceller inferred a capture discontinuity and
+   * rebuilt its alignment from the reference frontier.
+   */
+  referenceReanchors: number
+}
+
 /**
  * Echo-cancellation metrics returned to JS by `aecMetrics()`. One object
  * carries the canceller's own report and the reference queue's counters, so a
@@ -215,10 +266,11 @@ export interface AecMetricsJs {
    */
   referenceReanchors: number
   /**
-   * Far-end samples discarded because a single push exceeded the reference
-   * queue's bound, at the declared reference rate. The span they occupied is
-   * still represented as silence, so a discard costs the cancellation of
-   * that span alone.
+   * Far-end samples discarded, at the declared reference rate: a single
+   * push exceeded the reference queue's bound, or the push arrived while
+   * capture was not running. The span an oversized push occupied is still
+   * represented as silence, so that discard costs the cancellation of the
+   * span alone.
    */
   referenceDropped: number
   /**
@@ -227,6 +279,15 @@ export interface AecMetricsJs {
    * fault: while nothing is playing, the far end is silence.
    */
   referenceSilence: number
+  /**
+   * Every delivered channel's canceller report, in delivered order, one
+   * entry per channel. One canceller engine runs per delivered channel,
+   * each fed the same pushed reference and each finding its own channel's
+   * echo delay, so the entries differ where the channels' acoustic paths
+   * differ. On a single-channel stream this holds one entry agreeing with
+   * the top-level fields.
+   */
+  channels: Array<AecChannelMetricsJs>
 }
 
 /**
@@ -257,6 +318,15 @@ export interface AecMetricsJs {
 export interface DecibriOptions {
   sampleRate?: number
   channels?: number
+  /**
+   * Capture channel map: 0-based device channel indices, one per delivered
+   * channel (the shape of CoreAudio AUHAL's channel map, an index list, not
+   * miniaudio's spatial `channelMap`). Absent delivers the documented
+   * average of every opened channel. Entries are validated against the
+   * resolved device's own report when the stream starts; no fixed maximum
+   * exists.
+   */
+  channelMap?: Array<number>
   framesPerBuffer?: number
   format?: string
   device?: any
@@ -324,6 +394,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. */
@@ -340,8 +421,10 @@ export interface DeviceInfoJs {
   name: string
   /**
    * Stable per-host device ID suitable for `device: { id: ... }` selection.
-   * WASAPI endpoint ID on Windows, CoreAudio UID on macOS, ALSA pcm_id on
-   * Linux. Empty string if cpal cannot produce a stable ID for this device.
+   * The lowercase host name, a colon, then the platform device identifier:
+   * `wasapi:` then the endpoint ID on Windows, `coreaudio:` then the device
+   * UID on macOS, `alsa:` then the PCM identifier on Linux. Empty string if
+   * cpal cannot produce a stable ID for this device.
    */
   id: string
   maxInputChannels: number
@@ -351,14 +434,21 @@ export interface DeviceInfoJs {
 
 /**
  * Options passed from the JS `File` wrapper. The conditioning fields mirror
- * `DecibriOptions` exactly; the live-capture-only fields (device, channels,
- * framesPerBuffer) do not apply to an offline source. `vadThreshold` and
- * `vadHoldoffMs` are internal plumbing (the user passes them on the `vad`
- * config object; the wrapper resolves them), hidden from the generated
- * TypeScript like `ortLibraryPath`.
+ * `DecibriOptions` exactly, as do `channels` and `channelMap`, with the
+ * source's own channel count standing where the device's report stands; the
+ * live-capture-only fields (device, framesPerBuffer) do not apply to an
+ * offline source. `inputChannels` is the interleave of the caller's own
+ * samples and is honoured by `FileHandle::buffer` alone (a path's count
+ * comes from its header; the JS wrapper refuses the option on the open
+ * path). `vadThreshold` and `vadHoldoffMs` are internal plumbing (the user
+ * passes them on the `vad` config object; the wrapper resolves them),
+ * hidden from the generated TypeScript like `ortLibraryPath`.
  */
 export interface FileOptions {
   sampleRate?: number
+  channels?: number
+  channelMap?: Array<number>
+  inputChannels?: number
   format?: string
   vadMode?: string
   modelPath?: string

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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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.6.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