Class audio_filter¶

`class` audio_filter audio ¶

class audio_filter { … }

Multi-channel audio filter that operates on audio_data and maintains a per-channel array of filter<fbase> instances.

`constructor` audio_filter() ¶

audio_filter()

Default constructor. Constructs an empty audio filter with no channels.

Fully qualified name: kfr::audio_filter::audio_filter()

Declared at audio/filter.hpp:50

`constructor` audio_filter(size_t, std::function<std::unique_ptr<filter<fbase>> (size_t)>) ¶

audio_filter(size_t channels, std::function<std::unique_ptr<filter<fbase>>(size_t)> fn)

Constructs an audio_filter for the given number of channels, initializing each channel filter with the factory function fn() .

Parameters
fn	Factory function receiving the zero-based channel index and returning a `std::unique_ptr<filter<fbase>>` .
channels	Number of audio channels.

Fully qualified name: kfr::audio_filter::audio_filter(size_t, std::function<std::unique_ptr<filter<fbase>> (size_t)>)

Declared at audio/filter.hpp:59

`function` iir(size_t, const iir_params<fbase, tag_dynamic_vector> &) ¶

static audio_filter iir(size_t channels, const iir_params<fbase, tag_dynamic_vector>& params)

Creates an audio filter using IIR biquad sections for all channels.

Parameters
channels	Number of audio channels.
params	IIR biquad parameters.

Returns
	Constructed `audio_filter` .

Fully qualified name: kfr::audio_filter::iir(size_t, const iir_params<fbase, tag_dynamic_vector> &)

Declared at audio/filter.hpp:67

`function` iir(size_t, const biquad_section<fbase> &) ¶

static audio_filter iir(size_t channels, const biquad_section<fbase>& section)

Creates an audio filter using a single IIR biquad section for all channels.

Parameters
channels	Number of audio channels.
section	Single biquad section.

Returns
	Constructed `audio_filter` .

Fully qualified name: kfr::audio_filter::iir(size_t, const biquad_section<fbase> &)

Declared at audio/filter.hpp:75

`function` fir(size_t, const fir_params<fbase> &) ¶

static audio_filter fir(size_t channels, const fir_params<fbase>& taps)

Creates an audio filter using an FIR filter for all channels.

Parameters
channels	Number of audio channels.
taps	FIR filter taps / parameters.

Returns
	Constructed `audio_filter` .

Fully qualified name: kfr::audio_filter::fir(size_t, const fir_params<fbase> &)

Declared at audio/filter.hpp:83

`function` convolution(size_t, const univector_ref<const fbase> &, size_t) ¶

static audio_filter convolution(size_t channels, const univector_ref<const fbase>& impulse_response,
                                size_t block_size = 1024)

Creates an audio filter using streaming overlap-add FFT convolution for all channels.

Parameters
channels	Number of audio channels.
impulse_response	Filter impulse response / kernel.
block_size	Processing block size (default: 1024).

Returns
	Constructed `audio_filter` .

Fully qualified name: kfr::audio_filter::convolution(size_t, const univector_ref<const fbase> &, size_t)

Declared at audio/filter.hpp:93

`function` reset() ¶

void reset()

Resets the internal state of all per-channel filter instances.

Fully qualified name: kfr::audio_filter::reset()

Declared at audio/filter.hpp:100

`function` apply(audio_data_planar &) ¶

void apply(audio_data_planar& data)

Applies the filter in-place to planar audio data.

Parameters
data	Planar audio data to process in place.

Fully qualified name: kfr::audio_filter::apply(audio_data_planar &)

Declared at audio/filter.hpp:106

`function` apply(audio_data_planar &, const audio_data_planar &) ¶

void apply(audio_data_planar& dest, const audio_data_planar& src)

Applies the filter to planar audio data, writing the result to dest .

Parameters
dest	Destination planar audio data.
src	Source planar audio data.

Fully qualified name: kfr::audio_filter::apply(audio_data_planar &, const audio_data_planar &)

Declared at audio/filter.hpp:113

`variable` filters ¶

std::array<std::unique_ptr<filter<fbase>>, max_audio_channels> filters

Fully qualified name: kfr::audio_filter::filters

Declared at audio/filter.hpp:115

`variable` channels ¶

size_t channels = 0

Fully qualified name: kfr::audio_filter::channels

Declared at audio/filter.hpp:116

Fully qualified name: kfr::audio_filter

Declared at audio/filter.hpp:44

This file was generated by cxxdox, a C++ documentation generator based on MkDocs Material and libclang.

Class audio_filter¶