fix: refactor detector

Author: desher

README.md

@@ -51,14 +51,14 @@ By default, WebRTCIssueDetector can be created with minimum of mandatory constru
 ```typescript
 import WebRTCIssueDetector, {
   QualityLimitationsIssueDetector,
-  FramesDroppedIssueDetector,
   FramesEncodedSentIssueDetector,
   InboundNetworkIssueDetector,
   OutboundNetworkIssueDetector,
   NetworkMediaSyncIssueDetector,
   AvailableOutgoingBitrateIssueDetector,
   UnknownVideoDecoderImplementationDetector,
   FrozenVideoTrackDetector,
+  VideoDecoderIssueDetector,
 } from 'webrtc-issue-detector';
 
 const widWithDefaultConstructorArgs = new WebRTCIssueDetector();
@@ -68,14 +68,14 @@ const widWithDefaultConstructorArgs = new WebRTCIssueDetector();
 const widWithCustomConstructorArgs = new WebRTCIssueDetector({
   detectors: [ // you are free to change the detectors list according to your needs
     new QualityLimitationsIssueDetector(),
-    new FramesDroppedIssueDetector(),
     new FramesEncodedSentIssueDetector(),
     new InboundNetworkIssueDetector(),
     new OutboundNetworkIssueDetector(),
     new NetworkMediaSyncIssueDetector(),
     new AvailableOutgoingBitrateIssueDetector(),
     new UnknownVideoDecoderImplementationDetector(),
     new FrozenVideoTrackDetector(),
+    new VideoDecoderIssueDetector(),
   ],
   getStatsInterval: 10_000, // set custom stats parsing interval
   onIssues: (payload: IssueDetectorResult) => {
@@ -106,19 +106,12 @@ const exampleIssue = {
 }
 ```
 
-### FramesDroppedIssueDetector
+### VideoDecoderIssueDetector
 Detects issues with decoder.
 ```js
 const exampleIssue = {
     type: 'cpu',
     reason: 'decoder-cpu-throttling',
-    statsSample: {
-      deltaFramesDropped: 100,
-      deltaFramesReceived: 1000,
-      deltaFramesDecoded: 900,
-      framesDroppedPct: 10,
-    },
-    ssrc: 1234,
 }
 ```
 

src/WebRTCIssueDetector.ts

@@ -16,7 +16,6 @@ import PeriodicWebRTCStatsReporter from './parser/PeriodicWebRTCStatsReporter';
 import DefaultNetworkScoresCalculator from './NetworkScoresCalculator';
 import {
   AvailableOutgoingBitrateIssueDetector,
-  FramesDroppedIssueDetector,
   FramesEncodedSentIssueDetector,
   InboundNetworkIssueDetector,
   NetworkMediaSyncIssueDetector,
@@ -60,7 +59,6 @@ class WebRTCIssueDetector {
 
     this.detectors = params.detectors ?? [
       new QualityLimitationsIssueDetector(),
-      new FramesDroppedIssueDetector(),
       new FramesEncodedSentIssueDetector(),
       new InboundNetworkIssueDetector(),
       new OutboundNetworkIssueDetector(),

src/detectors/FramesDroppedIssueDetector.ts

@@ -69,7 +69,7 @@ class FrozenVideoTrackDetector extends BaseIssueDetector {
         return;
       }
 
-      // We skip it when ratio is too low because it should be handled by FramesDroppedIssueDetector
+      // We skip it when ratio is too low because it should be handled by VideoDecoderIssueDetector
       if (ratioFramesDropped >= this.#framesDroppedThreshold) {
         return;
       }

src/detectors/FrozenVideoTrackDetector.ts

@@ -95,16 +95,24 @@ class VideoDecoderIssueDetector extends BaseIssueDetector {
           volatility,
         });
 
-        return volatility > this.#volatilityThreshold && isDecodeTimePerFrameIncrease;
+        if (volatility > this.#volatilityThreshold && isDecodeTimePerFrameIncrease) {
+          return { ssrc: incomeVideoStream.ssrc, allDecodeTimePerFrame, volatility, };
+        } else {
+          return undefined;
+        }
       })
-      .filter((throttled) => throttled);
+      .filter((throttledVideoStream) => Boolean(throttledVideoStream));
 
 
     const affectedStreamsPercent = throtthedStreams.length / (data.video.inbound.length / 100);
     if (affectedStreamsPercent > this.#affectedStreamsPercentThreshold) {
       issues.push({
         type: IssueType.CPU,
         reason: IssueReason.DecoderCPUThrottling,
+        statsSample: {
+          affectedStreamsPercent,
+          throtthedStreams: throtthedStreams,
+        }
       });
     }
 

src/detectors/VideoDecoderIssueDetector.ts

@@ -1,6 +1,5 @@
 export { default as BaseIssueDetector } from './BaseIssueDetector';
 export { default as AvailableOutgoingBitrateIssueDetector } from './AvailableOutgoingBitrateIssueDetector';
-export { default as FramesDroppedIssueDetector } from './FramesDroppedIssueDetector';
 export { default as FramesEncodedSentIssueDetector } from './FramesEncodedSentIssueDetector';
 export { default as InboundNetworkIssueDetector } from './InboundNetworkIssueDetector';
 export { default as NetworkMediaSyncIssueDetector } from './NetworkMediaSyncIssueDetector';