livekit-client 2.1.2 → 2.1.4

package/dist/livekit-client.esm.mjs

@@ -5494,6 +5494,12 @@ const SimulateScenario = /*@__PURE__*/proto3.makeMessageType("livekit.SimulateSc
   kind: "scalar",
   T: 8 /* ScalarType.BOOL */,
   oneof: "scenario"
+}, {
+  no: 9,
+  name: "leave_request_full_reconnect",
+  kind: "scalar",
+  T: 8 /* ScalarType.BOOL */,
+  oneof: "scenario"
 }]);
 
 /**
@@ -10499,10 +10505,10 @@ function getOSVersion(ua) {
   return ua.includes('mac os') ? getMatch(/\(.+?(\d+_\d+(:?_\d+)?)/, ua, 1).replace(/_/g, '.') : undefined;
 }
 
-var version$1 = "2.1.2";
+var version$1 = "2.1.4";
 
 const version = version$1;
-const protocolVersion = 12;
+const protocolVersion = 13;
 
 /**
  * Timers that can be overridden with platform specific implementations
@@ -11203,6 +11209,9 @@ function getLogContextFromTrack(track) {
     };
   }
 }
+function supportsSynchronizationSources() {
+  return typeof RTCRtpReceiver !== 'undefined' && 'getSynchronizationSources' in RTCRtpReceiver;
+}
 
 const separator = '|';
 const ddExtensionURI = 'https://aomediacodec.github.io/av1-rtp-spec/#dependency-descriptor-rtp-header-extension';
@@ -11575,7 +11584,7 @@ function isVideoCodec(maybeCodec) {
   return videoCodecs.includes(maybeCodec);
 }
 function unwrapConstraint(constraint) {
-  if (typeof constraint === 'string') {
+  if (typeof constraint === 'string' || typeof constraint === 'number') {
     return constraint;
   }
   if (Array.isArray(constraint)) {
@@ -11712,6 +11721,14 @@ DeviceManager.userMediaPromiseMap = new Map();
 
 const defaultDimensionsTimeout = 1000;
 class LocalTrack extends Track {
+  /** @internal */
+  get sender() {
+    return this._sender;
+  }
+  /** @internal */
+  set sender(sender) {
+    this._sender = sender;
+  }
   get constraints() {
     return this._constraints;
   }
@@ -11726,6 +11743,7 @@ class LocalTrack extends Track {
     let userProvidedTrack = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
     let loggerOptions = arguments.length > 4 ? arguments[4] : undefined;
     super(mediaTrack, kind, loggerOptions);
+    this.manuallyStopped = false;
     this._isUpstreamPaused = false;
     this.handleTrackMuteEvent = () => this.debouncedTrackMuteHandler().catch(() => this.log.debug('track mute bounce got cancelled by an unmute event', this.logContext));
     this.debouncedTrackMuteHandler = r(() => __awaiter(this, void 0, void 0, function* () {
@@ -11936,6 +11954,7 @@ class LocalTrack extends Track {
   }
   restart(constraints) {
     return __awaiter(this, void 0, void 0, function* () {
+      this.manuallyStopped = false;
       const unlock = yield this.restartLock.lock();
       try {
         if (!constraints) {
@@ -11971,6 +11990,10 @@ class LocalTrack extends Track {
         yield this.setMediaStreamTrack(newTrack);
         this._constraints = constraints;
         this.emit(TrackEvent.Restarted, this);
+        if (this.manuallyStopped) {
+          this.log.warn('track was stopped during a restart, stopping restarted track', this.logContext);
+          this.stop();
+        }
         return this;
       } finally {
         unlock();
@@ -12008,6 +12031,7 @@ class LocalTrack extends Track {
   }
   stop() {
     var _a;
+    this.manuallyStopped = true;
     super.stop();
     this._mediaStreamTrack.removeEventListener('ended', this.handleEnded);
     this._mediaStreamTrack.removeEventListener('mute', this.handleTrackMuteEvent);
@@ -12933,8 +12957,9 @@ class SignalClient {
     return this.sendRequest({
       case: 'leave',
       value: new LeaveRequest({
-        canReconnect: false,
-        reason: DisconnectReason.CLIENT_INITIATED
+        reason: DisconnectReason.CLIENT_INITIATED,
+        // server doesn't process this field, keeping it here to indicate the intent of a full disconnect
+        action: LeaveRequest_Action.DISCONNECT
       })
     });
   }
@@ -14097,8 +14122,6 @@ class PCTransport extends eventsExports.EventEmitter {
         if (media.type === 'audio') {
           ensureAudioNackAndStereo(media, [], []);
         } else if (media.type === 'video') {
-          ensureVideoDDExtensionForSVC(media);
-          // mung sdp for codec bitrate setting that can't apply by sendEncoding
           this.trackBitrates.some(trackbr => {
             if (!media.msid || !trackbr.cid || !media.msid.includes(trackbr.cid)) {
               return false;
@@ -14114,6 +14137,14 @@ class PCTransport extends eventsExports.EventEmitter {
             if (codecPayload === 0) {
               return true;
             }
+            if (isSVCCodec(trackbr.codec)) {
+              ensureVideoDDExtensionForSVC(media);
+            }
+            // TODO: av1 slow starting issue already fixed in chrome 124, clean this after some versions
+            // mung sdp for av1 bitrate setting that can't apply by sendEncoding
+            if (trackbr.codec !== 'av1') {
+              return true;
+            }
             const startBitrate = Math.round(trackbr.maxbr * startBitrateForSVC);
             for (const fmtp of media.fmtp) {
               if (fmtp.payload === codecPayload) {
@@ -14330,13 +14361,9 @@ function ensureAudioNackAndStereo(media, stereoMids, nackMids) {
   }
 }
 function ensureVideoDDExtensionForSVC(media) {
-  var _a, _b, _c, _d;
-  const codec = (_b = (_a = media.rtp[0]) === null || _a === void 0 ? void 0 : _a.codec) === null || _b === void 0 ? void 0 : _b.toLowerCase();
-  if (!isSVCCodec(codec)) {
-    return;
-  }
+  var _a, _b;
   let maxID = 0;
-  const ddFound = (_c = media.ext) === null || _c === void 0 ? void 0 : _c.some(ext => {
+  const ddFound = (_a = media.ext) === null || _a === void 0 ? void 0 : _a.some(ext => {
     if (ext.uri === ddExtensionURI) {
       return true;
     }
@@ -14346,7 +14373,7 @@ function ensureVideoDDExtensionForSVC(media) {
     return false;
   });
   if (!ddFound) {
-    (_d = media.ext) === null || _d === void 0 ? void 0 : _d.push({
+    (_b = media.ext) === null || _b === void 0 ? void 0 : _b.push({
       value: maxID + 1,
       uri: ddExtensionURI
     });
@@ -15054,6 +15081,10 @@ function computeVideoEncodings(isScreenShare, width, height, options) {
         scalabilityMode: scalabilityMode
       });
     }
+    if (original.encoding.priority) {
+      encodings[0].priority = original.encoding.priority;
+      encodings[0].networkPriority = original.encoding.priority;
+    }
     livekitLogger.debug("using svc encoding", {
       encodings
     });
@@ -15267,9 +15298,25 @@ class ScalabilityMode {
     return "L".concat(this.spatial, "T").concat(this.temporal).concat((_a = this.suffix) !== null && _a !== void 0 ? _a : '');
   }
 }
+function getDefaultDegradationPreference(track) {
+  // a few of reasons we have different default paths:
+  // 1. without this, Chrome seems to aggressively resize the SVC video stating `quality-limitation: bandwidth` even when BW isn't an issue
+  // 2. since we are overriding contentHint to motion (to workaround L1T3 publishing), it overrides the default degradationPreference to `balanced`
+  if (track.source === Track.Source.ScreenShare || track.constraints.height && unwrapConstraint(track.constraints.height) >= 1080) {
+    return 'maintain-resolution';
+  } else {
+    return 'balanced';
+  }
+}
 
 const refreshSubscribedCodecAfterNewCodec = 5000;
 class LocalVideoTrack extends LocalTrack {
+  set sender(sender) {
+    this._sender = sender;
+    if (this.degradationPreference) {
+      this.setDegradationPreference(this.degradationPreference);
+    }
+  }
   /**
    *
    * @param mediaTrack
@@ -15282,6 +15329,7 @@ class LocalVideoTrack extends LocalTrack {
     super(mediaTrack, Track.Kind.Video, constraints, userProvidedTrack, loggerOptions);
     /* @internal */
     this.simulcastCodecs = new Map();
+    this.degradationPreference = 'balanced';
     this.monitorSender = () => __awaiter(this, void 0, void 0, function* () {
       if (!this.sender) {
         this._currentBitrate = 0;
@@ -15604,6 +15652,23 @@ class LocalVideoTrack extends LocalTrack {
       }();
     });
   }
+  setDegradationPreference(preference) {
+    return __awaiter(this, void 0, void 0, function* () {
+      this.degradationPreference = preference;
+      if (this.sender) {
+        try {
+          this.log.debug("setting degradationPreference to ".concat(preference), this.logContext);
+          const params = this.sender.getParameters();
+          params.degradationPreference = preference;
+          this.sender.setParameters(params);
+        } catch (e) {
+          this.log.warn("failed to set degradationPreference", Object.assign({
+            error: e
+          }, this.logContext));
+        }
+      }
+    });
+  }
   addSimulcastTrack(codec, encodings) {
     if (this.simulcastCodecs.has(codec)) {
       this.log.error("".concat(codec, " already added, skipping adding simulcast codec"), this.logContext);
@@ -16223,7 +16288,7 @@ class RTCEngine extends eventsExports.EventEmitter {
   }
   configure(joinResponse) {
     return __awaiter(this, void 0, void 0, function* () {
-      var _a;
+      var _a, _b;
       // already configured
       if (this.pcManager && this.pcManager.currentState !== PCTransportState.NEW) {
         return;
@@ -16268,7 +16333,9 @@ class RTCEngine extends eventsExports.EventEmitter {
       this.pcManager.onTrack = ev => {
         this.emit(EngineEvent.MediaTrackAdded, ev.track, ev.streams[0], ev.receiver);
       };
-      this.createDataChannels();
+      if (!supportOptionalDatachannel((_b = joinResponse.serverInfo) === null || _b === void 0 ? void 0 : _b.protocol)) {
+        this.createDataChannels();
+      }
     });
   }
   setupSignalClientCallbacks() {
@@ -16335,17 +16402,27 @@ class RTCEngine extends eventsExports.EventEmitter {
       this.handleDisconnect('signal', ReconnectReason.RR_SIGNAL_DISCONNECTED);
     };
     this.client.onLeave = leave => {
-      if (leave === null || leave === void 0 ? void 0 : leave.canReconnect) {
-        this.fullReconnectOnNext = true;
-        // reconnect immediately instead of waiting for next attempt
-        this.handleDisconnect(leaveReconnect);
-      } else {
-        this.emit(EngineEvent.Disconnected, leave === null || leave === void 0 ? void 0 : leave.reason);
-        this.close();
-      }
       this.log.debug('client leave request', Object.assign(Object.assign({}, this.logContext), {
         reason: leave === null || leave === void 0 ? void 0 : leave.reason
       }));
+      if (leave.regions && this.regionUrlProvider) {
+        this.log.debug('updating regions', this.logContext);
+        this.regionUrlProvider.setServerReportedRegions(leave.regions);
+      }
+      switch (leave.action) {
+        case LeaveRequest_Action.DISCONNECT:
+          this.emit(EngineEvent.Disconnected, leave === null || leave === void 0 ? void 0 : leave.reason);
+          this.close();
+          break;
+        case LeaveRequest_Action.RECONNECT:
+          this.fullReconnectOnNext = true;
+          // reconnect immediately instead of waiting for next attempt
+          this.handleDisconnect(leaveReconnect);
+          break;
+        case LeaveRequest_Action.RESUME:
+          // reconnect immediately instead of waiting for next attempt
+          this.handleDisconnect(leaveReconnect);
+      }
     };
   }
   makeRTCConfiguration(serverResponse) {
@@ -16729,7 +16806,15 @@ class RTCEngine extends eventsExports.EventEmitter {
         if (!transport) {
           throw new ConnectionError("".concat(transportName, " connection not set"));
         }
-        if (!subscriber && !_this2.pcManager.publisher.isICEConnected && _this2.pcManager.publisher.getICEConnectionState() !== 'checking') {
+        let needNegotiation = false;
+        if (!subscriber && !_this2.dataChannelForKind(kind, subscriber)) {
+          _this2.createDataChannels();
+          needNegotiation = true;
+        }
+        if (!needNegotiation && !subscriber && !_this2.pcManager.publisher.isICEConnected && _this2.pcManager.publisher.getICEConnectionState() !== 'checking') {
+          needNegotiation = true;
+        }
+        if (needNegotiation) {
           // start negotiation
           _this2.negotiate();
         }
@@ -16782,6 +16867,10 @@ class RTCEngine extends eventsExports.EventEmitter {
           return;
         }
         this.pcManager.requirePublisher();
+        // don't negotiate without any transceivers or data channel, it will generate sdp without ice frag then negotiate failed
+        if (this.pcManager.publisher.getTransceivers().length == 0 && !this.lossyDC && !this.reliableDC) {
+          this.createDataChannels();
+        }
         const abortController = new AbortController();
         const handleClosed = () => {
           abortController.abort();
@@ -16922,6 +17011,9 @@ class RTCEngine extends eventsExports.EventEmitter {
   }
 }
 class SignalReconnectError extends Error {}
+function supportOptionalDatachannel(protocol) {
+  return protocol !== undefined && protocol > 13;
+}
 
 class RegionUrlProvider {
   constructor(url, token) {
@@ -16980,6 +17072,10 @@ class RegionUrlProvider {
       }
     });
   }
+  setServerReportedRegions(regions) {
+    this.regionSettings = regions;
+    this.lastUpdateAt = Date.now();
+  }
 }
 function getCloudConfigUrl(serverUrl) {
   return "".concat(serverUrl.protocol.replace('ws', 'http'), "//").concat(serverUrl.host, "/settings");
@@ -17044,16 +17140,27 @@ class RemoteTrack extends Track {
     if (!this.monitorInterval) {
       this.monitorInterval = setInterval(() => this.monitorReceiver(), monitorFrequency);
     }
-    this.registerTimeSyncUpdate();
+    if (supportsSynchronizationSources()) {
+      this.registerTimeSyncUpdate();
+    }
   }
   registerTimeSyncUpdate() {
     const loop = () => {
-      var _a, _b;
+      var _a;
       this.timeSyncHandle = requestAnimationFrame(() => loop());
-      const newTime = (_b = (_a = this.receiver) === null || _a === void 0 ? void 0 : _a.getSynchronizationSources()[0]) === null || _b === void 0 ? void 0 : _b.rtpTimestamp;
-      if (newTime && this.rtpTimestamp !== newTime) {
-        this.emit(TrackEvent.TimeSyncUpdate, newTime);
-        this.rtpTimestamp = newTime;
+      const sources = (_a = this.receiver) === null || _a === void 0 ? void 0 : _a.getSynchronizationSources()[0];
+      if (sources) {
+        const {
+          timestamp,
+          rtpTimestamp
+        } = sources;
+        if (rtpTimestamp && this.rtpTimestamp !== rtpTimestamp) {
+          this.emit(TrackEvent.TimeSyncUpdate, {
+            timestamp,
+            rtpTimestamp
+          });
+          this.rtpTimestamp = rtpTimestamp;
+        }
       }
     };
     loop();
@@ -18593,7 +18700,7 @@ class LocalParticipant extends Participant {
   }
   publish(track, opts, isStereo) {
     return __awaiter(this, void 0, void 0, function* () {
-      var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+      var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
       const existingTrackOfSource = Array.from(this.trackPublications.values()).find(publishedTrack => track instanceof LocalTrack && publishedTrack.source === track.source);
       if (existingTrackOfSource && track.source !== Track.Source.Unknown) {
         this.log.info("publishing a second track with the same source: ".concat(track.source), Object.assign(Object.assign({}, this.logContext), getLogContextFromTrack(track)));
@@ -18753,6 +18860,10 @@ class LocalParticipant extends Participant {
         trackInfo: ti
       }));
       track.sender = yield this.engine.createSender(track, opts, encodings);
+      if (track instanceof LocalVideoTrack) {
+        (_l = opts.degradationPreference) !== null && _l !== void 0 ? _l : opts.degradationPreference = getDefaultDegradationPreference(track);
+        track.setDegradationPreference(opts.degradationPreference);
+      }
       if (encodings) {
         if (isFireFox() && track.kind === Track.Kind.Audio) {
           /* Refer to RFC https://datatracker.ietf.org/doc/html/rfc7587#section-6.1,
@@ -18773,11 +18884,10 @@ class LocalParticipant extends Participant {
             this.engine.pcManager.publisher.setTrackCodecBitrate({
               transceiver: trackTransceiver,
               codec: 'opus',
-              maxbr: ((_l = encodings[0]) === null || _l === void 0 ? void 0 : _l.maxBitrate) ? encodings[0].maxBitrate / 1000 : 0
+              maxbr: ((_m = encodings[0]) === null || _m === void 0 ? void 0 : _m.maxBitrate) ? encodings[0].maxBitrate / 1000 : 0
             });
           }
-        } else if (track.codec && track.codec == 'av1' && ((_m = encodings[0]) === null || _m === void 0 ? void 0 : _m.maxBitrate)) {
-          // AV1 requires setting x-start-bitrate in SDP
+        } else if (track.codec && isSVCCodec(track.codec) && ((_o = encodings[0]) === null || _o === void 0 ? void 0 : _o.maxBitrate)) {
           this.engine.pcManager.publisher.setTrackCodecBitrate({
             cid: req.cid,
             codec: track.codec,
@@ -18785,19 +18895,6 @@ class LocalParticipant extends Participant {
           });
         }
       }
-      if (track.kind === Track.Kind.Video && track.source === Track.Source.ScreenShare) {
-        // a few of reasons we are forcing this setting without allowing overrides:
-        // 1. without this, Chrome seems to aggressively resize the SVC video stating `quality-limitation: bandwidth` even when BW isn't an issue
-        // 2. since we are overriding contentHint to motion (to workaround L1T3 publishing), it overrides the default degradationPreference to `balanced`
-        try {
-          this.log.debug("setting degradationPreference to maintain-resolution");
-          const params = track.sender.getParameters();
-          params.degradationPreference = 'maintain-resolution';
-          yield track.sender.setParameters(params);
-        } catch (e) {
-          this.log.warn("failed to set degradationPreference: ".concat(e));
-        }
-      }
       yield this.engine.negotiate();
       if (track instanceof LocalVideoTrack) {
         track.startMonitor(this.engine.client);
@@ -20569,7 +20666,7 @@ class Room extends eventsExports.EventEmitter {
             if (onLeave) {
               onLeave(new LeaveRequest({
                 reason: DisconnectReason.CLIENT_INITIATED,
-                canReconnect: true
+                action: LeaveRequest_Action.RECONNECT
               }));
             }
           });
@@ -20585,6 +20682,13 @@ class Room extends eventsExports.EventEmitter {
             }
           });
           break;
+        case 'leave-full-reconnect':
+          req = new SimulateScenario({
+            scenario: {
+              case: 'leaveRequestFullReconnect',
+              value: true
+            }
+          });
       }
       if (req) {
         yield this.engine.client.sendSimulateScenario(req);