blob: 4a6ec64125c6bf27231c54c662769d32cb9041b7 [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
11#include <iostream>
12
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020013#include "logging/rtc_event_log/rtc_event_log_parser.h"
14#include "rtc_base/flags.h"
15#include "rtc_tools/event_log_visualizer/analyzer.h"
16#include "rtc_tools/event_log_visualizer/plot_base.h"
17#include "rtc_tools/event_log_visualizer/plot_python.h"
Bjorn Tereliusedab3012018-01-31 17:23:40 +010018#include "system_wrappers/include/field_trial_default.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020019#include "test/field_trial.h"
20#include "test/testsupport/fileutils.h"
terelius54ce6802016-07-13 06:44:41 -070021
terelius2ee076d2017-08-15 02:04:02 -070022DEFINE_string(plot_profile,
23 "default",
24 "A profile that selects a certain subset of the plots. Currently "
Bjorn Terelius1edfff92017-10-11 13:15:19 +020025 "defined profiles are \"all\", \"none\", \"sendside_bwe\","
26 "\"receiveside_bwe\" and \"default\"");
terelius2ee076d2017-08-15 02:04:02 -070027
28DEFINE_bool(plot_incoming_packet_sizes,
terelius54ce6802016-07-13 06:44:41 -070029 false,
terelius2ee076d2017-08-15 02:04:02 -070030 "Plot bar graph showing the size of each incoming packet.");
31DEFINE_bool(plot_outgoing_packet_sizes,
32 false,
33 "Plot bar graph showing the size of each outgoing packet.");
34DEFINE_bool(plot_incoming_packet_count,
35 false,
36 "Plot the accumulated number of packets for each incoming stream.");
37DEFINE_bool(plot_outgoing_packet_count,
38 false,
39 "Plot the accumulated number of packets for each outgoing stream.");
terelius54ce6802016-07-13 06:44:41 -070040DEFINE_bool(plot_audio_playout,
41 false,
42 "Plot bar graph showing the time between each audio playout.");
ivocaac9d6f2016-09-22 07:01:47 -070043DEFINE_bool(plot_audio_level,
44 false,
terelius2ee076d2017-08-15 02:04:02 -070045 "Plot line graph showing the audio level of incoming audio.");
46DEFINE_bool(plot_incoming_sequence_number_delta,
47 false,
48 "Plot the sequence number difference between consecutive incoming "
49 "packets.");
terelius54ce6802016-07-13 06:44:41 -070050DEFINE_bool(
terelius2ee076d2017-08-15 02:04:02 -070051 plot_incoming_delay_delta,
terelius54ce6802016-07-13 06:44:41 -070052 false,
53 "Plot the difference in 1-way path delay between consecutive packets.");
terelius2ee076d2017-08-15 02:04:02 -070054DEFINE_bool(plot_incoming_delay,
55 true,
56 "Plot the 1-way path delay for incoming packets, normalized so "
57 "that the first packet has delay 0.");
58DEFINE_bool(plot_incoming_loss_rate,
59 true,
60 "Compute the loss rate for incoming packets using a method that's "
61 "similar to the one used for RTCP SR and RR fraction lost. Note "
62 "that the loss rate can be negative if packets are duplicated or "
63 "reordered.");
64DEFINE_bool(plot_incoming_bitrate,
65 true,
66 "Plot the total bitrate used by all incoming streams.");
67DEFINE_bool(plot_outgoing_bitrate,
68 true,
69 "Plot the total bitrate used by all outgoing streams.");
70DEFINE_bool(plot_incoming_stream_bitrate,
71 true,
72 "Plot the bitrate used by each incoming stream.");
73DEFINE_bool(plot_outgoing_stream_bitrate,
74 true,
75 "Plot the bitrate used by each outgoing stream.");
Bjorn Terelius28db2662017-10-04 14:22:43 +020076DEFINE_bool(plot_simulated_receiveside_bwe,
77 false,
78 "Run the receive-side bandwidth estimator with the incoming rtp "
79 "packets and plot the resulting estimate.");
terelius2ee076d2017-08-15 02:04:02 -070080DEFINE_bool(plot_simulated_sendside_bwe,
terelius54ce6802016-07-13 06:44:41 -070081 false,
terelius2ee076d2017-08-15 02:04:02 -070082 "Run the send-side bandwidth estimator with the outgoing rtp and "
83 "incoming rtcp and plot the resulting estimate.");
stefanc3de0332016-08-02 07:22:17 -070084DEFINE_bool(plot_network_delay_feedback,
terelius2ee076d2017-08-15 02:04:02 -070085 true,
stefanc3de0332016-08-02 07:22:17 -070086 "Compute network delay based on sent packets and the received "
87 "transport feedback.");
terelius2ee076d2017-08-15 02:04:02 -070088DEFINE_bool(plot_fraction_loss_feedback,
89 true,
tereliusf736d232016-08-04 10:00:11 -070090 "Plot packet loss in percent for outgoing packets (as perceived by "
91 "the send-side bandwidth estimator).");
Bjorn Terelius0295a962017-10-25 17:42:41 +020092DEFINE_bool(plot_pacer_delay,
93 false,
94 "Plot the time each sent packet has spent in the pacer (based on "
95 "the difference between the RTP timestamp and the send "
96 "timestamp).");
stefane372d3c2017-02-02 08:04:18 -080097DEFINE_bool(plot_timestamps,
98 false,
99 "Plot the rtp timestamps of all rtp and rtcp packets over time.");
terelius2ee076d2017-08-15 02:04:02 -0700100DEFINE_bool(plot_audio_encoder_bitrate_bps,
michaelt6e5b2192017-02-22 07:33:27 -0800101 false,
102 "Plot the audio encoder target bitrate.");
terelius2ee076d2017-08-15 02:04:02 -0700103DEFINE_bool(plot_audio_encoder_frame_length_ms,
michaelt6e5b2192017-02-22 07:33:27 -0800104 false,
105 "Plot the audio encoder frame length.");
106DEFINE_bool(
terelius2ee076d2017-08-15 02:04:02 -0700107 plot_audio_encoder_packet_loss,
michaelt6e5b2192017-02-22 07:33:27 -0800108 false,
terelius2ee076d2017-08-15 02:04:02 -0700109 "Plot the uplink packet loss fraction which is sent to the audio encoder.");
110DEFINE_bool(plot_audio_encoder_fec, false, "Plot the audio encoder FEC.");
111DEFINE_bool(plot_audio_encoder_dtx, false, "Plot the audio encoder DTX.");
112DEFINE_bool(plot_audio_encoder_num_channels,
michaelt6e5b2192017-02-22 07:33:27 -0800113 false,
114 "Plot the audio encoder number of channels.");
henrik.lundin3c938fc2017-06-14 06:09:58 -0700115DEFINE_bool(plot_audio_jitter_buffer,
116 false,
117 "Plot the audio jitter buffer delay profile.");
Bjorn Terelius1edfff92017-10-11 13:15:19 +0200118
stefan985d2802016-11-15 06:54:09 -0800119DEFINE_string(
120 force_fieldtrials,
121 "",
122 "Field trials control experimental feature code which can be forced. "
123 "E.g. running with --force_fieldtrials=WebRTC-FooFeature/Enabled/"
124 " will assign the group Enabled to field trial WebRTC-FooFeature. Multiple "
125 "trials are separated by \"/\"");
owb7fbeb0b2017-08-16 02:48:33 -0700126DEFINE_string(wav_filename,
127 "",
128 "Path to wav file used for simulation of jitter buffer");
kjellander4fa5be42017-05-16 00:01:23 -0700129DEFINE_bool(help, false, "prints this message");
terelius54ce6802016-07-13 06:44:41 -0700130
terelius2ee076d2017-08-15 02:04:02 -0700131DEFINE_bool(show_detector_state,
132 false,
133 "Show the state of the delay based BWE detector on the total "
134 "bitrate graph");
135
Ilya Nikolaevskiya4259f62017-12-05 13:19:45 +0100136DEFINE_bool(show_alr_state,
137 false,
138 "Show the state ALR state on the total bitrate graph");
139
Bjorn Terelius2eb31882017-11-30 15:15:25 +0100140DEFINE_bool(
141 print_triage_notifications,
142 false,
143 "Print triage notifications, i.e. a list of suspicious looking events.");
144
terelius2ee076d2017-08-15 02:04:02 -0700145void SetAllPlotFlags(bool setting);
146
philipel23c7f252017-07-14 06:30:03 -0700147
terelius54ce6802016-07-13 06:44:41 -0700148int main(int argc, char* argv[]) {
149 std::string program_name = argv[0];
150 std::string usage =
151 "A tool for visualizing WebRTC event logs.\n"
152 "Example usage:\n" +
153 program_name + " <logfile> | python\n" + "Run " + program_name +
154 " --help for a list of command line options\n";
terelius2ee076d2017-08-15 02:04:02 -0700155
156 // Parse command line flags without removing them. We're only interested in
157 // the |plot_profile| flag.
158 rtc::FlagList::SetFlagsFromCommandLine(&argc, argv, false);
159 if (strcmp(FLAG_plot_profile, "all") == 0) {
160 SetAllPlotFlags(true);
161 } else if (strcmp(FLAG_plot_profile, "none") == 0) {
162 SetAllPlotFlags(false);
Bjorn Terelius1edfff92017-10-11 13:15:19 +0200163 } else if (strcmp(FLAG_plot_profile, "sendside_bwe") == 0) {
164 SetAllPlotFlags(false);
165 FLAG_plot_outgoing_packet_sizes = true;
166 FLAG_plot_outgoing_bitrate = true;
167 FLAG_plot_outgoing_stream_bitrate = true;
168 FLAG_plot_simulated_sendside_bwe = true;
169 FLAG_plot_network_delay_feedback = true;
170 FLAG_plot_fraction_loss_feedback = true;
171 } else if (strcmp(FLAG_plot_profile, "receiveside_bwe") == 0) {
172 SetAllPlotFlags(false);
173 FLAG_plot_incoming_packet_sizes = true;
174 FLAG_plot_incoming_delay_delta = true;
175 FLAG_plot_incoming_delay = true;
176 FLAG_plot_incoming_loss_rate = true;
177 FLAG_plot_incoming_bitrate = true;
178 FLAG_plot_incoming_stream_bitrate = true;
179 FLAG_plot_simulated_receiveside_bwe = true;
terelius2ee076d2017-08-15 02:04:02 -0700180 } else if (strcmp(FLAG_plot_profile, "default") == 0) {
181 // Do nothing.
182 } else {
183 rtc::Flag* plot_profile_flag = rtc::FlagList::Lookup("plot_profile");
184 RTC_CHECK(plot_profile_flag);
185 plot_profile_flag->Print(false);
186 }
187 // Parse the remaining flags. They are applied relative to the chosen profile.
kjellander4fa5be42017-05-16 00:01:23 -0700188 rtc::FlagList::SetFlagsFromCommandLine(&argc, argv, true);
terelius2ee076d2017-08-15 02:04:02 -0700189
tereliusc4a5c142017-07-20 08:05:09 -0700190 if (argc != 2 || FLAG_help) {
kjellander4fa5be42017-05-16 00:01:23 -0700191 // Print usage information.
192 std::cout << usage;
tereliusc4a5c142017-07-20 08:05:09 -0700193 if (FLAG_help)
194 rtc::FlagList::Print(nullptr, false);
kjellander4fa5be42017-05-16 00:01:23 -0700195 return 0;
196 }
197
henrik.lundin3c938fc2017-06-14 06:09:58 -0700198 webrtc::test::SetExecutablePath(argv[0]);
Bjorn Tereliusedab3012018-01-31 17:23:40 +0100199 webrtc::test::ValidateFieldTrialsStringOrDie(FLAG_force_fieldtrials);
200 // InitFieldTrialsFromString stores the char*, so the char array must outlive
201 // the application.
202 webrtc::field_trial::InitFieldTrialsFromString(FLAG_force_fieldtrials);
stefan985d2802016-11-15 06:54:09 -0800203
terelius54ce6802016-07-13 06:44:41 -0700204 std::string filename = argv[1];
205
206 webrtc::ParsedRtcEventLog parsed_log;
207
208 if (!parsed_log.ParseFile(filename)) {
209 std::cerr << "Could not parse the entire log file." << std::endl;
210 std::cerr << "Proceeding to analyze the first "
211 << parsed_log.GetNumberOfEvents() << " events in the file."
212 << std::endl;
213 }
214
215 webrtc::plotting::EventLogAnalyzer analyzer(parsed_log);
216 std::unique_ptr<webrtc::plotting::PlotCollection> collection(
217 new webrtc::plotting::PythonPlotCollection());
218
terelius2ee076d2017-08-15 02:04:02 -0700219 if (FLAG_plot_incoming_packet_sizes) {
220 analyzer.CreatePacketGraph(webrtc::PacketDirection::kIncomingPacket,
221 collection->AppendNewPlot());
terelius54ce6802016-07-13 06:44:41 -0700222 }
terelius2ee076d2017-08-15 02:04:02 -0700223 if (FLAG_plot_outgoing_packet_sizes) {
224 analyzer.CreatePacketGraph(webrtc::PacketDirection::kOutgoingPacket,
225 collection->AppendNewPlot());
226 }
227 if (FLAG_plot_incoming_packet_count) {
228 analyzer.CreateAccumulatedPacketsGraph(
229 webrtc::PacketDirection::kIncomingPacket, collection->AppendNewPlot());
230 }
231 if (FLAG_plot_outgoing_packet_count) {
232 analyzer.CreateAccumulatedPacketsGraph(
233 webrtc::PacketDirection::kOutgoingPacket, collection->AppendNewPlot());
234 }
235 if (FLAG_plot_audio_playout) {
tereliusdc35dcd2016-08-01 12:03:27 -0700236 analyzer.CreatePlayoutGraph(collection->AppendNewPlot());
terelius54ce6802016-07-13 06:44:41 -0700237 }
terelius2ee076d2017-08-15 02:04:02 -0700238 if (FLAG_plot_audio_level) {
ivocaac9d6f2016-09-22 07:01:47 -0700239 analyzer.CreateAudioLevelGraph(collection->AppendNewPlot());
240 }
terelius2ee076d2017-08-15 02:04:02 -0700241 if (FLAG_plot_incoming_sequence_number_delta) {
242 analyzer.CreateSequenceNumberGraph(collection->AppendNewPlot());
terelius54ce6802016-07-13 06:44:41 -0700243 }
terelius2ee076d2017-08-15 02:04:02 -0700244 if (FLAG_plot_incoming_delay_delta) {
245 analyzer.CreateIncomingDelayDeltaGraph(collection->AppendNewPlot());
terelius54ce6802016-07-13 06:44:41 -0700246 }
terelius2ee076d2017-08-15 02:04:02 -0700247 if (FLAG_plot_incoming_delay) {
248 analyzer.CreateIncomingDelayGraph(collection->AppendNewPlot());
terelius54ce6802016-07-13 06:44:41 -0700249 }
terelius2ee076d2017-08-15 02:04:02 -0700250 if (FLAG_plot_incoming_loss_rate) {
Stefan Holmer99f8e082016-09-09 13:37:50 +0200251 analyzer.CreateIncomingPacketLossGraph(collection->AppendNewPlot());
tereliusf736d232016-08-04 10:00:11 -0700252 }
terelius2ee076d2017-08-15 02:04:02 -0700253 if (FLAG_plot_incoming_bitrate) {
254 analyzer.CreateTotalBitrateGraph(webrtc::PacketDirection::kIncomingPacket,
255 collection->AppendNewPlot(),
Ilya Nikolaevskiya4259f62017-12-05 13:19:45 +0100256 FLAG_show_detector_state,
257 FLAG_show_alr_state);
terelius54ce6802016-07-13 06:44:41 -0700258 }
terelius2ee076d2017-08-15 02:04:02 -0700259 if (FLAG_plot_outgoing_bitrate) {
260 analyzer.CreateTotalBitrateGraph(webrtc::PacketDirection::kOutgoingPacket,
261 collection->AppendNewPlot(),
Ilya Nikolaevskiya4259f62017-12-05 13:19:45 +0100262 FLAG_show_detector_state,
263 FLAG_show_alr_state);
terelius54ce6802016-07-13 06:44:41 -0700264 }
terelius2ee076d2017-08-15 02:04:02 -0700265 if (FLAG_plot_incoming_stream_bitrate) {
266 analyzer.CreateStreamBitrateGraph(webrtc::PacketDirection::kIncomingPacket,
267 collection->AppendNewPlot());
268 }
269 if (FLAG_plot_outgoing_stream_bitrate) {
270 analyzer.CreateStreamBitrateGraph(webrtc::PacketDirection::kOutgoingPacket,
271 collection->AppendNewPlot());
272 }
Bjorn Terelius28db2662017-10-04 14:22:43 +0200273 if (FLAG_plot_simulated_receiveside_bwe) {
274 analyzer.CreateReceiveSideBweSimulationGraph(collection->AppendNewPlot());
275 }
terelius2ee076d2017-08-15 02:04:02 -0700276 if (FLAG_plot_simulated_sendside_bwe) {
Bjorn Terelius28db2662017-10-04 14:22:43 +0200277 analyzer.CreateSendSideBweSimulationGraph(collection->AppendNewPlot());
Stefan Holmer13181032016-07-29 14:48:54 +0200278 }
terelius2ee076d2017-08-15 02:04:02 -0700279 if (FLAG_plot_network_delay_feedback) {
tereliuse34c19c2016-08-15 08:47:14 -0700280 analyzer.CreateNetworkDelayFeedbackGraph(collection->AppendNewPlot());
stefanc3de0332016-08-02 07:22:17 -0700281 }
terelius2ee076d2017-08-15 02:04:02 -0700282 if (FLAG_plot_fraction_loss_feedback) {
283 analyzer.CreateFractionLossGraph(collection->AppendNewPlot());
284 }
285 if (FLAG_plot_timestamps) {
stefane372d3c2017-02-02 08:04:18 -0800286 analyzer.CreateTimestampGraph(collection->AppendNewPlot());
287 }
Bjorn Terelius0295a962017-10-25 17:42:41 +0200288 if (FLAG_plot_pacer_delay) {
289 analyzer.CreatePacerDelayGraph(collection->AppendNewPlot());
290 }
terelius2ee076d2017-08-15 02:04:02 -0700291 if (FLAG_plot_audio_encoder_bitrate_bps) {
michaelt6e5b2192017-02-22 07:33:27 -0800292 analyzer.CreateAudioEncoderTargetBitrateGraph(collection->AppendNewPlot());
293 }
terelius2ee076d2017-08-15 02:04:02 -0700294 if (FLAG_plot_audio_encoder_frame_length_ms) {
michaelt6e5b2192017-02-22 07:33:27 -0800295 analyzer.CreateAudioEncoderFrameLengthGraph(collection->AppendNewPlot());
296 }
terelius2ee076d2017-08-15 02:04:02 -0700297 if (FLAG_plot_audio_encoder_packet_loss) {
298 analyzer.CreateAudioEncoderPacketLossGraph(collection->AppendNewPlot());
michaelt6e5b2192017-02-22 07:33:27 -0800299 }
terelius2ee076d2017-08-15 02:04:02 -0700300 if (FLAG_plot_audio_encoder_fec) {
michaelt6e5b2192017-02-22 07:33:27 -0800301 analyzer.CreateAudioEncoderEnableFecGraph(collection->AppendNewPlot());
302 }
terelius2ee076d2017-08-15 02:04:02 -0700303 if (FLAG_plot_audio_encoder_dtx) {
michaelt6e5b2192017-02-22 07:33:27 -0800304 analyzer.CreateAudioEncoderEnableDtxGraph(collection->AppendNewPlot());
305 }
terelius2ee076d2017-08-15 02:04:02 -0700306 if (FLAG_plot_audio_encoder_num_channels) {
michaelt6e5b2192017-02-22 07:33:27 -0800307 analyzer.CreateAudioEncoderNumChannelsGraph(collection->AppendNewPlot());
308 }
terelius2ee076d2017-08-15 02:04:02 -0700309 if (FLAG_plot_audio_jitter_buffer) {
owb7fbeb0b2017-08-16 02:48:33 -0700310 std::string wav_path;
311 if (FLAG_wav_filename[0] != '\0') {
312 wav_path = FLAG_wav_filename;
313 } else {
314 wav_path = webrtc::test::ResourcePath(
315 "audio_processing/conversational_speech/EN_script2_F_sp2_B1", "wav");
316 }
317 analyzer.CreateAudioJitterBufferGraph(wav_path, 48000,
318 collection->AppendNewPlot());
henrik.lundin3c938fc2017-06-14 06:09:58 -0700319 }
320
tereliusdc35dcd2016-08-01 12:03:27 -0700321 collection->Draw();
terelius54ce6802016-07-13 06:44:41 -0700322
Bjorn Terelius2eb31882017-11-30 15:15:25 +0100323 if (FLAG_print_triage_notifications) {
324 analyzer.CreateTriageNotifications();
325 analyzer.PrintNotifications(stderr);
326 }
327
terelius54ce6802016-07-13 06:44:41 -0700328 return 0;
329}
terelius2ee076d2017-08-15 02:04:02 -0700330
331
332void SetAllPlotFlags(bool setting) {
333 FLAG_plot_incoming_packet_sizes = setting;
334 FLAG_plot_outgoing_packet_sizes = setting;
335 FLAG_plot_incoming_packet_count = setting;
336 FLAG_plot_outgoing_packet_count = setting;
337 FLAG_plot_audio_playout = setting;
338 FLAG_plot_audio_level = setting;
339 FLAG_plot_incoming_sequence_number_delta = setting;
340 FLAG_plot_incoming_delay_delta = setting;
341 FLAG_plot_incoming_delay = setting;
342 FLAG_plot_incoming_loss_rate = setting;
343 FLAG_plot_incoming_bitrate = setting;
344 FLAG_plot_outgoing_bitrate = setting;
345 FLAG_plot_incoming_stream_bitrate = setting;
346 FLAG_plot_outgoing_stream_bitrate = setting;
Bjorn Terelius28db2662017-10-04 14:22:43 +0200347 FLAG_plot_simulated_receiveside_bwe = setting;
terelius2ee076d2017-08-15 02:04:02 -0700348 FLAG_plot_simulated_sendside_bwe = setting;
349 FLAG_plot_network_delay_feedback = setting;
350 FLAG_plot_fraction_loss_feedback = setting;
351 FLAG_plot_timestamps = setting;
352 FLAG_plot_audio_encoder_bitrate_bps = setting;
353 FLAG_plot_audio_encoder_frame_length_ms = setting;
354 FLAG_plot_audio_encoder_packet_loss = setting;
355 FLAG_plot_audio_encoder_fec = setting;
356 FLAG_plot_audio_encoder_dtx = setting;
357 FLAG_plot_audio_encoder_num_channels = setting;
358 FLAG_plot_audio_jitter_buffer = setting;
359}