Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   Tutorial

StifKarp Class Reference

#include <StifKarp.h>

Inheritance diagram for StifKarp:

Instrmnt Stk List of all members.

Detailed Description

STK plucked stiff string instrument.

This class implements a simple plucked string algorithm (Karplus Strong) with enhancements (Jaffe-Smith, Smith, and others), including string stiffness and pluck position controls. The stiffness is modeled with allpass filters.

This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.

Control Change Numbers:

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

Definition at line 34 of file StifKarp.h.

Public Member Functions

 StifKarp (StkFloat lowestFrequency)
 Class constructor, taking the lowest desired playing frequency.

 ~StifKarp ()
 Class destructor.

void clear ()
 Reset and clear all internal state.

void setFrequency (StkFloat frequency)
 Set instrument parameters for a particular frequency.

void setStretch (StkFloat stretch)
 Set the stretch "factor" of the string (0.0 - 1.0).

void setPickupPosition (StkFloat position)
 Set the pluck or "excitation" position along the string (0.0 - 1.0).

void setBaseLoopGain (StkFloat aGain)
 Set the base loop gain.

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 ()
 Compute one output sample.

StkFloat * tick (StkFloat *vector, unsigned int vectorSize)
 Computer vectorSize outputs and return them in vector.

StkFrames & tick (StkFrames &frames, unsigned int channel=1)
 Fill a channel of the StkFrames object with computed outputs.

void controlChange (int number, StkFloat value)
 Perform the control change specified by number and value (0.0 - 128.0).

Member Function Documentation

void StifKarp::setBaseLoopGain (  StkFloat  aGain  ) 
 

Set the base loop gain.

The actual loop gain is set according to the frequency. Because of high-frequency loop filter roll-off, higher frequency settings have greater loop gains.

StkFrames& StifKarp::tick (  StkFrames &  frames,
unsigned int  channel = 1
)  [virtual]
 

Fill a channel of the StkFrames object with computed outputs.

The channel argument should be one or greater (the first channel is specified by 1). An StkError will be thrown if the channel argument is zero or it is greater than the number of channels in the StkFrames object.

Reimplemented from Instrmnt.

The documentation for this class was generated from the following file:
The Synthesis ToolKit in C++ (STK)
©1995-2004 Perry R. Cook and Gary P. Scavone. All Rights Reserved.