livekit-client 2.0.6 → 2.0.8

package/dist/livekit-client.esm.mjs

@@ -13473,7 +13473,7 @@ function getMatch(exp, ua) {
   return match && match.length >= id && match[id] || '';
 }
 
-var version$1 = "2.0.6";
+var version$1 = "2.0.8";
 
 const version = version$1;
 const protocolVersion = 12;
@@ -14118,7 +14118,8 @@ function screenCaptureToDisplayMediaStreamOptions(options) {
     controller: options.controller,
     selfBrowserSurface: options.selfBrowserSurface,
     surfaceSwitching: options.surfaceSwitching,
-    systemAudio: options.systemAudio
+    systemAudio: options.systemAudio,
+    preferCurrentTab: options.preferCurrentTab
   };
 }
 function mimeTypeToVideoCodecString(mimeType) {
@@ -15036,6 +15037,13 @@ class LocalTrack extends Track {
       const unlock = yield this.processorLock.lock();
       try {
         this.log.debug('setting up processor', this.logContext);
+        const processorOptions = {
+          kind: this.kind,
+          track: this._mediaStreamTrack,
+          element: this.processorElement,
+          audioContext: this.audioContext
+        };
+        yield processor.init(processorOptions);
         if (this.processor) {
           yield this.stopProcessor();
         }
@@ -15048,13 +15056,6 @@ class LocalTrack extends Track {
         this.processorElement.play().catch(error => this.log.error('failed to play processor element', Object.assign(Object.assign({}, this.logContext), {
           error
         })));
-        const processorOptions = {
-          kind: this.kind,
-          track: this._mediaStreamTrack,
-          element: this.processorElement,
-          audioContext: this.audioContext
-        };
-        yield processor.init(processorOptions);
         this.processor = processor;
         if (this.processor.processedTrack) {
           for (const el of this.attachedElements) {
@@ -15091,7 +15092,10 @@ class LocalTrack extends Track {
       this.processor = undefined;
       (_b = this.processorElement) === null || _b === void 0 ? void 0 : _b.remove();
       this.processorElement = undefined;
-      yield this.restart();
+      // apply original track constraints in case the processor changed them
+      yield this._mediaStreamTrack.applyConstraints(this._constraints);
+      // force re-setting of the mediaStreamTrack on the sender
+      yield this.setMediaStreamTrack(this._mediaStreamTrack, true);
       this.emit(TrackEvent.TrackProcessorUpdate);
     });
   }
@@ -17031,25 +17035,18 @@ class PCTransport extends eventsExports.EventEmitter {
             if (codecPayload === 0) {
               return true;
             }
-            let fmtpFound = false;
+            const startBitrate = Math.round(trackbr.maxbr * startBitrateForSVC);
             for (const fmtp of media.fmtp) {
               if (fmtp.payload === codecPayload) {
+                // if another track's fmtp already is set, we cannot override the bitrate
+                // this has the unfortunate consequence of being forced to use the
+                // initial track's bitrate for all tracks
                 if (!fmtp.config.includes('x-google-start-bitrate')) {
-                  fmtp.config += ";x-google-start-bitrate=".concat(Math.round(trackbr.maxbr * startBitrateForSVC));
+                  fmtp.config += ";x-google-start-bitrate=".concat(startBitrate);
                 }
-                if (!fmtp.config.includes('x-google-max-bitrate')) {
-                  fmtp.config += ";x-google-max-bitrate=".concat(trackbr.maxbr);
-                }
-                fmtpFound = true;
                 break;
               }
             }
-            if (!fmtpFound) {
-              media.fmtp.push({
-                payload: codecPayload,
-                config: "x-google-start-bitrate=".concat(Math.round(trackbr.maxbr * startBitrateForSVC), ";x-google-max-bitrate=").concat(trackbr.maxbr)
-              });
-            }
             return true;
           });
         }
@@ -19085,23 +19082,40 @@ function computeVideoEncodings(isScreenShare, width, height, options) {
   }
   const original = new VideoPreset(width, height, videoEncoding.maxBitrate, videoEncoding.maxFramerate, videoEncoding.priority);
   if (scalabilityMode && isSVCCodec(videoCodec)) {
-    livekitLogger.debug("using svc with scalabilityMode ".concat(scalabilityMode));
     const sm = new ScalabilityMode(scalabilityMode);
     const encodings = [];
     if (sm.spatial > 3) {
       throw new Error("unsupported scalabilityMode: ".concat(scalabilityMode));
     }
-    for (let i = 0; i < sm.spatial; i += 1) {
+    // Before M113 in Chrome, defining multiple encodings with an SVC codec indicated
+    // that SVC mode should be used. Safari still works this way.
+    // This is a bit confusing but is due to how libwebrtc interpreted the encodings field
+    // before M113.
+    // Announced here: https://groups.google.com/g/discuss-webrtc/c/-QQ3pxrl-fw?pli=1
+    const browser = getBrowser();
+    if (isSafari() || (browser === null || browser === void 0 ? void 0 : browser.name) === 'Chrome' && compareVersions(browser === null || browser === void 0 ? void 0 : browser.version, '113') < 0) {
+      for (let i = 0; i < sm.spatial; i += 1) {
+        // in legacy SVC, scaleResolutionDownBy cannot be set
+        encodings.push({
+          rid: videoRids[2 - i],
+          maxBitrate: videoEncoding.maxBitrate / Math.pow(3, i),
+          maxFramerate: original.encoding.maxFramerate
+        });
+      }
+      // legacy SVC, scalabilityMode is set only on the first encoding
+      /* @ts-ignore */
+      encodings[0].scalabilityMode = scalabilityMode;
+    } else {
       encodings.push({
-        rid: videoRids[2 - i],
-        maxBitrate: videoEncoding.maxBitrate / Math.pow(3, i),
+        maxBitrate: videoEncoding.maxBitrate,
+        maxFramerate: original.encoding.maxFramerate,
         /* @ts-ignore */
-        maxFramerate: original.encoding.maxFramerate
+        scalabilityMode: scalabilityMode
       });
     }
-    /* @ts-ignore */
-    encodings[0].scalabilityMode = scalabilityMode;
-    livekitLogger.debug('encodings', encodings);
+    livekitLogger.debug("using svc encoding", {
+      encodings
+    });
     return encodings;
   }
   if (!useSimulcast) {
@@ -19125,7 +19139,7 @@ function computeVideoEncodings(isScreenShare, width, height, options) {
     //      to disable when CPU constrained.
     //      So encodings should be ordered in increasing spatial
     //      resolution order.
-    //   2. ion-sfu translates rids into layers. So, all encodings
+    //   2. livekit-server translates rids into layers. So, all encodings
     //      should have the base layer `q` and then more added
     //      based on other conditions.
     const size = Math.max(width, height);
@@ -21520,9 +21534,19 @@ class LocalParticipant extends Participant {
         // for svc codecs, disable simulcast and use vp8 for backup codec
         if (track instanceof LocalVideoTrack) {
           if (isSVCCodec(videoCodec)) {
-            // vp9 svc with screenshare has problem to encode, always use L1T3 here
-            if (track.source === Track.Source.ScreenShare && videoCodec === 'vp9') {
+            if (track.source === Track.Source.ScreenShare) {
+              // vp9 svc with screenshare cannot encode multiple spatial layers
+              // doing so reduces publish resolution to minimal resolution
               opts.scalabilityMode = 'L1T3';
+              // Chrome does not allow more than 5 fps with L1T3, and it has encoding bugs with L3T3
+              // It has a different path for screenshare handling and it seems to be untested/buggy
+              // As a workaround, we are setting contentHint to force it to go through the same
+              // path as regular camera video. While this is not optimal, it delivers the performance
+              // that we need
+              if ('contentHint' in track.mediaStreamTrack) {
+                track.mediaStreamTrack.contentHint = 'motion';
+                this.log.info('forcing contentHint to motion for screenshare with SVC codecs', Object.assign(Object.assign({}, this.logContext), getLogContextFromTrack(track)));
+              }
             }
             // set scalabilityMode to 'L3T3_KEY' by default
             opts.scalabilityMode = (_e = opts.scalabilityMode) !== null && _e !== void 0 ? _e : 'L3T3_KEY';
@@ -21621,7 +21645,8 @@ class LocalParticipant extends Participant {
               maxbr: ((_l = encodings[0]) === null || _l === void 0 ? void 0 : _l.maxBitrate) ? encodings[0].maxBitrate / 1000 : 0
             });
           }
-        } else if (track.codec && isSVCCodec(track.codec) && ((_m = encodings[0]) === null || _m === void 0 ? void 0 : _m.maxBitrate)) {
+        } 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
           this.engine.pcManager.publisher.setTrackCodecBitrate({
             cid: req.cid,
             codec: track.codec,
@@ -21629,6 +21654,19 @@ 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);
@@ -22524,6 +22562,7 @@ class Room extends eventsExports.EventEmitter {
             }
             if (nextUrl) {
               this.log.info("Initial connection failed with ConnectionError: ".concat(e.message, ". Retrying with another region: ").concat(nextUrl), this.logContext);
+              this.recreateEngine();
               yield connectFn(resolve, reject, nextUrl);
             } else {
               this.handleDisconnect(this.options.stopLocalTrackOnUnpublish);
@@ -24600,5 +24639,5 @@ function isFacingModeValue(item) {
   return item === undefined || allowedValues.includes(item);
 }
 
-export { AudioPresets, BaseKeyProvider, ConnectionCheck, ConnectionError, ConnectionQuality, ConnectionState, CriticalTimers, CryptorEvent, DataPacket_Kind, DefaultReconnectPolicy, DeviceUnsupportedError, DisconnectReason, EncryptionEvent, EngineEvent, ExternalE2EEKeyProvider, KeyHandlerEvent, KeyProviderEvent, LivekitError, LocalAudioTrack, LocalParticipant, LocalTrack, LocalTrackPublication, LocalVideoTrack, LogLevel, LoggerNames, MediaDeviceFailure, NegotiationError, Participant, ParticipantEvent, PublishDataError, RemoteAudioTrack, RemoteParticipant, RemoteTrack, RemoteTrackPublication, RemoteVideoTrack, Room, RoomEvent, ScreenSharePresets, Track, TrackEvent, TrackInvalidError, TrackPublication, UnexpectedConnectionState, UnsupportedServer, VideoPreset, VideoPresets, VideoPresets43, VideoQuality, attachToElement, createAudioAnalyser, createE2EEKey, createKeyMaterialFromBuffer, createKeyMaterialFromString, createLocalAudioTrack, createLocalScreenTracks, createLocalTracks, createLocalVideoTrack, deriveKeys, detachTrack, facingModeFromDeviceLabel, facingModeFromLocalTrack, getEmptyAudioStreamTrack, getEmptyVideoStreamTrack, getLogger, importKey, isBackupCodec, isBrowserSupported, isE2EESupported, isInsertableStreamSupported, isScriptTransformSupported, isVideoFrame, needsRbspUnescaping, parseRbsp, protocolVersion, ratchet, setLogExtension, setLogLevel, supportsAV1, supportsAdaptiveStream, supportsDynacast, supportsVP9, version, videoCodecs, writeRbsp };
+export { AudioPresets, BaseKeyProvider, ConnectionCheck, ConnectionError, ConnectionQuality, ConnectionState, CriticalTimers, CryptorEvent, DataPacket_Kind, DefaultReconnectPolicy, DeviceUnsupportedError, DisconnectReason, EncryptionEvent, EngineEvent, ExternalE2EEKeyProvider, KeyHandlerEvent, KeyProviderEvent, LivekitError, LocalAudioTrack, LocalParticipant, LocalTrack, LocalTrackPublication, LocalVideoTrack, LogLevel, LoggerNames, MediaDeviceFailure, NegotiationError, Participant, ParticipantEvent, PublishDataError, RemoteAudioTrack, RemoteParticipant, RemoteTrack, RemoteTrackPublication, RemoteVideoTrack, Room, RoomEvent, ScreenSharePresets, SubscriptionError, Track, TrackEvent, TrackInvalidError, TrackPublication, UnexpectedConnectionState, UnsupportedServer, VideoPreset, VideoPresets, VideoPresets43, VideoQuality, attachToElement, createAudioAnalyser, createE2EEKey, createKeyMaterialFromBuffer, createKeyMaterialFromString, createLocalAudioTrack, createLocalScreenTracks, createLocalTracks, createLocalVideoTrack, deriveKeys, detachTrack, facingModeFromDeviceLabel, facingModeFromLocalTrack, getBrowser, getEmptyAudioStreamTrack, getEmptyVideoStreamTrack, getLogger, importKey, isBackupCodec, isBrowserSupported, isE2EESupported, isInsertableStreamSupported, isScriptTransformSupported, isVideoFrame, needsRbspUnescaping, parseRbsp, protocolVersion, ratchet, setLogExtension, setLogLevel, supportsAV1, supportsAdaptiveStream, supportsDynacast, supportsVP9, version, videoCodecs, writeRbsp };
 //# sourceMappingURL=livekit-client.esm.mjs.map