Bugfixes for rtp_analyzer.py tool.

webrtc/tools/py_event_log_analyzer/rtp_analyzer.py

 #  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.
 
 """Displays statistics and plots graphs from RTC protobuf dump."""
 
 from __future__ import division
 from __future__ import print_function
 
 import collections
 import optparse
+import os
 import sys
 
 import matplotlib.pyplot as plt
 import numpy
 
 import misc
 import pb_parse
 
 
 class RTPStatistics(object):
@@ skipping 242 matching lines @@
   point in the time sequence start, start+step, start+2*step... Takes
   the average of the delays of points rounded to the same. Returns
   masked array, in which time points with no value are masked.
 
   """
   grouped_delays = [[] for _ in numpy.arange(start, stop, step)]
   rounded_value_index = lambda x: int((x - start) / step)
   for point in points:
     grouped_delays[rounded_value_index(point.real_send_time_ms)
                   ].append(point.absdelay)
-  regularized_delays = [numpy.average(arr) if arr else None for arr in
+  regularized_delays = [numpy.average(arr) if arr else -1 for arr in
                         grouped_delays]
-  return numpy.ma.masked_values(regularized_delays, None)
+  return numpy.ma.masked_values(regularized_delays, -1)

[aleloi, 2016/08/29 11:37:33]

masked_values(array, x) marks all positions |i| in array for which |array[i] =
x|.

If the array contains floats, it will use a special floating point comparison.

The array typically contains floats, except for cases when there is a >50 ms
gap. Then the value is None. The intended behavior is to mark the positions of
these gaps.

When there are *no* gaps (and no None values), numpy considers the array a
|float| array and use float comparisons. It cannot compare float with None, so
there is an error. In a networked environment there are always 50ms gaps, so the
bug went unnoticed until we tested with a local dump.

The change is to replace the |None|s with |-1|. It is an invalid value, as the
array contains absolute delays.

[kwiberg-webrtc, 2016/08/29 11:49:44]

Acknowledged.

 
 
 def main():
   usage = "Usage: %prog [options] <filename of rtc event log>"
   parser = optparse.OptionParser(usage=usage)
   parser.add_option("--dump_header_to_stdout",
                     default=False, action="store_true",
                     help="print header info to stdout; similar to rtp_analyze")
   parser.add_option("--query_sample_rate",
                     default=False, action="store_true",
                     help="always query user for real sample rate")
 
+  parser.add_option("--working_directory",
+                    default=None, action="store",
+                    help="directory in which to search for relative paths")
+
   (options, args) = parser.parse_args()
 
   if len(args) < 1:
     parser.print_help()
     sys.exit(0)
 
-  data_points = pb_parse.parse_protobuf(args[0])
+  input_file = args[0]
+
+  if options.working_directory and not os.path.isabs(input_file):
+    input_file = os.path.join(options.working_directory, input_file)
+
+  data_points = pb_parse.parse_protobuf(input_file)

[aleloi, 2016/08/29 11:37:33]

Previously, you had to specify a log file with an absolute path or a connect
path relative to out/target. Now, the path can be relative to the current
directory and you can invoke the tool by

path/to/out/target/rtp_analyzer.sh logfile

[kwiberg-webrtc, 2016/08/29 11:49:44]

Acknowledged.

   rtp_stats = RTPStatistics(data_points)
 
   if options.dump_header_to_stdout:
     print("Printing header info to stdout.", file=sys.stderr)
     rtp_stats.print_header_statistics()
     sys.exit(0)
 
   chosen_ssrc = rtp_stats.choose_ssrc()
   print("Chosen SSRC: 0X{:X}".format(chosen_ssrc))
 
   rtp_stats.filter_ssrc(chosen_ssrc)
 
   print("Statistics:")
   rtp_stats.print_sequence_number_statistics()
   rtp_stats.estimate_frequency(options.query_sample_rate)
   rtp_stats.print_duration_statistics()
   rtp_stats.remove_reordered()
   rtp_stats.compute_bandwidth()
   rtp_stats.plot_statistics()
 
 if __name__ == "__main__":
   main()