@yume-chan/scrcpy 0.0.13 → 0.0.16

package/CHANGELOG.json

@@ -1,6 +1,51 @@
 {
   "name": "@yume-chan/scrcpy",
   "entries": [
+    {
+      "version": "0.0.16",
+      "tag": "@yume-chan/scrcpy_v0.0.16",
+      "date": "Sat, 28 May 2022 03:56:37 GMT",
+      "comments": {
+        "none": [
+          {
+            "comment": "Upgrade TypeScript to 4.7.2 to enable Node.js ESM"
+          },
+          {
+            "comment": "Add support for more `CodecOptions` keys"
+          },
+          {
+            "comment": "Add support for `CodecOptions` value types other than `int`"
+          }
+        ]
+      }
+    },
+    {
+      "version": "0.0.15",
+      "tag": "@yume-chan/scrcpy_v0.0.15",
+      "date": "Mon, 02 May 2022 04:18:01 GMT",
+      "comments": {
+        "none": [
+          {
+            "comment": "Add support for `rotateDevice` control message"
+          },
+          {
+            "comment": "Add method to get screen list"
+          }
+        ]
+      }
+    },
+    {
+      "version": "0.0.14",
+      "tag": "@yume-chan/scrcpy_v0.0.14",
+      "date": "Sat, 30 Apr 2022 14:05:48 GMT",
+      "comments": {
+        "none": [
+          {
+            "comment": "Add support for new option of 1.24"
+          }
+        ]
+      }
+    },
     {
       "version": "0.0.13",
       "tag": "@yume-chan/scrcpy_v0.0.13",

package/CHANGELOG.md

@@ -1,6 +1,30 @@
 # Change Log - @yume-chan/scrcpy
 
-This log was last generated on Thu, 28 Apr 2022 01:23:53 GMT and should not be manually modified.
+This log was last generated on Sat, 28 May 2022 03:56:37 GMT and should not be manually modified.
+
+## 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 new option of 1.24
 
 ## 0.0.13
 Thu, 28 Apr 2022 01:23:53 GMT

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020-2022 Simon Chan
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020-2022 Simon Chan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,89 +1,90 @@
-# @yume-chan/scrcpy
-
-TypeScript implementation of [Scrcpy](https://github.com/Genymobile/scrcpy) client.
-
-It uses the official Scrcpy server releases.
-
-**WARNING:** The public API is UNSTABLE. If you have any questions, please open an issue.
-
-## Download Server Binary
-
-This package has a script `fetch-scrcpy-server` to help you download the official server binary.
-
-The server binary is subject to [Apache License 2.0](https://github.com/Genymobile/scrcpy/blob/master/LICENSE).
-
-Usage:
-
-```
-$ npx fetch-scrcpy-server <version>
-```
-
-For example:
-
-```
-$ npx fetch-scrcpy-server 1.21
-```
-
-You can also add it to the `postinstall` script of your `package.json` so it will run automatically when you do `npm install`:
-
-```json
-"scripts": {
-    "postinstall": "fetch-scrcpy-server 1.21",
-},
-```
-
-It will download the binary to `bin/scrcpy` and write the version string to `bin/version.js`. You can import the version string with
-
-```js
-import SCRCPY_SERVER_VERSION from '@yume-chan/scrcpy/bin/version';
-```
-
-And import the server binary with [file-loader](https://v4.webpack.js.org/loaders/file-loader/) (Webpack 4) or [Asset Modules](https://webpack.js.org/guides/asset-modules/) (Webpack 5).
-
-## Option versions
-
-Scrcpy server has no backward compatibility on options input format. Currently the following versions are supported:
-
-| versions  | type                |
-| --------- | ------------------- |
-| 1.16~1.17 | `ScrcpyOptions1_16` |
-| 1.18~1.20 | `ScrcpyOptions1_18` |
-| 1.21      | `ScrcpyOptions1_21` |
-| 1.22      | `ScrcpyOptions1_22` |
-| 1.23      | `ScrcpyOptions1_23` |
-
-You must use the correct type according to the server version.
-
-## Video stream
-
-The data from `onVideoData` event is a raw H.264 stream. You can process it as you want, or use the following built-in decoders to render it in browsers:
-
-* WebCodecs decoder: Uses the [WebCodecs API](https://developer.mozilla.org/en-US/docs/Web/API/WebCodecs_API). The video stream will be decoded into `VideoFrame`s and drawn on a 2D canvas.
-* TinyH264 decoder: TinyH264 compiles the old Android H.264 software decoder (now deprecated and removed) into WebAssembly, and wrap it in Web Worker to prevent blocking the main thread. The video stream will be decoded into YUV frames, then converted to RGB using a WebGL shader.
-
-| Name              | Chrome | Firefox | Safari | Performance                     | Supported H.264 profile/level |
-| ----------------- | ------ | ------- | ------ | ------------------------------- | ----------------------------- |
-| WebCodecs decoder | 94     | No      | No     | High with Hardware acceleration | High level 5                  |
-| TinyH264 decoder  | 57     | 52      | 11     | Poor                            | Baseline level 4              |
-
-TinyH264 decoder needs some extra setup:
-
-1. `tinyh264`, `yuv-buffer` and `yuv-canvas` packages are peer dependencies. You must install them separately.
-2. The bundler you use must support the `new Worker(new URL('./worker.js', import.meta.url))` syntax. It's known to work with Webpack 5.
-
-Example usage:
-
-```ts
-const client = new ScrcpyClient(adb);
-const decoder = new WebCodecsDecoder(); // Or `new TinyH264Decoder()`
-client.onSizeChanged(size => decoder.setSize(size));
-client.onVideoData(data => decoder.feed(data));
-client.start(serverPath, serverVersion, new ScrcpyOptionsX_XX({
-    ...options,
-    codecOptions: new CodecOptions({
-        profile: decoder.maxProfile,
-        level: decoder.maxLevel,
-    }),
-}));
-document.body.appendChild(decoder.element);
-```
+# @yume-chan/scrcpy
+
+TypeScript implementation of [Scrcpy](https://github.com/Genymobile/scrcpy) client.
+
+It uses the official Scrcpy server releases.
+
+**WARNING:** The public API is UNSTABLE. If you have any questions, please open an issue.
+
+## Download Server Binary
+
+This package has a script `fetch-scrcpy-server` to help you download the official server binary.
+
+The server binary is subject to [Apache License 2.0](https://github.com/Genymobile/scrcpy/blob/master/LICENSE).
+
+Usage:
+
+```
+$ npx fetch-scrcpy-server <version>
+```
+
+For example:
+
+```
+$ npx fetch-scrcpy-server 1.21
+```
+
+You can also add it to the `postinstall` script of your `package.json` so it will run automatically when you do `npm install`:
+
+```json
+"scripts": {
+    "postinstall": "fetch-scrcpy-server 1.21",
+},
+```
+
+It will download the binary to `bin/scrcpy` and write the version string to `bin/version.js`. You can import the version string with
+
+```js
+import SCRCPY_SERVER_VERSION from '@yume-chan/scrcpy/bin/version';
+```
+
+And import the server binary with [file-loader](https://v4.webpack.js.org/loaders/file-loader/) (Webpack 4) or [Asset Modules](https://webpack.js.org/guides/asset-modules/) (Webpack 5).
+
+## Option versions
+
+Scrcpy server has no backward compatibility on options input format. Currently the following versions are supported:
+
+| versions  | type                |
+| --------- | ------------------- |
+| 1.16~1.17 | `ScrcpyOptions1_16` |
+| 1.18~1.20 | `ScrcpyOptions1_18` |
+| 1.21      | `ScrcpyOptions1_21` |
+| 1.22      | `ScrcpyOptions1_22` |
+| 1.23      | `ScrcpyOptions1_23` |
+| 1.24      | `ScrcpyOptions1_24` |
+
+You must use the correct type according to the server version.
+
+## Video stream
+
+The data from `onVideoData` event is a raw H.264 stream. You can process it as you want, or use the following built-in decoders to render it in browsers:
+
+* WebCodecs decoder: Uses the [WebCodecs API](https://developer.mozilla.org/en-US/docs/Web/API/WebCodecs_API). The video stream will be decoded into `VideoFrame`s and drawn on a 2D canvas.
+* TinyH264 decoder: TinyH264 compiles the old Android H.264 software decoder (now deprecated and removed) into WebAssembly, and wrap it in Web Worker to prevent blocking the main thread. The video stream will be decoded into YUV frames, then converted to RGB using a WebGL shader.
+
+| Name              | Chrome | Firefox | Safari | Performance                     | Supported H.264 profile/level |
+| ----------------- | ------ | ------- | ------ | ------------------------------- | ----------------------------- |
+| WebCodecs decoder | 94     | No      | No     | High with Hardware acceleration | High level 5                  |
+| TinyH264 decoder  | 57     | 52      | 11     | Poor                            | Baseline level 4              |
+
+TinyH264 decoder needs some extra setup:
+
+1. `tinyh264`, `yuv-buffer` and `yuv-canvas` packages are peer dependencies. You must install them separately.
+2. The bundler you use must support the `new Worker(new URL('./worker.js', import.meta.url))` syntax. It's known to work with Webpack 5.
+
+Example usage:
+
+```ts
+const client = new ScrcpyClient(adb);
+const decoder = new WebCodecsDecoder(); // Or `new TinyH264Decoder()`
+client.onSizeChanged(size => decoder.setSize(size));
+client.onVideoData(data => decoder.feed(data));
+client.start(serverPath, serverVersion, new ScrcpyOptionsX_XX({
+    ...options,
+    codecOptions: new CodecOptions({
+        profile: decoder.maxProfile,
+        level: decoder.maxLevel,
+    }),
+}));
+document.body.appendChild(decoder.element);
+```

package/bin/version.d.ts

@@ -1 +1 @@
-export default '1.23';
+export default '1.24';

package/bin/version.js

@@ -1 +1 @@
-export default '1.23';
+export default '1.24';

package/esm/client.d.ts

@@ -1,8 +1,17 @@
-import { type Adb, type AdbSocket, type AdbSubprocessProtocol, type ReadableStream } from '@yume-chan/adb';
+import { ReadableStream, type Adb, type AdbSocket, type AdbSubprocessProtocol } from '@yume-chan/adb';
 import { ScrcpyInjectKeyCodeControlMessage, ScrcpyInjectTouchControlMessage, type AndroidKeyEventAction } from './message.js';
 import type { ScrcpyInjectScrollControlMessage1_22, ScrcpyOptions, VideoStreamPacket } from "./options/index.js";
 export declare class ScrcpyClient {
+    /**
+     * This method will modify the given `options`,
+     * so don't reuse it elsewhere.
+     */
     static getEncoders(adb: Adb, path: string, version: string, options: ScrcpyOptions<any>): Promise<string[]>;
+    /**
+     * This method will modify the given `options`,
+     * so don't reuse it elsewhere.
+     */
+    static getDisplays(adb: Adb, path: string, version: string, options: ScrcpyOptions<any>): Promise<number[]>;
     static start(adb: Adb, path: string, version: string, options: ScrcpyOptions<any>): Promise<ScrcpyClient>;
     private _adb;
     get adb(): Adb;
@@ -24,13 +33,16 @@ export declare class ScrcpyClient {
         <TThis, TArgs extends unknown[]>(listener: import("@yume-chan/event").EventListener<string, TThis, TArgs, unknown>, thisArg: TThis, ...args: TArgs): import("@yume-chan/event").RemoveEventListener;
     };
     private lastTouchMessage;
-    constructor(adb: Adb, options: ScrcpyOptions<any>, process: AdbSubprocessProtocol, videoStream: AdbSocket, controlStream: AdbSocket | undefined);
+    constructor(adb: Adb, options: ScrcpyOptions<any>, process: AdbSubprocessProtocol, stdout: ReadableStream<string>, videoStream: AdbSocket, controlStream: AdbSocket | undefined);
     private checkControlStream;
+    private getControlMessageTypeValue;
     injectKeyCode(message: Omit<ScrcpyInjectKeyCodeControlMessage, 'type'>): Promise<void>;
     injectText(text: string): Promise<void>;
     injectTouch(message: Omit<ScrcpyInjectTouchControlMessage, 'type' | 'screenWidth' | 'screenHeight'>): Promise<void>;
     injectScroll(message: Omit<ScrcpyInjectScrollControlMessage1_22, 'type' | 'screenWidth' | 'screenHeight'>): Promise<void>;
     pressBackOrTurnOnScreen(action: AndroidKeyEventAction): Promise<void>;
+    private sendSimpleControlMessage;
+    rotateDevice(): Promise<void>;
     close(): Promise<void>;
 }
 //# sourceMappingURL=client.d.ts.map

package/esm/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkH,KAAK,GAAG,EAAE,KAAK,SAAS,EAAE,KAAK,qBAAqB,EAAE,KAAK,cAAc,EAAoC,MAAM,gBAAgB,CAAC;AAG7P,OAAO,EAAsD,iCAAiC,EAAkC,+BAA+B,EAAE,KAAK,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAClN,OAAO,KAAK,EAAE,oCAAoC,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAuBjH,qBAAa,YAAY;WACD,WAAW,CAC3B,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,GAC5B,OAAO,CAAC,MAAM,EAAE,CAAC;WAyBA,KAAK,CACrB,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC;IA4C/B,OAAO,CAAC,IAAI,CAAM;IAClB,IAAW,GAAG,QAAwB;IAEtC,OAAO,CAAC,OAAO,CAAqB;IACpC,OAAO,CAAC,OAAO,CAAwB;IAEvC,OAAO,CAAC,OAAO,CAAyB;IACxC,IAAW,MAAM,2BAA2B;IAE5C,IAAW,IAAI,oBAAgC;IAE/C,OAAO,CAAC,YAAY,CAAqB;IACzC,IAAW,WAAW,uBAAgC;IAEtD,OAAO,CAAC,aAAa,CAAqB;IAC1C,IAAW,YAAY,uBAAiC;IAExD,OAAO,CAAC,YAAY,CAAoC;IACxD,IAAW,WAAW,sCAAgC;IAEtD,OAAO,CAAC,oBAAoB,CAAsD;IAElF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA8B;IACnE,IAAW,iBAAiB;;;MAA8C;IAE1E,OAAO,CAAC,gBAAgB,CAAK;gBAGzB,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,OAAO,EAAE,qBAAqB,EAC9B,WAAW,EAAE,SAAS,EACtB,aAAa,EAAE,SAAS,GAAG,SAAS;IAmDxC,OAAO,CAAC,kBAAkB;IAQb,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,iCAAiC,EAAE,MAAM,CAAC;IAStE,UAAU,CAAC,IAAI,EAAE,MAAM;IASvB,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,+BAA+B,EAAE,MAAM,GAAG,aAAa,GAAG,cAAc,CAAC;IA2BnG,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,oCAAoC,EAAE,MAAM,GAAG,aAAa,GAAG,cAAc,CAAC;IAgBzG,uBAAuB,CAAC,MAAM,EAAE,qBAAqB;IAYrD,KAAK;CAIrB"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkG,cAAc,EAAmC,KAAK,GAAG,EAAE,KAAK,SAAS,EAAE,KAAK,qBAAqB,EAAoC,MAAM,gBAAgB,CAAC;AAGzQ,OAAO,EAAsD,iCAAiC,EAAkC,+BAA+B,EAA8B,KAAK,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAC9O,OAAO,KAAK,EAAE,oCAAoC,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AA8FjH,qBAAa,YAAY;IACrB;;;OAGG;WACiB,WAAW,CAC3B,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,GAC5B,OAAO,CAAC,MAAM,EAAE,CAAC;IA2BpB;;;OAGG;WACiB,WAAW,CAC3B,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,GAC5B,OAAO,CAAC,MAAM,EAAE,CAAC;WA8BA,KAAK,CACrB,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC;IA6E/B,OAAO,CAAC,IAAI,CAAM;IAClB,IAAW,GAAG,QAAwB;IAEtC,OAAO,CAAC,OAAO,CAAqB;IACpC,OAAO,CAAC,OAAO,CAAwB;IAEvC,OAAO,CAAC,OAAO,CAAyB;IACxC,IAAW,MAAM,2BAA2B;IAE5C,IAAW,IAAI,oBAAgC;IAE/C,OAAO,CAAC,YAAY,CAAqB;IACzC,IAAW,WAAW,uBAAgC;IAEtD,OAAO,CAAC,aAAa,CAAqB;IAC1C,IAAW,YAAY,uBAAiC;IAExD,OAAO,CAAC,YAAY,CAAoC;IACxD,IAAW,WAAW,sCAAgC;IAEtD,OAAO,CAAC,oBAAoB,CAAsD;IAElF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA8B;IACnE,IAAW,iBAAiB;;;MAA8C;IAE1E,OAAO,CAAC,gBAAgB,CAAK;gBAGzB,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,aAAa,CAAC,GAAG,CAAC,EAC3B,OAAO,EAAE,qBAAqB,EAC9B,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,EAC9B,WAAW,EAAE,SAAS,EACtB,aAAa,EAAE,SAAS,GAAG,SAAS;IAwCxC,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,0BAA0B;IASrB,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,iCAAiC,EAAE,MAAM,CAAC;IAStE,UAAU,CAAC,IAAI,EAAE,MAAM;IASvB,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,+BAA+B,EAAE,MAAM,GAAG,aAAa,GAAG,cAAc,CAAC;IA2BnG,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,oCAAoC,EAAE,MAAM,GAAG,aAAa,GAAG,cAAc,CAAC;IAgBzG,uBAAuB,CAAC,MAAM,EAAE,qBAAqB;YAYpD,wBAAwB;IAQzB,YAAY;IAIZ,KAAK;CAIrB"}