@buffered-audio/nodes 0.23.0 → 0.24.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -92,16 +92,15 @@ Adaptive (MEF FDAF Kalman + MWF + MSAD) reference-based microphone bleed reducti
92
92
 
93
93
  ### DeepFilterNet3 (Denoiser)
94
94
 
95
- Remove background noise from speech using DeepFilterNet3 (48 kHz full-band CRN)
95
+ Remove background noise from speech using DeepFilterNet3 (48 kHz full-band CRN). At other source rates, the internal resampling round trip may add or drop up to two source-rate frames.
96
96
 
97
97
  [Source](./src/transforms/deep-filter-net-3/index.ts)
98
98
 
99
99
  | Parameter | Type | Default | Description |
100
100
  | --- | --- | --- | --- |
101
101
  | `modelPath` | string | `""` | DeepFilterNet3 48 kHz denoiser model (.onnx) Download: [dfn3](https://github.com/yuyun2000/SpeechDenoiser) |
102
- | `ffmpegPath` | string | `""` | FFmpeg — only used when sampleRate 48000 to chain up/down resamplers around the inference stream; can be left blank when sampleRate === 48000. Download: [ffmpeg](https://ffmpeg.org/download.html) |
102
+ | `ffmpegPath` | string | `""` | FFmpeg — used when the input audio is not 48 kHz to chain up/down resamplers around the inference stream; can be left blank for 48 kHz input. Download: [ffmpeg](https://ffmpeg.org/download.html) |
103
103
  | `onnxAddonPath` | string | `""` | ONNX Runtime native addon Download: [onnx-addon](https://github.com/visionsofparadise/onnx-runtime-addon) |
104
- | `sampleRate` | number (min 0) | — | Source audio sample rate in Hz. Required. When ≠ 48000, ffmpeg resampling is chained around the inference stream via _setup composition. |
105
104
  | `attenuation` | number (0 to 100) | `30` | Attenuation cap in dB. Maps to the ONNX `atten_lim_db` input; 0 = no cap |
106
105
 
107
106
  ### Dither
@@ -392,7 +391,7 @@ Write audio to a file
392
391
  | `bitDepth` | "16" \| "24" \| "32" \| "32f" | `"16"` | |
393
392
  | `encoding` | Object, optional | — | Encode through ffmpeg to a non-WAV format. Requires `ffmpegPath`. |
394
393
  | `encoding.format` | "wav" \| "flac" \| "mp3" \| "aac" | — | |
395
- | `encoding.bitrate` | string, optional | — | |
394
+ | `encoding.bitrate` | number (8 to 1024), optional | — | Constant bitrate in kbps for MP3 and AAC. Defaults to 192 kbps. |
396
395
  | `encoding.vbr` | number (0 to 9), optional | — | |
397
396
  | `encoding.sampleRate` | number (min 0), optional | — | Output sample rate (Hz). When set, ffmpeg resamples on encode. |
398
397