@yume-chan/scrcpy 0.0.18 → 0.0.20

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

@@ -0,0 +1,80 @@
+import type { CodecOptions } from "./codec-options.js";
+
+export enum ScrcpyLogLevel1_16 {
+    Debug = "debug",
+    Info = "info",
+    Warn = "warn",
+    Error = "error",
+}
+
+export enum ScrcpyVideoOrientation1_16 {
+    Unlocked = -1,
+    Portrait = 0,
+    Landscape = 1,
+    PortraitFlipped = 2,
+    LandscapeFlipped = 3,
+}
+
+export interface ScrcpyOptionsInit1_16 {
+    logLevel?: ScrcpyLogLevel1_16;
+
+    /**
+     * The maximum value of both width and height.
+     */
+    maxSize?: number;
+
+    bitRate?: number;
+
+    /**
+     * 0 for unlimited.
+     *
+     * @default 0
+     */
+    maxFps?: number;
+
+    /**
+     * The orientation of the video stream.
+     *
+     * It will not keep the device screen in specific orientation,
+     * only the captured video will in this orientation.
+     */
+    lockVideoOrientation?: ScrcpyVideoOrientation1_16;
+
+    /**
+     * Use ADB forward tunnel instead of reverse tunnel.
+     *
+     * This option is mainly used for working around the bug that on Android <9,
+     * ADB daemon can't create reverse tunnels if connected wirelessly (ADB over WiFi).
+     *
+     * When using `AdbScrcpyClient`, it can detect this situation and enable this option automatically.
+     */
+    tunnelForward?: boolean;
+
+    crop?: string | undefined;
+
+    /**
+     * Send PTS so that the client may record properly
+     *
+     * Note: When `sendFrameMeta: false` is specified,
+     * the video stream will not contain `configuration` typed packets,
+     * which means it can't be decoded by the companion decoders.
+     * It's still possible to record the stream into a file,
+     * or to decode it with a more tolerant decoder like FFMpeg.
+     *
+     * @default true
+     */
+    sendFrameMeta?: boolean;
+
+    /**
+     * @default true
+     */
+    control?: boolean;
+
+    displayId?: number;
+
+    showTouches?: boolean;
+
+    stayAwake?: boolean;
+
+    codecOptions?: CodecOptions;
+}

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

@@ -0,0 +1,55 @@
+import Struct, { placeholder } from "@yume-chan/struct";
+
+import type { AndroidMotionEventAction } from "../../control/index.js";
+import {
+    BasicControlMessage,
+    ScrcpyControlMessageType,
+} from "../../control/index.js";
+
+import { ScrcpyFloatToUint16FieldDefinition } from "./float-to-uint16.js";
+
+export const SCRCPY_CONTROL_MESSAGE_TYPES_1_16: readonly ScrcpyControlMessageType[] =
+    [
+        /*  0 */ ScrcpyControlMessageType.InjectKeyCode,
+        /*  1 */ ScrcpyControlMessageType.InjectText,
+        /*  2 */ ScrcpyControlMessageType.InjectTouch,
+        /*  3 */ ScrcpyControlMessageType.InjectScroll,
+        /*  4 */ ScrcpyControlMessageType.BackOrScreenOn,
+        /*  5 */ ScrcpyControlMessageType.ExpandNotificationPanel,
+        /*  6 */ ScrcpyControlMessageType.CollapseNotificationPanel,
+        /*  7 */ ScrcpyControlMessageType.GetClipboard,
+        /*  8 */ ScrcpyControlMessageType.SetClipboard,
+        /*  9 */ ScrcpyControlMessageType.SetScreenPowerMode,
+        /* 10 */ ScrcpyControlMessageType.RotateDevice,
+    ];
+
+export const ScrcpyMediaStreamRawPacket = new Struct()
+    .uint64("pts")
+    .uint32("size")
+    .uint8Array("data", { lengthField: "size" });
+
+export const SCRCPY_MEDIA_PACKET_FLAG_CONFIG = 1n << 63n;
+
+export const ScrcpyInjectTouchControlMessage1_16 = new Struct()
+    .uint8("type")
+    .uint8("action", placeholder<AndroidMotionEventAction>())
+    .uint64("pointerId")
+    .uint32("pointerX")
+    .uint32("pointerY")
+    .uint16("screenWidth")
+    .uint16("screenHeight")
+    .field("pressure", ScrcpyFloatToUint16FieldDefinition)
+    .uint32("buttons");
+
+export type ScrcpyInjectTouchControlMessage1_16 =
+    (typeof ScrcpyInjectTouchControlMessage1_16)["TInit"];
+
+export const ScrcpyBackOrScreenOnControlMessage1_16 = BasicControlMessage;
+
+export const ScrcpySetClipboardControlMessage1_15 = new Struct()
+    .uint8("type")
+    .uint32("length")
+    .string("content", { lengthField: "length" });
+
+export type ScrcpySetClipboardControlMessage1_15 =
+    (typeof ScrcpySetClipboardControlMessage1_15)["TInit"];

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

@@ -1,299 +1,205 @@
+import type { ReadableStream } from "@yume-chan/stream-extra";
 import {
+    BufferedReadableStream,
     StructDeserializeStream,
     TransformStream,
 } from "@yume-chan/stream-extra";
-import Struct from "@yume-chan/struct";
+import type { AsyncExactReadable, ValueOrPromise } from "@yume-chan/struct";
+import { NumberFieldType, decodeUtf8 } from "@yume-chan/struct";
 
-import {
-    AndroidKeyEventAction,
+import type {
+    ScrcpyBackOrScreenOnControlMessage,
     ScrcpyControlMessageType,
-    type ScrcpyBackOrScreenOnControlMessage,
-    type ScrcpySetClipboardControlMessage,
+    ScrcpyInjectTouchControlMessage,
+    ScrcpySetClipboardControlMessage,
 } from "../../control/index.js";
-import {
-    toScrcpyOptionValue,
-    type ScrcpyOptions,
-    type ScrcpyVideoStreamPacket,
-} from "../types.js";
+import { AndroidKeyEventAction } from "../../control/index.js";
+import type {
+    ScrcpyMediaStreamPacket,
+    ScrcpyVideoStream,
+    ScrcpyVideoStreamMetadata,
+} from "../codec.js";
+import { ScrcpyVideoCodecId } from "../codec.js";
+import type { ScrcpyDisplay, ScrcpyEncoder, ScrcpyOptions } from "../types.js";
+import { toScrcpyOptionValue } from "../types.js";
 
 import { CodecOptions } from "./codec-options.js";
+import type { ScrcpyOptionsInit1_16 } from "./init.js";
+import { ScrcpyLogLevel1_16, ScrcpyVideoOrientation1_16 } from "./init.js";
 import {
-    parseH264Configuration,
-    parseSequenceParameterSet,
-    removeH264Emulation,
-} from "./h264-configuration.js";
-import {
-    ScrcpyScrollController1_16,
-    type ScrcpyScrollController,
-} from "./scroll.js";
-
-export enum ScrcpyLogLevel {
-    Verbose = "verbose",
-    Debug = "debug",
-    Info = "info",
-    Warn = "warn",
-    Error = "error",
-}
-
-export enum ScrcpyVideoOrientation {
-    Initial = -2,
-    Unlocked = -1,
-    Portrait = 0,
-    Landscape = 1,
-    PortraitFlipped = 2,
-    LandscapeFlipped = 3,
-}
-
-export interface ScrcpyOptionsInit1_16 {
-    logLevel: ScrcpyLogLevel;
-
-    /**
-     * The maximum value of both width and height.
-     */
-    maxSize: number;
-
-    bitRate: number;
-
-    /**
-     * 0 for unlimited.
-     *
-     * @default 0
-     */
-    maxFps: number;
-
-    /**
-     * The orientation of the video stream.
-     *
-     * It will not keep the device screen in specific orientation,
-     * only the captured video will in this orientation.
-     */
-    lockVideoOrientation: ScrcpyVideoOrientation;
-
-    tunnelForward: boolean;
-
-    crop: string;
-
-    /**
-     * Send PTS so that the client may record properly
-     *
-     * Note: When `sendFrameMeta: false` is specified,
-     * `onChangeEncoding` event won't fire and `onVideoData` event doesn't
-     * merge sps/pps frame and first video frame. Which means you can't use
-     * the shipped decoders to render the video
-     * (You can still record the stream into a file).
-     *
-     * @default true
-     */
-    sendFrameMeta: boolean;
-
-    /**
-     * @default true
-     */
-    control: boolean;
-
-    displayId: number;
-
-    showTouches: boolean;
-
-    stayAwake: boolean;
-
-    codecOptions: CodecOptions;
+    SCRCPY_CONTROL_MESSAGE_TYPES_1_16,
+    SCRCPY_MEDIA_PACKET_FLAG_CONFIG,
+    ScrcpyBackOrScreenOnControlMessage1_16,
+    ScrcpyInjectTouchControlMessage1_16,
+    ScrcpyMediaStreamRawPacket,
+    ScrcpySetClipboardControlMessage1_15,
+} from "./message.js";
+import type { ScrcpyScrollController } from "./scroll.js";
+import { ScrcpyScrollController1_16 } from "./scroll.js";
+
+export class ScrcpyOptions1_16 implements ScrcpyOptions<ScrcpyOptionsInit1_16> {
+    public static readonly DEFAULTS = {
+        logLevel: ScrcpyLogLevel1_16.Debug,
+        maxSize: 0,
+        bitRate: 8_000_000,
+        maxFps: 0,
+        lockVideoOrientation: ScrcpyVideoOrientation1_16.Unlocked,
+        tunnelForward: false,
+        crop: undefined,
+        sendFrameMeta: true,
+        control: true,
+        displayId: 0,
+        showTouches: false,
+        stayAwake: false,
+        codecOptions: new CodecOptions(),
+    } as const satisfies Required<ScrcpyOptionsInit1_16>;
+
+    public static readonly SERIALIZE_ORDER = [
+        "logLevel",
+        "maxSize",
+        "bitRate",
+        "maxFps",
+        "lockVideoOrientation",
+        "tunnelForward",
+        "crop",
+        "sendFrameMeta",
+        "control",
+        "displayId",
+        "showTouches",
+        "stayAwake",
+        "codecOptions",
+    ] as const satisfies readonly (keyof ScrcpyOptionsInit1_16)[];
+
+    public static serialize<T>(options: T, order: readonly (keyof T)[]) {
+        return order.map((key) => toScrcpyOptionValue(options[key], "-"));
+    }
 
-    encoderName: string;
-}
+    public static async parseCString(
+        stream: AsyncExactReadable,
+        maxLength: number
+    ): Promise<string> {
+        let result = decodeUtf8(await stream.readExactly(maxLength));
+        result = result.substring(0, result.indexOf("\0"));
+        return result;
+    }
 
-export const VideoPacket = new Struct()
-    .uint64("pts")
-    .uint32("size")
-    .uint8Array("data", { lengthField: "size" });
+    public static async parseUint16BE(
+        stream: AsyncExactReadable
+    ): Promise<number> {
+        const buffer = await stream.readExactly(NumberFieldType.Uint16.size);
+        return NumberFieldType.Uint16.deserialize(buffer, false);
+    }
 
-export const NO_PTS = BigInt(1) << BigInt(63);
+    public static async parseUint32BE(
+        stream: AsyncExactReadable
+    ): Promise<number> {
+        const buffer = await stream.readExactly(NumberFieldType.Uint32.size);
+        return NumberFieldType.Uint32.deserialize(buffer, false);
+    }
 
-export const ScrcpyBackOrScreenOnControlMessage1_16 = new Struct().uint8(
-    "type",
-    ScrcpyControlMessageType.BackOrScreenOn as const
-);
+    public value: Required<ScrcpyOptionsInit1_16>;
 
-export const ScrcpySetClipboardControlMessage1_15 = new Struct()
-    .uint8("type", ScrcpyControlMessageType.SetClipboard as const)
-    .uint32("length")
-    .string("content", { lengthField: "length" });
+    public readonly defaults: Required<ScrcpyOptionsInit1_16> =
+        ScrcpyOptions1_16.DEFAULTS;
 
-export type ScrcpySetClipboardControlMessage1_15 =
-    typeof ScrcpySetClipboardControlMessage1_15["TInit"];
+    public readonly controlMessageTypes: readonly ScrcpyControlMessageType[] =
+        SCRCPY_CONTROL_MESSAGE_TYPES_1_16;
 
-export class ScrcpyOptions1_16<
-    T extends ScrcpyOptionsInit1_16 = ScrcpyOptionsInit1_16
-> implements ScrcpyOptions<T>
-{
-    public value: Partial<T>;
+    public constructor(init: ScrcpyOptionsInit1_16) {
+        this.value = { ...ScrcpyOptions1_16.DEFAULTS, ...init };
+    }
 
-    public constructor(value: Partial<ScrcpyOptionsInit1_16>) {
-        if (
-            new.target === ScrcpyOptions1_16 &&
-            value.logLevel === ScrcpyLogLevel.Verbose
-        ) {
-            value.logLevel = ScrcpyLogLevel.Debug;
-        }
+    public serialize(): string[] {
+        return ScrcpyOptions1_16.serialize(
+            this.value,
+            ScrcpyOptions1_16.SERIALIZE_ORDER
+        );
+    }
 
-        if (
-            new.target === ScrcpyOptions1_16 &&
-            value.lockVideoOrientation === ScrcpyVideoOrientation.Initial
-        ) {
-            value.lockVideoOrientation = ScrcpyVideoOrientation.Unlocked;
-        }
+    public setListEncoders(): void {
+        throw new Error("Not supported");
+    }
 
-        this.value = value as Partial<T>;
+    public setListDisplays(): void {
+        // Set to an invalid value
+        // Server will print valid values before crashing
+        // (server will crash before opening sockets)
+        this.value.displayId = -1;
     }
 
-    protected getArgumentOrder(): (keyof T)[] {
-        return [
-            "logLevel",
-            "maxSize",
-            "bitRate",
-            "maxFps",
-            "lockVideoOrientation",
-            "tunnelForward",
-            "crop",
-            "sendFrameMeta",
-            "control",
-            "displayId",
-            "showTouches",
-            "stayAwake",
-            "codecOptions",
-            "encoderName",
-        ];
+    public parseEncoder(): ScrcpyEncoder | undefined {
+        throw new Error("Not supported");
     }
 
-    public getDefaultValue(): T {
-        return {
-            logLevel: ScrcpyLogLevel.Debug,
-            maxSize: 0,
-            bitRate: 8_000_000,
-            maxFps: 0,
-            lockVideoOrientation: ScrcpyVideoOrientation.Unlocked,
-            tunnelForward: false,
-            crop: "-",
-            sendFrameMeta: true,
-            control: true,
-            displayId: 0,
-            showTouches: false,
-            stayAwake: false,
-            codecOptions: new CodecOptions({}),
-            encoderName: "-",
-        } as T;
+    public parseDisplay(line: string): ScrcpyDisplay | undefined {
+        const displayIdRegex = /\s+scrcpy --display (\d+)/;
+        const match = line.match(displayIdRegex);
+        if (match) {
+            return {
+                id: Number.parseInt(match[1]!, 10),
+            };
+        }
+        return undefined;
     }
 
-    public formatServerArguments(): string[] {
-        const defaults = this.getDefaultValue();
-        return this.getArgumentOrder().map((key) =>
-            toScrcpyOptionValue(this.value[key] || defaults[key], "-")
-        );
+    public parseVideoStreamMetadata(
+        stream: ReadableStream<Uint8Array>
+    ): ValueOrPromise<ScrcpyVideoStream> {
+        return (async () => {
+            const buffered = new BufferedReadableStream(stream);
+            const metadata: ScrcpyVideoStreamMetadata = {
+                codec: ScrcpyVideoCodecId.H264,
+            };
+            metadata.deviceName = await ScrcpyOptions1_16.parseCString(
+                buffered,
+                64
+            );
+            metadata.width = await ScrcpyOptions1_16.parseUint16BE(buffered);
+            metadata.height = await ScrcpyOptions1_16.parseUint16BE(buffered);
+            return { stream: buffered.release(), metadata };
+        })();
     }
 
-    public getOutputEncoderNameRegex(): RegExp {
-        return /\s+scrcpy --encoder-name '(.*?)'/;
+    public parseAudioStreamMetadata(): never {
+        throw new Error("Not supported");
     }
 
-    public createVideoStreamTransformer(): TransformStream<
+    public createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyVideoStreamPacket
+        ScrcpyMediaStreamPacket
     > {
         // Optimized path for video frames only
-        if (this.value.sendFrameMeta === false) {
+        if (!this.value.sendFrameMeta) {
             return new TransformStream({
                 transform(chunk, controller) {
                     controller.enqueue({
-                        type: "frame",
+                        type: "data",
                         data: chunk,
                     });
                 },
             });
         }
 
-        let header: Uint8Array | undefined;
-
-        const deserializeStream = new StructDeserializeStream(VideoPacket);
+        const deserializeStream = new StructDeserializeStream(
+            ScrcpyMediaStreamRawPacket
+        );
         return {
             writable: deserializeStream.writable,
             readable: deserializeStream.readable.pipeThrough(
                 new TransformStream({
                     transform(packet, controller) {
-                        if (packet.pts === NO_PTS) {
-                            const {
-                                sequenceParameterSet,
-                                pictureParameterSet,
-                            } = parseH264Configuration(packet.data);
-
-                            const {
-                                profile_idc: profileIndex,
-                                constraint_set: constraintSet,
-                                level_idc: levelIndex,
-                                pic_width_in_mbs_minus1,
-                                pic_height_in_map_units_minus1,
-                                frame_mbs_only_flag,
-                                frame_crop_left_offset,
-                                frame_crop_right_offset,
-                                frame_crop_top_offset,
-                                frame_crop_bottom_offset,
-                            } = parseSequenceParameterSet(
-                                removeH264Emulation(sequenceParameterSet)
-                            );
-
-                            const encodedWidth =
-                                (pic_width_in_mbs_minus1 + 1) * 16;
-                            const encodedHeight =
-                                (pic_height_in_map_units_minus1 + 1) *
-                                (2 - frame_mbs_only_flag) *
-                                16;
-                            const cropLeft = frame_crop_left_offset * 2;
-                            const cropRight = frame_crop_right_offset * 2;
-                            const cropTop = frame_crop_top_offset * 2;
-                            const cropBottom = frame_crop_bottom_offset * 2;
-
-                            const croppedWidth =
-                                encodedWidth - cropLeft - cropRight;
-                            const croppedHeight =
-                                encodedHeight - cropTop - cropBottom;
-
-                            header = packet.data;
+                        if (packet.pts === SCRCPY_MEDIA_PACKET_FLAG_CONFIG) {
                             controller.enqueue({
                                 type: "configuration",
-                                pictureParameterSet,
-                                sequenceParameterSet,
-                                data: {
-                                    profileIndex,
-                                    constraintSet,
-                                    levelIndex,
-                                    encodedWidth,
-                                    encodedHeight,
-                                    cropLeft,
-                                    cropRight,
-                                    cropTop,
-                                    cropBottom,
-                                    croppedWidth,
-                                    croppedHeight,
-                                },
+                                data: packet.data,
                             });
                             return;
                         }
 
-                        let frameData: Uint8Array;
-                        if (header) {
-                            frameData = new Uint8Array(
-                                header.byteLength + packet.data.byteLength
-                            );
-                            frameData.set(header);
-                            frameData.set(packet.data, header.byteLength);
-                            header = undefined;
-                        } else {
-                            frameData = packet.data;
-                        }
-
                         controller.enqueue({
-                            type: "frame",
+                            type: "data",
                             pts: packet.pts,
-                            data: frameData,
+                            data: packet.data,
                         });
                     },
                 })
@@ -301,20 +207,10 @@ export class ScrcpyOptions1_16<
         };
     }
 
-    public getControlMessageTypes(): ScrcpyControlMessageType[] {
-        return [
-            /*  0 */ ScrcpyControlMessageType.InjectKeyCode,
-            /*  1 */ ScrcpyControlMessageType.InjectText,
-            /*  2 */ ScrcpyControlMessageType.InjectTouch,
-            /*  3 */ ScrcpyControlMessageType.InjectScroll,
-            /*  4 */ ScrcpyControlMessageType.BackOrScreenOn,
-            /*  5 */ ScrcpyControlMessageType.ExpandNotificationPanel,
-            /*  6 */ ScrcpyControlMessageType.CollapseNotificationPanel,
-            /*  7 */ ScrcpyControlMessageType.GetClipboard,
-            /*  8 */ ScrcpyControlMessageType.SetClipboard,
-            /*  9 */ ScrcpyControlMessageType.SetScreenPowerMode,
-            /* 10 */ ScrcpyControlMessageType.RotateDevice,
-        ];
+    public serializeInjectTouchControlMessage(
+        message: ScrcpyInjectTouchControlMessage
+    ): Uint8Array {
+        return ScrcpyInjectTouchControlMessage1_16.serialize(message);
     }
 
     public serializeBackOrScreenOnControlMessage(
@@ -333,7 +229,7 @@ export class ScrcpyOptions1_16<
         return ScrcpySetClipboardControlMessage1_15.serialize(message);
     }
 
-    public getScrollController(): ScrcpyScrollController {
+    public createScrollController(): ScrcpyScrollController {
         return new ScrcpyScrollController1_16();
     }
 }

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

@@ -1,9 +1,6 @@
 import Struct from "@yume-chan/struct";
 
-import {
-    ScrcpyControlMessageType,
-    type ScrcpyInjectScrollControlMessage,
-} from "../../control/index.js";
+import type { ScrcpyInjectScrollControlMessage } from "../../control/index.js";
 
 export interface ScrcpyScrollController {
     serializeScrollMessage(
@@ -12,7 +9,7 @@ export interface ScrcpyScrollController {
 }
 
 export const ScrcpyInjectScrollControlMessage1_16 = new Struct()
-    .uint8("type", ScrcpyControlMessageType.InjectScroll as const)
+    .uint8("type")
     .uint32("pointerX")
     .uint32("pointerY")
     .uint16("screenWidth")