2020-08-14 16:58:22 +00:00
|
|
|
/*
|
|
|
|
* Copyright 2015 The WebRTC Project Authors. All rights reserved.
|
|
|
|
*
|
|
|
|
* Use of this source code is governed by a BSD-style license
|
|
|
|
* that can be found in the LICENSE file in the root of the source
|
|
|
|
* tree. An additional intellectual property rights grant can be found
|
|
|
|
* in the file PATENTS. All contributing project authors may
|
|
|
|
* be found in the AUTHORS file in the root of the source tree.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef RTC_BASE_BUFFER_QUEUE_H_
|
|
|
|
#define RTC_BASE_BUFFER_QUEUE_H_
|
|
|
|
|
|
|
|
#include <stddef.h>
|
|
|
|
|
|
|
|
#include <deque>
|
|
|
|
#include <vector>
|
|
|
|
|
2021-06-25 00:43:10 +00:00
|
|
|
#include "api/sequence_checker.h"
|
2020-08-14 16:58:22 +00:00
|
|
|
#include "rtc_base/buffer.h"
|
2022-03-13 01:58:00 +00:00
|
|
|
#include "rtc_base/constructor_magic.h"
|
2021-06-25 00:43:10 +00:00
|
|
|
#include "rtc_base/system/no_unique_address.h"
|
2020-08-14 16:58:22 +00:00
|
|
|
#include "rtc_base/thread_annotations.h"
|
|
|
|
|
|
|
|
namespace rtc {
|
|
|
|
|
2020-12-23 07:48:30 +00:00
|
|
|
class BufferQueue final {
|
2020-08-14 16:58:22 +00:00
|
|
|
public:
|
|
|
|
// Creates a buffer queue with a given capacity and default buffer size.
|
|
|
|
BufferQueue(size_t capacity, size_t default_size);
|
2020-12-23 07:48:30 +00:00
|
|
|
~BufferQueue();
|
2020-08-14 16:58:22 +00:00
|
|
|
|
|
|
|
// Return number of queued buffers.
|
|
|
|
size_t size() const;
|
|
|
|
|
2022-03-11 16:49:54 +00:00
|
|
|
// Clear the BufferQueue by moving all Buffers from `queue_` to `free_list_`.
|
2020-08-14 16:58:22 +00:00
|
|
|
void Clear();
|
|
|
|
|
|
|
|
// ReadFront will only read one buffer at a time and will truncate buffers
|
|
|
|
// that don't fit in the passed memory.
|
|
|
|
// Returns true unless no data could be returned.
|
|
|
|
bool ReadFront(void* data, size_t bytes, size_t* bytes_read);
|
|
|
|
|
|
|
|
// WriteBack always writes either the complete memory or nothing.
|
|
|
|
// Returns true unless no data could be written.
|
|
|
|
bool WriteBack(const void* data, size_t bytes, size_t* bytes_written);
|
|
|
|
|
2020-12-23 07:48:30 +00:00
|
|
|
bool is_writable() const {
|
|
|
|
RTC_DCHECK_RUN_ON(&sequence_checker_);
|
|
|
|
return queue_.size() < capacity_;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool is_readable() const {
|
|
|
|
RTC_DCHECK_RUN_ON(&sequence_checker_);
|
|
|
|
return !queue_.empty();
|
|
|
|
}
|
2020-08-14 16:58:22 +00:00
|
|
|
|
|
|
|
private:
|
2021-06-25 00:43:10 +00:00
|
|
|
RTC_NO_UNIQUE_ADDRESS webrtc::SequenceChecker sequence_checker_;
|
2020-12-23 07:48:30 +00:00
|
|
|
const size_t capacity_;
|
|
|
|
const size_t default_size_;
|
|
|
|
std::deque<Buffer*> queue_ RTC_GUARDED_BY(sequence_checker_);
|
|
|
|
std::vector<Buffer*> free_list_ RTC_GUARDED_BY(sequence_checker_);
|
2022-03-13 01:58:00 +00:00
|
|
|
|
|
|
|
RTC_DISALLOW_COPY_AND_ASSIGN(BufferQueue);
|
2020-08-14 16:58:22 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace rtc
|
|
|
|
|
|
|
|
#endif // RTC_BASE_BUFFER_QUEUE_H_
|