|
|
| ADSR (void) |
| | Default constructor.
|
|
| ~ADSR (void) |
| | Class destructor.
|
|
void | keyOn (void) |
| | Set target = 1, state = ADSR::ATTACK.
|
|
void | keyOff (void) |
| | Set target = 0, state = ADSR::RELEASE.
|
|
void | setAttackRate (StkFloat rate) |
| | Set the attack rate (gain / sample).
|
|
void | setAttackTarget (StkFloat target) |
| | Set the target value for the attack (default = 1.0).
|
|
void | setDecayRate (StkFloat rate) |
| | Set the decay rate (gain / sample).
|
|
void | setSustainLevel (StkFloat level) |
| | Set the sustain level.
|
|
void | setReleaseRate (StkFloat rate) |
| | Set the release rate (gain / sample).
|
|
void | setAttackTime (StkFloat time) |
| | Set the attack rate based on a time duration (seconds).
|
|
void | setDecayTime (StkFloat time) |
| | Set the decay rate based on a time duration (seconds).
|
|
void | setReleaseTime (StkFloat time) |
| | Set the release rate based on a time duration (seconds).
|
|
void | setAllTimes (StkFloat aTime, StkFloat dTime, StkFloat sLevel, StkFloat rTime) |
| | Set sustain level and attack, decay, and release time durations (seconds).
|
|
void | setTarget (StkFloat target) |
| | Set a sustain target value and attack or decay from current value to target.
|
|
int | getState (void) const |
| | Return the current envelope state (ATTACK, DECAY, SUSTAIN, RELEASE, IDLE).
|
|
void | setValue (StkFloat value) |
| | Set to state = ADSR::SUSTAIN with current and target values of value.
|
|
StkFloat | lastOut (void) const |
| | Return the last computed output value.
|
|
StkFloat | tick (void) |
| | Compute and return one output sample.
|
| StkFrames & | tick (StkFrames &frames, unsigned int channel=0) |
| | Fill a channel of the StkFrames object with computed outputs.
|
|
unsigned int | channelsOut (void) const |
| | Return the number of output channels for the class.
|
|
const StkFrames & | lastFrame (void) const |
| | Return an StkFrames reference to the last output sample frame.
|
| void | ignoreSampleRateChange (bool ignore=true) |
| | A function to enable/disable the automatic updating of class data when the STK sample rate changes.
|
|
|
static StkFloat | sampleRate (void) |
| | Static method that returns the current STK sample rate.
|
| static void | setSampleRate (StkFloat rate) |
| | Static method that sets the STK sample rate.
|
|
static void | clear_alertList () |
| | Static method that frees memory from alertList_.
|
|
static std::string | rawwavePath (void) |
| | Static method that returns the current rawwave path.
|
|
static void | setRawwavePath (std::string path) |
| | Static method that sets the STK rawwave path.
|
|
static void | swap16 (unsigned char *ptr) |
| | Static method that byte-swaps a 16-bit data type.
|
|
static void | swap32 (unsigned char *ptr) |
| | Static method that byte-swaps a 32-bit data type.
|
|
static void | swap64 (unsigned char *ptr) |
| | Static method that byte-swaps a 64-bit data type.
|
|
static void | sleep (unsigned long milliseconds) |
| | Static cross-platform method to sleep for a number of milliseconds.
|
|
static bool | inRange (StkFloat value, StkFloat min, StkFloat max) |
| | Static method to check whether a value is within a specified range.
|
|
static void | handleError (const char *message, StkError::Type type) |
| | Static function for error reporting and handling using c-strings.
|
|
static void | handleError (std::string message, StkError::Type type) |
| | Static function for error reporting and handling using c++ strings.
|
|
static void | showWarnings (bool status) |
| | Toggle display of WARNING and STATUS messages.
|
|
static void | printErrors (bool status) |
| | Toggle display of error messages before throwing exceptions.
|
STK ADSR envelope class.
This class implements a traditional ADSR (Attack, Decay, Sustain, Release) envelope. It responds to simple keyOn and keyOff messages, keeping track of its state. The state = ADSR::IDLE before being triggered and after the envelope value reaches 0.0 in the ADSR::RELEASE state. All rate, target and level settings must be non-negative. All time settings are in seconds and must be positive.
by Perry R. Cook and Gary P. Scavone, 1995–2019.
| void stk::Stk::setSampleRate |
( |
StkFloat | rate | ) |
|
|
staticinherited |
Static method that sets the STK sample rate.
The sample rate set using this method is queried by all STK classes that depend on its value. It is initialized to the default SRATE set in Stk.h. Many STK classes use the sample rate during instantiation. Therefore, if you wish to use a rate that is different from the default rate, it is imperative that it be set BEFORE STK objects are instantiated. A few classes that make use of the global STK sample rate are automatically notified when the rate changes so that internal class data can be appropriately updated. However, this has not been fully implemented. Specifically, classes that appropriately update their own data when either a setFrequency() or noteOn() function is called do not currently receive the automatic notification of rate change. If the user wants a specific class instance to ignore such notifications, perhaps in a multi-rate context, the function Stk::ignoreSampleRateChange() should be called.