#include <CircularSampleBuffer.h>

Inheritance diagram for staffpad::audio::CircularSampleBuffer< SampleT >:

Public Member Functions
	CircularSampleBuffer ()

	~CircularSampleBuffer ()

void	setSize (int n)

int	getAllocatedSize () const

void	reset ()

void	write (int offset, const SampleT &sample)

void	writeOffset0 (const SampleT &sample)

const SampleT &	read (int offset) const

void	advance (int n)
	change the 0 position by n More...

void	writeBlock (int startOffset, int n, const SampleT *sourceBlock)

void	readBlockWithGain (int startOffset, int n, SampleT *targetBlock, float gainFactor) const

void	readAddBlockWithGain (int startOffset, int n, SampleT *targetBlock, float gainFactor) const

void	writeAddBlockWithGain (int startOffset, int n, const SampleT *sourceBlock, float gainFactor)

void	readBlock (int startOffset, int n, SampleT *targetBlock) const

void	readAndClearBlock (int startOffset, int n, SampleT *targetBlock)

void	clearBlock (int startOffset, int n)

Private Member Functions
template<typename fnc >
void	_splitBlockOffsetFunction (int startOffset, int n, fnc f) const

Private Attributes
SampleT *	_buffer = nullptr

int	_position0 = 0

int	_allocatedSize = 0

int	_bufferSizeMask = 0

Detailed Description

template<typename SampleT>
class staffpad::audio::CircularSampleBuffer< SampleT >

Definition at line 16 of file CircularSampleBuffer.h.

Constructor & Destructor Documentation

◆ CircularSampleBuffer()

template<typename SampleT >

staffpad::audio::CircularSampleBuffer< SampleT >::CircularSampleBuffer ( )

inline

Definition at line 19 of file CircularSampleBuffer.h.

20 {

21 }

◆ ~CircularSampleBuffer()

template<typename SampleT >

staffpad::audio::CircularSampleBuffer< SampleT >::~CircularSampleBuffer ( )

inline

Definition at line 23 of file CircularSampleBuffer.h.

  {
    if (_buffer)
      free(_buffer);
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, and staffpad::vo::free().

Here is the call graph for this function:

Member Function Documentation

◆ _splitBlockOffsetFunction()

template<typename SampleT >

template<typename fnc >

void staffpad::audio::CircularSampleBuffer< SampleT >::_splitBlockOffsetFunction	(	int	startOffset,
		int	n,
		fnc	f
	)		const

inlineprivate

Definition at line 88 of file CircularSampleBuffer.h.

  {
    assert(n <= _allocatedSize);
    int firstIndex = (_position0 + startOffset) & _bufferSizeMask;
    int n_to_end = _allocatedSize - firstIndex;
    if (n_to_end > n)
    {
      f(firstIndex, 0, n);
    }
    else
    {
      f(firstIndex, 0, n_to_end);
      f(0, n_to_end, n - n_to_end);
    }
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_allocatedSize, staffpad::audio::CircularSampleBuffer< SampleT >::_bufferSizeMask, and staffpad::audio::CircularSampleBuffer< SampleT >::_position0.

Referenced by staffpad::audio::CircularSampleBuffer< SampleT >::clearBlock(), staffpad::audio::CircularSampleBuffer< SampleT >::readAddBlockWithGain(), staffpad::audio::CircularSampleBuffer< SampleT >::readAndClearBlock(), staffpad::audio::CircularSampleBuffer< SampleT >::readBlock(), staffpad::audio::CircularSampleBuffer< SampleT >::readBlockWithGain(), staffpad::audio::CircularSampleBuffer< SampleT >::writeAddBlockWithGain(), and staffpad::audio::CircularSampleBuffer< SampleT >::writeBlock().

Here is the caller graph for this function:

◆ advance()

template<typename SampleT >

void staffpad::audio::CircularSampleBuffer< SampleT >::advance ( int n )

inline

change the 0 position by n

Definition at line 80 of file CircularSampleBuffer.h.

  {
    _position0 += n;
    _position0 &= _bufferSizeMask;
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_bufferSizeMask, and staffpad::audio::CircularSampleBuffer< SampleT >::_position0.

◆ clearBlock()

template<typename SampleT >

void staffpad::audio::CircularSampleBuffer< SampleT >::clearBlock	(	int	startOffset,
		int	n
	)

inline

Definition at line 148 of file CircularSampleBuffer.h.

  {
    _splitBlockOffsetFunction(startOffset, n,
                              [=](int bufferOff, int sampleOff, int n) { vo::setToZero(&_buffer[bufferOff], n); });
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, staffpad::audio::CircularSampleBuffer< SampleT >::_splitBlockOffsetFunction(), and staffpad::vo::setToZero().

Here is the call graph for this function:

◆ getAllocatedSize()

template<typename SampleT >

int staffpad::audio::CircularSampleBuffer< SampleT >::getAllocatedSize ( ) const

inline

Definition at line 52 of file CircularSampleBuffer.h.

  {
    return _allocatedSize;
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_allocatedSize.

◆ read()

template<typename SampleT >

const SampleT & staffpad::audio::CircularSampleBuffer< SampleT >::read ( int offset ) const

inline

Definition at line 74 of file CircularSampleBuffer.h.

  {
    return _buffer[(_position0 + offset) & _bufferSizeMask];
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, staffpad::audio::CircularSampleBuffer< SampleT >::_bufferSizeMask, and staffpad::audio::CircularSampleBuffer< SampleT >::_position0.

◆ readAddBlockWithGain()

template<typename SampleT >

void staffpad::audio::CircularSampleBuffer< SampleT >::readAddBlockWithGain	(	int	startOffset,
		int	n,
		SampleT *	targetBlock,
		float	gainFactor
	)		const

inline

Definition at line 119 of file CircularSampleBuffer.h.

  {
    _splitBlockOffsetFunction(startOffset, n, [=](int bufferOff, int sampleOff, int n) {
      vo::constantMultiplyAndAdd(&_buffer[bufferOff], gainFactor, &targetBlock[sampleOff], n);
    });
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, staffpad::audio::CircularSampleBuffer< SampleT >::_splitBlockOffsetFunction(), and staffpad::vo::constantMultiplyAndAdd().

Here is the call graph for this function:

◆ readAndClearBlock()

template<typename SampleT >

void staffpad::audio::CircularSampleBuffer< SampleT >::readAndClearBlock	(	int	startOffset,
		int	n,
		SampleT *	targetBlock
	)

inline

Definition at line 140 of file CircularSampleBuffer.h.

  {
    _splitBlockOffsetFunction(startOffset, n, [=](int bufferOff, int sampleOff, int n) {
      vo::copy(&_buffer[bufferOff], &targetBlock[sampleOff], n);
      vo::setToZero(&_buffer[bufferOff], n);
    });
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, staffpad::audio::CircularSampleBuffer< SampleT >::_splitBlockOffsetFunction(), staffpad::vo::copy(), and staffpad::vo::setToZero().

Here is the call graph for this function:

◆ readBlock()

template<typename SampleT >

void staffpad::audio::CircularSampleBuffer< SampleT >::readBlock	(	int	startOffset,
		int	n,
		SampleT *	targetBlock
	)		const

inline

Definition at line 133 of file CircularSampleBuffer.h.

  {
    _splitBlockOffsetFunction(startOffset, n, [=](int bufferOff, int sampleOff, int n) {
      vo::copy(&_buffer[bufferOff], &targetBlock[sampleOff], n);
    });
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, staffpad::audio::CircularSampleBuffer< SampleT >::_splitBlockOffsetFunction(), and staffpad::vo::copy().

Here is the call graph for this function:

◆ readBlockWithGain()

template<typename SampleT >

void staffpad::audio::CircularSampleBuffer< SampleT >::readBlockWithGain	(	int	startOffset,
		int	n,
		SampleT *	targetBlock,
		float	gainFactor
	)		const

inline

Definition at line 112 of file CircularSampleBuffer.h.

  {
    _splitBlockOffsetFunction(startOffset, n, [=](int bufferOff, int sampleOff, int n) {
      vo::constantMultiply(&_buffer[bufferOff], gainFactor, &targetBlock[sampleOff], n);
    });
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, staffpad::audio::CircularSampleBuffer< SampleT >::_splitBlockOffsetFunction(), and staffpad::vo::constantMultiply().

Here is the call graph for this function:

◆ reset()

template<typename SampleT >

void staffpad::audio::CircularSampleBuffer< SampleT >::reset ( )

inline

Definition at line 57 of file CircularSampleBuffer.h.

  {
    if (_buffer && _allocatedSize > 0)
      memset(_buffer, 0, sizeof(SampleT) * _allocatedSize);
    _position0 = 0;
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_allocatedSize, staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, and staffpad::audio::CircularSampleBuffer< SampleT >::_position0.

◆ setSize()

template<typename SampleT >

void staffpad::audio::CircularSampleBuffer< SampleT >::setSize ( int n )

inline

Definition at line 29 of file CircularSampleBuffer.h.

  {
    if (n > _allocatedSize)
    {
      auto oldSize = _allocatedSize;
 
      auto findLargerPowerOfTwo = [](int32_t number) {
        int32_t powerOf2 = 1;
        while (powerOf2 < number)
          powerOf2 *= 2;
        return powerOf2;
      };
 
      _allocatedSize = findLargerPowerOfTwo(n);
      _bufferSizeMask = _allocatedSize - 1;
      _buffer = (SampleT*)std::realloc(_buffer, _allocatedSize * sizeof(SampleT));
 
      // Reset the new memory region
      assert(_buffer);
      std::fill(_buffer + oldSize, _buffer + _allocatedSize, 0.f);
    }
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_allocatedSize, staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, and staffpad::audio::CircularSampleBuffer< SampleT >::_bufferSizeMask.

◆ write()

template<typename SampleT >

void staffpad::audio::CircularSampleBuffer< SampleT >::write	(	int	offset,
		const SampleT &	sample
	)

inline

Definition at line 64 of file CircularSampleBuffer.h.

  {
    _buffer[(_position0 + offset) & _bufferSizeMask] = sample;
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, staffpad::audio::CircularSampleBuffer< SampleT >::_bufferSizeMask, and staffpad::audio::CircularSampleBuffer< SampleT >::_position0.

◆ writeAddBlockWithGain()

template<typename SampleT >

void staffpad::audio::CircularSampleBuffer< SampleT >::writeAddBlockWithGain	(	int	startOffset,
		int	n,
		const SampleT *	sourceBlock,
		float	gainFactor
	)

inline

Definition at line 126 of file CircularSampleBuffer.h.

  {
    _splitBlockOffsetFunction(startOffset, n, [=](int bufferOff, int sampleOff, int n) {
      vo::constantMultiplyAndAdd(&sourceBlock[sampleOff], gainFactor, &_buffer[bufferOff], n);
    });
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, staffpad::audio::CircularSampleBuffer< SampleT >::_splitBlockOffsetFunction(), and staffpad::vo::constantMultiplyAndAdd().

Here is the call graph for this function:

◆ writeBlock()

template<typename SampleT >

void staffpad::audio::CircularSampleBuffer< SampleT >::writeBlock	(	int	startOffset,
		int	n,
		const SampleT *	sourceBlock
	)

inline

Definition at line 105 of file CircularSampleBuffer.h.

  {
    _splitBlockOffsetFunction(startOffset, n, [=](int bufferOff, int sampleOff, int n) {
      vo::copy(&sourceBlock[sampleOff], &_buffer[bufferOff], n);
    });
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, staffpad::audio::CircularSampleBuffer< SampleT >::_splitBlockOffsetFunction(), and staffpad::vo::copy().

Here is the call graph for this function:

◆ writeOffset0()

template<typename SampleT >

void staffpad::audio::CircularSampleBuffer< SampleT >::writeOffset0 ( const SampleT & sample )

inline

Definition at line 69 of file CircularSampleBuffer.h.

  {
    _buffer[_position0] = sample;
  }

References staffpad::audio::CircularSampleBuffer< SampleT >::_buffer, and staffpad::audio::CircularSampleBuffer< SampleT >::_position0.

Member Data Documentation

◆ _allocatedSize

template<typename SampleT >

int staffpad::audio::CircularSampleBuffer< SampleT >::_allocatedSize = 0

private

Definition at line 158 of file CircularSampleBuffer.h.

Referenced by staffpad::audio::CircularSampleBuffer< SampleT >::_splitBlockOffsetFunction(), staffpad::audio::CircularSampleBuffer< SampleT >::getAllocatedSize(), staffpad::audio::CircularSampleBuffer< SampleT >::reset(), and staffpad::audio::CircularSampleBuffer< SampleT >::setSize().

◆ _buffer

template<typename SampleT >

SampleT* staffpad::audio::CircularSampleBuffer< SampleT >::_buffer = nullptr

private

Definition at line 155 of file CircularSampleBuffer.h.

◆ _bufferSizeMask

template<typename SampleT >

int staffpad::audio::CircularSampleBuffer< SampleT >::_bufferSizeMask = 0

private

Definition at line 159 of file CircularSampleBuffer.h.

Referenced by staffpad::audio::CircularSampleBuffer< SampleT >::_splitBlockOffsetFunction(), staffpad::audio::CircularSampleBuffer< SampleT >::advance(), staffpad::audio::CircularSampleBuffer< SampleT >::read(), staffpad::audio::CircularSampleBuffer< SampleT >::setSize(), and staffpad::audio::CircularSampleBuffer< SampleT >::write().

◆ _position0

template<typename SampleT >

int staffpad::audio::CircularSampleBuffer< SampleT >::_position0 = 0

private

Definition at line 157 of file CircularSampleBuffer.h.

Referenced by staffpad::audio::CircularSampleBuffer< SampleT >::_splitBlockOffsetFunction(), staffpad::audio::CircularSampleBuffer< SampleT >::advance(), staffpad::audio::CircularSampleBuffer< SampleT >::read(), staffpad::audio::CircularSampleBuffer< SampleT >::reset(), staffpad::audio::CircularSampleBuffer< SampleT >::write(), and staffpad::audio::CircularSampleBuffer< SampleT >::writeOffset0().

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

CircularSampleBuffer.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CircularSampleBuffer()

◆ ~CircularSampleBuffer()

Member Function Documentation

◆ _splitBlockOffsetFunction()

◆ advance()

◆ clearBlock()

◆ getAllocatedSize()

◆ read()

◆ readAddBlockWithGain()

◆ readAndClearBlock()

◆ readBlock()

◆ readBlockWithGain()

◆ reset()

◆ setSize()

◆ write()

◆ writeAddBlockWithGain()

◆ writeBlock()

◆ writeOffset0()

Member Data Documentation

◆ _allocatedSize

◆ _buffer

◆ _bufferSizeMask

◆ _position0