Files
stk/include/Resonate.h
Gary Scavone a6381b9d38 Version 4.2.0
2013-09-29 23:06:14 +02:00

91 lines
2.4 KiB
C++

/***************************************************/
/*! \class Resonate
\brief STK noise driven formant filter.
This instrument contains a noise source, which
excites a biquad resonance filter, with volume
controlled by an ADSR.
Control Change Numbers:
- Resonance Frequency (0-Nyquist) = 2
- Pole Radii = 4
- Notch Frequency (0-Nyquist) = 11
- Zero Radii = 1
- Envelope Gain = 128
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
*/
/***************************************************/
#ifndef STK_RESONATE_H
#define STK_RESONATE_H
#include "Instrmnt.h"
#include "ADSR.h"
#include "BiQuad.h"
#include "Noise.h"
class Resonate : public Instrmnt
{
public:
//! Class constructor.
Resonate();
//! Class destructor.
~Resonate();
//! Reset and clear all internal state.
void clear();
//! Set the filter for a resonance at the given frequency (Hz) and radius.
void setResonance(StkFloat frequency, StkFloat radius);
//! Set the filter for a notch at the given frequency (Hz) and radius.
void setNotch(StkFloat frequency, StkFloat radius);
//! Set the filter zero coefficients for contant resonance gain.
void setEqualGainZeroes();
//! Initiate the envelope with a key-on event.
void keyOn();
//! Signal a key-off event to the envelope.
void keyOff();
//! Start a note with the given frequency and amplitude.
void noteOn(StkFloat frequency, StkFloat amplitude);
//! Stop a note with the given amplitude (speed of decay).
void noteOff(StkFloat amplitude);
//! Compute one output sample.
StkFloat tick();
//! Computer \e vectorSize outputs and return them in \e vector.
StkFloat *tick(StkFloat *vector, unsigned int vectorSize);
//! Fill a channel of the StkFrames object with computed outputs.
/*!
The \c channel argument should be one or greater (the first
channel is specified by 1). An StkError will be thrown if the \c
channel argument is zero or it is greater than the number of
channels in the StkFrames object.
*/
StkFrames& tick( StkFrames& frames, unsigned int channel = 1 );
//! Perform the control change specified by \e number and \e value (0.0 - 128.0).
void controlChange(int number, StkFloat value);
protected:
ADSR adsr_;
BiQuad filter_;
Noise noise_;
StkFloat poleFrequency_;
StkFloat poleRadius_;
StkFloat zeroFrequency_;
StkFloat zeroRadius_;
};
#endif