A NBufferExt is a subclass of NBuffer which allows to use a direct access API to the BaseBuffer. More...

#include <Buffers.h>

Inheritance diagram for NBufferExt< T >:

Public Member Functions
	NBufferExt (int size, int count)

T *	address ()
	returns the address of the start of the phsical read buffer

int	available ()
	determines the available entries for the current read buffer

int	availableForWrite ()
	determines the available entries for the write buffer

virtual int	bufferCountEmpty ()
	Provides the number of entries that are available to write.

virtual int	bufferCountFilled ()
	Provides the number of entries that are available to read.

void	clear ()
	same as reset

virtual int	clearArray (int len)
	Removes the next len entries.

void	flush ()

SingleBuffer< T > *	getBuffer (int id)
	Provides the buffer with the indicated id.

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 an entry from the buffer

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

SingleBuffer< T > *	readEnd ()

void	reset ()
	resets all buffers

virtual bool	resize (size_t bytes)
	Resizes the buffer if supported: returns false if not supported.

virtual bool	resize (size_t size, int count)
	Resize the buffers by defining a new buffer size and buffer count.

unsigned long	sampleRate ()
	provides the actual sample rate

size_t	size ()
	Provides the total capacity (=buffer size * buffer count)

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.

SingleBuffer< 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 ()

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 = 1024

QueueFromVector< BaseBuffer< T > * >	filled_buffers {0, nullptr}

unsigned long	sample_count = 0

unsigned long	start_time = 0

Detailed Description

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

A NBufferExt is a subclass of NBuffer which allows to use a direct access API to the BaseBuffer.

Template Parameters

T	buffered data type

Constructor & Destructor Documentation

◆ NBufferExt()

template<typename T = int16_t>

NBufferExt	(	int	size,
		int	count
	)

inline

Member Function Documentation

◆ addAvailableBuffer()

template<typename T = int16_t>

virtual bool addAvailableBuffer ( BaseBuffer< T > * buffer )

inlineprotectedvirtualinherited

Reimplemented in SynchronizedNBufferZephyrT< T >, and SynchronizedNBufferRTOST< T >.

◆ addFilledBuffer()

template<typename T = int16_t>

virtual bool addFilledBuffer ( BaseBuffer< T > * buffer )

inlineprotectedvirtualinherited

Reimplemented in SynchronizedNBufferZephyrT< T >, and SynchronizedNBufferRTOST< T >.

◆ address()

template<typename T = int16_t>

T * address ( )

inlinevirtualinherited

returns the address of the start of the phsical read buffer

Implements BaseBuffer< T >.

◆ available()

template<typename T = int16_t>

int available ( )

inlinevirtualinherited

determines the available entries for the current read buffer

Implements BaseBuffer< T >.

◆ availableForWrite()

template<typename T = int16_t>

int availableForWrite ( )

inlinevirtualinherited

determines the available entries for the write buffer

Implements BaseBuffer< T >.

◆ bufferCountEmpty()

template<typename T = int16_t>

virtual int bufferCountEmpty ( )

inlinevirtualinherited

Provides the number of entries that are available to write.

Reimplemented from BaseBuffer< T >.

Reimplemented in SynchronizedNBufferRTOST< T >, and SynchronizedNBufferZephyrT< T >.

◆ bufferCountFilled()

template<typename T = int16_t>

virtual int bufferCountFilled ( )

inlinevirtualinherited

Provides the number of entries that are available to read.

Reimplemented from BaseBuffer< T >.

Reimplemented in SynchronizedNBufferRTOST< T >, and SynchronizedNBufferZephyrT< T >.

◆ clear()

template<typename T = int16_t>

void clear ( )

inlineinherited

same as reset

◆ 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 >.

◆ flush()

template<typename T = int16_t>

void flush ( )

inlinevirtualinherited

Submit the partially-filled write buffer to the filled queue so the reader can access it immediately. Call after writeArray() when the writer won't add more data to the current block for a while.

Reimplemented from BaseBuffer< T >.

◆ freeMemory()

template<typename T = int16_t>

void freeMemory ( )

inlineprotectedinherited

◆ getBuffer()

template<typename T = int16_t>

SingleBuffer< T > * getBuffer ( int id )

inline

Provides the buffer with the indicated id.

◆ getNextAvailableBuffer()

template<typename T = int16_t>

virtual BaseBuffer< T > * getNextAvailableBuffer ( )

inlineprotectedvirtualinherited

Reimplemented in SynchronizedNBufferZephyrT< T >, and SynchronizedNBufferRTOST< T >.

◆ getNextFilledBuffer()

template<typename T = int16_t>

virtual BaseBuffer< T > * getNextFilledBuffer ( )

inlineprotectedvirtualinherited

Reimplemented in SynchronizedNBufferZephyrT< T >, and SynchronizedNBufferRTOST< T >.

◆ isEmpty()

template<typename T = int16_t>

bool isEmpty ( )

inlineinherited

◆ isFull()

template<typename T = int16_t>

bool isFull ( )

inlinevirtualinherited

checks if the buffer is full

Reimplemented from BaseBuffer< T >.

◆ levelPercent()

template<typename T = int16_t>

virtual float levelPercent ( )

inlinevirtualinherited

Returns the level of the buffer in %.

◆ peek()

template<typename T = int16_t>

bool peek ( T & result )

inlineoverridevirtualinherited

peeks the actual entry from the buffer

Implements BaseBuffer< T >.

◆ read()

template<typename T = int16_t>

bool read ( T & result )

inlineoverridevirtualinherited

reads an entry from the buffer

Implements BaseBuffer< T >.

◆ readArray()

template<typename T = int16_t>

int readArray	(	T	data[],
		int	len
	)

inlineoverridevirtualinherited

Reads up to len entries, spanning across multiple blocks. BaseBuffer::readArray stops at the first block boundary because it calls available() once. This override keeps reading across blocks.

Reimplemented from BaseBuffer< T >.

◆ readEnd()

template<typename T = int16_t>

SingleBuffer< T > * readEnd ( )

inline

Alternative interface using address: provides access to the next read buffer

◆ reset()

template<typename T = int16_t>

void reset ( )

inlinevirtualinherited

resets all buffers

Implements BaseBuffer< T >.

◆ resetCurrent()

template<typename T = int16_t>

void resetCurrent ( )

inlineprotectedinherited

◆ resize() [1/2]

template<typename T = int16_t>

virtual bool resize ( size_t bytes )

inlinevirtualinherited

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

Reimplemented from BaseBuffer< T >.

◆ resize() [2/2]

template<typename T = int16_t>

virtual bool resize	(	size_t	size,
		int	count
	)

inlinevirtualinherited

Resize the buffers by defining a new buffer size and buffer count.

Reimplemented in SynchronizedNBufferRTOST< T >, and SynchronizedNBufferZephyrT< T >.

◆ sampleRate()

template<typename T = int16_t>

unsigned long sampleRate ( )

inlineinherited

provides the actual sample rate

◆ size()

template<typename T = int16_t>

size_t size ( )

inlinevirtualinherited

Provides the total capacity (=buffer size * buffer count)

Implements BaseBuffer< T >.

Reimplemented in SynchronizedNBufferRTOST< T >, and SynchronizedNBufferZephyrT< T >.

◆ write()

template<typename T = int16_t>

bool write ( T data )

inlinevirtualinherited

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 >, BufferZephyr< T >, SingleBuffer< T >, SingleBuffer< T >, RingBufferFile< File, T >, NBufferFile< File, T >, and DynamicMultiBuffer< T, BufferType >.

◆ writeArrayOverwrite()

template<typename T = int16_t>

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

inlinevirtualinherited

Fills the buffer data and overwrites the oldest data if the buffer is full.

◆ writeEnd()

template<typename T = int16_t>

SingleBuffer< T > * writeEnd ( )

inline

Alternative interface: Provides access to the next write buffer

Member Data Documentation

◆ actual_read_buffer

template<typename T = int16_t>

BaseBuffer<T>* actual_read_buffer = nullptr

protectedinherited

◆ actual_write_buffer

template<typename T = int16_t>

BaseBuffer<T>* actual_write_buffer = nullptr

protectedinherited

◆ available_buffers

template<typename T = int16_t>

QueueFromVector<BaseBuffer<T> *> available_buffers {0, nullptr}

protectedinherited

◆ buffer_count

template<typename T = int16_t>

uint16_t buffer_count = 0

protectedinherited

◆ buffer_size

template<typename T = int16_t>

int buffer_size = 1024

protectedinherited

◆ filled_buffers

template<typename T = int16_t>

QueueFromVector<BaseBuffer<T> *> filled_buffers {0, nullptr}

protectedinherited

◆ sample_count

template<typename T = int16_t>

unsigned long sample_count = 0

protectedinherited

◆ start_time

template<typename T = int16_t>

unsigned long start_time = 0

protectedinherited

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

src/AudioTools/CoreAudio/Buffers.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NBufferExt()

Member Function Documentation

◆ addAvailableBuffer()

◆ addFilledBuffer()

◆ address()

◆ available()

◆ availableForWrite()

◆ bufferCountEmpty()

◆ bufferCountFilled()

◆ clear()

◆ clearArray()

◆ flush()

◆ freeMemory()

◆ getBuffer()

◆ getNextAvailableBuffer()

◆ getNextFilledBuffer()

◆ isEmpty()

◆ isFull()

◆ levelPercent()

◆ peek()

◆ read()

◆ readArray()

◆ readEnd()

◆ reset()

◆ resetCurrent()

◆ resize() [1/2]

◆ resize() [2/2]

◆ sampleRate()

◆ size()

◆ write()

◆ writeArray()

◆ writeArrayOverwrite()

◆ writeEnd()

Member Data Documentation

◆ actual_read_buffer

◆ actual_write_buffer

◆ available_buffers

◆ buffer_count

◆ buffer_size

◆ filled_buffers

◆ sample_count

◆ start_time