@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 0.1.4 → 0.3.0

package/src/PeerConnectionController/AggregatedStats.ts

@@ -1,10 +1,6 @@
 // Copyright Epic Games, Inc. All Rights Reserved.
 
-import {
-    InboundRTPStats,
-    InboundVideoStats,
-    InboundAudioStats
-} from './InboundRTPStats';
+import { InboundRTPStats, InboundVideoStats, InboundAudioStats } from './InboundRTPStats';
 import { InboundTrackStats } from './InboundTrackStats';
 import { DataChannelStats } from './DataChannelStats';
 import { CandidateStat } from './CandidateStat';
@@ -19,12 +15,10 @@ import { Logger } from '@epicgames-ps/lib-pixelstreamingcommon-ue5.5';
  * The Aggregated Stats that is generated from the RTC Stats Report
  */
 
-type RTCStatsTypePS = RTCStatsType | 'stream' | 'media-playout';
+type RTCStatsTypePS = RTCStatsType | 'stream' | 'media-playout' | 'track';
 export class AggregatedStats {
     inboundVideoStats: InboundVideoStats;
     inboundAudioStats: InboundAudioStats;
-    lastVideoStats: InboundVideoStats;
-    lastAudioStats: InboundAudioStats;
     candidatePairs: Array<CandidatePairStats>;
     DataChannelStats: DataChannelStats;
     localCandidates: Array<CandidateStat>;
@@ -32,7 +26,7 @@ export class AggregatedStats {
     outBoundVideoStats: OutBoundVideoStats;
     sessionStats: SessionStats;
     streamStats: StreamStats;
-    codecs: Map<string, string>;
+    codecs: Map<string, CodecStats>;
     transportStats: RTCTransportStats;
 
     constructor() {
@@ -42,7 +36,7 @@ export class AggregatedStats {
         this.outBoundVideoStats = new OutBoundVideoStats();
         this.sessionStats = new SessionStats();
         this.streamStats = new StreamStats();
-        this.codecs = new Map<string, string>();
+        this.codecs = new Map<string, CodecStats>();
     }
 
     /**
@@ -101,8 +95,8 @@ export class AggregatedStats {
                     this.handleStream(stat);
                     break;
                 default:
-                    Logger.Error(Logger.GetStackTrace(), 'unhandled Stat Type');
-                    Logger.Log(Logger.GetStackTrace(), stat);
+                    Logger.Error('unhandled Stat Type');
+                    Logger.Info(stat);
                     break;
             }
         });
@@ -122,10 +116,8 @@ export class AggregatedStats {
      * @param stat - the stats coming in from ice candidates
      */
     handleCandidatePair(stat: CandidatePairStats) {
-
         // Add the candidate pair to the candidate pair array
-        this.candidatePairs.push(stat)
-
+        this.candidatePairs.push(stat);
     }
 
     /**
@@ -135,8 +127,7 @@ export class AggregatedStats {
     handleDataChannel(stat: DataChannelStats) {
         this.DataChannelStats.bytesReceived = stat.bytesReceived;
         this.DataChannelStats.bytesSent = stat.bytesSent;
-        this.DataChannelStats.dataChannelIdentifier =
-            stat.dataChannelIdentifier;
+        this.DataChannelStats.dataChannelIdentifier = stat.dataChannelIdentifier;
         this.DataChannelStats.id = stat.id;
         this.DataChannelStats.label = stat.label;
         this.DataChannelStats.messagesReceived = stat.messagesReceived;
@@ -176,7 +167,7 @@ export class AggregatedStats {
         RemoteCandidate.id = stat.id;
         RemoteCandidate.candidateType = stat.candidateType;
         RemoteCandidate.relayProtocol = stat.relayProtocol;
-        RemoteCandidate.transportId = stat.transportId
+        RemoteCandidate.transportId = stat.transportId;
         this.remoteCandidates.push(RemoteCandidate);
     }
 
@@ -187,45 +178,39 @@ export class AggregatedStats {
     handleInBoundRTP(stat: InboundRTPStats) {
         switch (stat.kind) {
             case 'video':
-                // Need to convert to unknown first to remove an error around
-                // InboundVideoStats having the bitrate member which isn't found on
-                // the InboundRTPStats
-                this.inboundVideoStats = stat as unknown as InboundVideoStats;
-
-                if (this.lastVideoStats != undefined) {
+                // Calculate bitrate between stat updates
+                if (
+                    stat.bytesReceived > this.inboundVideoStats.bytesReceived &&
+                    stat.timestamp > this.inboundVideoStats.timestamp
+                ) {
                     this.inboundVideoStats.bitrate =
-                        (8 *
-                            (this.inboundVideoStats.bytesReceived -
-                                this.lastVideoStats.bytesReceived)) /
-                        (this.inboundVideoStats.timestamp -
-                            this.lastVideoStats.timestamp);
-                    this.inboundVideoStats.bitrate = Math.floor(
-                        this.inboundVideoStats.bitrate
-                    );
+                        (8 * (stat.bytesReceived - this.inboundVideoStats.bytesReceived)) /
+                        (stat.timestamp - this.inboundVideoStats.timestamp);
+                    this.inboundVideoStats.bitrate = Math.floor(this.inboundVideoStats.bitrate);
+                }
+
+                // Copy members from stat into `this.inboundVideoStats`
+                for (const key in stat) {
+                    (this.inboundVideoStats as any)[key] = (stat as any)[key];
                 }
-                this.lastVideoStats = { ...this.inboundVideoStats };
                 break;
             case 'audio':
-                // Need to convert to unknown first to remove an error around
-                // InboundAudioStats having the bitrate member which isn't found on
-                // the InboundRTPStats
-                this.inboundAudioStats = stat as unknown as InboundAudioStats;
-
-                if (this.lastAudioStats != undefined) {
+                if (
+                    stat.bytesReceived > this.inboundAudioStats.bytesReceived &&
+                    stat.timestamp > this.inboundAudioStats.timestamp
+                ) {
                     this.inboundAudioStats.bitrate =
-                        (8 *
-                            (this.inboundAudioStats.bytesReceived -
-                                this.lastAudioStats.bytesReceived)) /
-                        (this.inboundAudioStats.timestamp -
-                            this.lastAudioStats.timestamp);
-                    this.inboundAudioStats.bitrate = Math.floor(
-                        this.inboundAudioStats.bitrate
-                    );
+                        (8 * (stat.bytesReceived - this.inboundAudioStats.bytesReceived)) /
+                        (stat.timestamp - this.inboundAudioStats.timestamp);
+                    this.inboundAudioStats.bitrate = Math.floor(this.inboundAudioStats.bitrate);
+                }
+                // Copy members from stat into `this.inboundAudioStats`
+                for (const key in stat) {
+                    (this.inboundAudioStats as any)[key] = (stat as any)[key];
                 }
-                this.lastAudioStats = { ...this.inboundAudioStats };
                 break;
             default:
-                Logger.Log(Logger.GetStackTrace(), 'Kind is not handled');
+                Logger.Error(`Kind should be audio or video, we got ${stat.kind} - that's unsupported.`);
                 break;
         }
     }
@@ -258,10 +243,7 @@ export class AggregatedStats {
      */
     handleTrack(stat: InboundTrackStats) {
         // we only want to extract stats from the video track
-        if (
-            stat.type === 'track' &&
-            (stat.trackIdentifier === 'video_label' || stat.kind === 'video')
-        ) {
+        if (stat.type === 'track' && (stat.trackIdentifier === 'video_label' || stat.kind === 'video')) {
             this.inboundVideoStats.framesDropped = stat.framesDropped;
             this.inboundVideoStats.framesReceived = stat.framesReceived;
             this.inboundVideoStats.frameHeight = stat.frameHeight;
@@ -269,19 +251,13 @@ export class AggregatedStats {
         }
     }
 
-    handleTransport(stat: RTCTransportStats){
+    handleTransport(stat: RTCTransportStats) {
         this.transportStats = stat;
     }
 
-
     handleCodec(stat: CodecStats) {
         const codecId = stat.id;
-        const codecType = `${stat.mimeType
-            .replace('video/', '')
-            .replace('audio/', '')}${
-            stat.sdpFmtpLine ? ` ${stat.sdpFmtpLine}` : ''
-        }`;
-        this.codecs.set(codecId, codecType);
+        this.codecs.set(codecId, stat);
     }
 
     handleSessionStatistics(
@@ -290,17 +266,10 @@ export class AggregatedStats {
         videoEncoderAvgQP: number
     ) {
         const deltaTime = Date.now() - videoStartTime;
-        this.sessionStats.runTime = new Date(deltaTime)
-            .toISOString()
-            .substr(11, 8)
-            .toString();
+        this.sessionStats.runTime = new Date(deltaTime).toISOString().substr(11, 8).toString();
 
         const controlsStreamInput =
-            inputController === null
-                ? 'Not sent yet'
-                : inputController
-                ? 'true'
-                : 'false';
+            inputController === null ? 'Not sent yet' : inputController ? 'true' : 'false';
         this.sessionStats.controlsStreamInput = controlsStreamInput;
 
         this.sessionStats.videoEncoderAvgQP = videoEncoderAvgQP;
@@ -319,14 +288,16 @@ export class AggregatedStats {
      * @returns The candidate pair that is currently receiving data
      */
     public getActiveCandidatePair(): CandidatePairStats | null {
-        
         // Check if the RTCTransport stat is not undefined
-        if (this.transportStats){
+        if (this.transportStats) {
             // Return the candidate pair that matches the transport candidate pair id
-            return this.candidatePairs.find((candidatePair) => candidatePair.id === this.transportStats.selectedCandidatePairId, null);
+            return this.candidatePairs.find(
+                (candidatePair) => candidatePair.id === this.transportStats.selectedCandidatePairId,
+                null
+            );
         }
-        
+
         // Fall back to the selected candidate pair
         return this.candidatePairs.find((candidatePair) => candidatePair.selected, null);
-    }  
+    }
 }

package/src/PeerConnectionController/CandidatePairStats.ts

@@ -20,5 +20,5 @@ export class CandidatePairStats {
     timestamp: number;
     transportId: string;
     type: string;
-    writable: boolean;  
+    writable: boolean;
 }

package/src/PeerConnectionController/CandidateStat.ts

@@ -7,7 +7,7 @@ export class CandidateStat {
     address: string;
     candidateType: string;
     id: string;
-    label: string;    
+    label: string;
     port: number;
     protocol: 'tcp' | 'udp';
     relayProtocol: 'tcp' | 'udp' | 'tls';