Stateful ISTFT processor for chunked frame-by-frame synthesis. More...

#include <fft.H>

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

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

	ISTFTProcessor (const size_t fft_size, const Array< Real > &analysis_window, const Array< Real > &synthesis_window, const ISTFTOptions &options)
	Construct an inverse STFT processor with custom windows.

	ISTFTProcessor (const size_t fft_size, const Array< Real > &window, const ISTFTOptions &options)
	Construct an inverse STFT processor with a single window.

	ISTFTProcessor (const size_t fft_size, const size_t frame_size, const ISTFTOptions &options)
	Construct an inverse STFT processor with a Hann window.

template<typename AnalysisContainer , typename SynthesisContainer > requires Is_Real_Container<AnalysisContainer>
and Is_Real_Container< SynthesisContainer >	ISTFTProcessor (const size_t fft_size, const AnalysisContainer &analysis_window, const SynthesisContainer &synthesis_window, const ISTFTOptions &options)
	Construct an inverse STFT processor from any real containers.

size_t	frame_size () const noexcept

bool	configured () const noexcept

size_t	fft_size () const noexcept

size_t	hop_size () const noexcept

bool	centered () const noexcept

bool	finalized () const noexcept

void	reset ()

Array< Real >	process_frame (const Array< Complex > &spectrum)

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

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

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

Array< Real >	flush ()

Array< Real >	pflush (ThreadPool &, const size_t=0)

template<typename Container > requires Is_Complex_Container<Container>
Array< Real >	process_frame (const Container &spectrum)

template<typename Container > requires Is_Complex_Container<Container>
Array< Real >	pprocess_frame (ThreadPool &pool, const Container &spectrum, const size_t chunk_size=0)

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

void	initialize_state ()

void	ensure_pending_size (const size_t size)

void	accumulate_frame (const Array< Real > &frame)

Array< Real >	normalize_prefix (const size_t count)

Array< Real >	emit_samples (const Array< Real > &normalized, const bool final_flush)

Array< Real >	drain_ready_samples (const bool final_flush)

Array< Real >	process_frame_impl (const Array< Complex > &spectrum, ThreadPool *pool, const size_t chunk_size)

Private Attributes
Array< Real >	analysis_window_

Array< Real >	synthesis_window_

ISTFTOptions	options_

size_t	fft_size_ = 0

size_t	center_pad_ = 0

Plan	plan_

Array< Real >	pending_output_

Array< Real >	pending_norm_

size_t	frames_processed_ = 0

size_t	emitted_raw_samples_ = 0

size_t	left_trim_remaining_ = 0

size_t	emitted_signal_samples_ = 0

bool	configured_ = false

bool	has_seen_frame_ = false

bool	finalized_ = false

Detailed Description

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

Stateful ISTFT processor for chunked frame-by-frame synthesis.

Definition at line 10499 of file fft.H.

Constructor & Destructor Documentation

◆ ISTFTProcessor() [1/5]

template<std::floating_point Real = double>

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

default

Default constructor for an unconfigured inverse processor.

◆ ISTFTProcessor() [2/5]

template<std::floating_point Real = double>

Aleph::FFT< Real >::ISTFTProcessor::ISTFTProcessor	(	const size_t	fft_size,
		const Array< Real > &	analysis_window,
		const Array< Real > &	synthesis_window,
		const ISTFTOptions &	options
	)

inlineexplicit

Construct an inverse STFT processor with custom windows.

Parameters

fft_size	Fixed FFT transform size.
analysis_window	Analysis window used during STFT.
synthesis_window	Synthesis window for reconstruction.
options	Overlap-add parameters.

Definition at line 10695 of file fft.H.

References Aleph::FFT< Real >::ISTFTProcessor::analysis_window_, Aleph::FFT< Real >::ISTFTProcessor::fft_size_, Aleph::FFT< Real >::ISTFTProcessor::initialize_state(), Aleph::FFT< Real >::ISTFTProcessor::options_, Aleph::FFT< Real >::ISTFTProcessor::synthesis_window_, and Aleph::FFT< Real >::validate_istft_configuration().

◆ ISTFTProcessor() [3/5]

template<std::floating_point Real = double>

Aleph::FFT< Real >::ISTFTProcessor::ISTFTProcessor	(	const size_t	fft_size,
		const Array< Real > &	window,
		const ISTFTOptions &	options
	)

inlineexplicit

Construct an inverse STFT processor with a single window.

Parameters

fft_size	Fixed FFT transform size.
window	Window used for both analysis and synthesis.
options	Overlap-add parameters.

Definition at line 10721 of file fft.H.

◆ ISTFTProcessor() [4/5]

template<std::floating_point Real = double>

Aleph::FFT< Real >::ISTFTProcessor::ISTFTProcessor	(	const size_t	fft_size,
		const size_t	frame_size,
		const ISTFTOptions &	options
	)

inlineexplicit

Construct an inverse STFT processor with a Hann window.

Parameters

fft_size	Fixed FFT transform size.
frame_size	Hann window size.
options	Overlap-add parameters.

Definition at line 10733 of file fft.H.

◆ ISTFTProcessor() [5/5]

template<std::floating_point Real = double>

template<typename AnalysisContainer , typename SynthesisContainer >
requires Is_Real_Container<AnalysisContainer>

and Is_Real_Container< SynthesisContainer > Aleph::FFT< Real >::ISTFTProcessor::ISTFTProcessor	(	const size_t	fft_size,
		const AnalysisContainer &	analysis_window,
		const SynthesisContainer &	synthesis_window,
		const ISTFTOptions &	options
	)

inlineexplicit

Construct an inverse STFT processor from any real containers.

Template Parameters

AnalysisContainer	Type for analysis window.
SynthesisContainer	Type for synthesis window.

Parameters

fft_size	Fixed FFT transform size.
analysis_window	Analysis window.
synthesis_window	Synthesis window.
options	Overlap-add parameters.

Definition at line 10754 of file fft.H.

Member Function Documentation

◆ accumulate_frame()

template<std::floating_point Real = double>

void Aleph::FFT< Real >::ISTFTProcessor::accumulate_frame ( const Array< Real > & frame )

inlineprivate

Definition at line 10553 of file fft.H.

Referenced by Aleph::FFT< Real >::ISTFTProcessor::process_frame_impl().

◆ centered()

template<std::floating_point Real = double>

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

inlinenoexcept

Definition at line 10784 of file fft.H.

References Aleph::FFT< Real >::ISTFTOptions::centered, and Aleph::FFT< Real >::ISTFTProcessor::options_.

◆ configured()

template<std::floating_point Real = double>

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

inlinenoexcept

Definition at line 10769 of file fft.H.

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

◆ drain_ready_samples()

template<std::floating_point Real = double>

Array< Real > Aleph::FFT< Real >::ISTFTProcessor::drain_ready_samples ( const bool final_flush )

inlineprivate

Definition at line 10645 of file fft.H.

Referenced by Aleph::FFT< Real >::ISTFTProcessor::flush(), and Aleph::FFT< Real >::ISTFTProcessor::process_frame_impl().

◆ emit_samples()

template<std::floating_point Real = double>

Array< Real > Aleph::FFT< Real >::ISTFTProcessor::emit_samples	(	const Array< Real > &	normalized,
		const bool	final_flush
	)

inlineprivate

Definition at line 10610 of file fft.H.

References Aleph::and, Aleph::FFT< Real >::ISTFTProcessor::center_pad_, Aleph::FFT< Real >::ISTFTOptions::centered, Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::ISTFTProcessor::emitted_signal_samples_, Aleph::FFT< Real >::ISTFTProcessor::left_trim_remaining_, Aleph::FFT< Real >::ISTFTProcessor::options_, Aleph::Array< T >::reserve(), and Aleph::FFT< Real >::ISTFTOptions::signal_length.

Referenced by Aleph::FFT< Real >::ISTFTProcessor::drain_ready_samples().

◆ ensure_pending_size()

template<std::floating_point Real = double>

void Aleph::FFT< Real >::ISTFTProcessor::ensure_pending_size ( const size_t size )

inlineprivate

Definition at line 10538 of file fft.H.

References Aleph::Array< T >::append(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::ISTFTProcessor::pending_norm_, Aleph::FFT< Real >::ISTFTProcessor::pending_output_, Aleph::Array< T >::reserve(), Aleph::Array< T >::size(), and Aleph::size().

Referenced by Aleph::FFT< Real >::ISTFTProcessor::accumulate_frame().

◆ fft_size()

template<std::floating_point Real = double>

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

inlinenoexcept

Definition at line 10774 of file fft.H.

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

◆ finalized()

template<std::floating_point Real = double>

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

inlinenoexcept

Definition at line 10789 of file fft.H.

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

◆ flush()

template<std::floating_point Real = double>

Array< Real > Aleph::FFT< Real >::ISTFTProcessor::flush ( )

inline

Definition at line 10836 of file fft.H.

References Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::ISTFTProcessor::drain_ready_samples(), Aleph::Array< T >::empty(), Aleph::FFT< Real >::ISTFTProcessor::finalized_, Aleph::FFT< Real >::ISTFTProcessor::has_seen_frame_, Aleph::FFT< Real >::ISTFTProcessor::pending_norm_, Aleph::FFT< Real >::ISTFTProcessor::pending_output_, and Aleph::FFT< Real >::ISTFTProcessor::require_configured().

Referenced by Aleph::FFT< Real >::ISTFTProcessor::pflush().

◆ frame_size()

template<std::floating_point Real = double>

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

inlinenoexcept

Definition at line 10764 of file fft.H.

References Aleph::FFT< Real >::ISTFTProcessor::analysis_window_, and Aleph::Array< T >::size().

◆ hop_size()

template<std::floating_point Real = double>

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

inlinenoexcept

Definition at line 10779 of file fft.H.

References Aleph::FFT< Real >::ISTFTOptions::hop_size, and Aleph::FFT< Real >::ISTFTProcessor::options_.

◆ initialize_state()

template<std::floating_point Real = double>

void Aleph::FFT< Real >::ISTFTProcessor::initialize_state ( )

inlineprivate

Definition at line 10525 of file fft.H.

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

◆ normalize_prefix()

template<std::floating_point Real = double>

Array< Real > Aleph::FFT< Real >::ISTFTProcessor::normalize_prefix ( const size_t count )

inlineprivate

Definition at line 10578 of file fft.H.

References ah_domain_error_if, ah_invalid_argument_if, Aleph::count(), Aleph::Array< T >::create(), Aleph::divide_and_conquer_partition_dp(), Aleph::FFT< Real >::drop_prefix(), Aleph::FFT< Real >::ISTFTProcessor::emitted_raw_samples_, Aleph::FFT< Real >::max_abs_value(), Aleph::FFT< Real >::ISTFTProcessor::pending_norm_, Aleph::FFT< Real >::ISTFTProcessor::pending_output_, and Aleph::Array< T >::size().

Referenced by Aleph::FFT< Real >::ISTFTProcessor::drain_ready_samples().

◆ pflush()

template<std::floating_point Real = double>

Array< Real > Aleph::FFT< Real >::ISTFTProcessor::pflush	(	ThreadPool &	,
		const size_t	= `0`
	)

inline

Definition at line 10857 of file fft.H.

References Aleph::FFT< Real >::ISTFTProcessor::flush(), and Aleph::FFT< Real >::ISTFTProcessor::require_configured().

◆ pprocess_block()

template<std::floating_point Real = double>

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

inline

Definition at line 10824 of file fft.H.

References Aleph::FFT< Real >::append_all(), Aleph::divide_and_conquer_partition_dp(), and Aleph::FFT< Real >::ISTFTProcessor::pprocess_frame().

◆ pprocess_frame() [1/2]

template<std::floating_point Real = double>

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