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

package/src/1_15/impl/media-stream-transformer.ts

@@ -4,7 +4,7 @@ import {
 } from "@yume-chan/stream-extra";
 import { buffer, struct, u32, u64 } from "@yume-chan/struct";
 
-import type { ScrcpyMediaStreamPacket } from "../../base/index.js";
+import type { ScrcpyVideoStreamPacket } from "../../base/index.js";
 
 import type { Init } from "./init.js";
 
@@ -17,8 +17,8 @@ export const PtsConfig = 1n << 63n;
 
 export function createMediaStreamTransformer(
     options: Pick<Init, "sendFrameMeta">,
-): TransformStream<Uint8Array, ScrcpyMediaStreamPacket> {
-    // Optimized path for video frames only
+): TransformStream<Uint8Array, ScrcpyVideoStreamPacket> {
+    // Quick path for raw stream without frame meta
     if (!options.sendFrameMeta) {
         return new TransformStream({
             transform(chunk, controller) {

package/src/1_15/impl/parse-video-stream-metadata.ts

@@ -11,7 +11,7 @@ import type {
     ScrcpyVideoStream,
     ScrcpyVideoStreamMetadata,
 } from "../../base/index.js";
-import { ScrcpyVideoCodecId } from "../../base/index.js";
+import { ScrcpyVideoCodecId } from "../../video/index.js";
 
 /**
  * Parse a fixed-length, null-terminated string.
@@ -44,10 +44,10 @@ export async function parseVideoStreamMetadata(
 ): Promise<ScrcpyVideoStream> {
     const buffered = new BufferedReadableStream(stream);
     const metadata: ScrcpyVideoStreamMetadata = {
+        deviceName: await readString(buffered, 64),
+        width: await readU16(buffered),
+        height: await readU16(buffered),
         codec: ScrcpyVideoCodecId.H264,
     };
-    metadata.deviceName = await readString(buffered, 64);
-    metadata.width = await readU16(buffered);
-    metadata.height = await readU16(buffered);
     return { stream: buffered.release(), metadata };
 }

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/impl/set-display-power.ts

@@ -0,0 +1,29 @@
+import type { StructInit } from "@yume-chan/struct";
+import { struct, u8 } from "@yume-chan/struct";
+
+import { AndroidScreenPowerMode } from "../../android/index.js";
+import type { ScrcpySetDisplayPowerControlMessage } from "../../latest.js";
+
+export const SetDisplayPowerControlMessage = struct(
+    {
+        // value of `type` can change between versions
+        type: u8,
+        mode: u8<AndroidScreenPowerMode>(),
+    },
+    { littleEndian: false },
+);
+
+export type SetDisplayPowerControlMessage = StructInit<
+    typeof SetDisplayPowerControlMessage
+>;
+
+export function serializeSetDisplayPowerControlMessage(
+    message: ScrcpySetDisplayPowerControlMessage,
+) {
+    return SetDisplayPowerControlMessage.serialize({
+        type: message.type,
+        mode: message.on
+            ? AndroidScreenPowerMode.Normal
+            : AndroidScreenPowerMode.Off,
+    });
+}

package/src/1_15/options.ts

@@ -2,23 +2,25 @@ import type { MaybePromiseLike } from "@yume-chan/async";
 import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
 
 import type {
-    ScrcpyControlMessageType,
     ScrcpyDisplay,
-    ScrcpyMediaStreamPacket,
     ScrcpyOptions,
     ScrcpyScrollController,
     ScrcpyVideoStream,
+    ScrcpyVideoStreamPacket,
 } from "../base/index.js";
 import { ScrcpyDeviceMessageParsers } from "../base/index.js";
+import type { MapBoolean } from "../base/options.js";
 import type {
     ScrcpyBackOrScreenOnControlMessage,
     ScrcpyInjectTouchControlMessage,
     ScrcpySetClipboardControlMessage,
+    ScrcpySetDisplayPowerControlMessage,
 } from "../latest.js";
 
-import type { Init } from "./impl/index.js";
+import type { ComputeOptionTypes, Init } from "./impl/index.js";
 import {
     ClipboardStream,
+    computeOptionValues,
     ControlMessageTypes,
     createMediaStreamTransformer,
     createScrollController,
@@ -30,21 +32,28 @@ import {
     serializeInjectTouchControlMessage,
     SerializeOrder,
     serializeSetClipboardControlMessage,
+    serializeSetDisplayPowerControlMessage,
     setListDisplays,
 } from "./impl/index.js";
 
-export class ScrcpyOptions1_15 implements ScrcpyOptions<Init> {
+export class ScrcpyOptions1_15<
+    TInit extends Init = Init,
+> implements ScrcpyOptions<ScrcpyOptions1_15.Value<TInit>> {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init>;
+    readonly value: ScrcpyOptions1_15.Value<TInit>;
 
-    get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
+    get controlMessageTypes(): typeof ControlMessageTypes {
         return ControlMessageTypes;
     }
 
     #clipboard: ClipboardStream | undefined;
-    get clipboard(): ReadableStream<string> | undefined {
-        return this.#clipboard;
+    get clipboard(): MapBoolean<
+        this["value"]["control"],
+        ReadableStream<string>,
+        undefined
+    > {
+        return this.#clipboard as never;
     }
 
     #deviceMessageParsers = new ScrcpyDeviceMessageParsers();
@@ -52,8 +61,8 @@ export class ScrcpyOptions1_15 implements ScrcpyOptions<Init> {
         return this.#deviceMessageParsers;
     }
 
-    constructor(init: Init) {
-        this.value = { ...Defaults, ...init };
+    constructor(init: TInit) {
+        this.value = computeOptionValues(init, Defaults);
 
         if (this.value.control) {
             this.#clipboard = this.#deviceMessageParsers.add(
@@ -82,7 +91,7 @@ export class ScrcpyOptions1_15 implements ScrcpyOptions<Init> {
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -90,22 +99,43 @@ export class ScrcpyOptions1_15 implements ScrcpyOptions<Init> {
     serializeInjectTouchControlMessage(
         message: ScrcpyInjectTouchControlMessage,
     ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeInjectTouchControlMessage(message);
     }
 
     serializeBackOrScreenOnControlMessage(
         message: ScrcpyBackOrScreenOnControlMessage,
     ): Uint8Array | undefined {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeBackOrScreenOnControlMessage(message);
     }
 
     serializeSetClipboardControlMessage(
         message: ScrcpySetClipboardControlMessage,
     ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeSetClipboardControlMessage(message);
     }
 
+    serializeSetDisplayPowerControlMessage(
+        message: ScrcpySetDisplayPowerControlMessage,
+    ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
+        return serializeSetDisplayPowerControlMessage(message);
+    }
+
     createScrollController(): ScrcpyScrollController {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return createScrollController();
     }
 }
@@ -114,4 +144,9 @@ type Init_ = Init;
 
 export namespace ScrcpyOptions1_15 {
     export type Init = Init_;
+
+    export type Value<TInit extends Init> = ComputeOptionTypes<
+        TInit,
+        typeof Defaults
+    >;
 }

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,25 +2,27 @@ import type { MaybePromiseLike } from "@yume-chan/async";
 import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
 
 import type {
-    ScrcpyControlMessageType,
+    MapBoolean,
     ScrcpyDisplay,
     ScrcpyEncoder,
-    ScrcpyMediaStreamPacket,
     ScrcpyOptions,
     ScrcpyOptionsListEncoders,
     ScrcpyScrollController,
     ScrcpyVideoStream,
+    ScrcpyVideoStreamPacket,
 } from "../base/index.js";
 import { ScrcpyDeviceMessageParsers } from "../base/index.js";
 import type {
     ScrcpyBackOrScreenOnControlMessage,
     ScrcpyInjectTouchControlMessage,
     ScrcpySetClipboardControlMessage,
+    ScrcpySetDisplayPowerControlMessage,
 } from "../latest.js";
 
-import type { Init } from "./impl/index.js";
+import type { ComputeOptionTypes, Init } from "./impl/index.js";
 import {
     ClipboardStream,
+    computeOptionValues,
     ControlMessageTypes,
     createMediaStreamTransformer,
     createScrollController,
@@ -34,24 +36,31 @@ import {
     serializeInjectTouchControlMessage,
     SerializeOrder,
     serializeSetClipboardControlMessage,
+    serializeSetDisplayPowerControlMessage,
     setListDisplays,
     setListEncoders,
 } from "./impl/index.js";
 
-export class ScrcpyOptions1_17
-    implements ScrcpyOptions<Init>, ScrcpyOptionsListEncoders
+export class ScrcpyOptions1_17<TInit extends Init = Init>
+    implements
+        ScrcpyOptions<ScrcpyOptions1_17.Value<TInit>>,
+        ScrcpyOptionsListEncoders
 {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init>;
+    readonly value: ScrcpyOptions1_17.Value<TInit>;
 
-    get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
+    get controlMessageTypes(): typeof ControlMessageTypes {
         return ControlMessageTypes;
     }
 
     #clipboard: ClipboardStream | undefined;
-    get clipboard(): ReadableStream<string> | undefined {
-        return this.#clipboard;
+    get clipboard(): MapBoolean<
+        this["value"]["control"],
+        ReadableStream<string>,
+        undefined
+    > {
+        return this.#clipboard as never;
     }
 
     #deviceMessageParsers = new ScrcpyDeviceMessageParsers();
@@ -59,8 +68,8 @@ export class ScrcpyOptions1_17
         return this.#deviceMessageParsers;
     }
 
-    constructor(init: Init) {
-        this.value = { ...Defaults, ...init };
+    constructor(init: TInit) {
+        this.value = computeOptionValues(init, Defaults);
 
         if (this.value.control) {
             this.#clipboard = this.#deviceMessageParsers.add(
@@ -97,7 +106,7 @@ export class ScrcpyOptions1_17
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -105,22 +114,43 @@ export class ScrcpyOptions1_17
     serializeInjectTouchControlMessage(
         message: ScrcpyInjectTouchControlMessage,
     ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeInjectTouchControlMessage(message);
     }
 
     serializeBackOrScreenOnControlMessage(
         message: ScrcpyBackOrScreenOnControlMessage,
     ): Uint8Array | undefined {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeBackOrScreenOnControlMessage(message);
     }
 
     serializeSetClipboardControlMessage(
         message: ScrcpySetClipboardControlMessage,
     ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeSetClipboardControlMessage(message);
     }
 
+    serializeSetDisplayPowerControlMessage(
+        message: ScrcpySetDisplayPowerControlMessage,
+    ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
+        return serializeSetDisplayPowerControlMessage(message);
+    }
+
     createScrollController(): ScrcpyScrollController {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return createScrollController();
     }
 }
@@ -129,4 +159,9 @@ type Init_ = Init;
 
 export namespace ScrcpyOptions1_17 {
     export type Init = Init_;
+
+    export type Value<TInit extends Init> = ComputeOptionTypes<
+        TInit,
+        typeof Defaults
+    >;
 }

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,11 +14,13 @@ export const VideoOrientation = {
 export type VideoOrientation =
     (typeof VideoOrientation)[keyof typeof VideoOrientation];
 
-export interface Init
-    extends Omit<PrevImpl.Init, "logLevel" | "lockVideoOrientation"> {
-    logLevel?: LogLevel;
+export interface Init extends Omit<
+    PrevImpl.Init,
+    "logLevel" | "lockVideoOrientation"
+> {
+    logLevel?: LogLevel | undefined;
 
-    lockVideoOrientation?: VideoOrientation;
+    lockVideoOrientation?: VideoOrientation | undefined;
 
-    powerOffOnClose?: boolean;
+    powerOffOnClose?: boolean | undefined;
 }

package/src/1_18/options.ts

@@ -2,25 +2,27 @@ import type { MaybePromiseLike } from "@yume-chan/async";
 import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
 
 import type {
-    ScrcpyControlMessageType,
+    MapBoolean,
     ScrcpyDisplay,
     ScrcpyEncoder,
-    ScrcpyMediaStreamPacket,
     ScrcpyOptions,
     ScrcpyOptionsListEncoders,
     ScrcpyScrollController,
     ScrcpyVideoStream,
+    ScrcpyVideoStreamPacket,
 } from "../base/index.js";
 import { ScrcpyDeviceMessageParsers } from "../base/index.js";
 import type {
     ScrcpyBackOrScreenOnControlMessage,
     ScrcpyInjectTouchControlMessage,
     ScrcpySetClipboardControlMessage,
+    ScrcpySetDisplayPowerControlMessage,
 } from "../latest.js";
 
-import type { Init } from "./impl/index.js";
+import type { ComputeOptionTypes, Init } from "./impl/index.js";
 import {
     ClipboardStream,
+    computeOptionValues,
     ControlMessageTypes,
     createMediaStreamTransformer,
     createScrollController,
@@ -34,24 +36,31 @@ import {
     serializeInjectTouchControlMessage,
     SerializeOrder,
     serializeSetClipboardControlMessage,
+    serializeSetDisplayPowerControlMessage,
     setListDisplays,
     setListEncoders,
 } from "./impl/index.js";
 
-export class ScrcpyOptions1_18
-    implements ScrcpyOptions<Init>, ScrcpyOptionsListEncoders
+export class ScrcpyOptions1_18<TInit extends Init = Init>
+    implements
+        ScrcpyOptions<ScrcpyOptions1_18.Value<TInit>>,
+        ScrcpyOptionsListEncoders
 {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init>;
+    readonly value: ScrcpyOptions1_18.Value<TInit>;
 
-    get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
+    get controlMessageTypes(): typeof ControlMessageTypes {
         return ControlMessageTypes;
     }
 
     #clipboard: ClipboardStream | undefined;
-    get clipboard(): ReadableStream<string> | undefined {
-        return this.#clipboard;
+    get clipboard(): MapBoolean<
+        this["value"]["control"],
+        ReadableStream<string>,
+        undefined
+    > {
+        return this.#clipboard as never;
     }
 
     #deviceMessageParsers = new ScrcpyDeviceMessageParsers();
@@ -59,8 +68,8 @@ export class ScrcpyOptions1_18
         return this.#deviceMessageParsers;
     }
 
-    constructor(init: Init) {
-        this.value = { ...Defaults, ...init };
+    constructor(init: TInit) {
+        this.value = computeOptionValues(init, Defaults);
 
         if (this.value.control) {
             this.#clipboard = this.#deviceMessageParsers.add(
@@ -97,7 +106,7 @@ export class ScrcpyOptions1_18
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -105,22 +114,43 @@ export class ScrcpyOptions1_18
     serializeInjectTouchControlMessage(
         message: ScrcpyInjectTouchControlMessage,
     ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeInjectTouchControlMessage(message);
     }
 
     serializeBackOrScreenOnControlMessage(
         message: ScrcpyBackOrScreenOnControlMessage,
     ): Uint8Array | undefined {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeBackOrScreenOnControlMessage(message);
     }
 
     serializeSetClipboardControlMessage(
         message: ScrcpySetClipboardControlMessage,
     ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeSetClipboardControlMessage(message);
     }
 
+    serializeSetDisplayPowerControlMessage(
+        message: ScrcpySetDisplayPowerControlMessage,
+    ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
+        return serializeSetDisplayPowerControlMessage(message);
+    }
+
     createScrollController(): ScrcpyScrollController {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return createScrollController();
     }
 }
@@ -129,4 +159,9 @@ type Init_ = Init;
 
 export namespace ScrcpyOptions1_18 {
     export type Init = Init_;
+
+    export type Value<TInit extends Init> = ComputeOptionTypes<
+        TInit,
+        typeof Defaults
+    >;
 }

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";