arduino-audio-tools: BaseBuffer< T > Class Template Reference

arduino-audio-tools

Loading...

Searching...

No Matches

Shared functionality of all buffers. More...

#include <Buffers.h>

Inheritance diagram for BaseBuffer< T >:

Public Member Functions
	BaseBuffer ()=default

	BaseBuffer (const BaseBuffer &)=default

virtual	~BaseBuffer ()=default

virtual T *	address ()=0
	returns the address of the start of the physical read buffer

virtual int	available ()=0
	provides the number of entries that are available to read

virtual int	availableForWrite ()=0
	provides the number of entries that are available to write

virtual int	bufferCountEmpty ()
	Provides the number of entries that are available to write: -1 does not apply.

virtual int	bufferCountFilled ()
	Provides the number of entries that are available to read: -1 does not apply.

void	clear ()
	same as reset

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

virtual void	flush ()

bool	isEmpty ()

virtual bool	isFull ()
	checks if the buffer is full

virtual float	levelPercent ()
	Returns the level of the buffer in %.

BaseBuffer &	operator= (const BaseBuffer &)=default

virtual bool	peek (T &result)=0
	peeks the actual entry from the buffer

virtual bool	read (T &result)=0
	reads a single value

virtual int	readArray (T data[], int len)
	reads multiple values

virtual void	reset ()=0
	clears the buffer

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

virtual size_t	size ()=0

virtual bool	write (T data)=0
	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.

Detailed Description

template<typename T = uint8_t>
class audio_tools::BaseBuffer< T >

Shared functionality of all buffers.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ BaseBuffer() [1/2]

template<typename T = uint8_t>

BaseBuffer ( )

default

◆ ~BaseBuffer()

template<typename T = uint8_t>

virtual ~BaseBuffer ( )

virtualdefault

◆ BaseBuffer() [2/2]

template<typename T = uint8_t>

BaseBuffer ( const BaseBuffer< T > & )

default

Member Function Documentation

◆ address()

template<typename T = uint8_t>

virtual T * address ( )

pure virtual

returns the address of the start of the physical read buffer

Implemented in VariableSpeedRingBufferSimple< T >, VariableSpeedRingBuffer180< T >, VariableSpeedRingBuffer< T >, VariableSpeedRingBuffer< int16_t >, NBuffer< T >, NBuffer< Frame >, NBuffer< T >, NBuffer< uint8_t >, NBufferFile< File, T >, M4AFileSampleSizeBuffer, AdaptiveResamplingBuffer, RedisBuffer< T >, RingBufferSPSC< T >, RingBufferSPSC< uint8_t >, BufferRP2040T< T >, BufferRTOS< T >, BufferRTOS< uint8_t >, SynchronizedBuffer< T >, BufferZephyr< T >, SingleBuffer< T >, SingleBuffer< float >, SingleBuffer< int16_t >, SingleBuffer< int32_t >, SingleBuffer< stsz_sample_size_t >, SingleBuffer< T >, SingleBuffer< uint32_t >, SingleBuffer< uint8_t >, RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< Sample >, RingBuffer< T >, RingBuffer< uint16_t >, RingBuffer< uint8_t >, RingBufferFile< File, T >, and DynamicMultiBuffer< T, BufferType >.

◆ available()

template<typename T = uint8_t>

virtual int available ( )

pure virtual

provides the number of entries that are available to read

Implemented in M4AFileSampleSizeBuffer, VariableSpeedRingBufferSimple< T >, VariableSpeedRingBuffer180< T >, VariableSpeedRingBuffer< T >, VariableSpeedRingBuffer< int16_t >, NBuffer< T >, NBuffer< Frame >, NBuffer< T >, NBuffer< uint8_t >, AdaptiveResamplingBuffer, RedisBuffer< T >, RingBufferSPSC< T >, RingBufferSPSC< uint8_t >, BufferRP2040T< T >, BufferRTOS< T >, BufferRTOS< uint8_t >, SynchronizedBuffer< T >, BufferZephyr< T >, SingleBuffer< T >, SingleBuffer< float >, SingleBuffer< int16_t >, SingleBuffer< int32_t >, SingleBuffer< stsz_sample_size_t >, SingleBuffer< T >, SingleBuffer< uint32_t >, SingleBuffer< uint8_t >, RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< Sample >, RingBuffer< T >, RingBuffer< uint16_t >, RingBuffer< uint8_t >, RingBufferFile< File, T >, NBufferFile< File, T >, and DynamicMultiBuffer< T, BufferType >.

◆ availableForWrite()

template<typename T = uint8_t>

virtual int availableForWrite ( )

pure virtual

provides the number of entries that are available to write

Implemented in VariableSpeedRingBufferSimple< T >, VariableSpeedRingBuffer180< T >, VariableSpeedRingBuffer< T >, VariableSpeedRingBuffer< int16_t >, NBuffer< T >, NBuffer< Frame >, NBuffer< T >, NBuffer< uint8_t >, M4AFileSampleSizeBuffer, AdaptiveResamplingBuffer, RedisBuffer< T >, RingBufferSPSC< T >, RingBufferSPSC< uint8_t >, BufferRP2040T< T >, BufferRTOS< T >, BufferRTOS< uint8_t >, SynchronizedBuffer< T >, BufferZephyr< T >, SingleBuffer< T >, SingleBuffer< float >, SingleBuffer< int16_t >, SingleBuffer< int32_t >, SingleBuffer< stsz_sample_size_t >, SingleBuffer< T >, SingleBuffer< uint32_t >, SingleBuffer< uint8_t >, RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< Sample >, RingBuffer< T >, RingBuffer< uint16_t >, RingBuffer< uint8_t >, RingBufferFile< File, T >, NBufferFile< File, T >, and DynamicMultiBuffer< T, BufferType >.

◆ bufferCountEmpty()

template<typename T = uint8_t>

virtual int bufferCountEmpty ( )

inlinevirtual

Provides the number of entries that are available to write: -1 does not apply.

Reimplemented in SynchronizedNBufferRTOST< T >, SynchronizedNBufferZephyrT< T >, NBuffer< T >, NBuffer< Frame >, NBuffer< T >, and NBuffer< uint8_t >.

◆ bufferCountFilled()

template<typename T = uint8_t>

virtual int bufferCountFilled ( )

inlinevirtual

Provides the number of entries that are available to read: -1 does not apply.

Reimplemented in SynchronizedNBufferRTOST< T >, SynchronizedNBufferZephyrT< T >, NBuffer< T >, NBuffer< Frame >, NBuffer< T >, and NBuffer< uint8_t >.

◆ clear()

template<typename T = uint8_t>

void clear ( )

inline

same as reset

◆ clearArray()

template<typename T = uint8_t>

virtual int clearArray ( int len )

inlinevirtual

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

virtual void flush ( )

inlinevirtual

Submit any partially-filled write buffer so the reader can access it. Only meaningful for NBuffer-style block pools; no-op for ring buffers.

Reimplemented in NBuffer< T >, NBuffer< Frame >, NBuffer< T >, and NBuffer< uint8_t >.

◆ isEmpty()

template<typename T = uint8_t>

bool isEmpty ( )

inline

◆ isFull()

template<typename T = uint8_t>

virtual bool isFull ( )

inlinevirtual

◆ levelPercent()

template<typename T = uint8_t>

virtual float levelPercent ( )

inlinevirtual

Returns the level of the buffer in %.

Reimplemented in AdaptiveResamplingBuffer.

◆ operator=()

template<typename T = uint8_t>

BaseBuffer & operator= ( const BaseBuffer< T > & )

default

◆ peek()

template<typename T = uint8_t>

virtual bool peek ( T & result )

pure virtual

◆ read()

template<typename T = uint8_t>

virtual bool read ( T & result )

pure virtual

◆ readArray()

template<typename T = uint8_t>

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

inlinevirtual

reads multiple values

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

◆ reset()

template<typename T = uint8_t>

virtual void reset ( )

pure virtual

clears the buffer

Implemented in M4AFileSampleSizeBuffer, VariableSpeedRingBufferSimple< T >, VariableSpeedRingBuffer180< T >, VariableSpeedRingBuffer< T >, VariableSpeedRingBuffer< int16_t >, NBuffer< T >, NBuffer< Frame >, NBuffer< T >, NBuffer< uint8_t >, NBufferFile< File, T >, AdaptiveResamplingBuffer, RedisBuffer< T >, RingBufferSPSC< T >, RingBufferSPSC< uint8_t >, BufferRP2040T< T >, BufferRTOS< T >, BufferRTOS< uint8_t >, SynchronizedBuffer< T >, BufferZephyr< T >, SingleBuffer< T >, SingleBuffer< float >, SingleBuffer< int16_t >, SingleBuffer< int32_t >, SingleBuffer< stsz_sample_size_t >, SingleBuffer< T >, SingleBuffer< uint32_t >, SingleBuffer< uint8_t >, RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< Sample >, RingBuffer< T >, RingBuffer< uint16_t >, RingBuffer< uint8_t >, RingBufferFile< File, T >, and DynamicMultiBuffer< T, BufferType >.

◆ resize()

template<typename T = uint8_t>

virtual bool resize ( size_t bytes )

inlinevirtual

◆ size()

template<typename T = uint8_t>

virtual size_t size ( )

pure virtual

Implemented in BufferRP2040T< T >, BufferRTOS< T >, BufferRTOS< uint8_t >, SynchronizedNBufferRTOST< T >, SynchronizedBuffer< T >, SynchronizedNBufferZephyrT< T >, VariableSpeedRingBufferSimple< T >, VariableSpeedRingBuffer180< T >, VariableSpeedRingBuffer< T >, VariableSpeedRingBuffer< int16_t >, NBuffer< T >, NBuffer< Frame >, NBuffer< T >, NBuffer< uint8_t >, M4AFileSampleSizeBuffer, AdaptiveResamplingBuffer, RedisBuffer< T >, RingBufferSPSC< T >, RingBufferSPSC< uint8_t >, BufferZephyr< T >, SingleBuffer< T >, SingleBuffer< float >, SingleBuffer< int16_t >, SingleBuffer< int32_t >, SingleBuffer< stsz_sample_size_t >, SingleBuffer< T >, SingleBuffer< uint32_t >, SingleBuffer< uint8_t >, RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< Sample >, RingBuffer< T >, RingBuffer< uint16_t >, RingBuffer< uint8_t >, RingBufferFile< File, T >, NBufferFile< File, T >, and DynamicMultiBuffer< T, BufferType >.

◆ write()

template<typename T = uint8_t>

virtual bool write ( T data )

pure virtual

◆ writeArray()

template<typename T = uint8_t>

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

inlinevirtual

Fills the buffer data.

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

◆ writeArrayOverwrite()

template<typename T = uint8_t>

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

inlinevirtual

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

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

src/AudioTools/CoreAudio/Buffers.h