-
Notifications
You must be signed in to change notification settings - Fork 146
/
LocalParticipant.ts
454 lines (400 loc) · 12.9 KB
/
LocalParticipant.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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
import log from 'loglevel';
import { ParticipantInfo } from '../../proto/livekit_models';
import { DataPacket, DataPacket_Kind } from '../../proto/livekit_rtc';
import {
PublishDataError,
TrackInvalidError,
UnexpectedConnectionState,
} from '../errors';
import { ParticipantEvent, TrackEvent } from '../events';
import RTCEngine from '../RTCEngine';
import LocalAudioTrack from '../track/LocalAudioTrack';
import LocalTrack from '../track/LocalTrack';
import LocalTrackPublication from '../track/LocalTrackPublication';
import LocalVideoTrack from '../track/LocalVideoTrack';
import {
TrackPublishOptions,
VideoCodec,
VideoEncoding, VideoPreset, VideoPresets,
VideoPresets43,
} from '../track/options';
import { Track } from '../track/Track';
import Participant from './Participant';
import RemoteParticipant from './RemoteParticipant';
export default class LocalParticipant extends Participant {
private engine: RTCEngine;
audioTracks: Map<string, LocalTrackPublication>;
videoTracks: Map<string, LocalTrackPublication>;
/** map of track sid => all published tracks */
tracks: Map<string, LocalTrackPublication>;
/** @internal */
constructor(sid: string, identity: string, engine: RTCEngine) {
super(sid, identity);
this.audioTracks = new Map();
this.videoTracks = new Map();
this.tracks = new Map();
this.engine = engine;
}
/**
* Publish a new track to the room
* @param track
* @param options
*/
async publishTrack(
track: LocalTrack | MediaStreamTrack,
options?: TrackPublishOptions,
): Promise<LocalTrackPublication> {
// convert raw media track into audio or video track
if (track instanceof MediaStreamTrack) {
switch (track.kind) {
case 'audio':
track = new LocalAudioTrack(track, options?.name);
break;
case 'video':
track = new LocalVideoTrack(track, options?.name);
break;
default:
throw new TrackInvalidError(
`unsupported MediaStreamTrack kind ${track.kind}`,
);
}
}
// is it already published? if so skip
let existingPublication: LocalTrackPublication | undefined;
this.tracks.forEach((publication) => {
if (!publication.track) {
return;
}
if (publication.track === track) {
existingPublication = <LocalTrackPublication>publication;
}
});
if (existingPublication) return existingPublication;
// handle track actions
track.on(TrackEvent.Muted, this.onTrackMuted);
track.on(TrackEvent.Unmuted, this.onTrackUnmuted);
// get local track id for use during publishing
const cid = track.mediaStreamTrack.id;
// create track publication from track
const ti = await this.engine.addTrack(cid, track.name, track.kind, track.dimensions);
const publication = new LocalTrackPublication(track.kind, ti, track);
track.sid = ti.sid;
let encodings: RTCRtpEncodingParameters[] | undefined;
// for video
if (track.kind === Track.Kind.Video) {
// TODO: support react native, which doesn't expose getSettings
const settings = track.mediaStreamTrack.getSettings();
encodings = this.computeVideoEncodings(
settings.width,
settings.height,
options,
);
} else if (track.kind === Track.Kind.Audio && options?.audioBitrate) {
encodings = [
{
maxBitrate: options?.audioBitrate,
},
];
}
if (!this.engine.publisher) {
throw new UnexpectedConnectionState('publisher is closed');
}
log.debug('publishing with encodings', encodings);
const transceiverInit: RTCRtpTransceiverInit = { direction: 'sendonly' };
if (encodings) {
transceiverInit.sendEncodings = encodings;
}
const transceiver = this.engine.publisher.pc.addTransceiver(
track.mediaStreamTrack, transceiverInit,
);
// store RTPSender
track.sender = transceiver.sender;
if (track instanceof LocalVideoTrack) {
track.startMonitor(this.engine.client);
}
if (options?.videoCodec) {
this.setPreferredCodec(transceiver, track.kind, options.videoCodec);
}
this.addTrackPublication(publication);
// send event for publication
this.emit(ParticipantEvent.TrackPublished, publication);
return publication;
}
unpublishTrack(
track: LocalTrack | MediaStreamTrack,
): LocalTrackPublication | null {
// look through all published tracks to find the right ones
const publication = this.getPublicationForTrack(track);
log.debug('unpublishTrack', 'unpublishing track', track);
// TODO: add logging
if (!publication) {
log.warn(
'unpublishTrack',
'track was not unpublished because no publication was found',
track,
);
return null;
}
if (track instanceof LocalAudioTrack || track instanceof LocalVideoTrack) {
track.removeListener(TrackEvent.Muted, this.onTrackMuted);
track.removeListener(TrackEvent.Unmuted, this.onTrackUnmuted);
}
track.stop();
let mediaStreamTrack: MediaStreamTrack;
if (track instanceof MediaStreamTrack) {
mediaStreamTrack = track;
} else {
mediaStreamTrack = track.mediaStreamTrack;
}
if (this.engine.publisher) {
const senders = this.engine.publisher.pc.getSenders();
senders.forEach((sender) => {
if (sender.track === mediaStreamTrack) {
try {
this.engine.publisher?.pc.removeTrack(sender);
} catch (e) {
log.warn('unpublishTrack', 'failed to remove track', e);
}
}
});
}
// remove from our maps
this.tracks.delete(publication.trackSid);
switch (publication.kind) {
case Track.Kind.Audio:
this.audioTracks.delete(publication.trackSid);
break;
case Track.Kind.Video:
this.videoTracks.delete(publication.trackSid);
break;
default:
break;
}
return publication;
}
unpublishTracks(
tracks: LocalTrack[] | MediaStreamTrack[],
): LocalTrackPublication[] {
const publications: LocalTrackPublication[] = [];
tracks.forEach((track: LocalTrack | MediaStreamTrack) => {
const pub = this.unpublishTrack(track);
if (pub) {
publications.push(pub);
}
});
return publications;
}
get publisherMetrics(): any {
return null;
}
/** @internal */
updateInfo(info: ParticipantInfo) {
super.updateInfo(info);
// match local track mute status to server
info.tracks.forEach((ti) => {
const pub = <LocalTrackPublication> this.tracks.get(ti.sid);
if (!pub) {
return;
}
if (ti.muted && !pub.isMuted) {
pub.mute();
} else if (!ti.muted && pub.isMuted) {
pub.unmute();
}
});
}
/**
* Publish a new data payload to the room. Data will be forwarded to each
* participant in the room if the destination argument is empty
*
* @param data Uint8Array of the payload. To send string data, use TextEncoder.encode
* @param kind whether to send this as reliable or lossy.
* For data that you need delivery guarantee (such as chat messages), use Reliable.
* For data that should arrive as quickly as possible, but you are ok with dropped
* packets, use Lossy.
* @param destination the participants who will receive the message
*/
publishData(data: Uint8Array, kind: DataPacket_Kind,
destination?: RemoteParticipant[] | string[]) {
if (data.length > 14_000) {
throw new PublishDataError('data cannot be larger than 14k');
}
const dest: string[] = [];
if (destination !== undefined) {
destination.forEach((val : any) => {
if (val instanceof RemoteParticipant) {
dest.push(val.sid);
} else {
dest.push(val);
}
});
}
const packet: DataPacket = {
kind,
user: {
participantSid: this.sid,
payload: data,
destinationSids: dest,
},
};
const msg = DataPacket.encode(packet).finish();
if (kind === DataPacket_Kind.LOSSY && this.engine.lossyDC) {
this.engine.lossyDC.send(msg);
} else if (kind === DataPacket_Kind.RELIABLE && this.engine.reliableDC) {
this.engine.reliableDC.send(msg);
}
}
/** @internal */
onTrackUnmuted = (track: LocalVideoTrack | LocalAudioTrack) => {
this.onTrackMuted(track, false);
};
// when the local track changes in mute status, we'll notify server as such
/** @internal */
onTrackMuted = (
track: LocalVideoTrack | LocalAudioTrack,
muted?: boolean,
) => {
if (muted === undefined) {
muted = true;
}
if (!track.sid) {
log.error('could not update mute status for unpublished track', track);
return;
}
this.engine.updateMuteStatus(track.sid, muted);
};
private getPublicationForTrack(
track: LocalTrack | MediaStreamTrack,
): LocalTrackPublication | undefined {
let publication: LocalTrackPublication | undefined;
this.tracks.forEach((pub) => {
const localTrack = pub.track;
if (!localTrack) {
return;
}
// this looks overly complicated due to this object tree
if (track instanceof MediaStreamTrack) {
if (
localTrack instanceof LocalAudioTrack
|| localTrack instanceof LocalVideoTrack
) {
if (localTrack.mediaStreamTrack === track) {
publication = <LocalTrackPublication>pub;
}
}
} else if (track === localTrack) {
publication = <LocalTrackPublication>pub;
}
});
return publication;
}
private setPreferredCodec(
transceiver: RTCRtpTransceiver,
kind: Track.Kind,
videoCodec: VideoCodec,
) {
if (!('getCapabilities' in RTCRtpSender)) {
return;
}
const cap = RTCRtpSender.getCapabilities(kind);
if (!cap) return;
const selected = cap.codecs.find(
(c) => c.mimeType.toLowerCase() === `video/${videoCodec}`
|| c.mimeType.toLowerCase() === 'audio/opus',
);
if (selected && 'setCodecPreferences' in transceiver) {
transceiver.setCodecPreferences([selected]);
}
}
private computeVideoEncodings(
width?: number,
height?: number,
options?: TrackPublishOptions,
): RTCRtpEncodingParameters[] | undefined {
let encodings: RTCRtpEncodingParameters[];
let videoEncoding: VideoEncoding | undefined = options?.videoEncoding;
if ((!videoEncoding && !options?.simulcast) || !width || !height) {
// don't set encoding when we are not simulcasting and user isn't restricting
// encoding parameters
return undefined;
}
if (!videoEncoding) {
// find the right encoding based on width/height
videoEncoding = this.determineAppropriateEncoding(width, height);
log.debug('using video encoding', videoEncoding);
}
if (options?.simulcast) {
encodings = [
{
rid: 'f',
maxBitrate: videoEncoding.maxBitrate,
maxFramerate: videoEncoding.maxFramerate,
},
];
const presets = this.presetsForResolution(width, height);
const midPreset = presets[1];
const lowPreset = presets[0];
// if resolution is high enough, we would send both h and q res..
// otherwise only send h
if (height * 0.7 >= midPreset.height) {
encodings.push({
rid: 'h',
scaleResolutionDownBy: height / midPreset.height,
maxBitrate: midPreset.encoding.maxBitrate,
maxFramerate: midPreset.encoding.maxFramerate,
});
encodings.push({
rid: 'q',
scaleResolutionDownBy: height / lowPreset.height,
maxBitrate: lowPreset.encoding.maxBitrate,
maxFramerate: lowPreset.encoding.maxFramerate,
});
} else {
encodings.push({
rid: 'h',
scaleResolutionDownBy: height / lowPreset.height,
maxBitrate: lowPreset.encoding.maxBitrate,
maxFramerate: lowPreset.encoding.maxFramerate,
});
}
} else {
encodings = [videoEncoding];
}
return encodings;
}
private presets169 = [
VideoPresets.qvga,
VideoPresets.vga,
VideoPresets.qhd,
VideoPresets.hd,
VideoPresets.fhd,
];
private presets43 = [
VideoPresets43.qvga,
VideoPresets43.vga,
VideoPresets43.qhd,
VideoPresets43.hd,
VideoPresets43.fhd,
];
private determineAppropriateEncoding(
width: number,
height: number,
): VideoEncoding {
const presets = this.presetsForResolution(width, height);
let { encoding } = presets[0];
for (let i = 0; i < presets.length; i += 1) {
const preset = presets[i];
if (width >= preset.width && height >= preset.height) {
encoding = preset.encoding;
}
}
return encoding;
}
private presetsForResolution(width: number, height: number): VideoPreset[] {
const aspect = width / height;
if (Math.abs(aspect - 16.0 / 9) < Math.abs(aspect - 4.0 / 3)) {
return this.presets169;
}
return this.presets43;
}
}