Readonly observableMetric
observableMetricSpec: {} = ...
@@ -400,7 +404,7 @@
Readonly observableVideo<
observableVideoMetricSpec: {} = ...
@@ -448,6 +452,29 @@
+
+ streamDimensionMap: {} = ...
+
+
+
+
+
+
+
+
rtcStatsReport
+Readonly streamDimensionMap
+Dimensions derived from metric
+Type declaration
++-
+
+
+[id: string]: SdkStreamDimension.Type
+streamMetricReports
@@ -472,7 +499,7 @@Readonly videoDownstream<
videoDownstreamMetricMap: {} = ...
@@ -522,7 +549,7 @@
@@ -605,7 +632,7 @@
@@ -679,7 +706,7 @@
@@ -770,7 +797,7 @@
@@ -797,7 +824,7 @@
@@ -828,7 +855,7 @@
@@ -862,7 +889,7 @@
@@ -874,6 +901,28 @@
Readonly videoUpstreamvideoUpstreamMetricMap: {} = ...
clone
getMetricMap
Parameters
@@ -742,7 +769,7 @@getObservableMetricValue
getObservableMetrics
getObservableVideoMetricValue
getObservableVideoMetrics
getRTCStatsReport
Returns RTCStatsR +
+
+
+
+
+
+
+
+
@@ -989,7 +1090,7 @@
@@ -1077,6 +1178,9 @@
getStreamDimensionMap
++- get
StreamDimensionMap(): {}
+
++-
+
+
+
+Returns {}
++-
+
+
+[id: string]: SdkStreamDimension.Type
+identityValue
@@ -905,6 +954,32 @@Returns number
isHardwareImplementation
++- is
HardwareImplementation(metricName?: string, ssrc?: number): number
+
++-
+
+
+
+Parameters
++-
+
+ -
+
+
+Optional metricName: string
+Optional ssrc: number
+Returns number
+jitterBufferMs
@@ -931,6 +1006,32 @@Returns number
millisecondsPerSecond
++- milliseconds
PerSecond(metricName?: string, ssrc?: number): number
+
++-
+
+
+
+Parameters
++-
+
+ -
+
+
+Optional metricName: string
+Optional ssrc: number
+Returns number
+packetLossPercent
@@ -967,7 +1068,7 @@print
removeDestroyedSsrcs
Returns number rtcStatsReport
+
+ streamDimensionMap
+
streamMetricReports
@@ -1116,12 +1220,21 @@
Returns number getRTCStatsReport
+
+ getStreamDimensionMap
+
identityValue
+
+ isHardwareImplementation
+
jitterBufferMs
+
+ millisecondsPerSecond
+
packetLossPercent
diff --git a/docs/classes/globalmetricreport.html b/docs/classes/globalmetricreport.html
index ab8104f250..0bcd9f2d22 100644
--- a/docs/classes/globalmetricreport.html
+++ b/docs/classes/globalmetricreport.html
@@ -87,6 +87,7 @@
Constructors
Properties
- current
Metrics
+ - current
StringMetrics
- previous
Metrics
@@ -130,6 +131,24 @@[id: + +currentStringMetrics: {} = {}
+
+
+
+
currentMetrics
+
+ currentStringMetrics
+
direction
diff --git a/src/clientmetricreport/ClientMetricReport.ts b/src/clientmetricreport/ClientMetricReport.ts
index d335fd78cd..0864682735 100644
--- a/src/clientmetricreport/ClientMetricReport.ts
+++ b/src/clientmetricreport/ClientMetricReport.ts
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: Apache-2.0
import Logger from '../logger/Logger';
-import { SdkMetric } from '../signalingprotocol/SignalingProtocol.js';
+import { SdkMetric, SdkStreamDimension } from '../signalingprotocol/SignalingProtocol.js';
import VideoStreamIndex from '../videostreamindex/VideoStreamIndex';
import Direction from './ClientMetricReportDirection';
import MediaType from './ClientMetricReportMediaType';
@@ -126,6 +126,35 @@ export default class ClientMetricReport {
return Number(metricReport.currentMetrics[metricName] * 1000);
};
+ millisecondsPerSecond = (metricName?: string, ssrc?: number): number => {
+ const metricReport = ssrc ? this.streamMetricReports[ssrc] : this.globalMetricReport;
+ let intervalSeconds = (this.currentTimestampMs - this.previousTimestampMs) / 1000;
+ if (intervalSeconds <= 0) {
+ return 0;
+ }
+ if (this.previousTimestampMs <= 0) {
+ intervalSeconds = 1;
+ }
+ const diff =
+ metricReport.currentMetrics[metricName] - (metricReport.previousMetrics[metricName] || 0);
+ if (diff <= 0) {
+ return 0;
+ }
+ return (diff * 1000) / intervalSeconds;
+ };
+
+ isHardwareImplementation = (metricName?: string, ssrc?: number): number => {
+ const metricReport = this.streamMetricReports[ssrc];
+ const implName = String(metricReport.currentStringMetrics[metricName]);
+ const hasHwName =
+ implName.includes('ExternalDecoder') ||
+ implName.includes('ExternalEncoder') ||
+ implName.includes('EncodeAccelerator') ||
+ implName.includes('DecodeAccelerator');
+ const isFallback = implName.includes('fallback from');
+ return hasHwName && !isFallback ? 1 : 0;
+ };
+
/**
* Canonical and derived metric maps
*/
@@ -252,6 +281,14 @@ export default class ClientMetricReport {
jitter: {
transform: this.secondsToMilliseconds,
},
+ totalEncodeTime: {
+ transform: this.millisecondsPerSecond,
+ type: SdkMetric.Type.VIDEO_ENCODE_MS,
+ },
+ encoderImplementation: {
+ transform: this.isHardwareImplementation,
+ type: SdkMetric.Type.VIDEO_ENCODER_IS_HARDWARE,
+ },
};
readonly videoDownstreamMetricMap: {
@@ -261,7 +298,6 @@ export default class ClientMetricReport {
source?: string;
};
} = {
- totalDecodeTime: { transform: this.identityValue, type: SdkMetric.Type.VIDEO_DECODE_MS },
packetsReceived: { transform: this.countPerSecond, type: SdkMetric.Type.VIDEO_RECEIVED_PPS },
packetsLost: {
transform: this.packetLossPercent,
@@ -297,6 +333,14 @@ export default class ClientMetricReport {
},
frameHeight: { transform: this.identityValue, type: SdkMetric.Type.VIDEO_DECODE_HEIGHT },
frameWidth: { transform: this.identityValue, type: SdkMetric.Type.VIDEO_DECODE_WIDTH },
+ totalDecodeTime: {
+ transform: this.millisecondsPerSecond,
+ type: SdkMetric.Type.VIDEO_DECODE_MS,
+ },
+ decoderImplementation: {
+ transform: this.isHardwareImplementation,
+ type: SdkMetric.Type.VIDEO_DECODER_IS_HARDWARE,
+ },
};
getMetricMap(
@@ -329,6 +373,22 @@ export default class ClientMetricReport {
}
}
+ /**
+ * Dimensions derived from metric
+ */
+ readonly streamDimensionMap: {
+ [id: string]: SdkStreamDimension.Type;
+ } = {
+ encoderImplementation: SdkStreamDimension.Type.VIDEO_ENCODER_NAME,
+ decoderImplementation: SdkStreamDimension.Type.VIDEO_DECODER_NAME,
+ };
+
+ getStreamDimensionMap(): {
+ [id: string]: SdkStreamDimension.Type;
+ } {
+ return this.streamDimensionMap;
+ }
+
/**
* media Stream metrics
*/
diff --git a/src/clientmetricreport/GlobalMetricReport.ts b/src/clientmetricreport/GlobalMetricReport.ts
index aae4a3d666..5b7025caa6 100644
--- a/src/clientmetricreport/GlobalMetricReport.ts
+++ b/src/clientmetricreport/GlobalMetricReport.ts
@@ -4,4 +4,6 @@
export default class GlobalMetricReport {
previousMetrics: { [id: string]: number } = {};
currentMetrics: { [id: string]: number } = {};
+ // As metric values do not necessarily be number, this is a workaround in case metric value is string
+ currentStringMetrics: { [id: string]: string } = {};
}
diff --git a/src/clientmetricreport/StreamMetricReport.ts b/src/clientmetricreport/StreamMetricReport.ts
index 0eca54b7fd..709e92f759 100644
--- a/src/clientmetricreport/StreamMetricReport.ts
+++ b/src/clientmetricreport/StreamMetricReport.ts
@@ -10,4 +10,6 @@ export default class StreamMetricReport {
direction: Direction;
previousMetrics: { [id: string]: number } = {};
currentMetrics: { [id: string]: number } = {};
+ // As metric values do not necessarily be number, this is a workaround in case metric value is string
+ currentStringMetrics: { [id: string]: string } = {};
}
diff --git a/src/statscollector/StatsCollector.ts b/src/statscollector/StatsCollector.ts
index d5dc2725b9..0a501303b8 100644
--- a/src/statscollector/StatsCollector.ts
+++ b/src/statscollector/StatsCollector.ts
@@ -14,7 +14,9 @@ import IntervalScheduler from '../scheduler/IntervalScheduler';
import SignalingClient from '../signalingclient/SignalingClient';
import {
SdkClientMetricFrame,
+ SdkDimensionValue,
SdkMetric,
+ SdkStreamDimension,
SdkStreamMetricFrame,
} from '../signalingprotocol/SignalingProtocol.js';
import { Maybe } from '../utils/Types';
@@ -253,8 +255,16 @@ export default class StatsCollector {
for (const rawMetric in rawMetricReport) {
if (rawMetric in metricMap) {
- metricReport.previousMetrics[rawMetric] = metricReport.currentMetrics[rawMetric];
- metricReport.currentMetrics[rawMetric] = rawMetricReport[rawMetric];
+ if (typeof rawMetricReport[rawMetric] === 'number') {
+ metricReport.previousMetrics[rawMetric] = metricReport.currentMetrics[rawMetric];
+ metricReport.currentMetrics[rawMetric] = rawMetricReport[rawMetric];
+ } else if (typeof rawMetricReport[rawMetric] === 'string') {
+ metricReport.currentStringMetrics[rawMetric] = rawMetricReport[rawMetric];
+ } else {
+ this.logger.error(
+ `Unknown metric value type ${typeof rawMetricReport[rawMetric]} for metric ${rawMetric}`
+ );
+ }
}
}
}
@@ -300,6 +310,26 @@ export default class StatsCollector {
this.clientMetricReport.print();
}
+ /**
+ * Add stream metric dimension frames derived from metrics
+ */
+ private addStreamMetricDimensionFrames(
+ streamMetricFrame: SdkStreamMetricFrame,
+ streamMetricReport: StreamMetricReport
+ ): void {
+ const streamDimensionMap = this.clientMetricReport.getStreamDimensionMap();
+ for (const metricName in streamMetricReport.currentStringMetrics) {
+ if (metricName in streamDimensionMap) {
+ const dimensionFrame = SdkStreamDimension.create();
+ dimensionFrame.type = streamDimensionMap[metricName];
+ const dimensionValue = SdkDimensionValue.create();
+ dimensionValue.stringValue = streamMetricReport.currentStringMetrics[metricName];
+ dimensionFrame.value = dimensionValue;
+ streamMetricFrame.dimensions.push(dimensionFrame);
+ }
+ }
+ }
+
/**
* Packages a metric into the MetricFrame.
*/
@@ -350,11 +380,13 @@ export default class StatsCollector {
const streamMetricFrame = SdkStreamMetricFrame.create();
streamMetricFrame.streamId = streamMetricReport.streamId;
streamMetricFrame.metrics = [];
+ this.addStreamMetricDimensionFrames(streamMetricFrame, streamMetricReport);
clientMetricFrame.streamMetricFrames.push(streamMetricFrame);
const metricMap = this.clientMetricReport.getMetricMap(
streamMetricReport.mediaType,
streamMetricReport.direction
);
+
for (const metricName in streamMetricReport.currentMetrics) {
this.addMetricFrame(metricName, clientMetricFrame, metricMap[metricName], Number(ssrc));
}
diff --git a/test/clientmetricreport/ClientMetricReport.test.ts b/test/clientmetricreport/ClientMetricReport.test.ts
index 349217836b..87aeb1278d 100644
--- a/test/clientmetricreport/ClientMetricReport.test.ts
+++ b/test/clientmetricreport/ClientMetricReport.test.ts
@@ -248,6 +248,107 @@ describe('ClientMetricReport', () => {
});
});
+ describe('millisecondsPerSecond', () => {
+ const metricName = 'metric-name';
+
+ it('returns 0 if the interval is 0', () => {
+ const report = new GlobalMetricReport();
+ clientMetricReport.globalMetricReport = report;
+ clientMetricReport.currentTimestampMs = 0;
+ clientMetricReport.previousTimestampMs = 0;
+ expect(clientMetricReport.millisecondsPerSecond(metricName)).to.equal(0);
+ });
+
+ it('returns 0 if the diff is 0', () => {
+ const report = new GlobalMetricReport();
+ report.currentMetrics[metricName] = 0;
+ clientMetricReport.globalMetricReport = report;
+ clientMetricReport.currentTimestampMs = 2000;
+ clientMetricReport.previousTimestampMs = 0;
+ expect(clientMetricReport.millisecondsPerSecond(metricName)).to.equal(0);
+ });
+
+ it('interval is 1 second if pervious timestamp is 0', () => {
+ const report = new GlobalMetricReport();
+ report.currentMetrics[metricName] = 0.1;
+ clientMetricReport.globalMetricReport = report;
+ clientMetricReport.currentTimestampMs = 2000;
+ clientMetricReport.previousTimestampMs = 0;
+ expect(clientMetricReport.millisecondsPerSecond(metricName)).to.equal(100);
+ });
+
+ it('returns the count from the stream metric reports', () => {
+ const ssrc = 1;
+ const report = new StreamMetricReport();
+ report.currentMetrics[metricName] = 0.1;
+ clientMetricReport.streamMetricReports[ssrc] = report;
+ clientMetricReport.currentTimestampMs = 2000;
+ clientMetricReport.previousTimestampMs = 1000;
+ expect(clientMetricReport.millisecondsPerSecond(metricName, ssrc)).to.equal(100);
+ });
+ });
+
+ describe('isHardwareImplementation', () => {
+ const metricName = 'metric-name';
+
+ it('return 0 for software implementation FFmpeg', () => {
+ const ssrc = 1;
+ const report = new StreamMetricReport();
+ report.currentStringMetrics[metricName] = 'FFmpeg';
+ clientMetricReport.streamMetricReports[ssrc] = report;
+ expect(clientMetricReport.isHardwareImplementation(metricName, ssrc)).to.equal(0);
+ });
+
+ it('return 0 for software implementation OpenH264', () => {
+ const ssrc = 1;
+ const report = new StreamMetricReport();
+ report.currentStringMetrics[metricName] = 'OpenH264';
+ clientMetricReport.streamMetricReports[ssrc] = report;
+ expect(clientMetricReport.isHardwareImplementation(metricName, ssrc)).to.equal(0);
+ });
+
+ it('return 0 for software implementation libvpx', () => {
+ const ssrc = 1;
+ const report = new StreamMetricReport();
+ report.currentStringMetrics[metricName] = 'libvpx';
+ clientMetricReport.streamMetricReports[ssrc] = report;
+ expect(clientMetricReport.isHardwareImplementation(metricName, ssrc)).to.equal(0);
+ });
+
+ it('return 1 for hardware implementation with ExternalDecoder', () => {
+ const ssrc = 1;
+ const report = new StreamMetricReport();
+ report.currentStringMetrics[metricName] = 'ExternalDecoder (VDAVideoDecoder)';
+ clientMetricReport.streamMetricReports[ssrc] = report;
+ expect(clientMetricReport.isHardwareImplementation(metricName, ssrc)).to.equal(1);
+ });
+
+ it('return 1 for hardware implementation with ExternalEncoder', () => {
+ const ssrc = 1;
+ const report = new StreamMetricReport();
+ report.currentStringMetrics[metricName] = 'ExternalEncoder';
+ clientMetricReport.streamMetricReports[ssrc] = report;
+ expect(clientMetricReport.isHardwareImplementation(metricName, ssrc)).to.equal(1);
+ });
+
+ it('return 1 for hardware implementation with HardwareAccelerator', () => {
+ const ssrc = 1;
+ const report = new StreamMetricReport();
+ report.currentStringMetrics[metricName] = 'MediaFoundationVideoEncodeAccelerator';
+ clientMetricReport.streamMetricReports[ssrc] = report;
+ expect(clientMetricReport.isHardwareImplementation(metricName, ssrc)).to.equal(1);
+ });
+
+ it('return 0 for implementation fallback from hardware', () => {
+ const ssrc = 1;
+ const report = new StreamMetricReport();
+ report.currentStringMetrics[metricName] =
+ 'FFmpeg (fallback from: ExternalDecoder (VDAVideoDecoder)';
+ clientMetricReport.streamMetricReports[ssrc] = report;
+ expect(clientMetricReport.isHardwareImplementation(metricName, ssrc)).to.equal(0);
+ });
+ });
+
describe('getMetricMap', () => {
it('returns the global metric map if not passing the media type and the direction', () => {
expect(clientMetricReport.getMetricMap()).to.equal(clientMetricReport.globalMetricMap);
diff --git a/test/statscollector/StatsCollector.test.ts b/test/statscollector/StatsCollector.test.ts
index e1d54a6bf4..188d5e62f5 100644
--- a/test/statscollector/StatsCollector.test.ts
+++ b/test/statscollector/StatsCollector.test.ts
@@ -476,6 +476,7 @@ describe('StatsCollector', () => {
kind: 'video',
packetsLost: 10,
jitterBufferDelay: 100,
+ decoderImplementation: 'FFmpeg',
};
statsCollector.start(signalingClient, new TestVideoStreamIndex(logger));
@@ -503,6 +504,7 @@ describe('StatsCollector', () => {
kind: 'video',
packetsLost: 10,
jitterBufferDelay: 100,
+ decoderImplementation: 'FFmpeg',
};
const streamMetricReport = new StreamMetricReport();
@@ -511,6 +513,8 @@ describe('StatsCollector', () => {
streamMetricReport.direction = ClientMetricReportDirection.UPSTREAM;
streamMetricReport.currentMetrics['packetsLost'] = 10;
streamMetricReport.currentMetrics['jitterBufferDelay'] = 100;
+ streamMetricReport.currentStringMetrics['decoderImplementation'] = 'FFmpeg';
+ streamMetricReport.currentStringMetrics['invalid-type'] = 'invalid-value';
statsCollector = new StatsCollector(audioVideoController, logger, interval);
statsCollector.start(signalingClient, new TestVideoStreamIndex(logger));
@@ -550,6 +554,33 @@ describe('StatsCollector', () => {
});
});
+ it('adds the metric frame from the stream metric report when videoStreamIndex has streams and value in null type', done => {
+ class TestVideoStreamIndex extends DefaultVideoStreamIndex {
+ allStreams(): DefaultVideoStreamIdSet {
+ return new DefaultVideoStreamIdSet([1, 2, 3]);
+ }
+
+ streamIdForSSRC(_ssrcId: number): number {
+ return 1;
+ }
+ }
+ domMockBehavior.rtcPeerConnectionGetStatsReport = {
+ id: 'RTCInboundRTPVideoStream',
+ type: 'inbound-rtp',
+ kind: 'video',
+ packetsLost: 10,
+ jitterBufferDelay: 100,
+ decoderImplementation: null,
+ };
+
+ statsCollector.start(signalingClient, new TestVideoStreamIndex(logger));
+
+ new TimeoutScheduler(interval + 5).start(() => {
+ statsCollector.stop();
+ done();
+ });
+ });
+
it('cannot add the metric frame if the type does not exist in the metric spec', done => {
domMockBehavior.rtcPeerConnectionGetStatsReport = {
id: 'RTCIceCandidatePair',
currentStringMetrics
+Type declaration
++-
+
+
+[id: string]: string
+previousMetrics
@@ -171,6 +190,9 @@[id: currentMetrics
+
+ currentStringMetrics
+
previousMetrics
diff --git a/docs/classes/streammetricreport.html b/docs/classes/streammetricreport.html
index 095e8e222b..1ee708dc55 100644
--- a/docs/classes/streammetricreport.html
+++ b/docs/classes/streammetricreport.html
@@ -87,6 +87,7 @@ - current
Metrics
+ - current
StringMetrics
- direction
- media
Type
- previous
Metrics
@@ -133,6 +134,24 @@
Constructors
Properties
[id: + +currentStringMetrics: {} = {}
+
+
+
+
currentStringMetrics
+Type declaration
++-
+
+
+[id: string]: string
+direction
@@ -204,6 +223,9 @@streamId