1. Epic GamesDeveloper
  3. TCircularAudioBuffer

TCircularAudioBuffer

Basic implementation of a circular buffer built for pushing and popping arbitrary amounts of data at once.

API > API/Runtime > API/Runtime/SignalProcessing > API/Runtime/SignalProcessing/DSP

References

   
Module SignalProcessing
Header /Engine/Source/Runtime/SignalProcessing/Public/DSP/Dsp.h
Include #include "DSP/Dsp.h"

Syntax

template<typename SampleType, size_t Alignment>  
class TCircularAudioBuffer

Remarks

Basic implementation of a circular buffer built for pushing and popping arbitrary amounts of data at once. Designed to be thread safe for SPSC; However, if Push() and Pop() are both trying to access an overlapping area of the buffer, One of the calls will be truncated. Thus, it is advised that you use a high enough capacity that the producer and consumer are never in contention.

Constructors

  Type Name Description
Public function    
Public function  

TCircularAudioBuffer ( const TCircularAudioBuffer< SampleType, Alignment >& InOther
)

  
Public function  

TCircularAudioBuffer ( uint32 InCapacity
)

  

Functions

  Type Name Description
Public function void

Empty ()

  
Public function Const uint32 Get the current capacity of the buffer.
Public function Const uint32

Num ()

 Get number of samples that can be popped off of the buffer.
Public function Const int32

Peek ( SampleType* OutBuffer,
uint32 NumSamples
)

 Same as Pop(), but does not increment the read counter.
Public function Const bool

Peek ( SampleType& OutElement
)

 Peeks a single element. returns false if the element is empty.
Public function Const DisjointedArrayView< const SampleType >

PeekInPlace ( uint32 NumSamples
)

 Same Peek(), but provides a (possibly) disjointed view of the memory in-place Push calls while the returned view is being accessed is undefined behavior
Public function int32

Pop ( SampleType* OutBuffer,
uint32 NumSamples
)

 Pops some amount of samples into this circular buffer. Returns the amount of samples read.
Public function int32

Pop ( uint32 NumSamples
)

 Pops some amount of samples into this circular buffer. Returns the amount of samples read.
Public function SampleType

Pop ()

 Pops a single element.
Public function DisjointedArrayView< const SampleType >

PopInPlace ( uint32 NumSamples
)

 Same as Pop(), but provides a (possibly) disjinted view of memory in-place Push calls while the returned view is being accessed is undefined behavior
Public function int32

Push ( TArrayView< const SampleType > InBuffer
)

 Push an array of values into circular buffer.
Public function bool

Push ( SampleType&& InElement
)

  
Public function bool

Push ( const SampleType& InElement
)

 Push a single sample onto this buffer. Returns false if the buffer is full.
Public function int32

Push ( const SampleType* InBuffer,
uint32 NumSamples
)

 Pushes some amount of samples into this circular buffer.
Public function int32

PushZeros ( uint32 NumSamplesOfZeros
)

 Pushes some amount of zeros into the circular buffer.
Public function Const uint32 Get number of samples that can be pushed onto the buffer before it is full.
Public function void

Reserve ( uint32 InMinimumCapacity,
bool bRetainExistingSamples
)

 Reserve capacity.
Public function void

Reset ( uint32 InCapacity
)

  
Public function void

SetCapacity ( uint32 InCapacity
)

  
Public function void

SetNum ( uint32 NumSamples,
bool bRetainOldestSamples
)

 When called, seeks the read or write cursor to only retain either the NumSamples latest data (if bRetainOldestSamples is false) or the NumSamples oldest data (if bRetainOldestSamples is true) in the buffer.

Operators

  Type Name Description
Public function TCircularAudioBuffer &

operator= ( const TCircularAudioBuffer< SampleType, Alignment >& InOther
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page