@yume-chan/scrcpy 1.0.0 → 1.1.0

package/src/1_25/options.ts

@@ -39,6 +39,8 @@ import {
 export class ScrcpyOptions1_25 implements ScrcpyOptions<Init> {
     static readonly Defaults = Defaults;
 
+    readonly version: string;
+
     readonly value: Required<Init>;
 
     get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
@@ -52,8 +54,9 @@ export class ScrcpyOptions1_25 implements ScrcpyOptions<Init> {
 
     #ackClipboardHandler: AckClipboardHandler | undefined;
 
-    constructor(init: Init) {
+    constructor(init: Init, version = "1.25") {
         this.value = { ...Defaults, ...init };
+        this.version = version;
 
         if (this.value.control && this.value.clipboardAutosync) {
             this.#clipboard = new ClipboardStream();

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

@@ -1,23 +1,22 @@
 import { omit } from "../../utils/index.js";
 
 import type { Init } from "./init.js";
-import { InstanceId } from "./init.js";
 import { PrevImpl } from "./prev.js";
 
 export const Defaults = /* #__PURE__ */ (() =>
     ({
         ...omit(PrevImpl.Defaults, "bitRate", "codecOptions", "encoderName"),
-        scid: InstanceId.NONE,
+        scid: undefined,
 
         videoCodec: "h264",
         videoBitRate: 8000000,
-        videoCodecOptions: PrevImpl.CodecOptions.Empty,
+        videoCodecOptions: undefined,
         videoEncoder: undefined,
 
         audio: true,
         audioCodec: "opus",
         audioBitRate: 128000,
-        audioCodecOptions: PrevImpl.CodecOptions.Empty,
+        audioCodecOptions: undefined,
         audioEncoder: undefined,
 
         listEncoders: false,

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

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

package/src/2_0/options.ts

@@ -40,6 +40,8 @@ import {
 export class ScrcpyOptions2_0 implements ScrcpyOptions<Init> {
     static readonly Defaults = Defaults;
 
+    readonly version: string;
+
     readonly value: Required<Init>;
 
     get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
@@ -53,8 +55,9 @@ export class ScrcpyOptions2_0 implements ScrcpyOptions<Init> {
 
     #ackClipboardHandler: AckClipboardHandler | undefined;
 
-    constructor(init: Init) {
+    constructor(init: Init, version = "2.0") {
         this.value = { ...Defaults, ...init };
+        this.version = version;
 
         if (this.value.control && this.value.clipboardAutosync) {
             this.#clipboard = new ClipboardStream();

package/src/2_1/options.ts

@@ -40,6 +40,8 @@ import {
 export class ScrcpyOptions2_1 implements ScrcpyOptions<Init> {
     static readonly Defaults = Defaults;
 
+    readonly version: string;
+
     readonly value: Required<Init>;
 
     get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
@@ -53,8 +55,9 @@ export class ScrcpyOptions2_1 implements ScrcpyOptions<Init> {
 
     #ackClipboardHandler: AckClipboardHandler | undefined;
 
-    constructor(init: Init) {
+    constructor(init: Init, version = "2.1") {
         this.value = { ...Defaults, ...init };
+        this.version = version;
 
         if (this.value.control && this.value.clipboardAutosync) {
             this.#clipboard = new ClipboardStream();

package/src/2_1_1.ts

@@ -0,0 +1,9 @@
+import { ScrcpyOptions2_1 } from "./2_1/index.js";
+
+export class ScrcpyOptions2_1_1 extends ScrcpyOptions2_1 {
+    constructor(init: ScrcpyOptions2_1.Init, version = "2.1.1") {
+        super(init, version);
+    }
+}
+
+export { ScrcpyOptions2_1Impl as ScrcpyOptions2_1_1Impl } from "./2_1/index.js";

package/src/2_2/options.ts

@@ -40,6 +40,8 @@ import {
 export class ScrcpyOptions2_2 implements ScrcpyOptions<Init> {
     static readonly Defaults = Defaults;
 
+    readonly version: string;
+
     readonly value: Required<Init>;
 
     get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
@@ -53,8 +55,9 @@ export class ScrcpyOptions2_2 implements ScrcpyOptions<Init> {
 
     #ackClipboardHandler: AckClipboardHandler | undefined;
 
-    constructor(init: Init) {
+    constructor(init: Init, version = "v2.2") {
         this.value = { ...Defaults, ...init };
+        this.version = version;
 
         if (this.value.videoSource === "camera") {
             this.value.control = false;

package/src/2_3/options.ts

@@ -40,6 +40,8 @@ import {
 export class ScrcpyOptions2_3 implements ScrcpyOptions<Init> {
     static readonly Defaults = Defaults;
 
+    readonly version: string;
+
     readonly value: Required<Init>;
 
     get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
@@ -53,8 +55,9 @@ export class ScrcpyOptions2_3 implements ScrcpyOptions<Init> {
 
     #ackClipboardHandler: AckClipboardHandler | undefined;
 
-    constructor(init: Init) {
+    constructor(init: Init, version = "2.3") {
         this.value = { ...Defaults, ...init };
+        this.version = version;
 
         if (this.value.videoSource === "camera") {
             this.value.control = false;

package/src/2_3_1.ts

@@ -0,0 +1,9 @@
+import { ScrcpyOptions2_3 } from "./2_3/index.js";
+
+export class ScrcpyOptions2_3_1 extends ScrcpyOptions2_3 {
+    constructor(init: ScrcpyOptions2_3.Init, version = "2.3.1") {
+        super(init, version);
+    }
+}
+
+export { ScrcpyOptions2_3Impl as ScrcpyOptions2_3_1Impl } from "./2_3/index.js";

package/src/2_4/options.ts

@@ -44,6 +44,8 @@ import {
 export class ScrcpyOptions2_4 implements ScrcpyOptions<Init> {
     static readonly Defaults = Defaults;
 
+    readonly version: string;
+
     readonly value: Required<Init>;
 
     get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
@@ -64,8 +66,9 @@ export class ScrcpyOptions2_4 implements ScrcpyOptions<Init> {
         return this.#uHidOutput;
     }
 
-    constructor(init: Init) {
+    constructor(init: Init, version = "2.4") {
         this.value = { ...Defaults, ...init };
+        this.version = version;
 
         if (this.value.videoSource === "camera") {
             this.value.control = false;

package/src/2_5.ts

@@ -1,4 +1,9 @@
-export {
-    ScrcpyOptions2_4 as ScrcpyOptions2_5,
-    ScrcpyOptions2_4Impl as ScrcpyOptions2_5Impl,
-} from "./2_4/index.js";
+import { ScrcpyOptions2_4 } from "./2_4/index.js";
+
+export class ScrcpyOptions2_5 extends ScrcpyOptions2_4 {
+    constructor(init: ScrcpyOptions2_4.Init, version = "2.5") {
+        super(init, version);
+    }
+}
+
+export { ScrcpyOptions2_4Impl as ScrcpyOptions2_5Impl } from "./2_4/index.js";

package/src/2_6/options.ts

@@ -20,6 +20,7 @@ import type {
     ScrcpyUHidOutputDeviceMessage,
 } from "../latest.js";
 
+import type { Init } from "./impl/index.js";
 import {
     AckClipboardHandler,
     ClipboardStream,
@@ -39,11 +40,12 @@ import {
     setListEncoders,
     UHidOutputStream,
 } from "./impl/index.js";
-import type { Init } from "./impl/index.js";
 
 export class ScrcpyOptions2_6 implements ScrcpyOptions<Init> {
     static readonly Defaults = Defaults;
 
+    readonly version: string;
+
     readonly value: Required<Init>;
 
     get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
@@ -64,8 +66,9 @@ export class ScrcpyOptions2_6 implements ScrcpyOptions<Init> {
         return this.#uHidOutput;
     }
 
-    constructor(init: Init) {
+    constructor(init: Init, version = "2.6") {
         this.value = { ...Defaults, ...init };
+        this.version = version;
 
         if (this.value.videoSource === "camera") {
             this.value.control = false;

package/src/2_6_1.ts

@@ -0,0 +1,9 @@
+import { ScrcpyOptions2_6 } from "./2_6/index.js";
+
+export class ScrcpyOptions2_6_1 extends ScrcpyOptions2_6 {
+    constructor(init: ScrcpyOptions2_6.Init, version = "2.6.1") {
+        super(init, version);
+    }
+}
+
+export { ScrcpyOptions2_6Impl as ScrcpyOptions2_6_1Impl } from "./2_6/index.js";

package/src/2_7/options.ts

@@ -44,6 +44,8 @@ import {
 export class ScrcpyOptions2_7 implements ScrcpyOptions<Init> {
     static readonly Defaults = Defaults;
 
+    readonly version: string;
+
     readonly value: Required<Init>;
 
     get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
@@ -64,8 +66,9 @@ export class ScrcpyOptions2_7 implements ScrcpyOptions<Init> {
         return this.#uHidOutput;
     }
 
-    constructor(init: Init) {
+    constructor(init: Init, version = "2.7") {
         this.value = { ...Defaults, ...init };
+        this.version = version;
 
         if (this.value.videoSource === "camera") {
             this.value.control = false;

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

@@ -1,13 +1,12 @@
 import { omit } from "../../utils/index.js";
 
 import type { Init } from "./init.js";
-import { CaptureOrientation } from "./init.js";
 import { PrevImpl } from "./prev.js";
 
 export const Defaults = /* #__PURE__ */ (() =>
     ({
         ...omit(PrevImpl.Defaults, "lockVideoOrientation"),
-        captureOrientation: CaptureOrientation.Unlocked,
+        captureOrientation: undefined,
         angle: 0,
         screenOffTimeout: undefined,
         listApps: false,

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

@@ -107,7 +107,7 @@ export class NewDisplay implements ScrcpyOptionValue {
 }
 
 export interface Init extends Omit<PrevImpl.Init, "lockVideoOrientation"> {
-    captureOrientation?: CaptureOrientation;
+    captureOrientation?: CaptureOrientation | string | undefined;
     angle?: number;
     screenOffTimeout?: number | undefined;
 
@@ -116,6 +116,6 @@ export interface Init extends Omit<PrevImpl.Init, "lockVideoOrientation"> {
     // `display_id` and `new_display` can't be specified at the same time
     // but `serialize` method will exclude options that are same as the default value
     // so `displayId: 0` will be ignored
-    newDisplay?: NewDisplay | undefined;
+    newDisplay?: NewDisplay | string | undefined;
     vdSystemDecorations?: boolean;
 }

package/src/3_0/options.ts

@@ -44,6 +44,8 @@ import {
 export class ScrcpyOptions3_0 implements ScrcpyOptions<Init> {
     static readonly Defaults = Defaults;
 
+    readonly version: string;
+
     readonly value: Required<Init>;
 
     get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
@@ -64,8 +66,9 @@ export class ScrcpyOptions3_0 implements ScrcpyOptions<Init> {
         return this.#uHidOutput;
     }
 
-    constructor(init: Init) {
+    constructor(init: Init, version = "3.0") {
         this.value = { ...Defaults, ...init };
+        this.version = version;
 
         if (this.value.videoSource === "camera") {
             this.value.control = false;

package/src/3_0_1.ts

@@ -0,0 +1,9 @@
+import { ScrcpyOptions3_0 } from "./3_0/index.js";
+
+export class ScrcpyOptions3_0_1 extends ScrcpyOptions3_0 {
+    constructor(init: ScrcpyOptions3_0.Init, version = "3.0.1") {
+        super(init, version);
+    }
+}
+
+export { ScrcpyOptions3_0Impl as ScrcpyOptions3_0_1Impl } from "./3_0/index.js";

package/src/3_0_2.ts

@@ -0,0 +1,9 @@
+import { ScrcpyOptions3_0 } from "./3_0/index.js";
+
+export class ScrcpyOptions3_0_2 extends ScrcpyOptions3_0 {
+    constructor(init: ScrcpyOptions3_0.Init, version = "3.0.2") {
+        super(init, version);
+    }
+}
+
+export { ScrcpyOptions3_0Impl as ScrcpyOptions3_0_2Impl } from "./3_0/index.js";

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

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

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

@@ -0,0 +1,7 @@
+export * from "../../3_0/impl/index.js";
+export { Defaults } from "./defaults.js";
+export type { Init } from "./init.js";
+export {
+    serializeUHidCreateControlMessage,
+    UHidCreateControlMessage,
+} from "./serialize-uhid-create.js";

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

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

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

@@ -0,0 +1 @@
+export * as PrevImpl from "../../3_0/impl/index.js";

package/src/3_1/impl/serialize-uhid-create.ts

@@ -0,0 +1,28 @@
+import type { StructInit } from "@yume-chan/struct";
+import { buffer, string, struct, u16, u8 } from "@yume-chan/struct";
+
+import { ScrcpyControlMessageType } from "../../base/control-message-type.js";
+import type { ScrcpyUHidCreateControlMessage } from "../../latest.js";
+
+export const UHidCreateControlMessage = /* #__PURE__ */ (() =>
+    struct(
+        {
+            type: u8(ScrcpyControlMessageType.UHidCreate),
+            id: u16,
+            vendorId: u16,
+            productId: u16,
+            name: string(u8),
+            data: buffer(u16),
+        },
+        { littleEndian: false },
+    ))();
+
+export type UHidCreateControlMessage = StructInit<
+    typeof UHidCreateControlMessage
+>;
+
+export function serializeUHidCreateControlMessage(
+    message: ScrcpyUHidCreateControlMessage,
+) {
+    return UHidCreateControlMessage.serialize(message);
+}

package/src/3_1/index.ts

@@ -0,0 +1,2 @@
+export * as ScrcpyOptions3_1Impl from "./impl/index.js";
+export * from "./options.js";

package/src/3_1/options.ts

@@ -0,0 +1,190 @@
+import type { MaybePromiseLike } from "@yume-chan/async";
+import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
+import type { AsyncExactReadable } from "@yume-chan/struct";
+
+import type {
+    ScrcpyAudioStreamMetadata,
+    ScrcpyControlMessageType,
+    ScrcpyDisplay,
+    ScrcpyEncoder,
+    ScrcpyMediaStreamPacket,
+    ScrcpyOptions,
+    ScrcpyScrollController,
+    ScrcpyVideoStream,
+} from "../base/index.js";
+import type {
+    ScrcpyBackOrScreenOnControlMessage,
+    ScrcpyInjectTouchControlMessage,
+    ScrcpySetClipboardControlMessage,
+    ScrcpyUHidCreateControlMessage,
+    ScrcpyUHidOutputDeviceMessage,
+} from "../latest.js";
+
+import type { Init } from "./impl/index.js";
+import {
+    AckClipboardHandler,
+    ClipboardStream,
+    ControlMessageTypes,
+    createMediaStreamTransformer,
+    createScrollController,
+    Defaults,
+    parseAudioStreamMetadata,
+    parseDisplay,
+    parseEncoder,
+    parseVideoStreamMetadata,
+    serialize,
+    serializeBackOrScreenOnControlMessage,
+    serializeInjectTouchControlMessage,
+    serializeUHidCreateControlMessage,
+    setListDisplays,
+    setListEncoders,
+    UHidOutputStream,
+} from "./impl/index.js";
+
+export class ScrcpyOptions3_1 implements ScrcpyOptions<Init> {
+    static readonly Defaults = Defaults;
+
+    readonly version: string;
+
+    readonly value: Required<Init>;
+
+    get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
+        return ControlMessageTypes;
+    }
+
+    #clipboard: ClipboardStream | undefined;
+    get clipboard(): ReadableStream<string> | undefined {
+        return this.#clipboard;
+    }
+
+    #ackClipboardHandler: AckClipboardHandler | undefined;
+
+    #uHidOutput: UHidOutputStream | undefined;
+    get uHidOutput():
+        | ReadableStream<ScrcpyUHidOutputDeviceMessage>
+        | undefined {
+        return this.#uHidOutput;
+    }
+
+    constructor(init: Init, version = "3.1") {
+        this.value = { ...Defaults, ...init };
+        this.version = version;
+
+        if (this.value.videoSource === "camera") {
+            this.value.control = false;
+        }
+
+        if (this.value.audioDup) {
+            this.value.audioSource = "playback";
+        }
+
+        if (this.value.control) {
+            if (this.value.clipboardAutosync) {
+                this.#clipboard = new ClipboardStream();
+                this.#ackClipboardHandler = new AckClipboardHandler();
+            }
+
+            this.#uHidOutput = new UHidOutputStream();
+        }
+    }
+
+    serialize(): string[] {
+        return serialize(this.value, Defaults);
+    }
+
+    setListDisplays(): void {
+        setListDisplays(this.value);
+    }
+
+    parseDisplay(line: string): ScrcpyDisplay | undefined {
+        return parseDisplay(line);
+    }
+
+    setListEncoders() {
+        setListEncoders(this.value);
+    }
+
+    parseEncoder(line: string): ScrcpyEncoder | undefined {
+        return parseEncoder(line);
+    }
+
+    parseVideoStreamMetadata(
+        stream: ReadableStream<Uint8Array>,
+    ): MaybePromiseLike<ScrcpyVideoStream> {
+        return parseVideoStreamMetadata(this.value, stream);
+    }
+
+    parseAudioStreamMetadata(
+        stream: ReadableStream<Uint8Array>,
+    ): MaybePromiseLike<ScrcpyAudioStreamMetadata> {
+        return parseAudioStreamMetadata(stream, this.value);
+    }
+
+    async parseDeviceMessage(
+        id: number,
+        stream: AsyncExactReadable,
+    ): Promise<void> {
+        if (await this.#clipboard?.parse(id, stream)) {
+            return;
+        }
+
+        if (await this.#ackClipboardHandler?.parse(id, stream)) {
+            return;
+        }
+
+        throw new Error("Unknown device message");
+    }
+
+    endDeviceMessageStream(e?: unknown): void {
+        if (e) {
+            this.#clipboard?.error(e);
+            this.#ackClipboardHandler?.error(e);
+        } else {
+            this.#clipboard?.close();
+            this.#ackClipboardHandler?.close();
+        }
+    }
+
+    createMediaStreamTransformer(): TransformStream<
+        Uint8Array,
+        ScrcpyMediaStreamPacket
+    > {
+        return createMediaStreamTransformer(this.value);
+    }
+
+    serializeInjectTouchControlMessage(
+        message: ScrcpyInjectTouchControlMessage,
+    ): Uint8Array {
+        return serializeInjectTouchControlMessage(message);
+    }
+
+    serializeBackOrScreenOnControlMessage(
+        message: ScrcpyBackOrScreenOnControlMessage,
+    ): Uint8Array | undefined {
+        return serializeBackOrScreenOnControlMessage(message);
+    }
+
+    serializeSetClipboardControlMessage(
+        message: ScrcpySetClipboardControlMessage,
+    ): Uint8Array | [Uint8Array, Promise<void>] {
+        return this.#ackClipboardHandler!.serializeSetClipboardControlMessage(
+            message,
+        );
+    }
+
+    createScrollController(): ScrcpyScrollController {
+        return createScrollController();
+    }
+
+    serializeUHidCreateControlMessage(
+        message: ScrcpyUHidCreateControlMessage,
+    ): Uint8Array {
+        return serializeUHidCreateControlMessage(message);
+    }
+}
+
+type Init_ = Init;
+
+export namespace ScrcpyOptions3_1 {
+    export type Init = Init_;
+}

package/src/base/option-value.ts

@@ -28,8 +28,8 @@ export function toScrcpyOptionValue<T>(value: unknown, empty: T): string | T {
         typeof value !== "number" &&
         typeof value !== "boolean"
     ) {
-        throw new TypeError(`Invalid option value: ${String(value)}`);
+        throw new TypeError(`Invalid option value: ${JSON.stringify(value)}`);
     }
 
-    return String(value);
+    return value.toString();
 }

package/src/base/options.ts

@@ -19,6 +19,8 @@ import type { ScrcpyScrollController } from "./scroll-controller.js";
 import type { ScrcpyVideoStream } from "./video.js";
 
 export interface ScrcpyOptions<T extends object> {
+    get version(): string;
+
     get controlMessageTypes(): readonly ScrcpyControlMessageType[];
 
     value: Required<T>;

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from "./1_15/index.js";
+export * from "./1_15_1.js";
 export * from "./1_16.js";
 export * from "./1_17/index.js";
 export * from "./1_18/index.js";
@@ -11,13 +12,19 @@ export * from "./1_24/index.js";
 export * from "./1_25/index.js";
 export * from "./2_0/index.js";
 export * from "./2_1/index.js";
+export * from "./2_1_1.js";
 export * from "./2_2/index.js";
 export * from "./2_3/index.js";
+export * from "./2_3_1.js";
 export * from "./2_4/index.js";
 export * from "./2_5.js";
 export * from "./2_6/index.js";
+export * from "./2_6_1.js";
 export * from "./2_7/index.js";
 export * from "./3_0/index.js";
+export * from "./3_0_1.js";
+export * from "./3_0_2.js";
+export * from "./3_1/index.js";
 export * from "./android/index.js";
 export * from "./base/index.js";
 export * from "./codec/index.js";