blob: 944f97bf8714c03f40e2e724c6b99c06082c9bef [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>
philipele0b2f152016-09-28 10:23:49 +020016#include <queue>
Yves Gerey3e707812018-11-28 16:47:49 +010017#include <utility>
philipel798b2822018-06-11 13:10:14 +020018#include <vector>
philipelbe7a9e52016-05-19 12:19:35 +020019
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +020020#include "absl/memory/memory.h"
Yves Gerey3e707812018-11-28 16:47:49 +010021#include "api/video/encoded_image.h"
22#include "api/video/video_timing.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020023#include "modules/video_coding/include/video_coding_defines.h"
24#include "modules/video_coding/jitter_estimator.h"
25#include "modules/video_coding/timing.h"
26#include "rtc_base/checks.h"
Yves Gerey3e707812018-11-28 16:47:49 +010027#include "rtc_base/experiments/rtt_mult_experiment.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020028#include "rtc_base/logging.h"
Yves Gerey3e707812018-11-28 16:47:49 +010029#include "rtc_base/numerics/sequence_number_util.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020030#include "rtc_base/trace_event.h"
31#include "system_wrappers/include/clock.h"
philipel707f2782017-10-02 14:10:28 +020032#include "system_wrappers/include/field_trial.h"
philipelbe7a9e52016-05-19 12:19:35 +020033
34namespace webrtc {
35namespace video_coding {
36
37namespace {
philipele0b2f152016-09-28 10:23:49 +020038// Max number of frames the buffer will hold.
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +010039constexpr size_t kMaxFramesBuffered = 800;
philipelbe7a9e52016-05-19 12:19:35 +020040
philipele0b2f152016-09-28 10:23:49 +020041// Max number of decoded frame info that will be saved.
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +010042constexpr int kMaxFramesHistory = 1 << 13;
philipel65e1f942017-07-24 08:26:53 -070043
Ilya Nikolaevskiy8c4fe162018-02-27 15:49:47 +010044// The time it's allowed for a frame to be late to its rendering prediction and
45// still be rendered.
Ilya Nikolaevskiy7eef0072018-02-28 09:59:26 +010046constexpr int kMaxAllowedFrameDelayMs = 5;
Ilya Nikolaevskiy8c4fe162018-02-27 15:49:47 +010047
philipel65e1f942017-07-24 08:26:53 -070048constexpr int64_t kLogNonDecodedIntervalMs = 5000;
philipelbe7a9e52016-05-19 12:19:35 +020049} // namespace
50
philipelbe7a9e52016-05-19 12:19:35 +020051FrameBuffer::FrameBuffer(Clock* clock,
philipela45102f2017-02-22 05:30:39 -080052 VCMTiming* timing,
53 VCMReceiveStatisticsCallback* stats_callback)
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +010054 : decoded_frames_history_(kMaxFramesHistory),
55 clock_(clock),
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +020056 callback_queue_(nullptr),
Niels Möllerd9c2d942019-04-30 09:16:36 +020057 jitter_estimator_(clock),
philipelbe7a9e52016-05-19 12:19:35 +020058 timing_(timing),
philipel4f6cd6a2016-08-03 10:59:32 +020059 inter_frame_delay_(clock_->TimeInMilliseconds()),
philipel29f730e2017-03-15 08:10:08 -070060 stopped_(false),
philipela45102f2017-02-22 05:30:39 -080061 protection_mode_(kProtectionNack),
philipel65e1f942017-07-24 08:26:53 -070062 stats_callback_(stats_callback),
Elad Alone4b50232019-01-14 18:56:14 +010063 last_log_non_decoded_ms_(-kLogNonDecodedIntervalMs),
64 add_rtt_to_playout_delay_(
“Michaeld3a4ebe2019-06-07 03:55:01 -050065 webrtc::field_trial::IsEnabled("WebRTC-AddRttToPlayoutDelay")),
66 rtt_mult_settings_(RttMultExperiment::GetRttMultValue()) {}
philipel266f0a42016-11-28 08:49:07 -080067
philipela45102f2017-02-22 05:30:39 -080068FrameBuffer::~FrameBuffer() {}
philipelbe7a9e52016-05-19 12:19:35 +020069
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +020070void FrameBuffer::NextFrame(
71 int64_t max_wait_time_ms,
72 bool keyframe_required,
73 rtc::TaskQueue* callback_queue,
74 std::function<void(std::unique_ptr<EncodedFrame>, ReturnReason)> handler) {
75 RTC_DCHECK_RUN_ON(callback_queue);
76 TRACE_EVENT0("webrtc", "FrameBuffer::NextFrame");
77 int64_t latest_return_time_ms =
78 clock_->TimeInMilliseconds() + max_wait_time_ms;
79 rtc::CritScope lock(&crit_);
80 if (stopped_) {
81 return;
82 }
83 latest_return_time_ms_ = latest_return_time_ms;
84 keyframe_required_ = keyframe_required;
85 frame_handler_ = handler;
86 callback_queue_ = callback_queue;
87 StartWaitForNextFrameOnQueue();
88}
89
90void FrameBuffer::StartWaitForNextFrameOnQueue() {
91 RTC_DCHECK(callback_queue_);
92 RTC_DCHECK(!callback_task_.Running());
93 int64_t wait_ms = FindNextFrame(clock_->TimeInMilliseconds());
94 callback_task_ = RepeatingTaskHandle::DelayedStart(
Danil Chapovalov55284022020-02-07 14:53:52 +010095 callback_queue_->Get(), TimeDelta::Millis(wait_ms), [this] {
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +020096 // If this task has not been cancelled, we did not get any new frames
97 // while waiting. Continue with frame delivery.
98 rtc::CritScope lock(&crit_);
99 if (!frames_to_decode_.empty()) {
100 // We have frames, deliver!
101 frame_handler_(absl::WrapUnique(GetNextFrame()), kFrameFound);
102 CancelCallback();
103 return TimeDelta::Zero(); // Ignored.
104 } else if (clock_->TimeInMilliseconds() >= latest_return_time_ms_) {
105 // We have timed out, signal this and stop repeating.
106 frame_handler_(nullptr, kTimeout);
107 CancelCallback();
108 return TimeDelta::Zero(); // Ignored.
109 } else {
110 // If there's no frames to decode and there is still time left, it
111 // means that the frame buffer was cleared between creation and
112 // execution of this task. Continue waiting for the remaining time.
113 int64_t wait_ms = FindNextFrame(clock_->TimeInMilliseconds());
Danil Chapovalov55284022020-02-07 14:53:52 +0100114 return TimeDelta::Millis(wait_ms);
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200115 }
116 });
117}
118
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200119int64_t FrameBuffer::FindNextFrame(int64_t now_ms) {
120 int64_t wait_ms = latest_return_time_ms_ - now_ms;
121 frames_to_decode_.clear();
122
123 // |last_continuous_frame_| may be empty below, but nullopt is smaller
124 // than everything else and loop will immediately terminate as expected.
125 for (auto frame_it = frames_.begin();
126 frame_it != frames_.end() && frame_it->first <= last_continuous_frame_;
127 ++frame_it) {
128 if (!frame_it->second.continuous ||
129 frame_it->second.num_missing_decodable > 0) {
130 continue;
131 }
132
133 EncodedFrame* frame = frame_it->second.frame.get();
134
135 if (keyframe_required_ && !frame->is_keyframe())
136 continue;
137
138 auto last_decoded_frame_timestamp =
139 decoded_frames_history_.GetLastDecodedFrameTimestamp();
140
141 // TODO(https://bugs.webrtc.org/9974): consider removing this check
142 // as it may make a stream undecodable after a very long delay between
143 // frames.
144 if (last_decoded_frame_timestamp &&
145 AheadOf(*last_decoded_frame_timestamp, frame->Timestamp())) {
146 continue;
147 }
148
149 // Only ever return all parts of a superframe. Therefore skip this
150 // frame if it's not a beginning of a superframe.
151 if (frame->inter_layer_predicted) {
152 continue;
153 }
154
155 // Gather all remaining frames for the same superframe.
156 std::vector<FrameMap::iterator> current_superframe;
157 current_superframe.push_back(frame_it);
158 bool last_layer_completed = frame_it->second.frame->is_last_spatial_layer;
159 FrameMap::iterator next_frame_it = frame_it;
160 while (true) {
161 ++next_frame_it;
162 if (next_frame_it == frames_.end() ||
163 next_frame_it->first.picture_id != frame->id.picture_id ||
164 !next_frame_it->second.continuous) {
165 break;
166 }
167 // Check if the next frame has some undecoded references other than
168 // the previous frame in the same superframe.
169 size_t num_allowed_undecoded_refs =
170 (next_frame_it->second.frame->inter_layer_predicted) ? 1 : 0;
171 if (next_frame_it->second.num_missing_decodable >
172 num_allowed_undecoded_refs) {
173 break;
174 }
175 // All frames in the superframe should have the same timestamp.
176 if (frame->Timestamp() != next_frame_it->second.frame->Timestamp()) {
177 RTC_LOG(LS_WARNING) << "Frames in a single superframe have different"
178 " timestamps. Skipping undecodable superframe.";
179 break;
180 }
181 current_superframe.push_back(next_frame_it);
182 last_layer_completed = next_frame_it->second.frame->is_last_spatial_layer;
183 }
184 // Check if the current superframe is complete.
185 // TODO(bugs.webrtc.org/10064): consider returning all available to
186 // decode frames even if the superframe is not complete yet.
187 if (!last_layer_completed) {
188 continue;
189 }
190
191 frames_to_decode_ = std::move(current_superframe);
192
193 if (frame->RenderTime() == -1) {
194 frame->SetRenderTime(timing_->RenderTimeMs(frame->Timestamp(), now_ms));
195 }
196 wait_ms = timing_->MaxWaitingTime(frame->RenderTime(), now_ms);
197
198 // This will cause the frame buffer to prefer high framerate rather
199 // than high resolution in the case of the decoder not decoding fast
200 // enough and the stream has multiple spatial and temporal layers.
201 // For multiple temporal layers it may cause non-base layer frames to be
202 // skipped if they are late.
203 if (wait_ms < -kMaxAllowedFrameDelayMs)
204 continue;
205
206 break;
207 }
208 wait_ms = std::min<int64_t>(wait_ms, latest_return_time_ms_ - now_ms);
209 wait_ms = std::max<int64_t>(wait_ms, 0);
210 return wait_ms;
211}
212
213EncodedFrame* FrameBuffer::GetNextFrame() {
214 int64_t now_ms = clock_->TimeInMilliseconds();
215 // TODO(ilnik): remove |frames_out| use frames_to_decode_ directly.
216 std::vector<EncodedFrame*> frames_out;
217
218 RTC_DCHECK(!frames_to_decode_.empty());
219 bool superframe_delayed_by_retransmission = false;
220 size_t superframe_size = 0;
221 EncodedFrame* first_frame = frames_to_decode_[0]->second.frame.get();
222 int64_t render_time_ms = first_frame->RenderTime();
223 int64_t receive_time_ms = first_frame->ReceivedTime();
224 // Gracefully handle bad RTP timestamps and render time issues.
225 if (HasBadRenderTiming(*first_frame, now_ms)) {
Niels Möllerd9c2d942019-04-30 09:16:36 +0200226 jitter_estimator_.Reset();
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200227 timing_->Reset();
228 render_time_ms = timing_->RenderTimeMs(first_frame->Timestamp(), now_ms);
229 }
230
231 for (FrameMap::iterator& frame_it : frames_to_decode_) {
232 RTC_DCHECK(frame_it != frames_.end());
233 EncodedFrame* frame = frame_it->second.frame.release();
234
235 frame->SetRenderTime(render_time_ms);
236
237 superframe_delayed_by_retransmission |= frame->delayed_by_retransmission();
238 receive_time_ms = std::max(receive_time_ms, frame->ReceivedTime());
239 superframe_size += frame->size();
240
241 PropagateDecodability(frame_it->second);
242 decoded_frames_history_.InsertDecoded(frame_it->first, frame->Timestamp());
243
244 // Remove decoded frame and all undecoded frames before it.
Johannes Kron0c141c52019-08-26 15:04:43 +0200245 if (stats_callback_) {
246 unsigned int dropped_frames = std::count_if(
247 frames_.begin(), frame_it,
248 [](const std::pair<const VideoLayerFrameId, FrameInfo>& frame) {
249 return frame.second.frame != nullptr;
250 });
251 if (dropped_frames > 0) {
252 stats_callback_->OnDroppedFrames(dropped_frames);
253 }
254 }
255
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200256 frames_.erase(frames_.begin(), ++frame_it);
257
258 frames_out.push_back(frame);
259 }
260
261 if (!superframe_delayed_by_retransmission) {
262 int64_t frame_delay;
263
264 if (inter_frame_delay_.CalculateDelay(first_frame->Timestamp(),
265 &frame_delay, receive_time_ms)) {
Niels Möllerd9c2d942019-04-30 09:16:36 +0200266 jitter_estimator_.UpdateEstimate(frame_delay, superframe_size);
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200267 }
268
269 float rtt_mult = protection_mode_ == kProtectionNackFEC ? 0.0 : 1.0;
“Michaeld3a4ebe2019-06-07 03:55:01 -0500270 absl::optional<float> rtt_mult_add_cap_ms = absl::nullopt;
271 if (rtt_mult_settings_.has_value()) {
272 rtt_mult = rtt_mult_settings_->rtt_mult_setting;
273 rtt_mult_add_cap_ms = rtt_mult_settings_->rtt_mult_add_cap_ms;
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200274 }
“Michaele0f37042019-06-04 10:04:12 -0500275 timing_->SetJitterDelay(
276 jitter_estimator_.GetJitterEstimate(rtt_mult, rtt_mult_add_cap_ms));
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200277 timing_->UpdateCurrentDelay(render_time_ms, now_ms);
278 } else {
279 if (RttMultExperiment::RttMultEnabled() || add_rtt_to_playout_delay_)
Niels Möllerd9c2d942019-04-30 09:16:36 +0200280 jitter_estimator_.FrameNacked();
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200281 }
282
283 UpdateJitterDelay();
284 UpdateTimingFrameInfo();
285
286 if (frames_out.size() == 1) {
287 return frames_out[0];
288 } else {
289 return CombineAndDeleteFrames(frames_out);
290 }
291}
292
philipele7c891f2018-02-22 14:35:06 +0100293bool FrameBuffer::HasBadRenderTiming(const EncodedFrame& frame,
294 int64_t now_ms) {
stefan95e97542017-05-23 09:52:18 -0700295 // Assume that render timing errors are due to changes in the video stream.
296 int64_t render_time_ms = frame.RenderTimeMs();
Stefan Holmer812ceaf2018-05-15 13:00:10 +0200297 // Zero render time means render immediately.
298 if (render_time_ms == 0) {
299 return false;
300 }
stefan95e97542017-05-23 09:52:18 -0700301 if (render_time_ms < 0) {
302 return true;
303 }
Stefan Holmer812ceaf2018-05-15 13:00:10 +0200304 const int64_t kMaxVideoDelayMs = 10000;
stefan95e97542017-05-23 09:52:18 -0700305 if (std::abs(render_time_ms - now_ms) > kMaxVideoDelayMs) {
306 int frame_delay = static_cast<int>(std::abs(render_time_ms - now_ms));
Mirko Bonadei675513b2017-11-09 11:09:25 +0100307 RTC_LOG(LS_WARNING)
308 << "A frame about to be decoded is out of the configured "
Jonas Olssonb2b20312020-01-14 12:11:31 +0100309 "delay bounds ("
310 << frame_delay << " > " << kMaxVideoDelayMs
Mirko Bonadei675513b2017-11-09 11:09:25 +0100311 << "). Resetting the video jitter buffer.";
stefan95e97542017-05-23 09:52:18 -0700312 return true;
313 }
314 if (static_cast<int>(timing_->TargetVideoDelay()) > kMaxVideoDelayMs) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100315 RTC_LOG(LS_WARNING) << "The video target delay has grown larger than "
316 << kMaxVideoDelayMs << " ms.";
stefan95e97542017-05-23 09:52:18 -0700317 return true;
318 }
319 return false;
320}
321
philipel4f6cd6a2016-08-03 10:59:32 +0200322void FrameBuffer::SetProtectionMode(VCMVideoProtection mode) {
tommidb23ea62017-03-03 07:21:18 -0800323 TRACE_EVENT0("webrtc", "FrameBuffer::SetProtectionMode");
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000324 rtc::CritScope lock(&crit_);
325 protection_mode_ = mode;
philipel4f6cd6a2016-08-03 10:59:32 +0200326}
327
philipel504c47d2016-06-30 17:33:02 +0200328void FrameBuffer::Start() {
tommidb23ea62017-03-03 07:21:18 -0800329 TRACE_EVENT0("webrtc", "FrameBuffer::Start");
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000330 rtc::CritScope lock(&crit_);
331 stopped_ = false;
philipel504c47d2016-06-30 17:33:02 +0200332}
333
334void FrameBuffer::Stop() {
tommidb23ea62017-03-03 07:21:18 -0800335 TRACE_EVENT0("webrtc", "FrameBuffer::Stop");
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000336 rtc::CritScope lock(&crit_);
337 stopped_ = true;
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200338 CancelCallback();
philipel504c47d2016-06-30 17:33:02 +0200339}
340
Ilya Nikolaevskiye6a2d942018-11-07 14:32:28 +0100341void FrameBuffer::Clear() {
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000342 rtc::CritScope lock(&crit_);
343 ClearFramesAndHistory();
Ilya Nikolaevskiye6a2d942018-11-07 14:32:28 +0100344}
345
philipele21be1d2017-09-25 06:37:12 -0700346void FrameBuffer::UpdateRtt(int64_t rtt_ms) {
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000347 rtc::CritScope lock(&crit_);
Niels Möllerd9c2d942019-04-30 09:16:36 +0200348 jitter_estimator_.UpdateRtt(rtt_ms);
philipele21be1d2017-09-25 06:37:12 -0700349}
350
philipele7c891f2018-02-22 14:35:06 +0100351bool FrameBuffer::ValidReferences(const EncodedFrame& frame) const {
philipel112adf92017-06-15 09:06:21 -0700352 for (size_t i = 0; i < frame.num_references; ++i) {
Philip Eliasson1f850a62019-03-19 12:15:00 +0000353 if (frame.references[i] >= frame.id.picture_id)
philipel112adf92017-06-15 09:06:21 -0700354 return false;
philipel3b3c9c42017-09-11 09:38:36 -0700355
philipel112adf92017-06-15 09:06:21 -0700356 for (size_t j = i + 1; j < frame.num_references; ++j) {
357 if (frame.references[i] == frame.references[j])
358 return false;
359 }
360 }
361
philipel0fa82a62018-03-19 15:34:53 +0100362 if (frame.inter_layer_predicted && frame.id.spatial_layer == 0)
philipel112adf92017-06-15 09:06:21 -0700363 return false;
364
365 return true;
366}
367
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200368void FrameBuffer::CancelCallback() {
369 frame_handler_ = {};
370 callback_task_.Stop();
371 callback_queue_ = nullptr;
372}
373
Ilya Nikolaevskiy48193b02019-03-25 11:40:34 +0100374bool FrameBuffer::IsCompleteSuperFrame(const EncodedFrame& frame) {
375 if (frame.inter_layer_predicted) {
376 // Check that all previous spatial layers are already inserted.
377 VideoLayerFrameId id = frame.id;
378 RTC_DCHECK_GT(id.spatial_layer, 0);
379 --id.spatial_layer;
380 FrameMap::iterator prev_frame = frames_.find(id);
Ilya Nikolaevskiyb4a70ed2019-04-23 10:37:06 +0200381 if (prev_frame == frames_.end() || !prev_frame->second.frame)
Ilya Nikolaevskiy48193b02019-03-25 11:40:34 +0100382 return false;
383 while (prev_frame->second.frame->inter_layer_predicted) {
Ilya Nikolaevskiyf87a7df2019-04-09 19:23:36 +0200384 if (prev_frame == frames_.begin())
385 return false;
Ilya Nikolaevskiy48193b02019-03-25 11:40:34 +0100386 --prev_frame;
387 --id.spatial_layer;
Ilya Nikolaevskiyb4a70ed2019-04-23 10:37:06 +0200388 if (!prev_frame->second.frame ||
389 prev_frame->first.picture_id != id.picture_id ||
Ilya Nikolaevskiy48193b02019-03-25 11:40:34 +0100390 prev_frame->first.spatial_layer != id.spatial_layer) {
391 return false;
392 }
393 }
394 }
395
396 if (!frame.is_last_spatial_layer) {
397 // Check that all following spatial layers are already inserted.
398 VideoLayerFrameId id = frame.id;
399 ++id.spatial_layer;
400 FrameMap::iterator next_frame = frames_.find(id);
Ilya Nikolaevskiyb4a70ed2019-04-23 10:37:06 +0200401 if (next_frame == frames_.end() || !next_frame->second.frame)
Ilya Nikolaevskiy48193b02019-03-25 11:40:34 +0100402 return false;
403 while (!next_frame->second.frame->is_last_spatial_layer) {
404 ++next_frame;
405 ++id.spatial_layer;
Ilya Nikolaevskiyb4a70ed2019-04-23 10:37:06 +0200406 if (next_frame == frames_.end() || !next_frame->second.frame ||
Ilya Nikolaevskiy48193b02019-03-25 11:40:34 +0100407 next_frame->first.picture_id != id.picture_id ||
408 next_frame->first.spatial_layer != id.spatial_layer) {
409 return false;
410 }
411 }
412 }
413
414 return true;
415}
416
philipele7c891f2018-02-22 14:35:06 +0100417int64_t FrameBuffer::InsertFrame(std::unique_ptr<EncodedFrame> frame) {
tommidb23ea62017-03-03 07:21:18 -0800418 TRACE_EVENT0("webrtc", "FrameBuffer::InsertFrame");
philipel93e451b2016-10-06 12:25:13 +0200419 RTC_DCHECK(frame);
tommi0a735642017-03-14 06:23:57 -0700420
421 rtc::CritScope lock(&crit_);
philipel29f730e2017-03-15 08:10:08 -0700422
Ilya Nikolaevskiy48193b02019-03-25 11:40:34 +0100423 const VideoLayerFrameId& id = frame->id;
philipel1610f942017-12-12 13:58:31 +0100424 int64_t last_continuous_picture_id =
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100425 !last_continuous_frame_ ? -1 : last_continuous_frame_->picture_id;
philipele0b2f152016-09-28 10:23:49 +0200426
philipel112adf92017-06-15 09:06:21 -0700427 if (!ValidReferences(*frame)) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100428 RTC_LOG(LS_WARNING) << "Frame with (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100429 << id.picture_id << ":"
430 << static_cast<int>(id.spatial_layer)
Mirko Bonadei675513b2017-11-09 11:09:25 +0100431 << ") has invalid frame references, dropping frame.";
philipel112adf92017-06-15 09:06:21 -0700432 return last_continuous_picture_id;
433 }
434
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100435 if (frames_.size() >= kMaxFramesBuffered) {
philipel9771c502018-03-02 11:06:27 +0100436 if (frame->is_keyframe()) {
437 RTC_LOG(LS_WARNING) << "Inserting keyframe (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100438 << id.picture_id << ":"
439 << static_cast<int>(id.spatial_layer)
philipel9771c502018-03-02 11:06:27 +0100440 << ") but buffer is full, clearing"
Jonas Olssonb2b20312020-01-14 12:11:31 +0100441 " buffer and inserting the frame.";
philipel9771c502018-03-02 11:06:27 +0100442 ClearFramesAndHistory();
443 } else {
444 RTC_LOG(LS_WARNING) << "Frame with (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100445 << id.picture_id << ":"
446 << static_cast<int>(id.spatial_layer)
philipel9771c502018-03-02 11:06:27 +0100447 << ") could not be inserted due to the frame "
Jonas Olssonb2b20312020-01-14 12:11:31 +0100448 "buffer being full, dropping frame.";
philipel9771c502018-03-02 11:06:27 +0100449 return last_continuous_picture_id;
450 }
philipele0b2f152016-09-28 10:23:49 +0200451 }
452
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100453 auto last_decoded_frame = decoded_frames_history_.GetLastDecodedFrameId();
454 auto last_decoded_frame_timestamp =
455 decoded_frames_history_.GetLastDecodedFrameTimestamp();
456 if (last_decoded_frame && id <= *last_decoded_frame) {
457 if (AheadOf(frame->Timestamp(), *last_decoded_frame_timestamp) &&
philipel3042c2d2017-08-18 04:55:02 -0700458 frame->is_keyframe()) {
philipelfcc60062017-01-18 05:35:20 -0800459 // If this frame has a newer timestamp but an earlier picture id then we
460 // assume there has been a jump in the picture id due to some encoder
461 // reconfiguration or some other reason. Even though this is not according
462 // to spec we can still continue to decode from this frame if it is a
463 // keyframe.
Mirko Bonadei675513b2017-11-09 11:09:25 +0100464 RTC_LOG(LS_WARNING)
465 << "A jump in picture id was detected, clearing buffer.";
philipelfcc60062017-01-18 05:35:20 -0800466 ClearFramesAndHistory();
467 last_continuous_picture_id = -1;
468 } else {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100469 RTC_LOG(LS_WARNING) << "Frame with (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100470 << id.picture_id << ":"
471 << static_cast<int>(id.spatial_layer)
Mirko Bonadei675513b2017-11-09 11:09:25 +0100472 << ") inserted after frame ("
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100473 << last_decoded_frame->picture_id << ":"
474 << static_cast<int>(last_decoded_frame->spatial_layer)
Mirko Bonadei675513b2017-11-09 11:09:25 +0100475 << ") was handed off for decoding, dropping frame.";
philipelfcc60062017-01-18 05:35:20 -0800476 return last_continuous_picture_id;
477 }
philipele0b2f152016-09-28 10:23:49 +0200478 }
479
philipel146a48b2017-04-20 04:04:38 -0700480 // Test if inserting this frame would cause the order of the frames to become
481 // ambiguous (covering more than half the interval of 2^16). This can happen
482 // when the picture id make large jumps mid stream.
philipel0fa82a62018-03-19 15:34:53 +0100483 if (!frames_.empty() && id < frames_.begin()->first &&
484 frames_.rbegin()->first < id) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100485 RTC_LOG(LS_WARNING)
486 << "A jump in picture id was detected, clearing buffer.";
philipel146a48b2017-04-20 04:04:38 -0700487 ClearFramesAndHistory();
488 last_continuous_picture_id = -1;
489 }
490
philipel0fa82a62018-03-19 15:34:53 +0100491 auto info = frames_.emplace(id, FrameInfo()).first;
philipele0b2f152016-09-28 10:23:49 +0200492
philipel93e451b2016-10-06 12:25:13 +0200493 if (info->second.frame) {
philipele0b2f152016-09-28 10:23:49 +0200494 return last_continuous_picture_id;
495 }
496
philipel93e451b2016-10-06 12:25:13 +0200497 if (!UpdateFrameInfoWithIncomingFrame(*frame, info))
498 return last_continuous_picture_id;
Ruslan Burakov493a6502019-02-27 15:32:48 +0100499
500 if (!frame->delayed_by_retransmission())
501 timing_->IncomingTimestamp(frame->Timestamp(), frame->ReceivedTime());
philipel0a9f6de2018-02-28 11:29:47 +0100502
Johannes Kronb88b44e2019-08-22 13:16:44 +0200503 if (stats_callback_ && IsCompleteSuperFrame(*frame)) {
504 stats_callback_->OnCompleteFrame(frame->is_keyframe(), frame->size(),
505 frame->contentType());
506 }
507
philipele0b2f152016-09-28 10:23:49 +0200508 info->second.frame = std::move(frame);
philipele0b2f152016-09-28 10:23:49 +0200509
510 if (info->second.num_missing_continuous == 0) {
511 info->second.continuous = true;
512 PropagateContinuity(info);
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100513 last_continuous_picture_id = last_continuous_frame_->picture_id;
philipele0b2f152016-09-28 10:23:49 +0200514
515 // Since we now have new continuous frames there might be a better frame
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200516 // to return from NextFrame.
Sebastian Jansson11d0d7b2019-04-11 12:39:34 +0200517 if (callback_queue_) {
518 callback_queue_->PostTask([this] {
519 rtc::CritScope lock(&crit_);
520 if (!callback_task_.Running())
521 return;
522 RTC_CHECK(frame_handler_);
523 callback_task_.Stop();
524 StartWaitForNextFrameOnQueue();
525 });
526 }
philipele0b2f152016-09-28 10:23:49 +0200527 }
528
529 return last_continuous_picture_id;
philipelbe7a9e52016-05-19 12:19:35 +0200530}
531
philipele0b2f152016-09-28 10:23:49 +0200532void FrameBuffer::PropagateContinuity(FrameMap::iterator start) {
tommidb23ea62017-03-03 07:21:18 -0800533 TRACE_EVENT0("webrtc", "FrameBuffer::PropagateContinuity");
philipele0b2f152016-09-28 10:23:49 +0200534 RTC_DCHECK(start->second.continuous);
philipele0b2f152016-09-28 10:23:49 +0200535
536 std::queue<FrameMap::iterator> continuous_frames;
537 continuous_frames.push(start);
538
539 // A simple BFS to traverse continuous frames.
540 while (!continuous_frames.empty()) {
541 auto frame = continuous_frames.front();
542 continuous_frames.pop();
543
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100544 if (!last_continuous_frame_ || *last_continuous_frame_ < frame->first) {
545 last_continuous_frame_ = frame->first;
546 }
philipele0b2f152016-09-28 10:23:49 +0200547
548 // Loop through all dependent frames, and if that frame no longer has
549 // any unfulfilled dependencies then that frame is continuous as well.
Elad Alon69321dd2019-01-10 15:02:54 +0100550 for (size_t d = 0; d < frame->second.dependent_frames.size(); ++d) {
philipele0b2f152016-09-28 10:23:49 +0200551 auto frame_ref = frames_.find(frame->second.dependent_frames[d]);
philipel112adf92017-06-15 09:06:21 -0700552 RTC_DCHECK(frame_ref != frames_.end());
philipele0b2f152016-09-28 10:23:49 +0200553
philipel112adf92017-06-15 09:06:21 -0700554 // TODO(philipel): Look into why we've seen this happen.
555 if (frame_ref != frames_.end()) {
556 --frame_ref->second.num_missing_continuous;
557 if (frame_ref->second.num_missing_continuous == 0) {
558 frame_ref->second.continuous = true;
559 continuous_frames.push(frame_ref);
560 }
philipele0b2f152016-09-28 10:23:49 +0200561 }
562 }
563 }
564}
565
566void FrameBuffer::PropagateDecodability(const FrameInfo& info) {
tommidb23ea62017-03-03 07:21:18 -0800567 TRACE_EVENT0("webrtc", "FrameBuffer::PropagateDecodability");
Elad Alon69321dd2019-01-10 15:02:54 +0100568 for (size_t d = 0; d < info.dependent_frames.size(); ++d) {
philipele0b2f152016-09-28 10:23:49 +0200569 auto ref_info = frames_.find(info.dependent_frames[d]);
philipel93e451b2016-10-06 12:25:13 +0200570 RTC_DCHECK(ref_info != frames_.end());
tommie95b78b2017-05-14 07:23:11 -0700571 // TODO(philipel): Look into why we've seen this happen.
572 if (ref_info != frames_.end()) {
573 RTC_DCHECK_GT(ref_info->second.num_missing_decodable, 0U);
574 --ref_info->second.num_missing_decodable;
575 }
philipele0b2f152016-09-28 10:23:49 +0200576 }
577}
578
philipele7c891f2018-02-22 14:35:06 +0100579bool FrameBuffer::UpdateFrameInfoWithIncomingFrame(const EncodedFrame& frame,
philipele0b2f152016-09-28 10:23:49 +0200580 FrameMap::iterator info) {
tommidb23ea62017-03-03 07:21:18 -0800581 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateFrameInfoWithIncomingFrame");
philipel0fa82a62018-03-19 15:34:53 +0100582 const VideoLayerFrameId& id = frame.id;
philipele0b2f152016-09-28 10:23:49 +0200583
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100584 auto last_decoded_frame = decoded_frames_history_.GetLastDecodedFrameId();
585 RTC_DCHECK(!last_decoded_frame || *last_decoded_frame < info->first);
philipele0b2f152016-09-28 10:23:49 +0200586
philipel798b2822018-06-11 13:10:14 +0200587 // In this function we determine how many missing dependencies this |frame|
588 // has to become continuous/decodable. If a frame that this |frame| depend
589 // on has already been decoded then we can ignore that dependency since it has
590 // already been fulfilled.
591 //
592 // For all other frames we will register a backwards reference to this |frame|
593 // so that |num_missing_continuous| and |num_missing_decodable| can be
594 // decremented as frames become continuous/are decoded.
595 struct Dependency {
596 VideoLayerFrameId id;
597 bool continuous;
598 };
599 std::vector<Dependency> not_yet_fulfilled_dependencies;
600
601 // Find all dependencies that have not yet been fulfilled.
philipele0b2f152016-09-28 10:23:49 +0200602 for (size_t i = 0; i < frame.num_references; ++i) {
philipel0fa82a62018-03-19 15:34:53 +0100603 VideoLayerFrameId ref_key(frame.references[i], frame.id.spatial_layer);
philipel798b2822018-06-11 13:10:14 +0200604 // Does |frame| depend on a frame earlier than the last decoded one?
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100605 if (last_decoded_frame && ref_key <= *last_decoded_frame) {
philipel798b2822018-06-11 13:10:14 +0200606 // Was that frame decoded? If not, this |frame| will never become
607 // decodable.
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100608 if (!decoded_frames_history_.WasDecoded(ref_key)) {
philipel65e1f942017-07-24 08:26:53 -0700609 int64_t now_ms = clock_->TimeInMilliseconds();
610 if (last_log_non_decoded_ms_ + kLogNonDecodedIntervalMs < now_ms) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100611 RTC_LOG(LS_WARNING)
philipel0fa82a62018-03-19 15:34:53 +0100612 << "Frame with (picture_id:spatial_id) (" << id.picture_id << ":"
613 << static_cast<int>(id.spatial_layer)
philipel65e1f942017-07-24 08:26:53 -0700614 << ") depends on a non-decoded frame more previous than"
Jonas Olssonb2b20312020-01-14 12:11:31 +0100615 " the last decoded frame, dropping frame.";
philipel65e1f942017-07-24 08:26:53 -0700616 last_log_non_decoded_ms_ = now_ms;
617 }
philipele0b2f152016-09-28 10:23:49 +0200618 return false;
619 }
philipele0b2f152016-09-28 10:23:49 +0200620 } else {
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100621 auto ref_info = frames_.find(ref_key);
philipel798b2822018-06-11 13:10:14 +0200622 bool ref_continuous =
623 ref_info != frames_.end() && ref_info->second.continuous;
624 not_yet_fulfilled_dependencies.push_back({ref_key, ref_continuous});
philipele0b2f152016-09-28 10:23:49 +0200625 }
philipelbe7a9e52016-05-19 12:19:35 +0200626 }
627
philipel798b2822018-06-11 13:10:14 +0200628 // Does |frame| depend on the lower spatial layer?
philipelbe7a9e52016-05-19 12:19:35 +0200629 if (frame.inter_layer_predicted) {
philipel0fa82a62018-03-19 15:34:53 +0100630 VideoLayerFrameId ref_key(frame.id.picture_id, frame.id.spatial_layer - 1);
philipel798b2822018-06-11 13:10:14 +0200631 auto ref_info = frames_.find(ref_key);
philipele0b2f152016-09-28 10:23:49 +0200632
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100633 bool lower_layer_decoded =
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100634 last_decoded_frame && *last_decoded_frame == ref_key;
philipel798b2822018-06-11 13:10:14 +0200635 bool lower_layer_continuous =
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100636 lower_layer_decoded ||
637 (ref_info != frames_.end() && ref_info->second.continuous);
philipel798b2822018-06-11 13:10:14 +0200638
639 if (!lower_layer_continuous || !lower_layer_decoded) {
640 not_yet_fulfilled_dependencies.push_back(
641 {ref_key, lower_layer_continuous});
philipele0b2f152016-09-28 10:23:49 +0200642 }
philipelbe7a9e52016-05-19 12:19:35 +0200643 }
644
philipel798b2822018-06-11 13:10:14 +0200645 info->second.num_missing_continuous = not_yet_fulfilled_dependencies.size();
646 info->second.num_missing_decodable = not_yet_fulfilled_dependencies.size();
647
648 for (const Dependency& dep : not_yet_fulfilled_dependencies) {
649 if (dep.continuous)
650 --info->second.num_missing_continuous;
651
Elad Alon69321dd2019-01-10 15:02:54 +0100652 frames_[dep.id].dependent_frames.push_back(id);
philipel798b2822018-06-11 13:10:14 +0200653 }
philipel93e451b2016-10-06 12:25:13 +0200654
philipelbe7a9e52016-05-19 12:19:35 +0200655 return true;
656}
657
philipelbe742702016-11-30 01:31:40 -0800658void FrameBuffer::UpdateJitterDelay() {
tommidb23ea62017-03-03 07:21:18 -0800659 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateJitterDelay");
philipela45102f2017-02-22 05:30:39 -0800660 if (!stats_callback_)
661 return;
philipelbe742702016-11-30 01:31:40 -0800662
philipela45102f2017-02-22 05:30:39 -0800663 int max_decode_ms;
664 int current_delay_ms;
665 int target_delay_ms;
666 int jitter_buffer_ms;
667 int min_playout_delay_ms;
668 int render_delay_ms;
Johannes Kronbfd343b2019-07-01 10:07:50 +0200669 if (timing_->GetTimings(&max_decode_ms, &current_delay_ms, &target_delay_ms,
670 &jitter_buffer_ms, &min_playout_delay_ms,
671 &render_delay_ms)) {
philipela45102f2017-02-22 05:30:39 -0800672 stats_callback_->OnFrameBufferTimingsUpdated(
Johannes Kronbfd343b2019-07-01 10:07:50 +0200673 max_decode_ms, current_delay_ms, target_delay_ms, jitter_buffer_ms,
674 min_playout_delay_ms, render_delay_ms);
philipelbe742702016-11-30 01:31:40 -0800675 }
philipel266f0a42016-11-28 08:49:07 -0800676}
677
ilnik2edc6842017-07-06 03:06:50 -0700678void FrameBuffer::UpdateTimingFrameInfo() {
679 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateTimingFrameInfo");
Danil Chapovalov0040b662018-06-18 10:48:16 +0200680 absl::optional<TimingFrameInfo> info = timing_->GetTimingFrameInfo();
philipel97187112018-03-23 10:43:21 +0100681 if (info && stats_callback_)
ilnik2edc6842017-07-06 03:06:50 -0700682 stats_callback_->OnTimingFrameInfoUpdated(*info);
683}
684
philipelfcc60062017-01-18 05:35:20 -0800685void FrameBuffer::ClearFramesAndHistory() {
ilnik2edc6842017-07-06 03:06:50 -0700686 TRACE_EVENT0("webrtc", "FrameBuffer::ClearFramesAndHistory");
Johannes Kron0c141c52019-08-26 15:04:43 +0200687 if (stats_callback_) {
688 unsigned int dropped_frames = std::count_if(
689 frames_.begin(), frames_.end(),
690 [](const std::pair<const VideoLayerFrameId, FrameInfo>& frame) {
691 return frame.second.frame != nullptr;
692 });
693 if (dropped_frames > 0) {
694 stats_callback_->OnDroppedFrames(dropped_frames);
695 }
696 }
philipelfcc60062017-01-18 05:35:20 -0800697 frames_.clear();
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100698 last_continuous_frame_.reset();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100699 frames_to_decode_.clear();
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100700 decoded_frames_history_.Clear();
philipelfcc60062017-01-18 05:35:20 -0800701}
702
Niels Möllerff2e2152019-09-27 10:29:30 +0200703// TODO(philipel): Avoid the concatenation of frames here, by replacing
704// NextFrame and GetNextFrame with methods returning multiple frames.
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100705EncodedFrame* FrameBuffer::CombineAndDeleteFrames(
706 const std::vector<EncodedFrame*>& frames) const {
707 RTC_DCHECK(!frames.empty());
Sergey Silkin61832dd2018-12-20 14:32:14 +0100708 EncodedFrame* first_frame = frames[0];
709 EncodedFrame* last_frame = frames.back();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100710 size_t total_length = 0;
711 for (size_t i = 0; i < frames.size(); ++i) {
712 total_length += frames[i]->size();
713 }
Niels Möllerff2e2152019-09-27 10:29:30 +0200714 auto encoded_image_buffer = EncodedImageBuffer::Create(total_length);
715 uint8_t* buffer = encoded_image_buffer->data();
Sergey Silkin2799e632019-05-17 09:51:39 +0200716 first_frame->SetSpatialLayerFrameSize(first_frame->id.spatial_layer,
717 first_frame->size());
Niels Möllerff2e2152019-09-27 10:29:30 +0200718 memcpy(buffer, first_frame->data(), first_frame->size());
719 buffer += first_frame->size();
Sergey Silkin2799e632019-05-17 09:51:39 +0200720
Sergey Silkin61832dd2018-12-20 14:32:14 +0100721 // Spatial index of combined frame is set equal to spatial index of its top
722 // spatial layer.
723 first_frame->SetSpatialIndex(last_frame->id.spatial_layer);
724 first_frame->id.spatial_layer = last_frame->id.spatial_layer;
725
726 first_frame->video_timing_mutable()->network2_timestamp_ms =
727 last_frame->video_timing().network2_timestamp_ms;
728 first_frame->video_timing_mutable()->receive_finish_ms =
729 last_frame->video_timing().receive_finish_ms;
730
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100731 // Append all remaining frames to the first one.
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100732 for (size_t i = 1; i < frames.size(); ++i) {
Sergey Silkin61832dd2018-12-20 14:32:14 +0100733 EncodedFrame* next_frame = frames[i];
Sergey Silkin2799e632019-05-17 09:51:39 +0200734 first_frame->SetSpatialLayerFrameSize(next_frame->id.spatial_layer,
735 next_frame->size());
Niels Möller9c843902019-01-11 10:21:35 +0100736 memcpy(buffer, next_frame->data(), next_frame->size());
Sergey Silkin61832dd2018-12-20 14:32:14 +0100737 buffer += next_frame->size();
738 delete next_frame;
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100739 }
Niels Möllerff2e2152019-09-27 10:29:30 +0200740 first_frame->SetEncodedData(encoded_image_buffer);
Sergey Silkin61832dd2018-12-20 14:32:14 +0100741 return first_frame;
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100742}
743
Niels Möllerbe682d42018-03-27 08:31:45 +0200744FrameBuffer::FrameInfo::FrameInfo() = default;
745FrameBuffer::FrameInfo::FrameInfo(FrameInfo&&) = default;
746FrameBuffer::FrameInfo::~FrameInfo() = default;
747
philipelbe7a9e52016-05-19 12:19:35 +0200748} // namespace video_coding
749} // namespace webrtc