ury-playd/doxygen/ringbuffer_8hpp_source.html

 // This file is part of playd.
 // playd is licensed under the MIT licence: see LICENSE.txt.

 #ifndef PLAYD_RINGBUFFER_HPP
 #define PLAYD_RINGBUFFER_HPP

 extern "C" {
 #include "../contrib/pa_ringbuffer/pa_ringbuffer.h"
 }

 class RingBuffer
 {
 public:
     RingBuffer(int power, int size);

     ~RingBuffer();

     RingBuffer(const RingBuffer &) = delete;

     RingBuffer &operator=(const RingBuffer &) = delete;

     size_t WriteCapacity() const;

     size_t ReadCapacity() const;

     unsigned long Write(const char *start, unsigned long count);

     unsigned long Read(char *start, unsigned long count);

     void Flush();

 private:
     char *buffer;
     PaUtilRingBuffer *rb;

     static unsigned long CountCast(ring_buffer_size_t count);
 };

 #endif // PLAYD_RINGBUFFER_HPP
RingBuffer::RingBuffer
RingBuffer(int power, int size)
Constructs a RingBuffer.
Definition: ringbuffer.cpp:19

RingBuffer::buffer
char * buffer
The array used by the ringbuffer.
Definition: ringbuffer.hpp:111

RingBuffer::~RingBuffer
~RingBuffer()
Destructs a PaRingBuffer.
Definition: ringbuffer.cpp:37

RingBuffer::rb
PaUtilRingBuffer * rb
The internal PortAudio ringbuffer.
Definition: ringbuffer.hpp:112

RingBuffer::operator=
RingBuffer & operator=(const RingBuffer &)=delete
Deleted copy-assignment.

RingBuffer::Read
unsigned long Read(char *start, unsigned long count)
Reads samples from the ring buffer into an array.
Definition: ringbuffer.cpp:65

RingBuffer::WriteCapacity
size_t WriteCapacity() const
The current write capacity.
Definition: ringbuffer.cpp:46

RingBuffer::ReadCapacity
size_t ReadCapacity() const
The current read capacity.
Definition: ringbuffer.cpp:51

RingBuffer::Write
unsigned long Write(const char *start, unsigned long count)
Writes samples from an array into the ring buffer.
Definition: ringbuffer.cpp:56

RingBuffer
A ring buffer.
Definition: ringbuffer.hpp:24

RingBuffer::Flush
void Flush()
Empties the ring buffer.
Definition: ringbuffer.cpp:74

RingBuffer::CountCast
static unsigned long CountCast(ring_buffer_size_t count)
Converts a ring buffer size into an external size.
Definition: ringbuffer.cpp:80