1 /*
2 * Copyright 2012 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
11 #include "pc/stats_collector.h"
12
13 #include <stddef.h>
14 #include <stdint.h>
15
16 #include <memory>
17 #include <set>
18 #include <utility>
19 #include <vector>
20
21 #include "absl/types/optional.h"
22 #include "api/audio_codecs/audio_encoder.h"
23 #include "api/candidate.h"
24 #include "api/data_channel_interface.h"
25 #include "api/media_types.h"
26 #include "api/rtp_receiver_interface.h"
27 #include "api/rtp_sender_interface.h"
28 #include "api/scoped_refptr.h"
29 #include "api/sequence_checker.h"
30 #include "api/video/video_content_type.h"
31 #include "api/video/video_timing.h"
32 #include "call/call.h"
33 #include "media/base/media_channel.h"
34 #include "modules/audio_processing/include/audio_processing_statistics.h"
35 #include "p2p/base/ice_transport_internal.h"
36 #include "p2p/base/p2p_constants.h"
37 #include "pc/channel.h"
38 #include "pc/channel_interface.h"
39 #include "pc/data_channel_utils.h"
40 #include "pc/rtp_receiver.h"
41 #include "pc/rtp_transceiver.h"
42 #include "pc/transport_stats.h"
43 #include "rtc_base/checks.h"
44 #include "rtc_base/ip_address.h"
45 #include "rtc_base/location.h"
46 #include "rtc_base/logging.h"
47 #include "rtc_base/rtc_certificate.h"
48 #include "rtc_base/socket_address.h"
49 #include "rtc_base/ssl_stream_adapter.h"
50 #include "rtc_base/string_encode.h"
51 #include "rtc_base/thread.h"
52 #include "rtc_base/time_utils.h"
53 #include "system_wrappers/include/field_trial.h"
54
55 namespace webrtc {
56 namespace {
57
58 // Field trial which controls whether to report standard-compliant bytes
59 // sent/received per stream. If enabled, padding and headers are not included
60 // in bytes sent or received.
61 constexpr char kUseStandardBytesStats[] = "WebRTC-UseStandardBytesStats";
62
63 // The following is the enum RTCStatsIceCandidateType from
64 // http://w3c.github.io/webrtc-stats/#rtcstatsicecandidatetype-enum such that
65 // our stats report for ice candidate type could conform to that.
66 const char STATSREPORT_LOCAL_PORT_TYPE[] = "host";
67 const char STATSREPORT_STUN_PORT_TYPE[] = "serverreflexive";
68 const char STATSREPORT_PRFLX_PORT_TYPE[] = "peerreflexive";
69 const char STATSREPORT_RELAY_PORT_TYPE[] = "relayed";
70
71 // Strings used by the stats collector to report adapter types. This fits the
72 // general stype of http://w3c.github.io/webrtc-stats than what
73 // AdapterTypeToString does.
74 const char* STATSREPORT_ADAPTER_TYPE_ETHERNET = "lan";
75 const char* STATSREPORT_ADAPTER_TYPE_WIFI = "wlan";
76 const char* STATSREPORT_ADAPTER_TYPE_WWAN = "wwan";
77 const char* STATSREPORT_ADAPTER_TYPE_VPN = "vpn";
78 const char* STATSREPORT_ADAPTER_TYPE_LOOPBACK = "loopback";
79 const char* STATSREPORT_ADAPTER_TYPE_WILDCARD = "wildcard";
80
81 template <typename ValueType>
82 struct TypeForAdd {
83 const StatsReport::StatsValueName name;
84 const ValueType& value;
85 };
86
87 typedef TypeForAdd<bool> BoolForAdd;
88 typedef TypeForAdd<float> FloatForAdd;
89 typedef TypeForAdd<int64_t> Int64ForAdd;
90 typedef TypeForAdd<int> IntForAdd;
91
AddTrackReport(StatsCollection * reports,const std::string & track_id)92 StatsReport* AddTrackReport(StatsCollection* reports,
93 const std::string& track_id) {
94 // Adds an empty track report.
95 StatsReport::Id id(
96 StatsReport::NewTypedId(StatsReport::kStatsReportTypeTrack, track_id));
97 StatsReport* report = reports->ReplaceOrAddNew(id);
98 report->AddString(StatsReport::kStatsValueNameTrackId, track_id);
99 return report;
100 }
101
102 template <class Track>
CreateTrackReport(const Track * track,StatsCollection * reports,TrackIdMap * track_ids)103 void CreateTrackReport(const Track* track,
104 StatsCollection* reports,
105 TrackIdMap* track_ids) {
106 const std::string& track_id = track->id();
107 StatsReport* report = AddTrackReport(reports, track_id);
108 RTC_DCHECK(report != nullptr);
109 (*track_ids)[track_id] = report;
110 }
111
112 template <class TrackVector>
CreateTrackReports(const TrackVector & tracks,StatsCollection * reports,TrackIdMap * track_ids)113 void CreateTrackReports(const TrackVector& tracks,
114 StatsCollection* reports,
115 TrackIdMap* track_ids) {
116 for (const auto& track : tracks) {
117 CreateTrackReport(track.get(), reports, track_ids);
118 }
119 }
120
ExtractCommonSendProperties(const cricket::MediaSenderInfo & info,StatsReport * report,bool use_standard_bytes_stats)121 void ExtractCommonSendProperties(const cricket::MediaSenderInfo& info,
122 StatsReport* report,
123 bool use_standard_bytes_stats) {
124 report->AddString(StatsReport::kStatsValueNameCodecName, info.codec_name);
125 int64_t bytes_sent = info.payload_bytes_sent;
126 if (!use_standard_bytes_stats) {
127 bytes_sent += info.header_and_padding_bytes_sent;
128 }
129 report->AddInt64(StatsReport::kStatsValueNameBytesSent, bytes_sent);
130 if (info.rtt_ms >= 0) {
131 report->AddInt64(StatsReport::kStatsValueNameRtt, info.rtt_ms);
132 }
133 }
134
ExtractCommonReceiveProperties(const cricket::MediaReceiverInfo & info,StatsReport * report)135 void ExtractCommonReceiveProperties(const cricket::MediaReceiverInfo& info,
136 StatsReport* report) {
137 report->AddString(StatsReport::kStatsValueNameCodecName, info.codec_name);
138 }
139
SetAudioProcessingStats(StatsReport * report,bool typing_noise_detected,const AudioProcessingStats & apm_stats)140 void SetAudioProcessingStats(StatsReport* report,
141 bool typing_noise_detected,
142 const AudioProcessingStats& apm_stats) {
143 report->AddBoolean(StatsReport::kStatsValueNameTypingNoiseState,
144 typing_noise_detected);
145 if (apm_stats.delay_median_ms) {
146 report->AddInt(StatsReport::kStatsValueNameEchoDelayMedian,
147 *apm_stats.delay_median_ms);
148 }
149 if (apm_stats.delay_standard_deviation_ms) {
150 report->AddInt(StatsReport::kStatsValueNameEchoDelayStdDev,
151 *apm_stats.delay_standard_deviation_ms);
152 }
153 if (apm_stats.echo_return_loss) {
154 report->AddInt(StatsReport::kStatsValueNameEchoReturnLoss,
155 *apm_stats.echo_return_loss);
156 }
157 if (apm_stats.echo_return_loss_enhancement) {
158 report->AddInt(StatsReport::kStatsValueNameEchoReturnLossEnhancement,
159 *apm_stats.echo_return_loss_enhancement);
160 }
161 if (apm_stats.residual_echo_likelihood) {
162 report->AddFloat(StatsReport::kStatsValueNameResidualEchoLikelihood,
163 static_cast<float>(*apm_stats.residual_echo_likelihood));
164 }
165 if (apm_stats.residual_echo_likelihood_recent_max) {
166 report->AddFloat(
167 StatsReport::kStatsValueNameResidualEchoLikelihoodRecentMax,
168 static_cast<float>(*apm_stats.residual_echo_likelihood_recent_max));
169 }
170 if (apm_stats.divergent_filter_fraction) {
171 report->AddFloat(StatsReport::kStatsValueNameAecDivergentFilterFraction,
172 static_cast<float>(*apm_stats.divergent_filter_fraction));
173 }
174 }
175
ExtractStats(const cricket::VoiceReceiverInfo & info,StatsReport * report,bool use_standard_bytes_stats)176 void ExtractStats(const cricket::VoiceReceiverInfo& info,
177 StatsReport* report,
178 bool use_standard_bytes_stats) {
179 ExtractCommonReceiveProperties(info, report);
180 const FloatForAdd floats[] = {
181 {StatsReport::kStatsValueNameExpandRate, info.expand_rate},
182 {StatsReport::kStatsValueNameSecondaryDecodedRate,
183 info.secondary_decoded_rate},
184 {StatsReport::kStatsValueNameSecondaryDiscardedRate,
185 info.secondary_discarded_rate},
186 {StatsReport::kStatsValueNameSpeechExpandRate, info.speech_expand_rate},
187 {StatsReport::kStatsValueNameAccelerateRate, info.accelerate_rate},
188 {StatsReport::kStatsValueNamePreemptiveExpandRate,
189 info.preemptive_expand_rate},
190 {StatsReport::kStatsValueNameTotalAudioEnergy, info.total_output_energy},
191 {StatsReport::kStatsValueNameTotalSamplesDuration,
192 info.total_output_duration}};
193
194 const IntForAdd ints[] = {
195 {StatsReport::kStatsValueNameCurrentDelayMs, info.delay_estimate_ms},
196 {StatsReport::kStatsValueNameDecodingCNG, info.decoding_cng},
197 {StatsReport::kStatsValueNameDecodingCTN, info.decoding_calls_to_neteq},
198 {StatsReport::kStatsValueNameDecodingCTSG,
199 info.decoding_calls_to_silence_generator},
200 {StatsReport::kStatsValueNameDecodingMutedOutput,
201 info.decoding_muted_output},
202 {StatsReport::kStatsValueNameDecodingNormal, info.decoding_normal},
203 {StatsReport::kStatsValueNameDecodingPLC, info.decoding_plc},
204 {StatsReport::kStatsValueNameDecodingPLCCNG, info.decoding_plc_cng},
205 {StatsReport::kStatsValueNameJitterBufferMs, info.jitter_buffer_ms},
206 {StatsReport::kStatsValueNameJitterReceived, info.jitter_ms},
207 {StatsReport::kStatsValueNamePacketsLost, info.packets_lost},
208 {StatsReport::kStatsValueNamePacketsReceived, info.packets_rcvd},
209 {StatsReport::kStatsValueNamePreferredJitterBufferMs,
210 info.jitter_buffer_preferred_ms},
211 };
212
213 for (const auto& f : floats)
214 report->AddFloat(f.name, f.value);
215
216 for (const auto& i : ints)
217 report->AddInt(i.name, i.value);
218 if (info.audio_level >= 0) {
219 report->AddInt(StatsReport::kStatsValueNameAudioOutputLevel,
220 info.audio_level);
221 }
222 if (info.decoding_codec_plc)
223 report->AddInt(StatsReport::kStatsValueNameDecodingCodecPLC,
224 info.decoding_codec_plc);
225
226 int64_t bytes_rcvd = info.payload_bytes_rcvd;
227 if (!use_standard_bytes_stats) {
228 bytes_rcvd += info.header_and_padding_bytes_rcvd;
229 }
230 report->AddInt64(StatsReport::kStatsValueNameBytesReceived, bytes_rcvd);
231 if (info.capture_start_ntp_time_ms >= 0) {
232 report->AddInt64(StatsReport::kStatsValueNameCaptureStartNtpTimeMs,
233 info.capture_start_ntp_time_ms);
234 }
235 report->AddString(StatsReport::kStatsValueNameMediaType, "audio");
236 }
237
ExtractStats(const cricket::VoiceSenderInfo & info,StatsReport * report,bool use_standard_bytes_stats)238 void ExtractStats(const cricket::VoiceSenderInfo& info,
239 StatsReport* report,
240 bool use_standard_bytes_stats) {
241 ExtractCommonSendProperties(info, report, use_standard_bytes_stats);
242
243 SetAudioProcessingStats(report, info.typing_noise_detected,
244 info.apm_statistics);
245
246 const FloatForAdd floats[] = {
247 {StatsReport::kStatsValueNameTotalAudioEnergy, info.total_input_energy},
248 {StatsReport::kStatsValueNameTotalSamplesDuration,
249 info.total_input_duration}};
250
251 RTC_DCHECK_GE(info.audio_level, 0);
252 const IntForAdd ints[] = {
253 {StatsReport::kStatsValueNameAudioInputLevel, info.audio_level},
254 {StatsReport::kStatsValueNameJitterReceived, info.jitter_ms},
255 {StatsReport::kStatsValueNamePacketsLost, info.packets_lost},
256 {StatsReport::kStatsValueNamePacketsSent, info.packets_sent},
257 };
258
259 for (const auto& f : floats) {
260 report->AddFloat(f.name, f.value);
261 }
262
263 for (const auto& i : ints) {
264 if (i.value >= 0) {
265 report->AddInt(i.name, i.value);
266 }
267 }
268 report->AddString(StatsReport::kStatsValueNameMediaType, "audio");
269 if (info.ana_statistics.bitrate_action_counter) {
270 report->AddInt(StatsReport::kStatsValueNameAnaBitrateActionCounter,
271 *info.ana_statistics.bitrate_action_counter);
272 }
273 if (info.ana_statistics.channel_action_counter) {
274 report->AddInt(StatsReport::kStatsValueNameAnaChannelActionCounter,
275 *info.ana_statistics.channel_action_counter);
276 }
277 if (info.ana_statistics.dtx_action_counter) {
278 report->AddInt(StatsReport::kStatsValueNameAnaDtxActionCounter,
279 *info.ana_statistics.dtx_action_counter);
280 }
281 if (info.ana_statistics.fec_action_counter) {
282 report->AddInt(StatsReport::kStatsValueNameAnaFecActionCounter,
283 *info.ana_statistics.fec_action_counter);
284 }
285 if (info.ana_statistics.frame_length_increase_counter) {
286 report->AddInt(StatsReport::kStatsValueNameAnaFrameLengthIncreaseCounter,
287 *info.ana_statistics.frame_length_increase_counter);
288 }
289 if (info.ana_statistics.frame_length_decrease_counter) {
290 report->AddInt(StatsReport::kStatsValueNameAnaFrameLengthDecreaseCounter,
291 *info.ana_statistics.frame_length_decrease_counter);
292 }
293 if (info.ana_statistics.uplink_packet_loss_fraction) {
294 report->AddFloat(StatsReport::kStatsValueNameAnaUplinkPacketLossFraction,
295 *info.ana_statistics.uplink_packet_loss_fraction);
296 }
297 }
298
ExtractStats(const cricket::VideoReceiverInfo & info,StatsReport * report,bool use_standard_bytes_stats)299 void ExtractStats(const cricket::VideoReceiverInfo& info,
300 StatsReport* report,
301 bool use_standard_bytes_stats) {
302 ExtractCommonReceiveProperties(info, report);
303 report->AddString(StatsReport::kStatsValueNameCodecImplementationName,
304 info.decoder_implementation_name);
305 int64_t bytes_rcvd = info.payload_bytes_rcvd;
306 if (!use_standard_bytes_stats) {
307 bytes_rcvd += info.header_and_padding_bytes_rcvd;
308 }
309 report->AddInt64(StatsReport::kStatsValueNameBytesReceived, bytes_rcvd);
310 if (info.capture_start_ntp_time_ms >= 0) {
311 report->AddInt64(StatsReport::kStatsValueNameCaptureStartNtpTimeMs,
312 info.capture_start_ntp_time_ms);
313 }
314 if (info.first_frame_received_to_decoded_ms >= 0) {
315 report->AddInt64(StatsReport::kStatsValueNameFirstFrameReceivedToDecodedMs,
316 info.first_frame_received_to_decoded_ms);
317 }
318 if (info.qp_sum)
319 report->AddInt64(StatsReport::kStatsValueNameQpSum, *info.qp_sum);
320
321 const IntForAdd ints[] = {
322 {StatsReport::kStatsValueNameCurrentDelayMs, info.current_delay_ms},
323 {StatsReport::kStatsValueNameDecodeMs, info.decode_ms},
324 {StatsReport::kStatsValueNameFirsSent, info.firs_sent},
325 {StatsReport::kStatsValueNameFrameHeightReceived, info.frame_height},
326 {StatsReport::kStatsValueNameFrameRateDecoded, info.framerate_decoded},
327 {StatsReport::kStatsValueNameFrameRateOutput, info.framerate_output},
328 {StatsReport::kStatsValueNameFrameRateReceived, info.framerate_rcvd},
329 {StatsReport::kStatsValueNameFrameWidthReceived, info.frame_width},
330 {StatsReport::kStatsValueNameJitterBufferMs, info.jitter_buffer_ms},
331 {StatsReport::kStatsValueNameMaxDecodeMs, info.max_decode_ms},
332 {StatsReport::kStatsValueNameMinPlayoutDelayMs,
333 info.min_playout_delay_ms},
334 {StatsReport::kStatsValueNameNacksSent, info.nacks_sent},
335 {StatsReport::kStatsValueNamePacketsLost, info.packets_lost},
336 {StatsReport::kStatsValueNamePacketsReceived, info.packets_rcvd},
337 {StatsReport::kStatsValueNamePlisSent, info.plis_sent},
338 {StatsReport::kStatsValueNameRenderDelayMs, info.render_delay_ms},
339 {StatsReport::kStatsValueNameTargetDelayMs, info.target_delay_ms},
340 {StatsReport::kStatsValueNameFramesDecoded, info.frames_decoded},
341 };
342
343 for (const auto& i : ints)
344 report->AddInt(i.name, i.value);
345 report->AddString(StatsReport::kStatsValueNameMediaType, "video");
346
347 if (info.timing_frame_info) {
348 report->AddString(StatsReport::kStatsValueNameTimingFrameInfo,
349 info.timing_frame_info->ToString());
350 }
351
352 report->AddInt64(StatsReport::kStatsValueNameInterframeDelayMaxMs,
353 info.interframe_delay_max_ms);
354
355 report->AddString(
356 StatsReport::kStatsValueNameContentType,
357 webrtc::videocontenttypehelpers::ToString(info.content_type));
358 }
359
ExtractStats(const cricket::VideoSenderInfo & info,StatsReport * report,bool use_standard_bytes_stats)360 void ExtractStats(const cricket::VideoSenderInfo& info,
361 StatsReport* report,
362 bool use_standard_bytes_stats) {
363 ExtractCommonSendProperties(info, report, use_standard_bytes_stats);
364
365 report->AddString(StatsReport::kStatsValueNameCodecImplementationName,
366 info.encoder_implementation_name);
367 report->AddBoolean(StatsReport::kStatsValueNameBandwidthLimitedResolution,
368 (info.adapt_reason & 0x2) > 0);
369 report->AddBoolean(StatsReport::kStatsValueNameCpuLimitedResolution,
370 (info.adapt_reason & 0x1) > 0);
371 report->AddBoolean(StatsReport::kStatsValueNameHasEnteredLowResolution,
372 info.has_entered_low_resolution);
373
374 if (info.qp_sum)
375 report->AddInt(StatsReport::kStatsValueNameQpSum, *info.qp_sum);
376
377 const IntForAdd ints[] = {
378 {StatsReport::kStatsValueNameAdaptationChanges, info.adapt_changes},
379 {StatsReport::kStatsValueNameAvgEncodeMs, info.avg_encode_ms},
380 {StatsReport::kStatsValueNameEncodeUsagePercent,
381 info.encode_usage_percent},
382 {StatsReport::kStatsValueNameFirsReceived, info.firs_rcvd},
383 {StatsReport::kStatsValueNameFrameHeightSent, info.send_frame_height},
384 {StatsReport::kStatsValueNameFrameRateInput, info.framerate_input},
385 {StatsReport::kStatsValueNameFrameRateSent, info.framerate_sent},
386 {StatsReport::kStatsValueNameFrameWidthSent, info.send_frame_width},
387 {StatsReport::kStatsValueNameNacksReceived, info.nacks_rcvd},
388 {StatsReport::kStatsValueNamePacketsLost, info.packets_lost},
389 {StatsReport::kStatsValueNamePacketsSent, info.packets_sent},
390 {StatsReport::kStatsValueNamePlisReceived, info.plis_rcvd},
391 {StatsReport::kStatsValueNameFramesEncoded, info.frames_encoded},
392 {StatsReport::kStatsValueNameHugeFramesSent, info.huge_frames_sent},
393 };
394
395 for (const auto& i : ints)
396 report->AddInt(i.name, i.value);
397 report->AddString(StatsReport::kStatsValueNameMediaType, "video");
398 report->AddString(
399 StatsReport::kStatsValueNameContentType,
400 webrtc::videocontenttypehelpers::ToString(info.content_type));
401 }
402
ExtractStats(const cricket::BandwidthEstimationInfo & info,double stats_gathering_started,StatsReport * report)403 void ExtractStats(const cricket::BandwidthEstimationInfo& info,
404 double stats_gathering_started,
405 StatsReport* report) {
406 RTC_DCHECK(report->type() == StatsReport::kStatsReportTypeBwe);
407
408 report->set_timestamp(stats_gathering_started);
409 const IntForAdd ints[] = {
410 {StatsReport::kStatsValueNameAvailableSendBandwidth,
411 info.available_send_bandwidth},
412 {StatsReport::kStatsValueNameAvailableReceiveBandwidth,
413 info.available_recv_bandwidth},
414 {StatsReport::kStatsValueNameTargetEncBitrate, info.target_enc_bitrate},
415 {StatsReport::kStatsValueNameActualEncBitrate, info.actual_enc_bitrate},
416 {StatsReport::kStatsValueNameRetransmitBitrate, info.retransmit_bitrate},
417 {StatsReport::kStatsValueNameTransmitBitrate, info.transmit_bitrate},
418 };
419 for (const auto& i : ints)
420 report->AddInt(i.name, i.value);
421 report->AddInt64(StatsReport::kStatsValueNameBucketDelay, info.bucket_delay);
422 }
423
ExtractRemoteStats(const cricket::MediaSenderInfo & info,StatsReport * report)424 void ExtractRemoteStats(const cricket::MediaSenderInfo& info,
425 StatsReport* report) {
426 report->set_timestamp(info.remote_stats[0].timestamp);
427 // TODO(hta): Extract some stats here.
428 }
429
ExtractRemoteStats(const cricket::MediaReceiverInfo & info,StatsReport * report)430 void ExtractRemoteStats(const cricket::MediaReceiverInfo& info,
431 StatsReport* report) {
432 report->set_timestamp(info.remote_stats[0].timestamp);
433 // TODO(hta): Extract some stats here.
434 }
435
GetTrackIdBySsrc(uint32_t ssrc,StatsReport::Direction direction,const std::map<uint32_t,std::string> & track_id_by_ssrc)436 std::string GetTrackIdBySsrc(
437 uint32_t ssrc,
438 StatsReport::Direction direction,
439 const std::map<uint32_t, std::string>& track_id_by_ssrc) {
440 auto it = track_id_by_ssrc.find(ssrc);
441 if (it != track_id_by_ssrc.end()) {
442 return it->second;
443 }
444 if (direction == StatsReport::kReceive) {
445 // If the track ID was not found, this might be an unsignaled receive
446 // SSRC, so try looking up by the special SSRC 0.
447 it = track_id_by_ssrc.find(0);
448 if (it != track_id_by_ssrc.end()) {
449 RTC_LOG(LS_INFO) << "Assuming SSRC=" << ssrc
450 << " is an unsignalled receive stream corresponding "
451 "to the RtpReceiver with track ID \""
452 << it->second << "\".";
453 return it->second;
454 }
455 }
456 return "";
457 }
458
459 // Template to extract stats from a data vector.
460 // In order to use the template, the functions that are called from it,
461 // ExtractStats and ExtractRemoteStats, must be defined and overloaded
462 // for each type.
463 template <typename T>
ExtractStatsFromList(const std::vector<T> & data,const StatsReport::Id & transport_id,StatsCollector * collector,StatsReport::Direction direction,const std::map<uint32_t,std::string> & track_id_by_ssrc)464 void ExtractStatsFromList(
465 const std::vector<T>& data,
466 const StatsReport::Id& transport_id,
467 StatsCollector* collector,
468 StatsReport::Direction direction,
469 const std::map<uint32_t, std::string>& track_id_by_ssrc) {
470 for (const auto& d : data) {
471 uint32_t ssrc = d.ssrc();
472 std::string track_id = GetTrackIdBySsrc(ssrc, direction, track_id_by_ssrc);
473 // Each track can have stats for both local and remote objects.
474 // TODO(hta): Handle the case of multiple SSRCs per object.
475 StatsReport* report =
476 collector->PrepareReport(true, ssrc, track_id, transport_id, direction);
477 if (report)
478 ExtractStats(d, report, collector->UseStandardBytesStats());
479
480 if (!d.remote_stats.empty()) {
481 report = collector->PrepareReport(false, ssrc, track_id, transport_id,
482 direction);
483 if (report)
484 ExtractRemoteStats(d, report);
485 }
486 }
487 }
488
489 } // namespace
490
IceCandidateTypeToStatsType(const std::string & candidate_type)491 const char* IceCandidateTypeToStatsType(const std::string& candidate_type) {
492 if (candidate_type == cricket::LOCAL_PORT_TYPE) {
493 return STATSREPORT_LOCAL_PORT_TYPE;
494 }
495 if (candidate_type == cricket::STUN_PORT_TYPE) {
496 return STATSREPORT_STUN_PORT_TYPE;
497 }
498 if (candidate_type == cricket::PRFLX_PORT_TYPE) {
499 return STATSREPORT_PRFLX_PORT_TYPE;
500 }
501 if (candidate_type == cricket::RELAY_PORT_TYPE) {
502 return STATSREPORT_RELAY_PORT_TYPE;
503 }
504 RTC_NOTREACHED();
505 return "unknown";
506 }
507
AdapterTypeToStatsType(rtc::AdapterType type)508 const char* AdapterTypeToStatsType(rtc::AdapterType type) {
509 switch (type) {
510 case rtc::ADAPTER_TYPE_UNKNOWN:
511 return "unknown";
512 case rtc::ADAPTER_TYPE_ETHERNET:
513 return STATSREPORT_ADAPTER_TYPE_ETHERNET;
514 case rtc::ADAPTER_TYPE_WIFI:
515 return STATSREPORT_ADAPTER_TYPE_WIFI;
516 case rtc::ADAPTER_TYPE_CELLULAR:
517 case rtc::ADAPTER_TYPE_CELLULAR_2G:
518 case rtc::ADAPTER_TYPE_CELLULAR_3G:
519 case rtc::ADAPTER_TYPE_CELLULAR_4G:
520 case rtc::ADAPTER_TYPE_CELLULAR_5G:
521 return STATSREPORT_ADAPTER_TYPE_WWAN;
522 case rtc::ADAPTER_TYPE_VPN:
523 return STATSREPORT_ADAPTER_TYPE_VPN;
524 case rtc::ADAPTER_TYPE_LOOPBACK:
525 return STATSREPORT_ADAPTER_TYPE_LOOPBACK;
526 case rtc::ADAPTER_TYPE_ANY:
527 return STATSREPORT_ADAPTER_TYPE_WILDCARD;
528 default:
529 RTC_NOTREACHED();
530 return "";
531 }
532 }
533
StatsCollector(PeerConnectionInternal * pc)534 StatsCollector::StatsCollector(PeerConnectionInternal* pc)
535 : pc_(pc),
536 stats_gathering_started_(0),
537 use_standard_bytes_stats_(
538 webrtc::field_trial::IsEnabled(kUseStandardBytesStats)) {
539 RTC_DCHECK(pc_);
540 }
541
~StatsCollector()542 StatsCollector::~StatsCollector() {
543 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
544 }
545
546 // Wallclock time in ms.
GetTimeNow()547 double StatsCollector::GetTimeNow() {
548 return static_cast<double>(rtc::TimeUTCMillis());
549 }
550
551 // Adds a MediaStream with tracks that can be used as a |selector| in a call
552 // to GetStats.
AddStream(MediaStreamInterface * stream)553 void StatsCollector::AddStream(MediaStreamInterface* stream) {
554 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
555 RTC_DCHECK(stream != NULL);
556
557 CreateTrackReports<AudioTrackVector>(stream->GetAudioTracks(), &reports_,
558 &track_ids_);
559 CreateTrackReports<VideoTrackVector>(stream->GetVideoTracks(), &reports_,
560 &track_ids_);
561 }
562
AddTrack(MediaStreamTrackInterface * track)563 void StatsCollector::AddTrack(MediaStreamTrackInterface* track) {
564 if (track->kind() == MediaStreamTrackInterface::kAudioKind) {
565 CreateTrackReport(static_cast<AudioTrackInterface*>(track), &reports_,
566 &track_ids_);
567 } else if (track->kind() == MediaStreamTrackInterface::kVideoKind) {
568 CreateTrackReport(static_cast<VideoTrackInterface*>(track), &reports_,
569 &track_ids_);
570 } else {
571 RTC_NOTREACHED() << "Illegal track kind";
572 }
573 }
574
AddLocalAudioTrack(AudioTrackInterface * audio_track,uint32_t ssrc)575 void StatsCollector::AddLocalAudioTrack(AudioTrackInterface* audio_track,
576 uint32_t ssrc) {
577 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
578 RTC_DCHECK(audio_track != NULL);
579 #if RTC_DCHECK_IS_ON
580 for (const auto& track : local_audio_tracks_)
581 RTC_DCHECK(track.first != audio_track || track.second != ssrc);
582 #endif
583
584 local_audio_tracks_.push_back(std::make_pair(audio_track, ssrc));
585
586 // Create the kStatsReportTypeTrack report for the new track if there is no
587 // report yet.
588 StatsReport::Id id(StatsReport::NewTypedId(StatsReport::kStatsReportTypeTrack,
589 audio_track->id()));
590 StatsReport* report = reports_.Find(id);
591 if (!report) {
592 report = reports_.InsertNew(id);
593 report->AddString(StatsReport::kStatsValueNameTrackId, audio_track->id());
594 }
595 }
596
RemoveLocalAudioTrack(AudioTrackInterface * audio_track,uint32_t ssrc)597 void StatsCollector::RemoveLocalAudioTrack(AudioTrackInterface* audio_track,
598 uint32_t ssrc) {
599 RTC_DCHECK(audio_track != NULL);
600 local_audio_tracks_.erase(
601 std::remove_if(
602 local_audio_tracks_.begin(), local_audio_tracks_.end(),
603 [audio_track, ssrc](const LocalAudioTrackVector::value_type& track) {
604 return track.first == audio_track && track.second == ssrc;
605 }),
606 local_audio_tracks_.end());
607 }
608
GetStats(MediaStreamTrackInterface * track,StatsReports * reports)609 void StatsCollector::GetStats(MediaStreamTrackInterface* track,
610 StatsReports* reports) {
611 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
612 RTC_DCHECK(reports != NULL);
613 RTC_DCHECK(reports->empty());
614
615 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
616
617 if (!track) {
618 reports->reserve(reports_.size());
619 for (auto* r : reports_)
620 reports->push_back(r);
621 return;
622 }
623
624 StatsReport* report = reports_.Find(StatsReport::NewTypedId(
625 StatsReport::kStatsReportTypeSession, pc_->session_id()));
626 if (report)
627 reports->push_back(report);
628
629 report = reports_.Find(
630 StatsReport::NewTypedId(StatsReport::kStatsReportTypeTrack, track->id()));
631
632 if (!report)
633 return;
634
635 reports->push_back(report);
636
637 std::string track_id;
638 for (const auto* r : reports_) {
639 if (r->type() != StatsReport::kStatsReportTypeSsrc)
640 continue;
641
642 const StatsReport::Value* v =
643 r->FindValue(StatsReport::kStatsValueNameTrackId);
644 if (v && v->string_val() == track->id())
645 reports->push_back(r);
646 }
647 }
648
UpdateStats(PeerConnectionInterface::StatsOutputLevel level)649 void StatsCollector::UpdateStats(
650 PeerConnectionInterface::StatsOutputLevel level) {
651 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
652 // Calls to UpdateStats() that occur less than kMinGatherStatsPeriodMs apart
653 // will be ignored. Using a monotonic clock specifically for this, while using
654 // a UTC clock for the reports themselves.
655 const int64_t kMinGatherStatsPeriodMs = 50;
656 int64_t cache_now_ms = rtc::TimeMillis();
657 if (cache_timestamp_ms_ != 0 &&
658 cache_timestamp_ms_ + kMinGatherStatsPeriodMs > cache_now_ms) {
659 return;
660 }
661 cache_timestamp_ms_ = cache_now_ms;
662 stats_gathering_started_ = GetTimeNow();
663
664 // TODO(tommi): All of these hop over to the worker thread to fetch
665 // information. We could use an AsyncInvoker to run all of these and post
666 // the information back to the signaling thread where we can create and
667 // update stats reports. That would also clean up the threading story a bit
668 // since we'd be creating/updating the stats report objects consistently on
669 // the same thread (this class has no locks right now).
670 ExtractSessionInfo();
671 ExtractBweInfo();
672 ExtractMediaInfo();
673 ExtractSenderInfo();
674 ExtractDataInfo();
675 UpdateTrackReports();
676 }
677
PrepareReport(bool local,uint32_t ssrc,const std::string & track_id,const StatsReport::Id & transport_id,StatsReport::Direction direction)678 StatsReport* StatsCollector::PrepareReport(bool local,
679 uint32_t ssrc,
680 const std::string& track_id,
681 const StatsReport::Id& transport_id,
682 StatsReport::Direction direction) {
683 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
684 StatsReport::Id id(StatsReport::NewIdWithDirection(
685 local ? StatsReport::kStatsReportTypeSsrc
686 : StatsReport::kStatsReportTypeRemoteSsrc,
687 rtc::ToString(ssrc), direction));
688 StatsReport* report = reports_.Find(id);
689 if (!report) {
690 report = reports_.InsertNew(id);
691 }
692
693 // FYI - for remote reports, the timestamp will be overwritten later.
694 report->set_timestamp(stats_gathering_started_);
695
696 report->AddInt64(StatsReport::kStatsValueNameSsrc, ssrc);
697 if (!track_id.empty()) {
698 report->AddString(StatsReport::kStatsValueNameTrackId, track_id);
699 }
700 // Add the mapping of SSRC to transport.
701 report->AddId(StatsReport::kStatsValueNameTransportId, transport_id);
702 return report;
703 }
704
PrepareADMReport()705 StatsReport* StatsCollector::PrepareADMReport() {
706 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
707 StatsReport::Id id(StatsReport::NewTypedId(
708 StatsReport::kStatsReportTypeSession, pc_->session_id()));
709 StatsReport* report = reports_.FindOrAddNew(id);
710 return report;
711 }
712
IsValidTrack(const std::string & track_id)713 bool StatsCollector::IsValidTrack(const std::string& track_id) {
714 return reports_.Find(StatsReport::NewTypedId(
715 StatsReport::kStatsReportTypeTrack, track_id)) != nullptr;
716 }
717
AddCertificateReports(std::unique_ptr<rtc::SSLCertificateStats> cert_stats)718 StatsReport* StatsCollector::AddCertificateReports(
719 std::unique_ptr<rtc::SSLCertificateStats> cert_stats) {
720 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
721
722 StatsReport* first_report = nullptr;
723 StatsReport* prev_report = nullptr;
724 for (rtc::SSLCertificateStats* stats = cert_stats.get(); stats;
725 stats = stats->issuer.get()) {
726 StatsReport::Id id(StatsReport::NewTypedId(
727 StatsReport::kStatsReportTypeCertificate, stats->fingerprint));
728
729 StatsReport* report = reports_.ReplaceOrAddNew(id);
730 report->set_timestamp(stats_gathering_started_);
731 report->AddString(StatsReport::kStatsValueNameFingerprint,
732 stats->fingerprint);
733 report->AddString(StatsReport::kStatsValueNameFingerprintAlgorithm,
734 stats->fingerprint_algorithm);
735 report->AddString(StatsReport::kStatsValueNameDer,
736 stats->base64_certificate);
737 if (!first_report)
738 first_report = report;
739 else
740 prev_report->AddId(StatsReport::kStatsValueNameIssuerId, id);
741 prev_report = report;
742 }
743 return first_report;
744 }
745
AddConnectionInfoReport(const std::string & content_name,int component,int connection_id,const StatsReport::Id & channel_report_id,const cricket::ConnectionInfo & info)746 StatsReport* StatsCollector::AddConnectionInfoReport(
747 const std::string& content_name,
748 int component,
749 int connection_id,
750 const StatsReport::Id& channel_report_id,
751 const cricket::ConnectionInfo& info) {
752 StatsReport::Id id(
753 StatsReport::NewCandidatePairId(content_name, component, connection_id));
754 StatsReport* report = reports_.ReplaceOrAddNew(id);
755 report->set_timestamp(stats_gathering_started_);
756
757 const BoolForAdd bools[] = {
758 {StatsReport::kStatsValueNameActiveConnection, info.best_connection},
759 {StatsReport::kStatsValueNameReceiving, info.receiving},
760 {StatsReport::kStatsValueNameWritable, info.writable},
761 };
762 for (const auto& b : bools)
763 report->AddBoolean(b.name, b.value);
764
765 report->AddId(StatsReport::kStatsValueNameChannelId, channel_report_id);
766 cricket::CandidateStats local_candidate_stats(info.local_candidate);
767 cricket::CandidateStats remote_candidate_stats(info.remote_candidate);
768 report->AddId(StatsReport::kStatsValueNameLocalCandidateId,
769 AddCandidateReport(local_candidate_stats, true)->id());
770 report->AddId(StatsReport::kStatsValueNameRemoteCandidateId,
771 AddCandidateReport(remote_candidate_stats, false)->id());
772
773 const Int64ForAdd int64s[] = {
774 {StatsReport::kStatsValueNameBytesReceived, info.recv_total_bytes},
775 {StatsReport::kStatsValueNameBytesSent, info.sent_total_bytes},
776 {StatsReport::kStatsValueNamePacketsSent, info.sent_total_packets},
777 {StatsReport::kStatsValueNameRtt, info.rtt},
778 {StatsReport::kStatsValueNameSendPacketsDiscarded,
779 info.sent_discarded_packets},
780 {StatsReport::kStatsValueNameSentPingRequestsTotal,
781 info.sent_ping_requests_total},
782 {StatsReport::kStatsValueNameSentPingRequestsBeforeFirstResponse,
783 info.sent_ping_requests_before_first_response},
784 {StatsReport::kStatsValueNameSentPingResponses, info.sent_ping_responses},
785 {StatsReport::kStatsValueNameRecvPingRequests, info.recv_ping_requests},
786 {StatsReport::kStatsValueNameRecvPingResponses, info.recv_ping_responses},
787 };
788 for (const auto& i : int64s)
789 report->AddInt64(i.name, i.value);
790
791 report->AddString(StatsReport::kStatsValueNameLocalAddress,
792 info.local_candidate.address().ToString());
793 report->AddString(StatsReport::kStatsValueNameLocalCandidateType,
794 info.local_candidate.type());
795 report->AddString(StatsReport::kStatsValueNameRemoteAddress,
796 info.remote_candidate.address().ToString());
797 report->AddString(StatsReport::kStatsValueNameRemoteCandidateType,
798 info.remote_candidate.type());
799 report->AddString(StatsReport::kStatsValueNameTransportType,
800 info.local_candidate.protocol());
801
802 return report;
803 }
804
AddCandidateReport(const cricket::CandidateStats & candidate_stats,bool local)805 StatsReport* StatsCollector::AddCandidateReport(
806 const cricket::CandidateStats& candidate_stats,
807 bool local) {
808 const auto& candidate = candidate_stats.candidate;
809 StatsReport::Id id(StatsReport::NewCandidateId(local, candidate.id()));
810 StatsReport* report = reports_.Find(id);
811 if (!report) {
812 report = reports_.InsertNew(id);
813 report->set_timestamp(stats_gathering_started_);
814 if (local) {
815 report->AddString(StatsReport::kStatsValueNameCandidateNetworkType,
816 AdapterTypeToStatsType(candidate.network_type()));
817 }
818 report->AddString(StatsReport::kStatsValueNameCandidateIPAddress,
819 candidate.address().ipaddr().ToString());
820 report->AddString(StatsReport::kStatsValueNameCandidatePortNumber,
821 candidate.address().PortAsString());
822 report->AddInt(StatsReport::kStatsValueNameCandidatePriority,
823 candidate.priority());
824 report->AddString(StatsReport::kStatsValueNameCandidateType,
825 IceCandidateTypeToStatsType(candidate.type()));
826 report->AddString(StatsReport::kStatsValueNameCandidateTransportType,
827 candidate.protocol());
828 }
829 report->set_timestamp(stats_gathering_started_);
830
831 if (local && candidate_stats.stun_stats.has_value()) {
832 const auto& stun_stats = candidate_stats.stun_stats.value();
833 report->AddInt64(StatsReport::kStatsValueNameSentStunKeepaliveRequests,
834 stun_stats.stun_binding_requests_sent);
835 report->AddInt64(StatsReport::kStatsValueNameRecvStunKeepaliveResponses,
836 stun_stats.stun_binding_responses_received);
837 report->AddFloat(StatsReport::kStatsValueNameStunKeepaliveRttTotal,
838 stun_stats.stun_binding_rtt_ms_total);
839 report->AddFloat(StatsReport::kStatsValueNameStunKeepaliveRttSquaredTotal,
840 stun_stats.stun_binding_rtt_ms_squared_total);
841 }
842
843 return report;
844 }
845
ExtractSessionInfo()846 void StatsCollector::ExtractSessionInfo() {
847 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
848
849 // Extract information from the base session.
850 StatsReport::Id id(StatsReport::NewTypedId(
851 StatsReport::kStatsReportTypeSession, pc_->session_id()));
852 StatsReport* report = reports_.ReplaceOrAddNew(id);
853 report->set_timestamp(stats_gathering_started_);
854 report->AddBoolean(StatsReport::kStatsValueNameInitiator,
855 pc_->initial_offerer());
856
857 cricket::CandidateStatsList pooled_candidate_stats_list =
858 pc_->GetPooledCandidateStats();
859
860 for (const cricket::CandidateStats& stats : pooled_candidate_stats_list) {
861 AddCandidateReport(stats, true);
862 }
863
864 std::set<std::string> transport_names;
865 for (const auto& entry : pc_->GetTransportNamesByMid()) {
866 transport_names.insert(entry.second);
867 }
868
869 std::map<std::string, cricket::TransportStats> transport_stats_by_name =
870 pc_->GetTransportStatsByNames(transport_names);
871
872 for (const auto& entry : transport_stats_by_name) {
873 const std::string& transport_name = entry.first;
874 const cricket::TransportStats& transport_stats = entry.second;
875
876 // Attempt to get a copy of the certificates from the transport and
877 // expose them in stats reports. All channels in a transport share the
878 // same local and remote certificates.
879 //
880 StatsReport::Id local_cert_report_id, remote_cert_report_id;
881 rtc::scoped_refptr<rtc::RTCCertificate> certificate;
882 if (pc_->GetLocalCertificate(transport_name, &certificate)) {
883 StatsReport* r = AddCertificateReports(
884 certificate->GetSSLCertificateChain().GetStats());
885 if (r)
886 local_cert_report_id = r->id();
887 }
888
889 std::unique_ptr<rtc::SSLCertChain> remote_cert_chain =
890 pc_->GetRemoteSSLCertChain(transport_name);
891 if (remote_cert_chain) {
892 StatsReport* r = AddCertificateReports(remote_cert_chain->GetStats());
893 if (r)
894 remote_cert_report_id = r->id();
895 }
896
897 for (const auto& channel_iter : transport_stats.channel_stats) {
898 StatsReport::Id id(
899 StatsReport::NewComponentId(transport_name, channel_iter.component));
900 StatsReport* channel_report = reports_.ReplaceOrAddNew(id);
901 channel_report->set_timestamp(stats_gathering_started_);
902 channel_report->AddInt(StatsReport::kStatsValueNameComponent,
903 channel_iter.component);
904 if (local_cert_report_id.get()) {
905 channel_report->AddId(StatsReport::kStatsValueNameLocalCertificateId,
906 local_cert_report_id);
907 }
908 if (remote_cert_report_id.get()) {
909 channel_report->AddId(StatsReport::kStatsValueNameRemoteCertificateId,
910 remote_cert_report_id);
911 }
912 int srtp_crypto_suite = channel_iter.srtp_crypto_suite;
913 if (srtp_crypto_suite != rtc::SRTP_INVALID_CRYPTO_SUITE &&
914 rtc::SrtpCryptoSuiteToName(srtp_crypto_suite).length()) {
915 channel_report->AddString(
916 StatsReport::kStatsValueNameSrtpCipher,
917 rtc::SrtpCryptoSuiteToName(srtp_crypto_suite));
918 }
919 int ssl_cipher_suite = channel_iter.ssl_cipher_suite;
920 if (ssl_cipher_suite != rtc::TLS_NULL_WITH_NULL_NULL &&
921 rtc::SSLStreamAdapter::SslCipherSuiteToName(ssl_cipher_suite)
922 .length()) {
923 channel_report->AddString(
924 StatsReport::kStatsValueNameDtlsCipher,
925 rtc::SSLStreamAdapter::SslCipherSuiteToName(ssl_cipher_suite));
926 }
927
928 // Collect stats for non-pooled candidates. Note that the reports
929 // generated here supersedes the candidate reports generated in
930 // AddConnectionInfoReport below, and they may report candidates that are
931 // not paired. Also, the candidate report generated in
932 // AddConnectionInfoReport do not report port stats like StunStats.
933 for (const cricket::CandidateStats& stats :
934 channel_iter.ice_transport_stats.candidate_stats_list) {
935 AddCandidateReport(stats, true);
936 }
937
938 int connection_id = 0;
939 for (const cricket::ConnectionInfo& info :
940 channel_iter.ice_transport_stats.connection_infos) {
941 StatsReport* connection_report = AddConnectionInfoReport(
942 transport_name, channel_iter.component, connection_id++,
943 channel_report->id(), info);
944 if (info.best_connection) {
945 channel_report->AddId(
946 StatsReport::kStatsValueNameSelectedCandidatePairId,
947 connection_report->id());
948 }
949 }
950 }
951 }
952 }
953
ExtractBweInfo()954 void StatsCollector::ExtractBweInfo() {
955 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
956
957 if (pc_->signaling_state() == PeerConnectionInterface::kClosed)
958 return;
959
960 webrtc::Call::Stats call_stats = pc_->GetCallStats();
961 cricket::BandwidthEstimationInfo bwe_info;
962 bwe_info.available_send_bandwidth = call_stats.send_bandwidth_bps;
963 bwe_info.available_recv_bandwidth = call_stats.recv_bandwidth_bps;
964 bwe_info.bucket_delay = call_stats.pacer_delay_ms;
965
966 // Fill in target encoder bitrate, actual encoder bitrate, rtx bitrate, etc.
967 // TODO(holmer): Also fill this in for audio.
968 for (const auto& transceiver : pc_->GetTransceiversInternal()) {
969 if (transceiver->media_type() != cricket::MEDIA_TYPE_VIDEO) {
970 continue;
971 }
972 auto* video_channel =
973 static_cast<cricket::VideoChannel*>(transceiver->internal()->channel());
974 if (!video_channel) {
975 continue;
976 }
977 video_channel->FillBitrateInfo(&bwe_info);
978 }
979
980 StatsReport::Id report_id(StatsReport::NewBandwidthEstimationId());
981 StatsReport* report = reports_.FindOrAddNew(report_id);
982 ExtractStats(bwe_info, stats_gathering_started_, report);
983 }
984
985 namespace {
986
987 class MediaChannelStatsGatherer {
988 public:
989 virtual ~MediaChannelStatsGatherer() = default;
990
991 virtual bool GetStatsOnWorkerThread() = 0;
992
993 virtual void ExtractStats(StatsCollector* collector) const = 0;
994
995 virtual bool HasRemoteAudio() const = 0;
996
997 std::string mid;
998 std::string transport_name;
999 std::map<uint32_t, std::string> sender_track_id_by_ssrc;
1000 std::map<uint32_t, std::string> receiver_track_id_by_ssrc;
1001
1002 protected:
1003 template <typename ReceiverT, typename SenderT>
ExtractSenderReceiverStats(StatsCollector * collector,const std::vector<ReceiverT> & receiver_data,const std::vector<SenderT> & sender_data) const1004 void ExtractSenderReceiverStats(
1005 StatsCollector* collector,
1006 const std::vector<ReceiverT>& receiver_data,
1007 const std::vector<SenderT>& sender_data) const {
1008 RTC_DCHECK(collector);
1009 StatsReport::Id transport_id = StatsReport::NewComponentId(
1010 transport_name, cricket::ICE_CANDIDATE_COMPONENT_RTP);
1011 ExtractStatsFromList(receiver_data, transport_id, collector,
1012 StatsReport::kReceive, receiver_track_id_by_ssrc);
1013 ExtractStatsFromList(sender_data, transport_id, collector,
1014 StatsReport::kSend, sender_track_id_by_ssrc);
1015 }
1016 };
1017
1018 class VoiceMediaChannelStatsGatherer final : public MediaChannelStatsGatherer {
1019 public:
VoiceMediaChannelStatsGatherer(cricket::VoiceMediaChannel * voice_media_channel)1020 VoiceMediaChannelStatsGatherer(
1021 cricket::VoiceMediaChannel* voice_media_channel)
1022 : voice_media_channel_(voice_media_channel) {
1023 RTC_DCHECK(voice_media_channel_);
1024 }
1025
GetStatsOnWorkerThread()1026 bool GetStatsOnWorkerThread() override {
1027 return voice_media_channel_->GetStats(&voice_media_info,
1028 /*get_and_clear_legacy_stats=*/true);
1029 }
1030
ExtractStats(StatsCollector * collector) const1031 void ExtractStats(StatsCollector* collector) const override {
1032 ExtractSenderReceiverStats(collector, voice_media_info.receivers,
1033 voice_media_info.senders);
1034 if (voice_media_info.device_underrun_count == -2 ||
1035 voice_media_info.device_underrun_count > 0) {
1036 StatsReport* report = collector->PrepareADMReport();
1037 report->AddInt(StatsReport::kStatsValueNameAudioDeviceUnderrunCounter,
1038 voice_media_info.device_underrun_count);
1039 }
1040 }
1041
HasRemoteAudio() const1042 bool HasRemoteAudio() const override {
1043 return !voice_media_info.receivers.empty();
1044 }
1045
1046 private:
1047 cricket::VoiceMediaChannel* voice_media_channel_;
1048 cricket::VoiceMediaInfo voice_media_info;
1049 };
1050
1051 class VideoMediaChannelStatsGatherer final : public MediaChannelStatsGatherer {
1052 public:
VideoMediaChannelStatsGatherer(cricket::VideoMediaChannel * video_media_channel)1053 VideoMediaChannelStatsGatherer(
1054 cricket::VideoMediaChannel* video_media_channel)
1055 : video_media_channel_(video_media_channel) {
1056 RTC_DCHECK(video_media_channel_);
1057 }
1058
GetStatsOnWorkerThread()1059 bool GetStatsOnWorkerThread() override {
1060 return video_media_channel_->GetStats(&video_media_info);
1061 }
1062
ExtractStats(StatsCollector * collector) const1063 void ExtractStats(StatsCollector* collector) const override {
1064 ExtractSenderReceiverStats(collector, video_media_info.receivers,
1065 video_media_info.aggregated_senders);
1066 }
1067
HasRemoteAudio() const1068 bool HasRemoteAudio() const override { return false; }
1069
1070 private:
1071 cricket::VideoMediaChannel* video_media_channel_;
1072 cricket::VideoMediaInfo video_media_info;
1073 };
1074
CreateMediaChannelStatsGatherer(cricket::MediaChannel * channel)1075 std::unique_ptr<MediaChannelStatsGatherer> CreateMediaChannelStatsGatherer(
1076 cricket::MediaChannel* channel) {
1077 RTC_DCHECK(channel);
1078 if (channel->media_type() == cricket::MEDIA_TYPE_AUDIO) {
1079 return std::make_unique<VoiceMediaChannelStatsGatherer>(
1080 static_cast<cricket::VoiceMediaChannel*>(channel));
1081 } else {
1082 RTC_DCHECK_EQ(channel->media_type(), cricket::MEDIA_TYPE_VIDEO);
1083 return std::make_unique<VideoMediaChannelStatsGatherer>(
1084 static_cast<cricket::VideoMediaChannel*>(channel));
1085 }
1086 }
1087
1088 } // namespace
1089
ExtractMediaInfo()1090 void StatsCollector::ExtractMediaInfo() {
1091 RTC_DCHECK_RUN_ON(pc_->signaling_thread());
1092
1093 std::vector<std::unique_ptr<MediaChannelStatsGatherer>> gatherers;
1094
1095 {
1096 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
1097 for (const auto& transceiver : pc_->GetTransceiversInternal()) {
1098 cricket::ChannelInterface* channel = transceiver->internal()->channel();
1099 if (!channel) {
1100 continue;
1101 }
1102 std::unique_ptr<MediaChannelStatsGatherer> gatherer =
1103 CreateMediaChannelStatsGatherer(channel->media_channel());
1104 gatherer->mid = channel->content_name();
1105 gatherer->transport_name = channel->transport_name();
1106 for (const auto& sender : transceiver->internal()->senders()) {
1107 std::string track_id = (sender->track() ? sender->track()->id() : "");
1108 gatherer->sender_track_id_by_ssrc.insert(
1109 std::make_pair(sender->ssrc(), track_id));
1110 }
1111 for (const auto& receiver : transceiver->internal()->receivers()) {
1112 gatherer->receiver_track_id_by_ssrc.insert(std::make_pair(
1113 receiver->internal()->ssrc(), receiver->track()->id()));
1114 }
1115 gatherers.push_back(std::move(gatherer));
1116 }
1117 }
1118
1119 pc_->worker_thread()->Invoke<void>(RTC_FROM_HERE, [&] {
1120 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
1121 for (auto it = gatherers.begin(); it != gatherers.end();
1122 /* incremented manually */) {
1123 MediaChannelStatsGatherer* gatherer = it->get();
1124 if (!gatherer->GetStatsOnWorkerThread()) {
1125 RTC_LOG(LS_ERROR) << "Failed to get media channel stats for mid="
1126 << gatherer->mid;
1127 it = gatherers.erase(it);
1128 continue;
1129 }
1130 ++it;
1131 }
1132 });
1133
1134 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
1135
1136 bool has_remote_audio = false;
1137 for (const auto& gatherer : gatherers) {
1138 gatherer->ExtractStats(this);
1139 has_remote_audio |= gatherer->HasRemoteAudio();
1140 }
1141
1142 UpdateStatsFromExistingLocalAudioTracks(has_remote_audio);
1143 }
1144
ExtractSenderInfo()1145 void StatsCollector::ExtractSenderInfo() {
1146 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
1147
1148 for (const auto& sender : pc_->GetSenders()) {
1149 // TODO(nisse): SSRC == 0 currently means none. Delete check when
1150 // that is fixed.
1151 if (!sender->ssrc()) {
1152 continue;
1153 }
1154 const rtc::scoped_refptr<MediaStreamTrackInterface> track(sender->track());
1155 if (!track || track->kind() != MediaStreamTrackInterface::kVideoKind) {
1156 continue;
1157 }
1158 // Safe, because kind() == kVideoKind implies a subclass of
1159 // VideoTrackInterface; see mediastreaminterface.h.
1160 VideoTrackSourceInterface* source =
1161 static_cast<VideoTrackInterface*>(track.get())->GetSource();
1162
1163 VideoTrackSourceInterface::Stats stats;
1164 if (!source->GetStats(&stats)) {
1165 continue;
1166 }
1167 const StatsReport::Id stats_id = StatsReport::NewIdWithDirection(
1168 StatsReport::kStatsReportTypeSsrc, rtc::ToString(sender->ssrc()),
1169 StatsReport::kSend);
1170 StatsReport* report = reports_.FindOrAddNew(stats_id);
1171 report->AddInt(StatsReport::kStatsValueNameFrameWidthInput,
1172 stats.input_width);
1173 report->AddInt(StatsReport::kStatsValueNameFrameHeightInput,
1174 stats.input_height);
1175 }
1176 }
1177
ExtractDataInfo()1178 void StatsCollector::ExtractDataInfo() {
1179 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
1180
1181 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
1182
1183 std::vector<DataChannelStats> data_stats = pc_->GetDataChannelStats();
1184 for (const auto& stats : data_stats) {
1185 StatsReport::Id id(StatsReport::NewTypedIntId(
1186 StatsReport::kStatsReportTypeDataChannel, stats.id));
1187 StatsReport* report = reports_.ReplaceOrAddNew(id);
1188 report->set_timestamp(stats_gathering_started_);
1189 report->AddString(StatsReport::kStatsValueNameLabel, stats.label);
1190 // Filter out the initial id (-1).
1191 if (stats.id >= 0) {
1192 report->AddInt(StatsReport::kStatsValueNameDataChannelId, stats.id);
1193 }
1194 report->AddString(StatsReport::kStatsValueNameProtocol, stats.protocol);
1195 report->AddString(StatsReport::kStatsValueNameState,
1196 DataChannelInterface::DataStateString(stats.state));
1197 }
1198 }
1199
GetReport(const StatsReport::StatsType & type,const std::string & id,StatsReport::Direction direction)1200 StatsReport* StatsCollector::GetReport(const StatsReport::StatsType& type,
1201 const std::string& id,
1202 StatsReport::Direction direction) {
1203 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
1204 RTC_DCHECK(type == StatsReport::kStatsReportTypeSsrc ||
1205 type == StatsReport::kStatsReportTypeRemoteSsrc);
1206 return reports_.Find(StatsReport::NewIdWithDirection(type, id, direction));
1207 }
1208
UpdateStatsFromExistingLocalAudioTracks(bool has_remote_tracks)1209 void StatsCollector::UpdateStatsFromExistingLocalAudioTracks(
1210 bool has_remote_tracks) {
1211 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
1212 // Loop through the existing local audio tracks.
1213 for (const auto& it : local_audio_tracks_) {
1214 AudioTrackInterface* track = it.first;
1215 uint32_t ssrc = it.second;
1216 StatsReport* report = GetReport(StatsReport::kStatsReportTypeSsrc,
1217 rtc::ToString(ssrc), StatsReport::kSend);
1218 if (report == NULL) {
1219 // This can happen if a local audio track is added to a stream on the
1220 // fly and the report has not been set up yet. Do nothing in this case.
1221 RTC_LOG(LS_ERROR) << "Stats report does not exist for ssrc " << ssrc;
1222 continue;
1223 }
1224
1225 // The same ssrc can be used by both local and remote audio tracks.
1226 const StatsReport::Value* v =
1227 report->FindValue(StatsReport::kStatsValueNameTrackId);
1228 if (!v || v->string_val() != track->id())
1229 continue;
1230
1231 report->set_timestamp(stats_gathering_started_);
1232 UpdateReportFromAudioTrack(track, report, has_remote_tracks);
1233 }
1234 }
1235
UpdateReportFromAudioTrack(AudioTrackInterface * track,StatsReport * report,bool has_remote_tracks)1236 void StatsCollector::UpdateReportFromAudioTrack(AudioTrackInterface* track,
1237 StatsReport* report,
1238 bool has_remote_tracks) {
1239 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
1240 RTC_DCHECK(track != NULL);
1241
1242 // Don't overwrite report values if they're not available.
1243 int signal_level;
1244 if (track->GetSignalLevel(&signal_level)) {
1245 RTC_DCHECK_GE(signal_level, 0);
1246 report->AddInt(StatsReport::kStatsValueNameAudioInputLevel, signal_level);
1247 }
1248
1249 auto audio_processor(track->GetAudioProcessor());
1250
1251 if (audio_processor.get()) {
1252 AudioProcessorInterface::AudioProcessorStatistics stats =
1253 audio_processor->GetStats(has_remote_tracks);
1254
1255 SetAudioProcessingStats(report, stats.typing_noise_detected,
1256 stats.apm_statistics);
1257 }
1258 }
1259
UpdateTrackReports()1260 void StatsCollector::UpdateTrackReports() {
1261 RTC_DCHECK(pc_->signaling_thread()->IsCurrent());
1262
1263 rtc::Thread::ScopedDisallowBlockingCalls no_blocking_calls;
1264
1265 for (const auto& entry : track_ids_) {
1266 StatsReport* report = entry.second;
1267 report->set_timestamp(stats_gathering_started_);
1268 }
1269 }
1270
ClearUpdateStatsCacheForTest()1271 void StatsCollector::ClearUpdateStatsCacheForTest() {
1272 cache_timestamp_ms_ = 0;
1273 }
1274
1275 } // namespace webrtc
1276