blob: f26c574e5b61a909843de6c2df902ceb24472f29 [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
Henrik Boström1df1bf82018-03-20 13:24:20 +010016#include <memory>
hbosd565b732016-08-30 14:04:35 -070017#include <string>
oprypin803dc292017-02-01 01:55:59 -080018#include <vector>
hbosd565b732016-08-30 14:04:35 -070019
Steve Anton10542f22019-01-11 09:11:00 -080020#include "api/stats/rtc_stats.h"
Mirko Bonadei276827c2018-10-16 14:13:50 +020021#include "rtc_base/system/rtc_export.h"
hbosd565b732016-08-30 14:04:35 -070022
23namespace webrtc {
24
hboscc555c52016-10-18 12:48:31 -070025// https://w3c.github.io/webrtc-pc/#idl-def-rtcdatachannelstate
26struct RTCDataChannelState {
agrieve26622d32017-08-08 10:48:15 -070027 static const char* const kConnecting;
28 static const char* const kOpen;
29 static const char* const kClosing;
30 static const char* const kClosed;
hboscc555c52016-10-18 12:48:31 -070031};
32
hbosc47a0c32016-10-11 14:54:49 -070033// https://w3c.github.io/webrtc-stats/#dom-rtcstatsicecandidatepairstate
34struct RTCStatsIceCandidatePairState {
agrieve26622d32017-08-08 10:48:15 -070035 static const char* const kFrozen;
36 static const char* const kWaiting;
37 static const char* const kInProgress;
38 static const char* const kFailed;
39 static const char* const kSucceeded;
hbosc47a0c32016-10-11 14:54:49 -070040};
41
hboscc555c52016-10-18 12:48:31 -070042// https://w3c.github.io/webrtc-pc/#rtcicecandidatetype-enum
hbosab9f6e42016-10-07 02:18:47 -070043struct RTCIceCandidateType {
agrieve26622d32017-08-08 10:48:15 -070044 static const char* const kHost;
45 static const char* const kSrflx;
46 static const char* const kPrflx;
47 static const char* const kRelay;
hbosab9f6e42016-10-07 02:18:47 -070048};
49
hbos7064d592017-01-16 07:38:02 -080050// https://w3c.github.io/webrtc-pc/#idl-def-rtcdtlstransportstate
51struct RTCDtlsTransportState {
agrieve26622d32017-08-08 10:48:15 -070052 static const char* const kNew;
53 static const char* const kConnecting;
54 static const char* const kConnected;
55 static const char* const kClosed;
56 static const char* const kFailed;
hbos7064d592017-01-16 07:38:02 -080057};
58
hbos160e4a72017-01-17 02:53:23 -080059// |RTCMediaStreamTrackStats::kind| is not an enum in the spec but the only
60// valid values are "audio" and "video".
61// https://w3c.github.io/webrtc-stats/#dom-rtcmediastreamtrackstats-kind
62struct RTCMediaStreamTrackKind {
agrieve26622d32017-08-08 10:48:15 -070063 static const char* const kAudio;
64 static const char* const kVideo;
hbos160e4a72017-01-17 02:53:23 -080065};
66
Gary Liu37e489c2017-11-21 10:49:36 -080067// https://w3c.github.io/webrtc-stats/#dom-rtcnetworktype
68struct RTCNetworkType {
69 static const char* const kBluetooth;
70 static const char* const kCellular;
71 static const char* const kEthernet;
72 static const char* const kWifi;
73 static const char* const kWimax;
74 static const char* const kVpn;
75 static const char* const kUnknown;
76};
77
Henrik Boströmce33b6a2019-05-28 17:42:38 +020078// https://w3c.github.io/webrtc-stats/#dom-rtcqualitylimitationreason
79struct RTCQualityLimitationReason {
80 static const char* const kNone;
81 static const char* const kCpu;
82 static const char* const kBandwidth;
83 static const char* const kOther;
84};
85
Henrik Boström2e069262019-04-09 13:59:31 +020086// https://webrtc.org/experiments/rtp-hdrext/video-content-type/
87struct RTCContentType {
88 static const char* const kUnspecified;
89 static const char* const kScreenshare;
90};
91
hbos2fa7c672016-10-24 04:00:05 -070092// https://w3c.github.io/webrtc-stats/#certificatestats-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +020093class RTC_EXPORT RTCCertificateStats final : public RTCStats {
hbos2fa7c672016-10-24 04:00:05 -070094 public:
95 WEBRTC_RTCSTATS_DECL();
96
97 RTCCertificateStats(const std::string& id, int64_t timestamp_us);
98 RTCCertificateStats(std::string&& id, int64_t timestamp_us);
99 RTCCertificateStats(const RTCCertificateStats& other);
100 ~RTCCertificateStats() override;
101
102 RTCStatsMember<std::string> fingerprint;
103 RTCStatsMember<std::string> fingerprint_algorithm;
104 RTCStatsMember<std::string> base64_certificate;
105 RTCStatsMember<std::string> issuer_certificate_id;
106};
107
hbos0adb8282016-11-23 02:32:06 -0800108// https://w3c.github.io/webrtc-stats/#codec-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200109class RTC_EXPORT RTCCodecStats final : public RTCStats {
hbos0adb8282016-11-23 02:32:06 -0800110 public:
111 WEBRTC_RTCSTATS_DECL();
112
113 RTCCodecStats(const std::string& id, int64_t timestamp_us);
114 RTCCodecStats(std::string&& id, int64_t timestamp_us);
115 RTCCodecStats(const RTCCodecStats& other);
116 ~RTCCodecStats() override;
117
118 RTCStatsMember<uint32_t> payload_type;
hbos13f54b22017-02-28 06:56:04 -0800119 RTCStatsMember<std::string> mime_type;
hbos0adb8282016-11-23 02:32:06 -0800120 RTCStatsMember<uint32_t> clock_rate;
hbos585a9b12017-02-07 04:59:16 -0800121 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7061
hbos0adb8282016-11-23 02:32:06 -0800122 RTCStatsMember<uint32_t> channels;
hbos585a9b12017-02-07 04:59:16 -0800123 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7061
hbos13f54b22017-02-28 06:56:04 -0800124 RTCStatsMember<std::string> sdp_fmtp_line;
hbos0adb8282016-11-23 02:32:06 -0800125};
126
hbos2fa7c672016-10-24 04:00:05 -0700127// https://w3c.github.io/webrtc-stats/#dcstats-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200128class RTC_EXPORT RTCDataChannelStats final : public RTCStats {
hbos2fa7c672016-10-24 04:00:05 -0700129 public:
130 WEBRTC_RTCSTATS_DECL();
131
132 RTCDataChannelStats(const std::string& id, int64_t timestamp_us);
133 RTCDataChannelStats(std::string&& id, int64_t timestamp_us);
134 RTCDataChannelStats(const RTCDataChannelStats& other);
135 ~RTCDataChannelStats() override;
136
137 RTCStatsMember<std::string> label;
138 RTCStatsMember<std::string> protocol;
139 RTCStatsMember<int32_t> datachannelid;
140 // TODO(hbos): Support enum types? "RTCStatsMember<RTCDataChannelState>"?
141 RTCStatsMember<std::string> state;
142 RTCStatsMember<uint32_t> messages_sent;
143 RTCStatsMember<uint64_t> bytes_sent;
144 RTCStatsMember<uint32_t> messages_received;
145 RTCStatsMember<uint64_t> bytes_received;
146};
147
148// https://w3c.github.io/webrtc-stats/#candidatepair-dict*
hbos338f78a2017-02-07 06:41:21 -0800149// TODO(hbos): Tracking bug https://bugs.webrtc.org/7062
Mirko Bonadei276827c2018-10-16 14:13:50 +0200150class RTC_EXPORT RTCIceCandidatePairStats final : public RTCStats {
hbosc47a0c32016-10-11 14:54:49 -0700151 public:
152 WEBRTC_RTCSTATS_DECL();
153
154 RTCIceCandidatePairStats(const std::string& id, int64_t timestamp_us);
155 RTCIceCandidatePairStats(std::string&& id, int64_t timestamp_us);
156 RTCIceCandidatePairStats(const RTCIceCandidatePairStats& other);
157 ~RTCIceCandidatePairStats() override;
158
159 RTCStatsMember<std::string> transport_id;
160 RTCStatsMember<std::string> local_candidate_id;
161 RTCStatsMember<std::string> remote_candidate_id;
162 // TODO(hbos): Support enum types?
163 // "RTCStatsMember<RTCStatsIceCandidatePairState>"?
164 RTCStatsMember<std::string> state;
165 RTCStatsMember<uint64_t> priority;
166 RTCStatsMember<bool> nominated;
hbos338f78a2017-02-07 06:41:21 -0800167 // TODO(hbos): Collect this the way the spec describes it. We have a value for
168 // it but it is not spec-compliant. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700169 RTCStatsMember<bool> writable;
hbos338f78a2017-02-07 06:41:21 -0800170 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700171 RTCStatsMember<bool> readable;
172 RTCStatsMember<uint64_t> bytes_sent;
173 RTCStatsMember<uint64_t> bytes_received;
hbos3168c7a2016-12-15 06:17:08 -0800174 RTCStatsMember<double> total_round_trip_time;
hbos3168c7a2016-12-15 06:17:08 -0800175 RTCStatsMember<double> current_round_trip_time;
hbosc47a0c32016-10-11 14:54:49 -0700176 RTCStatsMember<double> available_outgoing_bitrate;
hbos338f78a2017-02-07 06:41:21 -0800177 // TODO(hbos): Populate this value. It is wired up and collected the same way
hbosbf8d3e52017-02-28 06:34:47 -0800178 // "VideoBwe.googAvailableReceiveBandwidth" is, but that value is always
hbos338f78a2017-02-07 06:41:21 -0800179 // undefined. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700180 RTCStatsMember<double> available_incoming_bitrate;
181 RTCStatsMember<uint64_t> requests_received;
182 RTCStatsMember<uint64_t> requests_sent;
183 RTCStatsMember<uint64_t> responses_received;
184 RTCStatsMember<uint64_t> responses_sent;
hbos338f78a2017-02-07 06:41:21 -0800185 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700186 RTCStatsMember<uint64_t> retransmissions_received;
hbos338f78a2017-02-07 06:41:21 -0800187 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700188 RTCStatsMember<uint64_t> retransmissions_sent;
hbos338f78a2017-02-07 06:41:21 -0800189 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700190 RTCStatsMember<uint64_t> consent_requests_received;
191 RTCStatsMember<uint64_t> consent_requests_sent;
hbos338f78a2017-02-07 06:41:21 -0800192 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700193 RTCStatsMember<uint64_t> consent_responses_received;
hbos338f78a2017-02-07 06:41:21 -0800194 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062
hbosc47a0c32016-10-11 14:54:49 -0700195 RTCStatsMember<uint64_t> consent_responses_sent;
196};
197
hbosab9f6e42016-10-07 02:18:47 -0700198// https://w3c.github.io/webrtc-stats/#icecandidate-dict*
hbos5d79a7c2016-10-24 09:27:10 -0700199// TODO(hbos): |RTCStatsCollector| only collects candidates that are part of
200// ice candidate pairs, but there could be candidates not paired with anything.
201// crbug.com/632723
Qingsi Wang72a43a12018-02-20 16:03:18 -0800202// TODO(qingsi): Add the stats of STUN binding requests (keepalives) and collect
203// them in the new PeerConnection::GetStats.
Mirko Bonadei276827c2018-10-16 14:13:50 +0200204class RTC_EXPORT RTCIceCandidateStats : public RTCStats {
hbosab9f6e42016-10-07 02:18:47 -0700205 public:
206 WEBRTC_RTCSTATS_DECL();
207
208 RTCIceCandidateStats(const RTCIceCandidateStats& other);
209 ~RTCIceCandidateStats() override;
210
hbosb4e426e2017-01-02 09:59:31 -0800211 RTCStatsMember<std::string> transport_id;
hbosc3a2b7f2017-01-02 04:46:15 -0800212 RTCStatsMember<bool> is_remote;
Gary Liu37e489c2017-11-21 10:49:36 -0800213 RTCStatsMember<std::string> network_type;
hbosab9f6e42016-10-07 02:18:47 -0700214 RTCStatsMember<std::string> ip;
215 RTCStatsMember<int32_t> port;
216 RTCStatsMember<std::string> protocol;
Philipp Hancke95513752018-09-27 14:40:08 +0200217 RTCStatsMember<std::string> relay_protocol;
hbosab9f6e42016-10-07 02:18:47 -0700218 // TODO(hbos): Support enum types? "RTCStatsMember<RTCIceCandidateType>"?
219 RTCStatsMember<std::string> candidate_type;
220 RTCStatsMember<int32_t> priority;
hbos5d79a7c2016-10-24 09:27:10 -0700221 // TODO(hbos): Not collected by |RTCStatsCollector|. crbug.com/632723
hbosab9f6e42016-10-07 02:18:47 -0700222 RTCStatsMember<std::string> url;
hbosd17a5a72017-01-02 08:09:59 -0800223 // TODO(hbos): |deleted = true| case is not supported by |RTCStatsCollector|.
224 // crbug.com/632723
225 RTCStatsMember<bool> deleted; // = false
hbosab9f6e42016-10-07 02:18:47 -0700226
227 protected:
Yves Gerey665174f2018-06-19 15:03:05 +0200228 RTCIceCandidateStats(const std::string& id,
229 int64_t timestamp_us,
230 bool is_remote);
hbosc3a2b7f2017-01-02 04:46:15 -0800231 RTCIceCandidateStats(std::string&& id, int64_t timestamp_us, bool is_remote);
hbosab9f6e42016-10-07 02:18:47 -0700232};
233
234// In the spec both local and remote varieties are of type RTCIceCandidateStats.
235// But here we define them as subclasses of |RTCIceCandidateStats| because the
236// |kType| need to be different ("RTCStatsType type") in the local/remote case.
237// https://w3c.github.io/webrtc-stats/#rtcstatstype-str*
Henrik Boström1df1bf82018-03-20 13:24:20 +0100238// This forces us to have to override copy() and type().
Mirko Bonadei276827c2018-10-16 14:13:50 +0200239class RTC_EXPORT RTCLocalIceCandidateStats final : public RTCIceCandidateStats {
hbosab9f6e42016-10-07 02:18:47 -0700240 public:
241 static const char kType[];
242 RTCLocalIceCandidateStats(const std::string& id, int64_t timestamp_us);
243 RTCLocalIceCandidateStats(std::string&& id, int64_t timestamp_us);
Henrik Boström1df1bf82018-03-20 13:24:20 +0100244 std::unique_ptr<RTCStats> copy() const override;
hbosab9f6e42016-10-07 02:18:47 -0700245 const char* type() const override;
246};
247
Mirko Bonadei276827c2018-10-16 14:13:50 +0200248class RTC_EXPORT RTCRemoteIceCandidateStats final
249 : public RTCIceCandidateStats {
hbosab9f6e42016-10-07 02:18:47 -0700250 public:
251 static const char kType[];
252 RTCRemoteIceCandidateStats(const std::string& id, int64_t timestamp_us);
253 RTCRemoteIceCandidateStats(std::string&& id, int64_t timestamp_us);
Henrik Boström1df1bf82018-03-20 13:24:20 +0100254 std::unique_ptr<RTCStats> copy() const override;
hbosab9f6e42016-10-07 02:18:47 -0700255 const char* type() const override;
256};
257
hbos09bc1282016-11-08 06:29:22 -0800258// https://w3c.github.io/webrtc-stats/#msstats-dict*
hbos0adb8282016-11-23 02:32:06 -0800259// TODO(hbos): Tracking bug crbug.com/660827
Mirko Bonadei276827c2018-10-16 14:13:50 +0200260class RTC_EXPORT RTCMediaStreamStats final : public RTCStats {
hbos09bc1282016-11-08 06:29:22 -0800261 public:
262 WEBRTC_RTCSTATS_DECL();
263
264 RTCMediaStreamStats(const std::string& id, int64_t timestamp_us);
265 RTCMediaStreamStats(std::string&& id, int64_t timestamp_us);
266 RTCMediaStreamStats(const RTCMediaStreamStats& other);
267 ~RTCMediaStreamStats() override;
268
269 RTCStatsMember<std::string> stream_identifier;
270 RTCStatsMember<std::vector<std::string>> track_ids;
271};
272
273// https://w3c.github.io/webrtc-stats/#mststats-dict*
hbos0adb8282016-11-23 02:32:06 -0800274// TODO(hbos): Tracking bug crbug.com/659137
Mirko Bonadei276827c2018-10-16 14:13:50 +0200275class RTC_EXPORT RTCMediaStreamTrackStats final : public RTCStats {
hbos09bc1282016-11-08 06:29:22 -0800276 public:
277 WEBRTC_RTCSTATS_DECL();
278
Yves Gerey665174f2018-06-19 15:03:05 +0200279 RTCMediaStreamTrackStats(const std::string& id,
280 int64_t timestamp_us,
hbos160e4a72017-01-17 02:53:23 -0800281 const char* kind);
Yves Gerey665174f2018-06-19 15:03:05 +0200282 RTCMediaStreamTrackStats(std::string&& id,
283 int64_t timestamp_us,
hbos160e4a72017-01-17 02:53:23 -0800284 const char* kind);
hbos09bc1282016-11-08 06:29:22 -0800285 RTCMediaStreamTrackStats(const RTCMediaStreamTrackStats& other);
286 ~RTCMediaStreamTrackStats() override;
287
288 RTCStatsMember<std::string> track_identifier;
Henrik Boström646fda02019-05-22 15:49:42 +0200289 RTCStatsMember<std::string> media_source_id;
hbos09bc1282016-11-08 06:29:22 -0800290 RTCStatsMember<bool> remote_source;
291 RTCStatsMember<bool> ended;
292 // TODO(hbos): |RTCStatsCollector| does not return stats for detached tracks.
293 // crbug.com/659137
294 RTCStatsMember<bool> detached;
hbos160e4a72017-01-17 02:53:23 -0800295 // See |RTCMediaStreamTrackKind| for valid values.
296 RTCStatsMember<std::string> kind;
Gustaf Ullbergb0a02072017-10-02 12:00:34 +0200297 // TODO(gustaf): Implement jitter_buffer_delay for video (currently
298 // implemented for audio only).
299 // https://crbug.com/webrtc/8318
300 RTCStatsMember<double> jitter_buffer_delay;
Chen Xing0acffb52019-01-15 15:46:29 +0100301 RTCStatsMember<uint64_t> jitter_buffer_emitted_count;
hbos09bc1282016-11-08 06:29:22 -0800302 // Video-only members
303 RTCStatsMember<uint32_t> frame_width;
304 RTCStatsMember<uint32_t> frame_height;
305 // TODO(hbos): Not collected by |RTCStatsCollector|. crbug.com/659137
306 RTCStatsMember<double> frames_per_second;
hbos09bc1282016-11-08 06:29:22 -0800307 RTCStatsMember<uint32_t> frames_sent;
Ilya Nikolaevskiy70473fc2018-02-28 16:35:03 +0100308 RTCStatsMember<uint32_t> huge_frames_sent;
hbos09bc1282016-11-08 06:29:22 -0800309 RTCStatsMember<uint32_t> frames_received;
hbos09bc1282016-11-08 06:29:22 -0800310 RTCStatsMember<uint32_t> frames_decoded;
hbos09bc1282016-11-08 06:29:22 -0800311 RTCStatsMember<uint32_t> frames_dropped;
312 // TODO(hbos): Not collected by |RTCStatsCollector|. crbug.com/659137
313 RTCStatsMember<uint32_t> frames_corrupted;
314 // TODO(hbos): Not collected by |RTCStatsCollector|. crbug.com/659137
315 RTCStatsMember<uint32_t> partial_frames_lost;
316 // TODO(hbos): Not collected by |RTCStatsCollector|. crbug.com/659137
317 RTCStatsMember<uint32_t> full_frames_lost;
318 // Audio-only members
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200319 RTCStatsMember<double> audio_level; // Receive-only
320 RTCStatsMember<double> total_audio_energy; // Receive-only
hbos09bc1282016-11-08 06:29:22 -0800321 RTCStatsMember<double> echo_return_loss;
322 RTCStatsMember<double> echo_return_loss_enhancement;
Steve Anton2dbc69f2017-08-24 17:15:13 -0700323 RTCStatsMember<uint64_t> total_samples_received;
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200324 RTCStatsMember<double> total_samples_duration; // Receive-only
Steve Anton2dbc69f2017-08-24 17:15:13 -0700325 RTCStatsMember<uint64_t> concealed_samples;
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200326 RTCStatsMember<uint64_t> silent_concealed_samples;
Gustaf Ullberg9a2e9062017-09-18 09:28:20 +0200327 RTCStatsMember<uint64_t> concealment_events;
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200328 RTCStatsMember<uint64_t> inserted_samples_for_deceleration;
329 RTCStatsMember<uint64_t> removed_samples_for_acceleration;
Ruslan Burakov8af88962018-11-22 17:21:10 +0100330 // Non-standard audio-only member
Jakob Ivarsson352ce5c2018-11-27 12:52:16 +0100331 // TODO(kuddai): Add description to standard. crbug.com/webrtc/10042
Ruslan Burakov8af88962018-11-22 17:21:10 +0100332 RTCNonStandardStatsMember<uint64_t> jitter_buffer_flushes;
Jakob Ivarsson352ce5c2018-11-27 12:52:16 +0100333 RTCNonStandardStatsMember<uint64_t> delayed_packet_outage_samples;
Jakob Ivarsson232b3fd2019-03-06 09:18:40 +0100334 RTCNonStandardStatsMember<double> relative_packet_arrival_delay;
Henrik Lundin44125fa2019-04-29 17:00:46 +0200335 // TODO(henrik.lundin): Add description of the interruption metrics at
336 // https://github.com/henbos/webrtc-provisional-stats/issues/17
337 RTCNonStandardStatsMember<uint32_t> interruption_count;
338 RTCNonStandardStatsMember<double> total_interruption_duration;
Sergey Silkin02371062019-01-31 16:45:42 +0100339 // Non-standard video-only members.
340 // https://henbos.github.io/webrtc-provisional-stats/#RTCVideoReceiverStats-dict*
341 RTCNonStandardStatsMember<uint32_t> freeze_count;
342 RTCNonStandardStatsMember<uint32_t> pause_count;
343 RTCNonStandardStatsMember<double> total_freezes_duration;
344 RTCNonStandardStatsMember<double> total_pauses_duration;
345 RTCNonStandardStatsMember<double> total_frames_duration;
346 RTCNonStandardStatsMember<double> sum_squared_frame_durations;
hbos09bc1282016-11-08 06:29:22 -0800347};
348
hbos6ab97ce2016-10-03 14:16:56 -0700349// https://w3c.github.io/webrtc-stats/#pcstats-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200350class RTC_EXPORT RTCPeerConnectionStats final : public RTCStats {
hbosd565b732016-08-30 14:04:35 -0700351 public:
hbosfc5e0502016-10-06 02:06:10 -0700352 WEBRTC_RTCSTATS_DECL();
353
hbos0e6758d2016-08-31 07:57:36 -0700354 RTCPeerConnectionStats(const std::string& id, int64_t timestamp_us);
355 RTCPeerConnectionStats(std::string&& id, int64_t timestamp_us);
hbosfc5e0502016-10-06 02:06:10 -0700356 RTCPeerConnectionStats(const RTCPeerConnectionStats& other);
357 ~RTCPeerConnectionStats() override;
hbosd565b732016-08-30 14:04:35 -0700358
359 RTCStatsMember<uint32_t> data_channels_opened;
360 RTCStatsMember<uint32_t> data_channels_closed;
361};
362
hbos6ded1902016-11-01 01:50:46 -0700363// https://w3c.github.io/webrtc-stats/#streamstats-dict*
hbos0adb8282016-11-23 02:32:06 -0800364// TODO(hbos): Tracking bug crbug.com/657854
Mirko Bonadei276827c2018-10-16 14:13:50 +0200365class RTC_EXPORT RTCRTPStreamStats : public RTCStats {
hbos6ded1902016-11-01 01:50:46 -0700366 public:
367 WEBRTC_RTCSTATS_DECL();
368
369 RTCRTPStreamStats(const RTCRTPStreamStats& other);
370 ~RTCRTPStreamStats() override;
371
hbos3443bb72017-02-07 06:28:11 -0800372 RTCStatsMember<uint32_t> ssrc;
hbos6ded1902016-11-01 01:50:46 -0700373 // TODO(hbos): When the remote case is supported |RTCStatsCollector| needs to
374 // set this. crbug.com/657855, 657856
375 RTCStatsMember<std::string> associate_stats_id;
376 // TODO(hbos): Remote case not supported by |RTCStatsCollector|.
377 // crbug.com/657855, 657856
Jonas Olssona4d87372019-07-05 19:08:33 +0200378 RTCStatsMember<bool> is_remote; // = false
Philipp Hancke3bc01662018-08-28 14:55:03 +0200379 RTCStatsMember<std::string> media_type; // renamed to kind.
380 RTCStatsMember<std::string> kind;
hbosb0ae9202017-01-27 06:35:16 -0800381 RTCStatsMember<std::string> track_id;
hbos6ded1902016-11-01 01:50:46 -0700382 RTCStatsMember<std::string> transport_id;
hbos6ded1902016-11-01 01:50:46 -0700383 RTCStatsMember<std::string> codec_id;
384 // FIR and PLI counts are only defined for |media_type == "video"|.
385 RTCStatsMember<uint32_t> fir_count;
386 RTCStatsMember<uint32_t> pli_count;
387 // TODO(hbos): NACK count should be collected by |RTCStatsCollector| for both
388 // audio and video but is only defined in the "video" case. crbug.com/657856
389 RTCStatsMember<uint32_t> nack_count;
390 // TODO(hbos): Not collected by |RTCStatsCollector|. crbug.com/657854
391 // SLI count is only defined for |media_type == "video"|.
392 RTCStatsMember<uint32_t> sli_count;
hbos6769c492017-01-02 08:35:13 -0800393 RTCStatsMember<uint64_t> qp_sum;
hbos6ded1902016-11-01 01:50:46 -0700394
395 protected:
396 RTCRTPStreamStats(const std::string& id, int64_t timestamp_us);
397 RTCRTPStreamStats(std::string&& id, int64_t timestamp_us);
398};
399
hboseeafe942016-11-01 03:00:17 -0700400// https://w3c.github.io/webrtc-stats/#inboundrtpstats-dict*
hbosa7a9be12017-03-01 01:02:45 -0800401// TODO(hbos): Support the remote case |is_remote = true|.
402// https://bugs.webrtc.org/7065
Mirko Bonadei276827c2018-10-16 14:13:50 +0200403class RTC_EXPORT RTCInboundRTPStreamStats final : public RTCRTPStreamStats {
hboseeafe942016-11-01 03:00:17 -0700404 public:
405 WEBRTC_RTCSTATS_DECL();
406
407 RTCInboundRTPStreamStats(const std::string& id, int64_t timestamp_us);
408 RTCInboundRTPStreamStats(std::string&& id, int64_t timestamp_us);
409 RTCInboundRTPStreamStats(const RTCInboundRTPStreamStats& other);
410 ~RTCInboundRTPStreamStats() override;
411
412 RTCStatsMember<uint32_t> packets_received;
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200413 RTCStatsMember<uint64_t> fec_packets_received;
414 RTCStatsMember<uint64_t> fec_packets_discarded;
hboseeafe942016-11-01 03:00:17 -0700415 RTCStatsMember<uint64_t> bytes_received;
Niels Möllerac0a4cb2019-10-09 15:01:33 +0200416 RTCStatsMember<uint64_t> header_bytes_received;
Harald Alvestrand719487e2017-12-13 12:26:04 +0100417 RTCStatsMember<int32_t> packets_lost; // Signed per RFC 3550
Henrik Boström01738c62019-04-15 17:32:00 +0200418 RTCStatsMember<double> last_packet_received_timestamp;
hbosa7a9be12017-03-01 01:02:45 -0800419 // TODO(hbos): Collect and populate this value for both "audio" and "video",
420 // currently not collected for "video". https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700421 RTCStatsMember<double> jitter;
hbosa7a9be12017-03-01 01:02:45 -0800422 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
423 RTCStatsMember<double> round_trip_time;
424 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700425 RTCStatsMember<uint32_t> packets_discarded;
hbosa7a9be12017-03-01 01:02:45 -0800426 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700427 RTCStatsMember<uint32_t> packets_repaired;
hbosa7a9be12017-03-01 01:02:45 -0800428 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700429 RTCStatsMember<uint32_t> burst_packets_lost;
hbosa7a9be12017-03-01 01:02:45 -0800430 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700431 RTCStatsMember<uint32_t> burst_packets_discarded;
hbosa7a9be12017-03-01 01:02:45 -0800432 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700433 RTCStatsMember<uint32_t> burst_loss_count;
hbosa7a9be12017-03-01 01:02:45 -0800434 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700435 RTCStatsMember<uint32_t> burst_discard_count;
hbosa7a9be12017-03-01 01:02:45 -0800436 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700437 RTCStatsMember<double> burst_loss_rate;
hbosa7a9be12017-03-01 01:02:45 -0800438 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700439 RTCStatsMember<double> burst_discard_rate;
hbosa7a9be12017-03-01 01:02:45 -0800440 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700441 RTCStatsMember<double> gap_loss_rate;
hbosa7a9be12017-03-01 01:02:45 -0800442 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065
hboseeafe942016-11-01 03:00:17 -0700443 RTCStatsMember<double> gap_discard_rate;
hbos6769c492017-01-02 08:35:13 -0800444 RTCStatsMember<uint32_t> frames_decoded;
Rasmus Brandt2efae772019-06-27 14:29:34 +0200445 RTCStatsMember<uint32_t> key_frames_decoded;
Johannes Kronbfd343b2019-07-01 10:07:50 +0200446 RTCStatsMember<double> total_decode_time;
Henrik Boström2e069262019-04-09 13:59:31 +0200447 // https://henbos.github.io/webrtc-provisional-stats/#dom-rtcinboundrtpstreamstats-contenttype
448 RTCStatsMember<std::string> content_type;
Henrik Boström6b430862019-08-16 13:09:51 +0200449 // TODO(hbos): This is only implemented for video; implement it for audio as
450 // well.
451 RTCStatsMember<std::string> decoder_implementation;
hboseeafe942016-11-01 03:00:17 -0700452};
453
hbos6ded1902016-11-01 01:50:46 -0700454// https://w3c.github.io/webrtc-stats/#outboundrtpstats-dict*
hbosa7a9be12017-03-01 01:02:45 -0800455// TODO(hbos): Support the remote case |is_remote = true|.
456// https://bugs.webrtc.org/7066
Mirko Bonadei276827c2018-10-16 14:13:50 +0200457class RTC_EXPORT RTCOutboundRTPStreamStats final : public RTCRTPStreamStats {
hbos6ded1902016-11-01 01:50:46 -0700458 public:
459 WEBRTC_RTCSTATS_DECL();
460
461 RTCOutboundRTPStreamStats(const std::string& id, int64_t timestamp_us);
462 RTCOutboundRTPStreamStats(std::string&& id, int64_t timestamp_us);
463 RTCOutboundRTPStreamStats(const RTCOutboundRTPStreamStats& other);
464 ~RTCOutboundRTPStreamStats() override;
465
Henrik Boström646fda02019-05-22 15:49:42 +0200466 RTCStatsMember<std::string> media_source_id;
hbos6ded1902016-11-01 01:50:46 -0700467 RTCStatsMember<uint32_t> packets_sent;
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200468 RTCStatsMember<uint64_t> retransmitted_packets_sent;
hbos6ded1902016-11-01 01:50:46 -0700469 RTCStatsMember<uint64_t> bytes_sent;
Niels Möllerac0a4cb2019-10-09 15:01:33 +0200470 RTCStatsMember<uint64_t> header_bytes_sent;
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200471 RTCStatsMember<uint64_t> retransmitted_bytes_sent;
hbosa7a9be12017-03-01 01:02:45 -0800472 // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7066
hbos6ded1902016-11-01 01:50:46 -0700473 RTCStatsMember<double> target_bitrate;
hbos6769c492017-01-02 08:35:13 -0800474 RTCStatsMember<uint32_t> frames_encoded;
Rasmus Brandt2efae772019-06-27 14:29:34 +0200475 RTCStatsMember<uint32_t> key_frames_encoded;
Henrik Boströmf71362f2019-04-08 16:14:23 +0200476 RTCStatsMember<double> total_encode_time;
Henrik Boström23aff9b2019-05-20 15:15:38 +0200477 RTCStatsMember<uint64_t> total_encoded_bytes_target;
Henrik Boström9fe18342019-05-16 18:38:20 +0200478 // TODO(https://crbug.com/webrtc/10635): This is only implemented for video;
479 // implement it for audio as well.
480 RTCStatsMember<double> total_packet_send_delay;
Henrik Boströmce33b6a2019-05-28 17:42:38 +0200481 // Enum type RTCQualityLimitationReason
482 // TODO(https://crbug.com/webrtc/10686): Also expose
483 // qualityLimitationDurations. Requires RTCStatsMember support for
484 // "record<DOMString, double>", see https://crbug.com/webrtc/10685.
485 RTCStatsMember<std::string> quality_limitation_reason;
Evan Shrubsolecc62b162019-09-09 11:26:45 +0200486 // https://w3c.github.io/webrtc-stats/#dom-rtcoutboundrtpstreamstats-qualitylimitationresolutionchanges
487 RTCStatsMember<uint32_t> quality_limitation_resolution_changes;
Henrik Boström2e069262019-04-09 13:59:31 +0200488 // https://henbos.github.io/webrtc-provisional-stats/#dom-rtcoutboundrtpstreamstats-contenttype
489 RTCStatsMember<std::string> content_type;
Henrik Boström6b430862019-08-16 13:09:51 +0200490 // TODO(hbos): This is only implemented for video; implement it for audio as
491 // well.
492 RTCStatsMember<std::string> encoder_implementation;
hbos6ded1902016-11-01 01:50:46 -0700493};
494
Henrik Boström883eefc2019-05-27 13:40:25 +0200495// TODO(https://crbug.com/webrtc/10671): Refactor the stats dictionaries to have
496// the same hierarchy as in the spec; implement RTCReceivedRtpStreamStats.
497// Several metrics are shared between "outbound-rtp", "remote-inbound-rtp",
498// "inbound-rtp" and "remote-outbound-rtp". In the spec there is a hierarchy of
499// dictionaries that minimizes defining the same metrics in multiple places.
500// From JavaScript this hierarchy is not observable and the spec's hierarchy is
501// purely editorial. In C++ non-final classes in the hierarchy could be used to
502// refer to different stats objects within the hierarchy.
503// https://w3c.github.io/webrtc-stats/#remoteinboundrtpstats-dict*
504class RTC_EXPORT RTCRemoteInboundRtpStreamStats final : public RTCStats {
505 public:
506 WEBRTC_RTCSTATS_DECL();
507
508 RTCRemoteInboundRtpStreamStats(const std::string& id, int64_t timestamp_us);
509 RTCRemoteInboundRtpStreamStats(std::string&& id, int64_t timestamp_us);
510 RTCRemoteInboundRtpStreamStats(const RTCRemoteInboundRtpStreamStats& other);
511 ~RTCRemoteInboundRtpStreamStats() override;
512
513 // In the spec RTCRemoteInboundRtpStreamStats inherits from RTCRtpStreamStats
514 // and RTCReceivedRtpStreamStats. The members here are listed based on where
515 // they are defined in the spec.
516 // RTCRtpStreamStats
517 RTCStatsMember<uint32_t> ssrc;
518 RTCStatsMember<std::string> kind;
519 RTCStatsMember<std::string> transport_id;
520 RTCStatsMember<std::string> codec_id;
521 // RTCReceivedRtpStreamStats
522 RTCStatsMember<int32_t> packets_lost;
523 RTCStatsMember<double> jitter;
524 // TODO(hbos): The following RTCReceivedRtpStreamStats metrics should also be
525 // implemented: packetsReceived, packetsDiscarded, packetsRepaired,
526 // burstPacketsLost, burstPacketsDiscarded, burstLossCount, burstDiscardCount,
527 // burstLossRate, burstDiscardRate, gapLossRate and gapDiscardRate.
528 // RTCRemoteInboundRtpStreamStats
529 RTCStatsMember<std::string> local_id;
530 RTCStatsMember<double> round_trip_time;
531 // TODO(hbos): The following RTCRemoteInboundRtpStreamStats metric should also
532 // be implemented: fractionLost.
533};
534
Henrik Boström646fda02019-05-22 15:49:42 +0200535// https://w3c.github.io/webrtc-stats/#dom-rtcmediasourcestats
536class RTC_EXPORT RTCMediaSourceStats : public RTCStats {
537 public:
538 WEBRTC_RTCSTATS_DECL();
539
540 RTCMediaSourceStats(const RTCMediaSourceStats& other);
541 ~RTCMediaSourceStats() override;
542
543 RTCStatsMember<std::string> track_identifier;
544 RTCStatsMember<std::string> kind;
545
546 protected:
547 RTCMediaSourceStats(const std::string& id, int64_t timestamp_us);
548 RTCMediaSourceStats(std::string&& id, int64_t timestamp_us);
549};
550
551// https://w3c.github.io/webrtc-stats/#dom-rtcaudiosourcestats
552class RTC_EXPORT RTCAudioSourceStats final : public RTCMediaSourceStats {
553 public:
554 WEBRTC_RTCSTATS_DECL();
555
556 RTCAudioSourceStats(const std::string& id, int64_t timestamp_us);
557 RTCAudioSourceStats(std::string&& id, int64_t timestamp_us);
558 RTCAudioSourceStats(const RTCAudioSourceStats& other);
559 ~RTCAudioSourceStats() override;
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200560
561 RTCStatsMember<double> audio_level;
562 RTCStatsMember<double> total_audio_energy;
563 RTCStatsMember<double> total_samples_duration;
Henrik Boström646fda02019-05-22 15:49:42 +0200564};
565
566// https://w3c.github.io/webrtc-stats/#dom-rtcvideosourcestats
567class RTC_EXPORT RTCVideoSourceStats final : public RTCMediaSourceStats {
568 public:
569 WEBRTC_RTCSTATS_DECL();
570
571 RTCVideoSourceStats(const std::string& id, int64_t timestamp_us);
572 RTCVideoSourceStats(std::string&& id, int64_t timestamp_us);
573 RTCVideoSourceStats(const RTCVideoSourceStats& other);
574 ~RTCVideoSourceStats() override;
575
576 RTCStatsMember<uint32_t> width;
577 RTCStatsMember<uint32_t> height;
578 // TODO(hbos): Implement this metric.
579 RTCStatsMember<uint32_t> frames;
580 RTCStatsMember<uint32_t> frames_per_second;
581};
582
hbos2fa7c672016-10-24 04:00:05 -0700583// https://w3c.github.io/webrtc-stats/#transportstats-dict*
Mirko Bonadei276827c2018-10-16 14:13:50 +0200584class RTC_EXPORT RTCTransportStats final : public RTCStats {
hbos2fa7c672016-10-24 04:00:05 -0700585 public:
586 WEBRTC_RTCSTATS_DECL();
587
588 RTCTransportStats(const std::string& id, int64_t timestamp_us);
589 RTCTransportStats(std::string&& id, int64_t timestamp_us);
590 RTCTransportStats(const RTCTransportStats& other);
591 ~RTCTransportStats() override;
592
593 RTCStatsMember<uint64_t> bytes_sent;
594 RTCStatsMember<uint64_t> bytes_received;
595 RTCStatsMember<std::string> rtcp_transport_stats_id;
hbos7064d592017-01-16 07:38:02 -0800596 // TODO(hbos): Support enum types? "RTCStatsMember<RTCDtlsTransportState>"?
597 RTCStatsMember<std::string> dtls_state;
hbos2fa7c672016-10-24 04:00:05 -0700598 RTCStatsMember<std::string> selected_candidate_pair_id;
599 RTCStatsMember<std::string> local_certificate_id;
600 RTCStatsMember<std::string> remote_certificate_id;
Jonas Oreland149dc722019-08-28 08:10:27 +0200601 RTCStatsMember<uint32_t> selected_candidate_pair_changes;
hbos2fa7c672016-10-24 04:00:05 -0700602};
603
hbosd565b732016-08-30 14:04:35 -0700604} // namespace webrtc
605
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200606#endif // API_STATS_RTCSTATS_OBJECTS_H_