@yume-chan/scrcpy 0.0.13 → 0.0.16

package/src/options/1_18.ts

@@ -1,41 +1,61 @@
-import Struct, { placeholder } from "@yume-chan/struct";
-import type { AndroidKeyEventAction } from "../message.js";
-import { ScrcpyBackOrScreenOnEvent1_16, ScrcpyOptions1_16, type ScrcpyOptionsInit1_16 } from "./1_16/index.js";
-
-export interface ScrcpyOptionsInit1_18 extends ScrcpyOptionsInit1_16 {
-    powerOffOnClose: boolean;
-}
-
-export const ScrcpyBackOrScreenOnEvent1_18 =
-    new Struct()
-        .fields(ScrcpyBackOrScreenOnEvent1_16)
-        .uint8('action', placeholder<AndroidKeyEventAction>());
-
-export type ScrcpyBackOrScreenOnEvent1_18 = typeof ScrcpyBackOrScreenOnEvent1_18["TInit"];
-
-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']);
-    }
-
-    protected override getDefaultValue(): T {
-        return {
-            ...super.getDefaultValue(),
-            powerOffOnClose: false,
-        };
-    }
-
-    public override getOutputEncoderNameRegex(): RegExp {
-        return /\s+scrcpy --encoder '(.*?)'/;
-    }
-
-    public override serializeBackOrScreenOnControlMessage(
-        message: ScrcpyBackOrScreenOnEvent1_18,
-    ) {
-        return ScrcpyBackOrScreenOnEvent1_18.serialize(message);
-    }
-}
+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";
+
+export interface ScrcpyOptionsInit1_18 extends ScrcpyOptionsInit1_16 {
+    powerOffOnClose: boolean;
+}
+
+export const ScrcpyBackOrScreenOnEvent1_18 =
+    new Struct()
+        .fields(ScrcpyBackOrScreenOnEvent1_16)
+        .uint8('action', placeholder<AndroidKeyEventAction>());
+
+export type ScrcpyBackOrScreenOnEvent1_18 = typeof ScrcpyBackOrScreenOnEvent1_18["TInit"];
+
+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']);
+    }
+
+    protected override getDefaultValue(): T {
+        return {
+            ...super.getDefaultValue(),
+            powerOffOnClose: false,
+        };
+    }
+
+    public override getOutputEncoderNameRegex(): RegExp {
+        return /\s+scrcpy --encoder '(.*?)'/;
+    }
+
+    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;
+    }
+
+    public override serializeBackOrScreenOnControlMessage(
+        message: ScrcpyBackOrScreenOnEvent1_18,
+    ) {
+        return ScrcpyBackOrScreenOnEvent1_18.serialize(message);
+    }
+}

package/src/options/1_21.ts

@@ -1,34 +1,34 @@
-// cspell: ignore autosync
-
-import { ScrcpyOptions1_18, type ScrcpyOptionsInit1_18 } from './1_18.js';
-import { toScrcpyOptionValue } from "./common.js";
-
-export interface ScrcpyOptionsInit1_21 extends ScrcpyOptionsInit1_18 {
-    clipboardAutosync?: boolean;
-}
-
-function toSnakeCase(input: string): string {
-    return input.replace(/([A-Z])/g, '_$1').toLowerCase();
-}
-
-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 {
-        return {
-            ...super.getDefaultValue(),
-            clipboardAutosync: true,
-        };
-    }
-
-    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}`);
-    }
-}
+// cspell: ignore autosync
+
+import { ScrcpyOptions1_18, type ScrcpyOptionsInit1_18 } from './1_18.js';
+import { toScrcpyOptionValue } from "./common.js";
+
+export interface ScrcpyOptionsInit1_21 extends ScrcpyOptionsInit1_18 {
+    clipboardAutosync?: boolean;
+}
+
+function toSnakeCase(input: string): string {
+    return input.replace(/([A-Z])/g, '_$1').toLowerCase();
+}
+
+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 {
+        return {
+            ...super.getDefaultValue(),
+            clipboardAutosync: true,
+        };
+    }
+
+    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}`);
+    }
+}

package/src/options/1_22.ts

@@ -1,80 +1,78 @@
-import type { Adb } from "@yume-chan/adb";
-import Struct from "@yume-chan/struct";
-import { ScrcpyClientForwardConnection, ScrcpyClientReverseConnection, type ScrcpyClientConnection, type ScrcpyClientConnectionOptions } from "../connection.js";
-import { ScrcpyInjectScrollControlMessage1_16 } from "./1_16/index.js";
-import { ScrcpyOptions1_21, type ScrcpyOptionsInit1_21 } from "./1_21.js";
-
-export interface ScrcpyOptionsInit1_22 extends ScrcpyOptionsInit1_21 {
-    downsizeOnError: boolean;
-
-    /**
-     * Send device name and size
-     *
-     * @default true
-     */
-    sendDeviceMeta: boolean;
-
-    /**
-     * Write a byte on start to detect connection issues
-     *
-     * @default true
-     */
-    sendDummyByte: boolean;
-
-    /**
-     * Implies `sendDeviceMeta: false`, `sendFrameMeta: false` and `sendDummyByte: false`
-     *
-     * @default false
-     */
-    rawVideoStream: boolean;
-}
-
-export const ScrcpyInjectScrollControlMessage1_22 =
-    new Struct()
-        .fields(ScrcpyInjectScrollControlMessage1_16)
-        .int32("buttons");
-
-export type ScrcpyInjectScrollControlMessage1_22 = typeof ScrcpyInjectScrollControlMessage1_22["TInit"];
-
-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);
-    }
-
-    protected override getDefaultValue(): T {
-        return {
-            ...super.getDefaultValue(),
-            downsizeOnError: true,
-            sendDeviceMeta: true,
-            sendDummyByte: true,
-            rawVideoStream: false,
-        };
-    }
-
-    public override createConnection(device: Adb): ScrcpyClientConnection {
-        const defaultValue = this.getDefaultValue();
-        const options: ScrcpyClientConnectionOptions = {
-            control: this.value.control ?? defaultValue.control,
-            sendDummyByte: this.value.sendDummyByte ?? defaultValue.sendDummyByte,
-            sendDeviceMeta: this.value.sendDeviceMeta ?? defaultValue.sendDeviceMeta,
-        };
-        if (this.value.tunnelForward) {
-            return new ScrcpyClientForwardConnection(device, options);
-        } else {
-            return new ScrcpyClientReverseConnection(device, options);
-        }
-    }
-
-    public override serializeInjectScrollControlMessage(
-        message: ScrcpyInjectScrollControlMessage1_22,
-    ): Uint8Array {
-        return ScrcpyInjectScrollControlMessage1_22.serialize(message);
-    }
-}
+import type { Adb } from "@yume-chan/adb";
+import Struct from "@yume-chan/struct";
+import { ScrcpyClientForwardConnection, ScrcpyClientReverseConnection, type ScrcpyClientConnection } from "../connection.js";
+import { ScrcpyInjectScrollControlMessage1_16 } from "./1_16/index.js";
+import { ScrcpyOptions1_21, 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;
+
+    /**
+     * Implies `sendDeviceMeta: false`, `sendFrameMeta: false` and `sendDummyByte: false`
+     *
+     * @default false
+     */
+    rawVideoStream: boolean;
+}
+
+export const ScrcpyInjectScrollControlMessage1_22 =
+    new Struct()
+        .fields(ScrcpyInjectScrollControlMessage1_16)
+        .int32("buttons");
+
+export type ScrcpyInjectScrollControlMessage1_22 = typeof ScrcpyInjectScrollControlMessage1_22["TInit"];
+
+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);
+    }
+
+    protected override getDefaultValue(): T {
+        return {
+            ...super.getDefaultValue(),
+            downsizeOnError: true,
+            sendDeviceMeta: true,
+            sendDummyByte: true,
+            rawVideoStream: false,
+        };
+    }
+
+    public override createConnection(device: Adb): ScrcpyClientConnection {
+        const options = {
+            ...this.getDefaultValue(),
+            ...this.value,
+        };
+        if (this.value.tunnelForward) {
+            return new ScrcpyClientForwardConnection(device, options);
+        } else {
+            return new ScrcpyClientReverseConnection(device, options);
+        }
+    }
+
+    public override serializeInjectScrollControlMessage(
+        message: ScrcpyInjectScrollControlMessage1_22,
+    ): Uint8Array {
+        return ScrcpyInjectScrollControlMessage1_22.serialize(message);
+    }
+}

package/src/options/1_24.ts

@@ -0,0 +1,18 @@
+import { ScrcpyOptions1_23, type ScrcpyOptionsInit1_23 } from './1_23.js';
+
+export interface ScrcpyOptionsInit1_24 extends ScrcpyOptionsInit1_23 {
+    powerOn: boolean;
+}
+
+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 {
+        return {
+            ...super.getDefaultValue(),
+            powerOn: true,
+        };
+    }
+}

package/src/options/common.ts

@@ -1,63 +1,66 @@
-import type { Adb, TransformStream } from "@yume-chan/adb";
-import type { ScrcpyClientConnection } from "../connection.js";
-import type { H264Configuration } from "../decoder/index.js";
-import type { ScrcpyBackOrScreenOnEvent1_18 } from "./1_18.js";
-import type { ScrcpyInjectScrollControlMessage1_22 } from "./1_22.js";
-
-export const DEFAULT_SERVER_PATH = '/data/local/tmp/scrcpy-server.jar';
-
-export interface ScrcpyOptionValue {
-    toOptionValue(): string | undefined;
-}
-
-export function isScrcpyOptionValue(value: any): value is ScrcpyOptionValue {
-    return typeof value === 'object' &&
-        value !== null &&
-        typeof value.toOptionValue === 'function';
-}
-
-export function toScrcpyOptionValue<T>(value: any, empty: T): string | T {
-    if (isScrcpyOptionValue(value)) {
-        value = value.toOptionValue();
-    }
-
-    if (value === undefined) {
-        return empty;
-    }
-
-    return `${value}`;
-}
-
-export interface VideoStreamConfigurationPacket {
-    type: 'configuration';
-    data: H264Configuration;
-}
-
-export interface VideoStreamFramePacket {
-    type: 'frame';
-    keyframe?: boolean | undefined;
-    pts?: bigint | undefined;
-    data: Uint8Array;
-}
-
-export type VideoStreamPacket = VideoStreamConfigurationPacket | VideoStreamFramePacket;
-
-export interface ScrcpyOptions<T> {
-    value: Partial<T>;
-
-    formatServerArguments(): string[];
-
-    getOutputEncoderNameRegex(): RegExp;
-
-    createConnection(adb: Adb): ScrcpyClientConnection;
-
-    createVideoStreamTransformer(): TransformStream<Uint8Array, VideoStreamPacket>;
-
-    serializeBackOrScreenOnControlMessage(
-        message: ScrcpyBackOrScreenOnEvent1_18,
-    ): Uint8Array | undefined;
-
-    serializeInjectScrollControlMessage(
-        message: ScrcpyInjectScrollControlMessage1_22,
-    ): Uint8Array;
-}
+import type { Adb, TransformStream } from "@yume-chan/adb";
+import type { ScrcpyClientConnection } from "../connection.js";
+import type { H264Configuration } from "../decoder/index.js";
+import type { ScrcpyControlMessageType } from "../message.js";
+import type { ScrcpyBackOrScreenOnEvent1_18 } from "./1_18.js";
+import type { ScrcpyInjectScrollControlMessage1_22 } from "./1_22.js";
+
+export const DEFAULT_SERVER_PATH = '/data/local/tmp/scrcpy-server.jar';
+
+export interface ScrcpyOptionValue {
+    toOptionValue(): string | undefined;
+}
+
+export function isScrcpyOptionValue(value: any): value is ScrcpyOptionValue {
+    return typeof value === 'object' &&
+        value !== null &&
+        typeof value.toOptionValue === 'function';
+}
+
+export function toScrcpyOptionValue<T>(value: any, empty: T): string | T {
+    if (isScrcpyOptionValue(value)) {
+        value = value.toOptionValue();
+    }
+
+    if (value === undefined) {
+        return empty;
+    }
+
+    return `${value}`;
+}
+
+export interface VideoStreamConfigurationPacket {
+    type: 'configuration';
+    data: H264Configuration;
+}
+
+export interface VideoStreamFramePacket {
+    type: 'frame';
+    keyframe?: boolean | undefined;
+    pts?: bigint | undefined;
+    data: Uint8Array;
+}
+
+export type VideoStreamPacket = VideoStreamConfigurationPacket | VideoStreamFramePacket;
+
+export interface ScrcpyOptions<T> {
+    value: Partial<T>;
+
+    formatServerArguments(): string[];
+
+    getOutputEncoderNameRegex(): RegExp;
+
+    createConnection(adb: Adb): ScrcpyClientConnection;
+
+    createVideoStreamTransformer(): TransformStream<Uint8Array, VideoStreamPacket>;
+
+    getControlMessageTypes(): ScrcpyControlMessageType[];
+
+    serializeBackOrScreenOnControlMessage(
+        message: ScrcpyBackOrScreenOnEvent1_18,
+    ): Uint8Array | undefined;
+
+    serializeInjectScrollControlMessage(
+        message: ScrcpyInjectScrollControlMessage1_22,
+    ): Uint8Array;
+}

package/src/options/index.ts

@@ -1,6 +1,7 @@
-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 './common.js';
+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';

package/src/push-server.ts

@@ -1,24 +1,24 @@
-import { WrapWritableStream, type Adb, type AdbSync } from "@yume-chan/adb";
-import { DEFAULT_SERVER_PATH } from "./options/index.js";
-
-export interface PushServerOptions {
-    path?: string;
-}
-
-export function pushServer(
-    device: Adb,
-    options: PushServerOptions = {}
-) {
-    const { path = DEFAULT_SERVER_PATH } = options;
-
-    let sync!: AdbSync;
-    return new WrapWritableStream<Uint8Array>({
-        async start() {
-            sync = await device.sync();
-            return sync.write(path);
-        },
-        async close() {
-            await sync.dispose();
-        },
-    });
-}
+import { WrapWritableStream, type Adb, type AdbSync } from "@yume-chan/adb";
+import { DEFAULT_SERVER_PATH } from "./options/index.js";
+
+export interface PushServerOptions {
+    path?: string;
+}
+
+export function pushServer(
+    device: Adb,
+    options: PushServerOptions = {}
+) {
+    const { path = DEFAULT_SERVER_PATH } = options;
+
+    let sync!: AdbSync;
+    return new WrapWritableStream<Uint8Array>({
+        async start() {
+            sync = await device.sync();
+            return sync.write(path);
+        },
+        async close() {
+            await sync.dispose();
+        },
+    });
+}

package/src/utils.ts

@@ -1,5 +1,5 @@
-export function delay(time: number): Promise<void> {
-    return new Promise(resolve => {
-        (globalThis as any).setTimeout(resolve, time);
-    });
-}
+export function delay(time: number): Promise<void> {
+    return new Promise(resolve => {
+        (globalThis as any).setTimeout(resolve, time);
+    });
+}