The Synthesis ToolKit in C++ (STK)

Home Information Classes Download Usage Mail List Requirements Links FAQ Tutorial

# stk::TubeBell Class Reference

STK tubular bell (orchestral chime) FM synthesis instrument. More...

`#include <TubeBell.h>`

Inheritance diagram for stk::TubeBell:

List of all members.

## Public Member Functions
| TubeBell (void)
| Class constructor.
| ~TubeBell (void)
| Class destructor.
void | noteOn (StkFloat frequency, StkFloat amplitude)
| Start a note with the given frequency and amplitude.
StkFloat | tick (unsigned int channel=0)
| Compute and return one output sample.
StkFrames & | tick (StkFrames &frames, unsigned int channel=0)
| Fill a channel of the StkFrames object with computed outputs.

## Detailed Description

STK tubular bell (orchestral chime) FM synthesis instrument.

This class implements two simple FM Pairs summed together, also referred to as algorithm 5 of the TX81Z.

        Algorithm 5 is :  4->3--\
                                 + --> Out
                          2->1--/

Control Change Numbers:

- Modulator Index One = 2
- Crossfade of Outputs = 4
- LFO Speed = 11
- LFO Depth = 1
- ADSR 2 & 4 Target = 128

The basic Chowning/Stanford FM patent expired in 1995, but there exist follow-on patents, mostly assigned to Yamaha. If you are of the type who should worry about this (making money) worry away.

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

## Constructor & Destructor Documentation

stk::TubeBell::TubeBell | ( | void |  | ) |

Class constructor.

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

## Member Function Documentation

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

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

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

- TubeBell.h

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