Visualization tool for WebrtcEventLogs

webrtc/tools/event_log_visualizer/analyzer.h

+/*
+ *  Copyright (c) 2016 The WebRTC project authors. All Rights Reserved.
+ *
+ *  Use of this source code is governed by a BSD-style license
+ *  that can be found in the LICENSE file in the root of the source
+ *  tree. An additional intellectual property rights grant can be found
+ *  in the file PATENTS.  All contributing project authors may
+ *  be found in the AUTHORS file in the root of the source tree.
+ */
+
+#ifndef WEBRTC_TOOLS_EVENT_LOG_VISUALIZER_ANALYZER_H_
+#define WEBRTC_TOOLS_EVENT_LOG_VISUALIZER_ANALYZER_H_
+
+#include <vector>
+
+#include "webrtc/call/rtc_event_log_parser.h"
+#include "webrtc/tools/event_log_visualizer/plot_base.h"
+
+namespace webrtc {
+namespace plotting {
+
+class EventLogAnalyzer {
+ public:
+  // The EventLogAnalyzer keeps a reference to the ParsedRtcEventLog for the
+  // duration of it's lifetime. The ParsedRtcEventLog must not be destroyed or

[aleloi, 2016/06/08 11:44:20]

it's -> its

[terelius, 2016/06/14 13:18:49]

Done.

+  // modified while the EventLogAnalyzer is being used.
+  EventLogAnalyzer(const ParsedRtcEventLog& log, bool extra_info);

[aleloi, 2016/06/08 11:44:20]

Add a comment describing extra_info

[terelius, 2016/06/14 13:18:49]

Done. Note that there isn't (yet) any way to visualize the additional
information.

+
+  void CreatePacketGraph(PacketDirection desired_direction, Plot* plot);
+
+  void CreatePlayoutGraph(Plot* plot);
+
+  void CreateSequenceNumberGraph(Plot* plot);
+
+  void CreateDelayChangeGraph(Plot* plot);
+
+  void CreateAccumulatedDelayChangeGraph(Plot* plot);
+
+  void CreateTotalBitrateGraph(PacketDirection desired_direction, Plot* plot);
+
+  void CreateStreamBitrateGraph(PacketDirection desired_direction, Plot* plot);
+
+ private:
+  const ParsedRtcEventLog& parsed_log;

[stefan-webrtc, 2016/05/31 18:53:40]

End all members with _

[terelius, 2016/06/14 13:18:49]

Done.

+  std::vector<uint32_t> desired_ssrc;
+  uint64_t begin_time;
+  uint64_t end_time;
+  uint64_t window_duration;
+  uint64_t step;

[aleloi, 2016/06/08 11:44:20]

Consider adding a comment that describes what |step| and |window_duration| is
used for. The other members have more self-explanatory names and are used in a
straight-forward way.

[terelius, 2016/06/14 13:18:49]

Done.

+  bool extra_point_info;
+};
+
+}  // namespace plotting
+}  // namespace webrtc
+
+#endif  // WEBRTC_TOOLS_EVENT_LOG_VISUALIZER_ANALYZER_H_