Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial


Public Member Functions | List of all members
stk::Modal Class Referenceabstract

STK resonance model abstract base class. More...

#include <Modal.h>

Inheritance diagram for stk::Modal:
stk::Instrmnt stk::Stk stk::ModalBar

Public Member Functions

 Modal (unsigned int modes=4)
 Class constructor, taking the desired number of modes to create. More...
 
virtual ~Modal (void)
 Class destructor.
 
void clear (void)
 Reset and clear all internal state.
 
virtual void setFrequency (StkFloat frequency)
 Set instrument parameters for a particular frequency.
 
void setRatioAndRadius (unsigned int modeIndex, StkFloat ratio, StkFloat radius)
 Set the ratio and radius for a specified mode filter.
 
void setMasterGain (StkFloat aGain)
 Set the master gain.
 
void setDirectGain (StkFloat aGain)
 Set the direct gain.
 
void setModeGain (unsigned int modeIndex, StkFloat gain)
 Set the gain for a specified mode filter.
 
virtual void strike (StkFloat amplitude)
 Initiate a strike with the given amplitude (0.0 - 1.0).
 
void damp (StkFloat amplitude)
 Damp modes with a given decay factor (0.0 - 1.0).
 
void noteOn (StkFloat frequency, StkFloat amplitude)
 Start a note with the given frequency and amplitude.
 
void noteOff (StkFloat amplitude)
 Stop a note with the given amplitude (speed of decay).
 
virtual void controlChange (int number, StkFloat value)=0
 Perform the control change specified by number and value (0.0 - 128.0).
 
StkFloat tick (unsigned int channel=0)
 Compute and return one output sample.
 
StkFramestick (StkFrames &frames, unsigned int channel=0)
 Fill a channel of the StkFrames object with computed outputs. More...
 
- Public Member Functions inherited from stk::Instrmnt
 Instrmnt (void)
 Class constructor.
 
unsigned int channelsOut (void) const
 Return the number of output channels for the class.
 
const StkFrameslastFrame (void) const
 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. More...
 
- Public Member Functions inherited from stk::Stk
void ignoreSampleRateChange (bool ignore=true)
 A function to enable/disable the automatic updating of class data when the STK sample rate changes. More...
 

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 void setSampleRate (StkFloat rate)
 Static method that sets the STK sample rate. More...
 
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
static const StkFormat STK_SINT8
 
static const StkFormat STK_SINT16
 
static const StkFormat STK_SINT24
 
static const StkFormat STK_SINT32
 
static const StkFormat STK_FLOAT32
 
static const StkFormat STK_FLOAT64
 
- 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 resonance model abstract base class.

This class contains an excitation wavetable, an envelope, an oscillator, and N resonances (non-sweeping BiQuad filters), where N is set during instantiation.

by Perry R. Cook and Gary P. Scavone, 1995–2014.

Constructor & Destructor Documentation

stk::Modal::Modal ( unsigned int  modes = 4)

Class constructor, taking the desired number of modes to create.

An StkError will be thrown if the rawwave path is incorrectly set.

Member Function Documentation

StkFrames & stk::Modal::tick ( StkFrames frames,
unsigned int  channel = 0 
)
inlinevirtual

Fill a channel of the StkFrames object with computed outputs.

The channel argument 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.

Implements stk::Instrmnt.

126 {
127  unsigned int nChannels = lastFrame_.channels();
128 #if defined(_STK_DEBUG_)
129  if ( channel > frames.channels() - nChannels ) {
130  oStream_ << "Modal::tick(): channel and StkFrames arguments are incompatible!";
131  handleError( StkError::FUNCTION_ARGUMENT );
132  }
133 #endif
134 
135  StkFloat *samples = &frames[channel];
136  unsigned int j, hop = frames.channels() - nChannels;
137  if ( nChannels == 1 ) {
138  for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
139  *samples++ = tick();
140  }
141  else {
142  for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
143  *samples++ = tick();
144  for ( j=1; j<nChannels; j++ )
145  *samples++ = lastFrame_[j];
146  }
147  }
148 
149  return frames;
150 }

The documentation for this class was generated from the following file:

The Synthesis ToolKit in C++ (STK)
©1995--2014 Perry R. Cook and Gary P. Scavone. All Rights Reserved.