You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

TraceablePeerConnection.js 114KB

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