1. Epic GamesDeveloper
  3. FAlignedBlockBuffer

FAlignedBlockBuffer

First In First Out Buffer designed for audio buffers.

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

References

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

Syntax

class FAlignedBlockBuffer

Remarks

First In First Out Buffer designed for audio buffers. Generally performs best when buffers are greater than 16 samples, optimally for buffers between 256 to 4096 samples. Memory operations are designed for audio applications by ensuring memory allocations only occur in the constructor or when capacity is altered, memory freeing only happens in the destructor or when capacity is altered. All assignments are performed using block memory copies.

Constructors

  Type Name Description
Public function  

FAlignedBlockBuffer ( int32 InSampleCapacity,
int32 InMaxNumInspectSamples,
uint32 InByteAlignment,
uint32 InAllocByteAlignment
)

 Constructor.

Destructors

  Type Name Description
Public function   Destructor.

Functions

  Type Name Description
Public function void

AddSamples ( const float* InSamples,
int32 InNum
)

 Add samples to the buffer.
Public function void

AddZeros ( int32 InNum
)

 Add zeros to the buffer.
Protected function Const float *

AllocateAlignedFloatArray ( int32 InNum
)

  
Public function void Clear entire buffer.
Protected function Const void

CopyFloatArray ( float* ToArray,
const float* FromArray,
int32 InNum
)

  
Protected function Const void

FreeFloatArray ( float*& Array
)

  
Public function Const int32 Maximum number of elements that can be inspected.
Public function Const int32 Amount of samples left over in buffer.
Public function Const int32 Maximum size of buffer.
Public function const float *

InspectSamples ( int32 InNum,
int32 InOffset
)

 Inspect samples in the buffer.
Public function void

RemoveSamples ( int32 InNum
)

 Remove samples from the buffer.
Protected function void

SetMaxNumInspectSamples ( int32 InMax
)

 Set the maximum number of elements that can be inspected.
Protected function Const void

ZeroFloatArray ( float* InArray,
int32 InNum
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page