@aeonentertainment/mixer 0.2.0 → 0.3.0

package/README.md

@@ -15,7 +15,7 @@ Each [release](https://github.com/aeonentertainment/aeon-mixer/releases) carries
 Depend on its URL, and the lockfile pins its hash:
 
 ```bash
-npm install https://github.com/aeonentertainment/aeon-mixer/releases/download/v0.2.0/aeonentertainment-mixer-0.2.0.tgz
+npm install https://github.com/aeonentertainment/aeon-mixer/releases/download/v0.3.0/aeonentertainment-mixer-0.3.0.tgz
 ```
 
 ## Use
@@ -51,7 +51,8 @@ await engine.close();
 - **Slots** are the mics: 8 per engine by default, up to 16 with `openEngine({ slots })`. `rtp`
   takes Opus over UDP from a phone or mediasoup, `l16` takes raw PCM over loopback from a house
   mic, and `push` takes PCM the host hands to `mixer.push`. Each slot has gain, pan, mute, solo,
-  reverb, a pitch reading and a melody guide.
+  reverb, a pitch reading, a melody guide and pitch correction toward it, whose delay `stats()`
+  reports.
 - **The backing** is any format Symphonia decodes, resampled to 48 kHz. The armed key and speed
   are rendered before `start` resolves. Live, it supports seek, pause, resume, a key change and
   stem gains, and `start`, `seek` and `resume` report the position the lyric clock follows.

package/dist/index.d.mts

@@ -72,7 +72,7 @@ declare class Mixer$1 {
    * recording it for null.
    */
   recordSlot(index: number, path?: string | undefined | null): void;
-  /** Every slot's ingest counters, as the audio thread last published them. */
+  /** Every slot's ingest counters and corrector delay, as the audio thread last published them. */
   stats(): Array<SlotStatsInfo>;
   /** The return stream's counters, or null for a mixer without one. */
   returnStats(): RtpReturnStats | null;
@@ -198,6 +198,8 @@ interface SlotStatsInfo {
   concealed: number;
   resyncs: number;
   jitterMs: number;
+  correctorDelayMs: number;
+  correctorMaxDelayMs: number;
 }
 interface StemGainsInput {
   instrumental: number;
@@ -290,6 +292,13 @@ interface SlotStats {
   concealed: number;
   resyncs: number;
   jitterMs: number;
+  /**
+   * How far the corrector holds this slot's voice now; 0 with correction off. It moves with the
+   * voice and one read is a sample of it, so show it and never add it to a budget or a clock.
+   */
+  correctorDelayMs: number;
+  /** The most that delay can reach; 0 with correction off. It holds still, so a budget adds this. */
+  correctorMaxDelayMs: number;
 }
 type EngineEvents = {
   fault: (error: Error) => void;

package/native/binding/index.d.ts

@@ -85,7 +85,7 @@ export declare class Mixer {
    * recording it for null.
    */
   recordSlot(index: number, path?: string | undefined | null): void
-  /** Every slot's ingest counters, as the audio thread last published them. */
+  /** Every slot's ingest counters and corrector delay, as the audio thread last published them. */
   stats(): Array<SlotStatsInfo>
   /** The return stream's counters, or null for a mixer without one. */
   returnStats(): RtpReturnStats | null
@@ -208,6 +208,8 @@ export interface SlotStatsInfo {
   concealed: number
   resyncs: number
   jitterMs: number
+  correctorDelayMs: number
+  correctorMaxDelayMs: number
 }
 
 export interface StemGainsInput {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aeonentertainment/mixer",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Low-latency LAN audio mixer for Aeon Karaoke: phone and house mics, a backing track, one mix to the room.",
   "bugs": {
     "url": "https://github.com/aeonentertainment/aeon-mixer/issues"