arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
BaseBuffer< T > Class Template Referenceabstract
Arduino Audio Tools » Tools » Buffers

Shared functionality of all buffers. More...

#include <Buffers.h>

Inheritance diagram for BaseBuffer< T >:
BufferRTOS< uint8_t > NBuffer< uint8_t > NBuffer< Frame > RingBuffer< uint8_t > RingBuffer< Sample > RingBuffer< uint16_t > RingBuffer< int32_t > RingBuffer< int16_t > SingleBuffer< uint8_t > SingleBuffer< int16_t > VariableSpeedRingBuffer< int16_t > BufferRP2040T< T > BufferRTOS< T > NBuffer< T > RingBuffer< T > RingBufferFile< File, T > SingleBuffer< T > SynchronizedBuffer< T > VariableSpeedRingBuffer< T > VariableSpeedRingBuffer180< T > VariableSpeedRingBufferSimple< T >

Public Member Functions

 BaseBuffer (BaseBuffer const &)=delete
 
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
 
void clear ()
 same as reset
 
virtual int clearArray (int len)
 Removes the next len entries.
 
bool isEmpty ()
 
virtual bool isFull ()=0
 checks if the buffer is full
 
virtual float levelPercent ()
 Returns the level of the buffer in %.
 
virtual T peek ()=0
 peeks the actual entry from the buffer
 
virtual T read ()=0
 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])
 
virtual void reset ()=0
 clears the buffer
 
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.
 

Protected Member Functions

void setWritePos (int pos)
 

Protected Attributes

friend NBuffer< T >
 

Detailed Description

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

Shared functionality of all buffers.

Author
Phil Schatzmann
Copyright
GPLv3

Member Function Documentation

◆ address()

template<typename 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 >, RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< int32_t >, RingBuffer< Sample >, RingBuffer< uint16_t >, RingBuffer< uint8_t >, NBuffer< T >, NBuffer< Frame >, NBuffer< uint8_t >, BufferRP2040T< T >, BufferRTOS< T >, BufferRTOS< uint8_t >, SynchronizedBuffer< T >, SingleBuffer< T >, SingleBuffer< int16_t >, SingleBuffer< uint8_t >, and RingBufferFile< File, T >.

◆ available()

template<typename T >
virtual int available ( )
pure virtual

provides the number of entries that are available to read

Implemented in VariableSpeedRingBufferSimple< T >, VariableSpeedRingBuffer180< T >, VariableSpeedRingBuffer< T >, VariableSpeedRingBuffer< int16_t >, RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< int32_t >, RingBuffer< Sample >, RingBuffer< uint16_t >, RingBuffer< uint8_t >, NBuffer< T >, NBuffer< Frame >, NBuffer< uint8_t >, BufferRP2040T< T >, BufferRTOS< T >, BufferRTOS< uint8_t >, SynchronizedBuffer< T >, SingleBuffer< T >, SingleBuffer< int16_t >, SingleBuffer< uint8_t >, and RingBufferFile< File, T >.

◆ availableForWrite()

template<typename 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 >, RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< int32_t >, RingBuffer< Sample >, RingBuffer< uint16_t >, RingBuffer< uint8_t >, NBuffer< T >, NBuffer< Frame >, NBuffer< uint8_t >, BufferRP2040T< T >, BufferRTOS< T >, BufferRTOS< uint8_t >, SynchronizedBuffer< T >, SingleBuffer< T >, SingleBuffer< int16_t >, SingleBuffer< uint8_t >, and RingBufferFile< File, T >.

◆ clearArray()

template<typename T >
virtual int clearArray ( int  len)
inlinevirtual

Removes the next len entries.

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

◆ isFull()

template<typename T >
virtual bool isFull ( )
pure virtual

checks if the buffer is full

Implemented in VariableSpeedRingBufferSimple< T >, VariableSpeedRingBuffer180< T >, VariableSpeedRingBuffer< T >, VariableSpeedRingBuffer< int16_t >, RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< int32_t >, RingBuffer< Sample >, RingBuffer< uint16_t >, RingBuffer< uint8_t >, NBuffer< T >, NBuffer< Frame >, NBuffer< uint8_t >, BufferRP2040T< T >, BufferRTOS< T >, BufferRTOS< uint8_t >, SynchronizedBuffer< T >, SingleBuffer< T >, SingleBuffer< int16_t >, SingleBuffer< uint8_t >, and RingBufferFile< File, T >.

◆ peek()

template<typename T >
virtual T peek ( )
pure virtual

peeks the actual entry from the buffer

Implemented in BufferRP2040T< T >, VariableSpeedRingBufferSimple< T >, VariableSpeedRingBuffer180< T >, VariableSpeedRingBuffer< T >, VariableSpeedRingBuffer< int16_t >, RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< int32_t >, RingBuffer< Sample >, RingBuffer< uint16_t >, RingBuffer< uint8_t >, NBuffer< T >, NBuffer< Frame >, NBuffer< uint8_t >, BufferRTOS< T >, BufferRTOS< uint8_t >, SynchronizedBuffer< T >, SingleBuffer< T >, SingleBuffer< int16_t >, SingleBuffer< uint8_t >, and RingBufferFile< File, T >.

◆ read()

template<typename T >
virtual T read ( )
pure virtual

reads a single value

Implemented in BufferRP2040T< T >, VariableSpeedRingBufferSimple< T >, VariableSpeedRingBuffer180< T >, VariableSpeedRingBuffer< T >, VariableSpeedRingBuffer< int16_t >, RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< int32_t >, RingBuffer< Sample >, RingBuffer< uint16_t >, RingBuffer< uint8_t >, NBuffer< T >, NBuffer< Frame >, NBuffer< uint8_t >, BufferRTOS< T >, BufferRTOS< uint8_t >, SynchronizedBuffer< T >, SingleBuffer< T >, SingleBuffer< int16_t >, SingleBuffer< uint8_t >, and RingBufferFile< File, T >.

◆ readArray()

template<typename T >
virtual int readArray ( T  data[],
int  len 
)
inlinevirtual

reads multiple values

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

◆ reset()

template<typename T >
virtual void reset ( )
pure virtual

clears the buffer

Implemented in VariableSpeedRingBufferSimple< T >, VariableSpeedRingBuffer180< T >, VariableSpeedRingBuffer< T >, VariableSpeedRingBuffer< int16_t >, RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< int32_t >, RingBuffer< Sample >, RingBuffer< uint16_t >, RingBuffer< uint8_t >, NBuffer< T >, NBuffer< Frame >, NBuffer< uint8_t >, BufferRP2040T< T >, BufferRTOS< T >, BufferRTOS< uint8_t >, SynchronizedBuffer< T >, SingleBuffer< T >, SingleBuffer< int16_t >, SingleBuffer< uint8_t >, and RingBufferFile< File, T >.

◆ size()

template<typename T >
virtual size_t size ( )
pure virtual

Implemented in RingBuffer< T >, RingBuffer< int16_t >, RingBuffer< int32_t >, RingBuffer< Sample >, RingBuffer< uint16_t >, and RingBuffer< uint8_t >.

◆ write()

template<typename T >
virtual bool write ( T  data)
pure virtual

write add an entry to the buffer

Implemented in RingBuffer< T >, NBuffer< T >, BufferRP2040T< T >, BufferRTOS< T >, SynchronizedBuffer< T >, RingBufferFile< File, T >, VariableSpeedRingBufferSimple< T >, VariableSpeedRingBuffer180< T >, VariableSpeedRingBuffer< T >, and SingleBuffer< T >.

◆ writeArray()

template<typename T >
virtual int writeArray ( const T  data[],
int  len 
)
inlinevirtual

Fills the buffer data.

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

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8