|
| OneZero (StkFloat theZero=-1.0) |
| The default constructor creates a low-pass filter (zero at z = -1.0).
|
|
| ~OneZero () |
| Class destructor.
|
|
void | setB0 (StkFloat b0) |
| Set the b[0] coefficient value.
|
|
void | setB1 (StkFloat b1) |
| Set the b[1] coefficient value.
|
|
void | setCoefficients (StkFloat b0, StkFloat b1, bool clearState=false) |
| Set all filter coefficients.
|
|
void | setZero (StkFloat theZero) |
| Set the zero position in the z-plane. More...
|
|
StkFloat | lastOut (void) const |
| Return the last computed output value.
|
|
StkFloat | tick (StkFloat input) |
| Input one sample to the filter and return one output.
|
|
StkFrames & | tick (StkFrames &frames, unsigned int channel=0) |
| Take a channel of the StkFrames object as inputs to the filter and replace with corresponding outputs. More...
|
|
StkFrames & | tick (StkFrames &iFrames, StkFrames &oFrames, unsigned int iChannel=0, unsigned int oChannel=0) |
| Take a channel of the iFrames object as inputs to the filter and write outputs to the oFrames object. More...
|
|
unsigned int | channelsIn (void) const |
| Return the number of input channels for the class.
|
|
unsigned int | channelsOut (void) const |
| Return the number of output channels for the class.
|
|
virtual void | clear (void) |
| Clears all internal states of the filter.
|
|
void | setGain (StkFloat gain) |
| Set the filter gain. More...
|
|
StkFloat | getGain (void) const |
| Return the current filter gain.
|
|
StkFloat | phaseDelay (StkFloat frequency) |
| Return the filter phase delay at the specified frequency. More...
|
|
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. More...
|
|
|
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. More...
|
|
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 one-zero filter class.
This class implements a one-zero digital filter. A method is provided for setting the zero position along the real axis of the z-plane while maintaining a constant filter gain.
by Perry R. Cook and Gary P. Scavone, 1995–2019.
static 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.