Superpowered::ThreeBandEQ Class Reference

Classic three-band equalizer with unique characteristics and total kills. More...

#include "Superpowered3BandEQ.h"

Inheritance diagram for Superpowered::ThreeBandEQ:

Collaboration diagram for Superpowered::ThreeBandEQ:

Public Member Functions
	ThreeBandEQ (unsigned int samplerate)
	Constructor. More...
	~ThreeBandEQ ()
bool	process (float *input, float *output, unsigned int numberOfFrames)
	Processes the audio. More...

Public Attributes
bool	enabled = false
	Turns the effect on/off. The actual switch will happen on the next process() call for smooth, audio-artifact free operation. More...
float	high
	High gain. See low for details. More...
float	low
	Low gain. Read-write. 1.0f is "flat", 2.0f is +6db. Kill is enabled under -40 db (0.01f). Default: 1.0f. Limits: 0.0f and 8.0f. More...
float	mid
	Mid gain. See low for details. More...
unsigned int	samplerate = 0
	Sample rate in Hz. More...

Private Member Functions
	ThreeBandEQ (const ThreeBandEQ &)
ThreeBandEQ &	operator= (const ThreeBandEQ &)

Private Attributes
eqInternals *	internals

Detailed Description

Classic three-band equalizer with unique characteristics and total kills.

It doesn't allocate any internal buffers and needs just a few bytes of memory.

Constructor & Destructor Documentation

ThreeBandEQ() [1/2]

Superpowered::ThreeBandEQ::ThreeBandEQ

(

unsigned int

samplerate

)

Constructor.

Enabled is false by default.

Parameters

samplerate

The initial sample rate in Hz.

~ThreeBandEQ()

Superpowered::ThreeBandEQ::~ThreeBandEQ

(

)

ThreeBandEQ() [2/2]

Superpowered::ThreeBandEQ::ThreeBandEQ ( const ThreeBandEQ &  )

private

Member Function Documentation

operator=()

ThreeBandEQ& Superpowered::ThreeBandEQ::operator= ( const ThreeBandEQ &  )

private

process()

bool Superpowered::ThreeBandEQ::process ( float *  input, float *  output, unsigned int  numberOfFrames  )

virtual

Processes the audio.

Always call it in the audio processing callback, regardless if the effect is enabled or not for smooth, audio-artifact free operation. It's never blocking for real-time usage. You can change all properties on any thread, concurrently with process().

Returns

If process() returns with true, the contents of output are replaced with the audio output. If process() returns with false, the contents of output are not changed.

Parameters

input	Pointer to floating point numbers. 32-bit interleaved stereo input.
output	Pointer to floating point numbers. 32-bit interleaved stereo output. Can point to the same location with input (in-place processing).
numberOfFrames	Number of frames to process. Recommendation for best performance: multiply of 4, minimum 64.

Implements Superpowered::FX.

Member Data Documentation

enabled

bool Superpowered::FX::enabled = false

inherited

Turns the effect on/off. The actual switch will happen on the next process() call for smooth, audio-artifact free operation.

high

float Superpowered::ThreeBandEQ::high

High gain. See low for details.

internals

eqInternals* Superpowered::ThreeBandEQ::internals

private

low

float Superpowered::ThreeBandEQ::low

Low gain. Read-write. 1.0f is "flat", 2.0f is +6db. Kill is enabled under -40 db (0.01f). Default: 1.0f. Limits: 0.0f and 8.0f.

mid

float Superpowered::ThreeBandEQ::mid

Mid gain. See low for details.

samplerate

unsigned int Superpowered::FX::samplerate = 0

inherited

Sample rate in Hz.

---

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

• latest/Superpowered/Superpowered3BandEQ.h