@yume-chan/scrcpy 0.0.23 → 0.0.24

package/src/codec/nalu.ts

@@ -91,153 +91,17 @@ export function* annexBSplitNalu(buffer: Uint8Array): Generator<Uint8Array> {
     yield buffer.subarray(start, buffer.length);
 }
 
-/**
- * Remove emulation prevention bytes from a H.264/H.265 NAL Unit.
- *
- * The input is not modified.
- * If the input doesn't contain any emulation prevention bytes,
- * the input is returned as-is.
- * Otherwise, a new `Uint8Array` is created and returned.
- */
-export function naluRemoveEmulation(buffer: Uint8Array) {
-    // output will be created when first emulation prevention byte is found
-    let output: Uint8Array | undefined;
-    let outputOffset = 0;
-
-    let zeroCount = 0;
-    let inEmulation = false;
-
-    let i = 0;
-    scan: for (; i < buffer.length; i += 1) {
-        const byte = buffer[i]!;
-
-        if (byte === 0x00) {
-            zeroCount += 1;
-            continue;
-        }
-
-        // Current byte is not zero
-        const prevZeroCount = zeroCount;
-        zeroCount = 0;
-
-        if (prevZeroCount < 2) {
-            // zero or one `0x00`s are acceptable
-            continue;
-        }
-
-        if (byte === 0x01) {
-            // Unexpected start code
-            throw new Error("Invalid data");
-        }
-
-        if (prevZeroCount > 2) {
-            // Too much `0x00`s
-            throw new Error("Invalid data");
-        }
-
-        switch (byte) {
-            case 0x02:
-                // Didn't find why, but 7.4.1 NAL unit semantics forbids `0x000002` appearing in NAL units
-                throw new Error("Invalid data");
-            case 0x03:
-                // `0x000003` is the "emulation_prevention_three_byte"
-                // `0x00000300`, `0x00000301`, `0x00000302` and `0x00000303` represent
-                // `0x000000`, `0x000001`, `0x000002` and `0x000003` respectively
-                inEmulation = true;
-
-                // Create output and copy the data before the emulation prevention byte
-                // Output size is unknown, so we use the input size as an upper bound
-                output = new Uint8Array(buffer.length - 1);
-                output.set(buffer.subarray(0, i));
-                outputOffset = i;
-                i += 1;
-                break scan;
-            default:
-                // `0x000004` or larger are as-is
-                break;
-        }
-    }
-
-    if (!output) {
-        return buffer;
-    }
-
-    // Continue at the byte after the emulation prevention byte
-    for (; i < buffer.length; i += 1) {
-        const byte = buffer[i]!;
-
-        output[outputOffset] = byte;
-        outputOffset += 1;
-
-        if (inEmulation) {
-            if (byte > 0x03) {
-                // `0x00000304` or larger are invalid
-                throw new Error("Invalid data");
-            }
-
-            // `00000300000300` results in `0000000000` (both `0x03` are removed)
-            // which means the `0x00` after `0x03` also counts
-            if (byte === 0x00) {
-                zeroCount += 1;
-            }
-
-            inEmulation = false;
-            continue;
-        }
-
-        if (byte === 0x00) {
-            zeroCount += 1;
-            continue;
-        }
-
-        const prevZeroCount = zeroCount;
-        zeroCount = 0;
-
-        if (prevZeroCount < 2) {
-            // zero or one `0x00`s are acceptable
-            continue;
-        }
-
-        if (byte === 0x01) {
-            // Unexpected start code
-            throw new Error("Invalid data");
-        }
-
-        if (prevZeroCount > 2) {
-            // Too much `0x00`s
-            throw new Error("Invalid data");
-        }
-
-        switch (byte) {
-            case 0x02:
-                // Didn't find why, but 7.4.1 NAL unit semantics forbids `0x000002` appearing in NAL units
-                throw new Error("Invalid data");
-            case 0x03:
-                // `0x000003` is the "emulation_prevention_three_byte"
-                // `0x00000300`, `0x00000301`, `0x00000302` and `0x00000303` represent
-                // `0x000000`, `0x000001`, `0x000002` and `0x000003` respectively
-                inEmulation = true;
-
-                // Remove the emulation prevention byte
-                outputOffset -= 1;
-                break;
-            default:
-                // `0x000004` or larger are as-is
-                break;
-        }
-    }
-
-    return output.subarray(0, outputOffset);
-}
-
 export class NaluSodbBitReader {
     readonly #nalu: Uint8Array;
+    // logical length is `#byteLength * 8 + (7 - #stopBitIndex)`
     readonly #byteLength: number;
     readonly #stopBitIndex: number;
 
     #zeroCount = 0;
-    #bytePosition = -1;
-    #bitPosition = -1;
+
+    // logical position is `#bytePosition * 8 + (7 - #bitPosition)`
+    #bytePosition = 0;
+    #bitPosition = 7;
     #byte = 0;
 
     get byteLength() {
@@ -258,14 +122,15 @@ export class NaluSodbBitReader {
 
     get ended() {
         return (
-            this.#bytePosition === this.#byteLength &&
-            this.#bitPosition === this.#stopBitIndex
+            this.#bytePosition >= this.#byteLength &&
+            this.#bitPosition <= this.#stopBitIndex
         );
     }
 
     constructor(nalu: Uint8Array) {
         this.#nalu = nalu;
 
+        // Search for the last bit being `1`, also known as the stop bit
         for (let i = nalu.length - 1; i >= 0; i -= 1) {
             if (this.#nalu[i] === 0) {
                 continue;
@@ -276,7 +141,7 @@ export class NaluSodbBitReader {
                 if (((byte >> j) & 1) === 1) {
                     this.#byteLength = i;
                     this.#stopBitIndex = j;
-                    this.#readByte();
+                    this.#loadByte();
                     return;
                 }
             }
@@ -285,15 +150,22 @@ export class NaluSodbBitReader {
         throw new Error("Stop bit not found");
     }
 
-    #readByte() {
+    #loadByte() {
         this.#byte = this.#nalu[this.#bytePosition]!;
+
+        // If the current sequence is `0x000003`, skip to the next byte.
+        // `annexBSplitNalu` had validated the input, so skip the check here
         if (this.#zeroCount === 2 && this.#byte === 3) {
             this.#zeroCount = 0;
             this.#bytePosition += 1;
-            this.#readByte();
+            // Call `#loadByte` again, because if the next byte is `0x00`,
+            // it need to be counted in `#zeroCount` as well.
+            this.#loadByte();
             return;
         }
 
+        // `0x00000301` becomes `0x000001`, so only the `0x03` byte needs to be skipped
+        // All `0x00` bytes are returned as-is
         if (this.#byte === 0) {
             this.#zeroCount += 1;
         } else {
@@ -302,18 +174,19 @@ export class NaluSodbBitReader {
     }
 
     next() {
-        if (this.#bitPosition === -1) {
-            this.#bitPosition = 7;
-            this.#bytePosition += 1;
-            this.#readByte();
-        }
-
         if (this.ended) {
             throw new Error("Bit index out of bounds");
         }
 
         const value = (this.#byte >> this.#bitPosition) & 1;
+
         this.#bitPosition -= 1;
+        if (this.#bitPosition < 0) {
+            this.#bytePosition += 1;
+            this.#bitPosition = 7;
+            this.#loadByte();
+        }
+
         return value;
     }
 
@@ -329,10 +202,50 @@ export class NaluSodbBitReader {
         return result;
     }
 
+    /**
+     * Throws an error if the current position is invalid for `skip`.
+     *
+     * Usually it will throw if `ended` is `true`,
+     * except when the bit position is at the stop bit,
+     * in which case `ended` will be `true`, but it won't throw.
+     * `skip` can skip all remaining bits, and stop at the end position.
+     * The next `next` call will throw since there is no more bits to read.
+     */
+    #checkSkipPosition() {
+        if (
+            this.#bytePosition >= this.#byteLength &&
+            this.#bitPosition < this.#stopBitIndex
+        ) {
+            throw new Error("Bit index out of bounds");
+        }
+    }
+
     skip(length: number) {
-        for (let i = 0; i < length; i += 1) {
-            this.next();
+        if (length <= this.#bitPosition + 1) {
+            this.#bitPosition -= length;
+            this.#checkSkipPosition();
+            return;
+        }
+
+        // Because of emulation prevention bytes,
+        // we don't know how many bits are left in the NAL,
+        // nor how many bits should be skipped.
+        // So we need to check each byte.
+
+        length -= this.#bitPosition + 1;
+        this.#bytePosition += 1;
+        this.#bitPosition = 7;
+        this.#loadByte();
+        this.#checkSkipPosition();
+
+        for (; length >= 8; length -= 8) {
+            this.#bytePosition += 1;
+            this.#loadByte();
+            this.#checkSkipPosition();
         }
+
+        this.#bitPosition = 7 - length;
+        this.#checkSkipPosition();
     }
 
     decodeExponentialGolombNumber(): number {

package/src/control/empty.ts

@@ -0,0 +1,3 @@
+import { Struct } from "@yume-chan/struct";
+
+export const EmptyControlMessage = new Struct().uint8("type");

package/src/control/index.ts

@@ -1,5 +1,5 @@
 export * from "./back-or-screen-on.js";
-export * from "./basic.js";
+export * from "./empty.js";
 export * from "./hover-helper.js";
 export * from "./inject-keycode.js";
 export * from "./inject-scroll.js";

package/src/control/rotate-device.ts

@@ -1,6 +1,6 @@
-import { BasicControlMessage } from "./basic.js";
+import { EmptyControlMessage } from "./empty.js";
 
-export const ScrcpyRotateDeviceControlMessage = BasicControlMessage;
+export const ScrcpyRotateDeviceControlMessage = EmptyControlMessage;
 
 export type ScrcpyRotateDeviceControlMessage =
     (typeof ScrcpyRotateDeviceControlMessage)["TInit"];

package/src/control/serializer.ts

@@ -3,13 +3,14 @@ import type {
     ScrcpyScrollController,
 } from "../options/index.js";
 
-import { BasicControlMessage } from "./basic.js";
+import { EmptyControlMessage } from "./empty.js";
 import type { AndroidKeyEventAction } from "./inject-keycode.js";
 import { ScrcpyInjectKeyCodeControlMessage } from "./inject-keycode.js";
 import type { ScrcpyInjectScrollControlMessage } from "./inject-scroll.js";
 import { ScrcpyInjectTextControlMessage } from "./inject-text.js";
 import type { ScrcpyInjectTouchControlMessage } from "./inject-touch.js";
 import { ScrcpyRotateDeviceControlMessage } from "./rotate-device.js";
+import type { ScrcpySetClipboardControlMessage } from "./set-clipboard.js";
 import type { AndroidScreenPowerMode } from "./set-screen-power-mode.js";
 import { ScrcpySetScreenPowerModeControlMessage } from "./set-screen-power-mode.js";
 import {
@@ -85,7 +86,7 @@ export class ScrcpyControlMessageSerializer {
     }
 
     expandNotificationPanel() {
-        return BasicControlMessage.serialize({
+        return EmptyControlMessage.serialize({
             type: this.#typeValues.get(
                 ScrcpyControlMessageType.ExpandNotificationPanel,
             ),
@@ -93,7 +94,7 @@ export class ScrcpyControlMessageSerializer {
     }
 
     expandSettingPanel() {
-        return BasicControlMessage.serialize({
+        return EmptyControlMessage.serialize({
             type: this.#typeValues.get(
                 ScrcpyControlMessageType.ExpandSettingPanel,
             ),
@@ -101,7 +102,7 @@ export class ScrcpyControlMessageSerializer {
     }
 
     collapseNotificationPanel() {
-        return BasicControlMessage.serialize({
+        return EmptyControlMessage.serialize({
             type: this.#typeValues.get(
                 ScrcpyControlMessageType.CollapseNotificationPanel,
             ),
@@ -113,4 +114,11 @@ export class ScrcpyControlMessageSerializer {
             type: this.#typeValues.get(ScrcpyControlMessageType.RotateDevice),
         });
     }
+
+    setClipboard(message: Omit<ScrcpySetClipboardControlMessage, "type">) {
+        return this.#options.serializeSetClipboardControlMessage({
+            ...message,
+            type: this.#typeValues.get(ScrcpyControlMessageType.SetClipboard),
+        });
+    }
 }

package/src/control/type.ts

@@ -34,7 +34,7 @@ export class ScrcpyControlMessageTypeValue {
     get(type: ScrcpyControlMessageType): number {
         const value = this.#types.indexOf(type);
         if (value === -1) {
-            throw new Error("Not supported");
+            throw new TypeError("Invalid or unsupported control message type");
         }
         return value;
     }

package/src/control/writer.ts

@@ -1,8 +1,5 @@
-import type {
-    Consumable,
-    WritableStreamDefaultWriter,
-} from "@yume-chan/stream-extra";
-import { ConsumableWritableStream } from "@yume-chan/stream-extra";
+import type { WritableStreamDefaultWriter } from "@yume-chan/stream-extra";
+import { Consumable } from "@yume-chan/stream-extra";
 
 import type { ScrcpyOptions } from "../options/index.js";
 
@@ -13,6 +10,7 @@ import type {
 import type { ScrcpyInjectScrollControlMessage } from "./inject-scroll.js";
 import type { ScrcpyInjectTouchControlMessage } from "./inject-touch.js";
 import { ScrcpyControlMessageSerializer } from "./serializer.js";
+import type { ScrcpySetClipboardControlMessage } from "./set-clipboard.js";
 import type { AndroidScreenPowerMode } from "./set-screen-power-mode.js";
 
 export class ScrcpyControlMessageWriter {
@@ -28,7 +26,7 @@ export class ScrcpyControlMessageWriter {
     }
 
     async write(message: Uint8Array) {
-        await ConsumableWritableStream.write(this.#writer, message);
+        await Consumable.WritableStream.write(this.#writer, message);
     }
 
     async injectKeyCode(
@@ -87,6 +85,18 @@ export class ScrcpyControlMessageWriter {
         await this.write(this.#serializer.rotateDevice());
     }
 
+    async setClipboard(
+        message: Omit<ScrcpySetClipboardControlMessage, "type">,
+    ) {
+        const result = this.#serializer.setClipboard(message);
+        if (result instanceof Uint8Array) {
+            await this.write(result);
+        } else {
+            await this.write(result[0]);
+            await result[1];
+        }
+    }
+
     releaseLock() {
         this.#writer.releaseLock();
     }

package/src/index.ts

@@ -1,4 +1,3 @@
 export * from "./codec/index.js";
 export * from "./control/index.js";
-export * from "./device-message/index.js";
 export * from "./options/index.js";

package/src/options/1_16/{float-to-uint16.ts → float.ts}

@@ -1,4 +1,6 @@
-import { NumberFieldDefinition, NumberFieldType } from "@yume-chan/struct";
+import { getUint16 } from "@yume-chan/no-data-view";
+import type { NumberFieldVariant } from "@yume-chan/struct";
+import { NumberFieldDefinition } from "@yume-chan/struct";
 
 export function clamp(value: number, min: number, max: number): number {
     if (value < min) {
@@ -12,11 +14,11 @@ export function clamp(value: number, min: number, max: number): number {
     return value;
 }
 
-export const ScrcpyFloatToUint16NumberType: NumberFieldType = {
+export const ScrcpyUnsignedFloatNumberVariant: NumberFieldVariant = {
     size: 2,
     signed: false,
     deserialize(array, littleEndian) {
-        const value = NumberFieldType.Uint16.deserialize(array, littleEndian);
+        const value = getUint16(array, 0, littleEndian);
         // https://github.com/Genymobile/scrcpy/blob/1f138aef41de651668043b32c4effc2d4adbfc44/server/src/main/java/com/genymobile/scrcpy/Binary.java#L22
         return value === 0xffff ? 1 : value / 0x10000;
     },
@@ -24,10 +26,10 @@ export const ScrcpyFloatToUint16NumberType: NumberFieldType = {
         // https://github.com/Genymobile/scrcpy/blob/1f138aef41de651668043b32c4effc2d4adbfc44/app/src/util/binary.h#L51
         value = clamp(value, -1, 1);
         value = value === 1 ? 0xffff : value * 0x10000;
-        NumberFieldType.Uint16.serialize(dataView, offset, value, littleEndian);
+        dataView.setUint16(offset, value, littleEndian);
     },
 };
 
-export const ScrcpyFloatToUint16FieldDefinition = new NumberFieldDefinition(
-    ScrcpyFloatToUint16NumberType,
+export const ScrcpyUnsignedFloatFieldDefinition = new NumberFieldDefinition(
+    ScrcpyUnsignedFloatNumberVariant,
 );

package/src/options/1_16/index.ts

@@ -1,5 +1,5 @@
 export * from "./codec-options.js";
-export * from "./float-to-uint16.js";
+export * from "./float.js";
 export * from "./init.js";
 export * from "./message.js";
 export * from "./options.js";

package/src/options/1_16/message.ts

@@ -2,11 +2,11 @@ import Struct, { placeholder } from "@yume-chan/struct";
 
 import type { AndroidMotionEventAction } from "../../control/index.js";
 import {
-    BasicControlMessage,
+    EmptyControlMessage,
     ScrcpyControlMessageType,
 } from "../../control/index.js";
 
-import { ScrcpyFloatToUint16FieldDefinition } from "./float-to-uint16.js";
+import { ScrcpyUnsignedFloatFieldDefinition } from "./float.js";
 
 export const SCRCPY_CONTROL_MESSAGE_TYPES_1_16: readonly ScrcpyControlMessageType[] =
     [
@@ -38,13 +38,13 @@ export const ScrcpyInjectTouchControlMessage1_16 = new Struct()
     .uint32("pointerY")
     .uint16("screenWidth")
     .uint16("screenHeight")
-    .field("pressure", ScrcpyFloatToUint16FieldDefinition)
+    .field("pressure", ScrcpyUnsignedFloatFieldDefinition)
     .uint32("buttons");
 
 export type ScrcpyInjectTouchControlMessage1_16 =
     (typeof ScrcpyInjectTouchControlMessage1_16)["TInit"];
 
-export const ScrcpyBackOrScreenOnControlMessage1_16 = BasicControlMessage;
+export const ScrcpyBackOrScreenOnControlMessage1_16 = EmptyControlMessage;
 
 export const ScrcpySetClipboardControlMessage1_15 = new Struct()
     .uint8("type")
@@ -53,3 +53,7 @@ export const ScrcpySetClipboardControlMessage1_15 = new Struct()
 
 export type ScrcpySetClipboardControlMessage1_15 =
     (typeof ScrcpySetClipboardControlMessage1_15)["TInit"];
+
+export const ScrcpyClipboardDeviceMessage = new Struct()
+    .uint32("length")
+    .string("content", { lengthField: "length" });