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

package/src/1_23/options.ts

@@ -2,26 +2,28 @@ 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 {
     AckClipboardHandler,
     ClipboardStream,
+    computeOptionValues,
     ControlMessageTypes,
     createMediaStreamTransformer,
     createScrollController,
@@ -33,24 +35,32 @@ import {
     serialize,
     serializeBackOrScreenOnControlMessage,
     serializeInjectTouchControlMessage,
+    serializeSetClipboardControlMessage,
+    serializeSetDisplayPowerControlMessage,
     setListDisplays,
     setListEncoders,
 } from "./impl/index.js";
 
-export class ScrcpyOptions1_23
-    implements ScrcpyOptions<Init>, ScrcpyOptionsListEncoders
+export class ScrcpyOptions1_23<TInit extends Init = Init>
+    implements
+        ScrcpyOptions<ScrcpyOptions1_23.Value<TInit>>,
+        ScrcpyOptionsListEncoders
 {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init>;
+    readonly value: ScrcpyOptions1_23.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"]["clipboardAutosync"],
+        ReadableStream<string>,
+        undefined
+    > {
+        return this.#clipboard as never;
     }
 
     #ackClipboardHandler: AckClipboardHandler | undefined;
@@ -60,13 +70,15 @@ export class ScrcpyOptions1_23
         return this.#deviceMessageParsers;
     }
 
-    constructor(init: Init) {
-        this.value = { ...Defaults, ...init };
+    constructor(init: TInit) {
+        this.value = computeOptionValues(init, Defaults);
 
-        if (this.value.control && this.value.clipboardAutosync) {
-            this.#clipboard = this.#deviceMessageParsers.add(
-                new ClipboardStream(),
-            );
+        if (this.value.control) {
+            if (this.value.clipboardAutosync) {
+                this.#clipboard = this.#deviceMessageParsers.add(
+                    new ClipboardStream(),
+                );
+            }
 
             this.#ackClipboardHandler = this.#deviceMessageParsers.add(
                 new AckClipboardHandler(),
@@ -97,12 +109,12 @@ export class ScrcpyOptions1_23
     parseVideoStreamMetadata(
         stream: ReadableStream<Uint8Array>,
     ): MaybePromiseLike<ScrcpyVideoStream> {
-        return parseVideoStreamMetadata(this.value, stream);
+        return parseVideoStreamMetadata(stream, this.value.sendDeviceMeta);
     }
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -110,24 +122,46 @@ export class ScrcpyOptions1_23
     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 | [Uint8Array, Promise<void>] {
-        return this.#ackClipboardHandler!.serializeSetClipboardControlMessage(
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
+        return serializeSetClipboardControlMessage(
             message,
+            this.#ackClipboardHandler,
         );
     }
 
+    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();
     }
 }
@@ -136,4 +170,9 @@ type Init_ = Init;
 
 export namespace ScrcpyOptions1_23 {
     export type Init = Init_;
+
+    export type Value<TInit extends Init> = ComputeOptionTypes<
+        TInit,
+        typeof Defaults
+    >;
 }

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

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

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

@@ -1,5 +1,5 @@
 import type { PrevImpl } from "./prev.js";
 
 export interface Init extends PrevImpl.Init {
-    powerOn?: boolean;
+    powerOn?: boolean | undefined;
 }

package/src/1_24/options.ts

@@ -2,26 +2,28 @@ 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 {
     AckClipboardHandler,
     ClipboardStream,
+    computeOptionValues,
     ControlMessageTypes,
     createMediaStreamTransformer,
     createScrollController,
@@ -33,24 +35,32 @@ import {
     serialize,
     serializeBackOrScreenOnControlMessage,
     serializeInjectTouchControlMessage,
+    serializeSetClipboardControlMessage,
+    serializeSetDisplayPowerControlMessage,
     setListDisplays,
     setListEncoders,
 } from "./impl/index.js";
 
-export class ScrcpyOptions1_24
-    implements ScrcpyOptions<Init>, ScrcpyOptionsListEncoders
+export class ScrcpyOptions1_24<TInit extends Init = Init>
+    implements
+        ScrcpyOptions<ScrcpyOptions1_24.Value<TInit>>,
+        ScrcpyOptionsListEncoders
 {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init>;
+    readonly value: ScrcpyOptions1_24.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"]["clipboardAutosync"],
+        ReadableStream<string>,
+        undefined
+    > {
+        return this.#clipboard as never;
     }
 
     #ackClipboardHandler: AckClipboardHandler | undefined;
@@ -60,13 +70,15 @@ export class ScrcpyOptions1_24
         return this.#deviceMessageParsers;
     }
 
-    constructor(init: Init) {
-        this.value = { ...Defaults, ...init };
+    constructor(init: TInit) {
+        this.value = computeOptionValues(init, Defaults);
 
-        if (this.value.control && this.value.clipboardAutosync) {
-            this.#clipboard = this.#deviceMessageParsers.add(
-                new ClipboardStream(),
-            );
+        if (this.value.control) {
+            if (this.value.clipboardAutosync) {
+                this.#clipboard = this.#deviceMessageParsers.add(
+                    new ClipboardStream(),
+                );
+            }
 
             this.#ackClipboardHandler = this.#deviceMessageParsers.add(
                 new AckClipboardHandler(),
@@ -97,12 +109,12 @@ export class ScrcpyOptions1_24
     parseVideoStreamMetadata(
         stream: ReadableStream<Uint8Array>,
     ): MaybePromiseLike<ScrcpyVideoStream> {
-        return parseVideoStreamMetadata(this.value, stream);
+        return parseVideoStreamMetadata(stream, this.value.sendDeviceMeta);
     }
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -110,24 +122,46 @@ export class ScrcpyOptions1_24
     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 | [Uint8Array, Promise<void>] {
-        return this.#ackClipboardHandler!.serializeSetClipboardControlMessage(
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
+        return serializeSetClipboardControlMessage(
             message,
+            this.#ackClipboardHandler,
         );
     }
 
+    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();
     }
 }
@@ -136,4 +170,9 @@ type Init_ = Init;
 
 export namespace ScrcpyOptions1_24 {
     export type Init = Init_;
+
+    export type Value<TInit extends Init> = ComputeOptionTypes<
+        TInit,
+        typeof Defaults
+    >;
 }

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

@@ -3,7 +3,6 @@ import type { Field, StructInit } from "@yume-chan/struct";
 import { field, struct, u16, u32, u8 } from "@yume-chan/struct";
 
 import type { ScrcpyScrollController } from "../../base/index.js";
-import { ScrcpyControlMessageType } from "../../base/index.js";
 import type { ScrcpyInjectScrollControlMessage } from "../../latest.js";
 import { clamp } from "../../utils/index.js";
 
@@ -24,20 +23,20 @@ export const SignedFloat: Field<number, never, never> = field(
     },
 );
 
-export const InjectScrollControlMessage = /* #__PURE__ */ (() =>
-    struct(
-        {
-            type: u8(ScrcpyControlMessageType.InjectScroll),
-            pointerX: u32,
-            pointerY: u32,
-            videoWidth: u16,
-            videoHeight: u16,
-            scrollX: SignedFloat,
-            scrollY: SignedFloat,
-            buttons: u32,
-        },
-        { littleEndian: false },
-    ))();
+export const InjectScrollControlMessage = struct(
+    {
+        // value of `type` can change between versions
+        type: u8,
+        pointerX: u32,
+        pointerY: u32,
+        videoWidth: u16,
+        videoHeight: u16,
+        scrollX: SignedFloat,
+        scrollY: SignedFloat,
+        buttons: u32,
+    },
+    { littleEndian: false },
+);
 
 export type InjectScrollControlMessage = StructInit<
     typeof InjectScrollControlMessage

package/src/1_25/options.ts

@@ -2,26 +2,28 @@ 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 {
     AckClipboardHandler,
     ClipboardStream,
+    computeOptionValues,
     ControlMessageTypes,
     createMediaStreamTransformer,
     createScrollController,
@@ -33,24 +35,32 @@ import {
     serialize,
     serializeBackOrScreenOnControlMessage,
     serializeInjectTouchControlMessage,
+    serializeSetClipboardControlMessage,
+    serializeSetDisplayPowerControlMessage,
     setListDisplays,
     setListEncoders,
 } from "./impl/index.js";
 
-export class ScrcpyOptions1_25
-    implements ScrcpyOptions<Init>, ScrcpyOptionsListEncoders
+export class ScrcpyOptions1_25<TInit extends Init = Init>
+    implements
+        ScrcpyOptions<ScrcpyOptions1_25.Value<TInit>>,
+        ScrcpyOptionsListEncoders
 {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init>;
+    readonly value: ScrcpyOptions1_25.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"]["clipboardAutosync"],
+        ReadableStream<string>,
+        undefined
+    > {
+        return this.#clipboard as never;
     }
 
     #ackClipboardHandler: AckClipboardHandler | undefined;
@@ -60,13 +70,15 @@ export class ScrcpyOptions1_25
         return this.#deviceMessageParsers;
     }
 
-    constructor(init: Init) {
-        this.value = { ...Defaults, ...init };
+    constructor(init: TInit) {
+        this.value = computeOptionValues(init, Defaults);
 
-        if (this.value.control && this.value.clipboardAutosync) {
-            this.#clipboard = this.#deviceMessageParsers.add(
-                new ClipboardStream(),
-            );
+        if (this.value.control) {
+            if (this.value.clipboardAutosync) {
+                this.#clipboard = this.#deviceMessageParsers.add(
+                    new ClipboardStream(),
+                );
+            }
 
             this.#ackClipboardHandler = this.#deviceMessageParsers.add(
                 new AckClipboardHandler(),
@@ -97,12 +109,12 @@ export class ScrcpyOptions1_25
     parseVideoStreamMetadata(
         stream: ReadableStream<Uint8Array>,
     ): MaybePromiseLike<ScrcpyVideoStream> {
-        return parseVideoStreamMetadata(this.value, stream);
+        return parseVideoStreamMetadata(stream, this.value.sendDeviceMeta);
     }
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -110,24 +122,46 @@ export class ScrcpyOptions1_25
     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 | [Uint8Array, Promise<void>] {
-        return this.#ackClipboardHandler!.serializeSetClipboardControlMessage(
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
+        return serializeSetClipboardControlMessage(
             message,
+            this.#ackClipboardHandler,
         );
     }
 
+    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();
     }
 }
@@ -136,4 +170,9 @@ type Init_ = Init;
 
 export namespace ScrcpyOptions1_25 {
     export type Init = Init_;
+
+    export type Value<TInit extends Init> = ComputeOptionTypes<
+        TInit,
+        typeof Defaults
+    >;
 }

package/src/2_0/impl/defaults.ts

@@ -1,11 +1,12 @@
-import { omit } from "../../utils/index.js";
+import { omit } from "../../utils/omit.js";
 
 import type { Init } from "./init.js";
 import { PrevImpl } from "./prev.js";
 
-export const Defaults = /* #__PURE__ */ (() =>
+export const Defaults = /* #__PURE__*/ (() =>
     ({
         ...omit(PrevImpl.Defaults, "bitRate", "codecOptions", "encoderName"),
+
         scid: undefined,
 
         videoCodec: "h264",

package/src/2_0/impl/index.ts

@@ -8,6 +8,10 @@ export {
 export * from "./parse-audio-stream-metadata.js";
 export { parseDisplay } from "./parse-display.js";
 export { parseEncoder } from "./parse-encoder.js";
-export { parseVideoStreamMetadata } from "./parse-video-stream-metadata.js";
+export {
+    parseVideoCodecOption,
+    parseVideoStreamMetadata,
+    parseVideoStreamMetadataAsync,
+} from "./parse-video-stream-metadata.js";
 export { setListDisplays } from "./set-list-display.js";
 export { setListEncoders } from "./set-list-encoder.js";

package/src/2_0/impl/init.ts

@@ -24,22 +24,24 @@ export class InstanceId implements ScrcpyOptionValue {
     }
 }
 
-export interface Init
-    extends Omit<PrevImpl.Init, "bitRate" | "codecOptions" | "encoderName"> {
+export interface Init extends Omit<
+    PrevImpl.Init,
+    "bitRate" | "codecOptions" | "encoderName"
+> {
     scid?: InstanceId | string | undefined;
 
-    videoCodec?: "h264" | "h265" | "av1";
-    videoBitRate?: number;
+    videoCodec?: "h264" | "h265" | "av1" | undefined;
+    videoBitRate?: number | undefined;
     videoCodecOptions?: PrevImpl.CodecOptions | string | undefined;
     videoEncoder?: string | undefined;
 
-    audio?: boolean;
-    audioCodec?: "raw" | "opus" | "aac";
-    audioBitRate?: number;
+    audio?: boolean | undefined;
+    audioCodec?: "raw" | "opus" | "aac" | undefined;
+    audioBitRate?: number | undefined;
     audioCodecOptions?: PrevImpl.CodecOptions | string | undefined;
     audioEncoder?: string | undefined;
 
-    listEncoders?: boolean;
-    listDisplays?: boolean;
-    sendCodecMeta?: boolean;
+    listEncoders?: boolean | undefined;
+    listDisplays?: boolean | undefined;
+    sendCodecMeta?: boolean | undefined;
 }

package/src/2_0/impl/inject-touch.ts

@@ -2,27 +2,26 @@ import type { StructInit } from "@yume-chan/struct";
 import { struct, u16, u32, u64, u8 } from "@yume-chan/struct";
 
 import type { AndroidMotionEventAction } from "../../android/motion-event.js";
-import { ScrcpyControlMessageType } from "../../base/control-message-type.js";
 import type { ScrcpyInjectTouchControlMessage } from "../../latest.js";
 
 import { PrevImpl } from "./prev.js";
 
-export const InjectTouchControlMessage = /* #__PURE__ */ (() =>
-    struct(
-        {
-            type: u8(ScrcpyControlMessageType.InjectTouch),
-            action: u8<AndroidMotionEventAction>(),
-            pointerId: u64,
-            pointerX: u32,
-            pointerY: u32,
-            videoWidth: u16,
-            videoHeight: u16,
-            pressure: PrevImpl.UnsignedFloat,
-            actionButton: u32,
-            buttons: u32,
-        },
-        { littleEndian: false },
-    ))();
+export const InjectTouchControlMessage = struct(
+    {
+        // value of `type` can change between versions
+        type: u8,
+        action: u8<AndroidMotionEventAction>(),
+        pointerId: u64,
+        pointerX: u32,
+        pointerY: u32,
+        videoWidth: u16,
+        videoHeight: u16,
+        pressure: PrevImpl.UnsignedFloat,
+        actionButton: u32,
+        buttons: u32,
+    },
+    { littleEndian: false },
+);
 
 export type InjectTouchControlMessage = StructInit<
     typeof InjectTouchControlMessage