Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial


Public Member Functions | List of all members
stk::BowTable Class Reference

STK bowed string table class. More...

#include <BowTable.h>

Inheritance diagram for stk::BowTable:
stk::Function stk::Stk

Public Member Functions

 BowTable (void)
 Default constructor.
 
void setOffset (StkFloat offset)
 Set the table offset value. More...
 
void setSlope (StkFloat slope)
 Set the table slope value. More...
 
void setMinOutput (StkFloat minimum)
 Set the minimum table output value (0.0 - 1.0).
 
void setMaxOutput (StkFloat maximum)
 Set the maximum table output value (0.0 - 1.0).
 
StkFloat tick (StkFloat input)
 Take one sample input and map to one sample of output.
 
StkFramestick (StkFrames &frames, unsigned int channel=0)
 Take a channel of the StkFrames object as inputs to the table and replace with corresponding outputs. More...
 
StkFramestick (StkFrames &iFrames, StkFrames &oFrames, unsigned int iChannel=0, unsigned int oChannel=0)
 Take a channel of the iFrames object as inputs to the table and write outputs to the oFrames object. More...
 
- Public Member Functions inherited from stk::Function
 Function (void)
 Class constructor.
 
StkFloat lastOut (void) const
 Return the last computed output sample.
 
- 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 bowed string table class.

This class implements a simple bowed string non-linear function, as described by Smith (1986). The output is an instantaneous reflection coefficient value.

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

Member Function Documentation

void stk::BowTable::setOffset ( StkFloat  offset)
inline

Set the table offset value.

The table offset is a bias which controls the symmetry of the friction. If you want the friction to vary with direction, use a non-zero value for the offset. The default value is zero.

35 { offset_ = offset; };
void stk::BowTable::setSlope ( StkFloat  slope)
inline

Set the table slope value.

The table slope controls the width of the friction pulse, which is related to bow force.

42 { slope_ = slope; };
StkFrames & stk::BowTable::tick ( StkFrames frames,
unsigned int  channel = 0 
)
inline

Take a channel of the StkFrames object as inputs to the table and replace with corresponding outputs.

The StkFrames argument reference is returned. 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.

102 {
103 #if defined(_STK_DEBUG_)
104  if ( channel >= frames.channels() ) {
105  oStream_ << "BowTable::tick(): channel and StkFrames arguments are incompatible!";
106  handleError( StkError::FUNCTION_ARGUMENT );
107  }
108 #endif
109 
110  StkFloat *samples = &frames[channel];
111  unsigned int hop = frames.channels();
112  for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
113  *samples = *samples + offset_;
114  *samples *= slope_;
115  *samples = (StkFloat) fabs( (double) *samples ) + 0.75;
116  *samples = (StkFloat) pow( *samples, (StkFloat) -4.0 );
117  if ( *samples > 1.0) *samples = 1.0;
118  }
119 
120  lastFrame_[0] = *(samples-hop);
121  return frames;
122 }
StkFrames & stk::BowTable::tick ( StkFrames iFrames,
StkFrames oFrames,
unsigned int  iChannel = 0,
unsigned int  oChannel = 0 
)
inline

Take a channel of the iFrames object as inputs to the table and write outputs to the oFrames object.

The iFrames object reference is returned. Each channel argument must be less than the number of channels in the corresponding 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.

125 {
126 #if defined(_STK_DEBUG_)
127  if ( iChannel >= iFrames.channels() || oChannel >= oFrames.channels() ) {
128  oStream_ << "BowTable::tick(): channel and StkFrames arguments are incompatible!";
129  handleError( StkError::FUNCTION_ARGUMENT );
130  }
131 #endif
132 
133  StkFloat *iSamples = &iFrames[iChannel];
134  StkFloat *oSamples = &oFrames[oChannel];
135  unsigned int iHop = iFrames.channels(), oHop = oFrames.channels();
136  for ( unsigned int i=0; i<iFrames.frames(); i++, iSamples += iHop, oSamples += oHop ) {
137  *oSamples = *iSamples + offset_;
138  *oSamples *= slope_;
139  *oSamples = (StkFloat) fabs( (double) *oSamples ) + 0.75;
140  *oSamples = (StkFloat) pow( *oSamples, (StkFloat) -4.0 );
141  if ( *oSamples > 1.0) *oSamples = 1.0;
142  }
143 
144  lastFrame_[0] = *(oSamples-oHop);
145  return iFrames;
146 }

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.