blob: 21939a7e47d2a6e190145faefc272fb40709a027 [file] [log] [blame]
stefan@webrtc.org792f1a12015-03-04 12:24:261/*
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 04:47:3112#include "call/bitrate_allocator.h"
stefan@webrtc.org792f1a12015-03-04 12:24:2613
14#include <algorithm>
Seth Hampsonfe73d6a2017-11-14 18:49:0615#include <cmath>
Alex Narest78609d52017-10-20 08:37:4716#include <memory>
stefan@webrtc.org792f1a12015-03-04 12:24:2617#include <utility>
18
Sebastian Jansson6736df12018-11-21 18:18:3919#include "api/units/data_rate.h"
20#include "api/units/time_delta.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3121#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 16:04:1125#include "system_wrappers/include/field_trial.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3126#include "system_wrappers/include/metrics.h"
stefan@webrtc.org792f1a12015-03-04 12:24:2627
28namespace webrtc {
29
Rasmus Brandt681de202019-02-04 14:09:3430namespace {
31
Stefan Holmere5904162015-03-26 10:11:0632// Allow packets to be transmitted in up to 2 times max video bitrate if the
33// bandwidth estimate allows it.
Ying Wanga646d302018-03-02 16:04:1134const uint8_t kTransmissionMaxBitrateMultiplier = 2;
Stefan Holmere5904162015-03-26 10:11:0635const int kDefaultBitrateBps = 300000;
36
mflodman101f2502016-06-09 15:21:1937// Require a bitrate increase of max(10%, 20kbps) to resume paused streams.
38const double kToggleFactor = 0.1;
39const uint32_t kMinToggleBitrateBps = 20000;
40
mflodman48a4beb2016-07-01 11:03:5941const int64_t kBweLogIntervalMs = 5000;
42
mflodman48a4beb2016-07-01 11:03:5943double MediaRatio(uint32_t allocated_bitrate, uint32_t protection_bitrate) {
kwibergaf476c72016-11-28 23:21:3944 RTC_DCHECK_GT(allocated_bitrate, 0);
mflodman48a4beb2016-07-01 11:03:5945 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}
Rasmus Brandt681de202019-02-04 14:09:3451
mflodman48a4beb2016-07-01 11:03:5952} // namespace
53
perkj71ee44c2016-06-15 07:47:5354BitrateAllocator::BitrateAllocator(LimitObserver* limit_observer)
55 : limit_observer_(limit_observer),
Sebastian Jansson89c94b92018-11-20 16:16:3656 last_target_bps_(0),
57 last_link_capacity_bps_(0),
perkjfea93092016-05-14 07:58:4858 last_non_zero_bitrate_bps_(kDefaultBitrateBps),
Stefan Holmere5904162015-03-26 10:11:0659 last_fraction_loss_(0),
mflodman48a4beb2016-07-01 11:03:5960 last_rtt_(0),
Sebastian Jansson13e59032018-11-21 18:13:0761 last_bwe_period_ms_(1000),
mflodman48a4beb2016-07-01 11:03:5962 num_pause_events_(0),
63 clock_(Clock::GetRealTimeClock()),
philipel5ef2bc12017-02-21 15:28:3164 last_bwe_log_time_(0),
65 total_requested_padding_bitrate_(0),
Alex Narest78609d52017-10-20 08:37:4766 total_requested_min_bitrate_(0),
Sebastian Jansson448f4d52018-04-04 12:52:0767 total_requested_max_bitrate_(0),
Ying Wanga646d302018-03-02 16:04:1168 bitrate_allocation_strategy_(nullptr),
69 transmission_max_bitrate_multiplier_(
70 GetTransmissionMaxBitrateMultiplier()) {
perkj26091b12016-09-01 08:17:4071 sequenced_checker_.Detach();
72}
mflodman48a4beb2016-07-01 11:03:5973
74BitrateAllocator::~BitrateAllocator() {
asapersson1d02d3e2016-09-10 05:40:2575 RTC_HISTOGRAM_COUNTS_100("WebRTC.Call.NumberOfPauseEvents",
76 num_pause_events_);
mflodman48a4beb2016-07-01 11:03:5977}
stefan@webrtc.org792f1a12015-03-04 12:24:2678
Sebastian Jansson2701bc92018-12-11 14:02:4779void BitrateAllocator::UpdateStartRate(uint32_t start_rate_bps) {
80 RTC_DCHECK_CALLED_SEQUENTIALLY(&sequenced_checker_);
81 last_non_zero_bitrate_bps_ = start_rate_bps;
82}
83
Niels Möller74e5f802018-04-25 12:03:4684// static
Ying Wanga646d302018-03-02 16:04:1185uint8_t BitrateAllocator::GetTransmissionMaxBitrateMultiplier() {
86 uint64_t multiplier = strtoul(webrtc::field_trial::FindFullName(
87 "WebRTC-TransmissionMaxBitrateMultiplier")
88 .c_str(),
89 nullptr, 10);
90 if (multiplier > 0 && multiplier <= kTransmissionMaxBitrateMultiplier) {
Ying Wang012b7e72018-03-05 14:44:2391 RTC_LOG(LS_INFO) << "TransmissionMaxBitrateMultiplier is set to "
92 << multiplier;
Ying Wanga646d302018-03-02 16:04:1193 return static_cast<uint8_t>(multiplier);
94 }
95 return kTransmissionMaxBitrateMultiplier;
96}
97
perkj71ee44c2016-06-15 07:47:5398void BitrateAllocator::OnNetworkChanged(uint32_t target_bitrate_bps,
Sebastian Jansson89c94b92018-11-20 16:16:3699 uint32_t link_capacity_bps,
perkj71ee44c2016-06-15 07:47:53100 uint8_t fraction_loss,
minyue78b4d562016-11-30 12:47:39101 int64_t rtt,
minyue93e45222017-05-18 21:32:41102 int64_t bwe_period_ms) {
perkj26091b12016-09-01 08:17:40103 RTC_DCHECK_CALLED_SEQUENTIALLY(&sequenced_checker_);
Sebastian Jansson89c94b92018-11-20 16:16:36104 last_target_bps_ = target_bitrate_bps;
105 last_link_capacity_bps_ = link_capacity_bps;
perkjfea93092016-05-14 07:58:48106 last_non_zero_bitrate_bps_ =
mflodman101f2502016-06-09 15:21:19107 target_bitrate_bps > 0 ? target_bitrate_bps : last_non_zero_bitrate_bps_;
Stefan Holmere5904162015-03-26 10:11:06108 last_fraction_loss_ = fraction_loss;
109 last_rtt_ = rtt;
minyue93e45222017-05-18 21:32:41110 last_bwe_period_ms_ = bwe_period_ms;
mflodman2ebe5b12016-05-13 08:43:51111
mflodman48a4beb2016-07-01 11:03:59112 // Periodically log the incoming BWE.
113 int64_t now = clock_->TimeInMilliseconds();
114 if (now > last_bwe_log_time_ + kBweLogIntervalMs) {
Mirko Bonadei675513b2017-11-09 10:09:25115 RTC_LOG(LS_INFO) << "Current BWE " << target_bitrate_bps;
mflodman48a4beb2016-07-01 11:03:59116 last_bwe_log_time_ = now;
sprang2f48d942015-11-05 12:25:49117 }
mflodman48a4beb2016-07-01 11:03:59118
119 ObserverAllocation allocation = AllocateBitrates(target_bitrate_bps);
Sebastian Jansson89c94b92018-11-20 16:16:36120 ObserverAllocation bandwidth_allocation = AllocateBitrates(link_capacity_bps);
mflodman48a4beb2016-07-01 11:03:59121
122 for (auto& config : bitrate_observer_configs_) {
123 uint32_t allocated_bitrate = allocation[config.observer];
Sebastian Jansson89c94b92018-11-20 16:16:36124 uint32_t allocated_bandwidth = bandwidth_allocation[config.observer];
Sebastian Jansson13e59032018-11-21 18:13:07125 BitrateAllocationUpdate update;
126 update.target_bitrate = DataRate::bps(allocated_bitrate);
127 update.link_capacity = DataRate::bps(allocated_bandwidth);
128 update.packet_loss_ratio = last_fraction_loss_ / 256.0;
129 update.round_trip_time = TimeDelta::ms(last_rtt_);
130 update.bwe_period = TimeDelta::ms(last_bwe_period_ms_);
131 uint32_t protection_bitrate = config.observer->OnBitrateUpdated(update);
mflodman48a4beb2016-07-01 11:03:59132
133 if (allocated_bitrate == 0 && config.allocated_bitrate_bps > 0) {
134 if (target_bitrate_bps > 0)
135 ++num_pause_events_;
136 // The protection bitrate is an estimate based on the ratio between media
137 // and protection used before this observer was muted.
138 uint32_t predicted_protection_bps =
139 (1.0 - config.media_ratio) * config.min_bitrate_bps;
Mirko Bonadei675513b2017-11-09 10:09:25140 RTC_LOG(LS_INFO) << "Pausing observer " << config.observer
141 << " with configured min bitrate "
142 << config.min_bitrate_bps << " and current estimate of "
143 << target_bitrate_bps << " and protection bitrate "
144 << predicted_protection_bps;
mflodman48a4beb2016-07-01 11:03:59145 } else if (allocated_bitrate > 0 && config.allocated_bitrate_bps == 0) {
146 if (target_bitrate_bps > 0)
147 ++num_pause_events_;
Mirko Bonadei675513b2017-11-09 10:09:25148 RTC_LOG(LS_INFO) << "Resuming observer " << config.observer
149 << ", configured min bitrate " << config.min_bitrate_bps
150 << ", current allocation " << allocated_bitrate
151 << " and protection bitrate " << protection_bitrate;
mflodman48a4beb2016-07-01 11:03:59152 }
153
154 // Only update the media ratio if the observer got an allocation.
155 if (allocated_bitrate > 0)
156 config.media_ratio = MediaRatio(allocated_bitrate, protection_bitrate);
157 config.allocated_bitrate_bps = allocated_bitrate;
158 }
philipel5ef2bc12017-02-21 15:28:31159 UpdateAllocationLimits();
Stefan Holmere5904162015-03-26 10:11:06160}
161
perkj57c21f92016-06-17 14:27:16162void BitrateAllocator::AddObserver(BitrateAllocatorObserver* observer,
Sebastian Jansson24ad7202018-04-19 06:25:12163 MediaStreamAllocationConfig config) {
perkj26091b12016-09-01 08:17:40164 RTC_DCHECK_CALLED_SEQUENTIALLY(&sequenced_checker_);
Sebastian Jansson24ad7202018-04-19 06:25:12165 RTC_DCHECK_GT(config.bitrate_priority, 0);
166 RTC_DCHECK(std::isnormal(config.bitrate_priority));
mflodman2ebe5b12016-05-13 08:43:51167 auto it = FindObserverConfig(observer);
stefan@webrtc.org792f1a12015-03-04 12:24:26168
mflodman101f2502016-06-09 15:21:19169 // Update settings if the observer already exists, create a new one otherwise.
mflodman2ebe5b12016-05-13 08:43:51170 if (it != bitrate_observer_configs_.end()) {
Sebastian Jansson24ad7202018-04-19 06:25:12171 it->min_bitrate_bps = config.min_bitrate_bps;
172 it->max_bitrate_bps = config.max_bitrate_bps;
173 it->pad_up_bitrate_bps = config.pad_up_bitrate_bps;
174 it->enforce_min_bitrate = config.enforce_min_bitrate;
175 it->bitrate_priority = config.bitrate_priority;
stefan@webrtc.org792f1a12015-03-04 12:24:26176 } else {
Sebastian Jansson464a5572019-02-12 12:32:32177 bitrate_observer_configs_.push_back(ObserverConfig(
178 observer, config.min_bitrate_bps, config.max_bitrate_bps,
179 config.pad_up_bitrate_bps, config.priority_bitrate_bps,
180 config.enforce_min_bitrate, config.track_id, config.bitrate_priority));
stefan@webrtc.org792f1a12015-03-04 12:24:26181 }
Stefan Holmere5904162015-03-26 10:11:06182
Sebastian Jansson89c94b92018-11-20 16:16:36183 if (last_target_bps_ > 0) {
mflodman101f2502016-06-09 15:21:19184 // Calculate a new allocation and update all observers.
Sebastian Jansson89c94b92018-11-20 16:16:36185
186 ObserverAllocation allocation = AllocateBitrates(last_target_bps_);
187 ObserverAllocation bandwidth_allocation =
188 AllocateBitrates(last_link_capacity_bps_);
mflodman48a4beb2016-07-01 11:03:59189 for (auto& config : bitrate_observer_configs_) {
190 uint32_t allocated_bitrate = allocation[config.observer];
Sebastian Jansson89c94b92018-11-20 16:16:36191 uint32_t bandwidth = bandwidth_allocation[config.observer];
Sebastian Jansson13e59032018-11-21 18:13:07192 BitrateAllocationUpdate update;
193 update.target_bitrate = DataRate::bps(allocated_bitrate);
194 update.link_capacity = DataRate::bps(bandwidth);
195 update.packet_loss_ratio = last_fraction_loss_ / 256.0;
196 update.round_trip_time = TimeDelta::ms(last_rtt_);
197 update.bwe_period = TimeDelta::ms(last_bwe_period_ms_);
198 uint32_t protection_bitrate = config.observer->OnBitrateUpdated(update);
mflodman48a4beb2016-07-01 11:03:59199 config.allocated_bitrate_bps = allocated_bitrate;
200 if (allocated_bitrate > 0)
201 config.media_ratio = MediaRatio(allocated_bitrate, protection_bitrate);
202 }
perkjfea93092016-05-14 07:58:48203 } else {
204 // Currently, an encoder is not allowed to produce frames.
205 // But we still have to return the initial config bitrate + let the
206 // observer know that it can not produce frames.
Sebastian Jansson13e59032018-11-21 18:13:07207
208 BitrateAllocationUpdate update;
209 update.target_bitrate = DataRate::Zero();
210 update.link_capacity = DataRate::Zero();
211 update.packet_loss_ratio = last_fraction_loss_ / 256.0;
212 update.round_trip_time = TimeDelta::ms(last_rtt_);
213 update.bwe_period = TimeDelta::ms(last_bwe_period_ms_);
214 observer->OnBitrateUpdated(update);
Stefan Holmere5904162015-03-26 10:11:06215 }
perkj71ee44c2016-06-15 07:47:53216 UpdateAllocationLimits();
stefan@webrtc.org792f1a12015-03-04 12:24:26217}
218
perkj71ee44c2016-06-15 07:47:53219void BitrateAllocator::UpdateAllocationLimits() {
220 uint32_t total_requested_padding_bitrate = 0;
221 uint32_t total_requested_min_bitrate = 0;
Sebastian Jansson448f4d52018-04-04 12:52:07222 uint32_t total_requested_max_bitrate = 0;
perkj26091b12016-09-01 08:17:40223 for (const auto& config : bitrate_observer_configs_) {
philipel5ef2bc12017-02-21 15:28:31224 uint32_t stream_padding = config.pad_up_bitrate_bps;
perkj26091b12016-09-01 08:17:40225 if (config.enforce_min_bitrate) {
226 total_requested_min_bitrate += config.min_bitrate_bps;
philipel5ef2bc12017-02-21 15:28:31227 } else if (config.allocated_bitrate_bps == 0) {
228 stream_padding =
srte1eb051c2017-11-29 10:23:59229 std::max(config.MinBitrateWithHysteresis(), stream_padding);
perkj71ee44c2016-06-15 07:47:53230 }
philipel5ef2bc12017-02-21 15:28:31231 total_requested_padding_bitrate += stream_padding;
Rasmus Brandt681de202019-02-04 14:09:34232 total_requested_max_bitrate += config.max_bitrate_bps;
stefan@webrtc.org792f1a12015-03-04 12:24:26233 }
perkj71ee44c2016-06-15 07:47:53234
philipel5ef2bc12017-02-21 15:28:31235 if (total_requested_padding_bitrate == total_requested_padding_bitrate_ &&
Sebastian Jansson29b204e2018-03-21 11:45:27236 total_requested_min_bitrate == total_requested_min_bitrate_ &&
Sebastian Jansson79f0d4d2019-01-23 08:41:43237 total_requested_max_bitrate == total_requested_max_bitrate_) {
philipel5ef2bc12017-02-21 15:28:31238 return;
239 }
240
241 total_requested_min_bitrate_ = total_requested_min_bitrate;
242 total_requested_padding_bitrate_ = total_requested_padding_bitrate;
Sebastian Jansson448f4d52018-04-04 12:52:07243 total_requested_max_bitrate_ = total_requested_max_bitrate;
philipel5ef2bc12017-02-21 15:28:31244
Mirko Bonadei675513b2017-11-09 10:09:25245 RTC_LOG(LS_INFO) << "UpdateAllocationLimits : total_requested_min_bitrate: "
246 << total_requested_min_bitrate
247 << "bps, total_requested_padding_bitrate: "
Sebastian Jansson448f4d52018-04-04 12:52:07248 << total_requested_padding_bitrate
249 << "bps, total_requested_max_bitrate: "
250 << total_requested_max_bitrate << "bps";
Sebastian Jansson79f0d4d2019-01-23 08:41:43251 limit_observer_->OnAllocationLimitsChanged(total_requested_min_bitrate,
252 total_requested_padding_bitrate,
253 total_requested_max_bitrate);
perkj71ee44c2016-06-15 07:47:53254}
255
256void BitrateAllocator::RemoveObserver(BitrateAllocatorObserver* observer) {
perkj26091b12016-09-01 08:17:40257 RTC_DCHECK_CALLED_SEQUENTIALLY(&sequenced_checker_);
Alex Narest78609d52017-10-20 08:37:47258
perkj26091b12016-09-01 08:17:40259 auto it = FindObserverConfig(observer);
260 if (it != bitrate_observer_configs_.end()) {
261 bitrate_observer_configs_.erase(it);
perkj71ee44c2016-06-15 07:47:53262 }
perkj26091b12016-09-01 08:17:40263
perkj71ee44c2016-06-15 07:47:53264 UpdateAllocationLimits();
stefan@webrtc.org792f1a12015-03-04 12:24:26265}
266
Sebastian Jansson44a262a2018-10-24 14:07:20267int BitrateAllocator::GetStartBitrate(
268 BitrateAllocatorObserver* observer) const {
perkj26091b12016-09-01 08:17:40269 RTC_DCHECK_CALLED_SEQUENTIALLY(&sequenced_checker_);
mflodman48a4beb2016-07-01 11:03:59270 const auto& it = FindObserverConfig(observer);
271 if (it == bitrate_observer_configs_.end()) {
272 // This observer hasn't been added yet, just give it its fair share.
273 return last_non_zero_bitrate_bps_ /
perkj26091b12016-09-01 08:17:40274 static_cast<int>((bitrate_observer_configs_.size() + 1));
mflodman48a4beb2016-07-01 11:03:59275 } else if (it->allocated_bitrate_bps == -1) {
276 // This observer hasn't received an allocation yet, so do the same.
277 return last_non_zero_bitrate_bps_ /
perkj26091b12016-09-01 08:17:40278 static_cast<int>(bitrate_observer_configs_.size());
mflodman48a4beb2016-07-01 11:03:59279 } else {
280 // This observer already has an allocation.
281 return it->allocated_bitrate_bps;
282 }
perkj57c21f92016-06-17 14:27:16283}
284
Alex Narest78609d52017-10-20 08:37:47285void BitrateAllocator::SetBitrateAllocationStrategy(
286 std::unique_ptr<rtc::BitrateAllocationStrategy>
287 bitrate_allocation_strategy) {
288 RTC_DCHECK_CALLED_SEQUENTIALLY(&sequenced_checker_);
289 bitrate_allocation_strategy_ = std::move(bitrate_allocation_strategy);
290}
291
Sebastian Jansson44a262a2018-10-24 14:07:20292BitrateAllocator::ObserverConfigs::const_iterator
293BitrateAllocator::FindObserverConfig(
294 const BitrateAllocatorObserver* observer) const {
295 for (auto it = bitrate_observer_configs_.begin();
296 it != bitrate_observer_configs_.end(); ++it) {
297 if (it->observer == observer)
298 return it;
299 }
300 return bitrate_observer_configs_.end();
301}
302
mflodman48a4beb2016-07-01 11:03:59303BitrateAllocator::ObserverConfigs::iterator
perkj26091b12016-09-01 08:17:40304BitrateAllocator::FindObserverConfig(const BitrateAllocatorObserver* observer) {
mflodman2ebe5b12016-05-13 08:43:51305 for (auto it = bitrate_observer_configs_.begin();
306 it != bitrate_observer_configs_.end(); ++it) {
307 if (it->observer == observer)
308 return it;
309 }
310 return bitrate_observer_configs_.end();
311}
312
perkjfea93092016-05-14 07:58:48313BitrateAllocator::ObserverAllocation BitrateAllocator::AllocateBitrates(
Sebastian Jansson44a262a2018-10-24 14:07:20314 uint32_t bitrate) const {
mflodman2ebe5b12016-05-13 08:43:51315 if (bitrate_observer_configs_.empty())
316 return ObserverAllocation();
317
Alex Narest78609d52017-10-20 08:37:47318 if (bitrate_allocation_strategy_ != nullptr) {
Sebastian Janssone2754c92018-10-24 14:02:26319 // Note: This intentionally causes slicing, we only copy the fields in
320 // ObserverConfig that are inherited from TrackConfig.
321 std::vector<rtc::BitrateAllocationStrategy::TrackConfig> track_configs(
322 bitrate_observer_configs_.begin(), bitrate_observer_configs_.end());
323
Alex Narest78609d52017-10-20 08:37:47324 std::vector<uint32_t> track_allocations =
Sebastian Janssone2754c92018-10-24 14:02:26325 bitrate_allocation_strategy_->AllocateBitrates(
326 bitrate, std::move(track_configs));
Alex Narest78609d52017-10-20 08:37:47327 // The strategy should return allocation for all tracks.
328 RTC_CHECK(track_allocations.size() == bitrate_observer_configs_.size());
329 ObserverAllocation allocation;
330 auto track_allocations_it = track_allocations.begin();
331 for (const auto& observer_config : bitrate_observer_configs_) {
332 allocation[observer_config.observer] = *track_allocations_it++;
333 }
334 return allocation;
335 }
336
perkjfea93092016-05-14 07:58:48337 if (bitrate == 0)
mflodman2ebe5b12016-05-13 08:43:51338 return ZeroRateAllocation();
339
340 uint32_t sum_min_bitrates = 0;
mflodman101f2502016-06-09 15:21:19341 uint32_t sum_max_bitrates = 0;
342 for (const auto& observer_config : bitrate_observer_configs_) {
mflodman2ebe5b12016-05-13 08:43:51343 sum_min_bitrates += observer_config.min_bitrate_bps;
mflodman101f2502016-06-09 15:21:19344 sum_max_bitrates += observer_config.max_bitrate_bps;
345 }
346
347 // Not enough for all observers to get an allocation, allocate according to:
348 // enforced min bitrate -> allocated bitrate previous round -> restart paused
349 // streams.
350 if (!EnoughBitrateForAllObservers(bitrate, sum_min_bitrates))
perkjfea93092016-05-14 07:58:48351 return LowRateAllocation(bitrate);
mflodman2ebe5b12016-05-13 08:43:51352
Seth Hampsonfe73d6a2017-11-14 18:49:06353 // All observers will get their min bitrate plus a share of the rest. This
354 // share is allocated to each observer based on its bitrate_priority.
mflodman101f2502016-06-09 15:21:19355 if (bitrate <= sum_max_bitrates)
356 return NormalRateAllocation(bitrate, sum_min_bitrates);
mflodman2ebe5b12016-05-13 08:43:51357
Ying Wanga646d302018-03-02 16:04:11358 // All observers will get up to transmission_max_bitrate_multiplier_ x max.
mflodman101f2502016-06-09 15:21:19359 return MaxRateAllocation(bitrate, sum_max_bitrates);
stefan@webrtc.org792f1a12015-03-04 12:24:26360}
361
Sebastian Jansson44a262a2018-10-24 14:07:20362BitrateAllocator::ObserverAllocation BitrateAllocator::ZeroRateAllocation()
363 const {
mflodman2ebe5b12016-05-13 08:43:51364 ObserverAllocation allocation;
mflodman2ebe5b12016-05-13 08:43:51365 for (const auto& observer_config : bitrate_observer_configs_)
366 allocation[observer_config.observer] = 0;
perkjec81bcd2016-05-11 13:01:13367 return allocation;
368}
369
mflodman2ebe5b12016-05-13 08:43:51370BitrateAllocator::ObserverAllocation BitrateAllocator::LowRateAllocation(
Sebastian Jansson44a262a2018-10-24 14:07:20371 uint32_t bitrate) const {
mflodman2ebe5b12016-05-13 08:43:51372 ObserverAllocation allocation;
mflodman101f2502016-06-09 15:21:19373 // Start by allocating bitrate to observers enforcing a min bitrate, hence
374 // remaining_bitrate might turn negative.
375 int64_t remaining_bitrate = bitrate;
376 for (const auto& observer_config : bitrate_observer_configs_) {
377 int32_t allocated_bitrate = 0;
378 if (observer_config.enforce_min_bitrate)
379 allocated_bitrate = observer_config.min_bitrate_bps;
380
381 allocation[observer_config.observer] = allocated_bitrate;
382 remaining_bitrate -= allocated_bitrate;
383 }
384
385 // Allocate bitrate to all previously active streams.
386 if (remaining_bitrate > 0) {
mflodman2ebe5b12016-05-13 08:43:51387 for (const auto& observer_config : bitrate_observer_configs_) {
mflodman101f2502016-06-09 15:21:19388 if (observer_config.enforce_min_bitrate ||
srte1eb051c2017-11-29 10:23:59389 observer_config.LastAllocatedBitrate() == 0)
mflodman101f2502016-06-09 15:21:19390 continue;
391
srte1eb051c2017-11-29 10:23:59392 uint32_t required_bitrate = observer_config.MinBitrateWithHysteresis();
mflodman48a4beb2016-07-01 11:03:59393 if (remaining_bitrate >= required_bitrate) {
394 allocation[observer_config.observer] = required_bitrate;
395 remaining_bitrate -= required_bitrate;
mflodman101f2502016-06-09 15:21:19396 }
stefan@webrtc.org792f1a12015-03-04 12:24:26397 }
398 }
mflodman101f2502016-06-09 15:21:19399
400 // Allocate bitrate to previously paused streams.
401 if (remaining_bitrate > 0) {
402 for (const auto& observer_config : bitrate_observer_configs_) {
srte1eb051c2017-11-29 10:23:59403 if (observer_config.LastAllocatedBitrate() != 0)
mflodman101f2502016-06-09 15:21:19404 continue;
405
406 // Add a hysteresis to avoid toggling.
srte1eb051c2017-11-29 10:23:59407 uint32_t required_bitrate = observer_config.MinBitrateWithHysteresis();
mflodman101f2502016-06-09 15:21:19408 if (remaining_bitrate >= required_bitrate) {
409 allocation[observer_config.observer] = required_bitrate;
410 remaining_bitrate -= required_bitrate;
411 }
412 }
413 }
414
415 // Split a possible remainder evenly on all streams with an allocation.
416 if (remaining_bitrate > 0)
417 DistributeBitrateEvenly(remaining_bitrate, false, 1, &allocation);
418
419 RTC_DCHECK_EQ(allocation.size(), bitrate_observer_configs_.size());
Stefan Holmere5904162015-03-26 10:11:06420 return allocation;
stefan@webrtc.org792f1a12015-03-04 12:24:26421}
mflodman101f2502016-06-09 15:21:19422
Seth Hampsonfe73d6a2017-11-14 18:49:06423// Allocates the bitrate based on the bitrate priority of each observer. This
424// bitrate priority defines the priority for bitrate to be allocated to that
425// observer in relation to other observers. For example with two observers, if
426// observer 1 had a bitrate_priority = 1.0, and observer 2 has a
427// bitrate_priority = 2.0, the expected behavior is that observer 2 will be
428// allocated twice the bitrate as observer 1 above the each observer's
429// min_bitrate_bps values, until one of the observers hits its max_bitrate_bps.
mflodman101f2502016-06-09 15:21:19430BitrateAllocator::ObserverAllocation BitrateAllocator::NormalRateAllocation(
431 uint32_t bitrate,
Sebastian Jansson44a262a2018-10-24 14:07:20432 uint32_t sum_min_bitrates) const {
mflodman101f2502016-06-09 15:21:19433 ObserverAllocation allocation;
Seth Hampsonfe73d6a2017-11-14 18:49:06434 ObserverAllocation observers_capacities;
435 for (const auto& observer_config : bitrate_observer_configs_) {
mflodman101f2502016-06-09 15:21:19436 allocation[observer_config.observer] = observer_config.min_bitrate_bps;
Seth Hampsonfe73d6a2017-11-14 18:49:06437 observers_capacities[observer_config.observer] =
438 observer_config.max_bitrate_bps - observer_config.min_bitrate_bps;
439 }
mflodman101f2502016-06-09 15:21:19440
441 bitrate -= sum_min_bitrates;
Sebastian Jansson464a5572019-02-12 12:32:32442
443 // TODO(srte): Implement fair sharing between prioritized streams, currently
444 // they are treated on a first come first serve basis.
445 for (const auto& observer_config : bitrate_observer_configs_) {
446 int64_t priority_margin = observer_config.priority_bitrate_bps -
447 allocation[observer_config.observer];
448 if (priority_margin > 0 && bitrate > 0) {
449 int64_t extra_bitrate = std::min<int64_t>(priority_margin, bitrate);
450 allocation[observer_config.observer] +=
451 rtc::dchecked_cast<int>(extra_bitrate);
452 observers_capacities[observer_config.observer] -= extra_bitrate;
453 bitrate -= extra_bitrate;
454 }
455 }
456
Seth Hampsonfe73d6a2017-11-14 18:49:06457 // From the remaining bitrate, allocate a proportional amount to each observer
458 // above the min bitrate already allocated.
mflodman101f2502016-06-09 15:21:19459 if (bitrate > 0)
Seth Hampsonfe73d6a2017-11-14 18:49:06460 DistributeBitrateRelatively(bitrate, observers_capacities, &allocation);
mflodman101f2502016-06-09 15:21:19461
462 return allocation;
463}
464
465BitrateAllocator::ObserverAllocation BitrateAllocator::MaxRateAllocation(
perkj26091b12016-09-01 08:17:40466 uint32_t bitrate,
Sebastian Jansson44a262a2018-10-24 14:07:20467 uint32_t sum_max_bitrates) const {
mflodman101f2502016-06-09 15:21:19468 ObserverAllocation allocation;
469
470 for (const auto& observer_config : bitrate_observer_configs_) {
471 allocation[observer_config.observer] = observer_config.max_bitrate_bps;
472 bitrate -= observer_config.max_bitrate_bps;
473 }
Ying Wanga646d302018-03-02 16:04:11474 DistributeBitrateEvenly(bitrate, true, transmission_max_bitrate_multiplier_,
mflodman101f2502016-06-09 15:21:19475 &allocation);
476 return allocation;
477}
478
srte1eb051c2017-11-29 10:23:59479uint32_t BitrateAllocator::ObserverConfig::LastAllocatedBitrate() const {
mflodman101f2502016-06-09 15:21:19480 // Return the configured minimum bitrate for newly added observers, to avoid
481 // requiring an extra high bitrate for the observer to get an allocated
482 // bitrate.
srte1eb051c2017-11-29 10:23:59483 return allocated_bitrate_bps == -1 ? min_bitrate_bps : allocated_bitrate_bps;
mflodman101f2502016-06-09 15:21:19484}
485
srte1eb051c2017-11-29 10:23:59486uint32_t BitrateAllocator::ObserverConfig::MinBitrateWithHysteresis() const {
487 uint32_t min_bitrate = min_bitrate_bps;
488 if (LastAllocatedBitrate() == 0) {
mflodman101f2502016-06-09 15:21:19489 min_bitrate += std::max(static_cast<uint32_t>(kToggleFactor * min_bitrate),
490 kMinToggleBitrateBps);
491 }
mflodman48a4beb2016-07-01 11:03:59492 // Account for protection bitrate used by this observer in the previous
493 // allocation.
494 // Note: the ratio will only be updated when the stream is active, meaning a
495 // paused stream won't get any ratio updates. This might lead to waiting a bit
496 // longer than necessary if the network condition improves, but this is to
497 // avoid too much toggling.
srte1eb051c2017-11-29 10:23:59498 if (media_ratio > 0.0 && media_ratio < 1.0)
499 min_bitrate += min_bitrate * (1.0 - media_ratio);
mflodman48a4beb2016-07-01 11:03:59500
mflodman101f2502016-06-09 15:21:19501 return min_bitrate;
502}
503
Sebastian Jansson44a262a2018-10-24 14:07:20504void BitrateAllocator::DistributeBitrateEvenly(
505 uint32_t bitrate,
506 bool include_zero_allocations,
507 int max_multiplier,
508 ObserverAllocation* allocation) const {
mflodman101f2502016-06-09 15:21:19509 RTC_DCHECK_EQ(allocation->size(), bitrate_observer_configs_.size());
510
511 ObserverSortingMap list_max_bitrates;
512 for (const auto& observer_config : bitrate_observer_configs_) {
513 if (include_zero_allocations ||
514 allocation->at(observer_config.observer) != 0) {
515 list_max_bitrates.insert(std::pair<uint32_t, const ObserverConfig*>(
516 observer_config.max_bitrate_bps, &observer_config));
517 }
518 }
519 auto it = list_max_bitrates.begin();
520 while (it != list_max_bitrates.end()) {
kwibergaf476c72016-11-28 23:21:39521 RTC_DCHECK_GT(bitrate, 0);
mflodman101f2502016-06-09 15:21:19522 uint32_t extra_allocation =
523 bitrate / static_cast<uint32_t>(list_max_bitrates.size());
524 uint32_t total_allocation =
525 extra_allocation + allocation->at(it->second->observer);
526 bitrate -= extra_allocation;
527 if (total_allocation > max_multiplier * it->first) {
528 // There is more than we can fit for this observer, carry over to the
529 // remaining observers.
530 bitrate += total_allocation - max_multiplier * it->first;
531 total_allocation = max_multiplier * it->first;
532 }
533 // Finally, update the allocation for this observer.
534 allocation->at(it->second->observer) = total_allocation;
535 it = list_max_bitrates.erase(it);
536 }
537}
538
Sebastian Jansson44a262a2018-10-24 14:07:20539bool BitrateAllocator::EnoughBitrateForAllObservers(
540 uint32_t bitrate,
541 uint32_t sum_min_bitrates) const {
mflodman101f2502016-06-09 15:21:19542 if (bitrate < sum_min_bitrates)
543 return false;
544
perkj26091b12016-09-01 08:17:40545 uint32_t extra_bitrate_per_observer =
546 (bitrate - sum_min_bitrates) /
mflodman101f2502016-06-09 15:21:19547 static_cast<uint32_t>(bitrate_observer_configs_.size());
548 for (const auto& observer_config : bitrate_observer_configs_) {
549 if (observer_config.min_bitrate_bps + extra_bitrate_per_observer <
srte1eb051c2017-11-29 10:23:59550 observer_config.MinBitrateWithHysteresis()) {
mflodman101f2502016-06-09 15:21:19551 return false;
philipel5ef2bc12017-02-21 15:28:31552 }
mflodman101f2502016-06-09 15:21:19553 }
554 return true;
555}
Seth Hampsonfe73d6a2017-11-14 18:49:06556
557void BitrateAllocator::DistributeBitrateRelatively(
558 uint32_t remaining_bitrate,
559 const ObserverAllocation& observers_capacities,
Sebastian Jansson44a262a2018-10-24 14:07:20560 ObserverAllocation* allocation) const {
Seth Hampsonfe73d6a2017-11-14 18:49:06561 RTC_DCHECK_EQ(allocation->size(), bitrate_observer_configs_.size());
562 RTC_DCHECK_EQ(observers_capacities.size(), bitrate_observer_configs_.size());
563
564 struct PriorityRateObserverConfig {
565 PriorityRateObserverConfig(BitrateAllocatorObserver* allocation_key,
566 uint32_t capacity_bps,
567 double bitrate_priority)
568 : allocation_key(allocation_key),
569 capacity_bps(capacity_bps),
570 bitrate_priority(bitrate_priority) {}
571
572 BitrateAllocatorObserver* allocation_key;
573 // The amount of bitrate bps that can be allocated to this observer.
574 uint32_t capacity_bps;
575 double bitrate_priority;
576
577 // We want to sort by which observers will be allocated their full capacity
578 // first. By dividing each observer's capacity by its bitrate priority we
579 // are "normalizing" the capacity of an observer by the rate it will be
580 // filled. This is because the amount allocated is based upon bitrate
581 // priority. We allocate twice as much bitrate to an observer with twice the
582 // bitrate priority of another.
583 bool operator<(const PriorityRateObserverConfig& other) const {
584 return capacity_bps / bitrate_priority <
585 other.capacity_bps / other.bitrate_priority;
586 }
587 };
588
589 double bitrate_priority_sum = 0;
590 std::vector<PriorityRateObserverConfig> priority_rate_observers;
591 for (const auto& observer_config : bitrate_observer_configs_) {
592 uint32_t capacity_bps = observers_capacities.at(observer_config.observer);
593 priority_rate_observers.emplace_back(observer_config.observer, capacity_bps,
594 observer_config.bitrate_priority);
595 bitrate_priority_sum += observer_config.bitrate_priority;
596 }
597
598 // Iterate in the order observers can be allocated their full capacity.
599 std::sort(priority_rate_observers.begin(), priority_rate_observers.end());
600 size_t i;
601 for (i = 0; i < priority_rate_observers.size(); ++i) {
602 const auto& priority_rate_observer = priority_rate_observers[i];
603 // We allocate the full capacity to an observer only if its relative
604 // portion from the remaining bitrate is sufficient to allocate its full
605 // capacity. This means we aren't greedily allocating the full capacity, but
606 // that it is only done when there is also enough bitrate to allocate the
607 // proportional amounts to all other observers.
608 double observer_share =
609 priority_rate_observer.bitrate_priority / bitrate_priority_sum;
610 double allocation_bps = observer_share * remaining_bitrate;
611 bool enough_bitrate = allocation_bps >= priority_rate_observer.capacity_bps;
612 if (!enough_bitrate)
613 break;
614 allocation->at(priority_rate_observer.allocation_key) +=
615 priority_rate_observer.capacity_bps;
616 remaining_bitrate -= priority_rate_observer.capacity_bps;
617 bitrate_priority_sum -= priority_rate_observer.bitrate_priority;
618 }
619
620 // From the remaining bitrate, allocate the proportional amounts to the
621 // observers that aren't allocated their max capacity.
622 for (; i < priority_rate_observers.size(); ++i) {
623 const auto& priority_rate_observer = priority_rate_observers[i];
624 double fraction_allocated =
625 priority_rate_observer.bitrate_priority / bitrate_priority_sum;
626 allocation->at(priority_rate_observer.allocation_key) +=
627 fraction_allocated * remaining_bitrate;
628 }
629}
630
stefan@webrtc.org792f1a12015-03-04 12:24:26631} // namespace webrtc