blob: 58ad31e50cefda7c959cdeffb08d22b61e795c94 [file] [log] [blame]
philipelc70e4ec2016-04-01 09:01:541/*
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
11#include "webrtc/modules/video_coding/packet_buffer.h"
12
13#include <algorithm>
14#include <limits>
philipel50934662016-08-11 13:09:2615#include <utility>
philipelc70e4ec2016-04-01 09:01:5416
philipel50934662016-08-11 13:09:2617#include "webrtc/base/atomicops.h"
philipelc70e4ec2016-04-01 09:01:5418#include "webrtc/base/checks.h"
philipel2e86f762016-05-09 09:41:4819#include "webrtc/base/logging.h"
philipelc70e4ec2016-04-01 09:01:5420#include "webrtc/modules/video_coding/frame_object.h"
philipeld053dee2016-07-11 15:46:2921#include "webrtc/system_wrappers/include/clock.h"
philipelc70e4ec2016-04-01 09:01:5422
23namespace webrtc {
24namespace video_coding {
25
philipel50934662016-08-11 13:09:2626rtc::scoped_refptr<PacketBuffer> PacketBuffer::Create(
27 Clock* clock,
28 size_t start_buffer_size,
29 size_t max_buffer_size,
30 OnReceivedFrameCallback* received_frame_callback) {
31 return rtc::scoped_refptr<PacketBuffer>(new PacketBuffer(
32 clock, start_buffer_size, max_buffer_size, received_frame_callback));
33}
34
philipeld053dee2016-07-11 15:46:2935PacketBuffer::PacketBuffer(Clock* clock,
36 size_t start_buffer_size,
philipelc70e4ec2016-04-01 09:01:5437 size_t max_buffer_size,
philipel50934662016-08-11 13:09:2638 OnReceivedFrameCallback* received_frame_callback)
philipeld053dee2016-07-11 15:46:2939 : clock_(clock),
40 size_(start_buffer_size),
philipelc70e4ec2016-04-01 09:01:5441 max_size_(max_buffer_size),
philipelc70e4ec2016-04-01 09:01:5442 first_seq_num_(0),
philipel2d4f1082016-04-20 08:26:3443 last_seq_num_(0),
44 first_packet_received_(false),
philipel56757802016-11-01 10:45:3445 is_cleared_to_first_seq_num_(false),
philipelc70e4ec2016-04-01 09:01:5446 data_buffer_(start_buffer_size),
47 sequence_buffer_(start_buffer_size),
philipel50934662016-08-11 13:09:2648 received_frame_callback_(received_frame_callback) {
philipelc70e4ec2016-04-01 09:01:5449 RTC_DCHECK_LE(start_buffer_size, max_buffer_size);
50 // Buffer size must always be a power of 2.
51 RTC_DCHECK((start_buffer_size & (start_buffer_size - 1)) == 0);
52 RTC_DCHECK((max_buffer_size & (max_buffer_size - 1)) == 0);
53}
54
philipel56757802016-11-01 10:45:3455PacketBuffer::~PacketBuffer() {
56 Clear();
57}
philipel50934662016-08-11 13:09:2658
philipelc70e4ec2016-04-01 09:01:5459bool PacketBuffer::InsertPacket(const VCMPacket& packet) {
60 rtc::CritScope lock(&crit_);
61 uint16_t seq_num = packet.seqNum;
philipel2d4f1082016-04-20 08:26:3462 size_t index = seq_num % size_;
philipelc70e4ec2016-04-01 09:01:5463
philipel2d4f1082016-04-20 08:26:3464 if (!first_packet_received_) {
philipel56757802016-11-01 10:45:3465 first_seq_num_ = seq_num;
philipelc70e4ec2016-04-01 09:01:5466 last_seq_num_ = seq_num;
philipel2d4f1082016-04-20 08:26:3467 first_packet_received_ = true;
philipel56757802016-11-01 10:45:3468 } else if (AheadOf(first_seq_num_, seq_num)) {
69 // If we have explicitly cleared past this packet then it's old,
70 // don't insert it.
71 if (is_cleared_to_first_seq_num_)
72 return false;
73
74 first_seq_num_ = seq_num;
philipelc70e4ec2016-04-01 09:01:5475 }
76
77 if (sequence_buffer_[index].used) {
78 // Duplicate packet, do nothing.
79 if (data_buffer_[index].seqNum == packet.seqNum)
80 return true;
81
82 // The packet buffer is full, try to expand the buffer.
83 while (ExpandBufferSize() && sequence_buffer_[seq_num % size_].used) {
84 }
85 index = seq_num % size_;
86
87 // Packet buffer is still full.
88 if (sequence_buffer_[index].used)
89 return false;
90 }
91
92 if (AheadOf(seq_num, last_seq_num_))
93 last_seq_num_ = seq_num;
94
95 sequence_buffer_[index].frame_begin = packet.isFirstPacket;
96 sequence_buffer_[index].frame_end = packet.markerBit;
97 sequence_buffer_[index].seq_num = packet.seqNum;
98 sequence_buffer_[index].continuous = false;
philipel2d4f1082016-04-20 08:26:3499 sequence_buffer_[index].frame_created = false;
philipelc70e4ec2016-04-01 09:01:54100 sequence_buffer_[index].used = true;
101 data_buffer_[index] = packet;
102
philipel2d4f1082016-04-20 08:26:34103 FindFrames(seq_num);
philipelc70e4ec2016-04-01 09:01:54104 return true;
105}
106
107void PacketBuffer::ClearTo(uint16_t seq_num) {
108 rtc::CritScope lock(&crit_);
philipel56757802016-11-01 10:45:34109
110 // If the packet buffer was cleared between a frame was created and returned.
111 if (!first_packet_received_)
112 return;
113
114 is_cleared_to_first_seq_num_ = true;
115 while (AheadOrAt<uint16_t>(seq_num, first_seq_num_)) {
116 size_t index = first_seq_num_ % size_;
philipel8f48a0f2016-09-21 09:27:47117 delete[] data_buffer_[index].dataPtr;
118 data_buffer_[index].dataPtr = nullptr;
philipelc70e4ec2016-04-01 09:01:54119 sequence_buffer_[index].used = false;
philipel56757802016-11-01 10:45:34120 ++first_seq_num_;
philipelc70e4ec2016-04-01 09:01:54121 }
122}
123
philipel56757802016-11-01 10:45:34124void PacketBuffer::Clear() {
125 rtc::CritScope lock(&crit_);
126 for (size_t i = 0; i < size_; ++i) {
127 delete[] data_buffer_[i].dataPtr;
128 data_buffer_[i].dataPtr = nullptr;
129 sequence_buffer_[i].used = false;
130 }
131
132 first_packet_received_ = false;
133 is_cleared_to_first_seq_num_ = false;
134}
135
philipelc70e4ec2016-04-01 09:01:54136bool PacketBuffer::ExpandBufferSize() {
philipel56757802016-11-01 10:45:34137 if (size_ == max_size_) {
138 LOG(LS_WARNING) << "PacketBuffer is already at max size (" << max_size_
139 << "), failed to increase size.";
philipelc70e4ec2016-04-01 09:01:54140 return false;
philipel56757802016-11-01 10:45:34141 }
philipelc70e4ec2016-04-01 09:01:54142
143 size_t new_size = std::min(max_size_, 2 * size_);
144 std::vector<VCMPacket> new_data_buffer(new_size);
145 std::vector<ContinuityInfo> new_sequence_buffer(new_size);
146 for (size_t i = 0; i < size_; ++i) {
147 if (sequence_buffer_[i].used) {
philipel2d4f1082016-04-20 08:26:34148 size_t index = sequence_buffer_[i].seq_num % new_size;
philipelc70e4ec2016-04-01 09:01:54149 new_sequence_buffer[index] = sequence_buffer_[i];
150 new_data_buffer[index] = data_buffer_[i];
151 }
152 }
153 size_ = new_size;
154 sequence_buffer_ = std::move(new_sequence_buffer);
155 data_buffer_ = std::move(new_data_buffer);
philipel56757802016-11-01 10:45:34156 LOG(LS_INFO) << "PacketBuffer size expanded to " << new_size;
philipelc70e4ec2016-04-01 09:01:54157 return true;
158}
159
philipel56757802016-11-01 10:45:34160bool PacketBuffer::PotentialNewFrame(uint16_t seq_num) const {
philipel2d4f1082016-04-20 08:26:34161 size_t index = seq_num % size_;
philipelc70e4ec2016-04-01 09:01:54162 int prev_index = index > 0 ? index - 1 : size_ - 1;
philipel2d4f1082016-04-20 08:26:34163
philipelc70e4ec2016-04-01 09:01:54164 if (!sequence_buffer_[index].used)
165 return false;
philipel2d4f1082016-04-20 08:26:34166 if (sequence_buffer_[index].frame_created)
167 return false;
philipel56757802016-11-01 10:45:34168 if (sequence_buffer_[index].frame_begin &&
169 (!sequence_buffer_[prev_index].used ||
170 AheadOf(seq_num, sequence_buffer_[prev_index].seq_num))) {
171 // The reason we only return true if this packet is the first packet of the
172 // frame and the sequence number is newer than the packet with the previous
173 // index is because we want to avoid an inifite loop in the case where
174 // a single frame containing more packets than the current size of the
175 // packet buffer is inserted.
philipelc70e4ec2016-04-01 09:01:54176 return true;
philipel56757802016-11-01 10:45:34177 }
philipelc70e4ec2016-04-01 09:01:54178 if (!sequence_buffer_[prev_index].used)
179 return false;
philipel2d4f1082016-04-20 08:26:34180 if (sequence_buffer_[prev_index].seq_num !=
philipel56757802016-11-01 10:45:34181 sequence_buffer_[index].seq_num - 1) {
philipel2d4f1082016-04-20 08:26:34182 return false;
philipel56757802016-11-01 10:45:34183 }
philipelc70e4ec2016-04-01 09:01:54184 if (sequence_buffer_[prev_index].continuous)
185 return true;
186
187 return false;
188}
189
philipel2d4f1082016-04-20 08:26:34190void PacketBuffer::FindFrames(uint16_t seq_num) {
philipel56757802016-11-01 10:45:34191 while (PotentialNewFrame(seq_num)) {
192 size_t index = seq_num % size_;
philipelc70e4ec2016-04-01 09:01:54193 sequence_buffer_[index].continuous = true;
194
philipel2d4f1082016-04-20 08:26:34195 // If all packets of the frame is continuous, find the first packet of the
196 // frame and create an RtpFrameObject.
philipelc70e4ec2016-04-01 09:01:54197 if (sequence_buffer_[index].frame_end) {
philipel0aeed852016-05-24 08:20:47198 size_t frame_size = 0;
199 int max_nack_count = -1;
philipelc70e4ec2016-04-01 09:01:54200 uint16_t start_seq_num = seq_num;
philipel2d4f1082016-04-20 08:26:34201
philipel0aeed852016-05-24 08:20:47202 // Find the start index by searching backward until the packet with
203 // the |frame_begin| flag is set.
204 int start_index = index;
205 while (true) {
206 frame_size += data_buffer_[start_index].sizeBytes;
207 max_nack_count = std::max(
208 max_nack_count, data_buffer_[start_index].timesNacked);
philipel2d4f1082016-04-20 08:26:34209 sequence_buffer_[start_index].frame_created = true;
philipel0aeed852016-05-24 08:20:47210
211 if (sequence_buffer_[start_index].frame_begin)
212 break;
213
philipel2d4f1082016-04-20 08:26:34214 start_index = start_index > 0 ? start_index - 1 : size_ - 1;
philipelc70e4ec2016-04-01 09:01:54215 start_seq_num--;
216 }
217
philipeld053dee2016-07-11 15:46:29218 std::unique_ptr<RtpFrameObject> frame(
219 new RtpFrameObject(this, start_seq_num, seq_num, frame_size,
220 max_nack_count, clock_->TimeInMilliseconds()));
philipel50934662016-08-11 13:09:26221
222 received_frame_callback_->OnReceivedFrame(std::move(frame));
philipelc70e4ec2016-04-01 09:01:54223 }
224
philipelc70e4ec2016-04-01 09:01:54225 ++seq_num;
226 }
227}
228
229void PacketBuffer::ReturnFrame(RtpFrameObject* frame) {
230 rtc::CritScope lock(&crit_);
philipel2d4f1082016-04-20 08:26:34231 size_t index = frame->first_seq_num() % size_;
232 size_t end = (frame->last_seq_num() + 1) % size_;
233 uint16_t seq_num = frame->first_seq_num();
philipelc70e4ec2016-04-01 09:01:54234 while (index != end) {
philipel8f48a0f2016-09-21 09:27:47235 if (sequence_buffer_[index].seq_num == seq_num) {
236 delete[] data_buffer_[index].dataPtr;
237 data_buffer_[index].dataPtr = nullptr;
philipelc70e4ec2016-04-01 09:01:54238 sequence_buffer_[index].used = false;
philipel8f48a0f2016-09-21 09:27:47239 }
philipel2d4f1082016-04-20 08:26:34240
philipelc70e4ec2016-04-01 09:01:54241 index = (index + 1) % size_;
242 ++seq_num;
243 }
philipelc70e4ec2016-04-01 09:01:54244}
245
246bool PacketBuffer::GetBitstream(const RtpFrameObject& frame,
247 uint8_t* destination) {
248 rtc::CritScope lock(&crit_);
249
philipel2d4f1082016-04-20 08:26:34250 size_t index = frame.first_seq_num() % size_;
251 size_t end = (frame.last_seq_num() + 1) % size_;
252 uint16_t seq_num = frame.first_seq_num();
philipelc70e4ec2016-04-01 09:01:54253 while (index != end) {
254 if (!sequence_buffer_[index].used ||
255 sequence_buffer_[index].seq_num != seq_num) {
256 return false;
257 }
258
259 const uint8_t* source = data_buffer_[index].dataPtr;
260 size_t length = data_buffer_[index].sizeBytes;
261 memcpy(destination, source, length);
262 destination += length;
263 index = (index + 1) % size_;
264 ++seq_num;
265 }
266 return true;
267}
268
philipel871cc2c2016-05-13 13:01:03269VCMPacket* PacketBuffer::GetPacket(uint16_t seq_num) {
270 rtc::CritScope lock(&crit_);
271 size_t index = seq_num % size_;
272 if (!sequence_buffer_[index].used ||
273 seq_num != sequence_buffer_[index].seq_num) {
274 return nullptr;
philipel2d4f1082016-04-20 08:26:34275 }
philipel871cc2c2016-05-13 13:01:03276 return &data_buffer_[index];
philipel2d4f1082016-04-20 08:26:34277}
278
philipel50934662016-08-11 13:09:26279int PacketBuffer::AddRef() const {
280 return rtc::AtomicOps::Increment(&ref_count_);
281}
282
283int PacketBuffer::Release() const {
284 int count = rtc::AtomicOps::Decrement(&ref_count_);
285 if (!count) {
286 delete this;
287 }
288 return count;
289}
290
philipelc70e4ec2016-04-01 09:01:54291} // namespace video_coding
292} // namespace webrtc