@yume-chan/scrcpy 0.0.24 → 1.0.0

package/src/base/options.ts

@@ -0,0 +1,76 @@
+import type { MaybePromiseLike } from "@yume-chan/async";
+import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
+import type { AsyncExactReadable } from "@yume-chan/struct";
+
+import type {
+    ScrcpyBackOrScreenOnControlMessage,
+    ScrcpyInjectTouchControlMessage,
+    ScrcpySetClipboardControlMessage,
+    ScrcpyUHidCreateControlMessage,
+    ScrcpyUHidOutputDeviceMessage,
+} from "../latest.js";
+
+import type { ScrcpyAudioStreamMetadata } from "./audio.js";
+import type { ScrcpyControlMessageType } from "./control-message-type.js";
+import type { ScrcpyDisplay } from "./display.js";
+import type { ScrcpyEncoder } from "./encoder.js";
+import type { ScrcpyMediaStreamPacket } from "./media.js";
+import type { ScrcpyScrollController } from "./scroll-controller.js";
+import type { ScrcpyVideoStream } from "./video.js";
+
+export interface ScrcpyOptions<T extends object> {
+    get controlMessageTypes(): readonly ScrcpyControlMessageType[];
+
+    value: Required<T>;
+
+    readonly clipboard?: ReadableStream<string> | undefined;
+
+    readonly uHidOutput?:
+        | ReadableStream<ScrcpyUHidOutputDeviceMessage>
+        | undefined;
+
+    serialize(): string[];
+
+    setListDisplays(): void;
+
+    parseDisplay(line: string): ScrcpyDisplay | undefined;
+
+    setListEncoders?(): void;
+
+    parseEncoder?(line: string): ScrcpyEncoder | undefined;
+
+    parseVideoStreamMetadata(
+        stream: ReadableStream<Uint8Array>,
+    ): MaybePromiseLike<ScrcpyVideoStream>;
+
+    parseAudioStreamMetadata?(
+        stream: ReadableStream<Uint8Array>,
+    ): MaybePromiseLike<ScrcpyAudioStreamMetadata>;
+
+    parseDeviceMessage(id: number, stream: AsyncExactReadable): Promise<void>;
+
+    endDeviceMessageStream(e?: unknown): void;
+
+    createMediaStreamTransformer(): TransformStream<
+        Uint8Array,
+        ScrcpyMediaStreamPacket
+    >;
+
+    serializeInjectTouchControlMessage(
+        message: ScrcpyInjectTouchControlMessage,
+    ): Uint8Array;
+
+    serializeBackOrScreenOnControlMessage(
+        message: ScrcpyBackOrScreenOnControlMessage,
+    ): Uint8Array | undefined;
+
+    serializeSetClipboardControlMessage(
+        message: ScrcpySetClipboardControlMessage,
+    ): Uint8Array | [Uint8Array, Promise<void>];
+
+    createScrollController(): ScrcpyScrollController;
+
+    serializeUHidCreateControlMessage?(
+        message: ScrcpyUHidCreateControlMessage,
+    ): Uint8Array;
+}

package/src/base/scroll-controller.ts

@@ -0,0 +1,7 @@
+import type { ScrcpyInjectScrollControlMessage } from "../latest.js";
+
+export interface ScrcpyScrollController {
+    serializeScrollMessage(
+        message: ScrcpyInjectScrollControlMessage,
+    ): Uint8Array | undefined;
+}

package/src/base/video.ts

@@ -0,0 +1,32 @@
+import type { ReadableStream } from "@yume-chan/stream-extra";
+
+export interface ScrcpyVideoStream {
+    readonly stream: ReadableStream<Uint8Array>;
+    readonly metadata: ScrcpyVideoStreamMetadata;
+}
+
+export interface ScrcpyVideoStreamMetadata {
+    deviceName?: string | undefined;
+    width?: number | undefined;
+    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/codec/av1.ts

@@ -6,39 +6,39 @@
 // cspell: ignore Smpte
 // cspell: ignore Chromat
 
-export enum AndroidAv1Profile {
-    Main8 = 1 << 0,
-    Main10 = 1 << 1,
-    Main10Hdr10 = 1 << 12,
-    Main10Hdr10Plus = 1 << 13,
-}
-
-export enum AndroidAv1Level {
-    Level2 = 1 << 0,
-    Level21 = 1 << 1,
-    Level22 = 1 << 2,
-    Level23 = 1 << 3,
-    Level3 = 1 << 4,
-    Level31 = 1 << 5,
-    Level32 = 1 << 6,
-    Level33 = 1 << 7,
-    Level4 = 1 << 8,
-    Level41 = 1 << 9,
-    Level42 = 1 << 10,
-    Level43 = 1 << 11,
-    Level5 = 1 << 12,
-    Level51 = 1 << 13,
-    Level52 = 1 << 14,
-    Level53 = 1 << 15,
-    Level6 = 1 << 16,
-    Level61 = 1 << 17,
-    Level62 = 1 << 18,
-    Level63 = 1 << 19,
-    Level7 = 1 << 20,
-    Level71 = 1 << 21,
-    Level72 = 1 << 22,
-    Level73 = 1 << 23,
-}
+export const AndroidAv1Profile = {
+    Main8: 1 << 0,
+    Main10: 1 << 1,
+    Main10Hdr10: 1 << 12,
+    Main10Hdr10Plus: 1 << 13,
+};
+
+export const AndroidAv1Level = {
+    Level2: 1 << 0,
+    Level21: 1 << 1,
+    Level22: 1 << 2,
+    Level23: 1 << 3,
+    Level3: 1 << 4,
+    Level31: 1 << 5,
+    Level32: 1 << 6,
+    Level33: 1 << 7,
+    Level4: 1 << 8,
+    Level41: 1 << 9,
+    Level42: 1 << 10,
+    Level43: 1 << 11,
+    Level5: 1 << 12,
+    Level51: 1 << 13,
+    Level52: 1 << 14,
+    Level53: 1 << 15,
+    Level6: 1 << 16,
+    Level61: 1 << 17,
+    Level62: 1 << 18,
+    Level63: 1 << 19,
+    Level7: 1 << 20,
+    Level71: 1 << 21,
+    Level72: 1 << 22,
+    Level73: 1 << 23,
+};
 
 class BitReader {
     #data: Uint8Array;
@@ -126,7 +126,78 @@ class BitReader {
     }
 }
 
+const ObuType = {
+    SequenceHeader: 1,
+    TemporalDelimiter: 2,
+    FrameHeader: 3,
+    TileGroup: 4,
+    Metadata: 5,
+    Frame: 6,
+    RedundantFrameHeader: 7,
+    TileList: 8,
+    Padding: 15,
+} as const;
+
+type ObuType = (typeof ObuType)[keyof typeof ObuType];
+
+const ColorPrimaries = {
+    Bt709: 1,
+    Unspecified: 2,
+    Bt470M: 4,
+    Bt470BG: 5,
+    Bt601: 6,
+    Smpte240: 7,
+    GenericFilm: 8,
+    Bt2020: 9,
+    Xyz: 10,
+    Smpte431: 11,
+    Smpte432: 12,
+    Ebu3213: 22,
+} as const;
+
+const TransferCharacteristics = {
+    Bt709: 1,
+    Unspecified: 2,
+    Bt470M: 4,
+    Bt470BG: 5,
+    Bt601: 6,
+    Smpte240: 7,
+    Linear: 8,
+    Log100: 9,
+    Log100Sqrt10: 10,
+    Iec61966: 11,
+    Bt1361: 12,
+    Srgb: 13,
+    Bt2020Ten: 14,
+    Bt2020Twelve: 15,
+    Smpte2084: 16,
+    Smpte428: 17,
+    Hlg: 18,
+} as const;
+
+const MatrixCoefficients = {
+    Identity: 0,
+    Bt709: 1,
+    Unspecified: 2,
+    Fcc: 4,
+    Bt470BG: 5,
+    Bt601: 6,
+    Smpte240: 7,
+    YCgCo: 8,
+    Bt2020Ncl: 9,
+    Bt2020Cl: 10,
+    Smpte2085: 11,
+    ChromatNcl: 12,
+    ChromatCl: 13,
+    ICtCp: 14,
+} as const;
+
 export class Av1 extends BitReader {
+    static ObuType = ObuType;
+    static ColorPrimaries = ColorPrimaries;
+    static TransferCharacteristics = TransferCharacteristics;
+    static MatrixCoefficients = MatrixCoefficients;
+
     #Leb128Bytes: number = 0;
 
     uvlc() {
@@ -552,13 +623,16 @@ export class Av1 extends BitReader {
         // const NumPlanes = mono_chrome ? 1 : 3;
 
         const color_description_present_flag = !!this.f1();
-        let color_primaries = Av1.ColorPrimaries.Unspecified;
-        let transfer_characteristics = Av1.TransferCharacteristics.Unspecified;
-        let matrix_coefficients = Av1.MatrixCoefficients.Unspecified;
+        let color_primaries: Av1.ColorPrimaries =
+            Av1.ColorPrimaries.Unspecified;
+        let transfer_characteristics: Av1.TransferCharacteristics =
+            Av1.TransferCharacteristics.Unspecified;
+        let matrix_coefficients: Av1.MatrixCoefficients =
+            Av1.MatrixCoefficients.Unspecified;
         if (color_description_present_flag) {
-            color_primaries = this.f(8);
-            transfer_characteristics = this.f(8);
-            matrix_coefficients = this.f(8);
+            color_primaries = this.f(8) as Av1.ColorPrimaries;
+            transfer_characteristics = this.f(8) as Av1.TransferCharacteristics;
+            matrix_coefficients = this.f(8) as Av1.MatrixCoefficients;
         }
 
         let color_range = false;
@@ -637,67 +711,14 @@ export namespace Av1 {
 
     export type SequenceHeaderObu = ReturnType<Av1["sequenceHeaderObu"]>;
 
-    export enum ObuType {
-        SequenceHeader = 1,
-        TemporalDelimiter,
-        FrameHeader,
-        TileGroup,
-        Metadata,
-        Frame,
-        RedundantFrameHeader,
-        TileList,
-        Padding = 15,
-    }
+    export type ObuType = (typeof ObuType)[keyof typeof ObuType];
 
-    export enum ColorPrimaries {
-        Bt709 = 1,
-        Unspecified,
-        Bt470M = 4,
-        Bt470BG,
-        Bt601,
-        Smpte240,
-        GenericFilm,
-        Bt2020,
-        Xyz,
-        Smpte431,
-        Smpte432,
-        Ebu3213 = 22,
-    }
+    export type ColorPrimaries =
+        (typeof ColorPrimaries)[keyof typeof ColorPrimaries];
 
-    export enum TransferCharacteristics {
-        Bt709 = 1,
-        Unspecified,
-        Bt470M = 4,
-        Bt470BG,
-        Bt601,
-        Smpte240,
-        Linear,
-        Log100,
-        Log100Sqrt10,
-        Iec61966,
-        Bt1361,
-        Srgb,
-        Bt2020Ten,
-        Bt2020Twelve,
-        Smpte2084,
-        Smpte428,
-        Hlg,
-    }
+    export type TransferCharacteristics =
+        (typeof TransferCharacteristics)[keyof typeof TransferCharacteristics];
 
-    export enum MatrixCoefficients {
-        Identity = 0,
-        Bt709,
-        Unspecified,
-        Fcc = 4,
-        Bt470BG,
-        Bt601,
-        Smpte240,
-        YCgCo,
-        Bt2020Ncl,
-        Bt2020Cl,
-        Smpte2085,
-        ChromatNcl,
-        ChromatCl,
-        ICtCp,
-    }
+    export type MatrixCoefficients =
+        (typeof MatrixCoefficients)[keyof typeof MatrixCoefficients];
 }

package/src/codec/h264.ts

@@ -5,40 +5,40 @@
 import { NaluSodbBitReader, annexBSplitNalu } from "./nalu.js";
 
 // From https://developer.android.com/reference/android/media/MediaCodecInfo.CodecProfileLevel
-export enum 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 enum 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 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,
+};
 
 // H.264 has two standards: ITU-T H.264 and ISO/IEC 14496-10
 // they have the same content, and refer themselves as "H.264".

package/src/codec/h265.ts

@@ -20,42 +20,42 @@
 
 import { NaluSodbBitReader, annexBSplitNalu } from "./nalu.js";
 
-export enum AndroidHevcProfile {
-    Main = 1 << 0,
-    Main10 = 1 << 1,
-    MainStill = 1 << 2,
-    Main10Hdr10 = 1 << 12,
-    Main10Hdr10Plus = 1 << 13,
-}
-
-export enum 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,
-}
+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,
+};
 
 /**
  * 6.2 Source, decoded and output picture formats

package/src/control/empty.ts

@@ -1,3 +1,9 @@
-import { Struct } from "@yume-chan/struct";
+import type { StructInit } from "@yume-chan/struct";
+import { struct, u8 } from "@yume-chan/struct";
 
-export const EmptyControlMessage = new Struct().uint8("type");
+export const EmptyControlMessage = struct(
+    { type: u8 },
+    { littleEndian: false },
+);
+
+export type EmptyControlMessage = StructInit<typeof EmptyControlMessage>;

package/src/control/index.ts

@@ -1,13 +1,7 @@
-export * from "./back-or-screen-on.js";
 export * from "./empty.js";
-export * from "./hover-helper.js";
-export * from "./inject-keycode.js";
-export * from "./inject-scroll.js";
+export * from "./inject-key-code.js";
 export * from "./inject-text.js";
-export * from "./inject-touch.js";
-export * from "./rotate-device.js";
+export * from "./message-type-map.js";
 export * from "./serializer.js";
-export * from "./set-clipboard.js";
 export * from "./set-screen-power-mode.js";
-export * from "./type.js";
 export * from "./writer.js";

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

@@ -0,0 +1,25 @@
+import type { StructInit } from "@yume-chan/struct";
+import { struct, u32, u8 } from "@yume-chan/struct";
+
+import type {
+    AndroidKeyCode,
+    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 type ScrcpyInjectKeyCodeControlMessage = StructInit<
+    typeof ScrcpyInjectKeyCodeControlMessage
+>;

package/src/control/inject-text.ts

@@ -1,9 +1,11 @@
-import Struct from "@yume-chan/struct";
+import type { StructInit } from "@yume-chan/struct";
+import { string, struct, u32, u8 } from "@yume-chan/struct";
 
-export const ScrcpyInjectTextControlMessage = new Struct()
-    .uint8("type")
-    .uint32("length")
-    .string("text", { lengthField: "length" });
+export const ScrcpyInjectTextControlMessage = struct(
+    { type: u8, text: string(u32) },
+    { littleEndian: false },
+);
 
-export type ScrcpyInjectTextControlMessage =
-    (typeof ScrcpyInjectTextControlMessage)["TInit"];
+export type ScrcpyInjectTextControlMessage = StructInit<
+    typeof ScrcpyInjectTextControlMessage
+>;

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

@@ -0,0 +1,30 @@
+import type { ScrcpyControlMessageType, ScrcpyOptions } from "../base/index.js";
+
+/**
+ * Scrcpy control message types have different values between versions.
+ *
+ * This class provides a way to get the actual value for a given type.
+ */
+export class ScrcpyControlMessageTypeMap {
+    #types: readonly ScrcpyControlMessageType[];
+
+    constructor(options: ScrcpyOptions<object>) {
+        this.#types = options.controlMessageTypes;
+    }
+
+    get(type: ScrcpyControlMessageType): number {
+        const value = this.#types.indexOf(type);
+        if (value === -1) {
+            throw new TypeError("Invalid or unsupported control message type");
+        }
+        return value;
+    }
+
+    fillMessageType<T extends { type: ScrcpyControlMessageType }>(
+        message: Omit<T, "type">,
+        type: T["type"],
+    ): T {
+        (message as T).type = this.get(type) as ScrcpyControlMessageType;
+        return message as T;
+    }
+}