RingBuffer< T > Class Template Reference

Implements a typed Ringbuffer. More...

#include <Buffers.h>

Inheritance diagram for RingBuffer< T >:

Public Member Functions
	RingBuffer (int size, Allocator &allocator=DefaultAllocator)
virtual T *	address () override
	returns the address of the start of the physical read buffer
virtual int	available () override
	provides the number of entries that are available to read
virtual int	availableForWrite () override
	provides the number of entries that are available to write
void	clear ()
	same as reset
virtual int	clearArray (int len)
	Removes the next len entries.
bool	isEmpty ()
virtual bool	isFull () override
	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
virtual int	peekArray (T *data, int n)
bool	read (T &result) override
	reads a single value
virtual int	readArray (T data[], int len)
	reads multiple values
virtual void	reset () override
	clears the buffer
virtual bool	resize (int len)
	Resizes the buffer if supported: returns false if not supported.
virtual size_t	size () override
	Returns the maximum capacity of the buffer.
virtual bool	write (T data) 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
int	nextIndex (int index)

Protected Attributes
Allocator &	_allocator
Vector< T >	_aucBuffer {_allocator}
int	_iHead
int	_iTail
int	_numElems
int	max_size = 0

Detailed Description

template<typename T = int16_t>
class audio_tools::RingBuffer< T >

Implements a typed Ringbuffer.

Template Parameters

T

Member Function Documentation

address()

template<typename T = int16_t>

virtual T * address ( )

inlineoverridevirtual

returns the address of the start of the physical read buffer

Implements BaseBuffer< T >.

available()

template<typename T = int16_t>

virtual int available ( )

inlineoverridevirtual

provides the number of entries that are available to read

Implements BaseBuffer< T >.

availableForWrite()

template<typename T = int16_t>

virtual int availableForWrite ( )

inlineoverridevirtual

provides the number of entries that are available to write

Implements BaseBuffer< T >.

clearArray()

template<typename T = int16_t>

virtual int clearArray ( int  len )

inlinevirtualinherited

Removes the next len entries.

Reimplemented in SingleBuffer< T >, SingleBuffer< float >, SingleBuffer< int16_t >, SingleBuffer< int32_t >, SingleBuffer< stsz_sample_size_t >, SingleBuffer< T >, SingleBuffer< uint32_t >, and SingleBuffer< uint8_t >.

isFull()

template<typename T = int16_t>

virtual bool isFull ( )

inlineoverridevirtual

checks if the buffer is full

Reimplemented from BaseBuffer< T >.

peek()

template<typename T = int16_t>

bool peek ( T &  result )

inlineoverridevirtual

peeks the actual entry from the buffer

Implements BaseBuffer< T >.

read()

template<typename T = int16_t>

bool read ( T &  result )

inlineoverridevirtual

reads a single value

Implements BaseBuffer< T >.

readArray()

template<typename T = int16_t>

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

inlinevirtualinherited

reads multiple values

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

reset()

template<typename T = int16_t>

virtual void reset ( )

inlineoverridevirtual

clears the buffer

Implements BaseBuffer< T >.

resize()

template<typename T = int16_t>

virtual bool resize ( int  bytes )

inlinevirtual

Resizes the buffer if supported: returns false if not supported.

Reimplemented from BaseBuffer< T >.

size()

template<typename T = int16_t>

virtual size_t size ( )

inlineoverridevirtual

Returns the maximum capacity of the buffer.

Implements BaseBuffer< T >.

write()

template<typename T = int16_t>

virtual bool write ( T  data )

inlineoverridevirtual

write add an entry to the buffer

Implements BaseBuffer< T >.

writeArray()

template<typename T = int16_t>

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

inlinevirtualinherited

Fills the buffer data.

Reimplemented in BufferRTOS< T >, SynchronizedBuffer< T >, RedisBuffer< T >, BufferRP2040T< T >, SingleBuffer< T >, SingleBuffer< T >, RingBufferFile< File, T >, NBufferFile< File, T >, and DynamicMultiBuffer< T, BufferType >.

---

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

• src/AudioTools/CoreAudio/Buffers.h