livekit-client 2.13.5 → 2.13.6

package/src/e2ee/worker/e2ee.worker.ts

@@ -65,6 +65,7 @@ onmessage = (ev) => {
           data.readableStream,
           data.writableStream,
           data.trackId,
+          data.isReuse,
           data.codec,
         );
         break;
@@ -75,6 +76,7 @@ onmessage = (ev) => {
           data.readableStream,
           data.writableStream,
           data.trackId,
+          data.isReuse,
           data.codec,
         );
         break;

package/src/room/PCTransport.ts

@@ -50,6 +50,8 @@ export default class PCTransport extends EventEmitter {
 
   private ddExtID = 0;
 
+  private latestOfferId: number = 0;
+
   pendingCandidates: RTCIceCandidateInit[] = [];
 
   restartingIce: boolean = false;
@@ -62,7 +64,7 @@ export default class PCTransport extends EventEmitter {
 
   remoteNackMids: string[] = [];
 
-  onOffer?: (offer: RTCSessionDescriptionInit) => void;
+  onOffer?: (offer: RTCSessionDescriptionInit, offerId: number) => void;
 
   onIceCandidate?: (candidate: RTCIceCandidate) => void;
 
@@ -137,7 +139,20 @@ export default class PCTransport extends EventEmitter {
     this.pendingCandidates.push(candidate);
   }
 
-  async setRemoteDescription(sd: RTCSessionDescriptionInit): Promise<void> {
+  async setRemoteDescription(sd: RTCSessionDescriptionInit, offerId: number): Promise<boolean> {
+    if (
+      sd.type === 'answer' &&
+      this.latestOfferId > 0 &&
+      offerId > 0 &&
+      offerId !== this.latestOfferId
+    ) {
+      this.log.warn('ignoring answer for old offer', {
+        ...this.logContext,
+        offerId,
+        latestOfferId: this.latestOfferId,
+      });
+      return false;
+    }
     let mungedSDP: string | undefined = undefined;
     if (sd.type === 'offer') {
       let { stereoMids, nackMids } = extractStereoAndNackAudioFromOffer(sd);
@@ -218,6 +233,7 @@ export default class PCTransport extends EventEmitter {
         });
       }
     }
+    return true;
   }
 
   // debounced negotiate interface
@@ -235,6 +251,9 @@ export default class PCTransport extends EventEmitter {
   }, debounceInterval);
 
   async createAndSendOffer(options?: RTCOfferOptions) {
+    // increase the offer id at the start to ensure the offer is always > 0 so that we can use 0 as a default value for legacy behavior
+    const offerId = this.latestOfferId + 1;
+    this.latestOfferId = offerId;
     if (this.onOffer === undefined) {
       return;
     }
@@ -317,9 +336,16 @@ export default class PCTransport extends EventEmitter {
         });
       }
     });
-
+    if (this.latestOfferId > offerId) {
+      this.log.warn('latestOfferId mismatch', {
+        ...this.logContext,
+        latestOfferId: this.latestOfferId,
+        offerId,
+      });
+      return;
+    }
     await this.setMungedSDP(offer, write(sdpParsed));
-    this.onOffer(offer);
+    this.onOffer(offer, this.latestOfferId);
   }
 
   async createAndSetAnswer(): Promise<RTCSessionDescriptionInit> {

package/src/room/PCTransportManager.ts

@@ -48,7 +48,7 @@ export class PCTransportManager {
 
   public onTrack?: (ev: RTCTrackEvent) => void;
 
-  public onPublisherOffer?: (offer: RTCSessionDescriptionInit) => void;
+  public onPublisherOffer?: (offer: RTCSessionDescriptionInit, offerId: number) => void;
 
   private isPublisherConnectionRequired: boolean;
 
@@ -96,8 +96,8 @@ export class PCTransportManager {
     this.subscriber.onTrack = (ev) => {
       this.onTrack?.(ev);
     };
-    this.publisher.onOffer = (offer) => {
-      this.onPublisherOffer?.(offer);
+    this.publisher.onOffer = (offer, offerId) => {
+      this.onPublisherOffer?.(offer, offerId);
     };
 
     this.state = PCTransportState.NEW;
@@ -126,8 +126,8 @@ export class PCTransportManager {
     return this.publisher.createAndSendOffer(options);
   }
 
-  setPublisherAnswer(sd: RTCSessionDescriptionInit) {
-    return this.publisher.setRemoteDescription(sd);
+  setPublisherAnswer(sd: RTCSessionDescriptionInit, offerId: number) {
+    return this.publisher.setRemoteDescription(sd, offerId);
   }
 
   removeTrack(sender: RTCRtpSender) {
@@ -168,7 +168,7 @@ export class PCTransportManager {
     }
   }
 
-  async createSubscriberAnswerFromOffer(sd: RTCSessionDescriptionInit) {
+  async createSubscriberAnswerFromOffer(sd: RTCSessionDescriptionInit, offerId: number) {
     this.log.debug('received server offer', {
       ...this.logContext,
       RTCSdpType: sd.type,
@@ -177,7 +177,10 @@ export class PCTransportManager {
     });
     const unlock = await this.remoteOfferLock.lock();
     try {
-      await this.subscriber.setRemoteDescription(sd);
+      const success = await this.subscriber.setRemoteDescription(sd, offerId);
+      if (!success) {
+        return undefined;
+      }
 
       // answer the offer
       const answer = await this.subscriber.createAndSetAnswer();

package/src/room/RTCEngine.ts

@@ -111,6 +111,11 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
    */
   latestJoinResponse?: JoinResponse;
 
+  /**
+   * @internal
+   */
+  latestRemoteOfferId: number = 0;
+
   get isClosed() {
     return this._isClosed;
   }
@@ -420,8 +425,8 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       this.client.sendIceCandidate(candidate, target);
     };
 
-    this.pcManager.onPublisherOffer = (offer) => {
-      this.client.sendOffer(offer);
+    this.pcManager.onPublisherOffer = (offer, offerId) => {
+      this.client.sendOffer(offer, offerId);
     };
 
     this.pcManager.onDataChannel = this.handleDataChannel;
@@ -476,12 +481,12 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
 
   private setupSignalClientCallbacks() {
     // configure signaling client
-    this.client.onAnswer = async (sd) => {
+    this.client.onAnswer = async (sd, offerId) => {
       if (!this.pcManager) {
         return;
       }
       this.log.debug('received server answer', { ...this.logContext, RTCSdpType: sd.type });
-      await this.pcManager.setPublisherAnswer(sd);
+      await this.pcManager.setPublisherAnswer(sd, offerId);
     };
 
     // add candidate on trickle
@@ -494,12 +499,15 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
     };
 
     // when server creates an offer for the client
-    this.client.onOffer = async (sd) => {
+    this.client.onOffer = async (sd, offerId) => {
+      this.latestRemoteOfferId = offerId;
       if (!this.pcManager) {
         return;
       }
-      const answer = await this.pcManager.createSubscriberAnswerFromOffer(sd);
-      this.client.sendAnswer(answer);
+      const answer = await this.pcManager.createSubscriberAnswerFromOffer(sd, offerId);
+      if (answer) {
+        this.client.sendAnswer(answer, offerId);
+      }
     };
 
     this.client.onLocalTrackPublished = (res: TrackPublishedResponse) => {

package/src/room/Room.ts

@@ -1301,10 +1301,10 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
    */
   async switchActiveDevice(kind: MediaDeviceKind, deviceId: string, exact: boolean = true) {
     let success = true;
-    let needsUpdateWithoutTracks = false;
+    let shouldTriggerImmediateDeviceChange = false;
     const deviceConstraint = exact ? { exact: deviceId } : deviceId;
     if (kind === 'audioinput') {
-      needsUpdateWithoutTracks = this.localParticipant.audioTrackPublications.size === 0;
+      shouldTriggerImmediateDeviceChange = this.localParticipant.audioTrackPublications.size === 0;
       const prevDeviceId =
         this.getActiveDevice(kind) ?? this.options.audioCaptureDefaults!.deviceId;
       this.options.audioCaptureDefaults!.deviceId = deviceConstraint;
@@ -1319,8 +1319,10 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
         this.options.audioCaptureDefaults!.deviceId = prevDeviceId;
         throw e;
       }
+      const isMuted = tracks.some((t) => t.track?.isMuted ?? false);
+      if (success && isMuted) shouldTriggerImmediateDeviceChange = true;
     } else if (kind === 'videoinput') {
-      needsUpdateWithoutTracks = this.localParticipant.videoTrackPublications.size === 0;
+      shouldTriggerImmediateDeviceChange = this.localParticipant.videoTrackPublications.size === 0;
       const prevDeviceId =
         this.getActiveDevice(kind) ?? this.options.videoCaptureDefaults!.deviceId;
       this.options.videoCaptureDefaults!.deviceId = deviceConstraint;
@@ -1336,6 +1338,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
         throw e;
       }
     } else if (kind === 'audiooutput') {
+      shouldTriggerImmediateDeviceChange = true;
       if (
         (!supportsSetSinkId() && !this.options.webAudioMix) ||
         (this.options.webAudioMix && this.audioContext && !('setSinkId' in this.audioContext))
@@ -1367,12 +1370,9 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
         throw e;
       }
     }
-    if (needsUpdateWithoutTracks || kind === 'audiooutput') {
-      // if there are not active tracks yet or we're switching audiooutput, we need to manually update the active device map here as changing audio output won't result in a track restart
-      this.localParticipant.activeDeviceMap.set(
-        kind,
-        (kind === 'audiooutput' && this.options.audioOutput?.deviceId) || deviceId,
-      );
+
+    if (shouldTriggerImmediateDeviceChange) {
+      this.localParticipant.activeDeviceMap.set(kind, deviceId);
       this.emit(RoomEvent.ActiveDeviceChanged, kind, deviceId);
     }
 

package/src/room/track/LocalVideoTrack.ts

@@ -7,12 +7,11 @@ import {
 } from '@livekit/protocol';
 import type { SignalClient } from '../../api/SignalClient';
 import type { StructuredLogger } from '../../logger';
-import { getBrowser } from '../../utils/browserParser';
 import { ScalabilityMode } from '../participant/publishUtils';
 import type { VideoSenderStats } from '../stats';
 import { computeBitrate, monitorFrequency } from '../stats';
 import type { LoggerOptions } from '../types';
-import { compareVersions, isFireFox, isMobile, isSVCCodec, isWeb } from '../utils';
+import { isFireFox, isMobile, isSVCCodec, isWeb } from '../utils';
 import LocalTrack from './LocalTrack';
 import { Track, VideoQuality } from './Track';
 import type { VideoCaptureOptions, VideoCodec } from './options';
@@ -459,15 +458,18 @@ async function setPublishingLayersForSender(
     }
 
     let hasChanged = false;
-    const browser = getBrowser();
-    const closableSpatial =
-      browser?.name === 'Chrome' && compareVersions(browser?.version, '133') > 0;
+
+    /* disable closable spatial layer as it has video blur / frozen issue with current server / client
+    1. chrome 113: when switching to up layer with scalability Mode change, it will generate a
+          low resolution frame and recover very quickly, but noticable
+    2. livekit sfu: additional pli request cause video frozen for a few frames, also noticable */
+    const closableSpatial = false;
     /* @ts-ignore */
     if (closableSpatial && encodings[0].scalabilityMode) {
       // svc dynacast encodings
       const encoding = encodings[0];
       /* @ts-ignore */
-      const mode = new ScalabilityMode(encoding.scalabilityMode);
+      // const mode = new ScalabilityMode(encoding.scalabilityMode);
       let maxQuality = ProtoVideoQuality.OFF;
       qualities.forEach((q) => {
         if (q.enabled && (maxQuality === ProtoVideoQuality.OFF || q.quality > maxQuality)) {
@@ -480,25 +482,22 @@ async function setPublishingLayersForSender(
           encoding.active = false;
           hasChanged = true;
         }
-      } else if (!encoding.active || mode.spatial !== maxQuality + 1) {
+      } else if (!encoding.active /* || mode.spatial !== maxQuality + 1*/) {
         hasChanged = true;
         encoding.active = true;
-        /* @ts-ignore */
-        const originalMode = new ScalabilityMode(senderEncodings[0].scalabilityMode);
+        /*
+        @ts-ignore
+        const originalMode = new ScalabilityMode(senderEncodings[0].scalabilityMode)
         mode.spatial = maxQuality + 1;
         mode.suffix = originalMode.suffix;
         if (mode.spatial === 1) {
           // no suffix for L1Tx
           mode.suffix = undefined;
         }
-        /* @ts-ignore */
+        @ts-ignore
         encoding.scalabilityMode = mode.toString();
         encoding.scaleResolutionDownBy = 2 ** (2 - maxQuality);
-        if (senderEncodings[0].maxBitrate) {
-          encoding.maxBitrate =
-            senderEncodings[0].maxBitrate /
-            (encoding.scaleResolutionDownBy * encoding.scaleResolutionDownBy);
-        }
+      */
       }
     } else {
       if (isSVC) {