AudioFFTConfig Struct Reference

Configuration for AudioFFT. If there are more then 1 channel the channel_used is defining which channel is used to perform the fft on. More...

#include <AudioFFT.h>

Inheritance diagram for AudioFFTConfig:

Public Member Functions
	AudioFFTConfig ()
virtual void	clear ()
void	copyFrom (AudioInfo info)
	Same as set.
bool	equals (AudioInfo alt)
	Returns true if alt values are the same like the current values.
bool	equalsExSampleRate (AudioInfo alt)
	Checks if only the sample rate is different.
virtual void	logInfo (const char *source="")
	operator bool ()
	Returns true if all components are defined (no component is 0)
bool	operator!= (AudioInfo alt)
	Returns true if alt values are the different from the current values.
bool	operator== (AudioInfo alt)
	Returns true if alt values are the same like the current values.
void	set (AudioInfo info)
	Copies the values from info.
void	setAudioInfo (AudioInfo info)
	Same as set.

Public Attributes
uint8_t	bits_per_sample = DEFAULT_BITS_PER_SAMPLE
	Number of bits per sample (int16_t = 16 bits)
void(*	callback )(AudioFFTBase &fft) = nullptr
	Callback method which is called after we got a new result.
uint8_t	channel_used = 0
	Channel which is used as input.
uint16_t	channels = DEFAULT_CHANNELS
	Number of channels: 2=stereo, 1=mono.
int	length = 8192
void *	ref = nullptr
	caller
RxTxMode	rxtx_mode = TX_MODE
	TX_MODE = FFT, RX_MODE = IFFT.
sample_rate_t	sample_rate = DEFAULT_SAMPLE_RATE
	Sample Rate: e.g 44100.
int	stride = 0
WindowFunction *	window_function = nullptr
	Optional window function for both fft and ifft.
WindowFunction *	window_function_fft = nullptr
	Optional window function for fft only.
WindowFunction *	window_function_ifft = nullptr
	Optional window function for ifft only.

Detailed Description

Configuration for AudioFFT. If there are more then 1 channel the channel_used is defining which channel is used to perform the fft on.

Note

Only channel_used is analyzed by the forward FFT - the other channels' input samples are discarded. On the reverse FFT the reconstructed signal is written identically to all channels, so multi-channel input/output is effectively collapsed to dual-mono rather than processed independently per channel.

Constructor & Destructor Documentation

AudioFFTConfig()

AudioFFTConfig ( )

inline

Member Function Documentation

clear()

virtual void clear ( )

inlinevirtualinherited

copyFrom()

void copyFrom ( AudioInfo  info )

inlineinherited

Same as set.

equals()

bool equals ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the same like the current values.

equalsExSampleRate()

bool equalsExSampleRate ( AudioInfo  alt )

inlineinherited

Checks if only the sample rate is different.

logInfo()

virtual void logInfo ( const char *  source = "" )

inlinevirtualinherited

Reimplemented in I2SConfigESP32, I2SConfigESP32V1, I2SConfigStd, and I2SConfigZephyr.

operator bool()

operator bool ( )

inlineinherited

Returns true if all components are defined (no component is 0)

operator!=()

bool operator!= ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the different from the current values.

operator==()

bool operator== ( AudioInfo  alt )

inlineinherited

Returns true if alt values are the same like the current values.

set()

void set ( AudioInfo  info )

inlineinherited

Copies the values from info.

setAudioInfo()

void setAudioInfo ( AudioInfo  info )

inlineinherited

Same as set.

Member Data Documentation

bits_per_sample

uint8_t bits_per_sample = DEFAULT_BITS_PER_SAMPLE

inherited

Number of bits per sample (int16_t = 16 bits)

callback

void(* callback) (AudioFFTBase &fft) = nullptr

Callback method which is called after we got a new result.

channel_used

uint8_t channel_used = 0

Channel which is used as input.

channels

uint16_t channels = DEFAULT_CHANNELS

inherited

Number of channels: 2=stereo, 1=mono.

length

int length = 8192

ref

void* ref = nullptr

caller

rxtx_mode

RxTxMode rxtx_mode = TX_MODE

TX_MODE = FFT, RX_MODE = IFFT.

sample_rate

sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE

inherited

Sample Rate: e.g 44100.

stride

int stride = 0

window_function

WindowFunction* window_function = nullptr

Optional window function for both fft and ifft.

window_function_fft

WindowFunction* window_function_fft = nullptr

Optional window function for fft only.

window_function_ifft

WindowFunction* window_function_ifft = nullptr

Optional window function for ifft only.

---

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

• src/AudioTools/FFT/AudioFFT.h