add rtt_us and use only baseline available stats

Author: lherman-cs

peer/proto

@@ -1,6 +1,7 @@
 // @ts-nocheck
 // @ts-nocheck
 // @ts-nocheck
+// @ts-nocheck
 // @generated by protobuf-ts 2.9.4 with parameter client_generic
 // @generated from protobuf file "google/protobuf/timestamp.proto" (package "google.protobuf", syntax proto3)
 // tslint:disable

peer/src/google/protobuf/timestamp.ts

@@ -334,6 +334,9 @@ export class Peer {
 
         const at = Date.now() * 1_000;
         const quality = calculateQualityScore(rawStats);
+        if (!quality) {
+          continue;
+        }
 
         events.push({
           timestampUs: BigInt(at),
@@ -342,7 +345,8 @@ export class Peer {
             dst: sess.other,
           },
           metrics: {
-            qualityScore: BigInt(quality),
+            qualityScore: quality.qualityScore,
+            rttUs: quality.rtt,
           },
         });
       }

peer/src/peer.ts

@@ -24,31 +24,31 @@ type RTCStatsType =
   | "track"
   | "transport";
 
+// https://developer.mozilla.org/en-US/docs/Web/API/RTCInboundRtpStreamStats
 interface RTCReceiverStats extends RTCStats {
   type: "inbound-rtp" | "rtp-receiver" | "remote-outbound-rtp";
   kind?: "audio" | "video";
   bytesReceived?: number;
   packetsReceived?: number;
   packetsLost?: number;
   jitter?: number;
-  framesDecoded?: number;
-  framesDropped?: number;
-  framesPerSecond?: number;
   totalSamplesReceived?: number;
+
+  // unsupported in Safari
+  // framesDecoded?: number;
+  // framesDropped?: number;
+  // framesPerSecond?: number;
 }
 
 interface RTCIceCandidatePairStats extends RTCStats {
   type: "candidate-pair";
   state?:
-    | "new"
-    | "checking"
-    | "connected"
-    | "completed"
     | "failed"
-    | "disconnected";
-  roundTripTime?: number;
-  localCandidateId?: string;
-  remoteCandidateId?: string;
+    | "frozen"
+    | "in-progress"
+    | "succeeded"
+    | "waiting";
+  currentRoundTripTime?: number;
 }
 
 interface RTCPeerConnectionStats extends RTCStats {
@@ -64,23 +64,33 @@ interface RTCPeerConnectionStats extends RTCStats {
   iceGatheringState?: "new" | "gathering" | "complete";
 }
 
-export function calculateQualityScore(stats: RTCStatsReport): number {
+export interface QualityStats {
+  qualityScore?: bigint;
+  // rtt in microseconds
+  rttUs?: bigint;
+}
+
+export function calculateQualityScore(
+  stats: RTCStatsReport,
+): QualityStats | null {
   let audioReceiverStats: RTCReceiverStats | undefined;
   let videoReceiverStats: RTCReceiverStats | undefined;
   let activeCandidatePairStats: RTCIceCandidatePairStats | undefined;
   let peerConnectionStats: RTCPeerConnectionStats | undefined;
 
   for (const stat of stats.values()) {
     if (stat.type === "inbound-rtp" || stat.type === "rtp-receiver") {
+      // https://developer.mozilla.org/en-US/docs/Web/API/RTCInboundRtpStreamStats
       const receiverStat = stat as RTCReceiverStats;
       if (receiverStat.kind === "audio") {
         audioReceiverStats = receiverStat;
       } else {
         videoReceiverStats = receiverStat;
       }
     } else if (stat.type === "candidate-pair") {
+      // https://developer.mozilla.org/en-US/docs/Web/API/RTCIceCandidatePairStats
       const candidatePairStat = stat as RTCIceCandidatePairStats;
-      if (candidatePairStat.state === "connected") {
+      if (candidatePairStat.state === "succeeded") {
         activeCandidatePairStats = candidatePairStat;
       }
     } else if (stat.type === "peer-connection") {
@@ -92,9 +102,11 @@ export function calculateQualityScore(stats: RTCStatsReport): number {
     peerConnectionStats && peerConnectionStats.iceConnectionState &&
     !["connected", "completed"].includes(peerConnectionStats.iceConnectionState)
   ) {
-    return 15; // Low score for connection issues
+    return null;
   }
 
+  const quality: QualityStats = {};
+
   let audioQuality = 100;
   if (audioReceiverStats) {
     const packetsLost = audioReceiverStats.packetsLost ?? 0;
@@ -128,31 +140,24 @@ export function calculateQualityScore(stats: RTCStatsReport): number {
     const videoJitterScore = videoJitter < 0.02
       ? 100
       : (videoJitter < 0.1 ? 70 : 30);
-    const framesDropped = videoReceiverStats.framesDropped ?? 0;
-    const framesDecoded = videoReceiverStats.framesDecoded ?? 0;
-    const frameDropRatio = framesDecoded > 0
-      ? framesDropped / framesDecoded
-      : 0;
-    const videoFrameDropScore = Math.max(0, 100 - (frameDropRatio * 100));
-    const videoFps = videoReceiverStats.framesPerSecond;
-    const videoFpsScore = videoFps !== undefined
-      ? Math.min(100, (videoFps / 15) * (100 / 1))
-      : 100;
-    videoQuality =
-      (videoPacketLossScore + videoJitterScore + videoFrameDropScore +
-        videoFpsScore) / 4;
+    videoQuality = (videoPacketLossScore + videoJitterScore) / 2;
   }
 
   let latencyScore = 80;
   if (activeCandidatePairStats) {
-    const rtt = activeCandidatePairStats.roundTripTime;
+    const rtt = activeCandidatePairStats.currentRoundTripTime;
     if (rtt !== undefined) {
+      // second to microseconds
+      quality.rttUs = BigInt(rtt * 1e6);
       latencyScore = rtt < 0.1 ? 100 : (rtt < 0.3 ? 80 : (rtt < 0.5 ? 60 : 40));
     }
   }
 
   const overallQuality = Math.round(
     (videoQuality * 0.5) + (audioQuality * 0.3) + (latencyScore * 0.2),
   );
-  return Math.max(0, Math.min(100, overallQuality));
+  const qualityScore = Math.max(0, Math.min(100, overallQuality));
+  quality.qualityScore = BigInt(qualityScore);
+
+  return quality;
 }

peer/src/quality.ts

@@ -364,9 +364,13 @@ export interface AnalyticsMetrics {
      * - 20-39: poor
      * - 0-19: bad
      *
-     * @generated from protobuf field: sint64 quality_score = 1;
+     * @generated from protobuf field: optional sint64 quality_score = 1;
      */
-    qualityScore: bigint;
+    qualityScore?: bigint;
+    /**
+     * @generated from protobuf field: optional sint64 rtt_us = 2;
+     */
+    rttUs?: bigint;
 }
 /**
  * @generated from protobuf message pulsebeam.v1.AnalyticsReportResp
@@ -714,7 +718,8 @@ export const AnalyticsTags = new AnalyticsTags$Type();
 class AnalyticsMetrics$Type extends MessageType<AnalyticsMetrics> {
     constructor() {
         super("pulsebeam.v1.AnalyticsMetrics", [
-            { no: 1, name: "quality_score", kind: "scalar", T: 18 /*ScalarType.SINT64*/, L: 0 /*LongType.BIGINT*/ }
+            { no: 1, name: "quality_score", kind: "scalar", opt: true, T: 18 /*ScalarType.SINT64*/, L: 0 /*LongType.BIGINT*/ },
+            { no: 2, name: "rtt_us", kind: "scalar", opt: true, T: 18 /*ScalarType.SINT64*/, L: 0 /*LongType.BIGINT*/ }
         ]);
     }
 }