The Synthesis ToolKit in C++ (STK)

Home Information Classes Download Usage Mail List Requirements Links FAQ Tutorial

# stk::BlowHole Class Reference

STK clarinet physical model with one register hole and one tonehole. More...

`#include <BlowHole.h>`

Inheritance diagram for stk::BlowHole:

List of all members.

## Public Member Functions
| BlowHole (StkFloat lowestFrequency)
| Class constructor.
| ~BlowHole (void)
| Class destructor.
void | clear (void)
| Reset and clear all internal state.
void | setFrequency (StkFloat frequency)
| Set instrument parameters for a particular frequency.
void | setTonehole (StkFloat newValue)
| Set the tonehole state (0.0 = closed, 1.0 = fully open).
void | setVent (StkFloat newValue)
| Set the register hole state (0.0 = closed, 1.0 = fully open).
void | startBlowing (StkFloat amplitude, StkFloat rate)
| Apply breath pressure to instrument with given amplitude and rate of increase.
void | stopBlowing (StkFloat rate)
| Decrease breath pressure with given rate of decrease.
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.
StkFrames & | tick (StkFrames &frames, unsigned int channel=0)
| Fill a channel of the StkFrames object with computed outputs.

## Detailed Description

STK clarinet physical model with one register hole and one tonehole.

This class is based on the clarinet model, with the addition of a two-port register hole and a three-port dynamic tonehole implementation, as discussed by Scavone and Cook (1998).

In this implementation, the distances between the reed/register hole and tonehole/bell are fixed. As a result, both the tonehole and register hole will have variable influence on the playing frequency, which is dependent on the length of the air column. In addition, the highest playing freqeuency is limited by these fixed lengths.

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

Control Change Numbers:

- Reed Stiffness = 2
- Noise Gain = 4
- Tonehole State = 11
- Register State = 1
- Breath Pressure = 128

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

## Constructor & Destructor Documentation

stk::BlowHole::BlowHole | ( | StkFloat | lowestFrequency | ) |

Class constructor.

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

## Member Function Documentation

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

    00157 {
    00158   unsigned int nChannels = lastFrame_.channels();
    00159 #if defined(_STK_DEBUG_)
    00160   if ( channel > frames.channels() - nChannels ) {
    00161     oStream_ << "BlowHole::tick(): channel and StkFrames arguments are incompatible!";
    00162     handleError( StkError::FUNCTION_ARGUMENT );
    00163   }
    00164 #endif
    00165
    00166   StkFloat *samples = &frames[channel];
    00167   unsigned int j, hop = frames.channels() - nChannels;
    00168   if ( nChannels == 1 ) {
    00169     for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
    00170       *samples++ = tick();
    00171   }
    00172   else {
    00173     for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
    00174       *samples++ = tick();
    00175       for ( j=1; j<nChannels; j++ )
    00176         *samples++ = lastFrame_[j];
    00177     }
    00178   }
    00179
    00180   return frames;
    00181 }

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

- BlowHole.h

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