blob: 4c0a3bb54bc657554619908d1121bd6c2033fa5d [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"
22#include "common_types.h" // NOLINT(build/include)
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 Nikolaevskiy6551faf2019-01-10 15:16:47 +010039constexpr size_t kMaxFramesBuffered = 600;
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 Nikolaevskiy6551faf2019-01-10 15:16:47 +010042constexpr size_t kMaxFramesHistory = 50;
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,
52 VCMJitterEstimator* jitter_estimator,
philipela45102f2017-02-22 05:30:39 -080053 VCMTiming* timing,
54 VCMReceiveStatisticsCallback* stats_callback)
philipelbe7a9e52016-05-19 12:19:35 +020055 : 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),
62 last_log_non_decoded_ms_(-kLogNonDecodedIntervalMs) {}
philipel266f0a42016-11-28 08:49:07 -080063
philipela45102f2017-02-22 05:30:39 -080064FrameBuffer::~FrameBuffer() {}
philipelbe7a9e52016-05-19 12:19:35 +020065
philipel75562822016-09-05 10:57:41 +020066FrameBuffer::ReturnReason FrameBuffer::NextFrame(
67 int64_t max_wait_time_ms,
philipele7c891f2018-02-22 14:35:06 +010068 std::unique_ptr<EncodedFrame>* frame_out,
philipel3042c2d2017-08-18 04:55:02 -070069 bool keyframe_required) {
tommidb23ea62017-03-03 07:21:18 -080070 TRACE_EVENT0("webrtc", "FrameBuffer::NextFrame");
philipel1c056252017-01-31 09:53:12 -080071 int64_t latest_return_time_ms =
72 clock_->TimeInMilliseconds() + max_wait_time_ms;
philipel504c47d2016-06-30 17:33:02 +020073 int64_t wait_ms = max_wait_time_ms;
philipel29f730e2017-03-15 08:10:08 -070074 int64_t now_ms = 0;
philipele0b2f152016-09-28 10:23:49 +020075
76 do {
philipel29f730e2017-03-15 08:10:08 -070077 now_ms = clock_->TimeInMilliseconds();
philipel504c47d2016-06-30 17:33:02 +020078 {
79 rtc::CritScope lock(&crit_);
tommi0a735642017-03-14 06:23:57 -070080 new_continuous_frame_event_.Reset();
philipel29f730e2017-03-15 08:10:08 -070081 if (stopped_)
82 return kStopped;
83
84 wait_ms = max_wait_time_ms;
85
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +010086 // Need to hold |crit_| in order to access frames_to_decode_. therefore we
philipele0b2f152016-09-28 10:23:49 +020087 // set it here in the loop instead of outside the loop in order to not
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +010088 // acquire the lock unnecessarily.
89 frames_to_decode_.clear();
philipelbe7a9e52016-05-19 12:19:35 +020090
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +010091 // |last_continuous_frame_| may be empty below, but nullopt is smaller
92 // than everything else and loop will immediately terminate as expected.
93 for (auto frame_it = frames_.begin();
94 frame_it != frames_.end() &&
95 frame_it->first <= last_continuous_frame_;
philipel146a48b2017-04-20 04:04:38 -070096 ++frame_it) {
philipel93e451b2016-10-06 12:25:13 +020097 if (!frame_it->second.continuous ||
98 frame_it->second.num_missing_decodable > 0) {
philipele0b2f152016-09-28 10:23:49 +020099 continue;
philipel93e451b2016-10-06 12:25:13 +0200100 }
philipele0b2f152016-09-28 10:23:49 +0200101
philipele7c891f2018-02-22 14:35:06 +0100102 EncodedFrame* frame = frame_it->second.frame.get();
philipel3042c2d2017-08-18 04:55:02 -0700103
104 if (keyframe_required && !frame->is_keyframe())
105 continue;
106
Ilya Nikolaevskiye6a2d942018-11-07 14:32:28 +0100107 // TODO(https://bugs.webrtc.org/9974): consider removing this check
108 // as it may make a stream undecodable after a very long delay between
109 // frames.
philipel6d216502018-10-22 14:36:45 +0200110 if (last_decoded_frame_timestamp_ &&
111 AheadOf(*last_decoded_frame_timestamp_, frame->Timestamp())) {
112 continue;
113 }
114
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100115 // Only ever return all parts of a superframe. Therefore skip this
116 // frame if it's not a beginning of a superframe.
117 if (frame->inter_layer_predicted) {
118 continue;
119 }
120
121 // Gather all remaining frames for the same superframe.
122 std::vector<FrameMap::iterator> current_superframe;
123 current_superframe.push_back(frame_it);
124 bool last_layer_completed =
125 frame_it->second.frame->is_last_spatial_layer;
126 FrameMap::iterator next_frame_it = frame_it;
127 while (true) {
128 ++next_frame_it;
129 if (next_frame_it == frames_.end() ||
130 next_frame_it->first.picture_id != frame->id.picture_id ||
131 !next_frame_it->second.continuous) {
132 break;
133 }
134 // Check if the next frame has some undecoded references other than
135 // the previous frame in the same superframe.
136 size_t num_allowed_undecoded_refs =
137 (next_frame_it->second.frame->inter_layer_predicted) ? 1 : 0;
138 if (next_frame_it->second.num_missing_decodable >
139 num_allowed_undecoded_refs) {
140 break;
141 }
142 // All frames in the superframe should have the same timestamp.
143 if (frame->Timestamp() != next_frame_it->second.frame->Timestamp()) {
144 RTC_LOG(LS_WARNING)
145 << "Frames in a single superframe have different"
146 " timestamps. Skipping undecodable superframe.";
147 break;
148 }
149 current_superframe.push_back(next_frame_it);
150 last_layer_completed =
151 next_frame_it->second.frame->is_last_spatial_layer;
152 }
153 // Check if the current superframe is complete.
154 // TODO(bugs.webrtc.org/10064): consider returning all available to
155 // decode frames even if the superframe is not complete yet.
156 if (!last_layer_completed) {
157 continue;
158 }
159
160 frames_to_decode_ = std::move(current_superframe);
161
philipel6d216502018-10-22 14:36:45 +0200162 if (frame->RenderTime() == -1) {
Niels Möller23775882018-08-16 10:24:12 +0200163 frame->SetRenderTime(
164 timing_->RenderTimeMs(frame->Timestamp(), now_ms));
philipel6d216502018-10-22 14:36:45 +0200165 }
philipele0b2f152016-09-28 10:23:49 +0200166 wait_ms = timing_->MaxWaitingTime(frame->RenderTime(), now_ms);
167
168 // This will cause the frame buffer to prefer high framerate rather
169 // than high resolution in the case of the decoder not decoding fast
170 // enough and the stream has multiple spatial and temporal layers.
Ilya Nikolaevskiy8c4fe162018-02-27 15:49:47 +0100171 // For multiple temporal layers it may cause non-base layer frames to be
172 // skipped if they are late.
Ilya Nikolaevskiy7eef0072018-02-28 09:59:26 +0100173 if (wait_ms < -kMaxAllowedFrameDelayMs)
philipele0b2f152016-09-28 10:23:49 +0200174 continue;
175
176 break;
177 }
178 } // rtc::Critscope lock(&crit_);
179
philipel1c056252017-01-31 09:53:12 -0800180 wait_ms = std::min<int64_t>(wait_ms, latest_return_time_ms - now_ms);
philipele0b2f152016-09-28 10:23:49 +0200181 wait_ms = std::max<int64_t>(wait_ms, 0);
tommi0a735642017-03-14 06:23:57 -0700182 } while (new_continuous_frame_event_.Wait(wait_ms));
philipele0b2f152016-09-28 10:23:49 +0200183
philipel29f730e2017-03-15 08:10:08 -0700184 {
185 rtc::CritScope lock(&crit_);
186 now_ms = clock_->TimeInMilliseconds();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100187 std::vector<EncodedFrame*> frames_out;
188 for (const FrameMap::iterator& frame_it : frames_to_decode_) {
189 RTC_DCHECK(frame_it != frames_.end());
190 EncodedFrame* frame = frame_it->second.frame.release();
philipele0b2f152016-09-28 10:23:49 +0200191
philipel29f730e2017-03-15 08:10:08 -0700192 if (!frame->delayed_by_retransmission()) {
193 int64_t frame_delay;
philipele0754302017-01-25 08:56:23 -0800194
Niels Möller23775882018-08-16 10:24:12 +0200195 if (inter_frame_delay_.CalculateDelay(frame->Timestamp(), &frame_delay,
philipel29f730e2017-03-15 08:10:08 -0700196 frame->ReceivedTime())) {
197 jitter_estimator_->UpdateEstimate(frame_delay, frame->size());
198 }
199
200 float rtt_mult = protection_mode_ == kProtectionNackFEC ? 0.0 : 1.0;
“Michaelf9fc1712018-08-27 10:08:58 -0500201 if (RttMultExperiment::RttMultEnabled()) {
202 rtt_mult = RttMultExperiment::GetRttMultValue();
203 }
philipel29f730e2017-03-15 08:10:08 -0700204 timing_->SetJitterDelay(jitter_estimator_->GetJitterEstimate(rtt_mult));
205 timing_->UpdateCurrentDelay(frame->RenderTime(), now_ms);
philipele21be1d2017-09-25 06:37:12 -0700206 } else {
“Michaelf9fc1712018-08-27 10:08:58 -0500207 if (RttMultExperiment::RttMultEnabled() ||
208 webrtc::field_trial::IsEnabled("WebRTC-AddRttToPlayoutDelay"))
philipel707f2782017-10-02 14:10:28 +0200209 jitter_estimator_->FrameNacked();
philipele0754302017-01-25 08:56:23 -0800210 }
211
stefan95e97542017-05-23 09:52:18 -0700212 // Gracefully handle bad RTP timestamps and render time issues.
213 if (HasBadRenderTiming(*frame, now_ms)) {
214 jitter_estimator_->Reset();
215 timing_->Reset();
Niels Möller23775882018-08-16 10:24:12 +0200216 frame->SetRenderTime(timing_->RenderTimeMs(frame->Timestamp(), now_ms));
stefan95e97542017-05-23 09:52:18 -0700217 }
218
philipel29f730e2017-03-15 08:10:08 -0700219 UpdateJitterDelay();
ilnik2edc6842017-07-06 03:06:50 -0700220 UpdateTimingFrameInfo();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100221 PropagateDecodability(frame_it->second);
brandtr9078d8c2017-04-27 07:07:27 -0700222
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100223 AdvanceLastDecodedFrame(frame_it);
Niels Möller23775882018-08-16 10:24:12 +0200224 last_decoded_frame_timestamp_ = frame->Timestamp();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100225 frames_out.push_back(frame);
226 }
227
228 if (!frames_out.empty()) {
229 if (frames_out.size() == 1) {
230 frame_out->reset(frames_out[0]);
231 } else {
232 frame_out->reset(CombineAndDeleteFrames(frames_out));
233 }
philipel29f730e2017-03-15 08:10:08 -0700234 return kFrameFound;
philipelbe7a9e52016-05-19 12:19:35 +0200235 }
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100236 } // rtc::Critscope lock(&crit_)
tommi0a735642017-03-14 06:23:57 -0700237
238 if (latest_return_time_ms - now_ms > 0) {
philipel1c056252017-01-31 09:53:12 -0800239 // If |next_frame_it_ == frames_.end()| and there is still time left, it
240 // means that the frame buffer was cleared as the thread in this function
241 // was waiting to acquire |crit_| in order to return. Wait for the
242 // remaining time and then return.
243 return NextFrame(latest_return_time_ms - now_ms, frame_out);
philipelbe7a9e52016-05-19 12:19:35 +0200244 }
tommi0a735642017-03-14 06:23:57 -0700245 return kTimeout;
philipelbe7a9e52016-05-19 12:19:35 +0200246}
247
philipele7c891f2018-02-22 14:35:06 +0100248bool FrameBuffer::HasBadRenderTiming(const EncodedFrame& frame,
249 int64_t now_ms) {
stefan95e97542017-05-23 09:52:18 -0700250 // Assume that render timing errors are due to changes in the video stream.
251 int64_t render_time_ms = frame.RenderTimeMs();
Stefan Holmer812ceaf2018-05-15 13:00:10 +0200252 // Zero render time means render immediately.
253 if (render_time_ms == 0) {
254 return false;
255 }
stefan95e97542017-05-23 09:52:18 -0700256 if (render_time_ms < 0) {
257 return true;
258 }
Stefan Holmer812ceaf2018-05-15 13:00:10 +0200259 const int64_t kMaxVideoDelayMs = 10000;
stefan95e97542017-05-23 09:52:18 -0700260 if (std::abs(render_time_ms - now_ms) > kMaxVideoDelayMs) {
261 int frame_delay = static_cast<int>(std::abs(render_time_ms - now_ms));
Mirko Bonadei675513b2017-11-09 11:09:25 +0100262 RTC_LOG(LS_WARNING)
263 << "A frame about to be decoded is out of the configured "
264 << "delay bounds (" << frame_delay << " > " << kMaxVideoDelayMs
265 << "). Resetting the video jitter buffer.";
stefan95e97542017-05-23 09:52:18 -0700266 return true;
267 }
268 if (static_cast<int>(timing_->TargetVideoDelay()) > kMaxVideoDelayMs) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100269 RTC_LOG(LS_WARNING) << "The video target delay has grown larger than "
270 << kMaxVideoDelayMs << " ms.";
stefan95e97542017-05-23 09:52:18 -0700271 return true;
272 }
273 return false;
274}
275
philipel4f6cd6a2016-08-03 10:59:32 +0200276void FrameBuffer::SetProtectionMode(VCMVideoProtection mode) {
tommidb23ea62017-03-03 07:21:18 -0800277 TRACE_EVENT0("webrtc", "FrameBuffer::SetProtectionMode");
philipel4f6cd6a2016-08-03 10:59:32 +0200278 rtc::CritScope lock(&crit_);
279 protection_mode_ = mode;
280}
281
philipel504c47d2016-06-30 17:33:02 +0200282void FrameBuffer::Start() {
tommidb23ea62017-03-03 07:21:18 -0800283 TRACE_EVENT0("webrtc", "FrameBuffer::Start");
philipel29f730e2017-03-15 08:10:08 -0700284 rtc::CritScope lock(&crit_);
285 stopped_ = false;
philipel504c47d2016-06-30 17:33:02 +0200286}
287
288void FrameBuffer::Stop() {
tommidb23ea62017-03-03 07:21:18 -0800289 TRACE_EVENT0("webrtc", "FrameBuffer::Stop");
philipel29f730e2017-03-15 08:10:08 -0700290 rtc::CritScope lock(&crit_);
291 stopped_ = true;
tommi0a735642017-03-14 06:23:57 -0700292 new_continuous_frame_event_.Set();
philipel504c47d2016-06-30 17:33:02 +0200293}
294
Ilya Nikolaevskiye6a2d942018-11-07 14:32:28 +0100295void FrameBuffer::Clear() {
296 rtc::CritScope lock(&crit_);
297 ClearFramesAndHistory();
298}
299
philipele21be1d2017-09-25 06:37:12 -0700300void FrameBuffer::UpdateRtt(int64_t rtt_ms) {
301 rtc::CritScope lock(&crit_);
302 jitter_estimator_->UpdateRtt(rtt_ms);
303}
304
philipele7c891f2018-02-22 14:35:06 +0100305bool FrameBuffer::ValidReferences(const EncodedFrame& frame) const {
philipel0fa82a62018-03-19 15:34:53 +0100306 if (frame.id.picture_id < 0)
philipel3b3c9c42017-09-11 09:38:36 -0700307 return false;
308
philipel112adf92017-06-15 09:06:21 -0700309 for (size_t i = 0; i < frame.num_references; ++i) {
philipel0fa82a62018-03-19 15:34:53 +0100310 if (frame.references[i] < 0 || frame.references[i] >= frame.id.picture_id)
philipel112adf92017-06-15 09:06:21 -0700311 return false;
philipel3b3c9c42017-09-11 09:38:36 -0700312
philipel112adf92017-06-15 09:06:21 -0700313 for (size_t j = i + 1; j < frame.num_references; ++j) {
314 if (frame.references[i] == frame.references[j])
315 return false;
316 }
317 }
318
philipel0fa82a62018-03-19 15:34:53 +0100319 if (frame.inter_layer_predicted && frame.id.spatial_layer == 0)
philipel112adf92017-06-15 09:06:21 -0700320 return false;
321
322 return true;
323}
324
philipele7c891f2018-02-22 14:35:06 +0100325void FrameBuffer::UpdatePlayoutDelays(const EncodedFrame& frame) {
gnishb2a318b2017-05-10 09:21:33 -0700326 TRACE_EVENT0("webrtc", "FrameBuffer::UpdatePlayoutDelays");
327 PlayoutDelay playout_delay = frame.EncodedImage().playout_delay_;
328 if (playout_delay.min_ms >= 0)
329 timing_->set_min_playout_delay(playout_delay.min_ms);
330
331 if (playout_delay.max_ms >= 0)
332 timing_->set_max_playout_delay(playout_delay.max_ms);
philipel0a9f6de2018-02-28 11:29:47 +0100333
334 if (!frame.delayed_by_retransmission())
Niels Möller23775882018-08-16 10:24:12 +0200335 timing_->IncomingTimestamp(frame.Timestamp(), frame.ReceivedTime());
gnishb2a318b2017-05-10 09:21:33 -0700336}
337
philipele7c891f2018-02-22 14:35:06 +0100338int64_t FrameBuffer::InsertFrame(std::unique_ptr<EncodedFrame> frame) {
tommidb23ea62017-03-03 07:21:18 -0800339 TRACE_EVENT0("webrtc", "FrameBuffer::InsertFrame");
philipel93e451b2016-10-06 12:25:13 +0200340 RTC_DCHECK(frame);
philipela45102f2017-02-22 05:30:39 -0800341 if (stats_callback_)
ilnik6d5b4d62017-08-30 03:32:14 -0700342 stats_callback_->OnCompleteFrame(frame->is_keyframe(), frame->size(),
343 frame->contentType());
philipel0fa82a62018-03-19 15:34:53 +0100344 const VideoLayerFrameId& id = frame->id;
tommi0a735642017-03-14 06:23:57 -0700345
346 rtc::CritScope lock(&crit_);
philipel29f730e2017-03-15 08:10:08 -0700347
philipel1610f942017-12-12 13:58:31 +0100348 int64_t last_continuous_picture_id =
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100349 !last_continuous_frame_ ? -1 : last_continuous_frame_->picture_id;
philipele0b2f152016-09-28 10:23:49 +0200350
philipel112adf92017-06-15 09:06:21 -0700351 if (!ValidReferences(*frame)) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100352 RTC_LOG(LS_WARNING) << "Frame with (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100353 << id.picture_id << ":"
354 << static_cast<int>(id.spatial_layer)
Mirko Bonadei675513b2017-11-09 11:09:25 +0100355 << ") has invalid frame references, dropping frame.";
philipel112adf92017-06-15 09:06:21 -0700356 return last_continuous_picture_id;
357 }
358
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100359 if (frames_.size() >= kMaxFramesBuffered) {
philipel9771c502018-03-02 11:06:27 +0100360 if (frame->is_keyframe()) {
361 RTC_LOG(LS_WARNING) << "Inserting keyframe (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100362 << id.picture_id << ":"
363 << static_cast<int>(id.spatial_layer)
philipel9771c502018-03-02 11:06:27 +0100364 << ") but buffer is full, clearing"
365 << " buffer and inserting the frame.";
366 ClearFramesAndHistory();
367 } else {
368 RTC_LOG(LS_WARNING) << "Frame with (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100369 << id.picture_id << ":"
370 << static_cast<int>(id.spatial_layer)
philipel9771c502018-03-02 11:06:27 +0100371 << ") could not be inserted due to the frame "
372 << "buffer being full, dropping frame.";
373 return last_continuous_picture_id;
374 }
philipele0b2f152016-09-28 10:23:49 +0200375 }
376
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100377 if (last_decoded_frame_ && id <= *last_decoded_frame_) {
philipel6d216502018-10-22 14:36:45 +0200378 if (AheadOf(frame->Timestamp(), *last_decoded_frame_timestamp_) &&
philipel3042c2d2017-08-18 04:55:02 -0700379 frame->is_keyframe()) {
philipelfcc60062017-01-18 05:35:20 -0800380 // If this frame has a newer timestamp but an earlier picture id then we
381 // assume there has been a jump in the picture id due to some encoder
382 // reconfiguration or some other reason. Even though this is not according
383 // to spec we can still continue to decode from this frame if it is a
384 // keyframe.
Mirko Bonadei675513b2017-11-09 11:09:25 +0100385 RTC_LOG(LS_WARNING)
386 << "A jump in picture id was detected, clearing buffer.";
philipelfcc60062017-01-18 05:35:20 -0800387 ClearFramesAndHistory();
388 last_continuous_picture_id = -1;
389 } else {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100390 RTC_LOG(LS_WARNING) << "Frame with (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100391 << id.picture_id << ":"
392 << static_cast<int>(id.spatial_layer)
Mirko Bonadei675513b2017-11-09 11:09:25 +0100393 << ") inserted after frame ("
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100394 << last_decoded_frame_->picture_id << ":"
Mirko Bonadei675513b2017-11-09 11:09:25 +0100395 << static_cast<int>(
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100396 last_decoded_frame_->spatial_layer)
Mirko Bonadei675513b2017-11-09 11:09:25 +0100397 << ") was handed off for decoding, dropping frame.";
philipelfcc60062017-01-18 05:35:20 -0800398 return last_continuous_picture_id;
399 }
philipele0b2f152016-09-28 10:23:49 +0200400 }
401
philipel146a48b2017-04-20 04:04:38 -0700402 // Test if inserting this frame would cause the order of the frames to become
403 // ambiguous (covering more than half the interval of 2^16). This can happen
404 // when the picture id make large jumps mid stream.
philipel0fa82a62018-03-19 15:34:53 +0100405 if (!frames_.empty() && id < frames_.begin()->first &&
406 frames_.rbegin()->first < id) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100407 RTC_LOG(LS_WARNING)
408 << "A jump in picture id was detected, clearing buffer.";
philipel146a48b2017-04-20 04:04:38 -0700409 ClearFramesAndHistory();
410 last_continuous_picture_id = -1;
411 }
412
philipel0fa82a62018-03-19 15:34:53 +0100413 auto info = frames_.emplace(id, FrameInfo()).first;
philipele0b2f152016-09-28 10:23:49 +0200414
philipel93e451b2016-10-06 12:25:13 +0200415 if (info->second.frame) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100416 RTC_LOG(LS_WARNING) << "Frame with (picture_id:spatial_id) ("
philipel0fa82a62018-03-19 15:34:53 +0100417 << id.picture_id << ":"
418 << static_cast<int>(id.spatial_layer)
Mirko Bonadei675513b2017-11-09 11:09:25 +0100419 << ") already inserted, dropping frame.";
philipele0b2f152016-09-28 10:23:49 +0200420 return last_continuous_picture_id;
421 }
422
philipel93e451b2016-10-06 12:25:13 +0200423 if (!UpdateFrameInfoWithIncomingFrame(*frame, info))
424 return last_continuous_picture_id;
gnishb2a318b2017-05-10 09:21:33 -0700425 UpdatePlayoutDelays(*frame);
philipel0a9f6de2018-02-28 11:29:47 +0100426
philipele0b2f152016-09-28 10:23:49 +0200427 info->second.frame = std::move(frame);
philipele0b2f152016-09-28 10:23:49 +0200428
429 if (info->second.num_missing_continuous == 0) {
430 info->second.continuous = true;
431 PropagateContinuity(info);
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100432 last_continuous_picture_id = last_continuous_frame_->picture_id;
philipele0b2f152016-09-28 10:23:49 +0200433
434 // Since we now have new continuous frames there might be a better frame
435 // to return from NextFrame. Signal that thread so that it again can choose
436 // which frame to return.
tommi0a735642017-03-14 06:23:57 -0700437 new_continuous_frame_event_.Set();
philipele0b2f152016-09-28 10:23:49 +0200438 }
439
440 return last_continuous_picture_id;
philipelbe7a9e52016-05-19 12:19:35 +0200441}
442
philipele0b2f152016-09-28 10:23:49 +0200443void FrameBuffer::PropagateContinuity(FrameMap::iterator start) {
tommidb23ea62017-03-03 07:21:18 -0800444 TRACE_EVENT0("webrtc", "FrameBuffer::PropagateContinuity");
philipele0b2f152016-09-28 10:23:49 +0200445 RTC_DCHECK(start->second.continuous);
philipele0b2f152016-09-28 10:23:49 +0200446
447 std::queue<FrameMap::iterator> continuous_frames;
448 continuous_frames.push(start);
449
450 // A simple BFS to traverse continuous frames.
451 while (!continuous_frames.empty()) {
452 auto frame = continuous_frames.front();
453 continuous_frames.pop();
454
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100455 if (!last_continuous_frame_ || *last_continuous_frame_ < frame->first) {
456 last_continuous_frame_ = frame->first;
457 }
philipele0b2f152016-09-28 10:23:49 +0200458
459 // Loop through all dependent frames, and if that frame no longer has
460 // any unfulfilled dependencies then that frame is continuous as well.
Elad Alon69321dd2019-01-10 15:02:54 +0100461 for (size_t d = 0; d < frame->second.dependent_frames.size(); ++d) {
philipele0b2f152016-09-28 10:23:49 +0200462 auto frame_ref = frames_.find(frame->second.dependent_frames[d]);
philipel112adf92017-06-15 09:06:21 -0700463 RTC_DCHECK(frame_ref != frames_.end());
philipele0b2f152016-09-28 10:23:49 +0200464
philipel112adf92017-06-15 09:06:21 -0700465 // TODO(philipel): Look into why we've seen this happen.
466 if (frame_ref != frames_.end()) {
467 --frame_ref->second.num_missing_continuous;
468 if (frame_ref->second.num_missing_continuous == 0) {
469 frame_ref->second.continuous = true;
470 continuous_frames.push(frame_ref);
471 }
philipele0b2f152016-09-28 10:23:49 +0200472 }
473 }
474 }
475}
476
477void FrameBuffer::PropagateDecodability(const FrameInfo& info) {
tommidb23ea62017-03-03 07:21:18 -0800478 TRACE_EVENT0("webrtc", "FrameBuffer::PropagateDecodability");
Elad Alon69321dd2019-01-10 15:02:54 +0100479 for (size_t d = 0; d < info.dependent_frames.size(); ++d) {
philipele0b2f152016-09-28 10:23:49 +0200480 auto ref_info = frames_.find(info.dependent_frames[d]);
philipel93e451b2016-10-06 12:25:13 +0200481 RTC_DCHECK(ref_info != frames_.end());
tommie95b78b2017-05-14 07:23:11 -0700482 // TODO(philipel): Look into why we've seen this happen.
483 if (ref_info != frames_.end()) {
484 RTC_DCHECK_GT(ref_info->second.num_missing_decodable, 0U);
485 --ref_info->second.num_missing_decodable;
486 }
philipele0b2f152016-09-28 10:23:49 +0200487 }
488}
489
490void FrameBuffer::AdvanceLastDecodedFrame(FrameMap::iterator decoded) {
tommidb23ea62017-03-03 07:21:18 -0800491 TRACE_EVENT0("webrtc", "FrameBuffer::AdvanceLastDecodedFrame");
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100492
493 decoded_frames_history_.insert(decoded->first);
494
495 FrameMap::iterator frame_it = frames_.begin();
philipele0b2f152016-09-28 10:23:49 +0200496
497 // First, delete non-decoded frames from the history.
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100498 while (frame_it != decoded)
499 frame_it = frames_.erase(frame_it);
philipelbe7a9e52016-05-19 12:19:35 +0200500
philipele0b2f152016-09-28 10:23:49 +0200501 // Then remove old history if we have too much history saved.
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100502 if (decoded_frames_history_.size() > kMaxFramesHistory)
503 decoded_frames_history_.erase(decoded_frames_history_.begin());
504
505 // Then remove the frame from the undecoded frames list.
506 last_decoded_frame_ = decoded->first;
507 frames_.erase(decoded);
philipele0b2f152016-09-28 10:23:49 +0200508}
509
philipele7c891f2018-02-22 14:35:06 +0100510bool FrameBuffer::UpdateFrameInfoWithIncomingFrame(const EncodedFrame& frame,
philipele0b2f152016-09-28 10:23:49 +0200511 FrameMap::iterator info) {
tommidb23ea62017-03-03 07:21:18 -0800512 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateFrameInfoWithIncomingFrame");
philipel0fa82a62018-03-19 15:34:53 +0100513 const VideoLayerFrameId& id = frame.id;
philipele0b2f152016-09-28 10:23:49 +0200514
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100515 RTC_DCHECK(!last_decoded_frame_ || *last_decoded_frame_ < info->first);
philipele0b2f152016-09-28 10:23:49 +0200516
philipel798b2822018-06-11 13:10:14 +0200517 // In this function we determine how many missing dependencies this |frame|
518 // has to become continuous/decodable. If a frame that this |frame| depend
519 // on has already been decoded then we can ignore that dependency since it has
520 // already been fulfilled.
521 //
522 // For all other frames we will register a backwards reference to this |frame|
523 // so that |num_missing_continuous| and |num_missing_decodable| can be
524 // decremented as frames become continuous/are decoded.
525 struct Dependency {
526 VideoLayerFrameId id;
527 bool continuous;
528 };
529 std::vector<Dependency> not_yet_fulfilled_dependencies;
530
531 // Find all dependencies that have not yet been fulfilled.
philipele0b2f152016-09-28 10:23:49 +0200532 for (size_t i = 0; i < frame.num_references; ++i) {
philipel0fa82a62018-03-19 15:34:53 +0100533 VideoLayerFrameId ref_key(frame.references[i], frame.id.spatial_layer);
philipel798b2822018-06-11 13:10:14 +0200534 // Does |frame| depend on a frame earlier than the last decoded one?
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100535 if (last_decoded_frame_ && ref_key <= *last_decoded_frame_) {
philipel798b2822018-06-11 13:10:14 +0200536 // Was that frame decoded? If not, this |frame| will never become
537 // decodable.
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100538 if (decoded_frames_history_.find(ref_key) ==
539 decoded_frames_history_.end()) {
philipel65e1f942017-07-24 08:26:53 -0700540 int64_t now_ms = clock_->TimeInMilliseconds();
541 if (last_log_non_decoded_ms_ + kLogNonDecodedIntervalMs < now_ms) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100542 RTC_LOG(LS_WARNING)
philipel0fa82a62018-03-19 15:34:53 +0100543 << "Frame with (picture_id:spatial_id) (" << id.picture_id << ":"
544 << static_cast<int>(id.spatial_layer)
philipel65e1f942017-07-24 08:26:53 -0700545 << ") depends on a non-decoded frame more previous than"
546 << " the last decoded frame, dropping frame.";
547 last_log_non_decoded_ms_ = now_ms;
548 }
philipele0b2f152016-09-28 10:23:49 +0200549 return false;
550 }
philipele0b2f152016-09-28 10:23:49 +0200551 } else {
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100552 auto ref_info = frames_.find(ref_key);
philipel798b2822018-06-11 13:10:14 +0200553 bool ref_continuous =
554 ref_info != frames_.end() && ref_info->second.continuous;
555 not_yet_fulfilled_dependencies.push_back({ref_key, ref_continuous});
philipele0b2f152016-09-28 10:23:49 +0200556 }
philipelbe7a9e52016-05-19 12:19:35 +0200557 }
558
philipel798b2822018-06-11 13:10:14 +0200559 // Does |frame| depend on the lower spatial layer?
philipelbe7a9e52016-05-19 12:19:35 +0200560 if (frame.inter_layer_predicted) {
philipel0fa82a62018-03-19 15:34:53 +0100561 VideoLayerFrameId ref_key(frame.id.picture_id, frame.id.spatial_layer - 1);
philipel798b2822018-06-11 13:10:14 +0200562 auto ref_info = frames_.find(ref_key);
philipele0b2f152016-09-28 10:23:49 +0200563
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100564 bool lower_layer_decoded =
565 last_decoded_frame_ && *last_decoded_frame_ == ref_key;
philipel798b2822018-06-11 13:10:14 +0200566 bool lower_layer_continuous =
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100567 lower_layer_decoded ||
568 (ref_info != frames_.end() && ref_info->second.continuous);
philipel798b2822018-06-11 13:10:14 +0200569
570 if (!lower_layer_continuous || !lower_layer_decoded) {
571 not_yet_fulfilled_dependencies.push_back(
572 {ref_key, lower_layer_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
Elad Alon69321dd2019-01-10 15:02:54 +0100583 frames_[dep.id].dependent_frames.push_back(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 decode_ms;
595 int max_decode_ms;
596 int current_delay_ms;
597 int target_delay_ms;
598 int jitter_buffer_ms;
599 int min_playout_delay_ms;
600 int render_delay_ms;
601 if (timing_->GetTimings(&decode_ms, &max_decode_ms, &current_delay_ms,
602 &target_delay_ms, &jitter_buffer_ms,
603 &min_playout_delay_ms, &render_delay_ms)) {
604 stats_callback_->OnFrameBufferTimingsUpdated(
605 decode_ms, max_decode_ms, current_delay_ms, target_delay_ms,
606 jitter_buffer_ms, min_playout_delay_ms, render_delay_ms);
philipelbe742702016-11-30 01:31:40 -0800607 }
philipel266f0a42016-11-28 08:49:07 -0800608}
609
ilnik2edc6842017-07-06 03:06:50 -0700610void FrameBuffer::UpdateTimingFrameInfo() {
611 TRACE_EVENT0("webrtc", "FrameBuffer::UpdateTimingFrameInfo");
Danil Chapovalov0040b662018-06-18 10:48:16 +0200612 absl::optional<TimingFrameInfo> info = timing_->GetTimingFrameInfo();
philipel97187112018-03-23 10:43:21 +0100613 if (info && stats_callback_)
ilnik2edc6842017-07-06 03:06:50 -0700614 stats_callback_->OnTimingFrameInfoUpdated(*info);
615}
616
philipelfcc60062017-01-18 05:35:20 -0800617void FrameBuffer::ClearFramesAndHistory() {
ilnik2edc6842017-07-06 03:06:50 -0700618 TRACE_EVENT0("webrtc", "FrameBuffer::ClearFramesAndHistory");
philipelfcc60062017-01-18 05:35:20 -0800619 frames_.clear();
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100620 last_decoded_frame_.reset();
621 last_continuous_frame_.reset();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100622 frames_to_decode_.clear();
Ilya Nikolaevskiy6551faf2019-01-10 15:16:47 +0100623 decoded_frames_history_.clear();
philipelfcc60062017-01-18 05:35:20 -0800624}
625
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100626EncodedFrame* FrameBuffer::CombineAndDeleteFrames(
627 const std::vector<EncodedFrame*>& frames) const {
628 RTC_DCHECK(!frames.empty());
Sergey Silkin61832dd2018-12-20 14:32:14 +0100629 EncodedFrame* first_frame = frames[0];
630 EncodedFrame* last_frame = frames.back();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100631 size_t total_length = 0;
632 for (size_t i = 0; i < frames.size(); ++i) {
633 total_length += frames[i]->size();
634 }
Sergey Silkin61832dd2018-12-20 14:32:14 +0100635 first_frame->VerifyAndAllocate(total_length);
636
637 // Spatial index of combined frame is set equal to spatial index of its top
638 // spatial layer.
639 first_frame->SetSpatialIndex(last_frame->id.spatial_layer);
640 first_frame->id.spatial_layer = last_frame->id.spatial_layer;
641
642 first_frame->video_timing_mutable()->network2_timestamp_ms =
643 last_frame->video_timing().network2_timestamp_ms;
644 first_frame->video_timing_mutable()->receive_finish_ms =
645 last_frame->video_timing().receive_finish_ms;
646
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100647 // Append all remaining frames to the first one.
Niels Möller9c843902019-01-11 10:21:35 +0100648 uint8_t* buffer = first_frame->data() + first_frame->size();
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100649 for (size_t i = 1; i < frames.size(); ++i) {
Sergey Silkin61832dd2018-12-20 14:32:14 +0100650 EncodedFrame* next_frame = frames[i];
Niels Möller9c843902019-01-11 10:21:35 +0100651 memcpy(buffer, next_frame->data(), next_frame->size());
Sergey Silkin61832dd2018-12-20 14:32:14 +0100652 buffer += next_frame->size();
653 delete next_frame;
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100654 }
Sergey Silkin61832dd2018-12-20 14:32:14 +0100655 first_frame->set_size(total_length);
656 return first_frame;
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100657}
658
Niels Möllerbe682d42018-03-27 08:31:45 +0200659FrameBuffer::FrameInfo::FrameInfo() = default;
660FrameBuffer::FrameInfo::FrameInfo(FrameInfo&&) = default;
661FrameBuffer::FrameInfo::~FrameInfo() = default;
662
philipelbe7a9e52016-05-19 12:19:35 +0200663} // namespace video_coding
664} // namespace webrtc