@yume-chan/scrcpy 2.3.0 → 3.0.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yume-chan/scrcpy",
-  "version": "2.3.0",
+  "version": "3.0.0-beta.0",
   "description": "TypeScript implementation of Scrcpy client.",
   "keywords": [
     "adb",
@@ -13,11 +13,11 @@
     "email": "cnsimonchan@live.com",
     "url": "https://chensi.moe/blog"
   },
-  "homepage": "https://github.com/yume-chan/ya-webadb/tree/main/packages/scrcpy#readme",
+  "homepage": "https://github.com/yume-chan/ya-webadb/tree/main/libraries/scrcpy#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/yume-chan/ya-webadb.git",
-    "directory": "packages/scrcpy"
+    "directory": "libraries/scrcpy"
   },
   "bugs": {
     "url": "https://github.com/yume-chan/ya-webadb/issues"
@@ -28,20 +28,21 @@
   "sideEffects": false,
   "dependencies": {
     "@yume-chan/async": "^4.1.3",
-    "@yume-chan/struct": "^2.0.1",
-    "@yume-chan/stream-extra": "^2.1.0",
-    "@yume-chan/no-data-view": "^2.0.0"
+    "@yume-chan/event": "3.0.0-beta.0",
+    "@yume-chan/stream-extra": "3.0.0-beta.0",
+    "@yume-chan/struct": "3.0.0-beta.0",
+    "@yume-chan/no-data-view": "3.0.0-beta.0"
   },
   "devDependencies": {
-    "@types/node": "^24.3.1",
-    "prettier": "^3.6.2",
-    "typescript": "^5.9.2",
+    "@types/node": "^26.0.0",
+    "prettier": "^3.8.4",
+    "typescript": "^6.0.3",
     "@yume-chan/eslint-config": "^1.0.0",
     "@yume-chan/test-runner": "^1.0.0",
     "@yume-chan/tsconfig": "^1.0.0"
   },
   "scripts": {
-    "build": "tsc -b tsconfig.build.json",
+    "build": "tsc -p tsconfig.build.json",
     "lint": "run-eslint && prettier src/**/*.ts --write --tab-width 4",
     "test": "run-test"
   }

package/src/1_15/impl/codec-options.ts

@@ -0,0 +1,236 @@
+// cspell: ignore Bframes
+// cspell: ignore macroblocks
+
+import type { ScrcpyOptionValue } from "../../base/option-value.js";
+
+export interface NumberCodecOption {
+    type: "int" | "float";
+    value: number;
+}
+
+export interface BigIntCodecOption {
+    type: "long";
+    value: bigint;
+}
+
+export interface StringCodecOption {
+    type: "string";
+    value: string;
+}
+
+export type CodecOption =
+    | NumberCodecOption
+    | BigIntCodecOption
+    | StringCodecOption;
+
+export class CodecOptions implements ScrcpyOptionValue {
+    static Empty = /* #__PURE__ */ new CodecOptions();
+
+    #values = new Map<string, CodecOption>();
+    get values(): ReadonlyMap<string, CodecOption> {
+        return this.#values;
+    }
+
+    setInt(key: string, value: number): this {
+        this.#values.set(key, { type: "int", value });
+        return this;
+    }
+
+    setFloat(key: string, value: number): this {
+        this.#values.set(key, { type: "float", value });
+        return this;
+    }
+
+    setLong(key: string, value: bigint): this {
+        this.#values.set(key, { type: "long", value });
+        return this;
+    }
+
+    setString(key: string, value: string): this {
+        this.#values.set(key, { type: "string", value });
+        return this;
+    }
+
+    delete(key: string) {
+        return this.#values.delete(key);
+    }
+
+    clear() {
+        this.#values.clear();
+    }
+
+    /**
+     * A key describing the desired codec priority.
+     *
+     * The associated value is an integer. Higher value means lower priority.
+     *
+     * Currently, only two levels are supported:
+     *
+     * - 0: realtime priority - meaning that the codec shall support the given performance
+     *  configuration (e.g. framerate) at realtime. This should only be used by media playback,
+     *  capture, and possibly by realtime communication scenarios if best effort performance
+     *  is not suitable.
+     * - 1: non-realtime priority (best effort).
+     *
+     * This is a hint used at codec configuration and resource planning -
+     * to understand the realtime requirements of the application;
+     * however, due to the nature of media components, performance is not guaranteed.
+     */
+    setPriority(priority: number): this {
+        return this.setInt("priority", priority);
+    }
+
+    toOptionValue(): string | undefined {
+        if (this.#values.size === 0) {
+            return undefined;
+        }
+
+        return Array.from(this.#values.entries(), ([key, value]) => {
+            let result = key;
+
+            if (value.type !== "int") {
+                result += ":" + value.type;
+            }
+
+            result += "=";
+
+            if (value.type === "string") {
+                result += value.value.replaceAll(",", "\\,");
+            } else {
+                result += value.value;
+            }
+
+            return result;
+        }).join(",");
+    }
+}
+
+export class VideoCodecOptions extends CodecOptions {
+    /**
+     * A key for applications to opt out of allowing a Surface to
+     * discard undisplayed/unconsumed frames as means to catch up after falling behind.
+     * This value is an integer.
+     * The value 0 indicates the surface is not allowed to drop frames.
+     * The value 1 indicates the surface is allowed to drop frames.
+     * [`MediaCodec`](https://developer.android.com/reference/android/media/MediaCodec)
+     * describes the semantics.
+     */
+    setAllowFrameDrop(value: boolean): this {
+        return this.setInt("allow-frame-drop", value ? 1 : 0);
+    }
+
+    /**
+     * An optional key describing the period of intra refresh in frames.
+     * This is an optional parameter that applies only to video encoders.
+     * If encoder supports it (MediaCodecInfo.CodecCapabilities.FEATURE_IntraRefresh),
+     * the whole frame is completely refreshed after the specified period.
+     * Also for each frame, a fix subset of macroblocks must be intra coded
+     * which leads to more constant bitrate than inserting a key frame.
+     * This key is recommended for video streaming applications as it provides
+     * low-delay and good error-resilience.
+     * This key is ignored if the video encoder does not support the intra refresh feature.
+     * The associated value is an integer.
+     */
+    setIntraRefreshPeriod(value: number): this {
+        return this.setInt("intra-refresh-period", value);
+    }
+
+    /**
+     * A key describing the frequency of key frames expressed in seconds between key frames.
+     *
+     * This key is used by video encoders.
+     * A negative value means no key frames are requested after the first frame.
+     * A zero value means a stream containing all key frames is requested.
+     *
+     * The associated value is an integer (or float since `Build.VERSION_CODES.N_MR1`).
+     */
+    setIFrameInterval(value: number, type: "int" | "float" = "int"): this {
+        return type === "int"
+            ? this.setInt("i-frame-interval", value)
+            : this.setFloat("i-frame-interval", value);
+    }
+
+    /**
+     *
+     * An optional key describing the desired encoder latency in frames.
+     * This is an optional parameter that applies only to video encoders.
+     * If encoder supports it, it should output at least one output frame
+     * after being queued the specified number of frames.
+     * This key is ignored if the video encoder does not support the latency feature.
+     * Use the output format to verify that this feature was enabled
+     * and the actual value used by the encoder.
+     *
+     * If the key is not specified, the default latency will be implementation specific.
+     * The associated value is an integer.
+     */
+    setLatency(value: number): this {
+        return this.setInt("latency", value);
+    }
+
+    /**
+     * A key describing the desired profile to be used by an encoder.
+     *
+     * The associated value is an integer. Constants are declared in
+     * [`MediaCodecInfo.CodecProfileLevel`](https://developer.android.com/reference/android/media/MediaCodecInfo.CodecProfileLevel).
+     * This key is used as a further hint when specifying a desired profile,
+     * and is only supported for codecs that specify a level.
+     *
+     * This key is ignored if the {@link setProfile | `profile`} is not specified.
+     * Otherwise, the value should be a level compatible with the configured encoding parameters.
+     */
+    setLevel(value: number): this {
+        return this.setInt("level", value);
+    }
+
+    /**
+     * A key describing the maximum number of B frames between I or P frames,
+     * to be used by a video encoder.
+     * The associated value is an integer.
+     * The default value is 0, which means that no B frames are allowed.
+     * Note that non-zero value does not guarantee B frames; it's up to the encoder to decide.
+     */
+    setMaxBFrames(value: number): this {
+        return this.setInt("max-bframes", value);
+    }
+
+    /**
+     * Instruct the video encoder in "surface-input" mode to drop excessive frames from the source,
+     * so that the input frame rate to the encoder does not exceed the specified fps.
+     * The associated value is a float, representing the max frame rate to feed the encoder at.
+     */
+    setMaxFpsToEncoder(value: number): this {
+        return this.setFloat("max-fps-to-encoder", value);
+    }
+
+    /**
+     * A key describing the desired profile to be used by an encoder.
+     *
+     * The associated value is an integer.
+     * Constants are declared in
+     * [MediaCodecInfo.CodecProfileLevel](https://developer.android.com/reference/android/media/MediaCodecInfo.CodecProfileLevel).
+     * This key is used as a hint, and is only supported for codecs that specify a profile.
+     * When configuring profile,
+     * encoder configuration may fail if other parameters are not compatible with
+     * the desired profile or if the desired profile is not supported,
+     * but it may also fail silently
+     * (where the encoder ends up using a different, compatible profile.)
+     *
+     * It is recommended that the profile is set for all encoders.
+     * For more information, see the *Encoder Profiles* section of the
+     * [`MediaCodec`](https://developer.android.com/reference/android/media/MediaCodec)
+     * API reference.
+     */
+    setProfile(value: number): this {
+        return this.setInt("profile", value);
+    }
+
+    /**
+     * Applies only when configuring a video encoder in "surface-input" mode.
+     * The associated value is a long and gives the time in microseconds
+     * after which the frame previously submitted to the encoder will be repeated (once)
+     * if no new frame became available since.
+     */
+    setRepeatPreviousFrameAfter(value: bigint): this {
+        return this.setLong("repeat-previous-frame-after", value);
+    }
+}

package/src/1_15/impl/control-message-types.ts

@@ -1,16 +1,16 @@
+import type { ScrcpyControlMessageTypeMap } from "../../base/index.js";
 import { ScrcpyControlMessageType } from "../../base/index.js";
 
-export const ControlMessageTypes: readonly ScrcpyControlMessageType[] =
-    /* #__PURE__ */ (() => [
-        /*  0 */ ScrcpyControlMessageType.InjectKeyCode,
-        /*  1 */ ScrcpyControlMessageType.InjectText,
-        /*  2 */ ScrcpyControlMessageType.InjectTouch,
-        /*  3 */ ScrcpyControlMessageType.InjectScroll,
-        /*  4 */ ScrcpyControlMessageType.BackOrScreenOn,
-        /*  5 */ ScrcpyControlMessageType.ExpandNotificationPanel,
-        /*  6 */ ScrcpyControlMessageType.CollapseNotificationPanel,
-        /*  7 */ ScrcpyControlMessageType.GetClipboard,
-        /*  8 */ ScrcpyControlMessageType.SetClipboard,
-        /*  9 */ ScrcpyControlMessageType.SetDisplayPower,
-        /* 10 */ ScrcpyControlMessageType.RotateDevice,
-    ])();
+export const ControlMessageTypes = {
+    [ScrcpyControlMessageType.InjectKeyCode]: 0,
+    [ScrcpyControlMessageType.InjectText]: 1,
+    [ScrcpyControlMessageType.InjectTouch]: 2,
+    [ScrcpyControlMessageType.InjectScroll]: 3,
+    [ScrcpyControlMessageType.BackOrScreenOn]: 4,
+    [ScrcpyControlMessageType.ExpandNotificationPanel]: 5,
+    [ScrcpyControlMessageType.CollapseNotificationPanel]: 6,
+    [ScrcpyControlMessageType.GetClipboard]: 7,
+    [ScrcpyControlMessageType.SetClipboard]: 8,
+    [ScrcpyControlMessageType.SetDisplayPower]: 9,
+    [ScrcpyControlMessageType.RotateDevice]: 10,
+} as const satisfies ScrcpyControlMessageTypeMap;

package/src/1_15/impl/index.ts

@@ -1,5 +1,6 @@
 export * from "./back-or-screen-on.js";
 export * from "./clipboard-stream.js";
+export * from "./codec-options.js";
 export * from "./control-message-types.js";
 export * from "./defaults.js";
 export * from "./init.js";

package/src/1_15/impl/init.ts

@@ -1,5 +1,7 @@
 import type { ScrcpyOptionValue } from "../../base/index.js";
 
+import type { CodecOptions } from "./codec-options.js";
+
 export const VideoOrientation = {
     Unlocked: -1,
     Portrait: 0,
@@ -13,82 +15,6 @@ export type VideoOrientation =
 
 export type LogLevel = "debug" | "info" | "warn" | "error";
 
-/**
- * If the option you need is not in this type,
- * please file an issue on GitHub.
- */
-export interface CodecOptionsInit {
-    profile?: number | undefined;
-    level?: number | undefined;
-
-    iFrameInterval?: number | undefined;
-    maxBframes?: number | undefined;
-    repeatPreviousFrameAfter?: number | undefined;
-    maxPtsGapToEncoder?: number | undefined;
-    intraRefreshPeriod?: number | undefined;
-}
-
-function toDashCase(input: string) {
-    return input.replace(/([A-Z])/g, "-$1").toLowerCase();
-}
-
-const CodecOptionTypes: Partial<
-    Record<keyof CodecOptionsInit, "long" | "float" | "string">
-> = {
-    repeatPreviousFrameAfter: "long",
-    maxPtsGapToEncoder: "long",
-};
-
-export class CodecOptions implements ScrcpyOptionValue {
-    static Empty = /* #__PURE__ */ new CodecOptions();
-
-    options: CodecOptionsInit;
-
-    constructor(options: CodecOptionsInit = {}) {
-        for (const [key, value] of Object.entries(options)) {
-            if (value === undefined) {
-                continue;
-            }
-
-            if (typeof value !== "number") {
-                throw new Error(
-                    `Invalid option value for ${key}: ${String(value)}`,
-                );
-            }
-        }
-
-        this.options = options;
-    }
-
-    toOptionValue(): string | undefined {
-        const entries = Object.entries(this.options).filter(
-            ([, value]) => value !== undefined,
-        );
-
-        if (entries.length === 0) {
-            return undefined;
-        }
-
-        return entries
-            .map(([key, value]) => {
-                let result = toDashCase(key);
-
-                const type = CodecOptionTypes[key as keyof CodecOptionsInit];
-                if (type) {
-                    result += `:${type}`;
-                }
-
-                result += `=${value}`;
-                return result;
-            })
-            .join(",");
-    }
-}
-
-export namespace CodecOptions {
-    export type Init = CodecOptionsInit;
-}
-
 export class Crop implements ScrcpyOptionValue {
     width: number;
     height: number;

package/src/1_15/impl/inject-touch.ts

@@ -32,6 +32,7 @@ export const PointerId = {
 
 export const InjectTouchControlMessage = struct(
     {
+        // value of `type` can change between versions
         type: u8,
         action: u8<AndroidMotionEventAction>(),
         pointerId: u64,

package/src/1_15/impl/scroll-controller.ts

@@ -6,6 +6,7 @@ import type { ScrcpyInjectScrollControlMessage } from "../../latest.js";
 
 export const InjectScrollControlMessage = struct(
     {
+        // value of `type` can change between versions
         type: u8,
         pointerX: u32,
         pointerY: u32,

package/src/1_15/impl/set-clipboard.ts

@@ -4,7 +4,11 @@ import { string, struct, u32, u8 } from "@yume-chan/struct";
 import type { ScrcpySetClipboardControlMessage } from "../../latest.js";
 
 export const SetClipboardControlMessage = struct(
-    { type: u8, content: string(u32) },
+    {
+        // value of `type` can change between versions
+        type: u8,
+        content: string(u32),
+    },
     { littleEndian: false },
 );
 

package/src/1_15/options.ts

@@ -2,7 +2,6 @@ import type { MaybePromiseLike } from "@yume-chan/async";
 import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
 
 import type {
-    ScrcpyControlMessageType,
     ScrcpyDisplay,
     ScrcpyMediaStreamPacket,
     ScrcpyOptions,
@@ -38,7 +37,7 @@ export class ScrcpyOptions1_15 implements ScrcpyOptions<Init> {
 
     readonly value: Required<Init>;
 
-    get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
+    get controlMessageTypes(): typeof ControlMessageTypes {
         return ControlMessageTypes;
     }
 

package/src/1_15_1.ts

@@ -1,11 +1 @@
-import { ScrcpyOptions1_15 } from "./1_15/index.js";
-
-export class ScrcpyOptions1_15_1 extends ScrcpyOptions1_15 {
-    constructor(init: ScrcpyOptions1_15.Init) {
-        super(init);
-    }
-}
-
-export namespace ScrcpyOptions1_15_1 {
-    export type Init = ScrcpyOptions1_15.Init;
-}
+export { ScrcpyOptions1_15 as ScrcpyOptions1_15_1 } from "./1_15/index.js";

package/src/1_16.ts

@@ -1,11 +1 @@
-import { ScrcpyOptions1_15 } from "./1_15/index.js";
-
-export class ScrcpyOptions1_16 extends ScrcpyOptions1_15 {
-    constructor(init: ScrcpyOptions1_15.Init) {
-        super(init);
-    }
-}
-
-export namespace ScrcpyOptions1_16 {
-    export type Init = ScrcpyOptions1_15.Init;
-}
+export { ScrcpyOptions1_15 as ScrcpyOptions1_16 } from "./1_15/index.js";

package/src/1_17/impl/defaults.ts

@@ -1,8 +1,7 @@
 import type { Init } from "./init.js";
 import { PrevImpl } from "./prev.js";
 
-export const Defaults = /* #__PURE__ */ (() =>
-    ({
-        ...PrevImpl.Defaults,
-        encoderName: undefined,
-    }) as const satisfies Required<Init>)();
+export const Defaults = {
+    ...PrevImpl.Defaults,
+    encoderName: undefined,
+} as const satisfies Required<Init>;

package/src/1_17/options.ts

@@ -2,7 +2,6 @@ import type { MaybePromiseLike } from "@yume-chan/async";
 import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
 
 import type {
-    ScrcpyControlMessageType,
     ScrcpyDisplay,
     ScrcpyEncoder,
     ScrcpyMediaStreamPacket,
@@ -45,7 +44,7 @@ export class ScrcpyOptions1_17
 
     readonly value: Required<Init>;
 
-    get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
+    get controlMessageTypes(): typeof ControlMessageTypes {
         return ControlMessageTypes;
     }
 

package/src/1_18/impl/control-message-types.ts

@@ -1,10 +1,17 @@
+import type { ScrcpyControlMessageTypeMap } from "../../base/index.js";
 import { ScrcpyControlMessageType } from "../../base/index.js";
 
-import { PrevImpl } from "./prev.js";
-
-export const ControlMessageTypes: readonly ScrcpyControlMessageType[] =
-    /* #__PURE__ */ (() => {
-        const result = PrevImpl.ControlMessageTypes.slice();
-        result.splice(6, 0, ScrcpyControlMessageType.ExpandSettingPanel);
-        return result;
-    })();
+export const ControlMessageTypes = {
+    [ScrcpyControlMessageType.InjectKeyCode]: 0,
+    [ScrcpyControlMessageType.InjectText]: 1,
+    [ScrcpyControlMessageType.InjectTouch]: 2,
+    [ScrcpyControlMessageType.InjectScroll]: 3,
+    [ScrcpyControlMessageType.BackOrScreenOn]: 4,
+    [ScrcpyControlMessageType.ExpandNotificationPanel]: 5,
+    [ScrcpyControlMessageType.ExpandSettingPanel]: 6,
+    [ScrcpyControlMessageType.CollapseNotificationPanel]: 7,
+    [ScrcpyControlMessageType.GetClipboard]: 8,
+    [ScrcpyControlMessageType.SetClipboard]: 9,
+    [ScrcpyControlMessageType.SetDisplayPower]: 10,
+    [ScrcpyControlMessageType.RotateDevice]: 11,
+} as const satisfies ScrcpyControlMessageTypeMap;

package/src/1_18/impl/defaults.ts

@@ -2,10 +2,9 @@ import type { Init } from "./init.js";
 import { VideoOrientation } from "./init.js";
 import { PrevImpl } from "./prev.js";
 
-export const Defaults = /* #__PURE__ */ (() =>
-    ({
-        ...PrevImpl.Defaults,
-        logLevel: "debug",
-        lockVideoOrientation: VideoOrientation.Unlocked,
-        powerOffOnClose: false,
-    }) as const satisfies Required<Init>)();
+export const Defaults = {
+    ...PrevImpl.Defaults,
+    logLevel: "debug",
+    lockVideoOrientation: VideoOrientation.Unlocked,
+    powerOffOnClose: false,
+} as const satisfies Required<Init>;

package/src/1_18/impl/init.ts

@@ -14,8 +14,10 @@ export const VideoOrientation = {
 export type VideoOrientation =
     (typeof VideoOrientation)[keyof typeof VideoOrientation];
 
-export interface Init
-    extends Omit<PrevImpl.Init, "logLevel" | "lockVideoOrientation"> {
+export interface Init extends Omit<
+    PrevImpl.Init,
+    "logLevel" | "lockVideoOrientation"
+> {
     logLevel?: LogLevel;
 
     lockVideoOrientation?: VideoOrientation;

package/src/1_18/options.ts

@@ -2,7 +2,6 @@ import type { MaybePromiseLike } from "@yume-chan/async";
 import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
 
 import type {
-    ScrcpyControlMessageType,
     ScrcpyDisplay,
     ScrcpyEncoder,
     ScrcpyMediaStreamPacket,
@@ -45,7 +44,7 @@ export class ScrcpyOptions1_18
 
     readonly value: Required<Init>;
 
-    get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
+    get controlMessageTypes(): typeof ControlMessageTypes {
         return ControlMessageTypes;
     }
 

package/src/1_19.ts

@@ -1,11 +1 @@
-import { ScrcpyOptions1_18 } from "./1_18/index.js";
-
-export class ScrcpyOptions1_19 extends ScrcpyOptions1_18 {
-    constructor(init: ScrcpyOptions1_18.Init) {
-        super(init);
-    }
-}
-
-export namespace ScrcpyOptions1_19 {
-    export type Init = ScrcpyOptions1_18.Init;
-}
+export { ScrcpyOptions1_18 as ScrcpyOptions1_19 } from "./1_18/index.js";

package/src/1_20.ts

@@ -1,11 +1 @@
-import { ScrcpyOptions1_18 } from "./1_18/index.js";
-
-export class ScrcpyOptions1_20 extends ScrcpyOptions1_18 {
-    constructor(init: ScrcpyOptions1_18.Init) {
-        super(init);
-    }
-}
-
-export namespace ScrcpyOptions1_20 {
-    export type Init = ScrcpyOptions1_18.Init;
-}
+export { ScrcpyOptions1_18 as ScrcpyOptions1_20 } from "./1_18/index.js";

package/src/1_21/impl/defaults.ts

@@ -1,8 +1,7 @@
 import type { Init } from "./init.js";
 import { PrevImpl } from "./prev.js";
 
-export const Defaults = /* #__PURE__ */ (() =>
-    ({
-        ...PrevImpl.Defaults,
-        clipboardAutosync: true,
-    }) as const satisfies Required<Init>)();
+export const Defaults = {
+    ...PrevImpl.Defaults,
+    clipboardAutosync: true,
+} as const satisfies Required<Init>;

package/src/1_21/impl/index.ts

@@ -7,4 +7,5 @@ export {
     AckClipboardDeviceMessage,
     AckClipboardHandler,
     SetClipboardControlMessage,
+    serializeSetClipboardControlMessage,
 } from "./set-clipboard.js";