xref: /aosp_15_r20/external/webrtc/rtc_base/buffer_queue.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1*d9f75844SAndroid Build Coastguard Worker /*
2*d9f75844SAndroid Build Coastguard Worker  *  Copyright 2015 The WebRTC Project Authors. All rights reserved.
3*d9f75844SAndroid Build Coastguard Worker  *
4*d9f75844SAndroid Build Coastguard Worker  *  Use of this source code is governed by a BSD-style license
5*d9f75844SAndroid Build Coastguard Worker  *  that can be found in the LICENSE file in the root of the source
6*d9f75844SAndroid Build Coastguard Worker  *  tree. An additional intellectual property rights grant can be found
7*d9f75844SAndroid Build Coastguard Worker  *  in the file PATENTS.  All contributing project authors may
8*d9f75844SAndroid Build Coastguard Worker  *  be found in the AUTHORS file in the root of the source tree.
9*d9f75844SAndroid Build Coastguard Worker  */
10*d9f75844SAndroid Build Coastguard Worker 
11*d9f75844SAndroid Build Coastguard Worker #ifndef RTC_BASE_BUFFER_QUEUE_H_
12*d9f75844SAndroid Build Coastguard Worker #define RTC_BASE_BUFFER_QUEUE_H_
13*d9f75844SAndroid Build Coastguard Worker 
14*d9f75844SAndroid Build Coastguard Worker #include <stddef.h>
15*d9f75844SAndroid Build Coastguard Worker 
16*d9f75844SAndroid Build Coastguard Worker #include <deque>
17*d9f75844SAndroid Build Coastguard Worker #include <vector>
18*d9f75844SAndroid Build Coastguard Worker 
19*d9f75844SAndroid Build Coastguard Worker #include "api/sequence_checker.h"
20*d9f75844SAndroid Build Coastguard Worker #include "rtc_base/buffer.h"
21*d9f75844SAndroid Build Coastguard Worker #include "rtc_base/system/no_unique_address.h"
22*d9f75844SAndroid Build Coastguard Worker #include "rtc_base/thread_annotations.h"
23*d9f75844SAndroid Build Coastguard Worker 
24*d9f75844SAndroid Build Coastguard Worker namespace rtc {
25*d9f75844SAndroid Build Coastguard Worker 
26*d9f75844SAndroid Build Coastguard Worker class BufferQueue final {
27*d9f75844SAndroid Build Coastguard Worker  public:
28*d9f75844SAndroid Build Coastguard Worker   // Creates a buffer queue with a given capacity and default buffer size.
29*d9f75844SAndroid Build Coastguard Worker   BufferQueue(size_t capacity, size_t default_size);
30*d9f75844SAndroid Build Coastguard Worker   ~BufferQueue();
31*d9f75844SAndroid Build Coastguard Worker 
32*d9f75844SAndroid Build Coastguard Worker   BufferQueue(const BufferQueue&) = delete;
33*d9f75844SAndroid Build Coastguard Worker   BufferQueue& operator=(const BufferQueue&) = delete;
34*d9f75844SAndroid Build Coastguard Worker 
35*d9f75844SAndroid Build Coastguard Worker   // Return number of queued buffers.
36*d9f75844SAndroid Build Coastguard Worker   size_t size() const;
37*d9f75844SAndroid Build Coastguard Worker 
38*d9f75844SAndroid Build Coastguard Worker   // Clear the BufferQueue by moving all Buffers from `queue_` to `free_list_`.
39*d9f75844SAndroid Build Coastguard Worker   void Clear();
40*d9f75844SAndroid Build Coastguard Worker 
41*d9f75844SAndroid Build Coastguard Worker   // ReadFront will only read one buffer at a time and will truncate buffers
42*d9f75844SAndroid Build Coastguard Worker   // that don't fit in the passed memory.
43*d9f75844SAndroid Build Coastguard Worker   // Returns true unless no data could be returned.
44*d9f75844SAndroid Build Coastguard Worker   bool ReadFront(void* data, size_t bytes, size_t* bytes_read);
45*d9f75844SAndroid Build Coastguard Worker 
46*d9f75844SAndroid Build Coastguard Worker   // WriteBack always writes either the complete memory or nothing.
47*d9f75844SAndroid Build Coastguard Worker   // Returns true unless no data could be written.
48*d9f75844SAndroid Build Coastguard Worker   bool WriteBack(const void* data, size_t bytes, size_t* bytes_written);
49*d9f75844SAndroid Build Coastguard Worker 
is_writable()50*d9f75844SAndroid Build Coastguard Worker   bool is_writable() const {
51*d9f75844SAndroid Build Coastguard Worker     RTC_DCHECK_RUN_ON(&sequence_checker_);
52*d9f75844SAndroid Build Coastguard Worker     return queue_.size() < capacity_;
53*d9f75844SAndroid Build Coastguard Worker   }
54*d9f75844SAndroid Build Coastguard Worker 
is_readable()55*d9f75844SAndroid Build Coastguard Worker   bool is_readable() const {
56*d9f75844SAndroid Build Coastguard Worker     RTC_DCHECK_RUN_ON(&sequence_checker_);
57*d9f75844SAndroid Build Coastguard Worker     return !queue_.empty();
58*d9f75844SAndroid Build Coastguard Worker   }
59*d9f75844SAndroid Build Coastguard Worker 
60*d9f75844SAndroid Build Coastguard Worker  private:
61*d9f75844SAndroid Build Coastguard Worker   RTC_NO_UNIQUE_ADDRESS webrtc::SequenceChecker sequence_checker_;
62*d9f75844SAndroid Build Coastguard Worker   const size_t capacity_;
63*d9f75844SAndroid Build Coastguard Worker   const size_t default_size_;
64*d9f75844SAndroid Build Coastguard Worker   std::deque<Buffer*> queue_ RTC_GUARDED_BY(sequence_checker_);
65*d9f75844SAndroid Build Coastguard Worker   std::vector<Buffer*> free_list_ RTC_GUARDED_BY(sequence_checker_);
66*d9f75844SAndroid Build Coastguard Worker };
67*d9f75844SAndroid Build Coastguard Worker 
68*d9f75844SAndroid Build Coastguard Worker }  // namespace rtc
69*d9f75844SAndroid Build Coastguard Worker 
70*d9f75844SAndroid Build Coastguard Worker #endif  // RTC_BASE_BUFFER_QUEUE_H_
71