Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial


stk::Plucked Class Reference

STK basic plucked string class. More...

#include <Plucked.h>

Inheritance diagram for stk::Plucked:
stk::Instrmnt stk::Stk

List of all members.

Public Member Functions

 Plucked (StkFloat lowestFrequency=10.0)
 Class constructor, taking the lowest desired playing frequency.
 ~Plucked (void)
 Class destructor.
void clear (void)
 Reset and clear all internal state.
void setFrequency (StkFloat frequency)
 Set instrument parameters for a particular frequency.
void pluck (StkFloat amplitude)
 Pluck the string with the given amplitude using the current frequency.
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).
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.

Detailed Description

STK basic plucked string class.

This class implements a simple plucked string physical model based on the Karplus-Strong algorithm.

For a more advanced plucked string implementation, see the stk::Twang class.

This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others. There exist at least two patents, assigned to Stanford, bearing the names of Karplus and/or Strong.

by Perry R. Cook and Gary P. Scavone, 1995-2012.


Member Function Documentation

StkFrames & stk::Plucked::tick ( StkFrames frames,
unsigned int  channel = 0 
) [inline, virtual]

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.

00088 {
00089   unsigned int nChannels = lastFrame_.channels();
00090 #if defined(_STK_DEBUG_)
00091   if ( channel > frames.channels() - nChannels ) {
00092     oStream_ << "Plucked::tick(): channel and StkFrames arguments are incompatible!";
00093     handleError( StkError::FUNCTION_ARGUMENT );
00094   }
00095 #endif
00096 
00097   StkFloat *samples = &frames[channel];
00098   unsigned int j, hop = frames.channels() - nChannels;
00099   if ( nChannels == 1 ) {
00100     for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
00101       *samples++ = tick();
00102   }
00103   else {
00104     for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
00105       *samples++ = tick();
00106       for ( j=1; j<nChannels; j++ )
00107         *samples++ = lastFrame_[j];
00108     }
00109   }
00110 
00111   return frames;
00112 }


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

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