SignalClient.kt
20.7 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
package io.livekit.android.room
import android.net.Uri
import com.google.protobuf.util.JsonFormat
import com.vdurmont.semver4j.Semver
import io.livekit.android.ConnectOptions
import io.livekit.android.Version
import io.livekit.android.dagger.InjectionNames
import io.livekit.android.room.participant.ParticipantTrackPermission
import io.livekit.android.room.track.Track
import io.livekit.android.stats.getClientInfo
import io.livekit.android.util.CloseableCoroutineScope
import io.livekit.android.util.Either
import io.livekit.android.util.LKLog
import io.livekit.android.util.safe
import io.livekit.android.webrtc.toProtoSessionDescription
import kotlinx.coroutines.*
import kotlinx.coroutines.flow.MutableSharedFlow
import kotlinx.serialization.decodeFromString
import kotlinx.serialization.encodeToString
import kotlinx.serialization.json.Json
import livekit.LivekitModels
import livekit.LivekitRtc
import okhttp3.*
import okio.ByteString
import okio.ByteString.Companion.toByteString
import org.webrtc.IceCandidate
import org.webrtc.PeerConnection
import org.webrtc.SessionDescription
import javax.inject.Inject
import javax.inject.Named
import javax.inject.Singleton
/**
* SignalClient to LiveKit WS servers
* @suppress
*/
@Singleton
class SignalClient
@Inject
constructor(
private val websocketFactory: WebSocket.Factory,
private val fromJsonProtobuf: JsonFormat.Parser,
private val toJsonProtobuf: JsonFormat.Printer,
private val json: Json,
private val okHttpClient: OkHttpClient,
@Named(InjectionNames.SIGNAL_JSON_ENABLED)
private val useJson: Boolean,
@Named(InjectionNames.DISPATCHER_IO)
private val ioDispatcher: CoroutineDispatcher,
) : WebSocketListener() {
var isConnected = false
private set
private var currentWs: WebSocket? = null
private var isReconnecting: Boolean = false
var listener: Listener? = null
private var serverVersion: Semver? = null
private var lastUrl: String? = null
private var joinContinuation: CancellableContinuation<Either<LivekitRtc.JoinResponse, Unit>>? = null
private lateinit var coroutineScope: CloseableCoroutineScope
private val responseFlow = MutableSharedFlow<LivekitRtc.SignalResponse>(Int.MAX_VALUE)
/**
* @throws Exception if fails to connect.
*/
suspend fun join(
url: String,
token: String,
options: ConnectOptions = ConnectOptions(),
): LivekitRtc.JoinResponse {
val joinResponse = connect(url, token, options)
return (joinResponse as Either.Left).value
}
/**
* @throws Exception if fails to connect.
*/
suspend fun reconnect(url: String, token: String) {
connect(
url,
token,
ConnectOptions()
.apply { reconnect = true }
)
}
suspend fun connect(
url: String,
token: String,
options: ConnectOptions
): Either<LivekitRtc.JoinResponse, Unit> {
val wsUrlString = "$url/rtc" + createConnectionParams(token, getClientInfo(), options)
isReconnecting = options.reconnect
LKLog.i { "connecting to $wsUrlString" }
// Clean up any pre-existing connection.
close()
coroutineScope = CloseableCoroutineScope(SupervisorJob() + ioDispatcher)
lastUrl = wsUrlString
val request = Request.Builder()
.url(wsUrlString)
.build()
currentWs = websocketFactory.newWebSocket(request, this)
return suspendCancellableCoroutine {
// Wait for join response through WebSocketListener
joinContinuation = it
}
}
private fun createConnectionParams(
token: String,
clientInfo: LivekitModels.ClientInfo,
options: ConnectOptions
): String {
val queryParams = mutableListOf<Pair<String, String>>()
queryParams.add(CONNECT_QUERY_TOKEN to token)
if (options.reconnect) {
queryParams.add(CONNECT_QUERY_RECONNECT to 1.toString())
}
val autoSubscribe = if(options.autoSubscribe) 1 else 0
queryParams.add(CONNECT_QUERY_AUTOSUBSCRIBE to autoSubscribe.toString())
// Client info
queryParams.add(CONNECT_QUERY_SDK to "android")
queryParams.add(CONNECT_QUERY_VERSION to clientInfo.version)
queryParams.add(CONNECT_QUERY_PROTOCOL to clientInfo.protocol.toString())
queryParams.add(CONNECT_QUERY_DEVICE_MODEL to clientInfo.deviceModel)
queryParams.add(CONNECT_QUERY_OS to clientInfo.os)
queryParams.add(CONNECT_QUERY_OS_VERSION to clientInfo.osVersion)
return queryParams.foldIndexed("") { index, acc, pair ->
val separator = if(index == 0) "?" else "&"
acc + separator + "${pair.first}=${pair.second}"
}
}
/**
* Notifies that the downstream consumers of SignalClient are ready to consume messages.
* Until this method is called, any messages received through the websocket are buffered.
*
* Should be called after resolving the join message.
*/
@OptIn(ExperimentalCoroutinesApi::class)
fun onReady() {
coroutineScope.launch {
responseFlow.collect {
responseFlow.resetReplayCache()
handleSignalResponseImpl(it)
}
}
}
//--------------------------------- WebSocket Listener --------------------------------------//
override fun onOpen(webSocket: WebSocket, response: Response) {
if (isReconnecting) {
// no need to wait for join response on reconnection.
isReconnecting = false
isConnected = true
joinContinuation?.resumeWith(Result.success(Either.Right(Unit)))
}
}
override fun onMessage(webSocket: WebSocket, text: String) {
val signalResponseBuilder = LivekitRtc.SignalResponse.newBuilder()
fromJsonProtobuf.merge(text, signalResponseBuilder)
val response = signalResponseBuilder.build()
handleSignalResponse(response)
}
override fun onMessage(webSocket: WebSocket, bytes: ByteString) {
val byteArray = bytes.toByteArray()
val signalResponseBuilder = LivekitRtc.SignalResponse.newBuilder()
.mergeFrom(byteArray)
val response = signalResponseBuilder.build()
handleSignalResponse(response)
}
override fun onClosed(webSocket: WebSocket, code: Int, reason: String) {
handleWebSocketClose(reason, code)
}
override fun onClosing(webSocket: WebSocket, code: Int, reason: String) {
LKLog.v { "websocket closing" }
}
override fun onFailure(webSocket: WebSocket, t: Throwable, response: Response?) {
var reason: String? = null
try {
lastUrl?.let {
val validationUrl = "http" + it.substring(2).replaceFirst("/rtc?", "/rtc/validate?")
val request = Request.Builder().url(validationUrl).build()
val resp = okHttpClient.newCall(request).execute()
if (!resp.isSuccessful) {
reason = resp.body?.string()
}
}
} catch (e: Throwable) {
LKLog.e(e) { "failed to validate connection" }
}
if (reason != null) {
LKLog.e(t) { "websocket failure: $reason" }
val error = Exception(reason)
listener?.onError(error)
joinContinuation?.cancel(error)
} else {
LKLog.e(t) { "websocket failure: $response" }
listener?.onError(t)
joinContinuation?.cancel(t)
}
val wasConnected = isConnected
isConnected = false
if (wasConnected) {
handleWebSocketClose(
reason = reason ?: response?.toString() ?: t.localizedMessage ?: "websocket failure",
code = response?.code ?: 500
)
}
}
private fun handleWebSocketClose(reason: String, code: Int) {
LKLog.v { "websocket closed" }
listener?.onClose(reason, code)
}
//------------------------------- End WebSocket Listener ------------------------------------//
private fun fromProtoSessionDescription(sd: LivekitRtc.SessionDescription): SessionDescription {
val rtcSdpType = when (sd.type) {
SD_TYPE_ANSWER -> SessionDescription.Type.ANSWER
SD_TYPE_OFFER -> SessionDescription.Type.OFFER
SD_TYPE_PRANSWER -> SessionDescription.Type.PRANSWER
else -> throw IllegalArgumentException("invalid RTC SdpType: ${sd.type}")
}
return SessionDescription(rtcSdpType, sd.sdp)
}
fun sendOffer(offer: SessionDescription) {
val sd = offer.toProtoSessionDescription()
val request = LivekitRtc.SignalRequest.newBuilder()
.setOffer(sd)
.build()
sendRequest(request)
}
fun sendAnswer(answer: SessionDescription) {
val sd = answer.toProtoSessionDescription()
val request = LivekitRtc.SignalRequest.newBuilder()
.setAnswer(sd)
.build()
sendRequest(request)
}
fun sendCandidate(candidate: IceCandidate, target: LivekitRtc.SignalTarget) {
val iceCandidateJSON = IceCandidateJSON(
candidate = candidate.sdp,
sdpMid = candidate.sdpMid,
sdpMLineIndex = candidate.sdpMLineIndex
)
val trickleRequest = LivekitRtc.TrickleRequest.newBuilder()
.setCandidateInit(json.encodeToString(iceCandidateJSON))
.setTarget(target)
.build()
val request = LivekitRtc.SignalRequest.newBuilder()
.setTrickle(trickleRequest)
.build()
sendRequest(request)
}
fun sendMuteTrack(trackSid: String, muted: Boolean) {
val muteRequest = LivekitRtc.MuteTrackRequest.newBuilder()
.setSid(trackSid)
.setMuted(muted)
.build()
val request = LivekitRtc.SignalRequest.newBuilder()
.setMute(muteRequest)
.build()
sendRequest(request)
}
/**
* @param builder an optional builder to include other parameters related to the track
*/
fun sendAddTrack(
cid: String,
name: String,
type: LivekitModels.TrackType,
builder: LivekitRtc.AddTrackRequest.Builder = LivekitRtc.AddTrackRequest.newBuilder()
) {
val addTrackRequest = builder
.setCid(cid)
.setName(name)
.setType(type)
val request = LivekitRtc.SignalRequest.newBuilder()
.setAddTrack(addTrackRequest)
.build()
sendRequest(request)
}
fun sendUpdateTrackSettings(
sid: String,
disabled: Boolean,
videoDimensions: Track.Dimensions?,
videoQuality: LivekitModels.VideoQuality?,
) {
val trackSettings = LivekitRtc.UpdateTrackSettings.newBuilder()
.addTrackSids(sid)
.setDisabled(disabled)
.apply {
if (videoDimensions != null) {
width = videoDimensions.width
height = videoDimensions.height
} else if (videoQuality != null) {
quality = videoQuality
} else {
// default to HIGH
quality = LivekitModels.VideoQuality.HIGH
}
}
val request = LivekitRtc.SignalRequest.newBuilder()
.setTrackSetting(trackSettings)
.build()
sendRequest(request)
}
fun sendUpdateSubscription(subscribe: Boolean, vararg participantTracks: LivekitModels.ParticipantTracks) {
val participantTracksList = participantTracks.toList()
// backwards compatibility for protocol version < 6
val trackSids = participantTracksList.map { it.trackSidsList }.flatten()
val subscription = LivekitRtc.UpdateSubscription.newBuilder()
.addAllParticipantTracks(participantTracks.toList())
.addAllTrackSids(trackSids)
.setSubscribe(subscribe)
val request = LivekitRtc.SignalRequest.newBuilder()
.setSubscription(subscription)
.build()
sendRequest(request)
}
fun sendUpdateSubscriptionPermissions(
allParticipants: Boolean,
participantTrackPermissions: List<ParticipantTrackPermission>
) {
val update = LivekitRtc.SubscriptionPermission.newBuilder()
.setAllParticipants(allParticipants)
.addAllTrackPermissions(participantTrackPermissions.map { it.toProto() })
val request = LivekitRtc.SignalRequest.newBuilder()
.setSubscriptionPermission(update)
.build()
sendRequest(request)
}
fun sendSyncState(syncState: LivekitRtc.SyncState) {
val request = LivekitRtc.SignalRequest.newBuilder()
.setSyncState(syncState)
.build()
sendRequest(request)
}
internal fun sendSimulateScenario(scenario: LivekitRtc.SimulateScenario) {
val request = LivekitRtc.SignalRequest.newBuilder()
.setSimulate(scenario)
.build()
sendRequest(request)
}
fun sendLeave() {
val request = LivekitRtc.SignalRequest.newBuilder()
.setLeave(LivekitRtc.LeaveRequest.newBuilder().build())
.build()
sendRequest(request)
}
private fun sendRequest(request: LivekitRtc.SignalRequest) {
LKLog.v { "sending request: $request" }
if (!isConnected || currentWs == null) {
LKLog.w { "not connected, could not send request $request" }
return
}
val sent: Boolean
if (useJson) {
val message = toJsonProtobuf.print(request)
sent = currentWs?.send(message) ?: false
} else {
val message = request.toByteArray().toByteString()
sent = currentWs?.send(message) ?: false
}
if (!sent) {
LKLog.e { "error sending request: $request" }
}
}
private fun handleSignalResponse(response: LivekitRtc.SignalResponse) {
LKLog.v { "response: $response" }
if (!isConnected) {
// Only handle joins if not connected.
if (response.hasJoin()) {
isConnected = true
try {
serverVersion = Semver(response.join.serverVersion)
} catch (t: Throwable) {
LKLog.w(t) { "Thrown while trying to parse server version." }
}
joinContinuation?.resumeWith(Result.success(Either.Left(response.join)))
} else {
LKLog.e { "Received response while not connected. ${toJsonProtobuf.print(response)}" }
}
return
}
coroutineScope.launch {
responseFlow.tryEmit(response)
}
}
private fun handleSignalResponseImpl(response: LivekitRtc.SignalResponse) {
when (response.messageCase) {
LivekitRtc.SignalResponse.MessageCase.ANSWER -> {
val sd = fromProtoSessionDescription(response.answer)
listener?.onAnswer(sd)
}
LivekitRtc.SignalResponse.MessageCase.OFFER -> {
val sd = fromProtoSessionDescription(response.offer)
listener?.onOffer(sd)
}
LivekitRtc.SignalResponse.MessageCase.TRICKLE -> {
val iceCandidateJson =
json.decodeFromString<IceCandidateJSON>(response.trickle.candidateInit)
val iceCandidate = IceCandidate(
iceCandidateJson.sdpMid,
iceCandidateJson.sdpMLineIndex,
iceCandidateJson.candidate
)
listener?.onTrickle(iceCandidate, response.trickle.target)
}
LivekitRtc.SignalResponse.MessageCase.UPDATE -> {
listener?.onParticipantUpdate(response.update.participantsList)
}
LivekitRtc.SignalResponse.MessageCase.TRACK_PUBLISHED -> {
listener?.onLocalTrackPublished(response.trackPublished)
}
LivekitRtc.SignalResponse.MessageCase.SPEAKERS_CHANGED -> {
listener?.onSpeakersChanged(response.speakersChanged.speakersList)
}
LivekitRtc.SignalResponse.MessageCase.JOIN -> {
LKLog.d { "received unexpected extra join message?" }
}
LivekitRtc.SignalResponse.MessageCase.LEAVE -> {
listener?.onLeave(response.leave)
}
LivekitRtc.SignalResponse.MessageCase.MUTE -> {
listener?.onRemoteMuteChanged(response.mute.sid, response.mute.muted)
}
LivekitRtc.SignalResponse.MessageCase.ROOM_UPDATE -> {
listener?.onRoomUpdate(response.roomUpdate.room)
}
LivekitRtc.SignalResponse.MessageCase.CONNECTION_QUALITY -> {
listener?.onConnectionQuality(response.connectionQuality.updatesList)
}
LivekitRtc.SignalResponse.MessageCase.STREAM_STATE_UPDATE -> {
listener?.onStreamStateUpdate(response.streamStateUpdate.streamStatesList)
}
LivekitRtc.SignalResponse.MessageCase.SUBSCRIBED_QUALITY_UPDATE -> {
val versionToIgnoreUpTo = Semver("0.15.1")
if (serverVersion?.compareTo(versionToIgnoreUpTo) ?: 1 <= 0) {
return
}
listener?.onSubscribedQualityUpdate(response.subscribedQualityUpdate)
}
LivekitRtc.SignalResponse.MessageCase.SUBSCRIPTION_PERMISSION_UPDATE -> {
listener?.onSubscriptionPermissionUpdate(response.subscriptionPermissionUpdate)
}
LivekitRtc.SignalResponse.MessageCase.REFRESH_TOKEN -> {
listener?.onRefreshToken(response.refreshToken)
}
LivekitRtc.SignalResponse.MessageCase.MESSAGE_NOT_SET,
null -> {
LKLog.v { "empty messageCase!" }
}
}.safe()
}
/**
* Closes out any existing websocket connection, and cleans up used resources.
*
* Can be reused afterwards.
*/
fun close(code: Int = 1000, reason: String = "Normal Closure") {
isConnected = false
if (::coroutineScope.isInitialized) {
coroutineScope.close()
}
currentWs?.close(code, reason)
currentWs = null
joinContinuation?.cancel()
joinContinuation = null
}
interface Listener {
fun onAnswer(sessionDescription: SessionDescription)
fun onOffer(sessionDescription: SessionDescription)
fun onTrickle(candidate: IceCandidate, target: LivekitRtc.SignalTarget)
fun onLocalTrackPublished(response: LivekitRtc.TrackPublishedResponse)
fun onParticipantUpdate(updates: List<LivekitModels.ParticipantInfo>)
fun onSpeakersChanged(speakers: List<LivekitModels.SpeakerInfo>)
fun onClose(reason: String, code: Int)
fun onRemoteMuteChanged(trackSid: String, muted: Boolean)
fun onRoomUpdate(update: LivekitModels.Room)
fun onConnectionQuality(updates: List<LivekitRtc.ConnectionQualityInfo>)
fun onLeave(leave: LivekitRtc.LeaveRequest)
fun onError(error: Throwable)
fun onStreamStateUpdate(streamStates: List<LivekitRtc.StreamStateInfo>)
fun onSubscribedQualityUpdate(subscribedQualityUpdate: LivekitRtc.SubscribedQualityUpdate)
fun onSubscriptionPermissionUpdate(subscriptionPermissionUpdate: LivekitRtc.SubscriptionPermissionUpdate)
fun onRefreshToken(token: String)
}
companion object {
const val CONNECT_QUERY_TOKEN = "access_token"
const val CONNECT_QUERY_RECONNECT = "reconnect"
const val CONNECT_QUERY_AUTOSUBSCRIBE = "autoSubscribe"
const val CONNECT_QUERY_SDK = "sdk"
const val CONNECT_QUERY_VERSION = "version"
const val CONNECT_QUERY_PROTOCOL = "protocol"
const val CONNECT_QUERY_DEVICE_MODEL = "device_model"
const val CONNECT_QUERY_OS = "os"
const val CONNECT_QUERY_OS_VERSION = "os_version"
const val SD_TYPE_ANSWER = "answer"
const val SD_TYPE_OFFER = "offer"
const val SD_TYPE_PRANSWER = "pranswer"
const val PROTOCOL_VERSION = 5
const val SDK_TYPE = "android"
private fun iceServer(url: String) =
PeerConnection.IceServer.builder(url).createIceServer()
// more stun servers might slow it down, WebRTC recommends 3 max
val DEFAULT_ICE_SERVERS = listOf(
iceServer("stun:stun.l.google.com:19302"),
iceServer("stun:stun1.l.google.com:19302"),
// iceServer("stun:stun2.l.google.com:19302"),
// iceServer("stun:stun3.l.google.com:19302"),
// iceServer("stun:stun4.l.google.com:19302"),
)
}
}