-
-
Notifications
You must be signed in to change notification settings - Fork 301
/
client.ts
393 lines (347 loc) · 11.8 KB
/
client.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
import type { Adb, AdbSubprocessProtocol } from "@yume-chan/adb";
import {
AdbReverseNotSupportedError,
AdbSubprocessNoneProtocol,
} from "@yume-chan/adb";
import type {
Consumable,
ReadableStream,
ReadableWritablePair,
} from "@yume-chan/stream-extra";
import {
AbortController,
DecodeUtf8Stream,
InspectStream,
PushReadableStream,
SplitStringStream,
WritableStream,
} from "@yume-chan/stream-extra";
import { h264ParseConfiguration } from "../codec/index.js";
import { ScrcpyControlMessageSerializer } from "../control/index.js";
import type { ScrcpyDeviceMessage } from "../device-message/index.js";
import { ScrcpyDeviceMessageDeserializeStream } from "../device-message/index.js";
import type {
ScrcpyAudioStreamMetadata,
ScrcpyEncoder,
ScrcpyMediaStreamPacket,
ScrcpyVideoStreamMetadata,
} from "../options/index.js";
import { DEFAULT_SERVER_PATH, ScrcpyVideoCodecId } from "../options/index.js";
import type { AdbScrcpyConnection } from "./connection.js";
import type { AdbScrcpyOptions } from "./options/index.js";
const NOOP = () => {
// no-op
};
function arrayToStream<T>(array: T[]): ReadableStream<T> {
return new PushReadableStream(async (controller) => {
for (const item of array) {
await controller.enqueue(item);
}
});
}
function concatStreams<T>(...streams: ReadableStream<T>[]): ReadableStream<T> {
return new PushReadableStream(async (controller) => {
for (const stream of streams) {
await stream.pipeTo(
new WritableStream({
async write(chunk) {
await controller.enqueue(chunk);
},
})
);
}
});
}
export class AdbScrcpyExitedError extends Error {
public output: string[];
public constructor(output: string[]) {
super("scrcpy server exited prematurely");
this.output = output;
}
}
interface AdbScrcpyClientInit {
options: AdbScrcpyOptions<object>;
process: AdbSubprocessProtocol;
stdout: ReadableStream<string>;
videoStream: ReadableStream<Uint8Array>;
audioStream: ReadableStream<Uint8Array> | undefined;
controlStream:
| ReadableWritablePair<Uint8Array, Consumable<Uint8Array>>
| undefined;
}
export interface AdbScrcpyVideoStream {
stream: ReadableStream<ScrcpyMediaStreamPacket>;
metadata: ScrcpyVideoStreamMetadata;
}
export interface AdbScrcpyAudioStream {
stream: ReadableStream<ScrcpyMediaStreamPacket>;
metadata: ScrcpyAudioStreamMetadata;
}
export class AdbScrcpyClient {
public static async pushServer(
adb: Adb,
file: ReadableStream<Consumable<Uint8Array>>,
filename = DEFAULT_SERVER_PATH
) {
const sync = await adb.sync();
try {
await sync.write({
filename,
file,
});
} finally {
await sync.dispose();
}
}
public static async start(
adb: Adb,
path: string,
version: string,
options: AdbScrcpyOptions<object>
) {
let connection: AdbScrcpyConnection | undefined;
let process: AdbSubprocessProtocol | undefined;
try {
try {
connection = options.createConnection(adb);
await connection.initialize();
} catch (e) {
if (e instanceof AdbReverseNotSupportedError) {
// When reverse tunnel is not supported, try forward tunnel.
options.tunnelForwardOverride = true;
connection = options.createConnection(adb);
await connection.initialize();
} else {
connection = undefined;
throw e;
}
}
process = await adb.subprocess.spawn(
[
// cspell: disable-next-line
`CLASSPATH=${path}`,
"app_process",
/* unused */ "/",
"com.genymobile.scrcpy.Server",
version,
...options.serialize(),
],
{
// Scrcpy server doesn't use stderr,
// so disable Shell Protocol to simplify processing
protocols: [AdbSubprocessNoneProtocol],
}
);
const stdout = process.stdout
.pipeThrough(new DecodeUtf8Stream())
.pipeThrough(new SplitStringStream("\n"));
// Read stdout, otherwise `process.exit` won't resolve.
const output: string[] = [];
const abortController = new AbortController();
const pipe = stdout
.pipeTo(
new WritableStream({
write(chunk) {
output.push(chunk);
},
}),
{
signal: abortController.signal,
preventCancel: true,
}
)
.catch(NOOP);
const streams = await Promise.race([
process.exit.then(() => {
throw new AdbScrcpyExitedError(output);
}),
connection.getStreams(),
]);
abortController.abort();
await pipe;
return new AdbScrcpyClient({
options,
process,
stdout: concatStreams(arrayToStream(output), stdout),
videoStream: streams.video,
audioStream: streams.audio,
controlStream: streams.control,
});
} catch (e) {
await process?.kill();
throw e;
} finally {
connection?.dispose();
}
}
/**
* This method will modify the given `options`,
* so don't reuse it elsewhere.
*/
public static async getEncoders(
adb: Adb,
path: string,
version: string,
options: AdbScrcpyOptions<object>
): Promise<ScrcpyEncoder[]> {
Object.assign(options.value, {
// Provide an invalid encoder name
// So the server will return all available encoders
encoderName: "_",
// Disable control for faster connection in 1.22+
control: false,
sendDeviceMeta: false,
sendDummyByte: false,
});
// Scrcpy server will open connections, before initializing encoder
// Thus although an invalid encoder name is given, the start process will success
const client = await AdbScrcpyClient.start(adb, path, version, options);
const encoders: ScrcpyEncoder[] = [];
await client.stdout.pipeTo(
new WritableStream({
write(line) {
const encoder = options.parseEncoder(line);
if (encoder) {
encoders.push(encoder);
}
},
})
);
return encoders;
}
/**
* This method will modify the given `options`,
* so don't reuse it elsewhere.
*/
public static async getDisplays(
adb: Adb,
path: string,
version: string,
options: AdbScrcpyOptions<object>
): Promise<number[]> {
Object.assign(options.value, {
// Similar to `getEncoders`, pass an invalid option and parse the output
displayId: -1,
// Disable control for faster connection in 1.22+
control: false,
sendDeviceMeta: false,
sendDummyByte: false,
});
try {
// Server will exit before opening connections when an invalid display id was given.
await AdbScrcpyClient.start(adb, path, version, options);
} catch (e) {
if (e instanceof AdbScrcpyExitedError) {
const displayIdRegex = /\s+scrcpy --display (\d+)/;
const displays: number[] = [];
for (const line of e.output) {
const match = line.match(displayIdRegex);
if (match) {
displays.push(Number.parseInt(match[1]!, 10));
}
}
return displays;
}
}
throw new Error("failed to get displays");
}
private _options: AdbScrcpyOptions<object>;
private _process: AdbSubprocessProtocol;
private _stdout: ReadableStream<string>;
public get stdout() {
return this._stdout;
}
public get exit() {
return this._process.exit;
}
private _screenWidth: number | undefined;
public get screenWidth() {
return this._screenWidth;
}
private _screenHeight: number | undefined;
public get screenHeight() {
return this._screenHeight;
}
private _videoStream: Promise<AdbScrcpyVideoStream>;
public get videoStream() {
return this._videoStream;
}
private _audioStream: Promise<AdbScrcpyAudioStream> | undefined;
public get audioStream() {
return this._audioStream;
}
private _controlMessageSerializer:
| ScrcpyControlMessageSerializer
| undefined;
public get controlMessageSerializer() {
return this._controlMessageSerializer;
}
private _deviceMessageStream:
| ReadableStream<ScrcpyDeviceMessage>
| undefined;
public get deviceMessageStream() {
return this._deviceMessageStream;
}
public constructor({
options,
process,
stdout,
videoStream,
audioStream,
controlStream,
}: AdbScrcpyClientInit) {
this._options = options;
this._process = process;
this._stdout = stdout;
this._videoStream = this.createVideoStream(videoStream);
this._audioStream = audioStream
? this.createAudioStream(audioStream)
: undefined;
if (controlStream) {
this._controlMessageSerializer = new ScrcpyControlMessageSerializer(
controlStream.writable,
options
);
this._deviceMessageStream = controlStream.readable.pipeThrough(
new ScrcpyDeviceMessageDeserializeStream()
);
}
}
private async createVideoStream(initialStream: ReadableStream<Uint8Array>) {
const { stream, metadata } =
await this._options.parseVideoStreamMetadata(initialStream);
return {
stream: stream
.pipeThrough(this._options.createMediaStreamTransformer())
.pipeThrough(
new InspectStream((packet) => {
if (packet.type === "configuration") {
switch (metadata.codec) {
case ScrcpyVideoCodecId.H264:
case undefined: {
const { croppedWidth, croppedHeight } =
h264ParseConfiguration(packet.data);
this._screenWidth = croppedWidth;
this._screenHeight = croppedHeight;
}
}
}
})
),
metadata,
};
}
private async createAudioStream(initialStream: ReadableStream<Uint8Array>) {
const { stream, metadata } =
await this._options.parseAudioStreamMetadata(initialStream);
return {
stream: stream.pipeThrough(
this._options.createMediaStreamTransformer()
),
metadata,
};
}
public async close() {
await this._process.kill();
}
}