blob: 8d41963a7e13bd98e902673408ac22be9bb4c2cb [file] [log] [blame]
Erik Språngd05edec2019-08-14 10:43:47 +02001/*
2 * Copyright (c) 2019 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#include "modules/pacing/pacing_controller.h"
12
13#include <algorithm>
Mirko Bonadei317a1f02019-09-17 17:06:18 +020014#include <memory>
Erik Språngd05edec2019-08-14 10:43:47 +020015#include <utility>
16#include <vector>
17
Erik Språngd05edec2019-08-14 10:43:47 +020018#include "modules/pacing/bitrate_prober.h"
19#include "modules/pacing/interval_budget.h"
20#include "modules/utility/include/process_thread.h"
21#include "rtc_base/checks.h"
22#include "rtc_base/logging.h"
23#include "rtc_base/time_utils.h"
24#include "system_wrappers/include/clock.h"
25
26namespace webrtc {
27namespace {
28// Time limit in milliseconds between packet bursts.
Danil Chapovalov55284022020-02-07 14:53:52 +010029constexpr TimeDelta kDefaultMinPacketLimit = TimeDelta::Millis(5);
30constexpr TimeDelta kCongestedPacketInterval = TimeDelta::Millis(500);
Erik Språngeb487992019-11-14 14:15:15 +010031// TODO(sprang): Consider dropping this limit.
32// The maximum debt level, in terms of time, capped when sending packets.
Danil Chapovalov55284022020-02-07 14:53:52 +010033constexpr TimeDelta kMaxDebtInTime = TimeDelta::Millis(500);
34constexpr TimeDelta kMaxElapsedTime = TimeDelta::Seconds(2);
Danil Chapovalovcad3e0e2020-02-17 18:46:07 +010035constexpr DataSize kDefaultPaddingTarget = DataSize::Bytes(50);
Erik Språngd05edec2019-08-14 10:43:47 +020036
37// Upper cap on process interval, in case process has not been called in a long
38// time.
Danil Chapovalov55284022020-02-07 14:53:52 +010039constexpr TimeDelta kMaxProcessingInterval = TimeDelta::Millis(30);
Erik Språngd05edec2019-08-14 10:43:47 +020040
Erik Språng78c82a42019-10-03 18:46:04 +020041constexpr int kFirstPriority = 0;
42
Erik Språngd05edec2019-08-14 10:43:47 +020043bool IsDisabled(const WebRtcKeyValueConfig& field_trials,
44 absl::string_view key) {
45 return field_trials.Lookup(key).find("Disabled") == 0;
46}
47
48bool IsEnabled(const WebRtcKeyValueConfig& field_trials,
49 absl::string_view key) {
50 return field_trials.Lookup(key).find("Enabled") == 0;
51}
52
Björn Terelius31d0f7c2020-02-06 16:35:46 +010053int GetPriorityForType(RtpPacketMediaType type) {
Erik Språng78c82a42019-10-03 18:46:04 +020054 // Lower number takes priority over higher.
Erik Språngd05edec2019-08-14 10:43:47 +020055 switch (type) {
Björn Terelius31d0f7c2020-02-06 16:35:46 +010056 case RtpPacketMediaType::kAudio:
Erik Språngd05edec2019-08-14 10:43:47 +020057 // Audio is always prioritized over other packet types.
Erik Språng78c82a42019-10-03 18:46:04 +020058 return kFirstPriority + 1;
Björn Terelius31d0f7c2020-02-06 16:35:46 +010059 case RtpPacketMediaType::kRetransmission:
Erik Språngd05edec2019-08-14 10:43:47 +020060 // Send retransmissions before new media.
Erik Språng78c82a42019-10-03 18:46:04 +020061 return kFirstPriority + 2;
Björn Terelius31d0f7c2020-02-06 16:35:46 +010062 case RtpPacketMediaType::kVideo:
63 case RtpPacketMediaType::kForwardErrorCorrection:
Erik Språng78c82a42019-10-03 18:46:04 +020064 // Video has "normal" priority, in the old speak.
Erik Språngd05edec2019-08-14 10:43:47 +020065 // Send redundancy concurrently to video. If it is delayed it might have a
66 // lower chance of being useful.
Erik Språng78c82a42019-10-03 18:46:04 +020067 return kFirstPriority + 3;
Björn Terelius31d0f7c2020-02-06 16:35:46 +010068 case RtpPacketMediaType::kPadding:
Erik Språngd05edec2019-08-14 10:43:47 +020069 // Packets that are in themselves likely useless, only sent to keep the
70 // BWE high.
Erik Språng78c82a42019-10-03 18:46:04 +020071 return kFirstPriority + 4;
Erik Språngd05edec2019-08-14 10:43:47 +020072 }
73}
74
75} // namespace
76
77const TimeDelta PacingController::kMaxExpectedQueueLength =
Danil Chapovalov55284022020-02-07 14:53:52 +010078 TimeDelta::Millis(2000);
Erik Språngd05edec2019-08-14 10:43:47 +020079const float PacingController::kDefaultPaceMultiplier = 2.5f;
80const TimeDelta PacingController::kPausedProcessInterval =
81 kCongestedPacketInterval;
Danil Chapovalov55284022020-02-07 14:53:52 +010082const TimeDelta PacingController::kMinSleepTime = TimeDelta::Millis(1);
Erik Språngd05edec2019-08-14 10:43:47 +020083
84PacingController::PacingController(Clock* clock,
85 PacketSender* packet_sender,
86 RtcEventLog* event_log,
Erik Språngeb487992019-11-14 14:15:15 +010087 const WebRtcKeyValueConfig* field_trials,
88 ProcessMode mode)
89 : mode_(mode),
90 clock_(clock),
Erik Språngd05edec2019-08-14 10:43:47 +020091 packet_sender_(packet_sender),
92 fallback_field_trials_(
Mirko Bonadei317a1f02019-09-17 17:06:18 +020093 !field_trials ? std::make_unique<FieldTrialBasedConfig>() : nullptr),
Erik Språngd05edec2019-08-14 10:43:47 +020094 field_trials_(field_trials ? field_trials : fallback_field_trials_.get()),
95 drain_large_queues_(
96 !IsDisabled(*field_trials_, "WebRTC-Pacer-DrainQueue")),
97 send_padding_if_silent_(
98 IsEnabled(*field_trials_, "WebRTC-Pacer-PadInSilence")),
Evan Shrubsole6ef59d12020-01-08 16:45:08 +010099 pace_audio_(IsEnabled(*field_trials_, "WebRTC-Pacer-BlockAudio")),
Erik Språng78c82a42019-10-03 18:46:04 +0200100 small_first_probe_packet_(
101 IsEnabled(*field_trials_, "WebRTC-Pacer-SmallFirstProbePacket")),
Mirko Bonadeie7bc3a32020-01-29 18:45:00 +0000102 ignore_transport_overhead_(
Sebastian Janssonbef818d2020-01-30 14:09:48 +0100103 IsEnabled(*field_trials_, "WebRTC-Pacer-IgnoreTransportOverhead")),
Erik Språngd05edec2019-08-14 10:43:47 +0200104 min_packet_limit_(kDefaultMinPacketLimit),
Mirko Bonadeie7bc3a32020-01-29 18:45:00 +0000105 transport_overhead_per_packet_(DataSize::Zero()),
Erik Språngd05edec2019-08-14 10:43:47 +0200106 last_timestamp_(clock_->CurrentTime()),
107 paused_(false),
108 media_budget_(0),
109 padding_budget_(0),
Erik Språngeb487992019-11-14 14:15:15 +0100110 media_debt_(DataSize::Zero()),
111 padding_debt_(DataSize::Zero()),
112 media_rate_(DataRate::Zero()),
113 padding_rate_(DataRate::Zero()),
Erik Språngd05edec2019-08-14 10:43:47 +0200114 prober_(*field_trials_),
115 probing_send_failure_(false),
Erik Språngd05edec2019-08-14 10:43:47 +0200116 pacing_bitrate_(DataRate::Zero()),
Erik Språngeb487992019-11-14 14:15:15 +0100117 last_process_time_(clock->CurrentTime()),
118 last_send_time_(last_process_time_),
Erik Språngdca14492019-11-19 18:14:30 +0100119 packet_queue_(last_process_time_, field_trials_),
Erik Språngd05edec2019-08-14 10:43:47 +0200120 packet_counter_(0),
121 congestion_window_size_(DataSize::PlusInfinity()),
122 outstanding_data_(DataSize::Zero()),
123 queue_time_limit(kMaxExpectedQueueLength),
Sebastian Janssonc3eb9fd2020-01-29 17:42:52 +0100124 account_for_audio_(false),
125 include_overhead_(false) {
Erik Språngd05edec2019-08-14 10:43:47 +0200126 if (!drain_large_queues_) {
127 RTC_LOG(LS_WARNING) << "Pacer queues will not be drained,"
128 "pushback experiment must be enabled.";
129 }
130 FieldTrialParameter<int> min_packet_limit_ms("", min_packet_limit_.ms());
131 ParseFieldTrial({&min_packet_limit_ms},
132 field_trials_->Lookup("WebRTC-Pacer-MinPacketLimitMs"));
Danil Chapovalov55284022020-02-07 14:53:52 +0100133 min_packet_limit_ = TimeDelta::Millis(min_packet_limit_ms.Get());
Erik Språngd05edec2019-08-14 10:43:47 +0200134 UpdateBudgetWithElapsedTime(min_packet_limit_);
135}
136
137PacingController::~PacingController() = default;
138
139void PacingController::CreateProbeCluster(DataRate bitrate, int cluster_id) {
Erik Språngb210eeb2019-11-05 11:21:48 +0100140 prober_.CreateProbeCluster(bitrate, CurrentTime(), cluster_id);
Erik Språngd05edec2019-08-14 10:43:47 +0200141}
142
143void PacingController::Pause() {
144 if (!paused_)
145 RTC_LOG(LS_INFO) << "PacedSender paused.";
146 paused_ = true;
147 packet_queue_.SetPauseState(true, CurrentTime());
148}
149
150void PacingController::Resume() {
151 if (paused_)
152 RTC_LOG(LS_INFO) << "PacedSender resumed.";
153 paused_ = false;
154 packet_queue_.SetPauseState(false, CurrentTime());
155}
156
157bool PacingController::IsPaused() const {
158 return paused_;
159}
160
161void PacingController::SetCongestionWindow(DataSize congestion_window_size) {
Erik Språngeb487992019-11-14 14:15:15 +0100162 const bool was_congested = Congested();
Erik Språngd05edec2019-08-14 10:43:47 +0200163 congestion_window_size_ = congestion_window_size;
Erik Språngeb487992019-11-14 14:15:15 +0100164 if (was_congested && !Congested()) {
165 TimeDelta elapsed_time = UpdateTimeAndGetElapsed(CurrentTime());
166 UpdateBudgetWithElapsedTime(elapsed_time);
167 }
Erik Språngd05edec2019-08-14 10:43:47 +0200168}
169
170void PacingController::UpdateOutstandingData(DataSize outstanding_data) {
Erik Språngeb487992019-11-14 14:15:15 +0100171 const bool was_congested = Congested();
Erik Språngd05edec2019-08-14 10:43:47 +0200172 outstanding_data_ = outstanding_data;
Erik Språngeb487992019-11-14 14:15:15 +0100173 if (was_congested && !Congested()) {
174 TimeDelta elapsed_time = UpdateTimeAndGetElapsed(CurrentTime());
175 UpdateBudgetWithElapsedTime(elapsed_time);
176 }
Erik Språngd05edec2019-08-14 10:43:47 +0200177}
178
179bool PacingController::Congested() const {
180 if (congestion_window_size_.IsFinite()) {
181 return outstanding_data_ >= congestion_window_size_;
182 }
183 return false;
184}
185
186Timestamp PacingController::CurrentTime() const {
187 Timestamp time = clock_->CurrentTime();
188 if (time < last_timestamp_) {
189 RTC_LOG(LS_WARNING)
190 << "Non-monotonic clock behavior observed. Previous timestamp: "
191 << last_timestamp_.ms() << ", new timestamp: " << time.ms();
192 RTC_DCHECK_GE(time, last_timestamp_);
193 time = last_timestamp_;
194 }
195 last_timestamp_ = time;
196 return time;
197}
198
199void PacingController::SetProbingEnabled(bool enabled) {
200 RTC_CHECK_EQ(0, packet_counter_);
201 prober_.SetEnabled(enabled);
202}
203
204void PacingController::SetPacingRates(DataRate pacing_rate,
205 DataRate padding_rate) {
206 RTC_DCHECK_GT(pacing_rate, DataRate::Zero());
Erik Språngeb487992019-11-14 14:15:15 +0100207 media_rate_ = pacing_rate;
208 padding_rate_ = padding_rate;
Erik Språngd05edec2019-08-14 10:43:47 +0200209 pacing_bitrate_ = pacing_rate;
210 padding_budget_.set_target_rate_kbps(padding_rate.kbps());
211
212 RTC_LOG(LS_VERBOSE) << "bwe:pacer_updated pacing_kbps="
213 << pacing_bitrate_.kbps()
214 << " padding_budget_kbps=" << padding_rate.kbps();
215}
216
Erik Språngd05edec2019-08-14 10:43:47 +0200217void PacingController::EnqueuePacket(std::unique_ptr<RtpPacketToSend> packet) {
218 RTC_DCHECK(pacing_bitrate_ > DataRate::Zero())
219 << "SetPacingRate must be called before InsertPacket.";
Erik Språngd05edec2019-08-14 10:43:47 +0200220 RTC_CHECK(packet->packet_type());
Erik Språng78c82a42019-10-03 18:46:04 +0200221 // Get priority first and store in temporary, to avoid chance of object being
222 // moved before GetPriorityForType() being called.
223 const int priority = GetPriorityForType(*packet->packet_type());
224 EnqueuePacketInternal(std::move(packet), priority);
Erik Språngd05edec2019-08-14 10:43:47 +0200225}
226
227void PacingController::SetAccountForAudioPackets(bool account_for_audio) {
228 account_for_audio_ = account_for_audio;
229}
230
Sebastian Janssonc3eb9fd2020-01-29 17:42:52 +0100231void PacingController::SetIncludeOverhead() {
232 include_overhead_ = true;
233 packet_queue_.SetIncludeOverhead();
234}
235
Mirko Bonadeie7bc3a32020-01-29 18:45:00 +0000236void PacingController::SetTransportOverhead(DataSize overhead_per_packet) {
237 if (ignore_transport_overhead_)
238 return;
239 transport_overhead_per_packet_ = overhead_per_packet;
240 packet_queue_.SetTransportOverhead(overhead_per_packet);
241}
242
Erik Språngd05edec2019-08-14 10:43:47 +0200243TimeDelta PacingController::ExpectedQueueTime() const {
244 RTC_DCHECK_GT(pacing_bitrate_, DataRate::Zero());
Danil Chapovalov55284022020-02-07 14:53:52 +0100245 return TimeDelta::Millis(
Erik Språngd05edec2019-08-14 10:43:47 +0200246 (QueueSizeData().bytes() * 8 * rtc::kNumMillisecsPerSec) /
247 pacing_bitrate_.bps());
248}
249
250size_t PacingController::QueueSizePackets() const {
251 return packet_queue_.SizeInPackets();
252}
253
254DataSize PacingController::QueueSizeData() const {
255 return packet_queue_.Size();
256}
257
Erik Språng4314a492019-11-26 17:48:49 +0100258DataSize PacingController::CurrentBufferLevel() const {
259 return std::max(media_debt_, padding_debt_);
260}
261
Erik Språngd05edec2019-08-14 10:43:47 +0200262absl::optional<Timestamp> PacingController::FirstSentPacketTime() const {
263 return first_sent_packet_time_;
264}
265
266TimeDelta PacingController::OldestPacketWaitTime() const {
267 Timestamp oldest_packet = packet_queue_.OldestEnqueueTime();
268 if (oldest_packet.IsInfinite()) {
269 return TimeDelta::Zero();
270 }
271
272 return CurrentTime() - oldest_packet;
273}
274
Erik Språng78c82a42019-10-03 18:46:04 +0200275void PacingController::EnqueuePacketInternal(
276 std::unique_ptr<RtpPacketToSend> packet,
277 int priority) {
Erik Språng78c82a42019-10-03 18:46:04 +0200278 prober_.OnIncomingPacket(packet->payload_size());
279
280 // TODO(sprang): Make sure tests respect this, replace with DCHECK.
Erik Språngb210eeb2019-11-05 11:21:48 +0100281 Timestamp now = CurrentTime();
Erik Språng78c82a42019-10-03 18:46:04 +0200282 if (packet->capture_time_ms() < 0) {
283 packet->set_capture_time_ms(now.ms());
284 }
285
Erik Språngeb487992019-11-14 14:15:15 +0100286 if (mode_ == ProcessMode::kDynamic && packet_queue_.Empty() &&
287 media_debt_ == DataSize::Zero()) {
288 last_process_time_ = CurrentTime();
289 }
Erik Språng78c82a42019-10-03 18:46:04 +0200290 packet_queue_.Push(priority, now, packet_counter_++, std::move(packet));
291}
292
Erik Språngd05edec2019-08-14 10:43:47 +0200293TimeDelta PacingController::UpdateTimeAndGetElapsed(Timestamp now) {
Erik Språngeb487992019-11-14 14:15:15 +0100294 if (last_process_time_.IsMinusInfinity()) {
295 return TimeDelta::Zero();
296 }
Erik Språngb1ccae22019-11-25 18:22:09 +0100297 RTC_DCHECK_GE(now, last_process_time_);
Erik Språngeb487992019-11-14 14:15:15 +0100298 TimeDelta elapsed_time = now - last_process_time_;
299 last_process_time_ = now;
Erik Språngd05edec2019-08-14 10:43:47 +0200300 if (elapsed_time > kMaxElapsedTime) {
301 RTC_LOG(LS_WARNING) << "Elapsed time (" << elapsed_time.ms()
302 << " ms) longer than expected, limiting to "
303 << kMaxElapsedTime.ms();
304 elapsed_time = kMaxElapsedTime;
305 }
306 return elapsed_time;
307}
308
309bool PacingController::ShouldSendKeepalive(Timestamp now) const {
Erik Språngeb487992019-11-14 14:15:15 +0100310 if (send_padding_if_silent_ || paused_ || Congested() ||
311 packet_counter_ == 0) {
Erik Språngd05edec2019-08-14 10:43:47 +0200312 // We send a padding packet every 500 ms to ensure we won't get stuck in
313 // congested state due to no feedback being received.
314 TimeDelta elapsed_since_last_send = now - last_send_time_;
315 if (elapsed_since_last_send >= kCongestedPacketInterval) {
Erik Språngeb487992019-11-14 14:15:15 +0100316 return true;
Erik Språngd05edec2019-08-14 10:43:47 +0200317 }
318 }
319 return false;
320}
321
Erik Språngeb487992019-11-14 14:15:15 +0100322Timestamp PacingController::NextSendTime() const {
Erik Språngb210eeb2019-11-05 11:21:48 +0100323 Timestamp now = CurrentTime();
Erik Språngeb487992019-11-14 14:15:15 +0100324
Erik Språngae100292019-12-17 17:49:49 +0100325 if (paused_) {
326 return last_send_time_ + kPausedProcessInterval;
327 }
328
Erik Språngeb487992019-11-14 14:15:15 +0100329 // If probing is active, that always takes priority.
330 if (prober_.IsProbing()) {
331 Timestamp probe_time = prober_.NextProbeTime(now);
332 // |probe_time| == PlusInfinity indicates no probe scheduled.
333 if (probe_time != Timestamp::PlusInfinity() && !probing_send_failure_) {
334 return probe_time;
335 }
Erik Språngd05edec2019-08-14 10:43:47 +0200336 }
337
Erik Språngeb487992019-11-14 14:15:15 +0100338 if (mode_ == ProcessMode::kPeriodic) {
Erik Språngae100292019-12-17 17:49:49 +0100339 // In periodic non-probing mode, we just have a fixed interval.
Erik Språngeb487992019-11-14 14:15:15 +0100340 return last_process_time_ + min_packet_limit_;
Erik Språngb210eeb2019-11-05 11:21:48 +0100341 }
342
Erik Språngeb487992019-11-14 14:15:15 +0100343 // In dynamic mode, figure out when the next packet should be sent,
344 // given the current conditions.
Erik Språngd05edec2019-08-14 10:43:47 +0200345
Erik Språngeb487992019-11-14 14:15:15 +0100346 if (Congested() || packet_counter_ == 0) {
347 // If congested, we only send keep-alive or audio (if audio is
348 // configured in pass-through mode).
349 if (!pace_audio_ && packet_queue_.NextPacketIsAudio()) {
350 return now;
351 }
352
353 // We need to at least send keep-alive packets with some interval.
354 return last_send_time_ + kCongestedPacketInterval;
355 }
356
Erik Språngb1ccae22019-11-25 18:22:09 +0100357 // Check how long until media buffer has drained. We schedule a call
358 // for when the last packet in the queue drains as otherwise we may
359 // be late in starting padding.
360 if (media_rate_ > DataRate::Zero() &&
361 (!packet_queue_.Empty() || !media_debt_.IsZero())) {
Erik Språngeb487992019-11-14 14:15:15 +0100362 return std::min(last_send_time_ + kPausedProcessInterval,
363 last_process_time_ + media_debt_ / media_rate_);
364 }
365
366 // If we _don't_ have pending packets, check how long until we have
367 // bandwidth for padding packets.
368 if (padding_rate_ > DataRate::Zero() && packet_queue_.Empty()) {
369 return std::min(last_send_time_ + kPausedProcessInterval,
370 last_process_time_ + padding_debt_ / padding_rate_);
371 }
372
Erik Språngb1ccae22019-11-25 18:22:09 +0100373 if (send_padding_if_silent_) {
374 return last_send_time_ + kPausedProcessInterval;
375 }
376 return last_process_time_ + kPausedProcessInterval;
Erik Språngd05edec2019-08-14 10:43:47 +0200377}
378
379void PacingController::ProcessPackets() {
380 Timestamp now = CurrentTime();
Erik Språngeb487992019-11-14 14:15:15 +0100381 Timestamp target_send_time = now;
382 if (mode_ == ProcessMode::kDynamic) {
383 target_send_time = NextSendTime();
384 if (target_send_time.IsMinusInfinity()) {
385 target_send_time = now;
Erik Språngb1ccae22019-11-25 18:22:09 +0100386 } else if (now < target_send_time) {
Erik Språngeb487992019-11-14 14:15:15 +0100387 // We are too early, abort and regroup!
388 return;
Erik Språngd05edec2019-08-14 10:43:47 +0200389 }
Erik Språngb1ccae22019-11-25 18:22:09 +0100390
391 if (target_send_time < last_process_time_) {
392 // After the last process call, at time X, the target send time
393 // shifted to be earlier than X. This should normally not happen
394 // but we want to make sure rounding errors or erratic behavior
395 // of NextSendTime() does not cause issue. In particular, if the
396 // buffer reduction of
397 // rate * (target_send_time - previous_process_time)
398 // in the main loop doesn't clean up the existing debt we may not
399 // be able to send again. We don't want to check this reordering
400 // there as it is the normal exit condtion when the buffer is
401 // exhausted and there are packets in the queue.
402 UpdateBudgetWithElapsedTime(last_process_time_ - target_send_time);
403 target_send_time = last_process_time_;
404 }
Erik Språngd05edec2019-08-14 10:43:47 +0200405 }
406
Erik Språngeb487992019-11-14 14:15:15 +0100407 Timestamp previous_process_time = last_process_time_;
408 TimeDelta elapsed_time = UpdateTimeAndGetElapsed(now);
409
410 if (ShouldSendKeepalive(now)) {
411 // We can not send padding unless a normal packet has first been sent. If
412 // we do, timestamps get messed up.
413 if (packet_counter_ == 0) {
414 last_send_time_ = now;
415 } else {
416 DataSize keepalive_data_sent = DataSize::Zero();
417 std::vector<std::unique_ptr<RtpPacketToSend>> keepalive_packets =
Danil Chapovalovcad3e0e2020-02-17 18:46:07 +0100418 packet_sender_->GeneratePadding(DataSize::Bytes(1));
Erik Språngeb487992019-11-14 14:15:15 +0100419 for (auto& packet : keepalive_packets) {
420 keepalive_data_sent +=
Danil Chapovalovcad3e0e2020-02-17 18:46:07 +0100421 DataSize::Bytes(packet->payload_size() + packet->padding_size());
Erik Språngeb487992019-11-14 14:15:15 +0100422 packet_sender_->SendRtpPacket(std::move(packet), PacedPacketInfo());
423 }
424 OnPaddingSent(keepalive_data_sent);
425 }
426 }
427
428 if (paused_) {
Erik Språngd05edec2019-08-14 10:43:47 +0200429 return;
Erik Språngeb487992019-11-14 14:15:15 +0100430 }
Erik Språngd05edec2019-08-14 10:43:47 +0200431
432 if (elapsed_time > TimeDelta::Zero()) {
433 DataRate target_rate = pacing_bitrate_;
434 DataSize queue_size_data = packet_queue_.Size();
435 if (queue_size_data > DataSize::Zero()) {
436 // Assuming equal size packets and input/output rate, the average packet
437 // has avg_time_left_ms left to get queue_size_bytes out of the queue, if
438 // time constraint shall be met. Determine bitrate needed for that.
Erik Språngeb487992019-11-14 14:15:15 +0100439 packet_queue_.UpdateQueueTime(now);
Erik Språngd05edec2019-08-14 10:43:47 +0200440 if (drain_large_queues_) {
441 TimeDelta avg_time_left =
Danil Chapovalov55284022020-02-07 14:53:52 +0100442 std::max(TimeDelta::Millis(1),
Erik Språngd05edec2019-08-14 10:43:47 +0200443 queue_time_limit - packet_queue_.AverageQueueTime());
444 DataRate min_rate_needed = queue_size_data / avg_time_left;
445 if (min_rate_needed > target_rate) {
446 target_rate = min_rate_needed;
447 RTC_LOG(LS_VERBOSE) << "bwe:large_pacing_queue pacing_rate_kbps="
448 << target_rate.kbps();
449 }
450 }
451 }
452
Erik Språngeb487992019-11-14 14:15:15 +0100453 if (mode_ == ProcessMode::kPeriodic) {
454 // In periodic processing mode, the IntevalBudget allows positive budget
455 // up to (process interval duration) * (target rate), so we only need to
456 // update it once before the packet sending loop.
457 media_budget_.set_target_rate_kbps(target_rate.kbps());
458 UpdateBudgetWithElapsedTime(elapsed_time);
459 } else {
460 media_rate_ = target_rate;
461 }
Erik Språngd05edec2019-08-14 10:43:47 +0200462 }
463
Erik Språng78c82a42019-10-03 18:46:04 +0200464 bool first_packet_in_probe = false;
Erik Språngd05edec2019-08-14 10:43:47 +0200465 bool is_probing = prober_.IsProbing();
466 PacedPacketInfo pacing_info;
467 absl::optional<DataSize> recommended_probe_size;
468 if (is_probing) {
469 pacing_info = prober_.CurrentCluster();
Erik Språng78c82a42019-10-03 18:46:04 +0200470 first_packet_in_probe = pacing_info.probe_cluster_bytes_sent == 0;
Danil Chapovalovcad3e0e2020-02-17 18:46:07 +0100471 recommended_probe_size = DataSize::Bytes(prober_.RecommendedMinProbeSize());
Erik Språngd05edec2019-08-14 10:43:47 +0200472 }
473
474 DataSize data_sent = DataSize::Zero();
Erik Språngeb487992019-11-14 14:15:15 +0100475
Erik Språngd05edec2019-08-14 10:43:47 +0200476 // The paused state is checked in the loop since it leaves the critical
477 // section allowing the paused state to be changed from other code.
478 while (!paused_) {
Erik Språng78c82a42019-10-03 18:46:04 +0200479 if (small_first_probe_packet_ && first_packet_in_probe) {
480 // If first packet in probe, insert a small padding packet so we have a
481 // more reliable start window for the rate estimation.
Danil Chapovalovcad3e0e2020-02-17 18:46:07 +0100482 auto padding = packet_sender_->GeneratePadding(DataSize::Bytes(1));
Erik Språng78c82a42019-10-03 18:46:04 +0200483 // If no RTP modules sending media are registered, we may not get a
484 // padding packet back.
485 if (!padding.empty()) {
486 // Insert with high priority so larger media packets don't preempt it.
487 EnqueuePacketInternal(std::move(padding[0]), kFirstPriority);
488 // We should never get more than one padding packets with a requested
489 // size of 1 byte.
490 RTC_DCHECK_EQ(padding.size(), 1u);
491 }
492 first_packet_in_probe = false;
493 }
494
Erik Språngeb487992019-11-14 14:15:15 +0100495 if (mode_ == ProcessMode::kDynamic &&
496 previous_process_time < target_send_time) {
497 // Reduce buffer levels with amount corresponding to time between last
498 // process and target send time for the next packet.
499 // If the process call is late, that may be the time between the optimal
500 // send times for two packets we should already have sent.
501 UpdateBudgetWithElapsedTime(target_send_time - previous_process_time);
502 previous_process_time = target_send_time;
503 }
504
505 // Fetch the next packet, so long as queue is not empty or budget is not
506 // exhausted.
Erik Språngb0df5932019-11-18 13:40:24 +0100507 std::unique_ptr<RtpPacketToSend> rtp_packet =
508 GetPendingPacket(pacing_info, target_send_time, now);
509
510 if (rtp_packet == nullptr) {
Erik Språngd05edec2019-08-14 10:43:47 +0200511 // No packet available to send, check if we should send padding.
Erik Språngf5815fa2019-08-21 14:27:31 +0200512 DataSize padding_to_add = PaddingToAdd(recommended_probe_size, data_sent);
513 if (padding_to_add > DataSize::Zero()) {
514 std::vector<std::unique_ptr<RtpPacketToSend>> padding_packets =
515 packet_sender_->GeneratePadding(padding_to_add);
516 if (padding_packets.empty()) {
517 // No padding packets were generated, quite send loop.
518 break;
Erik Språngd05edec2019-08-14 10:43:47 +0200519 }
Erik Språngf5815fa2019-08-21 14:27:31 +0200520 for (auto& packet : padding_packets) {
521 EnqueuePacket(std::move(packet));
522 }
523 // Continue loop to send the padding that was just added.
524 continue;
Erik Språngd05edec2019-08-14 10:43:47 +0200525 }
526
527 // Can't fetch new packet and no padding to send, exit send loop.
528 break;
529 }
530
Erik Språngf5815fa2019-08-21 14:27:31 +0200531 RTC_DCHECK(rtp_packet);
Erik Språngb0df5932019-11-18 13:40:24 +0100532 RTC_DCHECK(rtp_packet->packet_type().has_value());
Björn Terelius31d0f7c2020-02-06 16:35:46 +0100533 const RtpPacketMediaType packet_type = *rtp_packet->packet_type();
Danil Chapovalovcad3e0e2020-02-17 18:46:07 +0100534 DataSize packet_size = DataSize::Bytes(rtp_packet->payload_size() +
Mirko Bonadeie7bc3a32020-01-29 18:45:00 +0000535 rtp_packet->padding_size());
536
537 if (include_overhead_) {
Danil Chapovalovcad3e0e2020-02-17 18:46:07 +0100538 packet_size += DataSize::Bytes(rtp_packet->headers_size()) +
Mirko Bonadeie7bc3a32020-01-29 18:45:00 +0000539 transport_overhead_per_packet_;
540 }
Erik Språngf5815fa2019-08-21 14:27:31 +0200541 packet_sender_->SendRtpPacket(std::move(rtp_packet), pacing_info);
Erik Språngd05edec2019-08-14 10:43:47 +0200542
Erik Språngb0df5932019-11-18 13:40:24 +0100543 data_sent += packet_size;
544
545 // Send done, update send/process time to the target send time.
546 OnPacketSent(packet_type, packet_size, target_send_time);
Erik Språngf5815fa2019-08-21 14:27:31 +0200547 if (recommended_probe_size && data_sent > *recommended_probe_size)
Erik Språngd05edec2019-08-14 10:43:47 +0200548 break;
Erik Språngeb487992019-11-14 14:15:15 +0100549
550 if (mode_ == ProcessMode::kDynamic) {
551 // Update target send time in case that are more packets that we are late
552 // in processing.
553 Timestamp next_send_time = NextSendTime();
554 if (next_send_time.IsMinusInfinity()) {
555 target_send_time = now;
556 } else {
557 target_send_time = std::min(now, next_send_time);
558 }
559 }
Erik Språngd05edec2019-08-14 10:43:47 +0200560 }
561
562 if (is_probing) {
563 probing_send_failure_ = data_sent == DataSize::Zero();
564 if (!probing_send_failure_) {
Erik Språngb210eeb2019-11-05 11:21:48 +0100565 prober_.ProbeSent(CurrentTime(), data_sent.bytes());
Erik Språngd05edec2019-08-14 10:43:47 +0200566 }
567 }
568}
569
570DataSize PacingController::PaddingToAdd(
571 absl::optional<DataSize> recommended_probe_size,
Erik Språngeb487992019-11-14 14:15:15 +0100572 DataSize data_sent) const {
Erik Språngd05edec2019-08-14 10:43:47 +0200573 if (!packet_queue_.Empty()) {
574 // Actual payload available, no need to add padding.
575 return DataSize::Zero();
576 }
577
578 if (Congested()) {
579 // Don't add padding if congested, even if requested for probing.
580 return DataSize::Zero();
581 }
582
583 if (packet_counter_ == 0) {
584 // We can not send padding unless a normal packet has first been sent. If we
585 // do, timestamps get messed up.
586 return DataSize::Zero();
587 }
588
589 if (recommended_probe_size) {
590 if (*recommended_probe_size > data_sent) {
591 return *recommended_probe_size - data_sent;
592 }
593 return DataSize::Zero();
594 }
595
Erik Språngeb487992019-11-14 14:15:15 +0100596 if (mode_ == ProcessMode::kPeriodic) {
Danil Chapovalovcad3e0e2020-02-17 18:46:07 +0100597 return DataSize::Bytes(padding_budget_.bytes_remaining());
Erik Språngeb487992019-11-14 14:15:15 +0100598 } else if (padding_rate_ > DataRate::Zero() &&
599 padding_debt_ == DataSize::Zero()) {
600 return kDefaultPaddingTarget;
601 }
602 return DataSize::Zero();
Erik Språngd05edec2019-08-14 10:43:47 +0200603}
604
Erik Språngb0df5932019-11-18 13:40:24 +0100605std::unique_ptr<RtpPacketToSend> PacingController::GetPendingPacket(
Erik Språngeb487992019-11-14 14:15:15 +0100606 const PacedPacketInfo& pacing_info,
607 Timestamp target_send_time,
608 Timestamp now) {
Erik Språngf660e812019-09-01 12:26:44 +0000609 if (packet_queue_.Empty()) {
610 return nullptr;
611 }
612
Erik Språngeb487992019-11-14 14:15:15 +0100613 // First, check if there is any reason _not_ to send the next queued packet.
614
615 // Unpaced audio packets and probes are exempted from send checks.
616 bool unpaced_audio_packet = !pace_audio_ && packet_queue_.NextPacketIsAudio();
617 bool is_probe = pacing_info.probe_cluster_id != PacedPacketInfo::kNotAProbe;
618 if (!unpaced_audio_packet && !is_probe) {
619 if (Congested()) {
Evan Shrubsole6ef59d12020-01-08 16:45:08 +0100620 // Don't send anything if congested.
Erik Språngeb487992019-11-14 14:15:15 +0100621 return nullptr;
622 }
623
624 if (mode_ == ProcessMode::kPeriodic) {
625 if (media_budget_.bytes_remaining() <= 0) {
626 // Not enough budget.
627 return nullptr;
628 }
629 } else {
Erik Språngb1ccae22019-11-25 18:22:09 +0100630 // Dynamic processing mode.
Erik Språngeb487992019-11-14 14:15:15 +0100631 if (now <= target_send_time) {
632 // We allow sending slightly early if we think that we would actually
633 // had been able to, had we been right on time - i.e. the current debt
634 // is not more than would be reduced to zero at the target sent time.
635 TimeDelta flush_time = media_debt_ / media_rate_;
636 if (now + flush_time > target_send_time) {
637 return nullptr;
638 }
Erik Språngeb487992019-11-14 14:15:15 +0100639 }
640 }
Erik Språngf660e812019-09-01 12:26:44 +0000641 }
Erik Språngeb487992019-11-14 14:15:15 +0100642
Erik Språng4995f872019-11-21 18:34:38 +0100643 return packet_queue_.Pop();
Erik Språngf660e812019-09-01 12:26:44 +0000644}
645
Björn Terelius31d0f7c2020-02-06 16:35:46 +0100646void PacingController::OnPacketSent(RtpPacketMediaType packet_type,
Erik Språngb0df5932019-11-18 13:40:24 +0100647 DataSize packet_size,
Erik Språngeb487992019-11-14 14:15:15 +0100648 Timestamp send_time) {
Erik Språngf660e812019-09-01 12:26:44 +0000649 if (!first_sent_packet_time_) {
Erik Språngeb487992019-11-14 14:15:15 +0100650 first_sent_packet_time_ = send_time;
Erik Språngf660e812019-09-01 12:26:44 +0000651 }
Björn Terelius31d0f7c2020-02-06 16:35:46 +0100652 bool audio_packet = packet_type == RtpPacketMediaType::kAudio;
Erik Språngf660e812019-09-01 12:26:44 +0000653 if (!audio_packet || account_for_audio_) {
654 // Update media bytes sent.
Erik Språngb0df5932019-11-18 13:40:24 +0100655 UpdateBudgetWithSentData(packet_size);
Erik Språngf660e812019-09-01 12:26:44 +0000656 }
Erik Språngeb487992019-11-14 14:15:15 +0100657 last_send_time_ = send_time;
658 last_process_time_ = send_time;
Erik Språngf660e812019-09-01 12:26:44 +0000659}
660
Erik Språngd05edec2019-08-14 10:43:47 +0200661void PacingController::OnPaddingSent(DataSize data_sent) {
662 if (data_sent > DataSize::Zero()) {
663 UpdateBudgetWithSentData(data_sent);
Erik Språngd05edec2019-08-14 10:43:47 +0200664 }
665 last_send_time_ = CurrentTime();
Erik Språngeb487992019-11-14 14:15:15 +0100666 last_process_time_ = CurrentTime();
Erik Språngd05edec2019-08-14 10:43:47 +0200667}
668
669void PacingController::UpdateBudgetWithElapsedTime(TimeDelta delta) {
Erik Språngeb487992019-11-14 14:15:15 +0100670 if (mode_ == ProcessMode::kPeriodic) {
671 delta = std::min(kMaxProcessingInterval, delta);
672 media_budget_.IncreaseBudget(delta.ms());
673 padding_budget_.IncreaseBudget(delta.ms());
674 } else {
675 media_debt_ -= std::min(media_debt_, media_rate_ * delta);
676 padding_debt_ -= std::min(padding_debt_, padding_rate_ * delta);
677 }
Erik Språngd05edec2019-08-14 10:43:47 +0200678}
679
680void PacingController::UpdateBudgetWithSentData(DataSize size) {
681 outstanding_data_ += size;
Erik Språngeb487992019-11-14 14:15:15 +0100682 if (mode_ == ProcessMode::kPeriodic) {
683 media_budget_.UseBudget(size.bytes());
684 padding_budget_.UseBudget(size.bytes());
685 } else {
686 media_debt_ += size;
687 media_debt_ = std::min(media_debt_, media_rate_ * kMaxDebtInTime);
688 padding_debt_ += size;
689 padding_debt_ = std::min(padding_debt_, padding_rate_ * kMaxDebtInTime);
690 }
Erik Språngd05edec2019-08-14 10:43:47 +0200691}
692
693void PacingController::SetQueueTimeLimit(TimeDelta limit) {
694 queue_time_limit = limit;
695}
696
697} // namespace webrtc