blob: 0c2a624235c11a5431498e47f9cdc88267b7bfec [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
Yves Gerey3e707812018-11-28 16:47:49 +010020#include "api/video/encoded_image.h"
21#include "api/video/video_timing.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020022#include "modules/video_coding/include/video_coding_defines.h"
23#include "modules/video_coding/jitter_estimator.h"
24#include "modules/video_coding/timing.h"
25#include "rtc_base/checks.h"
Yves Gerey3e707812018-11-28 16:47:49 +010026#include "rtc_base/experiments/rtt_mult_experiment.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020027#include "rtc_base/logging.h"
Yves Gerey3e707812018-11-28 16:47:49 +010028#include "rtc_base/numerics/sequence_number_util.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020029#include "rtc_base/trace_event.h"
30#include "system_wrappers/include/clock.h"
philipel707f2782017-10-02 14:10:28 +020031#include "system_wrappers/include/field_trial.h"
philipelbe7a9e52016-05-19 12:19:35 +020032
33namespace webrtc {
34namespace video_coding {
35
36namespace {
philipele0b2f152016-09-28 10:23:49 +020037// Max number of frames the buffer will hold.
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +010038constexpr size_t kMaxFramesBuffered = 800;
philipelbe7a9e52016-05-19 12:19:35 +020039
philipele0b2f152016-09-28 10:23:49 +020040// Max number of decoded frame info that will be saved.
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +010041constexpr int kMaxFramesHistory = 1 << 13;
philipel65e1f942017-07-24 08:26:53 -070042
Ilya Nikolaevskiy8c4fe162018-02-27 15:49:47 +010043// The time it's allowed for a frame to be late to its rendering prediction and
44// still be rendered.
Ilya Nikolaevskiy7eef0072018-02-28 09:59:26 +010045constexpr int kMaxAllowedFrameDelayMs = 5;
Ilya Nikolaevskiy8c4fe162018-02-27 15:49:47 +010046
philipel65e1f942017-07-24 08:26:53 -070047constexpr int64_t kLogNonDecodedIntervalMs = 5000;
philipelbe7a9e52016-05-19 12:19:35 +020048} // namespace
49
philipelbe7a9e52016-05-19 12:19:35 +020050FrameBuffer::FrameBuffer(Clock* clock,
51 VCMJitterEstimator* jitter_estimator,
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),
philipelbe7a9e52016-05-19 12:19:35 +020056 jitter_estimator_(jitter_estimator),
57 timing_(timing),
philipel4f6cd6a2016-08-03 10:59:32 +020058 inter_frame_delay_(clock_->TimeInMilliseconds()),
philipel29f730e2017-03-15 08:10:08 -070059 stopped_(false),
philipela45102f2017-02-22 05:30:39 -080060 protection_mode_(kProtectionNack),
philipel65e1f942017-07-24 08:26:53 -070061 stats_callback_(stats_callback),
Elad Alone4b50232019-01-14 18:56:14 +010062 last_log_non_decoded_ms_(-kLogNonDecodedIntervalMs),
63 add_rtt_to_playout_delay_(
Henrik Boströmc680c4a2019-04-03 10:27:36 +000064 webrtc::field_trial::IsEnabled("WebRTC-AddRttToPlayoutDelay")) {}
philipel266f0a42016-11-28 08:49:07 -080065
philipela45102f2017-02-22 05:30:39 -080066FrameBuffer::~FrameBuffer() {}
philipelbe7a9e52016-05-19 12:19:35 +020067
philipel75562822016-09-05 10:57:41 +020068FrameBuffer::ReturnReason FrameBuffer::NextFrame(
69 int64_t max_wait_time_ms,
philipele7c891f2018-02-22 14:35:06 +010070 std::unique_ptr<EncodedFrame>* frame_out,
philipel3042c2d2017-08-18 04:55:02 -070071 bool keyframe_required) {
tommidb23ea62017-03-03 07:21:18 -080072 TRACE_EVENT0("webrtc", "FrameBuffer::NextFrame");
philipel1c056252017-01-31 09:53:12 -080073 int64_t latest_return_time_ms =
74 clock_->TimeInMilliseconds() + max_wait_time_ms;
philipel504c47d2016-06-30 17:33:02 +020075 int64_t wait_ms = max_wait_time_ms;
philipel29f730e2017-03-15 08:10:08 -070076 int64_t now_ms = 0;
philipele0b2f152016-09-28 10:23:49 +020077
78 do {
philipel29f730e2017-03-15 08:10:08 -070079 now_ms = clock_->TimeInMilliseconds();
philipel504c47d2016-06-30 17:33:02 +020080 {
81 rtc::CritScope lock(&crit_);
tommi0a735642017-03-14 06:23:57 -070082 new_continuous_frame_event_.Reset();
philipel29f730e2017-03-15 08:10:08 -070083 if (stopped_)
84 return kStopped;
85
Sebastian Jansson1c747f52019-04-04 13:01:39 +020086 keyframe_required_ = keyframe_required;
87 latest_return_time_ms_ = latest_return_time_ms;
88 wait_ms = FindNextFrame(now_ms);
89 }
tommi0a735642017-03-14 06:23:57 -070090 } while (new_continuous_frame_event_.Wait(wait_ms));
philipele0b2f152016-09-28 10:23:49 +020091
philipel29f730e2017-03-15 08:10:08 -070092 {
93 rtc::CritScope lock(&crit_);
philipele0b2f152016-09-28 10:23:49 +020094
Ilya Nikolaevskiyfdfe1c92019-01-18 13:33:38 +010095 if (!frames_to_decode_.empty()) {
Sebastian Jansson1c747f52019-04-04 13:01:39 +020096 frame_out->reset(GetNextFrame());
philipel29f730e2017-03-15 08:10:08 -070097 return kFrameFound;
philipelbe7a9e52016-05-19 12:19:35 +020098 }
Sebastian Jansson1c747f52019-04-04 13:01:39 +020099 }
tommi0a735642017-03-14 06:23:57 -0700100
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200101 if (latest_return_time_ms - clock_->TimeInMilliseconds() > 0) {
philipel1c056252017-01-31 09:53:12 -0800102 // If |next_frame_it_ == frames_.end()| and there is still time left, it
103 // means that the frame buffer was cleared as the thread in this function
104 // was waiting to acquire |crit_| in order to return. Wait for the
105 // remaining time and then return.
106 return NextFrame(latest_return_time_ms - now_ms, frame_out);
philipelbe7a9e52016-05-19 12:19:35 +0200107 }
tommi0a735642017-03-14 06:23:57 -0700108 return kTimeout;
philipelbe7a9e52016-05-19 12:19:35 +0200109}
110
Sebastian Jansson1c747f52019-04-04 13:01:39 +0200111int64_t FrameBuffer::FindNextFrame(int64_t now_ms) {
112 int64_t wait_ms = latest_return_time_ms_ - now_ms;
113 frames_to_decode_.clear();
114
115 // |last_continuous_frame_| may be empty below, but nullopt is smaller
116 // than everything else and loop will immediately terminate as expected.
117 for (auto frame_it = frames_.begin();
118 frame_it != frames_.end() && frame_it->first <= last_continuous_frame_;
119 ++frame_it) {
120 if (!frame_it->second.continuous ||
121 frame_it->second.num_missing_decodable > 0) {
122 continue;
123 }
124
125 EncodedFrame* frame = frame_it->second.frame.get();
126
127 if (keyframe_required_ && !frame->is_keyframe())
128 continue;
129
130 auto last_decoded_frame_timestamp =
131 decoded_frames_history_.GetLastDecodedFrameTimestamp();
132
133 // TODO(https://bugs.webrtc.org/9974): consider removing this check
134 // as it may make a stream undecodable after a very long delay between
135 // frames.
136 if (last_decoded_frame_timestamp &&
137 AheadOf(*last_decoded_frame_timestamp, frame->Timestamp())) {
138 continue;
139 }
140
141 // Only ever return all parts of a superframe. Therefore skip this
142 // frame if it's not a beginning of a superframe.
143 if (frame->inter_layer_predicted) {
144 continue;
145 }
146
147 // Gather all remaining frames for the same superframe.
148 std::vector<FrameMap::iterator> current_superframe;
149 current_superframe.push_back(frame_it);
150 bool last_layer_completed = frame_it->second.frame->is_last_spatial_layer;
151 FrameMap::iterator next_frame_it = frame_it;
152 while (true) {
153 ++next_frame_it;
154 if (next_frame_it == frames_.end() ||
155 next_frame_it->first.picture_id != frame->id.picture_id ||
156 !next_frame_it->second.continuous) {
157 break;
158 }
159 // Check if the next frame has some undecoded references other than
160 // the previous frame in the same superframe.
161 size_t num_allowed_undecoded_refs =
162 (next_frame_it->second.frame->inter_layer_predicted) ? 1 : 0;
163 if (next_frame_it->second.num_missing_decodable >
164 num_allowed_undecoded_refs) {
165 break;
166 }
167 // All frames in the superframe should have the same timestamp.
168 if (frame->Timestamp() != next_frame_it->second.frame->Timestamp()) {
169 RTC_LOG(LS_WARNING) << "Frames in a single superframe have different"
170 " timestamps. Skipping undecodable superframe.";
171 break;
172 }
173 current_superframe.push_back(next_frame_it);
174 last_layer_completed = next_frame_it->second.frame->is_last_spatial_layer;
175 }
176 // Check if the current superframe is complete.
177 // TODO(bugs.webrtc.org/10064): consider returning all available to
178 // decode frames even if the superframe is not complete yet.
179 if (!last_layer_completed) {
180 continue;
181 }
182
183 frames_to_decode_ = std::move(current_superframe);
184
185 if (frame->RenderTime() == -1) {
186 frame->SetRenderTime(timing_->RenderTimeMs(frame->Timestamp(), now_ms));
187 }
188 wait_ms = timing_->MaxWaitingTime(frame->RenderTime(), now_ms);
189
190 // This will cause the frame buffer to prefer high framerate rather
191 // than high resolution in the case of the decoder not decoding fast
192 // enough and the stream has multiple spatial and temporal layers.
193 // For multiple temporal layers it may cause non-base layer frames to be
194 // skipped if they are late.
195 if (wait_ms < -kMaxAllowedFrameDelayMs)
196 continue;
197
198 break;
199 }
200 wait_ms = std::min<int64_t>(wait_ms, latest_return_time_ms_ - now_ms);
201 wait_ms = std::max<int64_t>(wait_ms, 0);
202 return wait_ms;
203}
204
205EncodedFrame* FrameBuffer::GetNextFrame() {
206 int64_t now_ms = clock_->TimeInMilliseconds();
207 // TODO(ilnik): remove |frames_out| use frames_to_decode_ directly.
208 std::vector<EncodedFrame*> frames_out;
209
210 RTC_DCHECK(!frames_to_decode_.empty());
211 bool superframe_delayed_by_retransmission = false;
212 size_t superframe_size = 0;
213 EncodedFrame* first_frame = frames_to_decode_[0]->second.frame.get();
214 int64_t render_time_ms = first_frame->RenderTime();
215 int64_t receive_time_ms = first_frame->ReceivedTime();
216 // Gracefully handle bad RTP timestamps and render time issues.
217 if (HasBadRenderTiming(*first_frame, now_ms)) {
218 jitter_estimator_->Reset();
219 timing_->Reset();
220 render_time_ms = timing_->RenderTimeMs(first_frame->Timestamp(), now_ms);
221 }
222
223 for (FrameMap::iterator& frame_it : frames_to_decode_) {
224 RTC_DCHECK(frame_it != frames_.end());
225 EncodedFrame* frame = frame_it->second.frame.release();
226
227 frame->SetRenderTime(render_time_ms);
228
229 superframe_delayed_by_retransmission |= frame->delayed_by_retransmission();
230 receive_time_ms = std::max(receive_time_ms, frame->ReceivedTime());
231 superframe_size += frame->size();
232
233 PropagateDecodability(frame_it->second);
234 decoded_frames_history_.InsertDecoded(frame_it->first, frame->Timestamp());
235
236 // Remove decoded frame and all undecoded frames before it.
237 frames_.erase(frames_.begin(), ++frame_it);
238
239 frames_out.push_back(frame);
240 }
241
242 if (!superframe_delayed_by_retransmission) {
243 int64_t frame_delay;
244
245 if (inter_frame_delay_.CalculateDelay(first_frame->Timestamp(),
246 &frame_delay, receive_time_ms)) {
247 jitter_estimator_->UpdateEstimate(frame_delay, superframe_size);
248 }
249
250 float rtt_mult = protection_mode_ == kProtectionNackFEC ? 0.0 : 1.0;
251 if (RttMultExperiment::RttMultEnabled()) {
252 rtt_mult = RttMultExperiment::GetRttMultValue();
253 }
254 timing_->SetJitterDelay(jitter_estimator_->GetJitterEstimate(rtt_mult));
255 timing_->UpdateCurrentDelay(render_time_ms, now_ms);
256 } else {
257 if (RttMultExperiment::RttMultEnabled() || add_rtt_to_playout_delay_)
258 jitter_estimator_->FrameNacked();
259 }
260
261 UpdateJitterDelay();
262 UpdateTimingFrameInfo();
263
264 if (frames_out.size() == 1) {
265 return frames_out[0];
266 } else {
267 return CombineAndDeleteFrames(frames_out);
268 }
269}
270
philipele7c891f2018-02-22 14:35:06 +0100271bool FrameBuffer::HasBadRenderTiming(const EncodedFrame& frame,
272 int64_t now_ms) {
stefan95e97542017-05-23 09:52:18 -0700273 // Assume that render timing errors are due to changes in the video stream.
274 int64_t render_time_ms = frame.RenderTimeMs();
Stefan Holmer812ceaf2018-05-15 13:00:10 +0200275 // Zero render time means render immediately.
276 if (render_time_ms == 0) {
277 return false;
278 }
stefan95e97542017-05-23 09:52:18 -0700279 if (render_time_ms < 0) {
280 return true;
281 }
Stefan Holmer812ceaf2018-05-15 13:00:10 +0200282 const int64_t kMaxVideoDelayMs = 10000;
stefan95e97542017-05-23 09:52:18 -0700283 if (std::abs(render_time_ms - now_ms) > kMaxVideoDelayMs) {
284 int frame_delay = static_cast<int>(std::abs(render_time_ms - now_ms));
Mirko Bonadei675513b2017-11-09 11:09:25 +0100285 RTC_LOG(LS_WARNING)
286 << "A frame about to be decoded is out of the configured "
287 << "delay bounds (" << frame_delay << " > " << kMaxVideoDelayMs
288 << "). Resetting the video jitter buffer.";
stefan95e97542017-05-23 09:52:18 -0700289 return true;
290 }
291 if (static_cast<int>(timing_->TargetVideoDelay()) > kMaxVideoDelayMs) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100292 RTC_LOG(LS_WARNING) << "The video target delay has grown larger than "
293 << kMaxVideoDelayMs << " ms.";
stefan95e97542017-05-23 09:52:18 -0700294 return true;
295 }
296 return false;
297}
298
philipel4f6cd6a2016-08-03 10:59:32 +0200299void FrameBuffer::SetProtectionMode(VCMVideoProtection mode) {
tommidb23ea62017-03-03 07:21:18 -0800300 TRACE_EVENT0("webrtc", "FrameBuffer::SetProtectionMode");
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000301 rtc::CritScope lock(&crit_);
302 protection_mode_ = mode;
philipel4f6cd6a2016-08-03 10:59:32 +0200303}
304
philipel504c47d2016-06-30 17:33:02 +0200305void FrameBuffer::Start() {
tommidb23ea62017-03-03 07:21:18 -0800306 TRACE_EVENT0("webrtc", "FrameBuffer::Start");
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000307 rtc::CritScope lock(&crit_);
308 stopped_ = false;
philipel504c47d2016-06-30 17:33:02 +0200309}
310
311void FrameBuffer::Stop() {
tommidb23ea62017-03-03 07:21:18 -0800312 TRACE_EVENT0("webrtc", "FrameBuffer::Stop");
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000313 rtc::CritScope lock(&crit_);
314 stopped_ = true;
315 new_continuous_frame_event_.Set();
philipel504c47d2016-06-30 17:33:02 +0200316}
317
Ilya Nikolaevskiye6a2d942018-11-07 14:32:28 +0100318void FrameBuffer::Clear() {
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000319 rtc::CritScope lock(&crit_);
320 ClearFramesAndHistory();
Ilya Nikolaevskiye6a2d942018-11-07 14:32:28 +0100321}
322
philipele21be1d2017-09-25 06:37:12 -0700323void FrameBuffer::UpdateRtt(int64_t rtt_ms) {
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000324 rtc::CritScope lock(&crit_);
325 jitter_estimator_->UpdateRtt(rtt_ms);
philipele21be1d2017-09-25 06:37:12 -0700326}
327
philipele7c891f2018-02-22 14:35:06 +0100328bool FrameBuffer::ValidReferences(const EncodedFrame& frame) const {
philipel112adf92017-06-15 09:06:21 -0700329 for (size_t i = 0; i < frame.num_references; ++i) {
Philip Eliasson1f850a62019-03-19 12:15:00 +0000330 if (frame.references[i] >= frame.id.picture_id)
philipel112adf92017-06-15 09:06:21 -0700331 return false;
philipel3b3c9c42017-09-11 09:38:36 -0700332
philipel112adf92017-06-15 09:06:21 -0700333 for (size_t j = i + 1; j < frame.num_references; ++j) {
334 if (frame.references[i] == frame.references[j])
335 return false;
336 }
337 }
338
philipel0fa82a62018-03-19 15:34:53 +0100339 if (frame.inter_layer_predicted && frame.id.spatial_layer == 0)
philipel112adf92017-06-15 09:06:21 -0700340 return false;
341
342 return true;
343}
344
Ilya Nikolaevskiy48193b02019-03-25 11:40:34 +0100345bool FrameBuffer::IsCompleteSuperFrame(const EncodedFrame& frame) {
346 if (frame.inter_layer_predicted) {
347 // Check that all previous spatial layers are already inserted.
348 VideoLayerFrameId id = frame.id;
349 RTC_DCHECK_GT(id.spatial_layer, 0);
350 --id.spatial_layer;
351 FrameMap::iterator prev_frame = frames_.find(id);
352 if (prev_frame == frames_.end())
353 return false;
354 while (prev_frame->second.frame->inter_layer_predicted) {
355 --prev_frame;
356 --id.spatial_layer;
357 if (prev_frame == frames_.end() ||
358 prev_frame->first.picture_id != id.picture_id ||
359 prev_frame->first.spatial_layer != id.spatial_layer) {
360 return false;
361 }
362 }
363 }
364
365 if (!frame.is_last_spatial_layer) {
366 // Check that all following spatial layers are already inserted.
367 VideoLayerFrameId id = frame.id;
368 ++id.spatial_layer;
369 FrameMap::iterator next_frame = frames_.find(id);
370 if (next_frame == frames_.end())
371 return false;
372 while (!next_frame->second.frame->is_last_spatial_layer) {
373 ++next_frame;
374 ++id.spatial_layer;
375 if (next_frame == frames_.end() ||
376 next_frame->first.picture_id != id.picture_id ||
377 next_frame->first.spatial_layer != id.spatial_layer) {
378 return false;
379 }
380 }
381 }
382
383 return true;
384}
385
philipele7c891f2018-02-22 14:35:06 +0100386int64_t FrameBuffer::InsertFrame(std::unique_ptr<EncodedFrame> frame) {
tommidb23ea62017-03-03 07:21:18 -0800387 TRACE_EVENT0("webrtc", "FrameBuffer::InsertFrame");
philipel93e451b2016-10-06 12:25:13 +0200388 RTC_DCHECK(frame);
tommi0a735642017-03-14 06:23:57 -0700389
390 rtc::CritScope lock(&crit_);
philipel29f730e2017-03-15 08:10:08 -0700391
Ilya Nikolaevskiy48193b02019-03-25 11:40:34 +0100392 if (stats_callback_ && IsCompleteSuperFrame(*frame)) {
393 stats_callback_->OnCompleteFrame(frame->is_keyframe(), frame->size(),
394 frame->contentType());
395 }
396 const VideoLayerFrameId& id = frame->id;
397
philipel1610f942017-12-12 13:58:31 +0100398 int64_t last_continuous_picture_id =
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100399 !last_continuous_frame_ ? -1 : last_continuous_frame_->picture_id;
philipele0b2f152016-09-28 10:23:49 +0200400
philipel112adf92017-06-15 09:06:21 -0700401 if (!ValidReferences(*frame)) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100402 RTC_LOG(LS_WARNING) << "Frame with (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100403 << id.picture_id << ":"
404 << static_cast<int>(id.spatial_layer)
Mirko Bonadei675513b2017-11-09 11:09:25 +0100405 << ") has invalid frame references, dropping frame.";
philipel112adf92017-06-15 09:06:21 -0700406 return last_continuous_picture_id;
407 }
408
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100409 if (frames_.size() >= kMaxFramesBuffered) {
philipel9771c502018-03-02 11:06:27 +0100410 if (frame->is_keyframe()) {
411 RTC_LOG(LS_WARNING) << "Inserting keyframe (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100412 << id.picture_id << ":"
413 << static_cast<int>(id.spatial_layer)
philipel9771c502018-03-02 11:06:27 +0100414 << ") but buffer is full, clearing"
415 << " buffer and inserting the frame.";
416 ClearFramesAndHistory();
417 } else {
418 RTC_LOG(LS_WARNING) << "Frame with (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100419 << id.picture_id << ":"
420 << static_cast<int>(id.spatial_layer)
philipel9771c502018-03-02 11:06:27 +0100421 << ") could not be inserted due to the frame "
422 << "buffer being full, dropping frame.";
423 return last_continuous_picture_id;
424 }
philipele0b2f152016-09-28 10:23:49 +0200425 }
426
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100427 auto last_decoded_frame = decoded_frames_history_.GetLastDecodedFrameId();
428 auto last_decoded_frame_timestamp =
429 decoded_frames_history_.GetLastDecodedFrameTimestamp();
430 if (last_decoded_frame && id <= *last_decoded_frame) {
431 if (AheadOf(frame->Timestamp(), *last_decoded_frame_timestamp) &&
philipel3042c2d2017-08-18 04:55:02 -0700432 frame->is_keyframe()) {
philipelfcc60062017-01-18 05:35:20 -0800433 // If this frame has a newer timestamp but an earlier picture id then we
434 // assume there has been a jump in the picture id due to some encoder
435 // reconfiguration or some other reason. Even though this is not according
436 // to spec we can still continue to decode from this frame if it is a
437 // keyframe.
Mirko Bonadei675513b2017-11-09 11:09:25 +0100438 RTC_LOG(LS_WARNING)
439 << "A jump in picture id was detected, clearing buffer.";
philipelfcc60062017-01-18 05:35:20 -0800440 ClearFramesAndHistory();
441 last_continuous_picture_id = -1;
442 } else {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100443 RTC_LOG(LS_WARNING) << "Frame with (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100444 << id.picture_id << ":"
445 << static_cast<int>(id.spatial_layer)
Mirko Bonadei675513b2017-11-09 11:09:25 +0100446 << ") inserted after frame ("
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100447 << last_decoded_frame->picture_id << ":"
448 << static_cast<int>(last_decoded_frame->spatial_layer)
Mirko Bonadei675513b2017-11-09 11:09:25 +0100449 << ") was handed off for decoding, dropping frame.";
philipelfcc60062017-01-18 05:35:20 -0800450 return last_continuous_picture_id;
451 }
philipele0b2f152016-09-28 10:23:49 +0200452 }
453
philipel146a48b2017-04-20 04:04:38 -0700454 // Test if inserting this frame would cause the order of the frames to become
455 // ambiguous (covering more than half the interval of 2^16). This can happen
456 // when the picture id make large jumps mid stream.
philipel0fa82a62018-03-19 15:34:53 +0100457 if (!frames_.empty() && id < frames_.begin()->first &&
458 frames_.rbegin()->first < id) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100459 RTC_LOG(LS_WARNING)
460 << "A jump in picture id was detected, clearing buffer.";
philipel146a48b2017-04-20 04:04:38 -0700461 ClearFramesAndHistory();
462 last_continuous_picture_id = -1;
463 }
464
philipel0fa82a62018-03-19 15:34:53 +0100465 auto info = frames_.emplace(id, FrameInfo()).first;
philipele0b2f152016-09-28 10:23:49 +0200466
philipel93e451b2016-10-06 12:25:13 +0200467 if (info->second.frame) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100468 RTC_LOG(LS_WARNING) << "Frame with (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100469 << id.picture_id << ":"
470 << static_cast<int>(id.spatial_layer)
Mirko Bonadei675513b2017-11-09 11:09:25 +0100471 << ") already inserted, dropping frame.";
philipele0b2f152016-09-28 10:23:49 +0200472 return last_continuous_picture_id;
473 }
474
philipel93e451b2016-10-06 12:25:13 +0200475 if (!UpdateFrameInfoWithIncomingFrame(*frame, info))
476 return last_continuous_picture_id;
Ruslan Burakov493a6502019-02-27 15:32:48 +0100477
478 if (!frame->delayed_by_retransmission())
479 timing_->IncomingTimestamp(frame->Timestamp(), frame->ReceivedTime());
philipel0a9f6de2018-02-28 11:29:47 +0100480
philipele0b2f152016-09-28 10:23:49 +0200481 info->second.frame = std::move(frame);
philipele0b2f152016-09-28 10:23:49 +0200482
483 if (info->second.num_missing_continuous == 0) {
484 info->second.continuous = true;
485 PropagateContinuity(info);
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100486 last_continuous_picture_id = last_continuous_frame_->picture_id;
philipele0b2f152016-09-28 10:23:49 +0200487
488 // Since we now have new continuous frames there might be a better frame
Henrik Boströmc680c4a2019-04-03 10:27:36 +0000489 // to return from NextFrame. Signal that thread so that it again can choose
490 // which frame to return.
491 new_continuous_frame_event_.Set();
philipele0b2f152016-09-28 10:23:49 +0200492 }
493
494 return last_continuous_picture_id;
philipelbe7a9e52016-05-19 12:19:35 +0200495}
496
philipele0b2f152016-09-28 10:23:49 +0200497void FrameBuffer::PropagateContinuity(FrameMap::iterator start) {
tommidb23ea62017-03-03 07:21:18 -0800498 TRACE_EVENT0("webrtc", "FrameBuffer::PropagateContinuity");
philipele0b2f152016-09-28 10:23:49 +0200499 RTC_DCHECK(start->second.continuous);
philipele0b2f152016-09-28 10:23:49 +0200500
501 std::queue<FrameMap::iterator> continuous_frames;
502 continuous_frames.push(start);
503
504 // A simple BFS to traverse continuous frames.
505 while (!continuous_frames.empty()) {
506 auto frame = continuous_frames.front();
507 continuous_frames.pop();
508
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100509 if (!last_continuous_frame_ || *last_continuous_frame_ < frame->first) {
510 last_continuous_frame_ = frame->first;
511 }
philipele0b2f152016-09-28 10:23:49 +0200512
513 // Loop through all dependent frames, and if that frame no longer has
514 // any unfulfilled dependencies then that frame is continuous as well.
Elad Alon69321dd2019-01-10 15:02:54 +0100515 for (size_t d = 0; d < frame->second.dependent_frames.size(); ++d) {
philipele0b2f152016-09-28 10:23:49 +0200516 auto frame_ref = frames_.find(frame->second.dependent_frames[d]);
philipel112adf92017-06-15 09:06:21 -0700517 RTC_DCHECK(frame_ref != frames_.end());
philipele0b2f152016-09-28 10:23:49 +0200518
philipel112adf92017-06-15 09:06:21 -0700519 // TODO(philipel): Look into why we've seen this happen.
520 if (frame_ref != frames_.end()) {
521 --frame_ref->second.num_missing_continuous;
522 if (frame_ref->second.num_missing_continuous == 0) {
523 frame_ref->second.continuous = true;
524 continuous_frames.push(frame_ref);
525 }
philipele0b2f152016-09-28 10:23:49 +0200526 }
527 }
528 }
529}
530
531void FrameBuffer::PropagateDecodability(const FrameInfo& info) {
tommidb23ea62017-03-03 07:21:18 -0800532 TRACE_EVENT0("webrtc", "FrameBuffer::PropagateDecodability");
Elad Alon69321dd2019-01-10 15:02:54 +0100533 for (size_t d = 0; d < info.dependent_frames.size(); ++d) {
philipele0b2f152016-09-28 10:23:49 +0200534 auto ref_info = frames_.find(info.dependent_frames[d]);
philipel93e451b2016-10-06 12:25:13 +0200535 RTC_DCHECK(ref_info != frames_.end());
tommie95b78b2017-05-14 07:23:11 -0700536 // TODO(philipel): Look into why we've seen this happen.
537 if (ref_info != frames_.end()) {
538 RTC_DCHECK_GT(ref_info->second.num_missing_decodable, 0U);
539 --ref_info->second.num_missing_decodable;
540 }
philipele0b2f152016-09-28 10:23:49 +0200541 }
542}
543
philipele7c891f2018-02-22 14:35:06 +0100544bool FrameBuffer::UpdateFrameInfoWithIncomingFrame(const EncodedFrame& frame,
philipele0b2f152016-09-28 10:23:49 +0200545 FrameMap::iterator info) {
tommidb23ea62017-03-03 07:21:18 -0800546 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateFrameInfoWithIncomingFrame");
philipel0fa82a62018-03-19 15:34:53 +0100547 const VideoLayerFrameId& id = frame.id;
philipele0b2f152016-09-28 10:23:49 +0200548
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100549 auto last_decoded_frame = decoded_frames_history_.GetLastDecodedFrameId();
550 RTC_DCHECK(!last_decoded_frame || *last_decoded_frame < info->first);
philipele0b2f152016-09-28 10:23:49 +0200551
philipel798b2822018-06-11 13:10:14 +0200552 // In this function we determine how many missing dependencies this |frame|
553 // has to become continuous/decodable. If a frame that this |frame| depend
554 // on has already been decoded then we can ignore that dependency since it has
555 // already been fulfilled.
556 //
557 // For all other frames we will register a backwards reference to this |frame|
558 // so that |num_missing_continuous| and |num_missing_decodable| can be
559 // decremented as frames become continuous/are decoded.
560 struct Dependency {
561 VideoLayerFrameId id;
562 bool continuous;
563 };
564 std::vector<Dependency> not_yet_fulfilled_dependencies;
565
566 // Find all dependencies that have not yet been fulfilled.
philipele0b2f152016-09-28 10:23:49 +0200567 for (size_t i = 0; i < frame.num_references; ++i) {
philipel0fa82a62018-03-19 15:34:53 +0100568 VideoLayerFrameId ref_key(frame.references[i], frame.id.spatial_layer);
philipel798b2822018-06-11 13:10:14 +0200569 // Does |frame| depend on a frame earlier than the last decoded one?
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100570 if (last_decoded_frame && ref_key <= *last_decoded_frame) {
philipel798b2822018-06-11 13:10:14 +0200571 // Was that frame decoded? If not, this |frame| will never become
572 // decodable.
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100573 if (!decoded_frames_history_.WasDecoded(ref_key)) {
philipel65e1f942017-07-24 08:26:53 -0700574 int64_t now_ms = clock_->TimeInMilliseconds();
575 if (last_log_non_decoded_ms_ + kLogNonDecodedIntervalMs < now_ms) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100576 RTC_LOG(LS_WARNING)
philipel0fa82a62018-03-19 15:34:53 +0100577 << "Frame with (picture_id:spatial_id) (" << id.picture_id << ":"
578 << static_cast<int>(id.spatial_layer)
philipel65e1f942017-07-24 08:26:53 -0700579 << ") depends on a non-decoded frame more previous than"
580 << " the last decoded frame, dropping frame.";
581 last_log_non_decoded_ms_ = now_ms;
582 }
philipele0b2f152016-09-28 10:23:49 +0200583 return false;
584 }
philipele0b2f152016-09-28 10:23:49 +0200585 } else {
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100586 auto ref_info = frames_.find(ref_key);
philipel798b2822018-06-11 13:10:14 +0200587 bool ref_continuous =
588 ref_info != frames_.end() && ref_info->second.continuous;
589 not_yet_fulfilled_dependencies.push_back({ref_key, ref_continuous});
philipele0b2f152016-09-28 10:23:49 +0200590 }
philipelbe7a9e52016-05-19 12:19:35 +0200591 }
592
philipel798b2822018-06-11 13:10:14 +0200593 // Does |frame| depend on the lower spatial layer?
philipelbe7a9e52016-05-19 12:19:35 +0200594 if (frame.inter_layer_predicted) {
philipel0fa82a62018-03-19 15:34:53 +0100595 VideoLayerFrameId ref_key(frame.id.picture_id, frame.id.spatial_layer - 1);
philipel798b2822018-06-11 13:10:14 +0200596 auto ref_info = frames_.find(ref_key);
philipele0b2f152016-09-28 10:23:49 +0200597
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100598 bool lower_layer_decoded =
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100599 last_decoded_frame && *last_decoded_frame == ref_key;
philipel798b2822018-06-11 13:10:14 +0200600 bool lower_layer_continuous =
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100601 lower_layer_decoded ||
602 (ref_info != frames_.end() && ref_info->second.continuous);
philipel798b2822018-06-11 13:10:14 +0200603
604 if (!lower_layer_continuous || !lower_layer_decoded) {
605 not_yet_fulfilled_dependencies.push_back(
606 {ref_key, lower_layer_continuous});
philipele0b2f152016-09-28 10:23:49 +0200607 }
philipelbe7a9e52016-05-19 12:19:35 +0200608 }
609
philipel798b2822018-06-11 13:10:14 +0200610 info->second.num_missing_continuous = not_yet_fulfilled_dependencies.size();
611 info->second.num_missing_decodable = not_yet_fulfilled_dependencies.size();
612
613 for (const Dependency& dep : not_yet_fulfilled_dependencies) {
614 if (dep.continuous)
615 --info->second.num_missing_continuous;
616
Elad Alon69321dd2019-01-10 15:02:54 +0100617 frames_[dep.id].dependent_frames.push_back(id);
philipel798b2822018-06-11 13:10:14 +0200618 }
philipel93e451b2016-10-06 12:25:13 +0200619
philipelbe7a9e52016-05-19 12:19:35 +0200620 return true;
621}
622
philipelbe742702016-11-30 01:31:40 -0800623void FrameBuffer::UpdateJitterDelay() {
tommidb23ea62017-03-03 07:21:18 -0800624 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateJitterDelay");
philipela45102f2017-02-22 05:30:39 -0800625 if (!stats_callback_)
626 return;
philipelbe742702016-11-30 01:31:40 -0800627
philipela45102f2017-02-22 05:30:39 -0800628 int decode_ms;
629 int max_decode_ms;
630 int current_delay_ms;
631 int target_delay_ms;
632 int jitter_buffer_ms;
633 int min_playout_delay_ms;
634 int render_delay_ms;
635 if (timing_->GetTimings(&decode_ms, &max_decode_ms, &current_delay_ms,
636 &target_delay_ms, &jitter_buffer_ms,
637 &min_playout_delay_ms, &render_delay_ms)) {
638 stats_callback_->OnFrameBufferTimingsUpdated(
639 decode_ms, max_decode_ms, current_delay_ms, target_delay_ms,
640 jitter_buffer_ms, min_playout_delay_ms, render_delay_ms);
philipelbe742702016-11-30 01:31:40 -0800641 }
philipel266f0a42016-11-28 08:49:07 -0800642}
643
ilnik2edc6842017-07-06 03:06:50 -0700644void FrameBuffer::UpdateTimingFrameInfo() {
645 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateTimingFrameInfo");
Danil Chapovalov0040b662018-06-18 10:48:16 +0200646 absl::optional<TimingFrameInfo> info = timing_->GetTimingFrameInfo();
philipel97187112018-03-23 10:43:21 +0100647 if (info && stats_callback_)
ilnik2edc6842017-07-06 03:06:50 -0700648 stats_callback_->OnTimingFrameInfoUpdated(*info);
649}
650
philipelfcc60062017-01-18 05:35:20 -0800651void FrameBuffer::ClearFramesAndHistory() {
ilnik2edc6842017-07-06 03:06:50 -0700652 TRACE_EVENT0("webrtc", "FrameBuffer::ClearFramesAndHistory");
philipelfcc60062017-01-18 05:35:20 -0800653 frames_.clear();
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100654 last_continuous_frame_.reset();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100655 frames_to_decode_.clear();
Ilya Nikolaevskiy13717842019-01-14 13:24:22 +0100656 decoded_frames_history_.Clear();
philipelfcc60062017-01-18 05:35:20 -0800657}
658
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100659EncodedFrame* FrameBuffer::CombineAndDeleteFrames(
660 const std::vector<EncodedFrame*>& frames) const {
661 RTC_DCHECK(!frames.empty());
Sergey Silkin61832dd2018-12-20 14:32:14 +0100662 EncodedFrame* first_frame = frames[0];
663 EncodedFrame* last_frame = frames.back();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100664 size_t total_length = 0;
665 for (size_t i = 0; i < frames.size(); ++i) {
666 total_length += frames[i]->size();
667 }
Sergey Silkin61832dd2018-12-20 14:32:14 +0100668 first_frame->VerifyAndAllocate(total_length);
669
670 // Spatial index of combined frame is set equal to spatial index of its top
671 // spatial layer.
672 first_frame->SetSpatialIndex(last_frame->id.spatial_layer);
673 first_frame->id.spatial_layer = last_frame->id.spatial_layer;
674
675 first_frame->video_timing_mutable()->network2_timestamp_ms =
676 last_frame->video_timing().network2_timestamp_ms;
677 first_frame->video_timing_mutable()->receive_finish_ms =
678 last_frame->video_timing().receive_finish_ms;
679
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100680 // Append all remaining frames to the first one.
Niels Möller9c843902019-01-11 10:21:35 +0100681 uint8_t* buffer = first_frame->data() + first_frame->size();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100682 for (size_t i = 1; i < frames.size(); ++i) {
Sergey Silkin61832dd2018-12-20 14:32:14 +0100683 EncodedFrame* next_frame = frames[i];
Niels Möller9c843902019-01-11 10:21:35 +0100684 memcpy(buffer, next_frame->data(), next_frame->size());
Sergey Silkin61832dd2018-12-20 14:32:14 +0100685 buffer += next_frame->size();
686 delete next_frame;
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100687 }
Sergey Silkin61832dd2018-12-20 14:32:14 +0100688 first_frame->set_size(total_length);
689 return first_frame;
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100690}
691
Niels Möllerbe682d42018-03-27 08:31:45 +0200692FrameBuffer::FrameInfo::FrameInfo() = default;
693FrameBuffer::FrameInfo::FrameInfo(FrameInfo&&) = default;
694FrameBuffer::FrameInfo::~FrameInfo() = default;
695
philipelbe7a9e52016-05-19 12:19:35 +0200696} // namespace video_coding
697} // namespace webrtc