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

package/src/3_2/options.ts

@@ -2,69 +2,85 @@ import type { MaybePromiseLike } from "@yume-chan/async";
 import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
 
 import type {
+    MapBoolean,
     ScrcpyAudioStreamMetadata,
     ScrcpyDisplay,
     ScrcpyEncoder,
-    ScrcpyMediaStreamPacket,
     ScrcpyOptions,
     ScrcpyOptionsListEncoders,
     ScrcpyScrollController,
     ScrcpyVideoStream,
+    ScrcpyVideoStreamPacket,
 } from "../base/index.js";
 import { ScrcpyDeviceMessageParsers } from "../base/index.js";
 import type {
     ScrcpyBackOrScreenOnControlMessage,
     ScrcpyInjectTouchControlMessage,
     ScrcpySetClipboardControlMessage,
+    ScrcpySetDisplayPowerControlMessage,
     ScrcpyUHidCreateControlMessage,
     ScrcpyUHidOutputDeviceMessage,
 } from "../latest.js";
 
-import type { Init } from "./impl/index.js";
+import type { ComputeOptionTypes, Init } from "./impl/index.js";
 import {
     AckClipboardHandler,
     ClipboardStream,
+    computeOptionValues,
     ControlMessageTypes,
     createMediaStreamTransformer,
     createScrollController,
     Defaults,
+    parseAudioCodecOption,
+    parseAudioMetadataCodec,
     parseAudioStreamMetadata,
     parseDisplay,
     parseEncoder,
+    parseVideoCodecOption,
     parseVideoStreamMetadata,
+    parseVideoStreamMetadataAsync,
     serialize,
     serializeBackOrScreenOnControlMessage,
     serializeInjectTouchControlMessage,
     serializeSetClipboardControlMessage,
+    serializeSetDisplayPowerControlMessage,
     serializeUHidCreateControlMessage,
     setListDisplays,
     setListEncoders,
     UHidOutputStream,
 } from "./impl/index.js";
 
-export class ScrcpyOptions3_2<TVideo extends boolean>
-    implements ScrcpyOptions<Init<TVideo>>, ScrcpyOptionsListEncoders
+export class ScrcpyOptions3_2<TInit extends Init = Init>
+    implements
+        ScrcpyOptions<ScrcpyOptions3_2.Value<TInit>>,
+        ScrcpyOptionsListEncoders
 {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init<TVideo>>;
+    readonly value: ScrcpyOptions3_2.Value<TInit>;
 
     get controlMessageTypes(): typeof ControlMessageTypes {
         return ControlMessageTypes;
     }
 
     #clipboard: ClipboardStream | undefined;
-    get clipboard(): ReadableStream<string> | undefined {
-        return this.#clipboard;
+    get clipboard(): MapBoolean<
+        this["value"]["clipboardAutosync"],
+        ReadableStream<string>,
+        undefined
+    > {
+        return this.#clipboard as never;
     }
 
     #ackClipboardHandler: AckClipboardHandler | undefined;
 
     #uHidOutput: UHidOutputStream | undefined;
-    get uHidOutput():
-        | ReadableStream<ScrcpyUHidOutputDeviceMessage>
-        | undefined {
-        return this.#uHidOutput;
+    get uHidOutput(): MapBoolean<
+        this["value"]["control"],
+        ReadableStream<ScrcpyUHidOutputDeviceMessage>,
+        undefined
+    > {
+        return this.#uHidOutput as never;
     }
 
     #deviceMessageParsers = new ScrcpyDeviceMessageParsers();
@@ -72,16 +88,8 @@ export class ScrcpyOptions3_2<TVideo extends boolean>
         return this.#deviceMessageParsers;
     }
 
-    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";
-        }
+    constructor(init: TInit) {
+        this.value = computeOptionValues(init, Defaults);
 
         if (this.value.control) {
             if (this.value.clipboardAutosync) {
@@ -101,7 +109,7 @@ export class ScrcpyOptions3_2<TVideo extends boolean>
     }
 
     serialize(): string[] {
-        return serialize<Init<boolean>>(this.value, Defaults);
+        return serialize(this.value, Defaults);
     }
 
     setListDisplays(): void {
@@ -123,18 +131,29 @@ export class ScrcpyOptions3_2<TVideo extends boolean>
     parseVideoStreamMetadata(
         stream: ReadableStream<Uint8Array>,
     ): MaybePromiseLike<ScrcpyVideoStream> {
-        return parseVideoStreamMetadata(this.value, stream);
+        return parseVideoStreamMetadata(
+            stream,
+            this.value.sendDeviceMeta,
+            this.value.sendCodecMeta,
+            parseVideoCodecOption(this.value.videoCodec),
+            parseVideoStreamMetadataAsync,
+        );
     }
 
     parseAudioStreamMetadata(
         stream: ReadableStream<Uint8Array>,
     ): MaybePromiseLike<ScrcpyAudioStreamMetadata> {
-        return parseAudioStreamMetadata(stream, this.value);
+        return parseAudioStreamMetadata(
+            stream,
+            this.value.sendCodecMeta,
+            parseAudioMetadataCodec,
+            parseAudioCodecOption(this.value.audioCodec),
+        );
     }
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -142,37 +161,66 @@ export class ScrcpyOptions3_2<TVideo extends boolean>
     serializeInjectTouchControlMessage(
         message: ScrcpyInjectTouchControlMessage,
     ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeInjectTouchControlMessage(message);
     }
 
     serializeBackOrScreenOnControlMessage(
         message: ScrcpyBackOrScreenOnControlMessage,
     ): Uint8Array | undefined {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeBackOrScreenOnControlMessage(message);
     }
 
     serializeSetClipboardControlMessage(
         message: ScrcpySetClipboardControlMessage,
     ): Uint8Array | [Uint8Array, Promise<void>] {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeSetClipboardControlMessage(
             message,
             this.#ackClipboardHandler,
         );
     }
 
+    serializeSetDisplayPowerControlMessage(
+        message: ScrcpySetDisplayPowerControlMessage,
+    ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
+        return serializeSetDisplayPowerControlMessage(message);
+    }
+
     createScrollController(): ScrcpyScrollController {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return createScrollController();
     }
 
     serializeUHidCreateControlMessage(
         message: ScrcpyUHidCreateControlMessage,
     ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeUHidCreateControlMessage(message);
     }
 }
 
-type Init_<TVideo extends boolean> = Init<TVideo>;
+type Init_ = Init;
 
 export namespace ScrcpyOptions3_2 {
-    export type Init<TVideo extends boolean = boolean> = Init_<TVideo>;
+    export type Init = Init_;
+
+    export type Value<TInit extends Init> = ComputeOptionTypes<
+        TInit,
+        typeof Defaults
+    >;
 }

package/src/3_3_1/options.ts

@@ -2,69 +2,85 @@ import type { MaybePromiseLike } from "@yume-chan/async";
 import type { ReadableStream, TransformStream } from "@yume-chan/stream-extra";
 
 import type {
+    MapBoolean,
     ScrcpyAudioStreamMetadata,
     ScrcpyDisplay,
     ScrcpyEncoder,
-    ScrcpyMediaStreamPacket,
     ScrcpyOptions,
     ScrcpyOptionsListEncoders,
     ScrcpyScrollController,
     ScrcpyVideoStream,
+    ScrcpyVideoStreamPacket,
 } from "../base/index.js";
 import { ScrcpyDeviceMessageParsers } from "../base/index.js";
 import type {
     ScrcpyBackOrScreenOnControlMessage,
     ScrcpyInjectTouchControlMessage,
     ScrcpySetClipboardControlMessage,
+    ScrcpySetDisplayPowerControlMessage,
     ScrcpyUHidCreateControlMessage,
     ScrcpyUHidOutputDeviceMessage,
 } from "../latest.js";
 
-import type { Init } from "./impl/index.js";
+import type { ComputeOptionTypes, Init } from "./impl/index.js";
 import {
     AckClipboardHandler,
     ClipboardStream,
+    computeOptionValues,
     ControlMessageTypes,
     createMediaStreamTransformer,
     createScrollController,
     Defaults,
+    parseAudioCodecOption,
+    parseAudioMetadataCodec,
     parseAudioStreamMetadata,
     parseDisplay,
     parseEncoder,
+    parseVideoCodecOption,
     parseVideoStreamMetadata,
+    parseVideoStreamMetadataAsync,
     serialize,
     serializeBackOrScreenOnControlMessage,
     serializeInjectTouchControlMessage,
     serializeSetClipboardControlMessage,
+    serializeSetDisplayPowerControlMessage,
     serializeUHidCreateControlMessage,
     setListDisplays,
     setListEncoders,
     UHidOutputStream,
 } from "./impl/index.js";
 
-export class ScrcpyOptions3_3_1<TVideo extends boolean>
-    implements ScrcpyOptions<Init<TVideo>>, ScrcpyOptionsListEncoders
+export class ScrcpyOptions3_3_1<TInit extends Init = Init>
+    implements
+        ScrcpyOptions<ScrcpyOptions3_3_1.Value<TInit>>,
+        ScrcpyOptionsListEncoders
 {
     static readonly Defaults = Defaults;
 
-    readonly value: Required<Init<TVideo>>;
+    readonly value: ScrcpyOptions3_3_1.Value<TInit>;
 
     get controlMessageTypes(): typeof ControlMessageTypes {
         return ControlMessageTypes;
     }
 
     #clipboard: ClipboardStream | undefined;
-    get clipboard(): ReadableStream<string> | undefined {
-        return this.#clipboard;
+    get clipboard(): MapBoolean<
+        this["value"]["clipboardAutosync"],
+        ReadableStream<string>,
+        undefined
+    > {
+        return this.#clipboard as never;
     }
 
     #ackClipboardHandler: AckClipboardHandler | undefined;
 
     #uHidOutput: UHidOutputStream | undefined;
-    get uHidOutput():
-        | ReadableStream<ScrcpyUHidOutputDeviceMessage>
-        | undefined {
-        return this.#uHidOutput;
+    get uHidOutput(): MapBoolean<
+        this["value"]["control"],
+        ReadableStream<ScrcpyUHidOutputDeviceMessage>,
+        undefined
+    > {
+        return this.#uHidOutput as never;
     }
 
     #deviceMessageParsers = new ScrcpyDeviceMessageParsers();
@@ -72,16 +88,8 @@ export class ScrcpyOptions3_3_1<TVideo extends boolean>
         return this.#deviceMessageParsers;
     }
 
-    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";
-        }
+    constructor(init: TInit) {
+        this.value = computeOptionValues(init, Defaults);
 
         if (this.value.control) {
             if (this.value.clipboardAutosync) {
@@ -101,7 +109,7 @@ export class ScrcpyOptions3_3_1<TVideo extends boolean>
     }
 
     serialize(): string[] {
-        return serialize<Init<boolean>>(this.value, Defaults);
+        return serialize(this.value, Defaults);
     }
 
     setListDisplays(): void {
@@ -123,18 +131,29 @@ export class ScrcpyOptions3_3_1<TVideo extends boolean>
     parseVideoStreamMetadata(
         stream: ReadableStream<Uint8Array>,
     ): MaybePromiseLike<ScrcpyVideoStream> {
-        return parseVideoStreamMetadata(this.value, stream);
+        return parseVideoStreamMetadata(
+            stream,
+            this.value.sendDeviceMeta,
+            this.value.sendCodecMeta,
+            parseVideoCodecOption(this.value.videoCodec),
+            parseVideoStreamMetadataAsync,
+        );
     }
 
     parseAudioStreamMetadata(
         stream: ReadableStream<Uint8Array>,
     ): MaybePromiseLike<ScrcpyAudioStreamMetadata> {
-        return parseAudioStreamMetadata(stream, this.value);
+        return parseAudioStreamMetadata(
+            stream,
+            this.value.sendCodecMeta,
+            parseAudioMetadataCodec,
+            parseAudioCodecOption(this.value.audioCodec),
+        );
     }
 
     createMediaStreamTransformer(): TransformStream<
         Uint8Array,
-        ScrcpyMediaStreamPacket
+        ScrcpyVideoStreamPacket
     > {
         return createMediaStreamTransformer(this.value);
     }
@@ -142,37 +161,66 @@ export class ScrcpyOptions3_3_1<TVideo extends boolean>
     serializeInjectTouchControlMessage(
         message: ScrcpyInjectTouchControlMessage,
     ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeInjectTouchControlMessage(message);
     }
 
     serializeBackOrScreenOnControlMessage(
         message: ScrcpyBackOrScreenOnControlMessage,
     ): Uint8Array | undefined {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeBackOrScreenOnControlMessage(message);
     }
 
     serializeSetClipboardControlMessage(
         message: ScrcpySetClipboardControlMessage,
     ): Uint8Array | [Uint8Array, Promise<void>] {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeSetClipboardControlMessage(
             message,
             this.#ackClipboardHandler,
         );
     }
 
+    serializeSetDisplayPowerControlMessage(
+        message: ScrcpySetDisplayPowerControlMessage,
+    ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
+        return serializeSetDisplayPowerControlMessage(message);
+    }
+
     createScrollController(): ScrcpyScrollController {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return createScrollController();
     }
 
     serializeUHidCreateControlMessage(
         message: ScrcpyUHidCreateControlMessage,
     ): Uint8Array {
+        if (!this.value.control) {
+            throw new Error("control is disabled");
+        }
         return serializeUHidCreateControlMessage(message);
     }
 }
 
-type Init_<TVideo extends boolean> = Init<TVideo>;
+type Init_ = Init;
 
 export namespace ScrcpyOptions3_3_1 {
-    export type Init<TVideo extends boolean = boolean> = Init_<TVideo>;
+    export type Init = Init_;
+
+    export type Value<TInit extends Init> = ComputeOptionTypes<
+        TInit,
+        typeof Defaults
+    >;
 }

package/src/4_0/impl/compute-option-values.ts

@@ -0,0 +1,31 @@
+import type { ComputeOptionTypes as ComputeOptionTypes1_15 } from "../../1_15/impl/index.js";
+import { computeOptionValues as computeOptionValues1_15 } from "../../1_15/impl/index.js";
+
+import { PrevImpl } from "./prev.js";
+
+export type ComputeOptionTypes<
+    T extends object,
+    TDefaults extends object,
+> = PrevImpl.OverrideAudioSource<
+    PrevImpl.OverrideClipboardAutosync<ComputeOptionTypes1_15<T, TDefaults>>
+>;
+
+export function computeOptionValues<
+    T extends {
+        videoSource?: string | undefined;
+        control?: boolean | undefined;
+        audioDup?: boolean | undefined;
+        audioSource?: string | undefined;
+    },
+    TDefaults extends {
+        videoSource: string;
+        control: boolean;
+        audioDup: boolean;
+        audioSource: string;
+    },
+>(options: T, defaults: TDefaults): ComputeOptionTypes<T, TDefaults> {
+    const value = computeOptionValues1_15(options, defaults);
+    PrevImpl.overrideClipboardAutosync(value as never);
+    PrevImpl.overrideAudioSource(value as never);
+    return value as never;
+}

package/src/4_0/impl/control-message-types.ts

@@ -0,0 +1,27 @@
+import type { ScrcpyControlMessageTypeMap } from "../../base/index.js";
+import { ScrcpyControlMessageType } from "../../base/index.js";
+
+export const ControlMessageTypes = {
+    [ScrcpyControlMessageType.InjectKeyCode]: 0,
+    [ScrcpyControlMessageType.InjectText]: 1,
+    [ScrcpyControlMessageType.InjectTouch]: 2,
+    [ScrcpyControlMessageType.InjectScroll]: 3,
+    [ScrcpyControlMessageType.BackOrScreenOn]: 4,
+    [ScrcpyControlMessageType.ExpandNotificationPanel]: 5,
+    [ScrcpyControlMessageType.ExpandSettingPanel]: 6,
+    [ScrcpyControlMessageType.CollapseNotificationPanel]: 7,
+    [ScrcpyControlMessageType.GetClipboard]: 8,
+    [ScrcpyControlMessageType.SetClipboard]: 9,
+    [ScrcpyControlMessageType.SetDisplayPower]: 10,
+    [ScrcpyControlMessageType.RotateDevice]: 11,
+    [ScrcpyControlMessageType.UHidCreate]: 12,
+    [ScrcpyControlMessageType.UHidInput]: 13,
+    [ScrcpyControlMessageType.UHidDestroy]: 14,
+    [ScrcpyControlMessageType.OpenHardKeyboardSettings]: 15,
+    [ScrcpyControlMessageType.StartApp]: 16,
+    [ScrcpyControlMessageType.ResetVideo]: 17,
+    [ScrcpyControlMessageType.CameraSetTorch]: 18,
+    [ScrcpyControlMessageType.CameraZoomIn]: 19,
+    [ScrcpyControlMessageType.CameraZoomOut]: 20,
+    [ScrcpyControlMessageType.ResizeDisplay]: 21,
+} as const satisfies ScrcpyControlMessageTypeMap;

package/src/4_0/impl/defaults.ts

@@ -0,0 +1,20 @@
+import { omit } from "../../utils/omit.js";
+
+import type { Init } from "./init.js";
+import { PrevImpl } from "./prev.js";
+
+export const Defaults = /* #__PURE__*/ (() =>
+    ({
+        ...omit(PrevImpl.Defaults, "sendCodecMeta"),
+
+        minSizeAlignment: 1,
+
+        cameraZoom: 1,
+        cameraTorch: false,
+
+        flexDisplay: false,
+
+        keepActive: false,
+
+        sendStreamMeta: true,
+    }) as const satisfies Required<Init>)();

package/src/4_0/impl/index.ts

@@ -0,0 +1,9 @@
+export * from "../../3_2/impl/index.js";
+
+export { computeOptionValues } from "./compute-option-values.js";
+export type { ComputeOptionTypes } from "./compute-option-values.js";
+export { ControlMessageTypes } from "./control-message-types.js";
+export { Defaults } from "./defaults.js";
+export type { Init } from "./init.js";
+export { createMediaStreamTransformer } from "./media-stream-transformer.js";
+export { parseVideoStreamMetadataAsync } from "./parse-video-stream-metadata.js";

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

@@ -0,0 +1,14 @@
+import type { PrevImpl } from "./prev.js";
+
+export interface Init extends Omit<PrevImpl.Init, "sendCodecMeta"> {
+    minSizeAlignment?: 1 | 2 | 4 | 8 | 16 | undefined;
+
+    cameraZoom?: number | undefined;
+    cameraTorch?: boolean | undefined;
+
+    flexDisplay?: boolean | undefined;
+
+    keepActive?: boolean | undefined;
+
+    sendStreamMeta?: boolean | undefined;
+}

package/src/4_0/impl/media-stream-transformer.ts

@@ -0,0 +1,58 @@
+import {
+    getUint32BigEndian,
+    getUint64BigEndian,
+} from "@yume-chan/no-data-view";
+import {
+    BufferedTransformStream,
+    TransformStream,
+} from "@yume-chan/stream-extra";
+
+import type { ScrcpyVideoStreamPacket } from "../../base/index.js";
+
+import type { Init } from "./init.js";
+
+export function createMediaStreamTransformer(
+    options: Pick<Init, "sendFrameMeta">,
+): TransformStream<Uint8Array, ScrcpyVideoStreamPacket> {
+    // Quick path for raw stream without frame meta
+    if (!options.sendFrameMeta) {
+        return new TransformStream({
+            transform(chunk, controller) {
+                controller.enqueue({
+                    type: "data",
+                    data: chunk,
+                });
+            },
+        });
+    }
+
+    return new BufferedTransformStream<ScrcpyVideoStreamPacket>(
+        async (buffered) => {
+            const header = await buffered.readExactly(12);
+            if (header[0]! & 0x80) {
+                return {
+                    type: "session",
+                    isClientResize: !!(header[0]! & 1),
+                    width: getUint32BigEndian(header, 4),
+                    height: getUint32BigEndian(header, 8),
+                };
+            }
+
+            if (header[0]! & 0x40) {
+                return {
+                    type: "configuration",
+                    data: await buffered.readExactly(
+                        getUint32BigEndian(header, 8),
+                    ),
+                };
+            }
+
+            return {
+                type: "data",
+                keyframe: !!(header[0]! & 0x20),
+                pts: getUint64BigEndian(header, 0) & 0x1fffffffffffffffn,
+                data: await buffered.readExactly(getUint32BigEndian(header, 8)),
+            };
+        },
+    );
+}

package/src/4_0/impl/parse-video-stream-metadata.ts

@@ -0,0 +1,34 @@
+import type { ReadableStream } from "@yume-chan/stream-extra";
+import { BufferedReadableStream } from "@yume-chan/stream-extra";
+
+import type { ScrcpyVideoStream } from "../../base/video.js";
+import type { ScrcpyVideoCodecId } from "../../video/index.js";
+
+import type { Init } from "./init.js";
+import { PrevImpl } from "./prev.js";
+
+export async function parseVideoStreamMetadataAsync(
+    stream: ReadableStream<Uint8Array>,
+    sendDeviceMeta: Exclude<Init["sendDeviceMeta"], undefined>,
+    sendStreamMeta: Exclude<Init["sendStreamMeta"], undefined>,
+    fallbackCodec: ScrcpyVideoCodecId,
+): Promise<ScrcpyVideoStream> {
+    const buffered = new BufferedReadableStream(stream);
+
+    let deviceName: string | undefined;
+    if (sendDeviceMeta) {
+        deviceName = await PrevImpl.readString(buffered, 64);
+    }
+
+    let codec: ScrcpyVideoCodecId;
+    if (sendStreamMeta) {
+        codec = (await PrevImpl.readU32(buffered)) as ScrcpyVideoCodecId;
+    } else {
+        codec = fallbackCodec;
+    }
+
+    return {
+        stream: buffered.release(),
+        metadata: { deviceName, codec },
+    };
+}

package/src/4_0/impl/prev.ts

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