arduino-audio-tools
All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Macros Modules Pages
Public Member Functions | Public Attributes | List of all members
GoertzelConfig Struct Reference

Configuration for Goertzel algorithm detectors. More...

#include <GoerzelStream.h>

Inheritance diagram for GoertzelConfig:
AudioInfo

Public Member Functions

 GoertzelConfig (const AudioInfo &info)
 Copy constructor from AudioInfo.
 
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)
 
int block_size = 205
 Number of samples to process per block (N) - affects detection latency and accuracy.
 
uint16_t channels = DEFAULT_CHANNELS
 Number of channels: 2=stereo, 1=mono.
 
sample_rate_t sample_rate = DEFAULT_SAMPLE_RATE
 Sample Rate: e.g 44100.
 
float target_frequency = 440.0f
 Target frequency to detect in Hz (same for all channels)
 
float threshold = 0.5f
 Detection threshold for magnitude (normalized samples, typically 0.1 to 1.0)
 
float volume = 1.0f
 Volume factor for normalization - scales input samples before processing.
 

Detailed Description

Configuration for Goertzel algorithm detectors.

This structure extends AudioInfo to include Goertzel-specific parameters. It defines the frequency detection behavior, audio format, and processing parameters for the Goertzel algorithm implementation.

Author
pschatzmann

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