@livedigital/client 3.8.0 → 3.9.0

package/dist/types/common.d.ts

@@ -102,7 +102,7 @@ export declare enum ConnectionQuality {
     GOOD = 3
 }
 export declare type EncoderConfig = {};
-export declare type VideoCodec = 'h264' | 'vp8';
+export declare type VideoCodec = 'h264' | 'vp8' | 'vp9';
 export declare type AudioCodec = 'opus';
 export declare type VideoEncoderConfig = EncoderConfig & {
     preferredCodec?: VideoCodec;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@livedigital/client",
   "author": "vlprojects",
   "license": "MIT",
-  "version": "3.8.0",
+  "version": "3.9.0",
   "private": false,
   "bugs": {
     "url": "https://github.com/vlprojects/livedigital-sdk/issues"

package/src/engine/PeerConsumer.ts

@@ -62,7 +62,7 @@ class PeerConsumer {
     });
     this.currentMaxSpatialLayer = this.appData.producerData.maxSpatialLayer;
     this.parseScalabilityMode();
-    this.setSpatialLayersParams();
+    this.initAvailableSpatialLayers();
     this.setCurrentSpatialLayerParams();
   }
 
@@ -104,26 +104,46 @@ class PeerConsumer {
     }
   }
 
-  setSpatialLayersParams(): void {
-    const { encodings } = this.appData.producerData;
+  initAvailableSpatialLayers(): void {
+    const { encodings, trackTransformParams } = this.appData.producerData;
     if (!encodings) {
       return;
     }
 
-    this.availableSpatialLayers = encodings.map((encoding) => this.parseSpatialLayerParams(encoding));
+    this.availableSpatialLayers = encodings.map((encoding) => this.tryPrepareSpatialLayerParams(encoding));
+
+    if (!trackTransformParams || this.availableSpatialLayers.length > 1 || this.spatialLayers < 2) {
+      this.logger.debug('Using available spatial layers', { case: 'initAvailableSpatialLayers' });
+      return;
+    }
+
+    this.logger.debug('Pre-generating encodings with spatial layer params', { case: 'initAvailableSpatialLayers' });
+
+    const preGeneratedEncodings: SpatialLayerParams[] = [];
+    const baseEncoding = encodings[encodings.length - 1];
+
+    // imitate encodings with spatial layers params for automatic quality switching on client side
+    for (let i = this.spatialLayers - 1; i >= 0; i -= 1) {
+      preGeneratedEncodings.push(this.tryPrepareSpatialLayerParams({
+        ...baseEncoding,
+        scaleResolutionDownBy: 2 ** i,
+      }));
+    }
+
+    this.availableSpatialLayers = preGeneratedEncodings;
   }
 
   setCurrentSpatialLayerParams(): void {
     const { encodings } = this.appData.producerData;
-    if (!encodings) {
+    if (!encodings || !encodings[this.currentSpatialLayer]) {
       return;
     }
 
-    this.currentSpatialLayerParams = this.parseSpatialLayerParams(encodings[this.currentSpatialLayer]);
+    this.currentSpatialLayerParams = this.tryPrepareSpatialLayerParams(encodings[this.currentSpatialLayer]);
     this.logger.debug('setCurrentSpatialLayerParams()', { currentSpatialLayerParams: this.currentSpatialLayerParams });
   }
 
-  parseSpatialLayerParams(encoding: RtpEncodingParameters): SpatialLayerParams {
+  tryPrepareSpatialLayerParams(encoding: RtpEncodingParameters): SpatialLayerParams {
     const { trackTransformParams } = this.appData.producerData;
     if (!trackTransformParams) {
       return encoding;
@@ -131,6 +151,7 @@ class PeerConsumer {
 
     const { width, height } = trackTransformParams;
     const coefficient = encoding.scaleResolutionDownBy || 1;
+
     if (width && height) {
       return {
         width: width / coefficient,

package/src/engine/index.ts

@@ -53,6 +53,7 @@ import {
   MediaTracksFactory, AudioTrack, Track, BaseTrack,
 } from '../types/media';
 import ChannelStateSyncEventHandler from './handlers/ChannelStateSyncEventHandler';
+import { getSupportedCodecsMimeTypes } from '../helpers/media';
 
 type EngineParams = {
   clientEventEmitter: EnhancedEventEmitter;
@@ -205,6 +206,11 @@ class Engine {
         .request('router.getRtpCapabilities') as { rtpCapabilities: RtpCapabilities };
       await this.media.createNoiseSuppressor();
       await this.media.loadDevice(rtpCapabilities);
+
+      this.logger.info('Supported capabilities', {
+        codecs: getSupportedCodecsMimeTypes(this.media.mediasoupDevice),
+      });
+
       this.webRtcIssueDetector?.watchNewPeerConnections();
       await this.network.createSendTransport(this.media.mediasoupDevice);
       await this.network.createRecvTransport(this.media.mediasoupDevice);

package/src/engine/media/tracks/PeerTrack.ts

@@ -233,7 +233,7 @@ class PeerTrack {
 
     try {
       if (this.consumer.isAudio) {
-        this.#logger.warn('requestVideoPreferredLayers()', { message: 'Only video consumers support' });
+        this.#logger.warn('Only video consumers support layers', { case: 'requestVideoPreferredLayers' });
         return;
       }
 
@@ -242,7 +242,11 @@ class PeerTrack {
       }
 
       if (spatialLayer > this.consumer.spatialLayers) {
-        this.#logger.warn('requestVideoPreferredLayers()', { message: 'Invalid spatial layer' });
+        this.#logger.warn('Invalid spatial layer', {
+          spatialLayer,
+          consumerSpatialLayers: this.consumer.spatialLayers,
+          case: 'requestVideoPreferredLayers',
+        });
         return;
       }
 
@@ -264,9 +268,16 @@ class PeerTrack {
         temporalLayer,
       });
     } catch (error) {
-      this.#logger.error('requestVideoPreferredLayers()', {
-        peer: this,
+      this.#logger.error('Failed to request preferred layers', {
+        case: 'requestVideoPreferredLayers',
+        track: {
+          id: this.mediaStreamTrack.id,
+          kind: this.mediaStreamTrack.kind,
+          label: this.mediaStreamTrack.label,
+        },
         consumerId: this.consumer.id,
+        spatialLayers: this.consumer.spatialLayers,
+        temporalLayers: this.consumer.temporalLayers,
         error,
       });
       throw new Error('Error request preferred layers');
@@ -301,7 +312,7 @@ class PeerTrack {
     }
 
     if (this.consumer.isAudio) {
-      this.#logger.warn('getVideoAvailableLayers()', { message: 'Only video consumers support' });
+      this.#logger.warn('Only video consumers support layers', { case: 'getVideoAvailableLayers' });
       return undefined;
     }
 
@@ -353,12 +364,11 @@ class PeerTrack {
         || spatialLayer < this.consumer.currentMaxSpatialLayer;
 
       if (cantRequest) {
-        this.#logger.warn('requestMaxSpatialLayer()', {
-          message: 'Can`t request this spatial layer',
+        this.#logger.warn('Can`t request this spatial layer', {
+          case: 'requestMaxSpatialLayer',
           consumerId,
           spatialLayer,
         });
-
         return;
       }
 
@@ -373,8 +383,8 @@ class PeerTrack {
         spatialLayer,
       });
     } catch (error) {
-      this.#logger.warn('requestMaxSpatialLayer()', {
-        message: 'Error request spatial layer',
+      this.#logger.warn('Failed to request max spatial layer', {
+        case: 'requestMaxSpatialLayer',
         consumerId,
         spatialLayer,
         error,

package/src/helpers/media.ts

@@ -1,5 +1,6 @@
-import { types } from 'mediasoup-client';
+import { Device, types } from 'mediasoup-client';
 import Bowser from 'bowser';
+import { RtpCodecCapability } from 'mediasoup-client/lib/RtpParameters';
 
 // eslint-disable-next-line import/prefer-default-export
 export const detectHandlerName = (userAgent?: string): types.BuiltinHandlerName | undefined => {
@@ -24,7 +25,7 @@ export const detectHandlerName = (userAgent?: string): types.BuiltinHandlerName
 
 export const getNewAudioContext = (contextOptions?: AudioContextOptions): AudioContext | null => {
   const Context = window.AudioContext // Default
-    || (window as unknown as { webkitAudioContext : any }).webkitAudioContext // Safari and old versions of Chrome
+    || (window as unknown as { webkitAudioContext: any }).webkitAudioContext // Safari and old versions of Chrome
     || false;
 
   if (Context) {
@@ -33,3 +34,16 @@ export const getNewAudioContext = (contextOptions?: AudioContextOptions): AudioC
 
   return null;
 };
+
+export const getSupportedCodecsMimeTypes = (device: Device): string[] => device
+  .rtpCapabilities
+  .codecs
+  ?.reduce((acc: string[], codec: RtpCodecCapability) => {
+    const preparedCodec = codec.mimeType?.toLowerCase();
+
+    if (!acc.includes(preparedCodec)) {
+      acc.push(preparedCodec);
+    }
+
+    return acc;
+  }, []) || [];

package/src/types/common.ts

@@ -128,7 +128,7 @@ export enum ConnectionQuality {
 
 export type EncoderConfig = {};
 
-export type VideoCodec = 'h264' | 'vp8';
+export type VideoCodec = 'h264' | 'vp8' | 'vp9';
 
 export type AudioCodec = 'opus';