DRAFT: Make new base class PeriodicUmaLogger

webrtc/modules/audio_coding/neteq/statistics_calculator.cc

 /*
  *  Copyright (c) 2013 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.
  */
 
 #include "webrtc/modules/audio_coding/neteq/statistics_calculator.h"
 
 #include <assert.h>
 #include <string.h>  // memset
 
 #include "webrtc/base/checks.h"
 #include "webrtc/modules/audio_coding/neteq/decision_logic.h"
 #include "webrtc/modules/audio_coding/neteq/delay_manager.h"
 #include "webrtc/system_wrappers/interface/metrics.h"
 
 namespace webrtc {
 
+StatisticsCalculator::PeriodicUmaLogger::PeriodicUmaLogger(
+    const std::string& uma_name,
+    int report_interval_ms,
+    int max_value)
+    : uma_name_(uma_name),
+      report_interval_ms_(report_interval_ms),
+      max_value_(max_value),
+      timer_(0) {
+}
+
+StatisticsCalculator::PeriodicUmaLogger::~PeriodicUmaLogger() = default;
+
+void StatisticsCalculator::PeriodicUmaLogger::AdvanceClock(int step_ms) {
+  timer_ += step_ms;
+  if (timer_ < report_interval_ms_) {
+    return;
+  }
+  LogToUma(Metric());
+  Reset();
+  timer_ -= report_interval_ms_;
+  DCHECK_GE(timer_, 0);
+}
+
+void StatisticsCalculator::PeriodicUmaLogger::LogToUma(int value) const {
+  RTC_HISTOGRAM_COUNTS(uma_name_, value, 1, max_value_, 50);
+}
+
+StatisticsCalculator::DelayedPacketOutagesPerMinuteCounter::
+    DelayedPacketOutagesPerMinuteCounter()
+    : PeriodicUmaLogger("WebRTC.Audio.DelayedPacketOutageEventsPerMinute",
+                        60000,  // 60 seconds report interval.
+                        100) {
+}
+
 void StatisticsCalculator::DelayedPacketOutagesPerMinuteCounter::
     RegisterEvent() {
   ++counter_;
 }
 
-void StatisticsCalculator::DelayedPacketOutagesPerMinuteCounter::AdvanceClock(
-    int step_ms) {
-  timer_ += step_ms;
-  if (timer_ < kReportIntervalMs) {
-    return;
-  }
-  LogToUma();
-  counter_ = 0;
-  timer_ -= kReportIntervalMs;
-  DCHECK_GE(timer_, 0);
+int StatisticsCalculator::DelayedPacketOutagesPerMinuteCounter::Metric() const {
+  return counter_;
 }
 
-void StatisticsCalculator::DelayedPacketOutagesPerMinuteCounter::LogToUma()
-    const {
-  RTC_HISTOGRAM_COUNTS_100("WebRTC.Audio.DelayedPacketOutageEventsPerMinute",
-                           counter_);
+void StatisticsCalculator::DelayedPacketOutagesPerMinuteCounter::Reset() {
+  counter_ = 0;
+}
+
+StatisticsCalculator::AverageExcessBufferDelayMs::AverageExcessBufferDelayMs()
+    : PeriodicUmaLogger("WebRTC.Audio.AverageExcessBufferDelayMs",
+                        60000,  // 60 seconds report interval.
+                        1000) {
 }
 
 void StatisticsCalculator::AverageExcessBufferDelayMs::
     RegisterPacketWaitingTime(int time_ms) {
   sum_ += time_ms;
   ++num_packets_;
 }
 
-void StatisticsCalculator::AverageExcessBufferDelayMs::AdvanceClock(
-    int step_ms) {
-  timer_ += step_ms;
-  if (timer_ < kReportIntervalMs) {
-    return;
-  }
-  LogToUma();
+int StatisticsCalculator::AverageExcessBufferDelayMs::Metric() const {
+  return static_cast<int>(sum_ / num_packets_);
+}
+
+void StatisticsCalculator::AverageExcessBufferDelayMs::Reset() {
   sum_ = 0.0;
   num_packets_ = 0;
-  timer_ -= kReportIntervalMs;
-  DCHECK_GE(timer_, 0);
-}
-
-void StatisticsCalculator::AverageExcessBufferDelayMs::LogToUma() {
-  if (num_packets_ > 0) {
-    RTC_HISTOGRAM_COUNTS_1000("WebRTC.Audio.AverageExcessBufferDelayMs",
-                              static_cast<int>(sum_ / num_packets_));
-  }
 }
 
 StatisticsCalculator::StatisticsCalculator()
     : preemptive_samples_(0),
       accelerate_samples_(0),
       added_zero_samples_(0),
       expanded_speech_samples_(0),
       expanded_noise_samples_(0),
       discarded_packets_(0),
       lost_timestamps_(0),
@@ skipping 158 matching lines @@
     // Ratio must be smaller than 1 in Q14.
     assert((numerator << 14) / denominator < (1 << 14));
     return static_cast<uint16_t>((numerator << 14) / denominator);
   } else {
     // Will not produce a ratio larger than 1, since this is probably an error.
     return 1 << 14;
   }
 }
 
 }  // namespace webrtc