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

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/serializer.ts

@@ -14,7 +14,6 @@ import type {
 import { EmptyControlMessage } from "./empty.js";
 import { ScrcpyInjectKeyCodeControlMessage } from "./inject-key-code.js";
 import { ScrcpyInjectTextControlMessage } from "./inject-text.js";
-import { ScrcpyControlMessageTypeMap } from "./message-type-map.js";
 import { ScrcpySetDisplayPowerControlMessage } from "./set-screen-power-mode.js";
 import { ScrcpyStartAppControlMessage } from "./start-app.js";
 import {
@@ -24,28 +23,39 @@ import {
 
 export class ScrcpyControlMessageSerializer {
     #options: ScrcpyOptions<object>;
-    #typeMap: ScrcpyControlMessageTypeMap;
     #scrollController: ScrcpyScrollController;
 
     constructor(options: ScrcpyOptions<object>) {
         this.#options = options;
-        this.#typeMap = new ScrcpyControlMessageTypeMap(options);
         this.#scrollController = options.createScrollController();
     }
 
+    getType(type: ScrcpyControlMessageType): number {
+        const value = this.#options.controlMessageTypes[type];
+        if (value === undefined) {
+            throw new TypeError(`Invalid control message type: ${type}`);
+        }
+        return value;
+    }
+
+    #addType<T extends { type: number }>(
+        message: Omit<T, "type">,
+        type: ScrcpyControlMessageType,
+    ): T {
+        (message as T).type = this.getType(type);
+        return message as T;
+    }
+
     injectKeyCode(message: Omit<ScrcpyInjectKeyCodeControlMessage, "type">) {
         return ScrcpyInjectKeyCodeControlMessage.serialize(
-            this.#typeMap.fillMessageType(
-                message,
-                ScrcpyControlMessageType.InjectKeyCode,
-            ),
+            this.#addType(message, ScrcpyControlMessageType.InjectKeyCode),
         );
     }
 
     injectText(text: string) {
         return ScrcpyInjectTextControlMessage.serialize({
             text,
-            type: this.#typeMap.get(ScrcpyControlMessageType.InjectText),
+            type: this.getType(ScrcpyControlMessageType.InjectText),
         });
     }
 
@@ -54,10 +64,7 @@ export class ScrcpyControlMessageSerializer {
      */
     injectTouch(message: Omit<ScrcpyInjectTouchControlMessage, "type">) {
         return this.#options.serializeInjectTouchControlMessage(
-            this.#typeMap.fillMessageType(
-                message,
-                ScrcpyControlMessageType.InjectTouch,
-            ),
+            this.#addType(message, ScrcpyControlMessageType.InjectTouch),
         );
     }
 
@@ -66,30 +73,27 @@ export class ScrcpyControlMessageSerializer {
      */
     injectScroll(message: Omit<ScrcpyInjectScrollControlMessage, "type">) {
         return this.#scrollController.serializeScrollMessage(
-            this.#typeMap.fillMessageType(
-                message,
-                ScrcpyControlMessageType.InjectScroll,
-            ),
+            this.#addType(message, ScrcpyControlMessageType.InjectScroll),
         );
     }
 
     backOrScreenOn(action: AndroidKeyEventAction) {
         return this.#options.serializeBackOrScreenOnControlMessage({
             action,
-            type: this.#typeMap.get(ScrcpyControlMessageType.BackOrScreenOn),
+            type: this.getType(ScrcpyControlMessageType.BackOrScreenOn),
         });
     }
 
     setDisplayPower(mode: AndroidScreenPowerMode) {
         return ScrcpySetDisplayPowerControlMessage.serialize({
             mode,
-            type: this.#typeMap.get(ScrcpyControlMessageType.SetDisplayPower),
+            type: this.getType(ScrcpyControlMessageType.SetDisplayPower),
         });
     }
 
     expandNotificationPanel() {
         return EmptyControlMessage.serialize({
-            type: this.#typeMap.get(
+            type: this.getType(
                 ScrcpyControlMessageType.ExpandNotificationPanel,
             ),
         });
@@ -97,15 +101,13 @@ export class ScrcpyControlMessageSerializer {
 
     expandSettingPanel() {
         return EmptyControlMessage.serialize({
-            type: this.#typeMap.get(
-                ScrcpyControlMessageType.ExpandSettingPanel,
-            ),
+            type: this.getType(ScrcpyControlMessageType.ExpandSettingPanel),
         });
     }
 
     collapseNotificationPanel() {
         return EmptyControlMessage.serialize({
-            type: this.#typeMap.get(
+            type: this.getType(
                 ScrcpyControlMessageType.CollapseNotificationPanel,
             ),
         });
@@ -113,14 +115,14 @@ export class ScrcpyControlMessageSerializer {
 
     rotateDevice() {
         return EmptyControlMessage.serialize({
-            type: this.#typeMap.get(ScrcpyControlMessageType.RotateDevice),
+            type: this.getType(ScrcpyControlMessageType.RotateDevice),
         });
     }
 
     setClipboard(message: Omit<ScrcpySetClipboardControlMessage, "type">) {
         return this.#options.serializeSetClipboardControlMessage({
             ...message,
-            type: this.#typeMap.get(ScrcpyControlMessageType.SetClipboard),
+            type: this.getType(ScrcpyControlMessageType.SetClipboard),
         });
     }
 
@@ -130,25 +132,19 @@ export class ScrcpyControlMessageSerializer {
         }
 
         return this.#options.serializeUHidCreateControlMessage(
-            this.#typeMap.fillMessageType(
-                message,
-                ScrcpyControlMessageType.UHidCreate,
-            ),
+            this.#addType(message, ScrcpyControlMessageType.UHidCreate),
         );
     }
 
     uHidInput(message: Omit<ScrcpyUHidInputControlMessage, "type">) {
         return ScrcpyUHidInputControlMessage.serialize(
-            this.#typeMap.fillMessageType(
-                message,
-                ScrcpyControlMessageType.UHidInput,
-            ),
+            this.#addType(message, ScrcpyControlMessageType.UHidInput),
         );
     }
 
     uHidDestroy(id: number) {
         return ScrcpyUHidDestroyControlMessage.serialize({
-            type: this.#typeMap.get(ScrcpyControlMessageType.UHidDestroy),
+            type: this.getType(ScrcpyControlMessageType.UHidDestroy),
             id,
         });
     }
@@ -165,14 +161,14 @@ export class ScrcpyControlMessageSerializer {
         }
 
         return ScrcpyStartAppControlMessage.serialize({
-            type: this.#typeMap.get(ScrcpyControlMessageType.StartApp),
+            type: this.getType(ScrcpyControlMessageType.StartApp),
             name,
         });
     }
 
     resetVideo() {
         return EmptyControlMessage.serialize({
-            type: this.#typeMap.get(ScrcpyControlMessageType.ResetVideo),
+            type: this.getType(ScrcpyControlMessageType.ResetVideo),
         });
     }
 }

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

@@ -4,7 +4,11 @@ import { struct, u8 } from "@yume-chan/struct";
 import type { AndroidScreenPowerMode } from "../android/index.js";
 
 export const ScrcpySetDisplayPowerControlMessage = struct(
-    { type: u8, mode: u8<AndroidScreenPowerMode>() },
+    {
+        // value of `type` can change between versions
+        type: u8,
+        mode: u8<AndroidScreenPowerMode>(),
+    },
     { littleEndian: false },
 );
 

package/src/control/start-app.ts

@@ -3,6 +3,7 @@ import { string, struct, u8 } from "@yume-chan/struct";
 
 export const ScrcpyStartAppControlMessage = struct(
     {
+        // value of `type` can change between versions
         type: u8,
         name: string(u8),
     },

package/src/control/uhid.ts

@@ -1,24 +1,26 @@
 import type { StructInit } from "@yume-chan/struct";
 import { buffer, struct, u16, u8 } from "@yume-chan/struct";
 
-import { ScrcpyControlMessageType } from "../base/index.js";
-
-export const ScrcpyUHidInputControlMessage = /* #__PURE__ */ (() =>
-    struct(
-        {
-            type: u8(ScrcpyControlMessageType.UHidInput),
-            id: u16,
-            data: buffer(u16),
-        },
-        { littleEndian: false },
-    ))();
+export const ScrcpyUHidInputControlMessage = struct(
+    {
+        // value of `type` can change between versions
+        type: u8,
+        id: u16,
+        data: buffer(u16),
+    },
+    { littleEndian: false },
+);
 
 export type ScrcpyUHidInputControlMessage = StructInit<
     typeof ScrcpyUHidInputControlMessage
 >;
 
 export const ScrcpyUHidDestroyControlMessage = struct(
-    { type: u8, id: u16 },
+    {
+        // value of `type` can change between versions
+        type: u8,
+        id: u16,
+    },
     { littleEndian: false },
 );
 

package/src/control/writer.ts

@@ -67,7 +67,7 @@ export class ScrcpyControlMessageWriter {
         }
     }
 
-    setScreenPowerMode(mode: AndroidScreenPowerMode) {
+    setDisplayPower(mode: AndroidScreenPowerMode) {
         return this.write(this.#serializer.setDisplayPower(mode));
     }
 

package/src/index.ts

@@ -30,9 +30,10 @@ export * from "./3_3.js";
 export * from "./3_3_1/index.js";
 export * from "./3_3_2.js";
 export * from "./3_3_3.js";
+export * from "./3_3_4.js";
 export * from "./android/index.js";
 export * from "./base/index.js";
-export * from "./codec/index.js";
 export * from "./control/index.js";
 export * from "./latest.js";
 export * from "./utils/index.js";
+export * from "./video/index.js";

package/src/latest.ts

@@ -1,9 +1,10 @@
-export { ScrcpyOptions3_3_3 as ScrcpyOptionsLatest } from "./3_3_3.js";
+export { ScrcpyOptions3_3_2 as ScrcpyOptionsLatest } from "./3_3_2.js";
 
 export {
     BackOrScreenOnControlMessage as ScrcpyBackOrScreenOnControlMessage,
     CaptureOrientation as ScrcpyCaptureOrientation,
     CodecOptions as ScrcpyCodecOptions,
+    VideoCodecOptions as ScrcpyVideoCodecOptions,
     Crop as ScrcpyCrop,
     InjectScrollControlMessage as ScrcpyInjectScrollControlMessage,
     InjectTouchControlMessage as ScrcpyInjectTouchControlMessage,

package/src/video/android.ts

@@ -0,0 +1,72 @@
+// From https://developer.android.com/reference/android/media/MediaCodecInfo.CodecProfileLevel
+export const AndroidAvcProfile = {
+    Baseline: 1 << 0,
+    Main: 1 << 1,
+    Extended: 1 << 2,
+    High: 1 << 3,
+    High10: 1 << 4,
+    High422: 1 << 5,
+    High444: 1 << 6,
+    ConstrainedBaseline: 1 << 16,
+    ConstrainedHigh: 1 << 19,
+};
+
+export const AndroidAvcLevel = {
+    Level1: 1 << 0,
+    Level1b: 1 << 1,
+    Level11: 1 << 2,
+    Level12: 1 << 3,
+    Level13: 1 << 4,
+    Level2: 1 << 5,
+    Level21: 1 << 6,
+    Level22: 1 << 7,
+    Level3: 1 << 8,
+    Level31: 1 << 9,
+    Level32: 1 << 10,
+    Level4: 1 << 11,
+    Level41: 1 << 12,
+    Level42: 1 << 13,
+    Level5: 1 << 14,
+    Level51: 1 << 15,
+    Level52: 1 << 16,
+    Level6: 1 << 17,
+    Level61: 1 << 18,
+    Level62: 1 << 19,
+};
+
+export const AndroidHevcProfile = {
+    Main: 1 << 0,
+    Main10: 1 << 1,
+    MainStill: 1 << 2,
+    Main10Hdr10: 1 << 12,
+    Main10Hdr10Plus: 1 << 13,
+};
+
+export const AndroidHevcLevel = {
+    MainTierLevel1: 1 << 0,
+    HighTierLevel1: 1 << 1,
+    MainTierLevel2: 1 << 2,
+    HighTierLevel2: 1 << 3,
+    MainTierLevel21: 1 << 4,
+    HighTierLevel21: 1 << 5,
+    MainTierLevel3: 1 << 6,
+    HighTierLevel3: 1 << 7,
+    MainTierLevel31: 1 << 8,
+    HighTierLevel31: 1 << 9,
+    MainTierLevel4: 1 << 10,
+    HighTierLevel4: 1 << 11,
+    MainTierLevel41: 1 << 12,
+    HighTierLevel41: 1 << 13,
+    MainTierLevel5: 1 << 14,
+    HighTierLevel5: 1 << 15,
+    MainTierLevel51: 1 << 16,
+    HighTierLevel51: 1 << 17,
+    MainTierLevel52: 1 << 18,
+    HighTierLevel52: 1 << 19,
+    MainTierLevel6: 1 << 20,
+    HighTierLevel6: 1 << 21,
+    MainTierLevel61: 1 << 22,
+    HighTierLevel61: 1 << 23,
+    MainTierLevel62: 1 << 24,
+    HighTierLevel62: 1 << 25,
+};

package/src/video/index.ts

@@ -0,0 +1,2 @@
+export * from "./android.js";
+export * from "./size.js";

package/src/video/size.ts

@@ -0,0 +1,40 @@
+import type { Event } from "@yume-chan/event";
+import { StickyEventEmitter } from "@yume-chan/event";
+
+export interface ScrcpyVideoSize {
+    readonly width: number;
+    readonly height: number;
+
+    readonly sizeChanged: Event<{ width: number; height: number }>;
+}
+
+export class ScrcpyVideoSizeImpl implements ScrcpyVideoSize {
+    #width: number = 0;
+    get width() {
+        return this.#width;
+    }
+
+    #height: number = 0;
+    get height() {
+        return this.#height;
+    }
+
+    #sizeChanged = new StickyEventEmitter<{ width: number; height: number }>();
+    get sizeChanged() {
+        return this.#sizeChanged.event;
+    }
+
+    setSize(width: number, height: number) {
+        if (this.#width === width && this.#height === height) {
+            return;
+        }
+
+        this.#width = width;
+        this.#height = height;
+        this.#sizeChanged.fire({ width, height });
+    }
+
+    dispose() {
+        this.#sizeChanged.dispose();
+    }
+}

package/tsconfig.build.json

@@ -1,11 +1,3 @@
 {
     "extends": "./node_modules/@yume-chan/tsconfig/tsconfig.base.json",
-    "references": [
-        {
-            "path": "../stream-extra/tsconfig.build.json"
-        },
-        {
-            "path": "../struct/tsconfig.build.json"
-        }
-    ]
 }

package/CHANGELOG.md

@@ -1,224 +0,0 @@
-# Change Log - @yume-chan/scrcpy
-
-## 2.3.0
-
-### Minor Changes
-
-- ec2ec23: Add client version 3.3.3
-
-## 2.2.0
-
-### Minor Changes
-
-- f34724f: Add support for Scrcpy server version 3.3.2 (no protocol changes)
-
-## 2.1.1
-
-### Patch Changes
-
-- 7edd616: Fix UHID output stream doesn't work from server version 2.6
-- e0def5b: Add support for server version 3.3.1
-
-## 2.1.0
-
-### Patch Changes
-
-- Updated dependencies [40a60ca]
-    - @yume-chan/stream-extra@2.1.0
-
-## 2.0.1
-
-### Patch Changes
-
-- Updated dependencies [0bcb9b8]
-    - @yume-chan/struct@2.0.1
-    - @yume-chan/stream-extra@2.0.1
-
-## 2.0.0
-
-### Major Changes
-
-- fe06652: Move `version` parameter to `AdbScrcpyOptions`
-
-### Minor Changes
-
-- 02f5bd5: Add alias for all AdbScrcpyOptions versions
-
-### Patch Changes
-
-- Updated dependencies [b79df96]
-- Updated dependencies
-    - @yume-chan/struct@2.0.0
-    - @yume-chan/no-data-view@2.0.0
-    - @yume-chan/stream-extra@2.0.0
-
-## 1.1.0
-
-### Minor Changes
-
-- 8c5b3c2: Add support for Scrcpy 3.1
-- cb44b63: Move `version` info to option classes and provide default values
-
-### Patch Changes
-
-- 6140ebc: Accept raw (serialized) values for complex options
-- 6140ebc: Add `ScrcpyCrop` class for the `crop` option
-- 6140ebc: Add aliases for all Scrcpy patch versions
-- 7f2a09c: Fix incorrect scroll controller in version 1.22 and later
-
-## 1.0.1
-
-### Patch Changes
-
-- 53688d3: Use PNPM workspace and Changesets to manage the monorepo.
-
-    Because Changesets doesn't support alpha versions (`0.x.x`), this version is `1.0.0`. Future versions will follow SemVer rules, for example, breaking API changes will introduce a new major version.
-
-- db8466f: Rewrite the struct API completely
-- ea5002b: Add support up to Scrcpy version 3.0
-- db8466f: Improve tree-shaking by removing TypeScript enum and namespace
-- Updated dependencies [53688d3]
-- Updated dependencies [db8466f]
-- Updated dependencies [ea5002b]
-- Updated dependencies [db8466f]
-    - @yume-chan/no-data-view@1.0.1
-    - @yume-chan/stream-extra@1.0.1
-    - @yume-chan/struct@1.0.1
-
-This log was last generated on Tue, 18 Jun 2024 02:49:43 GMT and should not be manually modified.
-
-## 0.0.24
-
-Tue, 18 Jun 2024 02:49:43 GMT
-
-### Updates
-
-- Add AV1 metadata parser `Av1`
-- Move clipboard stream to `ScrcpyOptions#clipboard`
-- Make `ScrcpyControlMessageWriter#setClipboard` wait for the clipboard to be updated on device (when `sequence` is not 0)
-- Add options class for version 2.3
-
-## 0.0.23
-
-Thu, 21 Mar 2024 03:15:10 GMT
-
-### Updates
-
-- Fix several ReDos vulnerabilities
-
-## 0.0.22
-
-Wed, 13 Dec 2023 05:57:27 GMT
-
-### Updates
-
-- Fix parsing `sps_max_dec_pic_buffering_minus1` in H.265 SPS
-- Support parsing `vui_hrd_parameters` in H.265 SPS
-- Add support for Scrcpy 2.2
-
-## 0.0.21
-
-Fri, 25 Aug 2023 14:05:18 GMT
-
-### Updates
-
-- Add support for Scrcpy server version 2.1 and 2.1.1
-- Move the fetching server binary script to `@yume-chan/scrcpy-fetch-server` package
-
-## 0.0.20
-
-Mon, 05 Jun 2023 02:51:41 GMT
-
-### Updates
-
-- Add support for Scrcpy 2.0. New features including audio forwarding (supports PCM, AAC and OPUS encoding) and other video codecs (supports H.264 and H.265, AV1 not supported). Read the PR for new options and breaking changes. ([#495](https://github.com/yume-chan/ya-webadb/pull/495))
-- Move ADB related code to `@yume-chan/adb-scrcpy` package. This package now only implements the Scrcpy protocol.
-
-## 0.0.19
-
-Sun, 09 Apr 2023 05:55:33 GMT
-
-### Updates
-
-- Change `AdbScrcpyClient#pushServer` to take a `ReadableStream<Uint8Array>` instead of returning a `WritableStream<Uint8Array>`
-- Add `AdbReverseNotSupportedError` handling and automatically switch to forward tunnel in `AdbScrcpyClient`.
-- Update `AndroidKeyCode` enum to align with Web `KeyboardEvent.code`
-
-## 0.0.18
-
-Wed, 25 Jan 2023 21:33:49 GMT
-
-### Updates
-
-- Move `@yume-chan/adb` to `peerDependencies`
-- Add support for Scrcpy server version 1.25
-- Add support for `SetClipboard` control message and `AckClipboard` device message
-
-## 0.0.17
-
-Tue, 18 Oct 2022 09:32:30 GMT
-
-### Updates
-
-- Add standalone types for serializing/deserializing Scrcpy packets
-- Separate decoders to own packages so they don't need optional peer dependencies.
-
-## 0.0.16
-
-Sat, 28 May 2022 03:56:37 GMT
-
-### Updates
-
-- Upgrade TypeScript to 4.7.2 to enable Node.js ESM
-- Add support for more `CodecOptions` keys
-- Add support for `CodecOptions` value types other than `int`
-
-## 0.0.15
-
-Mon, 02 May 2022 04:18:01 GMT
-
-### Updates
-
-- Add support for `rotateDevice` control message
-- Add method to get screen list
-
-## 0.0.14
-
-Sat, 30 Apr 2022 14:05:48 GMT
-
-### Updates
-
-- Add support for Scrcpy server version 1.24
-
-## 0.0.13
-
-Thu, 28 Apr 2022 01:23:53 GMT
-
-### Updates
-
-- Add support for Scrcpy server version 1.23
-
-## 0.0.12
-
-Sun, 03 Apr 2022 11:18:47 GMT
-
-_Version update only_
-
-## 0.0.11
-
-Sun, 03 Apr 2022 10:54:15 GMT
-
-### Updates
-
-- Add support for Scrcpy server version 1.22
-- Update to use Web Streams API
-- Improve compatibility with Node.js 12 ESM format
-- Workaround a issue with server crash on Samsung ROM (https://github.com/Genymobile/scrcpy/issues/2841)
-- Remove output parsing. It's output is for debugging only, not machine readable.
-- Update license year
-
-## 0.0.10
-
-Sun, 09 Jan 2022 15:52:20 GMT
-
-_Initial release_