The Synthesis ToolKit in C++ (STK)

Home Information Classes Download Usage Mail List Requirements Links FAQ Tutorial

Flute.h
1#ifndef STK_FLUTE_H
2#define STK_FLUTE_H
3
4#include "Instrmnt.h"
5#include "JetTable.h"
6#include "DelayL.h"
7#include "OnePole.h"
8#include "PoleZero.h"
9#include "Noise.h"
10#include "ADSR.h"
11#include "SineWave.h"
12
13namespace stk {
14
15/***************************************************/
37/***************************************************/
38
39 class Flute : public Instrmnt
40{
41 public:
43
46 Flute( StkFloat lowestFrequency );
47
49 ~Flute( void );
50
52 void clear( void );
53
55 void setFrequency( StkFloat frequency );
56
58 void setJetReflection( StkFloat coefficient ) { jetReflection_ = coefficient; };
59
61 void setEndReflection( StkFloat coefficient ) { endReflection_ = coefficient; };
62
64 void setJetDelay( StkFloat aRatio );
65
67 void startBlowing( StkFloat amplitude, StkFloat rate );
68
70 void stopBlowing( StkFloat rate );
71
73 void noteOn( StkFloat frequency, StkFloat amplitude );
74
76 void noteOff( StkFloat amplitude );
77
79 void controlChange( int number, StkFloat value );
80
82 StkFloat tick( unsigned int channel = 0 );
83
85
92 StkFrames& tick( StkFrames& frames, unsigned int channel = 0 );
93
94 protected:
95
96 DelayL jetDelay_;
97 DelayL boreDelay_;
98 JetTable jetTable_;
99 OnePole filter_;
100 PoleZero dcBlock_;
101 Noise noise_;
102 ADSR adsr_;
103 SineWave vibrato_;
104
105 StkFloat lastFrequency_;
106 StkFloat maxPressure_;
107 StkFloat jetReflection_;
108 StkFloat endReflection_;
109 StkFloat noiseGain_;
110 StkFloat vibratoGain_;
111 StkFloat outputGain_;
112 StkFloat jetRatio_;
113
114};
115
116 inline StkFloat Flute :: tick( unsigned int )
117{
118 StkFloat pressureDiff;
119 StkFloat breathPressure;
120
121 // Calculate the breath pressure (envelope + noise + vibrato)
122 breathPressure = maxPressure_ * adsr_.tick();
123 breathPressure += breathPressure * ( noiseGain_ * noise_.tick() + vibratoGain_ * vibrato_.tick() );
124
125 StkFloat temp = -filter_.tick( boreDelay_.lastOut() );
126 //temp = dcBlock_.tick( temp ); // Block DC on reflection.
127
128 pressureDiff = breathPressure - (jetReflection_ * temp);
129 pressureDiff = jetDelay_.tick( pressureDiff );
130 //pressureDiff = jetTable_.tick( pressureDiff ) + (endReflection_ * temp);
131 pressureDiff = dcBlock_.tick(jetTable_.tick( pressureDiff )) + (endReflection_ * temp); // moved the DC blocker to after the jet non-linearity (GPS, 29 Jan. 2020)
132 lastFrame_[0] = (StkFloat) 0.3 * boreDelay_.tick( pressureDiff );
133
134 lastFrame_[0] *= outputGain_;
135 return lastFrame_[0];
136}
137
138 inline StkFrames& Flute :: tick( StkFrames& frames, unsigned int channel )
139{
140 unsigned int nChannels = lastFrame_.channels();
141#if defined(_STK_DEBUG_)
142 if ( channel > frames.channels() - nChannels ) {
143 oStream_ << "Flute::tick(): channel and StkFrames arguments are incompatible!";
144 handleError( StkError::FUNCTION_ARGUMENT );
145 }
146#endif
147
148 StkFloat *samples = &frames[channel];
149 unsigned int j, hop = frames.channels() - nChannels;
150 if ( nChannels == 1 ) {
151 for ( unsigned int i=0; i<frames.frames(); i++, samples += hop )
152 *samples++ = tick();
153 }
154 else {
155 for ( unsigned int i=0; i<frames.frames(); i++, samples += hop ) {
156 *samples++ = tick();
157 for ( j=1; j<nChannels; j++ )
158 *samples++ = lastFrame_[j];
159 }
160 }
161
162 return frames;
163}
164
165} // stk namespace
166
167#endif
stk::ADSR
STK ADSR envelope class.
Definition ADSR.h:25
stk::DelayL
STK linear interpolating delay line class.
Definition DelayL.h:28
stk::Flute::setJetReflection
void setJetReflection(StkFloat coefficient)
Set the reflection coefficient for the jet delay (-1.0 - 1.0).
Definition Flute.h:58
stk::Flute::startBlowing
void startBlowing(StkFloat amplitude, StkFloat rate)
Apply breath velocity to instrument with given amplitude and rate of increase.
stk::Flute::clear
void clear(void)
Reset and clear all internal state.
stk::Flute::stopBlowing
void stopBlowing(StkFloat rate)
Decrease breath velocity with given rate of decrease.
stk::Flute::~Flute
~Flute(void)
Class destructor.
stk::Flute::setEndReflection
void setEndReflection(StkFloat coefficient)
Set the reflection coefficient for the air column delay (-1.0 - 1.0).
Definition Flute.h:61
stk::Flute::controlChange
void controlChange(int number, StkFloat value)
Perform the control change specified by number and value (0.0 - 128.0).
stk::Flute::Flute
Flute(StkFloat lowestFrequency)
Class constructor, taking the lowest desired playing frequency.
stk::Flute::tick
StkFloat tick(unsigned int channel=0)
Compute and return one output sample.
Definition Flute.h:116
stk::Flute::setJetDelay
void setJetDelay(StkFloat aRatio)
Set the length of the jet delay in terms of a ratio of jet delay to air column delay lengths.
stk::Flute::noteOff
void noteOff(StkFloat amplitude)
Stop a note with the given amplitude (speed of decay).
stk::Flute::setFrequency
void setFrequency(StkFloat frequency)
Set instrument parameters for a particular frequency.
stk::Flute::noteOn
void noteOn(StkFloat frequency, StkFloat amplitude)
Start a note with the given frequency and amplitude.
stk::Instrmnt::Instrmnt
Instrmnt(void)
Class constructor.
Definition Instrmnt.h:23
stk::JetTable
STK jet table class.
Definition JetTable.h:24
stk::Noise
STK noise generator.
Definition Noise.h:22
stk::OnePole
STK one-pole filter class.
Definition OnePole.h:21
stk::PoleZero
STK one-pole, one-zero filter class.
Definition PoleZero.h:22
stk::SineWave
STK sinusoid oscillator class.
Definition SineWave.h:26
stk::SineWave::tick
StkFloat tick(void)
Compute and return one output sample.
Definition SineWave.h:99
stk::StkFrames
An STK class to handle vectorized audio data.
Definition Stk.h:279
stk::StkFrames::channels
unsigned int channels(void) const
Return the number of channels represented by the data.
Definition Stk.h:416
stk::StkFrames::frames
unsigned int frames(void) const
Return the number of sample frames represented by the data.
Definition Stk.h:419
stk::Stk::handleError
static void handleError(const char *message, StkError::Type type)
Static function for error reporting and handling using c-strings.
stk
The STK namespace.
Definition ADSR.h:6

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