decibri 3.4.2 → 4.0.0

package/README.md

@@ -1,6 +1,6 @@
 # decibri
 
-Cross-platform audio capture, output, and voice activity detection for Node.js and browsers.
+Cross-platform audio capture, playback, and voice activity detection for Node.js and browsers.
 
 ## Installation
 
@@ -8,18 +8,24 @@ Cross-platform audio capture, output, and voice activity detection for Node.js a
 npm install decibri
 ```
 
-One package for Node.js and browsers. Node.js gets a native addon (Rust via napi-rs). Browsers get a JavaScript AudioWorklet implementation. Platform-specific binaries are installed automatically.
+One package for Node.js and browsers. Node.js gets a prebuilt native addon. Browsers get a JavaScript AudioWorklet implementation. Platform-specific binaries are installed automatically.
 
 Requires Node.js >= 18. TypeScript definitions are bundled.
 
+The package uses named exports:
+
+```javascript
+const { Microphone, Speaker, inputDevices, outputDevices, version } = require('decibri');
+```
+
 ## Quick Start
 
 ### Capture audio
 
 ```javascript
-const Decibri = require('decibri');
+const { Microphone } = require('decibri');
 
-const mic = new Decibri({ sampleRate: 16000, channels: 1 });
+const mic = new Microphone({ sampleRate: 16000, channels: 1 });
 mic.on('data', (chunk) => { /* Buffer of Int16 PCM samples */ });
 setTimeout(() => mic.stop(), 5000);
 ```
@@ -27,9 +33,9 @@ setTimeout(() => mic.stop(), 5000);
 ### Play audio
 
 ```javascript
-const { DecibriOutput } = require('decibri');
+const { Speaker } = require('decibri');
 
-const speaker = new DecibriOutput({ sampleRate: 16000, channels: 1 });
+const speaker = new Speaker({ sampleRate: 16000, channels: 1 });
 speaker.write(pcmBuffer);
 speaker.end();
 ```
@@ -37,9 +43,9 @@ speaker.end();
 ### Browser capture
 
 ```javascript
-import { Decibri } from 'decibri'; // browser entry via conditional export
+import { Microphone } from 'decibri'; // browser entry via conditional export
 
-const mic = new Decibri({ sampleRate: 16000 });
+const mic = new Microphone({ sampleRate: 16000 });
 mic.on('data', (chunk) => { /* Int16Array of PCM samples */ });
 await mic.start(); // requires user gesture in Safari
 ```
@@ -47,14 +53,16 @@ await mic.start(); // requires user gesture in Safari
 ### Pipe capture to playback (echo)
 
 ```javascript
-const mic = new Decibri({ sampleRate: 16000, channels: 1 });
-const speaker = new DecibriOutput({ sampleRate: 16000, channels: 1 });
+const { Microphone, Speaker } = require('decibri');
+
+const mic = new Microphone({ sampleRate: 16000, channels: 1 });
+const speaker = new Speaker({ sampleRate: 16000, channels: 1 });
 mic.pipe(speaker);
 ```
 
-## API: Decibri (Capture)
+## API: Microphone (Capture)
 
-### `new Decibri(options?)`
+### `new Microphone(options?)`
 
 Creates a Readable stream that captures from the microphone.
 
@@ -64,27 +72,32 @@ Creates a Readable stream that captures from the microphone.
 | `channels` | number | 1 | Input channels (1 to 32) |
 | `framesPerBuffer` | number | 1600 | Frames per chunk (64 to 65536). At 16kHz mono, 1600 = 100ms = 3200 bytes |
 | `device` | number, string, or `{ id: string }` | system default | Device index, case-insensitive name substring, or stable per-host ID |
-| `format` | `'int16'` \| `'float32'` | `'int16'` | Sample encoding |
-| `vad` | boolean | false | Enable voice activity detection |
-| `vadMode` | `'energy'` \| `'silero'` | `'energy'` | VAD engine: RMS threshold or Silero ML model |
-| `vadThreshold` | number | 0.01 / 0.5 | Speech threshold. Default depends on `vadMode` |
+| `dtype` | `'int16'` \| `'float32'` | `'int16'` | Sample encoding |
+| `vad` | `false` \| `'silero'` \| `'energy'` | `false` | Voice activity detection: disabled, the Silero ML model, or an RMS energy threshold |
+| `vadThreshold` | number | 0.5 / 0.01 | Speech threshold. Default is 0.5 for `'silero'`, 0.01 for `'energy'` |
 | `vadHoldoff` | number | 300 | Silence holdoff in ms |
+| `modelPath` | string | bundled model | Path to the Silero model. Only used when `vad` is `'silero'` |
 
 Standard `ReadableOptions` (e.g. `highWaterMark`) are also accepted.
 
+`vad: true` is not accepted; pass the mode explicitly as `vad: 'silero'` or `vad: 'energy'`.
+
 ### Methods
 
 | Method | Description |
 | --- | --- |
 | `mic.stop()` | Stop capture and end stream. Safe to call multiple times |
-| `Decibri.devices()` | List available input devices |
-| `Decibri.version()` | Version info |
+| `Microphone.devices()` | List available input devices |
+| `Microphone.version()` | Version info: `{ decibri, audioBackend, binding }` |
+
+The module-level `inputDevices()` and `version()` free functions are equivalent to the static methods.
 
 ### Properties
 
 | Property | Type | Description |
 | --- | --- | --- |
 | `mic.isOpen` | boolean | `true` while capturing |
+| `mic.vadScore` | number | Latest VAD score for the active mode (Silero probability or normalized RMS); 0 when disabled |
 
 ### Events
 
@@ -97,9 +110,9 @@ Standard `ReadableOptions` (e.g. `highWaterMark`) are also accepted.
 | `'end'` | - | Stream ended |
 | `'error'` | Error | An error occurred |
 
-## API: DecibriOutput (Playback)
+## API: Speaker (Playback)
 
-### `new DecibriOutput(options?)`
+### `new Speaker(options?)`
 
 Creates a Writable stream for speaker playback.
 
@@ -107,7 +120,7 @@ Creates a Writable stream for speaker playback.
 | --- | --- | --- | --- |
 | `sampleRate` | number | 16000 | Playback sample rate (1000 to 384000) |
 | `channels` | number | 1 | Output channels (1 to 32) |
-| `format` | `'int16'` \| `'float32'` | `'int16'` | Sample encoding of incoming data |
+| `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 |
 
 Standard `WritableOptions` (e.g. `highWaterMark`) are also accepted.
@@ -118,24 +131,46 @@ Standard `WritableOptions` (e.g. `highWaterMark`) are also accepted.
 | `speaker.end()` | Signal end. Drains remaining audio, then emits `'finish'` |
 | `speaker.stop()` | Immediate stop. Discards remaining audio |
 | `speaker.isPlaying` | `true` while audio is being output |
-| `DecibriOutput.devices()` | List available output devices |
-| `DecibriOutput.version()` | Same as `Decibri.version()` |
+| `Speaker.devices()` | List available output devices |
+| `Speaker.version()` | Same as `Microphone.version()` |
+
+The module-level `outputDevices()` free function is equivalent to `Speaker.devices()`.
+
+## Errors
+
+Construction errors come as typed classes you can catch:
+
+```javascript
+const { Microphone, DecibriError, DeviceError } = require('decibri');
+
+try {
+  new Microphone({ device: 'no such device' });
+} catch (err) {
+  if (err instanceof DeviceError) {
+    console.log(err.code); // e.g. 'MICROPHONE_NOT_FOUND'
+  }
+}
+```
+
+`DeviceError`, `OrtError`, and `OrtPathError` extend `DecibriError`, which extends `Error`. Each carries a stable `code` string. Argument validation (bad `sampleRate`, `channels`, `dtype`, or `vad`) throws a built-in `RangeError` or `TypeError`.
 
 ## API: Browser
 
 The browser API uses `getUserMedia` and `AudioWorklet`. It differs from the Node.js API because browser audio is fundamentally async.
 
-### `new Decibri(options?)` (browser)
+### `new Microphone(options?)` (browser)
 
 Same options as Node.js, plus:
 
 | Option | Type | Default | Description |
 | --- | --- | --- | --- |
-| `device` | string | system default | Device ID from `Decibri.devices()` (not index) |
+| `device` | string | system default | Device ID from `Microphone.devices()` (not index) |
 | `echoCancellation` | boolean | true | Browser echo cancellation |
 | `noiseSuppression` | boolean | true | Browser noise suppression |
 | `workletUrl` | string | inline blob | Custom worklet URL for strict CSP |
 
+The browser runs energy-mode VAD only, so its `vad` option accepts `false` or `'energy'`. The browser `version()` returns `{ decibri }` only.
+
 ### Key differences from Node.js
 
 | Aspect | Node.js | Browser |
@@ -144,49 +179,52 @@ Same options as Node.js, plus:
 | Base class | Readable stream | Custom Emitter |
 | Data type | Buffer | Int16Array / Float32Array |
 | `devices()` | Sync, returns array | Async, returns Promise |
-| Sample rate | Direct via cpal | Resampled from native rate |
+| Sample rate | Native device rate | Resampled from native rate |
+| VAD | `'silero'` or `'energy'` | `'energy'` only |
 
 ## Voice Activity Detection
 
-### Energy mode (default)
+### Energy mode
 
 Lightweight RMS energy threshold. No model required.
 
 ```javascript
-const mic = new Decibri({ vad: true, vadThreshold: 0.01 });
+const mic = new Microphone({ vad: 'energy', vadThreshold: 0.01 });
 mic.on('speech', () => console.log('speaking'));
 mic.on('silence', () => console.log('silent'));
 ```
 
 ### Silero mode
 
-ML-based detection using the Silero VAD v5 ONNX model. More accurate than energy mode, especially in noisy environments.
+ML-based detection using the Silero VAD v5 model. More accurate than energy mode, especially in noisy environments.
 
 ```javascript
-const mic = new Decibri({ vad: true, vadMode: 'silero', vadThreshold: 0.5 });
+const mic = new Microphone({ vad: 'silero', vadThreshold: 0.5 });
 mic.on('speech', () => console.log('speaking'));
 mic.on('silence', () => console.log('silent'));
 ```
 
-The Silero model (~2MB) ships inside the npm package. No downloads or API keys required.
+The Silero model (~2MB) ships inside the npm package. No downloads or API keys required. Silero mode is Node.js only.
 
 ## Device Selection
 
 ```javascript
+const { Microphone } = require('decibri');
+
 // System default
-const mic = new Decibri();
+const mic = new Microphone();
 
 // By name (case-insensitive substring match)
-const mic = new Decibri({ device: 'USB' });
+const mic = new Microphone({ device: 'USB' });
 
 // By index
-const devices = Decibri.devices();
-const mic = new Decibri({ device: devices[1].index });
+const devices = Microphone.devices();
+const mic = new Microphone({ device: devices[1].index });
 
 // By stable per-host ID (survives across enumerations)
-const mic = new Decibri({ device: { id: devices[1].id } });
+const mic = new Microphone({ device: { id: devices[1].id } });
 
-Decibri.devices();
+Microphone.devices();
 // [
 //   { index: 0, name: 'Microphone', id: '{0.0.1.00000000}.{...}', maxInputChannels: 2, defaultSampleRate: 48000, isDefault: true },
 //   { index: 1, name: 'USB Headset', id: '{0.0.1.00000000}.{...}', maxInputChannels: 1, defaultSampleRate: 44100, isDefault: false }
@@ -206,6 +244,10 @@ node node_modules/decibri/examples/websocket-server.js   # terminal 1
 node node_modules/decibri/examples/websocket-stream.js   # terminal 2
 ```
 
+## Migrating from 3.x
+
+decibri 4.0.0 renames the API to a microphone and speaker vocabulary and switches to named exports. See [MIGRATION.md](./MIGRATION.md) for a complete before-and-after guide.
+
 ## Platform Support
 
 | Platform | Architecture | Audio Backend |
@@ -218,9 +260,9 @@ node node_modules/decibri/examples/websocket-stream.js   # terminal 2
 
 ## How It Works
 
-decibri is a Rust library using cpal for cross-platform audio I/O. The Rust core compiles to a Node.js native addon via napi-rs and ships pre-built binaries for each platform. Browser support uses a JavaScript AudioWorklet implementation with the same event-driven API.
+decibri compiles a Rust audio core to a Node.js native addon and ships prebuilt binaries for each platform, so there is no build step on install. Browser support uses a JavaScript AudioWorklet implementation with the same event-driven API.
 
-Audio flows from the OS audio device through cpal's callback, into a crossbeam channel, through frame-exact buffering (guarantees consistent chunk sizes), and into Node.js via a threadsafe function. The JavaScript layer wraps this in a standard Readable stream.
+On Node.js, audio flows from the OS audio device through frame-exact buffering (which guarantees consistent chunk sizes) and into a standard Readable stream. In the browser, audio is captured and resampled in an AudioWorklet and delivered through the same `'data'` event interface.
 
 ## Documentation
 

package/examples/wav-capture.js

@@ -5,14 +5,14 @@
 // Usage (from repo clone):            node npm/decibri/examples/wav-capture.js
 
 const fs = require('fs');
-const Decibri = require('decibri');
+const { Microphone } = require('decibri');
 
 const SAMPLE_RATE     = 16000;
 const CHANNELS        = 1;
 const BITS_PER_SAMPLE = 16;
 const DURATION_MS     = 5000;
 
-const mic    = new Decibri({ sampleRate: SAMPLE_RATE, channels: CHANNELS });
+const mic    = new Microphone({ sampleRate: SAMPLE_RATE, channels: CHANNELS });
 const chunks = [];
 
 mic.on('data',  (chunk) => chunks.push(chunk));

package/examples/websocket-stream.js

@@ -5,11 +5,11 @@
 // Usage (from repo clone):            node npm/decibri/examples/websocket-stream.js [ws://localhost:8080]
 
 const { WebSocket } = require('ws');
-const Decibri       = require('decibri');
+const { Microphone } = require('decibri');
 
 const url = process.argv[2] || 'ws://localhost:8080';
 const ws  = new WebSocket(url);
-const mic = new Decibri({ sampleRate: 16000, channels: 1 });
+const mic = new Microphone({ sampleRate: 16000, channels: 1 });
 
 ws.on('open', () => {
   console.log(`Connected to ${url}, streaming audio. Ctrl+C to stop.`);

package/index.d.ts

@@ -115,5 +115,5 @@ export interface OutputDeviceInfoJs {
 /** Version info returned to JS. */
 export interface VersionInfoJs {
   decibri: string
-  portaudio: string
+  audioBackend: 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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-        throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+      if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-            throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+          if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.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 !== '3.4.2' && process.env.NAPI_RS_ENFORCE_VERSION_CHECK && process.env.NAPI_RS_ENFORCE_VERSION_CHECK !== '0') {
-          throw new Error(`Native binding package version mismatch, expected 3.4.2 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
+        if (bindingPackageVersion !== '4.0.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 4.0.0 but got ${bindingPackageVersion}. You can reinstall dependencies to fix this issue.`)
         }
         return binding
       } catch (e) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "decibri",
-  "version": "3.4.2",
-  "description": "Cross-platform audio capture, output, and processing for Node.js and browsers",
+  "version": "4.0.0",
+  "description": "Cross-platform audio capture, playback, and processing for Node.js and browsers",
   "main": "src/decibri.js",
   "types": "src/decibri.d.ts",
   "browser": "./src/browser/index.js",
@@ -67,13 +67,15 @@
     "examples/",
     "index.js",
     "index.d.ts",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md",
+    "MIGRATION.md"
   ],
   "optionalDependencies": {
-    "@decibri/decibri-win32-x64-msvc": "3.4.2",
-    "@decibri/decibri-darwin-arm64": "3.4.2",
-    "@decibri/decibri-linux-x64-gnu": "3.4.2",
-    "@decibri/decibri-linux-arm64-gnu": "3.4.2"
+    "@decibri/decibri-win32-x64-msvc": "4.0.0",
+    "@decibri/decibri-darwin-arm64": "4.0.0",
+    "@decibri/decibri-linux-x64-gnu": "4.0.0",
+    "@decibri/decibri-linux-arm64-gnu": "4.0.0"
   },
   "devDependencies": {
     "@napi-rs/cli": "^3.0.0"