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

package/src/1_21/impl/compute-option-values.ts

@@ -0,0 +1,43 @@
+import { PrevImpl } from "./prev.js";
+
+// Distributive Conditional Types
+// (https://www.typescriptlang.org/docs/handbook/2/conditional-types.html#distributive-conditional-types)
+type ComputeClipboardAutosync<TControl, TClipboardAutosync> =
+    TControl extends false ? false : TClipboardAutosync;
+
+export type OverrideClipboardAutosync<T> = Omit<T, "clipboardAutosync"> & {
+    clipboardAutosync: ComputeClipboardAutosync<
+        T extends { control: infer TControl } ? TControl : never,
+        T extends { clipboardAutosync: infer TClipboardAutosync }
+            ? TClipboardAutosync
+            : never
+    >;
+};
+
+export type ComputeOptionTypes<
+    T extends object,
+    TDefaults extends object,
+> = OverrideClipboardAutosync<PrevImpl.ComputeOptionTypes<T, TDefaults>>;
+
+export function overrideClipboardAutosync<
+    T extends { control: boolean; clipboardAutosync: boolean },
+>(value: T) {
+    if (!value.control) {
+        value.clipboardAutosync = false;
+    }
+}
+
+export function computeOptionValues<
+    T extends {
+        control?: boolean | undefined;
+        clipboardAutosync?: boolean | undefined;
+    },
+    TDefaults extends {
+        control: boolean;
+        clipboardAutosync: boolean;
+    },
+>(options: T, defaults: TDefaults): ComputeOptionTypes<T, TDefaults> {
+    const value = PrevImpl.computeOptionValues(options, defaults);
+    overrideClipboardAutosync(value as never);
+    return value as never;
+}

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

@@ -1,4 +1,13 @@
 export * from "../../1_18/impl/index.js";
+
+export {
+    computeOptionValues,
+    overrideClipboardAutosync,
+} from "./compute-option-values.js";
+export type {
+    ComputeOptionTypes,
+    OverrideClipboardAutosync,
+} from "./compute-option-values.js";
 export { Defaults } from "./defaults.js";
 export type { Init } from "./init.js";
 export { EncoderRegex } from "./parse-encoder.js";
@@ -6,5 +15,6 @@ export { serialize } from "./serialize.js";
 export {
     AckClipboardDeviceMessage,
     AckClipboardHandler,
+    serializeSetClipboardControlMessage,
     SetClipboardControlMessage,
 } from "./set-clipboard.js";

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

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

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

@@ -5,9 +5,9 @@ function toSnakeCase(input: string): string {
 }
 
 // 1.21 changed the format of arguments
-export function serialize<T extends object>(
+export function serialize<T extends object, TDefaults extends object>(
     options: T,
-    defaults: Required<T>,
+    defaults: TDefaults,
 ): string[] {
     const result: string[] = [];
     for (const [key, value] of Object.entries(options)) {
@@ -18,7 +18,7 @@ export function serialize<T extends object>(
         }
 
         const defaultValue = toScrcpyOptionValue(
-            defaults[key as keyof T],
+            defaults[key as keyof TDefaults],
             undefined,
         );
         if (serializedValue === defaultValue) {

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

@@ -12,6 +12,7 @@ export const AckClipboardDeviceMessage = struct(
 
 export const SetClipboardControlMessage = struct(
     {
+        // value of `type` can change between versions
         type: u8,
         sequence: u64,
         paste: u8<boolean>(),
@@ -75,3 +76,16 @@ export class AckClipboardHandler implements ScrcpyDeviceMessageParser {
         ];
     }
 }
+
+export function serializeSetClipboardControlMessage(
+    message: ScrcpySetClipboardControlMessage,
+    ackHandler: AckClipboardHandler | undefined,
+): Uint8Array | [Uint8Array, Promise<void>] {
+    if (!ackHandler) {
+        throw new Error(
+            "`serializeSetClipboardControlMessage` requires `control: true` option",
+        );
+    }
+
+    return ackHandler.serializeSetClipboardControlMessage(message);
+}

package/src/1_21/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_21
-    implements ScrcpyOptions<Init>, ScrcpyOptionsListEncoders
+export class ScrcpyOptions1_21<TInit extends Init = Init>
+    implements
+        ScrcpyOptions<ScrcpyOptions1_21.Value<TInit>>,
+        ScrcpyOptionsListEncoders
 {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init>;
+    readonly value: ScrcpyOptions1_21.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_21
         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(),
@@ -102,7 +114,7 @@ export class ScrcpyOptions1_21
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -110,24 +122,46 @@ export class ScrcpyOptions1_21
     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_21 {
     export type Init = Init_;
+
+    export type Value<TInit extends Init> = ComputeOptionTypes<
+        TInit,
+        typeof Defaults
+    >;
 }

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

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

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

@@ -1,19 +1,19 @@
 import type { PrevImpl } from "./prev.js";
 
 export interface Init extends PrevImpl.Init {
-    downsizeOnError?: boolean;
+    downsizeOnError?: boolean | undefined;
 
     /**
      * Send device name and size at start of video stream.
      *
      * @default true
      */
-    sendDeviceMeta?: boolean;
+    sendDeviceMeta?: boolean | undefined;
 
     /**
      * Send a `0` byte on start of video stream to detect connection issues
      *
      * @default true
      */
-    sendDummyByte?: boolean;
+    sendDummyByte?: boolean | undefined;
 }

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

@@ -1,16 +1,16 @@
 import type { ReadableStream } from "@yume-chan/stream-extra";
 
-import type { ScrcpyVideoStream } from "../../base/video.js";
-import { ScrcpyVideoCodecId } from "../../base/video.js";
+import type { ScrcpyVideoStream } from "../../base/index.js";
+import { ScrcpyVideoCodecId } from "../../video/index.js";
 
 import type { Init } from "./init.js";
 import { PrevImpl } from "./prev.js";
 
 export async function parseVideoStreamMetadata(
-    options: Pick<Init, "sendDeviceMeta">,
     stream: ReadableStream<Uint8Array>,
+    sendDeviceMeta: Exclude<Init["sendDeviceMeta"], undefined>,
 ): Promise<ScrcpyVideoStream> {
-    if (!options.sendDeviceMeta) {
+    if (!sendDeviceMeta) {
         return { stream, metadata: { codec: ScrcpyVideoCodecId.H264 } };
     } else {
         return PrevImpl.parseVideoStreamMetadata(stream);

package/src/1_22/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_22
-    implements ScrcpyOptions<Init>, ScrcpyOptionsListEncoders
+export class ScrcpyOptions1_22<TInit extends Init = Init>
+    implements
+        ScrcpyOptions<ScrcpyOptions1_22.Value<TInit>>,
+        ScrcpyOptionsListEncoders
 {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init>;
+    readonly value: ScrcpyOptions1_22.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_22
         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_22
     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_22
     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_22 {
     export type Init = Init_;
+
+    export type Value<TInit extends Init> = ComputeOptionTypes<
+        TInit,
+        typeof Defaults
+    >;
 }

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

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

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

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

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

@@ -3,7 +3,7 @@ import {
     TransformStream,
 } from "@yume-chan/stream-extra";
 
-import type { ScrcpyMediaStreamPacket } from "../../base/index.js";
+import type { ScrcpyVideoStreamPacket } from "../../base/index.js";
 
 import type { Init } from "./init.js";
 import { PrevImpl } from "./prev.js";
@@ -12,8 +12,8 @@ export const PtsKeyframe = 1n << 62n;
 
 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) {