@webex/plugin-meetings 3.0.0-beta.75 → 3.0.0-beta.77

package/src/meeting/index.ts

@@ -632,31 +632,47 @@ export default class Meeting extends StatelessWebexPlugin {
      * All multistream media requests sent out for this meeting have to go through them.
      */
     this.mediaRequestManagers = {
-      // @ts-ignore - config coming from registerPlugin
-      audio: new MediaRequestManager(this.config.degradationPreferences, (mediaRequests) => {
-        if (!this.mediaProperties.webrtcMediaConnection) {
-          LoggerProxy.logger.warn(
-            'Meeting:index#mediaRequestManager --> trying to send audio media request before media connection was created'
-          );
+      audio: new MediaRequestManager(
+        (mediaRequests) => {
+          if (!this.mediaProperties.webrtcMediaConnection) {
+            LoggerProxy.logger.warn(
+              'Meeting:index#mediaRequestManager --> trying to send audio media request before media connection was created'
+            );
 
-          return;
-        }
-        this.mediaProperties.webrtcMediaConnection.requestMedia(MediaType.AudioMain, mediaRequests);
-      }),
-      // @ts-ignore - config coming from registerPlugin
-      video: new MediaRequestManager(this.config.degradationPreferences, (mediaRequests) => {
-        if (!this.mediaProperties.webrtcMediaConnection) {
-          LoggerProxy.logger.warn(
-            'Meeting:index#mediaRequestManager --> trying to send video media request before media connection was created'
+            return;
+          }
+          this.mediaProperties.webrtcMediaConnection.requestMedia(
+            MediaType.AudioMain,
+            mediaRequests
           );
+        },
+        {
+          // @ts-ignore - config coming from registerPlugin
+          degradationPreferences: this.config.degradationPreferences,
+          kind: 'audio',
+        }
+      ),
+      video: new MediaRequestManager(
+        (mediaRequests) => {
+          if (!this.mediaProperties.webrtcMediaConnection) {
+            LoggerProxy.logger.warn(
+              'Meeting:index#mediaRequestManager --> trying to send video media request before media connection was created'
+            );
 
-          return;
+            return;
+          }
+          this.mediaProperties.webrtcMediaConnection.requestMedia(
+            MediaType.VideoMain,
+            mediaRequests
+          );
+        },
+        {
+          // @ts-ignore - config coming from registerPlugin
+          degradationPreferences: this.config.degradationPreferences,
+          kind: 'video',
         }
-        this.mediaProperties.webrtcMediaConnection.requestMedia(MediaType.VideoMain, mediaRequests);
-      }),
+      ),
       screenShareAudio: new MediaRequestManager(
-        // @ts-ignore - config coming from registerPlugin
-        this.config.degradationPreferences,
         (mediaRequests) => {
           if (!this.mediaProperties.webrtcMediaConnection) {
             LoggerProxy.logger.warn(
@@ -669,11 +685,14 @@ export default class Meeting extends StatelessWebexPlugin {
             MediaType.AudioSlides,
             mediaRequests
           );
+        },
+        {
+          // @ts-ignore - config coming from registerPlugin
+          degradationPreferences: this.config.degradationPreferences,
+          kind: 'audio',
         }
       ),
       screenShareVideo: new MediaRequestManager(
-        // @ts-ignore - config coming from registerPlugin
-        this.config.degradationPreferences,
         (mediaRequests) => {
           if (!this.mediaProperties.webrtcMediaConnection) {
             LoggerProxy.logger.warn(
@@ -686,6 +705,11 @@ export default class Meeting extends StatelessWebexPlugin {
             MediaType.VideoSlides,
             mediaRequests
           );
+        },
+        {
+          // @ts-ignore - config coming from registerPlugin
+          degradationPreferences: this.config.degradationPreferences,
+          kind: 'video',
         }
       ),
     };
@@ -5343,8 +5367,12 @@ export default class Meeting extends StatelessWebexPlugin {
         if (this.config.stats.enableStatsAnalyzer) {
           // @ts-ignore - config coming from registerPlugin
           this.networkQualityMonitor = new NetworkQualityMonitor(this.config.stats);
-          // @ts-ignore - config coming from registerPlugin
-          this.statsAnalyzer = new StatsAnalyzer(this.config.stats, this.networkQualityMonitor);
+          this.statsAnalyzer = new StatsAnalyzer(
+            // @ts-ignore - config coming from registerPlugin
+            this.config.stats,
+            (ssrc: number) => this.receiveSlotManager.findReceiveSlotBySsrc(ssrc),
+            this.networkQualityMonitor
+          );
           this.setupStatsAnalyzerEventHandlers();
           this.networkQualityMonitor.on(
             EVENT_TRIGGERS.NETWORK_QUALITY,

package/src/multistream/mediaRequestManager.ts

@@ -6,6 +6,8 @@ import {
   ReceiverSelectedInfo,
   CodecInfo as WcmeCodecInfo,
   H264Codec,
+  getRecommendedMaxBitrateForFrameSize,
+  RecommendedOpusBitrates,
 } from '@webex/internal-media-core';
 import {cloneDeep, debounce, isEmpty} from 'lodash';
 
@@ -64,10 +66,17 @@ type DegradationPreferences = {
 };
 
 type SendMediaRequestsCallback = (mediaRequests: WcmeMediaRequest[]) => void;
+type Kind = 'audio' | 'video';
 
+type Options = {
+  degradationPreferences: DegradationPreferences;
+  kind: Kind;
+};
 export class MediaRequestManager {
   private sendMediaRequestsCallback: SendMediaRequestsCallback;
 
+  private kind: Kind;
+
   private counter: number;
 
   private clientRequests: {[key: MediaRequestId]: MediaRequest};
@@ -80,14 +89,12 @@ export class MediaRequestManager {
 
   private previousWCMEMediaRequests: Array<WcmeMediaRequest> = [];
 
-  constructor(
-    degradationPreferences: DegradationPreferences,
-    sendMediaRequestsCallback: SendMediaRequestsCallback
-  ) {
+  constructor(sendMediaRequestsCallback: SendMediaRequestsCallback, options: Options) {
     this.sendMediaRequestsCallback = sendMediaRequestsCallback;
     this.counter = 0;
     this.clientRequests = {};
-    this.degradationPreferences = degradationPreferences;
+    this.degradationPreferences = options.degradationPreferences;
+    this.kind = options.kind;
     this.sourceUpdateListener = this.commit.bind(this);
     this.debouncedSourceUpdateListener = debounce(
       this.sourceUpdateListener,
@@ -175,6 +182,45 @@ export class MediaRequestManager {
     );
   }
 
+  /**
+   * Returns the maxPayloadBitsPerSecond per Stream
+   *
+   * If MediaRequestManager kind is "audio", a constant bitrate will be returned.
+   * If MediaRequestManager kind is "video", the bitrate will be calculated based
+   * on maxFs (default h264 maxFs as fallback if maxFs is not defined)
+   *
+   * @param {MediaRequest} mediaRequest  - mediaRequest to take data from
+   * @returns {number} maxPayloadBitsPerSecond
+   */
+  private getMaxPayloadBitsPerSecond(mediaRequest: MediaRequest): number {
+    if (this.kind === 'audio') {
+      // return mono_music bitrate default if the kind of mediarequest manager is audio:
+      return RecommendedOpusBitrates.FB_MONO_MUSIC;
+    }
+
+    return getRecommendedMaxBitrateForFrameSize(
+      mediaRequest.codecInfo.maxFs || CODEC_DEFAULTS.h264.maxFs
+    );
+  }
+
+  /**
+   * Returns the max Macro Blocks per second (maxMbps) per H264 Stream
+   *
+   * The maxMbps will be calculated based on maxFs and maxFps
+   * (default h264 maxFps as fallback if maxFps is not defined)
+   *
+   * @param {MediaRequest} mediaRequest  - mediaRequest to take data from
+   * @returns {number} maxMbps
+   */
+  // eslint-disable-next-line class-methods-use-this
+  private getH264MaxMbps(mediaRequest: MediaRequest): number {
+    // fallback for maxFps (not needed for maxFs, since there is a fallback already in getDegradedClientRequests)
+    const maxFps = mediaRequest.codecInfo.maxFps || CODEC_DEFAULTS.h264.maxFps;
+
+    // divided by 100 since maxFps is 3000 (for 30 frames per seconds)
+    return (mediaRequest.codecInfo.maxFs * maxFps) / 100;
+  }
+
   /**
    * Clears the previous media requests.
    *
@@ -188,7 +234,6 @@ export class MediaRequestManager {
     const wcmeMediaRequests: WcmeMediaRequest[] = [];
 
     const clientRequests = this.getDegradedClientRequests();
-    const maxPayloadBitsPerSecond = 10 * 1000 * 1000;
 
     // map all the client media requests to wcme media requests
     Object.values(clientRequests).forEach((mr) => {
@@ -206,14 +251,14 @@ export class MediaRequestManager {
               )
             : new ReceiverSelectedInfo(mr.policyInfo.csi),
           mr.receiveSlots.map((receiveSlot) => receiveSlot.wcmeReceiveSlot),
-          maxPayloadBitsPerSecond,
+          this.getMaxPayloadBitsPerSecond(mr),
           mr.codecInfo && [
             new WcmeCodecInfo(
               0x80,
               new H264Codec(
                 mr.codecInfo.maxFs,
                 mr.codecInfo.maxFps || CODEC_DEFAULTS.h264.maxFps,
-                mr.codecInfo.maxMbps || CODEC_DEFAULTS.h264.maxMbps,
+                this.getH264MaxMbps(mr),
                 mr.codecInfo.maxWidth,
                 mr.codecInfo.maxHeight
               )

package/src/multistream/receiveSlotManager.ts

@@ -151,4 +151,16 @@ export class ReceiveSlotManager {
       });
     });
   }
+
+  /**
+   * Find a receive slot by a ssrc.
+   *
+   * @param ssrc - The ssrc of the receive slot to find.
+   * @returns - The receive slot with this ssrc, undefined if not found.
+   */
+  findReceiveSlotBySsrc(ssrc: number): ReceiveSlot | undefined {
+    return Object.values(this.allocatedSlots)
+      .flat()
+      .find((r) => ssrc && r.wcmeReceiveSlot?.id?.ssrc === ssrc);
+  }
 }

package/src/statsAnalyzer/index.ts

@@ -28,6 +28,7 @@ import {
   getVideoSenderMqa,
   getVideoReceiverMqa,
 } from './mqaUtil';
+import {ReceiveSlot} from '../multistream/receiveSlot';
 
 export const EVENTS = {
   MEDIA_QUALITY: 'MEDIA_QUALITY',
@@ -53,6 +54,8 @@ const emptyReceiver = {
   meanRoundTripTime: [],
 };
 
+type ReceiveSlotCallback = (csi: number) => ReceiveSlot | undefined;
+
 /**
  * Stats Analyzer class that will emit events based on detected quality
  *
@@ -74,17 +77,20 @@ export class StatsAnalyzer extends EventsScope {
   statsInterval: NodeJS.Timeout;
   statsResults: any;
   statsStarted: any;
+  receiveSlotCallback: ReceiveSlotCallback;
 
   /**
    * Creates a new instance of StatsAnalyzer
    * @constructor
    * @public
    * @param {Object} config SDK Configuration Object
+   * @param {Function} receiveSlotCallback Callback used to access receive slots.
    * @param {Object} networkQualityMonitor class for assessing network characteristics (jitter, packetLoss, latency)
    * @param {Object} statsResults Default properties for stats
    */
   constructor(
     config: any,
+    receiveSlotCallback: ReceiveSlotCallback = () => undefined,
     networkQualityMonitor: object = {},
     statsResults: object = defaultStats
   ) {
@@ -98,6 +104,7 @@ export class StatsAnalyzer extends EventsScope {
     this.mqaSentCount = -1;
     this.lastMqaDataSent = {};
     this.lastEmittedStartStopEvent = {};
+    this.receiveSlotCallback = receiveSlotCallback;
   }
 
   /**
@@ -523,7 +530,8 @@ export class StatsAnalyzer extends EventsScope {
           currentStats.totalPacketsSent === 0
         ) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No audio RTP packets sent`
+            `StatsAnalyzer:index#compareLastStatsResult --> No audio RTP packets sent`,
+            currentStats.totalPacketsSent
           );
         } else {
           if (
@@ -531,7 +539,8 @@ export class StatsAnalyzer extends EventsScope {
             currentStats.totalAudioEnergy === 0
           ) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No audio Energy present`
+              `StatsAnalyzer:index#compareLastStatsResult --> No audio Energy present`,
+              currentStats.totalAudioEnergy
             );
           }
 
@@ -565,14 +574,16 @@ export class StatsAnalyzer extends EventsScope {
 
         if (currentPacketsReceived === previousPacketsReceived || currentPacketsReceived === 0) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No audio RTP packets received`
+            `StatsAnalyzer:index#compareLastStatsResult --> No audio RTP packets received`,
+            currentPacketsReceived
           );
         } else if (
           currentSamplesReceived === previousSamplesReceived ||
           currentSamplesReceived === 0
         ) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No audio samples received`
+            `StatsAnalyzer:index#compareLastStatsResult --> No audio samples received`,
+            currentSamplesReceived
           );
         }
 
@@ -589,7 +600,8 @@ export class StatsAnalyzer extends EventsScope {
           currentStats.totalPacketsSent === 0
         ) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No video RTP packets sent`
+            `StatsAnalyzer:index#compareLastStatsResult --> No video RTP packets sent`,
+            currentStats.totalPacketsSent
           );
         } else {
           if (
@@ -597,7 +609,8 @@ export class StatsAnalyzer extends EventsScope {
             currentStats.framesEncoded === 0
           ) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No video Frames Encoded`
+              `StatsAnalyzer:index#compareLastStatsResult --> No video Frames Encoded`,
+              currentStats.framesEncoded
             );
           }
 
@@ -607,7 +620,8 @@ export class StatsAnalyzer extends EventsScope {
             this.statsResults.resolutions['video-send'].send.framesSent === 0
           ) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No video Frames sent`
+              `StatsAnalyzer:index#compareLastStatsResult --> No video Frames sent`,
+              this.statsResults.resolutions['video-send'].send.framesSent
             );
           }
         }
@@ -643,24 +657,28 @@ export class StatsAnalyzer extends EventsScope {
 
         if (currentPacketsReceived === previousPacketsReceived || currentPacketsReceived === 0) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No video RTP packets received`
+            `StatsAnalyzer:index#compareLastStatsResult --> No video RTP packets received`,
+            currentPacketsReceived
           );
         } else {
           if (currentFramesReceived === previousFramesReceived || currentFramesReceived === 0) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No video frames received`
+              `StatsAnalyzer:index#compareLastStatsResult --> No video frames received`,
+              currentFramesReceived
             );
           }
 
           if (currentFramesDecoded === previousFramesDecoded || currentFramesDecoded === 0) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No video frames decoded`
+              `StatsAnalyzer:index#compareLastStatsResult --> No video frames decoded`,
+              currentFramesDecoded
             );
           }
 
           if (currentFramesDropped - previousFramesDropped > 10) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> video frames are getting dropped`
+              `StatsAnalyzer:index#compareLastStatsResult --> video frames are getting dropped`,
+              currentFramesDropped - previousFramesDropped
             );
           }
         }
@@ -679,7 +697,8 @@ export class StatsAnalyzer extends EventsScope {
           currentStats.totalPacketsSent === 0
         ) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No share RTP packets sent`
+            `StatsAnalyzer:index#compareLastStatsResult --> No share RTP packets sent`,
+            currentStats.totalPacketsSent
           );
         } else {
           if (
@@ -687,7 +706,8 @@ export class StatsAnalyzer extends EventsScope {
             currentStats.framesEncoded === 0
           ) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No share frames getting encoded`
+              `StatsAnalyzer:index#compareLastStatsResult --> No share frames getting encoded`,
+              currentStats.framesEncoded
             );
           }
 
@@ -697,7 +717,8 @@ export class StatsAnalyzer extends EventsScope {
             this.statsResults.resolutions['video-share-send'].send.framesSent === 0
           ) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No share frames sent`
+              `StatsAnalyzer:index#compareLastStatsResult --> No share frames sent`,
+              this.statsResults.resolutions['video-share-send'].send.framesSent
             );
           }
         }
@@ -735,24 +756,28 @@ export class StatsAnalyzer extends EventsScope {
 
         if (currentPacketsReceived === previousPacketsReceived || currentPacketsReceived === 0) {
           LoggerProxy.logger.info(
-            `StatsAnalyzer:index#compareLastStatsResult --> No share RTP packets received`
+            `StatsAnalyzer:index#compareLastStatsResult --> No share RTP packets received`,
+            currentPacketsReceived
           );
         } else {
           if (currentFramesReceived === previousFramesReceived || currentFramesReceived === 0) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No share frames received`
+              `StatsAnalyzer:index#compareLastStatsResult --> No share frames received`,
+              currentFramesReceived
             );
           }
 
           if (currentFramesDecoded === previousFramesDecoded || currentFramesDecoded === 0) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> No share frames decoded`
+              `StatsAnalyzer:index#compareLastStatsResult --> No share frames decoded`,
+              currentFramesDecoded
             );
           }
 
           if (currentFramesDropped - previousFramesDropped > 10) {
             LoggerProxy.logger.info(
-              `StatsAnalyzer:index#compareLastStatsResult --> share frames are getting dropped`
+              `StatsAnalyzer:index#compareLastStatsResult --> share frames are getting dropped`,
+              currentFramesDropped - previousFramesDropped
             );
           }
         }
@@ -933,6 +958,10 @@ export class StatsAnalyzer extends EventsScope {
 
     if (result.bytesReceived) {
       let kilobytes = 0;
+      const receiveSlot = this.receiveSlotCallback(result.ssrc);
+      const idAndCsi = receiveSlot
+        ? `id: "${receiveSlot.id || ''}"${receiveSlot.csi ? ` and csi: ${receiveSlot.csi}` : ''}`
+        : '';
 
       if (result.frameWidth && result.frameHeight) {
         this.statsResults.resolutions[mediaType][sendrecvType].width = result.frameWidth;
@@ -989,10 +1018,12 @@ export class StatsAnalyzer extends EventsScope {
         result.packetsReceived;
 
       if (this.statsResults[mediaType][sendrecvType].packetsReceived === 0) {
-        LoggerProxy.logger.info(
-          `StatsAnalyzer:index#processInboundRTPResult --> No packets received for ${mediaType} `,
-          this.statsResults[mediaType][sendrecvType].packetsReceived
-        );
+        if (receiveSlot) {
+          LoggerProxy.logger.info(
+            `StatsAnalyzer:index#processInboundRTPResult --> No packets received for receive slot ${idAndCsi}`,
+            this.statsResults[mediaType][sendrecvType].packetsReceived
+          );
+        }
       }
 
       //  Check the over all packet Lost ratio
@@ -1004,7 +1035,7 @@ export class StatsAnalyzer extends EventsScope {
           : 0;
       if (this.statsResults[mediaType][sendrecvType].currentPacketLossRatio > 3) {
         LoggerProxy.logger.info(
-          'StatsAnalyzer:index#processInboundRTPResult --> Packets getting lost from the receiver ',
+          `StatsAnalyzer:index#processInboundRTPResult --> Packets getting lost from the receiver with slot ${idAndCsi}`,
           this.statsResults[mediaType][sendrecvType].currentPacketLossRatio
         );
       }

package/test/unit/spec/meeting/utils.js

@@ -4,7 +4,7 @@ import MeetingUtil from '@webex/plugin-meetings/src/meeting/util';
 import LoggerProxy from '@webex/plugin-meetings/src/common/logs/logger-proxy';
 import LoggerConfig from '@webex/plugin-meetings/src/common/logs/logger-config';
 import Metrics from '@webex/plugin-meetings/src/metrics/index';
-import {DISPLAY_HINTS} from '@webex/plugin-meetings/dist/constants';
+import {DISPLAY_HINTS} from '@webex/plugin-meetings/src/constants';
 
 describe('plugin-meetings', () => {
   describe('Meeting utils function', () => {