RTCEngine.kt
38.6 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
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
/*
* Copyright 2023-2024 LiveKit, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.livekit.android.room
import android.os.SystemClock
import androidx.annotation.VisibleForTesting
import com.google.protobuf.ByteString
import io.livekit.android.ConnectOptions
import io.livekit.android.RoomOptions
import io.livekit.android.dagger.InjectionNames
import io.livekit.android.events.DisconnectReason
import io.livekit.android.events.convert
import io.livekit.android.room.participant.ParticipantTrackPermission
import io.livekit.android.room.track.TrackException
import io.livekit.android.room.util.MediaConstraintKeys
import io.livekit.android.room.util.createAnswer
import io.livekit.android.room.util.setLocalDescription
import io.livekit.android.util.CloseableCoroutineScope
import io.livekit.android.util.Either
import io.livekit.android.util.FlowObservable
import io.livekit.android.util.LKLog
import io.livekit.android.util.flowDelegate
import io.livekit.android.util.nullSafe
import io.livekit.android.util.withCheckLock
import io.livekit.android.webrtc.RTCStatsGetter
import io.livekit.android.webrtc.copy
import io.livekit.android.webrtc.isConnected
import io.livekit.android.webrtc.isDisconnected
import io.livekit.android.webrtc.peerconnection.executeBlockingOnRTCThread
import io.livekit.android.webrtc.peerconnection.launchBlockingOnRTCThread
import io.livekit.android.webrtc.toProtoSessionDescription
import kotlinx.coroutines.*
import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock
import livekit.LivekitModels
import livekit.LivekitRtc
import livekit.LivekitRtc.JoinResponse
import livekit.LivekitRtc.ReconnectResponse
import livekit.org.webrtc.*
import livekit.org.webrtc.PeerConnection.RTCConfiguration
import livekit.org.webrtc.RtpTransceiver.RtpTransceiverInit
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)
private val ioDispatcher: CoroutineDispatcher,
) : SignalClient.Listener {
internal var listener: Listener? = null
/**
* Reflects the combined connection state of SignalClient and primary PeerConnection.
*/
@FlowObservable
@VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)
var connectionState: ConnectionState by flowDelegate(ConnectionState.DISCONNECTED) { newVal, oldVal ->
if (newVal == oldVal) {
return@flowDelegate
}
when (newVal) {
ConnectionState.CONNECTED -> {
if (oldVal == ConnectionState.DISCONNECTED) {
LKLog.d { "primary ICE connected" }
listener?.onEngineConnected()
} else if (oldVal == ConnectionState.RECONNECTING) {
LKLog.d { "primary ICE reconnected" }
listener?.onEngineReconnected()
} else if (oldVal == ConnectionState.RESUMING) {
listener?.onEngineResumed()
}
}
ConnectionState.DISCONNECTED -> {
LKLog.d { "primary ICE disconnected" }
if (oldVal == ConnectionState.CONNECTED) {
reconnect()
}
}
else -> {
}
}
}
internal var reconnectType: ReconnectType = ReconnectType.DEFAULT
private var reconnectingJob: Job? = null
private var fullReconnectOnNext = false
private val pendingTrackResolvers: MutableMap<String, Continuation<LivekitModels.TrackInfo>> =
mutableMapOf()
private var sessionUrl: String? = null
private var sessionToken: String? = null
private var connectOptions: ConnectOptions? = null
private var lastRoomOptions: RoomOptions? = null
private var participantSid: String? = null
private val publisherObserver = PublisherTransportObserver(this, client)
private val subscriberObserver = SubscriberTransportObserver(this, client)
private var publisher: PeerConnectionTransport? = null
private var subscriber: PeerConnectionTransport? = null
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 var coroutineScope = CloseableCoroutineScope(SupervisorJob() + ioDispatcher)
/**
* Note: If this lock is ever used in conjunction with the RTC thread,
* this must be grabbed on the RTC thread to prevent deadlocks.
*/
private var configurationLock = Mutex()
init {
client.listener = this
}
suspend fun join(
url: String,
token: String,
options: ConnectOptions,
roomOptions: RoomOptions,
): JoinResponse {
coroutineScope.close()
coroutineScope = CloseableCoroutineScope(SupervisorJob() + ioDispatcher)
sessionUrl = url
sessionToken = token
connectOptions = options
lastRoomOptions = roomOptions
return joinImpl(url, token, options, roomOptions)
}
suspend fun joinImpl(
url: String,
token: String,
options: ConnectOptions,
roomOptions: RoomOptions,
): JoinResponse = coroutineScope {
val joinResponse = client.join(url, token, options, roomOptions)
ensureActive()
listener?.onJoinResponse(joinResponse)
isClosed = false
listener?.onSignalConnected(false)
isSubscriberPrimary = joinResponse.subscriberPrimary
configure(joinResponse, options)
// create offer
if (!isSubscriberPrimary) {
negotiatePublisher()
}
client.onReadyForResponses()
return@coroutineScope joinResponse
}
private suspend fun configure(joinResponse: JoinResponse, connectOptions: ConnectOptions) {
launchBlockingOnRTCThread {
configurationLock.withCheckLock(
{
ensureActive()
if (publisher != null && subscriber != null) {
// already configured
return@launchBlockingOnRTCThread
}
},
) {
participantSid = if (joinResponse.hasParticipant()) {
joinResponse.participant.sid
} else {
null
}
// Setup peer connections
val rtcConfig = makeRTCConfig(Either.Left(joinResponse), connectOptions)
publisher?.close()
publisher = pctFactory.create(
rtcConfig,
publisherObserver,
publisherObserver,
)
subscriber?.close()
subscriber = pctFactory.create(
rtcConfig,
subscriberObserver,
null,
)
val connectionStateListener: (PeerConnection.PeerConnectionState) -> Unit = { newState ->
LKLog.v { "onIceConnection new state: $newState" }
if (newState.isConnected()) {
connectionState = ConnectionState.CONNECTED
} else if (newState.isDisconnected()) {
connectionState = ConnectionState.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(DataChannelObserver(dataChannel))
}
subscriberObserver.connectionChangeListener = connectionStateListener
// Also reconnect on publisher disconnect
publisherObserver.connectionChangeListener = { newState ->
if (newState.isDisconnected()) {
reconnect()
}
}
} else {
publisherObserver.connectionChangeListener = connectionStateListener
}
ensureActive()
// data channels
val reliableInit = DataChannel.Init()
reliableInit.ordered = true
reliableDataChannel = publisher?.withPeerConnection {
createDataChannel(
RELIABLE_DATA_CHANNEL_LABEL,
reliableInit,
).also { dataChannel ->
dataChannel.registerObserver(DataChannelObserver(dataChannel))
}
}
ensureActive()
val lossyInit = DataChannel.Init()
lossyInit.ordered = true
lossyInit.maxRetransmits = 0
lossyDataChannel = publisher?.withPeerConnection {
createDataChannel(
LOSSY_DATA_CHANNEL_LABEL,
lossyInit,
).also { dataChannel ->
dataChannel.registerObserver(DataChannelObserver(dataChannel))
}
}
}
}
}
/**
* @param builder an optional builder to include other parameters related to the track
*/
suspend fun addTrack(
cid: String,
name: String,
kind: LivekitModels.TrackType,
stream: String?,
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!")
}
// Suspend until signal client receives message confirming track publication.
return suspendCoroutine { cont ->
pendingTrackResolvers[cid] = cont
client.sendAddTrack(
cid = cid,
name = name,
type = kind,
stream = stream,
builder = builder,
)
}
}
internal suspend fun createSenderTransceiver(
rtcTrack: MediaStreamTrack,
transInit: RtpTransceiverInit,
): RtpTransceiver? {
return publisher?.withPeerConnection {
addTransceiver(rtcTrack, transInit)
}
}
fun updateSubscriptionPermissions(
allParticipants: Boolean,
participantTrackPermissions: List<ParticipantTrackPermission>,
) {
client.sendUpdateSubscriptionPermissions(allParticipants, participantTrackPermissions)
}
fun updateMuteStatus(sid: String, muted: Boolean) {
client.sendMuteTrack(sid, muted)
}
fun close(reason: String = "Normal Closure") {
if (isClosed) {
return
}
LKLog.v { "Close - $reason" }
isClosed = true
reconnectingJob?.cancel()
reconnectingJob = null
coroutineScope.close()
hasPublished = false
sessionUrl = null
sessionToken = null
connectOptions = null
lastRoomOptions = null
participantSid = null
closeResources(reason)
connectionState = ConnectionState.DISCONNECTED
}
private fun closeResources(reason: String) {
executeBlockingOnRTCThread {
runBlocking {
configurationLock.withLock {
publisherObserver.connectionChangeListener = null
subscriberObserver.connectionChangeListener = null
publisher?.closeBlocking()
publisher = null
subscriber?.closeBlocking()
subscriber = null
fun DataChannel?.completeDispose() {
this?.unregisterObserver()
this?.close()
this?.dispose()
}
reliableDataChannel?.completeDispose()
reliableDataChannel = null
reliableDataChannelSub?.completeDispose()
reliableDataChannelSub = null
lossyDataChannel?.completeDispose()
lossyDataChannel = null
lossyDataChannelSub?.completeDispose()
lossyDataChannelSub = null
isSubscriberPrimary = false
}
}
}
client.close(reason = reason)
}
/**
* reconnect Signal and PeerConnections
*/
@Synchronized
@VisibleForTesting
fun reconnect() {
if (reconnectingJob?.isActive == true) {
LKLog.d { "Reconnection is already in progress" }
return
}
if (this.isClosed) {
LKLog.d { "Skip reconnection - engine is closed" }
return
}
val url = sessionUrl
val token = sessionToken
if (url == null || token == null) {
LKLog.w { "couldn't reconnect, no url or no token" }
return
}
val forceFullReconnect = fullReconnectOnNext
fullReconnectOnNext = false
val job = coroutineScope.launch {
var hasResumedOnce = false
var hasReconnectedOnce = false
val reconnectStartTime = SystemClock.elapsedRealtime()
for (retries in 0 until MAX_RECONNECT_RETRIES) {
ensureActive()
if (retries != 0) {
yield()
}
if (isClosed) {
LKLog.v { "RTCEngine closed, aborting reconnection" }
break
}
var startDelay = 100 + retries.toLong() * retries * 500
if (startDelay > 5000) {
startDelay = 5000
}
LKLog.i { "Reconnecting to signal, attempt ${retries + 1}" }
delay(startDelay)
val isFullReconnect = when (reconnectType) {
// full reconnect after first try.
ReconnectType.DEFAULT -> retries != 0 || forceFullReconnect
ReconnectType.FORCE_SOFT_RECONNECT -> false
ReconnectType.FORCE_FULL_RECONNECT -> true
}
val connectOptions = connectOptions ?: ConnectOptions()
if (isFullReconnect) {
LKLog.v { "Attempting full reconnect." }
if (!hasReconnectedOnce) {
hasReconnectedOnce = true
listener?.onEngineReconnecting()
}
connectionState = ConnectionState.RECONNECTING
try {
closeResources("Full Reconnecting")
listener?.onFullReconnecting()
joinImpl(url, token, connectOptions, lastRoomOptions ?: RoomOptions())
} catch (e: Exception) {
LKLog.w(e) { "Error during reconnection." }
// reconnect failed, retry.
continue
}
} else {
if (!hasResumedOnce) {
hasResumedOnce = true
listener?.onEngineResuming()
}
connectionState = ConnectionState.RESUMING
LKLog.v { "Attempting soft reconnect." }
subscriber?.prepareForIceRestart()
try {
val response = client.reconnect(url, token, participantSid)
if (response is Either.Left) {
val reconnectResponse = response.value
val rtcConfig = makeRTCConfig(Either.Right(reconnectResponse), connectOptions)
subscriber?.updateRTCConfig(rtcConfig)
publisher?.updateRTCConfig(rtcConfig)
}
client.onReadyForResponses()
} catch (e: Exception) {
LKLog.w(e) { "Error during reconnection." }
// ws reconnect failed, retry.
continue
}
LKLog.v { "ws reconnected, restarting ICE" }
listener?.onSignalConnected(!isFullReconnect)
// trigger publisher reconnect
// only restart publisher if it's needed
if (hasPublished) {
negotiatePublisher()
}
}
ensureActive()
if (isClosed) {
LKLog.v { "RTCEngine closed, aborting reconnection" }
break
}
// wait until ICE connected
val endTime = SystemClock.elapsedRealtime() + MAX_ICE_CONNECT_TIMEOUT_MS
if (hasPublished) {
while (SystemClock.elapsedRealtime() < endTime) {
if (publisher?.isConnected() == true) {
LKLog.v { "publisher reconnected to ICE" }
break
}
delay(100)
}
}
ensureActive()
if (isClosed) {
LKLog.v { "RTCEngine closed, aborting reconnection" }
break
}
while (SystemClock.elapsedRealtime() < endTime) {
if (subscriber?.isConnected() == true) {
LKLog.v { "reconnected to ICE" }
connectionState = ConnectionState.CONNECTED
break
}
delay(100)
}
ensureActive()
if (isClosed) {
LKLog.v { "RTCEngine closed, aborting reconnection" }
break
}
if (connectionState == ConnectionState.CONNECTED &&
(!hasPublished || publisher?.isConnected() == true)
) {
client.onPCConnected()
listener?.onPostReconnect(isFullReconnect)
return@launch
}
val curReconnectTime = SystemClock.elapsedRealtime() - reconnectStartTime
if (curReconnectTime > MAX_RECONNECT_TIMEOUT) {
break
}
}
close("Failed reconnecting")
listener?.onEngineDisconnected(DisconnectReason.UNKNOWN_REASON)
}
reconnectingJob = job
job.invokeOnCompletion {
if (reconnectingJob == job) {
reconnectingJob = null
}
}
}
internal fun negotiatePublisher() {
if (!client.isConnected) {
return
}
hasPublished = true
coroutineScope.launch {
publisher?.negotiate?.invoke(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 (publisher == null) {
throw RoomException.ConnectException("Publisher isn't setup yet! Is room not connected?!")
}
if (publisher?.isConnected() != true &&
publisher?.iceConnectionState() != PeerConnection.IceConnectionState.CHECKING
) {
// start negotiation
this.negotiatePublisher()
}
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 (publisher?.isConnected() == true && 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 (connectionState == ConnectionState.RECONNECTING || connectionState == ConnectionState.RESUMING) {
add(
MediaConstraints.KeyValuePair(
MediaConstraintKeys.ICE_RESTART,
MediaConstraintKeys.TRUE,
),
)
}
}
}
}
private fun makeRTCConfig(
serverResponse: Either<JoinResponse, ReconnectResponse>,
connectOptions: ConnectOptions,
): RTCConfiguration {
// Convert protobuf ice servers
val serverIceServers = run {
val servers = mutableListOf<PeerConnection.IceServer>()
val responseServers = when (serverResponse) {
is Either.Left -> serverResponse.value.iceServersList
is Either.Right -> serverResponse.value.iceServersList
}
for (serverInfo in responseServers) {
servers.add(serverInfo.toWebrtc())
}
if (servers.isEmpty()) {
servers.addAll(SignalClient.DEFAULT_ICE_SERVERS)
}
servers
}
val rtcConfig = connectOptions.rtcConfig?.copy()?.apply {
val mergedServers = iceServers.toMutableList()
if (connectOptions.iceServers != null) {
connectOptions.iceServers.forEach { server ->
if (!mergedServers.contains(server)) {
mergedServers.add(server)
}
}
}
// Only use server-provided servers if user doesn't provide any.
if (mergedServers.isEmpty()) {
iceServers.forEach { server ->
if (!mergedServers.contains(server)) {
mergedServers.add(server)
}
}
}
iceServers = mergedServers
}
?: RTCConfiguration(serverIceServers).apply {
sdpSemantics = PeerConnection.SdpSemantics.UNIFIED_PLAN
continualGatheringPolicy =
PeerConnection.ContinualGatheringPolicy.GATHER_CONTINUALLY
}
val clientConfig = when (serverResponse) {
is Either.Left -> {
if (serverResponse.value.hasClientConfiguration()) {
serverResponse.value.clientConfiguration
} else {
null
}
}
is Either.Right -> {
if (serverResponse.value.hasClientConfiguration()) {
serverResponse.value.clientConfiguration
} else {
null
}
}
}
if (clientConfig != null) {
if (clientConfig.forceRelay == LivekitModels.ClientConfigSetting.ENABLED) {
rtcConfig.iceTransportsType = PeerConnection.IceTransportsType.RELAY
}
}
return rtcConfig
}
internal interface Listener {
fun onEngineConnected()
fun onEngineReconnected()
fun onEngineReconnecting()
fun onEngineResuming() {}
fun onEngineResumed() {}
fun onEngineDisconnected(reason: DisconnectReason)
fun onFailToConnect(error: Throwable)
fun onJoinResponse(response: JoinResponse)
fun onAddTrack(receiver: RtpReceiver, 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 onUserPacket(packet: LivekitModels.UserPacket, kind: LivekitModels.DataPacket.Kind)
fun onStreamStateUpdate(streamStates: List<LivekitRtc.StreamStateInfo>)
fun onSubscribedQualityUpdate(subscribedQualityUpdate: LivekitRtc.SubscribedQualityUpdate)
fun onSubscriptionPermissionUpdate(subscriptionPermissionUpdate: LivekitRtc.SubscriptionPermissionUpdate)
fun onSignalConnected(isResume: Boolean)
fun onFullReconnecting()
suspend fun onPostReconnect(isFullReconnect: Boolean)
fun onLocalTrackUnpublished(trackUnpublished: LivekitRtc.TrackUnpublishedResponse)
}
companion object {
/**
* @suppress
*/
@VisibleForTesting
const val RELIABLE_DATA_CHANNEL_LABEL = "_reliable"
/**
* @suppress
*/
@VisibleForTesting
const val LOSSY_DATA_CHANNEL_LABEL = "_lossy"
internal const val MAX_DATA_PACKET_SIZE = 15000
private const val MAX_RECONNECT_RETRIES = 10
private const val MAX_RECONNECT_TIMEOUT = 60 * 1000
private const val MAX_ICE_CONNECT_TIMEOUT_MS = 20000
internal val CONN_CONSTRAINTS = MediaConstraints().apply {
with(optional) {
add(MediaConstraints.KeyValuePair("DtlsSrtpKeyAgreement", "true"))
}
}
}
// ---------------------------------- SignalClient.Listener --------------------------------------//
override fun onAnswer(sessionDescription: SessionDescription) {
val signalingState = runBlocking { publisher?.signalingState() }
LKLog.v { "received server answer: ${sessionDescription.type}, $signalingState" }
coroutineScope.launch {
LKLog.i { sessionDescription.toString() }
when (val outcome = publisher?.setRemoteDescription(sessionDescription).nullSafe()) {
is Either.Left -> {
// do nothing.
}
is Either.Right -> {
LKLog.e { "error setting remote description for answer: ${outcome.value} " }
}
}
}
}
override fun onOffer(sessionDescription: SessionDescription) {
val signalingState = runBlocking { publisher?.signalingState() }
LKLog.v { "received server offer: ${sessionDescription.type}, $signalingState" }
coroutineScope.launch {
run {
when (val outcome = subscriber?.setRemoteDescription(sessionDescription).nullSafe()) {
is Either.Right -> {
LKLog.e { "error setting remote description for answer: ${outcome.value} " }
return@launch
}
else -> {}
}
}
if (isClosed) {
return@launch
}
val answer = run {
when (val outcome = subscriber?.withPeerConnection { createAnswer(MediaConstraints()) }.nullSafe()) {
is Either.Left -> outcome.value
is Either.Right -> {
LKLog.e { "error creating answer: ${outcome.value}" }
return@launch
}
}
}
if (isClosed) {
return@launch
}
run<Unit> {
when (val outcome = subscriber?.withPeerConnection { setLocalDescription(answer) }.nullSafe()) {
is Either.Left -> Unit
is Either.Right -> {
LKLog.e { "error setting local description for answer: ${outcome.value}" }
return@launch
}
}
}
if (isClosed) {
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)
?: LKLog.w { "received candidate for publisher when we don't have one. ignoring." }
}
LivekitRtc.SignalTarget.SUBSCRIBER -> {
subscriber?.addIceCandidate(candidate)
?: LKLog.w { "received candidate for subscriber when we don't have one. ignoring." }
}
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) {
LKLog.i { "received close event: $reason, code: $code" }
reconnect()
}
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(leave: LivekitRtc.LeaveRequest) {
if (leave.canReconnect) {
// reconnect will be triggered on close.
fullReconnectOnNext = true
} else {
close()
val disconnectReason = leave.reason.convert()
listener?.onEngineDisconnected(disconnectReason)
}
}
// Signal error
override fun onError(error: Throwable) {
if (connectionState == ConnectionState.CONNECTING) {
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)
}
override fun onRefreshToken(token: String) {
sessionToken = token
}
override fun onLocalTrackUnpublished(trackUnpublished: LivekitRtc.TrackUnpublishedResponse) {
listener?.onLocalTrackUnpublished(trackUnpublished)
}
// --------------------------------- DataChannel.Observer ------------------------------------//
fun onBufferedAmountChange(dataChannel: DataChannel, previousAmount: Long) {
}
fun onStateChange(dataChannel: DataChannel) {
}
fun onMessage(dataChannel: DataChannel, buffer: DataChannel.Buffer?) {
if (buffer == null) {
return
}
val dp = LivekitModels.DataPacket.parseFrom(ByteString.copyFrom(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" }
}
}
}
private inner class DataChannelObserver(val dataChannel: DataChannel) : DataChannel.Observer {
override fun onBufferedAmountChange(p0: Long) {
this@RTCEngine.onBufferedAmountChange(dataChannel, p0)
}
override fun onStateChange() {
this@RTCEngine.onStateChange(dataChannel)
}
override fun onMessage(p0: DataChannel.Buffer) {
this@RTCEngine.onMessage(dataChannel, p0)
}
}
fun sendSyncState(
subscription: LivekitRtc.UpdateSubscription,
publishedTracks: List<LivekitRtc.TrackPublishedResponse>,
) {
val answer = runBlocking {
subscriber?.withPeerConnection { localDescription?.toProtoSessionDescription() }
}
val dataChannelInfos = LivekitModels.DataPacket.Kind.values()
.toList()
.mapNotNull { kind -> dataChannelForKind(kind) }
.map { dataChannel ->
LivekitRtc.DataChannelInfo.newBuilder()
.setId(dataChannel.id())
.setLabel(dataChannel.label())
.build()
}
val syncState = with(LivekitRtc.SyncState.newBuilder()) {
if (answer != null) {
setAnswer(answer)
}
setSubscription(subscription)
addAllPublishTracks(publishedTracks)
addAllDataChannels(dataChannelInfos)
build()
}
client.sendSyncState(syncState)
}
fun getPublisherRTCStats(callback: RTCStatsCollectorCallback) {
runBlocking {
publisher?.withPeerConnection { getStats(callback) }
?: callback.onStatsDelivered(RTCStatsReport(0, emptyMap()))
}
}
fun getSubscriberRTCStats(callback: RTCStatsCollectorCallback) {
runBlocking {
subscriber?.withPeerConnection { getStats(callback) }
?: callback.onStatsDelivered(RTCStatsReport(0, emptyMap()))
}
}
fun createStatsGetter(sender: RtpSender): RTCStatsGetter {
val p = publisher
return { statsCallback: RTCStatsCollectorCallback ->
runBlocking {
p?.withPeerConnection {
getStats(sender, statsCallback)
} ?: statsCallback.onStatsDelivered(RTCStatsReport(0, emptyMap()))
}
}
}
fun createStatsGetter(receiver: RtpReceiver): RTCStatsGetter {
val p = subscriber
return { statsCallback: RTCStatsCollectorCallback ->
runBlocking {
p?.withPeerConnection {
getStats(receiver, statsCallback)
} ?: statsCallback.onStatsDelivered(RTCStatsReport(0, emptyMap()))
}
}
}
internal fun registerTrackBitrateInfo(cid: String, trackBitrateInfo: TrackBitrateInfo) {
publisher?.registerTrackBitrateInfo(cid, trackBitrateInfo)
}
internal fun removeTrack(rtcTrack: MediaStreamTrack) {
runBlocking {
publisher?.withPeerConnection {
val senders = this.senders
for (sender in senders) {
val t = sender.track() ?: continue
if (t.id() == rtcTrack.id()) {
this@withPeerConnection.removeTrack(sender)
}
}
}
}
}
@VisibleForTesting
fun getPublisherPeerConnection() =
publisher!!.peerConnection
@VisibleForTesting
fun getSubscriberPeerConnection() =
subscriber!!.peerConnection
}
/**
* @suppress
*/
enum class ReconnectType {
DEFAULT,
FORCE_SOFT_RECONNECT,
FORCE_FULL_RECONNECT,
}
fun LivekitRtc.ICEServer.toWebrtc(): PeerConnection.IceServer = PeerConnection.IceServer.builder(urlsList)
.setUsername(username ?: "")
.setPassword(credential ?: "")
.setTlsAlpnProtocols(emptyList())
.setTlsEllipticCurves(emptyList())
.createIceServer()