@openmoq/playback 0.0.0-stage → 0.6.0

package/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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

@@ -1,3 +1,19 @@
-# Temporary Holding Version
+<!-- Generated by scripts/generate-package-readmes.mjs — do not edit.
+     Content derives from this package's package.json (name, description).
+     Run `node scripts/generate-package-readmes.mjs --write` after editing it. -->
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @openmoq/playback
+
+Sans-I/O media playback core for Media over QUIC (MoQ): jitter buffer, A/V sync, gap detection, decoder state machine, and pipeline orchestration.
+
+Part of [Playa](https://github.com/openmoq/moq-playa) — a TypeScript implementation of Media over QUIC (MoQ). See the [project README](https://github.com/openmoq/moq-playa#readme) for architecture and API documentation.
+
+## Install
+
+```sh
+npm install @openmoq/playback
+```
+
+## License
+
+[Apache-2.0](https://github.com/openmoq/moq-playa/blob/main/LICENSE.txt)

package/dist/adaptive-tolerance.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Adaptive jitter tolerance controller.
+ *
+ * Auto-calibrates gap timeout and drift threshold from observed network
+ * jitter. Implements graduated recovery (monitoring → extended wait → skip)
+ * with stall-count escalation and exponential decay.
+ *
+ * Sans-I/O: time is an explicit parameter, no browser APIs.
+ * All state is flat and mutable in place — zero allocations in the hot path.
+ *
+ * @see draft-ietf-moq-loc-01 §2.3.1.1 (CaptureTimestamp)
+ * @module
+ */
+export declare const RecoveryPhase: {
+    /** Baseline — no active jitter issues. */
+    readonly Normal: "normal";
+    /** Gap detected, observing whether transient or persistent. */
+    readonly Monitoring: "monitoring";
+    /** Persistent gap — waiting with extended timeout before skipping. */
+    readonly ExtendedWait: "extended_wait";
+};
+export type RecoveryPhaseValue = (typeof RecoveryPhase)[keyof typeof RecoveryPhase];
+export interface ToleranceConfig {
+    readonly emaAlpha: number;
+    readonly varianceAlpha: number;
+    readonly slidingWindowSize: number;
+    readonly jitterMultiplier: number;
+    readonly minGapTimeoutMs: number;
+    readonly maxGapTimeoutMs: number;
+    readonly minDriftThresholdMs: number;
+    readonly driftThresholdMultiplier: number;
+    readonly stallIncrementMs: number;
+    readonly maxStallIncrements: number;
+    readonly monitorWindowMs: number;
+    readonly monitorCleanFrames: number;
+    readonly monitorCleanDurationMs: number;
+    readonly maxExtendedWaitMs: number;
+    readonly skipFrequencyThreshold: number;
+    readonly skipFrequencyWindowMs: number;
+    readonly decayMinCleanFrames: number;
+    readonly decayMinCleanDurationMs: number;
+    readonly decayFactor: number;
+}
+export declare const DEFAULT_TOLERANCE_CONFIG: ToleranceConfig;
+export interface TickResult {
+    /** Whether the caller should skip forward past the current gap. */
+    readonly shouldSkip: boolean;
+}
+/**
+ * Adaptive jitter tolerance controller.
+ *
+ * Consumes frame arrival and gap events, produces auto-calibrated
+ * thresholds for gap timeout and drift detection.
+ */
+export declare class AdaptiveToleranceController {
+    private readonly cfg;
+    private _jitterEma;
+    private _jitterVar;
+    private _lastTransitMs;
+    private _hasLastTransit;
+    private readonly _slidingMax;
+    private _phase;
+    private _phaseEnteredMs;
+    private _monitorGapCount;
+    private _stallCount;
+    private _stallEscalationMs;
+    private _skipTimestamps;
+    private _cleanFrameCount;
+    private _cleanStreakStartMs;
+    private _shouldReduceQuality;
+    private _deliveryTimeoutMs;
+    private _lastCaptureUs;
+    private _hasCaptureRef;
+    private _captureJitterEma;
+    constructor(config: ToleranceConfig);
+    get phase(): RecoveryPhaseValue;
+    get jitterEmaMs(): number;
+    get jitterVarMs(): number;
+    get slidingMaxMs(): number;
+    get stallCount(): number;
+    get shouldReduceQuality(): boolean;
+    /**
+     * Auto-calibrated gap timeout in milliseconds.
+     *
+     * baseline = max(minGap, EMA + K × variance, slidingMax)
+     * effective = min(baseline + stallEscalation, maxGap, deliveryTimeout)
+     */
+    get effectiveGapTimeoutMs(): number;
+    /**
+     * Auto-calibrated drift threshold in milliseconds.
+     *
+     * Based on observed CaptureTimestamp interarrival jitter.
+     */
+    get effectiveDriftThresholdMs(): number;
+    /**
+     * Notify that a frame arrived.
+     *
+     * @param nowMs Current time in milliseconds
+     * @param captureUs CaptureTimestamp in microseconds
+     * @param arrivalMs Arrival time in milliseconds
+     */
+    onFrameArrived(nowMs: number, captureUs: number, arrivalMs: number): void;
+    /**
+     * Notify that a gap was detected.
+     *
+     * @param nowMs Current time in milliseconds
+     * @param groupId The group ID where the gap was detected
+     */
+    onGapDetected(nowMs: number, _groupId: number): void;
+    /**
+     * Periodic tick — evaluate phase transitions and decay.
+     *
+     * @param nowMs Current time in milliseconds
+     * @returns TickResult indicating whether caller should skip forward
+     */
+    tick(nowMs: number): TickResult;
+    /**
+     * Set DELIVERY_TIMEOUT from protocol negotiation.
+     * Caps the effective gap timeout.
+     *
+     * @see draft-ietf-moq-transport-16 §9.2.2.2
+     */
+    setDeliveryTimeout(timeoutMs: number): void;
+    /** Reset all state (seek, pause→resume). */
+    reset(): void;
+    private _pruneSkipTimestamps;
+}
+//# sourceMappingURL=adaptive-tolerance.d.ts.map

package/dist/adaptive-tolerance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adaptive-tolerance.d.ts","sourceRoot":"","sources":["../src/adaptive-tolerance.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAIH,eAAO,MAAM,aAAa;IACxB,0CAA0C;;IAE1C,+DAA+D;;IAE/D,sEAAsE;;CAE9D,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC;AAIpF,MAAM,WAAW,eAAe;IAE9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAGlC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IAGjC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,wBAAwB,EAAE,MAAM,CAAC;IAG1C,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IAGpC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;IACxC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAGnC,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;IACxC,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;IAGvC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,eAAO,MAAM,wBAAwB,EAAE,eA0BtC,CAAC;AAIF,MAAM,WAAW,UAAU;IACzB,mEAAmE;IACnE,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;CAC9B;AAgED;;;;;GAKG;AACH,qBAAa,2BAA2B;IACtC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAkB;IAGtC,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAa;IAGzC,OAAO,CAAC,MAAM,CAA4C;IAC1D,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,kBAAkB,CAAK;IAG/B,OAAO,CAAC,eAAe,CAAgB;IAGvC,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,mBAAmB,CAAK;IAGhC,OAAO,CAAC,oBAAoB,CAAS;IAGrC,OAAO,CAAC,kBAAkB,CAAK;IAG/B,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,iBAAiB,CAAK;gBAElB,MAAM,EAAE,eAAe;IAOnC,IAAI,KAAK,IAAI,kBAAkB,CAAwB;IACvD,IAAI,WAAW,IAAI,MAAM,CAA4B;IACrD,IAAI,WAAW,IAAI,MAAM,CAA4B;IACrD,IAAI,YAAY,IAAI,MAAM,CAAiC;IAC3D,IAAI,UAAU,IAAI,MAAM,CAA6B;IACrD,IAAI,mBAAmB,IAAI,OAAO,CAAsC;IAExE;;;;;OAKG;IACH,IAAI,qBAAqB,IAAI,MAAM,CAclC;IAED;;;;OAIG;IACH,IAAI,yBAAyB,IAAI,MAAM,CAQtC;IAID;;;;;;OAMG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IA0CzE;;;;;OAKG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IA0BpD;;;;;OAKG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU;IAoE/B;;;;;OAKG;IACH,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAI3C,4CAA4C;IAC5C,KAAK,IAAI,IAAI;IA0Bb,OAAO,CAAC,oBAAoB;CAI7B"}