STK instrument abstract base class.
More...
#include <Instrmnt.h>
Inheritance diagram for stk::Instrmnt:
Class constructor.
virtual void
clear (void)
Reset and clear all internal state (for subclasses).
virtual void
noteOn (StkFloat frequency, StkFloat amplitude)=0
Start a note with the given frequency and amplitude.
virtual void
noteOff (StkFloat amplitude)=0
Stop a note with the given amplitude (speed of decay).
virtual void
setFrequency (StkFloat frequency)
Set instrument parameters for a particular frequency.
virtual void
controlChange (int number, StkFloat value)
Perform the control change specified by number and value (0.0 - 128.0).
unsigned int
channelsOut (void) const
Return the number of output channels for the class.
Return an
StkFrames reference to the last output sample frame.
StkFloat
lastOut (unsigned int channel=0)
Return the specified channel value of the last computed frame.
virtual StkFloat
tick (unsigned int channel=0)=0
Compute one sample frame and return the specified channel value.
Fill the
StkFrames object with computed sample frames, starting at the specified channel.
- Public Member Functions inherited from
stk::Stk A function to enable/disable the automatic updating of class data when the STK sample rate changes.
Additional Inherited Members
- Static Public Member Functions inherited from
stk::Stk
static StkFloat sampleRate (void)
Static method that returns the current STK sample 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.
- Static Public Attributes inherited from
stk::Stk
- Protected Member Functions inherited from
stk::Stk
Stk (void)
Default constructor.
virtual ~Stk (void)
Class destructor.
virtual void sampleRateChanged (StkFloat newRate, StkFloat oldRate)
This function should be implemented in subclasses that depend on the sample rate.
void
addSampleRateAlert (
Stk *ptr)
Add class pointer to list for sample rate change notification.
void
removeSampleRateAlert (
Stk *ptr)
Remove class pointer from list for sample rate change notification.
void handleError (StkError::Type type) const
Internal function for error reporting that assumes message in oStream_ variable.
Detailed Description
STK instrument abstract base class.
This class provides a common interface for all STK instruments.
by Perry R. Cook and Gary P. Scavone, 1995–2023.
Member Function Documentation
◆ clear()
virtual void stk::Instrmnt::clear
(
void
)
inlinevirtual
Reset and clear all internal state (for subclasses).
Not all subclasses implement a clear() function.
Reimplemented in stk::Brass, stk::BandedWG, stk::BlowBotl, stk::BlowHole, stk::Bowed, stk::Clarinet, stk::Flute, stk::Mandolin, stk::Mesh2D, stk::Modal, stk::Plucked, stk::Recorder, stk::Saxofony, stk::Sitar, stk::StifKarp, stk::VoicForm, and stk::Whistle.
◆ lastOut()
StkFloat stk::Instrmnt::lastOut
(
unsigned int
channel = 0 )
inline
Return the specified channel value of the last computed frame.
The channel argument must be less than the number of output channels, which can be determined with the channelsOut() function (the first channel is specified by 0). However, range checking is only performed if STK_DEBUG is defined during compilation, in which case an out-of-range value will trigger an StkError exception.
- See also
- lastFrame()
89{
90#if defined(_STK_DEBUG_)
91 if ( channel >= lastFrame_.
channels() ) {
92 oStream_ << "Instrmnt::lastOut(): channel argument is invalid!";
94 }
95#endif
96
97 return lastFrame_[channel];
98}
unsigned int channels(void) const
Return the number of channels represented by the data.
Definition Stk.h:416
static void handleError(const char *message, StkError::Type type)
Static function for error reporting and handling using c-strings.
◆ tick() [1/2]
virtual StkFloat stk::Instrmnt::tick
(
unsigned int
channel = 0 )
pure virtual
Compute one sample frame and return the specified channel value.
For monophonic instruments, the channel argument is ignored.
Implemented in stk::BandedWG, stk::BeeThree, stk::BlowBotl, stk::BlowHole, stk::Bowed, stk::Brass, stk::Clarinet, stk::Drummer, stk::Flute, stk::FMVoices, stk::HevyMetl, stk::Mandolin, stk::Mesh2D, stk::Modal, stk::Moog, stk::PercFlut, stk::Plucked, stk::Recorder, stk::Resonate, stk::Rhodey, stk::Saxofony, stk::Shakers, stk::Simple, stk::Sitar, stk::StifKarp, stk::TubeBell, stk::VoicForm, stk::Whistle, stk::Wurley, stk::Sampler, and stk::FM.
◆ tick() [2/2]
unsigned int
channel = 0
)
pure virtual
Fill the StkFrames object with computed sample frames, starting at the specified channel.
The channel argument plus the number of output channels must be less than the number of channels in the StkFrames argument (the first channel is specified by 0). However, range checking is only performed if STK_DEBUG is defined during compilation, in which case an out-of-range value will trigger an StkError exception.
Implemented in stk::BandedWG, stk::BeeThree, stk::BlowBotl, stk::BlowHole, stk::Bowed, stk::Brass, stk::Clarinet, stk::Drummer, stk::Flute, stk::FMVoices, stk::HevyMetl, stk::Mandolin, stk::Mesh2D, stk::Modal, stk::Moog, stk::PercFlut, stk::Plucked, stk::Recorder, stk::Resonate, stk::Rhodey, stk::Saxofony, stk::Shakers, stk::Simple, stk::Sitar, stk::StifKarp, stk::TubeBell, stk::VoicForm, stk::Whistle, stk::Wurley, stk::FM, and stk::Sampler.
The documentation for this class was generated from the following file:
©1995--2023 Perry R. Cook and Gary P. Scavone. All Rights Reserved.