Add ability to handle data from multiple streams in RateAccCounter.

webrtc/video/stats_counter.cc

 /*
  *  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.
  */
 
 #include "webrtc/video/stats_counter.h"
 
 #include <algorithm>
+#include <limits>
+#include <map>
 
 #include "webrtc/system_wrappers/include/clock.h"
 
 namespace webrtc {
 
 namespace {
 // Periodic time interval for processing samples.
 const int64_t kProcessIntervalMs = 2000;
+
+const uint32_t kSsrc0 = 0;
+
 }  // namespace
 
 // Class holding periodically computed metrics.
 class AggregatedCounter {
  public:
   AggregatedCounter() : sum_(0) {}
   ~AggregatedCounter() {}
 
   void Add(int sample) {
     sum_ += sample;
@@ skipping 15 matching lines @@
   void Compute() {
     if (stats_.num_samples == 0)
       return;
 
     stats_.average = (sum_ + stats_.num_samples / 2) / stats_.num_samples;
   }
   int64_t sum_;
   AggregatedStats stats_;
 };
 
+// Class holding gathered samples within a process interval.
+class Samples {
+ public:
+  Samples() {}
+  ~Samples() {}
+
+  void Add(int sample, uint32_t ssrc) { samples_[ssrc].Add(sample); }
+  void Set(int sample, uint32_t ssrc) { samples_[ssrc].Set(sample); }
+
+  int64_t Num() const {

[stefan-webrtc, 2016/09/08 07:13:34]

Should we rename Num and num_ Count() and count_?

[åsapersson, 2016/09/19 12:45:40]

Done.

+    int64_t num = 0;
+    for (const auto& it : samples_)
+      num += it.second.num_;
+    return num;
+  }
+
+  int64_t Sum() const {
+    int64_t sum = 0;
+    for (const auto& it : samples_)
+      sum += it.second.sum_;
+    return sum;
+  }
+
+  int Max() const {
+    int max = std::numeric_limits<int>::min();
+    for (const auto& it : samples_)
+      max = std::max(it.second.max_, max);
+    return max;
+  }
+
+  void Reset() {
+    for (auto& it : samples_)
+      it.second.Reset();
+  }
+
+  int64_t Diff() const {
+    int64_t sum_diff = 0;
+    int num = 0;
+    for (const auto& it : samples_) {
+      if (it.second.num_ > 0) {
+        int64_t diff = it.second.sum_ - it.second.last_sum_;
+        if (diff >= 0) {
+          sum_diff += diff;
+          ++num;
+        }
+      }
+    }
+    return (num > 0) ? sum_diff : -1;
+  }
+
+ private:
+  struct Stats {
+    void Add(int sample) {
+      sum_ += sample;
+      ++num_;
+      max_ = std::max(sample, max_);
+    }
+    void Set(int sample) {
+      sum_ = sample;
+      ++num_;
+    }
+    void Reset() {
+      if (num_ > 0)
+        last_sum_ = sum_;
+      sum_ = 0;
+      num_ = 0;
+      max_ = std::numeric_limits<int>::min();
+    }
+
+    int max_ = std::numeric_limits<int>::min();
+    int64_t num_ = 0;
+    int64_t sum_ = 0;
+    int64_t last_sum_ = 0;
+  };
+
+  std::map<uint32_t, Stats> samples_;  // Gathered samples mapped by SSRC.
+};
+
 // StatsCounter class.
 StatsCounter::StatsCounter(Clock* clock,
                            bool include_empty_intervals,
                            StatsCounterObserver* observer)
-    : max_(0),
-      sum_(0),
-      num_samples_(0),
-      last_sum_(0),
+    : samples_(new Samples()),
+      include_empty_intervals_(include_empty_intervals),
       clock_(clock),
-      include_empty_intervals_(include_empty_intervals),
       observer_(observer),
       aggregated_counter_(new AggregatedCounter()),
       last_process_time_ms_(-1) {}
 
 StatsCounter::~StatsCounter() {}
 
 AggregatedStats StatsCounter::GetStats() {
   return aggregated_counter_->ComputeStats();
 }
 
@@ skipping 14 matching lines @@
   if (include_empty_intervals_) {
     for (int64_t i = 0; i < num_intervals - 1; ++i) {
       aggregated_counter_->Add(0);
       if (observer_)
         observer_->OnMetricUpdated(0);
     }
   }
   return true;
 }
 
-void StatsCounter::Set(int sample) {
+void StatsCounter::Set(int sample, uint32_t ssrc) {
   TryProcess();
-  ++num_samples_;
-  sum_ = sample;
+  samples_->Set(sample, ssrc);
 }
 
 void StatsCounter::Add(int sample) {

[stefan-webrtc, 2016/09/08 07:15:13]

Do you think it would be better to just expose the SSRC here to keep the class
more general and have the user use ssrc 0 whenever it doesn't have ssrcs?

[åsapersson, 2016/09/19 12:45:40]

It is only one subclass that have use for setting the ssrc, RateAccCounter, so
in most cases it will not be needed (for all Add). Maybe keep it as it is?

   TryProcess();
-  ++num_samples_;
-  sum_ += sample;
-
-  if (num_samples_ == 1)
-    max_ = sample;
-  max_ = std::max(sample, max_);
+  samples_->Add(sample, kSsrc0);
 }
 
 void StatsCounter::TryProcess() {
   if (!TimeToProcess())
     return;
 
   int metric;
   if (GetMetric(&metric)) {
     aggregated_counter_->Add(metric);
     if (observer_)
       observer_->OnMetricUpdated(metric);
   }
-  last_sum_ = sum_;
-  sum_ = 0;
-  max_ = 0;
-  num_samples_ = 0;
+
+  samples_->Reset();
 }
 
 // StatsCounter sub-classes.
 AvgCounter::AvgCounter(Clock* clock, StatsCounterObserver* observer)
     : StatsCounter(clock,
                    false,  // |include_empty_intervals|
                    observer) {}
 
 void AvgCounter::Add(int sample) {
   StatsCounter::Add(sample);
 }
 
 bool AvgCounter::GetMetric(int* metric) const {
-  if (num_samples_ == 0)
+  int64_t num = samples_->Num();
+  if (num == 0)
     return false;

[stefan-webrtc, 2016/09/08 07:13:34]

This is a fairly expensive way of checking for no samples since you loop through
the samples and add them up. What's the expected size of the map? Maybe it's
better to keep a variable around in Samples which keeps track of the count?

[åsapersson, 2016/09/19 12:45:40]

The expected size will be one for all sub-classes except the RateAccCounter.
Added a total_count_.

-  *metric = (sum_ + num_samples_ / 2) / num_samples_;
+
+  *metric = (samples_->Sum() + num / 2) / num;
   return true;
 }
 
 MaxCounter::MaxCounter(Clock* clock, StatsCounterObserver* observer)
     : StatsCounter(clock,
                    false,  // |include_empty_intervals|
                    observer) {}
 
 void MaxCounter::Add(int sample) {
   StatsCounter::Add(sample);
 }
 
 bool MaxCounter::GetMetric(int* metric) const {
-  if (num_samples_ == 0)
+  int64_t num = samples_->Num();
+  if (num == 0)
     return false;
-  *metric = max_;
+
+  *metric = samples_->Max();
   return true;
 }
 
 PercentCounter::PercentCounter(Clock* clock, StatsCounterObserver* observer)
     : StatsCounter(clock,
                    false,  // |include_empty_intervals|
                    observer) {}
 
 void PercentCounter::Add(bool sample) {
   StatsCounter::Add(sample ? 1 : 0);
 }
 
 bool PercentCounter::GetMetric(int* metric) const {
-  if (num_samples_ == 0)
+  int64_t num = samples_->Num();
+  if (num == 0)
     return false;
-  *metric = (sum_ * 100 + num_samples_ / 2) / num_samples_;
+
+  *metric = (samples_->Sum() * 100 + num / 2) / num;
   return true;
 }
 
 PermilleCounter::PermilleCounter(Clock* clock, StatsCounterObserver* observer)
     : StatsCounter(clock,
                    false,  // |include_empty_intervals|
                    observer) {}
 
 void PermilleCounter::Add(bool sample) {
   StatsCounter::Add(sample ? 1 : 0);
 }
 
 bool PermilleCounter::GetMetric(int* metric) const {
-  if (num_samples_ == 0)
+  int64_t num = samples_->Num();
+  if (num == 0)
     return false;
-  *metric = (sum_ * 1000 + num_samples_ / 2) / num_samples_;
+
+  *metric = (samples_->Sum() * 1000 + num / 2) / num;
   return true;
 }
 
 RateCounter::RateCounter(Clock* clock,
                          StatsCounterObserver* observer,
                          bool include_empty_intervals)
     : StatsCounter(clock, include_empty_intervals, observer) {}
 
 void RateCounter::Add(int sample) {
   StatsCounter::Add(sample);
 }
 
 bool RateCounter::GetMetric(int* metric) const {
-  if (num_samples_ == 0)
+  if (samples_->Num() == 0)
     return false;
-  *metric = (sum_ * 1000 + kProcessIntervalMs / 2) / kProcessIntervalMs;
+
+  *metric =
+      (samples_->Sum() * 1000 + kProcessIntervalMs / 2) / kProcessIntervalMs;
   return true;
 }
 
 RateAccCounter::RateAccCounter(Clock* clock,
                                StatsCounterObserver* observer,
                                bool include_empty_intervals)
     : StatsCounter(clock, include_empty_intervals, observer) {}
 
-void RateAccCounter::Set(int sample) {
-  StatsCounter::Set(sample);
+void RateAccCounter::Set(int sample, uint32_t ssrc) {
+  StatsCounter::Set(sample, ssrc);
 }
 
 bool RateAccCounter::GetMetric(int* metric) const {
-  if (num_samples_ == 0 || last_sum_ > sum_)
+  if (samples_->Num() == 0)
     return false;
-  *metric =
-      ((sum_ - last_sum_) * 1000 + kProcessIntervalMs / 2) / kProcessIntervalMs;
+
+  int64_t diff = samples_->Diff();
+  if (diff < 0 || (!include_empty_intervals_ && diff == 0))
+    return false;
+
+  *metric = (diff * 1000 + kProcessIntervalMs / 2) / kProcessIntervalMs;
   return true;
 }
 
 }  // namespace webrtc