blob: 6984169b4189f5f709223387054771fd17a6bd63 [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;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200179 // Enum type RTCDataChannelState.
hbos2fa7c672016-10-24 04:00:05 -0700180 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*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200188class RTC_EXPORT RTCIceCandidatePairStats final : public RTCStats {
hbosc47a0c32016-10-11 14:54:49 -0700189 public:
190 WEBRTC_RTCSTATS_DECL();
191
192 RTCIceCandidatePairStats(const std::string& id, int64_t timestamp_us);
193 RTCIceCandidatePairStats(std::string&& id, int64_t timestamp_us);
194 RTCIceCandidatePairStats(const RTCIceCandidatePairStats& other);
195 ~RTCIceCandidatePairStats() override;
196
197 RTCStatsMember<std::string> transport_id;
198 RTCStatsMember<std::string> local_candidate_id;
199 RTCStatsMember<std::string> remote_candidate_id;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200200 // Enum type RTCStatsIceCandidatePairState.
hbosc47a0c32016-10-11 14:54:49 -0700201 RTCStatsMember<std::string> state;
Di Wuef036cd2021-03-19 08:24:41 -0700202 // Obsolete: priority
hbosc47a0c32016-10-11 14:54:49 -0700203 RTCStatsMember<uint64_t> priority;
204 RTCStatsMember<bool> nominated;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200205 // `writable` does not exist in the spec and old comments suggest it used to
206 // exist but was incorrectly implemented.
207 // TODO(https://crbug.com/webrtc/14171): Standardize and/or modify
208 // implementation.
hbosc47a0c32016-10-11 14:54:49 -0700209 RTCStatsMember<bool> writable;
Taylor Brandstetter79326ea2021-09-28 15:09:53 -0700210 RTCStatsMember<uint64_t> packets_sent;
211 RTCStatsMember<uint64_t> packets_received;
hbosc47a0c32016-10-11 14:54:49 -0700212 RTCStatsMember<uint64_t> bytes_sent;
213 RTCStatsMember<uint64_t> bytes_received;
hbos3168c7a2016-12-15 06:17:08 -0800214 RTCStatsMember<double> total_round_trip_time;
hbos3168c7a2016-12-15 06:17:08 -0800215 RTCStatsMember<double> current_round_trip_time;
hbosc47a0c32016-10-11 14:54:49 -0700216 RTCStatsMember<double> available_outgoing_bitrate;
217 RTCStatsMember<double> available_incoming_bitrate;
218 RTCStatsMember<uint64_t> requests_received;
219 RTCStatsMember<uint64_t> requests_sent;
220 RTCStatsMember<uint64_t> responses_received;
221 RTCStatsMember<uint64_t> responses_sent;
hbosc47a0c32016-10-11 14:54:49 -0700222 RTCStatsMember<uint64_t> consent_requests_sent;
Taylor Brandstetter79326ea2021-09-28 15:09:53 -0700223 RTCStatsMember<uint64_t> packets_discarded_on_send;
224 RTCStatsMember<uint64_t> bytes_discarded_on_send;
hbosc47a0c32016-10-11 14:54:49 -0700225};
226
hbosab9f6e42016-10-07 02:18:47 -0700227// https://w3c.github.io/webrtc-stats/#icecandidate-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200228class RTC_EXPORT RTCIceCandidateStats : public RTCStats {
hbosab9f6e42016-10-07 02:18:47 -0700229 public:
230 WEBRTC_RTCSTATS_DECL();
231
232 RTCIceCandidateStats(const RTCIceCandidateStats& other);
233 ~RTCIceCandidateStats() override;
234
hbosb4e426e2017-01-02 09:59:31 -0800235 RTCStatsMember<std::string> transport_id;
Di Wuef036cd2021-03-19 08:24:41 -0700236 // Obsolete: is_remote
hbosc3a2b7f2017-01-02 04:46:15 -0800237 RTCStatsMember<bool> is_remote;
Gary Liu37e489c2017-11-21 10:49:36 -0800238 RTCStatsMember<std::string> network_type;
hbosab9f6e42016-10-07 02:18:47 -0700239 RTCStatsMember<std::string> ip;
Philipp Hanckea9ba4502021-03-22 13:22:54 +0100240 RTCStatsMember<std::string> address;
hbosab9f6e42016-10-07 02:18:47 -0700241 RTCStatsMember<int32_t> port;
242 RTCStatsMember<std::string> protocol;
Philipp Hancke95513752018-09-27 14:40:08 +0200243 RTCStatsMember<std::string> relay_protocol;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200244 // Enum type RTCIceCandidateType.
hbosab9f6e42016-10-07 02:18:47 -0700245 RTCStatsMember<std::string> candidate_type;
246 RTCStatsMember<int32_t> priority;
247 RTCStatsMember<std::string> url;
248
Jonas Oreland0d13bbd2022-03-02 11:17:36 +0100249 RTCNonStandardStatsMember<bool> vpn;
250 RTCNonStandardStatsMember<std::string> network_adapter_type;
251
hbosab9f6e42016-10-07 02:18:47 -0700252 protected:
Yves Gerey665174f2018-06-19 15:03:05 +0200253 RTCIceCandidateStats(const std::string& id,
254 int64_t timestamp_us,
255 bool is_remote);
hbosc3a2b7f2017-01-02 04:46:15 -0800256 RTCIceCandidateStats(std::string&& id, int64_t timestamp_us, bool is_remote);
hbosab9f6e42016-10-07 02:18:47 -0700257};
258
259// In the spec both local and remote varieties are of type RTCIceCandidateStats.
Artem Titov0e61fdd2021-07-25 21:50:14 +0200260// But here we define them as subclasses of `RTCIceCandidateStats` because the
261// `kType` need to be different ("RTCStatsType type") in the local/remote case.
hbosab9f6e42016-10-07 02:18:47 -0700262// https://w3c.github.io/webrtc-stats/#rtcstatstype-str*
Henrik Boström1df1bf82018-03-20 13:24:20 +0100263// This forces us to have to override copy() and type().
Mirko Bonadei276827c2018-10-16 14:13:50 +0200264class RTC_EXPORT RTCLocalIceCandidateStats final : public RTCIceCandidateStats {
hbosab9f6e42016-10-07 02:18:47 -0700265 public:
266 static const char kType[];
267 RTCLocalIceCandidateStats(const std::string& id, int64_t timestamp_us);
268 RTCLocalIceCandidateStats(std::string&& id, int64_t timestamp_us);
Henrik Boström1df1bf82018-03-20 13:24:20 +0100269 std::unique_ptr<RTCStats> copy() const override;
hbosab9f6e42016-10-07 02:18:47 -0700270 const char* type() const override;
271};
272
Mirko Bonadei276827c2018-10-16 14:13:50 +0200273class RTC_EXPORT RTCRemoteIceCandidateStats final
274 : public RTCIceCandidateStats {
hbosab9f6e42016-10-07 02:18:47 -0700275 public:
276 static const char kType[];
277 RTCRemoteIceCandidateStats(const std::string& id, int64_t timestamp_us);
278 RTCRemoteIceCandidateStats(std::string&& id, int64_t timestamp_us);
Henrik Boström1df1bf82018-03-20 13:24:20 +0100279 std::unique_ptr<RTCStats> copy() const override;
hbosab9f6e42016-10-07 02:18:47 -0700280 const char* type() const override;
281};
282
Henrik Boström2843bbc2022-06-13 10:23:28 +0200283// https://w3c.github.io/webrtc-stats/#dom-rtcmediastreamstats
284// TODO(https://crbug.com/webrtc/14172): Deprecate and remove.
Mirko Bonadei276827c2018-10-16 14:13:50 +0200285class RTC_EXPORT RTCMediaStreamStats final : public RTCStats {
hbos09bc1282016-11-08 06:29:22 -0800286 public:
287 WEBRTC_RTCSTATS_DECL();
288
289 RTCMediaStreamStats(const std::string& id, int64_t timestamp_us);
290 RTCMediaStreamStats(std::string&& id, int64_t timestamp_us);
291 RTCMediaStreamStats(const RTCMediaStreamStats& other);
292 ~RTCMediaStreamStats() override;
293
294 RTCStatsMember<std::string> stream_identifier;
295 RTCStatsMember<std::vector<std::string>> track_ids;
296};
297
Henrik Boström2843bbc2022-06-13 10:23:28 +0200298// TODO(https://crbug.com/webrtc/14175): Deprecate and remove in favor of
299// RTCMediaSourceStats/RTCOutboundRtpStreamStats and RTCInboundRtpStreamStats.
Mirko Bonadei276827c2018-10-16 14:13:50 +0200300class RTC_EXPORT RTCMediaStreamTrackStats final : public RTCStats {
hbos09bc1282016-11-08 06:29:22 -0800301 public:
302 WEBRTC_RTCSTATS_DECL();
303
Yves Gerey665174f2018-06-19 15:03:05 +0200304 RTCMediaStreamTrackStats(const std::string& id,
305 int64_t timestamp_us,
hbos160e4a72017-01-17 02:53:23 -0800306 const char* kind);
Yves Gerey665174f2018-06-19 15:03:05 +0200307 RTCMediaStreamTrackStats(std::string&& id,
308 int64_t timestamp_us,
hbos160e4a72017-01-17 02:53:23 -0800309 const char* kind);
hbos09bc1282016-11-08 06:29:22 -0800310 RTCMediaStreamTrackStats(const RTCMediaStreamTrackStats& other);
311 ~RTCMediaStreamTrackStats() override;
312
313 RTCStatsMember<std::string> track_identifier;
Henrik Boström646fda02019-05-22 15:49:42 +0200314 RTCStatsMember<std::string> media_source_id;
hbos09bc1282016-11-08 06:29:22 -0800315 RTCStatsMember<bool> remote_source;
316 RTCStatsMember<bool> ended;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200317 // TODO(https://crbug.com/webrtc/14173): Remove this obsolete metric.
hbos09bc1282016-11-08 06:29:22 -0800318 RTCStatsMember<bool> detached;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200319 // Enum type RTCMediaStreamTrackKind.
hbos160e4a72017-01-17 02:53:23 -0800320 RTCStatsMember<std::string> kind;
Gustaf Ullbergb0a02072017-10-02 12:00:34 +0200321 RTCStatsMember<double> jitter_buffer_delay;
Chen Xing0acffb52019-01-15 15:46:29 +0100322 RTCStatsMember<uint64_t> jitter_buffer_emitted_count;
hbos09bc1282016-11-08 06:29:22 -0800323 // Video-only members
324 RTCStatsMember<uint32_t> frame_width;
325 RTCStatsMember<uint32_t> frame_height;
hbos09bc1282016-11-08 06:29:22 -0800326 RTCStatsMember<uint32_t> frames_sent;
Ilya Nikolaevskiy70473fc2018-02-28 16:35:03 +0100327 RTCStatsMember<uint32_t> huge_frames_sent;
hbos09bc1282016-11-08 06:29:22 -0800328 RTCStatsMember<uint32_t> frames_received;
hbos09bc1282016-11-08 06:29:22 -0800329 RTCStatsMember<uint32_t> frames_decoded;
hbos09bc1282016-11-08 06:29:22 -0800330 RTCStatsMember<uint32_t> frames_dropped;
hbos09bc1282016-11-08 06:29:22 -0800331 // Audio-only members
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200332 RTCStatsMember<double> audio_level; // Receive-only
333 RTCStatsMember<double> total_audio_energy; // Receive-only
hbos09bc1282016-11-08 06:29:22 -0800334 RTCStatsMember<double> echo_return_loss;
335 RTCStatsMember<double> echo_return_loss_enhancement;
Steve Anton2dbc69f2017-08-24 17:15:13 -0700336 RTCStatsMember<uint64_t> total_samples_received;
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200337 RTCStatsMember<double> total_samples_duration; // Receive-only
Steve Anton2dbc69f2017-08-24 17:15:13 -0700338 RTCStatsMember<uint64_t> concealed_samples;
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200339 RTCStatsMember<uint64_t> silent_concealed_samples;
Gustaf Ullberg9a2e9062017-09-18 09:28:20 +0200340 RTCStatsMember<uint64_t> concealment_events;
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200341 RTCStatsMember<uint64_t> inserted_samples_for_deceleration;
342 RTCStatsMember<uint64_t> removed_samples_for_acceleration;
Ruslan Burakov8af88962018-11-22 17:21:10 +0100343 // Non-standard audio-only member
Henrik Boström2843bbc2022-06-13 10:23:28 +0200344 // https://w3c.github.io/webrtc-provisional-stats/#dom-rtcaudioreceiverstats-jitterbufferflushes
Ruslan Burakov8af88962018-11-22 17:21:10 +0100345 RTCNonStandardStatsMember<uint64_t> jitter_buffer_flushes;
Jakob Ivarsson352ce5c2018-11-27 12:52:16 +0100346 RTCNonStandardStatsMember<uint64_t> delayed_packet_outage_samples;
Jakob Ivarsson232b3fd2019-03-06 09:18:40 +0100347 RTCNonStandardStatsMember<double> relative_packet_arrival_delay;
Artem Titove618cc92020-03-11 11:18:54 +0100348 // Non-standard metric showing target delay of jitter buffer.
349 // This value is increased by the target jitter buffer delay every time a
350 // sample is emitted by the jitter buffer. The added target is the target
351 // delay, in seconds, at the time that the sample was emitted from the jitter
352 // buffer. (https://github.com/w3c/webrtc-provisional-stats/pull/20)
353 // Currently it is implemented only for audio.
Henrik Boström2843bbc2022-06-13 10:23:28 +0200354 // TODO(https://crbug.com/webrtc/14176): This should be moved to
355 // RTCInboundRtpStreamStats and it should be implemented for video as well.
Artem Titove618cc92020-03-11 11:18:54 +0100356 RTCNonStandardStatsMember<double> jitter_buffer_target_delay;
Henrik Lundin44125fa2019-04-29 17:00:46 +0200357 // TODO(henrik.lundin): Add description of the interruption metrics at
Henrik Boström2843bbc2022-06-13 10:23:28 +0200358 // https://github.com/w3c/webrtc-provisional-stats/issues/17
Henrik Lundin44125fa2019-04-29 17:00:46 +0200359 RTCNonStandardStatsMember<uint32_t> interruption_count;
360 RTCNonStandardStatsMember<double> total_interruption_duration;
Sergey Silkin02371062019-01-31 16:45:42 +0100361 // Non-standard video-only members.
Henrik Boström2843bbc2022-06-13 10:23:28 +0200362 // https://w3c.github.io/webrtc-provisional-stats/#dom-rtcvideoreceiverstats
Sergey Silkin02371062019-01-31 16:45:42 +0100363 RTCNonStandardStatsMember<uint32_t> freeze_count;
364 RTCNonStandardStatsMember<uint32_t> pause_count;
365 RTCNonStandardStatsMember<double> total_freezes_duration;
366 RTCNonStandardStatsMember<double> total_pauses_duration;
367 RTCNonStandardStatsMember<double> total_frames_duration;
368 RTCNonStandardStatsMember<double> sum_squared_frame_durations;
hbos09bc1282016-11-08 06:29:22 -0800369};
370
hbos6ab97ce2016-10-03 14:16:56 -0700371// https://w3c.github.io/webrtc-stats/#pcstats-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200372class RTC_EXPORT RTCPeerConnectionStats final : public RTCStats {
hbosd565b732016-08-30 14:04:35 -0700373 public:
hbosfc5e0502016-10-06 02:06:10 -0700374 WEBRTC_RTCSTATS_DECL();
375
hbos0e6758d2016-08-31 07:57:36 -0700376 RTCPeerConnectionStats(const std::string& id, int64_t timestamp_us);
377 RTCPeerConnectionStats(std::string&& id, int64_t timestamp_us);
hbosfc5e0502016-10-06 02:06:10 -0700378 RTCPeerConnectionStats(const RTCPeerConnectionStats& other);
379 ~RTCPeerConnectionStats() override;
hbosd565b732016-08-30 14:04:35 -0700380
381 RTCStatsMember<uint32_t> data_channels_opened;
382 RTCStatsMember<uint32_t> data_channels_closed;
383};
384
hbos6ded1902016-11-01 01:50:46 -0700385// https://w3c.github.io/webrtc-stats/#streamstats-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200386class RTC_EXPORT RTCRTPStreamStats : public RTCStats {
hbos6ded1902016-11-01 01:50:46 -0700387 public:
388 WEBRTC_RTCSTATS_DECL();
389
390 RTCRTPStreamStats(const RTCRTPStreamStats& other);
391 ~RTCRTPStreamStats() override;
392
hbos3443bb72017-02-07 06:28:11 -0800393 RTCStatsMember<uint32_t> ssrc;
Philipp Hancke3bc01662018-08-28 14:55:03 +0200394 RTCStatsMember<std::string> kind;
Di Wuef036cd2021-03-19 08:24:41 -0700395 // Obsolete: track_id
hbosb0ae9202017-01-27 06:35:16 -0800396 RTCStatsMember<std::string> track_id;
hbos6ded1902016-11-01 01:50:46 -0700397 RTCStatsMember<std::string> transport_id;
hbos6ded1902016-11-01 01:50:46 -0700398 RTCStatsMember<std::string> codec_id;
Di Wufd1e9d12021-03-09 09:25:28 -0800399
400 // Obsolete
401 RTCStatsMember<std::string> media_type; // renamed to kind.
hbos6ded1902016-11-01 01:50:46 -0700402
403 protected:
404 RTCRTPStreamStats(const std::string& id, int64_t timestamp_us);
405 RTCRTPStreamStats(std::string&& id, int64_t timestamp_us);
406};
407
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100408// https://www.w3.org/TR/webrtc-stats/#receivedrtpstats-dict*
Di Wufd1e9d12021-03-09 09:25:28 -0800409class RTC_EXPORT RTCReceivedRtpStreamStats : public RTCRTPStreamStats {
410 public:
411 WEBRTC_RTCSTATS_DECL();
412
413 RTCReceivedRtpStreamStats(const RTCReceivedRtpStreamStats& other);
414 ~RTCReceivedRtpStreamStats() override;
415
Di Wufd1e9d12021-03-09 09:25:28 -0800416 RTCStatsMember<double> jitter;
417 RTCStatsMember<int32_t> packets_lost; // Signed per RFC 3550
Minyue Li28a2c632021-07-07 15:53:38 +0200418 RTCStatsMember<uint64_t> packets_discarded;
Di Wufd1e9d12021-03-09 09:25:28 -0800419
420 protected:
421 RTCReceivedRtpStreamStats(const std::string&& id, int64_t timestamp_us);
422 RTCReceivedRtpStreamStats(std::string&& id, int64_t timestamp_us);
423};
424
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100425// https://www.w3.org/TR/webrtc-stats/#sentrtpstats-dict*
426class RTC_EXPORT RTCSentRtpStreamStats : public RTCRTPStreamStats {
427 public:
428 WEBRTC_RTCSTATS_DECL();
429
430 RTCSentRtpStreamStats(const RTCSentRtpStreamStats& other);
431 ~RTCSentRtpStreamStats() override;
432
433 RTCStatsMember<uint32_t> packets_sent;
434 RTCStatsMember<uint64_t> bytes_sent;
435
436 protected:
437 RTCSentRtpStreamStats(const std::string&& id, int64_t timestamp_us);
438 RTCSentRtpStreamStats(std::string&& id, int64_t timestamp_us);
439};
440
hboseeafe942016-11-01 03:00:17 -0700441// https://w3c.github.io/webrtc-stats/#inboundrtpstats-dict*
Di Wufd1e9d12021-03-09 09:25:28 -0800442class RTC_EXPORT RTCInboundRTPStreamStats final
443 : public RTCReceivedRtpStreamStats {
hboseeafe942016-11-01 03:00:17 -0700444 public:
445 WEBRTC_RTCSTATS_DECL();
446
447 RTCInboundRTPStreamStats(const std::string& id, int64_t timestamp_us);
448 RTCInboundRTPStreamStats(std::string&& id, int64_t timestamp_us);
449 RTCInboundRTPStreamStats(const RTCInboundRTPStreamStats& other);
450 ~RTCInboundRTPStreamStats() override;
451
Henrik Boström2843bbc2022-06-13 10:23:28 +0200452 // TODO(https://crbug.com/webrtc/14174): Implement trackIdentifier and kind.
453
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100454 RTCStatsMember<std::string> remote_id;
hboseeafe942016-11-01 03:00:17 -0700455 RTCStatsMember<uint32_t> packets_received;
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200456 RTCStatsMember<uint64_t> fec_packets_received;
457 RTCStatsMember<uint64_t> fec_packets_discarded;
hboseeafe942016-11-01 03:00:17 -0700458 RTCStatsMember<uint64_t> bytes_received;
Niels Möllerac0a4cb2019-10-09 15:01:33 +0200459 RTCStatsMember<uint64_t> header_bytes_received;
Henrik Boström01738c62019-04-15 17:32:00 +0200460 RTCStatsMember<double> last_packet_received_timestamp;
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300461 RTCStatsMember<double> jitter_buffer_delay;
462 RTCStatsMember<uint64_t> jitter_buffer_emitted_count;
463 RTCStatsMember<uint64_t> total_samples_received;
464 RTCStatsMember<uint64_t> concealed_samples;
465 RTCStatsMember<uint64_t> silent_concealed_samples;
466 RTCStatsMember<uint64_t> concealment_events;
467 RTCStatsMember<uint64_t> inserted_samples_for_deceleration;
468 RTCStatsMember<uint64_t> removed_samples_for_acceleration;
469 RTCStatsMember<double> audio_level;
470 RTCStatsMember<double> total_audio_energy;
471 RTCStatsMember<double> total_samples_duration;
Philipp Hanckea16a6a62022-04-25 12:21:30 +0200472 // Stats below are only implemented or defined for video.
473 RTCStatsMember<int32_t> frames_received;
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300474 RTCStatsMember<uint32_t> frame_width;
475 RTCStatsMember<uint32_t> frame_height;
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300476 RTCStatsMember<double> frames_per_second;
hbos6769c492017-01-02 08:35:13 -0800477 RTCStatsMember<uint32_t> frames_decoded;
Rasmus Brandt2efae772019-06-27 14:29:34 +0200478 RTCStatsMember<uint32_t> key_frames_decoded;
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300479 RTCStatsMember<uint32_t> frames_dropped;
Johannes Kronbfd343b2019-07-01 10:07:50 +0200480 RTCStatsMember<double> total_decode_time;
Philipp Hanckea16a6a62022-04-25 12:21:30 +0200481 RTCStatsMember<double> total_processing_delay;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200482 // TODO(https://crbug.com/webrtc/13986): standardize
Philipp Hancke0359ba22022-05-05 15:55:36 +0200483 RTCNonStandardStatsMember<double> total_assembly_time;
484 RTCNonStandardStatsMember<uint32_t> frames_assembled_from_multiple_packets;
Johannes Kron00376e12019-11-25 10:25:42 +0100485 RTCStatsMember<double> total_inter_frame_delay;
486 RTCStatsMember<double> total_squared_inter_frame_delay;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200487 // https://w3c.github.io/webrtc-provisional-stats/#dom-rtcinboundrtpstreamstats-contenttype
Henrik Boström2e069262019-04-09 13:59:31 +0200488 RTCStatsMember<std::string> content_type;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200489 // Only populated if audio/video sync is enabled.
490 // TODO(https://crbug.com/webrtc/14177): Expose even if A/V sync is off?
Åsa Perssonfcf79cc2019-10-22 15:23:44 +0200491 RTCStatsMember<double> estimated_playout_timestamp;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200492 // Only implemented for video.
493 // TODO(https://crbug.com/webrtc/14178): Also implement for audio.
Henrik Boström6b430862019-08-16 13:09:51 +0200494 RTCStatsMember<std::string> decoder_implementation;
Philipp Hanckea3b5c4e2022-04-22 15:09:54 +0200495 // FIR and PLI counts are only defined for |kind == "video"|.
Di Wufd1e9d12021-03-09 09:25:28 -0800496 RTCStatsMember<uint32_t> fir_count;
497 RTCStatsMember<uint32_t> pli_count;
Di Wufd1e9d12021-03-09 09:25:28 -0800498 RTCStatsMember<uint32_t> nack_count;
499 RTCStatsMember<uint64_t> qp_sum;
Philipp Hancke6fb8d1a2022-05-30 12:37:04 +0200500
501 // The former googMinPlayoutDelayMs (in seconds).
502 RTCNonStandardStatsMember<double> min_playout_delay;
hboseeafe942016-11-01 03:00:17 -0700503};
504
hbos6ded1902016-11-01 01:50:46 -0700505// https://w3c.github.io/webrtc-stats/#outboundrtpstats-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200506class RTC_EXPORT RTCOutboundRTPStreamStats final : public RTCRTPStreamStats {
hbos6ded1902016-11-01 01:50:46 -0700507 public:
508 WEBRTC_RTCSTATS_DECL();
509
510 RTCOutboundRTPStreamStats(const std::string& id, int64_t timestamp_us);
511 RTCOutboundRTPStreamStats(std::string&& id, int64_t timestamp_us);
512 RTCOutboundRTPStreamStats(const RTCOutboundRTPStreamStats& other);
513 ~RTCOutboundRTPStreamStats() override;
514
Henrik Boström646fda02019-05-22 15:49:42 +0200515 RTCStatsMember<std::string> media_source_id;
Henrik Boström4f40fa52019-12-19 13:27:27 +0100516 RTCStatsMember<std::string> remote_id;
Henrik Boströma0ff50c2020-05-05 15:54:46 +0200517 RTCStatsMember<std::string> rid;
hbos6ded1902016-11-01 01:50:46 -0700518 RTCStatsMember<uint32_t> packets_sent;
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200519 RTCStatsMember<uint64_t> retransmitted_packets_sent;
hbos6ded1902016-11-01 01:50:46 -0700520 RTCStatsMember<uint64_t> bytes_sent;
Niels Möllerac0a4cb2019-10-09 15:01:33 +0200521 RTCStatsMember<uint64_t> header_bytes_sent;
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200522 RTCStatsMember<uint64_t> retransmitted_bytes_sent;
Jakob Ivarssonbf087452021-11-11 13:43:49 +0100523 // TODO(https://crbug.com/webrtc/13394): Also collect this metric for video.
hbos6ded1902016-11-01 01:50:46 -0700524 RTCStatsMember<double> target_bitrate;
hbos6769c492017-01-02 08:35:13 -0800525 RTCStatsMember<uint32_t> frames_encoded;
Rasmus Brandt2efae772019-06-27 14:29:34 +0200526 RTCStatsMember<uint32_t> key_frames_encoded;
Henrik Boströmf71362f2019-04-08 16:14:23 +0200527 RTCStatsMember<double> total_encode_time;
Henrik Boström23aff9b2019-05-20 15:15:38 +0200528 RTCStatsMember<uint64_t> total_encoded_bytes_target;
Henrik Boströma0ff50c2020-05-05 15:54:46 +0200529 RTCStatsMember<uint32_t> frame_width;
530 RTCStatsMember<uint32_t> frame_height;
531 RTCStatsMember<double> frames_per_second;
532 RTCStatsMember<uint32_t> frames_sent;
533 RTCStatsMember<uint32_t> huge_frames_sent;
Henrik Boström9fe18342019-05-16 18:38:20 +0200534 // TODO(https://crbug.com/webrtc/10635): This is only implemented for video;
535 // implement it for audio as well.
536 RTCStatsMember<double> total_packet_send_delay;
Henrik Boströmce33b6a2019-05-28 17:42:38 +0200537 // Enum type RTCQualityLimitationReason
Henrik Boströmce33b6a2019-05-28 17:42:38 +0200538 RTCStatsMember<std::string> quality_limitation_reason;
Byoungchan Lee7d235352021-05-28 21:32:04 +0900539 RTCStatsMember<std::map<std::string, double>> quality_limitation_durations;
Evan Shrubsolecc62b162019-09-09 11:26:45 +0200540 // https://w3c.github.io/webrtc-stats/#dom-rtcoutboundrtpstreamstats-qualitylimitationresolutionchanges
541 RTCStatsMember<uint32_t> quality_limitation_resolution_changes;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200542 // https://w3c.github.io/webrtc-provisional-stats/#dom-rtcoutboundrtpstreamstats-contenttype
Henrik Boström2e069262019-04-09 13:59:31 +0200543 RTCStatsMember<std::string> content_type;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200544 // Only implemented for video.
545 // TODO(https://crbug.com/webrtc/14178): Implement for audio as well.
Henrik Boström6b430862019-08-16 13:09:51 +0200546 RTCStatsMember<std::string> encoder_implementation;
Philipp Hanckea3b5c4e2022-04-22 15:09:54 +0200547 // FIR and PLI counts are only defined for |kind == "video"|.
Di Wufd1e9d12021-03-09 09:25:28 -0800548 RTCStatsMember<uint32_t> fir_count;
549 RTCStatsMember<uint32_t> pli_count;
Di Wufd1e9d12021-03-09 09:25:28 -0800550 RTCStatsMember<uint32_t> nack_count;
551 RTCStatsMember<uint64_t> qp_sum;
hbos6ded1902016-11-01 01:50:46 -0700552};
553
Henrik Boström883eefc2019-05-27 13:40:25 +0200554// https://w3c.github.io/webrtc-stats/#remoteinboundrtpstats-dict*
Di Wufd1e9d12021-03-09 09:25:28 -0800555class RTC_EXPORT RTCRemoteInboundRtpStreamStats final
556 : public RTCReceivedRtpStreamStats {
Henrik Boström883eefc2019-05-27 13:40:25 +0200557 public:
558 WEBRTC_RTCSTATS_DECL();
559
560 RTCRemoteInboundRtpStreamStats(const std::string& id, int64_t timestamp_us);
561 RTCRemoteInboundRtpStreamStats(std::string&& id, int64_t timestamp_us);
562 RTCRemoteInboundRtpStreamStats(const RTCRemoteInboundRtpStreamStats& other);
563 ~RTCRemoteInboundRtpStreamStats() override;
564
Henrik Boström883eefc2019-05-27 13:40:25 +0200565 RTCStatsMember<std::string> local_id;
566 RTCStatsMember<double> round_trip_time;
Di Wu86f04ad2021-02-28 23:36:03 -0800567 RTCStatsMember<double> fraction_lost;
Di Wu88a51b22021-03-01 11:22:06 -0800568 RTCStatsMember<double> total_round_trip_time;
569 RTCStatsMember<int32_t> round_trip_time_measurements;
Henrik Boström883eefc2019-05-27 13:40:25 +0200570};
571
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100572// https://w3c.github.io/webrtc-stats/#remoteoutboundrtpstats-dict*
573class RTC_EXPORT RTCRemoteOutboundRtpStreamStats final
574 : public RTCSentRtpStreamStats {
575 public:
576 WEBRTC_RTCSTATS_DECL();
577
578 RTCRemoteOutboundRtpStreamStats(const std::string& id, int64_t timestamp_us);
579 RTCRemoteOutboundRtpStreamStats(std::string&& id, int64_t timestamp_us);
580 RTCRemoteOutboundRtpStreamStats(const RTCRemoteOutboundRtpStreamStats& other);
581 ~RTCRemoteOutboundRtpStreamStats() override;
582
583 RTCStatsMember<std::string> local_id;
584 RTCStatsMember<double> remote_timestamp;
585 RTCStatsMember<uint64_t> reports_sent;
Ivo Creusen2562cf02021-09-03 14:51:22 +0000586 RTCStatsMember<double> round_trip_time;
587 RTCStatsMember<uint64_t> round_trip_time_measurements;
588 RTCStatsMember<double> total_round_trip_time;
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100589};
590
Henrik Boström646fda02019-05-22 15:49:42 +0200591// https://w3c.github.io/webrtc-stats/#dom-rtcmediasourcestats
592class RTC_EXPORT RTCMediaSourceStats : public RTCStats {
593 public:
594 WEBRTC_RTCSTATS_DECL();
595
596 RTCMediaSourceStats(const RTCMediaSourceStats& other);
597 ~RTCMediaSourceStats() override;
598
599 RTCStatsMember<std::string> track_identifier;
600 RTCStatsMember<std::string> kind;
601
602 protected:
603 RTCMediaSourceStats(const std::string& id, int64_t timestamp_us);
604 RTCMediaSourceStats(std::string&& id, int64_t timestamp_us);
605};
606
607// https://w3c.github.io/webrtc-stats/#dom-rtcaudiosourcestats
608class RTC_EXPORT RTCAudioSourceStats final : public RTCMediaSourceStats {
609 public:
610 WEBRTC_RTCSTATS_DECL();
611
612 RTCAudioSourceStats(const std::string& id, int64_t timestamp_us);
613 RTCAudioSourceStats(std::string&& id, int64_t timestamp_us);
614 RTCAudioSourceStats(const RTCAudioSourceStats& other);
615 ~RTCAudioSourceStats() override;
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200616
617 RTCStatsMember<double> audio_level;
618 RTCStatsMember<double> total_audio_energy;
619 RTCStatsMember<double> total_samples_duration;
Taylor Brandstetter64851c02021-06-24 13:32:50 -0700620 RTCStatsMember<double> echo_return_loss;
621 RTCStatsMember<double> echo_return_loss_enhancement;
Henrik Boström646fda02019-05-22 15:49:42 +0200622};
623
624// https://w3c.github.io/webrtc-stats/#dom-rtcvideosourcestats
625class RTC_EXPORT RTCVideoSourceStats final : public RTCMediaSourceStats {
626 public:
627 WEBRTC_RTCSTATS_DECL();
628
629 RTCVideoSourceStats(const std::string& id, int64_t timestamp_us);
630 RTCVideoSourceStats(std::string&& id, int64_t timestamp_us);
631 RTCVideoSourceStats(const RTCVideoSourceStats& other);
632 ~RTCVideoSourceStats() override;
633
634 RTCStatsMember<uint32_t> width;
635 RTCStatsMember<uint32_t> height;
Henrik Boström646fda02019-05-22 15:49:42 +0200636 RTCStatsMember<uint32_t> frames;
Byoungchan Leeefe46b62021-11-10 11:23:56 +0900637 RTCStatsMember<double> frames_per_second;
Henrik Boström646fda02019-05-22 15:49:42 +0200638};
639
hbos2fa7c672016-10-24 04:00:05 -0700640// https://w3c.github.io/webrtc-stats/#transportstats-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200641class RTC_EXPORT RTCTransportStats final : public RTCStats {
hbos2fa7c672016-10-24 04:00:05 -0700642 public:
643 WEBRTC_RTCSTATS_DECL();
644
645 RTCTransportStats(const std::string& id, int64_t timestamp_us);
646 RTCTransportStats(std::string&& id, int64_t timestamp_us);
647 RTCTransportStats(const RTCTransportStats& other);
648 ~RTCTransportStats() override;
649
650 RTCStatsMember<uint64_t> bytes_sent;
Artem Titovedacbd52020-07-06 16:06:37 +0200651 RTCStatsMember<uint64_t> packets_sent;
hbos2fa7c672016-10-24 04:00:05 -0700652 RTCStatsMember<uint64_t> bytes_received;
Artem Titovedacbd52020-07-06 16:06:37 +0200653 RTCStatsMember<uint64_t> packets_received;
hbos2fa7c672016-10-24 04:00:05 -0700654 RTCStatsMember<std::string> rtcp_transport_stats_id;
Henrik Boström2843bbc2022-06-13 10:23:28 +0200655 // Enum type RTCDtlsTransportState.
hbos7064d592017-01-16 07:38:02 -0800656 RTCStatsMember<std::string> dtls_state;
hbos2fa7c672016-10-24 04:00:05 -0700657 RTCStatsMember<std::string> selected_candidate_pair_id;
658 RTCStatsMember<std::string> local_certificate_id;
659 RTCStatsMember<std::string> remote_certificate_id;
Harald Alvestrand5cb78072019-10-28 09:51:17 +0100660 RTCStatsMember<std::string> tls_version;
661 RTCStatsMember<std::string> dtls_cipher;
Philipp Hancke69c1df22022-04-22 15:46:24 +0200662 RTCStatsMember<std::string> dtls_role;
Harald Alvestrand5cb78072019-10-28 09:51:17 +0100663 RTCStatsMember<std::string> srtp_cipher;
Jonas Oreland149dc722019-08-28 08:10:27 +0200664 RTCStatsMember<uint32_t> selected_candidate_pair_changes;
Philipp Hanckecc1b9b02022-05-04 18:58:26 +0200665 RTCStatsMember<std::string> ice_role;
Philipp Hancke95b1a342022-05-05 07:53:54 +0200666 RTCStatsMember<std::string> ice_local_username_fragment;
Philipp Hancke1f491572022-05-09 17:43:31 +0200667 RTCStatsMember<std::string> ice_state;
hbos2fa7c672016-10-24 04:00:05 -0700668};
669
hbosd565b732016-08-30 14:04:35 -0700670} // namespace webrtc
671
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200672#endif // API_STATS_RTCSTATS_OBJECTS_H_