Refactor NACK bitrate allocation

webrtc/modules/congestion_controller/congestion_controller.cc

 /*
  *  Copyright (c) 2012 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/modules/congestion_controller/include/congestion_controller.h"
 
 #include <algorithm>
 #include <memory>
 #include <vector>
 
 #include "webrtc/base/checks.h"
 #include "webrtc/base/constructormagic.h"
 #include "webrtc/base/logging.h"
 #include "webrtc/base/socket.h"
 #include "webrtc/base/thread_annotations.h"
 #include "webrtc/modules/bitrate_controller/include/bitrate_controller.h"
 #include "webrtc/modules/congestion_controller/delay_based_bwe.h"
 #include "webrtc/modules/remote_bitrate_estimator/include/send_time_history.h"
 #include "webrtc/modules/remote_bitrate_estimator/remote_bitrate_estimator_abs_send_time.h"
 #include "webrtc/modules/remote_bitrate_estimator/remote_bitrate_estimator_single_stream.h"
+#include "webrtc/modules/rtp_rtcp/include/rtp_rtcp_defines.h"
 #include "webrtc/modules/utility/include/process_thread.h"
 #include "webrtc/system_wrappers/include/critical_section_wrapper.h"
 #include "webrtc/video/payload_router.h"
 
 namespace webrtc {
 namespace {
 
 static const uint32_t kTimeOffsetSwitchThreshold = 30;
+static const int64_t kMinRetransmitWindowSizeMs = 30;
+static const int64_t kMaxRetransmitWindowSizeMs = 1000;
 
 class WrappingBitrateEstimator : public RemoteBitrateEstimator {
  public:
   WrappingBitrateEstimator(RemoteBitrateObserver* observer, Clock* clock)
       : observer_(observer),
         clock_(clock),
         crit_sect_(CriticalSectionWrapper::CreateCriticalSection()),
         rbe_(new RemoteBitrateEstimatorSingleStream(observer_, clock_)),
         using_absolute_send_time_(false),
         packets_since_absolute_send_time_(0),
@@ skipping 83 matching lines @@
   std::unique_ptr<RemoteBitrateEstimator> rbe_;
   bool using_absolute_send_time_;
   uint32_t packets_since_absolute_send_time_;
   int min_bitrate_bps_;
 
   RTC_DISALLOW_IMPLICIT_CONSTRUCTORS(WrappingBitrateEstimator);
 };
 
 }  // namespace
 
+class RateLimiter : public NackRateLimiter {
+ public:
+  RateLimiter(Clock* clock, int64_t max_window_size_ms, uint32_t max_rate_bps)
+      : clock_(clock),
+        current_rate_(max_window_size_ms, RateStatistics::kBpsScale),
+        window_size_ms_(max_window_size_ms),
+        max_rate_bps_(max_rate_bps) {}
+  virtual ~RateLimiter() {}
+
+  // Try to use rate to send bytes. Returns true on success and if so updates
+  // current rate.
+  bool TryUseRate(size_t bytes) override {
+    rtc::CritScope cs(&lock_);
+    rtc::Optional<uint32_t> current_rate =
+        current_rate_.Rate(clock_->TimeInMilliseconds());
+    if (current_rate) {
+      // If there is a current rate, check if adding bytes would cause maximum
+      // bitrate target to be exceeded. If there is NOT a valid current rate,
+      // allow allocating rate even if target is exceeded. This prevents
+      // problems
+      // at very low rates, where for instance retransmissions would never be
+      // allowed due to too high bitrate caused by a single packet.
+
+      uint32_t bitrate_addition_bps = (bytes * 8 * 1000) / window_size_ms_;
+      if (*current_rate + bitrate_addition_bps > max_rate_bps_)
+        return false;
+    }
+
+    current_rate_.Update(bytes, clock_->TimeInMilliseconds());
+    return true;
+  }
+
+  // Set the maximum bitrate, in bps, that this limiter allows to send.
+  void SetMaxRate(uint32_t max_bitrate_bps) {
+    rtc::CritScope cs(&lock_);
+    max_rate_bps_ = max_bitrate_bps;

[danilchap, 2016/06/28 14:26:17]

maybe rename max_rate_bps_ to max_bitrate_bps_
or max_bitrate_bps to max_rate_bps
to make names look more consistant.

[sprang_webrtc, 2016/07/04 09:33:03]

Done.

+  }
+
+  // Set the window size over which to measure the current bitrate.
+  // For retransmissions, this is typically the RTT.
+  void SetWindowSize(int64_t window_size_ms) {
+    rtc::CritScope cs(&lock_);
+    window_size_ms_ = window_size_ms;
+    current_rate_.SetWindowSize(window_size_ms, clock_->TimeInMilliseconds());
+  }
+
+ private:
+  Clock* const clock_;
+  rtc::CriticalSection lock_;
+  RateStatistics current_rate_ GUARDED_BY(lock_);
+  int64_t window_size_ms_ GUARDED_BY(lock_);
+  uint32_t max_rate_bps_ GUARDED_BY(lock_);
+
+  RTC_DISALLOW_COPY_AND_ASSIGN(RateLimiter);

[danilchap, 2016/06/28 14:26:17]

RTC_DISALLOW_IMPLICIT_CONSTRUCTORS(RateLimiter) since you are not using default
constructor too.

[sprang_webrtc, 2016/07/04 09:33:03]

Done.

+};
+
 CongestionController::CongestionController(
     Clock* clock,
     BitrateObserver* bitrate_observer,
     RemoteBitrateObserver* remote_bitrate_observer)
     : clock_(clock),
       observer_(nullptr),
       packet_router_(new PacketRouter()),
       pacer_(new PacedSender(clock_, packet_router_.get())),
       remote_bitrate_estimator_(
           new WrappingBitrateEstimator(remote_bitrate_observer, clock_)),
       bitrate_controller_(
           BitrateController::CreateBitrateController(clock_, bitrate_observer)),
+      nack_rate_limiter_(
+          new RateLimiter(clock,
+                          kMaxRetransmitWindowSizeMs,
+                          RemoteBitrateEstimator::kDefaultMinBitrateBps)),
       remote_estimator_proxy_(clock_, packet_router_.get()),
       transport_feedback_adapter_(bitrate_controller_.get(), clock_),
       min_bitrate_bps_(RemoteBitrateEstimator::kDefaultMinBitrateBps),
       last_reported_bitrate_bps_(0),
       last_reported_fraction_loss_(0),
       last_reported_rtt_(0),
       network_state_(kNetworkUp) {
   Init();
 }
 
 CongestionController::CongestionController(
     Clock* clock,
     Observer* observer,
     RemoteBitrateObserver* remote_bitrate_observer)
     : clock_(clock),
       observer_(observer),
       packet_router_(new PacketRouter()),
       pacer_(new PacedSender(clock_, packet_router_.get())),
       remote_bitrate_estimator_(
           new WrappingBitrateEstimator(remote_bitrate_observer, clock_)),
       bitrate_controller_(BitrateController::CreateBitrateController(clock_)),
+      nack_rate_limiter_(
+          new RateLimiter(clock,
+                          kMaxRetransmitWindowSizeMs,

[danilchap, 2016/06/28 14:26:17]

RateLimiter is local class, and window size/bitrate are initialized with same
constants. May be use this constants inside RateLimiter constructor class
instead of passing them as parameters. Would make CongestionController
constructors cleaner.

[sprang_webrtc, 2016/07/04 09:33:03]

True. This was a leftover from a partial refactoring.

+                          RemoteBitrateEstimator::kDefaultMinBitrateBps)),
       remote_estimator_proxy_(clock_, packet_router_.get()),
       transport_feedback_adapter_(bitrate_controller_.get(), clock_),
       min_bitrate_bps_(RemoteBitrateEstimator::kDefaultMinBitrateBps),
       last_reported_bitrate_bps_(0),
       last_reported_fraction_loss_(0),
       last_reported_rtt_(0),
       network_state_(kNetworkUp) {
   Init();
 }
 
 CongestionController::CongestionController(
     Clock* clock,
     Observer* observer,
     RemoteBitrateObserver* remote_bitrate_observer,
     std::unique_ptr<PacketRouter> packet_router,
     std::unique_ptr<PacedSender> pacer)
     : clock_(clock),
       observer_(observer),
       packet_router_(std::move(packet_router)),
       pacer_(std::move(pacer)),
       remote_bitrate_estimator_(
           new WrappingBitrateEstimator(remote_bitrate_observer, clock_)),
       // Constructed last as this object calls the provided callback on
       // construction.
       bitrate_controller_(BitrateController::CreateBitrateController(clock_)),
+      nack_rate_limiter_(
+          new RateLimiter(clock,
+                          kMaxRetransmitWindowSizeMs,
+                          RemoteBitrateEstimator::kDefaultMinBitrateBps)),
       remote_estimator_proxy_(clock_, packet_router_.get()),
       transport_feedback_adapter_(bitrate_controller_.get(), clock_),
       min_bitrate_bps_(RemoteBitrateEstimator::kDefaultMinBitrateBps),
       last_reported_bitrate_bps_(0),
       last_reported_fraction_loss_(0),
       last_reported_rtt_(0),
       network_state_(kNetworkUp) {
   Init();
 }
 
@@ skipping 44 matching lines @@
   } else {
     return remote_bitrate_estimator_.get();
   }
 }
 
 TransportFeedbackObserver*
 CongestionController::GetTransportFeedbackObserver() {
   return &transport_feedback_adapter_;
 }
 
+NackRateLimiter* CongestionController::GetNackRateLimiter() {
+  return nack_rate_limiter_.get();
+}
+
 void CongestionController::SetAllocatedSendBitrateLimits(
     int min_send_bitrate_bps,
     int max_padding_bitrate_bps) {
   pacer_->SetSendBitrateLimits(min_send_bitrate_bps, max_padding_bitrate_bps);
 }
 
 int64_t CongestionController::GetPacerQueuingDelayMs() const {
   return pacer_->QueueInMs();
 }
 
@@ skipping 11 matching lines @@
 }
 
 void CongestionController::OnSentPacket(const rtc::SentPacket& sent_packet) {
   transport_feedback_adapter_.OnSentPacket(sent_packet.packet_id,
                                             sent_packet.send_time_ms);
 }
 
 void CongestionController::OnRttUpdate(int64_t avg_rtt_ms, int64_t max_rtt_ms) {
   remote_bitrate_estimator_->OnRttUpdate(avg_rtt_ms, max_rtt_ms);
   transport_feedback_adapter_.OnRttUpdate(avg_rtt_ms, max_rtt_ms);
+
+  int64_t nack_window_size = max_rtt_ms;

[danilchap, 2016/06/28 14:26:17]

nack_window_size_ms

[sprang_webrtc, 2016/07/04 09:33:03]

Done.

+  if (nack_window_size > kMaxRetransmitWindowSizeMs) {
+    nack_window_size = kMaxRetransmitWindowSizeMs;
+  } else if (nack_window_size < kMinRetransmitWindowSizeMs) {
+    nack_window_size = kMinRetransmitWindowSizeMs;
+  }
+  nack_rate_limiter_->SetWindowSize(nack_window_size);
 }
 
 int64_t CongestionController::TimeUntilNextProcess() {
   return std::min(bitrate_controller_->TimeUntilNextProcess(),
                   remote_bitrate_estimator_->TimeUntilNextProcess());
 }
 
 void CongestionController::Process() {
   bitrate_controller_->Process();
   remote_bitrate_estimator_->Process();
   MaybeTriggerOnNetworkChanged();
 }
 
 void CongestionController::MaybeTriggerOnNetworkChanged() {
   // TODO(perkj): |observer_| can be nullptr if the ctor that accepts a
   // BitrateObserver is used. Remove this check once the ctor is removed.
   if (!observer_)
     return;
 
   uint32_t bitrate_bps;
   uint8_t fraction_loss;
   int64_t rtt;
   bool estimate_changed = bitrate_controller_->GetNetworkParameters(
       &bitrate_bps, &fraction_loss, &rtt);
-  if (estimate_changed)
+  if (estimate_changed) {
     pacer_->SetEstimatedBitrate(bitrate_bps);
+    nack_rate_limiter_->SetMaxRate(bitrate_bps);
+  }
 
   bitrate_bps = IsNetworkDown() || IsSendQueueFull() ? 0 : bitrate_bps;
 
   if (HasNetworkParametersToReportChanged(bitrate_bps, fraction_loss, rtt)) {
     observer_->OnNetworkChanged(bitrate_bps, fraction_loss, rtt);
   }
 }
 
 bool CongestionController::HasNetworkParametersToReportChanged(
     uint32_t bitrate_bps,
@@ skipping 13 matching lines @@
 bool CongestionController::IsSendQueueFull() const {
   return pacer_->ExpectedQueueTimeMs() > PacedSender::kMaxQueueLengthMs;
 }
 
 bool CongestionController::IsNetworkDown() const {
   rtc::CritScope cs(&critsect_);
   return network_state_ == kNetworkDown;
 }
 
 }  // namespace webrtc