@yume-chan/scrcpy 1.0.0 → 2.0.0

package/src/3_0/impl/init.ts

@@ -106,8 +106,9 @@ export class NewDisplay implements ScrcpyOptionValue {
     }
 }
 
-export interface Init extends Omit<PrevImpl.Init, "lockVideoOrientation"> {
-    captureOrientation?: CaptureOrientation;
+export interface Init<TVideo extends boolean>
+    extends Omit<PrevImpl.Init<TVideo>, "lockVideoOrientation"> {
+    captureOrientation?: CaptureOrientation | string | undefined;
     angle?: number;
     screenOffTimeout?: number | undefined;
 
@@ -116,6 +117,6 @@ export interface Init extends Omit<PrevImpl.Init, "lockVideoOrientation"> {
     // `display_id` and `new_display` can't be specified at the same time
     // but `serialize` method will exclude options that are same as the default value
     // so `displayId: 0` will be ignored
-    newDisplay?: NewDisplay | undefined;
+    newDisplay?: NewDisplay | string | undefined;
     vdSystemDecorations?: boolean;
 }

package/src/3_0/index.ts

@@ -1,2 +1 @@
-export * as ScrcpyOptions3_0Impl from "./impl/index.js";
 export * from "./options.js";

package/src/3_0/options.ts

@@ -1,6 +1,6 @@
 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 { AsyncExactReadable, ExactReadable } from "@yume-chan/struct";
 
 import type {
     ScrcpyAudioStreamMetadata,
@@ -9,6 +9,7 @@ import type {
     ScrcpyEncoder,
     ScrcpyMediaStreamPacket,
     ScrcpyOptions,
+    ScrcpyOptionsListEncoders,
     ScrcpyScrollController,
     ScrcpyVideoStream,
 } from "../base/index.js";
@@ -41,10 +42,12 @@ import {
     UHidOutputStream,
 } from "./impl/index.js";
 
-export class ScrcpyOptions3_0 implements ScrcpyOptions<Init> {
+export class ScrcpyOptions3_0<TVideo extends boolean>
+    implements ScrcpyOptions<Init<TVideo>>, ScrcpyOptionsListEncoders
+{
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init>;
+    readonly value: Required<Init<TVideo>>;
 
     get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
         return ControlMessageTypes;
@@ -64,8 +67,8 @@ export class ScrcpyOptions3_0 implements ScrcpyOptions<Init> {
         return this.#uHidOutput;
     }
 
-    constructor(init: Init) {
-        this.value = { ...Defaults, ...init };
+    constructor(init: Init<TVideo>) {
+        this.value = { ...Defaults, ...init } as never;
 
         if (this.value.videoSource === "camera") {
             this.value.control = false;
@@ -86,7 +89,7 @@ export class ScrcpyOptions3_0 implements ScrcpyOptions<Init> {
     }
 
     serialize(): string[] {
-        return serialize(this.value, Defaults);
+        return serialize<Init<boolean>>(this.value, Defaults);
     }
 
     setListDisplays(): void {
@@ -119,7 +122,7 @@ export class ScrcpyOptions3_0 implements ScrcpyOptions<Init> {
 
     async parseDeviceMessage(
         id: number,
-        stream: AsyncExactReadable,
+        stream: ExactReadable | AsyncExactReadable,
     ): Promise<void> {
         if (await this.#clipboard?.parse(id, stream)) {
             return;
@@ -180,8 +183,8 @@ export class ScrcpyOptions3_0 implements ScrcpyOptions<Init> {
     }
 }
 
-type Init_ = Init;
+type Init_<TVideo extends boolean> = Init<TVideo>;
 
 export namespace ScrcpyOptions3_0 {
-    export type Init = Init_;
+    export type Init<TVideo extends boolean = boolean> = Init_<TVideo>;
 }

package/src/3_0_1.ts

@@ -0,0 +1,14 @@
+import { ScrcpyOptions3_0 } from "./3_0/index.js";
+
+export class ScrcpyOptions3_0_1<
+    TVideo extends boolean,
+> extends ScrcpyOptions3_0<TVideo> {
+    constructor(init: ScrcpyOptions3_0.Init<TVideo>) {
+        super(init);
+    }
+}
+
+export namespace ScrcpyOptions3_0_1 {
+    export type Init<TVideo extends boolean = boolean> =
+        ScrcpyOptions3_0.Init<TVideo>;
+}

package/src/3_0_2.ts

@@ -0,0 +1,14 @@
+import { ScrcpyOptions3_0 } from "./3_0/index.js";
+
+export class ScrcpyOptions3_0_2<
+    TVideo extends boolean,
+> extends ScrcpyOptions3_0<TVideo> {
+    constructor(init: ScrcpyOptions3_0.Init<TVideo>) {
+        super(init);
+    }
+}
+
+export namespace ScrcpyOptions3_0_2 {
+    export type Init<TVideo extends boolean = boolean> =
+        ScrcpyOptions3_0.Init<TVideo>;
+}

package/src/3_1/impl/defaults.ts

@@ -0,0 +1,8 @@
+import type { Init } from "./init.js";
+import { PrevImpl } from "./prev.js";
+
+export const Defaults = /* #__PURE__ */ (() =>
+    ({
+        ...PrevImpl.Defaults,
+        vdDestroyContent: false,
+    }) as const satisfies Required<Init<true>>)();

package/src/3_1/impl/index.ts

@@ -0,0 +1,7 @@
+export * from "../../3_0/impl/index.js";
+export { Defaults } from "./defaults.js";
+export type { Init } from "./init.js";
+export {
+    serializeUHidCreateControlMessage,
+    UHidCreateControlMessage,
+} from "./serialize-uhid-create.js";

package/src/3_1/impl/init.ts

@@ -0,0 +1,5 @@
+import type { PrevImpl } from "./prev.js";
+
+export interface Init<TVideo extends boolean> extends PrevImpl.Init<TVideo> {
+    vdDestroyContent?: boolean;
+}

package/src/3_1/impl/prev.ts

@@ -0,0 +1 @@
+export * as PrevImpl from "../../3_0/impl/index.js";

package/src/3_1/impl/serialize-uhid-create.ts

@@ -0,0 +1,28 @@
+import type { StructInit } from "@yume-chan/struct";
+import { buffer, string, struct, u16, u8 } from "@yume-chan/struct";
+
+import { ScrcpyControlMessageType } from "../../base/control-message-type.js";
+import type { ScrcpyUHidCreateControlMessage } from "../../latest.js";
+
+export const UHidCreateControlMessage = /* #__PURE__ */ (() =>
+    struct(
+        {
+            type: u8(ScrcpyControlMessageType.UHidCreate),
+            id: u16,
+            vendorId: u16,
+            productId: u16,
+            name: string(u8),
+            data: buffer(u16),
+        },
+        { littleEndian: false },
+    ))();
+
+export type UHidCreateControlMessage = StructInit<
+    typeof UHidCreateControlMessage
+>;
+
+export function serializeUHidCreateControlMessage(
+    message: ScrcpyUHidCreateControlMessage,
+) {
+    return UHidCreateControlMessage.serialize(message);
+}

package/src/3_1/index.ts

@@ -0,0 +1 @@
+export * from "./options.js";

package/src/3_1/options.ts

@@ -0,0 +1,190 @@
+import type { MaybePromiseLike } from "@yume-chan/async";
+import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
+import type { AsyncExactReadable, ExactReadable } from "@yume-chan/struct";
+
+import type {
+    ScrcpyAudioStreamMetadata,
+    ScrcpyControlMessageType,
+    ScrcpyDisplay,
+    ScrcpyEncoder,
+    ScrcpyMediaStreamPacket,
+    ScrcpyOptions,
+    ScrcpyOptionsListEncoders,
+    ScrcpyScrollController,
+    ScrcpyVideoStream,
+} from "../base/index.js";
+import type {
+    ScrcpyBackOrScreenOnControlMessage,
+    ScrcpyInjectTouchControlMessage,
+    ScrcpySetClipboardControlMessage,
+    ScrcpyUHidCreateControlMessage,
+    ScrcpyUHidOutputDeviceMessage,
+} from "../latest.js";
+
+import type { Init } from "./impl/index.js";
+import {
+    AckClipboardHandler,
+    ClipboardStream,
+    ControlMessageTypes,
+    createMediaStreamTransformer,
+    createScrollController,
+    Defaults,
+    parseAudioStreamMetadata,
+    parseDisplay,
+    parseEncoder,
+    parseVideoStreamMetadata,
+    serialize,
+    serializeBackOrScreenOnControlMessage,
+    serializeInjectTouchControlMessage,
+    serializeUHidCreateControlMessage,
+    setListDisplays,
+    setListEncoders,
+    UHidOutputStream,
+} from "./impl/index.js";
+
+export class ScrcpyOptions3_1<TVideo extends boolean>
+    implements ScrcpyOptions<Init<TVideo>>, ScrcpyOptionsListEncoders
+{
+    static readonly Defaults = Defaults;
+
+    readonly value: Required<Init<TVideo>>;
+
+    get controlMessageTypes(): readonly ScrcpyControlMessageType[] {
+        return ControlMessageTypes;
+    }
+
+    #clipboard: ClipboardStream | undefined;
+    get clipboard(): ReadableStream<string> | undefined {
+        return this.#clipboard;
+    }
+
+    #ackClipboardHandler: AckClipboardHandler | undefined;
+
+    #uHidOutput: UHidOutputStream | undefined;
+    get uHidOutput():
+        | ReadableStream<ScrcpyUHidOutputDeviceMessage>
+        | undefined {
+        return this.#uHidOutput;
+    }
+
+    constructor(init: Init<TVideo>) {
+        this.value = { ...Defaults, ...init } as never;
+
+        if (this.value.videoSource === "camera") {
+            this.value.control = false;
+        }
+
+        if (this.value.audioDup) {
+            this.value.audioSource = "playback";
+        }
+
+        if (this.value.control) {
+            if (this.value.clipboardAutosync) {
+                this.#clipboard = new ClipboardStream();
+                this.#ackClipboardHandler = new AckClipboardHandler();
+            }
+
+            this.#uHidOutput = new UHidOutputStream();
+        }
+    }
+
+    serialize(): string[] {
+        return serialize<Init<boolean>>(this.value, Defaults);
+    }
+
+    setListDisplays(): void {
+        setListDisplays(this.value);
+    }
+
+    parseDisplay(line: string): ScrcpyDisplay | undefined {
+        return parseDisplay(line);
+    }
+
+    setListEncoders() {
+        setListEncoders(this.value);
+    }
+
+    parseEncoder(line: string): ScrcpyEncoder | undefined {
+        return parseEncoder(line);
+    }
+
+    parseVideoStreamMetadata(
+        stream: ReadableStream<Uint8Array>,
+    ): MaybePromiseLike<ScrcpyVideoStream> {
+        return parseVideoStreamMetadata(this.value, stream);
+    }
+
+    parseAudioStreamMetadata(
+        stream: ReadableStream<Uint8Array>,
+    ): MaybePromiseLike<ScrcpyAudioStreamMetadata> {
+        return parseAudioStreamMetadata(stream, this.value);
+    }
+
+    async parseDeviceMessage(
+        id: number,
+        stream: ExactReadable | AsyncExactReadable,
+    ): Promise<void> {
+        if (await this.#clipboard?.parse(id, stream)) {
+            return;
+        }
+
+        if (await this.#ackClipboardHandler?.parse(id, stream)) {
+            return;
+        }
+
+        throw new Error("Unknown device message");
+    }
+
+    endDeviceMessageStream(e?: unknown): void {
+        if (e) {
+            this.#clipboard?.error(e);
+            this.#ackClipboardHandler?.error(e);
+        } else {
+            this.#clipboard?.close();
+            this.#ackClipboardHandler?.close();
+        }
+    }
+
+    createMediaStreamTransformer(): TransformStream<
+        Uint8Array,
+        ScrcpyMediaStreamPacket
+    > {
+        return createMediaStreamTransformer(this.value);
+    }
+
+    serializeInjectTouchControlMessage(
+        message: ScrcpyInjectTouchControlMessage,
+    ): Uint8Array {
+        return serializeInjectTouchControlMessage(message);
+    }
+
+    serializeBackOrScreenOnControlMessage(
+        message: ScrcpyBackOrScreenOnControlMessage,
+    ): Uint8Array | undefined {
+        return serializeBackOrScreenOnControlMessage(message);
+    }
+
+    serializeSetClipboardControlMessage(
+        message: ScrcpySetClipboardControlMessage,
+    ): Uint8Array | [Uint8Array, Promise<void>] {
+        return this.#ackClipboardHandler!.serializeSetClipboardControlMessage(
+            message,
+        );
+    }
+
+    createScrollController(): ScrcpyScrollController {
+        return createScrollController();
+    }
+
+    serializeUHidCreateControlMessage(
+        message: ScrcpyUHidCreateControlMessage,
+    ): Uint8Array {
+        return serializeUHidCreateControlMessage(message);
+    }
+}
+
+type Init_<TVideo extends boolean> = Init<TVideo>;
+
+export namespace ScrcpyOptions3_1 {
+    export type Init<TVideo extends boolean = boolean> = Init_<TVideo>;
+}

package/src/android/key-event.ts

@@ -30,8 +30,9 @@ 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
-// Most names follow Web API `KeyboardEvent.code`,
-// Android-only (not exist in HID keyboard standard) keys are prefixed by `Android`.
+// 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,

package/src/base/option-value.ts

@@ -28,8 +28,8 @@ export function toScrcpyOptionValue<T>(value: unknown, empty: T): string | T {
         typeof value !== "number" &&
         typeof value !== "boolean"
     ) {
-        throw new TypeError(`Invalid option value: ${String(value)}`);
+        throw new TypeError(`Invalid option value: ${JSON.stringify(value)}`);
     }
 
-    return String(value);
+    return value.toString();
 }

package/src/base/options.ts

@@ -1,6 +1,6 @@
 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 { AsyncExactReadable, ExactReadable } from "@yume-chan/struct";
 
 import type {
     ScrcpyBackOrScreenOnControlMessage,
@@ -35,10 +35,6 @@ export interface ScrcpyOptions<T extends object> {
 
     parseDisplay(line: string): ScrcpyDisplay | undefined;
 
-    setListEncoders?(): void;
-
-    parseEncoder?(line: string): ScrcpyEncoder | undefined;
-
     parseVideoStreamMetadata(
         stream: ReadableStream<Uint8Array>,
     ): MaybePromiseLike<ScrcpyVideoStream>;
@@ -47,7 +43,10 @@ export interface ScrcpyOptions<T extends object> {
         stream: ReadableStream<Uint8Array>,
     ): MaybePromiseLike<ScrcpyAudioStreamMetadata>;
 
-    parseDeviceMessage(id: number, stream: AsyncExactReadable): Promise<void>;
+    parseDeviceMessage(
+        id: number,
+        stream: ExactReadable | AsyncExactReadable,
+    ): Promise<void>;
 
     endDeviceMessageStream(e?: unknown): void;
 
@@ -74,3 +73,9 @@ export interface ScrcpyOptions<T extends object> {
         message: ScrcpyUHidCreateControlMessage,
     ): Uint8Array;
 }
+
+export interface ScrcpyOptionsListEncoders {
+    setListEncoders(): void;
+
+    parseEncoder(line: string): ScrcpyEncoder | undefined;
+}

package/src/codec/h265.ts

@@ -330,8 +330,10 @@ export function h265ParseSequenceParameterSet(nalu: Uint8Array) {
     if (pcm_enabled_flag) {
         pcm_sample_bit_depth_luma_minus1 = reader.read(4);
         pcm_sample_bit_depth_chroma_minus1 = reader.read(4);
-        log2_min_pcm_luma_coding_block_size_minus3 = reader.read(4);
-        log2_diff_max_min_pcm_luma_coding_block_size = reader.read(4);
+        log2_min_pcm_luma_coding_block_size_minus3 =
+            reader.decodeExponentialGolombNumber();
+        log2_diff_max_min_pcm_luma_coding_block_size =
+            reader.decodeExponentialGolombNumber();
         pcm_loop_filter_disabled_flag = !!reader.next();
     }
 
@@ -894,6 +896,30 @@ export function h265ParseShortTermReferencePictureSet(
     };
 }
 
+export const H265AspectRatioIndicator = {
+    Unspecified: 0,
+    Square: 1,
+    _12_11: 2,
+    _10_11: 3,
+    _16_11: 4,
+    _40_33: 5,
+    _24_11: 6,
+    _20_11: 7,
+    _32_11: 8,
+    _80_33: 9,
+    _18_11: 10,
+    _15_11: 11,
+    _64_33: 12,
+    _160_99: 13,
+    _4_3: 15,
+    _3_2: 16,
+    _2_1: 17,
+    Extended: 255,
+} as const;
+
+export type H265AspectRatioIndicator =
+    (typeof H265AspectRatioIndicator)[keyof typeof H265AspectRatioIndicator];
+
 /**
  * E.2.1 VUI parameters syntax
  */
@@ -902,12 +928,12 @@ export function h265ParseVuiParameters(
     sps_max_sub_layers_minus1: number,
 ) {
     const aspect_ratio_info_present_flag = !!reader.next();
-    let aspect_ratio_idc: number | undefined;
+    let aspect_ratio_idc: H265AspectRatioIndicator | undefined;
     let sar_width: number | undefined;
     let sar_height: number | undefined;
     if (aspect_ratio_info_present_flag) {
-        aspect_ratio_idc = reader.read(8);
-        if (aspect_ratio_idc === 255) {
+        aspect_ratio_idc = reader.read(8) as H265AspectRatioIndicator;
+        if (aspect_ratio_idc === H265AspectRatioIndicator.Extended) {
             sar_width = reader.read(16);
             sar_height = reader.read(16);
         }

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from "./1_15/index.js";
+export * from "./1_15_1.js";
 export * from "./1_16.js";
 export * from "./1_17/index.js";
 export * from "./1_18/index.js";
@@ -11,13 +12,19 @@ export * from "./1_24/index.js";
 export * from "./1_25/index.js";
 export * from "./2_0/index.js";
 export * from "./2_1/index.js";
+export * from "./2_1_1.js";
 export * from "./2_2/index.js";
 export * from "./2_3/index.js";
+export * from "./2_3_1.js";
 export * from "./2_4/index.js";
 export * from "./2_5.js";
 export * from "./2_6/index.js";
+export * from "./2_6_1.js";
 export * from "./2_7/index.js";
 export * from "./3_0/index.js";
+export * from "./3_0_1.js";
+export * from "./3_0_2.js";
+export * from "./3_1/index.js";
 export * from "./android/index.js";
 export * from "./base/index.js";
 export * from "./codec/index.js";

package/src/latest.ts

@@ -1,7 +1,23 @@
+import { ScrcpyOptions3_1 } from "./3_1/options.js";
+
+export class ScrcpyOptionsLatest<
+    TVideo extends boolean,
+> extends ScrcpyOptions3_1<TVideo> {
+    constructor(init: ScrcpyOptions3_1.Init<TVideo>) {
+        super(init);
+    }
+}
+
+export namespace ScrcpyOptionsLatest {
+    export type Init<TVideo extends boolean = boolean> =
+        ScrcpyOptions3_1.Init<TVideo>;
+}
+
 export {
     BackOrScreenOnControlMessage as ScrcpyBackOrScreenOnControlMessage,
     CaptureOrientation as ScrcpyCaptureOrientation,
     CodecOptions as ScrcpyCodecOptions,
+    Crop as ScrcpyCrop,
     InjectScrollControlMessage as ScrcpyInjectScrollControlMessage,
     InjectTouchControlMessage as ScrcpyInjectTouchControlMessage,
     InstanceId as ScrcpyInstanceId,
@@ -12,4 +28,4 @@ export {
     SetClipboardControlMessage as ScrcpySetClipboardControlMessage,
     UHidCreateControlMessage as ScrcpyUHidCreateControlMessage,
     UHidOutputDeviceMessage as ScrcpyUHidOutputDeviceMessage,
-} from "./3_0/impl/index.js";
+} from "./3_1/impl/index.js";

package/src/utils/index.ts

@@ -1,4 +1,3 @@
 export * from "./clamp.js";
 export * from "./constants.js";
 export * from "./omit.js";
-export * from "./wrapper.js";