Add histogram stats for send delay for a sent video stream.

webrtc/video/send_statistics_proxy_unittest.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.
  */
 
 // This file includes unit tests for SendStatisticsProxy.
 #include "webrtc/video/send_statistics_proxy.h"
 
 #include <map>
 #include <memory>
 #include <string>
 #include <vector>
 
 #include "testing/gtest/include/gtest/gtest.h"
 #include "webrtc/system_wrappers/include/metrics.h"
 #include "webrtc/test/histogram.h"
 
 namespace webrtc {
 namespace {
 const uint32_t kFirstSsrc = 17;
 const uint32_t kSecondSsrc = 42;
 const uint32_t kFirstRtxSsrc = 18;
 const uint32_t kSecondRtxSsrc = 43;
 
+const int64_t kMaxPacketDelayMs = 11000;
 const int kMinRequiredSamples = 200;
 const int kQpIdx0 = 21;
 const int kQpIdx1 = 39;
 }  // namespace
 
 class SendStatisticsProxyTest : public ::testing::Test {
  public:
   SendStatisticsProxyTest()
       : fake_clock_(1234), config_(GetTestConfig()), avg_delay_ms_(0),
         max_delay_ms_(0) {}
@@ skipping 64 matching lines @@
   VideoSendStream::Config config_;
   int avg_delay_ms_;
   int max_delay_ms_;
   VideoSendStream::Stats expected_;
   typedef std::map<uint32_t, VideoSendStream::StreamStats>::const_iterator
       StreamIterator;
 };
 
 TEST_F(SendStatisticsProxyTest, RtcpStatistics) {
   RtcpStatisticsCallback* callback = statistics_proxy_.get();
-  for (std::vector<uint32_t>::const_iterator it = config_.rtp.ssrcs.begin();
-       it != config_.rtp.ssrcs.end();
-       ++it) {
-    const uint32_t ssrc = *it;
+  for (const auto& ssrc : config_.rtp.ssrcs) {
     VideoSendStream::StreamStats& ssrc_stats = expected_.substreams[ssrc];
 
     // Add statistics with some arbitrary, but unique, numbers.
     uint32_t offset = ssrc * sizeof(RtcpStatistics);
     ssrc_stats.rtcp_stats.cumulative_lost = offset;
     ssrc_stats.rtcp_stats.extended_max_sequence_number = offset + 1;
     ssrc_stats.rtcp_stats.fraction_lost = offset + 2;
     ssrc_stats.rtcp_stats.jitter = offset + 3;
     callback->StatisticsUpdated(ssrc_stats.rtcp_stats, ssrc);
   }
-  for (std::vector<uint32_t>::const_iterator it = config_.rtp.rtx.ssrcs.begin();
-       it != config_.rtp.rtx.ssrcs.end();
-       ++it) {
-    const uint32_t ssrc = *it;
+  for (const auto& ssrc : config_.rtp.rtx.ssrcs) {
     VideoSendStream::StreamStats& ssrc_stats = expected_.substreams[ssrc];
 
     // Add statistics with some arbitrary, but unique, numbers.
     uint32_t offset = ssrc * sizeof(RtcpStatistics);
     ssrc_stats.rtcp_stats.cumulative_lost = offset;
     ssrc_stats.rtcp_stats.extended_max_sequence_number = offset + 1;
     ssrc_stats.rtcp_stats.fraction_lost = offset + 2;
     ssrc_stats.rtcp_stats.jitter = offset + 3;
     callback->StatisticsUpdated(ssrc_stats.rtcp_stats, ssrc);
   }
@@ skipping 20 matching lines @@
   statistics_proxy_->OnSuspendChange(true);
   EXPECT_TRUE(statistics_proxy_->GetStats().suspended);
 
   // Verify that we can set it back to false again.
   statistics_proxy_->OnSuspendChange(false);
   EXPECT_FALSE(statistics_proxy_->GetStats().suspended);
 }
 
 TEST_F(SendStatisticsProxyTest, FrameCounts) {
   FrameCountObserver* observer = statistics_proxy_.get();
-  for (std::vector<uint32_t>::const_iterator it = config_.rtp.ssrcs.begin();
-       it != config_.rtp.ssrcs.end();
-       ++it) {
-    const uint32_t ssrc = *it;
+  for (const auto& ssrc : config_.rtp.ssrcs) {
     // Add statistics with some arbitrary, but unique, numbers.
     VideoSendStream::StreamStats& stats = expected_.substreams[ssrc];
     uint32_t offset = ssrc * sizeof(VideoSendStream::StreamStats);
     FrameCounts frame_counts;
     frame_counts.key_frames = offset;
     frame_counts.delta_frames = offset + 1;
     stats.frame_counts = frame_counts;
     observer->FrameCountUpdated(frame_counts, ssrc);
   }
-  for (std::vector<uint32_t>::const_iterator it = config_.rtp.rtx.ssrcs.begin();
-       it != config_.rtp.rtx.ssrcs.end();
-       ++it) {
-    const uint32_t ssrc = *it;
+  for (const auto& ssrc : config_.rtp.rtx.ssrcs) {
     // Add statistics with some arbitrary, but unique, numbers.
     VideoSendStream::StreamStats& stats = expected_.substreams[ssrc];
     uint32_t offset = ssrc * sizeof(VideoSendStream::StreamStats);
     FrameCounts frame_counts;
     frame_counts.key_frames = offset;
     frame_counts.delta_frames = offset + 1;
     stats.frame_counts = frame_counts;
     observer->FrameCountUpdated(frame_counts, ssrc);
   }
 
   VideoSendStream::Stats stats = statistics_proxy_->GetStats();
   ExpectEqual(expected_, stats);
 }
 
 TEST_F(SendStatisticsProxyTest, DataCounters) {
   StreamDataCountersCallback* callback = statistics_proxy_.get();
-  for (std::vector<uint32_t>::const_iterator it = config_.rtp.ssrcs.begin();
-       it != config_.rtp.ssrcs.end();
-       ++it) {
-    const uint32_t ssrc = *it;
+  for (const auto& ssrc : config_.rtp.ssrcs) {
     StreamDataCounters& counters = expected_.substreams[ssrc].rtp_stats;
     // Add statistics with some arbitrary, but unique, numbers.
     size_t offset = ssrc * sizeof(StreamDataCounters);
     uint32_t offset_uint32 = static_cast<uint32_t>(offset);
     counters.transmitted.payload_bytes = offset;
     counters.transmitted.header_bytes = offset + 1;
     counters.fec.packets = offset_uint32 + 2;
     counters.transmitted.padding_bytes = offset + 3;
     counters.retransmitted.packets = offset_uint32 + 4;
     counters.transmitted.packets = offset_uint32 + 5;
     callback->DataCountersUpdated(counters, ssrc);
   }
-  for (std::vector<uint32_t>::const_iterator it = config_.rtp.rtx.ssrcs.begin();
-       it != config_.rtp.rtx.ssrcs.end();
-       ++it) {
-    const uint32_t ssrc = *it;
+  for (const auto& ssrc : config_.rtp.rtx.ssrcs) {
     StreamDataCounters& counters = expected_.substreams[ssrc].rtp_stats;
     // Add statistics with some arbitrary, but unique, numbers.
     size_t offset = ssrc * sizeof(StreamDataCounters);
     uint32_t offset_uint32 = static_cast<uint32_t>(offset);
     counters.transmitted.payload_bytes = offset;
     counters.transmitted.header_bytes = offset + 1;
     counters.fec.packets = offset_uint32 + 2;
     counters.transmitted.padding_bytes = offset + 3;
     counters.retransmitted.packets = offset_uint32 + 4;
     counters.transmitted.packets = offset_uint32 + 5;
     callback->DataCountersUpdated(counters, ssrc);
   }
 
   VideoSendStream::Stats stats = statistics_proxy_->GetStats();
   ExpectEqual(expected_, stats);
 }
 
 TEST_F(SendStatisticsProxyTest, Bitrate) {
   BitrateStatisticsObserver* observer = statistics_proxy_.get();
-  for (std::vector<uint32_t>::const_iterator it = config_.rtp.ssrcs.begin();
-       it != config_.rtp.ssrcs.end();
-       ++it) {
-    const uint32_t ssrc = *it;
+  for (const auto& ssrc : config_.rtp.ssrcs) {
     BitrateStatistics total;
     BitrateStatistics retransmit;
     // Use ssrc as bitrate_bps to get a unique value for each stream.
     total.bitrate_bps = ssrc;
     retransmit.bitrate_bps = ssrc + 1;
     observer->Notify(total, retransmit, ssrc);
     expected_.substreams[ssrc].total_bitrate_bps = total.bitrate_bps;
     expected_.substreams[ssrc].retransmit_bitrate_bps = retransmit.bitrate_bps;
   }
-  for (std::vector<uint32_t>::const_iterator it = config_.rtp.rtx.ssrcs.begin();
-       it != config_.rtp.rtx.ssrcs.end();
-       ++it) {
-    const uint32_t ssrc = *it;
+  for (const auto& ssrc : config_.rtp.rtx.ssrcs) {
     BitrateStatistics total;
     BitrateStatistics retransmit;
     // Use ssrc as bitrate_bps to get a unique value for each stream.
     total.bitrate_bps = ssrc;
     retransmit.bitrate_bps = ssrc + 1;
     observer->Notify(total, retransmit, ssrc);
     expected_.substreams[ssrc].total_bitrate_bps = total.bitrate_bps;
     expected_.substreams[ssrc].retransmit_bitrate_bps = retransmit.bitrate_bps;
   }
 
   VideoSendStream::Stats stats = statistics_proxy_->GetStats();
   ExpectEqual(expected_, stats);
 }
 
 TEST_F(SendStatisticsProxyTest, SendSideDelay) {
   SendSideDelayObserver* observer = statistics_proxy_.get();
-  for (std::vector<uint32_t>::const_iterator it = config_.rtp.ssrcs.begin();
-       it != config_.rtp.ssrcs.end();
-       ++it) {
-    const uint32_t ssrc = *it;
+  for (const auto& ssrc : config_.rtp.ssrcs) {
     // Use ssrc as avg_delay_ms and max_delay_ms to get a unique value for each
     // stream.
     int avg_delay_ms = ssrc;
     int max_delay_ms = ssrc + 1;
     observer->SendSideDelayUpdated(avg_delay_ms, max_delay_ms, ssrc);
     expected_.substreams[ssrc].avg_delay_ms = avg_delay_ms;
     expected_.substreams[ssrc].max_delay_ms = max_delay_ms;
   }
-  for (std::vector<uint32_t>::const_iterator it = config_.rtp.rtx.ssrcs.begin();
-       it != config_.rtp.rtx.ssrcs.end();
-       ++it) {
-    const uint32_t ssrc = *it;
+  for (const auto& ssrc : config_.rtp.rtx.ssrcs) {
     // Use ssrc as avg_delay_ms and max_delay_ms to get a unique value for each
     // stream.
     int avg_delay_ms = ssrc;
     int max_delay_ms = ssrc + 1;
     observer->SendSideDelayUpdated(avg_delay_ms, max_delay_ms, ssrc);
     expected_.substreams[ssrc].avg_delay_ms = avg_delay_ms;
     expected_.substreams[ssrc].max_delay_ms = max_delay_ms;
   }
   VideoSendStream::Stats stats = statistics_proxy_->GetStats();
   ExpectEqual(expected_, stats);
 }
 
+TEST_F(SendStatisticsProxyTest, VerifySendDelayHistogramStats) {
+  test::ClearHistograms();
+  const int64_t kSendDelayInMs = 5;
+  SendPacketObserver* observer = statistics_proxy_.get();
+  const uint32_t ssrc = *config_.rtp.ssrcs.begin();
+
+  uint16_t packet_id = 0;
+  for (int i = 0; i < kMinRequiredSamples; ++i) {
+    observer->OnSendPacket(++packet_id, fake_clock_.TimeInMilliseconds(), ssrc);
+    // Packet sent to transport.
+    fake_clock_.AdvanceTimeMilliseconds(kSendDelayInMs);
+    EXPECT_TRUE(statistics_proxy_->OnSentPacket(packet_id));
+  }
+  statistics_proxy_.reset();
+  EXPECT_EQ(1, test::NumHistogramSamples("WebRTC.Video.SendDelayInMs"));
+  EXPECT_EQ(kSendDelayInMs,
+            test::LastHistogramSample("WebRTC.Video.SendDelayInMs"));
+}
+
+TEST_F(SendStatisticsProxyTest, OnSentPacket) {
+  const uint16_t kPacketId = 2345;
+  SendPacketObserver* observer = statistics_proxy_.get();
+  const uint32_t ssrc = *config_.rtp.ssrcs.begin();
+
+  observer->OnSendPacket(kPacketId, fake_clock_.TimeInMilliseconds(), ssrc);
+  fake_clock_.AdvanceTimeMilliseconds(kMaxPacketDelayMs - 1);
+  observer->OnSendPacket(kPacketId + 1, fake_clock_.TimeInMilliseconds(), ssrc);
+
+  // Verify that packets are found.
+  EXPECT_TRUE(statistics_proxy_->OnSentPacket(kPacketId));
+  EXPECT_TRUE(statistics_proxy_->OnSentPacket(kPacketId + 1));
+  // Packets found, should have been removed.
+  EXPECT_FALSE(statistics_proxy_->OnSentPacket(kPacketId));
+  EXPECT_FALSE(statistics_proxy_->OnSentPacket(kPacketId + 1));
+}
+
+TEST_F(SendStatisticsProxyTest, OnSendPacketRemovesOldPackets) {
+  SendPacketObserver* observer = statistics_proxy_.get();
+  const uint32_t ssrc = *config_.rtp.ssrcs.begin();
+  const int64_t kCaptureTimeMs = fake_clock_.TimeInMilliseconds();
+
+  observer->OnSendPacket(0xffffu, kCaptureTimeMs, ssrc);
+  observer->OnSendPacket(0u, kCaptureTimeMs, ssrc);
+  observer->OnSendPacket(1u, kCaptureTimeMs + 1, ssrc);
+  fake_clock_.AdvanceTimeMilliseconds(kMaxPacketDelayMs);  // 0xffff, 0 -> old.
+  observer->OnSendPacket(2u, kCaptureTimeMs + 2, ssrc);
+
+  EXPECT_FALSE(statistics_proxy_->OnSentPacket(0xffffu));  // Old removed.
+  EXPECT_FALSE(statistics_proxy_->OnSentPacket(0u));       // Old removed.
+  EXPECT_TRUE(statistics_proxy_->OnSentPacket(1u));
+  EXPECT_TRUE(statistics_proxy_->OnSentPacket(2u));
+}
+
 TEST_F(SendStatisticsProxyTest, OnEncodedFrameTimeMeasured) {
   const int kEncodeTimeMs = 11;
   CpuOveruseMetrics metrics;
   metrics.encode_usage_percent = 80;
   statistics_proxy_->OnEncodedFrameTimeMeasured(kEncodeTimeMs, metrics);
 
   VideoSendStream::Stats stats = statistics_proxy_->GetStats();
   EXPECT_EQ(kEncodeTimeMs, stats.avg_encode_time_ms);
   EXPECT_EQ(metrics.encode_usage_percent, stats.encode_usage_percent);
 }
@@ skipping 434 matching lines @@
 
   EXPECT_EQ(1, test::NumHistogramSamples(
                    "WebRTC.Video.Screenshare.FecBitrateSentInKbps"));
   EXPECT_EQ(static_cast<int>((rtx_counters.fec.TotalBytes() * 2 * 8) /
                              metrics::kMinRunTimeInSeconds / 1000),
             test::LastHistogramSample(
                 "WebRTC.Video.Screenshare.FecBitrateSentInKbps"));
 }
 
 }  // namespace webrtc