OpenWareLaboratory
Public Member Functions | Static Public Member Functions | Protected Attributes
CircularBuffer< DataType, IndexType > Class Template Reference
Inheritance diagram for CircularBuffer< DataType, IndexType >:
Inheritance graph
[legend]

Public Member Functions

 CircularBuffer ()
 
 CircularBuffer (DataType *data, IndexType size)
 
void clear ()
 
void delay (DataType *in, DataType *out, IndexType len, int delay_samples)
 Write to buffer and read with a delay. More...
 
IndexType getContiguousReadCapacity () const
 
IndexType getContiguousWriteCapacity () const
 
DataType * getData ()
 
IndexType getDelay () const
 Get the read index expressed as delay behind the write index. More...
 
IndexType getReadCapacity () const
 
DataType * getReadHead ()
 
IndexType getReadIndex ()
 
IndexType getSize () const
 
IndexType getWriteCapacity () const
 
DataType * getWriteHead ()
 
IndexType getWriteIndex ()
 
bool isEmpty () const
 
bool isFull () const
 
void moveReadHead (int32_t samples)
 
void moveWriteHead (int32_t samples)
 
void overdub (DataType c)
 
void overdubAt (IndexType index, DataType value)
 
DataType read ()
 
void read (DataType *dst, IndexType len)
 
DataType readAt (IndexType index)
 
void reset ()
 
void setAll (const DataType value)
 
void setData (DataType *data, IndexType len)
 
void setDelay (int samples)
 Set the read index. More...
 
void setReadIndex (IndexType pos)
 
void setWriteIndex (IndexType pos)
 
void skipUntilLast (char c)
 
void write (DataType *source, IndexType len)
 
void write (DataType c)
 
void writeAt (IndexType index, DataType value)
 

Static Public Member Functions

static CircularBuffer< DataType > * create (IndexType len)
 
static void destroy (CircularBuffer< DataType > *obj)
 

Protected Attributes

DataType * data
 
bool empty = true
 
IndexType readpos = 0
 
IndexType size
 
IndexType writepos = 0
 

Detailed Description

template<typename DataType, typename IndexType = size_t>
class CircularBuffer< DataType, IndexType >

Definition at line 12 of file CircularBuffer.h.

Constructor & Destructor Documentation

◆ CircularBuffer() [1/2]

template<typename DataType , typename IndexType = size_t>
CircularBuffer< DataType, IndexType >::CircularBuffer ( )
inline

Definition at line 20 of file CircularBuffer.h.

◆ CircularBuffer() [2/2]

template<typename DataType , typename IndexType = size_t>
CircularBuffer< DataType, IndexType >::CircularBuffer ( DataType *  data,
IndexType  size 
)
inline

Definition at line 21 of file CircularBuffer.h.

Member Function Documentation

◆ clear()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::clear ( )
inline

Definition at line 220 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::setAll().

Referenced by DelayProcessor::clear(), CrossFadingDelayProcessor::clear(), CircularBuffer< DataType, IndexType >::create(), InterpolatingCircularFloatBuffer< im >::create(), and CrossFadingCircularBuffer< T >::create().

◆ create()

template<typename DataType , typename IndexType = size_t>
static CircularBuffer<DataType>* CircularBuffer< DataType, IndexType >::create ( IndexType  len)
inlinestatic

Definition at line 224 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::clear().

◆ delay()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::delay ( DataType *  in,
DataType *  out,
IndexType  len,
int  delay_samples 
)
inline

Write to buffer and read with a delay.

Definition at line 182 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::read(), CircularBuffer< DataType, IndexType >::setDelay(), and CircularBuffer< DataType, IndexType >::write().

Referenced by DelayProcessor::process().

◆ destroy()

template<typename DataType , typename IndexType = size_t>
static void CircularBuffer< DataType, IndexType >::destroy ( CircularBuffer< DataType > *  obj)
inlinestatic

Definition at line 230 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data.

◆ getContiguousReadCapacity()

template<typename DataType , typename IndexType = size_t>
IndexType CircularBuffer< DataType, IndexType >::getContiguousReadCapacity ( ) const
inline

Definition at line 203 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::readpos, CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

◆ getContiguousWriteCapacity()

template<typename DataType , typename IndexType = size_t>
IndexType CircularBuffer< DataType, IndexType >::getContiguousWriteCapacity ( ) const
inline

Definition at line 196 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::readpos, CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

◆ getData()

template<typename DataType , typename IndexType = size_t>
DataType* CircularBuffer< DataType, IndexType >::getData ( )
inline

Definition at line 32 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data.

Referenced by DelayProcessor::destroy(), and InterpolatingWavetableOscillator< im >::getWavetable().

◆ getDelay()

template<typename DataType , typename IndexType = size_t>
IndexType CircularBuffer< DataType, IndexType >::getDelay ( ) const
inline

Get the read index expressed as delay behind the write index.

Definition at line 175 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::readpos, CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

◆ getReadCapacity()

template<typename DataType , typename IndexType = size_t>
IndexType CircularBuffer< DataType, IndexType >::getReadCapacity ( ) const
inline

Definition at line 188 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::getWriteCapacity(), and CircularBuffer< DataType, IndexType >::size.

Referenced by CircularBuffer< DataType, IndexType >::moveReadHead(), and CircularBuffer< DataType, IndexType >::read().

◆ getReadHead()

template<typename DataType , typename IndexType = size_t>
DataType* CircularBuffer< DataType, IndexType >::getReadHead ( )
inline

Definition at line 155 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, and CircularBuffer< DataType, IndexType >::readpos.

Referenced by CircularBuffer< DataType, IndexType >::read(), and CircularBuffer< DataType, IndexType >::skipUntilLast().

◆ getReadIndex()

template<typename DataType , typename IndexType = size_t>
IndexType CircularBuffer< DataType, IndexType >::getReadIndex ( )
inline

Definition at line 147 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::readpos.

◆ getSize()

template<typename DataType , typename IndexType = size_t>
IndexType CircularBuffer< DataType, IndexType >::getSize ( ) const
inline

Definition at line 28 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::size.

Referenced by InterpolatingWavetableOscillator< im >::getSample(), and InterpolatingWavetableOscillator< im >::getWavetable().

◆ getWriteCapacity()

template<typename DataType , typename IndexType = size_t>
IndexType CircularBuffer< DataType, IndexType >::getWriteCapacity ( ) const
inline

Definition at line 192 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::empty, CircularBuffer< DataType, IndexType >::readpos, CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

Referenced by CircularBuffer< DataType, IndexType >::getReadCapacity(), CircularBuffer< DataType, IndexType >::moveWriteHead(), and CircularBuffer< DataType, IndexType >::write().

◆ getWriteHead()

template<typename DataType , typename IndexType = size_t>
DataType* CircularBuffer< DataType, IndexType >::getWriteHead ( )
inline

Definition at line 137 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, and CircularBuffer< DataType, IndexType >::writepos.

Referenced by CircularBuffer< DataType, IndexType >::write().

◆ getWriteIndex()

template<typename DataType , typename IndexType = size_t>
IndexType CircularBuffer< DataType, IndexType >::getWriteIndex ( )
inline

Definition at line 129 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::writepos.

◆ isEmpty()

template<typename DataType , typename IndexType = size_t>
bool CircularBuffer< DataType, IndexType >::isEmpty ( ) const
inline

Definition at line 36 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::empty.

◆ isFull()

template<typename DataType , typename IndexType = size_t>
bool CircularBuffer< DataType, IndexType >::isFull ( ) const
inline

Definition at line 40 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::empty, CircularBuffer< DataType, IndexType >::readpos, and CircularBuffer< DataType, IndexType >::writepos.

◆ moveReadHead()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::moveReadHead ( int32_t  samples)
inline

Definition at line 159 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::empty, FLOW_ASSERT, CircularBuffer< DataType, IndexType >::getReadCapacity(), CircularBuffer< DataType, IndexType >::readpos, CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

◆ moveWriteHead()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::moveWriteHead ( int32_t  samples)
inline

Definition at line 141 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::empty, FLOW_ASSERT, CircularBuffer< DataType, IndexType >::getWriteCapacity(), CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

◆ overdub()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::overdub ( DataType  c)
inline

Definition at line 71 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, CircularBuffer< DataType, IndexType >::empty, CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

◆ overdubAt()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::overdubAt ( IndexType  index,
DataType  value 
)
inline

Definition at line 78 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, and CircularBuffer< DataType, IndexType >::size.

◆ read() [1/2]

template<typename DataType , typename IndexType = size_t>
DataType CircularBuffer< DataType, IndexType >::read ( )
inline

Definition at line 82 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, CircularBuffer< DataType, IndexType >::empty, FLOW_ASSERT, CircularBuffer< DataType, IndexType >::getReadCapacity(), CircularBuffer< DataType, IndexType >::readpos, CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

Referenced by CircularBuffer< DataType, IndexType >::delay(), CrossFadingCircularBuffer< T >::delay(), and DelayProcessor::process().

◆ read() [2/2]

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::read ( DataType *  dst,
IndexType  len 
)
inline

Definition at line 91 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, CircularBuffer< DataType, IndexType >::empty, FLOW_ASSERT, CircularBuffer< DataType, IndexType >::getReadCapacity(), CircularBuffer< DataType, IndexType >::getReadHead(), CircularBuffer< DataType, IndexType >::readpos, CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

◆ readAt()

template<typename DataType , typename IndexType = size_t>
DataType CircularBuffer< DataType, IndexType >::readAt ( IndexType  index)
inline

Definition at line 106 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, and CircularBuffer< DataType, IndexType >::size.

◆ reset()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::reset ( )
inline

Definition at line 215 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::empty, CircularBuffer< DataType, IndexType >::readpos, and CircularBuffer< DataType, IndexType >::writepos.

◆ setAll()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::setAll ( const DataType  value)
inline

Definition at line 210 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, and CircularBuffer< DataType, IndexType >::size.

Referenced by CircularBuffer< DataType, IndexType >::clear(), and InterpolatingSignalGenerator< im >::set().

◆ setData()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::setData ( DataType *  data,
IndexType  len 
)
inline

Definition at line 23 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, and CircularBuffer< DataType, IndexType >::size.

Referenced by InterpolatingWavetableOscillator< im >::setWavetable().

◆ setDelay()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::setDelay ( int  samples)
inline

Set the read index.

Parameters
samplesbehind the write index.

Definition at line 168 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::readpos, CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

Referenced by CircularBuffer< DataType, IndexType >::delay(), CrossFadingCircularBuffer< T >::delay(), and DelayProcessor::setDelay().

◆ setReadIndex()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::setReadIndex ( IndexType  pos)
inline

Definition at line 151 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::readpos, and CircularBuffer< DataType, IndexType >::size.

◆ setWriteIndex()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::setWriteIndex ( IndexType  pos)
inline

Definition at line 133 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

◆ skipUntilLast()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::skipUntilLast ( char  c)
inline

Definition at line 110 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, CircularBuffer< DataType, IndexType >::empty, CircularBuffer< DataType, IndexType >::getReadHead(), CircularBuffer< DataType, IndexType >::readpos, CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

◆ write() [1/2]

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::write ( DataType *  source,
IndexType  len 
)
inline

Definition at line 52 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, CircularBuffer< DataType, IndexType >::empty, FLOW_ASSERT, CircularBuffer< DataType, IndexType >::getWriteCapacity(), CircularBuffer< DataType, IndexType >::getWriteHead(), CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

◆ write() [2/2]

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::write ( DataType  c)
inline

Definition at line 44 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, CircularBuffer< DataType, IndexType >::empty, FLOW_ASSERT, CircularBuffer< DataType, IndexType >::getWriteCapacity(), CircularBuffer< DataType, IndexType >::size, and CircularBuffer< DataType, IndexType >::writepos.

Referenced by CircularBuffer< DataType, IndexType >::delay(), CrossFadingCircularBuffer< T >::delay(), DelayProcessor::process(), and InterpolatingSignalGenerator< im >::update().

◆ writeAt()

template<typename DataType , typename IndexType = size_t>
void CircularBuffer< DataType, IndexType >::writeAt ( IndexType  index,
DataType  value 
)
inline

Definition at line 67 of file CircularBuffer.h.

References CircularBuffer< DataType, IndexType >::data, and CircularBuffer< DataType, IndexType >::size.

Field Documentation

◆ data

template<typename DataType , typename IndexType = size_t>
DataType* CircularBuffer< DataType, IndexType >::data
protected

Definition at line 14 of file CircularBuffer.h.

Referenced by CircularBuffer< DataType, IndexType >::destroy(), CrossFadingCircularBuffer< T >::destroy(), InterpolatingCircularFloatBuffer< im >::destroy(), CircularBuffer< DataType, IndexType >::getData(), CircularBuffer< DataType, IndexType >::getReadHead(), CircularBuffer< DataType, IndexType >::getWriteHead(), CircularBuffer< DataType, IndexType >::overdub(), CircularBuffer< DataType, IndexType >::overdubAt(), CircularBuffer< DataType, IndexType >::read(), CircularBuffer< DataType, IndexType >::readAt(), CircularBuffer< DataType, IndexType >::setAll(), CircularBuffer< DataType, IndexType >::setData(), CircularBuffer< DataType, IndexType >::skipUntilLast(), CircularBuffer< DataType, IndexType >::write(), and CircularBuffer< DataType, IndexType >::writeAt().

◆ empty

template<typename DataType , typename IndexType = size_t>
bool CircularBuffer< DataType, IndexType >::empty = true
protected

Definition at line 18 of file CircularBuffer.h.

Referenced by CircularBuffer< DataType, IndexType >::getWriteCapacity(), CircularBuffer< DataType, IndexType >::isEmpty(), CircularBuffer< DataType, IndexType >::isFull(), CircularBuffer< DataType, IndexType >::moveReadHead(), CircularBuffer< DataType, IndexType >::moveWriteHead(), CircularBuffer< DataType, IndexType >::overdub(), CircularBuffer< DataType, IndexType >::read(), CircularBuffer< DataType, IndexType >::reset(), CircularBuffer< DataType, IndexType >::skipUntilLast(), and CircularBuffer< DataType, IndexType >::write().

◆ readpos

template<typename DataType , typename IndexType = size_t>
IndexType CircularBuffer< DataType, IndexType >::readpos = 0
protected

Definition at line 17 of file CircularBuffer.h.

Referenced by CircularBuffer< DataType, IndexType >::getContiguousReadCapacity(), CircularBuffer< DataType, IndexType >::getContiguousWriteCapacity(), CircularBuffer< DataType, IndexType >::getDelay(), CircularBuffer< DataType, IndexType >::getReadHead(), CircularBuffer< DataType, IndexType >::getReadIndex(), CircularBuffer< DataType, IndexType >::getWriteCapacity(), CircularBuffer< DataType, IndexType >::isFull(), CircularBuffer< DataType, IndexType >::moveReadHead(), CircularBuffer< DataType, IndexType >::read(), CircularBuffer< DataType, IndexType >::reset(), CircularBuffer< DataType, IndexType >::setDelay(), CircularBuffer< DataType, IndexType >::setReadIndex(), and CircularBuffer< DataType, IndexType >::skipUntilLast().

◆ size

template<typename DataType , typename IndexType = size_t>
IndexType CircularBuffer< DataType, IndexType >::size
protected

Definition at line 15 of file CircularBuffer.h.

Referenced by CircularBuffer< DataType, IndexType >::getContiguousReadCapacity(), CircularBuffer< DataType, IndexType >::getContiguousWriteCapacity(), CircularBuffer< DataType, IndexType >::getDelay(), CircularBuffer< DataType, IndexType >::getReadCapacity(), CircularBuffer< DataType, IndexType >::getSize(), CircularBuffer< DataType, IndexType >::getWriteCapacity(), CircularBuffer< DataType, IndexType >::moveReadHead(), CircularBuffer< DataType, IndexType >::moveWriteHead(), CircularBuffer< DataType, IndexType >::overdub(), CircularBuffer< DataType, IndexType >::overdubAt(), CircularBuffer< DataType, IndexType >::read(), CircularBuffer< DataType, IndexType >::readAt(), CircularBuffer< DataType, IndexType >::setAll(), CircularBuffer< DataType, IndexType >::setData(), CircularBuffer< DataType, IndexType >::setDelay(), CircularBuffer< DataType, IndexType >::setReadIndex(), CircularBuffer< DataType, IndexType >::setWriteIndex(), CircularBuffer< DataType, IndexType >::skipUntilLast(), CircularBuffer< DataType, IndexType >::write(), and CircularBuffer< DataType, IndexType >::writeAt().

◆ writepos

template<typename DataType , typename IndexType = size_t>
IndexType CircularBuffer< DataType, IndexType >::writepos = 0
protected

Definition at line 16 of file CircularBuffer.h.

Referenced by CircularBuffer< DataType, IndexType >::getContiguousReadCapacity(), CircularBuffer< DataType, IndexType >::getContiguousWriteCapacity(), CircularBuffer< DataType, IndexType >::getDelay(), CircularBuffer< DataType, IndexType >::getWriteCapacity(), CircularBuffer< DataType, IndexType >::getWriteHead(), CircularBuffer< DataType, IndexType >::getWriteIndex(), CircularBuffer< DataType, IndexType >::isFull(), CircularBuffer< DataType, IndexType >::moveReadHead(), CircularBuffer< DataType, IndexType >::moveWriteHead(), CircularBuffer< DataType, IndexType >::overdub(), CircularBuffer< DataType, IndexType >::read(), CircularBuffer< DataType, IndexType >::reset(), CircularBuffer< DataType, IndexType >::setDelay(), CircularBuffer< DataType, IndexType >::setWriteIndex(), CircularBuffer< DataType, IndexType >::skipUntilLast(), and CircularBuffer< DataType, IndexType >::write().

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