@yume-chan/scrcpy 0.0.24 → 1.0.0

package/src/{options/1_16/scroll.ts → 1_15/impl/scroll-controller.ts}

@@ -1,21 +1,25 @@
-import Struct from "@yume-chan/struct";
+import type { StructInit } from "@yume-chan/struct";
+import { s32, struct, u16, u32, u8 } from "@yume-chan/struct";
 
-import type { ScrcpyInjectScrollControlMessage } from "../../control/index.js";
+import type { ScrcpyScrollController } from "../../base/index.js";
+import type { ScrcpyInjectScrollControlMessage } from "../../latest.js";
 
-export interface ScrcpyScrollController {
-    serializeScrollMessage(
-        message: ScrcpyInjectScrollControlMessage,
-    ): Uint8Array | undefined;
-}
+export const InjectScrollControlMessage = struct(
+    {
+        type: u8,
+        pointerX: u32,
+        pointerY: u32,
+        screenWidth: u16,
+        screenHeight: u16,
+        scrollX: s32,
+        scrollY: s32,
+    },
+    { littleEndian: false },
+);
 
-export const ScrcpyInjectScrollControlMessage1_16 = new Struct()
-    .uint8("type")
-    .uint32("pointerX")
-    .uint32("pointerY")
-    .uint16("screenWidth")
-    .uint16("screenHeight")
-    .int32("scrollX")
-    .int32("scrollY");
+export type InjectScrollControlMessage = StructInit<
+    typeof InjectScrollControlMessage
+>;
 
 /**
  * Old version of Scrcpy server only supports integer values for scroll.
@@ -23,7 +27,7 @@ export const ScrcpyInjectScrollControlMessage1_16 = new Struct()
  * Accumulate scroll values and send scroll message when accumulated value
  * reaches 1 or -1.
  */
-export class ScrcpyScrollController1_16 implements ScrcpyScrollController {
+export class ScrollController implements ScrcpyScrollController {
     #accumulatedX = 0;
     #accumulatedY = 0;
 
@@ -68,6 +72,10 @@ export class ScrcpyScrollController1_16 implements ScrcpyScrollController {
             return undefined;
         }
 
-        return ScrcpyInjectScrollControlMessage1_16.serialize(processed);
+        return InjectScrollControlMessage.serialize(processed);
     }
 }
+
+export function createScrollController(): ScrcpyScrollController {
+    return new ScrollController();
+}

package/src/1_15/impl/serialize-order.ts

@@ -0,0 +1,17 @@
+import type { Init } from "./init.js";
+
+export const SerializeOrder = [
+    "logLevel",
+    "maxSize",
+    "bitRate",
+    "maxFps",
+    "lockVideoOrientation",
+    "tunnelForward",
+    "crop",
+    "sendFrameMeta",
+    "control",
+    "displayId",
+    "showTouches",
+    "stayAwake",
+    "codecOptions",
+] as const satisfies readonly (keyof Init)[];

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

@@ -0,0 +1,5 @@
+import { toScrcpyOptionValue } from "../../base/index.js";
+
+export function serialize<T>(options: T, order: readonly (keyof T)[]) {
+    return order.map((key) => toScrcpyOptionValue(options[key], "-"));
+}

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

@@ -0,0 +1,19 @@
+import type { StructInit } from "@yume-chan/struct";
+import { string, struct, u32, u8 } from "@yume-chan/struct";
+
+import type { ScrcpySetClipboardControlMessage } from "../../latest.js";
+
+export const SetClipboardControlMessage = struct(
+    { type: u8, content: string(u32) },
+    { littleEndian: false },
+);
+
+export type SetClipboardControlMessage = StructInit<
+    typeof SetClipboardControlMessage
+>;
+
+export function serializeSetClipboardControlMessage(
+    message: ScrcpySetClipboardControlMessage,
+): Uint8Array {
+    return SetClipboardControlMessage.serialize(message);
+}

package/src/1_15/impl/set-list-display.ts

@@ -0,0 +1,8 @@
+import type { Init } from "./init.js";
+
+export function setListDisplays(options: Pick<Init, "displayId">): void {
+    // Set to an invalid value
+    // Server will print valid values before crashing
+    // (server will crash before opening sockets)
+    options.displayId = -1;
+}

package/src/1_15/index.ts

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

package/src/1_15/options.ts

@@ -0,0 +1,129 @@
+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 {
+    ScrcpyControlMessageType,
+    ScrcpyDisplay,
+    ScrcpyMediaStreamPacket,
+    ScrcpyOptions,
+    ScrcpyScrollController,
+    ScrcpyVideoStream,
+} from "../base/index.js";
+import type {
+    ScrcpyBackOrScreenOnControlMessage,
+    ScrcpyInjectTouchControlMessage,
+    ScrcpySetClipboardControlMessage,
+} from "../latest.js";
+
+import type { Init } from "./impl/index.js";
+import {
+    ClipboardStream,
+    ControlMessageTypes,
+    createMediaStreamTransformer,
+    createScrollController,
+    Defaults,
+    parseDisplay,
+    parseVideoStreamMetadata,
+    serialize,
+    serializeBackOrScreenOnControlMessage,
+    serializeInjectTouchControlMessage,
+    SerializeOrder,
+    serializeSetClipboardControlMessage,
+    setListDisplays,
+} from "./impl/index.js";
+
+export class ScrcpyOptions1_15 implements ScrcpyOptions<Init> {
+    static readonly Defaults = Defaults;
+
+    readonly value: Required<Init>;
+
+    get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
+        return ControlMessageTypes;
+    }
+
+    #clipboard: ClipboardStream | undefined;
+    get clipboard(): ReadableStream<string> | undefined {
+        return this.#clipboard;
+    }
+
+    constructor(init: Init) {
+        this.value = { ...Defaults, ...init };
+
+        if (this.value.control) {
+            this.#clipboard = new ClipboardStream();
+        }
+    }
+
+    serialize(): string[] {
+        return serialize(this.value, SerializeOrder);
+    }
+
+    setListDisplays(): void {
+        setListDisplays(this.value);
+    }
+
+    parseDisplay(line: string): ScrcpyDisplay | undefined {
+        return parseDisplay(line);
+    }
+
+    parseVideoStreamMetadata(
+        stream: ReadableStream<Uint8Array>,
+    ): MaybePromiseLike<ScrcpyVideoStream> {
+        return parseVideoStreamMetadata(stream);
+    }
+
+    async parseDeviceMessage(
+        id: number,
+        stream: AsyncExactReadable,
+    ): Promise<void> {
+        if (await this.#clipboard!.parse(id, stream)) {
+            return;
+        }
+
+        throw new Error("Unknown device message");
+    }
+
+    endDeviceMessageStream(e?: unknown): void {
+        if (e) {
+            this.#clipboard!.error(e);
+        } else {
+            this.#clipboard!.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 {
+        return serializeSetClipboardControlMessage(message);
+    }
+
+    createScrollController(): ScrcpyScrollController {
+        return createScrollController();
+    }
+}
+
+type Init_ = Init;
+
+export namespace ScrcpyOptions1_15 {
+    export type Init = Init_;
+}

package/src/1_16.ts

@@ -0,0 +1,4 @@
+export {
+    ScrcpyOptions1_15 as ScrcpyOptions1_16,
+    ScrcpyOptions1_15Impl as ScrcpyOptions1_16Impl,
+} from "./1_15/index.js";

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

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

package/src/1_17/impl/index.ts

@@ -0,0 +1,6 @@
+export * from "../../1_15/impl/index.js";
+export { Defaults } from "./defaults.js";
+export type { Init } from "./init.js";
+export * from "./parse-encoder.js";
+export { SerializeOrder } from "./serialize-order.js";
+export * from "./set-list-encoder.js";

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

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

package/src/1_17/impl/parse-encoder.ts

@@ -0,0 +1,14 @@
+import type { ScrcpyEncoder } from "../../base/index.js";
+
+export function parseEncoder(
+    line: string,
+    encoderNameRegex: RegExp,
+): ScrcpyEncoder | undefined {
+    const match = line.match(encoderNameRegex);
+    if (match) {
+        return { type: "video", name: match[1]! };
+    }
+    return undefined;
+}
+
+export const EncoderRegex = /^\s+scrcpy --encoder-name '([^']+)'$/;

package/src/1_17/impl/prev.ts

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

package/src/1_17/impl/serialize-order.ts

@@ -0,0 +1,8 @@
+import type { Init } from "./init.js";
+import { PrevImpl } from "./prev.js";
+
+export const SerializeOrder = /* #__PURE__ */ (() =>
+    [
+        ...PrevImpl.SerializeOrder,
+        "encoderName",
+    ] as const satisfies readonly (keyof Init)[])();

package/src/1_17/impl/set-list-encoder.ts

@@ -0,0 +1,8 @@
+import type { Init } from "./init.js";
+
+export function setListEncoders(options: Pick<Init, "encoderName">): void {
+    // Set to an invalid value
+    // Server will print valid values before crashing
+    // (server will crash after opening video and control sockets)
+    options.encoderName = "_";
+}

package/src/1_17/index.ts

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

package/src/1_17/options.ts

@@ -0,0 +1,141 @@
+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 {
+    ScrcpyControlMessageType,
+    ScrcpyDisplay,
+    ScrcpyEncoder,
+    ScrcpyMediaStreamPacket,
+    ScrcpyOptions,
+    ScrcpyScrollController,
+    ScrcpyVideoStream,
+} from "../base/index.js";
+import type {
+    ScrcpyBackOrScreenOnControlMessage,
+    ScrcpyInjectTouchControlMessage,
+    ScrcpySetClipboardControlMessage,
+} from "../latest.js";
+
+import type { Init } from "./impl/index.js";
+import {
+    ClipboardStream,
+    ControlMessageTypes,
+    createMediaStreamTransformer,
+    createScrollController,
+    Defaults,
+    EncoderRegex,
+    parseDisplay,
+    parseEncoder,
+    parseVideoStreamMetadata,
+    serialize,
+    serializeBackOrScreenOnControlMessage,
+    serializeInjectTouchControlMessage,
+    SerializeOrder,
+    serializeSetClipboardControlMessage,
+    setListDisplays,
+    setListEncoders,
+} from "./impl/index.js";
+
+export class ScrcpyOptions1_17 implements ScrcpyOptions<Init> {
+    static readonly Defaults = Defaults;
+
+    readonly value: Required<Init>;
+
+    get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
+        return ControlMessageTypes;
+    }
+
+    #clipboard: ClipboardStream | undefined;
+    get clipboard(): ReadableStream<string> | undefined {
+        return this.#clipboard;
+    }
+
+    constructor(init: Init) {
+        this.value = { ...Defaults, ...init };
+
+        if (this.value.control) {
+            this.#clipboard = new ClipboardStream();
+        }
+    }
+
+    serialize(): string[] {
+        return serialize(this.value, SerializeOrder);
+    }
+
+    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, EncoderRegex);
+    }
+
+    parseVideoStreamMetadata(
+        stream: ReadableStream<Uint8Array>,
+    ): MaybePromiseLike<ScrcpyVideoStream> {
+        return parseVideoStreamMetadata(stream);
+    }
+
+    async parseDeviceMessage(
+        id: number,
+        stream: AsyncExactReadable,
+    ): Promise<void> {
+        if (await this.#clipboard!.parse(id, stream)) {
+            return;
+        }
+
+        throw new Error("Unknown device message");
+    }
+
+    endDeviceMessageStream(e?: unknown): void {
+        if (e) {
+            this.#clipboard!.error(e);
+        } else {
+            this.#clipboard!.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 {
+        return serializeSetClipboardControlMessage(message);
+    }
+
+    createScrollController(): ScrcpyScrollController {
+        return createScrollController();
+    }
+}
+
+type Init_ = Init;
+
+export namespace ScrcpyOptions1_17 {
+    export type Init = Init_;
+}

package/src/1_18/impl/back-or-screen-on.ts

@@ -0,0 +1,26 @@
+import type { StructInit } from "@yume-chan/struct";
+import { struct, u8 } from "@yume-chan/struct";
+
+import type { AndroidKeyEventAction } from "../../android/index.js";
+import type { ScrcpyBackOrScreenOnControlMessage } from "../../latest.js";
+
+import { PrevImpl } from "./prev.js";
+
+export const BackOrScreenOnControlMessage = /* #__PURE__ */ (() =>
+    struct(
+        {
+            ...PrevImpl.BackOrScreenOnControlMessage.fields,
+            action: u8<AndroidKeyEventAction>(),
+        },
+        { littleEndian: false },
+    ))();
+
+export type BackOrScreenOnControlMessage = StructInit<
+    typeof BackOrScreenOnControlMessage
+>;
+
+export function serializeBackOrScreenOnControlMessage(
+    message: ScrcpyBackOrScreenOnControlMessage,
+) {
+    return BackOrScreenOnControlMessage.serialize(message);
+}

package/src/1_18/impl/control-message-types.ts

@@ -0,0 +1,10 @@
+import { ScrcpyControlMessageType } from "../../base/index.js";
+
+import { PrevImpl } from "./prev.js";
+
+export const ControlMessageTypes: readonly ScrcpyControlMessageType[] =
+    /* #__PURE__ */ (() => {
+        const result = PrevImpl.ControlMessageTypes.slice();
+        result.splice(6, 0, ScrcpyControlMessageType.ExpandSettingPanel);
+        return result;
+    })();

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

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

package/src/1_18/impl/index.ts

@@ -0,0 +1,11 @@
+export * from "../../1_17/impl/index.js";
+export {
+    BackOrScreenOnControlMessage,
+    serializeBackOrScreenOnControlMessage,
+} from "./back-or-screen-on.js";
+export { ControlMessageTypes } from "./control-message-types.js";
+export { Defaults } from "./defaults.js";
+export { VideoOrientation } from "./init.js";
+export type { Init, LogLevel } from "./init.js";
+export { EncoderRegex } from "./parse-encoder.js";
+export { SerializeOrder } from "./serialize-order.js";

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

@@ -0,0 +1,24 @@
+import type { PrevImpl } from "./prev.js";
+
+export type LogLevel = "verbose" | "debug" | "info" | "warn" | "error";
+
+export const VideoOrientation = {
+    Initial: -2,
+    Unlocked: -1,
+    Portrait: 0,
+    Landscape: 1,
+    PortraitFlipped: 2,
+    LandscapeFlipped: 3,
+} as const;
+
+export type VideoOrientation =
+    (typeof VideoOrientation)[keyof typeof VideoOrientation];
+
+export interface Init
+    extends Omit<PrevImpl.Init, "logLevel" | "lockVideoOrientation"> {
+    logLevel?: LogLevel;
+
+    lockVideoOrientation?: VideoOrientation;
+
+    powerOffOnClose?: boolean;
+}

package/src/1_18/impl/parse-encoder.ts

@@ -0,0 +1 @@
+export const EncoderRegex = /^\s+scrcpy --encoder '([^']+)'$/;

package/src/1_18/impl/prev.ts

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

package/src/1_18/impl/serialize-order.ts

@@ -0,0 +1,8 @@
+import type { Init } from "./init.js";
+import { PrevImpl } from "./prev.js";
+
+export const SerializeOrder = /* #__PURE__ */ (() =>
+    [
+        ...PrevImpl.SerializeOrder,
+        "powerOffOnClose",
+    ] as const satisfies readonly (keyof Init)[])();

package/src/1_18/index.ts

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