Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SingleBuffer< T > Class Template Reference

A simple Buffer implementation which just uses a (dynamically sized) array. More...

#include <Buffers.h>

Inheritance diagram for SingleBuffer< T >:
BaseBuffer< T >

Public Member Functions

 SingleBuffer ()
 Construct a new Single Buffer w/o allocating any memory.
 SingleBuffer (int size)
 Construct a new Single Buffer object. More...
T * address () override
 Provides address to beginning of the buffer.
int available () override
 provides the number of entries that are available to read
int availableForWrite () override
 provides the number of entries that are available to write
void clear ()
 same as reset
int clearArray (int len) override
 consumes len bytes and moves current data to the beginning
T * data ()
 Provides address of actual data.
bool isEmpty ()
bool isFull () override
 checks if the buffer is full
void onExternalBufferRefilled (void *data, int len)
 notifies that the external buffer has been refilled
peek () override
 peeks the actual entry from the buffer
read () override
 reads a single value
virtual int readArray (T data[], int len)
 reads multiple values
int readFrames (T data[][2], int len)
 reads multiple values for array of 2 dimensional frames
template<int rows, int channels>
int readFrames (T(&data)[rows][channels])
void reset () override
 clears the buffer
void resize (int size)
size_t setAvailable (size_t available_size)
void setClearWithZero (bool flag)
 Sets the buffer to 0 on clear.
size_t size ()
bool write (T sample) override
 write add an entry to the buffer
virtual int writeArray (const T data[], int len)
 Fills the buffer data.
virtual int writeArrayOverwrite (const T data[], int len)
 Fills the buffer data and overwrites the oldest data if the buffer is full.

Protected Member Functions

void setWritePos (int pos)

Protected Attributes

Vector< T > buffer {0}
int current_read_pos = 0
int current_write_pos = 0
bool is_clear_with_zero = false
int max_size = 0
friend NBuffer< T >
bool owns_buffer = true

Detailed Description

template<typename T>
class audio_tools::SingleBuffer< T >

A simple Buffer implementation which just uses a (dynamically sized) array.

Phil Schatzmann

Constructor & Destructor Documentation

◆ SingleBuffer()

SingleBuffer ( int  size)

Construct a new Single Buffer object.


Member Function Documentation

◆ setAvailable()

size_t setAvailable ( size_t  available_size)

If we load values directly into the address we need to set the avialeble size

The documentation for this class was generated from the following file: