@yume-chan/scrcpy-decoder-shared 3.0.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-2026 Simon Chan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+<p align="center">
+    <img alt="Tango" src="https://raw.githubusercontent.com/yume-chan/ya-webadb/main/.github/logo.svg" width="200">
+</p>
+
+<h1 align="center">@yume-chan/scrcpy-decoder-shared</h1>
+
+<p align="center">
+    Shared types and utilities for Scrcpy video decoders.
+</p>
+
+<p align="center">
+    <a href="https://github.com/yume-chan/ya-webadb/blob/main/LICENSE">
+        <img alt="MIT License" src="https://img.shields.io/github/license/yume-chan/ya-webadb">
+    </a>
+    <a href="https://github.com/yume-chan/ya-webadb/releases">
+        <img alt="GitHub release" src="https://img.shields.io/github/v/release/yume-chan/ya-webadb?logo=github">
+    </a>
+    <a href="https://bundlephobia.com/package/@yume-chan/scrcpy-decoder-shared">
+        <img alt="Package Size" src="https://img.shields.io/bundlephobia/minzip/%40yume-chan%2Fscrcpy-decoder-shared">
+    </a>
+    <a href="https://www.npmjs.com/package/@yume-chan/scrcpy-decoder-shared">
+        <img alt="npm" src="https://img.shields.io/npm/dm/%40yume-chan/scrcpy-decoder-shared?logo=npm">
+    </a>
+    <a href="https://tangoadb.dev/discord">
+        <img alt="Discord" src="https://img.shields.io/discord/1120215514732564502?logo=discord&logoColor=%23ffffff&label=Discord">
+    </a>
+    <a href="https://tangoadb.dev/wechat">
+        <img alt="WeChat Group" src="https://img.shields.io/badge/WeChat-Group-%2307C160?logo=wechat&logoColor=white">
+    </a>
+</p>
+
+This package is part of [Tango ADB](https://github.com/yume-chan/ya-webadb). Generally you need multiple packages to build a complete ADB client that can run on Web browsers and Node.js. Read the documentation for more information.
+
+## Documentation
+
+Check the latest documentation at https://tangoadb.dev/scrcpy/video/tiny-h264/
+
+## Sponsors
+
+[Become a backer](https://opencollective.com/ya-webadb) and get your image on our README on GitHub with a link to your site.
+
+<a href="https://opencollective.com/ya-webadb/backer/0/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/0/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/ya-webadb/backer/1/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/1/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/ya-webadb/backer/2/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/2/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/ya-webadb/backer/3/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/3/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/ya-webadb/backer/4/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/4/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/ya-webadb/backer/5/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/5/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/ya-webadb/backer/6/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/6/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/ya-webadb/backer/7/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/7/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/ya-webadb/backer/8/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/8/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/ya-webadb/backer/9/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/9/avatar.svg?requireActive=false"></a>
+<a href="https://opencollective.com/ya-webadb/backer/10/website?requireActive=false" target="_blank"><img src="https://opencollective.com/ya-webadb/backer/10/avatar.svg?requireActive=false"></a>

package/esm/decoder-counter.d.ts

@@ -0,0 +1,34 @@
+export interface ScrcpyVideoDecoderPerformanceCounterInterface {
+    /**
+     * Gets the number of times the decoder has been reset to catch up new keyframes.
+     */
+    readonly decoderResetCount: number;
+    /**
+     * Gets the number of frames decoded by the decoder.
+     */
+    readonly framesDecoded: number;
+    /**
+     * Gets the number of frames skipped by the decoder.
+     */
+    readonly framesSkippedDecoding: number;
+}
+export declare class ScrcpyVideoDecoderPerformanceCounter implements ScrcpyVideoDecoderPerformanceCounterInterface {
+    #private;
+    /**
+     * Gets the number of times the decoder has been reset to catch up new keyframes.
+     */
+    get decoderResetCount(): number;
+    /**
+     * Gets the number of frames decoded by the decoder.
+     */
+    get framesDecoded(): number;
+    /**
+     * Gets the number of frames skipped by the decoder.
+     */
+    get framesSkippedDecoding(): number;
+    increaseResetCount(): void;
+    increaseFramesDecoded(): void;
+    addFramesDecoded(count: number): void;
+    addFramesSkippedDecoding(count: number): void;
+}
+//# sourceMappingURL=decoder-counter.d.ts.map

package/esm/decoder-counter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decoder-counter.d.ts","sourceRoot":"","sources":["../src/decoder-counter.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,6CAA6C;IAC1D;;OAEG;IACH,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAC;CAC1C;AAED,qBAAa,oCAAqC,YAAW,6CAA6C;;IAEtG;;OAEG;IACH,IAAI,iBAAiB,WAEpB;IAGD;;OAEG;IACH,IAAI,aAAa,WAEhB;IAGD;;OAEG;IACH,IAAI,qBAAqB,WAExB;IAED,kBAAkB;IAIlB,qBAAqB;IAIrB,gBAAgB,CAAC,KAAK,EAAE,MAAM;IAI9B,wBAAwB,CAAC,KAAK,EAAE,MAAM;CAGzC"}

package/esm/decoder-counter.js

@@ -0,0 +1,36 @@
+export class ScrcpyVideoDecoderPerformanceCounter {
+    #decoderResetCount = 0;
+    /**
+     * Gets the number of times the decoder has been reset to catch up new keyframes.
+     */
+    get decoderResetCount() {
+        return this.#decoderResetCount;
+    }
+    #framesDecoded = 0;
+    /**
+     * Gets the number of frames decoded by the decoder.
+     */
+    get framesDecoded() {
+        return this.#framesDecoded;
+    }
+    #framesSkippedDecoding = 0;
+    /**
+     * Gets the number of frames skipped by the decoder.
+     */
+    get framesSkippedDecoding() {
+        return this.#framesSkippedDecoding;
+    }
+    increaseResetCount() {
+        this.#decoderResetCount += 1;
+    }
+    increaseFramesDecoded() {
+        this.#framesDecoded += 1;
+    }
+    addFramesDecoded(count) {
+        this.#framesDecoded += count;
+    }
+    addFramesSkippedDecoding(count) {
+        this.#framesSkippedDecoding += count;
+    }
+}
+//# sourceMappingURL=decoder-counter.js.map

package/esm/decoder-counter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decoder-counter.js","sourceRoot":"","sources":["../src/decoder-counter.ts"],"names":[],"mappings":"AAeA,MAAM,OAAO,oCAAoC;IAC7C,kBAAkB,GAAG,CAAC,CAAC;IACvB;;OAEG;IACH,IAAI,iBAAiB;QACjB,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACnC,CAAC;IAED,cAAc,GAAG,CAAC,CAAC;IACnB;;OAEG;IACH,IAAI,aAAa;QACb,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAED,sBAAsB,GAAG,CAAC,CAAC;IAC3B;;OAEG;IACH,IAAI,qBAAqB;QACrB,OAAO,IAAI,CAAC,sBAAsB,CAAC;IACvC,CAAC;IAED,kBAAkB;QACd,IAAI,CAAC,kBAAkB,IAAI,CAAC,CAAC;IACjC,CAAC;IAED,qBAAqB;QACjB,IAAI,CAAC,cAAc,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,gBAAgB,CAAC,KAAa;QAC1B,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC;IACjC,CAAC;IAED,wBAAwB,CAAC,KAAa;QAClC,IAAI,CAAC,sBAAsB,IAAI,KAAK,CAAC;IACzC,CAAC;CACJ"}

package/esm/decoder.d.ts

@@ -0,0 +1,28 @@
+import type { MaybePromiseLike } from "@yume-chan/async";
+import type { Event } from "@yume-chan/event";
+import type { ScrcpyMediaStreamPacket, ScrcpyVideoCodecId, ScrcpyVideoSize } from "@yume-chan/scrcpy";
+import type { WritableStream } from "@yume-chan/stream-extra";
+import type { ScrcpyVideoDecoderPerformanceCounterInterface } from "./decoder-counter.js";
+import type { ScrcpyVideoDecoderPauseControllerInterface } from "./pause-controller.js";
+import type { ScrcpyVideoRendererPerformanceCounterInterface } from "./renderer-counter.js";
+export interface ScrcpyVideoDecoderCapability {
+    maxProfile?: number;
+    maxLevel?: number;
+}
+export interface ScrcpyVideoDecoder extends ScrcpyVideoDecoderPerformanceCounterInterface, ScrcpyVideoRendererPerformanceCounterInterface, ScrcpyVideoDecoderPauseControllerInterface, ScrcpyVideoSize {
+    readonly type: ScrcpyVideoDecoder.Type;
+    readonly onTypeChange?: Event<ScrcpyVideoDecoder.Type> | undefined;
+    readonly rendererType: ScrcpyVideoDecoder.RendererType;
+    readonly onRendererTypeChange?: Event<ScrcpyVideoDecoder.RendererType> | undefined;
+    readonly writable: WritableStream<ScrcpyMediaStreamPacket>;
+    dispose?(): MaybePromiseLike<undefined>;
+}
+export declare namespace ScrcpyVideoDecoder {
+    type Type = "software" | "hardware";
+    type RendererType = "software" | "hardware";
+}
+export interface ScrcpyVideoDecoderConstructor {
+    readonly capabilities: Record<string, ScrcpyVideoDecoderCapability>;
+    new (codec: ScrcpyVideoCodecId): ScrcpyVideoDecoder;
+}
+//# sourceMappingURL=decoder.d.ts.map

package/esm/decoder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decoder.d.ts","sourceRoot":"","sources":["../src/decoder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,KAAK,EACR,uBAAuB,EACvB,kBAAkB,EAClB,eAAe,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,OAAO,KAAK,EAAE,6CAA6C,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,KAAK,EAAE,0CAA0C,EAAE,MAAM,uBAAuB,CAAC;AACxF,OAAO,KAAK,EAAE,8CAA8C,EAAE,MAAM,uBAAuB,CAAC;AAE5F,MAAM,WAAW,4BAA4B;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBACb,SACI,6CAA6C,EAC7C,8CAA8C,EAC9C,0CAA0C,EAC1C,eAAe;IACnB,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;IACvC,QAAQ,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;IAEnE,QAAQ,CAAC,YAAY,EAAE,kBAAkB,CAAC,YAAY,CAAC;IACvD,QAAQ,CAAC,oBAAoB,CAAC,EACxB,KAAK,CAAC,kBAAkB,CAAC,YAAY,CAAC,GACtC,SAAS,CAAC;IAEhB,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,uBAAuB,CAAC,CAAC;IAE3D,OAAO,CAAC,IAAI,gBAAgB,CAAC,SAAS,CAAC,CAAC;CAC3C;AAED,yBAAiB,kBAAkB,CAAC;IAChC,KAAY,IAAI,GAAG,UAAU,GAAG,UAAU,CAAC;IAE3C,KAAY,YAAY,GAAG,UAAU,GAAG,UAAU,CAAC;CACtD;AAED,MAAM,WAAW,6BAA6B;IAC1C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,4BAA4B,CAAC,CAAC;IAEpE,KAAK,KAAK,EAAE,kBAAkB,GAAG,kBAAkB,CAAC;CACvD"}

package/esm/decoder.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=decoder.js.map

package/esm/decoder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decoder.js","sourceRoot":"","sources":["../src/decoder.ts"],"names":[],"mappings":""}

package/esm/gl.d.ts

@@ -0,0 +1,5 @@
+export declare function createCanvas(): HTMLCanvasElement | OffscreenCanvas;
+export declare function glCreateContext(canvas: HTMLCanvasElement | OffscreenCanvas, attributes?: WebGLContextAttributes): WebGLRenderingContext | WebGL2RenderingContext | null;
+export declare function glLoseContext(context: WebGLRenderingContext): void;
+export declare function glIsSupported(attributes?: WebGLContextAttributes): boolean;
+//# sourceMappingURL=gl.d.ts.map

package/esm/gl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gl.d.ts","sourceRoot":"","sources":["../src/gl.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,wCAQ3B;AAED,wBAAgB,eAAe,CAC3B,MAAM,EAAE,iBAAiB,GAAG,eAAe,EAC3C,UAAU,CAAC,EAAE,sBAAsB,GACpC,qBAAqB,GAAG,sBAAsB,GAAG,IAAI,CA6CvD;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE,qBAAqB,QAM3D;AAED,wBAAgB,aAAa,CAAC,UAAU,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAS1E"}

package/esm/gl.js

@@ -0,0 +1,58 @@
+export function createCanvas() {
+    if (typeof document !== "undefined") {
+        return document.createElement("canvas");
+    }
+    if (typeof OffscreenCanvas !== "undefined") {
+        return new OffscreenCanvas(1, 1);
+    }
+    throw new Error("no canvas input found nor any canvas can be created");
+}
+export function glCreateContext(canvas, attributes) {
+    // `HTMLCanvasElement.getContext` returns `null` for unsupported `contextId`,
+    // but `OffscreenCanvas.getContext` will throw errors,
+    // Support both cases using both `try...catch...` and `if`
+    try {
+        const context = canvas.getContext("webgl2", attributes);
+        if (context) {
+            return context;
+        }
+    }
+    catch {
+        // ignore
+    }
+    try {
+        const context = canvas.getContext("webgl", attributes);
+        if (context) {
+            return context;
+        }
+    }
+    catch {
+        // ignore
+    }
+    // Support very old browsers just in case
+    // `OffscreenCanvas` doesn't support `experimental-webgl`
+    if (canvas instanceof HTMLCanvasElement) {
+        const context = canvas.getContext("experimental-webgl", attributes);
+        if (context) {
+            return context;
+        }
+    }
+    return null;
+}
+export function glLoseContext(context) {
+    try {
+        context.getExtension("WEBGL_lose_context")?.loseContext();
+    }
+    catch {
+        // ignore
+    }
+}
+export function glIsSupported(attributes) {
+    const canvas = createCanvas();
+    const gl = glCreateContext(canvas, attributes);
+    if (gl) {
+        glLoseContext(gl);
+    }
+    return !!gl;
+}
+//# sourceMappingURL=gl.js.map

package/esm/gl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gl.js","sourceRoot":"","sources":["../src/gl.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,YAAY;IACxB,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;QAClC,OAAO,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;IACD,IAAI,OAAO,eAAe,KAAK,WAAW,EAAE,CAAC;QACzC,OAAO,IAAI,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACrC,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,eAAe,CAC3B,MAA2C,EAC3C,UAAmC;IAEnC,6EAA6E;IAC7E,sDAAsD;IACtD,0DAA0D;IAE1D,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAC7B,QAAQ,EACR,UAAU,CACoB,CAAC;QAEnC,IAAI,OAAO,EAAE,CAAC;YACV,OAAO,OAAO,CAAC;QACnB,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACL,SAAS;IACb,CAAC;IAED,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAC7B,OAAO,EACP,UAAU,CACmB,CAAC;QAElC,IAAI,OAAO,EAAE,CAAC;YACV,OAAO,OAAO,CAAC;QACnB,CAAC;IACL,CAAC;IAAC,MAAM,CAAC;QACL,SAAS;IACb,CAAC;IAED,yCAAyC;IACzC,yDAAyD;IACzD,IAAI,MAAM,YAAY,iBAAiB,EAAE,CAAC;QACtC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAC7B,oBAAoB,EACpB,UAAU,CACmB,CAAC;QAElC,IAAI,OAAO,EAAE,CAAC;YACV,OAAO,OAAO,CAAC;QACnB,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,OAA8B;IACxD,IAAI,CAAC;QACD,OAAO,CAAC,YAAY,CAAC,oBAAoB,CAAC,EAAE,WAAW,EAAE,CAAC;IAC9D,CAAC;IAAC,MAAM,CAAC;QACL,SAAS;IACb,CAAC;AACL,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,UAAmC;IAC7D,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;IAE9B,MAAM,EAAE,GAAG,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC/C,IAAI,EAAE,EAAE,CAAC;QACL,aAAa,CAAC,EAAE,CAAC,CAAC;IACtB,CAAC;IAED,OAAO,CAAC,CAAC,EAAE,CAAC;AAChB,CAAC"}

package/esm/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./decoder-counter.js";
+export * from "./decoder.js";
+export * from "./gl.js";
+export * from "./pause-controller.js";
+export * from "./renderer-counter.js";
+//# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC"}

package/esm/index.js

@@ -0,0 +1,6 @@
+export * from "./decoder-counter.js";
+export * from "./decoder.js";
+export * from "./gl.js";
+export * from "./pause-controller.js";
+export * from "./renderer-counter.js";
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC"}

package/esm/pause-controller.d.ts

@@ -0,0 +1,42 @@
+import type { MaybePromiseLike } from "@yume-chan/async";
+import type { ScrcpyMediaStreamConfigurationPacket, ScrcpyMediaStreamDataPacket, ScrcpyMediaStreamPacket } from "@yume-chan/scrcpy";
+import { TransformStream } from "@yume-chan/stream-extra";
+export interface ScrcpyVideoDecoderPauseControllerInterface {
+    readonly paused: boolean;
+    /**
+     * Pause the decoder.
+     *
+     * It has a higher priority than {@link trackDocumentVisibility}.
+     * After calling `pause`, the decoder can only be resumed by calling {@link resume}.
+     */
+    pause(): void;
+    /**
+     * Resume the decoder if it was paused.
+     */
+    resume(): MaybePromiseLike<undefined>;
+    /**
+     * Pause the decoder when the document becomes invisible,
+     * and resume when the document becomes visible,
+     * to save system resources and battery.
+     *
+     * @param document A document to track
+     * @returns A function to stop tracking, and resume the decoder (if it was not explicitly paused)
+     */
+    trackDocumentVisibility(document: Document): () => undefined;
+}
+export declare class ScrcpyVideoDecoderPauseController extends TransformStream<ScrcpyVideoDecoderPauseController.Input, ScrcpyVideoDecoderPauseController.Output> implements ScrcpyVideoDecoderPauseControllerInterface {
+    #private;
+    get paused(): boolean;
+    constructor();
+    pause(): void;
+    resume(): undefined;
+    trackDocumentVisibility(document: Document): () => undefined;
+    dispose(): void;
+}
+export declare namespace ScrcpyVideoDecoderPauseController {
+    type Input = ScrcpyMediaStreamPacket;
+    type Output = ScrcpyMediaStreamConfigurationPacket | (ScrcpyMediaStreamDataPacket & {
+        skipRendering: boolean;
+    });
+}
+//# sourceMappingURL=pause-controller.d.ts.map

package/esm/pause-controller.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pause-controller.d.ts","sourceRoot":"","sources":["../src/pause-controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,OAAO,KAAK,EACR,oCAAoC,EACpC,2BAA2B,EAC3B,uBAAuB,EAC1B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,WAAW,0CAA0C;IACvD,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB;;;;;OAKG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;OAEG;IACH,MAAM,IAAI,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAEtC;;;;;;;OAOG;IACH,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,SAAS,CAAC;CAChE;AAED,qBAAa,iCACT,SAAQ,eAAe,CACnB,iCAAiC,CAAC,KAAK,EACvC,iCAAiC,CAAC,MAAM,CAE5C,YAAW,0CAA0C;;IAMrD,IAAI,MAAM,YAET;;IA6FD,KAAK,IAAI,IAAI;IAiDb,MAAM,IAAI,SAAS;IAMnB,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,SAAS;IAsC5D,OAAO;CAaV;AAED,yBAAiB,iCAAiC,CAAC;IAC/C,KAAY,KAAK,GAAG,uBAAuB,CAAC;IAC5C,KAAY,MAAM,GACZ,oCAAoC,GACpC,CAAC,2BAA2B,GAAG;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CACpE"}

package/esm/pause-controller.js

@@ -0,0 +1,172 @@
+import { PromiseResolver } from "@yume-chan/async";
+import { TransformStream } from "@yume-chan/stream-extra";
+export class ScrcpyVideoDecoderPauseController extends TransformStream {
+    #controller;
+    #paused = false;
+    #pausedExplicitly = false;
+    get paused() {
+        return this.#paused;
+    }
+    /**
+     * Store incoming configuration change when paused,
+     * to recreate the decoder on resume
+     */
+    #pendingConfiguration;
+    /**
+     * Store incoming frames when paused, so the latest frame can be rendered on resume
+     * Because non-key frames require their previous frames to be decoded,
+     * we need to store several frames.
+     *
+     * There can be two situations:
+     *
+     *   1. **All pending frames are non-key frames:**
+     *      the decoder still holds the previous frames to decode them directly.
+     *
+     *   2. **A keyframe is encountered while pausing:**
+     *      The list is cleared before pushing the keyframe.
+     *      The decoder can start decoding from the keyframe directly.
+     */
+    #pendingFrames = [];
+    /** Block incoming frames while resuming */
+    #resuming;
+    #disposed = false;
+    constructor() {
+        let controller;
+        super({
+            start: (controller_) => {
+                controller = controller_;
+            },
+            transform: async (packet) => {
+                if (this.#disposed) {
+                    return;
+                }
+                if (this.#paused) {
+                    switch (packet.type) {
+                        case "configuration":
+                            this.#pendingConfiguration = packet;
+                            this.#pendingFrames.length = 0;
+                            break;
+                        case "data":
+                            if (packet.keyframe) {
+                                this.#pendingFrames.length = 0;
+                            }
+                            // Generally there won't be too many non-key frames
+                            // (because that's bad for video quality),
+                            // Also all frames are required for proper decoding
+                            this.#pendingFrames.push(packet);
+                            break;
+                    }
+                    return;
+                }
+                await this.#resuming;
+                if (this.#disposed) {
+                    return;
+                }
+                switch (packet.type) {
+                    case "configuration":
+                        controller.enqueue(packet);
+                        break;
+                    case "data":
+                        controller.enqueue({
+                            ...packet,
+                            skipRendering: false,
+                        });
+                        break;
+                }
+            },
+        });
+        this.#controller = controller;
+    }
+    #pauseInternal(explicitly) {
+        if (this.#disposed) {
+            throw new Error("Attempt to pause a closed decoder");
+        }
+        this.#paused = true;
+        if (explicitly) {
+            this.#pausedExplicitly = true;
+        }
+    }
+    pause() {
+        this.#pauseInternal(true);
+    }
+    #resumeInternal(explicitly) {
+        if (this.#disposed) {
+            throw new Error("Attempt to resume a closed decoder");
+        }
+        if (!this.#paused) {
+            return;
+        }
+        // Visibility tracker (explicitly = false) can't resume
+        // a decoder paused by user (#pausedExplicitly = true)
+        if (this.#pausedExplicitly && !explicitly) {
+            return;
+        }
+        const resolver = new PromiseResolver();
+        this.#resuming = resolver.promise;
+        this.#paused = false;
+        this.#pausedExplicitly = false;
+        if (this.#pendingConfiguration) {
+            this.#controller.enqueue(this.#pendingConfiguration);
+            this.#pendingConfiguration = undefined;
+        }
+        // `#pendingFrames` won't change during iteration
+        // because it can only change when `#paused` is `true`,
+        // but the code above already sets that to `false`
+        for (const [index, frame] of this.#pendingFrames.entries()) {
+            // All pending frames except the last one don't need to be rendered
+            // because they are decoded in quick succession by the decoder
+            // and won't be visible
+            this.#controller.enqueue({
+                ...frame,
+                skipRendering: index !== this.#pendingFrames.length - 1,
+            });
+        }
+        this.#pendingFrames.length = 0;
+        resolver.resolve(undefined);
+        this.#resuming = undefined;
+    }
+    resume() {
+        this.#resumeInternal(true);
+    }
+    #disposeVisibilityTracker;
+    trackDocumentVisibility(document) {
+        // Can only track one document
+        this.#disposeVisibilityTracker?.();
+        const handleVisibilityChange = () => {
+            if (document.visibilityState === "hidden") {
+                this.#pauseInternal(false);
+            }
+            else {
+                void this.#resumeInternal(false);
+            }
+        };
+        handleVisibilityChange();
+        document.addEventListener("visibilitychange", handleVisibilityChange);
+        let disposed = false;
+        this.#disposeVisibilityTracker = () => {
+            // Make sure the visibility tracker is only disposed once
+            // Do not resume if it's paused by another visibility tracker
+            if (disposed) {
+                return;
+            }
+            disposed = true;
+            document.removeEventListener("visibilitychange", handleVisibilityChange);
+            // Do not resume if decoder is already disposed
+            if (!this.#disposed) {
+                void this.#resumeInternal(false);
+            }
+        };
+        return this.#disposeVisibilityTracker;
+    }
+    dispose() {
+        if (this.#disposed) {
+            return;
+        }
+        this.#disposed = true;
+        this.#controller.terminate();
+        this.#pendingConfiguration = undefined;
+        this.#pendingFrames.length = 0;
+        this.#disposeVisibilityTracker?.();
+    }
+}
+//# sourceMappingURL=pause-controller.js.map

package/esm/pause-controller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pause-controller.js","sourceRoot":"","sources":["../src/pause-controller.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAOnD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AA6B1D,MAAM,OAAO,iCACT,SAAQ,eAGP;IAGD,WAAW,CAA6E;IAExF,OAAO,GAAG,KAAK,CAAC;IAChB,iBAAiB,GAAG,KAAK,CAAC;IAC1B,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,qBAAqB,CAAmD;IACxE;;;;;;;;;;;;;OAaG;IACH,cAAc,GAAkC,EAAE,CAAC;IAEnD,2CAA2C;IAC3C,SAAS,CAAiC;IAE1C,SAAS,GAAG,KAAK,CAAC;IAElB;QACI,IAAI,UAAuF,CAAC;QAE5F,KAAK,CAAC;YACF,KAAK,EAAE,CAAC,WAAW,EAAE,EAAE;gBACnB,UAAU,GAAG,WAAW,CAAC;YAC7B,CAAC;YACD,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;gBACxB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;oBACjB,OAAO;gBACX,CAAC;gBAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;oBACf,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;wBAClB,KAAK,eAAe;4BAChB,IAAI,CAAC,qBAAqB,GAAG,MAAM,CAAC;4BACpC,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;4BAC/B,MAAM;wBACV,KAAK,MAAM;4BACP,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gCAClB,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;4BACnC,CAAC;4BACD,mDAAmD;4BACnD,0CAA0C;4BAC1C,mDAAmD;4BACnD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;4BACjC,MAAM;oBACd,CAAC;oBACD,OAAO;gBACX,CAAC;gBAED,MAAM,IAAI,CAAC,SAAS,CAAC;gBAErB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;oBACjB,OAAO;gBACX,CAAC;gBAED,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;oBAClB,KAAK,eAAe;wBAChB,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;wBAC3B,MAAM;oBACV,KAAK,MAAM;wBACP,UAAU,CAAC,OAAO,CAAC;4BACf,GAAG,MAAM;4BACT,aAAa,EAAE,KAAK;yBACvB,CAAC,CAAC;wBACH,MAAM;gBACd,CAAC;YACL,CAAC;SACJ,CAAC,CAAC;QAEH,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAClC,CAAC;IAED,cAAc,CAAC,UAAmB;QAC9B,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,UAAU,EAAE,CAAC;YACb,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAClC,CAAC;IACL,CAAC;IAED,KAAK;QACD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,eAAe,CAAC,UAAmB;QAC/B,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAChB,OAAO;QACX,CAAC;QAED,uDAAuD;QACvD,sDAAsD;QACtD,IAAI,IAAI,CAAC,iBAAiB,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,OAAO;QACX,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,eAAe,EAAa,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC;QAElC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;QAE/B,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC7B,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACrD,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;QAC3C,CAAC;QAED,iDAAiD;QACjD,uDAAuD;QACvD,kDAAkD;QAClD,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC;YACzD,mEAAmE;YACnE,8DAA8D;YAC9D,uBAAuB;YACvB,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC;gBACrB,GAAG,KAAK;gBACR,aAAa,EAAE,KAAK,KAAK,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC;aAC1D,CAAC,CAAC;QACP,CAAC;QAED,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;QAE/B,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAED,MAAM;QACF,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,yBAAyB,CAAgC;IAEzD,uBAAuB,CAAC,QAAkB;QACtC,8BAA8B;QAC9B,IAAI,CAAC,yBAAyB,EAAE,EAAE,CAAC;QAEnC,MAAM,sBAAsB,GAAG,GAAG,EAAE;YAChC,IAAI,QAAQ,CAAC,eAAe,KAAK,QAAQ,EAAE,CAAC;gBACxC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC/B,CAAC;iBAAM,CAAC;gBACJ,KAAK,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YACrC,CAAC;QACL,CAAC,CAAC;QAEF,sBAAsB,EAAE,CAAC;QACzB,QAAQ,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,sBAAsB,CAAC,CAAC;QAEtE,IAAI,QAAQ,GAAG,KAAK,CAAC;QAErB,IAAI,CAAC,yBAAyB,GAAG,GAAG,EAAE;YAClC,yDAAyD;YACzD,6DAA6D;YAC7D,IAAI,QAAQ,EAAE,CAAC;gBACX,OAAO;YACX,CAAC;YACD,QAAQ,GAAG,IAAI,CAAC;YAEhB,QAAQ,CAAC,mBAAmB,CACxB,kBAAkB,EAClB,sBAAsB,CACzB,CAAC;YAEF,+CAA+C;YAC/C,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;gBAClB,KAAK,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YACrC,CAAC;QACL,CAAC,CAAC;QACF,OAAO,IAAI,CAAC,yBAAyB,CAAC;IAC1C,CAAC;IAED,OAAO;QACH,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,OAAO;QACX,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;QAE7B,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;QACvC,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;QAE/B,IAAI,CAAC,yBAAyB,EAAE,EAAE,CAAC;IACvC,CAAC;CACJ"}

package/esm/renderer-counter.d.ts

@@ -0,0 +1,51 @@
+export interface ScrcpyVideoRendererPerformanceCounterInterface {
+    /**
+     * Gets the number of frames that have been drawn on the renderer.
+     */
+    readonly framesRendered: number;
+    /**
+     * Gets the number of frames that's visible to the user.
+     *
+     * Multiple frames might be rendered during one vertical sync interval,
+     * but only the last of them is represented to the user.
+     * This costs some performance but reduces latency by 1 frame.
+     *
+     * Might be `0` if the renderer is in a nested Web Worker on Chrome due to a Chrome bug.
+     * https://issues.chromium.org/issues/41483010
+     */
+    readonly framesDisplayed: number;
+    /**
+     * Gets the number of frames that wasn't drawn on the renderer
+     * because the renderer can't keep up
+     */
+    readonly framesSkippedRendering: number;
+}
+export declare class ScrcpyVideoRendererPerformanceCounter implements ScrcpyVideoRendererPerformanceCounterInterface {
+    #private;
+    /**
+     * Gets the number of frames that have been drawn on the renderer.
+     */
+    get framesRendered(): number;
+    /**
+     * Gets the number of frames that's visible to the user.
+     *
+     * Multiple frames might be rendered during one vertical sync interval,
+     * but only the last of them is represented to the user.
+     * This costs some performance but reduces latency by 1 frame.
+     *
+     * Might be `0` if the renderer is in a nested Web Worker on Chrome due to a Chrome bug.
+     * https://issues.chromium.org/issues/41483010
+     */
+    get framesDisplayed(): number;
+    /**
+     * Gets the number of frames that wasn't drawn on the renderer
+     * because the renderer can't keep up
+     */
+    get framesSkippedRendering(): number;
+    constructor();
+    increaseFramesRendered(): void;
+    increaseFramesSkippedRendering(): void;
+    addFramesSkippedRendering(count: number): void;
+    dispose(): void;
+}
+//# sourceMappingURL=renderer-counter.d.ts.map

package/esm/renderer-counter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer-counter.d.ts","sourceRoot":"","sources":["../src/renderer-counter.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,8CAA8C;IAC3D;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC;;;;;;;;;OASG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;CAC3C;AAED,qBAAa,qCAAsC,YAAW,8CAA8C;;IAExG;;OAEG;IACH,IAAI,cAAc,WAEjB;IAQD;;;;;;;;;OASG;IACH,IAAI,eAAe,WAElB;IAGD;;;OAGG;IACH,IAAI,sBAAsB,WAEzB;;IAiCD,sBAAsB;IAKtB,8BAA8B;IAI9B,yBAAyB,CAAC,KAAK,EAAE,MAAM;IAIvC,OAAO;CAMV"}

package/esm/renderer-counter.js

@@ -0,0 +1,76 @@
+export class ScrcpyVideoRendererPerformanceCounter {
+    #framesRendered = 0;
+    /**
+     * Gets the number of frames that have been drawn on the renderer.
+     */
+    get framesRendered() {
+        return this.#framesRendered;
+    }
+    /**
+     * `true` if the next vertical sync will display a different frame
+     */
+    #hasNewFrame = false;
+    #framesDisplayed = 0;
+    /**
+     * Gets the number of frames that's visible to the user.
+     *
+     * Multiple frames might be rendered during one vertical sync interval,
+     * but only the last of them is represented to the user.
+     * This costs some performance but reduces latency by 1 frame.
+     *
+     * Might be `0` if the renderer is in a nested Web Worker on Chrome due to a Chrome bug.
+     * https://issues.chromium.org/issues/41483010
+     */
+    get framesDisplayed() {
+        return this.#framesDisplayed;
+    }
+    #framesSkippedRendering = 0;
+    /**
+     * Gets the number of frames that wasn't drawn on the renderer
+     * because the renderer can't keep up
+     */
+    get framesSkippedRendering() {
+        return this.#framesSkippedRendering;
+    }
+    #animationFrameId;
+    constructor() {
+        // `requestAnimationFrame` is available in Web Worker
+        // https://developer.mozilla.org/en-US/docs/Web/API/DedicatedWorkerGlobalScope/requestAnimationFrame
+        try {
+            this.#animationFrameId = requestAnimationFrame(this.#handleAnimationFrame);
+        }
+        catch {
+            // Chrome has a bug that `requestAnimationFrame` doesn't work in nested Workers
+            // https://issues.chromium.org/issues/41483010
+            // Because we need actual vertical sync to count presented frames,
+            // `setTimeout` with a fixed delay also doesn't work.
+            // In this case just leave `framesDisplayed` at `0`
+        }
+    }
+    #handleAnimationFrame = () => {
+        // Animation frame handler is called on every vertical sync interval.
+        // Only then a frame is visible to the user.
+        if (this.#hasNewFrame) {
+            this.#framesDisplayed += 1;
+            this.#hasNewFrame = false;
+        }
+        this.#animationFrameId = requestAnimationFrame(this.#handleAnimationFrame);
+    };
+    increaseFramesRendered() {
+        this.#framesRendered += 1;
+        this.#hasNewFrame = true;
+    }
+    increaseFramesSkippedRendering() {
+        this.#framesSkippedRendering += 1;
+    }
+    addFramesSkippedRendering(count) {
+        this.#framesSkippedRendering += count;
+    }
+    dispose() {
+        // `0` is a valid value for RAF ID
+        if (this.#animationFrameId !== undefined) {
+            cancelAnimationFrame(this.#animationFrameId);
+        }
+    }
+}
+//# sourceMappingURL=renderer-counter.js.map

package/esm/renderer-counter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer-counter.js","sourceRoot":"","sources":["../src/renderer-counter.ts"],"names":[],"mappings":"AAuBA,MAAM,OAAO,qCAAqC;IAC9C,eAAe,GAAG,CAAC,CAAC;IACpB;;OAEG;IACH,IAAI,cAAc;QACd,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,YAAY,GAAG,KAAK,CAAC;IAErB,gBAAgB,GAAG,CAAC,CAAC;IACrB;;;;;;;;;OASG;IACH,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,gBAAgB,CAAC;IACjC,CAAC;IAED,uBAAuB,GAAG,CAAC,CAAC;IAC5B;;;OAGG;IACH,IAAI,sBAAsB;QACtB,OAAO,IAAI,CAAC,uBAAuB,CAAC;IACxC,CAAC;IAED,iBAAiB,CAAqB;IAEtC;QACI,qDAAqD;QACrD,oGAAoG;QACpG,IAAI,CAAC;YACD,IAAI,CAAC,iBAAiB,GAAG,qBAAqB,CAC1C,IAAI,CAAC,qBAAqB,CAC7B,CAAC;QACN,CAAC;QAAC,MAAM,CAAC;YACL,+EAA+E;YAC/E,8CAA8C;YAC9C,kEAAkE;YAClE,qDAAqD;YACrD,mDAAmD;QACvD,CAAC;IACL,CAAC;IAED,qBAAqB,GAAG,GAAG,EAAE;QACzB,qEAAqE;QACrE,4CAA4C;QAC5C,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,IAAI,CAAC,gBAAgB,IAAI,CAAC,CAAC;YAC3B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,iBAAiB,GAAG,qBAAqB,CAC1C,IAAI,CAAC,qBAAqB,CAC7B,CAAC;IACN,CAAC,CAAC;IAEF,sBAAsB;QAClB,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC7B,CAAC;IAED,8BAA8B;QAC1B,IAAI,CAAC,uBAAuB,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,yBAAyB,CAAC,KAAa;QACnC,IAAI,CAAC,uBAAuB,IAAI,KAAK,CAAC;IAC1C,CAAC;IAED,OAAO;QACH,kCAAkC;QAClC,IAAI,IAAI,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YACvC,oBAAoB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QACjD,CAAC;IACL,CAAC;CACJ"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@yume-chan/scrcpy-decoder-shared",
+  "version": "3.0.0-beta.0",
+  "description": "Shared types and utilities for Scrcpy video decoders.",
+  "keywords": [
+    "adb",
+    "android-phone",
+    "scrcpy",
+    "scrcpy-decoder"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "Simon Chan",
+    "email": "cnsimonchan@live.com",
+    "url": "https://chensi.moe/blog"
+  },
+  "homepage": "https://github.com/yume-chan/ya-webadb/tree/main/libraries/scrcpy-decoder-shared#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yume-chan/ya-webadb.git",
+    "directory": "libraries/scrcpy-decoder-shared"
+  },
+  "bugs": {
+    "url": "https://github.com/yume-chan/ya-webadb/issues"
+  },
+  "type": "module",
+  "main": "esm/index.js",
+  "types": "esm/index.d.ts",
+  "sideEffects": false,
+  "dependencies": {
+    "@yume-chan/async": "^4.1.3",
+    "@yume-chan/event": "3.0.0-beta.0",
+    "@yume-chan/scrcpy": "3.0.0-beta.0",
+    "@yume-chan/stream-extra": "3.0.0-beta.0"
+  },
+  "devDependencies": {
+    "prettier": "^3.8.4",
+    "typescript": "^6.0.3",
+    "@yume-chan/eslint-config": "^1.0.0",
+    "@yume-chan/tsconfig": "^1.0.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "run-eslint && prettier src/**/*.ts --write --tab-width 4"
+  }
+}

package/src/decoder-counter.ts

@@ -0,0 +1,56 @@
+export interface ScrcpyVideoDecoderPerformanceCounterInterface {
+    /**
+     * Gets the number of times the decoder has been reset to catch up new keyframes.
+     */
+    readonly decoderResetCount: number;
+    /**
+     * Gets the number of frames decoded by the decoder.
+     */
+    readonly framesDecoded: number;
+    /**
+     * Gets the number of frames skipped by the decoder.
+     */
+    readonly framesSkippedDecoding: number;
+}
+
+export class ScrcpyVideoDecoderPerformanceCounter implements ScrcpyVideoDecoderPerformanceCounterInterface {
+    #decoderResetCount = 0;
+    /**
+     * Gets the number of times the decoder has been reset to catch up new keyframes.
+     */
+    get decoderResetCount() {
+        return this.#decoderResetCount;
+    }
+
+    #framesDecoded = 0;
+    /**
+     * Gets the number of frames decoded by the decoder.
+     */
+    get framesDecoded() {
+        return this.#framesDecoded;
+    }
+
+    #framesSkippedDecoding = 0;
+    /**
+     * Gets the number of frames skipped by the decoder.
+     */
+    get framesSkippedDecoding() {
+        return this.#framesSkippedDecoding;
+    }
+
+    increaseResetCount() {
+        this.#decoderResetCount += 1;
+    }
+
+    increaseFramesDecoded() {
+        this.#framesDecoded += 1;
+    }
+
+    addFramesDecoded(count: number) {
+        this.#framesDecoded += count;
+    }
+
+    addFramesSkippedDecoding(count: number) {
+        this.#framesSkippedDecoding += count;
+    }
+}

package/src/decoder.ts

@@ -0,0 +1,48 @@
+import type { MaybePromiseLike } from "@yume-chan/async";
+import type { Event } from "@yume-chan/event";
+import type {
+    ScrcpyMediaStreamPacket,
+    ScrcpyVideoCodecId,
+    ScrcpyVideoSize,
+} from "@yume-chan/scrcpy";
+import type { WritableStream } from "@yume-chan/stream-extra";
+
+import type { ScrcpyVideoDecoderPerformanceCounterInterface } from "./decoder-counter.js";
+import type { ScrcpyVideoDecoderPauseControllerInterface } from "./pause-controller.js";
+import type { ScrcpyVideoRendererPerformanceCounterInterface } from "./renderer-counter.js";
+
+export interface ScrcpyVideoDecoderCapability {
+    maxProfile?: number;
+    maxLevel?: number;
+}
+
+export interface ScrcpyVideoDecoder
+    extends
+        ScrcpyVideoDecoderPerformanceCounterInterface,
+        ScrcpyVideoRendererPerformanceCounterInterface,
+        ScrcpyVideoDecoderPauseControllerInterface,
+        ScrcpyVideoSize {
+    readonly type: ScrcpyVideoDecoder.Type;
+    readonly onTypeChange?: Event<ScrcpyVideoDecoder.Type> | undefined;
+
+    readonly rendererType: ScrcpyVideoDecoder.RendererType;
+    readonly onRendererTypeChange?:
+        | Event<ScrcpyVideoDecoder.RendererType>
+        | undefined;
+
+    readonly writable: WritableStream<ScrcpyMediaStreamPacket>;
+
+    dispose?(): MaybePromiseLike<undefined>;
+}
+
+export namespace ScrcpyVideoDecoder {
+    export type Type = "software" | "hardware";
+
+    export type RendererType = "software" | "hardware";
+}
+
+export interface ScrcpyVideoDecoderConstructor {
+    readonly capabilities: Record<string, ScrcpyVideoDecoderCapability>;
+
+    new (codec: ScrcpyVideoCodecId): ScrcpyVideoDecoder;
+}

package/src/gl.ts

@@ -0,0 +1,78 @@
+export function createCanvas() {
+    if (typeof document !== "undefined") {
+        return document.createElement("canvas");
+    }
+    if (typeof OffscreenCanvas !== "undefined") {
+        return new OffscreenCanvas(1, 1);
+    }
+    throw new Error("no canvas input found nor any canvas can be created");
+}
+
+export function glCreateContext(
+    canvas: HTMLCanvasElement | OffscreenCanvas,
+    attributes?: WebGLContextAttributes,
+): WebGLRenderingContext | WebGL2RenderingContext | null {
+    // `HTMLCanvasElement.getContext` returns `null` for unsupported `contextId`,
+    // but `OffscreenCanvas.getContext` will throw errors,
+    // Support both cases using both `try...catch...` and `if`
+
+    try {
+        const context = canvas.getContext(
+            "webgl2",
+            attributes,
+        ) as WebGL2RenderingContext | null;
+
+        if (context) {
+            return context;
+        }
+    } catch {
+        // ignore
+    }
+
+    try {
+        const context = canvas.getContext(
+            "webgl",
+            attributes,
+        ) as WebGLRenderingContext | null;
+
+        if (context) {
+            return context;
+        }
+    } catch {
+        // ignore
+    }
+
+    // Support very old browsers just in case
+    // `OffscreenCanvas` doesn't support `experimental-webgl`
+    if (canvas instanceof HTMLCanvasElement) {
+        const context = canvas.getContext(
+            "experimental-webgl",
+            attributes,
+        ) as WebGLRenderingContext | null;
+
+        if (context) {
+            return context;
+        }
+    }
+
+    return null;
+}
+
+export function glLoseContext(context: WebGLRenderingContext) {
+    try {
+        context.getExtension("WEBGL_lose_context")?.loseContext();
+    } catch {
+        // ignore
+    }
+}
+
+export function glIsSupported(attributes?: WebGLContextAttributes): boolean {
+    const canvas = createCanvas();
+
+    const gl = glCreateContext(canvas, attributes);
+    if (gl) {
+        glLoseContext(gl);
+    }
+
+    return !!gl;
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from "./decoder-counter.js";
+export * from "./decoder.js";
+export * from "./gl.js";
+export * from "./pause-controller.js";
+export * from "./renderer-counter.js";

package/src/pause-controller.ts

@@ -0,0 +1,257 @@
+import type { MaybePromiseLike } from "@yume-chan/async";
+import { PromiseResolver } from "@yume-chan/async";
+import type {
+    ScrcpyMediaStreamConfigurationPacket,
+    ScrcpyMediaStreamDataPacket,
+    ScrcpyMediaStreamPacket,
+} from "@yume-chan/scrcpy";
+import type { TransformStreamDefaultController } from "@yume-chan/stream-extra";
+import { TransformStream } from "@yume-chan/stream-extra";
+
+export interface ScrcpyVideoDecoderPauseControllerInterface {
+    readonly paused: boolean;
+
+    /**
+     * Pause the decoder.
+     *
+     * It has a higher priority than {@link trackDocumentVisibility}.
+     * After calling `pause`, the decoder can only be resumed by calling {@link resume}.
+     */
+    pause(): void;
+
+    /**
+     * Resume the decoder if it was paused.
+     */
+    resume(): MaybePromiseLike<undefined>;
+
+    /**
+     * Pause the decoder when the document becomes invisible,
+     * and resume when the document becomes visible,
+     * to save system resources and battery.
+     *
+     * @param document A document to track
+     * @returns A function to stop tracking, and resume the decoder (if it was not explicitly paused)
+     */
+    trackDocumentVisibility(document: Document): () => undefined;
+}
+
+export class ScrcpyVideoDecoderPauseController
+    extends TransformStream<
+        ScrcpyVideoDecoderPauseController.Input,
+        ScrcpyVideoDecoderPauseController.Output
+    >
+    implements ScrcpyVideoDecoderPauseControllerInterface
+{
+    #controller: TransformStreamDefaultController<ScrcpyVideoDecoderPauseController.Output>;
+
+    #paused = false;
+    #pausedExplicitly = false;
+    get paused() {
+        return this.#paused;
+    }
+
+    /**
+     * Store incoming configuration change when paused,
+     * to recreate the decoder on resume
+     */
+    #pendingConfiguration: ScrcpyMediaStreamConfigurationPacket | undefined;
+    /**
+     * Store incoming frames when paused, so the latest frame can be rendered on resume
+     * Because non-key frames require their previous frames to be decoded,
+     * we need to store several frames.
+     *
+     * There can be two situations:
+     *
+     *   1. **All pending frames are non-key frames:**
+     *      the decoder still holds the previous frames to decode them directly.
+     *
+     *   2. **A keyframe is encountered while pausing:**
+     *      The list is cleared before pushing the keyframe.
+     *      The decoder can start decoding from the keyframe directly.
+     */
+    #pendingFrames: ScrcpyMediaStreamDataPacket[] = [];
+
+    /** Block incoming frames while resuming */
+    #resuming: Promise<undefined> | undefined;
+
+    #disposed = false;
+
+    constructor() {
+        let controller!: TransformStreamDefaultController<ScrcpyVideoDecoderPauseController.Output>;
+
+        super({
+            start: (controller_) => {
+                controller = controller_;
+            },
+            transform: async (packet) => {
+                if (this.#disposed) {
+                    return;
+                }
+
+                if (this.#paused) {
+                    switch (packet.type) {
+                        case "configuration":
+                            this.#pendingConfiguration = packet;
+                            this.#pendingFrames.length = 0;
+                            break;
+                        case "data":
+                            if (packet.keyframe) {
+                                this.#pendingFrames.length = 0;
+                            }
+                            // Generally there won't be too many non-key frames
+                            // (because that's bad for video quality),
+                            // Also all frames are required for proper decoding
+                            this.#pendingFrames.push(packet);
+                            break;
+                    }
+                    return;
+                }
+
+                await this.#resuming;
+
+                if (this.#disposed) {
+                    return;
+                }
+
+                switch (packet.type) {
+                    case "configuration":
+                        controller.enqueue(packet);
+                        break;
+                    case "data":
+                        controller.enqueue({
+                            ...packet,
+                            skipRendering: false,
+                        });
+                        break;
+                }
+            },
+        });
+
+        this.#controller = controller;
+    }
+
+    #pauseInternal(explicitly: boolean): void {
+        if (this.#disposed) {
+            throw new Error("Attempt to pause a closed decoder");
+        }
+
+        this.#paused = true;
+        if (explicitly) {
+            this.#pausedExplicitly = true;
+        }
+    }
+
+    pause(): void {
+        this.#pauseInternal(true);
+    }
+
+    #resumeInternal(explicitly: boolean): undefined {
+        if (this.#disposed) {
+            throw new Error("Attempt to resume a closed decoder");
+        }
+
+        if (!this.#paused) {
+            return;
+        }
+
+        // Visibility tracker (explicitly = false) can't resume
+        // a decoder paused by user (#pausedExplicitly = true)
+        if (this.#pausedExplicitly && !explicitly) {
+            return;
+        }
+
+        const resolver = new PromiseResolver<undefined>();
+        this.#resuming = resolver.promise;
+
+        this.#paused = false;
+        this.#pausedExplicitly = false;
+
+        if (this.#pendingConfiguration) {
+            this.#controller.enqueue(this.#pendingConfiguration);
+            this.#pendingConfiguration = undefined;
+        }
+
+        // `#pendingFrames` won't change during iteration
+        // because it can only change when `#paused` is `true`,
+        // but the code above already sets that to `false`
+        for (const [index, frame] of this.#pendingFrames.entries()) {
+            // All pending frames except the last one don't need to be rendered
+            // because they are decoded in quick succession by the decoder
+            // and won't be visible
+            this.#controller.enqueue({
+                ...frame,
+                skipRendering: index !== this.#pendingFrames.length - 1,
+            });
+        }
+
+        this.#pendingFrames.length = 0;
+
+        resolver.resolve(undefined);
+        this.#resuming = undefined;
+    }
+
+    resume(): undefined {
+        this.#resumeInternal(true);
+    }
+
+    #disposeVisibilityTracker: (() => undefined) | undefined;
+
+    trackDocumentVisibility(document: Document): () => undefined {
+        // Can only track one document
+        this.#disposeVisibilityTracker?.();
+
+        const handleVisibilityChange = () => {
+            if (document.visibilityState === "hidden") {
+                this.#pauseInternal(false);
+            } else {
+                void this.#resumeInternal(false);
+            }
+        };
+
+        handleVisibilityChange();
+        document.addEventListener("visibilitychange", handleVisibilityChange);
+
+        let disposed = false;
+
+        this.#disposeVisibilityTracker = () => {
+            // Make sure the visibility tracker is only disposed once
+            // Do not resume if it's paused by another visibility tracker
+            if (disposed) {
+                return;
+            }
+            disposed = true;
+
+            document.removeEventListener(
+                "visibilitychange",
+                handleVisibilityChange,
+            );
+
+            // Do not resume if decoder is already disposed
+            if (!this.#disposed) {
+                void this.#resumeInternal(false);
+            }
+        };
+        return this.#disposeVisibilityTracker;
+    }
+
+    dispose() {
+        if (this.#disposed) {
+            return;
+        }
+
+        this.#disposed = true;
+        this.#controller.terminate();
+
+        this.#pendingConfiguration = undefined;
+        this.#pendingFrames.length = 0;
+
+        this.#disposeVisibilityTracker?.();
+    }
+}
+
+export namespace ScrcpyVideoDecoderPauseController {
+    export type Input = ScrcpyMediaStreamPacket;
+    export type Output =
+        | ScrcpyMediaStreamConfigurationPacket
+        | (ScrcpyMediaStreamDataPacket & { skipRendering: boolean });
+}

package/src/renderer-counter.ts

@@ -0,0 +1,112 @@
+export interface ScrcpyVideoRendererPerformanceCounterInterface {
+    /**
+     * Gets the number of frames that have been drawn on the renderer.
+     */
+    readonly framesRendered: number;
+    /**
+     * Gets the number of frames that's visible to the user.
+     *
+     * Multiple frames might be rendered during one vertical sync interval,
+     * but only the last of them is represented to the user.
+     * This costs some performance but reduces latency by 1 frame.
+     *
+     * Might be `0` if the renderer is in a nested Web Worker on Chrome due to a Chrome bug.
+     * https://issues.chromium.org/issues/41483010
+     */
+    readonly framesDisplayed: number;
+    /**
+     * Gets the number of frames that wasn't drawn on the renderer
+     * because the renderer can't keep up
+     */
+    readonly framesSkippedRendering: number;
+}
+
+export class ScrcpyVideoRendererPerformanceCounter implements ScrcpyVideoRendererPerformanceCounterInterface {
+    #framesRendered = 0;
+    /**
+     * Gets the number of frames that have been drawn on the renderer.
+     */
+    get framesRendered() {
+        return this.#framesRendered;
+    }
+
+    /**
+     * `true` if the next vertical sync will display a different frame
+     */
+    #hasNewFrame = false;
+
+    #framesDisplayed = 0;
+    /**
+     * Gets the number of frames that's visible to the user.
+     *
+     * Multiple frames might be rendered during one vertical sync interval,
+     * but only the last of them is represented to the user.
+     * This costs some performance but reduces latency by 1 frame.
+     *
+     * Might be `0` if the renderer is in a nested Web Worker on Chrome due to a Chrome bug.
+     * https://issues.chromium.org/issues/41483010
+     */
+    get framesDisplayed() {
+        return this.#framesDisplayed;
+    }
+
+    #framesSkippedRendering = 0;
+    /**
+     * Gets the number of frames that wasn't drawn on the renderer
+     * because the renderer can't keep up
+     */
+    get framesSkippedRendering() {
+        return this.#framesSkippedRendering;
+    }
+
+    #animationFrameId: number | undefined;
+
+    constructor() {
+        // `requestAnimationFrame` is available in Web Worker
+        // https://developer.mozilla.org/en-US/docs/Web/API/DedicatedWorkerGlobalScope/requestAnimationFrame
+        try {
+            this.#animationFrameId = requestAnimationFrame(
+                this.#handleAnimationFrame,
+            );
+        } catch {
+            // Chrome has a bug that `requestAnimationFrame` doesn't work in nested Workers
+            // https://issues.chromium.org/issues/41483010
+            // Because we need actual vertical sync to count presented frames,
+            // `setTimeout` with a fixed delay also doesn't work.
+            // In this case just leave `framesDisplayed` at `0`
+        }
+    }
+
+    #handleAnimationFrame = () => {
+        // Animation frame handler is called on every vertical sync interval.
+        // Only then a frame is visible to the user.
+        if (this.#hasNewFrame) {
+            this.#framesDisplayed += 1;
+            this.#hasNewFrame = false;
+        }
+
+        this.#animationFrameId = requestAnimationFrame(
+            this.#handleAnimationFrame,
+        );
+    };
+
+    increaseFramesRendered() {
+        this.#framesRendered += 1;
+        this.#hasNewFrame = true;
+    }
+
+    increaseFramesSkippedRendering() {
+        this.#framesSkippedRendering += 1;
+    }
+
+    addFramesSkippedRendering(count: number) {
+        this.#framesSkippedRendering += count;
+    }
+
+    dispose() {
+        // `0` is a valid value for RAF ID
+        if (this.#animationFrameId !== undefined) {
+            cancelAnimationFrame(this.#animationFrameId);
+        }
+    }
+}

package/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+    "extends": "./node_modules/@yume-chan/tsconfig/tsconfig.base.json",
+    "compilerOptions": {
+        "lib": [
+            "ESNext",
+            "DOM"
+        ]
+    }
+}