DRAFT: Make new base class PeriodicUmaLogger

webrtc/modules/audio_coding/neteq/statistics_calculator.h

 /*
  *  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.
  */
 
 #ifndef WEBRTC_MODULES_AUDIO_CODING_NETEQ_STATISTICS_CALCULATOR_H_
 #define WEBRTC_MODULES_AUDIO_CODING_NETEQ_STATISTICS_CALCULATOR_H_
 
+#include <string>
 #include <vector>
 
 #include "webrtc/base/constructormagic.h"
 #include "webrtc/modules/audio_coding/neteq/interface/neteq.h"
 #include "webrtc/typedefs.h"
 
 namespace webrtc {
 
 // Forward declarations.
 class DecisionLogic;
@@ skipping 65 matching lines @@
                             const DelayManager& delay_manager,
                             const DecisionLogic& decision_logic,
                             NetEqNetworkStatistics *stats);
 
   void WaitingTimes(std::vector<int>* waiting_times);
 
  private:
   static const int kMaxReportPeriod = 60;  // Seconds before auto-reset.
   static const int kLenWaitingTimes = 100;
 
-  class DelayedPacketOutagesPerMinuteCounter {
+  class PeriodicUmaLogger {
    public:
-    ~DelayedPacketOutagesPerMinuteCounter() {
-      LogToUma();  // Log the count for the current (incomplete) interval.
-    }
-    void RegisterEvent();
+    PeriodicUmaLogger(const std::string& uma_name,
+                      int report_interval_ms,
+                      int max_value);
+    virtual ~PeriodicUmaLogger();
     void AdvanceClock(int step_ms);
 
-   private:
-    static const int kReportIntervalMs = 60 * 1000;  // One minute.
+   protected:
+    void LogToUma(int value) const;
+    virtual int Metric() const = 0;
+    virtual void Reset() = 0;
 
-    void LogToUma() const;
-
-    int counter_ = 0;
+    const std::string uma_name_;
+    const int report_interval_ms_;
+    const int max_value_;
     int timer_ = 0;
   };
 
-  class AverageExcessBufferDelayMs {
+  class DelayedPacketOutagesPerMinuteCounter final : public PeriodicUmaLogger {
    public:
+    DelayedPacketOutagesPerMinuteCounter();
+    ~DelayedPacketOutagesPerMinuteCounter() {
+      // Log the count for the current (incomplete) interval.
+      LogToUma(Metric());
+    }
+    void RegisterEvent();
+
+   protected:
+    int Metric() const override;
+    void Reset() override;
+
+   private:
+    int counter_ = 0;
+  };
+
+  class AverageExcessBufferDelayMs final : public PeriodicUmaLogger {
+   public:
+    AverageExcessBufferDelayMs();
     ~AverageExcessBufferDelayMs() {
-      LogToUma();  // Log the average for the current (incomplete) interval.
+      // Log the average for the current (incomplete) interval.
+      LogToUma(Metric());
     }
     void RegisterPacketWaitingTime(int time_ms);
-    void AdvanceClock(int step_ms);
+
+   protected:
+    int Metric() const override;
+    void Reset() override;
 
    private:
-    static const int kReportIntervalMs = 60 * 1000;  // One minute.
-
-    void LogToUma();
-
     double sum_ = 0.0;
     int num_packets_ = 0;
-    int timer_ = 0;
   };
 
   // Calculates numerator / denominator, and returns the value in Q14.
   static uint16_t CalculateQ14Ratio(uint32_t numerator, uint32_t denominator);
 
   uint32_t preemptive_samples_;
   uint32_t accelerate_samples_;
   int added_zero_samples_;
   uint32_t expanded_speech_samples_;
   uint32_t expanded_noise_samples_;
   int discarded_packets_;
   uint32_t lost_timestamps_;
   uint32_t timestamps_since_last_report_;
   int waiting_times_[kLenWaitingTimes];  // Used as a circular buffer.
   int len_waiting_times_;
   int next_waiting_time_index_;
   uint32_t secondary_decoded_samples_;
   DelayedPacketOutagesPerMinuteCounter delayed_packet_outage_counter_;
   AverageExcessBufferDelayMs excess_buffer_delay_;
 
   DISALLOW_COPY_AND_ASSIGN(StatisticsCalculator);
 };
 
 }  // namespace webrtc
 #endif  // WEBRTC_MODULES_AUDIO_CODING_NETEQ_STATISTICS_CALCULATOR_H_