Add separate send-side UMA stats for screenshare and video.

webrtc/video/send_statistics_proxy.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.
  */
 
@@ skipping 13 matching lines @@
 namespace {
 // Used by histograms. Values of entries should not be changed.
 enum HistogramCodecType {
   kVideoUnknown = 0,
   kVideoVp8 = 1,
   kVideoVp9 = 2,
   kVideoH264 = 3,
   kVideoMax = 64,
 };
 
+const char* GetUmaPrefix(VideoEncoderConfig::ContentType content_type) {
+  switch (content_type) {
+    case VideoEncoderConfig::ContentType::kRealtimeVideo:
+      return "WebRTC.Video.";
+    case VideoEncoderConfig::ContentType::kScreen:
+      return "WebRTC.Video.Screenshare.";
+    default:
+      RTC_NOTREACHED() << "Unknown content type.";
+      return "";
+  }
+}
+
 HistogramCodecType PayloadNameToHistogramCodecType(
     const std::string& payload_name) {
   if (payload_name == "VP8") {
     return kVideoVp8;
   } else if (payload_name == "VP9") {
     return kVideoVp9;
   } else if (payload_name == "H264") {
     return kVideoH264;
   } else {
     return kVideoUnknown;
   }
 }
 
 void UpdateCodecTypeHistogram(const std::string& payload_name) {
   RTC_HISTOGRAM_ENUMERATION("WebRTC.Video.Encoder.CodecType",
       PayloadNameToHistogramCodecType(payload_name), kVideoMax);
 }
 }  // namespace
 
 
 const int SendStatisticsProxy::kStatsTimeoutMs = 5000;
 
-SendStatisticsProxy::SendStatisticsProxy(Clock* clock,
-                                         const VideoSendStream::Config& config)
+SendStatisticsProxy::SendStatisticsProxy(
+    Clock* clock,
+    const VideoSendStream::Config& config,
+    const VideoEncoderConfig& encoder_config)
     : clock_(clock),
       config_(config),
-      input_frame_rate_tracker_(100u, 10u),
-      sent_frame_rate_tracker_(100u, 10u),
+      content_type_(encoder_config.content_type),
       last_sent_frame_timestamp_(0),
-      max_sent_width_per_timestamp_(0),
-      max_sent_height_per_timestamp_(0) {
+      uma_container_(new UmaSamplesContainer(GetUmaPrefix(content_type_))) {
   UpdateCodecTypeHistogram(config_.encoder_settings.payload_name);
 }
 
-SendStatisticsProxy::~SendStatisticsProxy() {
-  UpdateHistograms();
-}
+SendStatisticsProxy::~SendStatisticsProxy() {}
 
-void SendStatisticsProxy::UpdateHistograms() {
+SendStatisticsProxy::UmaSamplesContainer::UmaSamplesContainer(
+    const char* prefix)
+    : uma_prefix_(prefix),
+      max_sent_width_per_timestamp_(0),
+      max_sent_height_per_timestamp_(0),
+      input_frame_rate_tracker_(100u, 10u),
+      sent_frame_rate_tracker_(100u, 10u) {}
+
+void SendStatisticsProxy::UmaSamplesContainer::UpdateHistograms() {
   const int kMinRequiredSamples = 200;
   int in_width = input_width_counter_.Avg(kMinRequiredSamples);
   int in_height = input_height_counter_.Avg(kMinRequiredSamples);
   int in_fps = round(input_frame_rate_tracker_.ComputeTotalRate());
   if (in_width != -1) {
-    RTC_HISTOGRAM_COUNTS_10000("WebRTC.Video.InputWidthInPixels", in_width);
-    RTC_HISTOGRAM_COUNTS_10000("WebRTC.Video.InputHeightInPixels", in_height);
-    RTC_HISTOGRAM_COUNTS_100("WebRTC.Video.InputFramesPerSecond", in_fps);
+    RTC_HISTOGRAM_COUNTS_10000(uma_prefix_ + "InputWidthInPixels", in_width);
+    RTC_HISTOGRAM_COUNTS_10000(uma_prefix_ + "InputHeightInPixels", in_height);
+    RTC_HISTOGRAM_COUNTS_100(uma_prefix_ + "InputFramesPerSecond", in_fps);
   }
   int sent_width = sent_width_counter_.Avg(kMinRequiredSamples);
   int sent_height = sent_height_counter_.Avg(kMinRequiredSamples);
   int sent_fps = round(sent_frame_rate_tracker_.ComputeTotalRate());
   if (sent_width != -1) {
-    RTC_HISTOGRAM_COUNTS_10000("WebRTC.Video.SentWidthInPixels", sent_width);
-    RTC_HISTOGRAM_COUNTS_10000("WebRTC.Video.SentHeightInPixels", sent_height);
-    RTC_HISTOGRAM_COUNTS_100("WebRTC.Video.SentFramesPerSecond", sent_fps);
+    RTC_HISTOGRAM_COUNTS_10000(uma_prefix_ + "SentWidthInPixels", sent_width);
+    RTC_HISTOGRAM_COUNTS_10000(uma_prefix_ + "SentHeightInPixels", sent_height);
+    RTC_HISTOGRAM_COUNTS_100(uma_prefix_ + "SentFramesPerSecond", sent_fps);
   }
   int encode_ms = encode_time_counter_.Avg(kMinRequiredSamples);
   if (encode_ms != -1)
-    RTC_HISTOGRAM_COUNTS_1000("WebRTC.Video.EncodeTimeInMs", encode_ms);
+    RTC_HISTOGRAM_COUNTS_1000(uma_prefix_ + "EncodeTimeInMs", encode_ms);
 
   int key_frames_permille = key_frame_counter_.Permille(kMinRequiredSamples);
   if (key_frames_permille != -1) {
-    RTC_HISTOGRAM_COUNTS_1000("WebRTC.Video.KeyFramesSentInPermille",
-        key_frames_permille);
+    RTC_HISTOGRAM_COUNTS_1000(uma_prefix_ + "KeyFramesSentInPermille",
+                              key_frames_permille);
   }
   int quality_limited =
       quality_limited_frame_counter_.Percent(kMinRequiredSamples);
   if (quality_limited != -1) {
-    RTC_HISTOGRAM_PERCENTAGE("WebRTC.Video.QualityLimitedResolutionInPercent",
+    RTC_HISTOGRAM_PERCENTAGE(uma_prefix_ + "QualityLimitedResolutionInPercent",
                              quality_limited);
   }
   int downscales = quality_downscales_counter_.Avg(kMinRequiredSamples);
   if (downscales != -1) {
-    RTC_HISTOGRAM_ENUMERATION("WebRTC.Video.QualityLimitedResolutionDownscales",
-                              downscales, 20);
+    RTC_HISTOGRAM_ENUMERATION(
+        uma_prefix_ + "QualityLimitedResolutionDownscales", downscales, 20);
   }
   int bw_limited = bw_limited_frame_counter_.Percent(kMinRequiredSamples);
   if (bw_limited != -1) {
-    RTC_HISTOGRAM_PERCENTAGE("WebRTC.Video.BandwidthLimitedResolutionInPercent",
-        bw_limited);
+    RTC_HISTOGRAM_PERCENTAGE(
+        uma_prefix_ + "BandwidthLimitedResolutionInPercent", bw_limited);
   }
   int num_disabled = bw_resolutions_disabled_counter_.Avg(kMinRequiredSamples);
   if (num_disabled != -1) {
     RTC_HISTOGRAM_ENUMERATION(
-        "WebRTC.Video.BandwidthLimitedResolutionsDisabled", num_disabled, 10);
+        uma_prefix_ + "BandwidthLimitedResolutionsDisabled", num_disabled, 10);
   }
   int delay_ms = delay_counter_.Avg(kMinRequiredSamples);
   if (delay_ms != -1)
-    RTC_HISTOGRAM_COUNTS_100000("WebRTC.Video.SendSideDelayInMs", delay_ms);
+    RTC_HISTOGRAM_COUNTS_100000(uma_prefix_ + "SendSideDelayInMs", delay_ms);
 
   int max_delay_ms = max_delay_counter_.Avg(kMinRequiredSamples);
   if (max_delay_ms != -1) {
-    RTC_HISTOGRAM_COUNTS_100000(
-        "WebRTC.Video.SendSideDelayMaxInMs", max_delay_ms);
+    RTC_HISTOGRAM_COUNTS_100000(uma_prefix_ + "SendSideDelayMaxInMs",
+                                max_delay_ms);
   }
 }
 
+void SendStatisticsProxy::SetContentType(
+    VideoEncoderConfig::ContentType content_type) {
+  rtc::CritScope lock(&crit_);
+  if (content_type_ != content_type) {
+    uma_container_->UpdateHistograms();

[mflodman, 2015/12/02 14:07:54]

Åsa,
What is the complexity of doing this mid-call with the current implementation of
RTC_HISTOGRAM_COUNTS_* ?

[åsapersson, 2015/12/02 14:43:45]

I don't think there will be an issue with doing this mid-call.

+    uma_container_.reset(new UmaSamplesContainer(GetUmaPrefix(content_type)));
+    content_type_ = content_type;
+  }
+}
+
 void SendStatisticsProxy::OnOutgoingRate(uint32_t framerate, uint32_t bitrate) {
   rtc::CritScope lock(&crit_);
   stats_.encode_frame_rate = framerate;
   stats_.media_bitrate_bps = bitrate;
 }
 
 void SendStatisticsProxy::CpuOveruseMetricsUpdated(
     const CpuOveruseMetrics& metrics) {
   rtc::CritScope lock(&crit_);
   // TODO(asapersson): Change to use OnEncodedFrame() for avg_encode_time_ms.
   stats_.avg_encode_time_ms = metrics.avg_encode_time_ms;
   stats_.encode_usage_percent = metrics.encode_usage_percent;
 }
 
 void SendStatisticsProxy::OnSuspendChange(bool is_suspended) {
   rtc::CritScope lock(&crit_);
   stats_.suspended = is_suspended;
 }
 
 VideoSendStream::Stats SendStatisticsProxy::GetStats() {
   rtc::CritScope lock(&crit_);
   PurgeOldStats();
   stats_.input_frame_rate =
-      round(input_frame_rate_tracker_.ComputeRate());
+      round(uma_container_->input_frame_rate_tracker_.ComputeRate());
   return stats_;
 }
 
 void SendStatisticsProxy::PurgeOldStats() {
   int64_t old_stats_ms = clock_->TimeInMilliseconds() - kStatsTimeoutMs;
   for (std::map<uint32_t, VideoSendStream::StreamStats>::iterator it =
            stats_.substreams.begin();
        it != stats_.substreams.end(); ++it) {
     uint32_t ssrc = it->first;
     if (update_times_[ssrc].resolution_update_ms <= old_stats_ms) {
@@ skipping 52 matching lines @@
 
   rtc::CritScope lock(&crit_);
   VideoSendStream::StreamStats* stats = GetStatsEntry(ssrc);
   if (stats == nullptr)
     return;
 
   stats->width = encoded_image._encodedWidth;
   stats->height = encoded_image._encodedHeight;
   update_times_[ssrc].resolution_update_ms = clock_->TimeInMilliseconds();
 
-  key_frame_counter_.Add(encoded_image._frameType == kVideoFrameKey);
+  uma_container_->key_frame_counter_.Add(encoded_image._frameType ==
+                                         kVideoFrameKey);
 
   if (encoded_image.adapt_reason_.quality_resolution_downscales != -1) {
     bool downscaled =
         encoded_image.adapt_reason_.quality_resolution_downscales > 0;
-    quality_limited_frame_counter_.Add(downscaled);
+    uma_container_->quality_limited_frame_counter_.Add(downscaled);
     if (downscaled) {
-      quality_downscales_counter_.Add(
+      uma_container_->quality_downscales_counter_.Add(
           encoded_image.adapt_reason_.quality_resolution_downscales);
     }
   }
   if (encoded_image.adapt_reason_.bw_resolutions_disabled != -1) {
     bool bw_limited = encoded_image.adapt_reason_.bw_resolutions_disabled > 0;
-    bw_limited_frame_counter_.Add(bw_limited);
+    uma_container_->bw_limited_frame_counter_.Add(bw_limited);
     if (bw_limited) {
-      bw_resolutions_disabled_counter_.Add(
-         encoded_image.adapt_reason_.bw_resolutions_disabled);
+      uma_container_->bw_resolutions_disabled_counter_.Add(
+          encoded_image.adapt_reason_.bw_resolutions_disabled);
     }
   }
 
   // TODO(asapersson): This is incorrect if simulcast layers are encoded on
   // different threads and there is no guarantee that one frame of all layers
   // are encoded before the next start.
   if (last_sent_frame_timestamp_ > 0 &&
       encoded_image._timeStamp != last_sent_frame_timestamp_) {
-    sent_frame_rate_tracker_.AddSamples(1);
-    sent_width_counter_.Add(max_sent_width_per_timestamp_);
-    sent_height_counter_.Add(max_sent_height_per_timestamp_);
-    max_sent_width_per_timestamp_ = 0;
-    max_sent_height_per_timestamp_ = 0;
+    uma_container_->sent_frame_rate_tracker_.AddSamples(1);
+    uma_container_->sent_width_counter_.Add(
+        uma_container_->max_sent_width_per_timestamp_);
+    uma_container_->sent_height_counter_.Add(
+        uma_container_->max_sent_height_per_timestamp_);
+    uma_container_->max_sent_width_per_timestamp_ = 0;
+    uma_container_->max_sent_height_per_timestamp_ = 0;
   }
   last_sent_frame_timestamp_ = encoded_image._timeStamp;
-  max_sent_width_per_timestamp_ =
-      std::max(max_sent_width_per_timestamp_,
+  uma_container_->max_sent_width_per_timestamp_ =
+      std::max(uma_container_->max_sent_width_per_timestamp_,
                static_cast<int>(encoded_image._encodedWidth));
-  max_sent_height_per_timestamp_ =
-      std::max(max_sent_height_per_timestamp_,
+  uma_container_->max_sent_height_per_timestamp_ =
+      std::max(uma_container_->max_sent_height_per_timestamp_,
                static_cast<int>(encoded_image._encodedHeight));
 }
 
 void SendStatisticsProxy::OnIncomingFrame(int width, int height) {
   rtc::CritScope lock(&crit_);
-  input_frame_rate_tracker_.AddSamples(1);
-  input_width_counter_.Add(width);
-  input_height_counter_.Add(height);
+  uma_container_->input_frame_rate_tracker_.AddSamples(1);
+  uma_container_->input_width_counter_.Add(width);
+  uma_container_->input_height_counter_.Add(height);
 }
 
 void SendStatisticsProxy::OnEncodedFrame(int encode_time_ms) {
   rtc::CritScope lock(&crit_);
-  encode_time_counter_.Add(encode_time_ms);
+  uma_container_->encode_time_counter_.Add(encode_time_ms);
 }
 
 void SendStatisticsProxy::RtcpPacketTypesCounterUpdated(
     uint32_t ssrc,
     const RtcpPacketTypeCounter& packet_counter) {
   rtc::CritScope lock(&crit_);
   VideoSendStream::StreamStats* stats = GetStatsEntry(ssrc);
   if (stats == nullptr)
     return;
 
@@ skipping 49 matching lines @@
 void SendStatisticsProxy::SendSideDelayUpdated(int avg_delay_ms,
                                                int max_delay_ms,
                                                uint32_t ssrc) {
   rtc::CritScope lock(&crit_);
   VideoSendStream::StreamStats* stats = GetStatsEntry(ssrc);
   if (stats == nullptr)
     return;
   stats->avg_delay_ms = avg_delay_ms;
   stats->max_delay_ms = max_delay_ms;
 
-  delay_counter_.Add(avg_delay_ms);
-  max_delay_counter_.Add(max_delay_ms);
+  uma_container_->delay_counter_.Add(avg_delay_ms);
+  uma_container_->max_delay_counter_.Add(max_delay_ms);
 }
 
 void SendStatisticsProxy::SampleCounter::Add(int sample) {
   sum += sample;
   ++num_samples;
 }
 
 int SendStatisticsProxy::SampleCounter::Avg(int min_required_samples) const {
   if (num_samples < min_required_samples || num_samples == 0)
     return -1;
@@ skipping 15 matching lines @@
     int min_required_samples) const {
   return Fraction(min_required_samples, 1000.0f);
 }
 
 int SendStatisticsProxy::BoolSampleCounter::Fraction(
     int min_required_samples, float multiplier) const {
   if (num_samples < min_required_samples || num_samples == 0)
     return -1;
   return static_cast<int>((sum * multiplier / num_samples) + 0.5f);
 }
-
 }  // namespace webrtc