1 /*
2  *  Copyright (c) 2015 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 #ifndef MODULES_AUDIO_CODING_CODECS_OPUS_TEST_AUDIO_RING_BUFFER_H_
11 #define MODULES_AUDIO_CODING_CODECS_OPUS_TEST_AUDIO_RING_BUFFER_H_
12 
13 #include <stddef.h>
14 
15 #include <memory>
16 #include <vector>
17 
18 struct RingBuffer;
19 
20 namespace webrtc {
21 
22 // A ring buffer tailored for float deinterleaved audio. Any operation that
23 // cannot be performed as requested will cause a crash (e.g. insufficient data
24 // in the buffer to fulfill a read request.)
25 class AudioRingBuffer final {
26  public:
27   // Specify the number of channels and maximum number of frames the buffer will
28   // contain.
29   AudioRingBuffer(size_t channels, size_t max_frames);
30   ~AudioRingBuffer();
31 
32   // Copies |data| to the buffer and advances the write pointer. |channels| must
33   // be the same as at creation time.
34   void Write(const float* const* data, size_t channels, size_t frames);
35 
36   // Copies from the buffer to |data| and advances the read pointer. |channels|
37   // must be the same as at creation time.
38   void Read(float* const* data, size_t channels, size_t frames);
39 
40   size_t ReadFramesAvailable() const;
41   size_t WriteFramesAvailable() const;
42 
43   // Moves the read position. The forward version advances the read pointer
44   // towards the write pointer and the backward verison withdraws the read
45   // pointer away from the write pointer (i.e. flushing and stuffing the buffer
46   // respectively.)
47   void MoveReadPositionForward(size_t frames);
48   void MoveReadPositionBackward(size_t frames);
49 
50  private:
51   // TODO(kwiberg): Use std::vector<std::unique_ptr<RingBuffer>> instead.
52   std::vector<RingBuffer*> buffers_;
53 };
54 
55 }  // namespace webrtc
56 
57 #endif  // MODULES_AUDIO_CODING_CODECS_OPUS_TEST_AUDIO_RING_BUFFER_H_
58