decibri 5.2.5 → 5.4.0

package/CHANGELOG.md

@@ -9,6 +9,38 @@ 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.4.0] - 2026-08-04
+
+### Added
+
+- `File.save(path, options)` writes the conditioned recording to disk as 16-bit PCM mono at `sampleRate`, in WAV, AIFF or FLAC, off the event loop. The container comes from the path's extension (`.wav`, `.aiff`, `.aif`, `.aifc` or `.flac`) or from `options.format`: decibri reads a file by its content and writes one by its name, and an extension it does not recognise rejects rather than defaulting. `options.compression` sets the FLAC compression level, 0 to 8 with 5 the default. Resolves to a `SaveReport`: `clippedSamples` counts finite samples outside full scale clamped to `[-1.0, 1.0]`, and `nonFiniteSamples` counts non-finite samples that never reach the file (NaN is written as silence, an infinity as full scale). Saving consumes the source and rejects with `FILE_ENGAGED` once the stream is engaged, exactly as `analyze()` does.
+- `AudioWriter`, a Writable file sink for PCM audio. Pipe a `File`, or any stream of int16 or float32 PCM bytes, into it and the whole stream is written as one audio file when it finishes, with the same containers, encoding, clamp and non-finite handling as `File.save`, so the two spellings produce the same bytes. Takes `sampleRate` (required), `dtype`, and the `File.save` options; `report` carries the `SaveReport` after `'finish'`.
+- Error code `FILE_WRITE_FAILED` on `DecibriError`, for an encoded file the filesystem refuses to write. The message names the path and the underlying I/O failure.
+- `File` reads AIFF, AIFF-C and FLAC as well as WAV, and reads WAV in mu-law, A-law, 8-bit and 24-bit as well as the 16-bit PCM and 32-bit float it already read. The container is identified from the file's own bytes, so the path's extension does not decide how a file is read. No option changes: the same `new File(path)` and `File.open(path)` open more files.
+- Error code `AUDIO_FORMAT_UNSUPPORTED` on `DecibriError`, for a file in a container or an encoding decibri cannot decode. The message names the container tag, codec or sample width in question.
+- Error code `AUDIO_FILE_MALFORMED` on `DecibriError`, for a file whose bytes are not what its format requires where they sit. The message names the byte offset and what was expected there.
+- Error code `AUDIO_FILE_TRUNCATED` on `DecibriError`, for a file that ends before the audio it declares. The message names what was needed against what was available.
+- `LICENSE`, the full Apache 2.0 text, in the published package.
+
+### Changed
+
+- **BREAKING: a WAV whose declared data length is not a whole number of frames now fails to open**, throwing a `DecibriError` with code `AUDIO_FILE_TRUNCATED`. It previously opened and delivered audio a fraction of a frame short of its own declaration, with nothing to indicate it. A file shorter than its declared length, which is what an interrupted download leaves behind, already failed to open and is unaffected.
+- A file declaring no channels carries `AUDIO_FORMAT_UNSUPPORTED` where it carried `WAV_INVALID`.
+
+### Removed
+
+- **BREAKING: the `WAV_INVALID` error code.** `AUDIO_FORMAT_UNSUPPORTED`, `AUDIO_FILE_MALFORMED` and `AUDIO_FILE_TRUNCATED` replace it, splitting what was one failure into the three the caller acts on differently. Code branching on `err.code === 'WAV_INVALID'` must be updated; `catch (e) { if (e instanceof DecibriError) ... }` catches all three unchanged.
+
+## [5.3.0] - 2026-07-31
+
+### Added
+
+- `aec` option on `Microphone`: acoustic echo cancellation on the capture path. The short form names the model (`aec: 'tau'`); the object form takes `{ model, tailMs, suppression, referenceSampleRate }`. It runs before the detector tap, so `vadScore` and the `speech` / `silence` events read the echo-removed signal, and it requires `sampleRate` in 8000 to 48000. Native capture only: the browser entry keeps the platform's own `echoCancellation` constraint.
+- `Microphone.pushAecReference(data)`, which queues the far-end audio the canceller cancels against: the same input shapes `Speaker.write` accepts, mono, in played order, at the declared `referenceSampleRate`. It never blocks and never throws on a full queue. When it is pushed does not have to match when it plays: the queue is read at the rate the capture consumes it, so a greeting pushed before the first `data` event, or a whole utterance handed over in one call, is read out over the capture it echoes into and every sample of it is cancelled against. The queue holds two seconds, which bounds how far ahead of its own capture a caller may run.
+- `Microphone.aecMetrics()`, the canceller's transport and cancellation metrics merged with the reference queue's counters, or `null` while echo cancellation is off or capture is not running.
+
+Echo cancellation joins automatic gain control as a stage that can drive captured samples above full scale when the limiter is off, because it subtracts its estimate of the echo from the capture and exceeds the capture wherever that estimate is wrong in phase. The limiter runs after it and bounds the output to its ceiling; the `int16` sample format clamps, so an over-scale sample arrives as full scale rather than wrapping, and a `float32` consumer without the limiter should clamp its own output.
+
 ## [5.2.5] - 2026-07-28
 
 ### Changed

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Decibri
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -341,7 +341,7 @@ VAD reads the signal before the chain, so `vadScore` and the `'speech'` / `'sile
 
 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.
 
-- `await File.open(path, options?)`: read a WAV off the event loop (recommended, like `Microphone.open`).
+- `await File.open(path, options?)`: read a file off the event loop (recommended, like `Microphone.open`). Reads WAV, AIFF, AIFF-C and FLAC, identified from the file's own bytes rather than its extension.
 - `new File(path, options?)`: the same result, synchronous (blocks on disk I/O; fine for scripts).
 - `File.buffer(samples, options)`: wrap a `Float32Array` of samples you already hold. `options.inputRate` is required (raw samples carry no header); a raw `Buffer` of bytes is rejected as ambiguous.
 - `await file.analyze()` (also spelled `analyse()`): consume the source and resolve to a `VadReport` of per-window `scores` (`{ start, end, vadScore, isSpeech }`) and merged speech `segments` (`{ start, end }`), in seconds of file time. Requires `vad: 'silero'`; a `File` opened without `vad` rejects with `analysis requires VAD`.

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.2.5";
+		const VERSION = "5.4.0";
 		/**
 		* Browser microphone capture.
 		*

package/index.d.ts

@@ -29,6 +29,21 @@ export declare class DecibriBridge {
    * number for any realistic count) to match the `vadProbability` getter.
    */
   get overrunCount(): number
+  /**
+   * 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.
+   */
+  pushAecReference(buffer: Buffer): void
+  /**
+   * The echo canceller's transport and cancellation metrics, merged with the
+   * 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.
+   */
+  aecMetrics(): AecMetricsJs | null
   /** List all available audio input devices. */
   static devices(): Array<DeviceInfoJs>
   /** Version information. */
@@ -100,13 +115,14 @@ export declare class DecibriOutputBridge {
  */
 export declare class FileHandle {
   /**
-   * Open a WAV path as an offline source, synchronously (blocks on disk
-   * I/O; the JS wrapper's async `File.open` uses `openAsync` instead).
+   * Open an audio path as an offline source, synchronously (blocks on
+   * disk I/O; the JS wrapper's async `File.open` uses `openAsync`
+   * instead).
    */
   static open(path: string, options?: FileOptions | undefined | null): FileHandle
   /**
-   * Open a WAV path without blocking the JS event loop: the disk read,
-   * WAV parse, and chain construction run on the libuv thread pool.
+   * Open an audio path without blocking the JS event loop: the disk read,
+   * decode, and chain construction run on the libuv thread pool.
    */
   static openAsync(path: string, options?: FileOptions | undefined | null): Promise<unknown>
   /**
@@ -132,6 +148,15 @@ export declare class FileHandle {
    * the configuration and retry.
    */
   analyze(): Promise<unknown>
+  /**
+   * Consume the source and write the conditioned recording to disk, off
+   * the JS event loop. Resolves to the `SaveReport`.
+   *
+   * Everything checkable is checked before the source is taken, so a
+   * rejected call leaves the File exactly as it was and the caller can fix
+   * the arguments and retry.
+   */
+  save(path: string, options?: SaveOptions | undefined | null): Promise<unknown>
   /** Release the source. Idempotent; a closed File reads as ended. */
   close(): void
   /**
@@ -142,12 +167,68 @@ export declare class FileHandle {
   /** The target output rate every delivered chunk carries. */
   get sampleRate(): number
   /**
-   * The source's native rate, from the WAV header or the explicit
+   * The source's native rate, from the file's header or the explicit
    * `inputRate` of `buffer`.
    */
   get inputRate(): 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
+ * caller reads one surface for the whole diagnosis.
+ */
+export interface AecMetricsJs {
+  /**
+   * The active delay alignment in samples, or `null` while the estimator is
+   * still searching. Staying `null` while `acquisitionParked` climbs is the
+   * signature of a canceller with no usable reference: none pushed, not at
+   * the declared rate, or not the signal that produced the echo.
+   */
+  delaySamples?: number
+  /**
+   * Smoothed echo-return-loss-enhancement estimate in dB: how much echo the
+   * canceller is currently removing. 0 before the filter has converged.
+   */
+  erleDb: number
+  /**
+   * Whether the double-talk detector currently believes the near-end talker
+   * is active; adaptation is held while true.
+   */
+  doubleTalk: boolean
+  /**
+   * Near-end samples the canceller could find no far-end sample for while an
+   * alignment was active. The core keeps the far-end stream level with the
+   * capture, so this stays 0 for a caller who simply stops pushing; a
+   * non-zero count means the caller ran further ahead of the capture than
+   * the canceller's far-end history reaches.
+   */
+  referenceStarved: number
+  /**
+   * Near-end samples processed while no delay alignment was active: the
+   * searching span, not a transport failure.
+   */
+  acquisitionParked: number
+  /**
+   * Times the canceller inferred a capture discontinuity and rebuilt its
+   * alignment from the reference frontier.
+   */
+  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.
+   */
+  referenceDropped: number
+  /**
+   * Far-end samples the core supplied as silence because the caller had
+   * pushed none for them, at the capture rate. An accounting figure, not a
+   * fault: while nothing is playing, the far end is silence.
+   */
+  referenceSilence: number
+}
+
 /**
  * Options passed from JS constructor.
  *
@@ -215,6 +296,34 @@ export interface DecibriOptions {
    * DSP: no bundled file and no model path, like `agc`.
    */
   limiter?: number
+  /**
+   * Echo canceller model name. The accepted set is owned by the canceller
+   * (`AecModel::from_str`); today it is `'tau'`. Absent leaves echo
+   * cancellation off. The JS wrapper resolves both public forms (the string
+   * shorthand and the `AecOptions` object) into this field and the three
+   * below. Pure DSP: no bundled file and no model path, like `highpass`.
+   */
+  aec?: string
+  /**
+   * Echo canceller filter tail in milliseconds: an integer in `16..=500`.
+   * Absent takes the canceller's own default. Consulted only when `aec`
+   * names a model.
+   */
+  aecTailMs?: number
+  /**
+   * Residual-suppression policy for the echo canceller: `'conservative'` or
+   * `'off'`. Absent takes the canceller's own default. Consulted only when
+   * `aec` names a model.
+   */
+  aecSuppression?: string
+  /**
+   * Sample rate in Hz of the far-end reference pushed through
+   * `pushAecReference`, in `1000..=384000`. Absent means the reference is
+   * already at the capture rate; when it names a different rate, the core
+   * converts the reference before the canceller sees it. Consulted only
+   * when `aec` names a model.
+   */
+  aecReferenceSampleRate?: number
 }
 
 /** Options passed from JS constructor for output. */
@@ -274,6 +383,25 @@ export interface OutputDeviceInfoJs {
   isDefault: boolean
 }
 
+/**
+ * Options passed from the JS `File.save` wrapper: the container format
+ * override and the FLAC compression level.
+ */
+export interface SaveOptions {
+  format?: string
+  compression?: number
+}
+
+/**
+ * What a save did to the samples on their way into the file: finite
+ * samples outside full scale clamped and counted, non-finite samples
+ * replaced (NaN with silence, an infinity with full scale) and counted.
+ */
+export interface SaveReport {
+  clippedSamples: number
+  nonFiniteSamples: number
+}
+
 /** One merged speech region of a recording, in seconds of file time. */
 export interface Segment {
   start: number