Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial

stk::Simple Class Reference

STK wavetable/noise instrument. More...

#include <Simple.h>

Inheritance diagram for stk::Simple:
stk::Instrmnt stk::Stk

List of all members.

Public Member Functions

 Simple (void)
 Class constructor.
 ~Simple (void)
 Class destructor.
void clear (void)
 Clear internal states.
void setFrequency (StkFloat frequency)
 Set instrument parameters for a particular frequency.
void keyOn (void)
 Start envelope toward "on" target.
void keyOff (void)
 Start envelope toward "off" target.
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).
void controlChange (int number, StkFloat value)
 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.

Detailed Description

STK wavetable/noise instrument.

This class combines a looped wave, a noise source, a biquad resonance filter, a one-pole filter, and an ADSR envelope to create some interesting sounds.

Control Change Numbers:

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

Constructor & Destructor Documentation

stk::Simple::Simple ( void   ) 

Class constructor.

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

Member Function Documentation

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

00101 {
00102   unsigned int nChannels = lastFrame_.channels();
00103 #if defined(_STK_DEBUG_)
00104   if ( channel > frames.channels() - nChannels ) {
00105     oStream_ << "Simple::tick(): channel and StkFrames arguments are incompatible!";
00106     handleError( StkError::FUNCTION_ARGUMENT );
00107   }
00108 #endif
00110   StkFloat *samples = &frames[channel];
00111   unsigned int j, hop = frames.channels() - nChannels;
00112   if ( nChannels == 1 ) {
00113     for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
00114       *samples++ = tick();
00115   }
00116   else {
00117     for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
00118       *samples++ = tick();
00119       for ( j=1; j<nChannels; j++ )
00120         *samples++ = lastFrame_[j];
00121     }
00122   }
00124   return frames;
00125 }

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.