blob: 81910176b27508a2450833cf1637dfc1cac814db [file] [log] [blame]
philipel02447bc2016-05-13 06:01:03 -07001/*
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/rtp_frame_reference_finder.h"
philipel02447bc2016-05-13 06:01:03 -070012
13#include <algorithm>
14#include <limits>
15
philipel1a4746a2018-07-09 15:52:29 +020016#include "absl/types/variant.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020017#include "modules/video_coding/frame_object.h"
18#include "modules/video_coding/packet_buffer.h"
19#include "rtc_base/checks.h"
20#include "rtc_base/logging.h"
Karl Wiberg80ba3332018-02-05 10:33:35 +010021#include "rtc_base/system/fallthrough.h"
philipel02447bc2016-05-13 06:01:03 -070022
23namespace webrtc {
24namespace video_coding {
25
26RtpFrameReferenceFinder::RtpFrameReferenceFinder(
27 OnCompleteFrameCallback* frame_callback)
28 : last_picture_id_(-1),
philipel02447bc2016-05-13 06:01:03 -070029 current_ss_idx_(0),
philipel463d3012016-09-09 03:32:44 -070030 cleared_to_seq_num_(-1),
philipel02447bc2016-05-13 06:01:03 -070031 frame_callback_(frame_callback) {}
32
Mirko Bonadei8fdcac32018-08-28 16:30:18 +020033RtpFrameReferenceFinder::~RtpFrameReferenceFinder() = default;
34
philipel02447bc2016-05-13 06:01:03 -070035void RtpFrameReferenceFinder::ManageFrame(
36 std::unique_ptr<RtpFrameObject> frame) {
37 rtc::CritScope lock(&crit_);
philipel463d3012016-09-09 03:32:44 -070038
39 // If we have cleared past this frame, drop it.
40 if (cleared_to_seq_num_ != -1 &&
41 AheadOf<uint16_t>(cleared_to_seq_num_, frame->first_seq_num())) {
42 return;
43 }
44
philipelafcf7f52017-04-26 08:17:35 -070045 FrameDecision decision = ManageFrameInternal(frame.get());
46
47 switch (decision) {
48 case kStash:
49 if (stashed_frames_.size() > kMaxStashedFrames)
50 stashed_frames_.pop_back();
51 stashed_frames_.push_front(std::move(frame));
52 break;
53 case kHandOff:
54 frame_callback_->OnCompleteFrame(std::move(frame));
55 RetryStashedFrames();
56 break;
57 case kDrop:
58 break;
59 }
60}
61
62void RtpFrameReferenceFinder::RetryStashedFrames() {
63 bool complete_frame = false;
64 do {
65 complete_frame = false;
66 for (auto frame_it = stashed_frames_.begin();
67 frame_it != stashed_frames_.end();) {
68 FrameDecision decision = ManageFrameInternal(frame_it->get());
69
70 switch (decision) {
71 case kStash:
72 ++frame_it;
73 break;
74 case kHandOff:
75 complete_frame = true;
76 frame_callback_->OnCompleteFrame(std::move(*frame_it));
Karl Wiberg80ba3332018-02-05 10:33:35 +010077 RTC_FALLTHROUGH();
philipelafcf7f52017-04-26 08:17:35 -070078 case kDrop:
79 frame_it = stashed_frames_.erase(frame_it);
80 }
81 }
82 } while (complete_frame);
83}
84
85RtpFrameReferenceFinder::FrameDecision
86RtpFrameReferenceFinder::ManageFrameInternal(RtpFrameObject* frame) {
philipel2837edc2018-10-02 13:55:47 +020087 absl::optional<RtpGenericFrameDescriptor> generic_descriptor =
88 frame->GetGenericFrameDescriptor();
89 if (generic_descriptor) {
90 return ManageFrameGeneric(frame, *generic_descriptor);
philipeldabfcae2018-09-25 12:54:37 +020091 }
92
philipel02447bc2016-05-13 06:01:03 -070093 switch (frame->codec_type()) {
philipel02447bc2016-05-13 06:01:03 -070094 case kVideoCodecVP8:
philipelafcf7f52017-04-26 08:17:35 -070095 return ManageFrameVp8(frame);
philipel02447bc2016-05-13 06:01:03 -070096 case kVideoCodecVP9:
philipelafcf7f52017-04-26 08:17:35 -070097 return ManageFrameVp9(frame);
Sami Kalliomäki98824952018-08-28 14:39:21 +020098 default: {
99 // Use 15 first bits of frame ID as picture ID if available.
philipel2837edc2018-10-02 13:55:47 +0200100 absl::optional<RTPVideoHeader> video_header = frame->GetRtpVideoHeader();
philipeldabfcae2018-09-25 12:54:37 +0200101 int picture_id = kNoPictureId;
102 if (video_header && video_header->generic)
103 picture_id = video_header->generic->frame_id & 0x7fff;
104
105 return ManageFramePidOrSeqNum(frame, picture_id);
Sami Kalliomäki98824952018-08-28 14:39:21 +0200106 }
philipel02447bc2016-05-13 06:01:03 -0700107 }
108}
109
philipel9b2ce6b2016-07-05 05:04:46 -0700110void RtpFrameReferenceFinder::PaddingReceived(uint16_t seq_num) {
111 rtc::CritScope lock(&crit_);
112 auto clean_padding_to =
113 stashed_padding_.lower_bound(seq_num - kMaxPaddingAge);
114 stashed_padding_.erase(stashed_padding_.begin(), clean_padding_to);
115 stashed_padding_.insert(seq_num);
116 UpdateLastPictureIdWithPadding(seq_num);
117 RetryStashedFrames();
118}
119
philipel463d3012016-09-09 03:32:44 -0700120void RtpFrameReferenceFinder::ClearTo(uint16_t seq_num) {
121 rtc::CritScope lock(&crit_);
122 cleared_to_seq_num_ = seq_num;
123
124 auto it = stashed_frames_.begin();
125 while (it != stashed_frames_.end()) {
126 if (AheadOf<uint16_t>(cleared_to_seq_num_, (*it)->first_seq_num())) {
127 it = stashed_frames_.erase(it);
128 } else {
129 ++it;
130 }
131 }
132}
133
philipel9b2ce6b2016-07-05 05:04:46 -0700134void RtpFrameReferenceFinder::UpdateLastPictureIdWithPadding(uint16_t seq_num) {
135 auto gop_seq_num_it = last_seq_num_gop_.upper_bound(seq_num);
136
137 // If this padding packet "belongs" to a group of pictures that we don't track
138 // anymore, do nothing.
139 if (gop_seq_num_it == last_seq_num_gop_.begin())
140 return;
141 --gop_seq_num_it;
142
143 // Calculate the next contiuous sequence number and search for it in
144 // the padding packets we have stashed.
145 uint16_t next_seq_num_with_padding = gop_seq_num_it->second.second + 1;
146 auto padding_seq_num_it =
147 stashed_padding_.lower_bound(next_seq_num_with_padding);
148
149 // While there still are padding packets and those padding packets are
150 // continuous, then advance the "last-picture-id-with-padding" and remove
151 // the stashed padding packet.
152 while (padding_seq_num_it != stashed_padding_.end() &&
153 *padding_seq_num_it == next_seq_num_with_padding) {
154 gop_seq_num_it->second.second = next_seq_num_with_padding;
155 ++next_seq_num_with_padding;
156 padding_seq_num_it = stashed_padding_.erase(padding_seq_num_it);
157 }
philipel41bb7922017-02-20 07:53:23 -0800158
159 // In the case where the stream has been continuous without any new keyframes
160 // for a while there is a risk that new frames will appear to be older than
161 // the keyframe they belong to due to wrapping sequence number. In order
162 // to prevent this we advance the picture id of the keyframe every so often.
163 if (ForwardDiff(gop_seq_num_it->first, seq_num) > 10000) {
164 RTC_DCHECK_EQ(1ul, last_seq_num_gop_.size());
165 last_seq_num_gop_[seq_num] = gop_seq_num_it->second;
166 last_seq_num_gop_.erase(gop_seq_num_it);
167 }
philipel9b2ce6b2016-07-05 05:04:46 -0700168}
169
philipelafcf7f52017-04-26 08:17:35 -0700170RtpFrameReferenceFinder::FrameDecision
philipeldabfcae2018-09-25 12:54:37 +0200171RtpFrameReferenceFinder::ManageFrameGeneric(
172 RtpFrameObject* frame,
philipel2837edc2018-10-02 13:55:47 +0200173 const RtpGenericFrameDescriptor& descriptor) {
174 int64_t frame_id = generic_frame_id_unwrapper_.Unwrap(descriptor.FrameId());
175 frame->id.picture_id = frame_id;
176 frame->id.spatial_layer = descriptor.SpatialLayer();
177
178 rtc::ArrayView<const uint16_t> diffs = descriptor.FrameDependenciesDiffs();
179 if (EncodedFrame::kMaxFrameReferences < diffs.size()) {
philipeldabfcae2018-09-25 12:54:37 +0200180 RTC_LOG(LS_WARNING) << "Too many dependencies in generic descriptor.";
181 return kDrop;
182 }
183
philipel2837edc2018-10-02 13:55:47 +0200184 frame->num_references = diffs.size();
185 for (size_t i = 0; i < diffs.size(); ++i)
186 frame->references[i] = frame_id - diffs[i];
philipeldabfcae2018-09-25 12:54:37 +0200187
188 return kHandOff;
189}
190
191RtpFrameReferenceFinder::FrameDecision
192RtpFrameReferenceFinder::ManageFramePidOrSeqNum(RtpFrameObject* frame,
193 int picture_id) {
philipel647998c2016-06-03 09:40:16 -0700194 // If |picture_id| is specified then we use that to set the frame references,
195 // otherwise we use sequence number.
196 if (picture_id != kNoPictureId) {
philipel0fa82a62018-03-19 15:34:53 +0100197 frame->id.picture_id = unwrapper_.Unwrap(picture_id);
Niels Möller8f7ce222019-03-21 15:43:58 +0100198 frame->num_references =
199 frame->frame_type() == VideoFrameType::kVideoFrameKey ? 0 : 1;
philipel0fa82a62018-03-19 15:34:53 +0100200 frame->references[0] = frame->id.picture_id - 1;
philipelafcf7f52017-04-26 08:17:35 -0700201 return kHandOff;
philipel647998c2016-06-03 09:40:16 -0700202 }
203
Niels Möller8f7ce222019-03-21 15:43:58 +0100204 if (frame->frame_type() == VideoFrameType::kVideoFrameKey) {
philipel9b2ce6b2016-07-05 05:04:46 -0700205 last_seq_num_gop_.insert(std::make_pair(
206 frame->last_seq_num(),
207 std::make_pair(frame->last_seq_num(), frame->last_seq_num())));
208 }
philipel02447bc2016-05-13 06:01:03 -0700209
210 // We have received a frame but not yet a keyframe, stash this frame.
philipelafcf7f52017-04-26 08:17:35 -0700211 if (last_seq_num_gop_.empty())
212 return kStash;
philipel02447bc2016-05-13 06:01:03 -0700213
214 // Clean up info for old keyframes but make sure to keep info
215 // for the last keyframe.
216 auto clean_to = last_seq_num_gop_.lower_bound(frame->last_seq_num() - 100);
philipel41bb7922017-02-20 07:53:23 -0800217 for (auto it = last_seq_num_gop_.begin();
218 it != clean_to && last_seq_num_gop_.size() > 1;) {
219 it = last_seq_num_gop_.erase(it);
220 }
philipel02447bc2016-05-13 06:01:03 -0700221
222 // Find the last sequence number of the last frame for the keyframe
223 // that this frame indirectly references.
224 auto seq_num_it = last_seq_num_gop_.upper_bound(frame->last_seq_num());
philipel9b2ce6b2016-07-05 05:04:46 -0700225 if (seq_num_it == last_seq_num_gop_.begin()) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100226 RTC_LOG(LS_WARNING) << "Generic frame with packet range ["
227 << frame->first_seq_num() << ", "
228 << frame->last_seq_num()
229 << "] has no GoP, dropping frame.";
philipelafcf7f52017-04-26 08:17:35 -0700230 return kDrop;
philipel9b2ce6b2016-07-05 05:04:46 -0700231 }
philipel02447bc2016-05-13 06:01:03 -0700232 seq_num_it--;
233
234 // Make sure the packet sequence numbers are continuous, otherwise stash
235 // this frame.
philipel9b2ce6b2016-07-05 05:04:46 -0700236 uint16_t last_picture_id_gop = seq_num_it->second.first;
237 uint16_t last_picture_id_with_padding_gop = seq_num_it->second.second;
Niels Möller8f7ce222019-03-21 15:43:58 +0100238 if (frame->frame_type() == VideoFrameType::kVideoFrameDelta) {
philipel9b2ce6b2016-07-05 05:04:46 -0700239 uint16_t prev_seq_num = frame->first_seq_num() - 1;
philipelafcf7f52017-04-26 08:17:35 -0700240
241 if (prev_seq_num != last_picture_id_with_padding_gop)
242 return kStash;
philipel02447bc2016-05-13 06:01:03 -0700243 }
244
245 RTC_DCHECK(AheadOrAt(frame->last_seq_num(), seq_num_it->first));
246
247 // Since keyframes can cause reordering we can't simply assign the
248 // picture id according to some incrementing counter.
philipel0fa82a62018-03-19 15:34:53 +0100249 frame->id.picture_id = frame->last_seq_num();
Niels Möller8f7ce222019-03-21 15:43:58 +0100250 frame->num_references =
251 frame->frame_type() == VideoFrameType::kVideoFrameDelta;
philipeldabfcae2018-09-25 12:54:37 +0200252 frame->references[0] = rtp_seq_num_unwrapper_.Unwrap(last_picture_id_gop);
philipel0fa82a62018-03-19 15:34:53 +0100253 if (AheadOf<uint16_t>(frame->id.picture_id, last_picture_id_gop)) {
254 seq_num_it->second.first = frame->id.picture_id;
255 seq_num_it->second.second = frame->id.picture_id;
philipel9b2ce6b2016-07-05 05:04:46 -0700256 }
philipel02447bc2016-05-13 06:01:03 -0700257
philipel0fa82a62018-03-19 15:34:53 +0100258 last_picture_id_ = frame->id.picture_id;
259 UpdateLastPictureIdWithPadding(frame->id.picture_id);
philipeldabfcae2018-09-25 12:54:37 +0200260 frame->id.picture_id = rtp_seq_num_unwrapper_.Unwrap(frame->id.picture_id);
philipelafcf7f52017-04-26 08:17:35 -0700261 return kHandOff;
philipel02447bc2016-05-13 06:01:03 -0700262}
263
philipelafcf7f52017-04-26 08:17:35 -0700264RtpFrameReferenceFinder::FrameDecision RtpFrameReferenceFinder::ManageFrameVp8(
265 RtpFrameObject* frame) {
philipel5470f402018-09-07 13:38:53 +0200266 absl::optional<RTPVideoHeader> video_header = frame->GetRtpVideoHeader();
Sami Kalliomäki98824952018-08-28 14:39:21 +0200267 if (!video_header) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100268 RTC_LOG(LS_WARNING)
269 << "Failed to get codec header from frame, dropping frame.";
philipelafcf7f52017-04-26 08:17:35 -0700270 return kDrop;
philipeld4fac692017-09-04 07:03:46 -0700271 }
Sami Kalliomäki98824952018-08-28 14:39:21 +0200272 RTPVideoTypeHeader rtp_codec_header = video_header->video_type_header;
philipel02447bc2016-05-13 06:01:03 -0700273
philipel1a4746a2018-07-09 15:52:29 +0200274 const RTPVideoHeaderVP8& codec_header =
Sami Kalliomäki98824952018-08-28 14:39:21 +0200275 absl::get<RTPVideoHeaderVP8>(rtp_codec_header);
philipel02447bc2016-05-13 06:01:03 -0700276
277 if (codec_header.pictureId == kNoPictureId ||
278 codec_header.temporalIdx == kNoTemporalIdx ||
279 codec_header.tl0PicIdx == kNoTl0PicIdx) {
Mirko Bonadei05cf6be2019-01-31 21:38:12 +0100280 return ManageFramePidOrSeqNum(frame, codec_header.pictureId);
philipel02447bc2016-05-13 06:01:03 -0700281 }
282
philipel0fa82a62018-03-19 15:34:53 +0100283 frame->id.picture_id = codec_header.pictureId % kPicIdLength;
philipel02447bc2016-05-13 06:01:03 -0700284
philipel02447bc2016-05-13 06:01:03 -0700285 if (last_picture_id_ == -1)
philipel0fa82a62018-03-19 15:34:53 +0100286 last_picture_id_ = frame->id.picture_id;
philipel02447bc2016-05-13 06:01:03 -0700287
288 // Find if there has been a gap in fully received frames and save the picture
289 // id of those frames in |not_yet_received_frames_|.
philipel0fa82a62018-03-19 15:34:53 +0100290 if (AheadOf<uint16_t, kPicIdLength>(frame->id.picture_id, last_picture_id_)) {
philipel9bd1d662017-07-14 04:52:01 -0700291 do {
philipel02447bc2016-05-13 06:01:03 -0700292 last_picture_id_ = Add<kPicIdLength>(last_picture_id_, 1);
philipel9bd1d662017-07-14 04:52:01 -0700293 not_yet_received_frames_.insert(last_picture_id_);
philipel0fa82a62018-03-19 15:34:53 +0100294 } while (last_picture_id_ != frame->id.picture_id);
philipel02447bc2016-05-13 06:01:03 -0700295 }
296
philipel57ec6852018-07-03 18:09:32 +0200297 int64_t unwrapped_tl0 = tl0_unwrapper_.Unwrap(codec_header.tl0PicIdx);
298
philipel02447bc2016-05-13 06:01:03 -0700299 // Clean up info for base layers that are too old.
philipel57ec6852018-07-03 18:09:32 +0200300 int64_t old_tl0_pic_idx = unwrapped_tl0 - kMaxLayerInfo;
philipel02447bc2016-05-13 06:01:03 -0700301 auto clean_layer_info_to = layer_info_.lower_bound(old_tl0_pic_idx);
302 layer_info_.erase(layer_info_.begin(), clean_layer_info_to);
303
304 // Clean up info about not yet received frames that are too old.
305 uint16_t old_picture_id =
philipel0fa82a62018-03-19 15:34:53 +0100306 Subtract<kPicIdLength>(frame->id.picture_id, kMaxNotYetReceivedFrames);
philipel02447bc2016-05-13 06:01:03 -0700307 auto clean_frames_to = not_yet_received_frames_.lower_bound(old_picture_id);
308 not_yet_received_frames_.erase(not_yet_received_frames_.begin(),
309 clean_frames_to);
310
Niels Möller8f7ce222019-03-21 15:43:58 +0100311 if (frame->frame_type() == VideoFrameType::kVideoFrameKey) {
philipel02447bc2016-05-13 06:01:03 -0700312 frame->num_references = 0;
philipel57ec6852018-07-03 18:09:32 +0200313 layer_info_[unwrapped_tl0].fill(-1);
314 UpdateLayerInfoVp8(frame, unwrapped_tl0, codec_header.temporalIdx);
philipelafcf7f52017-04-26 08:17:35 -0700315 return kHandOff;
philipel02447bc2016-05-13 06:01:03 -0700316 }
317
philipel57ec6852018-07-03 18:09:32 +0200318 auto layer_info_it = layer_info_.find(
319 codec_header.temporalIdx == 0 ? unwrapped_tl0 - 1 : unwrapped_tl0);
philipel02447bc2016-05-13 06:01:03 -0700320
321 // If we don't have the base layer frame yet, stash this frame.
philipelafcf7f52017-04-26 08:17:35 -0700322 if (layer_info_it == layer_info_.end())
323 return kStash;
philipel02447bc2016-05-13 06:01:03 -0700324
325 // A non keyframe base layer frame has been received, copy the layer info
326 // from the previous base layer frame and set a reference to the previous
327 // base layer frame.
328 if (codec_header.temporalIdx == 0) {
329 layer_info_it =
philipel57ec6852018-07-03 18:09:32 +0200330 layer_info_.emplace(unwrapped_tl0, layer_info_it->second).first;
philipel02447bc2016-05-13 06:01:03 -0700331 frame->num_references = 1;
332 frame->references[0] = layer_info_it->second[0];
philipel57ec6852018-07-03 18:09:32 +0200333 UpdateLayerInfoVp8(frame, unwrapped_tl0, codec_header.temporalIdx);
philipelafcf7f52017-04-26 08:17:35 -0700334 return kHandOff;
philipel02447bc2016-05-13 06:01:03 -0700335 }
336
337 // Layer sync frame, this frame only references its base layer frame.
338 if (codec_header.layerSync) {
339 frame->num_references = 1;
340 frame->references[0] = layer_info_it->second[0];
341
philipel57ec6852018-07-03 18:09:32 +0200342 UpdateLayerInfoVp8(frame, unwrapped_tl0, codec_header.temporalIdx);
philipelafcf7f52017-04-26 08:17:35 -0700343 return kHandOff;
philipel02447bc2016-05-13 06:01:03 -0700344 }
345
346 // Find all references for this frame.
347 frame->num_references = 0;
348 for (uint8_t layer = 0; layer <= codec_header.temporalIdx; ++layer) {
philipeld268d6f2016-09-15 13:43:13 +0200349 // If we have not yet received a previous frame on this temporal layer,
350 // stash this frame.
philipelafcf7f52017-04-26 08:17:35 -0700351 if (layer_info_it->second[layer] == -1)
352 return kStash;
philipel02447bc2016-05-13 06:01:03 -0700353
philipel86b92e02016-10-24 07:11:53 -0700354 // If the last frame on this layer is ahead of this frame it means that
355 // a layer sync frame has been received after this frame for the same
356 // base layer frame, drop this frame.
357 if (AheadOf<uint16_t, kPicIdLength>(layer_info_it->second[layer],
philipel0fa82a62018-03-19 15:34:53 +0100358 frame->id.picture_id)) {
philipelafcf7f52017-04-26 08:17:35 -0700359 return kDrop;
philipel86b92e02016-10-24 07:11:53 -0700360 }
361
philipel02447bc2016-05-13 06:01:03 -0700362 // If we have not yet received a frame between this frame and the referenced
363 // frame then we have to wait for that frame to be completed first.
364 auto not_received_frame_it =
365 not_yet_received_frames_.upper_bound(layer_info_it->second[layer]);
366 if (not_received_frame_it != not_yet_received_frames_.end() &&
philipel0fa82a62018-03-19 15:34:53 +0100367 AheadOf<uint16_t, kPicIdLength>(frame->id.picture_id,
philipel02447bc2016-05-13 06:01:03 -0700368 *not_received_frame_it)) {
philipelafcf7f52017-04-26 08:17:35 -0700369 return kStash;
philipel02447bc2016-05-13 06:01:03 -0700370 }
371
philipel0fa82a62018-03-19 15:34:53 +0100372 if (!(AheadOf<uint16_t, kPicIdLength>(frame->id.picture_id,
philipel57f19cc2017-03-07 03:54:05 -0800373 layer_info_it->second[layer]))) {
philipel0fa82a62018-03-19 15:34:53 +0100374 RTC_LOG(LS_WARNING) << "Frame with picture id " << frame->id.picture_id
Mirko Bonadei675513b2017-11-09 11:09:25 +0100375 << " and packet range [" << frame->first_seq_num()
376 << ", " << frame->last_seq_num()
377 << "] already received, "
378 << " dropping frame.";
philipelafcf7f52017-04-26 08:17:35 -0700379 return kDrop;
philipel57f19cc2017-03-07 03:54:05 -0800380 }
381
philipel02447bc2016-05-13 06:01:03 -0700382 ++frame->num_references;
383 frame->references[layer] = layer_info_it->second[layer];
384 }
385
philipel57ec6852018-07-03 18:09:32 +0200386 UpdateLayerInfoVp8(frame, unwrapped_tl0, codec_header.temporalIdx);
philipelafcf7f52017-04-26 08:17:35 -0700387 return kHandOff;
philipel02447bc2016-05-13 06:01:03 -0700388}
389
philipel57ec6852018-07-03 18:09:32 +0200390void RtpFrameReferenceFinder::UpdateLayerInfoVp8(RtpFrameObject* frame,
391 int64_t unwrapped_tl0,
392 uint8_t temporal_idx) {
393 auto layer_info_it = layer_info_.find(unwrapped_tl0);
philipel02447bc2016-05-13 06:01:03 -0700394
395 // Update this layer info and newer.
396 while (layer_info_it != layer_info_.end()) {
philipel57ec6852018-07-03 18:09:32 +0200397 if (layer_info_it->second[temporal_idx] != -1 &&
398 AheadOf<uint16_t, kPicIdLength>(layer_info_it->second[temporal_idx],
philipel0fa82a62018-03-19 15:34:53 +0100399 frame->id.picture_id)) {
philipel02447bc2016-05-13 06:01:03 -0700400 // The frame was not newer, then no subsequent layer info have to be
401 // update.
402 break;
403 }
404
philipel57ec6852018-07-03 18:09:32 +0200405 layer_info_it->second[temporal_idx] = frame->id.picture_id;
406 ++unwrapped_tl0;
407 layer_info_it = layer_info_.find(unwrapped_tl0);
philipel02447bc2016-05-13 06:01:03 -0700408 }
philipel0fa82a62018-03-19 15:34:53 +0100409 not_yet_received_frames_.erase(frame->id.picture_id);
philipel02447bc2016-05-13 06:01:03 -0700410
philipelafcf7f52017-04-26 08:17:35 -0700411 UnwrapPictureIds(frame);
philipel02447bc2016-05-13 06:01:03 -0700412}
413
philipelafcf7f52017-04-26 08:17:35 -0700414RtpFrameReferenceFinder::FrameDecision RtpFrameReferenceFinder::ManageFrameVp9(
415 RtpFrameObject* frame) {
philipel5470f402018-09-07 13:38:53 +0200416 absl::optional<RTPVideoHeader> video_header = frame->GetRtpVideoHeader();
Sami Kalliomäki98824952018-08-28 14:39:21 +0200417 if (!video_header) {
Mirko Bonadei675513b2017-11-09 11:09:25 +0100418 RTC_LOG(LS_WARNING)
419 << "Failed to get codec header from frame, dropping frame.";
philipel4c140092017-08-31 08:31:45 -0700420 return kDrop;
philipeld4fac692017-09-04 07:03:46 -0700421 }
Sami Kalliomäki98824952018-08-28 14:39:21 +0200422 RTPVideoTypeHeader rtp_codec_header = video_header->video_type_header;
philipel4c140092017-08-31 08:31:45 -0700423
philipel1a4746a2018-07-09 15:52:29 +0200424 const RTPVideoHeaderVP9& codec_header =
Sami Kalliomäki98824952018-08-28 14:39:21 +0200425 absl::get<RTPVideoHeaderVP9>(rtp_codec_header);
philipel02447bc2016-05-13 06:01:03 -0700426
philipel647998c2016-06-03 09:40:16 -0700427 if (codec_header.picture_id == kNoPictureId ||
Sergey Silkind34a1882018-08-20 16:46:05 +0200428 codec_header.temporal_idx == kNoTemporalIdx) {
Mirko Bonadei05cf6be2019-01-31 21:38:12 +0100429 return ManageFramePidOrSeqNum(frame, codec_header.picture_id);
philipel02447bc2016-05-13 06:01:03 -0700430 }
431
philipel0fa82a62018-03-19 15:34:53 +0100432 frame->id.spatial_layer = codec_header.spatial_idx;
philipel02447bc2016-05-13 06:01:03 -0700433 frame->inter_layer_predicted = codec_header.inter_layer_predicted;
philipel0fa82a62018-03-19 15:34:53 +0100434 frame->id.picture_id = codec_header.picture_id % kPicIdLength;
philipel02447bc2016-05-13 06:01:03 -0700435
philipel02447bc2016-05-13 06:01:03 -0700436 if (last_picture_id_ == -1)
philipel0fa82a62018-03-19 15:34:53 +0100437 last_picture_id_ = frame->id.picture_id;
philipel02447bc2016-05-13 06:01:03 -0700438
439 if (codec_header.flexible_mode) {
440 frame->num_references = codec_header.num_ref_pics;
441 for (size_t i = 0; i < frame->num_references; ++i) {
philipel0fa82a62018-03-19 15:34:53 +0100442 frame->references[i] = Subtract<kPicIdLength>(frame->id.picture_id,
443 codec_header.pid_diff[i]);
philipel02447bc2016-05-13 06:01:03 -0700444 }
445
philipelafcf7f52017-04-26 08:17:35 -0700446 UnwrapPictureIds(frame);
447 return kHandOff;
philipel02447bc2016-05-13 06:01:03 -0700448 }
449
Sergey Silkind34a1882018-08-20 16:46:05 +0200450 if (codec_header.tl0_pic_idx == kNoTl0PicIdx) {
451 RTC_LOG(LS_WARNING) << "TL0PICIDX is expected to be present in "
452 "non-flexible mode.";
453 return kDrop;
454 }
455
philipel15643602018-05-03 16:14:13 +0200456 GofInfo* info;
philipel57ec6852018-07-03 18:09:32 +0200457 int64_t unwrapped_tl0 = tl0_unwrapper_.Unwrap(codec_header.tl0_pic_idx);
philipel02447bc2016-05-13 06:01:03 -0700458 if (codec_header.ss_data_available) {
philipel02447bc2016-05-13 06:01:03 -0700459 if (codec_header.temporal_idx != 0) {
philipel15643602018-05-03 16:14:13 +0200460 RTC_LOG(LS_WARNING) << "Received scalability structure on a non base "
461 "layer frame. Scalability structure ignored.";
philipel02447bc2016-05-13 06:01:03 -0700462 } else {
Sergey Silkin2f864fb2018-09-07 11:49:38 +0200463 if (codec_header.gof.num_frames_in_gof > kMaxVp9FramesInGof) {
Natalie Silvanovich3ea3e302018-05-16 11:03:12 -0700464 return kDrop;
465 }
466
Sergey Silkin2f864fb2018-09-07 11:49:38 +0200467 GofInfoVP9 gof = codec_header.gof;
468 if (gof.num_frames_in_gof == 0) {
469 RTC_LOG(LS_WARNING) << "Number of frames in GOF is zero. Assume "
470 "that stream has only one temporal layer.";
471 gof.SetGofInfoVP9(kTemporalStructureMode1);
472 }
473
474 current_ss_idx_ = Add<kMaxGofSaved>(current_ss_idx_, 1);
475 scalability_structures_[current_ss_idx_] = gof;
philipel0fa82a62018-03-19 15:34:53 +0100476 scalability_structures_[current_ss_idx_].pid_start = frame->id.picture_id;
philipel57ec6852018-07-03 18:09:32 +0200477 gof_info_.emplace(unwrapped_tl0,
philipel15643602018-05-03 16:14:13 +0200478 GofInfo(&scalability_structures_[current_ss_idx_],
479 frame->id.picture_id));
philipel02447bc2016-05-13 06:01:03 -0700480 }
philipel15643602018-05-03 16:14:13 +0200481
philipel57ec6852018-07-03 18:09:32 +0200482 const auto gof_info_it = gof_info_.find(unwrapped_tl0);
philipel15643602018-05-03 16:14:13 +0200483 if (gof_info_it == gof_info_.end())
484 return kStash;
485
486 info = &gof_info_it->second;
487
Niels Möller8f7ce222019-03-21 15:43:58 +0100488 if (frame->frame_type() == VideoFrameType::kVideoFrameKey) {
philipel15643602018-05-03 16:14:13 +0200489 frame->num_references = 0;
490 FrameReceivedVp9(frame->id.picture_id, info);
491 UnwrapPictureIds(frame);
492 return kHandOff;
493 }
Niels Möller8f7ce222019-03-21 15:43:58 +0100494 } else if (frame->frame_type() == VideoFrameType::kVideoFrameKey) {
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100495 if (frame->id.spatial_layer == 0) {
philipel15643602018-05-03 16:14:13 +0200496 RTC_LOG(LS_WARNING) << "Received keyframe without scalability structure";
497 return kDrop;
498 }
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100499 const auto gof_info_it = gof_info_.find(unwrapped_tl0);
500 if (gof_info_it == gof_info_.end())
501 return kStash;
philipel15643602018-05-03 16:14:13 +0200502
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100503 info = &gof_info_it->second;
504
Niels Möller8f7ce222019-03-21 15:43:58 +0100505 if (frame->frame_type() == VideoFrameType::kVideoFrameKey) {
Ilya Nikolaevskiy5546aef2018-12-04 15:54:52 +0100506 frame->num_references = 0;
507 FrameReceivedVp9(frame->id.picture_id, info);
508 UnwrapPictureIds(frame);
509 return kHandOff;
510 }
511 } else {
philipel57ec6852018-07-03 18:09:32 +0200512 auto gof_info_it = gof_info_.find(
513 (codec_header.temporal_idx == 0) ? unwrapped_tl0 - 1 : unwrapped_tl0);
philipel15643602018-05-03 16:14:13 +0200514
515 // Gof info for this frame is not available yet, stash this frame.
516 if (gof_info_it == gof_info_.end())
517 return kStash;
518
519 if (codec_header.temporal_idx == 0) {
philipel57ec6852018-07-03 18:09:32 +0200520 gof_info_it = gof_info_
521 .emplace(unwrapped_tl0, GofInfo(gof_info_it->second.gof,
522 frame->id.picture_id))
523 .first;
philipel15643602018-05-03 16:14:13 +0200524 }
525
526 info = &gof_info_it->second;
philipel02447bc2016-05-13 06:01:03 -0700527 }
528
529 // Clean up info for base layers that are too old.
philipel57ec6852018-07-03 18:09:32 +0200530 int64_t old_tl0_pic_idx = unwrapped_tl0 - kMaxGofSaved;
philipel02447bc2016-05-13 06:01:03 -0700531 auto clean_gof_info_to = gof_info_.lower_bound(old_tl0_pic_idx);
532 gof_info_.erase(gof_info_.begin(), clean_gof_info_to);
533
philipel0fa82a62018-03-19 15:34:53 +0100534 FrameReceivedVp9(frame->id.picture_id, info);
philipel02447bc2016-05-13 06:01:03 -0700535
536 // Make sure we don't miss any frame that could potentially have the
537 // up switch flag set.
philipel0fa82a62018-03-19 15:34:53 +0100538 if (MissingRequiredFrameVp9(frame->id.picture_id, *info))
philipelafcf7f52017-04-26 08:17:35 -0700539 return kStash;
philipel02447bc2016-05-13 06:01:03 -0700540
philipel15643602018-05-03 16:14:13 +0200541 if (codec_header.temporal_up_switch)
542 up_switch_.emplace(frame->id.picture_id, codec_header.temporal_idx);
philipel02447bc2016-05-13 06:01:03 -0700543
544 // Clean out old info about up switch frames.
philipel0fa82a62018-03-19 15:34:53 +0100545 uint16_t old_picture_id = Subtract<kPicIdLength>(frame->id.picture_id, 50);
philipel02447bc2016-05-13 06:01:03 -0700546 auto up_switch_erase_to = up_switch_.lower_bound(old_picture_id);
547 up_switch_.erase(up_switch_.begin(), up_switch_erase_to);
548
philipelc9b27d52016-07-15 06:50:27 -0700549 size_t diff = ForwardDiff<uint16_t, kPicIdLength>(info->gof->pid_start,
philipel0fa82a62018-03-19 15:34:53 +0100550 frame->id.picture_id);
philipelc9b27d52016-07-15 06:50:27 -0700551 size_t gof_idx = diff % info->gof->num_frames_in_gof;
philipel02447bc2016-05-13 06:01:03 -0700552
553 // Populate references according to the scalability structure.
philipelc9b27d52016-07-15 06:50:27 -0700554 frame->num_references = info->gof->num_ref_pics[gof_idx];
philipel02447bc2016-05-13 06:01:03 -0700555 for (size_t i = 0; i < frame->num_references; ++i) {
philipelc9b27d52016-07-15 06:50:27 -0700556 frame->references[i] = Subtract<kPicIdLength>(
philipel0fa82a62018-03-19 15:34:53 +0100557 frame->id.picture_id, info->gof->pid_diff[gof_idx][i]);
philipel02447bc2016-05-13 06:01:03 -0700558
559 // If this is a reference to a frame earlier than the last up switch point,
560 // then ignore this reference.
philipel0fa82a62018-03-19 15:34:53 +0100561 if (UpSwitchInIntervalVp9(frame->id.picture_id, codec_header.temporal_idx,
philipel02447bc2016-05-13 06:01:03 -0700562 frame->references[i])) {
563 --frame->num_references;
564 }
565 }
566
Ilya Nikolaevskiy2ec0c652019-01-18 11:56:48 +0100567 // Override GOF references.
568 if (!codec_header.inter_pic_predicted) {
569 frame->num_references = 0;
570 }
571
philipelafcf7f52017-04-26 08:17:35 -0700572 UnwrapPictureIds(frame);
573 return kHandOff;
philipel02447bc2016-05-13 06:01:03 -0700574}
575
576bool RtpFrameReferenceFinder::MissingRequiredFrameVp9(uint16_t picture_id,
philipelc9b27d52016-07-15 06:50:27 -0700577 const GofInfo& info) {
578 size_t diff =
579 ForwardDiff<uint16_t, kPicIdLength>(info.gof->pid_start, picture_id);
580 size_t gof_idx = diff % info.gof->num_frames_in_gof;
581 size_t temporal_idx = info.gof->temporal_idx[gof_idx];
philipel02447bc2016-05-13 06:01:03 -0700582
philipela157e082018-05-02 15:19:01 +0200583 if (temporal_idx >= kMaxTemporalLayers) {
584 RTC_LOG(LS_WARNING) << "At most " << kMaxTemporalLayers << " temporal "
585 << "layers are supported.";
586 return true;
587 }
588
philipel02447bc2016-05-13 06:01:03 -0700589 // For every reference this frame has, check if there is a frame missing in
590 // the interval (|ref_pid|, |picture_id|) in any of the lower temporal
591 // layers. If so, we are missing a required frame.
philipelc9b27d52016-07-15 06:50:27 -0700592 uint8_t num_references = info.gof->num_ref_pics[gof_idx];
philipel02447bc2016-05-13 06:01:03 -0700593 for (size_t i = 0; i < num_references; ++i) {
594 uint16_t ref_pid =
philipelc9b27d52016-07-15 06:50:27 -0700595 Subtract<kPicIdLength>(picture_id, info.gof->pid_diff[gof_idx][i]);
philipel02447bc2016-05-13 06:01:03 -0700596 for (size_t l = 0; l < temporal_idx; ++l) {
597 auto missing_frame_it = missing_frames_for_layer_[l].lower_bound(ref_pid);
598 if (missing_frame_it != missing_frames_for_layer_[l].end() &&
599 AheadOf<uint16_t, kPicIdLength>(picture_id, *missing_frame_it)) {
600 return true;
601 }
602 }
603 }
604 return false;
605}
606
607void RtpFrameReferenceFinder::FrameReceivedVp9(uint16_t picture_id,
philipelc9b27d52016-07-15 06:50:27 -0700608 GofInfo* info) {
609 int last_picture_id = info->last_picture_id;
philipel459f4e32018-03-02 10:55:12 +0100610 size_t gof_size = std::min(info->gof->num_frames_in_gof, kMaxVp9FramesInGof);
philipel02447bc2016-05-13 06:01:03 -0700611
612 // If there is a gap, find which temporal layer the missing frames
613 // belong to and add the frame as missing for that temporal layer.
614 // Otherwise, remove this frame from the set of missing frames.
philipelc9b27d52016-07-15 06:50:27 -0700615 if (AheadOf<uint16_t, kPicIdLength>(picture_id, last_picture_id)) {
616 size_t diff = ForwardDiff<uint16_t, kPicIdLength>(info->gof->pid_start,
617 last_picture_id);
philipel459f4e32018-03-02 10:55:12 +0100618 size_t gof_idx = diff % gof_size;
philipel02447bc2016-05-13 06:01:03 -0700619
philipelc9b27d52016-07-15 06:50:27 -0700620 last_picture_id = Add<kPicIdLength>(last_picture_id, 1);
621 while (last_picture_id != picture_id) {
Yves Gerey665174f2018-06-19 15:03:05 +0200622 gof_idx = (gof_idx + 1) % gof_size;
philipel459f4e32018-03-02 10:55:12 +0100623 RTC_CHECK(gof_idx < kMaxVp9FramesInGof);
624
philipelc9b27d52016-07-15 06:50:27 -0700625 size_t temporal_idx = info->gof->temporal_idx[gof_idx];
philipel459f4e32018-03-02 10:55:12 +0100626 if (temporal_idx >= kMaxTemporalLayers) {
627 RTC_LOG(LS_WARNING) << "At most " << kMaxTemporalLayers << " temporal "
628 << "layers are supported.";
629 return;
630 }
631
philipelc9b27d52016-07-15 06:50:27 -0700632 missing_frames_for_layer_[temporal_idx].insert(last_picture_id);
633 last_picture_id = Add<kPicIdLength>(last_picture_id, 1);
philipel02447bc2016-05-13 06:01:03 -0700634 }
philipel459f4e32018-03-02 10:55:12 +0100635
philipelc9b27d52016-07-15 06:50:27 -0700636 info->last_picture_id = last_picture_id;
philipel02447bc2016-05-13 06:01:03 -0700637 } else {
638 size_t diff =
philipelc9b27d52016-07-15 06:50:27 -0700639 ForwardDiff<uint16_t, kPicIdLength>(info->gof->pid_start, picture_id);
philipel459f4e32018-03-02 10:55:12 +0100640 size_t gof_idx = diff % gof_size;
641 RTC_CHECK(gof_idx < kMaxVp9FramesInGof);
642
philipelc9b27d52016-07-15 06:50:27 -0700643 size_t temporal_idx = info->gof->temporal_idx[gof_idx];
philipel459f4e32018-03-02 10:55:12 +0100644 if (temporal_idx >= kMaxTemporalLayers) {
645 RTC_LOG(LS_WARNING) << "At most " << kMaxTemporalLayers << " temporal "
646 << "layers are supported.";
647 return;
648 }
649
philipel02447bc2016-05-13 06:01:03 -0700650 missing_frames_for_layer_[temporal_idx].erase(picture_id);
651 }
652}
653
654bool RtpFrameReferenceFinder::UpSwitchInIntervalVp9(uint16_t picture_id,
655 uint8_t temporal_idx,
656 uint16_t pid_ref) {
657 for (auto up_switch_it = up_switch_.upper_bound(pid_ref);
658 up_switch_it != up_switch_.end() &&
659 AheadOf<uint16_t, kPicIdLength>(picture_id, up_switch_it->first);
660 ++up_switch_it) {
661 if (up_switch_it->second < temporal_idx)
662 return true;
663 }
664
665 return false;
666}
667
philipelafcf7f52017-04-26 08:17:35 -0700668void RtpFrameReferenceFinder::UnwrapPictureIds(RtpFrameObject* frame) {
philipel02447bc2016-05-13 06:01:03 -0700669 for (size_t i = 0; i < frame->num_references; ++i)
philipeld4fac692017-09-04 07:03:46 -0700670 frame->references[i] = unwrapper_.Unwrap(frame->references[i]);
philipel0fa82a62018-03-19 15:34:53 +0100671 frame->id.picture_id = unwrapper_.Unwrap(frame->id.picture_id);
philipel02447bc2016-05-13 06:01:03 -0700672}
673
philipel02447bc2016-05-13 06:01:03 -0700674} // namespace video_coding
675} // namespace webrtc