livekit-client 2.0.6 → 2.0.8

package/src/room/participant/publishUtils.ts

@@ -1,4 +1,5 @@
 import log from '../../logger';
+import { getBrowser } from '../../utils/browserParser';
 import { TrackInvalidError } from '../errors';
 import LocalAudioTrack from '../track/LocalAudioTrack';
 import LocalVideoTrack from '../track/LocalVideoTrack';
@@ -11,7 +12,14 @@ import type {
 } from '../track/options';
 import { ScreenSharePresets, VideoPreset, VideoPresets, VideoPresets43 } from '../track/options';
 import type { LoggerOptions } from '../types';
-import { getReactNativeOs, isFireFox, isReactNative, isSVCCodec } from '../utils';
+import {
+  compareVersions,
+  getReactNativeOs,
+  isFireFox,
+  isReactNative,
+  isSVCCodec,
+  isSafari,
+} from '../utils';
 
 /** @internal */
 export function mediaTrackToLocalTrack(
@@ -125,8 +133,6 @@ export function computeVideoEncodings(
   );
 
   if (scalabilityMode && isSVCCodec(videoCodec)) {
-    log.debug(`using svc with scalabilityMode ${scalabilityMode}`);
-
     const sm = new ScalabilityMode(scalabilityMode);
 
     const encodings: RTCRtpEncodingParameters[] = [];
@@ -134,17 +140,37 @@ export function computeVideoEncodings(
     if (sm.spatial > 3) {
       throw new Error(`unsupported scalabilityMode: ${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?.name === 'Chrome' && compareVersions(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 / 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 / 3 ** i,
-        /* @ts-ignore */
+        maxBitrate: videoEncoding.maxBitrate,
         maxFramerate: original.encoding.maxFramerate,
+        /* @ts-ignore */
+        scalabilityMode: scalabilityMode,
       });
     }
-    /* @ts-ignore */
-    encodings[0].scalabilityMode = scalabilityMode;
-    log.debug('encodings', encodings);
+
+    log.debug(`using svc encoding`, { encodings });
     return encodings;
   }
 
@@ -174,7 +200,7 @@ export function computeVideoEncodings(
     //      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);
@@ -246,6 +272,7 @@ export function determineAppropriateEncoding(
       break;
     }
   }
+
   // presets are based on the assumption of vp8 as a codec
   // for other codecs we adjust the maxBitrate if no specific videoEncoding has been provided
   // users should override these with ones that are optimized for their use case

package/src/room/track/LocalTrack.ts

@@ -448,6 +448,13 @@ export default abstract class LocalTrack<
     const unlock = await 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,
+      };
+      await processor.init(processorOptions);
       if (this.processor) {
         await this.stopProcessor();
       }
@@ -466,14 +473,6 @@ export default abstract class LocalTrack<
           this.log.error('failed to play processor element', { ...this.logContext, error }),
         );
 
-      const processorOptions = {
-        kind: this.kind,
-        track: this._mediaStreamTrack,
-        element: this.processorElement,
-        audioContext: this.audioContext,
-      };
-
-      await processor.init(processorOptions);
       this.processor = processor;
       if (this.processor.processedTrack) {
         for (const el of this.attachedElements) {
@@ -510,7 +509,10 @@ export default abstract class LocalTrack<
     this.processor = undefined;
     this.processorElement?.remove();
     this.processorElement = undefined;
-    await this.restart();
+    // apply original track constraints in case the processor changed them
+    await this._mediaStreamTrack.applyConstraints(this._constraints);
+    // force re-setting of the mediaStreamTrack on the sender
+    await this.setMediaStreamTrack(this._mediaStreamTrack, true);
     this.emit(TrackEvent.TrackProcessorUpdate);
   }
 

package/src/room/track/RemoteAudioTrack.ts

@@ -1,6 +1,6 @@
 import { TrackEvent } from '../events';
-import { computeBitrate } from '../stats';
 import type { AudioReceiverStats } from '../stats';
+import { computeBitrate } from '../stats';
 import type { LoggerOptions } from '../types';
 import { isReactNative, supportsSetSinkId } from '../utils';
 import RemoteTrack from './RemoteTrack';

package/src/room/track/options.ts

@@ -190,6 +190,13 @@ export interface ScreenShareCaptureOptions {
    * local speakers when the tab is captured.
    */
   suppressLocalAudioPlayback?: boolean;
+
+  /**
+   * Experimental option to instruct the browser to offer the current tab as the most prominent capture source
+   * @experimental
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#prefercurrenttab
+   */
+  preferCurrentTab?: boolean;
 }
 
 export interface AudioCaptureOptions {

package/src/room/track/utils.ts

@@ -183,6 +183,7 @@ export function screenCaptureToDisplayMediaStreamOptions(
     selfBrowserSurface: options.selfBrowserSurface,
     surfaceSwitching: options.surfaceSwitching,
     systemAudio: options.systemAudio,
+    preferCurrentTab: options.preferCurrentTab,
   };
 }