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

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

@@ -34,21 +34,21 @@ export class Crop implements ScrcpyOptionValue {
 }
 
 export interface Init {
-    logLevel?: LogLevel;
+    logLevel?: LogLevel | undefined;
 
     /**
      * The maximum value of both width and height.
      */
-    maxSize?: number;
+    maxSize?: number | undefined;
 
-    bitRate?: number;
+    bitRate?: number | undefined;
 
     /**
      * 0 for unlimited.
      *
      * @default 0
      */
-    maxFps?: number;
+    maxFps?: number | undefined;
 
     /**
      * The orientation of the video stream.
@@ -56,7 +56,7 @@ export interface Init {
      * It will not keep the device screen in specific orientation,
      * only the captured video will in this orientation.
      */
-    lockVideoOrientation?: VideoOrientation;
+    lockVideoOrientation?: VideoOrientation | undefined;
 
     /**
      * Use ADB forward tunnel instead of reverse tunnel.
@@ -66,7 +66,7 @@ export interface Init {
      *
      * When using `AdbScrcpyClient`, it can detect this situation and enable this option automatically.
      */
-    tunnelForward?: boolean;
+    tunnelForward?: boolean | undefined;
 
     crop?: Crop | string | undefined;
 
@@ -81,18 +81,18 @@ export interface Init {
      *
      * @default true
      */
-    sendFrameMeta?: boolean;
+    sendFrameMeta?: boolean | undefined;
 
     /**
      * @default true
      */
-    control?: boolean;
+    control?: boolean | undefined;
 
-    displayId?: number;
+    displayId?: number | undefined;
 
-    showTouches?: boolean;
+    showTouches?: boolean | undefined;
 
-    stayAwake?: boolean;
+    stayAwake?: boolean | undefined;
 
     codecOptions?: CodecOptions | string | undefined;
 }

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/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

@@ -3,21 +3,24 @@ import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
 
 import type {
     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,
@@ -29,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(): 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();
@@ -51,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(
@@ -81,7 +91,7 @@ export class ScrcpyOptions1_15 implements ScrcpyOptions<Init> {
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -89,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();
     }
 }
@@ -113,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_17/options.ts

@@ -2,24 +2,27 @@ import type { MaybePromiseLike } from "@yume-chan/async";
 import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
 
 import type {
+    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,
@@ -33,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(): 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();
@@ -58,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(
@@ -96,7 +106,7 @@ export class ScrcpyOptions1_17
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -104,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();
     }
 }
@@ -128,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/init.ts

@@ -18,9 +18,9 @@ export interface Init extends Omit<
     PrevImpl.Init,
     "logLevel" | "lockVideoOrientation"
 > {
-    logLevel?: LogLevel;
+    logLevel?: LogLevel | undefined;
 
-    lockVideoOrientation?: VideoOrientation;
+    lockVideoOrientation?: VideoOrientation | undefined;
 
-    powerOffOnClose?: boolean;
+    powerOffOnClose?: boolean | undefined;
 }

package/src/1_18/options.ts

@@ -2,24 +2,27 @@ import type { MaybePromiseLike } from "@yume-chan/async";
 import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
 
 import type {
+    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,
@@ -33,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(): 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();
@@ -58,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(
@@ -96,7 +106,7 @@ export class ScrcpyOptions1_18
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -104,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();
     }
 }
@@ -128,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_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/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,6 +15,6 @@ export { serialize } from "./serialize.js";
 export {
     AckClipboardDeviceMessage,
     AckClipboardHandler,
-    SetClipboardControlMessage,
     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) {