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

package/src/3_0/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 ScrcpyOptions3_0<TVideo extends boolean>
-    implements ScrcpyOptions<Init<TVideo>>, ScrcpyOptionsListEncoders
+export class ScrcpyOptions3_0<TInit extends Init = Init>
+    implements
+        ScrcpyOptions<ScrcpyOptions3_0.Value<TInit>>,
+        ScrcpyOptionsListEncoders
 {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init<TVideo>>;
+    readonly value: ScrcpyOptions3_0.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,28 +88,20 @@ export class ScrcpyOptions3_0<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;
-        }
-
-        if (this.value.audioDup) {
-            this.value.audioSource = "playback";
-        }
+    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(),
             );
@@ -101,7 +109,7 @@ export class ScrcpyOptions3_0<TVideo extends boolean>
     }
 
     serialize(): string[] {
-        return serialize<Init<boolean>>(this.value, Defaults);
+        return serialize(this.value, Defaults);
     }
 
     setListDisplays(): void {
@@ -123,18 +131,29 @@ export class ScrcpyOptions3_0<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);
     }
@@ -142,36 +161,66 @@ export class ScrcpyOptions3_0<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 ScrcpyOptions3_0 {
-    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/3_0_1.ts

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

package/src/3_0_2.ts

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

package/src/3_1/impl/defaults.ts

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

package/src/3_1/impl/index.ts

@@ -1,4 +1,5 @@
 export * from "../../3_0/impl/index.js";
+
 export { Defaults } from "./defaults.js";
 export type { Init } from "./init.js";
 export {

package/src/3_1/impl/init.ts

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

package/src/3_1/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,
         vendorId: u16,

package/src/3_1/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 ScrcpyOptions3_1<TVideo extends boolean>
-    implements ScrcpyOptions<Init<TVideo>>, ScrcpyOptionsListEncoders
+export class ScrcpyOptions3_1<TInit extends Init = Init>
+    implements
+        ScrcpyOptions<ScrcpyOptions3_1.Value<TInit>>,
+        ScrcpyOptionsListEncoders
 {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init<TVideo>>;
+    readonly value: ScrcpyOptions3_1.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,28 +88,20 @@ export class ScrcpyOptions3_1<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;
-        }
-
-        if (this.value.audioDup) {
-            this.value.audioSource = "playback";
-        }
+    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(),
             );
@@ -101,7 +109,7 @@ export class ScrcpyOptions3_1<TVideo extends boolean>
     }
 
     serialize(): string[] {
-        return serialize<Init<boolean>>(this.value, Defaults);
+        return serialize(this.value, Defaults);
     }
 
     setListDisplays(): void {
@@ -123,18 +131,29 @@ export class ScrcpyOptions3_1<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);
     }
@@ -142,36 +161,66 @@ export class ScrcpyOptions3_1<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 ScrcpyOptions3_1 {
-    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/3_2/impl/defaults.ts

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

package/src/3_2/impl/index.ts

@@ -1,3 +1,4 @@
 export * from "../../3_1/impl/index.js";
+
 export { Defaults } from "./defaults.js";
 export type { Init } from "./init.js";

package/src/3_2/impl/init.ts

@@ -1,9 +1,8 @@
 import type { PrevImpl } from "./prev.js";
 
-export interface Init<TVideo extends boolean>
-    extends Omit<PrevImpl.Init<TVideo>, "audioSource"> {
+export interface Init extends Omit<PrevImpl.Init, "audioSource"> {
     audioSource?:
-        | PrevImpl.Init<TVideo>["audioSource"]
+        | PrevImpl.Init["audioSource"]
         | "mic-unprocessed"
         | "mic-camcorder"
         | "mic-voice-recognition"