blob: 660981c30e399edeb069a151640c6d35788edbf9 [file] [log] [blame]
stefan@webrtc.org792f1a12015-03-04 12:24:26 +00001/*
2 * Copyright (c) 2015 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 */
11
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020012#include "call/bitrate_allocator.h"
stefan@webrtc.org792f1a12015-03-04 12:24:26 +000013
14#include <algorithm>
Seth Hampsonfe73d6a2017-11-14 10:49:06 -080015#include <cmath>
Alex Narest78609d52017-10-20 10:37:47 +020016#include <memory>
stefan@webrtc.org792f1a12015-03-04 12:24:26 +000017#include <utility>
18
Sebastian Jansson6736df12018-11-21 19:18:39 +010019#include "api/units/data_rate.h"
20#include "api/units/time_delta.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020021#include "modules/bitrate_controller/include/bitrate_controller.h"
22#include "rtc_base/checks.h"
23#include "rtc_base/logging.h"
24#include "system_wrappers/include/clock.h"
Ying Wanga646d302018-03-02 17:04:11 +010025#include "system_wrappers/include/field_trial.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020026#include "system_wrappers/include/metrics.h"
stefan@webrtc.org792f1a12015-03-04 12:24:26 +000027
28namespace webrtc {
29
Stefan Holmere5904162015-03-26 11:11:06 +010030// Allow packets to be transmitted in up to 2 times max video bitrate if the
31// bandwidth estimate allows it.
Ying Wanga646d302018-03-02 17:04:11 +010032const uint8_t kTransmissionMaxBitrateMultiplier = 2;
Stefan Holmere5904162015-03-26 11:11:06 +010033const int kDefaultBitrateBps = 300000;
34
mflodman101f2502016-06-09 17:21:19 +020035// Require a bitrate increase of max(10%, 20kbps) to resume paused streams.
36const double kToggleFactor = 0.1;
37const uint32_t kMinToggleBitrateBps = 20000;
38
mflodman48a4beb2016-07-01 13:03:59 +020039const int64_t kBweLogIntervalMs = 5000;
40
41namespace {
42
43double MediaRatio(uint32_t allocated_bitrate, uint32_t protection_bitrate) {
kwibergaf476c72016-11-28 15:21:39 -080044 RTC_DCHECK_GT(allocated_bitrate, 0);
mflodman48a4beb2016-07-01 13:03:59 +020045 if (protection_bitrate == 0)
46 return 1.0;
47
48 uint32_t media_bitrate = allocated_bitrate - protection_bitrate;
49 return media_bitrate / static_cast<double>(allocated_bitrate);
50}
51} // namespace
52
perkj71ee44c2016-06-15 00:47:53 -070053BitrateAllocator::BitrateAllocator(LimitObserver* limit_observer)
54 : limit_observer_(limit_observer),
Sebastian Jansson89c94b92018-11-20 17:16:36 +010055 last_target_bps_(0),
56 last_link_capacity_bps_(0),
perkjfea93092016-05-14 00:58:48 -070057 last_non_zero_bitrate_bps_(kDefaultBitrateBps),
Stefan Holmere5904162015-03-26 11:11:06 +010058 last_fraction_loss_(0),
mflodman48a4beb2016-07-01 13:03:59 +020059 last_rtt_(0),
Sebastian Jansson13e59032018-11-21 19:13:07 +010060 last_bwe_period_ms_(1000),
mflodman48a4beb2016-07-01 13:03:59 +020061 num_pause_events_(0),
62 clock_(Clock::GetRealTimeClock()),
philipel5ef2bc12017-02-21 07:28:31 -080063 last_bwe_log_time_(0),
64 total_requested_padding_bitrate_(0),
Alex Narest78609d52017-10-20 10:37:47 +020065 total_requested_min_bitrate_(0),
Sebastian Jansson448f4d52018-04-04 14:52:07 +020066 total_requested_max_bitrate_(0),
Sebastian Jansson35fa2802018-10-01 09:16:12 +020067 allocated_without_feedback_(0),
Sebastian Jansson29b204e2018-03-21 12:45:27 +010068 has_packet_feedback_(false),
Ying Wanga646d302018-03-02 17:04:11 +010069 bitrate_allocation_strategy_(nullptr),
70 transmission_max_bitrate_multiplier_(
71 GetTransmissionMaxBitrateMultiplier()) {
perkj26091b12016-09-01 01:17:40 -070072 sequenced_checker_.Detach();
73}
mflodman48a4beb2016-07-01 13:03:59 +020074
75BitrateAllocator::~BitrateAllocator() {
asapersson1d02d3e2016-09-09 22:40:25 -070076 RTC_HISTOGRAM_COUNTS_100("WebRTC.Call.NumberOfPauseEvents",
77 num_pause_events_);
mflodman48a4beb2016-07-01 13:03:59 +020078}
stefan@webrtc.org792f1a12015-03-04 12:24:26 +000079
Niels Möller74e5f802018-04-25 14:03:46 +020080// static
Ying Wanga646d302018-03-02 17:04:11 +010081uint8_t BitrateAllocator::GetTransmissionMaxBitrateMultiplier() {
82 uint64_t multiplier = strtoul(webrtc::field_trial::FindFullName(
83 "WebRTC-TransmissionMaxBitrateMultiplier")
84 .c_str(),
85 nullptr, 10);
86 if (multiplier > 0 && multiplier <= kTransmissionMaxBitrateMultiplier) {
Ying Wang012b7e72018-03-05 15:44:23 +010087 RTC_LOG(LS_INFO) << "TransmissionMaxBitrateMultiplier is set to "
88 << multiplier;
Ying Wanga646d302018-03-02 17:04:11 +010089 return static_cast<uint8_t>(multiplier);
90 }
91 return kTransmissionMaxBitrateMultiplier;
92}
93
perkj71ee44c2016-06-15 00:47:53 -070094void BitrateAllocator::OnNetworkChanged(uint32_t target_bitrate_bps,
Sebastian Jansson89c94b92018-11-20 17:16:36 +010095 uint32_t link_capacity_bps,
perkj71ee44c2016-06-15 00:47:53 -070096 uint8_t fraction_loss,
minyue78b4d562016-11-30 04:47:39 -080097 int64_t rtt,
minyue93e45222017-05-18 14:32:41 -070098 int64_t bwe_period_ms) {
perkj26091b12016-09-01 01:17:40 -070099 RTC_DCHECK_CALLED_SEQUENTIALLY(&sequenced_checker_);
Sebastian Jansson89c94b92018-11-20 17:16:36 +0100100 last_target_bps_ = target_bitrate_bps;
101 last_link_capacity_bps_ = link_capacity_bps;
perkjfea93092016-05-14 00:58:48 -0700102 last_non_zero_bitrate_bps_ =
mflodman101f2502016-06-09 17:21:19 +0200103 target_bitrate_bps > 0 ? target_bitrate_bps : last_non_zero_bitrate_bps_;
Stefan Holmere5904162015-03-26 11:11:06 +0100104 last_fraction_loss_ = fraction_loss;
105 last_rtt_ = rtt;
minyue93e45222017-05-18 14:32:41 -0700106 last_bwe_period_ms_ = bwe_period_ms;
mflodman2ebe5b12016-05-13 01:43:51 -0700107
mflodman48a4beb2016-07-01 13:03:59 +0200108 // Periodically log the incoming BWE.
109 int64_t now = clock_->TimeInMilliseconds();
110 if (now > last_bwe_log_time_ + kBweLogIntervalMs) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100111 RTC_LOG(LS_INFO) << "Current BWE " << target_bitrate_bps;
mflodman48a4beb2016-07-01 13:03:59 +0200112 last_bwe_log_time_ = now;
sprang2f48d942015-11-05 04:25:49 -0800113 }
mflodman48a4beb2016-07-01 13:03:59 +0200114
115 ObserverAllocation allocation = AllocateBitrates(target_bitrate_bps);
Sebastian Jansson89c94b92018-11-20 17:16:36 +0100116 ObserverAllocation bandwidth_allocation = AllocateBitrates(link_capacity_bps);
mflodman48a4beb2016-07-01 13:03:59 +0200117
118 for (auto& config : bitrate_observer_configs_) {
119 uint32_t allocated_bitrate = allocation[config.observer];
Sebastian Jansson89c94b92018-11-20 17:16:36 +0100120 uint32_t allocated_bandwidth = bandwidth_allocation[config.observer];
Sebastian Jansson13e59032018-11-21 19:13:07 +0100121 BitrateAllocationUpdate update;
122 update.target_bitrate = DataRate::bps(allocated_bitrate);
123 update.link_capacity = DataRate::bps(allocated_bandwidth);
124 update.packet_loss_ratio = last_fraction_loss_ / 256.0;
125 update.round_trip_time = TimeDelta::ms(last_rtt_);
126 update.bwe_period = TimeDelta::ms(last_bwe_period_ms_);
127 uint32_t protection_bitrate = config.observer->OnBitrateUpdated(update);
mflodman48a4beb2016-07-01 13:03:59 +0200128
129 if (allocated_bitrate == 0 && config.allocated_bitrate_bps > 0) {
130 if (target_bitrate_bps > 0)
131 ++num_pause_events_;
132 // The protection bitrate is an estimate based on the ratio between media
133 // and protection used before this observer was muted.
134 uint32_t predicted_protection_bps =
135 (1.0 - config.media_ratio) * config.min_bitrate_bps;
Mirko Bonadei675513b2017-11-09 11:09:25 +0100136 RTC_LOG(LS_INFO) << "Pausing observer " << config.observer
137 << " with configured min bitrate "
138 << config.min_bitrate_bps << " and current estimate of "
139 << target_bitrate_bps << " and protection bitrate "
140 << predicted_protection_bps;
mflodman48a4beb2016-07-01 13:03:59 +0200141 } else if (allocated_bitrate > 0 && config.allocated_bitrate_bps == 0) {
142 if (target_bitrate_bps > 0)
143 ++num_pause_events_;
Mirko Bonadei675513b2017-11-09 11:09:25 +0100144 RTC_LOG(LS_INFO) << "Resuming observer " << config.observer
145 << ", configured min bitrate " << config.min_bitrate_bps
146 << ", current allocation " << allocated_bitrate
147 << " and protection bitrate " << protection_bitrate;
mflodman48a4beb2016-07-01 13:03:59 +0200148 }
149
150 // Only update the media ratio if the observer got an allocation.
151 if (allocated_bitrate > 0)
152 config.media_ratio = MediaRatio(allocated_bitrate, protection_bitrate);
153 config.allocated_bitrate_bps = allocated_bitrate;
154 }
philipel5ef2bc12017-02-21 07:28:31 -0800155 UpdateAllocationLimits();
Stefan Holmere5904162015-03-26 11:11:06 +0100156}
157
perkj57c21f92016-06-17 07:27:16 -0700158void BitrateAllocator::AddObserver(BitrateAllocatorObserver* observer,
Sebastian Jansson24ad7202018-04-19 08:25:12 +0200159 MediaStreamAllocationConfig config) {
perkj26091b12016-09-01 01:17:40 -0700160 RTC_DCHECK_CALLED_SEQUENTIALLY(&sequenced_checker_);
Sebastian Jansson24ad7202018-04-19 08:25:12 +0200161 RTC_DCHECK_GT(config.bitrate_priority, 0);
162 RTC_DCHECK(std::isnormal(config.bitrate_priority));
mflodman2ebe5b12016-05-13 01:43:51 -0700163 auto it = FindObserverConfig(observer);
stefan@webrtc.org792f1a12015-03-04 12:24:26 +0000164
mflodman101f2502016-06-09 17:21:19 +0200165 // Update settings if the observer already exists, create a new one otherwise.
mflodman2ebe5b12016-05-13 01:43:51 -0700166 if (it != bitrate_observer_configs_.end()) {
Sebastian Jansson24ad7202018-04-19 08:25:12 +0200167 it->min_bitrate_bps = config.min_bitrate_bps;
168 it->max_bitrate_bps = config.max_bitrate_bps;
169 it->pad_up_bitrate_bps = config.pad_up_bitrate_bps;
170 it->enforce_min_bitrate = config.enforce_min_bitrate;
171 it->bitrate_priority = config.bitrate_priority;
stefan@webrtc.org792f1a12015-03-04 12:24:26 +0000172 } else {
Seth Hampsonfe73d6a2017-11-14 10:49:06 -0800173 bitrate_observer_configs_.push_back(ObserverConfig(
Sebastian Jansson24ad7202018-04-19 08:25:12 +0200174 observer, config.min_bitrate_bps, config.max_bitrate_bps,
175 config.pad_up_bitrate_bps, config.enforce_min_bitrate, config.track_id,
176 config.bitrate_priority, config.has_packet_feedback));
stefan@webrtc.org792f1a12015-03-04 12:24:26 +0000177 }
Stefan Holmere5904162015-03-26 11:11:06 +0100178
Sebastian Jansson89c94b92018-11-20 17:16:36 +0100179 if (last_target_bps_ > 0) {
mflodman101f2502016-06-09 17:21:19 +0200180 // Calculate a new allocation and update all observers.
Sebastian Jansson89c94b92018-11-20 17:16:36 +0100181
182 ObserverAllocation allocation = AllocateBitrates(last_target_bps_);
183 ObserverAllocation bandwidth_allocation =
184 AllocateBitrates(last_link_capacity_bps_);
mflodman48a4beb2016-07-01 13:03:59 +0200185 for (auto& config : bitrate_observer_configs_) {
186 uint32_t allocated_bitrate = allocation[config.observer];
Sebastian Jansson89c94b92018-11-20 17:16:36 +0100187 uint32_t bandwidth = bandwidth_allocation[config.observer];
Sebastian Jansson13e59032018-11-21 19:13:07 +0100188 BitrateAllocationUpdate update;
189 update.target_bitrate = DataRate::bps(allocated_bitrate);
190 update.link_capacity = DataRate::bps(bandwidth);
191 update.packet_loss_ratio = last_fraction_loss_ / 256.0;
192 update.round_trip_time = TimeDelta::ms(last_rtt_);
193 update.bwe_period = TimeDelta::ms(last_bwe_period_ms_);
194 uint32_t protection_bitrate = config.observer->OnBitrateUpdated(update);
mflodman48a4beb2016-07-01 13:03:59 +0200195 config.allocated_bitrate_bps = allocated_bitrate;
196 if (allocated_bitrate > 0)
197 config.media_ratio = MediaRatio(allocated_bitrate, protection_bitrate);
198 }
perkjfea93092016-05-14 00:58:48 -0700199 } else {
200 // Currently, an encoder is not allowed to produce frames.
201 // But we still have to return the initial config bitrate + let the
202 // observer know that it can not produce frames.
Sebastian Jansson13e59032018-11-21 19:13:07 +0100203
204 BitrateAllocationUpdate update;
205 update.target_bitrate = DataRate::Zero();
206 update.link_capacity = DataRate::Zero();
207 update.packet_loss_ratio = last_fraction_loss_ / 256.0;
208 update.round_trip_time = TimeDelta::ms(last_rtt_);
209 update.bwe_period = TimeDelta::ms(last_bwe_period_ms_);
210 observer->OnBitrateUpdated(update);
Stefan Holmere5904162015-03-26 11:11:06 +0100211 }
perkj71ee44c2016-06-15 00:47:53 -0700212 UpdateAllocationLimits();
stefan@webrtc.org792f1a12015-03-04 12:24:26 +0000213}
214
perkj71ee44c2016-06-15 00:47:53 -0700215void BitrateAllocator::UpdateAllocationLimits() {
216 uint32_t total_requested_padding_bitrate = 0;
217 uint32_t total_requested_min_bitrate = 0;
Sebastian Jansson448f4d52018-04-04 14:52:07 +0200218 uint32_t total_requested_max_bitrate = 0;
Sebastian Jansson29b204e2018-03-21 12:45:27 +0100219 bool has_packet_feedback = false;
Sebastian Jansson35fa2802018-10-01 09:16:12 +0200220 uint32_t allocated_without_feedback = 0;
perkj26091b12016-09-01 01:17:40 -0700221 for (const auto& config : bitrate_observer_configs_) {
philipel5ef2bc12017-02-21 07:28:31 -0800222 uint32_t stream_padding = config.pad_up_bitrate_bps;
perkj26091b12016-09-01 01:17:40 -0700223 if (config.enforce_min_bitrate) {
224 total_requested_min_bitrate += config.min_bitrate_bps;
philipel5ef2bc12017-02-21 07:28:31 -0800225 } else if (config.allocated_bitrate_bps == 0) {
226 stream_padding =
srte1eb051c2017-11-29 11:23:59 +0100227 std::max(config.MinBitrateWithHysteresis(), stream_padding);
perkj71ee44c2016-06-15 00:47:53 -0700228 }
philipel5ef2bc12017-02-21 07:28:31 -0800229 total_requested_padding_bitrate += stream_padding;
Sebastian Jansson448f4d52018-04-04 14:52:07 +0200230 total_requested_max_bitrate += config.max_bitrate_bps;
Sebastian Jansson29b204e2018-03-21 12:45:27 +0100231 if (config.allocated_bitrate_bps > 0 && config.has_packet_feedback)
232 has_packet_feedback = true;
Sebastian Jansson35fa2802018-10-01 09:16:12 +0200233 // TODO(srte): Remove field trial check.
234 if (!config.has_packet_feedback &&
235 field_trial::IsEnabled("WebRTC-Audio-ABWENoTWCC"))
236 allocated_without_feedback += config.allocated_bitrate_bps;
stefan@webrtc.org792f1a12015-03-04 12:24:26 +0000237 }
perkj71ee44c2016-06-15 00:47:53 -0700238
philipel5ef2bc12017-02-21 07:28:31 -0800239 if (total_requested_padding_bitrate == total_requested_padding_bitrate_ &&
Sebastian Jansson29b204e2018-03-21 12:45:27 +0100240 total_requested_min_bitrate == total_requested_min_bitrate_ &&
Sebastian Jansson448f4d52018-04-04 14:52:07 +0200241 total_requested_max_bitrate == total_requested_max_bitrate_ &&
Sebastian Jansson35fa2802018-10-01 09:16:12 +0200242 allocated_without_feedback == allocated_without_feedback_ &&
Sebastian Jansson29b204e2018-03-21 12:45:27 +0100243 has_packet_feedback == has_packet_feedback_) {
philipel5ef2bc12017-02-21 07:28:31 -0800244 return;
245 }
246
247 total_requested_min_bitrate_ = total_requested_min_bitrate;
248 total_requested_padding_bitrate_ = total_requested_padding_bitrate;
Sebastian Jansson448f4d52018-04-04 14:52:07 +0200249 total_requested_max_bitrate_ = total_requested_max_bitrate;
Sebastian Jansson35fa2802018-10-01 09:16:12 +0200250 allocated_without_feedback_ = allocated_without_feedback;
Sebastian Jansson29b204e2018-03-21 12:45:27 +0100251 has_packet_feedback_ = has_packet_feedback;
philipel5ef2bc12017-02-21 07:28:31 -0800252
Mirko Bonadei675513b2017-11-09 11:09:25 +0100253 RTC_LOG(LS_INFO) << "UpdateAllocationLimits : total_requested_min_bitrate: "
254 << total_requested_min_bitrate
255 << "bps, total_requested_padding_bitrate: "
Sebastian Jansson448f4d52018-04-04 14:52:07 +0200256 << total_requested_padding_bitrate
257 << "bps, total_requested_max_bitrate: "
258 << total_requested_max_bitrate << "bps";
Sebastian Jansson29b204e2018-03-21 12:45:27 +0100259 limit_observer_->OnAllocationLimitsChanged(
260 total_requested_min_bitrate, total_requested_padding_bitrate,
Sebastian Jansson35fa2802018-10-01 09:16:12 +0200261 total_requested_max_bitrate, allocated_without_feedback,
262 has_packet_feedback);
perkj71ee44c2016-06-15 00:47:53 -0700263}
264
265void BitrateAllocator::RemoveObserver(BitrateAllocatorObserver* observer) {
perkj26091b12016-09-01 01:17:40 -0700266 RTC_DCHECK_CALLED_SEQUENTIALLY(&sequenced_checker_);
Alex Narest78609d52017-10-20 10:37:47 +0200267
perkj26091b12016-09-01 01:17:40 -0700268 auto it = FindObserverConfig(observer);
269 if (it != bitrate_observer_configs_.end()) {
270 bitrate_observer_configs_.erase(it);
perkj71ee44c2016-06-15 00:47:53 -0700271 }
perkj26091b12016-09-01 01:17:40 -0700272
perkj71ee44c2016-06-15 00:47:53 -0700273 UpdateAllocationLimits();
stefan@webrtc.org792f1a12015-03-04 12:24:26 +0000274}
275
Sebastian Jansson44a262a2018-10-24 16:07:20 +0200276int BitrateAllocator::GetStartBitrate(
277 BitrateAllocatorObserver* observer) const {
perkj26091b12016-09-01 01:17:40 -0700278 RTC_DCHECK_CALLED_SEQUENTIALLY(&sequenced_checker_);
mflodman48a4beb2016-07-01 13:03:59 +0200279 const auto& it = FindObserverConfig(observer);
280 if (it == bitrate_observer_configs_.end()) {
281 // This observer hasn't been added yet, just give it its fair share.
282 return last_non_zero_bitrate_bps_ /
perkj26091b12016-09-01 01:17:40 -0700283 static_cast<int>((bitrate_observer_configs_.size() + 1));
mflodman48a4beb2016-07-01 13:03:59 +0200284 } else if (it->allocated_bitrate_bps == -1) {
285 // This observer hasn't received an allocation yet, so do the same.
286 return last_non_zero_bitrate_bps_ /
perkj26091b12016-09-01 01:17:40 -0700287 static_cast<int>(bitrate_observer_configs_.size());
mflodman48a4beb2016-07-01 13:03:59 +0200288 } else {
289 // This observer already has an allocation.
290 return it->allocated_bitrate_bps;
291 }
perkj57c21f92016-06-17 07:27:16 -0700292}
293
Alex Narest78609d52017-10-20 10:37:47 +0200294void BitrateAllocator::SetBitrateAllocationStrategy(
295 std::unique_ptr<rtc::BitrateAllocationStrategy>
296 bitrate_allocation_strategy) {
297 RTC_DCHECK_CALLED_SEQUENTIALLY(&sequenced_checker_);
298 bitrate_allocation_strategy_ = std::move(bitrate_allocation_strategy);
299}
300
Sebastian Jansson44a262a2018-10-24 16:07:20 +0200301BitrateAllocator::ObserverConfigs::const_iterator
302BitrateAllocator::FindObserverConfig(
303 const BitrateAllocatorObserver* observer) const {
304 for (auto it = bitrate_observer_configs_.begin();
305 it != bitrate_observer_configs_.end(); ++it) {
306 if (it->observer == observer)
307 return it;
308 }
309 return bitrate_observer_configs_.end();
310}
311
mflodman48a4beb2016-07-01 13:03:59 +0200312BitrateAllocator::ObserverConfigs::iterator
perkj26091b12016-09-01 01:17:40 -0700313BitrateAllocator::FindObserverConfig(const BitrateAllocatorObserver* observer) {
mflodman2ebe5b12016-05-13 01:43:51 -0700314 for (auto it = bitrate_observer_configs_.begin();
315 it != bitrate_observer_configs_.end(); ++it) {
316 if (it->observer == observer)
317 return it;
318 }
319 return bitrate_observer_configs_.end();
320}
321
perkjfea93092016-05-14 00:58:48 -0700322BitrateAllocator::ObserverAllocation BitrateAllocator::AllocateBitrates(
Sebastian Jansson44a262a2018-10-24 16:07:20 +0200323 uint32_t bitrate) const {
mflodman2ebe5b12016-05-13 01:43:51 -0700324 if (bitrate_observer_configs_.empty())
325 return ObserverAllocation();
326
Alex Narest78609d52017-10-20 10:37:47 +0200327 if (bitrate_allocation_strategy_ != nullptr) {
Sebastian Janssone2754c92018-10-24 16:02:26 +0200328 // Note: This intentionally causes slicing, we only copy the fields in
329 // ObserverConfig that are inherited from TrackConfig.
330 std::vector<rtc::BitrateAllocationStrategy::TrackConfig> track_configs(
331 bitrate_observer_configs_.begin(), bitrate_observer_configs_.end());
332
Alex Narest78609d52017-10-20 10:37:47 +0200333 std::vector<uint32_t> track_allocations =
Sebastian Janssone2754c92018-10-24 16:02:26 +0200334 bitrate_allocation_strategy_->AllocateBitrates(
335 bitrate, std::move(track_configs));
Alex Narest78609d52017-10-20 10:37:47 +0200336 // The strategy should return allocation for all tracks.
337 RTC_CHECK(track_allocations.size() == bitrate_observer_configs_.size());
338 ObserverAllocation allocation;
339 auto track_allocations_it = track_allocations.begin();
340 for (const auto& observer_config : bitrate_observer_configs_) {
341 allocation[observer_config.observer] = *track_allocations_it++;
342 }
343 return allocation;
344 }
345
perkjfea93092016-05-14 00:58:48 -0700346 if (bitrate == 0)
mflodman2ebe5b12016-05-13 01:43:51 -0700347 return ZeroRateAllocation();
348
349 uint32_t sum_min_bitrates = 0;
mflodman101f2502016-06-09 17:21:19 +0200350 uint32_t sum_max_bitrates = 0;
351 for (const auto& observer_config : bitrate_observer_configs_) {
mflodman2ebe5b12016-05-13 01:43:51 -0700352 sum_min_bitrates += observer_config.min_bitrate_bps;
mflodman101f2502016-06-09 17:21:19 +0200353 sum_max_bitrates += observer_config.max_bitrate_bps;
354 }
355
356 // Not enough for all observers to get an allocation, allocate according to:
357 // enforced min bitrate -> allocated bitrate previous round -> restart paused
358 // streams.
359 if (!EnoughBitrateForAllObservers(bitrate, sum_min_bitrates))
perkjfea93092016-05-14 00:58:48 -0700360 return LowRateAllocation(bitrate);
mflodman2ebe5b12016-05-13 01:43:51 -0700361
Seth Hampsonfe73d6a2017-11-14 10:49:06 -0800362 // All observers will get their min bitrate plus a share of the rest. This
363 // share is allocated to each observer based on its bitrate_priority.
mflodman101f2502016-06-09 17:21:19 +0200364 if (bitrate <= sum_max_bitrates)
365 return NormalRateAllocation(bitrate, sum_min_bitrates);
mflodman2ebe5b12016-05-13 01:43:51 -0700366
Ying Wanga646d302018-03-02 17:04:11 +0100367 // All observers will get up to transmission_max_bitrate_multiplier_ x max.
mflodman101f2502016-06-09 17:21:19 +0200368 return MaxRateAllocation(bitrate, sum_max_bitrates);
stefan@webrtc.org792f1a12015-03-04 12:24:26 +0000369}
370
Sebastian Jansson44a262a2018-10-24 16:07:20 +0200371BitrateAllocator::ObserverAllocation BitrateAllocator::ZeroRateAllocation()
372 const {
mflodman2ebe5b12016-05-13 01:43:51 -0700373 ObserverAllocation allocation;
mflodman2ebe5b12016-05-13 01:43:51 -0700374 for (const auto& observer_config : bitrate_observer_configs_)
375 allocation[observer_config.observer] = 0;
perkjec81bcd2016-05-11 06:01:13 -0700376 return allocation;
377}
378
mflodman2ebe5b12016-05-13 01:43:51 -0700379BitrateAllocator::ObserverAllocation BitrateAllocator::LowRateAllocation(
Sebastian Jansson44a262a2018-10-24 16:07:20 +0200380 uint32_t bitrate) const {
mflodman2ebe5b12016-05-13 01:43:51 -0700381 ObserverAllocation allocation;
mflodman101f2502016-06-09 17:21:19 +0200382 // Start by allocating bitrate to observers enforcing a min bitrate, hence
383 // remaining_bitrate might turn negative.
384 int64_t remaining_bitrate = bitrate;
385 for (const auto& observer_config : bitrate_observer_configs_) {
386 int32_t allocated_bitrate = 0;
387 if (observer_config.enforce_min_bitrate)
388 allocated_bitrate = observer_config.min_bitrate_bps;
389
390 allocation[observer_config.observer] = allocated_bitrate;
391 remaining_bitrate -= allocated_bitrate;
392 }
393
394 // Allocate bitrate to all previously active streams.
395 if (remaining_bitrate > 0) {
mflodman2ebe5b12016-05-13 01:43:51 -0700396 for (const auto& observer_config : bitrate_observer_configs_) {
mflodman101f2502016-06-09 17:21:19 +0200397 if (observer_config.enforce_min_bitrate ||
srte1eb051c2017-11-29 11:23:59 +0100398 observer_config.LastAllocatedBitrate() == 0)
mflodman101f2502016-06-09 17:21:19 +0200399 continue;
400
srte1eb051c2017-11-29 11:23:59 +0100401 uint32_t required_bitrate = observer_config.MinBitrateWithHysteresis();
mflodman48a4beb2016-07-01 13:03:59 +0200402 if (remaining_bitrate >= required_bitrate) {
403 allocation[observer_config.observer] = required_bitrate;
404 remaining_bitrate -= required_bitrate;
mflodman101f2502016-06-09 17:21:19 +0200405 }
stefan@webrtc.org792f1a12015-03-04 12:24:26 +0000406 }
407 }
mflodman101f2502016-06-09 17:21:19 +0200408
409 // Allocate bitrate to previously paused streams.
410 if (remaining_bitrate > 0) {
411 for (const auto& observer_config : bitrate_observer_configs_) {
srte1eb051c2017-11-29 11:23:59 +0100412 if (observer_config.LastAllocatedBitrate() != 0)
mflodman101f2502016-06-09 17:21:19 +0200413 continue;
414
415 // Add a hysteresis to avoid toggling.
srte1eb051c2017-11-29 11:23:59 +0100416 uint32_t required_bitrate = observer_config.MinBitrateWithHysteresis();
mflodman101f2502016-06-09 17:21:19 +0200417 if (remaining_bitrate >= required_bitrate) {
418 allocation[observer_config.observer] = required_bitrate;
419 remaining_bitrate -= required_bitrate;
420 }
421 }
422 }
423
424 // Split a possible remainder evenly on all streams with an allocation.
425 if (remaining_bitrate > 0)
426 DistributeBitrateEvenly(remaining_bitrate, false, 1, &allocation);
427
428 RTC_DCHECK_EQ(allocation.size(), bitrate_observer_configs_.size());
Stefan Holmere5904162015-03-26 11:11:06 +0100429 return allocation;
stefan@webrtc.org792f1a12015-03-04 12:24:26 +0000430}
mflodman101f2502016-06-09 17:21:19 +0200431
Seth Hampsonfe73d6a2017-11-14 10:49:06 -0800432// Allocates the bitrate based on the bitrate priority of each observer. This
433// bitrate priority defines the priority for bitrate to be allocated to that
434// observer in relation to other observers. For example with two observers, if
435// observer 1 had a bitrate_priority = 1.0, and observer 2 has a
436// bitrate_priority = 2.0, the expected behavior is that observer 2 will be
437// allocated twice the bitrate as observer 1 above the each observer's
438// min_bitrate_bps values, until one of the observers hits its max_bitrate_bps.
mflodman101f2502016-06-09 17:21:19 +0200439BitrateAllocator::ObserverAllocation BitrateAllocator::NormalRateAllocation(
440 uint32_t bitrate,
Sebastian Jansson44a262a2018-10-24 16:07:20 +0200441 uint32_t sum_min_bitrates) const {
mflodman101f2502016-06-09 17:21:19 +0200442 ObserverAllocation allocation;
Seth Hampsonfe73d6a2017-11-14 10:49:06 -0800443 ObserverAllocation observers_capacities;
444 for (const auto& observer_config : bitrate_observer_configs_) {
mflodman101f2502016-06-09 17:21:19 +0200445 allocation[observer_config.observer] = observer_config.min_bitrate_bps;
Seth Hampsonfe73d6a2017-11-14 10:49:06 -0800446 observers_capacities[observer_config.observer] =
447 observer_config.max_bitrate_bps - observer_config.min_bitrate_bps;
448 }
mflodman101f2502016-06-09 17:21:19 +0200449
450 bitrate -= sum_min_bitrates;
Seth Hampsonfe73d6a2017-11-14 10:49:06 -0800451 // From the remaining bitrate, allocate a proportional amount to each observer
452 // above the min bitrate already allocated.
mflodman101f2502016-06-09 17:21:19 +0200453 if (bitrate > 0)
Seth Hampsonfe73d6a2017-11-14 10:49:06 -0800454 DistributeBitrateRelatively(bitrate, observers_capacities, &allocation);
mflodman101f2502016-06-09 17:21:19 +0200455
456 return allocation;
457}
458
459BitrateAllocator::ObserverAllocation BitrateAllocator::MaxRateAllocation(
perkj26091b12016-09-01 01:17:40 -0700460 uint32_t bitrate,
Sebastian Jansson44a262a2018-10-24 16:07:20 +0200461 uint32_t sum_max_bitrates) const {
mflodman101f2502016-06-09 17:21:19 +0200462 ObserverAllocation allocation;
463
464 for (const auto& observer_config : bitrate_observer_configs_) {
465 allocation[observer_config.observer] = observer_config.max_bitrate_bps;
466 bitrate -= observer_config.max_bitrate_bps;
467 }
Ying Wanga646d302018-03-02 17:04:11 +0100468 DistributeBitrateEvenly(bitrate, true, transmission_max_bitrate_multiplier_,
mflodman101f2502016-06-09 17:21:19 +0200469 &allocation);
470 return allocation;
471}
472
srte1eb051c2017-11-29 11:23:59 +0100473uint32_t BitrateAllocator::ObserverConfig::LastAllocatedBitrate() const {
mflodman101f2502016-06-09 17:21:19 +0200474 // Return the configured minimum bitrate for newly added observers, to avoid
475 // requiring an extra high bitrate for the observer to get an allocated
476 // bitrate.
srte1eb051c2017-11-29 11:23:59 +0100477 return allocated_bitrate_bps == -1 ? min_bitrate_bps : allocated_bitrate_bps;
mflodman101f2502016-06-09 17:21:19 +0200478}
479
srte1eb051c2017-11-29 11:23:59 +0100480uint32_t BitrateAllocator::ObserverConfig::MinBitrateWithHysteresis() const {
481 uint32_t min_bitrate = min_bitrate_bps;
482 if (LastAllocatedBitrate() == 0) {
mflodman101f2502016-06-09 17:21:19 +0200483 min_bitrate += std::max(static_cast<uint32_t>(kToggleFactor * min_bitrate),
484 kMinToggleBitrateBps);
485 }
mflodman48a4beb2016-07-01 13:03:59 +0200486 // Account for protection bitrate used by this observer in the previous
487 // allocation.
488 // Note: the ratio will only be updated when the stream is active, meaning a
489 // paused stream won't get any ratio updates. This might lead to waiting a bit
490 // longer than necessary if the network condition improves, but this is to
491 // avoid too much toggling.
srte1eb051c2017-11-29 11:23:59 +0100492 if (media_ratio > 0.0 && media_ratio < 1.0)
493 min_bitrate += min_bitrate * (1.0 - media_ratio);
mflodman48a4beb2016-07-01 13:03:59 +0200494
mflodman101f2502016-06-09 17:21:19 +0200495 return min_bitrate;
496}
497
Sebastian Jansson44a262a2018-10-24 16:07:20 +0200498void BitrateAllocator::DistributeBitrateEvenly(
499 uint32_t bitrate,
500 bool include_zero_allocations,
501 int max_multiplier,
502 ObserverAllocation* allocation) const {
mflodman101f2502016-06-09 17:21:19 +0200503 RTC_DCHECK_EQ(allocation->size(), bitrate_observer_configs_.size());
504
505 ObserverSortingMap list_max_bitrates;
506 for (const auto& observer_config : bitrate_observer_configs_) {
507 if (include_zero_allocations ||
508 allocation->at(observer_config.observer) != 0) {
509 list_max_bitrates.insert(std::pair<uint32_t, const ObserverConfig*>(
510 observer_config.max_bitrate_bps, &observer_config));
511 }
512 }
513 auto it = list_max_bitrates.begin();
514 while (it != list_max_bitrates.end()) {
kwibergaf476c72016-11-28 15:21:39 -0800515 RTC_DCHECK_GT(bitrate, 0);
mflodman101f2502016-06-09 17:21:19 +0200516 uint32_t extra_allocation =
517 bitrate / static_cast<uint32_t>(list_max_bitrates.size());
518 uint32_t total_allocation =
519 extra_allocation + allocation->at(it->second->observer);
520 bitrate -= extra_allocation;
521 if (total_allocation > max_multiplier * it->first) {
522 // There is more than we can fit for this observer, carry over to the
523 // remaining observers.
524 bitrate += total_allocation - max_multiplier * it->first;
525 total_allocation = max_multiplier * it->first;
526 }
527 // Finally, update the allocation for this observer.
528 allocation->at(it->second->observer) = total_allocation;
529 it = list_max_bitrates.erase(it);
530 }
531}
532
Sebastian Jansson44a262a2018-10-24 16:07:20 +0200533bool BitrateAllocator::EnoughBitrateForAllObservers(
534 uint32_t bitrate,
535 uint32_t sum_min_bitrates) const {
mflodman101f2502016-06-09 17:21:19 +0200536 if (bitrate < sum_min_bitrates)
537 return false;
538
perkj26091b12016-09-01 01:17:40 -0700539 uint32_t extra_bitrate_per_observer =
540 (bitrate - sum_min_bitrates) /
mflodman101f2502016-06-09 17:21:19 +0200541 static_cast<uint32_t>(bitrate_observer_configs_.size());
542 for (const auto& observer_config : bitrate_observer_configs_) {
543 if (observer_config.min_bitrate_bps + extra_bitrate_per_observer <
srte1eb051c2017-11-29 11:23:59 +0100544 observer_config.MinBitrateWithHysteresis()) {
mflodman101f2502016-06-09 17:21:19 +0200545 return false;
philipel5ef2bc12017-02-21 07:28:31 -0800546 }
mflodman101f2502016-06-09 17:21:19 +0200547 }
548 return true;
549}
Seth Hampsonfe73d6a2017-11-14 10:49:06 -0800550
551void BitrateAllocator::DistributeBitrateRelatively(
552 uint32_t remaining_bitrate,
553 const ObserverAllocation& observers_capacities,
Sebastian Jansson44a262a2018-10-24 16:07:20 +0200554 ObserverAllocation* allocation) const {
Seth Hampsonfe73d6a2017-11-14 10:49:06 -0800555 RTC_DCHECK_EQ(allocation->size(), bitrate_observer_configs_.size());
556 RTC_DCHECK_EQ(observers_capacities.size(), bitrate_observer_configs_.size());
557
558 struct PriorityRateObserverConfig {
559 PriorityRateObserverConfig(BitrateAllocatorObserver* allocation_key,
560 uint32_t capacity_bps,
561 double bitrate_priority)
562 : allocation_key(allocation_key),
563 capacity_bps(capacity_bps),
564 bitrate_priority(bitrate_priority) {}
565
566 BitrateAllocatorObserver* allocation_key;
567 // The amount of bitrate bps that can be allocated to this observer.
568 uint32_t capacity_bps;
569 double bitrate_priority;
570
571 // We want to sort by which observers will be allocated their full capacity
572 // first. By dividing each observer's capacity by its bitrate priority we
573 // are "normalizing" the capacity of an observer by the rate it will be
574 // filled. This is because the amount allocated is based upon bitrate
575 // priority. We allocate twice as much bitrate to an observer with twice the
576 // bitrate priority of another.
577 bool operator<(const PriorityRateObserverConfig& other) const {
578 return capacity_bps / bitrate_priority <
579 other.capacity_bps / other.bitrate_priority;
580 }
581 };
582
583 double bitrate_priority_sum = 0;
584 std::vector<PriorityRateObserverConfig> priority_rate_observers;
585 for (const auto& observer_config : bitrate_observer_configs_) {
586 uint32_t capacity_bps = observers_capacities.at(observer_config.observer);
587 priority_rate_observers.emplace_back(observer_config.observer, capacity_bps,
588 observer_config.bitrate_priority);
589 bitrate_priority_sum += observer_config.bitrate_priority;
590 }
591
592 // Iterate in the order observers can be allocated their full capacity.
593 std::sort(priority_rate_observers.begin(), priority_rate_observers.end());
594 size_t i;
595 for (i = 0; i < priority_rate_observers.size(); ++i) {
596 const auto& priority_rate_observer = priority_rate_observers[i];
597 // We allocate the full capacity to an observer only if its relative
598 // portion from the remaining bitrate is sufficient to allocate its full
599 // capacity. This means we aren't greedily allocating the full capacity, but
600 // that it is only done when there is also enough bitrate to allocate the
601 // proportional amounts to all other observers.
602 double observer_share =
603 priority_rate_observer.bitrate_priority / bitrate_priority_sum;
604 double allocation_bps = observer_share * remaining_bitrate;
605 bool enough_bitrate = allocation_bps >= priority_rate_observer.capacity_bps;
606 if (!enough_bitrate)
607 break;
608 allocation->at(priority_rate_observer.allocation_key) +=
609 priority_rate_observer.capacity_bps;
610 remaining_bitrate -= priority_rate_observer.capacity_bps;
611 bitrate_priority_sum -= priority_rate_observer.bitrate_priority;
612 }
613
614 // From the remaining bitrate, allocate the proportional amounts to the
615 // observers that aren't allocated their max capacity.
616 for (; i < priority_rate_observers.size(); ++i) {
617 const auto& priority_rate_observer = priority_rate_observers[i];
618 double fraction_allocated =
619 priority_rate_observer.bitrate_priority / bitrate_priority_sum;
620 allocation->at(priority_rate_observer.allocation_key) +=
621 fraction_allocated * remaining_bitrate;
622 }
623}
624
stefan@webrtc.org792f1a12015-03-04 12:24:26 +0000625} // namespace webrtc