@yume-chan/scrcpy 0.0.18 → 0.0.19

package/src/control/inject-keycode.ts

@@ -7,58 +7,203 @@ export enum AndroidKeyEventAction {
     Up = 1,
 }
 
-// https://github.com/Genymobile/scrcpy/blob/cabb102a04153f9c237b18257d3269a058558c63/app/src/android/keycodes.h#L26
+// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/view/KeyEvent.java;l=993;drc=95c1165bb895dd844e1793460710f7163dd330a3
+export enum AndroidKeyEventMeta {
+    AltOn = 0x02,
+    AltLeftOn = 0x10,
+    AltRightOn = 0x20,
+    ShiftOn = 0x01,
+    ShiftLeftOn = 0x40,
+    ShiftRightOn = 0x80,
+    CtrlOn = 0x1000,
+    CtrlLeftOn = 0x2000,
+    CtrlRightOn = 0x4000,
+    MetaOn = 0x10000,
+    MetaLeftOn = 0x20000,
+    MetaRightOn = 0x40000,
+    CapsLockOn = 0x100000,
+    NumLockOn = 0x200000,
+    ScrollLockOn = 0x400000,
+}
+
+// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/view/KeyEvent.java;l=97;drc=95c1165bb895dd844e1793460710f7163dd330a3
+// Most names follow Web API `KeyboardEvent.code`,
+// Android-only (not exist in HID keyboard standard) keys are prefixed by `Android`.
 export enum AndroidKeyCode {
-    Home = 3,
-    Back = 4,
-
-    DPadUp = 19,
-    DPadDown,
-    DPadLeft,
-    DPadRight,
-
-    VolumeUp = 24,
-    VolumeDown,
-
-    A = 29,
-    B,
-    C,
-    D,
-    E,
-    F,
-    G,
-    H,
-    I,
-    J,
-    K,
-    L,
-    M,
-    N,
-    O,
-    P,
-    Q,
-    R,
-    S,
-    T,
-    U,
-    V,
-    W,
-    X,
-    Y,
-    Z,
-
-    Tab = 61,
+    AndroidHome = 3,
+    AndroidBack = 4,
+    AndroidCall,
+    AndroidEndCall,
+
+    Digit0,
+    Digit1,
+    Digit2,
+    Digit3,
+    Digit4,
+    Digit5,
+    Digit6,
+    Digit7,
+    Digit8,
+    Digit9,
+    /**
+     * '*' key.
+     */
+    Star, // Name not verified
+    /**
+     * '#' key.
+     */
+    Pound, // Name not verified
+
+    /**
+     * Directional Pad Up key.
+     */
+    ArrowUp,
+    /**
+     * Directional Pad Down key.
+     */
+    ArrowDown,
+    /**
+     * Directional Pad Left key.
+     */
+    ArrowLeft,
+    /**
+     * Directional Pad Right key.
+     */
+    ArrowRight,
+    /**
+     * Directional Pad Center key.
+     */
+    AndroidDPadCenter,
+
+    VolumeUp, // Name not verified
+    VolumeDown, // Name not verified
+    Power, // Name not verified
+    AndroidCamera,
+    Clear, // Name not verified
+
+    KeyA,
+    KeyB,
+    KeyC,
+    KeyD,
+    KeyE,
+    KeyF,
+    KeyG,
+    KeyH,
+    KeyI,
+    KeyJ,
+    KeyK,
+    KeyL,
+    KeyM,
+    KeyN,
+    KeyO,
+    KeyP,
+    KeyQ,
+    KeyR,
+    KeyS,
+    KeyT,
+    KeyU,
+    KeyV,
+    KeyW,
+    KeyX,
+    KeyY,
+    KeyZ,
+    Comma,
+    Period,
+    AltLeft,
+    AltRight,
+    ShiftLeft,
+    ShiftRight,
+    Tab,
     Space,
-    Enter = 66,
-    Delete,
+    AndroidSymbol,
+    AndroidExplorer,
+    AndroidEnvelope,
+    Enter,
+    Backspace,
+    Backquote,
+    Minus,
+    Equal,
+    BracketLeft,
+    BracketRight,
+    Backslash,
+    Semicolon,
+    Quote,
+    Slash,
+    At, // Name not verified
+
+    AndroidNum,
+    AndroidHeadsetHook,
+    /**
+     * Camera Focus key。
+     */
+    AndroidFocus,
+
+    Plus, // Name not verified
+    ContextMenu,
+    AndroidNotification,
+    AndroidSearch,
+
+    PageUp = 92,
+    PageDown,
+
     Escape = 111,
-    ForwardDelete,
+    Delete,
+    ControlLeft,
+    ControlRight,
+    CapsLock,
+    ScrollLock,
+    MetaLeft,
+    MetaRight,
+    AndroidFunction,
+    PrintScreen,
+    Pause,
+
+    Home,
+    End,
+    Insert,
+    AndroidForward,
+
+    F1 = 131,
+    F2,
+    F3,
+    F4,
+    F5,
+    F6,
+    F7,
+    F8,
+    F9,
+    F10,
+    F11,
+    F12,
+
+    NumLock,
+    Numpad0,
+    Numpad1,
+    Numpad2,
+    Numpad3,
+    Numpad4,
+    Numpad5,
+    Numpad6,
+    Numpad7,
+    Numpad8,
+    Numpad9,
+    NumpadDivide,
+    NumpadMultiply,
+    NumpadSubtract,
+    NumpadAdd,
+    NumpadDecimal,
+    NumpadComma, // Name not verified
+    NumpadEnter,
+    NumpadEquals, // Name not verified
+    NumpadLeftParen, // Name not verified
+    NumpadRightParen, // Name not verified
 
-    MoveHome = 122,
-    MoveEnd = 123,
+    VolumeMute = 164, // Name not verified
+    AndroidAppSwitch = 187,
 
-    VolumeMute = 164,
-    AppSwitch = 187,
+    AndroidCut = 277,
+    AndroidCopy,
+    AndroidPaste,
 }
 
 export const ScrcpyInjectKeyCodeControlMessage = new Struct()
@@ -69,4 +214,4 @@ export const ScrcpyInjectKeyCodeControlMessage = new Struct()
     .uint32("metaState");
 
 export type ScrcpyInjectKeyCodeControlMessage =
-    typeof ScrcpyInjectKeyCodeControlMessage["TInit"];
+    (typeof ScrcpyInjectKeyCodeControlMessage)["TInit"];

package/src/control/inject-scroll.ts

@@ -1,4 +1,4 @@
-import { type ScrcpyInjectScrollControlMessage1_25 } from "../options/index.js";
+import type { ScrcpyInjectScrollControlMessage1_25 } from "../options/index.js";
 
 export type ScrcpyInjectScrollControlMessage =
     ScrcpyInjectScrollControlMessage1_25;

package/src/control/inject-text.ts

@@ -1,12 +1,11 @@
-import Struct from '@yume-chan/struct';
+import Struct from "@yume-chan/struct";
 
-import { ScrcpyControlMessageType } from './type.js';
+import { ScrcpyControlMessageType } from "./type.js";
 
-export const ScrcpyInjectTextControlMessage =
-    new Struct()
-        .uint8('type', ScrcpyControlMessageType.InjectText as const)
-        .uint32('length')
-        .string('text', { lengthField: 'length' });
+export const ScrcpyInjectTextControlMessage = new Struct()
+    .uint8("type", ScrcpyControlMessageType.InjectText as const)
+    .uint32("length")
+    .string("text", { lengthField: "length" });
 
 export type ScrcpyInjectTextControlMessage =
-    typeof ScrcpyInjectTextControlMessage['TInit'];
+    (typeof ScrcpyInjectTextControlMessage)["TInit"];

package/src/control/inject-touch.ts

@@ -75,4 +75,4 @@ export const ScrcpyInjectTouchControlMessage = new Struct()
     .uint32("buttons");
 
 export type ScrcpyInjectTouchControlMessage =
-    typeof ScrcpyInjectTouchControlMessage["TInit"];
+    (typeof ScrcpyInjectTouchControlMessage)["TInit"];

package/src/control/rotate-device.ts

@@ -1,10 +1,11 @@
-import Struct from '@yume-chan/struct';
+import Struct from "@yume-chan/struct";
 
-import { ScrcpyControlMessageType } from './type.js';
+import { ScrcpyControlMessageType } from "./type.js";
 
-export const ScrcpyRotateDeviceControlMessage =
-    new Struct()
-        .uint8('type', ScrcpyControlMessageType.RotateDevice as const)
+export const ScrcpyRotateDeviceControlMessage = new Struct().uint8(
+    "type",
+    ScrcpyControlMessageType.RotateDevice as const
+);
 
 export type ScrcpyRotateDeviceControlMessage =
-    typeof ScrcpyRotateDeviceControlMessage['TInit'];
+    (typeof ScrcpyRotateDeviceControlMessage)["TInit"];

package/src/control/serializer.ts

@@ -1,37 +1,36 @@
-import {
-    type WritableStream,
-    type WritableStreamDefaultWriter,
+import type {
+    Consumable,
+    WritableStream,
+    WritableStreamDefaultWriter,
 } from "@yume-chan/stream-extra";
+import { ConsumableWritableStream } from "@yume-chan/stream-extra";
 
-import {
-    type ScrcpyOptions,
-    type ScrcpyScrollController,
+import type {
+    ScrcpyOptions,
+    ScrcpyOptionsInit1_16,
+    ScrcpyScrollController,
 } from "../options/index.js";
 
-import {
-    ScrcpyInjectKeyCodeControlMessage,
-    type AndroidKeyEventAction,
-} from "./inject-keycode.js";
-import { type ScrcpyInjectScrollControlMessage } from "./inject-scroll.js";
+import type { AndroidKeyEventAction } from "./inject-keycode.js";
+import { ScrcpyInjectKeyCodeControlMessage } from "./inject-keycode.js";
+import type { ScrcpyInjectScrollControlMessage } from "./inject-scroll.js";
 import { ScrcpyInjectTextControlMessage } from "./inject-text.js";
 import { ScrcpyInjectTouchControlMessage } from "./inject-touch.js";
 import { ScrcpyRotateDeviceControlMessage } from "./rotate-device.js";
-import {
-    ScrcpySetScreenPowerModeControlMessage,
-    type AndroidScreenPowerMode,
-} from "./set-screen-power-mode.js";
+import type { AndroidScreenPowerMode } from "./set-screen-power-mode.js";
+import { ScrcpySetScreenPowerModeControlMessage } from "./set-screen-power-mode.js";
 import { ScrcpyControlMessageType } from "./type.js";
 
 export class ScrcpyControlMessageSerializer {
-    private options: ScrcpyOptions<object>;
+    private options: ScrcpyOptions<ScrcpyOptionsInit1_16>;
     /** Control message type values for current version of server */
     private types: ScrcpyControlMessageType[];
-    private writer: WritableStreamDefaultWriter<Uint8Array>;
+    private writer: WritableStreamDefaultWriter<Consumable<Uint8Array>>;
     private scrollController: ScrcpyScrollController;
 
     public constructor(
-        stream: WritableStream<Uint8Array>,
-        options: ScrcpyOptions<object>
+        stream: WritableStream<Consumable<Uint8Array>>,
+        options: ScrcpyOptions<ScrcpyOptionsInit1_16>
     ) {
         this.writer = stream.getWriter();
 
@@ -56,10 +55,14 @@ export class ScrcpyControlMessageSerializer {
         return message as T;
     }
 
+    private async write(data: Uint8Array) {
+        await ConsumableWritableStream.write(this.writer, data);
+    }
+
     public injectKeyCode(
         message: Omit<ScrcpyInjectKeyCodeControlMessage, "type">
     ) {
-        return this.writer.write(
+        return this.write(
             ScrcpyInjectKeyCodeControlMessage.serialize(
                 this.addMessageType(
                     message,
@@ -70,7 +73,7 @@ export class ScrcpyControlMessageSerializer {
     }
 
     public injectText(text: string) {
-        return this.writer.write(
+        return this.write(
             ScrcpyInjectTextControlMessage.serialize({
                 text,
                 type: this.getActualMessageType(
@@ -84,7 +87,7 @@ export class ScrcpyControlMessageSerializer {
      * `pressure` is a float value between 0 and 1.
      */
     public injectTouch(message: Omit<ScrcpyInjectTouchControlMessage, "type">) {
-        return this.writer.write(
+        return this.write(
             ScrcpyInjectTouchControlMessage.serialize(
                 this.addMessageType(
                     message,
@@ -108,7 +111,7 @@ export class ScrcpyControlMessageSerializer {
             return;
         }
 
-        return this.writer.write(data);
+        return this.write(data);
     }
 
     public async backOrScreenOn(action: AndroidKeyEventAction) {
@@ -120,12 +123,12 @@ export class ScrcpyControlMessageSerializer {
         });
 
         if (buffer) {
-            return await this.writer.write(buffer);
+            return await this.write(buffer);
         }
     }
 
     public setScreenPowerMode(mode: AndroidScreenPowerMode) {
-        return this.writer.write(
+        return this.write(
             ScrcpySetScreenPowerModeControlMessage.serialize({
                 mode,
                 type: this.getActualMessageType(
@@ -136,7 +139,7 @@ export class ScrcpyControlMessageSerializer {
     }
 
     public rotateDevice() {
-        return this.writer.write(
+        return this.write(
             ScrcpyRotateDeviceControlMessage.serialize({
                 type: this.getActualMessageType(
                     ScrcpyControlMessageType.RotateDevice

package/src/control/set-clipboard.ts

@@ -1,4 +1,4 @@
-import { type ScrcpySetClipboardControlMessage1_21 } from "../options/index.js";
+import type { ScrcpySetClipboardControlMessage1_21 } from "../options/index.js";
 
 export type ScrcpySetClipboardControlMessage =
     ScrcpySetClipboardControlMessage1_21;

package/src/control/set-screen-power-mode.ts

@@ -1,17 +1,16 @@
-import Struct, { placeholder } from '@yume-chan/struct';
+import Struct, { placeholder } from "@yume-chan/struct";
 
-import { ScrcpyControlMessageType } from './type.js';
+import { ScrcpyControlMessageType } from "./type.js";
 
 // https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/view/SurfaceControl.java;l=659;drc=20303e05bf73796124ab70a279cf849b61b97905
 export enum AndroidScreenPowerMode {
     Off = 0,
-    Normal = 2
+    Normal = 2,
 }
 
-export const ScrcpySetScreenPowerModeControlMessage =
-    new Struct()
-        .uint8('type', ScrcpyControlMessageType.SetScreenPowerMode as const)
-        .uint8('mode', placeholder<AndroidScreenPowerMode>());
+export const ScrcpySetScreenPowerModeControlMessage = new Struct()
+    .uint8("type", ScrcpyControlMessageType.SetScreenPowerMode as const)
+    .uint8("mode", placeholder<AndroidScreenPowerMode>());
 
 export type ScrcpySetScreenPowerModeControlMessage =
-    typeof ScrcpySetScreenPowerModeControlMessage['TInit'];
+    (typeof ScrcpySetScreenPowerModeControlMessage)["TInit"];

package/src/device-message/ack-clipboard.ts

@@ -7,4 +7,4 @@ export const ScrcpyAckClipboardDeviceMessage = new Struct()
     .extra({ type: ScrcpyDeviceMessageType.AckClipboard as const });
 
 export type ScrcpyAckClipboardDeviceMessage =
-    typeof ScrcpyAckClipboardDeviceMessage["TDeserializeResult"];
+    (typeof ScrcpyAckClipboardDeviceMessage)["TDeserializeResult"];

package/src/device-message/clipboard.ts

@@ -8,4 +8,4 @@ export const ScrcpyClipboardDeviceMessage = new Struct()
     .extra({ type: ScrcpyDeviceMessageType.Clipboard as const });
 
 export type ScrcpyClipboardDeviceMessage =
-    typeof ScrcpyClipboardDeviceMessage["TDeserializeResult"];
+    (typeof ScrcpyClipboardDeviceMessage)["TDeserializeResult"];

package/src/index.ts

@@ -1,5 +1,5 @@
-export * from './adb/index.js';
-export * from './codec.js';
-export * from './control/index.js';
-export * from './device-message/index.js';
-export * from './options/index.js';
+export * from "./adb/index.js";
+export * from "./codec.js";
+export * from "./control/index.js";
+export * from "./device-message/index.js";
+export * from "./options/index.js";

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

@@ -1,8 +1,5 @@
-import {
-    type AndroidCodecLevel,
-    type AndroidCodecProfile,
-} from "../../codec.js";
-import { type ScrcpyOptionValue } from "../types.js";
+import type { AndroidCodecLevel, AndroidCodecProfile } from "../../codec.js";
+import type { ScrcpyOptionValue } from "../types.js";
 
 /**
  * If the option you need is not in this type,
@@ -16,6 +13,7 @@ export interface CodecOptionsInit {
     maxBframes: number;
     repeatPreviousFrameAfter: number;
     maxPtsGapToEncoder: number;
+    intraRefreshPeriod: number;
 }
 
 function toDashCase(input: string) {
@@ -32,7 +30,7 @@ const CODEC_OPTION_TYPES: Partial<
 export class CodecOptions implements ScrcpyOptionValue {
     public value: Partial<CodecOptionsInit>;
 
-    public constructor(value: Partial<CodecOptionsInit>) {
+    public constructor(value: Partial<CodecOptionsInit> = {}) {
         this.value = value;
     }
 

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

@@ -4,17 +4,16 @@ import {
 } from "@yume-chan/stream-extra";
 import Struct from "@yume-chan/struct";
 
+import type {
+    ScrcpyBackOrScreenOnControlMessage,
+    ScrcpySetClipboardControlMessage,
+} from "../../control/index.js";
 import {
     AndroidKeyEventAction,
     ScrcpyControlMessageType,
-    type ScrcpyBackOrScreenOnControlMessage,
-    type ScrcpySetClipboardControlMessage,
 } from "../../control/index.js";
-import {
-    toScrcpyOptionValue,
-    type ScrcpyOptions,
-    type ScrcpyVideoStreamPacket,
-} from "../types.js";
+import type { ScrcpyOptions, ScrcpyVideoStreamPacket } from "../types.js";
+import { toScrcpyOptionValue } from "../types.js";
 
 import { CodecOptions } from "./codec-options.js";
 import {
@@ -22,10 +21,8 @@ import {
     parseSequenceParameterSet,
     removeH264Emulation,
 } from "./h264-configuration.js";
-import {
-    ScrcpyScrollController1_16,
-    type ScrcpyScrollController,
-} from "./scroll.js";
+import type { ScrcpyScrollController } from "./scroll.js";
+import { ScrcpyScrollController1_16 } from "./scroll.js";
 
 export enum ScrcpyLogLevel {
     Verbose = "verbose",
@@ -69,6 +66,14 @@ export interface ScrcpyOptionsInit1_16 {
      */
     lockVideoOrientation: ScrcpyVideoOrientation;
 
+    /**
+     * 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;
@@ -120,7 +125,7 @@ export const ScrcpySetClipboardControlMessage1_15 = new Struct()
     .string("content", { lengthField: "length" });
 
 export type ScrcpySetClipboardControlMessage1_15 =
-    typeof ScrcpySetClipboardControlMessage1_15["TInit"];
+    (typeof ScrcpySetClipboardControlMessage1_15)["TInit"];
 
 export class ScrcpyOptions1_16<
     T extends ScrcpyOptionsInit1_16 = ScrcpyOptionsInit1_16

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

@@ -1,9 +1,7 @@
 import Struct from "@yume-chan/struct";
 
-import {
-    ScrcpyControlMessageType,
-    type ScrcpyInjectScrollControlMessage,
-} from "../../control/index.js";
+import type { ScrcpyInjectScrollControlMessage } from "../../control/index.js";
+import { ScrcpyControlMessageType } from "../../control/index.js";
 
 export interface ScrcpyScrollController {
     serializeScrollMessage(

package/src/options/1_18.ts

@@ -1,15 +1,15 @@
 import Struct, { placeholder } from "@yume-chan/struct";
 
-import {
-    ScrcpyControlMessageType,
-    type AndroidKeyEventAction,
-    type ScrcpyBackOrScreenOnControlMessage,
+import type {
+    AndroidKeyEventAction,
+    ScrcpyBackOrScreenOnControlMessage,
 } from "../control/index.js";
+import { ScrcpyControlMessageType } from "../control/index.js";
 
+import type { ScrcpyOptionsInit1_16 } from "./1_16/options.js";
 import {
     ScrcpyBackOrScreenOnControlMessage1_16,
     ScrcpyOptions1_16,
-    type ScrcpyOptionsInit1_16,
 } from "./1_16/options.js";
 
 export interface ScrcpyOptionsInit1_18 extends ScrcpyOptionsInit1_16 {
@@ -21,7 +21,7 @@ export const ScrcpyBackOrScreenOnControlMessage1_18 = new Struct()
     .uint8("action", placeholder<AndroidKeyEventAction>());
 
 export type ScrcpyBackOrScreenOnControlMessage1_18 =
-    typeof ScrcpyBackOrScreenOnControlMessage1_18["TInit"];
+    (typeof ScrcpyBackOrScreenOnControlMessage1_18)["TInit"];
 
 export class ScrcpyOptions1_18<
     T extends ScrcpyOptionsInit1_18 = ScrcpyOptionsInit1_18

package/src/options/1_21.ts

@@ -2,12 +2,11 @@
 
 import Struct from "@yume-chan/struct";
 
-import {
-    ScrcpyControlMessageType,
-    type ScrcpySetClipboardControlMessage,
-} from "../control/index.js";
+import type { ScrcpySetClipboardControlMessage } from "../control/index.js";
+import { ScrcpyControlMessageType } from "../control/index.js";
 
-import { ScrcpyOptions1_18, type ScrcpyOptionsInit1_18 } from "./1_18.js";
+import type { ScrcpyOptionsInit1_18 } from "./1_18.js";
+import { ScrcpyOptions1_18 } from "./1_18.js";
 import { toScrcpyOptionValue } from "./types.js";
 
 export interface ScrcpyOptionsInit1_21 extends ScrcpyOptionsInit1_18 {
@@ -26,7 +25,7 @@ export const ScrcpySetClipboardControlMessage1_21 = new Struct()
     .string("content", { lengthField: "length" });
 
 export type ScrcpySetClipboardControlMessage1_21 =
-    typeof ScrcpySetClipboardControlMessage1_21["TInit"];
+    (typeof ScrcpySetClipboardControlMessage1_21)["TInit"];
 
 export class ScrcpyOptions1_21<
     T extends ScrcpyOptionsInit1_21 = ScrcpyOptionsInit1_21

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

@@ -1,5 +1,6 @@
-import { type ScrcpyScrollController } from "../1_16/index.js";
-import { ScrcpyOptions1_21, type ScrcpyOptionsInit1_21 } from "../1_21.js";
+import type { ScrcpyScrollController } from "../1_16/index.js";
+import type { ScrcpyOptionsInit1_21 } from "../1_21.js";
+import { ScrcpyOptions1_21 } from "../1_21.js";
 
 import { ScrcpyScrollController1_22 } from "./scroll.js";
 

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

@@ -10,7 +10,7 @@ export const ScrcpyInjectScrollControlMessage1_22 = new Struct()
     .int32("buttons");
 
 export type ScrcpyInjectScrollControlMessage1_22 =
-    typeof ScrcpyInjectScrollControlMessage1_22["TInit"];
+    (typeof ScrcpyInjectScrollControlMessage1_22)["TInit"];
 
 export class ScrcpyScrollController1_22 extends ScrcpyScrollController1_16 {
     public override serializeScrollMessage(