mirror of
https://github.com/thestk/stk
synced 2026-01-11 20:11:52 +00:00
98 lines
2.5 KiB
C++
98 lines
2.5 KiB
C++
/***************************************************/
|
|
/*! \class ADSR
|
|
\brief STK ADSR envelope class.
|
|
|
|
This Envelope subclass implements a
|
|
traditional ADSR (Attack, Decay,
|
|
Sustain, Release) envelope. It
|
|
responds to simple keyOn and keyOff
|
|
messages, keeping track of its state.
|
|
The \e state = ADSR::DONE after the
|
|
envelope value reaches 0.0 in the
|
|
ADSR::RELEASE state.
|
|
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
|
|
*/
|
|
/***************************************************/
|
|
|
|
#ifndef STK_ADSR_H
|
|
#define STK_ADSR_H
|
|
|
|
#include "Envelope.h"
|
|
|
|
class ADSR : public Envelope
|
|
{
|
|
public:
|
|
|
|
//! Envelope states.
|
|
enum { ATTACK, DECAY, SUSTAIN, RELEASE, DONE };
|
|
|
|
//! Default constructor.
|
|
ADSR(void);
|
|
|
|
//! Class destructor.
|
|
~ADSR(void);
|
|
|
|
//! Set target = 1, state = \e ADSR::ATTACK.
|
|
void keyOn(void);
|
|
|
|
//! Set target = 0, state = \e ADSR::RELEASE.
|
|
void keyOff(void);
|
|
|
|
//! Set the attack rate.
|
|
void setAttackRate(StkFloat rate);
|
|
|
|
//! Set the decay rate.
|
|
void setDecayRate(StkFloat rate);
|
|
|
|
//! Set the sustain level.
|
|
void setSustainLevel(StkFloat level);
|
|
|
|
//! Set the release rate.
|
|
void setReleaseRate(StkFloat rate);
|
|
|
|
//! Set the attack rate based on a time duration.
|
|
void setAttackTime(StkFloat time);
|
|
|
|
//! Set the decay rate based on a time duration.
|
|
void setDecayTime(StkFloat time);
|
|
|
|
//! Set the release rate based on a time duration.
|
|
void setReleaseTime(StkFloat time);
|
|
|
|
//! Set sustain level and attach, decay, and release time durations.
|
|
void setAllTimes(StkFloat aTime, StkFloat dTime, StkFloat sLevel, StkFloat rTime);
|
|
|
|
//! Set the target value.
|
|
void setTarget(StkFloat target);
|
|
|
|
//! Return the current envelope \e state (ATTACK, DECAY, SUSTAIN, RELEASE, DONE).
|
|
int getState(void) const;
|
|
|
|
//! Set to state = ADSR::SUSTAIN with current and target values of \e aValue.
|
|
void setValue(StkFloat value);
|
|
|
|
//! Return one envelope output value.
|
|
StkFloat tick(void);
|
|
|
|
//! Compute \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 );
|
|
|
|
protected:
|
|
StkFloat attackRate_;
|
|
StkFloat decayRate_;
|
|
StkFloat sustainLevel_;
|
|
StkFloat releaseRate_;
|
|
};
|
|
|
|
#endif
|