RTCEngine.kt
21.1 KB
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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
package io.livekit.android.room
import android.os.SystemClock
import io.livekit.android.ConnectOptions
import io.livekit.android.dagger.InjectionNames
import io.livekit.android.room.participant.ParticipantTrackPermission
import io.livekit.android.room.track.TrackException
import io.livekit.android.room.util.*
import io.livekit.android.util.CloseableCoroutineScope
import io.livekit.android.util.Either
import io.livekit.android.util.LKLog
import io.livekit.android.webrtc.isConnected
import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.SupervisorJob
import kotlinx.coroutines.delay
import kotlinx.coroutines.launch
import livekit.LivekitModels
import livekit.LivekitRtc
import org.webrtc.*
import java.net.ConnectException
import java.nio.ByteBuffer
import javax.inject.Inject
import javax.inject.Named
import javax.inject.Singleton
import kotlin.coroutines.Continuation
import kotlin.coroutines.resume
import kotlin.coroutines.suspendCoroutine
/**
* @suppress
*/
@Singleton
class RTCEngine
@Inject
internal constructor(
val client: SignalClient,
private val pctFactory: PeerConnectionTransport.Factory,
@Named(InjectionNames.DISPATCHER_IO) ioDispatcher: CoroutineDispatcher,
) : SignalClient.Listener, DataChannel.Observer {
internal var listener: Listener? = null
internal var iceState: IceState = IceState.DISCONNECTED
set(value) {
val oldVal = field
field = value
if (value == oldVal) {
return
}
when (value) {
IceState.CONNECTED -> {
if (oldVal == IceState.DISCONNECTED) {
LKLog.d { "publisher ICE connected" }
listener?.onIceConnected()
} else if (oldVal == IceState.RECONNECTING) {
LKLog.d { "publisher ICE reconnected" }
listener?.onIceReconnected()
}
}
IceState.DISCONNECTED -> {
LKLog.d { "publisher ICE disconnected" }
listener?.onDisconnect("Peer connection disconnected")
}
else -> {
}
}
}
private var wsRetries: Int = 0
private val pendingTrackResolvers: MutableMap<String, Continuation<LivekitModels.TrackInfo>> =
mutableMapOf()
private var sessionUrl: String? = null
private var sessionToken: String? = null
private val publisherObserver = PublisherTransportObserver(this, client)
private val subscriberObserver = SubscriberTransportObserver(this, client)
internal lateinit var publisher: PeerConnectionTransport
private lateinit var subscriber: PeerConnectionTransport
private var reliableDataChannel: DataChannel? = null
private var reliableDataChannelSub: DataChannel? = null
private var lossyDataChannel: DataChannel? = null
private var lossyDataChannelSub: DataChannel? = null
private var isSubscriberPrimary = false
private var isClosed = true
private var hasPublished = false
private val coroutineScope = CloseableCoroutineScope(SupervisorJob() + ioDispatcher)
init {
client.listener = this
}
suspend fun join(url: String, token: String, options: ConnectOptions): LivekitRtc.JoinResponse {
sessionUrl = url
sessionToken = token
val joinResponse = client.join(url, token, options)
isClosed = false
isSubscriberPrimary = joinResponse.subscriberPrimary
if (!this::publisher.isInitialized) {
configure(joinResponse, options)
}
// create offer
if (!this.isSubscriberPrimary) {
negotiate()
}
client.onReady()
return joinResponse
}
private fun configure(joinResponse: LivekitRtc.JoinResponse, connectOptions: ConnectOptions?) {
if (this::publisher.isInitialized || this::subscriber.isInitialized) {
// already configured
return
}
// update ICE servers before creating PeerConnection
val iceServers = if (connectOptions?.iceServers != null) {
connectOptions.iceServers
} else {
val servers = mutableListOf<PeerConnection.IceServer>()
for (serverInfo in joinResponse.iceServersList) {
val username = serverInfo.username ?: ""
val credential = serverInfo.credential ?: ""
servers.add(
PeerConnection.IceServer
.builder(serverInfo.urlsList)
.setUsername(username)
.setPassword(credential)
.createIceServer()
)
}
if (servers.isEmpty()) {
servers.addAll(SignalClient.DEFAULT_ICE_SERVERS)
}
servers
}
// Setup peer connections
val rtcConfig = connectOptions?.rtcConfig?.apply {
val mergedServers = this.iceServers.toMutableList()
iceServers.forEach { server ->
if (!mergedServers.contains(server)) {
mergedServers.add(server)
}
}
}
?: PeerConnection.RTCConfiguration(iceServers).apply {
sdpSemantics = PeerConnection.SdpSemantics.UNIFIED_PLAN
continualGatheringPolicy =
PeerConnection.ContinualGatheringPolicy.GATHER_CONTINUALLY
enableDtlsSrtp = true
}
publisher = pctFactory.create(
rtcConfig,
publisherObserver,
publisherObserver,
)
subscriber = pctFactory.create(
rtcConfig,
subscriberObserver,
null,
)
val iceConnectionStateListener: (PeerConnection.IceConnectionState?) -> Unit = { newState ->
val state =
newState ?: throw NullPointerException("unexpected null new state, what do?")
LKLog.v { "onIceConnection new state: $newState" }
if (state == PeerConnection.IceConnectionState.CONNECTED) {
iceState = IceState.CONNECTED
} else if (state == PeerConnection.IceConnectionState.FAILED) {
// when we publish tracks, some WebRTC versions will send out disconnected events periodically
iceState = IceState.DISCONNECTED
listener?.onDisconnect("Peer connection disconnected")
}
}
if (joinResponse.subscriberPrimary) {
// in subscriber primary mode, server side opens sub data channels.
subscriberObserver.dataChannelListener = onDataChannel@{ dataChannel: DataChannel ->
when (dataChannel.label()) {
RELIABLE_DATA_CHANNEL_LABEL -> reliableDataChannelSub = dataChannel
LOSSY_DATA_CHANNEL_LABEL -> lossyDataChannelSub = dataChannel
else -> return@onDataChannel
}
dataChannel.registerObserver(this)
}
subscriberObserver.iceConnectionChangeListener = iceConnectionStateListener
} else {
publisherObserver.iceConnectionChangeListener = iceConnectionStateListener
}
// data channels
val reliableInit = DataChannel.Init()
reliableInit.ordered = true
reliableDataChannel = publisher.peerConnection.createDataChannel(
RELIABLE_DATA_CHANNEL_LABEL,
reliableInit
)
reliableDataChannel!!.registerObserver(this)
val lossyInit = DataChannel.Init()
lossyInit.ordered = true
lossyInit.maxRetransmits = 0
lossyDataChannel = publisher.peerConnection.createDataChannel(
LOSSY_DATA_CHANNEL_LABEL,
lossyInit
)
lossyDataChannel!!.registerObserver(this)
}
/**
* @param builder an optional builder to include other parameters related to the track
*/
suspend fun addTrack(
cid: String,
name: String,
kind: LivekitModels.TrackType,
builder: LivekitRtc.AddTrackRequest.Builder = LivekitRtc.AddTrackRequest.newBuilder()
): LivekitModels.TrackInfo {
if (pendingTrackResolvers[cid] != null) {
throw TrackException.DuplicateTrackException("Track with same ID $cid has already been published!")
}
return suspendCoroutine { cont ->
pendingTrackResolvers[cid] = cont
client.sendAddTrack(cid, name, kind, builder)
}
}
fun updateSubscriptionPermissions(
allParticipants: Boolean,
participantTrackPermissions: List<ParticipantTrackPermission>
) {
client.sendUpdateSubscriptionPermissions(allParticipants, participantTrackPermissions)
}
fun updateMuteStatus(sid: String, muted: Boolean) {
client.sendMuteTrack(sid, muted)
}
fun close() {
coroutineScope.close()
publisher.close()
subscriber.close()
client.close()
}
/**
* reconnect Signal and PeerConnections
*/
internal fun reconnect() {
val url = sessionUrl
val token = sessionToken
if (url == null || token == null) {
LKLog.w { "couldn't reconnect, no url or no token" }
return
}
if (iceState == IceState.DISCONNECTED || wsRetries >= MAX_SIGNAL_RETRIES) {
LKLog.w { "could not connect to signal after max attempts, giving up" }
close()
listener?.onDisconnect("could not reconnect after limit")
return
}
var startDelay = wsRetries.toLong() * wsRetries * 500
if (startDelay > 5000) {
startDelay = 5000
}
coroutineScope.launch {
delay(startDelay)
if (iceState == IceState.DISCONNECTED) {
LKLog.e { "Ice is disconnected" }
return@launch
}
client.reconnect(url, token)
LKLog.v { "reconnected, restarting ICE" }
wsRetries = 0
// trigger publisher reconnect
subscriber.prepareForIceRestart()
// only restart publisher if it's needed
if (hasPublished) {
publisher.negotiate(
getPublisherOfferConstraints().apply {
with(mandatory) {
add(
MediaConstraints.KeyValuePair(
MediaConstraintKeys.ICE_RESTART,
MediaConstraintKeys.TRUE
)
)
}
}
)
}
}
}
internal fun negotiate() {
if (!client.isConnected) {
return
}
coroutineScope.launch {
publisher.negotiate(getPublisherOfferConstraints())
}
}
internal suspend fun sendData(dataPacket: LivekitModels.DataPacket) {
ensurePublisherConnected(dataPacket.kind)
val buf = DataChannel.Buffer(
ByteBuffer.wrap(dataPacket.toByteArray()),
true,
)
val channel = dataChannelForKind(dataPacket.kind)
?: throw TrackException.PublishException("channel not established for ${dataPacket.kind.name}")
channel.send(buf)
}
private suspend fun ensurePublisherConnected(kind: LivekitModels.DataPacket.Kind) {
if (!isSubscriberPrimary) {
return
}
if (!this::publisher.isInitialized) {
throw RoomException.ConnectException("Publisher is not connected!")
}
if (!publisher.peerConnection.isConnected() &&
publisher.peerConnection.iceConnectionState() != PeerConnection.IceConnectionState.CHECKING
) {
// start negotiation
this.negotiate();
}
val targetChannel = dataChannelForKind(kind) ?: throw IllegalArgumentException("Unknown data packet kind!")
if (targetChannel.state() == DataChannel.State.OPEN) {
return
}
// wait until publisher ICE connected
val endTime = SystemClock.elapsedRealtime() + MAX_ICE_CONNECT_TIMEOUT_MS;
while (SystemClock.elapsedRealtime() < endTime) {
if (this.publisher.peerConnection.isConnected() && targetChannel.state() == DataChannel.State.OPEN) {
return
}
delay(50)
}
throw ConnectException("could not establish publisher connection")
}
private fun dataChannelForKind(kind: LivekitModels.DataPacket.Kind) =
when (kind) {
LivekitModels.DataPacket.Kind.RELIABLE -> reliableDataChannel
LivekitModels.DataPacket.Kind.LOSSY -> lossyDataChannel
else -> null
}
private fun getPublisherOfferConstraints(): MediaConstraints {
return MediaConstraints().apply {
with(mandatory) {
add(
MediaConstraints.KeyValuePair(
MediaConstraintKeys.OFFER_TO_RECV_AUDIO,
MediaConstraintKeys.FALSE
)
)
add(
MediaConstraints.KeyValuePair(
MediaConstraintKeys.OFFER_TO_RECV_VIDEO,
MediaConstraintKeys.FALSE
)
)
if (iceState == IceState.RECONNECTING) {
add(
MediaConstraints.KeyValuePair(
MediaConstraintKeys.ICE_RESTART,
MediaConstraintKeys.TRUE
)
)
}
}
}
}
internal interface Listener {
fun onIceConnected()
fun onIceReconnected()
fun onAddTrack(track: MediaStreamTrack, streams: Array<out MediaStream>)
fun onUpdateParticipants(updates: List<LivekitModels.ParticipantInfo>)
fun onActiveSpeakersUpdate(speakers: List<LivekitModels.SpeakerInfo>)
fun onRemoteMuteChanged(trackSid: String, muted: Boolean)
fun onRoomUpdate(update: LivekitModels.Room)
fun onConnectionQuality(updates: List<LivekitRtc.ConnectionQualityInfo>)
fun onSpeakersChanged(speakers: List<LivekitModels.SpeakerInfo>)
fun onDisconnect(reason: String)
fun onFailToConnect(error: Throwable)
fun onUserPacket(packet: LivekitModels.UserPacket, kind: LivekitModels.DataPacket.Kind)
fun onStreamStateUpdate(streamStates: List<LivekitRtc.StreamStateInfo>)
fun onSubscribedQualityUpdate(subscribedQualityUpdate: LivekitRtc.SubscribedQualityUpdate)
fun onSubscriptionPermissionUpdate(subscriptionPermissionUpdate: LivekitRtc.SubscriptionPermissionUpdate)
}
companion object {
private const val RELIABLE_DATA_CHANNEL_LABEL = "_reliable"
private const val LOSSY_DATA_CHANNEL_LABEL = "_lossy"
internal const val MAX_DATA_PACKET_SIZE = 15000
private const val MAX_SIGNAL_RETRIES = 5
private const val MAX_ICE_CONNECT_TIMEOUT_MS = 5000
internal val CONN_CONSTRAINTS = MediaConstraints().apply {
with(optional) {
add(MediaConstraints.KeyValuePair("DtlsSrtpKeyAgreement", "true"))
}
}
}
//---------------------------------- SignalClient.Listener --------------------------------------//
override fun onAnswer(sessionDescription: SessionDescription) {
LKLog.v { "received server answer: ${sessionDescription.type}, ${publisher.peerConnection.signalingState()}" }
coroutineScope.launch {
LKLog.i { sessionDescription.toString() }
when (val outcome = publisher.setRemoteDescription(sessionDescription)) {
is Either.Left -> {
// when reconnecting, ICE might not have disconnected and won't trigger
// our connected callback, so we'll take a shortcut and set it to active
if (iceState == IceState.RECONNECTING) {
iceState = IceState.CONNECTED
}
}
is Either.Right -> {
LKLog.e { "error setting remote description for answer: ${outcome.value} " }
}
}
}
}
override fun onOffer(sessionDescription: SessionDescription) {
LKLog.v { "received server offer: ${sessionDescription.type}, ${subscriber.peerConnection.signalingState()}" }
coroutineScope.launch {
run<Unit> {
when (val outcome =
subscriber.setRemoteDescription(sessionDescription)) {
is Either.Right -> {
LKLog.e { "error setting remote description for answer: ${outcome.value} " }
return@launch
}
}
}
val answer = run {
when (val outcome = subscriber.peerConnection.createAnswer(MediaConstraints())) {
is Either.Left -> outcome.value
is Either.Right -> {
LKLog.e { "error creating answer: ${outcome.value}" }
return@launch
}
}
}
run<Unit> {
when (val outcome = subscriber.peerConnection.setLocalDescription(answer)) {
is Either.Right -> {
LKLog.e { "error setting local description for answer: ${outcome.value}" }
return@launch
}
}
}
client.sendAnswer(answer)
}
}
override fun onTrickle(candidate: IceCandidate, target: LivekitRtc.SignalTarget) {
LKLog.v { "received ice candidate from peer: $candidate, $target" }
when (target) {
LivekitRtc.SignalTarget.PUBLISHER -> publisher.addIceCandidate(candidate)
LivekitRtc.SignalTarget.SUBSCRIBER -> subscriber.addIceCandidate(candidate)
else -> LKLog.i { "unknown ice candidate target?" }
}
}
override fun onLocalTrackPublished(response: LivekitRtc.TrackPublishedResponse) {
val cid = response.cid ?: run {
LKLog.e { "local track published with null cid?" }
return
}
val track = response.track
if (track == null) {
LKLog.d { "local track published with null track info?" }
}
LKLog.v { "local track published $cid" }
val cont = pendingTrackResolvers.remove(cid)
if (cont == null) {
LKLog.d { "missing track resolver for: $cid" }
return
}
cont.resume(response.track)
}
override fun onParticipantUpdate(updates: List<LivekitModels.ParticipantInfo>) {
listener?.onUpdateParticipants(updates)
}
override fun onSpeakersChanged(speakers: List<LivekitModels.SpeakerInfo>) {
listener?.onSpeakersChanged(speakers)
}
override fun onClose(reason: String, code: Int) {
// TODO: reconnect logic
LKLog.i { "received close event: $reason, code: $code" }
listener?.onDisconnect(reason)
}
override fun onRemoteMuteChanged(trackSid: String, muted: Boolean) {
listener?.onRemoteMuteChanged(trackSid, muted)
}
override fun onRoomUpdate(update: LivekitModels.Room) {
listener?.onRoomUpdate(update)
}
override fun onConnectionQuality(updates: List<LivekitRtc.ConnectionQualityInfo>) {
listener?.onConnectionQuality(updates)
}
override fun onLeave() {
close()
listener?.onDisconnect("")
}
override fun onError(error: Throwable) {
listener?.onFailToConnect(error)
}
override fun onStreamStateUpdate(streamStates: List<LivekitRtc.StreamStateInfo>) {
listener?.onStreamStateUpdate(streamStates)
}
override fun onSubscribedQualityUpdate(subscribedQualityUpdate: LivekitRtc.SubscribedQualityUpdate) {
listener?.onSubscribedQualityUpdate(subscribedQualityUpdate)
}
override fun onSubscriptionPermissionUpdate(subscriptionPermissionUpdate: LivekitRtc.SubscriptionPermissionUpdate) {
listener?.onSubscriptionPermissionUpdate(subscriptionPermissionUpdate)
}
//--------------------------------- DataChannel.Observer ------------------------------------//
override fun onBufferedAmountChange(previousAmount: Long) {
}
override fun onStateChange() {
}
override fun onMessage(buffer: DataChannel.Buffer?) {
if (buffer == null) {
return
}
val dp = LivekitModels.DataPacket.parseFrom(buffer.data)
when (dp.valueCase) {
LivekitModels.DataPacket.ValueCase.SPEAKER -> {
listener?.onActiveSpeakersUpdate(dp.speaker.speakersList)
}
LivekitModels.DataPacket.ValueCase.USER -> {
listener?.onUserPacket(dp.user, dp.kind)
}
LivekitModels.DataPacket.ValueCase.VALUE_NOT_SET,
null -> {
LKLog.v { "invalid value for data packet" }
}
}
}
}
internal enum class IceState {
DISCONNECTED,
RECONNECTING,
CONNECTED,
}