blob: b15db96364f4df18d9aa50b3416aa9c2923882a0 [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());
107 int64_t wait_ms = FindNextFrame(clock_->TimeInMilliseconds());
108 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();
Rezaul Barbhuiya82c22482021-08-05 17:54:11 -0700121 timing_->SetLastDecodeScheduledTimestamp(
122 clock_->TimeInMilliseconds());
Markus Handell334b1fd2020-12-14 00:08:11 +0100123 } else if (clock_->TimeInMilliseconds() < latest_return_time_ms_) {
124 // If there's no frames to decode and there is still time left, it
125 // means that the frame buffer was cleared between creation and
126 // execution of this task. Continue waiting for the remaining time.
127 int64_t wait_ms = FindNextFrame(clock_->TimeInMilliseconds());
128 return TimeDelta::Millis(wait_ms);
129 }
130 frame_handler = std::move(frame_handler_);
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200131 CancelCallback();
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200132 }
Markus Handell334b1fd2020-12-14 00:08:11 +0100133 // Deliver frame, if any. Otherwise signal timeout.
Evan Shrubsole3d29efd2021-12-07 14:11:45 +0100134 frame_handler(std::move(frame));
Markus Handell334b1fd2020-12-14 00:08:11 +0100135 return TimeDelta::Zero(); // Ignored.
Henrik Boström4c72f992022-01-25 08:15:50 +0100136 },
137 TaskQueueBase::DelayPrecision::kHigh);
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200138}
139
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200140int64_t FrameBuffer::FindNextFrame(int64_t now_ms) {
141 int64_t wait_ms = latest_return_time_ms_ - now_ms;
142 frames_to_decode_.clear();
143
Artem Titovdcd7fc72021-08-09 13:02:57 +0200144 // `last_continuous_frame_` may be empty below, but nullopt is smaller
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200145 // than everything else and loop will immediately terminate as expected.
146 for (auto frame_it = frames_.begin();
147 frame_it != frames_.end() && frame_it->first <= last_continuous_frame_;
148 ++frame_it) {
149 if (!frame_it->second.continuous ||
150 frame_it->second.num_missing_decodable > 0) {
151 continue;
152 }
153
154 EncodedFrame* frame = frame_it->second.frame.get();
155
156 if (keyframe_required_ && !frame->is_keyframe())
157 continue;
158
159 auto last_decoded_frame_timestamp =
160 decoded_frames_history_.GetLastDecodedFrameTimestamp();
161
162 // TODO(https://bugs.webrtc.org/9974): consider removing this check
163 // as it may make a stream undecodable after a very long delay between
164 // frames.
165 if (last_decoded_frame_timestamp &&
166 AheadOf(*last_decoded_frame_timestamp, frame->Timestamp())) {
167 continue;
168 }
169
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200170 // Gather all remaining frames for the same superframe.
171 std::vector<FrameMap::iterator> current_superframe;
172 current_superframe.push_back(frame_it);
173 bool last_layer_completed = frame_it->second.frame->is_last_spatial_layer;
174 FrameMap::iterator next_frame_it = frame_it;
philipela65d7852020-11-20 17:49:24 +0100175 while (!last_layer_completed) {
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200176 ++next_frame_it;
philipela65d7852020-11-20 17:49:24 +0100177
178 if (next_frame_it == frames_.end() || !next_frame_it->second.frame) {
179 break;
180 }
181
182 if (next_frame_it->second.frame->Timestamp() != frame->Timestamp() ||
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200183 !next_frame_it->second.continuous) {
184 break;
185 }
philipela65d7852020-11-20 17:49:24 +0100186
187 if (next_frame_it->second.num_missing_decodable > 0) {
philipelcb327d92020-12-10 10:49:20 +0100188 bool has_inter_layer_dependency = false;
189 for (size_t i = 0; i < EncodedFrame::kMaxFrameReferences &&
philipela65d7852020-11-20 17:49:24 +0100190 i < next_frame_it->second.frame->num_references;
191 ++i) {
philipel9aa9b8d2021-02-15 13:31:29 +0100192 if (next_frame_it->second.frame->references[i] >= frame_it->first) {
philipela65d7852020-11-20 17:49:24 +0100193 has_inter_layer_dependency = true;
philipelcb327d92020-12-10 10:49:20 +0100194 break;
philipela65d7852020-11-20 17:49:24 +0100195 }
196 }
197
198 // If the frame has an undecoded dependency that is not within the same
philipelcb327d92020-12-10 10:49:20 +0100199 // temporal unit then this frame is not yet ready to be decoded. If it
philipela65d7852020-11-20 17:49:24 +0100200 // is within the same temporal unit then the not yet decoded dependency
201 // is just a lower spatial frame, which is ok.
202 if (!has_inter_layer_dependency ||
203 next_frame_it->second.num_missing_decodable > 1) {
204 break;
205 }
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200206 }
philipela65d7852020-11-20 17:49:24 +0100207
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200208 current_superframe.push_back(next_frame_it);
209 last_layer_completed = next_frame_it->second.frame->is_last_spatial_layer;
210 }
211 // Check if the current superframe is complete.
212 // TODO(bugs.webrtc.org/10064): consider returning all available to
213 // decode frames even if the superframe is not complete yet.
214 if (!last_layer_completed) {
215 continue;
216 }
217
218 frames_to_decode_ = std::move(current_superframe);
219
220 if (frame->RenderTime() == -1) {
221 frame->SetRenderTime(timing_->RenderTimeMs(frame->Timestamp(), now_ms));
222 }
Johannes Kron2ddc39e2021-08-10 16:56:12 +0200223 bool too_many_frames_queued =
224 frames_.size() > zero_playout_delay_max_decode_queue_size_ ? true
225 : false;
226 wait_ms = timing_->MaxWaitingTime(frame->RenderTime(), now_ms,
227 too_many_frames_queued);
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200228
229 // This will cause the frame buffer to prefer high framerate rather
230 // than high resolution in the case of the decoder not decoding fast
231 // enough and the stream has multiple spatial and temporal layers.
232 // For multiple temporal layers it may cause non-base layer frames to be
233 // skipped if they are late.
234 if (wait_ms < -kMaxAllowedFrameDelayMs)
235 continue;
236
237 break;
238 }
239 wait_ms = std::min<int64_t>(wait_ms, latest_return_time_ms_ - now_ms);
240 wait_ms = std::max<int64_t>(wait_ms, 0);
241 return wait_ms;
242}
243
Evan Shrubsole0072c212021-11-10 11:41:14 +0100244std::unique_ptr<EncodedFrame> FrameBuffer::GetNextFrame() {
Tommi430951a2020-05-19 23:27:29 +0200245 RTC_DCHECK_RUN_ON(&callback_checker_);
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200246 int64_t now_ms = clock_->TimeInMilliseconds();
Artem Titovdcd7fc72021-08-09 13:02:57 +0200247 // TODO(ilnik): remove `frames_out` use frames_to_decode_ directly.
Evan Shrubsole0072c212021-11-10 11:41:14 +0100248 std::vector<std::unique_ptr<EncodedFrame>> frames_out;
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200249
250 RTC_DCHECK(!frames_to_decode_.empty());
251 bool superframe_delayed_by_retransmission = false;
252 size_t superframe_size = 0;
Evan Shrubsole5b9b9aa2021-11-01 10:28:31 +0100253 const EncodedFrame& first_frame = *frames_to_decode_[0]->second.frame;
254 int64_t render_time_ms = first_frame.RenderTime();
255 int64_t receive_time_ms = first_frame.ReceivedTime();
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200256 // Gracefully handle bad RTP timestamps and render time issues.
Evan Shrubsolef83d4262021-12-15 15:05:15 +0100257 if (FrameHasBadRenderTiming(first_frame.RenderTimeMs(), now_ms,
258 timing_->TargetVideoDelay())) {
Niels Möllerd9c2d942019-04-30 09:16:36 +0200259 jitter_estimator_.Reset();
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200260 timing_->Reset();
Evan Shrubsole5b9b9aa2021-11-01 10:28:31 +0100261 render_time_ms = timing_->RenderTimeMs(first_frame.Timestamp(), now_ms);
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200262 }
263
264 for (FrameMap::iterator& frame_it : frames_to_decode_) {
265 RTC_DCHECK(frame_it != frames_.end());
Evan Shrubsole0072c212021-11-10 11:41:14 +0100266 std::unique_ptr<EncodedFrame> frame = std::move(frame_it->second.frame);
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200267
268 frame->SetRenderTime(render_time_ms);
269
270 superframe_delayed_by_retransmission |= frame->delayed_by_retransmission();
271 receive_time_ms = std::max(receive_time_ms, frame->ReceivedTime());
272 superframe_size += frame->size();
273
274 PropagateDecodability(frame_it->second);
275 decoded_frames_history_.InsertDecoded(frame_it->first, frame->Timestamp());
276
277 // Remove decoded frame and all undecoded frames before it.
Johannes Kron0c141c52019-08-26 15:04:43 +0200278 if (stats_callback_) {
philipel9aa9b8d2021-02-15 13:31:29 +0100279 unsigned int dropped_frames =
280 std::count_if(frames_.begin(), frame_it,
281 [](const std::pair<const int64_t, FrameInfo>& frame) {
282 return frame.second.frame != nullptr;
283 });
Johannes Kron0c141c52019-08-26 15:04:43 +0200284 if (dropped_frames > 0) {
285 stats_callback_->OnDroppedFrames(dropped_frames);
286 }
287 }
288
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200289 frames_.erase(frames_.begin(), ++frame_it);
290
Evan Shrubsole0072c212021-11-10 11:41:14 +0100291 frames_out.emplace_back(std::move(frame));
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200292 }
293
294 if (!superframe_delayed_by_retransmission) {
295 int64_t frame_delay;
296
Evan Shrubsole5b9b9aa2021-11-01 10:28:31 +0100297 if (inter_frame_delay_.CalculateDelay(first_frame.Timestamp(), &frame_delay,
298 receive_time_ms)) {
Niels Möllerd9c2d942019-04-30 09:16:36 +0200299 jitter_estimator_.UpdateEstimate(frame_delay, superframe_size);
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200300 }
301
302 float rtt_mult = protection_mode_ == kProtectionNackFEC ? 0.0 : 1.0;
“Michaeld3a4ebe2019-06-07 03:55:01 -0500303 absl::optional<float> rtt_mult_add_cap_ms = absl::nullopt;
304 if (rtt_mult_settings_.has_value()) {
305 rtt_mult = rtt_mult_settings_->rtt_mult_setting;
306 rtt_mult_add_cap_ms = rtt_mult_settings_->rtt_mult_add_cap_ms;
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200307 }
“Michaele0f37042019-06-04 10:04:12 -0500308 timing_->SetJitterDelay(
309 jitter_estimator_.GetJitterEstimate(rtt_mult, rtt_mult_add_cap_ms));
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200310 timing_->UpdateCurrentDelay(render_time_ms, now_ms);
311 } else {
Evan Shrubsole9146d762021-10-13 11:19:48 +0200312 if (RttMultExperiment::RttMultEnabled())
Niels Möllerd9c2d942019-04-30 09:16:36 +0200313 jitter_estimator_.FrameNacked();
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200314 }
315
316 UpdateJitterDelay();
317 UpdateTimingFrameInfo();
318
319 if (frames_out.size() == 1) {
Evan Shrubsole0072c212021-11-10 11:41:14 +0100320 return std::move(frames_out[0]);
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200321 } else {
Evan Shrubsole0072c212021-11-10 11:41:14 +0100322 return CombineAndDeleteFrames(std::move(frames_out));
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200323 }
324}
325
philipel4f6cd6a2016-08-03 10:59:32 +0200326void FrameBuffer::SetProtectionMode(VCMVideoProtection mode) {
tommidb23ea62017-03-03 07:21:18 -0800327 TRACE_EVENT0("webrtc", "FrameBuffer::SetProtectionMode");
Markus Handell6deec382020-07-07 12:17:12 +0200328 MutexLock lock(&mutex_);
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000329 protection_mode_ = mode;
philipel4f6cd6a2016-08-03 10:59:32 +0200330}
331
philipel504c47d2016-06-30 17:33:02 +0200332void FrameBuffer::Stop() {
tommidb23ea62017-03-03 07:21:18 -0800333 TRACE_EVENT0("webrtc", "FrameBuffer::Stop");
Markus Handell6deec382020-07-07 12:17:12 +0200334 MutexLock lock(&mutex_);
Tommi430951a2020-05-19 23:27:29 +0200335 if (stopped_)
336 return;
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000337 stopped_ = true;
Tommi430951a2020-05-19 23:27:29 +0200338
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200339 CancelCallback();
philipel504c47d2016-06-30 17:33:02 +0200340}
341
Ilya Nikolaevskiye6a2d942018-11-07 14:32:28 +0100342void FrameBuffer::Clear() {
Markus Handell6deec382020-07-07 12:17:12 +0200343 MutexLock lock(&mutex_);
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000344 ClearFramesAndHistory();
Ilya Nikolaevskiye6a2d942018-11-07 14:32:28 +0100345}
346
Johannes Kron111e9812020-10-26 13:54:40 +0100347int FrameBuffer::Size() {
348 MutexLock lock(&mutex_);
349 return frames_.size();
350}
351
philipele21be1d2017-09-25 06:37:12 -0700352void FrameBuffer::UpdateRtt(int64_t rtt_ms) {
Markus Handell6deec382020-07-07 12:17:12 +0200353 MutexLock lock(&mutex_);
Niels Möllerd9c2d942019-04-30 09:16:36 +0200354 jitter_estimator_.UpdateRtt(rtt_ms);
philipele21be1d2017-09-25 06:37:12 -0700355}
356
philipele7c891f2018-02-22 14:35:06 +0100357bool FrameBuffer::ValidReferences(const EncodedFrame& frame) const {
philipel112adf92017-06-15 09:06:21 -0700358 for (size_t i = 0; i < frame.num_references; ++i) {
philipel9aa9b8d2021-02-15 13:31:29 +0100359 if (frame.references[i] >= frame.Id())
philipel112adf92017-06-15 09:06:21 -0700360 return false;
philipel3b3c9c42017-09-11 09:38:36 -0700361
philipel112adf92017-06-15 09:06:21 -0700362 for (size_t j = i + 1; j < frame.num_references; ++j) {
363 if (frame.references[i] == frame.references[j])
364 return false;
365 }
366 }
367
philipel112adf92017-06-15 09:06:21 -0700368 return true;
369}
370
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200371void FrameBuffer::CancelCallback() {
Tommi430951a2020-05-19 23:27:29 +0200372 // Called from the callback queue or from within Stop().
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200373 frame_handler_ = {};
374 callback_task_.Stop();
375 callback_queue_ = nullptr;
Tommi430951a2020-05-19 23:27:29 +0200376 callback_checker_.Detach();
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200377}
378
philipele7c891f2018-02-22 14:35:06 +0100379int64_t FrameBuffer::InsertFrame(std::unique_ptr<EncodedFrame> frame) {
tommidb23ea62017-03-03 07:21:18 -0800380 TRACE_EVENT0("webrtc", "FrameBuffer::InsertFrame");
philipel93e451b2016-10-06 12:25:13 +0200381 RTC_DCHECK(frame);
tommi0a735642017-03-14 06:23:57 -0700382
Markus Handell6deec382020-07-07 12:17:12 +0200383 MutexLock lock(&mutex_);
philipel29f730e2017-03-15 08:10:08 -0700384
philipel9aa9b8d2021-02-15 13:31:29 +0100385 int64_t last_continuous_frame_id = last_continuous_frame_.value_or(-1);
philipele0b2f152016-09-28 10:23:49 +0200386
philipel112adf92017-06-15 09:06:21 -0700387 if (!ValidReferences(*frame)) {
philipel9aa9b8d2021-02-15 13:31:29 +0100388 RTC_LOG(LS_WARNING) << "Frame " << frame->Id()
philipelf1091932021-02-11 15:25:08 +0100389 << " has invalid frame references, dropping frame.";
philipel9aa9b8d2021-02-15 13:31:29 +0100390 return last_continuous_frame_id;
philipel112adf92017-06-15 09:06:21 -0700391 }
392
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100393 if (frames_.size() >= kMaxFramesBuffered) {
philipel9771c502018-03-02 11:06:27 +0100394 if (frame->is_keyframe()) {
philipel9aa9b8d2021-02-15 13:31:29 +0100395 RTC_LOG(LS_WARNING) << "Inserting keyframe " << frame->Id()
philipelf1091932021-02-11 15:25:08 +0100396 << " but buffer is full, clearing"
Jonas Olssonb2b20312020-01-14 12:11:31 +0100397 " buffer and inserting the frame.";
philipel9771c502018-03-02 11:06:27 +0100398 ClearFramesAndHistory();
399 } else {
philipel9aa9b8d2021-02-15 13:31:29 +0100400 RTC_LOG(LS_WARNING) << "Frame " << frame->Id()
philipelf1091932021-02-11 15:25:08 +0100401 << " could not be inserted due to the frame "
Jonas Olssonb2b20312020-01-14 12:11:31 +0100402 "buffer being full, dropping frame.";
philipel9aa9b8d2021-02-15 13:31:29 +0100403 return last_continuous_frame_id;
philipel9771c502018-03-02 11:06:27 +0100404 }
philipele0b2f152016-09-28 10:23:49 +0200405 }
406
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100407 auto last_decoded_frame = decoded_frames_history_.GetLastDecodedFrameId();
408 auto last_decoded_frame_timestamp =
409 decoded_frames_history_.GetLastDecodedFrameTimestamp();
philipel9aa9b8d2021-02-15 13:31:29 +0100410 if (last_decoded_frame && frame->Id() <= *last_decoded_frame) {
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100411 if (AheadOf(frame->Timestamp(), *last_decoded_frame_timestamp) &&
philipel3042c2d2017-08-18 04:55:02 -0700412 frame->is_keyframe()) {
philipel9aa9b8d2021-02-15 13:31:29 +0100413 // If this frame has a newer timestamp but an earlier frame id then we
414 // assume there has been a jump in the frame id due to some encoder
philipelfcc60062017-01-18 05:35:20 -0800415 // reconfiguration or some other reason. Even though this is not according
416 // to spec we can still continue to decode from this frame if it is a
417 // keyframe.
Mirko Bonadei675513b2017-11-09 11:09:25 +0100418 RTC_LOG(LS_WARNING)
philipel9aa9b8d2021-02-15 13:31:29 +0100419 << "A jump in frame id was detected, clearing buffer.";
philipelfcc60062017-01-18 05:35:20 -0800420 ClearFramesAndHistory();
philipel9aa9b8d2021-02-15 13:31:29 +0100421 last_continuous_frame_id = -1;
philipelfcc60062017-01-18 05:35:20 -0800422 } else {
philipel9aa9b8d2021-02-15 13:31:29 +0100423 RTC_LOG(LS_WARNING) << "Frame " << frame->Id() << " inserted after frame "
424 << *last_decoded_frame
philipelf1091932021-02-11 15:25:08 +0100425 << " was handed off for decoding, dropping frame.";
philipel9aa9b8d2021-02-15 13:31:29 +0100426 return last_continuous_frame_id;
philipelfcc60062017-01-18 05:35:20 -0800427 }
philipele0b2f152016-09-28 10:23:49 +0200428 }
429
philipel146a48b2017-04-20 04:04:38 -0700430 // Test if inserting this frame would cause the order of the frames to become
431 // ambiguous (covering more than half the interval of 2^16). This can happen
philipel9aa9b8d2021-02-15 13:31:29 +0100432 // when the frame id make large jumps mid stream.
433 if (!frames_.empty() && frame->Id() < frames_.begin()->first &&
434 frames_.rbegin()->first < frame->Id()) {
435 RTC_LOG(LS_WARNING) << "A jump in frame id was detected, clearing buffer.";
philipel146a48b2017-04-20 04:04:38 -0700436 ClearFramesAndHistory();
philipel9aa9b8d2021-02-15 13:31:29 +0100437 last_continuous_frame_id = -1;
philipel146a48b2017-04-20 04:04:38 -0700438 }
439
philipel9aa9b8d2021-02-15 13:31:29 +0100440 auto info = frames_.emplace(frame->Id(), FrameInfo()).first;
philipele0b2f152016-09-28 10:23:49 +0200441
philipel93e451b2016-10-06 12:25:13 +0200442 if (info->second.frame) {
philipel9aa9b8d2021-02-15 13:31:29 +0100443 return last_continuous_frame_id;
philipele0b2f152016-09-28 10:23:49 +0200444 }
445
philipel93e451b2016-10-06 12:25:13 +0200446 if (!UpdateFrameInfoWithIncomingFrame(*frame, info))
philipel9aa9b8d2021-02-15 13:31:29 +0100447 return last_continuous_frame_id;
Ruslan Burakov493a6502019-02-27 15:32:48 +0100448
449 if (!frame->delayed_by_retransmission())
450 timing_->IncomingTimestamp(frame->Timestamp(), frame->ReceivedTime());
philipel0a9f6de2018-02-28 11:29:47 +0100451
philipel0cb73262020-12-08 17:36:53 +0100452 // It can happen that a frame will be reported as fully received even if a
453 // lower spatial layer frame is missing.
454 if (stats_callback_ && frame->is_last_spatial_layer) {
Johannes Kronb88b44e2019-08-22 13:16:44 +0200455 stats_callback_->OnCompleteFrame(frame->is_keyframe(), frame->size(),
456 frame->contentType());
457 }
458
philipele0b2f152016-09-28 10:23:49 +0200459 info->second.frame = std::move(frame);
philipele0b2f152016-09-28 10:23:49 +0200460
461 if (info->second.num_missing_continuous == 0) {
462 info->second.continuous = true;
463 PropagateContinuity(info);
philipel9aa9b8d2021-02-15 13:31:29 +0100464 last_continuous_frame_id = *last_continuous_frame_;
philipele0b2f152016-09-28 10:23:49 +0200465
466 // Since we now have new continuous frames there might be a better frame
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200467 // to return from NextFrame.
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200468 if (callback_queue_) {
469 callback_queue_->PostTask([this] {
Markus Handell6deec382020-07-07 12:17:12 +0200470 MutexLock lock(&mutex_);
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200471 if (!callback_task_.Running())
472 return;
473 RTC_CHECK(frame_handler_);
474 callback_task_.Stop();
475 StartWaitForNextFrameOnQueue();
476 });
477 }
philipele0b2f152016-09-28 10:23:49 +0200478 }
479
philipel9aa9b8d2021-02-15 13:31:29 +0100480 return last_continuous_frame_id;
philipelbe7a9e52016-05-19 12:19:35 +0200481}
482
philipele0b2f152016-09-28 10:23:49 +0200483void FrameBuffer::PropagateContinuity(FrameMap::iterator start) {
tommidb23ea62017-03-03 07:21:18 -0800484 TRACE_EVENT0("webrtc", "FrameBuffer::PropagateContinuity");
philipele0b2f152016-09-28 10:23:49 +0200485 RTC_DCHECK(start->second.continuous);
philipele0b2f152016-09-28 10:23:49 +0200486
487 std::queue<FrameMap::iterator> continuous_frames;
488 continuous_frames.push(start);
489
490 // A simple BFS to traverse continuous frames.
491 while (!continuous_frames.empty()) {
492 auto frame = continuous_frames.front();
493 continuous_frames.pop();
494
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100495 if (!last_continuous_frame_ || *last_continuous_frame_ < frame->first) {
496 last_continuous_frame_ = frame->first;
497 }
philipele0b2f152016-09-28 10:23:49 +0200498
499 // Loop through all dependent frames, and if that frame no longer has
500 // any unfulfilled dependencies then that frame is continuous as well.
Elad Alon69321dd2019-01-10 15:02:54 +0100501 for (size_t d = 0; d < frame->second.dependent_frames.size(); ++d) {
philipele0b2f152016-09-28 10:23:49 +0200502 auto frame_ref = frames_.find(frame->second.dependent_frames[d]);
philipel112adf92017-06-15 09:06:21 -0700503 RTC_DCHECK(frame_ref != frames_.end());
philipele0b2f152016-09-28 10:23:49 +0200504
philipel112adf92017-06-15 09:06:21 -0700505 // TODO(philipel): Look into why we've seen this happen.
506 if (frame_ref != frames_.end()) {
507 --frame_ref->second.num_missing_continuous;
508 if (frame_ref->second.num_missing_continuous == 0) {
509 frame_ref->second.continuous = true;
510 continuous_frames.push(frame_ref);
511 }
philipele0b2f152016-09-28 10:23:49 +0200512 }
513 }
514 }
515}
516
517void FrameBuffer::PropagateDecodability(const FrameInfo& info) {
tommidb23ea62017-03-03 07:21:18 -0800518 TRACE_EVENT0("webrtc", "FrameBuffer::PropagateDecodability");
Elad Alon69321dd2019-01-10 15:02:54 +0100519 for (size_t d = 0; d < info.dependent_frames.size(); ++d) {
philipele0b2f152016-09-28 10:23:49 +0200520 auto ref_info = frames_.find(info.dependent_frames[d]);
philipel93e451b2016-10-06 12:25:13 +0200521 RTC_DCHECK(ref_info != frames_.end());
tommie95b78b2017-05-14 07:23:11 -0700522 // TODO(philipel): Look into why we've seen this happen.
523 if (ref_info != frames_.end()) {
524 RTC_DCHECK_GT(ref_info->second.num_missing_decodable, 0U);
525 --ref_info->second.num_missing_decodable;
526 }
philipele0b2f152016-09-28 10:23:49 +0200527 }
528}
529
philipele7c891f2018-02-22 14:35:06 +0100530bool FrameBuffer::UpdateFrameInfoWithIncomingFrame(const EncodedFrame& frame,
philipele0b2f152016-09-28 10:23:49 +0200531 FrameMap::iterator info) {
tommidb23ea62017-03-03 07:21:18 -0800532 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateFrameInfoWithIncomingFrame");
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100533 auto last_decoded_frame = decoded_frames_history_.GetLastDecodedFrameId();
534 RTC_DCHECK(!last_decoded_frame || *last_decoded_frame < info->first);
philipele0b2f152016-09-28 10:23:49 +0200535
Artem Titovdcd7fc72021-08-09 13:02:57 +0200536 // In this function we determine how many missing dependencies this `frame`
537 // has to become continuous/decodable. If a frame that this `frame` depend
philipel798b2822018-06-11 13:10:14 +0200538 // on has already been decoded then we can ignore that dependency since it has
539 // already been fulfilled.
540 //
Artem Titovdcd7fc72021-08-09 13:02:57 +0200541 // For all other frames we will register a backwards reference to this `frame`
542 // so that `num_missing_continuous` and `num_missing_decodable` can be
philipel798b2822018-06-11 13:10:14 +0200543 // decremented as frames become continuous/are decoded.
544 struct Dependency {
philipel9aa9b8d2021-02-15 13:31:29 +0100545 int64_t frame_id;
philipel798b2822018-06-11 13:10:14 +0200546 bool continuous;
547 };
548 std::vector<Dependency> not_yet_fulfilled_dependencies;
549
550 // Find all dependencies that have not yet been fulfilled.
philipele0b2f152016-09-28 10:23:49 +0200551 for (size_t i = 0; i < frame.num_references; ++i) {
Artem Titovdcd7fc72021-08-09 13:02:57 +0200552 // Does `frame` depend on a frame earlier than the last decoded one?
philipel9aa9b8d2021-02-15 13:31:29 +0100553 if (last_decoded_frame && frame.references[i] <= *last_decoded_frame) {
Artem Titovdcd7fc72021-08-09 13:02:57 +0200554 // Was that frame decoded? If not, this `frame` will never become
philipel798b2822018-06-11 13:10:14 +0200555 // decodable.
philipel9aa9b8d2021-02-15 13:31:29 +0100556 if (!decoded_frames_history_.WasDecoded(frame.references[i])) {
philipel65e1f942017-07-24 08:26:53 -0700557 int64_t now_ms = clock_->TimeInMilliseconds();
558 if (last_log_non_decoded_ms_ + kLogNonDecodedIntervalMs < now_ms) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100559 RTC_LOG(LS_WARNING)
philipel9aa9b8d2021-02-15 13:31:29 +0100560 << "Frame " << frame.Id()
philipelf1091932021-02-11 15:25:08 +0100561 << " depends on a non-decoded frame more previous than the last "
562 "decoded frame, dropping frame.";
philipel65e1f942017-07-24 08:26:53 -0700563 last_log_non_decoded_ms_ = now_ms;
564 }
philipele0b2f152016-09-28 10:23:49 +0200565 return false;
566 }
philipele0b2f152016-09-28 10:23:49 +0200567 } else {
philipel9aa9b8d2021-02-15 13:31:29 +0100568 auto ref_info = frames_.find(frame.references[i]);
philipel798b2822018-06-11 13:10:14 +0200569 bool ref_continuous =
570 ref_info != frames_.end() && ref_info->second.continuous;
philipel9aa9b8d2021-02-15 13:31:29 +0100571 not_yet_fulfilled_dependencies.push_back(
572 {frame.references[i], ref_continuous});
philipele0b2f152016-09-28 10:23:49 +0200573 }
philipelbe7a9e52016-05-19 12:19:35 +0200574 }
575
philipel798b2822018-06-11 13:10:14 +0200576 info->second.num_missing_continuous = not_yet_fulfilled_dependencies.size();
577 info->second.num_missing_decodable = not_yet_fulfilled_dependencies.size();
578
579 for (const Dependency& dep : not_yet_fulfilled_dependencies) {
580 if (dep.continuous)
581 --info->second.num_missing_continuous;
582
philipel9aa9b8d2021-02-15 13:31:29 +0100583 frames_[dep.frame_id].dependent_frames.push_back(frame.Id());
philipel798b2822018-06-11 13:10:14 +0200584 }
philipel93e451b2016-10-06 12:25:13 +0200585
philipelbe7a9e52016-05-19 12:19:35 +0200586 return true;
587}
588
philipelbe742702016-11-30 01:31:40 -0800589void FrameBuffer::UpdateJitterDelay() {
tommidb23ea62017-03-03 07:21:18 -0800590 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateJitterDelay");
philipela45102f2017-02-22 05:30:39 -0800591 if (!stats_callback_)
592 return;
philipelbe742702016-11-30 01:31:40 -0800593
philipela45102f2017-02-22 05:30:39 -0800594 int max_decode_ms;
595 int current_delay_ms;
596 int target_delay_ms;
597 int jitter_buffer_ms;
598 int min_playout_delay_ms;
599 int render_delay_ms;
Johannes Kronbfd343b2019-07-01 10:07:50 +0200600 if (timing_->GetTimings(&max_decode_ms, &current_delay_ms, &target_delay_ms,
601 &jitter_buffer_ms, &min_playout_delay_ms,
602 &render_delay_ms)) {
philipela45102f2017-02-22 05:30:39 -0800603 stats_callback_->OnFrameBufferTimingsUpdated(
Johannes Kronbfd343b2019-07-01 10:07:50 +0200604 max_decode_ms, current_delay_ms, target_delay_ms, jitter_buffer_ms,
605 min_playout_delay_ms, render_delay_ms);
philipelbe742702016-11-30 01:31:40 -0800606 }
philipel266f0a42016-11-28 08:49:07 -0800607}
608
ilnik2edc6842017-07-06 03:06:50 -0700609void FrameBuffer::UpdateTimingFrameInfo() {
610 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateTimingFrameInfo");
Danil Chapovalov0040b662018-06-18 10:48:16 +0200611 absl::optional<TimingFrameInfo> info = timing_->GetTimingFrameInfo();
philipel97187112018-03-23 10:43:21 +0100612 if (info && stats_callback_)
ilnik2edc6842017-07-06 03:06:50 -0700613 stats_callback_->OnTimingFrameInfoUpdated(*info);
614}
615
philipelfcc60062017-01-18 05:35:20 -0800616void FrameBuffer::ClearFramesAndHistory() {
ilnik2edc6842017-07-06 03:06:50 -0700617 TRACE_EVENT0("webrtc", "FrameBuffer::ClearFramesAndHistory");
Johannes Kron0c141c52019-08-26 15:04:43 +0200618 if (stats_callback_) {
philipel9aa9b8d2021-02-15 13:31:29 +0100619 unsigned int dropped_frames =
620 std::count_if(frames_.begin(), frames_.end(),
621 [](const std::pair<const int64_t, FrameInfo>& frame) {
622 return frame.second.frame != nullptr;
623 });
Johannes Kron0c141c52019-08-26 15:04:43 +0200624 if (dropped_frames > 0) {
625 stats_callback_->OnDroppedFrames(dropped_frames);
626 }
627 }
philipelfcc60062017-01-18 05:35:20 -0800628 frames_.clear();
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100629 last_continuous_frame_.reset();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100630 frames_to_decode_.clear();
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100631 decoded_frames_history_.Clear();
philipelfcc60062017-01-18 05:35:20 -0800632}
633
Niels Möllerff2e2152019-09-27 10:29:30 +0200634// TODO(philipel): Avoid the concatenation of frames here, by replacing
635// NextFrame and GetNextFrame with methods returning multiple frames.
Evan Shrubsole0072c212021-11-10 11:41:14 +0100636std::unique_ptr<EncodedFrame> FrameBuffer::CombineAndDeleteFrames(
637 std::vector<std::unique_ptr<EncodedFrame>> frames) const {
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100638 RTC_DCHECK(!frames.empty());
Evan Shrubsolef83d4262021-12-15 15:05:15 +0100639 absl::InlinedVector<std::unique_ptr<EncodedFrame>, 4> inlined;
640 for (auto& frame : frames) {
641 inlined.push_back(std::move(frame));
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100642 }
Evan Shrubsolef83d4262021-12-15 15:05:15 +0100643 return webrtc::CombineAndDeleteFrames(std::move(inlined));
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100644}
645
Niels Möllerbe682d42018-03-27 08:31:45 +0200646FrameBuffer::FrameInfo::FrameInfo() = default;
647FrameBuffer::FrameInfo::FrameInfo(FrameInfo&&) = default;
648FrameBuffer::FrameInfo::~FrameInfo() = default;
649
philipelbe7a9e52016-05-19 12:19:35 +0200650} // namespace video_coding
651} // namespace webrtc