pulp::signal::SpectralFrameBlurT< SampleType > Class Template Reference

#include <spectral_gate_blur.hpp>

Public Member Functions
bool	prepare (int channels, int num_bins, int blur_frames)
	Allocate fixed history off the audio thread.
void	reset () noexcept
	Clear the finite history without changing prepared capacity.
bool	process (std::complex< SampleType > *const *frames, int channels, int num_bins) noexcept
	Apply a causal box blur across at most blur_frames() analysis frames.
int	channels () const noexcept
int	num_bins () const noexcept
int	blur_frames () const noexcept
int	filled_frames () const noexcept
std::uint64_t	retained_bytes () const noexcept

Static Public Member Functions
static bool	checked_retained_bytes (int channels, int num_bins, int blur_frames, std::uint64_t target_max_bytes, std::uint64_t &bytes) noexcept
static bool	supports_configuration (int channels, int num_bins, int blur_frames) noexcept

Static Public Attributes
static constexpr int	maximum_channels = 64
static constexpr int	maximum_bins = 8193
static constexpr int	maximum_frames = 128

Member Function Documentation

blur_frames()

template<typename SampleType = float>

int pulp::signal::SpectralFrameBlurT< SampleType >::blur_frames ( ) const

inlinenoexcept

channels()

template<typename SampleType = float>

int pulp::signal::SpectralFrameBlurT< SampleType >::channels ( ) const

inlinenoexcept

checked_retained_bytes()

template<typename SampleType = float>

bool pulp::signal::SpectralFrameBlurT< SampleType >::checked_retained_bytes ( int channels, int num_bins, int blur_frames, std::uint64_t target_max_bytes, std::uint64_t & bytes )

inlinestaticnoexcept

filled_frames()

template<typename SampleType = float>

int pulp::signal::SpectralFrameBlurT< SampleType >::filled_frames ( ) const

inlinenoexcept

num_bins()

template<typename SampleType = float>

int pulp::signal::SpectralFrameBlurT< SampleType >::num_bins ( ) const

inlinenoexcept

prepare()

template<typename SampleType = float>

bool pulp::signal::SpectralFrameBlurT< SampleType >::prepare ( int channels, int num_bins, int blur_frames )

inline

Allocate fixed history off the audio thread.

Invalid geometry is rejected without changing the prepared instance.

process()

template<typename SampleType = float>

bool pulp::signal::SpectralFrameBlurT< SampleType >::process ( std::complex< SampleType > *const * frames, int channels, int num_bins )

inlinenoexcept

Apply a causal box blur across at most blur_frames() analysis frames.

Startup divides by the number of frames actually observed, not by zero padding. Invalid geometry is rejected before mutation. Non-finite bins enter history as silence; finite subsequent input therefore recovers.

reset()

template<typename SampleType = float>

void pulp::signal::SpectralFrameBlurT< SampleType >::reset ( )

inlinenoexcept

Clear the finite history without changing prepared capacity.

retained_bytes()

template<typename SampleType = float>

std::uint64_t pulp::signal::SpectralFrameBlurT< SampleType >::retained_bytes ( ) const

inlinenoexcept

supports_configuration()

template<typename SampleType = float>

bool pulp::signal::SpectralFrameBlurT< SampleType >::supports_configuration ( int channels, int num_bins, int blur_frames )

inlinestaticnoexcept

Member Data Documentation

maximum_bins

template<typename SampleType = float>

int pulp::signal::SpectralFrameBlurT< SampleType >::maximum_bins = 8193

staticconstexpr

maximum_channels

template<typename SampleType = float>

int pulp::signal::SpectralFrameBlurT< SampleType >::maximum_channels = 64

staticconstexpr

maximum_frames

template<typename SampleType = float>

int pulp::signal::SpectralFrameBlurT< SampleType >::maximum_frames = 128

staticconstexpr

---

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

• /home/runner/work/pulp/pulp/core/signal/include/pulp/signal/spectral_gate_blur.hpp