@yume-chan/scrcpy 2.3.0 → 3.0.0-beta.1

package/src/android/key-code-value.ts

@@ -0,0 +1,194 @@
+// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/view/KeyEvent.java;l=97;drc=95c1165bb895dd844e1793460710f7163dd330a3
+// Android key code to Chrome key code: https://source.chromium.org/chromium/chromium/src/+/main:ui/events/keycodes/keyboard_code_conversion_android.cc
+// Chrome key code to DOM key code: https://source.chromium.org/chromium/chromium/src/+/main:ui/events/keycodes/dom/dom_code_data.inc
+// Some keys are not mapped to `KeyboardEvent.code`, only to `KeyboardEvent.key`: https://source.chromium.org/chromium/chromium/src/+/main:ui/events/keycodes/dom/dom_key_data.inc
+
+export const AndroidHome = 3;
+export const AndroidBack = 4;
+export const AndroidCall = 5;
+export const AndroidEndCall = 6;
+
+export const Digit0 = 7;
+export const Digit1 = 8;
+export const Digit2 = 9;
+export const Digit3 = 10;
+export const Digit4 = 11;
+export const Digit5 = 12;
+export const Digit6 = 13;
+export const Digit7 = 14;
+export const Digit8 = 15;
+export const Digit9 = 16;
+
+/**
+ * '*' key.
+ */
+export const Star = 17; // Name not verified
+/**
+ * '#' key.
+ */
+export const Pound = 18; // Name not verified
+
+/**
+ * Directional Pad Up key.
+ */
+export const ArrowUp = 19;
+/**
+ * Directional Pad Down key.
+ */
+export const ArrowDown = 20;
+/**
+ * Directional Pad Left key.
+ */
+export const ArrowLeft = 21;
+/**
+ * Directional Pad Right key.
+ */
+export const ArrowRight = 22;
+/**
+ * Directional Pad Center key.
+ */
+export const AndroidDPadCenter = 23;
+
+export const VolumeUp = 24; // Name not verified
+export const VolumeDown = 25; // Name not verified
+export const Power = 26; // Name not verified
+export const AndroidCamera = 27;
+export const Clear = 28; // Name not verified
+
+export const KeyA = 29;
+export const KeyB = 30;
+export const KeyC = 31;
+export const KeyD = 32;
+export const KeyE = 33;
+export const KeyF = 34;
+export const KeyG = 35;
+export const KeyH = 36;
+export const KeyI = 37;
+export const KeyJ = 38;
+export const KeyK = 39;
+export const KeyL = 40;
+export const KeyM = 41;
+export const KeyN = 42;
+export const KeyO = 43;
+export const KeyP = 44;
+export const KeyQ = 45;
+export const KeyR = 46;
+export const KeyS = 47;
+export const KeyT = 48;
+export const KeyU = 49;
+export const KeyV = 50;
+export const KeyW = 51;
+export const KeyX = 52;
+export const KeyY = 53;
+export const KeyZ = 54;
+export const Comma = 55;
+export const Period = 56;
+export const AltLeft = 57;
+export const AltRight = 58;
+export const ShiftLeft = 59;
+export const ShiftRight = 60;
+export const Tab = 61;
+export const Space = 62;
+export const AndroidSymbol = 63;
+export const AndroidExplorer = 64;
+export const AndroidEnvelope = 65;
+export const Enter = 66;
+export const Backspace = 67;
+export const Backquote = 68;
+export const Minus = 69;
+export const Equal = 70;
+export const BracketLeft = 71;
+export const BracketRight = 72;
+export const Backslash = 73;
+export const Semicolon = 74;
+export const Quote = 75;
+export const Slash = 76;
+export const At = 77; // Name not verified
+
+/**
+ * Number modifier key.
+ *
+ * Used to enter numeric symbols.
+ * This key is not Num Lock; it is more like {@link AltLeft} and is
+ * interpreted as an ALT key by `android.text.method.MetaKeyKeyListener`.
+ */
+export const AndroidNum = 78;
+/**
+ * Headset Hook key.
+ *
+ * Used to hang up calls and stop media.
+ */
+export const AndroidHeadsetHook = 79;
+/**
+ * Camera Focus key.
+ *
+ * Used to focus the camera.
+ */
+export const AndroidFocus = 80;
+
+export const Plus = 81; // Name not verified
+export const ContextMenu = 82;
+export const AndroidNotification = 83;
+export const AndroidSearch = 84;
+
+export const PageUp = 92;
+export const PageDown = 93;
+
+export const Escape = 111;
+export const Delete = 112;
+export const ControlLeft = 113;
+export const ControlRight = 114;
+export const CapsLock = 115;
+export const ScrollLock = 116;
+export const MetaLeft = 117;
+export const MetaRight = 118;
+export const AndroidFunction = 119;
+export const PrintScreen = 120;
+export const Pause = 121;
+
+export const Home = 122;
+export const End = 123;
+export const Insert = 124;
+export const AndroidForward = 125;
+
+export const F1 = 131;
+export const F2 = 132;
+export const F3 = 133;
+export const F4 = 134;
+export const F5 = 135;
+export const F6 = 136;
+export const F7 = 137;
+export const F8 = 138;
+export const F9 = 139;
+export const F10 = 140;
+export const F11 = 141;
+export const F12 = 142;
+
+export const NumLock = 143;
+export const Numpad0 = 144;
+export const Numpad1 = 145;
+export const Numpad2 = 146;
+export const Numpad3 = 147;
+export const Numpad4 = 148;
+export const Numpad5 = 149;
+export const Numpad6 = 150;
+export const Numpad7 = 151;
+export const Numpad8 = 152;
+export const Numpad9 = 153;
+export const NumpadDivide = 154;
+export const NumpadMultiply = 155;
+export const NumpadSubtract = 156;
+export const NumpadAdd = 157;
+export const NumpadDecimal = 158;
+export const NumpadComma = 159; // Name not verified
+export const NumpadEnter = 160;
+export const NumpadEquals = 161; // Name not verified
+export const NumpadLeftParen = 162; // Name not verified
+export const NumpadRightParen = 163; // Name not verified
+
+export const VolumeMute = 164; // Name not verified
+export const AndroidAppSwitch = 187; // Name not verified
+
+export const AndroidCut = 277;
+export const AndroidCopy = 278;
+export const AndroidPaste = 279;

package/src/android/key-event.ts

@@ -1,3 +1,5 @@
+import * as AndroidKeyCode from "./key-code-value.js";
+
 export const AndroidKeyEventAction = {
     Down: 0,
     Up: 1,
@@ -29,189 +31,10 @@ export const AndroidKeyEventMeta = {
 export type AndroidKeyEventMeta =
     (typeof AndroidKeyEventMeta)[keyof typeof AndroidKeyEventMeta];
 
-// https://cs.android.com/android/platform/superproject/+/master:frameworks/base/core/java/android/view/KeyEvent.java;l=97;drc=95c1165bb895dd844e1793460710f7163dd330a3
-// Android key code to Chrome key code: https://source.chromium.org/chromium/chromium/src/+/main:ui/events/keycodes/keyboard_code_conversion_android.cc
-// Chrome key code to DOM key code: https://source.chromium.org/chromium/chromium/src/+/main:ui/events/keycodes/dom/dom_code_data.inc
-// Some keys are not mapped to `KeyboardEvent.code`, only to `KeyboardEvent.key`: https://source.chromium.org/chromium/chromium/src/+/main:ui/events/keycodes/dom/dom_key_data.inc
-export const AndroidKeyCode = {
-    AndroidHome: 3,
-    AndroidBack: 4,
-    AndroidCall: 5,
-    AndroidEndCall: 6,
-
-    Digit0: 7,
-    Digit1: 8,
-    Digit2: 9,
-    Digit3: 10,
-    Digit4: 11,
-    Digit5: 12,
-    Digit6: 13,
-    Digit7: 14,
-    Digit8: 15,
-    Digit9: 16,
-    /**
-     * '*' key.
-     */
-    Star: 17, // Name not verified
-    /**
-     * '#' key.
-     */
-    Pound: 18, // Name not verified
-
-    /**
-     * Directional Pad Up key.
-     */
-    ArrowUp: 19,
-    /**
-     * Directional Pad Down key.
-     */
-    ArrowDown: 20,
-    /**
-     * Directional Pad Left key.
-     */
-    ArrowLeft: 21,
-    /**
-     * Directional Pad Right key.
-     */
-    ArrowRight: 22,
-    /**
-     * Directional Pad Center key.
-     */
-    AndroidDPadCenter: 23,
-
-    VolumeUp: 24, // Name not verified
-    VolumeDown: 25, // Name not verified
-    Power: 26, // Name not verified
-    AndroidCamera: 27,
-    Clear: 28, // Name not verified
-
-    KeyA: 29,
-    KeyB: 30,
-    KeyC: 31,
-    KeyD: 32,
-    KeyE: 33,
-    KeyF: 34,
-    KeyG: 35,
-    KeyH: 36,
-    KeyI: 37,
-    KeyJ: 38,
-    KeyK: 39,
-    KeyL: 40,
-    KeyM: 41,
-    KeyN: 42,
-    KeyO: 43,
-    KeyP: 44,
-    KeyQ: 45,
-    KeyR: 46,
-    KeyS: 47,
-    KeyT: 48,
-    KeyU: 49,
-    KeyV: 50,
-    KeyW: 51,
-    KeyX: 52,
-    KeyY: 53,
-    KeyZ: 54,
-    Comma: 55,
-    Period: 56,
-    AltLeft: 57,
-    AltRight: 58,
-    ShiftLeft: 59,
-    ShiftRight: 60,
-    Tab: 61,
-    Space: 62,
-    AndroidSymbol: 63,
-    AndroidExplorer: 64,
-    AndroidEnvelope: 65,
-    Enter: 66,
-    Backspace: 67,
-    Backquote: 68,
-    Minus: 69,
-    Equal: 70,
-    BracketLeft: 71,
-    BracketRight: 72,
-    Backslash: 73,
-    Semicolon: 74,
-    Quote: 75,
-    Slash: 76,
-    At: 77, // Name not verified
-
-    AndroidNum: 78,
-    AndroidHeadsetHook: 79,
-    /**
-     * Camera Focus key。
-     */
-    AndroidFocus: 80,
-
-    Plus: 81, // Name not verified
-    ContextMenu: 82,
-    AndroidNotification: 83,
-    AndroidSearch: 84,
-
-    PageUp: 92,
-    PageDown: 93,
-
-    Escape: 111,
-    Delete: 112,
-    ControlLeft: 113,
-    ControlRight: 114,
-    CapsLock: 115,
-    ScrollLock: 116,
-    MetaLeft: 117,
-    MetaRight: 118,
-    AndroidFunction: 119,
-    PrintScreen: 120,
-    Pause: 121,
-
-    Home: 122,
-    End: 123,
-    Insert: 124,
-    AndroidForward: 125,
-
-    F1: 131,
-    F2: 132,
-    F3: 133,
-    F4: 134,
-    F5: 135,
-    F6: 136,
-    F7: 137,
-    F8: 138,
-    F9: 139,
-    F10: 140,
-    F11: 141,
-    F12: 142,
-
-    NumLock: 143,
-    Numpad0: 144,
-    Numpad1: 145,
-    Numpad2: 146,
-    Numpad3: 147,
-    Numpad4: 148,
-    Numpad5: 149,
-    Numpad6: 150,
-    Numpad7: 151,
-    Numpad8: 152,
-    Numpad9: 153,
-    NumpadDivide: 154,
-    NumpadMultiply: 155,
-    NumpadSubtract: 156,
-    NumpadAdd: 157,
-    NumpadDecimal: 158,
-    NumpadComma: 159, // Name not verified
-    NumpadEnter: 160,
-    NumpadEquals: 161, // Name not verified
-    NumpadLeftParen: 162, // Name not verified
-    NumpadRightParen: 163, // Name not verified
-
-    VolumeMute: 164, // Name not verified
-    AndroidAppSwitch: 187, // Name not verified
-
-    AndroidCut: 277,
-    AndroidCopy: 278,
-    AndroidPaste: 279,
-} as const;
+// biome-ignore lint/suspicious/noRedeclare: TypeScript declaration merging for enum-like object
+type AndroidKeyCode = (typeof AndroidKeyCode)[keyof typeof AndroidKeyCode];
 
-export type AndroidKeyCode =
-    (typeof AndroidKeyCode)[keyof typeof AndroidKeyCode];
+export { AndroidKeyCode };
 
 export const AndroidKeyNames = /* #__PURE__ */ (() =>
     Object.fromEntries(

package/src/base/control-message-type-value.ts

@@ -0,0 +1,23 @@
+export const InjectKeyCode = 0;
+export const InjectText = 1;
+export const InjectTouch = 2;
+export const InjectScroll = 3;
+export const BackOrScreenOn = 4;
+export const ExpandNotificationPanel = 5;
+export const ExpandSettingPanel = 6;
+export const CollapseNotificationPanel = 7;
+export const GetClipboard = 8;
+export const SetClipboard = 9;
+export const SetDisplayPower = 10;
+export const RotateDevice = 11;
+export const UHidCreate = 12;
+export const UHidInput = 13;
+export const UHidDestroy = 14;
+export const OpenHardKeyboardSettings = 15;
+export const StartApp = 16;
+export const ResetVideo = 17;
+export const CameraSetTorch = 18;
+export const CameraZoomIn = 19;
+export const CameraZoomOut = 20;
+export const ResizeDisplay = 21;
+export const ScanFile = 22;

package/src/base/control-message-type.ts

@@ -1,24 +1,8 @@
-// Their IDs change between versions, so always use `options.getControlMessageTypes()`
-export const ScrcpyControlMessageType = {
-    InjectKeyCode: 0,
-    InjectText: 1,
-    InjectTouch: 2,
-    InjectScroll: 3,
-    BackOrScreenOn: 4,
-    ExpandNotificationPanel: 5,
-    ExpandSettingPanel: 6,
-    CollapseNotificationPanel: 7,
-    GetClipboard: 8,
-    SetClipboard: 9,
-    SetDisplayPower: 10,
-    RotateDevice: 11,
-    UHidCreate: 12,
-    UHidInput: 13,
-    UHidDestroy: 14,
-    OpenHardKeyboardSettings: 15,
-    StartApp: 16,
-    ResetVideo: 17,
-} as const;
+import * as ScrcpyControlMessageType from "./control-message-type-value.js";
 
-export type ScrcpyControlMessageType =
+// These IDs change between versions, so always use `options.controlMessageTypes`
+// biome-ignore lint/suspicious/noRedeclare: TypeScript declaration merging for enum-like object
+type ScrcpyControlMessageType =
     (typeof ScrcpyControlMessageType)[keyof typeof ScrcpyControlMessageType];
+
+export { ScrcpyControlMessageType };

package/src/base/media.ts

@@ -10,6 +10,15 @@ export interface ScrcpyMediaStreamDataPacket {
     data: Uint8Array;
 }
 
-export type ScrcpyMediaStreamPacket =
-    | ScrcpyMediaStreamConfigurationPacket
-    | ScrcpyMediaStreamDataPacket;
+export interface ScrcpyVideoStreamSessionPacket {
+    type: "session";
+    isClientResize: boolean;
+    width: number;
+    height: number;
+}
+
+export type ScrcpyAudioStreamPacket =
+    ScrcpyMediaStreamConfigurationPacket | ScrcpyMediaStreamDataPacket;
+
+export type ScrcpyVideoStreamPacket =
+    ScrcpyAudioStreamPacket | ScrcpyVideoStreamSessionPacket;

package/src/base/options.ts

@@ -5,6 +5,7 @@ import type {
     ScrcpyBackOrScreenOnControlMessage,
     ScrcpyInjectTouchControlMessage,
     ScrcpySetClipboardControlMessage,
+    ScrcpySetDisplayPowerControlMessage,
     ScrcpyUHidCreateControlMessage,
     ScrcpyUHidOutputDeviceMessage,
 } from "../latest.js";
@@ -14,20 +15,29 @@ import type { ScrcpyControlMessageType } from "./control-message-type.js";
 import type { ScrcpyDeviceMessageParsers } from "./device-message.js";
 import type { ScrcpyDisplay } from "./display.js";
 import type { ScrcpyEncoder } from "./encoder.js";
-import type { ScrcpyMediaStreamPacket } from "./media.js";
+import type { ScrcpyVideoStreamPacket } from "./media.js";
 import type { ScrcpyScrollController } from "./scroll-controller.js";
 import type { ScrcpyVideoStream } from "./video.js";
 
+export type ScrcpyControlMessageTypeMap = Partial<
+    Record<ScrcpyControlMessageType, number>
+>;
+
+// Distributive Conditional Types
+// (https://www.typescriptlang.org/docs/handbook/2/conditional-types.html#distributive-conditional-types)
+export type MapBoolean<T extends boolean, TTrue, TFalse> = T extends true
+    ? TTrue
+    : TFalse;
+
 export interface ScrcpyOptions<T extends object> {
-    get controlMessageTypes(): readonly ScrcpyControlMessageType[];
+    get controlMessageTypes(): ScrcpyControlMessageTypeMap;
 
-    value: Required<T>;
+    value: T;
 
     readonly clipboard?: ReadableStream<string> | undefined;
 
     readonly uHidOutput?:
-        | ReadableStream<ScrcpyUHidOutputDeviceMessage>
-        | undefined;
+        ReadableStream<ScrcpyUHidOutputDeviceMessage> | undefined;
 
     readonly deviceMessageParsers: ScrcpyDeviceMessageParsers;
 
@@ -47,7 +57,7 @@ export interface ScrcpyOptions<T extends object> {
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     >;
 
     serializeInjectTouchControlMessage(
@@ -62,6 +72,10 @@ export interface ScrcpyOptions<T extends object> {
         message: ScrcpySetClipboardControlMessage,
     ): Uint8Array | [Uint8Array, Promise<void>];
 
+    serializeSetDisplayPowerControlMessage(
+        message: ScrcpySetDisplayPowerControlMessage,
+    ): Uint8Array;
+
     createScrollController(): ScrcpyScrollController;
 
     serializeUHidCreateControlMessage?(

package/src/base/video.ts

@@ -1,5 +1,7 @@
 import type { ReadableStream } from "@yume-chan/stream-extra";
 
+import type { ScrcpyVideoCodecId } from "../video/index.js";
+
 export interface ScrcpyVideoStream {
     readonly stream: ReadableStream<Uint8Array>;
     readonly metadata: ScrcpyVideoStreamMetadata;
@@ -11,22 +13,3 @@ export interface ScrcpyVideoStreamMetadata {
     height?: number | undefined;
     codec: ScrcpyVideoCodecId;
 }
-
-export const ScrcpyVideoCodecId = {
-    H264: 0x68_32_36_34,
-    H265: 0x68_32_36_35,
-    AV1: 0x00_61_76_31,
-} as const;
-
-export type ScrcpyVideoCodecId =
-    (typeof ScrcpyVideoCodecId)[keyof typeof ScrcpyVideoCodecId];
-
-export const ScrcpyVideoCodecNameMap = /* #__PURE__ */ (() => {
-    const result = new Map<number, string>();
-    for (const key in ScrcpyVideoCodecId) {
-        const value =
-            ScrcpyVideoCodecId[key as keyof typeof ScrcpyVideoCodecId];
-        result.set(value, key);
-    }
-    return result;
-})();

package/src/control/boolean.ts

@@ -0,0 +1,9 @@
+import type { StructInit } from "@yume-chan/struct";
+import { struct, u8 } from "@yume-chan/struct";
+
+export const BooleanControlMessage = struct(
+    { type: u8, value: u8<boolean>() },
+    { littleEndian: false },
+);
+
+export type BooleanControlMessage = StructInit<typeof BooleanControlMessage>;

package/src/control/index.ts

@@ -1,7 +1,7 @@
+export * from "./boolean.js";
 export * from "./empty.js";
 export * from "./inject-key-code.js";
 export * from "./inject-text.js";
-export * from "./message-type-map.js";
+export * from "./resize-display.js";
 export * from "./serializer.js";
-export * from "./set-screen-power-mode.js";
 export * from "./writer.js";

package/src/control/inject-key-code.ts

@@ -6,19 +6,18 @@ import type {
     AndroidKeyEventAction,
     AndroidKeyEventMeta,
 } from "../android/index.js";
-import { ScrcpyControlMessageType } from "../base/index.js";
 
-export const ScrcpyInjectKeyCodeControlMessage = /* #__PURE__ */ (() =>
-    struct(
-        {
-            type: u8(ScrcpyControlMessageType.InjectKeyCode),
-            action: u8<AndroidKeyEventAction>(),
-            keyCode: u32<AndroidKeyCode>(),
-            repeat: u32,
-            metaState: u32<AndroidKeyEventMeta>(),
-        },
-        { littleEndian: false },
-    ))();
+export const ScrcpyInjectKeyCodeControlMessage = struct(
+    {
+        // value of `type` can change between versions
+        type: u8,
+        action: u8<AndroidKeyEventAction>(),
+        keyCode: u32<AndroidKeyCode>(),
+        repeat: u32,
+        metaState: u32<AndroidKeyEventMeta>(),
+    },
+    { littleEndian: false },
+);
 
 export type ScrcpyInjectKeyCodeControlMessage = StructInit<
     typeof ScrcpyInjectKeyCodeControlMessage

package/src/control/inject-text.ts

@@ -2,7 +2,11 @@ import type { StructInit } from "@yume-chan/struct";
 import { string, struct, u32, u8 } from "@yume-chan/struct";
 
 export const ScrcpyInjectTextControlMessage = struct(
-    { type: u8, text: string(u32) },
+    {
+        // value of `type` can change between versions
+        type: u8,
+        text: string(u32),
+    },
     { littleEndian: false },
 );
 

package/src/control/resize-display.ts

@@ -0,0 +1,16 @@
+import type { StructInit } from "@yume-chan/struct";
+import { struct, u16, u8 } from "@yume-chan/struct";
+
+export const ScrcpyResizeDisplayControlMessage = struct(
+    {
+        // value of `type` can change between versions
+        type: u8,
+        width: u16,
+        height: u16,
+    },
+    { littleEndian: false },
+);
+
+export type ScrcpyResizeDisplayControlMessage = StructInit<
+    typeof ScrcpyResizeDisplayControlMessage
+>;