@epicgames-ps/lib-pixelstreamingfrontend-ue5.5 0.4.8 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/dist/cjs/Config/Config.js +4 -0
  2. package/dist/cjs/Config/Config.js.map +1 -1
  3. package/dist/cjs/Config/SettingBase.js +1 -3
  4. package/dist/cjs/Config/SettingBase.js.map +1 -1
  5. package/dist/cjs/Config/SettingFlag.js +1 -3
  6. package/dist/cjs/Config/SettingFlag.js.map +1 -1
  7. package/dist/cjs/Config/SettingNumber.js +1 -3
  8. package/dist/cjs/Config/SettingNumber.js.map +1 -1
  9. package/dist/cjs/Config/SettingOption.js +2 -6
  10. package/dist/cjs/Config/SettingOption.js.map +1 -1
  11. package/dist/cjs/Config/SettingText.js +1 -3
  12. package/dist/cjs/Config/SettingText.js.map +1 -1
  13. package/dist/cjs/Inputs/GamepadController.js +0 -2
  14. package/dist/cjs/Inputs/GamepadController.js.map +1 -1
  15. package/dist/cjs/PeerConnectionController/AggregatedStats.js +103 -45
  16. package/dist/cjs/PeerConnectionController/AggregatedStats.js.map +1 -1
  17. package/dist/cjs/PeerConnectionController/InboundRTPStats.js.map +1 -1
  18. package/dist/cjs/PeerConnectionController/LatencyCalculator.js +290 -0
  19. package/dist/cjs/PeerConnectionController/LatencyCalculator.js.map +1 -0
  20. package/dist/cjs/PeerConnectionController/OutBoundRTPStats.js +11 -7
  21. package/dist/cjs/PeerConnectionController/OutBoundRTPStats.js.map +1 -1
  22. package/dist/cjs/PeerConnectionController/PeerConnectionController.js +53 -19
  23. package/dist/cjs/PeerConnectionController/PeerConnectionController.js.map +1 -1
  24. package/dist/cjs/PixelStreaming/PixelStreaming.js +21 -3
  25. package/dist/cjs/PixelStreaming/PixelStreaming.js.map +1 -1
  26. package/dist/cjs/Util/EventEmitter.js +31 -1
  27. package/dist/cjs/Util/EventEmitter.js.map +1 -1
  28. package/dist/cjs/WebRtcPlayer/WebRtcPlayerController.js +20 -4
  29. package/dist/cjs/WebRtcPlayer/WebRtcPlayerController.js.map +1 -1
  30. package/dist/cjs/__test__/mockMediaStream.js +100 -0
  31. package/dist/cjs/__test__/mockMediaStream.js.map +1 -0
  32. package/dist/cjs/__test__/mockRTCPeerConnection.js +252 -0
  33. package/dist/cjs/__test__/mockRTCPeerConnection.js.map +1 -0
  34. package/dist/cjs/__test__/mockRTCRtpReceiver.js +26 -0
  35. package/dist/cjs/__test__/mockRTCRtpReceiver.js.map +1 -0
  36. package/dist/cjs/__test__/mockWebSocket.js +109 -0
  37. package/dist/cjs/__test__/mockWebSocket.js.map +1 -0
  38. package/dist/cjs/pixelstreamingfrontend.js +4 -2
  39. package/dist/cjs/pixelstreamingfrontend.js.map +1 -1
  40. package/dist/esm/Config/Config.js +4 -0
  41. package/dist/esm/Config/Config.js.map +1 -1
  42. package/dist/esm/Config/SettingBase.js +1 -3
  43. package/dist/esm/Config/SettingBase.js.map +1 -1
  44. package/dist/esm/Config/SettingFlag.js +1 -3
  45. package/dist/esm/Config/SettingFlag.js.map +1 -1
  46. package/dist/esm/Config/SettingNumber.js +1 -3
  47. package/dist/esm/Config/SettingNumber.js.map +1 -1
  48. package/dist/esm/Config/SettingOption.js +2 -6
  49. package/dist/esm/Config/SettingOption.js.map +1 -1
  50. package/dist/esm/Config/SettingText.js +1 -3
  51. package/dist/esm/Config/SettingText.js.map +1 -1
  52. package/dist/esm/Inputs/GamepadController.js +0 -2
  53. package/dist/esm/Inputs/GamepadController.js.map +1 -1
  54. package/dist/esm/PeerConnectionController/AggregatedStats.js +104 -46
  55. package/dist/esm/PeerConnectionController/AggregatedStats.js.map +1 -1
  56. package/dist/esm/PeerConnectionController/InboundRTPStats.js.map +1 -1
  57. package/dist/esm/PeerConnectionController/LatencyCalculator.js +284 -0
  58. package/dist/esm/PeerConnectionController/LatencyCalculator.js.map +1 -0
  59. package/dist/esm/PeerConnectionController/OutBoundRTPStats.js +8 -4
  60. package/dist/esm/PeerConnectionController/OutBoundRTPStats.js.map +1 -1
  61. package/dist/esm/PeerConnectionController/PeerConnectionController.js +52 -18
  62. package/dist/esm/PeerConnectionController/PeerConnectionController.js.map +1 -1
  63. package/dist/esm/PixelStreaming/PixelStreaming.js +22 -4
  64. package/dist/esm/PixelStreaming/PixelStreaming.js.map +1 -1
  65. package/dist/esm/Util/EventEmitter.js +27 -0
  66. package/dist/esm/Util/EventEmitter.js.map +1 -1
  67. package/dist/esm/WebRtcPlayer/WebRtcPlayerController.js +20 -4
  68. package/dist/esm/WebRtcPlayer/WebRtcPlayerController.js.map +1 -1
  69. package/dist/esm/__test__/mockMediaStream.js +92 -0
  70. package/dist/esm/__test__/mockMediaStream.js.map +1 -0
  71. package/dist/esm/__test__/mockRTCPeerConnection.js +242 -0
  72. package/dist/esm/__test__/mockRTCPeerConnection.js.map +1 -0
  73. package/dist/esm/__test__/mockRTCRtpReceiver.js +21 -0
  74. package/dist/esm/__test__/mockRTCRtpReceiver.js.map +1 -0
  75. package/dist/esm/__test__/mockWebSocket.js +103 -0
  76. package/dist/esm/__test__/mockWebSocket.js.map +1 -0
  77. package/dist/esm/pixelstreamingfrontend.js +2 -1
  78. package/dist/esm/pixelstreamingfrontend.js.map +1 -1
  79. package/dist/types/Config/Config.d.ts +1 -0
  80. package/dist/types/PeerConnectionController/AggregatedStats.d.ts +18 -7
  81. package/dist/types/PeerConnectionController/InboundRTPStats.d.ts +88 -85
  82. package/dist/types/PeerConnectionController/LatencyCalculator.d.ts +87 -0
  83. package/dist/types/PeerConnectionController/OutBoundRTPStats.d.ts +46 -12
  84. package/dist/types/PeerConnectionController/PeerConnectionController.d.ts +17 -3
  85. package/dist/types/PixelStreaming/PixelStreaming.d.ts +16 -3
  86. package/dist/types/Util/EventEmitter.d.ts +34 -1
  87. package/dist/types/VideoPlayer/VideoPlayer.d.ts +1 -1
  88. package/dist/types/__test__/mockMediaStream.d.ts +49 -0
  89. package/dist/types/__test__/mockRTCPeerConnection.d.ts +134 -0
  90. package/dist/types/__test__/mockRTCRtpReceiver.d.ts +3 -0
  91. package/dist/types/__test__/mockWebSocket.d.ts +33 -0
  92. package/dist/types/pixelstreamingfrontend.d.ts +2 -1
  93. package/eslint.config.mjs +52 -0
  94. package/package.json +13 -14
  95. package/src/Config/Config.ts +14 -0
  96. package/src/Config/SettingBase.ts +1 -1
  97. package/src/Config/SettingFlag.ts +1 -1
  98. package/src/Config/SettingNumber.ts +1 -1
  99. package/src/Config/SettingOption.ts +2 -2
  100. package/src/Config/SettingText.ts +1 -1
  101. package/src/Inputs/GamepadController.ts +2 -2
  102. package/src/PeerConnectionController/AggregatedStats.ts +111 -52
  103. package/src/PeerConnectionController/InboundRTPStats.ts +88 -85
  104. package/src/PeerConnectionController/LatencyCalculator.ts +392 -0
  105. package/src/PeerConnectionController/OutBoundRTPStats.ts +46 -12
  106. package/src/PeerConnectionController/PeerConnectionController.ts +72 -19
  107. package/src/PixelStreaming/PixelStreaming.ts +29 -4
  108. package/src/Util/EventEmitter.ts +48 -0
  109. package/src/VideoPlayer/VideoPlayer.ts +1 -1
  110. package/src/WebRtcPlayer/WebRtcPlayerController.ts +23 -5
  111. package/src/__test__/mockRTCPeerConnection.ts +1 -1
  112. package/src/pixelstreamingfrontend.ts +2 -1
  113. package/tsconfig.base.json +2 -2
  114. package/.eslintignore +0 -12
  115. package/.eslintrc.js +0 -20
  116. package/.prettierrc.json +0 -7
@@ -4,41 +4,41 @@
4
4
  * Inbound Audio Stats collected from the RTC Stats Report
5
5
  */
6
6
  export class InboundAudioStats {
7
- audioLevel: number;
7
+ audioLevel: number | undefined;
8
8
  bytesReceived: number;
9
9
  codecId: string;
10
- concealedSamples: number;
11
- concealmentEvents: number;
12
- fecPacketsDiscarded: number;
13
- fecPacketsReceived: number;
10
+ concealedSamples: number | undefined;
11
+ concealmentEvents: number | undefined;
12
+ fecPacketsDiscarded: number | undefined;
13
+ fecPacketsReceived: number | undefined;
14
14
  headerBytesReceived: number;
15
15
  id: string;
16
- insertedSamplesForDeceleration: number;
16
+ insertedSamplesForDeceleration: number | undefined;
17
17
  jitter: number;
18
18
  jitterBufferDelay: number;
19
19
  jitterBufferEmittedCount: number;
20
- jitterBufferMinimumDelay: number;
21
- jitterBufferTargetDelay: number;
20
+ jitterBufferMinimumDelay: number | undefined;
21
+ jitterBufferTargetDelay: number | undefined;
22
22
  kind: string;
23
23
  lastPacketReceivedTimestamp: number;
24
- mediaType: string;
24
+ mediaType: string | undefined;
25
25
  mid: string;
26
- packetsDiscarded: number;
26
+ packetsDiscarded: number | undefined;
27
27
  packetsLost: number;
28
28
  packetsReceived: number;
29
- removedSamplesForAcceleration: number;
30
- silentConcealedSamples: number;
29
+ removedSamplesForAcceleration: number | undefined;
30
+ silentConcealedSamples: number | undefined;
31
31
  ssrc: number;
32
32
  timestamp: number;
33
- totalAudioEnergy: number;
34
- totalSamplesDuration: number;
35
- totalSamplesReceived: number;
36
- trackIdentifier: string;
37
- transportId: string;
33
+ totalAudioEnergy: number | undefined;
34
+ totalSamplesDuration: number | undefined;
35
+ totalSamplesReceived: number | undefined;
36
+ trackIdentifier: string | undefined;
37
+ transportId: string | undefined;
38
38
  type: string;
39
39
 
40
40
  /* additional, custom stats */
41
- bitrate: number;
41
+ bitrate: number | undefined;
42
42
  }
43
43
 
44
44
  /**
@@ -46,47 +46,47 @@ export class InboundAudioStats {
46
46
  */
47
47
  export class InboundVideoStats {
48
48
  bytesReceived: number;
49
- codecId: string;
50
- firCount: number;
51
- frameHeight: number;
52
- frameWidth: number;
53
- framesAssembledFromMultiplePackets: number;
54
- framesDecoded: number;
55
- framesDropped: number;
56
- framesPerSecond: number;
57
- framesReceived: number;
58
- freezeCount: number;
59
- googTimingFrameInfo: string;
49
+ codecId: string | undefined;
50
+ firCount: number | undefined;
51
+ frameHeight: number | undefined;
52
+ frameWidth: number | undefined;
53
+ framesAssembledFromMultiplePackets: number | undefined;
54
+ framesDecoded: number | undefined;
55
+ framesDropped: number | undefined;
56
+ framesPerSecond: number | undefined;
57
+ framesReceived: number | undefined;
58
+ freezeCount: number | undefined;
59
+ googTimingFrameInfo: string | undefined;
60
60
  headerBytesReceived: number;
61
61
  id: string;
62
62
  jitter: number;
63
63
  jitterBufferDelay: number;
64
64
  jitterBufferEmittedCount: number;
65
- keyFramesDecoded: number;
65
+ keyFramesDecoded: number | undefined;
66
66
  kind: string;
67
- lastPacketReceivedTimestamp: number;
68
- mediaType: string;
67
+ lastPacketReceivedTimestamp: number | undefined;
68
+ mediaType: string | undefined;
69
69
  mid: string;
70
- nackCount: number;
70
+ nackCount: number | undefined;
71
71
  packetsLost: number;
72
72
  packetsReceived: number;
73
- pauseCount: number;
74
- pliCount: number;
73
+ pauseCount: number | undefined;
74
+ pliCount: number | undefined;
75
75
  ssrc: number;
76
76
  timestamp: number;
77
- totalAssemblyTime: number;
78
- totalDecodeTime: number;
79
- totalFreezesDuration: number;
80
- totalInterFrameDelay: number;
81
- totalPausesDuration: number;
82
- totalProcessingDelay: number;
83
- totalSquaredInterFrameDelay: number;
84
- trackIdentifier: string;
85
- transportId: string;
77
+ totalAssemblyTime: number | undefined;
78
+ totalDecodeTime: number | undefined;
79
+ totalFreezesDuration: number | undefined;
80
+ totalInterFrameDelay: number | undefined;
81
+ totalPausesDuration: number | undefined;
82
+ totalProcessingDelay: number | undefined;
83
+ totalSquaredInterFrameDelay: number | undefined;
84
+ trackIdentifier: string | undefined;
85
+ transportId: string | undefined;
86
86
  type: string;
87
87
 
88
88
  /* additional, custom stats */
89
- bitrate: number;
89
+ bitrate: number | undefined;
90
90
  }
91
91
 
92
92
  /**
@@ -95,60 +95,63 @@ export class InboundVideoStats {
95
95
  export class InboundRTPStats {
96
96
  /* common stats */
97
97
  bytesReceived: number;
98
- codecId: string;
98
+ codecId: string | undefined;
99
99
  headerBytesReceived: number;
100
100
  id: string;
101
101
  jitter: number;
102
102
  jitterBufferDelay: number;
103
103
  jitterBufferEmittedCount: number;
104
104
  kind: string;
105
- lastPacketReceivedTimestamp: number;
106
- mediaType: string;
105
+ lastPacketReceivedTimestamp: number | undefined;
106
+ mediaType: string | undefined;
107
107
  mid: string;
108
108
  packetsLost: number;
109
109
  packetsReceived: number;
110
+ playoutId: string | undefined;
111
+ qpsum: number | undefined;
112
+ remoteId: string | undefined;
110
113
  ssrc: number;
111
114
  timestamp: number;
112
- trackIdentifier: string;
113
- transportId: string;
115
+ trackIdentifier: string | undefined;
116
+ transportId: string | undefined;
114
117
  type: string;
115
118
 
116
119
  /* audio specific stats */
117
- audioLevel: number;
118
- concealedSamples: number;
119
- concealmentEvents: number;
120
- fecPacketsDiscarded: number;
121
- fecPacketsReceived: number;
122
- insertedSamplesForDeceleration: number;
123
- jitterBufferMinimumDelay: number;
124
- jitterBufferTargetDelay: number;
125
- packetsDiscarded: number;
126
- removedSamplesForAcceleration: number;
127
- silentConcealedSamples: number;
128
- totalAudioEnergy: number;
129
- totalSamplesDuration: number;
130
- totalSamplesReceived: number;
120
+ audioLevel: number | undefined;
121
+ concealedSamples: number | undefined;
122
+ concealmentEvents: number | undefined;
123
+ fecPacketsDiscarded: number | undefined;
124
+ fecPacketsReceived: number | undefined;
125
+ insertedSamplesForDeceleration: number | undefined;
126
+ jitterBufferMinimumDelay: number | undefined;
127
+ jitterBufferTargetDelay: number | undefined;
128
+ packetsDiscarded: number | undefined;
129
+ removedSamplesForAcceleration: number | undefined;
130
+ silentConcealedSamples: number | undefined;
131
+ totalAudioEnergy: number | undefined;
132
+ totalSamplesDuration: number | undefined;
133
+ totalSamplesReceived: number | undefined;
131
134
 
132
135
  /* video specific stats */
133
- firCount: number;
134
- frameHeight: number;
135
- frameWidth: number;
136
- framesAssembledFromMultiplePackets: number;
137
- framesDecoded: number;
138
- framesDropped: number;
139
- framesPerSecond: number;
140
- framesReceived: number;
141
- freezeCount: number;
142
- googTimingFrameInfo: string;
143
- keyFramesDecoded: number;
144
- nackCount: number;
145
- pauseCount: number;
146
- pliCount: number;
147
- totalAssemblyTime: number;
148
- totalDecodeTime: number;
149
- totalFreezesDuration: number;
150
- totalInterFrameDelay: number;
151
- totalPausesDuration: number;
152
- totalProcessingDelay: number;
153
- totalSquaredInterFrameDelay: number;
136
+ firCount: number | undefined;
137
+ frameHeight: number | undefined;
138
+ frameWidth: number | undefined;
139
+ framesAssembledFromMultiplePackets: number | undefined;
140
+ framesDecoded: number | undefined;
141
+ framesDropped: number | undefined;
142
+ framesPerSecond: number | undefined;
143
+ framesReceived: number | undefined;
144
+ freezeCount: number | undefined;
145
+ googTimingFrameInfo: string | undefined;
146
+ keyFramesDecoded: number | undefined;
147
+ nackCount: number | undefined;
148
+ pauseCount: number | undefined;
149
+ pliCount: number | undefined;
150
+ totalAssemblyTime: number | undefined;
151
+ totalDecodeTime: number | undefined;
152
+ totalFreezesDuration: number | undefined;
153
+ totalInterFrameDelay: number | undefined;
154
+ totalPausesDuration: number | undefined;
155
+ totalProcessingDelay: number | undefined;
156
+ totalSquaredInterFrameDelay: number | undefined;
154
157
  }
@@ -0,0 +1,392 @@
1
+ // Copyright Epic Games, Inc. All Rights Reserved.
2
+
3
+ import { AggregatedStats } from './AggregatedStats';
4
+ import { CandidatePairStats } from './CandidatePairStats';
5
+
6
+ /**
7
+ * Represents either a:
8
+ * - synchronization source: https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpReceiver/getSynchronizationSources
9
+ * - contributing source: https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpReceiver/getContributingSources
10
+ * Which also (if browser supports it) may optionall contain fields for captureTimestamp + senderCaptureTimeOffset
11
+ * if the abs-capture-time RTP header extension is enabled (currently this only works in Chromium based browsers).
12
+ */
13
+ class RTCRtpCaptureSource {
14
+ timestamp: number;
15
+ captureTimestamp: number;
16
+ senderCaptureTimeOffset: number;
17
+ }
18
+
19
+ /**
20
+ * FrameTimingInfo is a Chromium-specific set of WebRTC stats useful for latency calculation. It is stored in WebRTC stats as `googTimingFrameInfo`.
21
+ * It is defined as an RTP header extension here: https://webrtc.googlesource.com/src/+/refs/heads/main/docs/native-code/rtp-hdrext/video-timing/README.md
22
+ * It is defined in source code here: https://source.chromium.org/chromium/chromium/src/+/main:third_party/webrtc/api/video/video_timing.cc;l=82;drc=8d399817282e3c12ed54eb23ec42a5e418298ec6
23
+ * It is discussed by its author here: https://github.com/w3c/webrtc-provisional-stats/issues/40#issuecomment-1272916692
24
+ * In summary it a comma-delimited string that contains the following (in this order):
25
+ * 1) RTP timestamp: the RTP timestamp of the frame
26
+ * 2) Capture time: timestamp when this frame was captured
27
+ * 3) Encode start: timestamp when this frame started to be encoded
28
+ * 4) Encode finish: timestamp when this frame finished encoding
29
+ * 5) Packetization finish: timestamp when this frame was split into packets and was ready to be sent over the network
30
+ * 6) Pacer exit: timestamp when last packet of this frame was sent over the network by the sender at this timestamp
31
+ * 7) Network timestamp1: place for the SFU to mark when the frame started being forwarded. Application specific.
32
+ * 8) Network timestamp2: place for the SFU to mark when the frame finished being forwarded. Application specific.
33
+ * 9) Receive start: timestamp when the first packet of this frame was received
34
+ * 10) Receive finish: timestamp when the last packet of this frame was received
35
+ * 11) Decode start: timestamp when the frame was passed to decoder
36
+ * 12) Decode finish: timestamp when the frame was decoded
37
+ * 13) Render time: timestamp of the projected render time for this frame
38
+ * 14) "is outlier": a flag for if this frame is bigger in encoded size than the average frame by at least 5x.
39
+ * 15) "triggered by timer": a flag for if this report was triggered by the timer (The report is sent every 200ms)
40
+ */
41
+ export class FrameTimingInfo {
42
+ rtpTimestamp: number;
43
+ captureTimestamp: number;
44
+ encodeStartTimestamp: number;
45
+ encodeFinishTimestamp: number;
46
+ packetizerFinishTimestamp: number;
47
+ pacerExitTimestamp: number;
48
+ networkTimestamp1: number;
49
+ networkTimestamp2: number;
50
+ receiveStart: number;
51
+ receiveFinish: number;
52
+ decodeStart: number;
53
+ decodeFinish: number;
54
+ renderTime: number;
55
+ isOutlier: boolean;
56
+ isTriggeredByTimer: boolean;
57
+
58
+ /* Milliseconds between encoder start and finish */
59
+ encoderLatencyMs: number;
60
+
61
+ /* Milliseconds between encode end and packetizer finish time */
62
+ packetizeLatencyMs: number;
63
+
64
+ /* Milliseconds between packetize finish time and pacer sending the frame */
65
+ pacerLatencyMs: number;
66
+
67
+ /* Milliseconds between capture time and pacer exit */
68
+ captureToSendLatencyMs: number;
69
+ }
70
+
71
+ /**
72
+ * Calculates a combination of latency statistics using purely WebRTC API.
73
+ */
74
+ export class LatencyCalculator {
75
+ /* Clock offset between peer clocks cannot always be calculated as it relies of latest sender reports.
76
+ * so we store the last time we had a valid clock offset in the assumption that clocks haven't drifted too much since then.
77
+ */
78
+ private latestSenderRecvClockOffset: number | null = null;
79
+
80
+ public calculate(stats: AggregatedStats, receivers: RTCRtpReceiver[]): LatencyInfo {
81
+ const latencyInfo = new LatencyInfo();
82
+
83
+ const rttMS: number | null = this.getRTTMs(stats);
84
+
85
+ if (rttMS != null) {
86
+ latencyInfo.rttMs = rttMS;
87
+
88
+ // Calculate sender latency using the first valid video ssrc/csrc
89
+ const captureSource: RTCRtpCaptureSource | null = this.getCaptureSource(receivers);
90
+ if (captureSource != null) {
91
+ const senderLatencyMs = this.calculateSenderLatency(stats, captureSource);
92
+ if (senderLatencyMs !== null) {
93
+ latencyInfo.senderLatencyMs = senderLatencyMs;
94
+ }
95
+ }
96
+ }
97
+
98
+ // https://w3c.github.io/webrtc-stats/#dom-rtcinboundrtpstreamstats-totalprocessingdelay
99
+ if (
100
+ stats.inboundVideoStats.totalProcessingDelay !== undefined &&
101
+ stats.inboundVideoStats.framesDecoded !== undefined
102
+ ) {
103
+ latencyInfo.averageProcessingDelayMs =
104
+ (stats.inboundVideoStats.totalProcessingDelay / stats.inboundVideoStats.framesDecoded) * 1000;
105
+ }
106
+
107
+ // https://w3c.github.io/webrtc-stats/#dom-rtcinboundrtpstreamstats-jitterbufferminimumdelay
108
+ if (
109
+ stats.inboundVideoStats.jitterBufferDelay !== undefined &&
110
+ stats.inboundVideoStats.jitterBufferEmittedCount !== undefined
111
+ ) {
112
+ latencyInfo.averageJitterBufferDelayMs =
113
+ (stats.inboundVideoStats.jitterBufferDelay /
114
+ stats.inboundVideoStats.jitterBufferEmittedCount) *
115
+ 1000;
116
+ }
117
+
118
+ // https://w3c.github.io/webrtc-stats/#dom-rtcinboundrtpstreamstats-totaldecodetime
119
+ if (
120
+ stats.inboundVideoStats.framesDecoded !== undefined &&
121
+ stats.inboundVideoStats.totalDecodeTime !== undefined
122
+ ) {
123
+ latencyInfo.averageDecodeLatencyMs =
124
+ (stats.inboundVideoStats.totalDecodeTime / stats.inboundVideoStats.framesDecoded) * 1000;
125
+ }
126
+
127
+ // https://w3c.github.io/webrtc-stats/#dom-rtcinboundrtpstreamstats-framesassembledfrommultiplepackets
128
+ if (
129
+ stats.inboundVideoStats.totalAssemblyTime !== undefined &&
130
+ stats.inboundVideoStats.framesAssembledFromMultiplePackets !== undefined
131
+ ) {
132
+ latencyInfo.averageAssemblyDelayMs =
133
+ (stats.inboundVideoStats.totalAssemblyTime /
134
+ stats.inboundVideoStats.framesAssembledFromMultiplePackets) *
135
+ 1000;
136
+ }
137
+
138
+ // Extract extra Chrome-specific stats like encoding latency
139
+ if (
140
+ stats.inboundVideoStats.googTimingFrameInfo !== undefined &&
141
+ stats.inboundVideoStats.googTimingFrameInfo.length > 0
142
+ ) {
143
+ latencyInfo.frameTiming = this.extractFrameTimingInfo(
144
+ stats.inboundVideoStats.googTimingFrameInfo
145
+ );
146
+ }
147
+
148
+ // Calculate E2E latency using video-timing capture to send time + one way network latency + receiver-side latency
149
+ if (
150
+ latencyInfo.frameTiming !== undefined &&
151
+ latencyInfo.frameTiming.captureToSendLatencyMs !== undefined &&
152
+ latencyInfo.averageProcessingDelayMs !== undefined &&
153
+ latencyInfo.rttMs !== undefined
154
+ ) {
155
+ latencyInfo.averageE2ELatency =
156
+ latencyInfo.frameTiming.captureToSendLatencyMs +
157
+ latencyInfo.rttMs * 0.5 +
158
+ latencyInfo.averageProcessingDelayMs;
159
+ }
160
+
161
+ // Calculate E2E latency as abs-capture-time capture to send latency + one way network latency + receiver-side latency
162
+ if (
163
+ latencyInfo.senderLatencyMs != undefined &&
164
+ latencyInfo.averageProcessingDelayMs !== undefined &&
165
+ latencyInfo.rttMs !== undefined
166
+ ) {
167
+ latencyInfo.averageE2ELatency =
168
+ latencyInfo.senderLatencyMs + latencyInfo.rttMs * 0.5 + latencyInfo.averageProcessingDelayMs;
169
+ }
170
+
171
+ return latencyInfo;
172
+ }
173
+
174
+ private extractFrameTimingInfo(googTimingFrameInfo: string): FrameTimingInfo {
175
+ const timingInfo: FrameTimingInfo = new FrameTimingInfo();
176
+
177
+ const timingInfoArr: string[] = googTimingFrameInfo.split(',');
178
+
179
+ // Should have exactly 15 elements according to:
180
+ // https://source.chromium.org/chromium/chromium/src/+/main:third_party/webrtc/api/video/video_timing.cc;l=82;drc=8d399817282e3c12ed54eb23ec42a5e418298ec6
181
+ if (timingInfoArr.length === 15) {
182
+ timingInfo.rtpTimestamp = Number.parseInt(timingInfoArr[0]);
183
+ timingInfo.captureTimestamp = Number.parseInt(timingInfoArr[1]);
184
+ timingInfo.encodeStartTimestamp = Number.parseInt(timingInfoArr[2]);
185
+ timingInfo.encodeFinishTimestamp = Number.parseInt(timingInfoArr[3]);
186
+ timingInfo.packetizerFinishTimestamp = Number.parseInt(timingInfoArr[4]);
187
+ timingInfo.pacerExitTimestamp = Number.parseInt(timingInfoArr[5]);
188
+ timingInfo.networkTimestamp1 = Number.parseInt(timingInfoArr[6]);
189
+ timingInfo.networkTimestamp2 = Number.parseInt(timingInfoArr[7]);
190
+ timingInfo.receiveStart = Number.parseInt(timingInfoArr[8]);
191
+ timingInfo.receiveFinish = Number.parseInt(timingInfoArr[9]);
192
+ timingInfo.decodeStart = Number.parseInt(timingInfoArr[10]);
193
+ timingInfo.decodeFinish = Number.parseInt(timingInfoArr[11]);
194
+ timingInfo.renderTime = Number.parseInt(timingInfoArr[12]);
195
+ timingInfo.isOutlier = Number.parseInt(timingInfoArr[13]) > 0;
196
+ timingInfo.isTriggeredByTimer = Number.parseInt(timingInfoArr[14]) > 0;
197
+
198
+ // Calculate some latency stats
199
+ timingInfo.encoderLatencyMs = timingInfo.encodeFinishTimestamp - timingInfo.encodeStartTimestamp;
200
+ timingInfo.packetizeLatencyMs =
201
+ timingInfo.packetizerFinishTimestamp - timingInfo.encodeFinishTimestamp;
202
+ timingInfo.pacerLatencyMs = timingInfo.pacerExitTimestamp - timingInfo.packetizerFinishTimestamp;
203
+ timingInfo.captureToSendLatencyMs = timingInfo.pacerExitTimestamp - timingInfo.captureTimestamp;
204
+ }
205
+
206
+ return timingInfo;
207
+ }
208
+
209
+ private calculateSenderLatency(
210
+ stats: AggregatedStats,
211
+ captureSource: RTCRtpCaptureSource
212
+ ): number | null {
213
+ // The calculation performed in this function is as per the procedure defined here:
214
+ // https://w3c.github.io/webrtc-extensions/#dom-rtcrtpcontributingsource-sendercapturetimeoffset
215
+
216
+ // Get the sender capture in the sender's clock
217
+ const senderCaptureTimestamp = captureSource.captureTimestamp + captureSource.senderCaptureTimeOffset;
218
+
219
+ let sendRecvClockOffset: number | null = this.calculateSenderReceiverClockOffset(stats);
220
+
221
+ // Use latest clock offset if we couldn't calculate one now
222
+ if (sendRecvClockOffset == null) {
223
+ if (this.latestSenderRecvClockOffset != null) {
224
+ sendRecvClockOffset = this.latestSenderRecvClockOffset;
225
+ } else {
226
+ return null;
227
+ }
228
+ } else {
229
+ this.latestSenderRecvClockOffset = sendRecvClockOffset;
230
+ }
231
+
232
+ // This brings sender clock roughly inline with recv clock
233
+ const recvCaptureTimestampNTP = senderCaptureTimestamp + sendRecvClockOffset;
234
+
235
+ // As defined in Chrome source: https://chromium.googlesource.com/external/webrtc/+/master/system_wrappers/include/clock.h#26
236
+ const ntp1970 = 2208988800000;
237
+
238
+ const recvCaptureTimestamp = recvCaptureTimestampNTP - ntp1970;
239
+
240
+ const senderLatency = captureSource.timestamp - recvCaptureTimestamp;
241
+
242
+ return senderLatency;
243
+ }
244
+
245
+ /**
246
+ * Find the first valid ssrc or csrc that has capture time fields present from abs-capture-time header extension.
247
+ * @param receivers The RTP receviers this peer connection has.
248
+ * @returns A single valid ssrc or csrc that has capture time fields or null if there is none (e.g. in non-chromium browsers it will be null).
249
+ */
250
+ private getCaptureSource(receivers: RTCRtpReceiver[]): RTCRtpCaptureSource | null {
251
+ // We only want video receivers
252
+ receivers = receivers.filter((receiver) => receiver.track.kind === 'video');
253
+
254
+ for (const receiver of receivers) {
255
+ // Go through all ssrc and csrc to check for capture timestamp
256
+ // Note: Conversion to `any` here is because TS does not have captureTimestamp etc defined in the types
257
+ // these fields only exist in Chromium currently.
258
+ const sources: any[] = receiver
259
+ .getSynchronizationSources()
260
+ .concat(receiver.getContributingSources());
261
+
262
+ for (const src of sources) {
263
+ if (
264
+ src.captureTimestamp !== undefined &&
265
+ src.senderCaptureTimeOffset !== undefined &&
266
+ src.timestamp !== undefined
267
+ ) {
268
+ const captureSrc = new RTCRtpCaptureSource();
269
+ captureSrc.timestamp = src.timestamp;
270
+ captureSrc.captureTimestamp = src.captureTimestamp;
271
+ captureSrc.senderCaptureTimeOffset = src.senderCaptureTimeOffset;
272
+ return captureSrc;
273
+ }
274
+ }
275
+ }
276
+
277
+ return null;
278
+ }
279
+
280
+ private calculateSenderReceiverClockOffset(stats: AggregatedStats): number | null {
281
+ // The calculation performed in this function is as per the procedure defined here:
282
+ // https://w3c.github.io/webrtc-extensions/#dom-rtcrtpcontributingsource-sendercapturetimeoffset
283
+
284
+ const hasRemoteOutboundVideoStats =
285
+ stats.remoteOutboundVideoStats !== undefined &&
286
+ stats.remoteOutboundVideoStats.timestamp !== undefined &&
287
+ stats.remoteOutboundVideoStats.remoteTimestamp !== undefined;
288
+
289
+ // Note: As of Chrome 132, remote-outbound-rtp stats for video are not yet implemented (audio works).
290
+ // This codepath should activate once they do begin to work.
291
+ if (!hasRemoteOutboundVideoStats) {
292
+ return null;
293
+ }
294
+
295
+ const remoteStatsArrivedTimestamp = stats.remoteOutboundVideoStats.timestamp;
296
+ const remoteStatsSentTimestamp = stats.remoteOutboundVideoStats.remoteTimestamp;
297
+
298
+ const rttMs: number | null = this.getRTTMs(stats);
299
+
300
+ if (
301
+ remoteStatsArrivedTimestamp !== undefined &&
302
+ remoteStatsSentTimestamp !== undefined &&
303
+ rttMs !== null
304
+ ) {
305
+ const onewayDelay = rttMs * 0.5;
306
+ return remoteStatsArrivedTimestamp - (remoteStatsSentTimestamp + onewayDelay);
307
+ }
308
+ // Could not get stats to calculate sender/receiver clock offset
309
+ else {
310
+ return null;
311
+ }
312
+ }
313
+
314
+ private getRTTMs(stats: AggregatedStats): number | null {
315
+ // Try to get it from the active candidate pair
316
+ const activeCandidatePair: CandidatePairStats | null = stats.getActiveCandidatePair();
317
+ if (!!activeCandidatePair && activeCandidatePair.currentRoundTripTime !== undefined) {
318
+ const curRTTSeconds = activeCandidatePair.currentRoundTripTime;
319
+ return curRTTSeconds * 1000;
320
+ }
321
+
322
+ // Next try to get it from remote-outbound-rtp video stats
323
+ if (
324
+ !!stats.remoteOutboundVideoStats &&
325
+ stats.remoteOutboundVideoStats.totalRoundTripTime !== undefined &&
326
+ stats.remoteOutboundVideoStats.roundTripTimeMeasurements !== undefined &&
327
+ stats.remoteOutboundVideoStats.roundTripTimeMeasurements > 0
328
+ ) {
329
+ const avgRttSeconds =
330
+ stats.remoteOutboundVideoStats.totalRoundTripTime /
331
+ stats.remoteOutboundVideoStats.roundTripTimeMeasurements;
332
+ return avgRttSeconds * 1000;
333
+ }
334
+
335
+ // Next try to get it from remote-outbound-rtp audio stats
336
+ if (
337
+ !!stats.remoteOutboundAudioStats &&
338
+ stats.remoteOutboundAudioStats.totalRoundTripTime !== undefined &&
339
+ stats.remoteOutboundAudioStats.roundTripTimeMeasurements !== undefined &&
340
+ stats.remoteOutboundAudioStats.roundTripTimeMeasurements > 0
341
+ ) {
342
+ const avgRttSeconds =
343
+ stats.remoteOutboundAudioStats.totalRoundTripTime /
344
+ stats.remoteOutboundAudioStats.roundTripTimeMeasurements;
345
+ return avgRttSeconds * 1000;
346
+ }
347
+
348
+ return null;
349
+ }
350
+ }
351
+
352
+ /**
353
+ * A collection of latency information calculated using the WebRTC API.
354
+ * Most stats are calculated following the spec:
355
+ * https://w3c.github.io/webrtc-stats/#dictionary-rtcinboundrtpstreamstats-members
356
+ */
357
+ export class LatencyInfo {
358
+ /**
359
+ * The time taken from the moment a frame is done capturing to the moment it is sent over the network.
360
+ * Note: This can only be calculated if both offer and answer contain the
361
+ * the RTP header extension for `video-timing` (Chrome only for now)
362
+ */
363
+ public senderLatencyMs: number | undefined = undefined;
364
+
365
+ /**
366
+ * The time taken from the moment a frame is done capturing to the moment it is sent over the network.
367
+ * Note: This can only be calculated if both offer and answer contain the
368
+ * the RTP header extension for `abs-capture-time` (Chrome only for now)
369
+ */
370
+ public senderLatencyAbsCaptureTimeMs: number | undefined = undefined;
371
+
372
+ /* The round trip time (milliseconds) between each sender->receiver->sender */
373
+ public rttMs: number | undefined = undefined;
374
+
375
+ /* Average time taken (milliseconds) from video packet receipt to post-decode. */
376
+ public averageProcessingDelayMs: number | undefined = undefined;
377
+
378
+ /* Average time taken (milliseconds) inside the jitter buffer (which is post-receipt but pre-decode). */
379
+ public averageJitterBufferDelayMs: number | undefined = undefined;
380
+
381
+ /* Average time taken (milliseconds) to decode a video frame. */
382
+ public averageDecodeLatencyMs: number | undefined = undefined;
383
+
384
+ /* Average time taken (milliseconds) to between receipt of the first and last video packet of a. */
385
+ public averageAssemblyDelayMs: number | undefined = undefined;
386
+
387
+ /* The sender latency + RTT/2 + processing delay */
388
+ public averageE2ELatency: number | undefined = undefined;
389
+
390
+ /* Timing information about the worst performing frame since the last getStats call (only works on Chrome) */
391
+ public frameTiming: FrameTimingInfo | undefined = undefined;
392
+ }