blob: eb36b2679ee86214f2ab22338558d307c3a60a00 [file] [log] [blame]
terelius54ce6802016-07-13 06:44:41 -07001/*
2 * Copyright (c) 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
Yves Gerey3e707812018-11-28 16:47:49 +010011#include <stdio.h>
12#include <string.h>
Jonas Olsson5b2eda42019-06-11 14:29:40 +020013
terelius54ce6802016-07-13 06:44:41 -070014#include <iostream>
Yves Gerey3e707812018-11-28 16:47:49 +010015#include <map>
16#include <memory>
17#include <string>
18#include <utility>
Mirko Bonadei4b091f42019-07-16 11:55:08 +020019#include <vector>
terelius54ce6802016-07-13 06:44:41 -070020
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +020021#include "absl/algorithm/container.h"
Mirko Bonadei4b091f42019-07-16 11:55:08 +020022#include "absl/flags/flag.h"
23#include "absl/flags/parse.h"
Mirko Bonadeif2d97b82019-07-24 15:29:47 +020024#include "absl/flags/usage.h"
25#include "absl/flags/usage_config.h"
26#include "absl/strings/match.h"
Ivo Creusen3ce44a32019-10-31 14:38:11 +010027#include "api/neteq/neteq.h"
Danil Chapovalov83bbe912019-08-07 12:24:53 +020028#include "api/rtc_event_log/rtc_event_log.h"
Sebastian Janssonb290a6d2019-01-03 14:46:23 +010029#include "logging/rtc_event_log/rtc_event_log_parser.h"
Yves Gerey3e707812018-11-28 16:47:49 +010030#include "modules/rtp_rtcp/source/rtcp_packet/report_block.h"
31#include "rtc_base/checks.h"
Björn Tereliusa06048a2019-11-01 14:31:46 +010032#include "rtc_base/logging.h"
Mirko Bonadei575998c2019-07-25 13:57:41 +020033#include "rtc_tools/rtc_event_log_visualizer/analyzer.h"
34#include "rtc_tools/rtc_event_log_visualizer/plot_base.h"
35#include "rtc_tools/rtc_event_log_visualizer/plot_protobuf.h"
36#include "rtc_tools/rtc_event_log_visualizer/plot_python.h"
Mirko Bonadei17f48782018-09-28 08:51:10 +020037#include "system_wrappers/include/field_trial.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020038#include "test/field_trial.h"
Steve Anton10542f22019-01-11 09:11:00 -080039#include "test/testsupport/file_utils.h"
terelius54ce6802016-07-13 06:44:41 -070040
Mirko Bonadei4b091f42019-07-16 11:55:08 +020041ABSL_FLAG(std::string,
42 plot,
43 "default",
Mirko Bonadeif2d97b82019-07-24 15:29:47 +020044 "A comma separated list of plot names. See --list_plots for valid "
45 "options.");
Bjorn Terelius1edfff92017-10-11 13:15:19 +020046
Mirko Bonadei4b091f42019-07-16 11:55:08 +020047ABSL_FLAG(
48 std::string,
stefan985d2802016-11-15 06:54:09 -080049 force_fieldtrials,
50 "",
51 "Field trials control experimental feature code which can be forced. "
52 "E.g. running with --force_fieldtrials=WebRTC-FooFeature/Enabled/"
53 " will assign the group Enabled to field trial WebRTC-FooFeature. Multiple "
54 "trials are separated by \"/\"");
Mirko Bonadei4b091f42019-07-16 11:55:08 +020055ABSL_FLAG(std::string,
56 wav_filename,
57 "",
58 "Path to wav file used for simulation of jitter buffer");
terelius54ce6802016-07-13 06:44:41 -070059
Mirko Bonadei4b091f42019-07-16 11:55:08 +020060ABSL_FLAG(bool,
61 show_detector_state,
62 false,
63 "Show the state of the delay based BWE detector on the total "
64 "bitrate graph");
terelius2ee076d2017-08-15 02:04:02 -070065
Mirko Bonadei4b091f42019-07-16 11:55:08 +020066ABSL_FLAG(bool,
67 show_alr_state,
68 false,
69 "Show the state ALR state on the total bitrate graph");
Ilya Nikolaevskiya4259f62017-12-05 13:19:45 +010070
Mirko Bonadei4b091f42019-07-16 11:55:08 +020071ABSL_FLAG(bool,
72 parse_unconfigured_header_extensions,
73 true,
74 "Attempt to parse unconfigured header extensions using the default "
75 "WebRTC mapping. This can give very misleading results if the "
76 "application negotiates a different mapping.");
Bjorn Tereliusc4ca1d32018-04-27 14:33:34 +020077
Mirko Bonadei4b091f42019-07-16 11:55:08 +020078ABSL_FLAG(bool,
79 print_triage_alerts,
80 false,
81 "Print triage alerts, i.e. a list of potential problems.");
Bjorn Terelius2eb31882017-11-30 15:15:25 +010082
Mirko Bonadei4b091f42019-07-16 11:55:08 +020083ABSL_FLAG(bool,
84 normalize_time,
85 true,
86 "Normalize the log timestamps so that the call starts at time 0.");
Stefan Holmer1d4a2272018-05-24 13:48:09 +020087
Mirko Bonadei4b091f42019-07-16 11:55:08 +020088ABSL_FLAG(bool,
89 shared_xaxis,
90 false,
91 "Share x-axis between all plots so that zooming in one plot "
92 "updates all the others too. A downside is that certain "
93 "operations like panning become much slower.");
Bjorn Tereliusff8cce32019-04-11 18:34:01 +020094
Mirko Bonadei4b091f42019-07-16 11:55:08 +020095ABSL_FLAG(bool,
96 protobuf_output,
97 false,
98 "Output charts as protobuf instead of python code.");
Bjorn Tereliusef73f592018-09-10 20:11:49 +020099
Mirko Bonadeif2d97b82019-07-24 15:29:47 +0200100ABSL_FLAG(bool,
101 list_plots,
102 false,
103 "List of registered plots (for use with the --plot flag)");
104
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200105using webrtc::Plot;
106
107namespace {
108std::vector<std::string> StrSplit(const std::string& s,
109 const std::string& delimiter) {
110 std::vector<std::string> v;
111 size_t pos = 0;
112 while (pos < s.length()) {
113 const std::string token = s.substr(pos, s.find(delimiter, pos) - pos);
114 pos += token.length() + delimiter.length();
115 v.push_back(token);
116 }
117 return v;
118}
119
120struct PlotDeclaration {
121 PlotDeclaration(const std::string& label, std::function<void(Plot*)> f)
122 : label(label), enabled(false), plot_func(f) {}
123 const std::string label;
124 bool enabled;
125 // TODO(terelius): Add a help text/explanation.
126 const std::function<void(Plot*)> plot_func;
127};
128
129class PlotMap {
130 public:
131 void RegisterPlot(const std::string& label, std::function<void(Plot*)> f) {
132 for (const auto& plot : plots_) {
133 RTC_DCHECK(plot.label != label)
134 << "Can't use the same label for multiple plots";
135 }
136 plots_.push_back({label, f});
137 }
138
139 bool EnablePlotsByFlags(
140 const std::vector<std::string>& flags,
141 const std::map<std::string, std::vector<std::string>>& flag_aliases) {
142 bool status = true;
143 for (const std::string& flag : flags) {
144 auto alias_it = flag_aliases.find(flag);
145 if (alias_it != flag_aliases.end()) {
146 const auto& replacements = alias_it->second;
147 for (const auto& replacement : replacements) {
148 status &= EnablePlotByFlag(replacement);
149 }
150 } else {
151 status &= EnablePlotByFlag(flag);
152 }
153 }
154 return status;
155 }
156
157 void EnableAllPlots() {
158 for (auto& plot : plots_) {
159 plot.enabled = true;
160 }
161 }
162
163 std::vector<PlotDeclaration>::iterator begin() { return plots_.begin(); }
164 std::vector<PlotDeclaration>::iterator end() { return plots_.end(); }
165
166 private:
167 bool EnablePlotByFlag(const std::string& flag) {
168 for (auto& plot : plots_) {
169 if (plot.label == flag) {
170 plot.enabled = true;
171 return true;
172 }
173 }
174 if (flag == "simulated_neteq_jitter_buffer_delay") {
175 // This flag is handled separately.
176 return true;
177 }
178 std::cerr << "Unrecognized plot name \'" << flag << "\'. Aborting."
179 << std::endl;
180 return false;
181 }
182
183 std::vector<PlotDeclaration> plots_;
184};
Mirko Bonadeif2d97b82019-07-24 15:29:47 +0200185
186bool ContainsHelppackageFlags(absl::string_view filename) {
187 return absl::EndsWith(filename, "main.cc");
188}
189
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200190} // namespace
terelius2ee076d2017-08-15 02:04:02 -0700191
terelius54ce6802016-07-13 06:44:41 -0700192int main(int argc, char* argv[]) {
Mirko Bonadeif2d97b82019-07-24 15:29:47 +0200193 absl::SetProgramUsageMessage(
terelius54ce6802016-07-13 06:44:41 -0700194 "A tool for visualizing WebRTC event logs.\n"
Mirko Bonadeif2d97b82019-07-24 15:29:47 +0200195 "Example usage:\n"
196 "./event_log_visualizer <logfile> | python\n");
197 absl::FlagsUsageConfig config;
198 config.contains_help_flags = &ContainsHelppackageFlags;
199 absl::SetFlagsUsageConfig(config);
Mirko Bonadei4b091f42019-07-16 11:55:08 +0200200 std::vector<char*> args = absl::ParseCommandLine(argc, argv);
201
Björn Tereliusa06048a2019-11-01 14:31:46 +0100202 // Print RTC_LOG warnings and errors even in release builds.
203 if (rtc::LogMessage::GetLogToDebug() > rtc::LS_WARNING) {
204 rtc::LogMessage::LogToDebug(rtc::LS_WARNING);
205 }
206 rtc::LogMessage::SetLogToStderr(true);
207
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200208 // Flag replacements
209 std::map<std::string, std::vector<std::string>> flag_aliases = {
210 {"default",
211 {"incoming_delay", "incoming_loss_rate", "incoming_bitrate",
Bjorn Terelius873a7a92019-06-13 16:01:17 +0200212 "outgoing_bitrate", "incoming_stream_bitrate",
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200213 "outgoing_stream_bitrate", "network_delay_feedback",
214 "fraction_loss_feedback"}},
215 {"sendside_bwe",
216 {"outgoing_packet_sizes", "outgoing_bitrate", "outgoing_stream_bitrate",
217 "simulated_sendside_bwe", "network_delay_feedback",
218 "fraction_loss_feedback"}},
219 {"receiveside_bwe",
220 {"incoming_packet_sizes", "incoming_delay", "incoming_loss_rate",
Bjorn Terelius873a7a92019-06-13 16:01:17 +0200221 "incoming_bitrate", "incoming_stream_bitrate",
222 "simulated_receiveside_bwe"}},
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200223 {"rtcp_details",
224 {"incoming_rtcp_fraction_lost", "outgoing_rtcp_fraction_lost",
Bjorn Terelius873a7a92019-06-13 16:01:17 +0200225 "incoming_rtcp_cumulative_lost", "outgoing_rtcp_cumulative_lost",
226 "incoming_rtcp_highest_seq_number", "outgoing_rtcp_highest_seq_number",
227 "incoming_rtcp_delay_since_last_sr",
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200228 "outgoing_rtcp_delay_since_last_sr"}},
229 {"simulated_neteq_stats",
230 {"simulated_neteq_jitter_buffer_delay",
Bjorn Terelius873a7a92019-06-13 16:01:17 +0200231 "simulated_neteq_preferred_buffer_size",
232 "simulated_neteq_concealment_events",
233 "simulated_neteq_packet_loss_rate", "simulated_neteq_preemptive_rate",
234 "simulated_neteq_accelerate_rate", "simulated_neteq_speech_expand_rate",
235 "simulated_neteq_expand_rate"}}};
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200236
Mirko Bonadei4b091f42019-07-16 11:55:08 +0200237 std::vector<std::string> plot_flags =
238 StrSplit(absl::GetFlag(FLAGS_plot), ",");
kjellander4fa5be42017-05-16 00:01:23 -0700239
Bjorn Tereliusedab3012018-01-31 17:23:40 +0100240 // InitFieldTrialsFromString stores the char*, so the char array must outlive
241 // the application.
Mirko Bonadei4b091f42019-07-16 11:55:08 +0200242 const std::string field_trials = absl::GetFlag(FLAGS_force_fieldtrials);
243 webrtc::field_trial::InitFieldTrialsFromString(field_trials.c_str());
stefan985d2802016-11-15 06:54:09 -0800244
Sebastian Janssonb290a6d2019-01-03 14:46:23 +0100245 webrtc::ParsedRtcEventLog::UnconfiguredHeaderExtensions header_extensions =
246 webrtc::ParsedRtcEventLog::UnconfiguredHeaderExtensions::kDontParse;
Mirko Bonadei4b091f42019-07-16 11:55:08 +0200247 if (absl::GetFlag(FLAGS_parse_unconfigured_header_extensions)) {
Sebastian Janssonb290a6d2019-01-03 14:46:23 +0100248 header_extensions = webrtc::ParsedRtcEventLog::
Bjorn Tereliusc4ca1d32018-04-27 14:33:34 +0200249 UnconfiguredHeaderExtensions::kAttemptWebrtcDefaultConfig;
250 }
Björn Tereliusa06048a2019-11-01 14:31:46 +0100251 webrtc::ParsedRtcEventLog parsed_log(header_extensions,
252 /*allow_incomplete_logs*/ true);
terelius54ce6802016-07-13 06:44:41 -0700253
Mirko Bonadei4b091f42019-07-16 11:55:08 +0200254 if (args.size() == 2) {
255 std::string filename = args[1];
Björn Tereliusa06048a2019-11-01 14:31:46 +0100256 auto status = parsed_log.ParseFile(filename);
257 if (!status.ok()) {
258 std::cerr << "Failed to parse " << filename << ": " << status.message()
259 << std::endl;
260 return -1;
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200261 }
terelius54ce6802016-07-13 06:44:41 -0700262 }
263
Mirko Bonadei4b091f42019-07-16 11:55:08 +0200264 webrtc::EventLogAnalyzer analyzer(parsed_log,
265 absl::GetFlag(FLAGS_normalize_time));
Bjorn Tereliusef73f592018-09-10 20:11:49 +0200266 std::unique_ptr<webrtc::PlotCollection> collection;
Mirko Bonadei4b091f42019-07-16 11:55:08 +0200267 if (absl::GetFlag(FLAGS_protobuf_output)) {
Bjorn Tereliusef73f592018-09-10 20:11:49 +0200268 collection.reset(new webrtc::ProtobufPlotCollection());
269 } else {
Mirko Bonadei4b091f42019-07-16 11:55:08 +0200270 collection.reset(
271 new webrtc::PythonPlotCollection(absl::GetFlag(FLAGS_shared_xaxis)));
Bjorn Tereliusef73f592018-09-10 20:11:49 +0200272 }
terelius54ce6802016-07-13 06:44:41 -0700273
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200274 PlotMap plots;
275 plots.RegisterPlot("incoming_packet_sizes", [&](Plot* plot) {
276 analyzer.CreatePacketGraph(webrtc::kIncomingPacket, plot);
277 });
278
279 plots.RegisterPlot("outgoing_packet_sizes", [&](Plot* plot) {
280 analyzer.CreatePacketGraph(webrtc::kOutgoingPacket, plot);
281 });
282 plots.RegisterPlot("incoming_rtcp_types", [&](Plot* plot) {
283 analyzer.CreateRtcpTypeGraph(webrtc::kIncomingPacket, plot);
284 });
285 plots.RegisterPlot("outgoing_rtcp_types", [&](Plot* plot) {
286 analyzer.CreateRtcpTypeGraph(webrtc::kOutgoingPacket, plot);
287 });
288 plots.RegisterPlot("incoming_packet_count", [&](Plot* plot) {
289 analyzer.CreateAccumulatedPacketsGraph(webrtc::kIncomingPacket, plot);
290 });
291 plots.RegisterPlot("outgoing_packet_count", [&](Plot* plot) {
292 analyzer.CreateAccumulatedPacketsGraph(webrtc::kOutgoingPacket, plot);
293 });
Kristoffer Erlandsson283c1062020-03-30 13:01:37 +0200294 plots.RegisterPlot("incoming_packet_rate", [&](Plot* plot) {
295 analyzer.CreatePacketRateGraph(webrtc::kIncomingPacket, plot);
296 });
297 plots.RegisterPlot("outgoing_packet_rate", [&](Plot* plot) {
298 analyzer.CreatePacketRateGraph(webrtc::kOutgoingPacket, plot);
299 });
Kristoffer Erlandssona2ce4232020-04-01 14:33:30 +0200300 plots.RegisterPlot("total_incoming_packet_rate", [&](Plot* plot) {
301 analyzer.CreateTotalPacketRateGraph(webrtc::kIncomingPacket, plot);
302 });
303 plots.RegisterPlot("total_outgoing_packet_rate", [&](Plot* plot) {
304 analyzer.CreateTotalPacketRateGraph(webrtc::kOutgoingPacket, plot);
305 });
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200306 plots.RegisterPlot("audio_playout",
307 [&](Plot* plot) { analyzer.CreatePlayoutGraph(plot); });
308 plots.RegisterPlot("incoming_audio_level", [&](Plot* plot) {
309 analyzer.CreateAudioLevelGraph(webrtc::kIncomingPacket, plot);
310 });
311 plots.RegisterPlot("outgoing_audio_level", [&](Plot* plot) {
312 analyzer.CreateAudioLevelGraph(webrtc::kOutgoingPacket, plot);
313 });
314 plots.RegisterPlot("incoming_sequence_number_delta", [&](Plot* plot) {
315 analyzer.CreateSequenceNumberGraph(plot);
316 });
317 plots.RegisterPlot("incoming_delay", [&](Plot* plot) {
318 analyzer.CreateIncomingDelayGraph(plot);
319 });
320 plots.RegisterPlot("incoming_loss_rate", [&](Plot* plot) {
321 analyzer.CreateIncomingPacketLossGraph(plot);
322 });
323 plots.RegisterPlot("incoming_bitrate", [&](Plot* plot) {
324 analyzer.CreateTotalIncomingBitrateGraph(plot);
325 });
326 plots.RegisterPlot("outgoing_bitrate", [&](Plot* plot) {
Mirko Bonadei4b091f42019-07-16 11:55:08 +0200327 analyzer.CreateTotalOutgoingBitrateGraph(
328 plot, absl::GetFlag(FLAGS_show_detector_state),
329 absl::GetFlag(FLAGS_show_alr_state));
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200330 });
331 plots.RegisterPlot("incoming_stream_bitrate", [&](Plot* plot) {
332 analyzer.CreateStreamBitrateGraph(webrtc::kIncomingPacket, plot);
333 });
334 plots.RegisterPlot("outgoing_stream_bitrate", [&](Plot* plot) {
335 analyzer.CreateStreamBitrateGraph(webrtc::kOutgoingPacket, plot);
336 });
337 plots.RegisterPlot("incoming_layer_bitrate_allocation", [&](Plot* plot) {
338 analyzer.CreateBitrateAllocationGraph(webrtc::kIncomingPacket, plot);
339 });
340 plots.RegisterPlot("outgoing_layer_bitrate_allocation", [&](Plot* plot) {
341 analyzer.CreateBitrateAllocationGraph(webrtc::kOutgoingPacket, plot);
342 });
343 plots.RegisterPlot("simulated_receiveside_bwe", [&](Plot* plot) {
344 analyzer.CreateReceiveSideBweSimulationGraph(plot);
345 });
346 plots.RegisterPlot("simulated_sendside_bwe", [&](Plot* plot) {
347 analyzer.CreateSendSideBweSimulationGraph(plot);
348 });
349 plots.RegisterPlot("simulated_goog_cc", [&](Plot* plot) {
350 analyzer.CreateGoogCcSimulationGraph(plot);
351 });
352 plots.RegisterPlot("network_delay_feedback", [&](Plot* plot) {
353 analyzer.CreateNetworkDelayFeedbackGraph(plot);
354 });
355 plots.RegisterPlot("fraction_loss_feedback", [&](Plot* plot) {
356 analyzer.CreateFractionLossGraph(plot);
357 });
358 plots.RegisterPlot("incoming_timestamps", [&](Plot* plot) {
359 analyzer.CreateTimestampGraph(webrtc::kIncomingPacket, plot);
360 });
361 plots.RegisterPlot("outgoing_timestamps", [&](Plot* plot) {
362 analyzer.CreateTimestampGraph(webrtc::kOutgoingPacket, plot);
363 });
364
365 auto GetFractionLost = [](const webrtc::rtcp::ReportBlock& block) -> float {
366 return static_cast<double>(block.fraction_lost()) / 256 * 100;
367 };
368 plots.RegisterPlot("incoming_rtcp_fraction_lost", [&](Plot* plot) {
Bjorn Tereliusb1222c22018-07-24 13:45:31 +0200369 analyzer.CreateSenderAndReceiverReportPlot(
370 webrtc::kIncomingPacket, GetFractionLost,
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200371 "Fraction lost (incoming RTCP)", "Loss rate (percent)", plot);
372 });
373 plots.RegisterPlot("outgoing_rtcp_fraction_lost", [&](Plot* plot) {
Bjorn Tereliusb1222c22018-07-24 13:45:31 +0200374 analyzer.CreateSenderAndReceiverReportPlot(
375 webrtc::kOutgoingPacket, GetFractionLost,
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200376 "Fraction lost (outgoing RTCP)", "Loss rate (percent)", plot);
377 });
378 auto GetCumulativeLost = [](const webrtc::rtcp::ReportBlock& block) -> float {
379 return block.cumulative_lost_signed();
380 };
381 plots.RegisterPlot("incoming_rtcp_cumulative_lost", [&](Plot* plot) {
Bjorn Tereliusb1222c22018-07-24 13:45:31 +0200382 analyzer.CreateSenderAndReceiverReportPlot(
383 webrtc::kIncomingPacket, GetCumulativeLost,
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200384 "Cumulative lost packets (incoming RTCP)", "Packets", plot);
385 });
386 plots.RegisterPlot("outgoing_rtcp_cumulative_lost", [&](Plot* plot) {
Bjorn Tereliusb1222c22018-07-24 13:45:31 +0200387 analyzer.CreateSenderAndReceiverReportPlot(
388 webrtc::kOutgoingPacket, GetCumulativeLost,
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200389 "Cumulative lost packets (outgoing RTCP)", "Packets", plot);
390 });
Bjorn Tereliusb1222c22018-07-24 13:45:31 +0200391
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200392 auto GetHighestSeqNumber =
393 [](const webrtc::rtcp::ReportBlock& block) -> float {
394 return block.extended_high_seq_num();
395 };
396 plots.RegisterPlot("incoming_rtcp_highest_seq_number", [&](Plot* plot) {
Bjorn Tereliusb1222c22018-07-24 13:45:31 +0200397 analyzer.CreateSenderAndReceiverReportPlot(
398 webrtc::kIncomingPacket, GetHighestSeqNumber,
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200399 "Highest sequence number (incoming RTCP)", "Sequence number", plot);
400 });
401 plots.RegisterPlot("outgoing_rtcp_highest_seq_number", [&](Plot* plot) {
Bjorn Tereliusb1222c22018-07-24 13:45:31 +0200402 analyzer.CreateSenderAndReceiverReportPlot(
403 webrtc::kOutgoingPacket, GetHighestSeqNumber,
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200404 "Highest sequence number (outgoing RTCP)", "Sequence number", plot);
405 });
Bjorn Tereliusb1222c22018-07-24 13:45:31 +0200406
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200407 auto DelaySinceLastSr = [](const webrtc::rtcp::ReportBlock& block) -> float {
408 return static_cast<double>(block.delay_since_last_sr()) / 65536;
409 };
410 plots.RegisterPlot("incoming_rtcp_delay_since_last_sr", [&](Plot* plot) {
Bjorn Tereliusb1222c22018-07-24 13:45:31 +0200411 analyzer.CreateSenderAndReceiverReportPlot(
412 webrtc::kIncomingPacket, DelaySinceLastSr,
413 "Delay since last received sender report (incoming RTCP)", "Time (s)",
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200414 plot);
415 });
416 plots.RegisterPlot("outgoing_rtcp_delay_since_last_sr", [&](Plot* plot) {
Bjorn Tereliusb1222c22018-07-24 13:45:31 +0200417 analyzer.CreateSenderAndReceiverReportPlot(
418 webrtc::kOutgoingPacket, DelaySinceLastSr,
419 "Delay since last received sender report (outgoing RTCP)", "Time (s)",
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200420 plot);
421 });
Bjorn Tereliusb1222c22018-07-24 13:45:31 +0200422
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200423 plots.RegisterPlot("pacer_delay",
424 [&](Plot* plot) { analyzer.CreatePacerDelayGraph(plot); });
425 plots.RegisterPlot("audio_encoder_bitrate", [&](Plot* plot) {
426 analyzer.CreateAudioEncoderTargetBitrateGraph(plot);
427 });
428 plots.RegisterPlot("audio_encoder_frame_length", [&](Plot* plot) {
429 analyzer.CreateAudioEncoderFrameLengthGraph(plot);
430 });
431 plots.RegisterPlot("audio_encoder_packet_loss", [&](Plot* plot) {
432 analyzer.CreateAudioEncoderPacketLossGraph(plot);
433 });
434 plots.RegisterPlot("audio_encoder_fec", [&](Plot* plot) {
435 analyzer.CreateAudioEncoderEnableFecGraph(plot);
436 });
437 plots.RegisterPlot("audio_encoder_dtx", [&](Plot* plot) {
438 analyzer.CreateAudioEncoderEnableDtxGraph(plot);
439 });
440 plots.RegisterPlot("audio_encoder_num_channels", [&](Plot* plot) {
441 analyzer.CreateAudioEncoderNumChannelsGraph(plot);
442 });
443
444 plots.RegisterPlot("ice_candidate_pair_config", [&](Plot* plot) {
445 analyzer.CreateIceCandidatePairConfigGraph(plot);
446 });
447 plots.RegisterPlot("ice_connectivity_check", [&](Plot* plot) {
448 analyzer.CreateIceConnectivityCheckGraph(plot);
449 });
450 plots.RegisterPlot("dtls_transport_state", [&](Plot* plot) {
451 analyzer.CreateDtlsTransportStateGraph(plot);
452 });
453 plots.RegisterPlot("dtls_writable_state", [&](Plot* plot) {
454 analyzer.CreateDtlsWritableStateGraph(plot);
455 });
456
457 std::string wav_path;
Mirko Bonadei4b091f42019-07-16 11:55:08 +0200458 if (!absl::GetFlag(FLAGS_wav_filename).empty()) {
459 wav_path = absl::GetFlag(FLAGS_wav_filename);
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200460 } else {
461 wav_path = webrtc::test::ResourcePath(
462 "audio_processing/conversational_speech/EN_script2_F_sp2_B1", "wav");
Bjorn Terelius0295a962017-10-25 17:42:41 +0200463 }
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200464 absl::optional<webrtc::EventLogAnalyzer::NetEqStatsGetterMap> neteq_stats;
465
466 plots.RegisterPlot("simulated_neteq_expand_rate", [&](Plot* plot) {
467 if (!neteq_stats) {
468 neteq_stats = analyzer.SimulateNetEq(wav_path, 48000);
Minyue Li45fc6df2018-06-21 11:47:14 +0200469 }
Minyue Lic9ac93f2018-06-26 13:01:32 +0200470 analyzer.CreateNetEqNetworkStatsGraph(
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200471 *neteq_stats,
Minyue Li27e2b7d2018-05-07 15:20:24 +0200472 [](const webrtc::NetEqNetworkStatistics& stats) {
473 return stats.expand_rate / 16384.f;
474 },
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200475 "Expand rate", plot);
476 });
477
478 plots.RegisterPlot("simulated_neteq_speech_expand_rate", [&](Plot* plot) {
479 if (!neteq_stats) {
480 neteq_stats = analyzer.SimulateNetEq(wav_path, 48000);
481 }
Minyue Lic9ac93f2018-06-26 13:01:32 +0200482 analyzer.CreateNetEqNetworkStatsGraph(
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200483 *neteq_stats,
Minyue Li27e2b7d2018-05-07 15:20:24 +0200484 [](const webrtc::NetEqNetworkStatistics& stats) {
485 return stats.speech_expand_rate / 16384.f;
486 },
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200487 "Speech expand rate", plot);
488 });
489
490 plots.RegisterPlot("simulated_neteq_accelerate_rate", [&](Plot* plot) {
491 if (!neteq_stats) {
492 neteq_stats = analyzer.SimulateNetEq(wav_path, 48000);
493 }
Minyue Lic9ac93f2018-06-26 13:01:32 +0200494 analyzer.CreateNetEqNetworkStatsGraph(
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200495 *neteq_stats,
Minyue Li27e2b7d2018-05-07 15:20:24 +0200496 [](const webrtc::NetEqNetworkStatistics& stats) {
497 return stats.accelerate_rate / 16384.f;
498 },
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200499 "Accelerate rate", plot);
500 });
501
502 plots.RegisterPlot("simulated_neteq_preemptive_rate", [&](Plot* plot) {
503 if (!neteq_stats) {
504 neteq_stats = analyzer.SimulateNetEq(wav_path, 48000);
505 }
Minyue Lic9ac93f2018-06-26 13:01:32 +0200506 analyzer.CreateNetEqNetworkStatsGraph(
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200507 *neteq_stats,
Minyue Li27e2b7d2018-05-07 15:20:24 +0200508 [](const webrtc::NetEqNetworkStatistics& stats) {
Jakob Ivarsson21f6fd72019-04-04 10:15:02 +0200509 return stats.preemptive_rate / 16384.f;
510 },
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200511 "Preemptive rate", plot);
512 });
513
514 plots.RegisterPlot("simulated_neteq_packet_loss_rate", [&](Plot* plot) {
515 if (!neteq_stats) {
516 neteq_stats = analyzer.SimulateNetEq(wav_path, 48000);
517 }
Jakob Ivarsson21f6fd72019-04-04 10:15:02 +0200518 analyzer.CreateNetEqNetworkStatsGraph(
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200519 *neteq_stats,
Jakob Ivarsson21f6fd72019-04-04 10:15:02 +0200520 [](const webrtc::NetEqNetworkStatistics& stats) {
Minyue Li27e2b7d2018-05-07 15:20:24 +0200521 return stats.packet_loss_rate / 16384.f;
522 },
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200523 "Packet loss rate", plot);
524 });
525
526 plots.RegisterPlot("simulated_neteq_concealment_events", [&](Plot* plot) {
527 if (!neteq_stats) {
528 neteq_stats = analyzer.SimulateNetEq(wav_path, 48000);
529 }
Minyue Lic9ac93f2018-06-26 13:01:32 +0200530 analyzer.CreateNetEqLifetimeStatsGraph(
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200531 *neteq_stats,
Minyue Lic9ac93f2018-06-26 13:01:32 +0200532 [](const webrtc::NetEqLifetimeStatistics& stats) {
533 return static_cast<float>(stats.concealment_events);
534 },
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200535 "Concealment events", plot);
536 });
537
538 plots.RegisterPlot("simulated_neteq_preferred_buffer_size", [&](Plot* plot) {
539 if (!neteq_stats) {
540 neteq_stats = analyzer.SimulateNetEq(wav_path, 48000);
541 }
Jakob Ivarsson21f6fd72019-04-04 10:15:02 +0200542 analyzer.CreateNetEqNetworkStatsGraph(
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200543 *neteq_stats,
Jakob Ivarsson21f6fd72019-04-04 10:15:02 +0200544 [](const webrtc::NetEqNetworkStatistics& stats) {
545 return stats.preferred_buffer_size_ms;
546 },
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200547 "Preferred buffer size (ms)", plot);
548 });
549
550 if (absl::c_find(plot_flags, "all") != plot_flags.end()) {
551 plots.EnableAllPlots();
552 // Treated separately since it isn't registered like the other plots.
553 plot_flags.push_back("simulated_neteq_jitter_buffer_delay");
554 } else {
555 bool success = plots.EnablePlotsByFlags(plot_flags, flag_aliases);
556 if (!success) {
557 return 1;
558 }
henrik.lundin3c938fc2017-06-14 06:09:58 -0700559 }
560
Mirko Bonadeif2d97b82019-07-24 15:29:47 +0200561 if (absl::GetFlag(FLAGS_list_plots)) {
562 std::cerr << "List of registered plots (for use with the --plot flag):"
563 << std::endl;
564 for (const auto& plot : plots) {
565 // TODO(terelius): Also print a help text.
566 std::cerr << " " << plot.label << std::endl;
567 }
568 // The following flag doesn't fit the model used for the other plots.
569 std::cerr << "simulated_neteq_jitter_buffer_delay" << std::endl;
570 std::cerr << "List of plot aliases (for use with the --plot flag):"
571 << std::endl;
572 std::cerr << " all = every registered plot" << std::endl;
573 for (const auto& alias : flag_aliases) {
574 std::cerr << " " << alias.first << " = ";
575 for (const auto& replacement : alias.second) {
576 std::cerr << replacement << ",";
577 }
578 std::cerr << std::endl;
579 }
580 return 0;
581 }
582 if (args.size() != 2) {
583 // Print usage information.
584 std::cerr << absl::ProgramUsageMessage();
585 return 1;
586 }
Qingsi Wang8eca1ff2018-02-02 11:49:44 -0800587
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200588 for (const auto& plot : plots) {
589 if (plot.enabled) {
590 Plot* output = collection->AppendNewPlot();
591 plot.plot_func(output);
592 output->SetId(plot.label);
593 }
Zach Stein10a58012018-12-07 12:26:28 -0800594 }
Bjorn Terelius1aa9ee92019-06-11 17:39:38 +0200595
596 // The model we use for registering plots assumes that the each plot label
597 // can be mapped to a lambda that will produce exactly one plot. The
598 // simulated_neteq_jitter_buffer_delay plot doesn't fit this model since it
599 // creates multiple plots, and would need some state kept between the lambda
600 // calls.
601 if (absl::c_find(plot_flags, "simulated_neteq_jitter_buffer_delay") !=
602 plot_flags.end()) {
603 if (!neteq_stats) {
604 neteq_stats = analyzer.SimulateNetEq(wav_path, 48000);
605 }
606 for (webrtc::EventLogAnalyzer::NetEqStatsGetterMap::const_iterator it =
607 neteq_stats->cbegin();
608 it != neteq_stats->cend(); ++it) {
609 analyzer.CreateAudioJitterBufferGraph(it->first, it->second.get(),
610 collection->AppendNewPlot());
611 }
Zach Stein10a58012018-12-07 12:26:28 -0800612 }
613
tereliusdc35dcd2016-08-01 12:03:27 -0700614 collection->Draw();
terelius54ce6802016-07-13 06:44:41 -0700615
Mirko Bonadei4b091f42019-07-16 11:55:08 +0200616 if (absl::GetFlag(FLAGS_print_triage_alerts)) {
Bjorn Terelius2eb31882017-11-30 15:15:25 +0100617 analyzer.CreateTriageNotifications();
618 analyzer.PrintNotifications(stderr);
619 }
620
terelius54ce6802016-07-13 06:44:41 -0700621 return 0;
622}