@yume-chan/scrcpy 0.0.16 → 0.0.18

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

@@ -0,0 +1,76 @@
+import Struct from "@yume-chan/struct";
+
+import {
+    ScrcpyControlMessageType,
+    type ScrcpyInjectScrollControlMessage,
+} from "../../control/index.js";
+
+export interface ScrcpyScrollController {
+    serializeScrollMessage(
+        message: ScrcpyInjectScrollControlMessage
+    ): Uint8Array | undefined;
+}
+
+export const ScrcpyInjectScrollControlMessage1_16 = new Struct()
+    .uint8("type", ScrcpyControlMessageType.InjectScroll as const)
+    .uint32("pointerX")
+    .uint32("pointerY")
+    .uint16("screenWidth")
+    .uint16("screenHeight")
+    .int32("scrollX")
+    .int32("scrollY");
+
+/**
+ * Old version of Scrcpy server only supports integer values for scroll.
+ *
+ * Accumulate scroll values and send scroll message when accumulated value
+ * reaches 1 or -1.
+ */
+export class ScrcpyScrollController1_16 implements ScrcpyScrollController {
+    private accumulatedX = 0;
+    private accumulatedY = 0;
+
+    protected processMessage(
+        message: ScrcpyInjectScrollControlMessage
+    ): ScrcpyInjectScrollControlMessage | undefined {
+        this.accumulatedX += message.scrollX;
+        this.accumulatedY += message.scrollY;
+
+        let scrollX = 0;
+        let scrollY = 0;
+        if (this.accumulatedX >= 1) {
+            scrollX = 1;
+            this.accumulatedX = 0;
+        } else if (this.accumulatedX <= -1) {
+            scrollX = -1;
+            this.accumulatedX = 0;
+        }
+
+        if (this.accumulatedY >= 1) {
+            scrollY = 1;
+            this.accumulatedY = 0;
+        } else if (this.accumulatedY <= -1) {
+            scrollY = -1;
+            this.accumulatedY = 0;
+        }
+
+        if (scrollX === 0 && scrollY === 0) {
+            return undefined;
+        }
+
+        message.scrollX = scrollX;
+        message.scrollY = scrollY;
+        return message;
+    }
+
+    public serializeScrollMessage(
+        message: ScrcpyInjectScrollControlMessage
+    ): Uint8Array | undefined {
+        const processed = this.processMessage(message);
+        if (!processed) {
+            return undefined;
+        }
+
+        return ScrcpyInjectScrollControlMessage1_16.serialize(processed);
+    }
+}

package/src/options/1_18.ts

@@ -1,28 +1,40 @@
 import Struct, { placeholder } from "@yume-chan/struct";
-import { AndroidKeyEventAction, ScrcpyControlMessageType } from "../message.js";
-import { ScrcpyBackOrScreenOnEvent1_16, ScrcpyOptions1_16, type ScrcpyOptionsInit1_16 } from "./1_16/index.js";
+
+import {
+    ScrcpyControlMessageType,
+    type AndroidKeyEventAction,
+    type ScrcpyBackOrScreenOnControlMessage,
+} from "../control/index.js";
+
+import {
+    ScrcpyBackOrScreenOnControlMessage1_16,
+    ScrcpyOptions1_16,
+    type ScrcpyOptionsInit1_16,
+} from "./1_16/options.js";
 
 export interface ScrcpyOptionsInit1_18 extends ScrcpyOptionsInit1_16 {
     powerOffOnClose: boolean;
 }
 
-export const ScrcpyBackOrScreenOnEvent1_18 =
-    new Struct()
-        .fields(ScrcpyBackOrScreenOnEvent1_16)
-        .uint8('action', placeholder<AndroidKeyEventAction>());
+export const ScrcpyBackOrScreenOnControlMessage1_18 = new Struct()
+    .fields(ScrcpyBackOrScreenOnControlMessage1_16)
+    .uint8("action", placeholder<AndroidKeyEventAction>());
 
-export type ScrcpyBackOrScreenOnEvent1_18 = typeof ScrcpyBackOrScreenOnEvent1_18["TInit"];
+export type ScrcpyBackOrScreenOnControlMessage1_18 =
+    typeof ScrcpyBackOrScreenOnControlMessage1_18["TInit"];
 
-export class ScrcpyOptions1_18<T extends ScrcpyOptionsInit1_18 = ScrcpyOptionsInit1_18> extends ScrcpyOptions1_16<T> {
+export class ScrcpyOptions1_18<
+    T extends ScrcpyOptionsInit1_18 = ScrcpyOptionsInit1_18
+> extends ScrcpyOptions1_16<T> {
     constructor(value: Partial<ScrcpyOptionsInit1_18>) {
         super(value);
     }
 
     protected override getArgumentOrder(): (keyof T)[] {
-        return super.getArgumentOrder().concat(['powerOffOnClose']);
+        return super.getArgumentOrder().concat(["powerOffOnClose"]);
     }
 
-    protected override getDefaultValue(): T {
+    public override getDefaultValue(): T {
         return {
             ...super.getDefaultValue(),
             powerOffOnClose: false,
@@ -54,8 +66,8 @@ export class ScrcpyOptions1_18<T extends ScrcpyOptionsInit1_18 = ScrcpyOptionsIn
     }
 
     public override serializeBackOrScreenOnControlMessage(
-        message: ScrcpyBackOrScreenOnEvent1_18,
+        message: ScrcpyBackOrScreenOnControlMessage
     ) {
-        return ScrcpyBackOrScreenOnEvent1_18.serialize(message);
+        return ScrcpyBackOrScreenOnControlMessage1_18.serialize(message);
     }
 }

package/src/options/1_21.ts

@@ -1,22 +1,41 @@
 // cspell: ignore autosync
 
-import { ScrcpyOptions1_18, type ScrcpyOptionsInit1_18 } from './1_18.js';
-import { toScrcpyOptionValue } from "./common.js";
+import Struct from "@yume-chan/struct";
+
+import {
+    ScrcpyControlMessageType,
+    type ScrcpySetClipboardControlMessage,
+} from "../control/index.js";
+
+import { ScrcpyOptions1_18, type ScrcpyOptionsInit1_18 } from "./1_18.js";
+import { toScrcpyOptionValue } from "./types.js";
 
 export interface ScrcpyOptionsInit1_21 extends ScrcpyOptionsInit1_18 {
     clipboardAutosync?: boolean;
 }
 
 function toSnakeCase(input: string): string {
-    return input.replace(/([A-Z])/g, '_$1').toLowerCase();
+    return input.replace(/([A-Z])/g, "_$1").toLowerCase();
 }
 
-export class ScrcpyOptions1_21<T extends ScrcpyOptionsInit1_21 = ScrcpyOptionsInit1_21> extends ScrcpyOptions1_18<T> {
+export const ScrcpySetClipboardControlMessage1_21 = new Struct()
+    .uint8("type", ScrcpyControlMessageType.SetClipboard as const)
+    .uint64("sequence")
+    .int8("paste")
+    .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);
     }
 
-    protected override getDefaultValue(): T {
+    public override getDefaultValue(): T {
         return {
             ...super.getDefaultValue(),
             clipboardAutosync: true,
@@ -27,8 +46,17 @@ export class ScrcpyOptions1_21<T extends ScrcpyOptionsInit1_21 = ScrcpyOptionsIn
         // 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)
+            .map(
+                ([key, value]) =>
+                    [key, toScrcpyOptionValue(value, undefined)] as const
+            )
             .filter((pair): pair is [string, string] => pair[1] !== undefined)
             .map(([key, value]) => `${toSnakeCase(key)}=${value}`);
     }
+
+    public override serializeSetClipboardControlMessage(
+        message: ScrcpySetClipboardControlMessage
+    ): Uint8Array {
+        return ScrcpySetClipboardControlMessage1_21.serialize(message);
+    }
 }

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

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

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

@@ -0,0 +1,58 @@
+import { type ScrcpyScrollController } from "../1_16/index.js";
+import { ScrcpyOptions1_21, type ScrcpyOptionsInit1_21 } from "../1_21.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<
+    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;
+        }
+
+        super(init);
+    }
+
+    public override getDefaultValue(): T {
+        return {
+            ...super.getDefaultValue(),
+            downsizeOnError: true,
+            sendDeviceMeta: true,
+            sendDummyByte: true,
+            rawVideoStream: false,
+        };
+    }
+
+    public override getScrollController(): ScrcpyScrollController {
+        return new ScrcpyScrollController1_22();
+    }
+}

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

@@ -0,0 +1,26 @@
+import Struct from "@yume-chan/struct";
+
+import {
+    ScrcpyInjectScrollControlMessage1_16,
+    ScrcpyScrollController1_16,
+} from "../1_16/index.js";
+
+export const ScrcpyInjectScrollControlMessage1_22 = new Struct()
+    .fields(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
+    ): Uint8Array | undefined {
+        const processed = this.processMessage(message);
+        if (!processed) {
+            return undefined;
+        }
+
+        return ScrcpyInjectScrollControlMessage1_22.serialize(processed);
+    }
+}

package/src/options/1_23.ts

@@ -1,6 +1,10 @@
-import { TransformStream } from "@yume-chan/adb";
-import { ScrcpyOptions1_22, type ScrcpyOptionsInit1_22 } from './1_22.js';
-import type { VideoStreamPacket } from "./common.js";
+import { TransformStream } from "@yume-chan/stream-extra";
+
+import {
+    ScrcpyOptions1_22,
+    type ScrcpyOptionsInit1_22,
+} from "./1_22/options.js";
+import { type ScrcpyVideoStreamPacket } from "./types.js";
 
 export interface ScrcpyOptionsInit1_23 extends ScrcpyOptionsInit1_22 {
     cleanup: boolean;
@@ -8,37 +12,47 @@ export interface ScrcpyOptionsInit1_23 extends ScrcpyOptionsInit1_22 {
 
 const KEYFRAME_PTS = BigInt(1) << BigInt(62);
 
-export class ScrcpyOptions1_23<T extends ScrcpyOptionsInit1_23 = ScrcpyOptionsInit1_23> extends ScrcpyOptions1_22<T> {
+export class ScrcpyOptions1_23<
+    T extends ScrcpyOptionsInit1_23 = ScrcpyOptionsInit1_23
+> extends ScrcpyOptions1_22<T> {
     public constructor(init: Partial<ScrcpyOptionsInit1_23>) {
         super(init);
     }
 
-    protected override getDefaultValue(): T {
+    public override getDefaultValue(): T {
         return {
             ...super.getDefaultValue(),
             cleanup: true,
         };
     }
 
-    public override createVideoStreamTransformer(): TransformStream<Uint8Array, VideoStreamPacket> {
+    public override createVideoStreamTransformer(): TransformStream<
+        Uint8Array,
+        ScrcpyVideoStreamPacket
+    > {
         const superStream = super.createVideoStreamTransformer();
         return {
             writable: superStream.writable,
-            readable: superStream.readable.pipeThrough(new TransformStream({
-                transform(packet, controller): void {
-                    if (packet.type !== 'frame') {
-                        controller.enqueue(packet);
-                        return;
-                    }
+            readable: superStream.readable.pipeThrough(
+                new TransformStream({
+                    transform(packet, controller): void {
+                        if (packet.type !== "frame") {
+                            controller.enqueue(packet);
+                            return;
+                        }
 
-                    if (packet.pts !== undefined && packet.pts & KEYFRAME_PTS) {
-                        packet.keyframe = true;
-                        packet.pts &= ~KEYFRAME_PTS;
-                    }
+                        if (
+                            packet.pts !== undefined &&
+                            packet.pts & KEYFRAME_PTS
+                        ) {
+                            packet.keyframe = true;
+                            packet.pts &= ~KEYFRAME_PTS;
+                        }
 
-                    controller.enqueue(packet);
-                }
-            }))
+                        controller.enqueue(packet);
+                    },
+                })
+            ),
         };
     }
 }

package/src/options/1_24.ts

@@ -4,12 +4,13 @@ export interface ScrcpyOptionsInit1_24 extends ScrcpyOptionsInit1_23 {
     powerOn: boolean;
 }
 
-export class ScrcpyOptions1_24<T extends ScrcpyOptionsInit1_24 = ScrcpyOptionsInit1_24> extends ScrcpyOptions1_23<T> {
+export class ScrcpyOptions1_24<T extends ScrcpyOptionsInit1_24 = ScrcpyOptionsInit1_24>
+    extends ScrcpyOptions1_23<T> {
     public constructor(init: Partial<ScrcpyOptionsInit1_24>) {
         super(init);
     }
 
-    protected override getDefaultValue(): T {
+    public override getDefaultValue(): T {
         return {
             ...super.getDefaultValue(),
             powerOn: true,

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

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

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

@@ -0,0 +1,12 @@
+import { type ScrcpyScrollController } from "../1_16/index.js";
+import { ScrcpyOptions1_24, type ScrcpyOptionsInit1_24 } from "../1_24.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 {
+        return new ScrcpyScrollController1_25();
+    }
+}

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

@@ -0,0 +1,52 @@
+import Struct, {
+    NumberFieldDefinition,
+    NumberFieldType,
+} from "@yume-chan/struct";
+
+import {
+    clamp,
+    ScrcpyControlMessageType,
+    type ScrcpyInjectScrollControlMessage,
+} from "../../control/index.js";
+import { type ScrcpyScrollController } from "../1_16/index.js";
+
+export const ScrcpyFloatToInt16NumberType: NumberFieldType = {
+    size: 2,
+    signed: true,
+    deserialize(array, littleEndian) {
+        const value = NumberFieldType.Int16.deserialize(array, littleEndian);
+        // https://github.com/Genymobile/scrcpy/blob/1f138aef41de651668043b32c4effc2d4adbfc44/server/src/main/java/com/genymobile/scrcpy/Binary.java#L34
+        return value === 0x7fff ? 1 : value / 0x8000;
+    },
+    serialize(dataView, offset, value, littleEndian) {
+        // https://github.com/Genymobile/scrcpy/blob/1f138aef41de651668043b32c4effc2d4adbfc44/app/src/util/binary.h#L65
+        value = clamp(value, -1, 1);
+        value = value === 1 ? 0x7fff : value * 0x8000;
+        NumberFieldType.Int16.serialize(dataView, offset, value, littleEndian);
+    },
+};
+
+const ScrcpyFloatToInt16FieldDefinition = new NumberFieldDefinition(
+    ScrcpyFloatToInt16NumberType
+);
+
+export const ScrcpyInjectScrollControlMessage1_25 = new Struct()
+    .uint8("type", ScrcpyControlMessageType.InjectScroll as const)
+    .uint32("pointerX")
+    .uint32("pointerY")
+    .uint16("screenWidth")
+    .uint16("screenHeight")
+    .field("scrollX", ScrcpyFloatToInt16FieldDefinition)
+    .field("scrollY", ScrcpyFloatToInt16FieldDefinition)
+    .int32("buttons");
+
+export type ScrcpyInjectScrollControlMessage1_25 =
+    typeof ScrcpyInjectScrollControlMessage1_25["TInit"];
+
+export class ScrcpyScrollController1_25 implements ScrcpyScrollController {
+    serializeScrollMessage(
+        message: ScrcpyInjectScrollControlMessage
+    ): Uint8Array | undefined {
+        return ScrcpyInjectScrollControlMessage1_25.serialize(message);
+    }
+}

package/src/options/index.ts

@@ -1,7 +1,8 @@
 export * from './1_16/index.js';
 export * from './1_18.js';
 export * from './1_21.js';
-export * from './1_22.js';
-export * from './1_23.js';
-export * from './1_24.js';
-export * from './common.js';
+export * from "./1_22/index.js";
+export * from "./1_23.js";
+export * from "./1_24.js";
+export * from "./1_25/index.js";
+export * from "./types.js";

package/src/options/types.ts

@@ -0,0 +1,102 @@
+import { type TransformStream } from "@yume-chan/stream-extra";
+
+import {
+    type ScrcpyBackOrScreenOnControlMessage,
+    type ScrcpyControlMessageType,
+    type ScrcpySetClipboardControlMessage,
+} from "../control/index.js";
+
+import { type ScrcpyScrollController } from "./1_16/scroll.js";
+
+export const DEFAULT_SERVER_PATH = "/data/local/tmp/scrcpy-server.jar";
+
+export interface ScrcpyOptionValue {
+    toOptionValue(): string | undefined;
+}
+
+export function isScrcpyOptionValue(
+    value: unknown
+): value is ScrcpyOptionValue {
+    return (
+        typeof value === "object" &&
+        value !== null &&
+        "toOptionValue" in value &&
+        typeof value.toOptionValue === "function"
+    );
+}
+
+export function toScrcpyOptionValue<T>(value: unknown, empty: T): string | T {
+    if (isScrcpyOptionValue(value)) {
+        value = value.toOptionValue();
+    }
+
+    // `value` may become `undefined` after `toOptionValue`
+    if (value === undefined) {
+        return empty;
+    }
+
+    return String(value);
+}
+
+export interface H264Configuration {
+    profileIndex: number;
+    constraintSet: number;
+    levelIndex: number;
+
+    encodedWidth: number;
+    encodedHeight: number;
+
+    cropLeft: number;
+    cropRight: number;
+
+    cropTop: number;
+    cropBottom: number;
+
+    croppedWidth: number;
+    croppedHeight: number;
+}
+
+export interface ScrcpyVideoStreamConfigurationPacket {
+    type: "configuration";
+    sequenceParameterSet: Uint8Array;
+    pictureParameterSet: Uint8Array;
+    data: H264Configuration;
+}
+
+export interface ScrcpyVideoStreamFramePacket {
+    type: "frame";
+    keyframe?: boolean | undefined;
+    pts?: bigint | undefined;
+    data: Uint8Array;
+}
+
+export type ScrcpyVideoStreamPacket =
+    | ScrcpyVideoStreamConfigurationPacket
+    | ScrcpyVideoStreamFramePacket;
+
+export interface ScrcpyOptions<T extends object> {
+    value: Partial<T>;
+
+    getDefaultValue(): T;
+
+    formatServerArguments(): string[];
+
+    getOutputEncoderNameRegex(): RegExp;
+
+    createVideoStreamTransformer(): TransformStream<
+        Uint8Array,
+        ScrcpyVideoStreamPacket
+    >;
+
+    getControlMessageTypes(): ScrcpyControlMessageType[];
+
+    serializeBackOrScreenOnControlMessage(
+        message: ScrcpyBackOrScreenOnControlMessage
+    ): Uint8Array | undefined;
+
+    serializeSetClipboardControlMessage(
+        message: ScrcpySetClipboardControlMessage
+    ): Uint8Array;
+
+    getScrollController(): ScrcpyScrollController;
+}

package/tsconfig.build.json

@@ -0,0 +1,3 @@
+{
+    "extends": "./node_modules/@yume-chan/tsconfig/tsconfig.base.json"
+}