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

package/src/2_3_1.ts

@@ -1,14 +1 @@
-import { ScrcpyOptions2_3 } from "./2_3/index.js";
-
-export class ScrcpyOptions2_3_1<
-    TVideo extends boolean,
-> extends ScrcpyOptions2_3<TVideo> {
-    constructor(init: ScrcpyOptions2_3.Init<TVideo>) {
-        super(init);
-    }
-}
-
-export namespace ScrcpyOptions2_3_1 {
-    export type Init<TVideo extends boolean = boolean> =
-        ScrcpyOptions2_3.Init<TVideo>;
-}
+export { ScrcpyOptions2_3 as ScrcpyOptions2_3_1 } from "./2_3/index.js";

package/src/2_4/impl/control-message-types.ts

@@ -1,11 +1,20 @@
+import type { ScrcpyControlMessageTypeMap } from "../../base/index.js";
 import { ScrcpyControlMessageType } from "../../base/index.js";
 
-import { PrevImpl } from "./prev.js";
-
-export const ControlMessageTypes: readonly ScrcpyControlMessageType[] =
-    /* #__PURE__ */ (() => [
-        ...PrevImpl.ControlMessageTypes,
-        ScrcpyControlMessageType.UHidCreate,
-        ScrcpyControlMessageType.UHidInput,
-        ScrcpyControlMessageType.OpenHardKeyboardSettings,
-    ])();
+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,
+    [ScrcpyControlMessageType.UHidCreate]: 12,
+    [ScrcpyControlMessageType.UHidInput]: 13,
+    [ScrcpyControlMessageType.OpenHardKeyboardSettings]: 14,
+} as const satisfies ScrcpyControlMessageTypeMap;

package/src/2_4/impl/serialize-uhid-create.ts

@@ -5,6 +5,7 @@ import type { ScrcpyUHidCreateControlMessage } from "../../latest.js";
 
 export const UHidCreateControlMessage = struct(
     {
+        // value of `type` can change between versions
         type: u8,
         id: u16,
         data: buffer(u16),

package/src/2_4/options.ts

@@ -2,69 +2,85 @@ import type { MaybePromiseLike } from "@yume-chan/async";
 import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
 
 import type {
+    MapBoolean,
     ScrcpyAudioStreamMetadata,
-    ScrcpyControlMessageType,
     ScrcpyDisplay,
     ScrcpyEncoder,
-    ScrcpyMediaStreamPacket,
     ScrcpyOptions,
     ScrcpyOptionsListEncoders,
     ScrcpyScrollController,
     ScrcpyVideoStream,
+    ScrcpyVideoStreamPacket,
 } from "../base/index.js";
 import { ScrcpyDeviceMessageParsers } from "../base/index.js";
 import type {
     ScrcpyBackOrScreenOnControlMessage,
     ScrcpyInjectTouchControlMessage,
     ScrcpySetClipboardControlMessage,
+    ScrcpySetDisplayPowerControlMessage,
     ScrcpyUHidCreateControlMessage,
     ScrcpyUHidOutputDeviceMessage,
 } 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,
     Defaults,
+    parseAudioCodecOption,
+    parseAudioMetadataCodec,
     parseAudioStreamMetadata,
     parseDisplay,
     parseEncoder,
+    parseVideoCodecOption,
     parseVideoStreamMetadata,
+    parseVideoStreamMetadataAsync,
     serialize,
     serializeBackOrScreenOnControlMessage,
     serializeInjectTouchControlMessage,
+    serializeSetClipboardControlMessage,
+    serializeSetDisplayPowerControlMessage,
     serializeUHidCreateControlMessage,
     setListDisplays,
     setListEncoders,
     UHidOutputStream,
 } from "./impl/index.js";
 
-export class ScrcpyOptions2_4<TVideo extends boolean>
-    implements ScrcpyOptions<Init<TVideo>>, ScrcpyOptionsListEncoders
+export class ScrcpyOptions2_4<TInit extends Init = Init>
+    implements
+        ScrcpyOptions<ScrcpyOptions2_4.Value<TInit>>,
+        ScrcpyOptionsListEncoders
 {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init<TVideo>>;
+    readonly value: ScrcpyOptions2_4.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;
 
     #uHidOutput: UHidOutputStream | undefined;
-    get uHidOutput():
-        | ReadableStream<ScrcpyUHidOutputDeviceMessage>
-        | undefined {
-        return this.#uHidOutput;
+    get uHidOutput(): MapBoolean<
+        this["value"]["control"],
+        ReadableStream<ScrcpyUHidOutputDeviceMessage>,
+        undefined
+    > {
+        return this.#uHidOutput as never;
     }
 
     #deviceMessageParsers = new ScrcpyDeviceMessageParsers();
@@ -72,24 +88,20 @@ export class ScrcpyOptions2_4<TVideo extends boolean>
         return this.#deviceMessageParsers;
     }
 
-    constructor(init: Init<TVideo>) {
-        this.value = { ...Defaults, ...init } as never;
-
-        if (this.value.videoSource === "camera") {
-            this.value.control = false;
-        }
+    constructor(init: TInit) {
+        this.value = computeOptionValues(init, Defaults);
 
         if (this.value.control) {
             if (this.value.clipboardAutosync) {
                 this.#clipboard = this.#deviceMessageParsers.add(
                     new ClipboardStream(),
                 );
-
-                this.#ackClipboardHandler = this.#deviceMessageParsers.add(
-                    new AckClipboardHandler(),
-                );
             }
 
+            this.#ackClipboardHandler = this.#deviceMessageParsers.add(
+                new AckClipboardHandler(),
+            );
+
             this.#uHidOutput = this.#deviceMessageParsers.add(
                 new UHidOutputStream(),
             );
@@ -97,7 +109,7 @@ export class ScrcpyOptions2_4<TVideo extends boolean>
     }
 
     serialize(): string[] {
-        return serialize<Init<boolean>>(this.value, Defaults);
+        return serialize(this.value, Defaults);
     }
 
     setListDisplays(): void {
@@ -119,18 +131,29 @@ export class ScrcpyOptions2_4<TVideo extends boolean>
     parseVideoStreamMetadata(
         stream: ReadableStream<Uint8Array>,
     ): MaybePromiseLike<ScrcpyVideoStream> {
-        return parseVideoStreamMetadata(this.value, stream);
+        return parseVideoStreamMetadata(
+            stream,
+            this.value.sendDeviceMeta,
+            this.value.sendCodecMeta,
+            parseVideoCodecOption(this.value.videoCodec),
+            parseVideoStreamMetadataAsync,
+        );
     }
 
     parseAudioStreamMetadata(
         stream: ReadableStream<Uint8Array>,
     ): MaybePromiseLike<ScrcpyAudioStreamMetadata> {
-        return parseAudioStreamMetadata(stream, this.value);
+        return parseAudioStreamMetadata(
+            stream,
+            this.value.sendCodecMeta,
+            parseAudioMetadataCodec,
+            parseAudioCodecOption(this.value.audioCodec),
+        );
     }
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -138,36 +161,66 @@ export class ScrcpyOptions2_4<TVideo extends boolean>
     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();
     }
 
     serializeUHidCreateControlMessage(
         message: ScrcpyUHidCreateControlMessage,
     ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeUHidCreateControlMessage(message);
     }
 }
 
-type Init_<TVideo extends boolean> = Init<TVideo>;
+type Init_ = Init;
 
 export namespace ScrcpyOptions2_4 {
-    export type Init<TVideo extends boolean = boolean> = Init_<TVideo>;
+    export type Init = Init_;
+
+    export type Value<TInit extends Init> = ComputeOptionTypes<
+        TInit,
+        typeof Defaults
+    >;
 }

package/src/2_5.ts

@@ -1,14 +1 @@
-import { ScrcpyOptions2_4 } from "./2_4/index.js";
-
-export class ScrcpyOptions2_5<
-    TVideo extends boolean,
-> extends ScrcpyOptions2_4<TVideo> {
-    constructor(init: ScrcpyOptions2_4.Init<TVideo>) {
-        super(init);
-    }
-}
-
-export namespace ScrcpyOptions2_5 {
-    export type Init<TVideo extends boolean = boolean> =
-        ScrcpyOptions2_4.Init<TVideo>;
-}
+export { ScrcpyOptions2_4 as ScrcpyOptions2_5 } from "./2_4/index.js";

package/src/2_6/generate-type-tests.js

@@ -0,0 +1,119 @@
+/// <reference types="node" />
+
+import { writeFileSync } from "node:fs";
+import { format } from "prettier";
+
+let content = `
+// Generated by generate-type-tests.js. Do not edit manually.
+
+import type {ScrcpyOptions2_6} from "./options.js";
+
+type Equal<X, Y> =
+    (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2
+        ? true
+        : false;
+
+function expectTrue<T extends true>(value?: T) { void value; }
+
+`;
+
+const audioDupValues = ["true", "false", "undefined"];
+const audioSourceValues = [`"output"`, `"playback"`, `"mic"`, "undefined"];
+
+/**
+ * @param {string[]} values
+ */
+function* powerSetExceptEmpty(values) {
+    /**
+     * @param {number} start
+     * @param {string[]} combo
+     * @returns {Generator<string[], void, unknown>}
+     */
+    function* backtrack(start, combo) {
+        if (combo.length > 0) {
+            yield [...combo];
+        }
+
+        for (let i = start; i < values.length; i++) {
+            combo.push(values[i]);
+            yield* backtrack(i + 1, combo);
+            combo.pop();
+        }
+    }
+
+    yield* backtrack(0, []);
+}
+
+/**
+ *
+ * @param {string[]} audioDup
+ * @param {string[]} audioSource
+ * @param {string} expectedType
+ * @returns {string}
+ */
+function generateCase(audioDup, audioSource, expectedType) {
+    return `
+expectTrue<Equal<ScrcpyOptions2_6<{audioDup:${audioDup.join("|")}, audioSource:${audioSource.join("|")}}>["value"]["audioSource"], ${expectedType}>>();
+    `.trim();
+}
+
+for (const audioDup of powerSetExceptEmpty(audioDupValues)) {
+    content += `\n// #region audioDup: ${audioDup.join(" | ")}\n`;
+
+    for (const audioSource of powerSetExceptEmpty(audioSourceValues)) {
+        const willOverrideAudioSource =
+            audioDup.length === 1 && audioDup[0] === "true";
+        if (willOverrideAudioSource) {
+            content += generateCase(audioDup, audioSource, `"playback"`);
+            continue;
+        }
+
+        const mayOverrideAudioSource = audioDup.includes(`true`);
+        if (mayOverrideAudioSource) {
+            const expected = new Set([`"playback"`]);
+            for (const source of audioSource) {
+                switch (source) {
+                    case "undefined":
+                        // add default value
+                        expected.add(`"output"`);
+                        break;
+                    default:
+                        expected.add(source);
+                        break;
+                }
+            }
+
+            content += generateCase(
+                audioDup,
+                audioSource,
+                Array.from(expected).join("|"),
+            );
+            continue;
+        }
+
+        const expected = new Set();
+        for (const source of audioSource) {
+            switch (source) {
+                case "undefined":
+                    // add default value
+                    expected.add(`"output"`);
+                    break;
+                default:
+                    expected.add(source);
+                    break;
+            }
+        }
+
+        content += generateCase(
+            audioDup,
+            audioSource,
+            Array.from(expected).join("|"),
+        );
+    }
+
+    content += `\n// #endregion\n`;
+}
+
+content = await format(content, { parser: "typescript", tabWidth: 4 });
+
+writeFileSync(new URL("./type-tests.spec.ts", import.meta.url), content);

package/src/2_6/impl/compute-option-values.ts

@@ -0,0 +1,48 @@
+import { PrevImpl } from "./prev.js";
+
+// Distributive Conditional Types
+// (https://www.typescriptlang.org/docs/handbook/2/conditional-types.html#distributive-conditional-types)
+type ComputeAudioSource<TAudioDup, TAudioSource> = TAudioDup extends true
+    ? "playback"
+    : TAudioSource;
+
+export type OverrideAudioSource<T> = Omit<T, "audioSource"> & {
+    audioSource: ComputeAudioSource<
+        T extends { audioDup: infer TAudioDup } ? TAudioDup : never,
+        T extends { audioSource: infer TAudioSource } ? TAudioSource : never
+    >;
+};
+
+export type ComputeOptionTypes<
+    T extends object,
+    TDefaults extends object,
+> = OverrideAudioSource<PrevImpl.ComputeOptionTypes<T, TDefaults>>;
+
+export function overrideAudioSource<
+    T extends { audioDup: boolean; audioSource: string },
+>(value: T) {
+    if (value.audioDup) {
+        value.audioSource = "playback";
+    }
+}
+
+export function computeOptionValues<
+    T extends {
+        videoSource?: string | undefined;
+        control?: boolean | undefined;
+        clipboardAutosync?: boolean | undefined;
+        audioDup?: boolean | undefined;
+        audioSource?: string | undefined;
+    },
+    TDefaults extends {
+        videoSource: string;
+        control: boolean;
+        clipboardAutosync: boolean;
+        audioDup: boolean;
+        audioSource: string;
+    },
+>(options: T, defaults: TDefaults): ComputeOptionTypes<T, TDefaults> {
+    const value = PrevImpl.computeOptionValues(options, defaults);
+    overrideAudioSource(value as never);
+    return value as never;
+}

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

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

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

@@ -1,3 +1,12 @@
 export * from "../../2_4/impl/index.js";
+
+export {
+    computeOptionValues,
+    overrideAudioSource,
+} from "./compute-option-values.js";
+export type {
+    ComputeOptionTypes,
+    OverrideAudioSource,
+} from "./compute-option-values.js";
 export { Defaults } from "./defaults.js";
 export type { Init } from "./init.js";

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

@@ -1,7 +1,6 @@
 import type { PrevImpl } from "./prev.js";
 
-export interface Init<TVideo extends boolean>
-    extends Omit<PrevImpl.Init<TVideo>, "audioSource"> {
-    audioSource?: PrevImpl.Init<TVideo>["audioSource"] | "playback";
-    audioDup?: boolean;
+export interface Init extends Omit<PrevImpl.Init, "audioSource"> {
+    audioSource?: PrevImpl.Init["audioSource"] | "playback";
+    audioDup?: boolean | undefined;
 }