Arduino STK 4.6.2
stk::SineWave Class Reference

STK sinusoid oscillator class. More...

#include <SineWave.h>

Inheritance diagram for stk::SineWave:
stk::Generator stk::Stk

Public Member Functions

 SineWave (void)
 Default constructor.
 ~SineWave (void)
 Class destructor.
void reset (void)
 Clear output and reset time pointer to zero.
void setRate (StkFloat rate)
 Set the data read rate in samples. The rate can be negative.
void setFrequency (StkFloat frequency)
 Set the data interpolation rate based on a looping frequency.
void addTime (StkFloat time)
 Increment the read pointer by time in samples, modulo the table size.
void addPhase (StkFloat phase)
 Increment the read pointer by a normalized phase value.
void addPhaseOffset (StkFloat phaseOffset)
 Add a normalized phase offset to the read pointer.
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 Public Member Functions

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.

Static Public Attributes

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

void handleError (StkError::Type type) const
 Internal function for error reporting that assumes message in oStream_ variable.
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.

Detailed Description

STK sinusoid oscillator class.

This class computes and saves a static sine "table" that can be shared by multiple instances. It has an interface similar to the WaveLoop class but inherits from the Generator class. Output values are computed using linear interpolation.

The "table" length, set in SineWave.h, is 2048 samples by default.

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

Member Function Documentation

◆ setRate()

void stk::SineWave::setRate ( StkFloat rate)
inline

Set the data read rate in samples. The rate can be negative.

If the rate value is negative, the data is read in reverse order.

41{ rate_ = rate; };

◆ setFrequency()

void stk::SineWave::setFrequency ( StkFloat frequency)

Set the data interpolation rate based on a looping frequency.

This function determines the interpolation rate based on the file size and the current Stk::sampleRate. The frequency value corresponds to file cycles per second. The frequency can be negative, in which case the loop is read in reverse order.

◆ addPhase()

void stk::SineWave::addPhase ( StkFloat phase)

Increment the read pointer by a normalized phase value.

This function increments the read pointer by a normalized phase value, such that phase = 1.0 corresponds to a 360 degree phase shift. Positive or negative values are possible.

◆ addPhaseOffset()

void stk::SineWave::addPhaseOffset ( StkFloat phaseOffset)

Add a normalized phase offset to the read pointer.

A phaseOffset = 1.0 corresponds to a 360 degree phase offset. Positive or negative values are possible.

◆ tick()

StkFrames & stk::SineWave::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::Generator.

124{
125#if defined(_STK_DEBUG_)
126 if ( channel >= frames.channels() ) {
127 oStream_ << "SineWave::tick(): channel and StkFrames arguments are incompatible!";
128 handleError( StkError::FUNCTION_ARGUMENT );
129 }
130#endif
131
132 StkFloat *samples = &frames[channel];
133 StkFloat tmp = 0.0;
134
135 unsigned int hop = frames.channels();
136 for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
137
138 // Check limits of time address ... if necessary, recalculate modulo
139 // TABLE_SIZE.
140 while ( time_ < 0.0f )
141 time_ += TABLE_SIZE;
142 while ( time_ >= TABLE_SIZE )
143 time_ -= TABLE_SIZE;
144
145 iIndex_ = (unsigned int) time_;
146 alpha_ = time_ - iIndex_;
147 tmp = table_[ iIndex_ ];
148 tmp += ( alpha_ * ( table_[ iIndex_ + 1 ] - tmp ) );
149 *samples = tmp;
150
151 // Increment time, which can be negative.
152 time_ += rate_;
153 }
154
155 lastFrame_[0] = tmp;
156 return frames;
157}
static void handleError(const char *message, StkError::Type type)
Static function for error reporting and handling using c-strings.

◆ setSampleRate()

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.

◆ ignoreSampleRateChange()

void stk::Stk::ignoreSampleRateChange ( bool ignore = true)
inlineinherited

A function to enable/disable the automatic updating of class data when the STK sample rate changes.

This function allows the user to enable or disable class data updates in response to global sample rate changes on a class by class basis.

184{ ignoreSampleRateChange_ = ignore; };

Member Data Documentation

◆ STK_SINT8

const StkFormat stk::Stk::STK_SINT8
staticinherited

-128 to +127

◆ STK_SINT16

const StkFormat stk::Stk::STK_SINT16
staticinherited

-32768 to +32767

◆ STK_SINT24

const StkFormat stk::Stk::STK_SINT24
staticinherited

Lower 3 bytes of 32-bit signed integer.

◆ STK_SINT32

const StkFormat stk::Stk::STK_SINT32
staticinherited

-2147483648 to +2147483647.

◆ STK_FLOAT32

const StkFormat stk::Stk::STK_FLOAT32
staticinherited

Normalized between plus/minus 1.0.

◆ STK_FLOAT64

const StkFormat stk::Stk::STK_FLOAT64
staticinherited

Normalized between plus/minus 1.0.


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