@yume-chan/scrcpy 0.0.19 → 0.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (252) hide show
  1. package/CHANGELOG.json +15 -0
  2. package/CHANGELOG.md +9 -1
  3. package/README.md +105 -181
  4. package/esm/codec/h264.d.ts +1 -21
  5. package/esm/codec/h264.d.ts.map +1 -1
  6. package/esm/codec/h264.js +13 -234
  7. package/esm/codec/h264.js.map +1 -1
  8. package/esm/codec/h265.d.ts +454 -0
  9. package/esm/codec/h265.d.ts.map +1 -1
  10. package/esm/codec/h265.js +1060 -0
  11. package/esm/codec/h265.js.map +1 -1
  12. package/esm/codec/index.d.ts +1 -0
  13. package/esm/codec/index.d.ts.map +1 -1
  14. package/esm/codec/index.js +1 -0
  15. package/esm/codec/index.js.map +1 -1
  16. package/esm/codec/nalu.d.ts +44 -0
  17. package/esm/codec/nalu.d.ts.map +1 -0
  18. package/esm/codec/nalu.js +310 -0
  19. package/esm/codec/nalu.js.map +1 -0
  20. package/esm/control/back-or-screen-on.d.ts +1 -1
  21. package/esm/control/back-or-screen-on.d.ts.map +1 -1
  22. package/esm/control/index.d.ts +2 -0
  23. package/esm/control/index.d.ts.map +1 -1
  24. package/esm/control/index.js +2 -0
  25. package/esm/control/index.js.map +1 -1
  26. package/esm/control/inject-keycode.d.ts +1 -2
  27. package/esm/control/inject-keycode.d.ts.map +1 -1
  28. package/esm/control/inject-keycode.js +1 -2
  29. package/esm/control/inject-keycode.js.map +1 -1
  30. package/esm/control/inject-text.d.ts +1 -2
  31. package/esm/control/inject-text.d.ts.map +1 -1
  32. package/esm/control/inject-text.js +1 -2
  33. package/esm/control/inject-text.js.map +1 -1
  34. package/esm/control/inject-touch.d.ts +15 -20
  35. package/esm/control/inject-touch.d.ts.map +1 -1
  36. package/esm/control/inject-touch.js +14 -41
  37. package/esm/control/inject-touch.js.map +1 -1
  38. package/esm/control/rotate-device.d.ts +2 -4
  39. package/esm/control/rotate-device.d.ts.map +1 -1
  40. package/esm/control/rotate-device.js +2 -3
  41. package/esm/control/rotate-device.js.map +1 -1
  42. package/esm/control/serializer.d.ts +13 -23
  43. package/esm/control/serializer.d.ts.map +1 -1
  44. package/esm/control/serializer.js +23 -52
  45. package/esm/control/serializer.js.map +1 -1
  46. package/esm/control/set-screen-power-mode.d.ts +1 -2
  47. package/esm/control/set-screen-power-mode.d.ts.map +1 -1
  48. package/esm/control/set-screen-power-mode.js +1 -2
  49. package/esm/control/set-screen-power-mode.js.map +1 -1
  50. package/esm/control/type.d.ts +14 -0
  51. package/esm/control/type.d.ts.map +1 -1
  52. package/esm/control/type.js +22 -0
  53. package/esm/control/type.js.map +1 -1
  54. package/esm/control/writer.d.ts +28 -0
  55. package/esm/control/writer.d.ts.map +1 -0
  56. package/esm/control/writer.js +53 -0
  57. package/esm/control/writer.js.map +1 -0
  58. package/esm/device-message/stream.d.ts.map +1 -1
  59. package/esm/device-message/stream.js +23 -8
  60. package/esm/device-message/stream.js.map +1 -1
  61. package/esm/index.d.ts +1 -2
  62. package/esm/index.d.ts.map +1 -1
  63. package/esm/index.js +1 -2
  64. package/esm/index.js.map +1 -1
  65. package/esm/options/1_16/codec-options.d.ts +2 -3
  66. package/esm/options/1_16/codec-options.d.ts.map +1 -1
  67. package/esm/options/1_16/codec-options.js.map +1 -1
  68. package/esm/options/1_16/index.d.ts +3 -1
  69. package/esm/options/1_16/index.d.ts.map +1 -1
  70. package/esm/options/1_16/index.js +3 -1
  71. package/esm/options/1_16/index.js.map +1 -1
  72. package/esm/options/1_16/options.d.ts +42 -96
  73. package/esm/options/1_16/options.d.ts.map +1 -1
  74. package/esm/options/1_16/options.js +106 -143
  75. package/esm/options/1_16/options.js.map +1 -1
  76. package/esm/options/1_16/scroll.d.ts +1 -2
  77. package/esm/options/1_16/scroll.d.ts.map +1 -1
  78. package/esm/options/1_16/scroll.js +1 -2
  79. package/esm/options/1_16/scroll.js.map +1 -1
  80. package/esm/options/1_17.d.ts +1 -0
  81. package/esm/options/1_17.d.ts.map +1 -1
  82. package/esm/options/1_17.js +7 -1
  83. package/esm/options/1_17.js.map +1 -1
  84. package/esm/options/1_18.d.ts +49 -11
  85. package/esm/options/1_18.d.ts.map +1 -1
  86. package/esm/options/1_18.js +65 -32
  87. package/esm/options/1_18.js.map +1 -1
  88. package/esm/options/1_21.d.ts +26 -7
  89. package/esm/options/1_21.d.ts.map +1 -1
  90. package/esm/options/1_21.js +35 -20
  91. package/esm/options/1_21.js.map +1 -1
  92. package/esm/options/1_22/index.d.ts +1 -0
  93. package/esm/options/1_22/index.d.ts.map +1 -1
  94. package/esm/options/1_22/index.js +1 -0
  95. package/esm/options/1_22/index.js.map +1 -1
  96. package/esm/options/1_22/options.d.ts +32 -26
  97. package/esm/options/1_22/options.d.ts.map +1 -1
  98. package/esm/options/1_22/options.js +27 -16
  99. package/esm/options/1_22/options.js.map +1 -1
  100. package/esm/options/1_22/scroll.d.ts +1 -1
  101. package/esm/options/1_22/scroll.js +1 -1
  102. package/esm/options/1_23.d.ts +32 -8
  103. package/esm/options/1_23.d.ts.map +1 -1
  104. package/esm/options/1_23.js +24 -14
  105. package/esm/options/1_23.js.map +1 -1
  106. package/esm/options/1_24.d.ts +29 -4
  107. package/esm/options/1_24.d.ts.map +1 -1
  108. package/esm/options/1_24.js +17 -7
  109. package/esm/options/1_24.js.map +1 -1
  110. package/esm/options/1_25/options.d.ts +6 -2
  111. package/esm/options/1_25/options.d.ts.map +1 -1
  112. package/esm/options/1_25/options.js +16 -2
  113. package/esm/options/1_25/options.js.map +1 -1
  114. package/esm/options/1_25/scroll.d.ts.map +1 -1
  115. package/esm/options/1_25/scroll.js +2 -1
  116. package/esm/options/1_25/scroll.js.map +1 -1
  117. package/esm/options/2_0.d.ts +12 -8
  118. package/esm/options/2_0.d.ts.map +1 -1
  119. package/esm/options/2_0.js +80 -11
  120. package/esm/options/2_0.js.map +1 -1
  121. package/esm/options/codec.d.ts +4 -4
  122. package/esm/options/codec.d.ts.map +1 -1
  123. package/esm/options/codec.js +3 -3
  124. package/esm/options/codec.js.map +1 -1
  125. package/esm/options/index.d.ts +4 -0
  126. package/esm/options/index.d.ts.map +1 -1
  127. package/esm/options/index.js +4 -0
  128. package/esm/options/index.js.map +1 -1
  129. package/esm/options/types.d.ts +73 -33
  130. package/esm/options/types.d.ts.map +1 -1
  131. package/esm/options/types.js +52 -0
  132. package/esm/options/types.js.map +1 -1
  133. package/package.json +7 -14
  134. package/src/codec/av1.ts +33 -0
  135. package/src/codec/h264.ts +317 -0
  136. package/src/codec/h265.ts +1375 -0
  137. package/src/codec/index.ts +4 -0
  138. package/src/codec/nalu.ts +373 -0
  139. package/src/control/back-or-screen-on.ts +1 -1
  140. package/{esm/control/simple.js → src/control/basic.ts} +3 -3
  141. package/src/control/index.ts +2 -0
  142. package/src/control/inject-keycode.ts +1 -3
  143. package/src/control/inject-text.ts +1 -3
  144. package/src/control/inject-touch.ts +16 -55
  145. package/src/control/rotate-device.ts +2 -7
  146. package/src/control/serializer.ts +42 -101
  147. package/src/control/set-screen-power-mode.ts +1 -3
  148. package/src/control/type.ts +32 -0
  149. package/src/control/writer.ts +87 -0
  150. package/src/device-message/stream.ts +32 -12
  151. package/src/index.ts +1 -2
  152. package/src/options/1_16/codec-options.ts +2 -3
  153. package/src/options/1_16/float-to-uint16.ts +33 -0
  154. package/src/options/1_16/index.ts +3 -1
  155. package/src/options/1_16/init.ts +80 -0
  156. package/src/options/1_16/message.ts +55 -0
  157. package/src/options/1_16/options.ts +146 -255
  158. package/src/options/1_16/scroll.ts +1 -2
  159. package/src/options/1_17.ts +66 -0
  160. package/src/options/1_18.ts +101 -37
  161. package/src/options/1_21.ts +47 -25
  162. package/src/options/1_22/index.ts +1 -0
  163. package/src/options/1_22/init.ts +19 -0
  164. package/src/options/1_22/options.ts +38 -45
  165. package/src/options/1_22/scroll.ts +1 -1
  166. package/src/options/1_23.ts +33 -21
  167. package/src/options/1_24.ts +23 -11
  168. package/src/options/1_25/options.ts +22 -4
  169. package/src/options/1_25/scroll.ts +2 -1
  170. package/src/options/2_0.ts +342 -0
  171. package/src/options/codec.ts +98 -0
  172. package/src/options/index.ts +4 -0
  173. package/src/options/latest.ts +14 -0
  174. package/src/options/types.ts +152 -42
  175. package/tsconfig.build.json +9 -1
  176. package/tsconfig.build.tsbuildinfo +1 -1
  177. package/esm/adb/client.d.ts +0 -41
  178. package/esm/adb/client.d.ts.map +0 -1
  179. package/esm/adb/client.js +0 -224
  180. package/esm/adb/client.js.map +0 -1
  181. package/esm/adb/connection.d.ts +0 -49
  182. package/esm/adb/connection.d.ts.map +0 -1
  183. package/esm/adb/connection.js +0 -122
  184. package/esm/adb/connection.js.map +0 -1
  185. package/esm/adb/index.d.ts +0 -4
  186. package/esm/adb/index.d.ts.map +0 -1
  187. package/esm/adb/index.js +0 -4
  188. package/esm/adb/index.js.map +0 -1
  189. package/esm/adb/options/1_16.d.ts +0 -8
  190. package/esm/adb/options/1_16.d.ts.map +0 -1
  191. package/esm/adb/options/1_16.js +0 -20
  192. package/esm/adb/options/1_16.js.map +0 -1
  193. package/esm/adb/options/1_22.d.ts +0 -8
  194. package/esm/adb/options/1_22.d.ts.map +0 -1
  195. package/esm/adb/options/1_22.js +0 -17
  196. package/esm/adb/options/1_22.js.map +0 -1
  197. package/esm/adb/options/1_26.d.ts +0 -9
  198. package/esm/adb/options/1_26.d.ts.map +0 -1
  199. package/esm/adb/options/1_26.js +0 -11
  200. package/esm/adb/options/1_26.js.map +0 -1
  201. package/esm/adb/options/2_0.d.ts +0 -8
  202. package/esm/adb/options/2_0.d.ts.map +0 -1
  203. package/esm/adb/options/2_0.js +0 -13
  204. package/esm/adb/options/2_0.js.map +0 -1
  205. package/esm/adb/options/index.d.ts +0 -4
  206. package/esm/adb/options/index.d.ts.map +0 -1
  207. package/esm/adb/options/index.js +0 -4
  208. package/esm/adb/options/index.js.map +0 -1
  209. package/esm/adb/options/types.d.ts +0 -24
  210. package/esm/adb/options/types.d.ts.map +0 -1
  211. package/esm/adb/options/types.js +0 -37
  212. package/esm/adb/options/types.js.map +0 -1
  213. package/esm/codec.d.ts +0 -34
  214. package/esm/codec.d.ts.map +0 -1
  215. package/esm/codec.js +0 -37
  216. package/esm/codec.js.map +0 -1
  217. package/esm/control/simple.d.ts +0 -5
  218. package/esm/control/simple.d.ts.map +0 -1
  219. package/esm/control/simple.js.map +0 -1
  220. package/esm/decoder.d.ts +0 -2
  221. package/esm/decoder.d.ts.map +0 -1
  222. package/esm/decoder.js +0 -2
  223. package/esm/decoder.js.map +0 -1
  224. package/esm/options/1.17.d.ts +0 -3
  225. package/esm/options/1.17.d.ts.map +0 -1
  226. package/esm/options/1.17.js +0 -2
  227. package/esm/options/1.17.js.map +0 -1
  228. package/esm/options/1_16/h264-configuration.d.ts +0 -49
  229. package/esm/options/1_16/h264-configuration.d.ts.map +0 -1
  230. package/esm/options/1_16/h264-configuration.js +0 -414
  231. package/esm/options/1_16/h264-configuration.js.map +0 -1
  232. package/esm/options/1_16/sps.d.ts +0 -22
  233. package/esm/options/1_16/sps.d.ts.map +0 -1
  234. package/esm/options/1_16/sps.js +0 -263
  235. package/esm/options/1_16/sps.js.map +0 -1
  236. package/esm/options/1_26.d.ts +0 -57
  237. package/esm/options/1_26.d.ts.map +0 -1
  238. package/esm/options/1_26.js +0 -67
  239. package/esm/options/1_26.js.map +0 -1
  240. package/esm/options/2.d.ts +0 -57
  241. package/esm/options/2.d.ts.map +0 -1
  242. package/esm/options/2.js +0 -67
  243. package/esm/options/2.js.map +0 -1
  244. package/src/adb/client.ts +0 -329
  245. package/src/adb/connection.ts +0 -209
  246. package/src/adb/index.ts +0 -3
  247. package/src/adb/options/1_16.ts +0 -32
  248. package/src/adb/options/1_22.ts +0 -26
  249. package/src/adb/options/index.ts +0 -3
  250. package/src/adb/options/types.ts +0 -75
  251. package/src/codec.ts +0 -35
  252. package/src/options/1_16/h264-configuration.ts +0 -485
package/CHANGELOG.json CHANGED
@@ -1,6 +1,21 @@
1
1
  {
2
2
  "name": "@yume-chan/scrcpy",
3
3
  "entries": [
4
+ {
5
+ "version": "0.0.20",
6
+ "tag": "@yume-chan/scrcpy_v0.0.20",
7
+ "date": "Mon, 05 Jun 2023 02:51:41 GMT",
8
+ "comments": {
9
+ "none": [
10
+ {
11
+ "comment": "Add support for Scrcpy 2.0. New features including audio forwarding (supports PCM, AAC and OPUS encoding) and other video codecs (supports H.264 and H.265, AV1 not supported). Read the PR for new options and breaking changes. ([#495](https://github.com/yume-chan/ya-webadb/pull/495))"
12
+ },
13
+ {
14
+ "comment": "Move ADB related code to `@yume-chan/adb-scrcpy` package. This package now only implements the Scrcpy protocol."
15
+ }
16
+ ]
17
+ }
18
+ },
4
19
  {
5
20
  "version": "0.0.19",
6
21
  "tag": "@yume-chan/scrcpy_v0.0.19",
package/CHANGELOG.md CHANGED
@@ -1,6 +1,14 @@
1
1
  # Change Log - @yume-chan/scrcpy
2
2
 
3
- This log was last generated on Sun, 09 Apr 2023 05:55:33 GMT and should not be manually modified.
3
+ This log was last generated on Mon, 05 Jun 2023 02:51:41 GMT and should not be manually modified.
4
+
5
+ ## 0.0.20
6
+ Mon, 05 Jun 2023 02:51:41 GMT
7
+
8
+ ### Updates
9
+
10
+ - Add support for Scrcpy 2.0. New features including audio forwarding (supports PCM, AAC and OPUS encoding) and other video codecs (supports H.264 and H.265, AV1 not supported). Read the PR for new options and breaking changes. ([#495](https://github.com/yume-chan/ya-webadb/pull/495))
11
+ - Move ADB related code to `@yume-chan/adb-scrcpy` package. This package now only implements the Scrcpy protocol.
4
12
 
5
13
  ## 0.0.19
6
14
  Sun, 09 Apr 2023 05:55:33 GMT
package/README.md CHANGED
@@ -1,79 +1,94 @@
1
1
  # @yume-chan/scrcpy
2
2
 
3
- TypeScript implementation of [Scrcpy](https://github.com/Genymobile/scrcpy) client.
3
+ TypeScript library to communicate with [Scrcpy](https://github.com/Genymobile/scrcpy) server.
4
4
 
5
5
  It's compatible with the official Scrcpy server binaries.
6
6
 
7
- **WARNING:** The public API is UNSTABLE. If you have any questions, please open an issue.
7
+ **WARNING:** The public API is UNSTABLE. Open a GitHub discussion if you have any questions.
8
8
 
9
- - [Basic information](#basic-information)
10
- - [Prepare server binary](#prepare-server-binary)
11
- - [`fetch-scrcpy-server`](#fetch-scrcpy-server)
12
- - [Use the server binary](#use-the-server-binary)
13
- - [Node.js CommonJS](#nodejs-commonjs)
14
- - [Node.js ES module](#nodejs-es-module)
15
- - [Webpack 4](#webpack-4)
16
- - [Webpack 5](#webpack-5)
17
- - [Read the server version](#read-the-server-version)
18
- - [Server versions](#server-versions)
19
- - [Use with `@yume-chan/adb`](#use-with-yume-chanadb)
20
- - [Push server binary](#push-server-binary)
21
- - [Start server on device](#start-server-on-device)
22
- - [Using other transportation](#using-other-transportation)
23
- - [Parsing video packets](#parsing-video-packets)
24
- - [Sending control messages](#sending-control-messages)
25
- - [Reading device messages](#reading-device-messages)
26
- - [Always read the streams](#always-read-the-streams)
27
- - [Video stream](#video-stream)
28
- - [Decode video stream](#decode-video-stream)
9
+ - [How does Scrcpy work](#how-does-scrcpy-work)
10
+ - [What does this package do](#what-does-this-package-do)
11
+ - [Prepare server binary](#prepare-server-binary)
12
+ - [`fetch-scrcpy-server`](#fetch-scrcpy-server)
13
+ - [Use the server binary](#use-the-server-binary)
14
+ - [Node.js CommonJS](#nodejs-commonjs)
15
+ - [Node.js ES module](#nodejs-es-module)
16
+ - [Webpack 4](#webpack-4)
17
+ - [Webpack 5](#webpack-5)
18
+ - [Server versions](#server-versions)
19
+ - [Reading and writing packets](#reading-and-writing-packets)
20
+ - [Reading video/audio packets](#reading-videoaudio-packets)
21
+ - [Sending control messages](#sending-control-messages)
22
+ - [Reading device messages](#reading-device-messages)
23
+ - [Always read all streams](#always-read-all-streams)
24
+ - [Video/audio stream](#videoaudio-stream)
25
+ - [Decode video stream](#decode-video-stream)
29
26
 
30
- ## Basic information
27
+ ## How does Scrcpy work
31
28
 
32
- Although Scrcpy doesn't install any App on the device, it does have a server binary executable to be run on the device.
29
+ Scrcpy has two parts: a client and a server.
33
30
 
34
- With the official Scrcpy client and server, the client uses ADB to transfer the server binary file to the device, run it, and communicate with it via ADB tunnel (the bootstrap process).
31
+ The server is a Java application (but not an Android app) that runs on the device to capture the video and audio, and send them to the client.
35
32
 
36
- This package provides types that can serialize and deserialize Scrcpy protocol messages, but it generally requires you to do the bootstrapping and provide the data stream to the server.
33
+ The client receives captured video and audio data, and renders them on computer.
37
34
 
38
- If you are also using `@yume-chan/adb`, this package has a helper class that can complete the bootstrap process using it, doing what the official client does.
35
+ The official Scrcpy client also spawns Google ADB executable to set up the reverse tunnel, push the server binary to the device, and start the server.
39
36
 
40
- **NOTE:** `@yume-chan/adb` is a peer dependency, you need to install it yourself. Only those types whose names begin with `Adb` requires `@yume-chan/adb`.
37
+ ## What does this package do
38
+
39
+ This package can't push nor start the server, nor render the video and audio. It only provides APIs to communicate with the server.
40
+
41
+ `@yume-chan/adb-scrcpy` package is a wrapper of this package, provides integration with `@yume-chan/adb` package, and can push, start, and stop the server.
41
42
 
42
43
  ## Prepare server binary
43
44
 
44
- This package doesn't include the server binary. It's compatible with many versions of the official server binary, but may not work with future versions due to protocol changes.
45
+ This package is compatible with many versions of the official server binary, but it doesn't include the server binary itself.
45
46
 
46
- You can download the server binary from official releases (https://github.com/Genymobile/scrcpy/releases), or use the built-in `fetch-scrcpy-server` script to automate the process.
47
+ You can download the server binary from official releases (https://github.com/Genymobile/scrcpy/releases), or use the included `fetch-scrcpy-server` script to automate the process.
47
48
 
48
49
  The server binary is subject to [Apache License 2.0](https://github.com/Genymobile/scrcpy/blob/master/LICENSE).
49
50
 
50
51
  ### `fetch-scrcpy-server`
51
52
 
52
- This package includes a script that downloads the server binary from official releases for you.
53
+ This script downloads the server binary from official releases for you.
53
54
 
54
- The `gh-release-fetch@3` package is a peer dependency for this script, thus requires separated installation.
55
+ Before using this script, install `gh-release-fetch@3` package separately:
56
+
57
+ ```sh
58
+ npm install --save-dev gh-release-fetch@3
59
+ ```
55
60
 
56
61
  Usage:
57
62
 
58
63
  ```
59
- $ npx fetch-scrcpy-server <version>
64
+ npx fetch-scrcpy-server <version>
60
65
  ```
61
66
 
62
67
  For example:
63
68
 
64
69
  ```
65
- $ npx fetch-scrcpy-server 1.25
70
+ npx fetch-scrcpy-server 1.25
66
71
  ```
67
72
 
68
- It can also be added to the `postinstall` script in `package.json`, so running `npm install` will automatically invoke the script:
73
+ Add it to `scripts.postinstall` in your `package.json`, so running `npm install` automatically invokes the script:
69
74
 
70
75
  ```json
71
- "scripts": {
72
- "postinstall": "fetch-scrcpy-server 1.25",
73
- },
76
+ {
77
+ "scripts": {
78
+ "postinstall": "fetch-scrcpy-server 1.25"
79
+ }
80
+ }
74
81
  ```
75
82
 
76
- The server binary will be named `bin/scrcpy-server` in this package's installation directory (usually in `node_modules`).
83
+ The server binary will be saved to `bin/scrcpy-server` in this package's installation directory (usually in `node_modules`).
84
+
85
+ It will also save the version number to `bin/version.js`.
86
+
87
+ ```js
88
+ import SCRCPY_SERVER_VERSION from "@yume-chan/scrcpy/bin/version.js";
89
+
90
+ console.log(SCRCPY_SERVER_VERSION); // "1.25"
91
+ ```
77
92
 
78
93
  ### Use the server binary
79
94
 
@@ -91,6 +106,8 @@ const buffer: Buffer = fs.readFileSync(path);
91
106
 
92
107
  #### Node.js ES module
93
108
 
109
+ Without the `import.meta.resolve` feature:
110
+
94
111
  ```ts
95
112
  import fs from "node:fs/promises";
96
113
  import { createRequire } from "node:module";
@@ -101,9 +118,7 @@ const path: string = createRequire(import.meta.url).resolve(
101
118
  const buffer: Buffer = await fs.readFile(path);
102
119
  ```
103
120
 
104
- Currently, ES Module doesn't have a `resolve` function like `require.resolve` in CommonJS, so `createRequire` is used to create a CommonJS resolver.
105
-
106
- Or with the `--experimental-import-meta-resolve` command line flag, you can use `import.meta.resolve`:
121
+ With `import.meta.resolve` feature (requires `--experimental-import-meta-resolve` command line flag for Node.js 12.6.0+):
107
122
 
108
123
  ```ts
109
124
  import fs from "node:fs/promises";
@@ -139,143 +154,55 @@ const buffer: ArrayBuffer = await fetch(SCRCPY_SERVER_URL).then((response) =>
139
154
  );
140
155
  ```
141
156
 
142
- ### Read the server version
143
-
144
- The correct version number is required to launch the server, so `fetch-scrcpy-server` also writes the version number to `bin/version.js`.
145
-
146
- ```js
147
- import SCRCPY_SERVER_VERSION from "@yume-chan/scrcpy/bin/version.js";
148
-
149
- console.log(SCRCPY_SERVER_VERSION); // "1.25"
150
- ```
151
-
152
157
  ## Server versions
153
158
 
154
- Scrcpy protocol change over time, and are usually not backwards compatible. This package supports multiple server versions (or ranges), and uses different option types to choose different behaviors. Using incorrect option version usually results in errors.
159
+ Scrcpy protocol changes over time, and are usually not backwards compatible. This package supports multiple server versions (ranges), and uses different option types to choose different behaviors. Using incorrect option version usually results in errors.
155
160
 
156
161
  The latest one may continue to work for future server versions, but there is no guarantee.
157
162
 
158
163
  | Version | Type |
159
164
  | --------- | ------------------- |
160
- | 1.16~1.17 | `ScrcpyOptions1_16` |
165
+ | 1.16 | `ScrcpyOptions1_16` |
166
+ | 1.17 | `ScrcpyOptions1_17` |
161
167
  | 1.18~1.20 | `ScrcpyOptions1_18` |
162
168
  | 1.21 | `ScrcpyOptions1_21` |
163
169
  | 1.22 | `ScrcpyOptions1_22` |
164
170
  | 1.23 | `ScrcpyOptions1_23` |
165
171
  | 1.24 | `ScrcpyOptions1_24` |
166
172
  | 1.25 | `ScrcpyOptions1_25` |
173
+ | 2.0 | `ScrcpyOptions2_0` |
167
174
 
168
- When using `AdbScrcpyClient`, there are `AdbScrcpyOptions` containing `@yume-chan/adb` specific options:
169
-
170
- | Version | Type |
171
- | --------- | ---------------------- |
172
- | 1.16~1.21 | `AdbScrcpyOptions1_16` |
173
- | 1.22~1.25 | `AdbScrcpyOptions1_22` |
174
-
175
- ## Use with `@yume-chan/adb`
175
+ ## Reading and writing packets
176
176
 
177
- `@yume-chan/adb` is a TypeScript ADB implementation that can run on Web browser. It can be used to bootstrap the server on a device.
177
+ This packets operates on Web Streams API streams.
178
178
 
179
- ### Push server binary
179
+ **NOTE:** Web Streams API streams usually can't pipe between different implementations. This package by default uses the native implementation on `globalThis`, and `web-streams-polyfill` otherwise. If you are using another implementation, or simply not sure, wrap your streams using the `WrapReadableStream` and `WrapWritableStream` types from `@yume-chan/stream-extra` package.
180
180
 
181
- The `AdbSync#write()` method can be used to push files to the device. Read more at `@yume-chan/adb`'s documentation (https://github.com/yume-chan/ya-webadb/tree/main/libraries/adb#readme).
181
+ ### Reading video/audio packets
182
182
 
183
- This package also provides the `AdbScrcpyClient.pushServer()` static method as a shortcut, plus it will automatically close the `AdbSync` object on completion.
184
-
185
- Example using a `ReadableStream`:
186
-
187
- ```ts
188
- import { WrapReadableStream } from "@yume-chan/adb";
189
- import { AdbScrcpyClient } from "@yume-chan/scrcpy";
190
-
191
- await AdbScrcpyClient.pushServer(
192
- adb,
193
- await fetch(SCRCPY_SERVER_URL).then(
194
- // `WrapReadableStream` is required because native `ReadableStream` (from `fetch`)
195
- // doesn't support `pipeTo()` non-native `WritableStream`s
196
- // (`@yume-chan/adb` is using `web-streams-polyfill`)
197
- (response) => new WrapReadableStream(response.body)
198
- )
199
- );
200
- ```
201
-
202
- Example using an `ArrayBuffer`:
183
+ Requires a `ReadableStream<Uint8Array>` that reads from the video socket.
203
184
 
204
185
  ```ts
205
- import { AdbScrcpyClient } from "@yume-chan/scrcpy";
206
-
207
- await AdbScrcpyClient.pushServer(
208
- adb,
209
- new ReadableStream({
210
- start(controller) {
211
- controller.enqueue(new Uint8Array(buffer));
212
- controller.end();
213
- },
214
- })
215
- );
216
- ```
217
-
218
- ### Start server on device
219
-
220
- To start the server, use the `AdbScrcpyClient.start()` method. It automatically sets up port forwarding, launches the server, and connects to it.
221
-
222
- ```js
223
- import {
224
- AdbScrcpyClient,
225
- AdbScrcpyOptions1_22,
226
- DEFAULT_SERVER_PATH,
227
- ScrcpyOptions1_24,
228
- } from "@yume-chan/scrcpy";
229
- import SCRCPY_SERVER_VERSION from "@yume-chan/scrcpy/bin/version.js";
230
-
231
- const client: AdbScrcpyClient = await AdbScrcpyClient.start(
232
- adb,
233
- DEFAULT_SERVER_PATH,
234
- // If server binary was downloaded manually, must provide the correct version
235
- SCRCPY_SERVER_VERSION,
236
- new AdbScrcpyOptions1_22(
237
- ScrcpyOptions1_24({
238
- // options
239
- })
240
- )
241
- );
242
-
243
- const stdout: ReadableStream<string> = client.stdout;
244
- const videoPacketStream: ReadableStream<ScrcpyVideoStreamPacket> =
245
- client.videoStream;
246
- const controlMessageSerializer: ScrcpyControlMessageSerializer | undefined =
247
- client.controlMessageSerializer;
248
- const deviceMessageStream: ReadableStream<ScrcpyDeviceMessage> | undefined =
249
- client.deviceMessageStream;
250
-
251
- // to stop the server
252
- client.close();
253
- ```
186
+ import { ScrcpyOptions1_25, ScrcpyVideoStreamPacket } from "@yume-chan/scrcpy";
254
187
 
255
- ## Using other transportation
256
-
257
- If you push, start and connect to the server yourself, you can still use this package to serialize/deserialize packets.
258
-
259
- ### Parsing video packets
260
-
261
- Requires a `ReadableStream<Uint8Array>` that reads from the video socket, preserving packet boundaries.
262
-
263
- **NOTE:** Because this package uses `web-streams-polyfill` NPM package's Web Streams API implementation, the provided `ReadableStream` must also be from `web-streams-polyfill` (or another polyfill that doesn't check object prototype when piping).
264
-
265
- ```ts
266
- import { ScrcpyOptions1_24, ScrcpyVideoStreamPacket } from "@yume-chan/scrcpy";
188
+ const options = new ScrcpyOptions1_25({
189
+ // use the same version and options when starting the server
190
+ });
267
191
 
268
192
  const videoStream: ReadableStream<Uint8Array>; // get the stream yourself
269
193
 
270
- const options = new ScrcpyOptions1_24({
271
- // use the same version and options
272
- });
194
+ // Parse video socket metadata
195
+ // Use `videoStream2` instead of `videoStream` from now on
196
+ const { metadata, stream: videoStream2 } =
197
+ await options.parseVideoStreamMetadata(videoStream);
273
198
 
274
- const videoPacketStream: ReadableStream<ScrcpyVideoStreamPacket> =
275
- videoStream.pipeThrough(options.createVideoStreamTransformer());
199
+ const videoPacketStream: ReadableStream<ScrcpyMediaStreamPacket> =
200
+ videoStream2.pipeThrough(options.createMediaStreamTransformer());
276
201
  // Read from `videoPacketStream`
277
202
  ```
278
203
 
204
+ Read audio stream is similar, but uses `parseVideoStreamMetadata` instead.
205
+
279
206
  ### Sending control messages
280
207
 
281
208
  Requires a `WritableStream<Uint8Array>` that writes to the control socket.
@@ -284,37 +211,36 @@ Control socket is optional if control is not enabled. Video socket and control s
284
211
 
285
212
  ```ts
286
213
  import {
287
- ScrcpyControlMessageSerializer,
288
- ScrcpyOptions1_24,
214
+ ScrcpyControlMessageWriter,
215
+ ScrcpyOptions1_25,
289
216
  } from "@yume-chan/scrcpy";
290
217
 
291
- const controlStream: ReadableWritablePair<Uint8Array, Uint8Array> | undefined; // get the stream yourself
292
-
293
- const options = new ScrcpyOptions1_24({
294
- // use the same version and options
218
+ const options = new ScrcpyOptions1_25({
219
+ // use the same version and options when starting the server
295
220
  });
296
221
 
297
- const controlMessageSerializer = new ScrcpyControlMessageSerializer(
298
- controlStream.writable,
222
+ const controlStream: ReadableWritablePair<Uint8Array, Uint8Array>; // get the stream yourself
223
+
224
+ const controlMessageWriter = new ScrcpyControlMessageWriter(
225
+ controlStream.writable.getWriter(),
299
226
  options
300
227
  );
301
- // Call methods on `controlMessageSerializer`
302
- controlMessageSerializer.injectText("Hello World!");
228
+
229
+ // Call methods on `controlMessageWriter`
230
+ controlMessageWriter.injectText("Hello World!");
303
231
  ```
304
232
 
305
233
  ### Reading device messages
306
234
 
307
235
  Requires a `ReadableStream<Uint8Array>` that reads from the control socket.
308
236
 
309
- **NOTE:** Because this package uses `web-streams-polyfill` NPM package's Web Streams API implementation, the provided `ReadableStream` must also be from `web-streams-polyfill` (or another polyfill that doesn't check object prototype when piping).
310
-
311
237
  ```ts
312
238
  import {
313
239
  ScrcpyDeviceMessageDeserializeStream,
314
240
  ScrcpyOptions1_24,
315
241
  } from "@yume-chan/scrcpy";
316
242
 
317
- const controlStream: ReadableWritablePair<Uint8Array, Uint8Array> | undefined; // get the stream yourself
243
+ const controlStream: ReadableWritablePair<Uint8Array, Uint8Array>; // get the stream yourself
318
244
 
319
245
  const deviceMessageStream: ReadableStream<ScrcpyDeviceMessage> =
320
246
  controlStream.readable.pipeThrough(
@@ -322,11 +248,9 @@ const deviceMessageStream: ReadableStream<ScrcpyDeviceMessage> =
322
248
  );
323
249
  ```
324
250
 
325
- ## Always read the streams
251
+ ## Always read all streams
326
252
 
327
- In Web Streams API, `ReadableStream` will block its upstream when too many chunks are kept not read. If multiple streams are from the same upstream source, block one stream means blocking all of them.
328
-
329
- For Scrcpy, usually all streams are originated from the same ADB connection (either USB or TCP), so it's important to always read from all streams, even if you don't care about their data.
253
+ In Web Streams API, pipes will block its upstream when downstream's queue is full (back-pressure mechanism). If multiple streams are separated from the same source (for example, all Scrcpy streams are from the same USB or TCP connection), blocking one stream means blocking all of them, so it's important to always read from all streams, even if you don't care about their data.
330
254
 
331
255
  ```ts
332
256
  // when using `AdbScrcpyClient`
@@ -364,31 +288,31 @@ deviceMessageStream
364
288
  .catch(() => {});
365
289
  ```
366
290
 
367
- ## Video stream
291
+ ## Video/audio stream
368
292
 
369
- The data from `videoPacketStream` has two types: `configuration` and `frame`. Some fields may not be populated depending on the server version and options.
293
+ The data from `createMediaStreamTransformer()` has two types: `configuration` and `data`.
370
294
 
371
295
  ```ts
372
- export interface ScrcpyVideoStreamConfigurationPacket {
296
+ export interface ScrcpyMediaStreamConfigurationPacket {
373
297
  type: "configuration";
374
- data: H264Configuration;
298
+ data: Uint8Array;
375
299
  }
376
300
 
377
- export interface ScrcpyVideoStreamFramePacket {
378
- type: "frame";
379
- keyframe?: boolean | undefined;
380
- pts?: bigint | undefined;
301
+ export interface ScrcpyMediaStreamDataPacket {
302
+ type: "data";
303
+ keyframe?: boolean;
304
+ pts?: bigint;
381
305
  data: Uint8Array;
382
306
  }
383
307
  ```
384
308
 
385
- When `sendFrameMeta: false` is set, `videoPacketStream` only contains `frame` packets, and only the `data` field in it is available. It's commonly used when feeding into decoders like FFmpeg that can parse the H.264 stream itself, or saving to disk directly.
309
+ When `sendFrameMeta: false` is set, there will be no `configuration` packets, and no `keyframe` and `pts` fields in `data` packets. It's commonly used with decoders that can parse the media stream itself like FFmpeg, or saved unprocessed.
386
310
 
387
- Otherwise, both `configuration` and `frame` packets are available.
311
+ Otherwise, both `configuration` and `data` packets are available.
388
312
 
389
- - `configuration` packets contain the parsed SPS data, and can be used to initialize a video decoder.
390
- - `pts` (and `keyframe` field from server version 1.23) fields in `frame` packets are available to help decode the video.
313
+ - `configuration` packet will be the first packet, and contains codec information. It will occasionally be sent again if the stream configuration changes.
314
+ - `pts` (and `keyframe` field from server version 1.23) fields in `data` packets are available to help decode the stream.
391
315
 
392
316
  ## Decode video stream
393
317
 
394
- `@yume-chan/scrcpy-decoder-tinyh264` and `@yume-chan/scrcpy-decoder-webcodecs` can be used to decode and render the video stream in Browser environments. Refer to their README files for compatibility and usage information.
318
+ `@yume-chan/scrcpy-decoder-tinyh264` and `@yume-chan/scrcpy-decoder-webcodecs` can be used to decode and render the video stream in browsers. Refer to their README files for compatibility and usage information.
@@ -31,27 +31,7 @@ export declare enum AndroidAvcLevel {
31
31
  Level61 = 262144,
32
32
  Level62 = 524288
33
33
  }
34
- /**
35
- * Split NAL units from a H.264/H.265 Annex B stream.
36
- *
37
- * The input is not modified.
38
- * The returned NAL units are views of the input (no memory allocation nor copy),
39
- * and still contains emulation prevention bytes.
40
- *
41
- * This methods returns a generator, so it can be stopped immediately
42
- * after the interested NAL unit is found.
43
- */
44
- export declare function naluSplit(buffer: Uint8Array): Generator<Uint8Array>;
45
- /**
46
- * Remove emulation prevention bytes from a H.264/H.265 NAL Unit.
47
- *
48
- * The input is not modified.
49
- * If the input doesn't contain any emulation prevention bytes,
50
- * the input is returned as-is.
51
- * Otherwise, a new `Uint8Array` is created and returned.
52
- */
53
- export declare function naluRemoveEmulation(buffer: Uint8Array): Uint8Array;
54
- export declare function h264ParseSequenceParameterSet(buffer: Uint8Array): {
34
+ export declare function h264ParseSequenceParameterSet(nalu: Uint8Array): {
55
35
  profile_idc: number;
56
36
  constraint_set: number;
57
37
  constraint_set0_flag: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"h264.d.ts","sourceRoot":"","sources":["../../src/codec/h264.ts"],"names":[],"mappings":"AAKA,oBAAY,iBAAiB;IACzB,QAAQ,IAAS;IACjB,IAAI,IAAS;IACb,QAAQ,IAAS;IACjB,IAAI,IAAS;IACb,MAAM,KAAS;IACf,OAAO,KAAS;IAChB,OAAO,KAAS;IAChB,mBAAmB,QAAU;IAC7B,eAAe,SAAU;CAC5B;AAED,oBAAY,eAAe;IACvB,MAAM,IAAS;IACf,OAAO,IAAS;IAChB,OAAO,IAAS;IAChB,OAAO,IAAS;IAChB,OAAO,KAAS;IAChB,MAAM,KAAS;IACf,OAAO,KAAS;IAChB,OAAO,MAAS;IAChB,MAAM,MAAS;IACf,OAAO,MAAS;IAChB,OAAO,OAAU;IACjB,MAAM,OAAU;IAChB,OAAO,OAAU;IACjB,OAAO,OAAU;IACjB,MAAM,QAAU;IAChB,OAAO,QAAU;IACjB,OAAO,QAAU;IACjB,MAAM,SAAU;IAChB,OAAO,SAAU;IACjB,OAAO,SAAU;CACpB;AAmDD;;;;;;;;;GASG;AACH,wBAAiB,SAAS,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,CAiFpE;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,UAAU,cA0HrD;AAID,wBAAgB,6BAA6B,CAAC,MAAM,EAAE,UAAU;;;;;;;;;;;;;;;;;;;EAsK/D;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,UAAU;;;EAgCzD;AAED,MAAM,WAAW,iBAAiB;IAC9B,mBAAmB,EAAE,UAAU,CAAC;IAChC,oBAAoB,EAAE,UAAU,CAAC;IAEjC,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IAEtB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACzB;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,UAAU,GAAG,iBAAiB,CA6C1E"}
1
+ {"version":3,"file":"h264.d.ts","sourceRoot":"","sources":["../../src/codec/h264.ts"],"names":[],"mappings":"AAOA,oBAAY,iBAAiB;IACzB,QAAQ,IAAS;IACjB,IAAI,IAAS;IACb,QAAQ,IAAS;IACjB,IAAI,IAAS;IACb,MAAM,KAAS;IACf,OAAO,KAAS;IAChB,OAAO,KAAS;IAChB,mBAAmB,QAAU;IAC7B,eAAe,SAAU;CAC5B;AAED,oBAAY,eAAe;IACvB,MAAM,IAAS;IACf,OAAO,IAAS;IAChB,OAAO,IAAS;IAChB,OAAO,IAAS;IAChB,OAAO,KAAS;IAChB,MAAM,KAAS;IACf,OAAO,KAAS;IAChB,OAAO,MAAS;IAChB,MAAM,MAAS;IACf,OAAO,MAAS;IAChB,OAAO,OAAU;IACjB,MAAM,OAAU;IAChB,OAAO,OAAU;IACjB,OAAO,OAAU;IACjB,MAAM,QAAU;IAChB,OAAO,QAAU;IACjB,OAAO,QAAU;IACjB,MAAM,SAAU;IAChB,OAAO,SAAU;IACjB,OAAO,SAAU;CACpB;AAWD,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,UAAU;;;;;;;;;;;;;;;;;;;EAmK7D;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,UAAU;;;EAgCzD;AAED,MAAM,WAAW,iBAAiB;IAC9B,mBAAmB,EAAE,UAAU,CAAC;IAChC,oBAAoB,EAAE,UAAU,CAAC;IAEjC,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IAEnB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IAEtB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACzB;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,UAAU,GAAG,iBAAiB,CA2C1E"}