-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
JingleSessionPC.js
2399 lines (2101 loc) · 90.4 KB
/
JingleSessionPC.js
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
/* global __filename, $ */
import {
ICE_DURATION,
ICE_STATE_CHANGED
} from '../../service/statistics/AnalyticsEvents';
import { getLogger } from 'jitsi-meet-logger';
import { $iq, Strophe } from 'strophe.js';
import { integerHash } from '../util/StringUtils';
import browser from './../browser';
import JingleSession from './JingleSession';
import * as JingleSessionState from './JingleSessionState';
import SDP from './SDP';
import SDPDiffer from './SDPDiffer';
import SDPUtil from './SDPUtil';
import SignalingLayerImpl from './SignalingLayerImpl';
import RTCEvents from '../../service/RTC/RTCEvents';
import Statistics from '../statistics/statistics';
import XMPPEvents from '../../service/xmpp/XMPPEvents';
import AsyncQueue from '../util/AsyncQueue';
import GlobalOnErrorHandler from '../util/GlobalOnErrorHandler';
import XmppConnection from './XmppConnection';
const logger = getLogger(__filename);
/**
* Constant tells how long we're going to wait for IQ response, before timeout
* error is triggered.
* @type {number}
*/
const IQ_TIMEOUT = 10000;
/*
* The default number of samples (per stat) to keep when webrtc stats gathering
* is enabled in TraceablePeerConnection.
*/
const DEFAULT_MAX_STATS = 300;
/**
* @typedef {Object} JingleSessionPCOptions
* @property {Object} abTesting - A/B testing related options (ask George).
* @property {boolean} abTesting.enableSuspendVideoTest - enables the suspend
* video test ?(ask George).
* @property {boolean} disableH264 - Described in the config.js[1].
* @property {boolean} disableRtx - Described in the config.js[1].
* @property {boolean} disableSimulcast - Described in the config.js[1].
* @property {boolean} enableLayerSuspension - Described in the config.js[1].
* @property {boolean} failICE - it's an option used in the tests. Set to
* <tt>true</tt> to block any real candidates and make the ICE fail.
* @property {boolean} gatherStats - Described in the config.js[1].
* @property {object} p2p - Peer to peer related options (FIXME those could be
* fetched from config.p2p on the upper level).
* @property {boolean} p2p.disableH264 - Described in the config.js[1].
* @property {boolean} p2p.preferH264 - Described in the config.js[1].
* @property {boolean} preferH264 - Described in the config.js[1].
* @property {Object} testing - Testing and/or experimental options.
* @property {boolean} webrtcIceUdpDisable - Described in the config.js[1].
* @property {boolean} webrtcIceTcpDisable - Described in the config.js[1].
*
* [1]: https://github.com/jitsi/jitsi-meet/blob/master/config.js
*/
/**
*
*/
export default class JingleSessionPC extends JingleSession {
/**
* Parses 'senders' attribute of the video content.
* @param {jQuery} jingleContents
* @return {string|null} one of the values of content "senders" attribute
* defined by Jingle. If there is no "senders" attribute or if the value is
* invalid then <tt>null</tt> will be returned.
* @private
*/
static parseVideoSenders(jingleContents) {
const videoContents = jingleContents.find('>content[name="video"]');
if (videoContents.length) {
const senders = videoContents[0].getAttribute('senders');
if (senders === 'both'
|| senders === 'initiator'
|| senders === 'responder'
|| senders === 'none') {
return senders;
}
}
return null;
}
/* eslint-disable max-params */
/**
* Creates new <tt>JingleSessionPC</tt>
* @param {string} sid the Jingle Session ID - random string which
* identifies the session
* @param {string} localJid our JID
* @param {string} remoteJid remote peer JID
* @param {XmppConnection} connection - The XMPP connection instance.
* @param mediaConstraints the media constraints object passed to
* createOffer/Answer, as defined by the WebRTC standard
* @param iceConfig the ICE servers config object as defined by the WebRTC
* standard.
* @param {boolean} isP2P indicates whether this instance is
* meant to be used in a direct, peer to peer connection or <tt>false</tt>
* if it's a JVB connection.
* @param {boolean} isInitiator indicates if it will be the side which
* initiates the session.
* @constructor
*
* @implements {SignalingLayer}
*/
constructor(
sid,
localJid,
remoteJid,
connection,
mediaConstraints,
iceConfig,
isP2P,
isInitiator) {
super(
sid,
localJid,
remoteJid, connection, mediaConstraints, iceConfig, isInitiator);
/**
* The bridge session's identifier. One Jingle session can during
* it's lifetime participate in multiple bridge sessions managed by
* Jicofo. A new bridge session is started whenever Jicofo sends
* 'session-initiate' or 'transport-replace'.
*
* @type {?string}
* @private
*/
this._bridgeSessionId = null;
/**
* The oldest SDP passed to {@link notifyMySSRCUpdate} while the XMPP connection was offline that will be
* used to update Jicofo once the XMPP connection goes back online.
* @type {SDP|undefined}
* @private
*/
this._cachedOldLocalSdp = undefined;
/**
* The latest SDP passed to {@link notifyMySSRCUpdate} while the XMPP connection was offline that will be
* used to update Jicofo once the XMPP connection goes back online.
* @type {SDP|undefined}
* @private
*/
this._cachedNewLocalSdp = undefined;
/**
* Stores result of {@link window.performance.now()} at the time when
* ICE enters 'checking' state.
* @type {number|null} null if no value has been stored yet
* @private
*/
this._iceCheckingStartedTimestamp = null;
/**
* Stores result of {@link window.performance.now()} at the time when
* first ICE candidate is spawned by the peerconnection to mark when
* ICE gathering started. That's, because ICE gathering state changed
* events are not supported by most of the browsers, so we try something
* that will work everywhere. It may not be as accurate, but given that
* 'host' candidate usually comes first, the delay should be minimal.
* @type {number|null} null if no value has been stored yet
* @private
*/
this._gatheringStartedTimestamp = null;
/**
* Indicates whether or not this session is willing to send/receive
* video media. When set to <tt>false</tt> the underlying peer
* connection will disable local video transfer and the remote peer will
* be will be asked to stop sending video via 'content-modify' IQ
* (the senders attribute of video contents will be adjusted
* accordingly). Note that this notification is sent only in P2P
* session, because Jicofo does not support it yet. Obviously when
* the value is changed from <tt>false</tt> to <tt>true</tt> another
* notification will be sent to resume video transfer on the remote
* side.
* @type {boolean}
* @private
*/
this._localVideoActive = true;
/**
* Indicates whether or not the remote peer has video transfer active.
* When set to <tt>true</tt> it means that remote peer is neither
* sending nor willing to receive video. In such case we'll ask
* our peerconnection to stop sending video by calling
* {@link TraceablePeerConnection.setVideoTransferActive} with
* <tt>false</tt>.
* @type {boolean}
* @private
*/
this._remoteVideoActive = true;
/**
* Marks that ICE gathering duration has been reported already. That
* prevents reporting it again, after eventual 'transport-replace' (JVB
* conference migration/ICE restart).
* @type {boolean}
* @private
*/
this._gatheringReported = false;
this.lasticecandidate = false;
this.closed = false;
/**
* Indicates whether or not this <tt>JingleSessionPC</tt> is used in
* a peer to peer type of session.
* @type {boolean} <tt>true</tt> if it's a peer to peer
* session or <tt>false</tt> if it's a JVB session
*/
this.isP2P = isP2P;
/**
* The signaling layer implementation.
* @type {SignalingLayerImpl}
*/
this.signalingLayer = new SignalingLayerImpl();
/**
* The queue used to serialize operations done on the peerconnection.
*
* @type {AsyncQueue}
*/
this.modificationQueue = new AsyncQueue();
/**
* Flag used to guarantee that the connection established event is
* triggered just once.
* @type {boolean}
*/
this.wasConnected = false;
/**
* Keeps track of how long (in ms) it took from ICE start to ICE
* connect.
*
* @type {number}
*/
this.establishmentDuration = undefined;
this._xmppListeners = [];
this._xmppListeners.push(
connection.addEventListener(
XmppConnection.Events.CONN_STATUS_CHANGED,
this.onXmppStatusChanged.bind(this))
);
}
/* eslint-enable max-params */
/**
* Checks whether or not this session instance is still operational.
* @private
* @returns {boolean} {@code true} if operation or {@code false} otherwise.
*/
_assertNotEnded() {
return this.state !== JingleSessionState.ENDED;
}
/**
* @inheritDoc
* @param {JingleSessionPCOptions} options - a set of config options.
*/
doInitialize(options) {
this.failICE = Boolean(options.failICE);
this.lasticecandidate = false;
this.options = options;
/**
* {@code true} if reconnect is in progress.
* @type {boolean}
*/
this.isReconnect = false;
/**
* Set to {@code true} if the connection was ever stable
* @type {boolean}
*/
this.wasstable = false;
this.webrtcIceUdpDisable = Boolean(options.webrtcIceUdpDisable);
this.webrtcIceTcpDisable = Boolean(options.webrtcIceTcpDisable);
const pcOptions = { disableRtx: options.disableRtx };
if (options.gatherStats) {
pcOptions.maxstats = DEFAULT_MAX_STATS;
}
pcOptions.capScreenshareBitrate = false;
if (this.isP2P) {
// simulcast needs to be disabled for P2P (121) calls
pcOptions.disableSimulcast = true;
pcOptions.disableH264 = options.p2p && options.p2p.disableH264;
pcOptions.preferH264 = options.p2p && options.p2p.preferH264;
const abtestSuspendVideo = this._abtestSuspendVideoEnabled(options);
if (typeof abtestSuspendVideo !== 'undefined') {
pcOptions.abtestSuspendVideo = abtestSuspendVideo;
}
} else {
// H264 does not support simulcast, so it needs to be disabled.
pcOptions.disableSimulcast
= options.disableSimulcast
|| (options.preferH264 && !options.disableH264);
pcOptions.preferH264 = options.preferH264;
pcOptions.enableLayerSuspension = options.enableLayerSuspension;
// disable simulcast for screenshare and set the max bitrate to
// 500Kbps if the testing flag is present in config.js.
if (options.testing
&& options.testing.capScreenshareBitrate
&& typeof options.testing.capScreenshareBitrate === 'number') {
pcOptions.capScreenshareBitrate
= Math.random()
< options.testing.capScreenshareBitrate;
// add the capScreenshareBitrate to the permanent properties so
// that it's included with every event that we send to the
// analytics backend.
Statistics.analytics.addPermanentProperties({ capScreenshareBitrate: pcOptions.capScreenshareBitrate });
}
}
if (options.startSilent) {
pcOptions.startSilent = true;
}
this.peerconnection
= this.rtc.createPeerConnection(
this.signalingLayer,
this.iceConfig,
this.isP2P,
pcOptions);
this.peerconnection.onicecandidate = ev => {
if (!ev) {
// There was an incomplete check for ev before which left
// the last line of the function unprotected from a potential
// throw of an exception. Consequently, it may be argued that
// the check is unnecessary. Anyway, I'm leaving it and making
// the check complete.
return;
}
// XXX this is broken, candidate is not parsed.
const candidate = ev.candidate;
const now = window.performance.now();
if (candidate) {
if (this._gatheringStartedTimestamp === null) {
this._gatheringStartedTimestamp = now;
}
// Discard candidates of disabled protocols.
let protocol = candidate.protocol;
if (typeof protocol === 'string') {
protocol = protocol.toLowerCase();
if (protocol === 'tcp' || protocol === 'ssltcp') {
if (this.webrtcIceTcpDisable) {
return;
}
} else if (protocol === 'udp') {
if (this.webrtcIceUdpDisable) {
return;
}
}
}
} else if (!this._gatheringReported) {
// End of gathering
Statistics.sendAnalytics(
ICE_DURATION,
{
phase: 'gathering',
value: now - this._gatheringStartedTimestamp,
p2p: this.isP2P,
initiator: this.isInitiator
});
this._gatheringReported = true;
}
this.sendIceCandidate(candidate);
};
// Note there is a change in the spec about closed:
// This value moved into the RTCPeerConnectionState enum in
// the May 13, 2016 draft of the specification, as it reflects the state
// of the RTCPeerConnection, not the signaling connection. You now
// detect a closed connection by checking for connectionState to be
// "closed" instead.
// I suppose at some point this will be moved to onconnectionstatechange
this.peerconnection.onsignalingstatechange = () => {
if (this.peerconnection.signalingState === 'stable') {
this.wasstable = true;
} else if (this.peerconnection.signalingState === 'closed'
|| this.peerconnection.connectionState === 'closed') {
this.room.eventEmitter.emit(XMPPEvents.SUSPEND_DETECTED, this);
}
};
/**
* The oniceconnectionstatechange event handler contains the code to
* execute when the iceconnectionstatechange event, of type Event,
* is received by this RTCPeerConnection. Such an event is sent when
* the value of RTCPeerConnection.iceConnectionState changes.
*/
this.peerconnection.oniceconnectionstatechange = () => {
const now = window.performance.now();
if (!this.isP2P) {
this.room.connectionTimes[
`ice.state.${this.peerconnection.iceConnectionState}`]
= now;
}
logger.log(
`(TIME) ICE ${this.peerconnection.iceConnectionState}`
+ ` P2P? ${this.isP2P}:\t`,
now);
Statistics.sendAnalytics(
ICE_STATE_CHANGED,
{
p2p: this.isP2P,
state: this.peerconnection.iceConnectionState,
'signaling_state': this.peerconnection.signalingState,
reconnect: this.isReconnect,
value: now
});
this.room.eventEmitter.emit(
XMPPEvents.ICE_CONNECTION_STATE_CHANGED,
this,
this.peerconnection.iceConnectionState);
switch (this.peerconnection.iceConnectionState) {
case 'checking':
this._iceCheckingStartedTimestamp = now;
break;
case 'connected':
// Informs interested parties that the connection has been
// restored.
if (this.peerconnection.signalingState === 'stable') {
if (this.isReconnect) {
this.room.eventEmitter.emit(
XMPPEvents.CONNECTION_RESTORED, this);
}
}
if (!this.wasConnected && this.wasstable) {
Statistics.sendAnalytics(
ICE_DURATION,
{
phase: 'checking',
value: now - this._iceCheckingStartedTimestamp,
p2p: this.isP2P,
initiator: this.isInitiator
});
// Switch between ICE gathering and ICE checking whichever
// started first (scenarios are different for initiator
// vs responder)
const iceStarted
= Math.min(
this._iceCheckingStartedTimestamp,
this._gatheringStartedTimestamp);
this.establishmentDuration = now - iceStarted;
Statistics.sendAnalytics(
ICE_DURATION,
{
phase: 'establishment',
value: this.establishmentDuration,
p2p: this.isP2P,
initiator: this.isInitiator
});
this.wasConnected = true;
this.room.eventEmitter.emit(
XMPPEvents.CONNECTION_ESTABLISHED, this);
}
this.isReconnect = false;
break;
case 'disconnected':
this.isReconnect = true;
// Informs interested parties that the connection has been
// interrupted.
if (this.wasstable) {
this.room.eventEmitter.emit(
XMPPEvents.CONNECTION_INTERRUPTED, this);
}
break;
case 'failed':
this.room.eventEmitter.emit(
XMPPEvents.CONNECTION_ICE_FAILED, this);
break;
}
};
/**
* The negotiationneeded event is fired whenever we shake the media on the
* RTCPeerConnection object.
*/
this.peerconnection.onnegotiationneeded = () => {
const state = this.peerconnection.signalingState;
const remoteDescription = this.peerconnection.remoteDescription;
this.room.eventEmitter.emit(XMPPEvents.PEERCONNECTION_READY, this);
if (browser.usesUnifiedPlan() && state === 'stable'
&& remoteDescription && typeof remoteDescription.sdp === 'string') {
logger.debug(`onnegotiationneeded fired on ${this.peerconnection} in state: ${state}`);
const workFunction = finishedCallback => {
const oldSdp = new SDP(this.peerconnection.localDescription.sdp);
this._renegotiate()
.then(() => {
const newSdp = new SDP(this.peerconnection.localDescription.sdp);
this.notifyMySSRCUpdate(oldSdp, newSdp);
finishedCallback();
},
finishedCallback /* will be called with en error */);
};
this.modificationQueue.push(
workFunction,
error => {
if (error) {
logger.error('onnegotiationneeded error', error);
} else {
logger.debug('onnegotiationneeded executed - OK');
}
});
}
};
// The signaling layer will bind it's listeners at this point
this.signalingLayer.setChatRoom(this.room);
if (!this.isP2P && options.enableLayerSuspension) {
// If this is the bridge session, we'll listen for
// IS_SELECTED_CHANGED events and notify the peer connection
this.rtc.addListener(RTCEvents.IS_SELECTED_CHANGED,
isSelected => {
this.peerconnection.setIsSelected(isSelected);
logger.info('Doing local O/A due to '
+ 'IS_SELECTED_CHANGED event');
this.modificationQueue.push(finishedCallback => {
this._renegotiate()
.then(finishedCallback)
.catch(finishedCallback);
});
}
);
}
}
/**
* Sends given candidate in Jingle 'transport-info' message.
* @param {RTCIceCandidate} candidate the WebRTC ICE candidate instance
* @private
*/
sendIceCandidate(candidate) {
const localSDP = new SDP(this.peerconnection.localDescription.sdp);
if (candidate && candidate.candidate.length && !this.lasticecandidate) {
const ice
= SDPUtil.iceparams(
localSDP.media[candidate.sdpMLineIndex], localSDP.session);
const jcand = SDPUtil.candidateToJingle(candidate.candidate);
if (!(ice && jcand)) {
const errorMesssage = 'failed to get ice && jcand';
GlobalOnErrorHandler.callErrorHandler(new Error(errorMesssage));
logger.error(errorMesssage);
return;
}
ice.xmlns = 'urn:xmpp:jingle:transports:ice-udp:1';
if (this.usedrip) {
if (this.dripContainer.length === 0) {
// start 20ms callout
setTimeout(() => {
if (this.dripContainer.length === 0) {
return;
}
this.sendIceCandidates(this.dripContainer);
this.dripContainer = [];
}, 20);
}
this.dripContainer.push(candidate);
} else {
this.sendIceCandidates([ candidate ]);
}
} else {
logger.log('sendIceCandidate: last candidate.');
// FIXME: remember to re-think in ICE-restart
this.lasticecandidate = true;
}
}
/**
* Sends given candidates in Jingle 'transport-info' message.
* @param {Array<RTCIceCandidate>} candidates an array of the WebRTC ICE
* candidate instances
* @private
*/
sendIceCandidates(candidates) {
if (!this._assertNotEnded('sendIceCandidates')) {
return;
}
logger.log('sendIceCandidates', candidates);
const cand = $iq({ to: this.remoteJid,
type: 'set' })
.c('jingle', { xmlns: 'urn:xmpp:jingle:1',
action: 'transport-info',
initiator: this.initiatorJid,
sid: this.sid });
const localSDP = new SDP(this.peerconnection.localDescription.sdp);
for (let mid = 0; mid < localSDP.media.length; mid++) {
const cands = candidates.filter(el => el.sdpMLineIndex === mid);
const mline
= SDPUtil.parseMLine(localSDP.media[mid].split('\r\n')[0]);
if (cands.length > 0) {
const ice
= SDPUtil.iceparams(localSDP.media[mid], localSDP.session);
ice.xmlns = 'urn:xmpp:jingle:transports:ice-udp:1';
cand.c('content', {
creator: this.initiatorJid === this.localJid
? 'initiator' : 'responder',
name: cands[0].sdpMid ? cands[0].sdpMid : mline.media
}).c('transport', ice);
for (let i = 0; i < cands.length; i++) {
const candidate
= SDPUtil.candidateToJingle(cands[i].candidate);
// Mangle ICE candidate if 'failICE' test option is enabled
if (this.failICE) {
candidate.ip = '1.1.1.1';
}
cand.c('candidate', candidate).up();
}
// add fingerprint
const fingerprintLine
= SDPUtil.findLine(
localSDP.media[mid],
'a=fingerprint:', localSDP.session);
if (fingerprintLine) {
const tmp = SDPUtil.parseFingerprint(fingerprintLine);
tmp.required = true;
cand.c(
'fingerprint',
{ xmlns: 'urn:xmpp:jingle:apps:dtls:0' })
.t(tmp.fingerprint);
delete tmp.fingerprint;
cand.attrs(tmp);
cand.up();
}
cand.up(); // transport
cand.up(); // content
}
}
// might merge last-candidate notification into this, but it is called
// a lot later. See webrtc issue #2340
// logger.log('was this the last candidate', this.lasticecandidate);
this.connection.sendIQ(
cand, null, this.newJingleErrorHandler(cand), IQ_TIMEOUT);
}
/**
* Sends Jingle 'session-info' message which includes custom Jitsi Meet
* 'ice-state' element with the text value 'failed' to let Jicofo know
* that the ICE connection has entered the failed state. It can then
* choose to re-create JVB channels and send 'transport-replace' to
* retry the connection.
*/
sendIceFailedNotification() {
const sessionInfo
= $iq({
to: this.remoteJid,
type: 'set' })
.c('jingle', { xmlns: 'urn:xmpp:jingle:1',
action: 'session-info',
initiator: this.initiatorJid,
sid: this.sid })
.c('ice-state', { xmlns: 'http://jitsi.org/protocol/focus' })
.t('failed')
.up();
this._bridgeSessionId
&& sessionInfo.c(
'bridge-session', {
xmlns: 'http://jitsi.org/protocol/focus',
id: this._bridgeSessionId
});
this.connection.sendIQ2(
sessionInfo, {
/*
* This message will be often sent when there are connectivity
* issues, so make it slightly longer than Prosody's default BOSH
* inactivity timeout of 60 seconds.
*/
timeout: 65
})
.catch(this.newJingleErrorHandler(sessionInfo));
}
/**
* {@inheritDoc}
*/
addIceCandidates(elem) {
if (this.peerconnection.signalingState === 'closed') {
logger.warn('Ignored add ICE candidate when in closed state');
return;
}
const iceCandidates = [];
elem.find('>content>transport>candidate')
.each((idx, candidate) => {
let line = SDPUtil.candidateFromJingle(candidate);
line = line.replace('\r\n', '').replace('a=', '');
// FIXME this code does not care to handle
// non-bundle transport
const rtcCandidate = new RTCIceCandidate({
sdpMLineIndex: 0,
// FF comes up with more complex names like audio-23423,
// Given that it works on both Chrome and FF without
// providing it, let's leave it like this for the time
// being...
// sdpMid: 'audio',
sdpMid: '',
candidate: line
});
iceCandidates.push(rtcCandidate);
});
if (!iceCandidates.length) {
logger.error(
'No ICE candidates to add ?', elem[0] && elem[0].outerHTML);
return;
}
// We want to have this task queued, so that we know it is executed,
// after the initial sRD/sLD offer/answer cycle was done (based on
// the assumption that candidates are spawned after the offer/answer
// and XMPP preserves order).
const workFunction = finishedCallback => {
for (const iceCandidate of iceCandidates) {
this.peerconnection.addIceCandidate(iceCandidate)
.then(
() => logger.debug('addIceCandidate ok!'),
err => logger.error('addIceCandidate failed!', err));
}
finishedCallback();
};
logger.debug(
`Queued add (${iceCandidates.length}) ICE candidates task...`);
this.modificationQueue.push(workFunction);
}
/**
*
* @param contents
*/
readSsrcInfo(contents) {
const ssrcs
= $(contents).find(
'>description>'
+ 'source[xmlns="urn:xmpp:jingle:apps:rtp:ssma:0"]');
ssrcs.each((i, ssrcElement) => {
const ssrc = Number(ssrcElement.getAttribute('ssrc'));
if (this.isP2P) {
// In P2P all SSRCs are owner by the remote peer
this.signalingLayer.setSSRCOwner(
ssrc, Strophe.getResourceFromJid(this.remoteJid));
} else {
$(ssrcElement)
.find('>ssrc-info[xmlns="http://jitsi.org/jitmeet"]')
.each((i3, ssrcInfoElement) => {
const owner = ssrcInfoElement.getAttribute('owner');
if (owner && owner.length) {
if (isNaN(ssrc) || ssrc < 0) {
logger.warn(
`Invalid SSRC ${ssrc} value received`
+ ` for ${owner}`);
} else {
this.signalingLayer.setSSRCOwner(
ssrc,
Strophe.getResourceFromJid(owner));
}
}
});
}
});
}
/**
* Makes the underlying TraceablePeerConnection generate new SSRC for
* the recvonly video stream.
* @deprecated
*/
generateRecvonlySsrc() {
if (this.peerconnection) {
this.peerconnection.generateRecvonlySsrc();
} else {
logger.error(
'Unable to generate recvonly SSRC - no peerconnection');
}
}
/* eslint-disable max-params */
/**
* Accepts incoming Jingle 'session-initiate' and should send
* 'session-accept' in result.
* @param jingleOffer jQuery selector pointing to the jingle element of
* the offer IQ
* @param success callback called when we accept incoming session
* successfully and receive RESULT packet to 'session-accept' sent.
* @param failure function(error) called if for any reason we fail to accept
* the incoming offer. 'error' argument can be used to log some details
* about the error.
* @param {Array<JitsiLocalTrack>} [localTracks] the optional list of
* the local tracks that will be added, before the offer/answer cycle
* executes. We allow the localTracks to optionally be passed in so that
* the addition of the local tracks and the processing of the initial offer
* can all be done atomically. We want to make sure that any other
* operations which originate in the XMPP Jingle messages related with
* this session to be executed with an assumption that the initial
* offer/answer cycle has been executed already.
*/
acceptOffer(jingleOffer, success, failure, localTracks) {
this.setOfferAnswerCycle(
jingleOffer,
() => {
// FIXME we may not care about RESULT packet for session-accept
// then we should either call 'success' here immediately or
// modify sendSessionAccept method to do that
this.sendSessionAccept(success, failure);
},
failure,
localTracks);
}
/* eslint-enable max-params */
/**
* Creates an offer and sends Jingle 'session-initiate' to the remote peer.
* @param {Array<JitsiLocalTrack>} localTracks the local tracks that will be
* added, before the offer/answer cycle executes (for the local track
* addition to be an atomic operation together with the offer/answer).
*/
invite(localTracks) {
if (!this.isInitiator) {
throw new Error('Trying to invite from the responder session');
}
const workFunction = finishedCallback => {
for (const localTrack of localTracks) {
this.peerconnection.addTrack(localTrack, true /* isInitiator */);
}
this.peerconnection.createOffer(this.mediaConstraints)
.then(offerSdp => {
this.peerconnection.setLocalDescription(offerSdp)
.then(() => {
// NOTE that the offer is obtained from
// the localDescription getter as it needs to go
// though the transformation chain.
this.sendSessionInitiate(
this.peerconnection.localDescription.sdp);
finishedCallback();
}, error => {
logger.error(
'Failed to set local SDP', error, offerSdp);
finishedCallback(error);
});
}, error => {
logger.error(
'Failed to create an offer',
error,
this.mediaConstraints);
finishedCallback(error);
});
};
this.modificationQueue.push(
workFunction,
error => {
if (error) {
logger.error('invite error', error);
} else {
logger.debug('invite executed - OK');
}
});
}
/**
* Sends 'session-initiate' to the remote peer.
*
* NOTE this method is synchronous and we're not waiting for the RESULT
* response which would delay the startup process.
*
* @param {string} offerSdp - The local session description which will be
* used to generate an offer.
* @private
*/
sendSessionInitiate(offerSdp) {
let init = $iq({
to: this.remoteJid,
type: 'set'
}).c('jingle', {
xmlns: 'urn:xmpp:jingle:1',
action: 'session-initiate',
initiator: this.initiatorJid,
sid: this.sid
});
new SDP(offerSdp).toJingle(
init,
this.isInitiator ? 'initiator' : 'responder');
init = init.tree();
logger.info('Session-initiate: ', init);
this.connection.sendIQ(init,
() => {
logger.info('Got RESULT for "session-initiate"');
},
error => {
logger.error('"session-initiate" error', error);
},
IQ_TIMEOUT);
}
/**
* Sets the answer received from the remote peer.
* @param jingleAnswer
*/
setAnswer(jingleAnswer) {
if (!this.isInitiator) {
throw new Error('Trying to set an answer on the responder session');
}
this.setOfferAnswerCycle(
jingleAnswer,
() => {
logger.info('setAnswer - succeeded');
},
error => {
logger.error('setAnswer failed: ', error);
});
}
/* eslint-disable max-params */
/**
* This is a setRemoteDescription/setLocalDescription cycle which starts at
* converting Strophe Jingle IQ into remote offer SDP. Once converted
* setRemoteDescription, createAnswer and setLocalDescription calls follow.
* @param jingleOfferAnswerIq jQuery selector pointing to the jingle element
* of the offer (or answer) IQ
* @param success callback called when sRD/sLD cycle finishes successfully.
* @param failure callback called with an error object as an argument if we
* fail at any point during setRD, createAnswer, setLD.
* @param {Array<JitsiLocalTrack>} [localTracks] the optional list of
* the local tracks that will be added, before the offer/answer cycle
* executes (for the local track addition to be an atomic operation together
* with the offer/answer).