Stateful STFT processor for chunked real-time analysis. More...

#include <fft.H>

Collaboration diagram for Aleph::FFT< Real >::STFTProcessor:

Public Member Functions
	STFTProcessor ()=default
	Default constructor for an unconfigured processor.

	STFTProcessor (const Array< Real > &window, const STFTOptions &options)
	Construct an STFT processor with a fixed analysis window.

	STFTProcessor (const size_t frame_size, const STFTOptions &options)
	Construct an STFT processor using a Hann window.

template<typename WindowContainer > requires Is_Real_Container<WindowContainer>
	STFTProcessor (const WindowContainer &window, const STFTOptions &options)
	Construct an STFT processor from any real container.

size_t	frame_size () const noexcept

bool	configured () const noexcept

size_t	hop_size () const noexcept

size_t	fft_size () const noexcept

bool	centered () const noexcept

bool	pad_end () const noexcept

bool	finalized () const noexcept

const Array< Real > &	window () const noexcept

void	reset ()

Array< Array< Complex > >	process_block (const Array< Real > &block)

Array< Array< Complex > >	pprocess_block (ThreadPool &pool, const Array< Real > &block, const size_t chunk_size=0)

Array< Array< Complex > >	flush ()

Array< Array< Complex > >	pflush (ThreadPool &pool, const size_t chunk_size=0)

template<typename Container > requires Is_Real_Container<Container>
Array< Array< Complex > >	process_block (const Container &block)

template<typename Container > requires Is_Real_Container<Container>
Array< Array< Complex > >	pprocess_block (ThreadPool &pool, const Container &block, const size_t chunk_size=0)

Private Member Functions
void	require_configured (const char *ctx) const

void	initialize_pending ()

void	append_samples (const Array< Real > &block)

Array< Array< Complex > >	emit_ready_frames (ThreadPool *pool, const size_t chunk_size, const bool allow_partial_frames)

Private Attributes
Array< Real >	window_

STFTOptions	options_

size_t	fft_size_ = 0

size_t	center_pad_ = 0

Plan	plan_

Array< Real >	pending_

bool	configured_ = false

bool	has_seen_input_ = false

bool	finalized_ = false

Detailed Description

template<std::floating_point Real = double>
class Aleph::FFT< Real >::STFTProcessor

Stateful STFT processor for chunked real-time analysis.

Definition at line 10237 of file fft.H.

Constructor & Destructor Documentation

◆ STFTProcessor() [1/4]

template<std::floating_point Real = double>

Aleph::FFT< Real >::STFTProcessor::STFTProcessor ( )

default

Default constructor for an unconfigured processor.

◆ STFTProcessor() [2/4]

template<std::floating_point Real = double>

Aleph::FFT< Real >::STFTProcessor::STFTProcessor	(	const Array< Real > &	window,
		const STFTOptions &	options
	)

inlineexplicit

Construct an STFT processor with a fixed analysis window.

Parameters

window	Analysis window (e.g. Hann, Hamming).
options	STFT parameters (hop size, centered, etc.).

Definition at line 10306 of file fft.H.

References Aleph::FFT< Real >::STFTProcessor::initialize_pending().

◆ STFTProcessor() [3/4]

template<std::floating_point Real = double>

Aleph::FFT< Real >::STFTProcessor::STFTProcessor	(	const size_t	frame_size,
		const STFTOptions &	options
	)

inlineexplicit

Construct an STFT processor using a Hann window.

Parameters

frame_size	Analysis window size.
options	STFT parameters.

Definition at line 10325 of file fft.H.

◆ STFTProcessor() [4/4]

template<std::floating_point Real = double>

template<typename WindowContainer >
requires Is_Real_Container<WindowContainer>

Aleph::FFT< Real >::STFTProcessor::STFTProcessor	(	const WindowContainer &	window,
		const STFTOptions &	options
	)

inlineexplicit

Construct an STFT processor from any real container.

Template Parameters

WindowContainer Container type (e.g. std::vector<double>).

Parameters

window	Analysis window.
options	STFT parameters.

Definition at line 10338 of file fft.H.

Member Function Documentation

◆ append_samples()

template<std::floating_point Real = double>

void Aleph::FFT< Real >::STFTProcessor::append_samples ( const Array< Real > & block )

inlineprivate

Definition at line 10265 of file fft.H.

References ah_invalid_argument_if, Aleph::FFT< Real >::append_all(), Aleph::FFT< Real >::STFTProcessor::pending_, and Aleph::Array< T >::size().

Referenced by Aleph::FFT< Real >::STFTProcessor::flush(), Aleph::FFT< Real >::STFTProcessor::pflush(), Aleph::FFT< Real >::STFTProcessor::pprocess_block(), and Aleph::FFT< Real >::STFTProcessor::process_block().

◆ centered()

template<std::floating_point Real = double>

bool Aleph::FFT< Real >::STFTProcessor::centered ( ) const

inlinenoexcept

Definition at line 10363 of file fft.H.

References Aleph::FFT< Real >::STFTOptions::centered, and Aleph::FFT< Real >::STFTProcessor::options_.

◆ configured()

template<std::floating_point Real = double>

bool Aleph::FFT< Real >::STFTProcessor::configured ( ) const

inlinenoexcept

Definition at line 10348 of file fft.H.

References Aleph::FFT< Real >::STFTProcessor::configured_.

◆ emit_ready_frames()

template<std::floating_point Real = double>

Array< Array< Complex > > Aleph::FFT< Real >::STFTProcessor::emit_ready_frames	(	ThreadPool *	pool,
		const size_t	chunk_size,
		const bool	allow_partial_frames
	)

inlineprivate

Definition at line 10274 of file fft.H.

References Aleph::and, Aleph::Array< T >::append(), Aleph::FFT< Real >::build_padded_frame_from_prefix(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::drop_prefix(), Aleph::FFT< Real >::STFTProcessor::fft_size_, Aleph::FFT< Real >::STFTOptions::hop_size, Aleph::Array< T >::is_empty(), Aleph::FFT< Real >::STFTProcessor::options_, Aleph::FFT< Real >::STFTProcessor::pending_, Aleph::FFT< Real >::STFTProcessor::plan_, Aleph::Array< T >::size(), Aleph::FFT< Real >::transform_stft_frames(), and Aleph::FFT< Real >::STFTProcessor::window_.

Referenced by Aleph::FFT< Real >::STFTProcessor::flush(), Aleph::FFT< Real >::STFTProcessor::pflush(), Aleph::FFT< Real >::STFTProcessor::pprocess_block(), and Aleph::FFT< Real >::STFTProcessor::process_block().

◆ fft_size()

template<std::floating_point Real = double>

size_t Aleph::FFT< Real >::STFTProcessor::fft_size ( ) const

inlinenoexcept

Definition at line 10358 of file fft.H.

References Aleph::FFT< Real >::STFTProcessor::fft_size_.

◆ finalized()

template<std::floating_point Real = double>

bool Aleph::FFT< Real >::STFTProcessor::finalized ( ) const

inlinenoexcept

Definition at line 10373 of file fft.H.

References Aleph::FFT< Real >::STFTProcessor::finalized_.

◆ flush()

template<std::floating_point Real = double>

Array< Array< Complex > > Aleph::FFT< Real >::STFTProcessor::flush ( )

inline

Definition at line 10424 of file fft.H.

◆ frame_size()

template<std::floating_point Real = double>

size_t Aleph::FFT< Real >::STFTProcessor::frame_size ( ) const

inlinenoexcept

Definition at line 10343 of file fft.H.

References Aleph::Array< T >::size(), and Aleph::FFT< Real >::STFTProcessor::window_.

◆ hop_size()

template<std::floating_point Real = double>

size_t Aleph::FFT< Real >::STFTProcessor::hop_size ( ) const

inlinenoexcept

Definition at line 10353 of file fft.H.

References Aleph::FFT< Real >::STFTOptions::hop_size, and Aleph::FFT< Real >::STFTProcessor::options_.

◆ initialize_pending()

template<std::floating_point Real = double>

void Aleph::FFT< Real >::STFTProcessor::initialize_pending ( )

inlineprivate

Definition at line 10256 of file fft.H.

References Aleph::Array< T >::append(), Aleph::FFT< Real >::STFTProcessor::center_pad_, Aleph::divide_and_conquer_partition_dp(), Aleph::Array< T >::empty(), Aleph::FFT< Real >::STFTProcessor::pending_, and Aleph::Array< T >::reserve().

Referenced by Aleph::FFT< Real >::STFTProcessor::STFTProcessor(), and Aleph::FFT< Real >::STFTProcessor::reset().

◆ pad_end()

template<std::floating_point Real = double>

bool Aleph::FFT< Real >::STFTProcessor::pad_end ( ) const

inlinenoexcept

Definition at line 10368 of file fft.H.

References Aleph::FFT< Real >::STFTProcessor::options_, and Aleph::FFT< Real >::STFTOptions::pad_end.

◆ pflush()

template<std::floating_point Real = double>

Array< Array< Complex > > Aleph::FFT< Real >::STFTProcessor::pflush	(	ThreadPool &	pool,
		const size_t	chunk_size = `0`
	)

inline

Definition at line 10452 of file fft.H.

◆ pprocess_block() [1/2]

template<std::floating_point Real = double>

Array< Array< Complex > > Aleph::FFT< Real >::STFTProcessor::pprocess_block	(	ThreadPool &	pool,
		const Array< Real > &	block,
		const size_t	chunk_size = `0`
	)

inline

Definition at line 10407 of file fft.H.

References ah_runtime_error_if, Aleph::FFT< Real >::STFTProcessor::append_samples(), Aleph::FFT< Real >::STFTProcessor::emit_ready_frames(), Aleph::FFT< Real >::STFTProcessor::finalized_, Aleph::FFT< Real >::STFTProcessor::has_seen_input_, Aleph::Array< T >::is_empty(), and Aleph::FFT< Real >::STFTProcessor::require_configured().

Referenced by Aleph::FFT< Real >::STFTProcessor::pprocess_block().

◆ pprocess_block() [2/2]

template<std::floating_point Real = double>

template<typename Container >
requires Is_Real_Container<Container>

Array< Array< Complex > > Aleph::FFT< Real >::STFTProcessor::pprocess_block	(	ThreadPool &	pool,
		const Container &	block,
		const size_t	chunk_size = `0`
	)

inline

Definition at line 10490 of file fft.H.

References Aleph::FFT< Real >::build_real_input(), and Aleph::FFT< Real >::STFTProcessor::pprocess_block().

◆ process_block() [1/2]

template<std::floating_point Real = double>

Array< Array< Complex > > Aleph::FFT< Real >::STFTProcessor::process_block ( const Array< Real > & block )

inline

Definition at line 10392 of file fft.H.

References ah_runtime_error_if, Aleph::FFT< Real >::STFTProcessor::append_samples(), Aleph::FFT< Real >::STFTProcessor::emit_ready_frames(), Aleph::FFT< Real >::STFTProcessor::finalized_, Aleph::FFT< Real >::STFTProcessor::has_seen_input_, Aleph::Array< T >::is_empty(), and Aleph::FFT< Real >::STFTProcessor::require_configured().

Referenced by Aleph::FFT< Real >::STFTProcessor::process_block().

◆ process_block() [2/2]

template<std::floating_point Real = double>

template<typename Container >
requires Is_Real_Container<Container>

Array< Array< Complex > > Aleph::FFT< Real >::STFTProcessor::process_block ( const Container & block )

inline

Definition at line 10482 of file fft.H.

References Aleph::FFT< Real >::build_real_input(), and Aleph::FFT< Real >::STFTProcessor::process_block().

◆ require_configured()

template<std::floating_point Real = double>

void Aleph::FFT< Real >::STFTProcessor::require_configured ( const char * ctx ) const

inlineprivate

Definition at line 10250 of file fft.H.

References ah_runtime_error_if, Aleph::FFT< Real >::STFTProcessor::configured_, and Aleph::divide_and_conquer_partition_dp().

Referenced by Aleph::FFT< Real >::STFTProcessor::flush(), Aleph::FFT< Real >::STFTProcessor::pflush(), Aleph::FFT< Real >::STFTProcessor::pprocess_block(), Aleph::FFT< Real >::STFTProcessor::process_block(), and Aleph::FFT< Real >::STFTProcessor::reset().

◆ reset()

template<std::floating_point Real = double>

void Aleph::FFT< Real >::STFTProcessor::reset ( )

inline

Definition at line 10383 of file fft.H.

References Aleph::FFT< Real >::STFTProcessor::finalized_, Aleph::FFT< Real >::STFTProcessor::has_seen_input_, Aleph::FFT< Real >::STFTProcessor::initialize_pending(), and Aleph::FFT< Real >::STFTProcessor::require_configured().

◆ window()

template<std::floating_point Real = double>

const Array< Real > & Aleph::FFT< Real >::STFTProcessor::window ( ) const

inlinenoexcept

Definition at line 10378 of file fft.H.

References Aleph::FFT< Real >::STFTProcessor::window_.

Member Data Documentation

◆ center_pad_

template<std::floating_point Real = double>

size_t Aleph::FFT< Real >::STFTProcessor::center_pad_ = 0

private

Definition at line 10242 of file fft.H.

Referenced by Aleph::FFT< Real >::STFTProcessor::flush(), Aleph::FFT< Real >::STFTProcessor::initialize_pending(), and Aleph::FFT< Real >::STFTProcessor::pflush().

◆ configured_

template<std::floating_point Real = double>

bool Aleph::FFT< Real >::STFTProcessor::configured_ = false

private

Definition at line 10245 of file fft.H.

Referenced by Aleph::FFT< Real >::STFTProcessor::configured(), and Aleph::FFT< Real >::STFTProcessor::require_configured().

◆ fft_size_

template<std::floating_point Real = double>

size_t Aleph::FFT< Real >::STFTProcessor::fft_size_ = 0

private

Definition at line 10241 of file fft.H.

Referenced by Aleph::FFT< Real >::STFTProcessor::emit_ready_frames(), and Aleph::FFT< Real >::STFTProcessor::fft_size().

◆ finalized_

template<std::floating_point Real = double>

bool Aleph::FFT< Real >::STFTProcessor::finalized_ = false

private

Definition at line 10247 of file fft.H.

Referenced by Aleph::FFT< Real >::STFTProcessor::finalized(), Aleph::FFT< Real >::STFTProcessor::flush(), Aleph::FFT< Real >::STFTProcessor::pflush(), Aleph::FFT< Real >::STFTProcessor::pprocess_block(), Aleph::FFT< Real >::STFTProcessor::process_block(), and Aleph::FFT< Real >::STFTProcessor::reset().

◆ has_seen_input_

template<std::floating_point Real = double>

bool Aleph::FFT< Real >::STFTProcessor::has_seen_input_ = false

private

Definition at line 10246 of file fft.H.

Referenced by Aleph::FFT< Real >::STFTProcessor::flush(), Aleph::FFT< Real >::STFTProcessor::pflush(), Aleph::FFT< Real >::STFTProcessor::pprocess_block(), Aleph::FFT< Real >::STFTProcessor::process_block(), and Aleph::FFT< Real >::STFTProcessor::reset().

◆ options_

template<std::floating_point Real = double>

STFTOptions Aleph::FFT< Real >::STFTProcessor::options_

private

Definition at line 10240 of file fft.H.

Referenced by Aleph::FFT< Real >::STFTProcessor::centered(), Aleph::FFT< Real >::STFTProcessor::emit_ready_frames(), Aleph::FFT< Real >::STFTProcessor::flush(), Aleph::FFT< Real >::STFTProcessor::hop_size(), Aleph::FFT< Real >::STFTProcessor::pad_end(), and Aleph::FFT< Real >::STFTProcessor::pflush().

◆ pending_

template<std::floating_point Real = double>

Array<Real> Aleph::FFT< Real >::STFTProcessor::pending_

private

Definition at line 10244 of file fft.H.

Referenced by Aleph::FFT< Real >::STFTProcessor::append_samples(), Aleph::FFT< Real >::STFTProcessor::emit_ready_frames(), Aleph::FFT< Real >::STFTProcessor::flush(), Aleph::FFT< Real >::STFTProcessor::initialize_pending(), and Aleph::FFT< Real >::STFTProcessor::pflush().

◆ plan_

template<std::floating_point Real = double>

Plan Aleph::FFT< Real >::STFTProcessor::plan_

private

Definition at line 10243 of file fft.H.

Referenced by Aleph::FFT< Real >::STFTProcessor::emit_ready_frames().

◆ window_

template<std::floating_point Real = double>

Array<Real> Aleph::FFT< Real >::STFTProcessor::window_

private

Definition at line 10239 of file fft.H.

Referenced by Aleph::FFT< Real >::STFTProcessor::emit_ready_frames(), Aleph::FFT< Real >::STFTProcessor::frame_size(), and Aleph::FFT< Real >::STFTProcessor::window().

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

fft.H

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ STFTProcessor() [1/4]

◆ STFTProcessor() [2/4]

◆ STFTProcessor() [3/4]

◆ STFTProcessor() [4/4]

Member Function Documentation

◆ append_samples()

◆ centered()

◆ configured()

◆ emit_ready_frames()

◆ fft_size()

◆ finalized()

◆ flush()

◆ frame_size()

◆ hop_size()

◆ initialize_pending()

◆ pad_end()

◆ pflush()

◆ pprocess_block() [1/2]

◆ pprocess_block() [2/2]

◆ process_block() [1/2]

◆ process_block() [2/2]

◆ require_configured()

◆ reset()

◆ window()

Member Data Documentation

◆ center_pad_

◆ configured_

◆ fft_size_

◆ finalized_

◆ has_seen_input_

◆ options_

◆ pending_

◆ plan_

◆ window_