blob: 14c5f24a2c7238a738d3bfaaea65e7704ab10d75 [file] [log] [blame]
hbosd565b732016-08-30 14:04:35 -07001/*
2 * Copyright 2016 The WebRTC Project Authors. All rights reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020011#ifndef API_STATS_RTCSTATS_OBJECTS_H_
12#define API_STATS_RTCSTATS_OBJECTS_H_
hbosd565b732016-08-30 14:04:35 -070013
Yves Gerey3e707812018-11-28 16:47:49 +010014#include <stdint.h>
Jonas Olssona4d87372019-07-05 19:08:33 +020015
Byoungchan Lee7d235352021-05-28 21:32:04 +090016#include <map>
Henrik Boström1df1bf82018-03-20 13:24:20 +010017#include <memory>
hbosd565b732016-08-30 14:04:35 -070018#include <string>
oprypin803dc292017-02-01 01:55:59 -080019#include <vector>
hbosd565b732016-08-30 14:04:35 -070020
Steve Anton10542f22019-01-11 09:11:00 -080021#include "api/stats/rtc_stats.h"
Mirko Bonadei276827c2018-10-16 14:13:50 +020022#include "rtc_base/system/rtc_export.h"
hbosd565b732016-08-30 14:04:35 -070023
24namespace webrtc {
25
hboscc555c52016-10-18 12:48:31 -070026// https://w3c.github.io/webrtc-pc/#idl-def-rtcdatachannelstate
27struct RTCDataChannelState {
agrieve26622d32017-08-08 10:48:15 -070028 static const char* const kConnecting;
29 static const char* const kOpen;
30 static const char* const kClosing;
31 static const char* const kClosed;
hboscc555c52016-10-18 12:48:31 -070032};
33
hbosc47a0c32016-10-11 14:54:49 -070034// https://w3c.github.io/webrtc-stats/#dom-rtcstatsicecandidatepairstate
35struct RTCStatsIceCandidatePairState {
agrieve26622d32017-08-08 10:48:15 -070036 static const char* const kFrozen;
37 static const char* const kWaiting;
38 static const char* const kInProgress;
39 static const char* const kFailed;
40 static const char* const kSucceeded;
hbosc47a0c32016-10-11 14:54:49 -070041};
42
hboscc555c52016-10-18 12:48:31 -070043// https://w3c.github.io/webrtc-pc/#rtcicecandidatetype-enum
hbosab9f6e42016-10-07 02:18:47 -070044struct RTCIceCandidateType {
agrieve26622d32017-08-08 10:48:15 -070045 static const char* const kHost;
46 static const char* const kSrflx;
47 static const char* const kPrflx;
48 static const char* const kRelay;
hbosab9f6e42016-10-07 02:18:47 -070049};
50
hbos7064d592017-01-16 07:38:02 -080051// https://w3c.github.io/webrtc-pc/#idl-def-rtcdtlstransportstate
52struct RTCDtlsTransportState {
agrieve26622d32017-08-08 10:48:15 -070053 static const char* const kNew;
54 static const char* const kConnecting;
55 static const char* const kConnected;
56 static const char* const kClosed;
57 static const char* const kFailed;
hbos7064d592017-01-16 07:38:02 -080058};
59
Artem Titovcfea2182021-08-10 01:22:31 +020060// `RTCMediaStreamTrackStats::kind` is not an enum in the spec but the only
hbos160e4a72017-01-17 02:53:23 -080061// valid values are "audio" and "video".
62// https://w3c.github.io/webrtc-stats/#dom-rtcmediastreamtrackstats-kind
63struct RTCMediaStreamTrackKind {
agrieve26622d32017-08-08 10:48:15 -070064 static const char* const kAudio;
65 static const char* const kVideo;
hbos160e4a72017-01-17 02:53:23 -080066};
67
Gary Liu37e489c2017-11-21 10:49:36 -080068// https://w3c.github.io/webrtc-stats/#dom-rtcnetworktype
69struct RTCNetworkType {
70 static const char* const kBluetooth;
71 static const char* const kCellular;
72 static const char* const kEthernet;
73 static const char* const kWifi;
74 static const char* const kWimax;
75 static const char* const kVpn;
76 static const char* const kUnknown;
77};
78
Henrik Boströmce33b6a2019-05-28 17:42:38 +020079// https://w3c.github.io/webrtc-stats/#dom-rtcqualitylimitationreason
80struct RTCQualityLimitationReason {
81 static const char* const kNone;
82 static const char* const kCpu;
83 static const char* const kBandwidth;
84 static const char* const kOther;
85};
86
Henrik Boström2e069262019-04-09 13:59:31 +020087// https://webrtc.org/experiments/rtp-hdrext/video-content-type/
88struct RTCContentType {
89 static const char* const kUnspecified;
90 static const char* const kScreenshare;
91};
92
Philipp Hancke69c1df22022-04-22 15:46:24 +020093// https://w3c.github.io/webrtc-stats/#dom-rtcdtlsrole
94struct RTCDtlsRole {
95 static const char* const kUnknown;
96 static const char* const kClient;
97 static const char* const kServer;
98};
99
Philipp Hanckecc1b9b02022-05-04 18:58:26 +0200100// https://www.w3.org/TR/webrtc/#rtcicerole
101struct RTCIceRole {
102 static const char* const kUnknown;
103 static const char* const kControlled;
104 static const char* const kControlling;
105};
106
Philipp Hancke1f491572022-05-09 17:43:31 +0200107// https://www.w3.org/TR/webrtc/#dom-rtcicetransportstate
108struct RTCIceTransportState {
109 static const char* const kNew;
110 static const char* const kChecking;
111 static const char* const kConnected;
112 static const char* const kCompleted;
113 static const char* const kDisconnected;
114 static const char* const kFailed;
115 static const char* const kClosed;
116};
117
hbos2fa7c672016-10-24 04:00:05 -0700118// https://w3c.github.io/webrtc-stats/#certificatestats-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200119class RTC_EXPORT RTCCertificateStats final : public RTCStats {
hbos2fa7c672016-10-24 04:00:05 -0700120 public:
121 WEBRTC_RTCSTATS_DECL();
122
123 RTCCertificateStats(const std::string& id, int64_t timestamp_us);
124 RTCCertificateStats(std::string&& id, int64_t timestamp_us);
125 RTCCertificateStats(const RTCCertificateStats& other);
126 ~RTCCertificateStats() override;
127
128 RTCStatsMember<std::string> fingerprint;
129 RTCStatsMember<std::string> fingerprint_algorithm;
130 RTCStatsMember<std::string> base64_certificate;
131 RTCStatsMember<std::string> issuer_certificate_id;
132};
133
Jonas Oreland0d13bbd2022-03-02 11:17:36 +0100134// Non standard extension mapping to rtc::AdapterType
135struct RTCNetworkAdapterType {
136 static constexpr char kUnknown[] = "unknown";
137 static constexpr char kEthernet[] = "ethernet";
138 static constexpr char kWifi[] = "wifi";
139 static constexpr char kCellular[] = "cellular";
140 static constexpr char kLoopback[] = "loopback";
141 static constexpr char kAny[] = "any";
142 static constexpr char kCellular2g[] = "cellular2g";
143 static constexpr char kCellular3g[] = "cellular3g";
144 static constexpr char kCellular4g[] = "cellular4g";
145 static constexpr char kCellular5g[] = "cellular5g";
146};
147
hbos0adb8282016-11-23 02:32:06 -0800148// https://w3c.github.io/webrtc-stats/#codec-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200149class RTC_EXPORT RTCCodecStats final : public RTCStats {
hbos0adb8282016-11-23 02:32:06 -0800150 public:
151 WEBRTC_RTCSTATS_DECL();
152
153 RTCCodecStats(const std::string& id, int64_t timestamp_us);
154 RTCCodecStats(std::string&& id, int64_t timestamp_us);
155 RTCCodecStats(const RTCCodecStats& other);
156 ~RTCCodecStats() override;
157
Philipp Hancke95157a02020-11-16 20:08:27 +0100158 RTCStatsMember<std::string> transport_id;
hbos0adb8282016-11-23 02:32:06 -0800159 RTCStatsMember<uint32_t> payload_type;
hbos13f54b22017-02-28 06:56:04 -0800160 RTCStatsMember<std::string> mime_type;
hbos0adb8282016-11-23 02:32:06 -0800161 RTCStatsMember<uint32_t> clock_rate;
hbos0adb8282016-11-23 02:32:06 -0800162 RTCStatsMember<uint32_t> channels;
hbos13f54b22017-02-28 06:56:04 -0800163 RTCStatsMember<std::string> sdp_fmtp_line;
hbos0adb8282016-11-23 02:32:06 -0800164};
165
hbos2fa7c672016-10-24 04:00:05 -0700166// https://w3c.github.io/webrtc-stats/#dcstats-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200167class RTC_EXPORT RTCDataChannelStats final : public RTCStats {
hbos2fa7c672016-10-24 04:00:05 -0700168 public:
169 WEBRTC_RTCSTATS_DECL();
170
171 RTCDataChannelStats(const std::string& id, int64_t timestamp_us);
172 RTCDataChannelStats(std::string&& id, int64_t timestamp_us);
173 RTCDataChannelStats(const RTCDataChannelStats& other);
174 ~RTCDataChannelStats() override;
175
176 RTCStatsMember<std::string> label;
177 RTCStatsMember<std::string> protocol;
Harald Alvestrand10ef8472020-06-05 15:38:51 +0200178 RTCStatsMember<int32_t> data_channel_identifier;
hbos2fa7c672016-10-24 04:00:05 -0700179 // TODO(hbos): Support enum types? "RTCStatsMember<RTCDataChannelState>"?
180 RTCStatsMember<std::string> state;
181 RTCStatsMember<uint32_t> messages_sent;
182 RTCStatsMember<uint64_t> bytes_sent;
183 RTCStatsMember<uint32_t> messages_received;
184 RTCStatsMember<uint64_t> bytes_received;
185};
186
187// https://w3c.github.io/webrtc-stats/#candidatepair-dict*
hbos338f78a2017-02-07 06:41:21 -0800188// TODO(hbos): Tracking bug https://bugs.webrtc.org/7062
Mirko Bonadei276827c2018-10-16 14:13:50 +0200189class RTC_EXPORT RTCIceCandidatePairStats final : public RTCStats {
hbosc47a0c32016-10-11 14:54:49 -0700190 public:
191 WEBRTC_RTCSTATS_DECL();
192
193 RTCIceCandidatePairStats(const std::string& id, int64_t timestamp_us);
194 RTCIceCandidatePairStats(std::string&& id, int64_t timestamp_us);
195 RTCIceCandidatePairStats(const RTCIceCandidatePairStats& other);
196 ~RTCIceCandidatePairStats() override;
197
198 RTCStatsMember<std::string> transport_id;
199 RTCStatsMember<std::string> local_candidate_id;
200 RTCStatsMember<std::string> remote_candidate_id;
201 // TODO(hbos): Support enum types?
202 // "RTCStatsMember<RTCStatsIceCandidatePairState>"?
203 RTCStatsMember<std::string> state;
Di Wuef036cd2021-03-19 08:24:41 -0700204 // Obsolete: priority
hbosc47a0c32016-10-11 14:54:49 -0700205 RTCStatsMember<uint64_t> priority;
206 RTCStatsMember<bool> nominated;
hbos338f78a2017-02-07 06:41:21 -0800207 // TODO(hbos): Collect this the way the spec describes it. We have a value for
208 // it but it is not spec-compliant. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700209 RTCStatsMember<bool> writable;
hbos338f78a2017-02-07 06:41:21 -0800210 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700211 RTCStatsMember<bool> readable;
Taylor Brandstetter79326ea2021-09-28 15:09:53 -0700212 RTCStatsMember<uint64_t> packets_sent;
213 RTCStatsMember<uint64_t> packets_received;
hbosc47a0c32016-10-11 14:54:49 -0700214 RTCStatsMember<uint64_t> bytes_sent;
215 RTCStatsMember<uint64_t> bytes_received;
hbos3168c7a2016-12-15 06:17:08 -0800216 RTCStatsMember<double> total_round_trip_time;
hbos3168c7a2016-12-15 06:17:08 -0800217 RTCStatsMember<double> current_round_trip_time;
hbosc47a0c32016-10-11 14:54:49 -0700218 RTCStatsMember<double> available_outgoing_bitrate;
hbos338f78a2017-02-07 06:41:21 -0800219 // TODO(hbos): Populate this value. It is wired up and collected the same way
hbosbf8d3e52017-02-28 06:34:47 -0800220 // "VideoBwe.googAvailableReceiveBandwidth" is, but that value is always
hbos338f78a2017-02-07 06:41:21 -0800221 // undefined. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700222 RTCStatsMember<double> available_incoming_bitrate;
223 RTCStatsMember<uint64_t> requests_received;
224 RTCStatsMember<uint64_t> requests_sent;
225 RTCStatsMember<uint64_t> responses_received;
226 RTCStatsMember<uint64_t> responses_sent;
hbos338f78a2017-02-07 06:41:21 -0800227 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700228 RTCStatsMember<uint64_t> retransmissions_received;
hbos338f78a2017-02-07 06:41:21 -0800229 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700230 RTCStatsMember<uint64_t> retransmissions_sent;
hbos338f78a2017-02-07 06:41:21 -0800231 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700232 RTCStatsMember<uint64_t> consent_requests_received;
233 RTCStatsMember<uint64_t> consent_requests_sent;
hbos338f78a2017-02-07 06:41:21 -0800234 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700235 RTCStatsMember<uint64_t> consent_responses_received;
hbos338f78a2017-02-07 06:41:21 -0800236 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700237 RTCStatsMember<uint64_t> consent_responses_sent;
Taylor Brandstetter79326ea2021-09-28 15:09:53 -0700238 RTCStatsMember<uint64_t> packets_discarded_on_send;
239 RTCStatsMember<uint64_t> bytes_discarded_on_send;
hbosc47a0c32016-10-11 14:54:49 -0700240};
241
hbosab9f6e42016-10-07 02:18:47 -0700242// https://w3c.github.io/webrtc-stats/#icecandidate-dict*
Artem Titov0e61fdd2021-07-25 21:50:14 +0200243// TODO(hbos): `RTCStatsCollector` only collects candidates that are part of
hbos5d79a7c2016-10-24 09:27:10 -0700244// ice candidate pairs, but there could be candidates not paired with anything.
245// crbug.com/632723
Qingsi Wang72a43a12018-02-20 16:03:18 -0800246// TODO(qingsi): Add the stats of STUN binding requests (keepalives) and collect
247// them in the new PeerConnection::GetStats.
Mirko Bonadei276827c2018-10-16 14:13:50 +0200248class RTC_EXPORT RTCIceCandidateStats : public RTCStats {
hbosab9f6e42016-10-07 02:18:47 -0700249 public:
250 WEBRTC_RTCSTATS_DECL();
251
252 RTCIceCandidateStats(const RTCIceCandidateStats& other);
253 ~RTCIceCandidateStats() override;
254
hbosb4e426e2017-01-02 09:59:31 -0800255 RTCStatsMember<std::string> transport_id;
Di Wuef036cd2021-03-19 08:24:41 -0700256 // Obsolete: is_remote
hbosc3a2b7f2017-01-02 04:46:15 -0800257 RTCStatsMember<bool> is_remote;
Gary Liu37e489c2017-11-21 10:49:36 -0800258 RTCStatsMember<std::string> network_type;
hbosab9f6e42016-10-07 02:18:47 -0700259 RTCStatsMember<std::string> ip;
Philipp Hanckea9ba4502021-03-22 13:22:54 +0100260 RTCStatsMember<std::string> address;
hbosab9f6e42016-10-07 02:18:47 -0700261 RTCStatsMember<int32_t> port;
262 RTCStatsMember<std::string> protocol;
Philipp Hancke95513752018-09-27 14:40:08 +0200263 RTCStatsMember<std::string> relay_protocol;
hbosab9f6e42016-10-07 02:18:47 -0700264 // TODO(hbos): Support enum types? "RTCStatsMember<RTCIceCandidateType>"?
265 RTCStatsMember<std::string> candidate_type;
266 RTCStatsMember<int32_t> priority;
267 RTCStatsMember<std::string> url;
268
Jonas Oreland0d13bbd2022-03-02 11:17:36 +0100269 RTCNonStandardStatsMember<bool> vpn;
270 RTCNonStandardStatsMember<std::string> network_adapter_type;
271
hbosab9f6e42016-10-07 02:18:47 -0700272 protected:
Yves Gerey665174f2018-06-19 15:03:05 +0200273 RTCIceCandidateStats(const std::string& id,
274 int64_t timestamp_us,
275 bool is_remote);
hbosc3a2b7f2017-01-02 04:46:15 -0800276 RTCIceCandidateStats(std::string&& id, int64_t timestamp_us, bool is_remote);
hbosab9f6e42016-10-07 02:18:47 -0700277};
278
279// In the spec both local and remote varieties are of type RTCIceCandidateStats.
Artem Titov0e61fdd2021-07-25 21:50:14 +0200280// But here we define them as subclasses of `RTCIceCandidateStats` because the
281// `kType` need to be different ("RTCStatsType type") in the local/remote case.
hbosab9f6e42016-10-07 02:18:47 -0700282// https://w3c.github.io/webrtc-stats/#rtcstatstype-str*
Henrik Boström1df1bf82018-03-20 13:24:20 +0100283// This forces us to have to override copy() and type().
Mirko Bonadei276827c2018-10-16 14:13:50 +0200284class RTC_EXPORT RTCLocalIceCandidateStats final : public RTCIceCandidateStats {
hbosab9f6e42016-10-07 02:18:47 -0700285 public:
286 static const char kType[];
287 RTCLocalIceCandidateStats(const std::string& id, int64_t timestamp_us);
288 RTCLocalIceCandidateStats(std::string&& id, int64_t timestamp_us);
Henrik Boström1df1bf82018-03-20 13:24:20 +0100289 std::unique_ptr<RTCStats> copy() const override;
hbosab9f6e42016-10-07 02:18:47 -0700290 const char* type() const override;
291};
292
Mirko Bonadei276827c2018-10-16 14:13:50 +0200293class RTC_EXPORT RTCRemoteIceCandidateStats final
294 : public RTCIceCandidateStats {
hbosab9f6e42016-10-07 02:18:47 -0700295 public:
296 static const char kType[];
297 RTCRemoteIceCandidateStats(const std::string& id, int64_t timestamp_us);
298 RTCRemoteIceCandidateStats(std::string&& id, int64_t timestamp_us);
Henrik Boström1df1bf82018-03-20 13:24:20 +0100299 std::unique_ptr<RTCStats> copy() const override;
hbosab9f6e42016-10-07 02:18:47 -0700300 const char* type() const override;
301};
302
hbos09bc1282016-11-08 06:29:22 -0800303// https://w3c.github.io/webrtc-stats/#msstats-dict*
hbos0adb8282016-11-23 02:32:06 -0800304// TODO(hbos): Tracking bug crbug.com/660827
Mirko Bonadei276827c2018-10-16 14:13:50 +0200305class RTC_EXPORT RTCMediaStreamStats final : public RTCStats {
hbos09bc1282016-11-08 06:29:22 -0800306 public:
307 WEBRTC_RTCSTATS_DECL();
308
309 RTCMediaStreamStats(const std::string& id, int64_t timestamp_us);
310 RTCMediaStreamStats(std::string&& id, int64_t timestamp_us);
311 RTCMediaStreamStats(const RTCMediaStreamStats& other);
312 ~RTCMediaStreamStats() override;
313
314 RTCStatsMember<std::string> stream_identifier;
315 RTCStatsMember<std::vector<std::string>> track_ids;
316};
317
318// https://w3c.github.io/webrtc-stats/#mststats-dict*
hbos0adb8282016-11-23 02:32:06 -0800319// TODO(hbos): Tracking bug crbug.com/659137
Mirko Bonadei276827c2018-10-16 14:13:50 +0200320class RTC_EXPORT RTCMediaStreamTrackStats final : public RTCStats {
hbos09bc1282016-11-08 06:29:22 -0800321 public:
322 WEBRTC_RTCSTATS_DECL();
323
Yves Gerey665174f2018-06-19 15:03:05 +0200324 RTCMediaStreamTrackStats(const std::string& id,
325 int64_t timestamp_us,
hbos160e4a72017-01-17 02:53:23 -0800326 const char* kind);
Yves Gerey665174f2018-06-19 15:03:05 +0200327 RTCMediaStreamTrackStats(std::string&& id,
328 int64_t timestamp_us,
hbos160e4a72017-01-17 02:53:23 -0800329 const char* kind);
hbos09bc1282016-11-08 06:29:22 -0800330 RTCMediaStreamTrackStats(const RTCMediaStreamTrackStats& other);
331 ~RTCMediaStreamTrackStats() override;
332
333 RTCStatsMember<std::string> track_identifier;
Henrik Boström646fda02019-05-22 15:49:42 +0200334 RTCStatsMember<std::string> media_source_id;
hbos09bc1282016-11-08 06:29:22 -0800335 RTCStatsMember<bool> remote_source;
336 RTCStatsMember<bool> ended;
Artem Titov0e61fdd2021-07-25 21:50:14 +0200337 // TODO(hbos): `RTCStatsCollector` does not return stats for detached tracks.
hbos09bc1282016-11-08 06:29:22 -0800338 // crbug.com/659137
339 RTCStatsMember<bool> detached;
Artem Titov0e61fdd2021-07-25 21:50:14 +0200340 // See `RTCMediaStreamTrackKind` for valid values.
hbos160e4a72017-01-17 02:53:23 -0800341 RTCStatsMember<std::string> kind;
Gustaf Ullbergb0a02072017-10-02 12:00:34 +0200342 RTCStatsMember<double> jitter_buffer_delay;
Chen Xing0acffb52019-01-15 15:46:29 +0100343 RTCStatsMember<uint64_t> jitter_buffer_emitted_count;
hbos09bc1282016-11-08 06:29:22 -0800344 // Video-only members
345 RTCStatsMember<uint32_t> frame_width;
346 RTCStatsMember<uint32_t> frame_height;
Artem Titov0e61fdd2021-07-25 21:50:14 +0200347 // TODO(hbos): Not collected by `RTCStatsCollector`. crbug.com/659137
hbos09bc1282016-11-08 06:29:22 -0800348 RTCStatsMember<double> frames_per_second;
hbos09bc1282016-11-08 06:29:22 -0800349 RTCStatsMember<uint32_t> frames_sent;
Ilya Nikolaevskiy70473fc2018-02-28 16:35:03 +0100350 RTCStatsMember<uint32_t> huge_frames_sent;
hbos09bc1282016-11-08 06:29:22 -0800351 RTCStatsMember<uint32_t> frames_received;
hbos09bc1282016-11-08 06:29:22 -0800352 RTCStatsMember<uint32_t> frames_decoded;
hbos09bc1282016-11-08 06:29:22 -0800353 RTCStatsMember<uint32_t> frames_dropped;
Artem Titov0e61fdd2021-07-25 21:50:14 +0200354 // TODO(hbos): Not collected by `RTCStatsCollector`. crbug.com/659137
hbos09bc1282016-11-08 06:29:22 -0800355 RTCStatsMember<uint32_t> frames_corrupted;
Artem Titov0e61fdd2021-07-25 21:50:14 +0200356 // TODO(hbos): Not collected by `RTCStatsCollector`. crbug.com/659137
hbos09bc1282016-11-08 06:29:22 -0800357 RTCStatsMember<uint32_t> partial_frames_lost;
Artem Titov0e61fdd2021-07-25 21:50:14 +0200358 // TODO(hbos): Not collected by `RTCStatsCollector`. crbug.com/659137
hbos09bc1282016-11-08 06:29:22 -0800359 RTCStatsMember<uint32_t> full_frames_lost;
360 // Audio-only members
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200361 RTCStatsMember<double> audio_level; // Receive-only
362 RTCStatsMember<double> total_audio_energy; // Receive-only
hbos09bc1282016-11-08 06:29:22 -0800363 RTCStatsMember<double> echo_return_loss;
364 RTCStatsMember<double> echo_return_loss_enhancement;
Steve Anton2dbc69f2017-08-24 17:15:13 -0700365 RTCStatsMember<uint64_t> total_samples_received;
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200366 RTCStatsMember<double> total_samples_duration; // Receive-only
Steve Anton2dbc69f2017-08-24 17:15:13 -0700367 RTCStatsMember<uint64_t> concealed_samples;
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200368 RTCStatsMember<uint64_t> silent_concealed_samples;
Gustaf Ullberg9a2e9062017-09-18 09:28:20 +0200369 RTCStatsMember<uint64_t> concealment_events;
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200370 RTCStatsMember<uint64_t> inserted_samples_for_deceleration;
371 RTCStatsMember<uint64_t> removed_samples_for_acceleration;
Ruslan Burakov8af88962018-11-22 17:21:10 +0100372 // Non-standard audio-only member
Jakob Ivarsson352ce5c2018-11-27 12:52:16 +0100373 // TODO(kuddai): Add description to standard. crbug.com/webrtc/10042
Ruslan Burakov8af88962018-11-22 17:21:10 +0100374 RTCNonStandardStatsMember<uint64_t> jitter_buffer_flushes;
Jakob Ivarsson352ce5c2018-11-27 12:52:16 +0100375 RTCNonStandardStatsMember<uint64_t> delayed_packet_outage_samples;
Jakob Ivarsson232b3fd2019-03-06 09:18:40 +0100376 RTCNonStandardStatsMember<double> relative_packet_arrival_delay;
Artem Titove618cc92020-03-11 11:18:54 +0100377 // Non-standard metric showing target delay of jitter buffer.
378 // This value is increased by the target jitter buffer delay every time a
379 // sample is emitted by the jitter buffer. The added target is the target
380 // delay, in seconds, at the time that the sample was emitted from the jitter
381 // buffer. (https://github.com/w3c/webrtc-provisional-stats/pull/20)
382 // Currently it is implemented only for audio.
383 // TODO(titovartem) implement for video streams when will be requested.
384 RTCNonStandardStatsMember<double> jitter_buffer_target_delay;
Henrik Lundin44125fa2019-04-29 17:00:46 +0200385 // TODO(henrik.lundin): Add description of the interruption metrics at
386 // https://github.com/henbos/webrtc-provisional-stats/issues/17
387 RTCNonStandardStatsMember<uint32_t> interruption_count;
388 RTCNonStandardStatsMember<double> total_interruption_duration;
Sergey Silkin02371062019-01-31 16:45:42 +0100389 // Non-standard video-only members.
390 // https://henbos.github.io/webrtc-provisional-stats/#RTCVideoReceiverStats-dict*
391 RTCNonStandardStatsMember<uint32_t> freeze_count;
392 RTCNonStandardStatsMember<uint32_t> pause_count;
393 RTCNonStandardStatsMember<double> total_freezes_duration;
394 RTCNonStandardStatsMember<double> total_pauses_duration;
395 RTCNonStandardStatsMember<double> total_frames_duration;
396 RTCNonStandardStatsMember<double> sum_squared_frame_durations;
hbos09bc1282016-11-08 06:29:22 -0800397};
398
hbos6ab97ce2016-10-03 14:16:56 -0700399// https://w3c.github.io/webrtc-stats/#pcstats-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200400class RTC_EXPORT RTCPeerConnectionStats final : public RTCStats {
hbosd565b732016-08-30 14:04:35 -0700401 public:
hbosfc5e0502016-10-06 02:06:10 -0700402 WEBRTC_RTCSTATS_DECL();
403
hbos0e6758d2016-08-31 07:57:36 -0700404 RTCPeerConnectionStats(const std::string& id, int64_t timestamp_us);
405 RTCPeerConnectionStats(std::string&& id, int64_t timestamp_us);
hbosfc5e0502016-10-06 02:06:10 -0700406 RTCPeerConnectionStats(const RTCPeerConnectionStats& other);
407 ~RTCPeerConnectionStats() override;
hbosd565b732016-08-30 14:04:35 -0700408
409 RTCStatsMember<uint32_t> data_channels_opened;
410 RTCStatsMember<uint32_t> data_channels_closed;
411};
412
hbos6ded1902016-11-01 01:50:46 -0700413// https://w3c.github.io/webrtc-stats/#streamstats-dict*
hbos0adb8282016-11-23 02:32:06 -0800414// TODO(hbos): Tracking bug crbug.com/657854
Mirko Bonadei276827c2018-10-16 14:13:50 +0200415class RTC_EXPORT RTCRTPStreamStats : public RTCStats {
hbos6ded1902016-11-01 01:50:46 -0700416 public:
417 WEBRTC_RTCSTATS_DECL();
418
419 RTCRTPStreamStats(const RTCRTPStreamStats& other);
420 ~RTCRTPStreamStats() override;
421
hbos3443bb72017-02-07 06:28:11 -0800422 RTCStatsMember<uint32_t> ssrc;
Philipp Hancke3bc01662018-08-28 14:55:03 +0200423 RTCStatsMember<std::string> kind;
Di Wuef036cd2021-03-19 08:24:41 -0700424 // Obsolete: track_id
hbosb0ae9202017-01-27 06:35:16 -0800425 RTCStatsMember<std::string> track_id;
hbos6ded1902016-11-01 01:50:46 -0700426 RTCStatsMember<std::string> transport_id;
hbos6ded1902016-11-01 01:50:46 -0700427 RTCStatsMember<std::string> codec_id;
Di Wufd1e9d12021-03-09 09:25:28 -0800428
429 // Obsolete
430 RTCStatsMember<std::string> media_type; // renamed to kind.
hbos6ded1902016-11-01 01:50:46 -0700431
432 protected:
433 RTCRTPStreamStats(const std::string& id, int64_t timestamp_us);
434 RTCRTPStreamStats(std::string&& id, int64_t timestamp_us);
435};
436
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100437// https://www.w3.org/TR/webrtc-stats/#receivedrtpstats-dict*
Di Wufd1e9d12021-03-09 09:25:28 -0800438class RTC_EXPORT RTCReceivedRtpStreamStats : public RTCRTPStreamStats {
439 public:
440 WEBRTC_RTCSTATS_DECL();
441
442 RTCReceivedRtpStreamStats(const RTCReceivedRtpStreamStats& other);
443 ~RTCReceivedRtpStreamStats() override;
444
445 // TODO(hbos) The following fields need to be added and migrated
446 // both from RTCInboundRtpStreamStats and RTCRemoteInboundRtpStreamStats:
Minyue Li28a2c632021-07-07 15:53:38 +0200447 // packetsReceived, packetsRepaired, burstPacketsLost,
Di Wufd1e9d12021-03-09 09:25:28 -0800448 // burstPacketDiscarded, burstLossCount, burstDiscardCount, burstLossRate,
449 // burstDiscardRate, gapLossRate, gapDiscardRate, framesDropped,
450 // partialFramesLost, fullFramesLost
451 // crbug.com/webrtc/12532
452 RTCStatsMember<double> jitter;
453 RTCStatsMember<int32_t> packets_lost; // Signed per RFC 3550
Minyue Li28a2c632021-07-07 15:53:38 +0200454 RTCStatsMember<uint64_t> packets_discarded;
Di Wufd1e9d12021-03-09 09:25:28 -0800455
456 protected:
457 RTCReceivedRtpStreamStats(const std::string&& id, int64_t timestamp_us);
458 RTCReceivedRtpStreamStats(std::string&& id, int64_t timestamp_us);
459};
460
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100461// https://www.w3.org/TR/webrtc-stats/#sentrtpstats-dict*
462class RTC_EXPORT RTCSentRtpStreamStats : public RTCRTPStreamStats {
463 public:
464 WEBRTC_RTCSTATS_DECL();
465
466 RTCSentRtpStreamStats(const RTCSentRtpStreamStats& other);
467 ~RTCSentRtpStreamStats() override;
468
469 RTCStatsMember<uint32_t> packets_sent;
470 RTCStatsMember<uint64_t> bytes_sent;
471
472 protected:
473 RTCSentRtpStreamStats(const std::string&& id, int64_t timestamp_us);
474 RTCSentRtpStreamStats(std::string&& id, int64_t timestamp_us);
475};
476
hboseeafe942016-11-01 03:00:17 -0700477// https://w3c.github.io/webrtc-stats/#inboundrtpstats-dict*
hbosa7a9be12017-03-01 01:02:45 -0800478// TODO(hbos): Support the remote case |is_remote = true|.
479// https://bugs.webrtc.org/7065
Di Wufd1e9d12021-03-09 09:25:28 -0800480class RTC_EXPORT RTCInboundRTPStreamStats final
481 : public RTCReceivedRtpStreamStats {
hboseeafe942016-11-01 03:00:17 -0700482 public:
483 WEBRTC_RTCSTATS_DECL();
484
485 RTCInboundRTPStreamStats(const std::string& id, int64_t timestamp_us);
486 RTCInboundRTPStreamStats(std::string&& id, int64_t timestamp_us);
487 RTCInboundRTPStreamStats(const RTCInboundRTPStreamStats& other);
488 ~RTCInboundRTPStreamStats() override;
489
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100490 RTCStatsMember<std::string> remote_id;
hboseeafe942016-11-01 03:00:17 -0700491 RTCStatsMember<uint32_t> packets_received;
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200492 RTCStatsMember<uint64_t> fec_packets_received;
493 RTCStatsMember<uint64_t> fec_packets_discarded;
hboseeafe942016-11-01 03:00:17 -0700494 RTCStatsMember<uint64_t> bytes_received;
Niels Möllerac0a4cb2019-10-09 15:01:33 +0200495 RTCStatsMember<uint64_t> header_bytes_received;
Henrik Boström01738c62019-04-15 17:32:00 +0200496 RTCStatsMember<double> last_packet_received_timestamp;
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300497 RTCStatsMember<double> jitter_buffer_delay;
498 RTCStatsMember<uint64_t> jitter_buffer_emitted_count;
499 RTCStatsMember<uint64_t> total_samples_received;
500 RTCStatsMember<uint64_t> concealed_samples;
501 RTCStatsMember<uint64_t> silent_concealed_samples;
502 RTCStatsMember<uint64_t> concealment_events;
503 RTCStatsMember<uint64_t> inserted_samples_for_deceleration;
504 RTCStatsMember<uint64_t> removed_samples_for_acceleration;
505 RTCStatsMember<double> audio_level;
506 RTCStatsMember<double> total_audio_energy;
507 RTCStatsMember<double> total_samples_duration;
hbosa7a9be12017-03-01 01:02:45 -0800508 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
509 RTCStatsMember<double> round_trip_time;
510 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700511 RTCStatsMember<uint32_t> packets_repaired;
hbosa7a9be12017-03-01 01:02:45 -0800512 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700513 RTCStatsMember<uint32_t> burst_packets_lost;
hbosa7a9be12017-03-01 01:02:45 -0800514 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700515 RTCStatsMember<uint32_t> burst_packets_discarded;
hbosa7a9be12017-03-01 01:02:45 -0800516 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700517 RTCStatsMember<uint32_t> burst_loss_count;
hbosa7a9be12017-03-01 01:02:45 -0800518 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700519 RTCStatsMember<uint32_t> burst_discard_count;
hbosa7a9be12017-03-01 01:02:45 -0800520 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700521 RTCStatsMember<double> burst_loss_rate;
hbosa7a9be12017-03-01 01:02:45 -0800522 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700523 RTCStatsMember<double> burst_discard_rate;
hbosa7a9be12017-03-01 01:02:45 -0800524 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700525 RTCStatsMember<double> gap_loss_rate;
hbosa7a9be12017-03-01 01:02:45 -0800526 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700527 RTCStatsMember<double> gap_discard_rate;
Philipp Hanckea16a6a62022-04-25 12:21:30 +0200528 // Stats below are only implemented or defined for video.
529 RTCStatsMember<int32_t> frames_received;
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300530 RTCStatsMember<uint32_t> frame_width;
531 RTCStatsMember<uint32_t> frame_height;
532 RTCStatsMember<uint32_t> frame_bit_depth;
533 RTCStatsMember<double> frames_per_second;
hbos6769c492017-01-02 08:35:13 -0800534 RTCStatsMember<uint32_t> frames_decoded;
Rasmus Brandt2efae772019-06-27 14:29:34 +0200535 RTCStatsMember<uint32_t> key_frames_decoded;
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300536 RTCStatsMember<uint32_t> frames_dropped;
Johannes Kronbfd343b2019-07-01 10:07:50 +0200537 RTCStatsMember<double> total_decode_time;
Philipp Hanckea16a6a62022-04-25 12:21:30 +0200538 RTCStatsMember<double> total_processing_delay;
Johannes Kron00376e12019-11-25 10:25:42 +0100539 RTCStatsMember<double> total_inter_frame_delay;
540 RTCStatsMember<double> total_squared_inter_frame_delay;
Henrik Boström2e069262019-04-09 13:59:31 +0200541 // https://henbos.github.io/webrtc-provisional-stats/#dom-rtcinboundrtpstreamstats-contenttype
542 RTCStatsMember<std::string> content_type;
Åsa Perssonfcf79cc2019-10-22 15:23:44 +0200543 // TODO(asapersson): Currently only populated if audio/video sync is enabled.
544 RTCStatsMember<double> estimated_playout_timestamp;
Henrik Boström6b430862019-08-16 13:09:51 +0200545 // TODO(hbos): This is only implemented for video; implement it for audio as
546 // well.
547 RTCStatsMember<std::string> decoder_implementation;
Philipp Hanckea3b5c4e2022-04-22 15:09:54 +0200548 // FIR and PLI counts are only defined for |kind == "video"|.
Di Wufd1e9d12021-03-09 09:25:28 -0800549 RTCStatsMember<uint32_t> fir_count;
550 RTCStatsMember<uint32_t> pli_count;
Di Wufd1e9d12021-03-09 09:25:28 -0800551 RTCStatsMember<uint32_t> nack_count;
552 RTCStatsMember<uint64_t> qp_sum;
hboseeafe942016-11-01 03:00:17 -0700553};
554
hbos6ded1902016-11-01 01:50:46 -0700555// https://w3c.github.io/webrtc-stats/#outboundrtpstats-dict*
hbosa7a9be12017-03-01 01:02:45 -0800556// TODO(hbos): Support the remote case |is_remote = true|.
557// https://bugs.webrtc.org/7066
Mirko Bonadei276827c2018-10-16 14:13:50 +0200558class RTC_EXPORT RTCOutboundRTPStreamStats final : public RTCRTPStreamStats {
hbos6ded1902016-11-01 01:50:46 -0700559 public:
560 WEBRTC_RTCSTATS_DECL();
561
562 RTCOutboundRTPStreamStats(const std::string& id, int64_t timestamp_us);
563 RTCOutboundRTPStreamStats(std::string&& id, int64_t timestamp_us);
564 RTCOutboundRTPStreamStats(const RTCOutboundRTPStreamStats& other);
565 ~RTCOutboundRTPStreamStats() override;
566
Henrik Boström646fda02019-05-22 15:49:42 +0200567 RTCStatsMember<std::string> media_source_id;
Henrik Boström4f40fa52019-12-19 13:27:27 +0100568 RTCStatsMember<std::string> remote_id;
Henrik Boströma0ff50c2020-05-05 15:54:46 +0200569 RTCStatsMember<std::string> rid;
hbos6ded1902016-11-01 01:50:46 -0700570 RTCStatsMember<uint32_t> packets_sent;
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200571 RTCStatsMember<uint64_t> retransmitted_packets_sent;
hbos6ded1902016-11-01 01:50:46 -0700572 RTCStatsMember<uint64_t> bytes_sent;
Niels Möllerac0a4cb2019-10-09 15:01:33 +0200573 RTCStatsMember<uint64_t> header_bytes_sent;
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200574 RTCStatsMember<uint64_t> retransmitted_bytes_sent;
Jakob Ivarssonbf087452021-11-11 13:43:49 +0100575 // TODO(https://crbug.com/webrtc/13394): Also collect this metric for video.
hbos6ded1902016-11-01 01:50:46 -0700576 RTCStatsMember<double> target_bitrate;
hbos6769c492017-01-02 08:35:13 -0800577 RTCStatsMember<uint32_t> frames_encoded;
Rasmus Brandt2efae772019-06-27 14:29:34 +0200578 RTCStatsMember<uint32_t> key_frames_encoded;
Henrik Boströmf71362f2019-04-08 16:14:23 +0200579 RTCStatsMember<double> total_encode_time;
Henrik Boström23aff9b2019-05-20 15:15:38 +0200580 RTCStatsMember<uint64_t> total_encoded_bytes_target;
Henrik Boströma0ff50c2020-05-05 15:54:46 +0200581 RTCStatsMember<uint32_t> frame_width;
582 RTCStatsMember<uint32_t> frame_height;
583 RTCStatsMember<double> frames_per_second;
584 RTCStatsMember<uint32_t> frames_sent;
585 RTCStatsMember<uint32_t> huge_frames_sent;
Henrik Boström9fe18342019-05-16 18:38:20 +0200586 // TODO(https://crbug.com/webrtc/10635): This is only implemented for video;
587 // implement it for audio as well.
588 RTCStatsMember<double> total_packet_send_delay;
Henrik Boströmce33b6a2019-05-28 17:42:38 +0200589 // Enum type RTCQualityLimitationReason
Henrik Boströmce33b6a2019-05-28 17:42:38 +0200590 RTCStatsMember<std::string> quality_limitation_reason;
Byoungchan Lee7d235352021-05-28 21:32:04 +0900591 RTCStatsMember<std::map<std::string, double>> quality_limitation_durations;
Evan Shrubsolecc62b162019-09-09 11:26:45 +0200592 // https://w3c.github.io/webrtc-stats/#dom-rtcoutboundrtpstreamstats-qualitylimitationresolutionchanges
593 RTCStatsMember<uint32_t> quality_limitation_resolution_changes;
Henrik Boström2e069262019-04-09 13:59:31 +0200594 // https://henbos.github.io/webrtc-provisional-stats/#dom-rtcoutboundrtpstreamstats-contenttype
595 RTCStatsMember<std::string> content_type;
Henrik Boström6b430862019-08-16 13:09:51 +0200596 // TODO(hbos): This is only implemented for video; implement it for audio as
597 // well.
598 RTCStatsMember<std::string> encoder_implementation;
Philipp Hanckea3b5c4e2022-04-22 15:09:54 +0200599 // FIR and PLI counts are only defined for |kind == "video"|.
Di Wufd1e9d12021-03-09 09:25:28 -0800600 RTCStatsMember<uint32_t> fir_count;
601 RTCStatsMember<uint32_t> pli_count;
Di Wufd1e9d12021-03-09 09:25:28 -0800602 RTCStatsMember<uint32_t> nack_count;
603 RTCStatsMember<uint64_t> qp_sum;
hbos6ded1902016-11-01 01:50:46 -0700604};
605
Henrik Boström883eefc2019-05-27 13:40:25 +0200606// https://w3c.github.io/webrtc-stats/#remoteinboundrtpstats-dict*
Di Wufd1e9d12021-03-09 09:25:28 -0800607class RTC_EXPORT RTCRemoteInboundRtpStreamStats final
608 : public RTCReceivedRtpStreamStats {
Henrik Boström883eefc2019-05-27 13:40:25 +0200609 public:
610 WEBRTC_RTCSTATS_DECL();
611
612 RTCRemoteInboundRtpStreamStats(const std::string& id, int64_t timestamp_us);
613 RTCRemoteInboundRtpStreamStats(std::string&& id, int64_t timestamp_us);
614 RTCRemoteInboundRtpStreamStats(const RTCRemoteInboundRtpStreamStats& other);
615 ~RTCRemoteInboundRtpStreamStats() override;
616
Henrik Boström883eefc2019-05-27 13:40:25 +0200617 // TODO(hbos): The following RTCReceivedRtpStreamStats metrics should also be
Minyue Li28a2c632021-07-07 15:53:38 +0200618 // implemented: packetsReceived, packetsRepaired,
Henrik Boström883eefc2019-05-27 13:40:25 +0200619 // burstPacketsLost, burstPacketsDiscarded, burstLossCount, burstDiscardCount,
620 // burstLossRate, burstDiscardRate, gapLossRate and gapDiscardRate.
621 // RTCRemoteInboundRtpStreamStats
622 RTCStatsMember<std::string> local_id;
623 RTCStatsMember<double> round_trip_time;
Di Wu86f04ad2021-02-28 23:36:03 -0800624 RTCStatsMember<double> fraction_lost;
Di Wu88a51b22021-03-01 11:22:06 -0800625 RTCStatsMember<double> total_round_trip_time;
626 RTCStatsMember<int32_t> round_trip_time_measurements;
Henrik Boström883eefc2019-05-27 13:40:25 +0200627};
628
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100629// https://w3c.github.io/webrtc-stats/#remoteoutboundrtpstats-dict*
630class RTC_EXPORT RTCRemoteOutboundRtpStreamStats final
631 : public RTCSentRtpStreamStats {
632 public:
633 WEBRTC_RTCSTATS_DECL();
634
635 RTCRemoteOutboundRtpStreamStats(const std::string& id, int64_t timestamp_us);
636 RTCRemoteOutboundRtpStreamStats(std::string&& id, int64_t timestamp_us);
637 RTCRemoteOutboundRtpStreamStats(const RTCRemoteOutboundRtpStreamStats& other);
638 ~RTCRemoteOutboundRtpStreamStats() override;
639
640 RTCStatsMember<std::string> local_id;
641 RTCStatsMember<double> remote_timestamp;
642 RTCStatsMember<uint64_t> reports_sent;
Ivo Creusen2562cf02021-09-03 14:51:22 +0000643 RTCStatsMember<double> round_trip_time;
644 RTCStatsMember<uint64_t> round_trip_time_measurements;
645 RTCStatsMember<double> total_round_trip_time;
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100646};
647
Henrik Boström646fda02019-05-22 15:49:42 +0200648// https://w3c.github.io/webrtc-stats/#dom-rtcmediasourcestats
649class RTC_EXPORT RTCMediaSourceStats : public RTCStats {
650 public:
651 WEBRTC_RTCSTATS_DECL();
652
653 RTCMediaSourceStats(const RTCMediaSourceStats& other);
654 ~RTCMediaSourceStats() override;
655
656 RTCStatsMember<std::string> track_identifier;
657 RTCStatsMember<std::string> kind;
658
659 protected:
660 RTCMediaSourceStats(const std::string& id, int64_t timestamp_us);
661 RTCMediaSourceStats(std::string&& id, int64_t timestamp_us);
662};
663
664// https://w3c.github.io/webrtc-stats/#dom-rtcaudiosourcestats
665class RTC_EXPORT RTCAudioSourceStats final : public RTCMediaSourceStats {
666 public:
667 WEBRTC_RTCSTATS_DECL();
668
669 RTCAudioSourceStats(const std::string& id, int64_t timestamp_us);
670 RTCAudioSourceStats(std::string&& id, int64_t timestamp_us);
671 RTCAudioSourceStats(const RTCAudioSourceStats& other);
672 ~RTCAudioSourceStats() override;
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200673
674 RTCStatsMember<double> audio_level;
675 RTCStatsMember<double> total_audio_energy;
676 RTCStatsMember<double> total_samples_duration;
Taylor Brandstetter64851c02021-06-24 13:32:50 -0700677 RTCStatsMember<double> echo_return_loss;
678 RTCStatsMember<double> echo_return_loss_enhancement;
Henrik Boström646fda02019-05-22 15:49:42 +0200679};
680
681// https://w3c.github.io/webrtc-stats/#dom-rtcvideosourcestats
682class RTC_EXPORT RTCVideoSourceStats final : public RTCMediaSourceStats {
683 public:
684 WEBRTC_RTCSTATS_DECL();
685
686 RTCVideoSourceStats(const std::string& id, int64_t timestamp_us);
687 RTCVideoSourceStats(std::string&& id, int64_t timestamp_us);
688 RTCVideoSourceStats(const RTCVideoSourceStats& other);
689 ~RTCVideoSourceStats() override;
690
691 RTCStatsMember<uint32_t> width;
692 RTCStatsMember<uint32_t> height;
Henrik Boström646fda02019-05-22 15:49:42 +0200693 RTCStatsMember<uint32_t> frames;
Byoungchan Leeefe46b62021-11-10 11:23:56 +0900694 RTCStatsMember<double> frames_per_second;
Henrik Boström646fda02019-05-22 15:49:42 +0200695};
696
hbos2fa7c672016-10-24 04:00:05 -0700697// https://w3c.github.io/webrtc-stats/#transportstats-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200698class RTC_EXPORT RTCTransportStats final : public RTCStats {
hbos2fa7c672016-10-24 04:00:05 -0700699 public:
700 WEBRTC_RTCSTATS_DECL();
701
702 RTCTransportStats(const std::string& id, int64_t timestamp_us);
703 RTCTransportStats(std::string&& id, int64_t timestamp_us);
704 RTCTransportStats(const RTCTransportStats& other);
705 ~RTCTransportStats() override;
706
707 RTCStatsMember<uint64_t> bytes_sent;
Artem Titovedacbd52020-07-06 16:06:37 +0200708 RTCStatsMember<uint64_t> packets_sent;
hbos2fa7c672016-10-24 04:00:05 -0700709 RTCStatsMember<uint64_t> bytes_received;
Artem Titovedacbd52020-07-06 16:06:37 +0200710 RTCStatsMember<uint64_t> packets_received;
hbos2fa7c672016-10-24 04:00:05 -0700711 RTCStatsMember<std::string> rtcp_transport_stats_id;
hbos7064d592017-01-16 07:38:02 -0800712 // TODO(hbos): Support enum types? "RTCStatsMember<RTCDtlsTransportState>"?
713 RTCStatsMember<std::string> dtls_state;
hbos2fa7c672016-10-24 04:00:05 -0700714 RTCStatsMember<std::string> selected_candidate_pair_id;
715 RTCStatsMember<std::string> local_certificate_id;
716 RTCStatsMember<std::string> remote_certificate_id;
Harald Alvestrand5cb78072019-10-28 09:51:17 +0100717 RTCStatsMember<std::string> tls_version;
718 RTCStatsMember<std::string> dtls_cipher;
Philipp Hancke69c1df22022-04-22 15:46:24 +0200719 RTCStatsMember<std::string> dtls_role;
Harald Alvestrand5cb78072019-10-28 09:51:17 +0100720 RTCStatsMember<std::string> srtp_cipher;
Jonas Oreland149dc722019-08-28 08:10:27 +0200721 RTCStatsMember<uint32_t> selected_candidate_pair_changes;
Philipp Hanckecc1b9b02022-05-04 18:58:26 +0200722 RTCStatsMember<std::string> ice_role;
Philipp Hancke95b1a342022-05-05 07:53:54 +0200723 RTCStatsMember<std::string> ice_local_username_fragment;
Philipp Hancke1f491572022-05-09 17:43:31 +0200724 RTCStatsMember<std::string> ice_state;
hbos2fa7c672016-10-24 04:00:05 -0700725};
726
hbosd565b732016-08-30 14:04:35 -0700727} // namespace webrtc
728
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200729#endif // API_STATS_RTCSTATS_OBJECTS_H_