NBuffer< T > Class Template Reference

A lock free N buffer. If count=2 we create a DoubleBuffer, if count=3 a TripleBuffer etc. More...

#include <Buffers.h>

Inheritance diagram for NBuffer< T >:

Public Member Functions
	NBuffer (int size, int count)
T *	address ()
	returns the address of the start of the physical read buffer
int	available ()
	provides the number of entries that are available to read
int	availableForWrite ()
	provides the number of entries that are available to write
virtual int	bufferCountEmpty ()
virtual int	bufferCountFilled ()
void	clear ()
	same as reset
virtual int	clearArray (int len)
	Removes the next len entries.
bool	isEmpty ()
bool	isFull ()
	checks if the buffer is full
virtual float	levelPercent ()
	Returns the level of the buffer in %.
bool	peek (T &result) override
	peeks the actual entry from the buffer
bool	read (T &result) override
	reads a single value
virtual int	readArray (T data[], int len)
	reads multiple values
BaseBuffer< T > &	readEnd ()
void	reset ()
	clears the buffer
virtual void	resize (int size, int count)
unsigned long	sampleRate ()
size_t	size ()
bool	write (T data)
	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.
BaseBuffer< T > &	writeEnd ()

Protected Member Functions
virtual bool	addAvailableBuffer (BaseBuffer< T > *buffer)
virtual bool	addFilledBuffer (BaseBuffer< T > *buffer)
void	freeMemory ()
virtual BaseBuffer< T > *	getNextAvailableBuffer ()
virtual BaseBuffer< T > *	getNextFilledBuffer ()
void	resetCurrent ()
void	setWritePos (int pos)

Protected Attributes
BaseBuffer< T > *	actual_read_buffer = nullptr
BaseBuffer< T > *	actual_write_buffer = nullptr
QueueFromVector< BaseBuffer< T > * >	available_buffers {0, nullptr}
uint16_t	buffer_count = 0
int	buffer_size = 0
QueueFromVector< BaseBuffer< T > * >	filled_buffers {0, nullptr}
friend	NBuffer< T >
unsigned long	sample_count = 0
unsigned long	start_time = 0

Detailed Description

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

A lock free N buffer. If count=2 we create a DoubleBuffer, if count=3 a TripleBuffer etc.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

address()

template<typename T >

T * address ( )

inlinevirtual

returns the address of the start of the physical read buffer

Implements BaseBuffer< T >.

available()

template<typename T >

int available ( )

inlinevirtual

provides the number of entries that are available to read

Implements BaseBuffer< T >.

availableForWrite()

template<typename T >

int availableForWrite ( )

inlinevirtual

provides the number of entries that are available to write

Implements BaseBuffer< T >.

clearArray()

template<typename T >

virtual int clearArray ( int  len )

inlinevirtualinherited

Removes the next len entries.

Reimplemented in SingleBuffer< T >, SingleBuffer< int16_t >, and SingleBuffer< uint8_t >.

isFull()

template<typename T >

bool isFull ( )

inlinevirtual

checks if the buffer is full

Reimplemented from BaseBuffer< T >.

peek()

template<typename T >

bool peek ( T &  result )

inlineoverridevirtual

peeks the actual entry from the buffer

Implements BaseBuffer< T >.

read()

template<typename T >

bool read ( T &  result )

inlineoverridevirtual

reads a single value

Implements BaseBuffer< T >.

readArray()

template<typename T >

virtual int readArray ( T  data[], int  len  )

inlinevirtualinherited

reads multiple values

Reimplemented in RingBufferFile< File, T >, BufferRTOS< T >, SynchronizedBuffer< T >, BufferRP2040T< T >, and NBufferFile< File, T >.

reset()

template<typename T >

void reset ( )

inlinevirtual

clears the buffer

Implements BaseBuffer< T >.

size()

template<typename T >

size_t size ( )

inlinevirtual

Implements BaseBuffer< T >.

write()

template<typename T >

bool write ( T  data )

inlinevirtual

write add an entry to the buffer

Implements BaseBuffer< T >.

writeArray()

template<typename T >

virtual int writeArray ( const T  data[], int  len  )

inlinevirtualinherited

Fills the buffer data.

Reimplemented in BufferRTOS< T >, SynchronizedBuffer< T >, BufferRP2040T< T >, RingBufferFile< File, T >, and NBufferFile< File, T >.

---

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

• src/AudioTools/CoreAudio/Buffers.h