Use RateAccCounter for sent bitrate stats. Reports average of periodically computed stats over a ca…

webrtc/video/stats_counter.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.
  */
 
@@ skipping 81 matching lines @@
   // Gets aggregated stats (i.e. aggregate of periodically computed metrics).
   AggregatedStats GetStats();
 
   // Reports metrics for elapsed intervals to AggregatedCounter and GetStats.
   AggregatedStats ProcessAndGetStats();
 
   // Reports metrics for elapsed intervals to AggregatedCounter and pauses stats
   // (i.e. empty intervals will be discarded until next sample is added).
   void ProcessAndPause();
 
+  // As above with a minimum pause time. Added samples within this interval will
+  // not pause the stats.
+  void ProcessAndPauseWithMin(int64_t min_pause_time_ms);
+
+  // Reports metrics for elapsed intervals to AggregatedCounter and stops pause.
+  void ProcessAndStopPause();
+
   // Checks if a sample has been added (i.e. Add or Set called).
   bool HasSample() const;
 
  protected:
   StatsCounter(Clock* clock,
                int64_t process_intervals_ms,
                bool include_empty_intervals,
                StatsCounterObserver* observer);
 
   void Add(int sample);
-  void Set(int sample, uint32_t stream_id);
+  void Set(int64_t sample, uint32_t stream_id);
+  void SetLast(int64_t sample, uint32_t stream_id);
 
   const bool include_empty_intervals_;
   const int64_t process_intervals_ms_;
   const std::unique_ptr<AggregatedCounter> aggregated_counter_;
   const std::unique_ptr<Samples> samples_;
 
  private:
   bool TimeToProcess(int* num_elapsed_intervals);
   void TryProcess();
   void ReportMetricToAggregatedCounter(int value, int num_values_to_add) const;
   bool IncludeEmptyIntervals() const;
+  void ResetPause();
+  void ResetPauseIfMinTimePassed();
 
   Clock* const clock_;
   const std::unique_ptr<StatsCounterObserver> observer_;
   int64_t last_process_time_ms_;
   bool paused_;
+  int64_t pause_time_ms_;
+  int64_t min_pause_time_ms_;
 };
 
 // AvgCounter: average of samples
 //
 //           | *      *      *      | *           *       | ...
 //           | Add(5) Add(1) Add(6) | Add(5)      Add(5)  |
 // GetMetric | (5 + 1 + 6) / 3      | (5 + 5) / 2         |
 //
 // |include_empty_intervals|: If set, intervals without samples will be included
 //                            in the stats. The value for an interval is
@@ skipping 102 matching lines @@
  private:
   bool GetMetric(int* metric) const override;
   int GetValueForEmptyInterval() const override;  // Returns zero.
 
   RTC_DISALLOW_COPY_AND_ASSIGN(RateCounter);
 };
 
 // RateAccCounter: units per second (used for counters)
 //
 //           | *      *      *      | *         *         | ...
-//           | Set(5) Set(6) Set(8) | Set(11)   Set(13)   |
+// SetLast(0)| Set(5) Set(6) Set(8) | Set(11)   Set(13)   |
 //           |<------ 2 sec ------->|                     |
-// GetMetric | 8 / 2                | (13 - 8) / 2        |
+// GetMetric | (8 - 0) / 2          | (13 - 8) / 2        |
 //
 // |include_empty_intervals|: If set, intervals without samples will be included
 //                            in the stats. The value for an interval is
 //                            determined by GetValueForEmptyInterval().
 //
 class RateAccCounter : public StatsCounter {
  public:
   RateAccCounter(Clock* clock,
                  StatsCounterObserver* observer,
                  bool include_empty_intervals);
   ~RateAccCounter() override {}
 
-  void Set(int sample, uint32_t stream_id);
+  void Set(int64_t sample, uint32_t stream_id);
+
+  // Sets the value for previous interval. Used initially, zero is default.

[stefan-webrtc, 2017/01/10 09:16:23]

I think it would have been good with an example of how this is supposed to be
used in a typical case.

[åsapersson, 2017/01/13 13:02:57]

Updated comment, hopefully more clear now.

+  void SetLast(int64_t sample, uint32_t stream_id);
 
  private:
   bool GetMetric(int* metric) const override;
   int GetValueForEmptyInterval() const override;  // Returns zero.
 
   RTC_DISALLOW_COPY_AND_ASSIGN(RateAccCounter);
 };
 
 }  // namespace webrtc
 
 #endif  // WEBRTC_VIDEO_STATS_COUNTER_H_