blob: b17cc944f6f46c25c535c03853219c8b11226f60 [file] [log] [blame]
philipelbe7a9e52016-05-19 12:19:35 +02001/*
2 * Copyright (c) 2016 The WebRTC project authors. All Rights Reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020011#include "modules/video_coding/frame_buffer2.h"
philipelbe7a9e52016-05-19 12:19:35 +020012
13#include <algorithm>
Yves Gerey3e707812018-11-28 16:47:49 +010014#include <cstdlib>
15#include <iterator>
Evan Shrubsole0072c212021-11-10 11:41:14 +010016#include <memory>
philipele0b2f152016-09-28 10:23:49 +020017#include <queue>
Yves Gerey3e707812018-11-28 16:47:49 +010018#include <utility>
philipel798b2822018-06-11 13:10:14 +020019#include <vector>
philipelbe7a9e52016-05-19 12:19:35 +020020
Evan Shrubsolef83d4262021-12-15 15:05:15 +010021#include "absl/container/inlined_vector.h"
Yves Gerey3e707812018-11-28 16:47:49 +010022#include "api/video/encoded_image.h"
23#include "api/video/video_timing.h"
Evan Shrubsolef83d4262021-12-15 15:05:15 +010024#include "modules/video_coding/frame_helpers.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020025#include "modules/video_coding/include/video_coding_defines.h"
26#include "modules/video_coding/jitter_estimator.h"
27#include "modules/video_coding/timing.h"
28#include "rtc_base/checks.h"
Yves Gerey3e707812018-11-28 16:47:49 +010029#include "rtc_base/experiments/rtt_mult_experiment.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020030#include "rtc_base/logging.h"
Yves Gerey3e707812018-11-28 16:47:49 +010031#include "rtc_base/numerics/sequence_number_util.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020032#include "rtc_base/trace_event.h"
33#include "system_wrappers/include/clock.h"
philipel707f2782017-10-02 14:10:28 +020034#include "system_wrappers/include/field_trial.h"
philipelbe7a9e52016-05-19 12:19:35 +020035
36namespace webrtc {
37namespace video_coding {
38
39namespace {
philipele0b2f152016-09-28 10:23:49 +020040// Max number of frames the buffer will hold.
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +010041constexpr size_t kMaxFramesBuffered = 800;
philipelbe7a9e52016-05-19 12:19:35 +020042
Johannes Kron23bfff32021-09-28 21:31:46 +020043// Default value for the maximum decode queue size that is used when the
44// low-latency renderer is used.
45constexpr size_t kZeroPlayoutDelayDefaultMaxDecodeQueueSize = 8;
46
philipele0b2f152016-09-28 10:23:49 +020047// Max number of decoded frame info that will be saved.
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +010048constexpr int kMaxFramesHistory = 1 << 13;
philipel65e1f942017-07-24 08:26:53 -070049
Ilya Nikolaevskiy8c4fe162018-02-27 15:49:47 +010050// The time it's allowed for a frame to be late to its rendering prediction and
51// still be rendered.
Ilya Nikolaevskiy7eef0072018-02-28 09:59:26 +010052constexpr int kMaxAllowedFrameDelayMs = 5;
Ilya Nikolaevskiy8c4fe162018-02-27 15:49:47 +010053
philipel65e1f942017-07-24 08:26:53 -070054constexpr int64_t kLogNonDecodedIntervalMs = 5000;
philipelbe7a9e52016-05-19 12:19:35 +020055} // namespace
56
philipelbe7a9e52016-05-19 12:19:35 +020057FrameBuffer::FrameBuffer(Clock* clock,
philipela45102f2017-02-22 05:30:39 -080058 VCMTiming* timing,
59 VCMReceiveStatisticsCallback* stats_callback)
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +010060 : decoded_frames_history_(kMaxFramesHistory),
61 clock_(clock),
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +020062 callback_queue_(nullptr),
Niels Möllerd9c2d942019-04-30 09:16:36 +020063 jitter_estimator_(clock),
philipelbe7a9e52016-05-19 12:19:35 +020064 timing_(timing),
philipel4f6cd6a2016-08-03 10:59:32 +020065 inter_frame_delay_(clock_->TimeInMilliseconds()),
philipel29f730e2017-03-15 08:10:08 -070066 stopped_(false),
philipela45102f2017-02-22 05:30:39 -080067 protection_mode_(kProtectionNack),
philipel65e1f942017-07-24 08:26:53 -070068 stats_callback_(stats_callback),
Elad Alone4b50232019-01-14 18:56:14 +010069 last_log_non_decoded_ms_(-kLogNonDecodedIntervalMs),
Johannes Kron2ddc39e2021-08-10 16:56:12 +020070 rtt_mult_settings_(RttMultExperiment::GetRttMultValue()),
Johannes Kron23bfff32021-09-28 21:31:46 +020071 zero_playout_delay_max_decode_queue_size_(
72 "max_decode_queue_size",
73 kZeroPlayoutDelayDefaultMaxDecodeQueueSize) {
Johannes Kron2ddc39e2021-08-10 16:56:12 +020074 ParseFieldTrial({&zero_playout_delay_max_decode_queue_size_},
75 field_trial::FindFullName("WebRTC-ZeroPlayoutDelay"));
Tommi430951a2020-05-19 23:27:29 +020076 callback_checker_.Detach();
77}
philipel266f0a42016-11-28 08:49:07 -080078
Tommi430951a2020-05-19 23:27:29 +020079FrameBuffer::~FrameBuffer() {
80 RTC_DCHECK_RUN_ON(&construction_checker_);
81}
philipelbe7a9e52016-05-19 12:19:35 +020082
Evan Shrubsole3d29efd2021-12-07 14:11:45 +010083void FrameBuffer::NextFrame(int64_t max_wait_time_ms,
84 bool keyframe_required,
85 rtc::TaskQueue* callback_queue,
86 NextFrameCallback handler) {
Tommi430951a2020-05-19 23:27:29 +020087 RTC_DCHECK_RUN_ON(&callback_checker_);
88 RTC_DCHECK(callback_queue->IsCurrent());
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +020089 TRACE_EVENT0("webrtc", "FrameBuffer::NextFrame");
90 int64_t latest_return_time_ms =
91 clock_->TimeInMilliseconds() + max_wait_time_ms;
Tommi430951a2020-05-19 23:27:29 +020092
Markus Handell6deec382020-07-07 12:17:12 +020093 MutexLock lock(&mutex_);
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +020094 if (stopped_) {
95 return;
96 }
97 latest_return_time_ms_ = latest_return_time_ms;
98 keyframe_required_ = keyframe_required;
99 frame_handler_ = handler;
100 callback_queue_ = callback_queue;
101 StartWaitForNextFrameOnQueue();
102}
103
104void FrameBuffer::StartWaitForNextFrameOnQueue() {
105 RTC_DCHECK(callback_queue_);
106 RTC_DCHECK(!callback_task_.Running());
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100107 int64_t wait_ms = FindNextFrame(clock_->CurrentTime());
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200108 callback_task_ = RepeatingTaskHandle::DelayedStart(
Henrik Boström4c72f992022-01-25 08:15:50 +0100109 callback_queue_->Get(), TimeDelta::Millis(wait_ms),
110 [this] {
Tommi430951a2020-05-19 23:27:29 +0200111 RTC_DCHECK_RUN_ON(&callback_checker_);
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200112 // If this task has not been cancelled, we did not get any new frames
113 // while waiting. Continue with frame delivery.
Markus Handell334b1fd2020-12-14 00:08:11 +0100114 std::unique_ptr<EncodedFrame> frame;
Evan Shrubsole3d29efd2021-12-07 14:11:45 +0100115 NextFrameCallback frame_handler;
Markus Handell334b1fd2020-12-14 00:08:11 +0100116 {
117 MutexLock lock(&mutex_);
118 if (!frames_to_decode_.empty()) {
119 // We have frames, deliver!
Evan Shrubsole0072c212021-11-10 11:41:14 +0100120 frame = GetNextFrame();
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100121 timing_->SetLastDecodeScheduledTimestamp(clock_->CurrentTime());
Markus Handell334b1fd2020-12-14 00:08:11 +0100122 } else if (clock_->TimeInMilliseconds() < latest_return_time_ms_) {
123 // If there's no frames to decode and there is still time left, it
124 // means that the frame buffer was cleared between creation and
125 // execution of this task. Continue waiting for the remaining time.
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100126 int64_t wait_ms = FindNextFrame(clock_->CurrentTime());
Markus Handell334b1fd2020-12-14 00:08:11 +0100127 return TimeDelta::Millis(wait_ms);
128 }
129 frame_handler = std::move(frame_handler_);
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200130 CancelCallback();
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200131 }
Markus Handell334b1fd2020-12-14 00:08:11 +0100132 // Deliver frame, if any. Otherwise signal timeout.
Evan Shrubsole3d29efd2021-12-07 14:11:45 +0100133 frame_handler(std::move(frame));
Markus Handell334b1fd2020-12-14 00:08:11 +0100134 return TimeDelta::Zero(); // Ignored.
Henrik Boström4c72f992022-01-25 08:15:50 +0100135 },
136 TaskQueueBase::DelayPrecision::kHigh);
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200137}
138
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100139int64_t FrameBuffer::FindNextFrame(Timestamp now) {
140 int64_t wait_ms = latest_return_time_ms_ - now.ms();
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200141 frames_to_decode_.clear();
142
Artem Titovdcd7fc72021-08-09 13:02:57 +0200143 // `last_continuous_frame_` may be empty below, but nullopt is smaller
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200144 // than everything else and loop will immediately terminate as expected.
145 for (auto frame_it = frames_.begin();
146 frame_it != frames_.end() && frame_it->first <= last_continuous_frame_;
147 ++frame_it) {
148 if (!frame_it->second.continuous ||
149 frame_it->second.num_missing_decodable > 0) {
150 continue;
151 }
152
153 EncodedFrame* frame = frame_it->second.frame.get();
154
155 if (keyframe_required_ && !frame->is_keyframe())
156 continue;
157
158 auto last_decoded_frame_timestamp =
159 decoded_frames_history_.GetLastDecodedFrameTimestamp();
160
161 // TODO(https://bugs.webrtc.org/9974): consider removing this check
162 // as it may make a stream undecodable after a very long delay between
163 // frames.
164 if (last_decoded_frame_timestamp &&
165 AheadOf(*last_decoded_frame_timestamp, frame->Timestamp())) {
166 continue;
167 }
168
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200169 // Gather all remaining frames for the same superframe.
170 std::vector<FrameMap::iterator> current_superframe;
171 current_superframe.push_back(frame_it);
172 bool last_layer_completed = frame_it->second.frame->is_last_spatial_layer;
173 FrameMap::iterator next_frame_it = frame_it;
philipela65d7852020-11-20 17:49:24 +0100174 while (!last_layer_completed) {
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200175 ++next_frame_it;
philipela65d7852020-11-20 17:49:24 +0100176
177 if (next_frame_it == frames_.end() || !next_frame_it->second.frame) {
178 break;
179 }
180
181 if (next_frame_it->second.frame->Timestamp() != frame->Timestamp() ||
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200182 !next_frame_it->second.continuous) {
183 break;
184 }
philipela65d7852020-11-20 17:49:24 +0100185
186 if (next_frame_it->second.num_missing_decodable > 0) {
philipelcb327d92020-12-10 10:49:20 +0100187 bool has_inter_layer_dependency = false;
188 for (size_t i = 0; i < EncodedFrame::kMaxFrameReferences &&
philipela65d7852020-11-20 17:49:24 +0100189 i < next_frame_it->second.frame->num_references;
190 ++i) {
philipel9aa9b8d2021-02-15 13:31:29 +0100191 if (next_frame_it->second.frame->references[i] >= frame_it->first) {
philipela65d7852020-11-20 17:49:24 +0100192 has_inter_layer_dependency = true;
philipelcb327d92020-12-10 10:49:20 +0100193 break;
philipela65d7852020-11-20 17:49:24 +0100194 }
195 }
196
197 // If the frame has an undecoded dependency that is not within the same
philipelcb327d92020-12-10 10:49:20 +0100198 // temporal unit then this frame is not yet ready to be decoded. If it
philipela65d7852020-11-20 17:49:24 +0100199 // is within the same temporal unit then the not yet decoded dependency
200 // is just a lower spatial frame, which is ok.
201 if (!has_inter_layer_dependency ||
202 next_frame_it->second.num_missing_decodable > 1) {
203 break;
204 }
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200205 }
philipela65d7852020-11-20 17:49:24 +0100206
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200207 current_superframe.push_back(next_frame_it);
208 last_layer_completed = next_frame_it->second.frame->is_last_spatial_layer;
209 }
210 // Check if the current superframe is complete.
211 // TODO(bugs.webrtc.org/10064): consider returning all available to
212 // decode frames even if the superframe is not complete yet.
213 if (!last_layer_completed) {
214 continue;
215 }
216
217 frames_to_decode_ = std::move(current_superframe);
218
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100219 absl::optional<Timestamp> render_time = frame->RenderTimestamp();
220 if (!render_time) {
221 render_time = timing_->RenderTime(frame->Timestamp(), now);
222 frame->SetRenderTime(render_time->ms());
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200223 }
Johannes Kron2ddc39e2021-08-10 16:56:12 +0200224 bool too_many_frames_queued =
225 frames_.size() > zero_playout_delay_max_decode_queue_size_ ? true
226 : false;
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100227 wait_ms =
228 timing_->MaxWaitingTime(*render_time, now, too_many_frames_queued).ms();
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200229
230 // This will cause the frame buffer to prefer high framerate rather
231 // than high resolution in the case of the decoder not decoding fast
232 // enough and the stream has multiple spatial and temporal layers.
233 // For multiple temporal layers it may cause non-base layer frames to be
234 // skipped if they are late.
235 if (wait_ms < -kMaxAllowedFrameDelayMs)
236 continue;
237
238 break;
239 }
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100240 wait_ms = std::min<int64_t>(wait_ms, latest_return_time_ms_ - now.ms());
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200241 wait_ms = std::max<int64_t>(wait_ms, 0);
242 return wait_ms;
243}
244
Evan Shrubsole0072c212021-11-10 11:41:14 +0100245std::unique_ptr<EncodedFrame> FrameBuffer::GetNextFrame() {
Tommi430951a2020-05-19 23:27:29 +0200246 RTC_DCHECK_RUN_ON(&callback_checker_);
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100247 Timestamp now = clock_->CurrentTime();
Artem Titovdcd7fc72021-08-09 13:02:57 +0200248 // TODO(ilnik): remove `frames_out` use frames_to_decode_ directly.
Evan Shrubsole0072c212021-11-10 11:41:14 +0100249 std::vector<std::unique_ptr<EncodedFrame>> frames_out;
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200250
251 RTC_DCHECK(!frames_to_decode_.empty());
252 bool superframe_delayed_by_retransmission = false;
253 size_t superframe_size = 0;
Evan Shrubsole5b9b9aa2021-11-01 10:28:31 +0100254 const EncodedFrame& first_frame = *frames_to_decode_[0]->second.frame;
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100255 absl::optional<Timestamp> render_time = first_frame.RenderTimestamp();
Evan Shrubsole5b9b9aa2021-11-01 10:28:31 +0100256 int64_t receive_time_ms = first_frame.ReceivedTime();
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200257 // Gracefully handle bad RTP timestamps and render time issues.
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100258 if (!render_time ||
259 FrameHasBadRenderTiming(*render_time, now, timing_->TargetVideoDelay())) {
Niels Möllerd9c2d942019-04-30 09:16:36 +0200260 jitter_estimator_.Reset();
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200261 timing_->Reset();
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100262 render_time = timing_->RenderTime(first_frame.Timestamp(), now);
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200263 }
264
265 for (FrameMap::iterator& frame_it : frames_to_decode_) {
266 RTC_DCHECK(frame_it != frames_.end());
Evan Shrubsole0072c212021-11-10 11:41:14 +0100267 std::unique_ptr<EncodedFrame> frame = std::move(frame_it->second.frame);
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200268
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100269 frame->SetRenderTime(render_time->ms());
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200270
271 superframe_delayed_by_retransmission |= frame->delayed_by_retransmission();
272 receive_time_ms = std::max(receive_time_ms, frame->ReceivedTime());
273 superframe_size += frame->size();
274
275 PropagateDecodability(frame_it->second);
276 decoded_frames_history_.InsertDecoded(frame_it->first, frame->Timestamp());
277
278 // Remove decoded frame and all undecoded frames before it.
Johannes Kron0c141c52019-08-26 15:04:43 +0200279 if (stats_callback_) {
philipel9aa9b8d2021-02-15 13:31:29 +0100280 unsigned int dropped_frames =
281 std::count_if(frames_.begin(), frame_it,
282 [](const std::pair<const int64_t, FrameInfo>& frame) {
283 return frame.second.frame != nullptr;
284 });
Johannes Kron0c141c52019-08-26 15:04:43 +0200285 if (dropped_frames > 0) {
286 stats_callback_->OnDroppedFrames(dropped_frames);
287 }
288 }
289
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200290 frames_.erase(frames_.begin(), ++frame_it);
291
Evan Shrubsole0072c212021-11-10 11:41:14 +0100292 frames_out.emplace_back(std::move(frame));
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200293 }
294
295 if (!superframe_delayed_by_retransmission) {
296 int64_t frame_delay;
297
Evan Shrubsole5b9b9aa2021-11-01 10:28:31 +0100298 if (inter_frame_delay_.CalculateDelay(first_frame.Timestamp(), &frame_delay,
299 receive_time_ms)) {
Niels Möllerd9c2d942019-04-30 09:16:36 +0200300 jitter_estimator_.UpdateEstimate(frame_delay, superframe_size);
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200301 }
302
303 float rtt_mult = protection_mode_ == kProtectionNackFEC ? 0.0 : 1.0;
“Michaeld3a4ebe2019-06-07 03:55:01 -0500304 absl::optional<float> rtt_mult_add_cap_ms = absl::nullopt;
305 if (rtt_mult_settings_.has_value()) {
306 rtt_mult = rtt_mult_settings_->rtt_mult_setting;
307 rtt_mult_add_cap_ms = rtt_mult_settings_->rtt_mult_add_cap_ms;
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200308 }
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100309 timing_->SetJitterDelay(TimeDelta::Millis(
310 jitter_estimator_.GetJitterEstimate(rtt_mult, rtt_mult_add_cap_ms)));
311 timing_->UpdateCurrentDelay(*render_time, now);
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200312 } else {
Evan Shrubsole9146d762021-10-13 11:19:48 +0200313 if (RttMultExperiment::RttMultEnabled())
Niels Möllerd9c2d942019-04-30 09:16:36 +0200314 jitter_estimator_.FrameNacked();
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200315 }
316
317 UpdateJitterDelay();
318 UpdateTimingFrameInfo();
319
320 if (frames_out.size() == 1) {
Evan Shrubsole0072c212021-11-10 11:41:14 +0100321 return std::move(frames_out[0]);
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200322 } else {
Evan Shrubsole0072c212021-11-10 11:41:14 +0100323 return CombineAndDeleteFrames(std::move(frames_out));
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200324 }
325}
326
philipel4f6cd6a2016-08-03 10:59:32 +0200327void FrameBuffer::SetProtectionMode(VCMVideoProtection mode) {
tommidb23ea62017-03-03 07:21:18 -0800328 TRACE_EVENT0("webrtc", "FrameBuffer::SetProtectionMode");
Markus Handell6deec382020-07-07 12:17:12 +0200329 MutexLock lock(&mutex_);
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000330 protection_mode_ = mode;
philipel4f6cd6a2016-08-03 10:59:32 +0200331}
332
philipel504c47d2016-06-30 17:33:02 +0200333void FrameBuffer::Stop() {
tommidb23ea62017-03-03 07:21:18 -0800334 TRACE_EVENT0("webrtc", "FrameBuffer::Stop");
Markus Handell6deec382020-07-07 12:17:12 +0200335 MutexLock lock(&mutex_);
Tommi430951a2020-05-19 23:27:29 +0200336 if (stopped_)
337 return;
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000338 stopped_ = true;
Tommi430951a2020-05-19 23:27:29 +0200339
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200340 CancelCallback();
philipel504c47d2016-06-30 17:33:02 +0200341}
342
Ilya Nikolaevskiye6a2d942018-11-07 14:32:28 +0100343void FrameBuffer::Clear() {
Markus Handell6deec382020-07-07 12:17:12 +0200344 MutexLock lock(&mutex_);
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000345 ClearFramesAndHistory();
Ilya Nikolaevskiye6a2d942018-11-07 14:32:28 +0100346}
347
Johannes Kron111e9812020-10-26 13:54:40 +0100348int FrameBuffer::Size() {
349 MutexLock lock(&mutex_);
350 return frames_.size();
351}
352
philipele21be1d2017-09-25 06:37:12 -0700353void FrameBuffer::UpdateRtt(int64_t rtt_ms) {
Markus Handell6deec382020-07-07 12:17:12 +0200354 MutexLock lock(&mutex_);
Niels Möllerd9c2d942019-04-30 09:16:36 +0200355 jitter_estimator_.UpdateRtt(rtt_ms);
philipele21be1d2017-09-25 06:37:12 -0700356}
357
philipele7c891f2018-02-22 14:35:06 +0100358bool FrameBuffer::ValidReferences(const EncodedFrame& frame) const {
philipel112adf92017-06-15 09:06:21 -0700359 for (size_t i = 0; i < frame.num_references; ++i) {
philipel9aa9b8d2021-02-15 13:31:29 +0100360 if (frame.references[i] >= frame.Id())
philipel112adf92017-06-15 09:06:21 -0700361 return false;
philipel3b3c9c42017-09-11 09:38:36 -0700362
philipel112adf92017-06-15 09:06:21 -0700363 for (size_t j = i + 1; j < frame.num_references; ++j) {
364 if (frame.references[i] == frame.references[j])
365 return false;
366 }
367 }
368
philipel112adf92017-06-15 09:06:21 -0700369 return true;
370}
371
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200372void FrameBuffer::CancelCallback() {
Tommi430951a2020-05-19 23:27:29 +0200373 // Called from the callback queue or from within Stop().
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200374 frame_handler_ = {};
375 callback_task_.Stop();
376 callback_queue_ = nullptr;
Tommi430951a2020-05-19 23:27:29 +0200377 callback_checker_.Detach();
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200378}
379
philipele7c891f2018-02-22 14:35:06 +0100380int64_t FrameBuffer::InsertFrame(std::unique_ptr<EncodedFrame> frame) {
tommidb23ea62017-03-03 07:21:18 -0800381 TRACE_EVENT0("webrtc", "FrameBuffer::InsertFrame");
philipel93e451b2016-10-06 12:25:13 +0200382 RTC_DCHECK(frame);
tommi0a735642017-03-14 06:23:57 -0700383
Markus Handell6deec382020-07-07 12:17:12 +0200384 MutexLock lock(&mutex_);
philipel29f730e2017-03-15 08:10:08 -0700385
philipel9aa9b8d2021-02-15 13:31:29 +0100386 int64_t last_continuous_frame_id = last_continuous_frame_.value_or(-1);
philipele0b2f152016-09-28 10:23:49 +0200387
philipel112adf92017-06-15 09:06:21 -0700388 if (!ValidReferences(*frame)) {
philipel9aa9b8d2021-02-15 13:31:29 +0100389 RTC_LOG(LS_WARNING) << "Frame " << frame->Id()
philipelf1091932021-02-11 15:25:08 +0100390 << " has invalid frame references, dropping frame.";
philipel9aa9b8d2021-02-15 13:31:29 +0100391 return last_continuous_frame_id;
philipel112adf92017-06-15 09:06:21 -0700392 }
393
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100394 if (frames_.size() >= kMaxFramesBuffered) {
philipel9771c502018-03-02 11:06:27 +0100395 if (frame->is_keyframe()) {
philipel9aa9b8d2021-02-15 13:31:29 +0100396 RTC_LOG(LS_WARNING) << "Inserting keyframe " << frame->Id()
philipelf1091932021-02-11 15:25:08 +0100397 << " but buffer is full, clearing"
Jonas Olssonb2b20312020-01-14 12:11:31 +0100398 " buffer and inserting the frame.";
philipel9771c502018-03-02 11:06:27 +0100399 ClearFramesAndHistory();
400 } else {
philipel9aa9b8d2021-02-15 13:31:29 +0100401 RTC_LOG(LS_WARNING) << "Frame " << frame->Id()
philipelf1091932021-02-11 15:25:08 +0100402 << " could not be inserted due to the frame "
Jonas Olssonb2b20312020-01-14 12:11:31 +0100403 "buffer being full, dropping frame.";
philipel9aa9b8d2021-02-15 13:31:29 +0100404 return last_continuous_frame_id;
philipel9771c502018-03-02 11:06:27 +0100405 }
philipele0b2f152016-09-28 10:23:49 +0200406 }
407
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100408 auto last_decoded_frame = decoded_frames_history_.GetLastDecodedFrameId();
409 auto last_decoded_frame_timestamp =
410 decoded_frames_history_.GetLastDecodedFrameTimestamp();
philipel9aa9b8d2021-02-15 13:31:29 +0100411 if (last_decoded_frame && frame->Id() <= *last_decoded_frame) {
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100412 if (AheadOf(frame->Timestamp(), *last_decoded_frame_timestamp) &&
philipel3042c2d2017-08-18 04:55:02 -0700413 frame->is_keyframe()) {
philipel9aa9b8d2021-02-15 13:31:29 +0100414 // If this frame has a newer timestamp but an earlier frame id then we
415 // assume there has been a jump in the frame id due to some encoder
philipelfcc60062017-01-18 05:35:20 -0800416 // reconfiguration or some other reason. Even though this is not according
417 // to spec we can still continue to decode from this frame if it is a
418 // keyframe.
Mirko Bonadei675513b2017-11-09 11:09:25 +0100419 RTC_LOG(LS_WARNING)
philipel9aa9b8d2021-02-15 13:31:29 +0100420 << "A jump in frame id was detected, clearing buffer.";
philipelfcc60062017-01-18 05:35:20 -0800421 ClearFramesAndHistory();
philipel9aa9b8d2021-02-15 13:31:29 +0100422 last_continuous_frame_id = -1;
philipelfcc60062017-01-18 05:35:20 -0800423 } else {
philipel9aa9b8d2021-02-15 13:31:29 +0100424 RTC_LOG(LS_WARNING) << "Frame " << frame->Id() << " inserted after frame "
425 << *last_decoded_frame
philipelf1091932021-02-11 15:25:08 +0100426 << " was handed off for decoding, dropping frame.";
philipel9aa9b8d2021-02-15 13:31:29 +0100427 return last_continuous_frame_id;
philipelfcc60062017-01-18 05:35:20 -0800428 }
philipele0b2f152016-09-28 10:23:49 +0200429 }
430
philipel146a48b2017-04-20 04:04:38 -0700431 // Test if inserting this frame would cause the order of the frames to become
432 // ambiguous (covering more than half the interval of 2^16). This can happen
philipel9aa9b8d2021-02-15 13:31:29 +0100433 // when the frame id make large jumps mid stream.
434 if (!frames_.empty() && frame->Id() < frames_.begin()->first &&
435 frames_.rbegin()->first < frame->Id()) {
436 RTC_LOG(LS_WARNING) << "A jump in frame id was detected, clearing buffer.";
philipel146a48b2017-04-20 04:04:38 -0700437 ClearFramesAndHistory();
philipel9aa9b8d2021-02-15 13:31:29 +0100438 last_continuous_frame_id = -1;
philipel146a48b2017-04-20 04:04:38 -0700439 }
440
philipel9aa9b8d2021-02-15 13:31:29 +0100441 auto info = frames_.emplace(frame->Id(), FrameInfo()).first;
philipele0b2f152016-09-28 10:23:49 +0200442
philipel93e451b2016-10-06 12:25:13 +0200443 if (info->second.frame) {
philipel9aa9b8d2021-02-15 13:31:29 +0100444 return last_continuous_frame_id;
philipele0b2f152016-09-28 10:23:49 +0200445 }
446
philipel93e451b2016-10-06 12:25:13 +0200447 if (!UpdateFrameInfoWithIncomingFrame(*frame, info))
philipel9aa9b8d2021-02-15 13:31:29 +0100448 return last_continuous_frame_id;
Ruslan Burakov493a6502019-02-27 15:32:48 +0100449
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100450 // If ReceiveTime is negative then it is not a valid timestamp.
451 if (!frame->delayed_by_retransmission() && frame->ReceivedTime() >= 0)
452 timing_->IncomingTimestamp(frame->Timestamp(),
453 Timestamp::Millis(frame->ReceivedTime()));
philipel0a9f6de2018-02-28 11:29:47 +0100454
philipel0cb73262020-12-08 17:36:53 +0100455 // It can happen that a frame will be reported as fully received even if a
456 // lower spatial layer frame is missing.
457 if (stats_callback_ && frame->is_last_spatial_layer) {
Johannes Kronb88b44e2019-08-22 13:16:44 +0200458 stats_callback_->OnCompleteFrame(frame->is_keyframe(), frame->size(),
459 frame->contentType());
460 }
461
philipele0b2f152016-09-28 10:23:49 +0200462 info->second.frame = std::move(frame);
philipele0b2f152016-09-28 10:23:49 +0200463
464 if (info->second.num_missing_continuous == 0) {
465 info->second.continuous = true;
466 PropagateContinuity(info);
philipel9aa9b8d2021-02-15 13:31:29 +0100467 last_continuous_frame_id = *last_continuous_frame_;
philipele0b2f152016-09-28 10:23:49 +0200468
469 // Since we now have new continuous frames there might be a better frame
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200470 // to return from NextFrame.
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200471 if (callback_queue_) {
472 callback_queue_->PostTask([this] {
Markus Handell6deec382020-07-07 12:17:12 +0200473 MutexLock lock(&mutex_);
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200474 if (!callback_task_.Running())
475 return;
476 RTC_CHECK(frame_handler_);
477 callback_task_.Stop();
478 StartWaitForNextFrameOnQueue();
479 });
480 }
philipele0b2f152016-09-28 10:23:49 +0200481 }
482
philipel9aa9b8d2021-02-15 13:31:29 +0100483 return last_continuous_frame_id;
philipelbe7a9e52016-05-19 12:19:35 +0200484}
485
philipele0b2f152016-09-28 10:23:49 +0200486void FrameBuffer::PropagateContinuity(FrameMap::iterator start) {
tommidb23ea62017-03-03 07:21:18 -0800487 TRACE_EVENT0("webrtc", "FrameBuffer::PropagateContinuity");
philipele0b2f152016-09-28 10:23:49 +0200488 RTC_DCHECK(start->second.continuous);
philipele0b2f152016-09-28 10:23:49 +0200489
490 std::queue<FrameMap::iterator> continuous_frames;
491 continuous_frames.push(start);
492
493 // A simple BFS to traverse continuous frames.
494 while (!continuous_frames.empty()) {
495 auto frame = continuous_frames.front();
496 continuous_frames.pop();
497
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100498 if (!last_continuous_frame_ || *last_continuous_frame_ < frame->first) {
499 last_continuous_frame_ = frame->first;
500 }
philipele0b2f152016-09-28 10:23:49 +0200501
502 // Loop through all dependent frames, and if that frame no longer has
503 // any unfulfilled dependencies then that frame is continuous as well.
Elad Alon69321dd2019-01-10 15:02:54 +0100504 for (size_t d = 0; d < frame->second.dependent_frames.size(); ++d) {
philipele0b2f152016-09-28 10:23:49 +0200505 auto frame_ref = frames_.find(frame->second.dependent_frames[d]);
philipel112adf92017-06-15 09:06:21 -0700506 RTC_DCHECK(frame_ref != frames_.end());
philipele0b2f152016-09-28 10:23:49 +0200507
philipel112adf92017-06-15 09:06:21 -0700508 // TODO(philipel): Look into why we've seen this happen.
509 if (frame_ref != frames_.end()) {
510 --frame_ref->second.num_missing_continuous;
511 if (frame_ref->second.num_missing_continuous == 0) {
512 frame_ref->second.continuous = true;
513 continuous_frames.push(frame_ref);
514 }
philipele0b2f152016-09-28 10:23:49 +0200515 }
516 }
517 }
518}
519
520void FrameBuffer::PropagateDecodability(const FrameInfo& info) {
tommidb23ea62017-03-03 07:21:18 -0800521 TRACE_EVENT0("webrtc", "FrameBuffer::PropagateDecodability");
Elad Alon69321dd2019-01-10 15:02:54 +0100522 for (size_t d = 0; d < info.dependent_frames.size(); ++d) {
philipele0b2f152016-09-28 10:23:49 +0200523 auto ref_info = frames_.find(info.dependent_frames[d]);
philipel93e451b2016-10-06 12:25:13 +0200524 RTC_DCHECK(ref_info != frames_.end());
tommie95b78b2017-05-14 07:23:11 -0700525 // TODO(philipel): Look into why we've seen this happen.
526 if (ref_info != frames_.end()) {
527 RTC_DCHECK_GT(ref_info->second.num_missing_decodable, 0U);
528 --ref_info->second.num_missing_decodable;
529 }
philipele0b2f152016-09-28 10:23:49 +0200530 }
531}
532
philipele7c891f2018-02-22 14:35:06 +0100533bool FrameBuffer::UpdateFrameInfoWithIncomingFrame(const EncodedFrame& frame,
philipele0b2f152016-09-28 10:23:49 +0200534 FrameMap::iterator info) {
tommidb23ea62017-03-03 07:21:18 -0800535 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateFrameInfoWithIncomingFrame");
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100536 auto last_decoded_frame = decoded_frames_history_.GetLastDecodedFrameId();
537 RTC_DCHECK(!last_decoded_frame || *last_decoded_frame < info->first);
philipele0b2f152016-09-28 10:23:49 +0200538
Artem Titovdcd7fc72021-08-09 13:02:57 +0200539 // In this function we determine how many missing dependencies this `frame`
540 // has to become continuous/decodable. If a frame that this `frame` depend
philipel798b2822018-06-11 13:10:14 +0200541 // on has already been decoded then we can ignore that dependency since it has
542 // already been fulfilled.
543 //
Artem Titovdcd7fc72021-08-09 13:02:57 +0200544 // For all other frames we will register a backwards reference to this `frame`
545 // so that `num_missing_continuous` and `num_missing_decodable` can be
philipel798b2822018-06-11 13:10:14 +0200546 // decremented as frames become continuous/are decoded.
547 struct Dependency {
philipel9aa9b8d2021-02-15 13:31:29 +0100548 int64_t frame_id;
philipel798b2822018-06-11 13:10:14 +0200549 bool continuous;
550 };
551 std::vector<Dependency> not_yet_fulfilled_dependencies;
552
553 // Find all dependencies that have not yet been fulfilled.
philipele0b2f152016-09-28 10:23:49 +0200554 for (size_t i = 0; i < frame.num_references; ++i) {
Artem Titovdcd7fc72021-08-09 13:02:57 +0200555 // Does `frame` depend on a frame earlier than the last decoded one?
philipel9aa9b8d2021-02-15 13:31:29 +0100556 if (last_decoded_frame && frame.references[i] <= *last_decoded_frame) {
Artem Titovdcd7fc72021-08-09 13:02:57 +0200557 // Was that frame decoded? If not, this `frame` will never become
philipel798b2822018-06-11 13:10:14 +0200558 // decodable.
philipel9aa9b8d2021-02-15 13:31:29 +0100559 if (!decoded_frames_history_.WasDecoded(frame.references[i])) {
philipel65e1f942017-07-24 08:26:53 -0700560 int64_t now_ms = clock_->TimeInMilliseconds();
561 if (last_log_non_decoded_ms_ + kLogNonDecodedIntervalMs < now_ms) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100562 RTC_LOG(LS_WARNING)
philipel9aa9b8d2021-02-15 13:31:29 +0100563 << "Frame " << frame.Id()
philipelf1091932021-02-11 15:25:08 +0100564 << " depends on a non-decoded frame more previous than the last "
565 "decoded frame, dropping frame.";
philipel65e1f942017-07-24 08:26:53 -0700566 last_log_non_decoded_ms_ = now_ms;
567 }
philipele0b2f152016-09-28 10:23:49 +0200568 return false;
569 }
philipele0b2f152016-09-28 10:23:49 +0200570 } else {
philipel9aa9b8d2021-02-15 13:31:29 +0100571 auto ref_info = frames_.find(frame.references[i]);
philipel798b2822018-06-11 13:10:14 +0200572 bool ref_continuous =
573 ref_info != frames_.end() && ref_info->second.continuous;
philipel9aa9b8d2021-02-15 13:31:29 +0100574 not_yet_fulfilled_dependencies.push_back(
575 {frame.references[i], ref_continuous});
philipele0b2f152016-09-28 10:23:49 +0200576 }
philipelbe7a9e52016-05-19 12:19:35 +0200577 }
578
philipel798b2822018-06-11 13:10:14 +0200579 info->second.num_missing_continuous = not_yet_fulfilled_dependencies.size();
580 info->second.num_missing_decodable = not_yet_fulfilled_dependencies.size();
581
582 for (const Dependency& dep : not_yet_fulfilled_dependencies) {
583 if (dep.continuous)
584 --info->second.num_missing_continuous;
585
philipel9aa9b8d2021-02-15 13:31:29 +0100586 frames_[dep.frame_id].dependent_frames.push_back(frame.Id());
philipel798b2822018-06-11 13:10:14 +0200587 }
philipel93e451b2016-10-06 12:25:13 +0200588
philipelbe7a9e52016-05-19 12:19:35 +0200589 return true;
590}
591
philipelbe742702016-11-30 01:31:40 -0800592void FrameBuffer::UpdateJitterDelay() {
tommidb23ea62017-03-03 07:21:18 -0800593 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateJitterDelay");
philipela45102f2017-02-22 05:30:39 -0800594 if (!stats_callback_)
595 return;
philipelbe742702016-11-30 01:31:40 -0800596
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100597 TimeDelta max_decode = TimeDelta::Zero();
598 TimeDelta current_delay = TimeDelta::Zero();
599 TimeDelta target_delay = TimeDelta::Zero();
600 TimeDelta jitter_buffer = TimeDelta::Zero();
601 TimeDelta min_playout_delay = TimeDelta::Zero();
602 TimeDelta render_delay = TimeDelta::Zero();
603 if (timing_->GetTimings(&max_decode, &current_delay, &target_delay,
604 &jitter_buffer, &min_playout_delay, &render_delay)) {
philipela45102f2017-02-22 05:30:39 -0800605 stats_callback_->OnFrameBufferTimingsUpdated(
Evan Shrubsoled6cdf802022-03-02 15:13:55 +0100606 max_decode.ms(), current_delay.ms(), target_delay.ms(),
607 jitter_buffer.ms(), min_playout_delay.ms(), render_delay.ms());
philipelbe742702016-11-30 01:31:40 -0800608 }
philipel266f0a42016-11-28 08:49:07 -0800609}
610
ilnik2edc6842017-07-06 03:06:50 -0700611void FrameBuffer::UpdateTimingFrameInfo() {
612 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateTimingFrameInfo");
Danil Chapovalov0040b662018-06-18 10:48:16 +0200613 absl::optional<TimingFrameInfo> info = timing_->GetTimingFrameInfo();
philipel97187112018-03-23 10:43:21 +0100614 if (info && stats_callback_)
ilnik2edc6842017-07-06 03:06:50 -0700615 stats_callback_->OnTimingFrameInfoUpdated(*info);
616}
617
philipelfcc60062017-01-18 05:35:20 -0800618void FrameBuffer::ClearFramesAndHistory() {
ilnik2edc6842017-07-06 03:06:50 -0700619 TRACE_EVENT0("webrtc", "FrameBuffer::ClearFramesAndHistory");
Johannes Kron0c141c52019-08-26 15:04:43 +0200620 if (stats_callback_) {
philipel9aa9b8d2021-02-15 13:31:29 +0100621 unsigned int dropped_frames =
622 std::count_if(frames_.begin(), frames_.end(),
623 [](const std::pair<const int64_t, FrameInfo>& frame) {
624 return frame.second.frame != nullptr;
625 });
Johannes Kron0c141c52019-08-26 15:04:43 +0200626 if (dropped_frames > 0) {
627 stats_callback_->OnDroppedFrames(dropped_frames);
628 }
629 }
philipelfcc60062017-01-18 05:35:20 -0800630 frames_.clear();
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100631 last_continuous_frame_.reset();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100632 frames_to_decode_.clear();
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100633 decoded_frames_history_.Clear();
philipelfcc60062017-01-18 05:35:20 -0800634}
635
Niels Möllerff2e2152019-09-27 10:29:30 +0200636// TODO(philipel): Avoid the concatenation of frames here, by replacing
637// NextFrame and GetNextFrame with methods returning multiple frames.
Evan Shrubsole0072c212021-11-10 11:41:14 +0100638std::unique_ptr<EncodedFrame> FrameBuffer::CombineAndDeleteFrames(
639 std::vector<std::unique_ptr<EncodedFrame>> frames) const {
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100640 RTC_DCHECK(!frames.empty());
Evan Shrubsolef83d4262021-12-15 15:05:15 +0100641 absl::InlinedVector<std::unique_ptr<EncodedFrame>, 4> inlined;
642 for (auto& frame : frames) {
643 inlined.push_back(std::move(frame));
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100644 }
Evan Shrubsolef83d4262021-12-15 15:05:15 +0100645 return webrtc::CombineAndDeleteFrames(std::move(inlined));
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100646}
647
Niels Möllerbe682d42018-03-27 08:31:45 +0200648FrameBuffer::FrameInfo::FrameInfo() = default;
649FrameBuffer::FrameInfo::FrameInfo(FrameInfo&&) = default;
650FrameBuffer::FrameInfo::~FrameInfo() = default;
651
philipelbe7a9e52016-05-19 12:19:35 +0200652} // namespace video_coding
653} // namespace webrtc