blob: 394c14747b7acb2ad014a54005d48a557f03b74d [file] [log] [blame]
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +00001/*
2 * Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020011#include "modules/bitrate_controller/send_side_bandwidth_estimation.h"
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +000012
jbauchf91e6d02016-01-24 23:05:21 -080013#include <algorithm>
Piotr Tworek5e4833c2017-12-12 12:09:31 +010014#include <cstdio>
Stefan Holmer9c79ed92017-03-31 15:53:27 +020015#include <limits>
16#include <string>
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +000017
Karl Wiberg918f50c2018-07-05 11:40:33 +020018#include "absl/memory/memory.h"
Yves Gerey988cc082018-10-23 12:03:01 +020019#include "logging/rtc_event_log/events/rtc_event.h"
Elad Alon4a87e1c2017-10-03 16:11:34 +020020#include "logging/rtc_event_log/events/rtc_event_bwe_update_loss_based.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020021#include "logging/rtc_event_log/rtc_event_log.h"
22#include "modules/remote_bitrate_estimator/include/bwe_defines.h"
23#include "rtc_base/checks.h"
24#include "rtc_base/logging.h"
25#include "system_wrappers/include/field_trial.h"
26#include "system_wrappers/include/metrics.h"
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +000027
28namespace webrtc {
andresp@webrtc.org07bc7342014-03-21 16:51:01 +000029namespace {
Sebastian Jansson7c1744d2018-10-08 11:00:50 +020030constexpr TimeDelta kBweIncreaseInterval = TimeDelta::Millis<1000>();
31constexpr TimeDelta kBweDecreaseInterval = TimeDelta::Millis<300>();
32constexpr TimeDelta kStartPhase = TimeDelta::Millis<2000>();
33constexpr TimeDelta kBweConverganceTime = TimeDelta::Millis<20000>();
34constexpr int kLimitNumPackets = 20;
35constexpr DataRate kDefaultMaxBitrate = DataRate::BitsPerSec<1000000000>();
36constexpr TimeDelta kLowBitrateLogPeriod = TimeDelta::Millis<10000>();
37constexpr TimeDelta kRtcEventLogPeriod = TimeDelta::Millis<5000>();
Stefan Holmer52200d02016-09-20 14:14:23 +020038// Expecting that RTCP feedback is sent uniformly within [0.5, 1.5]s intervals.
Sebastian Jansson7c1744d2018-10-08 11:00:50 +020039constexpr TimeDelta kMaxRtcpFeedbackInterval = TimeDelta::Millis<5000>();
40constexpr int kFeedbackTimeoutIntervals = 3;
41constexpr TimeDelta kTimeoutInterval = TimeDelta::Millis<1000>();
andresp@webrtc.org07bc7342014-03-21 16:51:01 +000042
Sebastian Jansson7c1744d2018-10-08 11:00:50 +020043constexpr float kDefaultLowLossThreshold = 0.02f;
44constexpr float kDefaultHighLossThreshold = 0.1f;
45constexpr DataRate kDefaultBitrateThreshold = DataRate::Zero();
Stefan Holmer9c79ed92017-03-31 15:53:27 +020046
stefan@webrtc.org474e36e2015-01-19 15:44:47 +000047struct UmaRampUpMetric {
48 const char* metric_name;
49 int bitrate_kbps;
50};
51
52const UmaRampUpMetric kUmaRampupMetrics[] = {
53 {"WebRTC.BWE.RampUpTimeTo500kbpsInMs", 500},
54 {"WebRTC.BWE.RampUpTimeTo1000kbpsInMs", 1000},
55 {"WebRTC.BWE.RampUpTimeTo2000kbpsInMs", 2000}};
56const size_t kNumUmaRampupMetrics =
57 sizeof(kUmaRampupMetrics) / sizeof(kUmaRampupMetrics[0]);
58
Stefan Holmer9c79ed92017-03-31 15:53:27 +020059const char kBweLosExperiment[] = "WebRTC-BweLossExperiment";
60
61bool BweLossExperimentIsEnabled() {
62 std::string experiment_string =
63 webrtc::field_trial::FindFullName(kBweLosExperiment);
64 // The experiment is enabled iff the field trial string begins with "Enabled".
65 return experiment_string.find("Enabled") == 0;
66}
67
68bool ReadBweLossExperimentParameters(float* low_loss_threshold,
69 float* high_loss_threshold,
70 uint32_t* bitrate_threshold_kbps) {
71 RTC_DCHECK(low_loss_threshold);
72 RTC_DCHECK(high_loss_threshold);
73 RTC_DCHECK(bitrate_threshold_kbps);
74 std::string experiment_string =
75 webrtc::field_trial::FindFullName(kBweLosExperiment);
76 int parsed_values =
77 sscanf(experiment_string.c_str(), "Enabled-%f,%f,%u", low_loss_threshold,
78 high_loss_threshold, bitrate_threshold_kbps);
79 if (parsed_values == 3) {
80 RTC_CHECK_GT(*low_loss_threshold, 0.0f)
81 << "Loss threshold must be greater than 0.";
82 RTC_CHECK_LE(*low_loss_threshold, 1.0f)
83 << "Loss threshold must be less than or equal to 1.";
84 RTC_CHECK_GT(*high_loss_threshold, 0.0f)
85 << "Loss threshold must be greater than 0.";
86 RTC_CHECK_LE(*high_loss_threshold, 1.0f)
87 << "Loss threshold must be less than or equal to 1.";
88 RTC_CHECK_LE(*low_loss_threshold, *high_loss_threshold)
89 << "The low loss threshold must be less than or equal to the high loss "
90 "threshold.";
91 RTC_CHECK_GE(*bitrate_threshold_kbps, 0)
92 << "Bitrate threshold can't be negative.";
93 RTC_CHECK_LT(*bitrate_threshold_kbps,
94 std::numeric_limits<int>::max() / 1000)
95 << "Bitrate must be smaller enough to avoid overflows.";
96 return true;
97 }
Mirko Bonadei675513b2017-11-09 11:09:25 +010098 RTC_LOG(LS_WARNING) << "Failed to parse parameters for BweLossExperiment "
99 "experiment from field trial string. Using default.";
Stefan Holmer9c79ed92017-03-31 15:53:27 +0200100 *low_loss_threshold = kDefaultLowLossThreshold;
101 *high_loss_threshold = kDefaultHighLossThreshold;
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200102 *bitrate_threshold_kbps = kDefaultBitrateThreshold.kbps();
Stefan Holmer9c79ed92017-03-31 15:53:27 +0200103 return false;
104}
jbauchf91e6d02016-01-24 23:05:21 -0800105} // namespace
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000106
Sebastian Jansson57f3ad02018-11-23 14:49:18 +0100107LinkCapacityTracker::LinkCapacityTracker()
108 : tracking_rate("rate", TimeDelta::seconds(10)) {
109 ParseFieldTrial({&tracking_rate},
110 field_trial::FindFullName("WebRTC-Bwe-LinkCapacity"));
111}
112
113LinkCapacityTracker::~LinkCapacityTracker() {}
114
115void LinkCapacityTracker::OnOveruse(DataRate acknowledged_rate,
116 Timestamp at_time) {
117 capacity_estimate_bps_ =
118 std::min(capacity_estimate_bps_, acknowledged_rate.bps<double>());
119 last_link_capacity_update_ = at_time;
120}
121
122void LinkCapacityTracker::OnStartingRate(DataRate start_rate) {
123 if (last_link_capacity_update_.IsInfinite())
124 capacity_estimate_bps_ = start_rate.bps<double>();
125}
126
127void LinkCapacityTracker::OnRateUpdate(DataRate acknowledged,
128 Timestamp at_time) {
129 if (acknowledged.bps() > capacity_estimate_bps_) {
130 TimeDelta delta = at_time - last_link_capacity_update_;
131 double alpha = delta.IsFinite() ? exp(-(delta / tracking_rate.Get())) : 0;
132 capacity_estimate_bps_ = alpha * capacity_estimate_bps_ +
133 (1 - alpha) * acknowledged.bps<double>();
134 }
135 last_link_capacity_update_ = at_time;
136}
137
138void LinkCapacityTracker::OnRttBackoff(DataRate backoff_rate,
139 Timestamp at_time) {
140 capacity_estimate_bps_ =
141 std::min(capacity_estimate_bps_, backoff_rate.bps<double>());
142 last_link_capacity_update_ = at_time;
143}
144
145DataRate LinkCapacityTracker::estimate() const {
146 return DataRate::bps(capacity_estimate_bps_);
147}
148
Sebastian Jansson24643482018-11-14 14:19:45 +0100149RttBasedBackoff::RttBasedBackoff()
150 : rtt_limit_("limit", TimeDelta::PlusInfinity()),
151 drop_fraction_("fraction", 0.5),
152 drop_interval_("interval", TimeDelta::ms(300)),
153 persist_on_route_change_("persist"),
154 // By initializing this to plus infinity, we make sure that we never
155 // trigger rtt backoff unless packet feedback is enabled.
156 last_propagation_rtt_update_(Timestamp::PlusInfinity()),
157 last_propagation_rtt_(TimeDelta::Zero()) {
158 ParseFieldTrial({&rtt_limit_, &drop_fraction_, &drop_interval_,
159 &persist_on_route_change_},
160 field_trial::FindFullName("WebRTC-Bwe-MaxRttLimit"));
Sebastian Jansson2e068e82018-10-08 12:49:53 +0200161}
Sebastian Jansson24643482018-11-14 14:19:45 +0100162
163void RttBasedBackoff::OnRouteChange() {
164 if (!persist_on_route_change_) {
165 last_propagation_rtt_update_ = Timestamp::PlusInfinity();
166 last_propagation_rtt_ = TimeDelta::Zero();
167 }
168}
169
170void RttBasedBackoff::UpdatePropagationRtt(Timestamp at_time,
171 TimeDelta propagation_rtt) {
172 last_propagation_rtt_update_ = at_time;
173 last_propagation_rtt_ = propagation_rtt;
174}
175
176TimeDelta RttBasedBackoff::RttLowerBound(Timestamp at_time) const {
177 // TODO(srte): Use time since last unacknowledged packet for this.
178 TimeDelta time_since_rtt = at_time - last_propagation_rtt_update_;
179 return time_since_rtt + last_propagation_rtt_;
180}
181
182RttBasedBackoff::~RttBasedBackoff() = default;
Sebastian Jansson2e068e82018-10-08 12:49:53 +0200183
ivoc14d5dbe2016-07-04 07:06:55 -0700184SendSideBandwidthEstimation::SendSideBandwidthEstimation(RtcEventLog* event_log)
Sebastian Jansson24643482018-11-14 14:19:45 +0100185 : lost_packets_since_last_loss_update_(0),
pbosb7edb882015-10-22 08:52:20 -0700186 expected_packets_since_last_loss_update_(0),
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200187 current_bitrate_(DataRate::Zero()),
188 min_bitrate_configured_(
189 DataRate::bps(congestion_controller::GetMinBitrateBps())),
190 max_bitrate_configured_(kDefaultMaxBitrate),
191 last_low_bitrate_log_(Timestamp::MinusInfinity()),
pbosb7edb882015-10-22 08:52:20 -0700192 has_decreased_since_last_fraction_loss_(false),
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200193 last_loss_feedback_(Timestamp::MinusInfinity()),
194 last_loss_packet_report_(Timestamp::MinusInfinity()),
195 last_timeout_(Timestamp::MinusInfinity()),
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000196 last_fraction_loss_(0),
stefan3821ff82016-09-04 05:07:26 -0700197 last_logged_fraction_loss_(0),
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200198 last_round_trip_time_(TimeDelta::Zero()),
199 bwe_incoming_(DataRate::Zero()),
200 delay_based_bitrate_(DataRate::Zero()),
201 time_last_decrease_(Timestamp::MinusInfinity()),
202 first_report_time_(Timestamp::MinusInfinity()),
stefan@webrtc.org548b2282014-11-03 14:42:43 +0000203 initially_lost_packets_(0),
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200204 bitrate_at_2_seconds_(DataRate::Zero()),
stefan@webrtc.org474e36e2015-01-19 15:44:47 +0000205 uma_update_state_(kNoUpdate),
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100206 uma_rtt_state_(kNoUpdate),
terelius006d93d2015-11-05 12:02:15 -0800207 rampup_uma_stats_updated_(kNumUmaRampupMetrics, false),
stefan3821ff82016-09-04 05:07:26 -0700208 event_log_(event_log),
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200209 last_rtc_event_log_(Timestamp::MinusInfinity()),
sprangc1b57a12017-02-28 08:50:47 -0800210 in_timeout_experiment_(
Stefan Holmer9c79ed92017-03-31 15:53:27 +0200211 webrtc::field_trial::IsEnabled("WebRTC-FeedbackTimeout")),
212 low_loss_threshold_(kDefaultLowLossThreshold),
213 high_loss_threshold_(kDefaultHighLossThreshold),
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200214 bitrate_threshold_(kDefaultBitrateThreshold) {
ivoc14d5dbe2016-07-04 07:06:55 -0700215 RTC_DCHECK(event_log);
Stefan Holmer9c79ed92017-03-31 15:53:27 +0200216 if (BweLossExperimentIsEnabled()) {
217 uint32_t bitrate_threshold_kbps;
218 if (ReadBweLossExperimentParameters(&low_loss_threshold_,
219 &high_loss_threshold_,
220 &bitrate_threshold_kbps)) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100221 RTC_LOG(LS_INFO) << "Enabled BweLossExperiment with parameters "
222 << low_loss_threshold_ << ", " << high_loss_threshold_
223 << ", " << bitrate_threshold_kbps;
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200224 bitrate_threshold_ = DataRate::kbps(bitrate_threshold_kbps);
Stefan Holmer9c79ed92017-03-31 15:53:27 +0200225 }
226 }
ivoc14d5dbe2016-07-04 07:06:55 -0700227}
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000228
andresp@webrtc.org16b75c22014-03-21 14:00:51 +0000229SendSideBandwidthEstimation::~SendSideBandwidthEstimation() {}
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000230
Sebastian Jansson24643482018-11-14 14:19:45 +0100231void SendSideBandwidthEstimation::OnRouteChange() {
232 lost_packets_since_last_loss_update_ = 0;
233 expected_packets_since_last_loss_update_ = 0;
234 current_bitrate_ = DataRate::Zero();
235 min_bitrate_configured_ =
236 DataRate::bps(congestion_controller::GetMinBitrateBps());
237 max_bitrate_configured_ = kDefaultMaxBitrate;
238 last_low_bitrate_log_ = Timestamp::MinusInfinity();
239 has_decreased_since_last_fraction_loss_ = false;
240 last_loss_feedback_ = Timestamp::MinusInfinity();
241 last_loss_packet_report_ = Timestamp::MinusInfinity();
242 last_timeout_ = Timestamp::MinusInfinity();
243 last_fraction_loss_ = 0;
244 last_logged_fraction_loss_ = 0;
245 last_round_trip_time_ = TimeDelta::Zero();
246 bwe_incoming_ = DataRate::Zero();
247 delay_based_bitrate_ = DataRate::Zero();
248 time_last_decrease_ = Timestamp::MinusInfinity();
249 first_report_time_ = Timestamp::MinusInfinity();
250 initially_lost_packets_ = 0;
251 bitrate_at_2_seconds_ = DataRate::Zero();
252 uma_update_state_ = kNoUpdate;
253 uma_rtt_state_ = kNoUpdate;
254 last_rtc_event_log_ = Timestamp::MinusInfinity();
255
256 rtt_backoff_.OnRouteChange();
257}
258
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200259void SendSideBandwidthEstimation::SetBitrates(
260 absl::optional<DataRate> send_bitrate,
261 DataRate min_bitrate,
262 DataRate max_bitrate,
263 Timestamp at_time) {
philipel1b965312017-04-18 06:55:32 -0700264 SetMinMaxBitrate(min_bitrate, max_bitrate);
Sebastian Jansson57f3ad02018-11-23 14:49:18 +0100265 if (send_bitrate) {
266 link_capacity_.OnStartingRate(*send_bitrate);
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200267 SetSendBitrate(*send_bitrate, at_time);
Sebastian Jansson57f3ad02018-11-23 14:49:18 +0100268 }
philipelc6957c72016-04-28 15:52:49 +0200269}
270
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200271void SendSideBandwidthEstimation::SetSendBitrate(DataRate bitrate,
272 Timestamp at_time) {
273 RTC_DCHECK(bitrate > DataRate::Zero());
274 // Reset to avoid being capped by the estimate.
275 delay_based_bitrate_ = DataRate::Zero();
Christoffer Rodbro3a837482018-11-19 15:30:23 +0100276 if (loss_based_bandwidth_estimation_.Enabled()) {
277 loss_based_bandwidth_estimation_.MaybeReset(bitrate);
278 }
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200279 CapBitrateToThresholds(at_time, bitrate);
andresp@webrtc.org44caf012014-03-26 21:00:21 +0000280 // Clear last sent bitrate history so the new value can be used directly
281 // and not capped.
282 min_bitrate_history_.clear();
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000283}
284
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200285void SendSideBandwidthEstimation::SetMinMaxBitrate(DataRate min_bitrate,
286 DataRate max_bitrate) {
michaeltf082c2a2016-11-07 04:17:14 -0800287 min_bitrate_configured_ =
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200288 std::max(min_bitrate, congestion_controller::GetMinBitrate());
289 if (max_bitrate > DataRate::Zero() && max_bitrate.IsFinite()) {
290 max_bitrate_configured_ = std::max(min_bitrate_configured_, max_bitrate);
Stefan Holmere5904162015-03-26 11:11:06 +0100291 } else {
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200292 max_bitrate_configured_ = kDefaultMaxBitrate;
Stefan Holmere5904162015-03-26 11:11:06 +0100293 }
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000294}
295
Stefan Holmere5904162015-03-26 11:11:06 +0100296int SendSideBandwidthEstimation::GetMinBitrate() const {
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200297 return min_bitrate_configured_.bps<int>();
henrik.lundin@webrtc.org845862f2014-03-06 07:19:28 +0000298}
299
Stefan Holmere5904162015-03-26 11:11:06 +0100300void SendSideBandwidthEstimation::CurrentEstimate(int* bitrate,
andresp@webrtc.org07bc7342014-03-21 16:51:01 +0000301 uint8_t* loss,
pkasting@chromium.org16825b12015-01-12 21:51:21 +0000302 int64_t* rtt) const {
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200303 *bitrate = current_bitrate_.bps<int>();
andresp@webrtc.org07bc7342014-03-21 16:51:01 +0000304 *loss = last_fraction_loss_;
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200305 *rtt = last_round_trip_time_.ms<int64_t>();
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000306}
307
Sebastian Jansson57f3ad02018-11-23 14:49:18 +0100308DataRate SendSideBandwidthEstimation::GetEstimatedLinkCapacity() const {
309 return link_capacity_.estimate();
310}
311
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200312void SendSideBandwidthEstimation::UpdateReceiverEstimate(Timestamp at_time,
313 DataRate bandwidth) {
andresp@webrtc.org07bc7342014-03-21 16:51:01 +0000314 bwe_incoming_ = bandwidth;
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200315 CapBitrateToThresholds(at_time, current_bitrate_);
andresp@webrtc.org07bc7342014-03-21 16:51:01 +0000316}
317
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200318void SendSideBandwidthEstimation::UpdateDelayBasedEstimate(Timestamp at_time,
319 DataRate bitrate) {
Sebastian Jansson57f3ad02018-11-23 14:49:18 +0100320 if (acknowledged_rate_) {
321 if (bitrate < delay_based_bitrate_) {
322 link_capacity_.OnOveruse(*acknowledged_rate_, at_time);
323 }
324 }
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200325 delay_based_bitrate_ = bitrate;
326 CapBitrateToThresholds(at_time, current_bitrate_);
stefan32f81542016-01-20 07:13:58 -0800327}
328
Sebastian Jansson57f3ad02018-11-23 14:49:18 +0100329void SendSideBandwidthEstimation::SetAcknowledgedRate(
330 absl::optional<DataRate> acknowledged_rate,
331 Timestamp at_time) {
332 acknowledged_rate_ = acknowledged_rate;
333 if (acknowledged_rate && loss_based_bandwidth_estimation_.Enabled()) {
Christoffer Rodbro3a837482018-11-19 15:30:23 +0100334 loss_based_bandwidth_estimation_.UpdateAcknowledgedBitrate(
Sebastian Jansson57f3ad02018-11-23 14:49:18 +0100335 *acknowledged_rate, at_time);
Christoffer Rodbro3a837482018-11-19 15:30:23 +0100336 }
Sebastian Jansson57f3ad02018-11-23 14:49:18 +0100337}
338
339void SendSideBandwidthEstimation::IncomingPacketFeedbackVector(
340 const TransportPacketsFeedback& report) {
341 if (loss_based_bandwidth_estimation_.Enabled()) {
342 loss_based_bandwidth_estimation_.UpdateLossStatistics(
343 report.packet_feedbacks, report.feedback_time);
344 }
Christoffer Rodbro3a837482018-11-19 15:30:23 +0100345}
346
andresp@webrtc.org07bc7342014-03-21 16:51:01 +0000347void SendSideBandwidthEstimation::UpdateReceiverBlock(uint8_t fraction_loss,
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200348 TimeDelta rtt,
andresp@webrtc.org07bc7342014-03-21 16:51:01 +0000349 int number_of_packets,
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200350 Timestamp at_time) {
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100351 const int kRoundingConstant = 128;
352 int packets_lost = (static_cast<int>(fraction_loss) * number_of_packets +
353 kRoundingConstant) >>
354 8;
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200355 UpdatePacketsLost(packets_lost, number_of_packets, at_time);
356 UpdateRtt(rtt, at_time);
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100357}
358
359void SendSideBandwidthEstimation::UpdatePacketsLost(int packets_lost,
360 int number_of_packets,
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200361 Timestamp at_time) {
362 last_loss_feedback_ = at_time;
363 if (first_report_time_.IsInfinite())
364 first_report_time_ = at_time;
stefan@webrtc.org83d48042014-11-10 13:55:16 +0000365
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000366 // Check sequence number diff and weight loss report
367 if (number_of_packets > 0) {
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000368 // Accumulate reports.
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100369 lost_packets_since_last_loss_update_ += packets_lost;
pbosb7edb882015-10-22 08:52:20 -0700370 expected_packets_since_last_loss_update_ += number_of_packets;
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000371
pbosb7edb882015-10-22 08:52:20 -0700372 // Don't generate a loss rate until it can be based on enough packets.
373 if (expected_packets_since_last_loss_update_ < kLimitNumPackets)
andresp@webrtc.org07bc7342014-03-21 16:51:01 +0000374 return;
pbosb7edb882015-10-22 08:52:20 -0700375
376 has_decreased_since_last_fraction_loss_ = false;
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100377 int64_t lost_q8 = lost_packets_since_last_loss_update_ << 8;
378 int64_t expected = expected_packets_since_last_loss_update_;
379 last_fraction_loss_ = std::min<int>(lost_q8 / expected, 255);
pbosb7edb882015-10-22 08:52:20 -0700380
381 // Reset accumulators.
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100382
383 lost_packets_since_last_loss_update_ = 0;
pbosb7edb882015-10-22 08:52:20 -0700384 expected_packets_since_last_loss_update_ = 0;
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200385 last_loss_packet_report_ = at_time;
386 UpdateEstimate(at_time);
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000387 }
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200388 UpdateUmaStatsPacketsLost(at_time, packets_lost);
stefan@webrtc.orgdb262472014-11-04 19:32:10 +0000389}
390
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200391void SendSideBandwidthEstimation::UpdateUmaStatsPacketsLost(Timestamp at_time,
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100392 int packets_lost) {
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200393 DataRate bitrate_kbps = DataRate::kbps((current_bitrate_.bps() + 500) / 1000);
stefan@webrtc.org474e36e2015-01-19 15:44:47 +0000394 for (size_t i = 0; i < kNumUmaRampupMetrics; ++i) {
395 if (!rampup_uma_stats_updated_[i] &&
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200396 bitrate_kbps.kbps() >= kUmaRampupMetrics[i].bitrate_kbps) {
asapersson1d02d3e2016-09-09 22:40:25 -0700397 RTC_HISTOGRAMS_COUNTS_100000(i, kUmaRampupMetrics[i].metric_name,
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200398 (at_time - first_report_time_).ms());
stefan@webrtc.org474e36e2015-01-19 15:44:47 +0000399 rampup_uma_stats_updated_[i] = true;
400 }
401 }
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200402 if (IsInStartPhase(at_time)) {
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100403 initially_lost_packets_ += packets_lost;
stefan@webrtc.orgdb262472014-11-04 19:32:10 +0000404 } else if (uma_update_state_ == kNoUpdate) {
405 uma_update_state_ = kFirstDone;
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200406 bitrate_at_2_seconds_ = bitrate_kbps;
asapersson1d02d3e2016-09-09 22:40:25 -0700407 RTC_HISTOGRAM_COUNTS("WebRTC.BWE.InitiallyLostPackets",
408 initially_lost_packets_, 0, 100, 50);
asapersson1d02d3e2016-09-09 22:40:25 -0700409 RTC_HISTOGRAM_COUNTS("WebRTC.BWE.InitialBandwidthEstimate",
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200410 bitrate_at_2_seconds_.kbps(), 0, 2000, 50);
stefan@webrtc.orgdb262472014-11-04 19:32:10 +0000411 } else if (uma_update_state_ == kFirstDone &&
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200412 at_time - first_report_time_ >= kBweConverganceTime) {
stefan@webrtc.orgdb262472014-11-04 19:32:10 +0000413 uma_update_state_ = kDone;
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200414 int bitrate_diff_kbps = std::max(
415 bitrate_at_2_seconds_.kbps<int>() - bitrate_kbps.kbps<int>(), 0);
asapersson1d02d3e2016-09-09 22:40:25 -0700416 RTC_HISTOGRAM_COUNTS("WebRTC.BWE.InitialVsConvergedDiff", bitrate_diff_kbps,
417 0, 2000, 50);
stefan@webrtc.org548b2282014-11-03 14:42:43 +0000418 }
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000419}
420
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200421void SendSideBandwidthEstimation::UpdateRtt(TimeDelta rtt, Timestamp at_time) {
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100422 // Update RTT if we were able to compute an RTT based on this RTCP.
423 // FlexFEC doesn't send RTCP SR, which means we won't be able to compute RTT.
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200424 if (rtt > TimeDelta::Zero())
425 last_round_trip_time_ = rtt;
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100426
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200427 if (!IsInStartPhase(at_time) && uma_rtt_state_ == kNoUpdate) {
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100428 uma_rtt_state_ = kDone;
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200429 RTC_HISTOGRAM_COUNTS("WebRTC.BWE.InitialRtt", rtt.ms<int>(), 0, 2000, 50);
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100430 }
431}
432
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200433void SendSideBandwidthEstimation::UpdateEstimate(Timestamp at_time) {
434 DataRate new_bitrate = current_bitrate_;
Sebastian Jansson24643482018-11-14 14:19:45 +0100435 if (rtt_backoff_.RttLowerBound(at_time) > rtt_backoff_.rtt_limit_) {
436 if (at_time - time_last_decrease_ >= rtt_backoff_.drop_interval_) {
Sebastian Jansson2e068e82018-10-08 12:49:53 +0200437 time_last_decrease_ = at_time;
Sebastian Jansson24643482018-11-14 14:19:45 +0100438 new_bitrate = current_bitrate_ * rtt_backoff_.drop_fraction_;
Sebastian Jansson57f3ad02018-11-23 14:49:18 +0100439 link_capacity_.OnRttBackoff(new_bitrate, at_time);
Sebastian Jansson2e068e82018-10-08 12:49:53 +0200440 }
441 CapBitrateToThresholds(at_time, new_bitrate);
442 return;
443 }
444
stefanfa156692016-01-21 08:55:03 -0800445 // We trust the REMB and/or delay-based estimate during the first 2 seconds if
446 // we haven't had any packet loss reported, to allow startup bitrate probing.
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200447 if (last_fraction_loss_ == 0 && IsInStartPhase(at_time)) {
philipel1b965312017-04-18 06:55:32 -0700448 new_bitrate = std::max(bwe_incoming_, new_bitrate);
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200449 new_bitrate = std::max(delay_based_bitrate_, new_bitrate);
Christoffer Rodbro3a837482018-11-19 15:30:23 +0100450 if (loss_based_bandwidth_estimation_.Enabled()) {
451 loss_based_bandwidth_estimation_.SetInitialBitrate(new_bitrate);
452 }
philipel1b965312017-04-18 06:55:32 -0700453
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200454 if (new_bitrate != current_bitrate_) {
stefanfa156692016-01-21 08:55:03 -0800455 min_bitrate_history_.clear();
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200456 min_bitrate_history_.push_back(std::make_pair(at_time, current_bitrate_));
457 CapBitrateToThresholds(at_time, new_bitrate);
stefanfa156692016-01-21 08:55:03 -0800458 return;
459 }
stefan@webrtc.org82462aa2014-10-23 11:57:05 +0000460 }
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200461 UpdateMinHistory(at_time);
462 if (last_loss_packet_report_.IsInfinite()) {
Stefan Holmer52200d02016-09-20 14:14:23 +0200463 // No feedback received.
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200464 CapBitrateToThresholds(at_time, current_bitrate_);
Stefan Holmer52200d02016-09-20 14:14:23 +0200465 return;
466 }
Christoffer Rodbro3a837482018-11-19 15:30:23 +0100467
468 if (loss_based_bandwidth_estimation_.Enabled()) {
469 loss_based_bandwidth_estimation_.Update(
470 at_time, min_bitrate_history_.front().second, last_round_trip_time_);
471 new_bitrate = MaybeRampupOrBackoff(new_bitrate, at_time);
472 CapBitrateToThresholds(at_time, new_bitrate);
473 return;
474 }
475
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200476 TimeDelta time_since_loss_packet_report = at_time - last_loss_packet_report_;
477 TimeDelta time_since_loss_feedback = at_time - last_loss_feedback_;
478 if (time_since_loss_packet_report < 1.2 * kMaxRtcpFeedbackInterval) {
Stefan Holmer9c79ed92017-03-31 15:53:27 +0200479 // We only care about loss above a given bitrate threshold.
480 float loss = last_fraction_loss_ / 256.0f;
481 // We only make decisions based on loss when the bitrate is above a
482 // threshold. This is a crude way of handling loss which is uncorrelated
483 // to congestion.
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200484 if (current_bitrate_ < bitrate_threshold_ || loss <= low_loss_threshold_) {
andresp@webrtc.org44caf012014-03-26 21:00:21 +0000485 // Loss < 2%: Increase rate by 8% of the min bitrate in the last
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200486 // kBweIncreaseInterval.
andresp@webrtc.org44caf012014-03-26 21:00:21 +0000487 // Note that by remembering the bitrate over the last second one can
488 // rampup up one second faster than if only allowed to start ramping
489 // at 8% per second rate now. E.g.:
Christoffer Rodbro3a837482018-11-19 15:30:23 +0100490 // If sending a constant 100kbps it can rampup immediately to 108kbps
andresp@webrtc.org44caf012014-03-26 21:00:21 +0000491 // whenever a receiver report is received with lower packet loss.
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200492 // If instead one would do: current_bitrate_ *= 1.08^(delta time),
philipel1b965312017-04-18 06:55:32 -0700493 // it would take over one second since the lower packet loss to achieve
Stefan Holmer52200d02016-09-20 14:14:23 +0200494 // 108kbps.
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200495 new_bitrate =
496 DataRate::bps(min_bitrate_history_.front().second.bps() * 1.08 + 0.5);
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000497
andresp@webrtc.org07bc7342014-03-21 16:51:01 +0000498 // Add 1 kbps extra, just to make sure that we do not get stuck
499 // (gives a little extra increase at low rates, negligible at higher
500 // rates).
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200501 new_bitrate += DataRate::bps(1000);
502 } else if (current_bitrate_ > bitrate_threshold_) {
Stefan Holmer9c79ed92017-03-31 15:53:27 +0200503 if (loss <= high_loss_threshold_) {
504 // Loss between 2% - 10%: Do nothing.
505 } else {
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200506 // Loss > 10%: Limit the rate decreases to once a kBweDecreaseInterval
Stefan Holmer9c79ed92017-03-31 15:53:27 +0200507 // + rtt.
508 if (!has_decreased_since_last_fraction_loss_ &&
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200509 (at_time - time_last_decrease_) >=
510 (kBweDecreaseInterval + last_round_trip_time_)) {
511 time_last_decrease_ = at_time;
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000512
Stefan Holmer9c79ed92017-03-31 15:53:27 +0200513 // Reduce rate:
514 // newRate = rate * (1 - 0.5*lossRate);
515 // where packetLoss = 256*lossRate;
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200516 new_bitrate =
517 DataRate::bps((current_bitrate_.bps() *
518 static_cast<double>(512 - last_fraction_loss_)) /
519 512.0);
Stefan Holmer9c79ed92017-03-31 15:53:27 +0200520 has_decreased_since_last_fraction_loss_ = true;
521 }
andresp@webrtc.org44caf012014-03-26 21:00:21 +0000522 }
andresp@webrtc.org07bc7342014-03-21 16:51:01 +0000523 }
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200524 } else if (time_since_loss_feedback >
525 kFeedbackTimeoutIntervals * kMaxRtcpFeedbackInterval &&
526 (last_timeout_.IsInfinite() ||
527 at_time - last_timeout_ > kTimeoutInterval)) {
Stefan Holmer52200d02016-09-20 14:14:23 +0200528 if (in_timeout_experiment_) {
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200529 RTC_LOG(LS_WARNING) << "Feedback timed out ("
530 << ToString(time_since_loss_feedback)
531 << "), reducing bitrate.";
532 new_bitrate = new_bitrate * 0.8;
Stefan Holmer52200d02016-09-20 14:14:23 +0200533 // Reset accumulators since we've already acted on missing feedback and
534 // shouldn't to act again on these old lost packets.
Sebastian Jansson439f0bc2018-02-20 10:46:39 +0100535 lost_packets_since_last_loss_update_ = 0;
Stefan Holmer52200d02016-09-20 14:14:23 +0200536 expected_packets_since_last_loss_update_ = 0;
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200537 last_timeout_ = at_time;
Stefan Holmer52200d02016-09-20 14:14:23 +0200538 }
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000539 }
philipel1b965312017-04-18 06:55:32 -0700540
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200541 CapBitrateToThresholds(at_time, new_bitrate);
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000542}
andresp@webrtc.org4e69f782014-03-17 17:07:48 +0000543
Sebastian Jansson2e068e82018-10-08 12:49:53 +0200544void SendSideBandwidthEstimation::UpdatePropagationRtt(
545 Timestamp at_time,
546 TimeDelta propagation_rtt) {
Sebastian Jansson24643482018-11-14 14:19:45 +0100547 rtt_backoff_.UpdatePropagationRtt(at_time, propagation_rtt);
Sebastian Jansson2e068e82018-10-08 12:49:53 +0200548}
549
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200550bool SendSideBandwidthEstimation::IsInStartPhase(Timestamp at_time) const {
551 return first_report_time_.IsInfinite() ||
552 at_time - first_report_time_ < kStartPhase;
stefan@webrtc.org548b2282014-11-03 14:42:43 +0000553}
554
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200555void SendSideBandwidthEstimation::UpdateMinHistory(Timestamp at_time) {
andresp@webrtc.org44caf012014-03-26 21:00:21 +0000556 // Remove old data points from history.
557 // Since history precision is in ms, add one so it is able to increase
558 // bitrate if it is off by as little as 0.5ms.
559 while (!min_bitrate_history_.empty() &&
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200560 at_time - min_bitrate_history_.front().first + TimeDelta::ms(1) >
561 kBweIncreaseInterval) {
andresp@webrtc.org44caf012014-03-26 21:00:21 +0000562 min_bitrate_history_.pop_front();
563 }
564
565 // Typical minimum sliding-window algorithm: Pop values higher than current
566 // bitrate before pushing it.
567 while (!min_bitrate_history_.empty() &&
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200568 current_bitrate_ <= min_bitrate_history_.back().second) {
andresp@webrtc.org44caf012014-03-26 21:00:21 +0000569 min_bitrate_history_.pop_back();
570 }
571
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200572 min_bitrate_history_.push_back(std::make_pair(at_time, current_bitrate_));
andresp@webrtc.org44caf012014-03-26 21:00:21 +0000573}
574
Christoffer Rodbro3a837482018-11-19 15:30:23 +0100575DataRate SendSideBandwidthEstimation::MaybeRampupOrBackoff(DataRate new_bitrate,
576 Timestamp at_time) {
577 // TODO(crodbro): reuse this code in UpdateEstimate instead of current
578 // inlining of very similar functionality.
579 const TimeDelta time_since_loss_packet_report =
580 at_time - last_loss_packet_report_;
581 const TimeDelta time_since_loss_feedback = at_time - last_loss_feedback_;
582 if (time_since_loss_packet_report < 1.2 * kMaxRtcpFeedbackInterval) {
583 new_bitrate = min_bitrate_history_.front().second * 1.08;
584 new_bitrate += DataRate::bps(1000);
585 } else if (time_since_loss_feedback >
586 kFeedbackTimeoutIntervals * kMaxRtcpFeedbackInterval &&
587 (last_timeout_.IsInfinite() ||
588 at_time - last_timeout_ > kTimeoutInterval)) {
589 if (in_timeout_experiment_) {
590 RTC_LOG(LS_WARNING) << "Feedback timed out ("
591 << ToString(time_since_loss_feedback)
592 << "), reducing bitrate.";
593 new_bitrate = new_bitrate * 0.8;
594 // Reset accumulators since we've already acted on missing feedback and
595 // shouldn't to act again on these old lost packets.
596 lost_packets_since_last_loss_update_ = 0;
597 expected_packets_since_last_loss_update_ = 0;
598 last_timeout_ = at_time;
599 }
600 }
601 return new_bitrate;
602}
603
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200604void SendSideBandwidthEstimation::CapBitrateToThresholds(Timestamp at_time,
605 DataRate bitrate) {
606 if (bwe_incoming_ > DataRate::Zero() && bitrate > bwe_incoming_) {
607 bitrate = bwe_incoming_;
andresp@webrtc.org4e69f782014-03-17 17:07:48 +0000608 }
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200609 if (delay_based_bitrate_ > DataRate::Zero() &&
610 bitrate > delay_based_bitrate_) {
611 bitrate = delay_based_bitrate_;
stefan32f81542016-01-20 07:13:58 -0800612 }
Christoffer Rodbro3a837482018-11-19 15:30:23 +0100613 if (loss_based_bandwidth_estimation_.Enabled() &&
614 loss_based_bandwidth_estimation_.GetEstimate() > DataRate::Zero()) {
615 bitrate = std::min(bitrate, loss_based_bandwidth_estimation_.GetEstimate());
616 }
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200617 if (bitrate > max_bitrate_configured_) {
618 bitrate = max_bitrate_configured_;
andresp@webrtc.org4e69f782014-03-17 17:07:48 +0000619 }
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200620 if (bitrate < min_bitrate_configured_) {
621 if (last_low_bitrate_log_.IsInfinite() ||
622 at_time - last_low_bitrate_log_ > kLowBitrateLogPeriod) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100623 RTC_LOG(LS_WARNING) << "Estimated available bandwidth "
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200624 << ToString(bitrate)
625 << " is below configured min bitrate "
626 << ToString(min_bitrate_configured_) << ".";
627 last_low_bitrate_log_ = at_time;
stefanb6b0b922015-09-04 03:04:56 -0700628 }
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200629 bitrate = min_bitrate_configured_;
andresp@webrtc.org4e69f782014-03-17 17:07:48 +0000630 }
philipel1b965312017-04-18 06:55:32 -0700631
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200632 if (bitrate != current_bitrate_ ||
philipel1b965312017-04-18 06:55:32 -0700633 last_fraction_loss_ != last_logged_fraction_loss_ ||
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200634 at_time - last_rtc_event_log_ > kRtcEventLogPeriod) {
Karl Wiberg918f50c2018-07-05 11:40:33 +0200635 event_log_->Log(absl::make_unique<RtcEventBweUpdateLossBased>(
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200636 bitrate.bps(), last_fraction_loss_,
Elad Alon4a87e1c2017-10-03 16:11:34 +0200637 expected_packets_since_last_loss_update_));
philipel1b965312017-04-18 06:55:32 -0700638 last_logged_fraction_loss_ = last_fraction_loss_;
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200639 last_rtc_event_log_ = at_time;
philipel1b965312017-04-18 06:55:32 -0700640 }
Sebastian Jansson7c1744d2018-10-08 11:00:50 +0200641 current_bitrate_ = bitrate;
Sebastian Jansson57f3ad02018-11-23 14:49:18 +0100642
643 if (acknowledged_rate_) {
644 link_capacity_.OnRateUpdate(std::min(current_bitrate_, *acknowledged_rate_),
645 at_time);
646 }
andresp@webrtc.org4e69f782014-03-17 17:07:48 +0000647}
pwestin@webrtc.org1cd11622012-04-19 12:13:52 +0000648} // namespace webrtc