No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
audio_tools::AudioFFTBase Class Reference

Executes FFT using audio data. The Driver which is passed in the constructor selects a specifc FFT implementation. More...

#include <AudioFFT.h>

Inheritance diagram for audio_tools::AudioFFTBase:
audio_tools::AudioPrint Print audio_tools::AudioBaseInfoDependent audio_tools::AudioBaseInfoSource audio_tools::AudioCmsisFFT audio_tools::AudioESP32FFT audio_tools::AudioEspressifFFT audio_tools::AudioKissFFT audio_tools::AudioRealFFT

Public Member Functions

 AudioFFTBase (FFTDriver *driver)
 Default Constructor. The len needs to be of the power of 2 (e.g. 512, 1024, 2048, 4096, 8192)
int availableForWrite ()
 We try to fill the buffer at once. More...
bool begin (AudioFFTConfig info)
 starts the processing
AudioFFTConfig config ()
 Provides the actual configuration.
AudioFFTConfig defaultConfig ()
 Provides the default configuration.
FFTDriverdriver ()
 provides access to the FFTDriver which implements the basic FFT functionality
void end ()
 Release the allocated memory.
float frequency (int bin)
 Determines the frequency of the indicated bin.
int length ()
 The number of samples.
float magnitude (int bin)
 Calculates the magnitude of the fft result to determine the max value (bin is 0 to size())
float * magnitudes ()
 Provides the magnitudes as array of size size(). Please note that this method is allocating additinal memory!
AudioFFTResult result ()
 Determines the result values in the max magnitude bin.
template<int N>
void resultArray (AudioFFTResult(&result)[N])
 Determines the N biggest result values.
unsigned long resultTime ()
 time after the fft: time when the last result was provided - you can poll this to check if we have a new result
unsigned long resultTimeBegin ()
 time before the fft
void setAudioInfo (AudioBaseInfo info) override
 Notify change of audio information. More...
int size ()
 The number of bins used by the FFT which are relevant for the result.
size_t write (const uint8_t *data, size_t len) override
 Provide the audio data as FFT input. More...
- Public Member Functions inherited from audio_tools::AudioPrint
virtual AudioBaseInfo audioInfo () override
virtual int availableForWrite ()
virtual bool doRelease ()
 If true we need to release the related memory. More...
void flush ()
virtual void setAudioInfo (AudioBaseInfo info) override
virtual void setNotifyAudioChange (AudioBaseInfoDependent &bi) override
virtual size_t write (const uint8_t *buffer, size_t size) override=0
virtual size_t write (uint8_t ch) override
- Public Member Functions inherited from Print
virtual int availableForWrite ()
void clearWriteError ()
virtual void flush ()
int getWriteError ()
size_t print (char)
size_t print (const __FlashStringHelper *)
size_t print (const char[])
size_t print (const Printable &)
size_t print (const String &)
size_t print (double, int=2)
size_t print (int, int=DEC)
size_t print (long long, int=DEC)
size_t print (long, int=DEC)
size_t print (unsigned char, int=DEC)
size_t print (unsigned int, int=DEC)
size_t print (unsigned long long, int=DEC)
size_t print (unsigned long, int=DEC)
size_t println (char)
size_t println (const __FlashStringHelper *)
size_t println (const char[])
size_t println (const Printable &)
size_t println (const String &s)
size_t println (double, int=2)
size_t println (int, int=DEC)
size_t println (long long, int=DEC)
size_t println (long, int=DEC)
size_t println (unsigned char, int=DEC)
size_t println (unsigned int, int=DEC)
size_t println (unsigned long long, int=DEC)
size_t println (unsigned long, int=DEC)
size_t println (void)
size_t write (const char *buffer, size_t size)
size_t write (const char *str)
virtual size_t write (const uint8_t *buffer, size_t size)
virtual size_t write (uint8_t)=0
- Public Member Functions inherited from audio_tools::AudioBaseInfoDependent
virtual AudioBaseInfo audioInfo ()=0
virtual void setAudioInfo (AudioBaseInfo info)=0
virtual bool validate (AudioBaseInfo &info)
virtual void setNotifyAudioChange (AudioBaseInfoDependent &bi)=0

Protected Member Functions

int bytesPerSample ()
bool createStrideBuffer ()
 Allocates the stride buffer if necessary.
void fft ()
template<int N>
bool InsertSorted (AudioFFTResult(&result)[N], AudioFFTResult tmp)
 make sure that we do not reuse already found results
bool isPowerOfTwo (uint16_t x)
template<typename T >
void processSamples (const void *data, size_t byteCount)
void writeStrideBuffer (uint8_t *buffer, size_t len)
- Protected Member Functions inherited from Print
void setWriteError (int err=1)

Protected Attributes

AudioFFTConfig cfg
int current_pos = 0
FFTDriverp_driver =nullptr
float * p_magnitudes = nullptr
RingBuffer< uint8_t > * p_stridebuffer = nullptr
unsigned long timestamp =0l
unsigned long timestamp_begin =0l
- Protected Attributes inherited from audio_tools::AudioPrint
AudioBaseInfo cfg
AudioBaseInfoDependentp_notify =nullptr
uint8_t tmp [MAX_SINGLE_CHARS]
int tmpPos =0

Detailed Description

Executes FFT using audio data. The Driver which is passed in the constructor selects a specifc FFT implementation.

Phil Schatzmann

Member Function Documentation

◆ availableForWrite()

int audio_tools::AudioFFTBase::availableForWrite ( )

We try to fill the buffer at once.

Reimplemented from audio_tools::AudioPrint.

◆ setAudioInfo()

void audio_tools::AudioFFTBase::setAudioInfo ( AudioBaseInfo  info)

Notify change of audio information.

Reimplemented from audio_tools::AudioPrint.

◆ write()

size_t audio_tools::AudioFFTBase::write ( const uint8_t *  data,
size_t  len 

Provide the audio data as FFT input.

Implements audio_tools::AudioPrint.

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