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

3 Band Equalizer inspired from https://www.musicdsp.org/en/latest/Filters/236-3-band-equaliser.html More...

#include <Equalizer.h>

Inheritance diagram for Equalizer3Bands:
ModifyingStream AudioStream BaseStream AudioInfoSupport AudioInfoSource Stream Print

Classes

struct  EQSTATE
 

Public Member Functions

 Equalizer3Bands (AudioOutput &out)
 
 Equalizer3Bands (AudioStream &stream)
 
 Equalizer3Bands (Print &out)
 
 Equalizer3Bands (Stream &in)
 
virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 
int available () override
 
int availableForWrite () override
 
virtual bool begin ()
 
bool begin (ConfigEqualizer3Bands &config)
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
ConfigEqualizer3Bandsconfig ()
 
ConfigEqualizer3BandsdefaultConfig ()
 
virtual void end ()
 
virtual void flush () override
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
virtual operator bool ()
 
size_t readBytes (uint8_t *data, size_t len) override
 Provides the data from all streams mixed together.
 
virtual size_t readSilence (uint8_t *buffer, size_t length)
 Source to generate silence: just sets the buffer to 0.
 
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
 
virtual void setAudioInfo (AudioInfo info) override
 Defines the input AudioInfo.
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
void setOutput (Print &out) override
 Defines/Changes the output target.
 
void setStream (Stream &io) override
 Defines/Changes the input & output.
 
size_t write (const uint8_t *data, size_t len) override
 
virtual size_t write (uint8_t ch) override
 
virtual void writeSilence (size_t len)
 Writes len bytes of silence (=0).
 

Protected Member Functions

void filterSamples (const uint8_t *data, size_t len)
 
virtual int not_supported (int out, const char *msg="")
 
void notifyAudioChange (AudioInfo info)
 
void refillReadBuffer ()
 
float sample (EQSTATE &es, float sample)
 

Protected Attributes

int _timeout = 10
 
ConfigEqualizer3Bands cfg
 
AudioInfo info
 
bool is_notify_active = true
 
int max_state_count = 0
 
Vector< AudioInfoSupport * > notify_vector
 
ConfigEqualizer3Bandsp_cfg = &cfg
 
Printp_print = nullptr
 
Streamp_stream = nullptr
 
struct audio_tools::Equalizer3Bands::EQSTATEstate = nullptr
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 
const float vsa = (1.0 / 4294967295.0)
 

Detailed Description

3 Band Equalizer inspired from https://www.musicdsp.org/en/latest/Filters/236-3-band-equaliser.html

Author
pschatzmann

Member Function Documentation

◆ addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport bi)
inlinevirtualinherited

◆ audioInfo()

virtual AudioInfo audioInfo ( )
inlineoverridevirtualinherited

◆ audioInfoOut()

virtual AudioInfo audioInfoOut ( )
inlinevirtualinherited

◆ available()

int available ( )
inlineoverridevirtual

Reimplemented from BaseStream.

◆ availableForWrite()

int availableForWrite ( )
inlineoverridevirtual

Reimplemented from BaseStream.

◆ begin()

virtual bool begin ( )
inlinevirtualinherited

◆ end()

virtual void end ( )
inlinevirtualinherited

◆ flush()

virtual void flush ( )
inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in ResampleStream, BufferedTaskStream, and BufferedStream.

◆ operator bool()

virtual operator bool ( )
inlinevirtualinherited

Reimplemented in A2DPStream, Pipeline, I2SStream, and MemoryStream.

◆ readBytes()

size_t readBytes ( uint8_t *  data,
size_t  len 
)
inlineoverridevirtual

Provides the data from all streams mixed together.

Reimplemented from AudioStream.

◆ setAudioInfo()

virtual void setAudioInfo ( AudioInfo  info)
inlineoverridevirtual

Defines the input AudioInfo.

Reimplemented from AudioStream.

◆ setOutput()

void setOutput ( Print out)
inlineoverridevirtual

Defines/Changes the output target.

Implements ModifyingStream.

◆ setStream()

void setStream ( Stream io)
inlineoverridevirtual

Defines/Changes the input & output.

Implements ModifyingStream.

◆ write() [1/2]

size_t write ( const uint8_t *  data,
size_t  len 
)
inlineoverridevirtual

Reimplemented from AudioStream.

◆ write() [2/2]

virtual size_t write ( uint8_t  ch)
inlineoverridevirtualinherited

Reimplemented in BufferedTaskStream, and BufferedStream.


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