@yume-chan/scrcpy 0.0.19 → 0.0.21

package/src/options/1_18.ts

@@ -6,67 +6,131 @@ import type {
 } from "../control/index.js";
 import { ScrcpyControlMessageType } from "../control/index.js";
 
-import type { ScrcpyOptionsInit1_16 } from "./1_16/options.js";
 import {
+    SCRCPY_CONTROL_MESSAGE_TYPES_1_16,
     ScrcpyBackOrScreenOnControlMessage1_16,
+    ScrcpyLogLevel1_16,
     ScrcpyOptions1_16,
-} from "./1_16/options.js";
+    ScrcpyVideoOrientation1_16,
+} from "./1_16/index.js";
+import type { ScrcpyOptionsInit1_17 } from "./1_17.js";
+import { ScrcpyOptions1_17 } from "./1_17.js";
+import type { ScrcpyEncoder } from "./types.js";
+import { ScrcpyOptionsBase } from "./types.js";
 
-export interface ScrcpyOptionsInit1_18 extends ScrcpyOptionsInit1_16 {
-    powerOffOnClose: boolean;
+export enum ScrcpyLogLevel1_18 {
+    Verbose = "verbose",
+    Debug = "debug",
+    Info = "info",
+    Warn = "warn",
+    Error = "error",
+}
+
+export enum ScrcpyVideoOrientation1_18 {
+    Initial = -2,
+    Unlocked = -1,
+    Portrait = 0,
+    Landscape = 1,
+    PortraitFlipped = 2,
+    LandscapeFlipped = 3,
+}
+
+export interface ScrcpyOptionsInit1_18
+    extends Omit<ScrcpyOptionsInit1_17, "logLevel" | "lockVideoOrientation"> {
+    logLevel?: ScrcpyLogLevel1_18;
+
+    lockVideoOrientation?: ScrcpyVideoOrientation1_18;
+
+    powerOffOnClose?: boolean;
 }
 
 export const ScrcpyBackOrScreenOnControlMessage1_18 = new Struct()
-    .fields(ScrcpyBackOrScreenOnControlMessage1_16)
+    .concat(ScrcpyBackOrScreenOnControlMessage1_16)
     .uint8("action", placeholder<AndroidKeyEventAction>());
 
 export type ScrcpyBackOrScreenOnControlMessage1_18 =
     (typeof ScrcpyBackOrScreenOnControlMessage1_18)["TInit"];
 
-export class ScrcpyOptions1_18<
-    T extends ScrcpyOptionsInit1_18 = ScrcpyOptionsInit1_18
-> extends ScrcpyOptions1_16<T> {
-    constructor(value: Partial<ScrcpyOptionsInit1_18>) {
-        super(value);
+export const SCRCPY_CONTROL_MESSAGE_TYPES_1_18 =
+    SCRCPY_CONTROL_MESSAGE_TYPES_1_16.slice();
+SCRCPY_CONTROL_MESSAGE_TYPES_1_18.splice(
+    6,
+    0,
+    ScrcpyControlMessageType.ExpandSettingPanel,
+);
+
+const LOG_LEVEL_MAP = {
+    [ScrcpyLogLevel1_18.Verbose]: ScrcpyLogLevel1_16.Debug,
+    [ScrcpyLogLevel1_18.Debug]: ScrcpyLogLevel1_16.Debug,
+    [ScrcpyLogLevel1_18.Info]: ScrcpyLogLevel1_16.Info,
+    [ScrcpyLogLevel1_18.Warn]: ScrcpyLogLevel1_16.Warn,
+    [ScrcpyLogLevel1_18.Error]: ScrcpyLogLevel1_16.Error,
+};
+
+const VIDEO_ORIENTATION_MAP = {
+    [ScrcpyVideoOrientation1_18.Initial]: ScrcpyVideoOrientation1_16.Unlocked,
+    [ScrcpyVideoOrientation1_18.Unlocked]: ScrcpyVideoOrientation1_16.Unlocked,
+    [ScrcpyVideoOrientation1_18.Portrait]: ScrcpyVideoOrientation1_16.Portrait,
+    [ScrcpyVideoOrientation1_18.Landscape]:
+        ScrcpyVideoOrientation1_16.Landscape,
+    [ScrcpyVideoOrientation1_18.PortraitFlipped]:
+        ScrcpyVideoOrientation1_16.PortraitFlipped,
+    [ScrcpyVideoOrientation1_18.LandscapeFlipped]:
+        ScrcpyVideoOrientation1_16.LandscapeFlipped,
+};
+export class ScrcpyOptions1_18 extends ScrcpyOptionsBase<
+    ScrcpyOptionsInit1_18,
+    ScrcpyOptions1_17
+> {
+    static readonly DEFAULTS = {
+        ...ScrcpyOptions1_17.DEFAULTS,
+        logLevel: ScrcpyLogLevel1_18.Debug,
+        lockVideoOrientation: ScrcpyVideoOrientation1_18.Unlocked,
+        powerOffOnClose: false,
+    } as const satisfies Required<ScrcpyOptionsInit1_18>;
+
+    static readonly SERIALIZE_ORDER = [
+        ...ScrcpyOptions1_17.SERIALIZE_ORDER,
+        "powerOffOnClose",
+    ] as const satisfies readonly (keyof ScrcpyOptionsInit1_18)[];
+
+    override get defaults(): Required<ScrcpyOptionsInit1_18> {
+        return ScrcpyOptions1_18.DEFAULTS;
     }
 
-    protected override getArgumentOrder(): (keyof T)[] {
-        return super.getArgumentOrder().concat(["powerOffOnClose"]);
+    override get controlMessageTypes() {
+        return SCRCPY_CONTROL_MESSAGE_TYPES_1_18;
     }
 
-    public override getDefaultValue(): T {
-        return {
-            ...super.getDefaultValue(),
-            powerOffOnClose: false,
-        };
+    constructor(init: ScrcpyOptionsInit1_18) {
+        const value = { ...ScrcpyOptions1_18.DEFAULTS, ...init };
+        super(
+            new ScrcpyOptions1_17({
+                ...init,
+                logLevel: LOG_LEVEL_MAP[value.logLevel],
+                lockVideoOrientation:
+                    VIDEO_ORIENTATION_MAP[value.lockVideoOrientation],
+            }),
+            value,
+        );
     }
 
-    public override getOutputEncoderNameRegex(): RegExp {
-        return /\s+scrcpy --encoder '(.*?)'/;
+    override serialize(): string[] {
+        return ScrcpyOptions1_16.serialize(
+            this.value,
+            ScrcpyOptions1_18.SERIALIZE_ORDER,
+        );
     }
 
-    public override getControlMessageTypes(): ScrcpyControlMessageType[] {
-        /**
-         *  0 InjectKeycode
-         *  1 InjectText
-         *  2 InjectTouch
-         *  3 InjectScroll
-         *  4 BackOrScreenOn
-         *  5 ExpandNotificationPanel
-         *  6 ExpandSettingsPanel
-         *  7 CollapseNotificationPanel
-         *  8 GetClipboard
-         *  9 SetClipboard
-         * 10 SetScreenPowerMode
-         * 11 RotateDevice
-         */
-        const types = super.getControlMessageTypes();
-        types.splice(6, 0, ScrcpyControlMessageType.ExpandSettingPanel);
-        return types;
+    override parseEncoder(line: string): ScrcpyEncoder | undefined {
+        return ScrcpyOptions1_17.parseEncoder(
+            line,
+            /\s+scrcpy --encoder '(.*?)'/,
+        );
     }
 
-    public override serializeBackOrScreenOnControlMessage(
-        message: ScrcpyBackOrScreenOnControlMessage
+    override serializeBackOrScreenOnControlMessage(
+        message: ScrcpyBackOrScreenOnControlMessage,
     ) {
         return ScrcpyBackOrScreenOnControlMessage1_18.serialize(message);
     }

package/src/options/1_21.ts

@@ -1,13 +1,12 @@
 // cspell: ignore autosync
 
-import Struct from "@yume-chan/struct";
+import Struct, { placeholder } from "@yume-chan/struct";
 
 import type { ScrcpySetClipboardControlMessage } from "../control/index.js";
-import { ScrcpyControlMessageType } from "../control/index.js";
 
 import type { ScrcpyOptionsInit1_18 } from "./1_18.js";
 import { ScrcpyOptions1_18 } from "./1_18.js";
-import { toScrcpyOptionValue } from "./types.js";
+import { ScrcpyOptionsBase, toScrcpyOptionValue } from "./types.js";
 
 export interface ScrcpyOptionsInit1_21 extends ScrcpyOptionsInit1_18 {
     clipboardAutosync?: boolean;
@@ -18,43 +17,66 @@ function toSnakeCase(input: string): string {
 }
 
 export const ScrcpySetClipboardControlMessage1_21 = new Struct()
-    .uint8("type", ScrcpyControlMessageType.SetClipboard as const)
+    .uint8("type")
     .uint64("sequence")
-    .int8("paste")
+    .int8("paste", placeholder<boolean>())
     .uint32("length")
     .string("content", { lengthField: "length" });
 
 export type ScrcpySetClipboardControlMessage1_21 =
     (typeof ScrcpySetClipboardControlMessage1_21)["TInit"];
 
-export class ScrcpyOptions1_21<
-    T extends ScrcpyOptionsInit1_21 = ScrcpyOptionsInit1_21
-> extends ScrcpyOptions1_18<T> {
-    public constructor(init: Partial<ScrcpyOptionsInit1_21>) {
-        super(init);
+export class ScrcpyOptions1_21 extends ScrcpyOptionsBase<
+    ScrcpyOptionsInit1_21,
+    ScrcpyOptions1_18
+> {
+    static readonly DEFAULTS = {
+        ...ScrcpyOptions1_18.DEFAULTS,
+        clipboardAutosync: true,
+    } as const satisfies Required<ScrcpyOptionsInit1_21>;
+
+    static serialize<T extends object>(
+        options: T,
+        defaults: Required<T>,
+    ): string[] {
+        // 1.21 changed the format of arguments
+        const result: string[] = [];
+        for (const [key, value] of Object.entries(options)) {
+            const serializedValue = toScrcpyOptionValue(value, undefined);
+            if (!serializedValue) {
+                continue;
+            }
+
+            const defaultValue = toScrcpyOptionValue(
+                defaults[key as keyof T],
+                undefined,
+            );
+            if (serializedValue == defaultValue) {
+                continue;
+            }
+
+            result.push(`${toSnakeCase(key)}=${serializedValue}`);
+        }
+        return result;
     }
 
-    public override getDefaultValue(): T {
-        return {
-            ...super.getDefaultValue(),
-            clipboardAutosync: true,
-        };
+    override get defaults(): Required<ScrcpyOptionsInit1_21> {
+        return ScrcpyOptions1_21.DEFAULTS;
     }
 
-    public override formatServerArguments(): string[] {
-        // 1.21 changed the format of arguments
-        // So `getArgumentOrder()` is no longer needed
-        return Object.entries(this.value)
-            .map(
-                ([key, value]) =>
-                    [key, toScrcpyOptionValue(value, undefined)] as const
-            )
-            .filter((pair): pair is [string, string] => pair[1] !== undefined)
-            .map(([key, value]) => `${toSnakeCase(key)}=${value}`);
+    constructor(init: ScrcpyOptionsInit1_21) {
+        super(new ScrcpyOptions1_18(init), {
+            ...ScrcpyOptions1_21.DEFAULTS,
+            ...init,
+        });
+    }
+
+    override serialize(): string[] {
+        return ScrcpyOptions1_21.serialize(this.value, this.defaults);
     }
 
-    public override serializeSetClipboardControlMessage(
-        message: ScrcpySetClipboardControlMessage
+    override serializeSetClipboardControlMessage(
+        message: ScrcpySetClipboardControlMessage,
     ): Uint8Array {
         return ScrcpySetClipboardControlMessage1_21.serialize(message);
     }

package/src/options/1_22/index.ts

@@ -1,2 +1,3 @@
+export * from "./init.js";
 export * from "./options.js";
 export * from "./scroll.js";

package/src/options/1_22/init.ts

@@ -0,0 +1,19 @@
+import type { ScrcpyOptionsInit1_21 } from "../1_21.js";
+
+export interface ScrcpyOptionsInit1_22 extends ScrcpyOptionsInit1_21 {
+    downsizeOnError?: boolean;
+
+    /**
+     * Send device name and size at start of video stream.
+     *
+     * @default true
+     */
+    sendDeviceMeta?: boolean;
+
+    /**
+     * Send a `0` byte on start of video stream to detect connection issues
+     *
+     * @default true
+     */
+    sendDummyByte?: boolean;
+}

package/src/options/1_22/options.ts

@@ -1,59 +1,52 @@
+import type { ReadableStream } from "@yume-chan/stream-extra";
+import type { ValueOrPromise } from "@yume-chan/struct";
+
 import type { ScrcpyScrollController } from "../1_16/index.js";
-import type { ScrcpyOptionsInit1_21 } from "../1_21.js";
 import { ScrcpyOptions1_21 } from "../1_21.js";
+import type { ScrcpyVideoStream } from "../codec.js";
+import { ScrcpyVideoCodecId } from "../codec.js";
+import { ScrcpyOptionsBase } from "../types.js";
 
+import type { ScrcpyOptionsInit1_22 } from "./init.js";
 import { ScrcpyScrollController1_22 } from "./scroll.js";
 
-export interface ScrcpyOptionsInit1_22 extends ScrcpyOptionsInit1_21 {
-    downsizeOnError: boolean;
-
-    /**
-     * Send device name and size at start of video stream.
-     *
-     * @default true
-     */
-    sendDeviceMeta: boolean;
-
-    /**
-     * Send a `0` byte on start of video stream to detect connection issues
-     *
-     * @default true
-     */
-    sendDummyByte: boolean;
-
-    /**
-     * Implies `sendDeviceMeta: false`, `sendFrameMeta: false` and `sendDummyByte: false`
-     *
-     * @default false
-     */
-    rawVideoStream: boolean;
-}
+export class ScrcpyOptions1_22 extends ScrcpyOptionsBase<
+    ScrcpyOptionsInit1_22,
+    ScrcpyOptions1_21
+> {
+    static readonly DEFAULTS = {
+        ...ScrcpyOptions1_21.DEFAULTS,
+        downsizeOnError: true,
+        sendDeviceMeta: true,
+        sendDummyByte: true,
+    } as const satisfies Required<ScrcpyOptionsInit1_22>;
+
+    override get defaults(): Required<ScrcpyOptionsInit1_22> {
+        return ScrcpyOptions1_22.DEFAULTS;
+    }
 
-export class ScrcpyOptions1_22<
-    T extends ScrcpyOptionsInit1_22 = ScrcpyOptionsInit1_22
-> extends ScrcpyOptions1_21<T> {
-    public constructor(init: Partial<ScrcpyOptionsInit1_22>) {
-        if (init.rawVideoStream) {
-            // Set implied options for client-side processing
-            init.sendDeviceMeta = false;
-            init.sendFrameMeta = false;
-            init.sendDummyByte = false;
-        }
+    constructor(init: ScrcpyOptionsInit1_22) {
+        super(new ScrcpyOptions1_21(init), {
+            ...ScrcpyOptions1_22.DEFAULTS,
+            ...init,
+        });
+    }
 
-        super(init);
+    override parseVideoStreamMetadata(
+        stream: ReadableStream<Uint8Array>,
+    ): ValueOrPromise<ScrcpyVideoStream> {
+        if (!this.value.sendDeviceMeta) {
+            return { stream, metadata: { codec: ScrcpyVideoCodecId.H264 } };
+        } else {
+            return this._base.parseVideoStreamMetadata(stream);
+        }
     }
 
-    public override getDefaultValue(): T {
-        return {
-            ...super.getDefaultValue(),
-            downsizeOnError: true,
-            sendDeviceMeta: true,
-            sendDummyByte: true,
-            rawVideoStream: false,
-        };
+    override serialize(): string[] {
+        return ScrcpyOptions1_21.serialize(this.value, this.defaults);
     }
 
-    public override getScrollController(): ScrcpyScrollController {
+    override createScrollController(): ScrcpyScrollController {
         return new ScrcpyScrollController1_22();
     }
 }

package/src/options/1_22/scroll.ts

@@ -6,15 +6,15 @@ import {
 } from "../1_16/index.js";
 
 export const ScrcpyInjectScrollControlMessage1_22 = new Struct()
-    .fields(ScrcpyInjectScrollControlMessage1_16)
+    .concat(ScrcpyInjectScrollControlMessage1_16)
     .int32("buttons");
 
 export type ScrcpyInjectScrollControlMessage1_22 =
     (typeof ScrcpyInjectScrollControlMessage1_22)["TInit"];
 
 export class ScrcpyScrollController1_22 extends ScrcpyScrollController1_16 {
-    public override serializeScrollMessage(
-        message: ScrcpyInjectScrollControlMessage1_22
+    override serializeScrollMessage(
+        message: ScrcpyInjectScrollControlMessage1_22,
     ): Uint8Array | undefined {
         const processed = this.processMessage(message);
         if (!processed) {

package/src/options/1_23.ts

@@ -1,40 +1,52 @@
 import { TransformStream } from "@yume-chan/stream-extra";
 
-import type { ScrcpyOptionsInit1_22 } from "./1_22/options.js";
-import { ScrcpyOptions1_22 } from "./1_22/options.js";
-import type { ScrcpyVideoStreamPacket } from "./types.js";
+import { ScrcpyOptions1_21 } from "./1_21.js";
+import type { ScrcpyOptionsInit1_22 } from "./1_22/index.js";
+import { ScrcpyOptions1_22 } from "./1_22/index.js";
+import type { ScrcpyMediaStreamPacket } from "./codec.js";
+import { ScrcpyOptionsBase } from "./types.js";
 
 export interface ScrcpyOptionsInit1_23 extends ScrcpyOptionsInit1_22 {
-    cleanup: boolean;
+    cleanup?: boolean;
 }
 
-const KEYFRAME_PTS = BigInt(1) << BigInt(62);
+const KEYFRAME_PTS = 1n << 62n;
 
-export class ScrcpyOptions1_23<
-    T extends ScrcpyOptionsInit1_23 = ScrcpyOptionsInit1_23
-> extends ScrcpyOptions1_22<T> {
-    public constructor(init: Partial<ScrcpyOptionsInit1_23>) {
-        super(init);
+export class ScrcpyOptions1_23 extends ScrcpyOptionsBase<
+    ScrcpyOptionsInit1_23,
+    ScrcpyOptions1_22
+> {
+    static readonly DEFAULTS = {
+        ...ScrcpyOptions1_22.DEFAULTS,
+        cleanup: true,
+    } as const satisfies Required<ScrcpyOptionsInit1_23>;
+
+    override get defaults(): Required<ScrcpyOptionsInit1_23> {
+        return ScrcpyOptions1_23.DEFAULTS;
     }
 
-    public override getDefaultValue(): T {
-        return {
-            ...super.getDefaultValue(),
-            cleanup: true,
-        };
+    constructor(init: ScrcpyOptionsInit1_22) {
+        super(new ScrcpyOptions1_22(init), {
+            ...ScrcpyOptions1_23.DEFAULTS,
+            ...init,
+        });
+    }
+
+    override serialize(): string[] {
+        return ScrcpyOptions1_21.serialize(this.value, this.defaults);
     }
 
-    public override createVideoStreamTransformer(): TransformStream<
+    override createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyVideoStreamPacket
+        ScrcpyMediaStreamPacket
     > {
-        const superStream = super.createVideoStreamTransformer();
+        const stream = this._base.createMediaStreamTransformer();
         return {
-            writable: superStream.writable,
-            readable: superStream.readable.pipeThrough(
+            writable: stream.writable,
+            readable: stream.readable.pipeThrough(
                 new TransformStream({
                     transform(packet, controller): void {
-                        if (packet.type !== "frame") {
+                        if (packet.type !== "data") {
                             controller.enqueue(packet);
                             return;
                         }
@@ -49,7 +61,7 @@ export class ScrcpyOptions1_23<
 
                         controller.enqueue(packet);
                     },
-                })
+                }),
             ),
         };
     }

package/src/options/1_24.ts

@@ -1,21 +1,33 @@
+import { ScrcpyOptions1_21 } from "./1_21.js";
 import type { ScrcpyOptionsInit1_23 } from "./1_23.js";
 import { ScrcpyOptions1_23 } from "./1_23.js";
+import { ScrcpyOptionsBase } from "./types.js";
 
 export interface ScrcpyOptionsInit1_24 extends ScrcpyOptionsInit1_23 {
-    powerOn: boolean;
+    powerOn?: boolean;
 }
 
-export class ScrcpyOptions1_24<
-    T extends ScrcpyOptionsInit1_24 = ScrcpyOptionsInit1_24
-> extends ScrcpyOptions1_23<T> {
-    public constructor(init: Partial<ScrcpyOptionsInit1_24>) {
-        super(init);
+export class ScrcpyOptions1_24 extends ScrcpyOptionsBase<
+    ScrcpyOptionsInit1_24,
+    ScrcpyOptions1_23
+> {
+    static readonly DEFAULTS = {
+        ...ScrcpyOptions1_23.DEFAULTS,
+        powerOn: true,
+    } as const satisfies Required<ScrcpyOptionsInit1_24>;
+
+    override get defaults(): Required<ScrcpyOptionsInit1_24> {
+        return ScrcpyOptions1_24.DEFAULTS;
+    }
+
+    constructor(init: ScrcpyOptionsInit1_24) {
+        super(new ScrcpyOptions1_23(init), {
+            ...ScrcpyOptions1_24.DEFAULTS,
+            ...init,
+        });
     }
 
-    public override getDefaultValue(): T {
-        return {
-            ...super.getDefaultValue(),
-            powerOn: true,
-        };
+    override serialize(): string[] {
+        return ScrcpyOptions1_21.serialize(this.value, this.defaults);
     }
 }

package/src/options/1_25/options.ts

@@ -1,13 +1,31 @@
 import type { ScrcpyScrollController } from "../1_16/index.js";
+import { ScrcpyOptions1_21 } from "../1_21.js";
 import type { ScrcpyOptionsInit1_24 } from "../1_24.js";
 import { ScrcpyOptions1_24 } from "../1_24.js";
+import { ScrcpyOptionsBase } from "../types.js";
 
 import { ScrcpyScrollController1_25 } from "./scroll.js";
 
-export class ScrcpyOptions1_25<
-    T extends ScrcpyOptionsInit1_24 = ScrcpyOptionsInit1_24
-> extends ScrcpyOptions1_24<T> {
-    public override getScrollController(): ScrcpyScrollController {
+export class ScrcpyOptions1_25 extends ScrcpyOptionsBase<
+    ScrcpyOptionsInit1_24,
+    ScrcpyOptions1_24
+> {
+    override get defaults(): Required<ScrcpyOptionsInit1_24> {
+        return ScrcpyOptions1_24.DEFAULTS;
+    }
+
+    constructor(init: ScrcpyOptionsInit1_24) {
+        super(new ScrcpyOptions1_24(init), {
+            ...ScrcpyOptions1_24.DEFAULTS,
+            ...init,
+        });
+    }
+
+    override serialize(): string[] {
+        return ScrcpyOptions1_21.serialize(this.value, this.defaults);
+    }
+
+    override createScrollController(): ScrcpyScrollController {
         return new ScrcpyScrollController1_25();
     }
 }

package/src/options/1_25/scroll.ts

@@ -4,8 +4,9 @@ import Struct, {
 } from "@yume-chan/struct";
 
 import type { ScrcpyInjectScrollControlMessage } from "../../control/index.js";
-import { clamp, ScrcpyControlMessageType } from "../../control/index.js";
+import { ScrcpyControlMessageType } from "../../control/index.js";
 import type { ScrcpyScrollController } from "../1_16/index.js";
+import { clamp } from "../1_16/index.js";
 
 export const ScrcpyFloatToInt16NumberType: NumberFieldType = {
     size: 2,
@@ -24,7 +25,7 @@ export const ScrcpyFloatToInt16NumberType: NumberFieldType = {
 };
 
 const ScrcpyFloatToInt16FieldDefinition = new NumberFieldDefinition(
-    ScrcpyFloatToInt16NumberType
+    ScrcpyFloatToInt16NumberType,
 );
 
 export const ScrcpyInjectScrollControlMessage1_25 = new Struct()
@@ -42,7 +43,7 @@ export type ScrcpyInjectScrollControlMessage1_25 =
 
 export class ScrcpyScrollController1_25 implements ScrcpyScrollController {
     serializeScrollMessage(
-        message: ScrcpyInjectScrollControlMessage
+        message: ScrcpyInjectScrollControlMessage,
     ): Uint8Array | undefined {
         return ScrcpyInjectScrollControlMessage1_25.serialize(message);
     }