hbos | d565b73 | 2016-08-30 14:04:35 -0700 | [diff] [blame] | 1 | /* |
| 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 Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 11 | #ifndef API_STATS_RTCSTATS_OBJECTS_H_ |
| 12 | #define API_STATS_RTCSTATS_OBJECTS_H_ |
hbos | d565b73 | 2016-08-30 14:04:35 -0700 | [diff] [blame] | 13 | |
Yves Gerey | 3e70781 | 2018-11-28 16:47:49 +0100 | [diff] [blame] | 14 | #include <stdint.h> |
Henrik Boström | 1df1bf8 | 2018-03-20 13:24:20 +0100 | [diff] [blame] | 15 | #include <memory> |
hbos | d565b73 | 2016-08-30 14:04:35 -0700 | [diff] [blame] | 16 | #include <string> |
oprypin | 803dc29 | 2017-02-01 01:55:59 -0800 | [diff] [blame] | 17 | #include <vector> |
hbos | d565b73 | 2016-08-30 14:04:35 -0700 | [diff] [blame] | 18 | |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 19 | #include "api/stats/rtc_stats.h" |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 20 | #include "rtc_base/system/rtc_export.h" |
hbos | d565b73 | 2016-08-30 14:04:35 -0700 | [diff] [blame] | 21 | |
| 22 | namespace webrtc { |
| 23 | |
hbos | cc555c5 | 2016-10-18 12:48:31 -0700 | [diff] [blame] | 24 | // https://w3c.github.io/webrtc-pc/#idl-def-rtcdatachannelstate |
| 25 | struct RTCDataChannelState { |
agrieve | 26622d3 | 2017-08-08 10:48:15 -0700 | [diff] [blame] | 26 | static const char* const kConnecting; |
| 27 | static const char* const kOpen; |
| 28 | static const char* const kClosing; |
| 29 | static const char* const kClosed; |
hbos | cc555c5 | 2016-10-18 12:48:31 -0700 | [diff] [blame] | 30 | }; |
| 31 | |
hbos | c47a0c3 | 2016-10-11 14:54:49 -0700 | [diff] [blame] | 32 | // https://w3c.github.io/webrtc-stats/#dom-rtcstatsicecandidatepairstate |
| 33 | struct RTCStatsIceCandidatePairState { |
agrieve | 26622d3 | 2017-08-08 10:48:15 -0700 | [diff] [blame] | 34 | static const char* const kFrozen; |
| 35 | static const char* const kWaiting; |
| 36 | static const char* const kInProgress; |
| 37 | static const char* const kFailed; |
| 38 | static const char* const kSucceeded; |
hbos | c47a0c3 | 2016-10-11 14:54:49 -0700 | [diff] [blame] | 39 | }; |
| 40 | |
hbos | cc555c5 | 2016-10-18 12:48:31 -0700 | [diff] [blame] | 41 | // https://w3c.github.io/webrtc-pc/#rtcicecandidatetype-enum |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 42 | struct RTCIceCandidateType { |
agrieve | 26622d3 | 2017-08-08 10:48:15 -0700 | [diff] [blame] | 43 | static const char* const kHost; |
| 44 | static const char* const kSrflx; |
| 45 | static const char* const kPrflx; |
| 46 | static const char* const kRelay; |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 47 | }; |
| 48 | |
hbos | 7064d59 | 2017-01-16 07:38:02 -0800 | [diff] [blame] | 49 | // https://w3c.github.io/webrtc-pc/#idl-def-rtcdtlstransportstate |
| 50 | struct RTCDtlsTransportState { |
agrieve | 26622d3 | 2017-08-08 10:48:15 -0700 | [diff] [blame] | 51 | static const char* const kNew; |
| 52 | static const char* const kConnecting; |
| 53 | static const char* const kConnected; |
| 54 | static const char* const kClosed; |
| 55 | static const char* const kFailed; |
hbos | 7064d59 | 2017-01-16 07:38:02 -0800 | [diff] [blame] | 56 | }; |
| 57 | |
hbos | 160e4a7 | 2017-01-17 02:53:23 -0800 | [diff] [blame] | 58 | // |RTCMediaStreamTrackStats::kind| is not an enum in the spec but the only |
| 59 | // valid values are "audio" and "video". |
| 60 | // https://w3c.github.io/webrtc-stats/#dom-rtcmediastreamtrackstats-kind |
| 61 | struct RTCMediaStreamTrackKind { |
agrieve | 26622d3 | 2017-08-08 10:48:15 -0700 | [diff] [blame] | 62 | static const char* const kAudio; |
| 63 | static const char* const kVideo; |
hbos | 160e4a7 | 2017-01-17 02:53:23 -0800 | [diff] [blame] | 64 | }; |
| 65 | |
Gary Liu | 37e489c | 2017-11-21 10:49:36 -0800 | [diff] [blame] | 66 | // https://w3c.github.io/webrtc-stats/#dom-rtcnetworktype |
| 67 | struct RTCNetworkType { |
| 68 | static const char* const kBluetooth; |
| 69 | static const char* const kCellular; |
| 70 | static const char* const kEthernet; |
| 71 | static const char* const kWifi; |
| 72 | static const char* const kWimax; |
| 73 | static const char* const kVpn; |
| 74 | static const char* const kUnknown; |
| 75 | }; |
| 76 | |
Henrik Boström | ce33b6a | 2019-05-28 17:42:38 +0200 | [diff] [blame] | 77 | // https://w3c.github.io/webrtc-stats/#dom-rtcqualitylimitationreason |
| 78 | struct RTCQualityLimitationReason { |
| 79 | static const char* const kNone; |
| 80 | static const char* const kCpu; |
| 81 | static const char* const kBandwidth; |
| 82 | static const char* const kOther; |
| 83 | }; |
| 84 | |
Henrik Boström | 2e06926 | 2019-04-09 13:59:31 +0200 | [diff] [blame] | 85 | // https://webrtc.org/experiments/rtp-hdrext/video-content-type/ |
| 86 | struct RTCContentType { |
| 87 | static const char* const kUnspecified; |
| 88 | static const char* const kScreenshare; |
| 89 | }; |
| 90 | |
hbos | 2fa7c67 | 2016-10-24 04:00:05 -0700 | [diff] [blame] | 91 | // https://w3c.github.io/webrtc-stats/#certificatestats-dict* |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 92 | class RTC_EXPORT RTCCertificateStats final : public RTCStats { |
hbos | 2fa7c67 | 2016-10-24 04:00:05 -0700 | [diff] [blame] | 93 | public: |
| 94 | WEBRTC_RTCSTATS_DECL(); |
| 95 | |
| 96 | RTCCertificateStats(const std::string& id, int64_t timestamp_us); |
| 97 | RTCCertificateStats(std::string&& id, int64_t timestamp_us); |
| 98 | RTCCertificateStats(const RTCCertificateStats& other); |
| 99 | ~RTCCertificateStats() override; |
| 100 | |
| 101 | RTCStatsMember<std::string> fingerprint; |
| 102 | RTCStatsMember<std::string> fingerprint_algorithm; |
| 103 | RTCStatsMember<std::string> base64_certificate; |
| 104 | RTCStatsMember<std::string> issuer_certificate_id; |
| 105 | }; |
| 106 | |
hbos | 0adb828 | 2016-11-23 02:32:06 -0800 | [diff] [blame] | 107 | // https://w3c.github.io/webrtc-stats/#codec-dict* |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 108 | class RTC_EXPORT RTCCodecStats final : public RTCStats { |
hbos | 0adb828 | 2016-11-23 02:32:06 -0800 | [diff] [blame] | 109 | public: |
| 110 | WEBRTC_RTCSTATS_DECL(); |
| 111 | |
| 112 | RTCCodecStats(const std::string& id, int64_t timestamp_us); |
| 113 | RTCCodecStats(std::string&& id, int64_t timestamp_us); |
| 114 | RTCCodecStats(const RTCCodecStats& other); |
| 115 | ~RTCCodecStats() override; |
| 116 | |
| 117 | RTCStatsMember<uint32_t> payload_type; |
hbos | 13f54b2 | 2017-02-28 06:56:04 -0800 | [diff] [blame] | 118 | RTCStatsMember<std::string> mime_type; |
hbos | 0adb828 | 2016-11-23 02:32:06 -0800 | [diff] [blame] | 119 | RTCStatsMember<uint32_t> clock_rate; |
hbos | 585a9b1 | 2017-02-07 04:59:16 -0800 | [diff] [blame] | 120 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7061 |
hbos | 0adb828 | 2016-11-23 02:32:06 -0800 | [diff] [blame] | 121 | RTCStatsMember<uint32_t> channels; |
hbos | 585a9b1 | 2017-02-07 04:59:16 -0800 | [diff] [blame] | 122 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7061 |
hbos | 13f54b2 | 2017-02-28 06:56:04 -0800 | [diff] [blame] | 123 | RTCStatsMember<std::string> sdp_fmtp_line; |
hbos | 585a9b1 | 2017-02-07 04:59:16 -0800 | [diff] [blame] | 124 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7061 |
hbos | 0adb828 | 2016-11-23 02:32:06 -0800 | [diff] [blame] | 125 | RTCStatsMember<std::string> implementation; |
| 126 | }; |
| 127 | |
hbos | 2fa7c67 | 2016-10-24 04:00:05 -0700 | [diff] [blame] | 128 | // https://w3c.github.io/webrtc-stats/#dcstats-dict* |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 129 | class RTC_EXPORT RTCDataChannelStats final : public RTCStats { |
hbos | 2fa7c67 | 2016-10-24 04:00:05 -0700 | [diff] [blame] | 130 | public: |
| 131 | WEBRTC_RTCSTATS_DECL(); |
| 132 | |
| 133 | RTCDataChannelStats(const std::string& id, int64_t timestamp_us); |
| 134 | RTCDataChannelStats(std::string&& id, int64_t timestamp_us); |
| 135 | RTCDataChannelStats(const RTCDataChannelStats& other); |
| 136 | ~RTCDataChannelStats() override; |
| 137 | |
| 138 | RTCStatsMember<std::string> label; |
| 139 | RTCStatsMember<std::string> protocol; |
| 140 | RTCStatsMember<int32_t> datachannelid; |
| 141 | // TODO(hbos): Support enum types? "RTCStatsMember<RTCDataChannelState>"? |
| 142 | RTCStatsMember<std::string> state; |
| 143 | RTCStatsMember<uint32_t> messages_sent; |
| 144 | RTCStatsMember<uint64_t> bytes_sent; |
| 145 | RTCStatsMember<uint32_t> messages_received; |
| 146 | RTCStatsMember<uint64_t> bytes_received; |
| 147 | }; |
| 148 | |
| 149 | // https://w3c.github.io/webrtc-stats/#candidatepair-dict* |
hbos | 338f78a | 2017-02-07 06:41:21 -0800 | [diff] [blame] | 150 | // TODO(hbos): Tracking bug https://bugs.webrtc.org/7062 |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 151 | class RTC_EXPORT RTCIceCandidatePairStats final : public RTCStats { |
hbos | c47a0c3 | 2016-10-11 14:54:49 -0700 | [diff] [blame] | 152 | public: |
| 153 | WEBRTC_RTCSTATS_DECL(); |
| 154 | |
| 155 | RTCIceCandidatePairStats(const std::string& id, int64_t timestamp_us); |
| 156 | RTCIceCandidatePairStats(std::string&& id, int64_t timestamp_us); |
| 157 | RTCIceCandidatePairStats(const RTCIceCandidatePairStats& other); |
| 158 | ~RTCIceCandidatePairStats() override; |
| 159 | |
| 160 | RTCStatsMember<std::string> transport_id; |
| 161 | RTCStatsMember<std::string> local_candidate_id; |
| 162 | RTCStatsMember<std::string> remote_candidate_id; |
| 163 | // TODO(hbos): Support enum types? |
| 164 | // "RTCStatsMember<RTCStatsIceCandidatePairState>"? |
| 165 | RTCStatsMember<std::string> state; |
| 166 | RTCStatsMember<uint64_t> priority; |
| 167 | RTCStatsMember<bool> nominated; |
hbos | 338f78a | 2017-02-07 06:41:21 -0800 | [diff] [blame] | 168 | // TODO(hbos): Collect this the way the spec describes it. We have a value for |
| 169 | // it but it is not spec-compliant. https://bugs.webrtc.org/7062 |
hbos | c47a0c3 | 2016-10-11 14:54:49 -0700 | [diff] [blame] | 170 | RTCStatsMember<bool> writable; |
hbos | 338f78a | 2017-02-07 06:41:21 -0800 | [diff] [blame] | 171 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062 |
hbos | c47a0c3 | 2016-10-11 14:54:49 -0700 | [diff] [blame] | 172 | RTCStatsMember<bool> readable; |
| 173 | RTCStatsMember<uint64_t> bytes_sent; |
| 174 | RTCStatsMember<uint64_t> bytes_received; |
hbos | 3168c7a | 2016-12-15 06:17:08 -0800 | [diff] [blame] | 175 | RTCStatsMember<double> total_round_trip_time; |
hbos | 3168c7a | 2016-12-15 06:17:08 -0800 | [diff] [blame] | 176 | RTCStatsMember<double> current_round_trip_time; |
hbos | c47a0c3 | 2016-10-11 14:54:49 -0700 | [diff] [blame] | 177 | RTCStatsMember<double> available_outgoing_bitrate; |
hbos | 338f78a | 2017-02-07 06:41:21 -0800 | [diff] [blame] | 178 | // TODO(hbos): Populate this value. It is wired up and collected the same way |
hbos | bf8d3e5 | 2017-02-28 06:34:47 -0800 | [diff] [blame] | 179 | // "VideoBwe.googAvailableReceiveBandwidth" is, but that value is always |
hbos | 338f78a | 2017-02-07 06:41:21 -0800 | [diff] [blame] | 180 | // undefined. https://bugs.webrtc.org/7062 |
hbos | c47a0c3 | 2016-10-11 14:54:49 -0700 | [diff] [blame] | 181 | RTCStatsMember<double> available_incoming_bitrate; |
| 182 | RTCStatsMember<uint64_t> requests_received; |
| 183 | RTCStatsMember<uint64_t> requests_sent; |
| 184 | RTCStatsMember<uint64_t> responses_received; |
| 185 | RTCStatsMember<uint64_t> responses_sent; |
hbos | 338f78a | 2017-02-07 06:41:21 -0800 | [diff] [blame] | 186 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062 |
hbos | c47a0c3 | 2016-10-11 14:54:49 -0700 | [diff] [blame] | 187 | RTCStatsMember<uint64_t> retransmissions_received; |
hbos | 338f78a | 2017-02-07 06:41:21 -0800 | [diff] [blame] | 188 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062 |
hbos | c47a0c3 | 2016-10-11 14:54:49 -0700 | [diff] [blame] | 189 | RTCStatsMember<uint64_t> retransmissions_sent; |
hbos | 338f78a | 2017-02-07 06:41:21 -0800 | [diff] [blame] | 190 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062 |
hbos | c47a0c3 | 2016-10-11 14:54:49 -0700 | [diff] [blame] | 191 | RTCStatsMember<uint64_t> consent_requests_received; |
| 192 | RTCStatsMember<uint64_t> consent_requests_sent; |
hbos | 338f78a | 2017-02-07 06:41:21 -0800 | [diff] [blame] | 193 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062 |
hbos | c47a0c3 | 2016-10-11 14:54:49 -0700 | [diff] [blame] | 194 | RTCStatsMember<uint64_t> consent_responses_received; |
hbos | 338f78a | 2017-02-07 06:41:21 -0800 | [diff] [blame] | 195 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7062 |
hbos | c47a0c3 | 2016-10-11 14:54:49 -0700 | [diff] [blame] | 196 | RTCStatsMember<uint64_t> consent_responses_sent; |
| 197 | }; |
| 198 | |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 199 | // https://w3c.github.io/webrtc-stats/#icecandidate-dict* |
hbos | 5d79a7c | 2016-10-24 09:27:10 -0700 | [diff] [blame] | 200 | // TODO(hbos): |RTCStatsCollector| only collects candidates that are part of |
| 201 | // ice candidate pairs, but there could be candidates not paired with anything. |
| 202 | // crbug.com/632723 |
Qingsi Wang | 72a43a1 | 2018-02-20 16:03:18 -0800 | [diff] [blame] | 203 | // TODO(qingsi): Add the stats of STUN binding requests (keepalives) and collect |
| 204 | // them in the new PeerConnection::GetStats. |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 205 | class RTC_EXPORT RTCIceCandidateStats : public RTCStats { |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 206 | public: |
| 207 | WEBRTC_RTCSTATS_DECL(); |
| 208 | |
| 209 | RTCIceCandidateStats(const RTCIceCandidateStats& other); |
| 210 | ~RTCIceCandidateStats() override; |
| 211 | |
hbos | b4e426e | 2017-01-02 09:59:31 -0800 | [diff] [blame] | 212 | RTCStatsMember<std::string> transport_id; |
hbos | c3a2b7f | 2017-01-02 04:46:15 -0800 | [diff] [blame] | 213 | RTCStatsMember<bool> is_remote; |
Gary Liu | 37e489c | 2017-11-21 10:49:36 -0800 | [diff] [blame] | 214 | RTCStatsMember<std::string> network_type; |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 215 | RTCStatsMember<std::string> ip; |
| 216 | RTCStatsMember<int32_t> port; |
| 217 | RTCStatsMember<std::string> protocol; |
Philipp Hancke | 9551375 | 2018-09-27 14:40:08 +0200 | [diff] [blame] | 218 | RTCStatsMember<std::string> relay_protocol; |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 219 | // TODO(hbos): Support enum types? "RTCStatsMember<RTCIceCandidateType>"? |
| 220 | RTCStatsMember<std::string> candidate_type; |
| 221 | RTCStatsMember<int32_t> priority; |
hbos | 5d79a7c | 2016-10-24 09:27:10 -0700 | [diff] [blame] | 222 | // TODO(hbos): Not collected by |RTCStatsCollector|. crbug.com/632723 |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 223 | RTCStatsMember<std::string> url; |
hbos | d17a5a7 | 2017-01-02 08:09:59 -0800 | [diff] [blame] | 224 | // TODO(hbos): |deleted = true| case is not supported by |RTCStatsCollector|. |
| 225 | // crbug.com/632723 |
| 226 | RTCStatsMember<bool> deleted; // = false |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 227 | |
| 228 | protected: |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 229 | RTCIceCandidateStats(const std::string& id, |
| 230 | int64_t timestamp_us, |
| 231 | bool is_remote); |
hbos | c3a2b7f | 2017-01-02 04:46:15 -0800 | [diff] [blame] | 232 | RTCIceCandidateStats(std::string&& id, int64_t timestamp_us, bool is_remote); |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 233 | }; |
| 234 | |
| 235 | // In the spec both local and remote varieties are of type RTCIceCandidateStats. |
| 236 | // But here we define them as subclasses of |RTCIceCandidateStats| because the |
| 237 | // |kType| need to be different ("RTCStatsType type") in the local/remote case. |
| 238 | // https://w3c.github.io/webrtc-stats/#rtcstatstype-str* |
Henrik Boström | 1df1bf8 | 2018-03-20 13:24:20 +0100 | [diff] [blame] | 239 | // This forces us to have to override copy() and type(). |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 240 | class RTC_EXPORT RTCLocalIceCandidateStats final : public RTCIceCandidateStats { |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 241 | public: |
| 242 | static const char kType[]; |
| 243 | RTCLocalIceCandidateStats(const std::string& id, int64_t timestamp_us); |
| 244 | RTCLocalIceCandidateStats(std::string&& id, int64_t timestamp_us); |
Henrik Boström | 1df1bf8 | 2018-03-20 13:24:20 +0100 | [diff] [blame] | 245 | std::unique_ptr<RTCStats> copy() const override; |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 246 | const char* type() const override; |
| 247 | }; |
| 248 | |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 249 | class RTC_EXPORT RTCRemoteIceCandidateStats final |
| 250 | : public RTCIceCandidateStats { |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 251 | public: |
| 252 | static const char kType[]; |
| 253 | RTCRemoteIceCandidateStats(const std::string& id, int64_t timestamp_us); |
| 254 | RTCRemoteIceCandidateStats(std::string&& id, int64_t timestamp_us); |
Henrik Boström | 1df1bf8 | 2018-03-20 13:24:20 +0100 | [diff] [blame] | 255 | std::unique_ptr<RTCStats> copy() const override; |
hbos | ab9f6e4 | 2016-10-07 02:18:47 -0700 | [diff] [blame] | 256 | const char* type() const override; |
| 257 | }; |
| 258 | |
hbos | 09bc128 | 2016-11-08 06:29:22 -0800 | [diff] [blame] | 259 | // https://w3c.github.io/webrtc-stats/#msstats-dict* |
hbos | 0adb828 | 2016-11-23 02:32:06 -0800 | [diff] [blame] | 260 | // TODO(hbos): Tracking bug crbug.com/660827 |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 261 | class RTC_EXPORT RTCMediaStreamStats final : public RTCStats { |
hbos | 09bc128 | 2016-11-08 06:29:22 -0800 | [diff] [blame] | 262 | public: |
| 263 | WEBRTC_RTCSTATS_DECL(); |
| 264 | |
| 265 | RTCMediaStreamStats(const std::string& id, int64_t timestamp_us); |
| 266 | RTCMediaStreamStats(std::string&& id, int64_t timestamp_us); |
| 267 | RTCMediaStreamStats(const RTCMediaStreamStats& other); |
| 268 | ~RTCMediaStreamStats() override; |
| 269 | |
| 270 | RTCStatsMember<std::string> stream_identifier; |
| 271 | RTCStatsMember<std::vector<std::string>> track_ids; |
| 272 | }; |
| 273 | |
| 274 | // https://w3c.github.io/webrtc-stats/#mststats-dict* |
hbos | 0adb828 | 2016-11-23 02:32:06 -0800 | [diff] [blame] | 275 | // TODO(hbos): Tracking bug crbug.com/659137 |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 276 | class RTC_EXPORT RTCMediaStreamTrackStats final : public RTCStats { |
hbos | 09bc128 | 2016-11-08 06:29:22 -0800 | [diff] [blame] | 277 | public: |
| 278 | WEBRTC_RTCSTATS_DECL(); |
| 279 | |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 280 | RTCMediaStreamTrackStats(const std::string& id, |
| 281 | int64_t timestamp_us, |
hbos | 160e4a7 | 2017-01-17 02:53:23 -0800 | [diff] [blame] | 282 | const char* kind); |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 283 | RTCMediaStreamTrackStats(std::string&& id, |
| 284 | int64_t timestamp_us, |
hbos | 160e4a7 | 2017-01-17 02:53:23 -0800 | [diff] [blame] | 285 | const char* kind); |
hbos | 09bc128 | 2016-11-08 06:29:22 -0800 | [diff] [blame] | 286 | RTCMediaStreamTrackStats(const RTCMediaStreamTrackStats& other); |
| 287 | ~RTCMediaStreamTrackStats() override; |
| 288 | |
| 289 | RTCStatsMember<std::string> track_identifier; |
Henrik Boström | 646fda0 | 2019-05-22 15:49:42 +0200 | [diff] [blame] | 290 | RTCStatsMember<std::string> media_source_id; |
hbos | 09bc128 | 2016-11-08 06:29:22 -0800 | [diff] [blame] | 291 | RTCStatsMember<bool> remote_source; |
| 292 | RTCStatsMember<bool> ended; |
| 293 | // TODO(hbos): |RTCStatsCollector| does not return stats for detached tracks. |
| 294 | // crbug.com/659137 |
| 295 | RTCStatsMember<bool> detached; |
hbos | 160e4a7 | 2017-01-17 02:53:23 -0800 | [diff] [blame] | 296 | // See |RTCMediaStreamTrackKind| for valid values. |
| 297 | RTCStatsMember<std::string> kind; |
Gustaf Ullberg | b0a0207 | 2017-10-02 12:00:34 +0200 | [diff] [blame] | 298 | // TODO(gustaf): Implement jitter_buffer_delay for video (currently |
| 299 | // implemented for audio only). |
| 300 | // https://crbug.com/webrtc/8318 |
| 301 | RTCStatsMember<double> jitter_buffer_delay; |
Chen Xing | 0acffb5 | 2019-01-15 15:46:29 +0100 | [diff] [blame] | 302 | RTCStatsMember<uint64_t> jitter_buffer_emitted_count; |
hbos | 09bc128 | 2016-11-08 06:29:22 -0800 | [diff] [blame] | 303 | // Video-only members |
| 304 | RTCStatsMember<uint32_t> frame_width; |
| 305 | RTCStatsMember<uint32_t> frame_height; |
| 306 | // TODO(hbos): Not collected by |RTCStatsCollector|. crbug.com/659137 |
| 307 | RTCStatsMember<double> frames_per_second; |
hbos | 09bc128 | 2016-11-08 06:29:22 -0800 | [diff] [blame] | 308 | RTCStatsMember<uint32_t> frames_sent; |
Ilya Nikolaevskiy | 70473fc | 2018-02-28 16:35:03 +0100 | [diff] [blame] | 309 | RTCStatsMember<uint32_t> huge_frames_sent; |
hbos | 09bc128 | 2016-11-08 06:29:22 -0800 | [diff] [blame] | 310 | RTCStatsMember<uint32_t> frames_received; |
hbos | 09bc128 | 2016-11-08 06:29:22 -0800 | [diff] [blame] | 311 | RTCStatsMember<uint32_t> frames_decoded; |
hbos | 09bc128 | 2016-11-08 06:29:22 -0800 | [diff] [blame] | 312 | RTCStatsMember<uint32_t> frames_dropped; |
| 313 | // TODO(hbos): Not collected by |RTCStatsCollector|. crbug.com/659137 |
| 314 | RTCStatsMember<uint32_t> frames_corrupted; |
| 315 | // TODO(hbos): Not collected by |RTCStatsCollector|. crbug.com/659137 |
| 316 | RTCStatsMember<uint32_t> partial_frames_lost; |
| 317 | // TODO(hbos): Not collected by |RTCStatsCollector|. crbug.com/659137 |
| 318 | RTCStatsMember<uint32_t> full_frames_lost; |
| 319 | // Audio-only members |
| 320 | RTCStatsMember<double> audio_level; |
zstein | e76bd3a | 2017-07-14 12:17:49 -0700 | [diff] [blame] | 321 | RTCStatsMember<double> total_audio_energy; |
hbos | 09bc128 | 2016-11-08 06:29:22 -0800 | [diff] [blame] | 322 | RTCStatsMember<double> echo_return_loss; |
| 323 | RTCStatsMember<double> echo_return_loss_enhancement; |
Steve Anton | 2dbc69f | 2017-08-24 17:15:13 -0700 | [diff] [blame] | 324 | RTCStatsMember<uint64_t> total_samples_received; |
| 325 | RTCStatsMember<double> total_samples_duration; |
| 326 | RTCStatsMember<uint64_t> concealed_samples; |
Ivo Creusen | 8d8ffdb | 2019-04-30 09:45:21 +0200 | [diff] [blame] | 327 | RTCStatsMember<uint64_t> silent_concealed_samples; |
Gustaf Ullberg | 9a2e906 | 2017-09-18 09:28:20 +0200 | [diff] [blame] | 328 | RTCStatsMember<uint64_t> concealment_events; |
Ivo Creusen | 8d8ffdb | 2019-04-30 09:45:21 +0200 | [diff] [blame] | 329 | RTCStatsMember<uint64_t> inserted_samples_for_deceleration; |
| 330 | RTCStatsMember<uint64_t> removed_samples_for_acceleration; |
Ruslan Burakov | 8af8896 | 2018-11-22 17:21:10 +0100 | [diff] [blame] | 331 | // Non-standard audio-only member |
Jakob Ivarsson | 352ce5c | 2018-11-27 12:52:16 +0100 | [diff] [blame] | 332 | // TODO(kuddai): Add description to standard. crbug.com/webrtc/10042 |
Ruslan Burakov | 8af8896 | 2018-11-22 17:21:10 +0100 | [diff] [blame] | 333 | RTCNonStandardStatsMember<uint64_t> jitter_buffer_flushes; |
Jakob Ivarsson | 352ce5c | 2018-11-27 12:52:16 +0100 | [diff] [blame] | 334 | RTCNonStandardStatsMember<uint64_t> delayed_packet_outage_samples; |
Jakob Ivarsson | 232b3fd | 2019-03-06 09:18:40 +0100 | [diff] [blame] | 335 | RTCNonStandardStatsMember<double> relative_packet_arrival_delay; |
Henrik Lundin | 44125fa | 2019-04-29 17:00:46 +0200 | [diff] [blame] | 336 | // TODO(henrik.lundin): Add description of the interruption metrics at |
| 337 | // https://github.com/henbos/webrtc-provisional-stats/issues/17 |
| 338 | RTCNonStandardStatsMember<uint32_t> interruption_count; |
| 339 | RTCNonStandardStatsMember<double> total_interruption_duration; |
Sergey Silkin | 0237106 | 2019-01-31 16:45:42 +0100 | [diff] [blame] | 340 | // Non-standard video-only members. |
| 341 | // https://henbos.github.io/webrtc-provisional-stats/#RTCVideoReceiverStats-dict* |
| 342 | RTCNonStandardStatsMember<uint32_t> freeze_count; |
| 343 | RTCNonStandardStatsMember<uint32_t> pause_count; |
| 344 | RTCNonStandardStatsMember<double> total_freezes_duration; |
| 345 | RTCNonStandardStatsMember<double> total_pauses_duration; |
| 346 | RTCNonStandardStatsMember<double> total_frames_duration; |
| 347 | RTCNonStandardStatsMember<double> sum_squared_frame_durations; |
hbos | 09bc128 | 2016-11-08 06:29:22 -0800 | [diff] [blame] | 348 | }; |
| 349 | |
hbos | 6ab97ce | 2016-10-03 14:16:56 -0700 | [diff] [blame] | 350 | // https://w3c.github.io/webrtc-stats/#pcstats-dict* |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 351 | class RTC_EXPORT RTCPeerConnectionStats final : public RTCStats { |
hbos | d565b73 | 2016-08-30 14:04:35 -0700 | [diff] [blame] | 352 | public: |
hbos | fc5e050 | 2016-10-06 02:06:10 -0700 | [diff] [blame] | 353 | WEBRTC_RTCSTATS_DECL(); |
| 354 | |
hbos | 0e6758d | 2016-08-31 07:57:36 -0700 | [diff] [blame] | 355 | RTCPeerConnectionStats(const std::string& id, int64_t timestamp_us); |
| 356 | RTCPeerConnectionStats(std::string&& id, int64_t timestamp_us); |
hbos | fc5e050 | 2016-10-06 02:06:10 -0700 | [diff] [blame] | 357 | RTCPeerConnectionStats(const RTCPeerConnectionStats& other); |
| 358 | ~RTCPeerConnectionStats() override; |
hbos | d565b73 | 2016-08-30 14:04:35 -0700 | [diff] [blame] | 359 | |
| 360 | RTCStatsMember<uint32_t> data_channels_opened; |
| 361 | RTCStatsMember<uint32_t> data_channels_closed; |
| 362 | }; |
| 363 | |
hbos | 6ded190 | 2016-11-01 01:50:46 -0700 | [diff] [blame] | 364 | // https://w3c.github.io/webrtc-stats/#streamstats-dict* |
hbos | 0adb828 | 2016-11-23 02:32:06 -0800 | [diff] [blame] | 365 | // TODO(hbos): Tracking bug crbug.com/657854 |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 366 | class RTC_EXPORT RTCRTPStreamStats : public RTCStats { |
hbos | 6ded190 | 2016-11-01 01:50:46 -0700 | [diff] [blame] | 367 | public: |
| 368 | WEBRTC_RTCSTATS_DECL(); |
| 369 | |
| 370 | RTCRTPStreamStats(const RTCRTPStreamStats& other); |
| 371 | ~RTCRTPStreamStats() override; |
| 372 | |
hbos | 3443bb7 | 2017-02-07 06:28:11 -0800 | [diff] [blame] | 373 | RTCStatsMember<uint32_t> ssrc; |
hbos | 6ded190 | 2016-11-01 01:50:46 -0700 | [diff] [blame] | 374 | // TODO(hbos): When the remote case is supported |RTCStatsCollector| needs to |
| 375 | // set this. crbug.com/657855, 657856 |
| 376 | RTCStatsMember<std::string> associate_stats_id; |
| 377 | // TODO(hbos): Remote case not supported by |RTCStatsCollector|. |
| 378 | // crbug.com/657855, 657856 |
| 379 | RTCStatsMember<bool> is_remote; // = false |
Philipp Hancke | 3bc0166 | 2018-08-28 14:55:03 +0200 | [diff] [blame] | 380 | RTCStatsMember<std::string> media_type; // renamed to kind. |
| 381 | RTCStatsMember<std::string> kind; |
hbos | b0ae920 | 2017-01-27 06:35:16 -0800 | [diff] [blame] | 382 | RTCStatsMember<std::string> track_id; |
hbos | 6ded190 | 2016-11-01 01:50:46 -0700 | [diff] [blame] | 383 | RTCStatsMember<std::string> transport_id; |
hbos | 6ded190 | 2016-11-01 01:50:46 -0700 | [diff] [blame] | 384 | RTCStatsMember<std::string> codec_id; |
| 385 | // FIR and PLI counts are only defined for |media_type == "video"|. |
| 386 | RTCStatsMember<uint32_t> fir_count; |
| 387 | RTCStatsMember<uint32_t> pli_count; |
| 388 | // TODO(hbos): NACK count should be collected by |RTCStatsCollector| for both |
| 389 | // audio and video but is only defined in the "video" case. crbug.com/657856 |
| 390 | RTCStatsMember<uint32_t> nack_count; |
| 391 | // TODO(hbos): Not collected by |RTCStatsCollector|. crbug.com/657854 |
| 392 | // SLI count is only defined for |media_type == "video"|. |
| 393 | RTCStatsMember<uint32_t> sli_count; |
hbos | 6769c49 | 2017-01-02 08:35:13 -0800 | [diff] [blame] | 394 | RTCStatsMember<uint64_t> qp_sum; |
hbos | 6ded190 | 2016-11-01 01:50:46 -0700 | [diff] [blame] | 395 | |
| 396 | protected: |
| 397 | RTCRTPStreamStats(const std::string& id, int64_t timestamp_us); |
| 398 | RTCRTPStreamStats(std::string&& id, int64_t timestamp_us); |
| 399 | }; |
| 400 | |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 401 | // https://w3c.github.io/webrtc-stats/#inboundrtpstats-dict* |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 402 | // TODO(hbos): Support the remote case |is_remote = true|. |
| 403 | // https://bugs.webrtc.org/7065 |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 404 | class RTC_EXPORT RTCInboundRTPStreamStats final : public RTCRTPStreamStats { |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 405 | public: |
| 406 | WEBRTC_RTCSTATS_DECL(); |
| 407 | |
| 408 | RTCInboundRTPStreamStats(const std::string& id, int64_t timestamp_us); |
| 409 | RTCInboundRTPStreamStats(std::string&& id, int64_t timestamp_us); |
| 410 | RTCInboundRTPStreamStats(const RTCInboundRTPStreamStats& other); |
| 411 | ~RTCInboundRTPStreamStats() override; |
| 412 | |
| 413 | RTCStatsMember<uint32_t> packets_received; |
Ivo Creusen | 8d8ffdb | 2019-04-30 09:45:21 +0200 | [diff] [blame] | 414 | RTCStatsMember<uint64_t> fec_packets_received; |
| 415 | RTCStatsMember<uint64_t> fec_packets_discarded; |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 416 | RTCStatsMember<uint64_t> bytes_received; |
Harald Alvestrand | 719487e | 2017-12-13 12:26:04 +0100 | [diff] [blame] | 417 | RTCStatsMember<int32_t> packets_lost; // Signed per RFC 3550 |
Henrik Boström | 01738c6 | 2019-04-15 17:32:00 +0200 | [diff] [blame] | 418 | RTCStatsMember<double> last_packet_received_timestamp; |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 419 | // TODO(hbos): Collect and populate this value for both "audio" and "video", |
| 420 | // currently not collected for "video". https://bugs.webrtc.org/7065 |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 421 | RTCStatsMember<double> jitter; |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 422 | // 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 |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 425 | RTCStatsMember<uint32_t> packets_discarded; |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 426 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065 |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 427 | RTCStatsMember<uint32_t> packets_repaired; |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 428 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065 |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 429 | RTCStatsMember<uint32_t> burst_packets_lost; |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 430 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065 |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 431 | RTCStatsMember<uint32_t> burst_packets_discarded; |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 432 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065 |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 433 | RTCStatsMember<uint32_t> burst_loss_count; |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 434 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065 |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 435 | RTCStatsMember<uint32_t> burst_discard_count; |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 436 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065 |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 437 | RTCStatsMember<double> burst_loss_rate; |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 438 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065 |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 439 | RTCStatsMember<double> burst_discard_rate; |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 440 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065 |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 441 | RTCStatsMember<double> gap_loss_rate; |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 442 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7065 |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 443 | RTCStatsMember<double> gap_discard_rate; |
hbos | 6769c49 | 2017-01-02 08:35:13 -0800 | [diff] [blame] | 444 | RTCStatsMember<uint32_t> frames_decoded; |
Rasmus Brandt | 2efae77 | 2019-06-27 14:29:34 +0200 | [diff] [blame^] | 445 | RTCStatsMember<uint32_t> key_frames_decoded; |
Henrik Boström | 2e06926 | 2019-04-09 13:59:31 +0200 | [diff] [blame] | 446 | // https://henbos.github.io/webrtc-provisional-stats/#dom-rtcinboundrtpstreamstats-contenttype |
| 447 | RTCStatsMember<std::string> content_type; |
hbos | eeafe94 | 2016-11-01 03:00:17 -0700 | [diff] [blame] | 448 | }; |
| 449 | |
hbos | 6ded190 | 2016-11-01 01:50:46 -0700 | [diff] [blame] | 450 | // https://w3c.github.io/webrtc-stats/#outboundrtpstats-dict* |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 451 | // TODO(hbos): Support the remote case |is_remote = true|. |
| 452 | // https://bugs.webrtc.org/7066 |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 453 | class RTC_EXPORT RTCOutboundRTPStreamStats final : public RTCRTPStreamStats { |
hbos | 6ded190 | 2016-11-01 01:50:46 -0700 | [diff] [blame] | 454 | public: |
| 455 | WEBRTC_RTCSTATS_DECL(); |
| 456 | |
| 457 | RTCOutboundRTPStreamStats(const std::string& id, int64_t timestamp_us); |
| 458 | RTCOutboundRTPStreamStats(std::string&& id, int64_t timestamp_us); |
| 459 | RTCOutboundRTPStreamStats(const RTCOutboundRTPStreamStats& other); |
| 460 | ~RTCOutboundRTPStreamStats() override; |
| 461 | |
Henrik Boström | 646fda0 | 2019-05-22 15:49:42 +0200 | [diff] [blame] | 462 | RTCStatsMember<std::string> media_source_id; |
hbos | 6ded190 | 2016-11-01 01:50:46 -0700 | [diff] [blame] | 463 | RTCStatsMember<uint32_t> packets_sent; |
Henrik Boström | cf96e0f | 2019-04-17 13:51:53 +0200 | [diff] [blame] | 464 | RTCStatsMember<uint64_t> retransmitted_packets_sent; |
hbos | 6ded190 | 2016-11-01 01:50:46 -0700 | [diff] [blame] | 465 | RTCStatsMember<uint64_t> bytes_sent; |
Henrik Boström | cf96e0f | 2019-04-17 13:51:53 +0200 | [diff] [blame] | 466 | RTCStatsMember<uint64_t> retransmitted_bytes_sent; |
hbos | a7a9be1 | 2017-03-01 01:02:45 -0800 | [diff] [blame] | 467 | // TODO(hbos): Collect and populate this value. https://bugs.webrtc.org/7066 |
hbos | 6ded190 | 2016-11-01 01:50:46 -0700 | [diff] [blame] | 468 | RTCStatsMember<double> target_bitrate; |
hbos | 6769c49 | 2017-01-02 08:35:13 -0800 | [diff] [blame] | 469 | RTCStatsMember<uint32_t> frames_encoded; |
Rasmus Brandt | 2efae77 | 2019-06-27 14:29:34 +0200 | [diff] [blame^] | 470 | RTCStatsMember<uint32_t> key_frames_encoded; |
Henrik Boström | f71362f | 2019-04-08 16:14:23 +0200 | [diff] [blame] | 471 | RTCStatsMember<double> total_encode_time; |
Henrik Boström | 23aff9b | 2019-05-20 15:15:38 +0200 | [diff] [blame] | 472 | RTCStatsMember<uint64_t> total_encoded_bytes_target; |
Henrik Boström | 9fe1834 | 2019-05-16 18:38:20 +0200 | [diff] [blame] | 473 | // TODO(https://crbug.com/webrtc/10635): This is only implemented for video; |
| 474 | // implement it for audio as well. |
| 475 | RTCStatsMember<double> total_packet_send_delay; |
Henrik Boström | ce33b6a | 2019-05-28 17:42:38 +0200 | [diff] [blame] | 476 | // Enum type RTCQualityLimitationReason |
| 477 | // TODO(https://crbug.com/webrtc/10686): Also expose |
| 478 | // qualityLimitationDurations. Requires RTCStatsMember support for |
| 479 | // "record<DOMString, double>", see https://crbug.com/webrtc/10685. |
| 480 | RTCStatsMember<std::string> quality_limitation_reason; |
Henrik Boström | 2e06926 | 2019-04-09 13:59:31 +0200 | [diff] [blame] | 481 | // https://henbos.github.io/webrtc-provisional-stats/#dom-rtcoutboundrtpstreamstats-contenttype |
| 482 | RTCStatsMember<std::string> content_type; |
hbos | 6ded190 | 2016-11-01 01:50:46 -0700 | [diff] [blame] | 483 | }; |
| 484 | |
Henrik Boström | 883eefc | 2019-05-27 13:40:25 +0200 | [diff] [blame] | 485 | // TODO(https://crbug.com/webrtc/10671): Refactor the stats dictionaries to have |
| 486 | // the same hierarchy as in the spec; implement RTCReceivedRtpStreamStats. |
| 487 | // Several metrics are shared between "outbound-rtp", "remote-inbound-rtp", |
| 488 | // "inbound-rtp" and "remote-outbound-rtp". In the spec there is a hierarchy of |
| 489 | // dictionaries that minimizes defining the same metrics in multiple places. |
| 490 | // From JavaScript this hierarchy is not observable and the spec's hierarchy is |
| 491 | // purely editorial. In C++ non-final classes in the hierarchy could be used to |
| 492 | // refer to different stats objects within the hierarchy. |
| 493 | // https://w3c.github.io/webrtc-stats/#remoteinboundrtpstats-dict* |
| 494 | class RTC_EXPORT RTCRemoteInboundRtpStreamStats final : public RTCStats { |
| 495 | public: |
| 496 | WEBRTC_RTCSTATS_DECL(); |
| 497 | |
| 498 | RTCRemoteInboundRtpStreamStats(const std::string& id, int64_t timestamp_us); |
| 499 | RTCRemoteInboundRtpStreamStats(std::string&& id, int64_t timestamp_us); |
| 500 | RTCRemoteInboundRtpStreamStats(const RTCRemoteInboundRtpStreamStats& other); |
| 501 | ~RTCRemoteInboundRtpStreamStats() override; |
| 502 | |
| 503 | // In the spec RTCRemoteInboundRtpStreamStats inherits from RTCRtpStreamStats |
| 504 | // and RTCReceivedRtpStreamStats. The members here are listed based on where |
| 505 | // they are defined in the spec. |
| 506 | // RTCRtpStreamStats |
| 507 | RTCStatsMember<uint32_t> ssrc; |
| 508 | RTCStatsMember<std::string> kind; |
| 509 | RTCStatsMember<std::string> transport_id; |
| 510 | RTCStatsMember<std::string> codec_id; |
| 511 | // RTCReceivedRtpStreamStats |
| 512 | RTCStatsMember<int32_t> packets_lost; |
| 513 | RTCStatsMember<double> jitter; |
| 514 | // TODO(hbos): The following RTCReceivedRtpStreamStats metrics should also be |
| 515 | // implemented: packetsReceived, packetsDiscarded, packetsRepaired, |
| 516 | // burstPacketsLost, burstPacketsDiscarded, burstLossCount, burstDiscardCount, |
| 517 | // burstLossRate, burstDiscardRate, gapLossRate and gapDiscardRate. |
| 518 | // RTCRemoteInboundRtpStreamStats |
| 519 | RTCStatsMember<std::string> local_id; |
| 520 | RTCStatsMember<double> round_trip_time; |
| 521 | // TODO(hbos): The following RTCRemoteInboundRtpStreamStats metric should also |
| 522 | // be implemented: fractionLost. |
| 523 | }; |
| 524 | |
Henrik Boström | 646fda0 | 2019-05-22 15:49:42 +0200 | [diff] [blame] | 525 | // https://w3c.github.io/webrtc-stats/#dom-rtcmediasourcestats |
| 526 | class RTC_EXPORT RTCMediaSourceStats : public RTCStats { |
| 527 | public: |
| 528 | WEBRTC_RTCSTATS_DECL(); |
| 529 | |
| 530 | RTCMediaSourceStats(const RTCMediaSourceStats& other); |
| 531 | ~RTCMediaSourceStats() override; |
| 532 | |
| 533 | RTCStatsMember<std::string> track_identifier; |
| 534 | RTCStatsMember<std::string> kind; |
| 535 | |
| 536 | protected: |
| 537 | RTCMediaSourceStats(const std::string& id, int64_t timestamp_us); |
| 538 | RTCMediaSourceStats(std::string&& id, int64_t timestamp_us); |
| 539 | }; |
| 540 | |
| 541 | // https://w3c.github.io/webrtc-stats/#dom-rtcaudiosourcestats |
| 542 | class RTC_EXPORT RTCAudioSourceStats final : public RTCMediaSourceStats { |
| 543 | public: |
| 544 | WEBRTC_RTCSTATS_DECL(); |
| 545 | |
| 546 | RTCAudioSourceStats(const std::string& id, int64_t timestamp_us); |
| 547 | RTCAudioSourceStats(std::string&& id, int64_t timestamp_us); |
| 548 | RTCAudioSourceStats(const RTCAudioSourceStats& other); |
| 549 | ~RTCAudioSourceStats() override; |
| 550 | }; |
| 551 | |
| 552 | // https://w3c.github.io/webrtc-stats/#dom-rtcvideosourcestats |
| 553 | class RTC_EXPORT RTCVideoSourceStats final : public RTCMediaSourceStats { |
| 554 | public: |
| 555 | WEBRTC_RTCSTATS_DECL(); |
| 556 | |
| 557 | RTCVideoSourceStats(const std::string& id, int64_t timestamp_us); |
| 558 | RTCVideoSourceStats(std::string&& id, int64_t timestamp_us); |
| 559 | RTCVideoSourceStats(const RTCVideoSourceStats& other); |
| 560 | ~RTCVideoSourceStats() override; |
| 561 | |
| 562 | RTCStatsMember<uint32_t> width; |
| 563 | RTCStatsMember<uint32_t> height; |
| 564 | // TODO(hbos): Implement this metric. |
| 565 | RTCStatsMember<uint32_t> frames; |
| 566 | RTCStatsMember<uint32_t> frames_per_second; |
| 567 | }; |
| 568 | |
hbos | 2fa7c67 | 2016-10-24 04:00:05 -0700 | [diff] [blame] | 569 | // https://w3c.github.io/webrtc-stats/#transportstats-dict* |
Mirko Bonadei | 276827c | 2018-10-16 14:13:50 +0200 | [diff] [blame] | 570 | class RTC_EXPORT RTCTransportStats final : public RTCStats { |
hbos | 2fa7c67 | 2016-10-24 04:00:05 -0700 | [diff] [blame] | 571 | public: |
| 572 | WEBRTC_RTCSTATS_DECL(); |
| 573 | |
| 574 | RTCTransportStats(const std::string& id, int64_t timestamp_us); |
| 575 | RTCTransportStats(std::string&& id, int64_t timestamp_us); |
| 576 | RTCTransportStats(const RTCTransportStats& other); |
| 577 | ~RTCTransportStats() override; |
| 578 | |
| 579 | RTCStatsMember<uint64_t> bytes_sent; |
| 580 | RTCStatsMember<uint64_t> bytes_received; |
| 581 | RTCStatsMember<std::string> rtcp_transport_stats_id; |
hbos | 7064d59 | 2017-01-16 07:38:02 -0800 | [diff] [blame] | 582 | // TODO(hbos): Support enum types? "RTCStatsMember<RTCDtlsTransportState>"? |
| 583 | RTCStatsMember<std::string> dtls_state; |
hbos | 2fa7c67 | 2016-10-24 04:00:05 -0700 | [diff] [blame] | 584 | RTCStatsMember<std::string> selected_candidate_pair_id; |
| 585 | RTCStatsMember<std::string> local_certificate_id; |
| 586 | RTCStatsMember<std::string> remote_certificate_id; |
| 587 | }; |
| 588 | |
hbos | d565b73 | 2016-08-30 14:04:35 -0700 | [diff] [blame] | 589 | } // namespace webrtc |
| 590 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 591 | #endif // API_STATS_RTCSTATS_OBJECTS_H_ |