modified lib-jitsi-meet dev repo
Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.

TraceablePeerConnection.js 115KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203
  1. import { getLogger } from '@jitsi/logger';
  2. import { Interop } from '@jitsi/sdp-interop';
  3. import transform from 'sdp-transform';
  4. import * as CodecMimeType from '../../service/RTC/CodecMimeType';
  5. import { MediaDirection } from '../../service/RTC/MediaDirection';
  6. import { MediaType } from '../../service/RTC/MediaType';
  7. import RTCEvents from '../../service/RTC/RTCEvents';
  8. import * as SignalingEvents from '../../service/RTC/SignalingEvents';
  9. import {
  10. getSourceIndexFromSourceName,
  11. getSourceNameForJitsiTrack
  12. } from '../../service/RTC/SignalingLayer';
  13. import { VideoType } from '../../service/RTC/VideoType';
  14. import { SS_DEFAULT_FRAME_RATE } from '../RTC/ScreenObtainer';
  15. import browser from '../browser';
  16. import FeatureFlags from '../flags/FeatureFlags';
  17. import LocalSdpMunger from '../sdp/LocalSdpMunger';
  18. import RtxModifier from '../sdp/RtxModifier';
  19. import SDP from '../sdp/SDP';
  20. import SDPUtil from '../sdp/SDPUtil';
  21. import SdpConsistency from '../sdp/SdpConsistency';
  22. import SdpSimulcast from '../sdp/SdpSimulcast';
  23. import { SdpTransformWrap } from '../sdp/SdpTransformUtil';
  24. import * as GlobalOnErrorHandler from '../util/GlobalOnErrorHandler';
  25. import JitsiRemoteTrack from './JitsiRemoteTrack';
  26. import RTC from './RTC';
  27. import {
  28. HD_BITRATE,
  29. HD_SCALE_FACTOR,
  30. SIM_LAYER_RIDS,
  31. TPCUtils
  32. } from './TPCUtils';
  33. // FIXME SDP tools should end up in some kind of util module
  34. const logger = getLogger(__filename);
  35. const DEGRADATION_PREFERENCE_CAMERA = 'maintain-framerate';
  36. const DEGRADATION_PREFERENCE_DESKTOP = 'maintain-resolution';
  37. /* eslint-disable max-params */
  38. /**
  39. * Creates new instance of 'TraceablePeerConnection'.
  40. *
  41. * @param {RTC} rtc the instance of <tt>RTC</tt> service
  42. * @param {number} id the peer connection id assigned by the parent RTC module.
  43. * @param {SignalingLayer} signalingLayer the signaling layer instance
  44. * @param {object} pcConfig The {@code RTCConfiguration} to use for the WebRTC peer connection.
  45. * @param {object} constraints WebRTC 'PeerConnection' constraints
  46. * @param {boolean} isP2P indicates whether or not the new instance will be used in a peer to peer connection.
  47. * @param {object} options <tt>TracablePeerConnection</tt> config options.
  48. * @param {boolean} options.disableSimulcast if set to 'true' will disable the simulcast.
  49. * @param {boolean} options.disableRtx if set to 'true' will disable the RTX.
  50. * @param {string} options.disabledCodec the mime type of the code that should not be negotiated on the peerconnection.
  51. * @param {string} options.preferredCodec the mime type of the codec that needs to be made the preferred codec for the
  52. * peerconnection.
  53. * @param {boolean} options.startSilent If set to 'true' no audio will be sent or received.
  54. * @param {boolean} options.usesUnifiedPlan Indicates if the browser is running in unified plan mode.
  55. *
  56. * FIXME: initially the purpose of TraceablePeerConnection was to be able to
  57. * debug the peer connection. Since many other responsibilities have been added
  58. * it would make sense to extract a separate class from it and come up with
  59. * a more suitable name.
  60. *
  61. * @constructor
  62. */
  63. export default function TraceablePeerConnection(
  64. rtc,
  65. id,
  66. signalingLayer,
  67. pcConfig,
  68. constraints,
  69. isP2P,
  70. options) {
  71. /**
  72. * Indicates whether or not this peer connection instance is actively
  73. * sending/receiving audio media. When set to <tt>false</tt> the SDP audio
  74. * media direction will be adjusted to 'inactive' in order to suspend
  75. * the transmission.
  76. * @type {boolean}
  77. * @private
  78. */
  79. this.audioTransferActive = !(options.startSilent === true);
  80. /**
  81. * The DTMF sender instance used to send DTMF tones.
  82. *
  83. * @type {RTCDTMFSender|undefined}
  84. * @private
  85. */
  86. this._dtmfSender = undefined;
  87. /**
  88. * @typedef {Object} TouchToneRequest
  89. * @property {string} tones - The DTMF tones string as defined by
  90. * {@code RTCDTMFSender.insertDTMF}, 'tones' argument.
  91. * @property {number} duration - The amount of time in milliseconds that
  92. * each DTMF should last.
  93. * @property {string} interToneGap - The length of time in miliseconds to
  94. * wait between tones.
  95. */
  96. /**
  97. * TouchToneRequests which are waiting to be played. This queue is filled
  98. * if there are touch tones currently being played.
  99. *
  100. * @type {Array<TouchToneRequest>}
  101. * @private
  102. */
  103. this._dtmfTonesQueue = [];
  104. /**
  105. * Indicates whether or not this peer connection instance is actively
  106. * sending/receiving video media. When set to <tt>false</tt> the SDP video
  107. * media direction will be adjusted to 'inactive' in order to suspend
  108. * the transmission.
  109. * @type {boolean}
  110. * @private
  111. */
  112. this.videoTransferActive = true;
  113. /**
  114. * The parent instance of RTC service which created this
  115. * <tt>TracablePeerConnection</tt>.
  116. * @type {RTC}
  117. */
  118. this.rtc = rtc;
  119. /**
  120. * The peer connection identifier assigned by the RTC module.
  121. * @type {number}
  122. */
  123. this.id = id;
  124. /**
  125. * Indicates whether or not this instance is used in a peer to peer
  126. * connection.
  127. * @type {boolean}
  128. */
  129. this.isP2P = isP2P;
  130. /**
  131. * The map holds remote tracks associated with this peer connection. It maps user's JID to media type and a set of
  132. * remote tracks.
  133. * @type {Map<string, Map<MediaType, Set<JitsiRemoteTrack>>>}
  134. */
  135. this.remoteTracks = new Map();
  136. /**
  137. * A map which stores local tracks mapped by {@link JitsiLocalTrack.rtcId}
  138. * @type {Map<number, JitsiLocalTrack>}
  139. */
  140. this.localTracks = new Map();
  141. /**
  142. * Keeps tracks of the WebRTC <tt>MediaStream</tt>s that have been added to
  143. * the underlying WebRTC PeerConnection.
  144. * @type {Array}
  145. * @private
  146. */
  147. this._addedStreams = [];
  148. /**
  149. * @typedef {Object} TPCGroupInfo
  150. * @property {string} semantics the SSRC groups semantics
  151. * @property {Array<number>} ssrcs group's SSRCs in order where the first
  152. * one is group's primary SSRC, the second one is secondary (RTX) and so
  153. * on...
  154. */
  155. /**
  156. * @typedef {Object} TPCSSRCInfo
  157. * @property {Array<number>} ssrcs an array which holds all track's SSRCs
  158. * @property {Array<TPCGroupInfo>} groups an array stores all track's SSRC
  159. * groups
  160. */
  161. /**
  162. * Holds the info about local track's SSRCs mapped per their
  163. * {@link JitsiLocalTrack.rtcId}
  164. * @type {Map<number, TPCSSRCInfo>}
  165. */
  166. this.localSSRCs = new Map();
  167. /**
  168. * The local ICE username fragment for this session.
  169. */
  170. this.localUfrag = null;
  171. /**
  172. * The remote ICE username fragment for this session.
  173. */
  174. this.remoteUfrag = null;
  175. /**
  176. * The DTLS transport object for the PeerConnection.
  177. * Note: this assume only one shared transport exists because we bundled
  178. * all streams on the same underlying transport.
  179. */
  180. this._dtlsTransport = null;
  181. /**
  182. * The signaling layer which operates this peer connection.
  183. * @type {SignalingLayer}
  184. */
  185. this.signalingLayer = signalingLayer;
  186. // SignalingLayer listeners
  187. this._peerVideoTypeChanged = this._peerVideoTypeChanged.bind(this);
  188. this.signalingLayer.on(SignalingEvents.PEER_VIDEO_TYPE_CHANGED, this._peerVideoTypeChanged);
  189. this._peerMutedChanged = this._peerMutedChanged.bind(this);
  190. this.signalingLayer.on(SignalingEvents.PEER_MUTED_CHANGED, this._peerMutedChanged);
  191. this.options = options;
  192. // Setup SignalingLayer listeners for source-name based events.
  193. this.signalingLayer.on(SignalingEvents.SOURCE_MUTED_CHANGED,
  194. (sourceName, isMuted) => this._sourceMutedChanged(sourceName, isMuted));
  195. this.signalingLayer.on(SignalingEvents.SOURCE_VIDEO_TYPE_CHANGED,
  196. (sourceName, videoType) => this._sourceVideoTypeChanged(sourceName, videoType));
  197. // Make sure constraints is properly formatted in order to provide information about whether or not this
  198. // connection is P2P to rtcstats.
  199. const safeConstraints = constraints || {};
  200. safeConstraints.optional = safeConstraints.optional || [];
  201. // The `optional` parameter needs to be of type array, otherwise chrome will throw an error.
  202. // Firefox and Safari just ignore it.
  203. if (Array.isArray(safeConstraints.optional)) {
  204. safeConstraints.optional.push({ rtcStatsSFUP2P: this.isP2P });
  205. } else {
  206. logger.warn('Optional param is not an array, rtcstats p2p data is omitted.');
  207. }
  208. this.peerconnection = new RTCPeerConnection(pcConfig, safeConstraints);
  209. this.tpcUtils = new TPCUtils(this);
  210. this.updateLog = [];
  211. this.stats = {};
  212. this.statsinterval = null;
  213. /**
  214. * Flag used to indicate if simulcast is turned off and a cap of 500 Kbps is applied on screensharing.
  215. */
  216. this._capScreenshareBitrate = this.options.capScreenshareBitrate;
  217. /**
  218. * Flag used to indicate if the browser is running in unified plan mode.
  219. */
  220. this._usesUnifiedPlan = options.usesUnifiedPlan;
  221. /**
  222. * Flag used to indicate if RTCRtpTransceiver#setCodecPreferences is to be used instead of SDP
  223. * munging for codec selection.
  224. */
  225. this._usesTransceiverCodecPreferences = browser.supportsCodecPreferences() && this._usesUnifiedPlan;
  226. this._usesTransceiverCodecPreferences
  227. && logger.info('Using RTCRtpTransceiver#setCodecPreferences for codec selection');
  228. // We currently need these flags only for FF and that's why we are updating them only for unified plan.
  229. if (this._usesUnifiedPlan) {
  230. /**
  231. * Indicates whether an audio track has ever been added to the peer connection.
  232. */
  233. this._hasHadAudioTrack = false;
  234. /**
  235. * Indicates whether a video track has ever been added to the peer connection.
  236. */
  237. this._hasHadVideoTrack = false;
  238. }
  239. /**
  240. * @type {number} The max number of stats to keep in this.stats. Limit to
  241. * 300 values, i.e. 5 minutes; set to 0 to disable
  242. */
  243. this.maxstats = options.maxstats;
  244. this.interop = new Interop();
  245. if (this._usesUnifiedPlan) {
  246. this.simulcast = new SdpSimulcast({ numOfLayers: SIM_LAYER_RIDS.length });
  247. } else {
  248. const Simulcast = require('@jitsi/sdp-simulcast');
  249. this.simulcast = new Simulcast(
  250. {
  251. numOfLayers: SIM_LAYER_RIDS.length,
  252. explodeRemoteSimulcast: false,
  253. usesUnifiedPlan: false
  254. });
  255. }
  256. this.sdpConsistency = new SdpConsistency(this.toString());
  257. /**
  258. * Munges local SDP provided to the Jingle Session in order to prevent from
  259. * sending SSRC updates on attach/detach and mute/unmute (for video).
  260. * @type {LocalSdpMunger}
  261. */
  262. this.localSdpMunger = new LocalSdpMunger(this, this.rtc.getLocalEndpointId());
  263. /**
  264. * TracablePeerConnection uses RTC's eventEmitter
  265. * @type {EventEmitter}
  266. */
  267. this.eventEmitter = rtc.eventEmitter;
  268. this.rtxModifier = new RtxModifier();
  269. /**
  270. * The height constraint applied on the video sender. The default value is 2160 (4K) when layer suspension is
  271. * explicitly disabled.
  272. */
  273. this._senderVideoMaxHeight = 2160;
  274. /**
  275. * The height constraints to be applied on the sender per local video source (source name as the key).
  276. * @type {Map<string, number>}
  277. */
  278. this._senderMaxHeights = new Map();
  279. /**
  280. * Holds the RTCRtpTransceiver mids that the local tracks are attached to, mapped per their
  281. * {@link JitsiLocalTrack.rtcId}.
  282. * @type {Map<string, string>}
  283. */
  284. this._localTrackTransceiverMids = new Map();
  285. // override as desired
  286. this.trace = (what, info) => {
  287. logger.debug(what, info);
  288. this.updateLog.push({
  289. time: new Date(),
  290. type: what,
  291. value: info || ''
  292. });
  293. };
  294. this.onicecandidate = null;
  295. this.peerconnection.onicecandidate = event => {
  296. this.trace(
  297. 'onicecandidate',
  298. JSON.stringify(event.candidate, null, ' '));
  299. if (this.onicecandidate !== null) {
  300. this.onicecandidate(event);
  301. }
  302. };
  303. // Use track events when browser is running in unified plan mode and stream events in plan-b mode.
  304. if (this._usesUnifiedPlan) {
  305. this.onTrack = evt => {
  306. const stream = evt.streams[0];
  307. this._remoteTrackAdded(stream, evt.track, evt.transceiver);
  308. stream.addEventListener('removetrack', e => {
  309. this._remoteTrackRemoved(stream, e.track);
  310. });
  311. };
  312. this.peerconnection.addEventListener('track', this.onTrack);
  313. } else {
  314. this.peerconnection.onaddstream = event => this._remoteStreamAdded(event.stream);
  315. this.peerconnection.onremovestream = event => this._remoteStreamRemoved(event.stream);
  316. }
  317. this.onsignalingstatechange = null;
  318. this.peerconnection.onsignalingstatechange = event => {
  319. this.trace('onsignalingstatechange', this.signalingState);
  320. if (this.onsignalingstatechange !== null) {
  321. this.onsignalingstatechange(event);
  322. }
  323. };
  324. this.oniceconnectionstatechange = null;
  325. this.peerconnection.oniceconnectionstatechange = event => {
  326. this.trace('oniceconnectionstatechange', this.iceConnectionState);
  327. if (this.oniceconnectionstatechange !== null) {
  328. this.oniceconnectionstatechange(event);
  329. }
  330. };
  331. this.onnegotiationneeded = null;
  332. this.peerconnection.onnegotiationneeded = event => {
  333. this.trace('onnegotiationneeded');
  334. if (this.onnegotiationneeded !== null) {
  335. this.onnegotiationneeded(event);
  336. }
  337. };
  338. this.onconnectionstatechange = null;
  339. this.peerconnection.onconnectionstatechange = event => {
  340. this.trace('onconnectionstatechange', this.connectionState);
  341. if (this.onconnectionstatechange !== null) {
  342. this.onconnectionstatechange(event);
  343. }
  344. };
  345. this.ondatachannel = null;
  346. this.peerconnection.ondatachannel = event => {
  347. this.trace('ondatachannel');
  348. if (this.ondatachannel !== null) {
  349. this.ondatachannel(event);
  350. }
  351. };
  352. if (this.maxstats) {
  353. this.statsinterval = window.setInterval(() => {
  354. this.getStats().then(stats => {
  355. if (typeof stats?.result === 'function') {
  356. const results = stats.result();
  357. for (let i = 0; i < results.length; ++i) {
  358. const res = results[i];
  359. res.names().forEach(name => {
  360. this._processStat(res, name, res.stat(name));
  361. });
  362. }
  363. } else {
  364. stats.forEach(r => this._processStat(r, '', r));
  365. }
  366. });
  367. }, 1000);
  368. }
  369. logger.info(`Create new ${this}`);
  370. }
  371. /* eslint-enable max-params */
  372. /**
  373. * Process stat and adds it to the array of stats we store.
  374. * @param report the current stats report.
  375. * @param name the name of the report, if available
  376. * @param statValue the value to add.
  377. * @private
  378. */
  379. TraceablePeerConnection.prototype._processStat
  380. = function(report, name, statValue) {
  381. const id = `${report.id}-${name}`;
  382. let s = this.stats[id];
  383. const now = new Date();
  384. if (!s) {
  385. this.stats[id] = s = {
  386. startTime: now,
  387. endTime: now,
  388. values: [],
  389. times: []
  390. };
  391. }
  392. s.values.push(statValue);
  393. s.times.push(now.getTime());
  394. if (s.values.length > this.maxstats) {
  395. s.values.shift();
  396. s.times.shift();
  397. }
  398. s.endTime = now;
  399. };
  400. /**
  401. * Returns a string representation of a SessionDescription object.
  402. */
  403. const dumpSDP = function(description) {
  404. if (typeof description === 'undefined' || description === null) {
  405. return '';
  406. }
  407. return `type: ${description.type}\r\n${description.sdp}`;
  408. };
  409. /**
  410. * Forwards the {@link peerconnection.iceConnectionState} state except that it
  411. * will convert "completed" into "connected" where both mean that the ICE has
  412. * succeeded and is up and running. We never see "completed" state for
  413. * the JVB connection, but it started appearing for the P2P one. This method
  414. * allows to adapt old logic to this new situation.
  415. * @return {string}
  416. */
  417. TraceablePeerConnection.prototype.getConnectionState = function() {
  418. const state = this.peerconnection.iceConnectionState;
  419. if (state === 'completed') {
  420. return 'connected';
  421. }
  422. return state;
  423. };
  424. /**
  425. * Obtains the media direction for given {@link MediaType}. The method takes
  426. * into account whether or not there are any local tracks for media and
  427. * the {@link audioTransferActive} and {@link videoTransferActive} flags.
  428. * @param {MediaType} mediaType
  429. * @param {boolean} isAddOperation whether the direction is to be calculated after a source-add action.
  430. * @return {string} one of the SDP direction constants ('sendrecv, 'recvonly'
  431. * etc.) which should be used when setting local description on the peer
  432. * connection.
  433. * @private
  434. */
  435. TraceablePeerConnection.prototype.getDesiredMediaDirection = function(mediaType, isAddOperation = false) {
  436. const hasLocalSource = this.hasAnyTracksOfType(mediaType);
  437. if (this._usesUnifiedPlan) {
  438. return isAddOperation
  439. ? hasLocalSource ? MediaDirection.SENDRECV : MediaDirection.SENDONLY
  440. : hasLocalSource ? MediaDirection.RECVONLY : MediaDirection.INACTIVE;
  441. }
  442. const mediaTransferActive = mediaType === MediaType.AUDIO ? this.audioTransferActive : this.videoTransferActive;
  443. if (mediaTransferActive) {
  444. return hasLocalSource ? MediaDirection.SENDRECV : MediaDirection.RECVONLY;
  445. }
  446. return MediaDirection.INACTIVE;
  447. };
  448. /**
  449. * Returns the list of RTCRtpReceivers created for the source of the given media type associated with
  450. * the set of remote endpoints specified.
  451. * @param {Array<string>} endpoints list of the endpoints
  452. * @param {string} mediaType 'audio' or 'video'
  453. * @returns {Array<RTCRtpReceiver>} list of receivers created by the peerconnection.
  454. */
  455. TraceablePeerConnection.prototype._getReceiversByEndpointIds = function(endpoints, mediaType) {
  456. let remoteTracks = [];
  457. let receivers = [];
  458. for (const endpoint of endpoints) {
  459. remoteTracks = remoteTracks.concat(this.getRemoteTracks(endpoint, mediaType));
  460. }
  461. // Get the ids of the MediaStreamTracks associated with each of these remote tracks.
  462. const remoteTrackIds = remoteTracks.map(remote => remote.track?.id);
  463. receivers = this.peerconnection.getReceivers()
  464. .filter(receiver => receiver.track
  465. && receiver.track.kind === mediaType
  466. && remoteTrackIds.find(trackId => trackId === receiver.track.id));
  467. return receivers;
  468. };
  469. /**
  470. * Tells whether or not this TPC instance is using Simulcast.
  471. * @return {boolean} <tt>true</tt> if simulcast is enabled and active or
  472. * <tt>false</tt> if it's turned off.
  473. */
  474. TraceablePeerConnection.prototype.isSimulcastOn = function() {
  475. return !this.options.disableSimulcast;
  476. };
  477. /**
  478. * Handles {@link SignalingEvents.PEER_VIDEO_TYPE_CHANGED}
  479. * @param {string} endpointId the video owner's ID (MUC nickname)
  480. * @param {VideoType} videoType the new value
  481. * @private
  482. */
  483. TraceablePeerConnection.prototype._peerVideoTypeChanged = function(endpointId, videoType) {
  484. // Check if endpointId has a value to avoid action on random track
  485. if (!endpointId) {
  486. logger.error(`${this} No endpointID on peerVideoTypeChanged`);
  487. return;
  488. }
  489. const videoTrack = this.getRemoteTracks(endpointId, MediaType.VIDEO);
  490. if (videoTrack.length) {
  491. // NOTE 1 track per media type is assumed
  492. videoTrack[0]._setVideoType(videoType);
  493. }
  494. };
  495. /**
  496. * Handles remote track mute / unmute events.
  497. * @param {string} endpointId the track owner's identifier (MUC nickname)
  498. * @param {MediaType} mediaType "audio" or "video"
  499. * @param {boolean} isMuted the new mute state
  500. * @private
  501. */
  502. TraceablePeerConnection.prototype._peerMutedChanged = function(endpointId, mediaType, isMuted) {
  503. // Check if endpointId is a value to avoid doing action on all remote tracks
  504. if (!endpointId) {
  505. logger.error(`${this} On peerMuteChanged - no endpoint ID`);
  506. return;
  507. }
  508. const track = this.getRemoteTracks(endpointId, mediaType);
  509. if (track.length) {
  510. // NOTE 1 track per media type is assumed
  511. track[0].setMute(isMuted);
  512. }
  513. };
  514. /**
  515. * Handles remote source mute and unmute changed events.
  516. *
  517. * @param {string} sourceName - The name of the remote source.
  518. * @param {boolean} isMuted - The new mute state.
  519. */
  520. TraceablePeerConnection.prototype._sourceMutedChanged = function(sourceName, isMuted) {
  521. const track = this.getRemoteTracks().find(t => t.getSourceName() === sourceName);
  522. if (!track) {
  523. return;
  524. }
  525. track.setMute(isMuted);
  526. };
  527. /**
  528. * Handles remote source videoType changed events.
  529. *
  530. * @param {string} sourceName - The name of the remote source.
  531. * @param {boolean} isMuted - The new value.
  532. */
  533. TraceablePeerConnection.prototype._sourceVideoTypeChanged = function(sourceName, videoType) {
  534. const track = this.getRemoteTracks().find(t => t.getSourceName() === sourceName);
  535. if (!track) {
  536. return;
  537. }
  538. track._setVideoType(videoType);
  539. };
  540. /**
  541. * Obtains audio levels of the remote audio tracks by getting the source information on the RTCRtpReceivers.
  542. * The information relevant to the ssrc is updated each time a RTP packet constaining the ssrc is received.
  543. * @param {Array<string>} speakerList list of endpoint ids for which audio levels are to be gathered.
  544. * @returns {Object} containing ssrc and audio level information as a key-value pair.
  545. */
  546. TraceablePeerConnection.prototype.getAudioLevels = function(speakerList = []) {
  547. const audioLevels = {};
  548. const audioReceivers = speakerList.length
  549. ? this._getReceiversByEndpointIds(speakerList, MediaType.AUDIO)
  550. : this.peerconnection.getReceivers()
  551. .filter(receiver => receiver.track && receiver.track.kind === MediaType.AUDIO && receiver.track.enabled);
  552. audioReceivers.forEach(remote => {
  553. const ssrc = remote.getSynchronizationSources();
  554. if (ssrc && ssrc.length) {
  555. // As per spec, this audiolevel is a value between 0..1 (linear), where 1.0
  556. // represents 0 dBov, 0 represents silence, and 0.5 represents approximately
  557. // 6 dBSPL change in the sound pressure level from 0 dBov.
  558. // https://www.w3.org/TR/webrtc/#dom-rtcrtpcontributingsource-audiolevel
  559. audioLevels[ssrc[0].source] = ssrc[0].audioLevel;
  560. }
  561. });
  562. return audioLevels;
  563. };
  564. /**
  565. * Obtains local tracks for given {@link MediaType}. If the <tt>mediaType</tt>
  566. * argument is omitted the list of all local tracks will be returned.
  567. * @param {MediaType} [mediaType]
  568. * @return {Array<JitsiLocalTrack>}
  569. */
  570. TraceablePeerConnection.prototype.getLocalTracks = function(mediaType) {
  571. let tracks = Array.from(this.localTracks.values());
  572. if (mediaType !== undefined) {
  573. tracks = tracks.filter(track => track.getType() === mediaType);
  574. }
  575. return tracks;
  576. };
  577. /**
  578. * Retrieves the local video tracks.
  579. *
  580. * @returns {Array<JitsiLocalTrack>} - local video tracks.
  581. */
  582. TraceablePeerConnection.prototype.getLocalVideoTracks = function() {
  583. return this.getLocalTracks(MediaType.VIDEO);
  584. };
  585. /**
  586. * Checks whether or not this {@link TraceablePeerConnection} instance contains any local tracks for given
  587. * <tt>mediaType</tt>.
  588. *
  589. * @param {MediaType} mediaType - The media type.
  590. * @return {boolean}
  591. */
  592. TraceablePeerConnection.prototype.hasAnyTracksOfType = function(mediaType) {
  593. if (!mediaType) {
  594. throw new Error('"mediaType" is required');
  595. }
  596. return this.getLocalTracks(mediaType).length > 0;
  597. };
  598. /**
  599. * Obtains all remote tracks currently known to this PeerConnection instance.
  600. *
  601. * @param {string} [endpointId] - The track owner's identifier (MUC nickname)
  602. * @param {MediaType} [mediaType] - The remote tracks will be filtered by their media type if this argument is
  603. * specified.
  604. * @return {Array<JitsiRemoteTrack>}
  605. */
  606. TraceablePeerConnection.prototype.getRemoteTracks = function(endpointId, mediaType) {
  607. let remoteTracks = [];
  608. const endpoints = endpointId ? [ endpointId ] : this.remoteTracks.keys();
  609. for (const endpoint of endpoints) {
  610. const endpointTracksByMediaType = this.remoteTracks.get(endpoint);
  611. if (endpointTracksByMediaType) {
  612. for (const trackMediaType of endpointTracksByMediaType.keys()) {
  613. // per media type filtering
  614. if (!mediaType || mediaType === trackMediaType) {
  615. remoteTracks = remoteTracks.concat(Array.from(endpointTracksByMediaType.get(trackMediaType)));
  616. }
  617. }
  618. }
  619. }
  620. return remoteTracks;
  621. };
  622. /**
  623. * Parses the remote description and returns the sdp lines of the sources associated with a remote participant.
  624. *
  625. * @param {string} id Endpoint id of the remote participant.
  626. * @returns {Array<string>} The sdp lines that have the ssrc information.
  627. */
  628. TraceablePeerConnection.prototype.getRemoteSourceInfoByParticipant = function(id) {
  629. const removeSsrcInfo = [];
  630. const remoteTracks = this.getRemoteTracks(id);
  631. if (!remoteTracks?.length) {
  632. return removeSsrcInfo;
  633. }
  634. const primarySsrcs = remoteTracks.map(track => track.getSSRC());
  635. const sdp = new SDP(this.remoteDescription.sdp);
  636. primarySsrcs.forEach((ssrc, idx) => {
  637. for (const media of sdp.media) {
  638. let lines = '';
  639. let ssrcLines = SDPUtil.findLines(media, `a=ssrc:${ssrc}`);
  640. if (ssrcLines.length) {
  641. if (!removeSsrcInfo[idx]) {
  642. removeSsrcInfo[idx] = '';
  643. }
  644. // Check if there are any FID groups present for the primary ssrc.
  645. const fidLines = SDPUtil.findLines(media, `a=ssrc-group:FID ${ssrc}`);
  646. if (fidLines.length) {
  647. const secondarySsrc = fidLines[0].split(' ')[2];
  648. lines += `${fidLines[0]}\r\n`;
  649. ssrcLines = ssrcLines.concat(SDPUtil.findLines(media, `a=ssrc:${secondarySsrc}`));
  650. }
  651. removeSsrcInfo[idx] += `${ssrcLines.join('\r\n')}\r\n`;
  652. removeSsrcInfo[idx] += lines;
  653. }
  654. }
  655. });
  656. return removeSsrcInfo;
  657. };
  658. /**
  659. * Returns the target bitrates configured for the local video source.
  660. *
  661. * @returns {Object}
  662. */
  663. TraceablePeerConnection.prototype.getTargetVideoBitrates = function() {
  664. const currentCodec = this.getConfiguredVideoCodec();
  665. return this.tpcUtils.videoBitrates[currentCodec.toUpperCase()] || this.tpcUtils.videoBitrates;
  666. };
  667. /**
  668. * Tries to find {@link JitsiTrack} for given SSRC number. It will search both
  669. * local and remote tracks bound to this instance.
  670. * @param {number} ssrc
  671. * @return {JitsiTrack|null}
  672. */
  673. TraceablePeerConnection.prototype.getTrackBySSRC = function(ssrc) {
  674. if (typeof ssrc !== 'number') {
  675. throw new Error(`SSRC ${ssrc} is not a number`);
  676. }
  677. for (const localTrack of this.localTracks.values()) {
  678. if (this.getLocalSSRC(localTrack) === ssrc) {
  679. return localTrack;
  680. }
  681. }
  682. for (const remoteTrack of this.getRemoteTracks()) {
  683. if (remoteTrack.getSSRC() === ssrc) {
  684. return remoteTrack;
  685. }
  686. }
  687. return null;
  688. };
  689. /**
  690. * Tries to find SSRC number for given {@link JitsiTrack} id. It will search
  691. * both local and remote tracks bound to this instance.
  692. * @param {string} id
  693. * @return {number|null}
  694. */
  695. TraceablePeerConnection.prototype.getSsrcByTrackId = function(id) {
  696. const findTrackById = track => track.getTrack().id === id;
  697. const localTrack = this.getLocalTracks().find(findTrackById);
  698. if (localTrack) {
  699. return this.getLocalSSRC(localTrack);
  700. }
  701. const remoteTrack = this.getRemoteTracks().find(findTrackById);
  702. if (remoteTrack) {
  703. return remoteTrack.getSSRC();
  704. }
  705. return null;
  706. };
  707. /**
  708. * Called when new remote MediaStream is added to the PeerConnection.
  709. * @param {MediaStream} stream the WebRTC MediaStream for remote participant
  710. */
  711. TraceablePeerConnection.prototype._remoteStreamAdded = function(stream) {
  712. const streamId = stream.id;
  713. if (!RTC.isUserStreamById(streamId)) {
  714. logger.info(`${this} ignored remote 'stream added' event for non-user stream[id=${streamId}]`);
  715. return;
  716. }
  717. // Bind 'addtrack'/'removetrack' event handlers
  718. if (browser.isChromiumBased()) {
  719. stream.onaddtrack = event => {
  720. this._remoteTrackAdded(stream, event.track);
  721. };
  722. stream.onremovetrack = event => {
  723. this._remoteTrackRemoved(stream, event.track);
  724. };
  725. }
  726. // Call remoteTrackAdded for each track in the stream
  727. const streamAudioTracks = stream.getAudioTracks();
  728. for (const audioTrack of streamAudioTracks) {
  729. this._remoteTrackAdded(stream, audioTrack);
  730. }
  731. const streamVideoTracks = stream.getVideoTracks();
  732. for (const videoTrack of streamVideoTracks) {
  733. this._remoteTrackAdded(stream, videoTrack);
  734. }
  735. };
  736. /**
  737. * Called on "track added" and "stream added" PeerConnection events (because we
  738. * handle streams on per track basis). Finds the owner and the SSRC for
  739. * the track and passes that to ChatRoom for further processing.
  740. * @param {MediaStream} stream the WebRTC MediaStream instance which is
  741. * the parent of the track
  742. * @param {MediaStreamTrack} track the WebRTC MediaStreamTrack added for remote
  743. * participant.
  744. * @param {RTCRtpTransceiver} transceiver the WebRTC transceiver that is created
  745. * for the remote participant in unified plan.
  746. */
  747. TraceablePeerConnection.prototype._remoteTrackAdded = function(stream, track, transceiver = null) {
  748. const streamId = stream.id;
  749. const mediaType = track.kind;
  750. if (!this.isP2P && !RTC.isUserStreamById(streamId)) {
  751. logger.info(`${this} ignored remote 'stream added' event for non-user stream[id=${streamId}]`);
  752. return;
  753. }
  754. logger.info(`${this} adding remote track for stream[id=${streamId},type=${mediaType}]`);
  755. // look up an associated JID for a stream id
  756. if (!mediaType) {
  757. GlobalOnErrorHandler.callErrorHandler(
  758. new Error(
  759. `MediaType undefined for remote track, stream id: ${streamId}`
  760. ));
  761. // Abort
  762. return;
  763. }
  764. const remoteSDP = this._usesUnifiedPlan
  765. ? new SDP(this.peerconnection.remoteDescription.sdp)
  766. : new SDP(this.remoteDescription.sdp);
  767. let mediaLines;
  768. // In unified plan mode, find the matching mline using 'mid' if its availble, otherwise use the
  769. // 'msid' attribute of the stream.
  770. if (this._usesUnifiedPlan) {
  771. if (transceiver && transceiver.mid) {
  772. const mid = transceiver.mid;
  773. mediaLines = remoteSDP.media.filter(mls => SDPUtil.findLine(mls, `a=mid:${mid}`));
  774. } else {
  775. mediaLines = remoteSDP.media.filter(mls => {
  776. const msid = SDPUtil.findLine(mls, 'a=msid:');
  777. return typeof msid !== 'undefined' && streamId === msid.substring(7).split(' ')[0];
  778. });
  779. }
  780. } else {
  781. mediaLines = remoteSDP.media.filter(mls => mls.startsWith(`m=${mediaType}`));
  782. }
  783. if (!mediaLines.length) {
  784. GlobalOnErrorHandler.callErrorHandler(
  785. new Error(`No media lines found in remote SDP for remote stream[id=${streamId},type=${mediaType}]`));
  786. // Abort
  787. return;
  788. }
  789. let ssrcLines = SDPUtil.findLines(mediaLines[0], 'a=ssrc:');
  790. ssrcLines
  791. = ssrcLines.filter(line => line.indexOf(`msid:${streamId}`) !== -1);
  792. if (!ssrcLines.length) {
  793. GlobalOnErrorHandler.callErrorHandler(
  794. new Error(`No SSRC lines found in remote SDP for remote stream[msid=${streamId},type=${mediaType}]`));
  795. // Abort
  796. return;
  797. }
  798. // FIXME the length of ssrcLines[0] not verified, but it will fail
  799. // with global error handler anyway
  800. const ssrcStr = ssrcLines[0].substring(7).split(' ')[0];
  801. const trackSsrc = Number(ssrcStr);
  802. const ownerEndpointId = this.signalingLayer.getSSRCOwner(trackSsrc);
  803. if (isNaN(trackSsrc) || trackSsrc < 0) {
  804. GlobalOnErrorHandler.callErrorHandler(
  805. new Error(
  806. `Invalid SSRC for remote stream[ssrc=${trackSsrc},id=${streamId},type=${mediaType}]`));
  807. // Abort
  808. return;
  809. } else if (!ownerEndpointId) {
  810. GlobalOnErrorHandler.callErrorHandler(
  811. new Error(
  812. `No SSRC owner known for remote stream[ssrc=${trackSsrc},id=${streamId},type=${mediaType}]`));
  813. // Abort
  814. return;
  815. }
  816. let sourceName;
  817. if (FeatureFlags.isSourceNameSignalingEnabled()) {
  818. sourceName = this.signalingLayer.getTrackSourceName(trackSsrc);
  819. // If source name was not signaled, we'll generate one which allows testing signaling
  820. // when mixing legacy(mobile) with new clients.
  821. if (!sourceName) {
  822. sourceName = getSourceNameForJitsiTrack(ownerEndpointId, mediaType, 0);
  823. }
  824. }
  825. // eslint-disable-next-line no-undef
  826. logger.info(`${this} creating remote track[endpoint=${ownerEndpointId},ssrc=${trackSsrc},`
  827. + `type=${mediaType},sourceName=${sourceName}]`);
  828. const peerMediaInfo = this.signalingLayer.getPeerMediaInfo(ownerEndpointId, mediaType, sourceName);
  829. if (!peerMediaInfo) {
  830. GlobalOnErrorHandler.callErrorHandler(
  831. new Error(`${this}: no peer media info available for ${ownerEndpointId}`));
  832. return;
  833. }
  834. const muted = peerMediaInfo.muted;
  835. const videoType = peerMediaInfo.videoType; // can be undefined
  836. // eslint-disable-next-line no-undef
  837. this._createRemoteTrack(
  838. ownerEndpointId, stream, track, mediaType, videoType, trackSsrc, muted, sourceName);
  839. };
  840. // FIXME cleanup params
  841. /* eslint-disable max-params */
  842. /**
  843. * Initializes a new JitsiRemoteTrack instance with the data provided by
  844. * the signaling layer and SDP.
  845. *
  846. * @param {string} ownerEndpointId the owner's endpoint ID (MUC nickname)
  847. * @param {MediaStream} stream the WebRTC stream instance
  848. * @param {MediaStreamTrack} track the WebRTC track instance
  849. * @param {MediaType} mediaType the track's type of the media
  850. * @param {VideoType} [videoType] the track's type of the video (if applicable)
  851. * @param {number} ssrc the track's main SSRC number
  852. * @param {boolean} muted the initial muted status
  853. * @param {String} sourceName the track's source name
  854. */
  855. TraceablePeerConnection.prototype._createRemoteTrack = function(
  856. ownerEndpointId,
  857. stream,
  858. track,
  859. mediaType,
  860. videoType,
  861. ssrc,
  862. muted,
  863. sourceName) {
  864. let remoteTracksMap = this.remoteTracks.get(ownerEndpointId);
  865. if (!remoteTracksMap) {
  866. remoteTracksMap = new Map();
  867. remoteTracksMap.set(MediaType.AUDIO, new Set());
  868. remoteTracksMap.set(MediaType.VIDEO, new Set());
  869. this.remoteTracks.set(ownerEndpointId, remoteTracksMap);
  870. }
  871. const userTracksByMediaType = remoteTracksMap.get(mediaType);
  872. if (userTracksByMediaType?.size
  873. && Array.from(userTracksByMediaType).find(jitsiTrack => jitsiTrack.getTrack() === track)) {
  874. // Ignore duplicated event which can originate either from 'onStreamAdded' or 'onTrackAdded'.
  875. logger.info(`${this} ignored duplicated track event for track[endpoint=${ownerEndpointId},type=${mediaType}]`);
  876. return;
  877. } else if (userTracksByMediaType?.size && !FeatureFlags.isSourceNameSignalingEnabled()) {
  878. logger.error(`${this} received a second remote track for track[endpoint=${ownerEndpointId},type=${mediaType}]`
  879. + 'deleting the existing track');
  880. const existingTrack = Array.from(userTracksByMediaType)[0];
  881. // The exisiting track needs to be removed here. This happens on Safari sometimes when a SSRC is removed from
  882. // the remote description and the browser doesn't fire a 'removetrack' event on the associated MediaStream.
  883. this._remoteTrackRemoved(existingTrack.getOriginalStream(), existingTrack.getTrack());
  884. }
  885. const remoteTrack
  886. = new JitsiRemoteTrack(
  887. this.rtc,
  888. this.rtc.conference,
  889. ownerEndpointId,
  890. stream,
  891. track,
  892. mediaType,
  893. videoType,
  894. ssrc,
  895. muted,
  896. this.isP2P,
  897. sourceName);
  898. userTracksByMediaType.add(remoteTrack);
  899. this.eventEmitter.emit(RTCEvents.REMOTE_TRACK_ADDED, remoteTrack, this);
  900. };
  901. /* eslint-enable max-params */
  902. /**
  903. * Handles remote stream removal.
  904. * @param stream the WebRTC MediaStream object which is being removed from the
  905. * PeerConnection
  906. */
  907. TraceablePeerConnection.prototype._remoteStreamRemoved = function(stream) {
  908. if (!RTC.isUserStream(stream)) {
  909. logger.info(`Ignored remote 'stream removed' event for stream[id=${stream.id}]`);
  910. return;
  911. }
  912. // Call remoteTrackRemoved for each track in the stream
  913. const streamVideoTracks = stream.getVideoTracks();
  914. for (const videoTrack of streamVideoTracks) {
  915. this._remoteTrackRemoved(stream, videoTrack);
  916. }
  917. const streamAudioTracks = stream.getAudioTracks();
  918. for (const audioTrack of streamAudioTracks) {
  919. this._remoteTrackRemoved(stream, audioTrack);
  920. }
  921. };
  922. /**
  923. * Handles remote media track removal.
  924. *
  925. * @param {MediaStream} stream - WebRTC MediaStream instance which is the parent of the track.
  926. * @param {MediaStreamTrack} track - WebRTC MediaStreamTrack which has been removed from the PeerConnection.
  927. * @returns {void}
  928. */
  929. TraceablePeerConnection.prototype._remoteTrackRemoved = function(stream, track) {
  930. const streamId = stream.id;
  931. const trackId = track?.id;
  932. if (!RTC.isUserStreamById(streamId)) {
  933. logger.info(`${this} ignored remote 'stream removed' event for non-user stream[id=${streamId}]`);
  934. return;
  935. }
  936. if (!streamId) {
  937. GlobalOnErrorHandler.callErrorHandler(new Error(`${this} remote track removal failed - no stream ID`));
  938. return;
  939. }
  940. if (!trackId) {
  941. GlobalOnErrorHandler.callErrorHandler(new Error(`${this} remote track removal failed - no track ID`));
  942. return;
  943. }
  944. const toBeRemoved = this.getRemoteTracks().find(
  945. remoteTrack => remoteTrack.getStreamId() === streamId
  946. && remoteTrack.getTrackId() === trackId);
  947. if (!toBeRemoved) {
  948. GlobalOnErrorHandler.callErrorHandler(new Error(`${this} remote track removal failed - track not found`));
  949. return;
  950. }
  951. logger.info(`${this} remote track removed stream[id=${streamId},trackId=${trackId}]`);
  952. this._removeRemoteTrack(toBeRemoved);
  953. };
  954. /**
  955. * Removes all JitsiRemoteTracks associated with given MUC nickname (resource part of the JID).
  956. *
  957. * @param {string} owner - The resource part of the MUC JID.
  958. * @returns {JitsiRemoteTrack[]} - The array of removed tracks.
  959. */
  960. TraceablePeerConnection.prototype.removeRemoteTracks = function(owner) {
  961. let removedTracks = [];
  962. const remoteTracksByMedia = this.remoteTracks.get(owner);
  963. if (remoteTracksByMedia) {
  964. removedTracks = removedTracks.concat(Array.from(remoteTracksByMedia.get(MediaType.AUDIO)));
  965. removedTracks = removedTracks.concat(Array.from(remoteTracksByMedia.get(MediaType.VIDEO)));
  966. this.remoteTracks.delete(owner);
  967. }
  968. logger.debug(`${this} removed remote tracks[endpoint=${owner},count=${removedTracks.length}`);
  969. return removedTracks;
  970. };
  971. /**
  972. * Removes and disposes given <tt>JitsiRemoteTrack</tt> instance. Emits {@link RTCEvents.REMOTE_TRACK_REMOVED}.
  973. *
  974. * @param {JitsiRemoteTrack} toBeRemoved - The remote track to be removed.
  975. * @returns {void}
  976. */
  977. TraceablePeerConnection.prototype._removeRemoteTrack = function(toBeRemoved) {
  978. toBeRemoved.dispose();
  979. const participantId = toBeRemoved.getParticipantId();
  980. const userTracksByMediaType = this.remoteTracks.get(participantId);
  981. if (!userTracksByMediaType) {
  982. logger.error(`${this} removeRemoteTrack: no remote tracks map for endpoint=${participantId}`);
  983. } else if (!userTracksByMediaType.get(toBeRemoved.getType())?.delete(toBeRemoved)) {
  984. logger.error(`${this} Failed to remove ${toBeRemoved} - type mapping messed up ?`);
  985. }
  986. this.eventEmitter.emit(RTCEvents.REMOTE_TRACK_REMOVED, toBeRemoved);
  987. };
  988. /**
  989. * Returns a map with keys msid/mediaType and <tt>TrackSSRCInfo</tt> values.
  990. * @param {RTCSessionDescription} desc the local description.
  991. * @return {Map<string,TrackSSRCInfo>}
  992. */
  993. TraceablePeerConnection.prototype._extractSSRCMap = function(desc) {
  994. /**
  995. * Track SSRC infos mapped by stream ID (msid) or mediaType (unified-plan)
  996. * @type {Map<string,TrackSSRCInfo>}
  997. */
  998. const ssrcMap = new Map();
  999. /**
  1000. * Groups mapped by primary SSRC number
  1001. * @type {Map<number,Array<SSRCGroupInfo>>}
  1002. */
  1003. const groupsMap = new Map();
  1004. if (typeof desc !== 'object' || desc === null
  1005. || typeof desc.sdp !== 'string') {
  1006. logger.warn('An empty description was passed as an argument');
  1007. return ssrcMap;
  1008. }
  1009. const session = transform.parse(desc.sdp);
  1010. if (!Array.isArray(session.media)) {
  1011. return ssrcMap;
  1012. }
  1013. let media = session.media;
  1014. // For unified plan clients, only the first audio and video mlines will have ssrcs for the local sources.
  1015. // The rest of the m-lines are for the recv-only sources, one for each remote source.
  1016. if (this._usesUnifiedPlan) {
  1017. if (FeatureFlags.isMultiStreamSupportEnabled()) {
  1018. media = media.filter(mline => mline.direction === MediaDirection.SENDONLY
  1019. || mline.direction === MediaDirection.SENDRECV);
  1020. } else {
  1021. media = [];
  1022. [ MediaType.AUDIO, MediaType.VIDEO ].forEach(mediaType => {
  1023. const mLine = session.media.find(m => m.type === mediaType);
  1024. mLine && media.push(mLine);
  1025. });
  1026. }
  1027. }
  1028. let index = 0;
  1029. for (const mLine of media) {
  1030. if (!Array.isArray(mLine.ssrcs)) {
  1031. continue; // eslint-disable-line no-continue
  1032. }
  1033. if (Array.isArray(mLine.ssrcGroups)) {
  1034. for (const group of mLine.ssrcGroups) {
  1035. if (typeof group.semantics !== 'undefined' && typeof group.ssrcs !== 'undefined') {
  1036. // Parse SSRCs and store as numbers
  1037. const groupSSRCs = group.ssrcs.split(' ').map(ssrcStr => parseInt(ssrcStr, 10));
  1038. const primarySSRC = groupSSRCs[0];
  1039. // Note that group.semantics is already present
  1040. group.ssrcs = groupSSRCs;
  1041. // eslint-disable-next-line max-depth
  1042. if (!groupsMap.has(primarySSRC)) {
  1043. groupsMap.set(primarySSRC, []);
  1044. }
  1045. groupsMap.get(primarySSRC).push(group);
  1046. }
  1047. }
  1048. }
  1049. let ssrcs = mLine.ssrcs;
  1050. // Filter the ssrcs with 'msid' attribute for plan-b clients and 'cname' for unified-plan clients.
  1051. ssrcs = this._usesUnifiedPlan
  1052. ? ssrcs.filter(s => s.attribute === 'cname')
  1053. : ssrcs.filter(s => s.attribute === 'msid');
  1054. for (const ssrc of ssrcs) {
  1055. // Use the mediaType as key for the source map for unified plan clients since msids are not part of
  1056. // the standard and the unified plan SDPs do not have a proper msid attribute for the sources.
  1057. // Also the ssrcs for sources do not change for Unified plan clients since RTCRtpSender#replaceTrack is
  1058. // used for switching the tracks so it is safe to use the mediaType as the key for the TrackSSRCInfo map.
  1059. const key = this._usesUnifiedPlan
  1060. ? FeatureFlags.isMultiStreamSupportEnabled() ? `${mLine.type}-${index}` : mLine.type
  1061. : ssrc.value;
  1062. const ssrcNumber = ssrc.id;
  1063. let ssrcInfo = ssrcMap.get(key);
  1064. if (!ssrcInfo) {
  1065. ssrcInfo = {
  1066. ssrcs: [],
  1067. groups: [],
  1068. msid: key
  1069. };
  1070. ssrcMap.set(key, ssrcInfo);
  1071. }
  1072. ssrcInfo.ssrcs.push(ssrcNumber);
  1073. if (groupsMap.has(ssrcNumber)) {
  1074. const ssrcGroups = groupsMap.get(ssrcNumber);
  1075. for (const group of ssrcGroups) {
  1076. ssrcInfo.groups.push(group);
  1077. }
  1078. }
  1079. }
  1080. // Currently multi-stream is supported for video only.
  1081. mLine.type === MediaType.VIDEO && index++;
  1082. }
  1083. return ssrcMap;
  1084. };
  1085. /**
  1086. * Takes a SessionDescription object and returns a "normalized" version.
  1087. * Currently it takes care of ordering the a=ssrc lines and denoting receive
  1088. * only SSRCs.
  1089. */
  1090. const normalizePlanB = function(desc) {
  1091. if (typeof desc !== 'object' || desc === null
  1092. || typeof desc.sdp !== 'string') {
  1093. logger.warn('An empty description was passed as an argument');
  1094. return desc;
  1095. }
  1096. // eslint-disable-next-line no-shadow
  1097. const transform = require('sdp-transform');
  1098. const session = transform.parse(desc.sdp);
  1099. if (typeof session !== 'undefined'
  1100. && typeof session.media !== 'undefined'
  1101. && Array.isArray(session.media)) {
  1102. session.media.forEach(mLine => {
  1103. // Chrome appears to be picky about the order in which a=ssrc lines
  1104. // are listed in an m-line when rtx is enabled (and thus there are
  1105. // a=ssrc-group lines with FID semantics). Specifically if we have
  1106. // "a=ssrc-group:FID S1 S2" and the "a=ssrc:S2" lines appear before
  1107. // the "a=ssrc:S1" lines, SRD fails.
  1108. // So, put SSRC which appear as the first SSRC in an FID ssrc-group
  1109. // first.
  1110. const firstSsrcs = [];
  1111. const newSsrcLines = [];
  1112. if (typeof mLine.ssrcGroups !== 'undefined'
  1113. && Array.isArray(mLine.ssrcGroups)) {
  1114. mLine.ssrcGroups.forEach(group => {
  1115. if (typeof group.semantics !== 'undefined'
  1116. && group.semantics === 'FID') {
  1117. if (typeof group.ssrcs !== 'undefined') {
  1118. firstSsrcs.push(Number(group.ssrcs.split(' ')[0]));
  1119. }
  1120. }
  1121. });
  1122. }
  1123. if (Array.isArray(mLine.ssrcs)) {
  1124. let i;
  1125. for (i = 0; i < mLine.ssrcs.length; i++) {
  1126. if (typeof mLine.ssrcs[i] === 'object'
  1127. && typeof mLine.ssrcs[i].id !== 'undefined'
  1128. && firstSsrcs.indexOf(mLine.ssrcs[i].id) >= 0) {
  1129. newSsrcLines.push(mLine.ssrcs[i]);
  1130. delete mLine.ssrcs[i];
  1131. }
  1132. }
  1133. for (i = 0; i < mLine.ssrcs.length; i++) {
  1134. if (typeof mLine.ssrcs[i] !== 'undefined') {
  1135. newSsrcLines.push(mLine.ssrcs[i]);
  1136. }
  1137. }
  1138. mLine.ssrcs = replaceDefaultUnifiedPlanMsid(newSsrcLines);
  1139. }
  1140. });
  1141. }
  1142. const resStr = transform.write(session);
  1143. return new RTCSessionDescription({
  1144. type: desc.type,
  1145. sdp: resStr
  1146. });
  1147. };
  1148. /**
  1149. * Unified plan differentiates a remote track not associated with a stream using
  1150. * the msid "-", which can incorrectly trigger an onaddstream event in plan-b.
  1151. * For jitsi, these tracks are actually receive-only ssrcs. To prevent
  1152. * onaddstream from firing, remove the ssrcs with msid "-" except the cname
  1153. * line. Normally the ssrcs are not used by the client, as the bridge controls
  1154. * media flow, but keep one reference to the ssrc for the p2p case.
  1155. *
  1156. * @param {Array<Object>} ssrcLines - The ssrc lines from a remote description.
  1157. * @private
  1158. * @returns {Array<Object>} ssrcLines with removed lines referencing msid "-".
  1159. */
  1160. function replaceDefaultUnifiedPlanMsid(ssrcLines = []) {
  1161. if (!browser.isChrome() || !browser.isVersionGreaterThan(70)) {
  1162. return ssrcLines;
  1163. }
  1164. let filteredLines = [ ...ssrcLines ];
  1165. const problematicSsrcIds = ssrcLines.filter(ssrcLine =>
  1166. ssrcLine.attribute === 'mslabel' && ssrcLine.value === '-')
  1167. .map(ssrcLine => ssrcLine.id);
  1168. problematicSsrcIds.forEach(ssrcId => {
  1169. // Find the cname which is to be modified and left in.
  1170. const cnameLine = filteredLines.find(line =>
  1171. line.id === ssrcId && line.attribute === 'cname');
  1172. cnameLine.value = `${MediaDirection.RECVONLY}-${ssrcId}`;
  1173. // Remove all of lines for the ssrc.
  1174. filteredLines
  1175. = filteredLines.filter(line => line.id !== ssrcId);
  1176. // But re-add the cname line so there is a reference kept to the ssrc
  1177. // in the SDP.
  1178. filteredLines.push(cnameLine);
  1179. });
  1180. return filteredLines;
  1181. }
  1182. /**
  1183. * Makes sure that both audio and video directions are configured as 'sendrecv'.
  1184. * @param {Object} localDescription the SDP object as defined by WebRTC.
  1185. * @param {object} options <tt>TracablePeerConnection</tt> config options.
  1186. */
  1187. const enforceSendRecv = function(localDescription, options) {
  1188. if (!localDescription) {
  1189. throw new Error('No local description passed in.');
  1190. }
  1191. const transformer = new SdpTransformWrap(localDescription.sdp);
  1192. const audioMedia = transformer.selectMedia(MediaType.AUDIO)?.[0];
  1193. let changed = false;
  1194. if (audioMedia && audioMedia.direction !== MediaDirection.SENDRECV) {
  1195. if (options.startSilent) {
  1196. audioMedia.direction = MediaDirection.INACTIVE;
  1197. } else {
  1198. audioMedia.direction = MediaDirection.SENDRECV;
  1199. }
  1200. changed = true;
  1201. }
  1202. const videoMedia = transformer.selectMedia(MediaType.VIDEO)?.[0];
  1203. if (videoMedia && videoMedia.direction !== MediaDirection.SENDRECV) {
  1204. videoMedia.direction = MediaDirection.SENDRECV;
  1205. changed = true;
  1206. }
  1207. if (changed) {
  1208. return new RTCSessionDescription({
  1209. type: localDescription.type,
  1210. sdp: transformer.toRawSDP()
  1211. });
  1212. }
  1213. return localDescription;
  1214. };
  1215. /**
  1216. *
  1217. * @param {JitsiLocalTrack} localTrack
  1218. */
  1219. TraceablePeerConnection.prototype.getLocalSSRC = function(localTrack) {
  1220. const ssrcInfo = this._getSSRC(localTrack.rtcId);
  1221. return ssrcInfo && ssrcInfo.ssrcs[0];
  1222. };
  1223. /**
  1224. * When doing unified plan simulcast, we'll have a set of ssrcs but no ssrc-groups on Firefox. Unfortunately, Jicofo
  1225. * will complain if it sees ssrcs with matching msids but no ssrc-group, so a ssrc-group line is injected to make
  1226. * Jicofo happy.
  1227. *
  1228. * @param desc A session description object (with 'type' and 'sdp' fields)
  1229. * @return A session description object with its sdp field modified to contain an inject ssrc-group for simulcast.
  1230. */
  1231. TraceablePeerConnection.prototype._injectSsrcGroupForUnifiedSimulcast = function(desc) {
  1232. const sdp = transform.parse(desc.sdp);
  1233. const video = sdp.media.find(mline => mline.type === 'video');
  1234. // Check if the browser supports RTX, add only the primary ssrcs to the SIM group if that is the case.
  1235. video.ssrcGroups = video.ssrcGroups || [];
  1236. const fidGroups = video.ssrcGroups.filter(group => group.semantics === 'FID');
  1237. if (video.simulcast || video.simulcast_03) {
  1238. const ssrcs = [];
  1239. if (fidGroups && fidGroups.length) {
  1240. fidGroups.forEach(group => {
  1241. ssrcs.push(group.ssrcs.split(' ')[0]);
  1242. });
  1243. } else {
  1244. video.ssrcs.forEach(ssrc => {
  1245. if (ssrc.attribute === 'msid') {
  1246. ssrcs.push(ssrc.id);
  1247. }
  1248. });
  1249. }
  1250. if (video.ssrcGroups.find(group => group.semantics === 'SIM')) {
  1251. // Group already exists, no need to do anything
  1252. return desc;
  1253. }
  1254. // Add a SIM group for every 3 FID groups.
  1255. for (let i = 0; i < ssrcs.length; i += 3) {
  1256. const simSsrcs = ssrcs.slice(i, i + 3);
  1257. video.ssrcGroups.push({
  1258. semantics: 'SIM',
  1259. ssrcs: simSsrcs.join(' ')
  1260. });
  1261. }
  1262. }
  1263. return new RTCSessionDescription({
  1264. type: desc.type,
  1265. sdp: transform.write(sdp)
  1266. });
  1267. };
  1268. /* eslint-disable-next-line vars-on-top */
  1269. const getters = {
  1270. signalingState() {
  1271. return this.peerconnection.signalingState;
  1272. },
  1273. iceConnectionState() {
  1274. return this.peerconnection.iceConnectionState;
  1275. },
  1276. connectionState() {
  1277. return this.peerconnection.connectionState;
  1278. },
  1279. localDescription() {
  1280. let desc = this.peerconnection.localDescription;
  1281. if (!desc) {
  1282. logger.debug(`${this} getLocalDescription no localDescription found`);
  1283. return {};
  1284. }
  1285. this.trace('getLocalDescription::preTransform', dumpSDP(desc));
  1286. // If the browser is running in unified plan mode and this is a jvb connection,
  1287. // transform the SDP to Plan B first.
  1288. if (this._usesUnifiedPlan && !this.isP2P) {
  1289. desc = this.interop.toPlanB(desc);
  1290. this.trace('getLocalDescription::postTransform (Plan B)',
  1291. dumpSDP(desc));
  1292. desc = this._injectSsrcGroupForUnifiedSimulcast(desc);
  1293. this.trace('getLocalDescription::postTransform (inject ssrc group)',
  1294. dumpSDP(desc));
  1295. } else if (!this._usesUnifiedPlan) {
  1296. if (browser.doesVideoMuteByStreamRemove()) {
  1297. desc = this.localSdpMunger.maybeAddMutedLocalVideoTracksToSDP(desc);
  1298. logger.debug(
  1299. 'getLocalDescription::postTransform (munge local SDP)', desc);
  1300. }
  1301. // What comes out of this getter will be signalled over Jingle to
  1302. // the other peer, so we need to make sure the media direction is
  1303. // 'sendrecv' because we won't change the direction later and don't want
  1304. // the other peer to think we can't send or receive.
  1305. //
  1306. // Note that the description we set in chrome does have the accurate
  1307. // direction (e.g. 'recvonly'), since that is technically what is
  1308. // happening (check setLocalDescription impl).
  1309. desc = enforceSendRecv(desc, this.options);
  1310. }
  1311. // See the method's doc for more info about this transformation.
  1312. desc = this.localSdpMunger.transformStreamIdentifiers(desc);
  1313. return desc;
  1314. },
  1315. remoteDescription() {
  1316. let desc = this.peerconnection.remoteDescription;
  1317. if (!desc) {
  1318. logger.debug(`${this} getRemoteDescription no remoteDescription found`);
  1319. return {};
  1320. }
  1321. this.trace('getRemoteDescription::preTransform', dumpSDP(desc));
  1322. if (this._usesUnifiedPlan) {
  1323. if (this.isP2P) {
  1324. // Adjust the media direction for p2p based on whether a local source has been added.
  1325. desc = this._adjustRemoteMediaDirection(desc);
  1326. } else {
  1327. // If this is a jvb connection, transform the SDP to Plan B first.
  1328. desc = this.interop.toPlanB(desc);
  1329. this.trace('getRemoteDescription::postTransform (Plan B)', dumpSDP(desc));
  1330. }
  1331. }
  1332. return desc;
  1333. }
  1334. };
  1335. Object.keys(getters).forEach(prop => {
  1336. Object.defineProperty(
  1337. TraceablePeerConnection.prototype,
  1338. prop, {
  1339. get: getters[prop]
  1340. }
  1341. );
  1342. });
  1343. TraceablePeerConnection.prototype._getSSRC = function(rtcId) {
  1344. return this.localSSRCs.get(rtcId);
  1345. };
  1346. /**
  1347. * Checks if low fps screensharing is in progress.
  1348. *
  1349. * @private
  1350. * @returns {boolean} Returns true if 5 fps screensharing is in progress, false otherwise.
  1351. */
  1352. TraceablePeerConnection.prototype.isSharingLowFpsScreen = function() {
  1353. return this._isSharingScreen() && this._capScreenshareBitrate;
  1354. };
  1355. /**
  1356. * Checks if screensharing is in progress.
  1357. *
  1358. * @returns {boolean} Returns true if a desktop track has been added to the peerconnection, false otherwise.
  1359. */
  1360. TraceablePeerConnection.prototype._isSharingScreen = function() {
  1361. const tracks = this.getLocalVideoTracks();
  1362. return Boolean(tracks.find(track => track.videoType === VideoType.DESKTOP));
  1363. };
  1364. /**
  1365. * Munges the order of the codecs in the SDP passed based on the preference
  1366. * set through config.js settings. All instances of the specified codec are
  1367. * moved up to the top of the list when it is preferred. The specified codec
  1368. * is deleted from the list if the configuration specifies that the codec be
  1369. * disabled.
  1370. * @param {RTCSessionDescription} description that needs to be munged.
  1371. * @returns {RTCSessionDescription} the munged description.
  1372. */
  1373. TraceablePeerConnection.prototype._mungeCodecOrder = function(description) {
  1374. if (!this.codecPreference) {
  1375. return description;
  1376. }
  1377. const parsedSdp = transform.parse(description.sdp);
  1378. // Only the m-line that defines the source the browser will be sending should need to change.
  1379. // This is typically the first m-line with the matching media type.
  1380. const mLine = parsedSdp.media.find(m => m.type === this.codecPreference.mediaType);
  1381. if (!mLine) {
  1382. return description;
  1383. }
  1384. if (this.codecPreference.enable) {
  1385. SDPUtil.preferCodec(mLine, this.codecPreference.mimeType);
  1386. // Strip the high profile H264 codecs on mobile clients for p2p connection.
  1387. // High profile codecs give better quality at the expense of higher load which
  1388. // we do not want on mobile clients.
  1389. // Jicofo offers only the baseline code for the jvb connection.
  1390. // TODO - add check for mobile browsers once js-utils provides that check.
  1391. if (this.codecPreference.mimeType === CodecMimeType.H264 && browser.isReactNative() && this.isP2P) {
  1392. SDPUtil.stripCodec(mLine, this.codecPreference.mimeType, true /* high profile */);
  1393. }
  1394. } else {
  1395. SDPUtil.stripCodec(mLine, this.codecPreference.mimeType);
  1396. }
  1397. return new RTCSessionDescription({
  1398. type: description.type,
  1399. sdp: transform.write(parsedSdp)
  1400. });
  1401. };
  1402. /**
  1403. * Add {@link JitsiLocalTrack} to this TPC.
  1404. * @param {JitsiLocalTrack} track
  1405. * @param {boolean} isInitiator indicates if the endpoint is the offerer.
  1406. * @returns {Promise<void>} - resolved when done.
  1407. */
  1408. TraceablePeerConnection.prototype.addTrack = function(track, isInitiator = false) {
  1409. const rtcId = track.rtcId;
  1410. logger.info(`${this} adding ${track}`);
  1411. if (this.localTracks.has(rtcId)) {
  1412. return Promise.reject(new Error(`${track} is already in ${this}`));
  1413. }
  1414. this.localTracks.set(rtcId, track);
  1415. const webrtcStream = track.getOriginalStream();
  1416. if (this._usesUnifiedPlan) {
  1417. logger.debug(`${this} TPC.addTrack using unified plan`);
  1418. try {
  1419. this.tpcUtils.addTrack(track, isInitiator);
  1420. if (track) {
  1421. if (track.isAudioTrack()) {
  1422. this._hasHadAudioTrack = true;
  1423. } else {
  1424. this._hasHadVideoTrack = true;
  1425. }
  1426. }
  1427. } catch (error) {
  1428. logger.error(`${this} Adding track=${track} failed: ${error?.message}`);
  1429. return Promise.reject(error);
  1430. }
  1431. } else {
  1432. // Use addStream API for the plan-b case.
  1433. if (webrtcStream) {
  1434. this._addStream(webrtcStream);
  1435. // It's not ok for a track to not have a WebRTC stream if:
  1436. } else if (!browser.doesVideoMuteByStreamRemove()
  1437. || track.isAudioTrack()
  1438. || (track.isVideoTrack() && !track.isMuted())) {
  1439. return Promise.reject(new Error(`${this} no WebRTC stream for track=${track}`));
  1440. }
  1441. // Muted video tracks do not have WebRTC stream
  1442. if (browser.doesVideoMuteByStreamRemove() && track.isVideoTrack() && track.isMuted()) {
  1443. const ssrcInfo = this.generateNewStreamSSRCInfo(track);
  1444. this.sdpConsistency.setPrimarySsrc(ssrcInfo.ssrcs[0]);
  1445. const simGroup
  1446. = ssrcInfo.groups.find(groupInfo => groupInfo.semantics === 'SIM');
  1447. if (simGroup) {
  1448. this.simulcast.setSsrcCache(simGroup.ssrcs);
  1449. }
  1450. const fidGroups
  1451. = ssrcInfo.groups.filter(
  1452. groupInfo => groupInfo.semantics === 'FID');
  1453. if (fidGroups) {
  1454. const rtxSsrcMapping = new Map();
  1455. fidGroups.forEach(fidGroup => {
  1456. const primarySsrc = fidGroup.ssrcs[0];
  1457. const rtxSsrc = fidGroup.ssrcs[1];
  1458. rtxSsrcMapping.set(primarySsrc, rtxSsrc);
  1459. });
  1460. this.rtxModifier.setSsrcCache(rtxSsrcMapping);
  1461. }
  1462. }
  1463. }
  1464. let promiseChain = Promise.resolve();
  1465. // On Firefox, the encodings have to be configured on the sender only after the transceiver is created.
  1466. if (browser.isFirefox()) {
  1467. promiseChain = promiseChain.then(() => webrtcStream && this.tpcUtils.setEncodings(track));
  1468. }
  1469. return promiseChain;
  1470. };
  1471. /**
  1472. * Adds local track to the RTCPeerConnection.
  1473. *
  1474. * @param {JitsiLocalTrack} track the track to be added to the pc.
  1475. * @return {Promise<boolean>} Promise that resolves to true if the underlying PeerConnection's state has changed and
  1476. * renegotiation is required, false if no renegotiation is needed or Promise is rejected when something goes wrong.
  1477. */
  1478. TraceablePeerConnection.prototype.addTrackToPc = function(track) {
  1479. logger.info(`${this} Adding track=${track} to PC`);
  1480. if (!this._assertTrackBelongs('addTrackToPc', track)) {
  1481. // Abort
  1482. return Promise.reject('Track not found on the peerconnection');
  1483. }
  1484. const webRtcStream = track.getOriginalStream();
  1485. if (!webRtcStream) {
  1486. logger.error(`${this} Unable to add track=${track} to PC - no WebRTC stream`);
  1487. return Promise.reject('Stream not found');
  1488. }
  1489. if (this._usesUnifiedPlan) {
  1490. return this.tpcUtils.replaceTrack(null, track).then(() => {
  1491. if (track) {
  1492. if (track.isAudioTrack()) {
  1493. this._hasHadAudioTrack = true;
  1494. } else {
  1495. this._hasHadVideoTrack = true;
  1496. }
  1497. }
  1498. return false;
  1499. });
  1500. }
  1501. this._addStream(webRtcStream);
  1502. return Promise.resolve(true);
  1503. };
  1504. /**
  1505. * Adds WebRTC media stream to the underlying PeerConnection
  1506. * @param {MediaStream} mediaStream
  1507. * @private
  1508. */
  1509. TraceablePeerConnection.prototype._addStream = function(mediaStream) {
  1510. this.peerconnection.addStream(mediaStream);
  1511. this._addedStreams.push(mediaStream);
  1512. };
  1513. /**
  1514. * Removes WebRTC media stream from the underlying PeerConection
  1515. * @param {MediaStream} mediaStream
  1516. */
  1517. TraceablePeerConnection.prototype._removeStream = function(mediaStream) {
  1518. this.peerconnection.removeStream(mediaStream);
  1519. this._addedStreams
  1520. = this._addedStreams.filter(stream => stream !== mediaStream);
  1521. };
  1522. /**
  1523. * This method when called will check if given <tt>localTrack</tt> belongs to
  1524. * this TPC (that it has been previously added using {@link addTrack}). If the
  1525. * track does not belong an error message will be logged.
  1526. * @param {string} methodName the method name that will be logged in an error
  1527. * message
  1528. * @param {JitsiLocalTrack} localTrack
  1529. * @return {boolean} <tt>true</tt> if given local track belongs to this TPC or
  1530. * <tt>false</tt> otherwise.
  1531. * @private
  1532. */
  1533. TraceablePeerConnection.prototype._assertTrackBelongs = function(
  1534. methodName,
  1535. localTrack) {
  1536. const doesBelong = this.localTracks.has(localTrack?.rtcId);
  1537. if (!doesBelong) {
  1538. logger.error(`${this} ${methodName}: track=${localTrack} does not belong to pc`);
  1539. }
  1540. return doesBelong;
  1541. };
  1542. /**
  1543. * Returns the codec that is configured on the client as the preferred video codec.
  1544. * This takes into account the current order of codecs in the local description sdp.
  1545. *
  1546. * @returns {CodecMimeType} The codec that is set as the preferred codec to receive
  1547. * video in the local SDP.
  1548. */
  1549. TraceablePeerConnection.prototype.getConfiguredVideoCodec = function() {
  1550. const sdp = this.peerconnection.localDescription?.sdp;
  1551. const defaultCodec = CodecMimeType.VP8;
  1552. if (!sdp) {
  1553. return defaultCodec;
  1554. }
  1555. const parsedSdp = transform.parse(sdp);
  1556. const mLine = parsedSdp.media.find(m => m.type === MediaType.VIDEO);
  1557. const codec = mLine.rtp[0].codec;
  1558. if (codec) {
  1559. return Object.values(CodecMimeType).find(value => value === codec.toLowerCase());
  1560. }
  1561. return defaultCodec;
  1562. };
  1563. /**
  1564. * Enables or disables simulcast for screenshare based on the frame rate requested for desktop track capture.
  1565. *
  1566. * @param {number} maxFps framerate to be used for desktop track capture.
  1567. */
  1568. TraceablePeerConnection.prototype.setDesktopSharingFrameRate = function(maxFps) {
  1569. const lowFps = maxFps <= SS_DEFAULT_FRAME_RATE;
  1570. this._capScreenshareBitrate = this.isSimulcastOn() && lowFps;
  1571. };
  1572. /**
  1573. * Sets the codec preference on the peerconnection. The codec preference goes into effect when
  1574. * the next renegotiation happens.
  1575. *
  1576. * @param {CodecMimeType} preferredCodec the preferred codec.
  1577. * @param {CodecMimeType} disabledCodec the codec that needs to be disabled.
  1578. * @returns {void}
  1579. */
  1580. TraceablePeerConnection.prototype.setVideoCodecs = function(preferredCodec = null, disabledCodec = null) {
  1581. // If both enable and disable are set, disable settings will prevail.
  1582. const enable = disabledCodec === null;
  1583. const mimeType = disabledCodec ? disabledCodec : preferredCodec;
  1584. if (this.codecPreference && (preferredCodec || disabledCodec)) {
  1585. this.codecPreference.enable = enable;
  1586. this.codecPreference.mimeType = mimeType;
  1587. } else if (preferredCodec || disabledCodec) {
  1588. this.codecPreference = {
  1589. enable,
  1590. mediaType: MediaType.VIDEO,
  1591. mimeType
  1592. };
  1593. } else {
  1594. logger.warn(`${this} Invalid codec settings[preferred=${preferredCodec},disabled=${disabledCodec}],
  1595. atleast one value is needed`);
  1596. }
  1597. };
  1598. /**
  1599. * Tells if the given WebRTC <tt>MediaStream</tt> has been added to
  1600. * the underlying WebRTC PeerConnection.
  1601. * @param {MediaStream} mediaStream
  1602. * @returns {boolean}
  1603. */
  1604. TraceablePeerConnection.prototype.isMediaStreamInPc = function(mediaStream) {
  1605. return this._addedStreams.indexOf(mediaStream) > -1;
  1606. };
  1607. /**
  1608. * Remove local track from this TPC.
  1609. * @param {JitsiLocalTrack} localTrack the track to be removed from this TPC.
  1610. *
  1611. * FIXME It should probably remove a boolean just like {@link removeTrackFromPc}
  1612. * The same applies to addTrack.
  1613. */
  1614. TraceablePeerConnection.prototype.removeTrack = function(localTrack) {
  1615. const webRtcStream = localTrack.getOriginalStream();
  1616. this.trace(
  1617. 'removeStream',
  1618. localTrack.rtcId, webRtcStream ? webRtcStream.id : undefined);
  1619. if (!this._assertTrackBelongs('removeStream', localTrack)) {
  1620. // Abort - nothing to be done here
  1621. return;
  1622. }
  1623. this.localTracks.delete(localTrack.rtcId);
  1624. this.localSSRCs.delete(localTrack.rtcId);
  1625. if (webRtcStream) {
  1626. this.peerconnection.removeStream(webRtcStream);
  1627. }
  1628. };
  1629. /**
  1630. * Returns the sender corresponding to the given media type.
  1631. * @param {MEDIA_TYPE} mediaType - The media type 'audio' or 'video' to be used for the search.
  1632. * @returns {RTPSender|undefined} - The found sender or undefined if no sender
  1633. * was found.
  1634. */
  1635. TraceablePeerConnection.prototype.findSenderByKind = function(mediaType) {
  1636. if (this.peerconnection.getSenders) {
  1637. return this.peerconnection.getSenders().find(s => s.track && s.track.kind === mediaType);
  1638. }
  1639. };
  1640. /**
  1641. * Returns the receiver corresponding to the given MediaStreamTrack.
  1642. *
  1643. * @param {MediaSreamTrack} track - The media stream track used for the search.
  1644. * @returns {RTCRtpReceiver|undefined} - The found receiver or undefined if no receiver
  1645. * was found.
  1646. */
  1647. TraceablePeerConnection.prototype.findReceiverForTrack = function(track) {
  1648. return this.peerconnection.getReceivers().find(r => r.track === track);
  1649. };
  1650. /**
  1651. * Returns the sender corresponding to the given MediaStreamTrack.
  1652. *
  1653. * @param {MediaSreamTrack} track - The media stream track used for the search.
  1654. * @returns {RTCRtpSender|undefined} - The found sender or undefined if no sender
  1655. * was found.
  1656. */
  1657. TraceablePeerConnection.prototype.findSenderForTrack = function(track) {
  1658. if (this.peerconnection.getSenders) {
  1659. return this.peerconnection.getSenders().find(s => s.track === track);
  1660. }
  1661. };
  1662. /**
  1663. * Processes the local description SDP and caches the mids of the mlines associated with the given tracks.
  1664. *
  1665. * @param {Array<JitsiLocalTrack>} localTracks - local tracks that are added to the peerconnection.
  1666. * @returns {void}
  1667. */
  1668. TraceablePeerConnection.prototype.processLocalSdpForTransceiverInfo = function(localTracks) {
  1669. const localSdp = this.peerconnection.localDescription?.sdp;
  1670. if (!localSdp) {
  1671. return;
  1672. }
  1673. for (const localTrack of localTracks) {
  1674. const mediaType = localTrack.getType();
  1675. const parsedSdp = transform.parse(localSdp);
  1676. const mLine = parsedSdp.media.find(mline => mline.type === mediaType);
  1677. if (!this._localTrackTransceiverMids.has(localTrack.rtcId)) {
  1678. this._localTrackTransceiverMids.set(localTrack.rtcId, mLine.mid.toString());
  1679. }
  1680. }
  1681. };
  1682. /**
  1683. * Replaces <tt>oldTrack</tt> with <tt>newTrack</tt> from the peer connection.
  1684. * Either <tt>oldTrack</tt> or <tt>newTrack</tt> can be null; replacing a valid
  1685. * <tt>oldTrack</tt> with a null <tt>newTrack</tt> effectively just removes
  1686. * <tt>oldTrack</tt>
  1687. *
  1688. * @param {JitsiLocalTrack|null} oldTrack - The current track in use to be replaced on the pc.
  1689. * @param {JitsiLocalTrack|null} newTrack - The new track to be used.
  1690. *
  1691. * @returns {Promise<boolean>} - If the promise resolves with true, renegotiation will be needed.
  1692. * Otherwise no renegotiation is needed.
  1693. */
  1694. TraceablePeerConnection.prototype.replaceTrack = function(oldTrack, newTrack) {
  1695. if (!(oldTrack || newTrack)) {
  1696. logger.info(`${this} replaceTrack called with no new track and no old track`);
  1697. return Promise.resolve();
  1698. }
  1699. if (this._usesUnifiedPlan) {
  1700. logger.debug(`${this} TPC.replaceTrack using unified plan`);
  1701. const mediaType = newTrack?.getType() ?? oldTrack?.getType();
  1702. return this.tpcUtils.replaceTrack(oldTrack, newTrack)
  1703. .then(transceiver => {
  1704. if (oldTrack) {
  1705. this.localTracks.delete(oldTrack.rtcId);
  1706. this._localTrackTransceiverMids.delete(oldTrack.rtcId);
  1707. }
  1708. if (newTrack) {
  1709. if (newTrack.isAudioTrack()) {
  1710. this._hasHadAudioTrack = true;
  1711. } else {
  1712. this._hasHadVideoTrack = true;
  1713. }
  1714. this._localTrackTransceiverMids.set(newTrack.rtcId, transceiver?.mid?.toString());
  1715. this.localTracks.set(newTrack.rtcId, newTrack);
  1716. }
  1717. // Update the local SSRC cache for the case when one track gets replaced with another and no
  1718. // renegotiation is triggered as a result of this.
  1719. if (oldTrack && newTrack) {
  1720. const oldTrackSSRC = this.localSSRCs.get(oldTrack.rtcId);
  1721. if (oldTrackSSRC) {
  1722. this.localSSRCs.delete(oldTrack.rtcId);
  1723. this.localSSRCs.set(newTrack.rtcId, oldTrackSSRC);
  1724. }
  1725. }
  1726. const mediaActive = mediaType === MediaType.AUDIO
  1727. ? this.audioTransferActive
  1728. : this.videoTransferActive;
  1729. // Set the transceiver direction only if media is not suspended on the connection. This happens when
  1730. // the client is using the p2p connection. Transceiver direction is updated when media is resumed on
  1731. // this connection again.
  1732. if (transceiver && mediaActive) {
  1733. // In the scenario where we remove the oldTrack (oldTrack is not null and newTrack is null) on FF
  1734. // if we change the direction to RECVONLY, create answer will generate SDP with only 1 receive
  1735. // only ssrc instead of keeping all 6 ssrcs that we currently have. Stopping the screen sharing
  1736. // and then starting it again will trigger 2 rounds of source-remove and source-add replacing
  1737. // the 6 ssrcs for the screen sharing with 1 receive only ssrc and then removing the receive
  1738. // only ssrc and adding the same 6 ssrcs. On the remote participant's side the same ssrcs will
  1739. // be reused on a new m-line and if the remote participant is FF due to
  1740. // https://bugzilla.mozilla.org/show_bug.cgi?id=1768729 the video stream won't be rendered.
  1741. // That's why we need keep the direction to SENDRECV for FF.
  1742. //
  1743. // NOTE: If we return back to the approach of not removing the track for FF and instead using the
  1744. // enabled property for mute or stopping screensharing we may need to change the direction to
  1745. // RECVONLY if FF still sends the media even though the enabled flag is set to false.
  1746. transceiver.direction
  1747. = newTrack || browser.isFirefox() ? MediaDirection.SENDRECV : MediaDirection.RECVONLY;
  1748. } else if (transceiver) {
  1749. transceiver.direction = MediaDirection.INACTIVE;
  1750. }
  1751. // Avoid configuring the encodings on Chromium/Safari until simulcast is configured
  1752. // for the newly added track using SDP munging which happens during the renegotiation.
  1753. const configureEncodingsPromise = browser.usesSdpMungingForSimulcast() || !newTrack
  1754. ? Promise.resolve()
  1755. : this.tpcUtils.setEncodings(newTrack);
  1756. return configureEncodingsPromise.then(() => false);
  1757. });
  1758. }
  1759. logger.debug(`${this} TPC.replaceTrack using plan B`);
  1760. let promiseChain = Promise.resolve();
  1761. if (oldTrack) {
  1762. this.removeTrack(oldTrack);
  1763. }
  1764. if (newTrack) {
  1765. promiseChain = this.addTrack(newTrack);
  1766. }
  1767. return promiseChain.then(() => true);
  1768. };
  1769. /**
  1770. * Removes local track from the RTCPeerConnection.
  1771. *
  1772. * @param {JitsiLocalTrack} localTrack the local track to be removed.
  1773. * @return {Promise<boolean>} Promise that resolves to true if the underlying PeerConnection's state has changed and
  1774. * renegotiation is required, false if no renegotiation is needed or Promise is rejected when something goes wrong.
  1775. */
  1776. TraceablePeerConnection.prototype.removeTrackFromPc = function(localTrack) {
  1777. const webRtcStream = localTrack.getOriginalStream();
  1778. this.trace('removeTrack', localTrack.rtcId, webRtcStream ? webRtcStream.id : null);
  1779. if (!this._assertTrackBelongs('removeTrack', localTrack)) {
  1780. // Abort - nothing to be done here
  1781. return Promise.reject('Track not found in the peerconnection');
  1782. }
  1783. if (this._usesUnifiedPlan) {
  1784. return this.tpcUtils.replaceTrack(localTrack, null).then(() => false);
  1785. }
  1786. if (webRtcStream) {
  1787. logger.info(`${this} Removing track=${localTrack} from PC`);
  1788. this._removeStream(webRtcStream);
  1789. return Promise.resolve(true);
  1790. }
  1791. logger.error(`${this} removeTrack - no WebRTC stream for track=${localTrack}`);
  1792. return Promise.reject('Stream not found');
  1793. };
  1794. TraceablePeerConnection.prototype.createDataChannel = function(label, opts) {
  1795. this.trace('createDataChannel', label, opts);
  1796. return this.peerconnection.createDataChannel(label, opts);
  1797. };
  1798. /**
  1799. * Ensures that the simulcast ssrc-group appears after any other ssrc-groups
  1800. * in the SDP so that simulcast is properly activated.
  1801. *
  1802. * @param {Object} localSdp the WebRTC session description instance for
  1803. * the local description.
  1804. * @private
  1805. */
  1806. TraceablePeerConnection.prototype._ensureSimulcastGroupIsLast = function(localSdp) {
  1807. let sdpStr = localSdp.sdp;
  1808. const videoStartIndex = sdpStr.indexOf('m=video');
  1809. const simStartIndex = sdpStr.indexOf('a=ssrc-group:SIM', videoStartIndex);
  1810. let otherStartIndex = sdpStr.lastIndexOf('a=ssrc-group');
  1811. if (simStartIndex === -1
  1812. || otherStartIndex === -1
  1813. || otherStartIndex === simStartIndex) {
  1814. return localSdp;
  1815. }
  1816. const simEndIndex = sdpStr.indexOf('\r\n', simStartIndex);
  1817. const simStr = sdpStr.substring(simStartIndex, simEndIndex + 2);
  1818. sdpStr = sdpStr.replace(simStr, '');
  1819. otherStartIndex = sdpStr.lastIndexOf('a=ssrc-group');
  1820. const otherEndIndex = sdpStr.indexOf('\r\n', otherStartIndex);
  1821. const sdpHead = sdpStr.slice(0, otherEndIndex);
  1822. const simStrTrimmed = simStr.trim();
  1823. const sdpTail = sdpStr.slice(otherEndIndex);
  1824. sdpStr = `${sdpHead}\r\n${simStrTrimmed}${sdpTail}`;
  1825. return new RTCSessionDescription({
  1826. type: localSdp.type,
  1827. sdp: sdpStr
  1828. });
  1829. };
  1830. /**
  1831. * Will adjust audio and video media direction in the given SDP object to
  1832. * reflect the current status of the {@link audioTransferActive} and
  1833. * {@link videoTransferActive} flags.
  1834. * @param {RTCSessionDescription} localDescription the WebRTC session description instance for
  1835. * the local description.
  1836. * @private
  1837. */
  1838. TraceablePeerConnection.prototype._adjustLocalMediaDirection = function(localDescription) {
  1839. const transformer = new SdpTransformWrap(localDescription.sdp);
  1840. let modifiedDirection = false;
  1841. const audioMedia = transformer.selectMedia(MediaType.AUDIO)?.[0];
  1842. if (audioMedia) {
  1843. const desiredAudioDirection = this.getDesiredMediaDirection(MediaType.AUDIO);
  1844. if (audioMedia.direction !== desiredAudioDirection) {
  1845. audioMedia.direction = desiredAudioDirection;
  1846. logger.info(`${this} Adjusted local audio direction to ${desiredAudioDirection}`);
  1847. modifiedDirection = true;
  1848. }
  1849. } else {
  1850. logger.warn(`${this} No "audio" media found in the local description`);
  1851. }
  1852. const videoMedia = transformer.selectMedia(MediaType.VIDEO)?.[0];
  1853. if (videoMedia) {
  1854. const desiredVideoDirection = this.getDesiredMediaDirection(MediaType.VIDEO);
  1855. if (videoMedia.direction !== desiredVideoDirection) {
  1856. videoMedia.direction = desiredVideoDirection;
  1857. logger.info(`${this} Adjusted local video direction to ${desiredVideoDirection}`);
  1858. modifiedDirection = true;
  1859. }
  1860. } else {
  1861. logger.warn(`${this} No "video" media found in the local description`);
  1862. }
  1863. if (modifiedDirection) {
  1864. return new RTCSessionDescription({
  1865. type: localDescription.type,
  1866. sdp: transformer.toRawSDP()
  1867. });
  1868. }
  1869. return localDescription;
  1870. };
  1871. /**
  1872. * Adjusts the media direction on the remote description based on availability of local and remote sources in a p2p
  1873. * media connection.
  1874. *
  1875. * @param {RTCSessionDescription} remoteDescription the WebRTC session description instance for the remote description.
  1876. * @returns the transformed remoteDescription.
  1877. * @private
  1878. */
  1879. TraceablePeerConnection.prototype._adjustRemoteMediaDirection = function(remoteDescription) {
  1880. const transformer = new SdpTransformWrap(remoteDescription.sdp);
  1881. [ MediaType.AUDIO, MediaType.VIDEO ].forEach(mediaType => {
  1882. const media = transformer.selectMedia(mediaType)?.[0];
  1883. const hasLocalSource = this.hasAnyTracksOfType(mediaType);
  1884. const hasRemoteSource = this.getRemoteTracks(null, mediaType).length > 0;
  1885. media.direction = hasLocalSource && hasRemoteSource
  1886. ? MediaDirection.SENDRECV
  1887. : hasLocalSource
  1888. ? MediaDirection.RECVONLY
  1889. : hasRemoteSource ? MediaDirection.SENDONLY : MediaDirection.INACTIVE;
  1890. });
  1891. return new RTCSessionDescription({
  1892. type: remoteDescription.type,
  1893. sdp: transformer.toRawSDP()
  1894. });
  1895. };
  1896. /**
  1897. * Munges the stereo flag as well as the opusMaxAverageBitrate in the SDP, based
  1898. * on values set through config.js, if present.
  1899. *
  1900. * @param {RTCSessionDescription} description that needs to be munged.
  1901. * @returns {RTCSessionDescription} the munged description.
  1902. */
  1903. TraceablePeerConnection.prototype._mungeOpus = function(description) {
  1904. const { audioQuality } = this.options;
  1905. if (!audioQuality?.enableOpusDtx && !audioQuality?.stereo && !audioQuality?.opusMaxAverageBitrate) {
  1906. return description;
  1907. }
  1908. const parsedSdp = transform.parse(description.sdp);
  1909. const mLines = parsedSdp.media;
  1910. for (const mLine of mLines) {
  1911. if (mLine.type === 'audio') {
  1912. const { payload } = mLine.rtp.find(protocol => protocol.codec === CodecMimeType.OPUS);
  1913. if (!payload) {
  1914. // eslint-disable-next-line no-continue
  1915. continue;
  1916. }
  1917. let fmtpOpus = mLine.fmtp.find(protocol => protocol.payload === payload);
  1918. if (!fmtpOpus) {
  1919. fmtpOpus = {
  1920. payload,
  1921. config: ''
  1922. };
  1923. }
  1924. const fmtpConfig = transform.parseParams(fmtpOpus.config);
  1925. let sdpChanged = false;
  1926. if (audioQuality?.stereo) {
  1927. fmtpConfig.stereo = 1;
  1928. sdpChanged = true;
  1929. }
  1930. if (audioQuality?.opusMaxAverageBitrate) {
  1931. fmtpConfig.maxaveragebitrate = audioQuality.opusMaxAverageBitrate;
  1932. sdpChanged = true;
  1933. }
  1934. // On Firefox, the OpusDtx enablement has no effect
  1935. if (!browser.isFirefox() && audioQuality?.enableOpusDtx) {
  1936. fmtpConfig.usedtx = 1;
  1937. sdpChanged = true;
  1938. }
  1939. if (!sdpChanged) {
  1940. // eslint-disable-next-line no-continue
  1941. continue;
  1942. }
  1943. let mungedConfig = '';
  1944. for (const key of Object.keys(fmtpConfig)) {
  1945. mungedConfig += `${key}=${fmtpConfig[key]}; `;
  1946. }
  1947. fmtpOpus.config = mungedConfig.trim();
  1948. }
  1949. }
  1950. return new RTCSessionDescription({
  1951. type: description.type,
  1952. sdp: transform.write(parsedSdp)
  1953. });
  1954. };
  1955. /**
  1956. * Munges the SDP to set all directions to inactive and drop all ssrc and ssrc-groups.
  1957. *
  1958. * @param {RTCSessionDescription} description that needs to be munged.
  1959. * @returns {RTCSessionDescription} the munged description.
  1960. */
  1961. TraceablePeerConnection.prototype._mungeInactive = function(description) {
  1962. const parsedSdp = transform.parse(description.sdp);
  1963. const mLines = parsedSdp.media;
  1964. for (const mLine of mLines) {
  1965. mLine.direction = MediaDirection.INACTIVE;
  1966. mLine.ssrcs = undefined;
  1967. mLine.ssrcGroups = undefined;
  1968. }
  1969. return new RTCSessionDescription({
  1970. type: description.type,
  1971. sdp: transform.write(parsedSdp)
  1972. });
  1973. };
  1974. /**
  1975. * Sets up the _dtlsTransport object and initializes callbacks for it.
  1976. */
  1977. TraceablePeerConnection.prototype._initializeDtlsTransport = function() {
  1978. // We are assuming here that we only have one bundled transport here
  1979. if (!this.peerconnection.getSenders || this._dtlsTransport) {
  1980. return;
  1981. }
  1982. const senders = this.peerconnection.getSenders();
  1983. if (senders.length !== 0 && senders[0].transport) {
  1984. this._dtlsTransport = senders[0].transport;
  1985. this._dtlsTransport.onerror = error => {
  1986. logger.error(`${this} DtlsTransport error: ${error}`);
  1987. };
  1988. this._dtlsTransport.onstatechange = () => {
  1989. this.trace('dtlsTransport.onstatechange', this._dtlsTransport.state);
  1990. };
  1991. }
  1992. };
  1993. /**
  1994. * Sets the max bitrates on the video m-lines when VP9 is the selected codec.
  1995. *
  1996. * @param {RTCSessionDescription} description - The local description that needs to be munged.
  1997. * @param {boolean} isLocalSdp - Whether the max bitrate (via b=AS line in SDP) is set on local SDP.
  1998. * @returns RTCSessionDescription
  1999. */
  2000. TraceablePeerConnection.prototype._setVp9MaxBitrates = function(description, isLocalSdp = false) {
  2001. if (!this.codecPreference) {
  2002. return description;
  2003. }
  2004. const parsedSdp = transform.parse(description.sdp);
  2005. // Find all the m-lines associated with the local sources.
  2006. const direction = isLocalSdp ? MediaDirection.RECVONLY : MediaDirection.SENDONLY;
  2007. const mLines = FeatureFlags.isMultiStreamSupportEnabled()
  2008. ? parsedSdp.media.filter(m => m.type === MediaType.VIDEO && m.direction !== direction)
  2009. : [ parsedSdp.media.find(m => m.type === MediaType.VIDEO) ];
  2010. // Find the mid associated with the desktop track so that bitrates can be configured accordingly on the
  2011. // corresponding m-line.
  2012. const getDesktopTrackMid = () => {
  2013. const desktopTrack = this.getLocalVideoTracks().find(track => track.getVideoType() === VideoType.DESKTOP);
  2014. let mid;
  2015. if (desktopTrack) {
  2016. const trackIndex = Number(desktopTrack.getSourceName()?.split('-')[1].substring(1));
  2017. if (typeof trackIndex === 'number') {
  2018. const transceiver = this.peerconnection.getTransceivers()
  2019. .filter(t => t.receiver.track.kind === MediaType.VIDEO
  2020. && t.direction !== MediaDirection.RECVONLY)[trackIndex];
  2021. mid = transceiver?.mid;
  2022. }
  2023. }
  2024. return Number(mid);
  2025. };
  2026. for (const mLine of mLines) {
  2027. if (this.codecPreference.mimeType === CodecMimeType.VP9) {
  2028. const bitrates = this.tpcUtils.videoBitrates.VP9 || this.tpcUtils.videoBitrates;
  2029. const hdBitrate = bitrates.high ? bitrates.high : HD_BITRATE;
  2030. const mid = mLine.mid;
  2031. const isSharingScreen = FeatureFlags.isMultiStreamSupportEnabled()
  2032. ? mid === getDesktopTrackMid()
  2033. : this._isSharingScreen();
  2034. const limit = Math.floor((isSharingScreen ? HD_BITRATE : hdBitrate) / 1000);
  2035. // Use only the HD bitrate for now as there is no API available yet for configuring
  2036. // the bitrates on the individual SVC layers.
  2037. mLine.bandwidth = [ {
  2038. type: 'AS',
  2039. limit
  2040. } ];
  2041. } else {
  2042. // Clear the bandwidth limit in SDP when VP9 is no longer the preferred codec.
  2043. // This is needed on react native clients as react-native-webrtc returns the
  2044. // SDP that the application passed instead of returning the SDP off the native side.
  2045. // This line automatically gets cleared on web on every renegotiation.
  2046. mLine.bandwidth = undefined;
  2047. }
  2048. }
  2049. return new RTCSessionDescription({
  2050. type: description.type,
  2051. sdp: transform.write(parsedSdp)
  2052. });
  2053. };
  2054. /**
  2055. * Configures the stream encodings depending on the video type and the bitrates configured.
  2056. *
  2057. * @param {JitsiLocalTrack} - The local track for which the sender encodings have to configured.
  2058. * @returns {Promise} promise that will be resolved when the operation is successful and rejected otherwise.
  2059. */
  2060. TraceablePeerConnection.prototype.configureSenderVideoEncodings = function(localVideoTrack = null) {
  2061. if (FeatureFlags.isSourceNameSignalingEnabled()) {
  2062. if (localVideoTrack) {
  2063. return this.setSenderVideoConstraints(
  2064. this._senderMaxHeights.get(localVideoTrack.getSourceName()),
  2065. localVideoTrack);
  2066. }
  2067. const promises = [];
  2068. for (const track of this.getLocalVideoTracks()) {
  2069. promises.push(this.setSenderVideoConstraints(this._senderMaxHeights.get(track.getSourceName()), track));
  2070. }
  2071. return Promise.allSettled(promises);
  2072. }
  2073. let localTrack = localVideoTrack;
  2074. if (!localTrack) {
  2075. localTrack = this.getLocalVideoTracks()[0];
  2076. }
  2077. return this.setSenderVideoConstraints(this._senderVideoMaxHeight, localTrack);
  2078. };
  2079. TraceablePeerConnection.prototype.setLocalDescription = function(description) {
  2080. let localDescription = description;
  2081. this.trace('setLocalDescription::preTransform', dumpSDP(localDescription));
  2082. // Munge stereo flag and opusMaxAverageBitrate based on config.js
  2083. localDescription = this._mungeOpus(localDescription);
  2084. if (!this._usesUnifiedPlan) {
  2085. localDescription = this._adjustLocalMediaDirection(localDescription);
  2086. localDescription = this._ensureSimulcastGroupIsLast(localDescription);
  2087. }
  2088. // Munge the order of the codecs based on the preferences set through config.js.
  2089. localDescription = this._mungeCodecOrder(localDescription);
  2090. localDescription = this._setVp9MaxBitrates(localDescription, true);
  2091. this.trace('setLocalDescription::postTransform', dumpSDP(localDescription));
  2092. return new Promise((resolve, reject) => {
  2093. this.peerconnection.setLocalDescription(localDescription)
  2094. .then(() => {
  2095. this.trace('setLocalDescriptionOnSuccess');
  2096. const localUfrag = SDPUtil.getUfrag(localDescription.sdp);
  2097. if (localUfrag !== this.localUfrag) {
  2098. this.localUfrag = localUfrag;
  2099. this.eventEmitter.emit(RTCEvents.LOCAL_UFRAG_CHANGED, this, localUfrag);
  2100. }
  2101. this._initializeDtlsTransport();
  2102. resolve();
  2103. }, err => {
  2104. this.trace('setLocalDescriptionOnFailure', err);
  2105. this.eventEmitter.emit(RTCEvents.SET_LOCAL_DESCRIPTION_FAILED, err, this);
  2106. reject(err);
  2107. });
  2108. });
  2109. };
  2110. /**
  2111. * Enables/disables audio media transmission on this peer connection. When
  2112. * disabled the SDP audio media direction in the local SDP will be adjusted to
  2113. * 'inactive' which means that no data will be sent nor accepted, but
  2114. * the connection should be kept alive.
  2115. * @param {boolean} active <tt>true</tt> to enable audio media transmission or
  2116. * <tt>false</tt> to disable. If the value is not a boolean the call will have
  2117. * no effect.
  2118. * @return {boolean} <tt>true</tt> if the value has changed and sRD/sLD cycle
  2119. * needs to be executed in order for the changes to take effect or
  2120. * <tt>false</tt> if the given value was the same as the previous one.
  2121. * @public
  2122. */
  2123. TraceablePeerConnection.prototype.setAudioTransferActive = function(active) {
  2124. logger.debug(`${this} audio transfer active: ${active}`);
  2125. const changed = this.audioTransferActive !== active;
  2126. this.audioTransferActive = active;
  2127. if (this._usesUnifiedPlan) {
  2128. this.tpcUtils.setAudioTransferActive(active);
  2129. // false means no renegotiation up the chain which is not needed in the Unified mode
  2130. return false;
  2131. }
  2132. return changed;
  2133. };
  2134. TraceablePeerConnection.prototype.setRemoteDescription = function(description) {
  2135. let remoteDescription = description;
  2136. this.trace('setRemoteDescription::preTransform', dumpSDP(description));
  2137. // Munge stereo flag and opusMaxAverageBitrate based on config.js
  2138. remoteDescription = this._mungeOpus(remoteDescription);
  2139. if (this._usesUnifiedPlan) {
  2140. // Translate the SDP to Unified plan format first for the jvb case, p2p case will only have 2 m-lines.
  2141. if (!this.isP2P) {
  2142. const currentDescription = this.peerconnection.remoteDescription;
  2143. remoteDescription = this.interop.toUnifiedPlan(remoteDescription, currentDescription);
  2144. this.trace('setRemoteDescription::postTransform (Unified)', dumpSDP(remoteDescription));
  2145. if (FeatureFlags.isRunInLiteModeEnabled()) {
  2146. remoteDescription = this._mungeInactive(remoteDescription);
  2147. }
  2148. }
  2149. if (this.isSimulcastOn()) {
  2150. remoteDescription = this.tpcUtils.insertUnifiedPlanSimulcastReceive(remoteDescription);
  2151. this.trace('setRemoteDescription::postTransform (sim receive)', dumpSDP(remoteDescription));
  2152. }
  2153. remoteDescription = this.tpcUtils.ensureCorrectOrderOfSsrcs(remoteDescription);
  2154. this.trace('setRemoteDescription::postTransform (correct ssrc order)', dumpSDP(remoteDescription));
  2155. } else {
  2156. if (this.isSimulcastOn()) {
  2157. // Implode the simulcast ssrcs so that the remote sdp has only the first ssrc in the SIM group.
  2158. remoteDescription = this.simulcast.mungeRemoteDescription(
  2159. remoteDescription,
  2160. true /* add x-google-conference flag */);
  2161. this.trace('setRemoteDescription::postTransform (simulcast)', dumpSDP(remoteDescription));
  2162. }
  2163. remoteDescription = normalizePlanB(remoteDescription);
  2164. }
  2165. // Munge the order of the codecs based on the preferences set through config.js.
  2166. remoteDescription = this._mungeCodecOrder(remoteDescription);
  2167. remoteDescription = this._setVp9MaxBitrates(remoteDescription);
  2168. this.trace('setRemoteDescription::postTransform (munge codec order)', dumpSDP(remoteDescription));
  2169. return new Promise((resolve, reject) => {
  2170. this.peerconnection.setRemoteDescription(remoteDescription)
  2171. .then(() => {
  2172. this.trace('setRemoteDescriptionOnSuccess');
  2173. const remoteUfrag = SDPUtil.getUfrag(remoteDescription.sdp);
  2174. if (remoteUfrag !== this.remoteUfrag) {
  2175. this.remoteUfrag = remoteUfrag;
  2176. this.eventEmitter.emit(RTCEvents.REMOTE_UFRAG_CHANGED, this, remoteUfrag);
  2177. }
  2178. this._initializeDtlsTransport();
  2179. resolve();
  2180. }, err => {
  2181. this.trace('setRemoteDescriptionOnFailure', err);
  2182. this.eventEmitter.emit(RTCEvents.SET_REMOTE_DESCRIPTION_FAILED, err, this);
  2183. reject(err);
  2184. });
  2185. });
  2186. };
  2187. /**
  2188. * Changes the resolution of the video stream that is sent to the peer based on the resolution requested by the peer
  2189. * and user preference, sets the degradation preference on the sender based on the video type, configures the maximum
  2190. * bitrates on the send stream.
  2191. *
  2192. * @param {number} frameHeight - The max frame height to be imposed on the outgoing video stream.
  2193. * @param {JitsiLocalTrack} - The local track for which the sender constraints have to be applied.
  2194. * @returns {Promise} promise that will be resolved when the operation is successful and rejected otherwise.
  2195. */
  2196. TraceablePeerConnection.prototype.setSenderVideoConstraints = function(frameHeight, localVideoTrack) {
  2197. if (frameHeight < 0) {
  2198. throw new Error(`Invalid frameHeight: ${frameHeight}`);
  2199. }
  2200. // XXX: This is not yet supported on mobile.
  2201. if (browser.isReactNative()) {
  2202. return Promise.resolve();
  2203. }
  2204. if (FeatureFlags.isSourceNameSignalingEnabled()) {
  2205. this._senderMaxHeights.set(localVideoTrack.getSourceName(), frameHeight);
  2206. } else {
  2207. this._senderVideoMaxHeight = frameHeight;
  2208. }
  2209. if (!localVideoTrack || localVideoTrack.isMuted()) {
  2210. return Promise.resolve();
  2211. }
  2212. const videoSender = this.findSenderForTrack(localVideoTrack.getTrack());
  2213. if (!videoSender) {
  2214. return Promise.resolve();
  2215. }
  2216. const parameters = videoSender.getParameters();
  2217. if (!parameters?.encodings?.length) {
  2218. return Promise.resolve();
  2219. }
  2220. const isSharingLowFpsScreen = localVideoTrack.getVideoType() === VideoType.DESKTOP && this._capScreenshareBitrate;
  2221. // Set the degradation preference.
  2222. const preference = isSharingLowFpsScreen
  2223. ? DEGRADATION_PREFERENCE_DESKTOP // Prefer resolution for low fps share.
  2224. : DEGRADATION_PREFERENCE_CAMERA; // Prefer frame-rate for high fps share and camera.
  2225. parameters.degradationPreference = preference;
  2226. logger.info(`${this} Setting degradation preference [preference=${preference},track=${localVideoTrack}`);
  2227. // Calculate the encodings active state based on the resolution requested by the bridge.
  2228. this.encodingsEnabledState = this.tpcUtils.calculateEncodingsActiveState(localVideoTrack, frameHeight);
  2229. const maxBitrates = this.tpcUtils.calculateEncodingsBitrates(localVideoTrack);
  2230. const videoType = localVideoTrack.getVideoType();
  2231. if (this.isSimulcastOn()) {
  2232. for (const encoding in parameters.encodings) {
  2233. if (parameters.encodings.hasOwnProperty(encoding)) {
  2234. parameters.encodings[encoding].active = this.encodingsEnabledState[encoding];
  2235. // Firefox doesn't follow the spec and lets application specify the degradation preference on the
  2236. // encodings.
  2237. browser.isFirefox() && (parameters.encodings[encoding].degradationPreference = preference);
  2238. if (this.getConfiguredVideoCodec() === CodecMimeType.VP8
  2239. && (this.options?.videoQuality?.maxBitratesVideo
  2240. || isSharingLowFpsScreen
  2241. || this._usesUnifiedPlan)) {
  2242. parameters.encodings[encoding].maxBitrate = maxBitrates[encoding];
  2243. }
  2244. }
  2245. }
  2246. this.tpcUtils.updateEncodingsResolution(parameters);
  2247. // For p2p and cases and where simulcast is explicitly disabled.
  2248. } else if (frameHeight > 0) {
  2249. let scaleFactor = HD_SCALE_FACTOR;
  2250. // Do not scale down encodings for desktop tracks for non-simulcast case.
  2251. if (videoType === VideoType.CAMERA && localVideoTrack.resolution > frameHeight) {
  2252. scaleFactor = Math.floor(localVideoTrack.resolution / frameHeight);
  2253. }
  2254. parameters.encodings[0].active = true;
  2255. parameters.encodings[0].scaleResolutionDownBy = scaleFactor;
  2256. // Firefox doesn't follow the spec and lets application specify the degradation preference on the encodings.
  2257. browser.isFirefox() && (parameters.encodings[0].degradationPreference = preference);
  2258. // Configure the bitrate.
  2259. if (this.getConfiguredVideoCodec() === CodecMimeType.VP8 && this.options?.videoQuality?.maxBitratesVideo) {
  2260. let bitrate = this.getTargetVideoBitrates()?.high;
  2261. if (videoType === VideoType.CAMERA) {
  2262. bitrate = this.tpcUtils.localStreamEncodingsConfig
  2263. .find(layer => layer.scaleResolutionDownBy === scaleFactor)?.maxBitrate ?? bitrate;
  2264. }
  2265. parameters.encodings[0].maxBitrate = bitrate;
  2266. }
  2267. } else {
  2268. parameters.encodings[0].active = false;
  2269. }
  2270. logger.info(`${this} setting max height=${frameHeight},encodings=${JSON.stringify(parameters.encodings)}`);
  2271. return videoSender.setParameters(parameters).then(() => {
  2272. localVideoTrack.maxEnabledResolution = frameHeight;
  2273. this.eventEmitter.emit(RTCEvents.LOCAL_TRACK_MAX_ENABLED_RESOLUTION_CHANGED, localVideoTrack);
  2274. });
  2275. };
  2276. /**
  2277. * Enables/disables video media transmission on this peer connection. When
  2278. * disabled the SDP video media direction in the local SDP will be adjusted to
  2279. * 'inactive' which means that no data will be sent nor accepted, but
  2280. * the connection should be kept alive.
  2281. * @param {boolean} active <tt>true</tt> to enable video media transmission or
  2282. * <tt>false</tt> to disable. If the value is not a boolean the call will have
  2283. * no effect.
  2284. * @return {boolean} <tt>true</tt> if the value has changed and sRD/sLD cycle
  2285. * needs to be executed in order for the changes to take effect or
  2286. * <tt>false</tt> if the given value was the same as the previous one.
  2287. * @public
  2288. */
  2289. TraceablePeerConnection.prototype.setVideoTransferActive = function(active) {
  2290. logger.debug(`${this} video transfer active: ${active}`);
  2291. const changed = this.videoTransferActive !== active;
  2292. this.videoTransferActive = active;
  2293. if (this._usesUnifiedPlan) {
  2294. this.tpcUtils.setVideoTransferActive(active);
  2295. // false means no renegotiation up the chain which is not needed in the Unified mode
  2296. return false;
  2297. }
  2298. return changed;
  2299. };
  2300. /**
  2301. * Sends DTMF tones if possible.
  2302. *
  2303. * @param {string} tones - The DTMF tones string as defined by {@code RTCDTMFSender.insertDTMF}, 'tones' argument.
  2304. * @param {number} duration - The amount of time in milliseconds that each DTMF should last. It's 200ms by default.
  2305. * @param {number} interToneGap - The length of time in miliseconds to wait between tones. It's 200ms by default.
  2306. *
  2307. * @returns {void}
  2308. */
  2309. TraceablePeerConnection.prototype.sendTones = function(tones, duration = 200, interToneGap = 200) {
  2310. if (!this._dtmfSender) {
  2311. if (this.peerconnection.getSenders) {
  2312. const rtpSender = this.peerconnection.getSenders().find(s => s.dtmf);
  2313. this._dtmfSender = rtpSender && rtpSender.dtmf;
  2314. this._dtmfSender && logger.info(`${this} initialized DTMFSender using getSenders`);
  2315. }
  2316. if (!this._dtmfSender) {
  2317. const localAudioTrack = Array.from(this.localTracks.values()).find(t => t.isAudioTrack());
  2318. if (this.peerconnection.createDTMFSender && localAudioTrack) {
  2319. this._dtmfSender = this.peerconnection.createDTMFSender(localAudioTrack.getTrack());
  2320. }
  2321. this._dtmfSender && logger.info(`${this} initialized DTMFSender using deprecated createDTMFSender`);
  2322. }
  2323. if (this._dtmfSender) {
  2324. this._dtmfSender.ontonechange = this._onToneChange.bind(this);
  2325. }
  2326. }
  2327. if (this._dtmfSender) {
  2328. if (this._dtmfSender.toneBuffer) {
  2329. this._dtmfTonesQueue.push({
  2330. tones,
  2331. duration,
  2332. interToneGap
  2333. });
  2334. return;
  2335. }
  2336. this._dtmfSender.insertDTMF(tones, duration, interToneGap);
  2337. } else {
  2338. logger.warn(`${this} sendTones - failed to select DTMFSender`);
  2339. }
  2340. };
  2341. /**
  2342. * Callback ivoked by {@code this._dtmfSender} when it has finished playing
  2343. * a single tone.
  2344. *
  2345. * @param {Object} event - The tonechange event which indicates what characters
  2346. * are left to be played for the current tone.
  2347. * @private
  2348. * @returns {void}
  2349. */
  2350. TraceablePeerConnection.prototype._onToneChange = function(event) {
  2351. // An empty event.tone indicates the current tones have finished playing.
  2352. // Automatically start playing any queued tones on finish.
  2353. if (this._dtmfSender && event.tone === '' && this._dtmfTonesQueue.length) {
  2354. const { tones, duration, interToneGap } = this._dtmfTonesQueue.shift();
  2355. this._dtmfSender.insertDTMF(tones, duration, interToneGap);
  2356. }
  2357. };
  2358. /**
  2359. * Makes the underlying TraceablePeerConnection generate new SSRC for
  2360. * the recvonly video stream.
  2361. */
  2362. TraceablePeerConnection.prototype.generateRecvonlySsrc = function() {
  2363. const newSSRC = SDPUtil.generateSsrc();
  2364. logger.info(`${this} generated new recvonly SSRC=${newSSRC}`);
  2365. this.sdpConsistency.setPrimarySsrc(newSSRC);
  2366. };
  2367. /**
  2368. * Makes the underlying TraceablePeerConnection forget the current primary video
  2369. * SSRC.
  2370. */
  2371. TraceablePeerConnection.prototype.clearRecvonlySsrc = function() {
  2372. logger.info(`${this} Clearing primary video SSRC!`);
  2373. this.sdpConsistency.clearVideoSsrcCache();
  2374. };
  2375. /**
  2376. * Closes underlying WebRTC PeerConnection instance and removes all remote
  2377. * tracks by emitting {@link RTCEvents.REMOTE_TRACK_REMOVED} for each one of
  2378. * them.
  2379. */
  2380. TraceablePeerConnection.prototype.close = function() {
  2381. this.trace('stop');
  2382. // Off SignalingEvents
  2383. this.signalingLayer.off(SignalingEvents.PEER_MUTED_CHANGED, this._peerMutedChanged);
  2384. this.signalingLayer.off(SignalingEvents.PEER_VIDEO_TYPE_CHANGED, this._peerVideoTypeChanged);
  2385. this._usesUnifiedPlan && this.peerconnection.removeEventListener('track', this.onTrack);
  2386. for (const peerTracks of this.remoteTracks.values()) {
  2387. for (const remoteTracks of peerTracks.values()) {
  2388. for (const remoteTrack of remoteTracks) {
  2389. this._removeRemoteTrack(remoteTrack);
  2390. }
  2391. }
  2392. }
  2393. this.remoteTracks.clear();
  2394. this._addedStreams = [];
  2395. this._dtmfSender = null;
  2396. this._dtmfTonesQueue = [];
  2397. if (!this.rtc._removePeerConnection(this)) {
  2398. logger.error(`${this} RTC._removePeerConnection returned false`);
  2399. }
  2400. if (this.statsinterval !== null) {
  2401. window.clearInterval(this.statsinterval);
  2402. this.statsinterval = null;
  2403. }
  2404. logger.info(`${this} Closing peerconnection`);
  2405. this.peerconnection.close();
  2406. };
  2407. TraceablePeerConnection.prototype.createAnswer = function(constraints) {
  2408. return this._createOfferOrAnswer(false /* answer */, constraints);
  2409. };
  2410. TraceablePeerConnection.prototype.createOffer = function(constraints) {
  2411. return this._createOfferOrAnswer(true /* offer */, constraints);
  2412. };
  2413. TraceablePeerConnection.prototype._createOfferOrAnswer = function(
  2414. isOffer,
  2415. constraints) {
  2416. const logName = isOffer ? 'Offer' : 'Answer';
  2417. this.trace(`create${logName}`, JSON.stringify(constraints, null, ' '));
  2418. const handleSuccess = (resultSdp, resolveFn, rejectFn) => {
  2419. try {
  2420. this.trace(
  2421. `create${logName}OnSuccess::preTransform`, dumpSDP(resultSdp));
  2422. if (!this._usesUnifiedPlan) {
  2423. // If there are no local video tracks, then a "recvonly"
  2424. // SSRC needs to be generated
  2425. if (!this.hasAnyTracksOfType(MediaType.VIDEO)
  2426. && !this.sdpConsistency.hasPrimarySsrcCached()) {
  2427. this.generateRecvonlySsrc();
  2428. }
  2429. // eslint-disable-next-line no-param-reassign
  2430. resultSdp = new RTCSessionDescription({
  2431. type: resultSdp.type,
  2432. sdp: this.sdpConsistency.makeVideoPrimarySsrcsConsistent(
  2433. resultSdp.sdp)
  2434. });
  2435. this.trace(
  2436. `create${logName}OnSuccess::postTransform `
  2437. + '(make primary audio/video ssrcs consistent)',
  2438. dumpSDP(resultSdp));
  2439. }
  2440. const localVideoTrack = this.getLocalVideoTracks()[0];
  2441. // Configure simulcast for camera tracks and for desktop tracks that need simulcast.
  2442. if (this.isSimulcastOn() && browser.usesSdpMungingForSimulcast()
  2443. && (localVideoTrack?.getVideoType() === VideoType.CAMERA
  2444. || this._usesUnifiedPlan)) {
  2445. // eslint-disable-next-line no-param-reassign
  2446. resultSdp = this.simulcast.mungeLocalDescription(resultSdp);
  2447. this.trace(`create${logName} OnSuccess::postTransform (simulcast)`, dumpSDP(resultSdp));
  2448. }
  2449. if (!this.options.disableRtx && browser.usesSdpMungingForSimulcast()) {
  2450. // eslint-disable-next-line no-param-reassign
  2451. resultSdp = new RTCSessionDescription({
  2452. type: resultSdp.type,
  2453. sdp: this.rtxModifier.modifyRtxSsrcs(resultSdp.sdp)
  2454. });
  2455. this.trace(
  2456. `create${logName}`
  2457. + 'OnSuccess::postTransform (rtx modifier)',
  2458. dumpSDP(resultSdp));
  2459. }
  2460. const ssrcMap = this._extractSSRCMap(resultSdp);
  2461. this._processLocalSSRCsMap(ssrcMap);
  2462. resolveFn(resultSdp);
  2463. } catch (e) {
  2464. this.trace(`create${logName}OnError`, e);
  2465. this.trace(`create${logName}OnError`, dumpSDP(resultSdp));
  2466. logger.error(`${this} create${logName}OnError`, e, dumpSDP(resultSdp));
  2467. rejectFn(e);
  2468. }
  2469. };
  2470. const handleFailure = (err, rejectFn) => {
  2471. this.trace(`create${logName}OnFailure`, err);
  2472. const eventType
  2473. = isOffer
  2474. ? RTCEvents.CREATE_OFFER_FAILED
  2475. : RTCEvents.CREATE_ANSWER_FAILED;
  2476. this.eventEmitter.emit(eventType, err, this);
  2477. rejectFn(err);
  2478. };
  2479. // Set the codec preference before creating an offer or answer so that the generated SDP will have
  2480. // the correct preference order.
  2481. if (this._usesTransceiverCodecPreferences) {
  2482. const transceiver = this.peerconnection.getTransceivers()
  2483. .find(t => t.receiver && t.receiver?.track?.kind === MediaType.VIDEO);
  2484. if (transceiver) {
  2485. let capabilities = RTCRtpReceiver.getCapabilities(MediaType.VIDEO)?.codecs;
  2486. const mimeType = this.codecPreference?.mimeType;
  2487. const enable = this.codecPreference?.enable;
  2488. if (capabilities && mimeType && enable) {
  2489. // Move the desired codec (all variations of it as well) to the beginning of the list.
  2490. /* eslint-disable-next-line arrow-body-style */
  2491. capabilities.sort(caps => {
  2492. return caps.mimeType.toLowerCase() === `${MediaType.VIDEO}/${mimeType}` ? -1 : 1;
  2493. });
  2494. } else if (capabilities && mimeType) {
  2495. capabilities = capabilities
  2496. .filter(caps => caps.mimeType.toLowerCase() !== `${MediaType.VIDEO}/${mimeType}`);
  2497. }
  2498. // Disable ulpfec on Google Chrome and derivatives because
  2499. // https://bugs.chromium.org/p/chromium/issues/detail?id=1276427
  2500. if (browser.isChromiumBased()) {
  2501. capabilities = capabilities
  2502. .filter(caps => caps.mimeType.toLowerCase() !== `${MediaType.VIDEO}/${CodecMimeType.ULPFEC}`);
  2503. }
  2504. try {
  2505. transceiver.setCodecPreferences(capabilities);
  2506. } catch (err) {
  2507. logger.warn(`${this} Setting codec[preference=${mimeType},enable=${enable}] failed`, err);
  2508. }
  2509. }
  2510. }
  2511. return new Promise((resolve, reject) => {
  2512. let oaPromise;
  2513. if (isOffer) {
  2514. oaPromise = this.peerconnection.createOffer(constraints);
  2515. } else {
  2516. oaPromise = this.peerconnection.createAnswer(constraints);
  2517. }
  2518. oaPromise
  2519. .then(
  2520. sdp => handleSuccess(sdp, resolve, reject),
  2521. error => handleFailure(error, reject));
  2522. });
  2523. };
  2524. /**
  2525. * Extract primary SSRC from given {@link TrackSSRCInfo} object.
  2526. * @param {TrackSSRCInfo} ssrcObj
  2527. * @return {number|null} the primary SSRC or <tt>null</tt>
  2528. */
  2529. TraceablePeerConnection.prototype._extractPrimarySSRC = function(ssrcObj) {
  2530. if (ssrcObj && ssrcObj.groups && ssrcObj.groups.length) {
  2531. return ssrcObj.groups[0].ssrcs[0];
  2532. } else if (ssrcObj && ssrcObj.ssrcs && ssrcObj.ssrcs.length) {
  2533. return ssrcObj.ssrcs[0];
  2534. }
  2535. return null;
  2536. };
  2537. /**
  2538. * Goes over the SSRC map extracted from the latest local description and tries
  2539. * to match them with the local tracks (by MSID). Will update the values
  2540. * currently stored in the {@link TraceablePeerConnection.localSSRCs} map.
  2541. * @param {Map<string,TrackSSRCInfo>} ssrcMap
  2542. * @private
  2543. */
  2544. TraceablePeerConnection.prototype._processLocalSSRCsMap = function(ssrcMap) {
  2545. for (const track of this.localTracks.values()) {
  2546. let sourceIndex, sourceName;
  2547. if (FeatureFlags.isMultiStreamSupportEnabled()) {
  2548. sourceName = track.getSourceName();
  2549. sourceIndex = getSourceIndexFromSourceName(sourceName);
  2550. }
  2551. const sourceIdentifier = this._usesUnifiedPlan
  2552. ? FeatureFlags.isMultiStreamSupportEnabled()
  2553. ? `${track.getType()}-${sourceIndex}` : track.getType()
  2554. : track.storedMSID;
  2555. if (ssrcMap.has(sourceIdentifier)) {
  2556. const newSSRC = ssrcMap.get(sourceIdentifier);
  2557. if (!newSSRC) {
  2558. logger.error(`${this} No SSRC found for stream=${sourceIdentifier}`);
  2559. return;
  2560. }
  2561. const oldSSRC = this.localSSRCs.get(track.rtcId);
  2562. const newSSRCNum = this._extractPrimarySSRC(newSSRC);
  2563. const oldSSRCNum = this._extractPrimarySSRC(oldSSRC);
  2564. // eslint-disable-next-line no-negated-condition
  2565. if (newSSRCNum !== oldSSRCNum) {
  2566. oldSSRCNum && logger.error(`${this} Overwriting SSRC for track=${track}] with ssrc=${newSSRC}`);
  2567. this.localSSRCs.set(track.rtcId, newSSRC);
  2568. this.eventEmitter.emit(RTCEvents.LOCAL_TRACK_SSRC_UPDATED, track, newSSRCNum);
  2569. }
  2570. } else if (!track.isVideoTrack() && !track.isMuted()) {
  2571. // It is normal to find no SSRCs for a muted video track in
  2572. // the local SDP as the recv-only SSRC is no longer munged in.
  2573. // So log the warning only if it's not a muted video track.
  2574. logger.warn(`${this} No SSRCs found in the local SDP for track=${track}, stream=${sourceIdentifier}`);
  2575. }
  2576. }
  2577. };
  2578. TraceablePeerConnection.prototype.addIceCandidate = function(candidate) {
  2579. this.trace('addIceCandidate', JSON.stringify({
  2580. candidate: candidate.candidate,
  2581. sdpMid: candidate.sdpMid,
  2582. sdpMLineIndex: candidate.sdpMLineIndex,
  2583. usernameFragment: candidate.usernameFragment
  2584. }, null, ' '));
  2585. return this.peerconnection.addIceCandidate(candidate);
  2586. };
  2587. /**
  2588. * Returns the number of simulcast streams that are currently enabled on the peerconnection.
  2589. *
  2590. * @returns {number} The number of simulcast streams currently enabled or 1 when simulcast is disabled.
  2591. */
  2592. TraceablePeerConnection.prototype.getActiveSimulcastStreams = function() {
  2593. let activeStreams = 1;
  2594. if (this.isSimulcastOn() && this.encodingsEnabledState) {
  2595. activeStreams = this.encodingsEnabledState.filter(stream => Boolean(stream))?.length;
  2596. } else if (this.isSimulcastOn()) {
  2597. activeStreams = SIM_LAYER_RIDS.length;
  2598. }
  2599. return activeStreams;
  2600. };
  2601. /**
  2602. * Obtains call-related stats from the peer connection.
  2603. *
  2604. * @returns {Promise<Object>} Promise which resolves with data providing statistics about
  2605. * the peerconnection.
  2606. */
  2607. TraceablePeerConnection.prototype.getStats = function() {
  2608. return this.peerconnection.getStats();
  2609. };
  2610. /**
  2611. * Generates and stores new SSRC info object for given local track.
  2612. * The method should be called only for a video track being added to this TPC
  2613. * in the muted state (given that the current browser uses this strategy).
  2614. * @param {JitsiLocalTrack} track
  2615. * @return {TPCSSRCInfo}
  2616. */
  2617. TraceablePeerConnection.prototype.generateNewStreamSSRCInfo = function(track) {
  2618. const rtcId = track.rtcId;
  2619. let ssrcInfo = this._getSSRC(rtcId);
  2620. if (ssrcInfo) {
  2621. logger.error(`${this} Overwriting local SSRCs for track id=${rtcId}`);
  2622. }
  2623. // Configure simulcast for camera tracks and desktop tracks that need simulcast.
  2624. if (this.isSimulcastOn()
  2625. && (track.getVideoType() === VideoType.CAMERA || !this.isSharingLowFpsScreen())) {
  2626. ssrcInfo = {
  2627. ssrcs: [],
  2628. groups: []
  2629. };
  2630. for (let i = 0; i < SIM_LAYER_RIDS.length; i++) {
  2631. ssrcInfo.ssrcs.push(SDPUtil.generateSsrc());
  2632. }
  2633. ssrcInfo.groups.push({
  2634. ssrcs: ssrcInfo.ssrcs.slice(),
  2635. semantics: 'SIM'
  2636. });
  2637. } else {
  2638. ssrcInfo = {
  2639. ssrcs: [ SDPUtil.generateSsrc() ],
  2640. groups: []
  2641. };
  2642. }
  2643. if (!this.options.disableRtx) {
  2644. // Specifically use a for loop here because we'll
  2645. // be adding to the list we're iterating over, so we
  2646. // only want to iterate through the items originally
  2647. // on the list
  2648. const currNumSsrcs = ssrcInfo.ssrcs.length;
  2649. for (let i = 0; i < currNumSsrcs; ++i) {
  2650. const primarySsrc = ssrcInfo.ssrcs[i];
  2651. const rtxSsrc = SDPUtil.generateSsrc();
  2652. ssrcInfo.ssrcs.push(rtxSsrc);
  2653. ssrcInfo.groups.push({
  2654. ssrcs: [ primarySsrc, rtxSsrc ],
  2655. semantics: 'FID'
  2656. });
  2657. }
  2658. }
  2659. ssrcInfo.msid = track.storedMSID;
  2660. this.localSSRCs.set(rtcId, ssrcInfo);
  2661. return ssrcInfo;
  2662. };
  2663. /**
  2664. * Returns if the peer connection uses Unified plan implementation.
  2665. *
  2666. * @returns {boolean} True if the pc uses Unified plan, false otherwise.
  2667. */
  2668. TraceablePeerConnection.prototype.usesUnifiedPlan = function() {
  2669. return this._usesUnifiedPlan;
  2670. };
  2671. /**
  2672. * Creates a text representation of this <tt>TraceablePeerConnection</tt>
  2673. * instance.
  2674. * @return {string}
  2675. */
  2676. TraceablePeerConnection.prototype.toString = function() {
  2677. return `TPC[id=${this.id},type=${this.isP2P ? 'P2P' : 'JVB'}]`;
  2678. };