Home   Information   Classes   Download   Usage   Mail List   Requirements   Links   FAQ   Tutorial


Voicer Class Reference

#include <Voicer.h>

Inheritance diagram for Voicer:

Stk List of all members.

Detailed Description

STK voice manager class.

This class can be used to manage a group of STK instrument classes. Individual voices can be controlled via unique note tags. Instrument groups can be controlled by channel number.

A previously constructed STK instrument class is linked with a voice manager using the addInstrument() function. An optional channel number argument can be specified to the addInstrument() function as well (default channel = 0). The voice manager does not delete any instrument instances ... it is the responsibility of the user to allocate and deallocate all instruments.

The tick() function returns the mix of all sounding voices. Each noteOn returns a unique tag (credits to the NeXT MusicKit), so you can send control changes to specific voices within an ensemble. Alternately, control changes can be sent to all voices on a given channel.

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


Public Member Functions

 Voicer (StkFloat decayTime=0.2)
 Class constructor taking an optional note decay time (in seconds).
 ~Voicer ()
 Class destructor.
void addInstrument (Instrmnt *instrument, int channel=0)
 Add an instrument with an optional channel number to the voice manager.
void removeInstrument (Instrmnt *instrument)
 Remove the given instrument pointer from the voice manager's control.
long noteOn (StkFloat noteNumber, StkFloat amplitude, int channel=0)
 Initiate a noteOn event with the given note number and amplitude and return a unique note tag.
void noteOff (StkFloat noteNumber, StkFloat amplitude, int channel=0)
 Send a noteOff to all voices having the given noteNumber and optional channel (default channel = 0).
void noteOff (long tag, StkFloat amplitude)
 Send a noteOff to the voice with the given note tag.
void setFrequency (StkFloat noteNumber, int channel=0)
 Send a frequency update message to all voices assigned to the optional channel argument (default channel = 0).
void setFrequency (long tag, StkFloat noteNumber)
 Send a frequency update message to the voice with the given note tag.
void pitchBend (StkFloat value, int channel=0)
 Send a pitchBend message to all voices assigned to the optional channel argument (default channel = 0).
void pitchBend (long tag, StkFloat value)
 Send a pitchBend message to the voice with the given note tag.
void controlChange (int number, StkFloat value, int channel=0)
 Send a controlChange to all instruments assigned to the optional channel argument (default channel = 0).
void controlChange (long tag, int number, StkFloat value)
 Send a controlChange to the voice with the given note tag.
void silence (void)
 Send a noteOff message to all existing voices.
StkFloat tick ()
 Mix the output for all sounding voices.
StkFloat * tick (StkFloat *vector, unsigned int vectorSize)
 Compute vectorSize output mixes and return them in vector.
virtual StkFramestick (StkFrames &frames, unsigned int channel=1)
 Fill a channel of the StkFrames object with computed outputs.
StkFloat lastOut () const
 Return the last output value.
StkFloat lastOutLeft () const
 Return the last left output value.
StkFloat lastOutRight () const
 Return the last right output value.


Member Function Documentation

void Voicer::addInstrument Instrmnt instrument,
int  channel = 0
 

Add an instrument with an optional channel number to the voice manager.

A set of instruments can be grouped by channel number and controlled via the functions which take a channel number argument.

void Voicer::removeInstrument Instrmnt instrument  ) 
 

Remove the given instrument pointer from the voice manager's control.

It is important that any instruments which are to be deleted by the user while the voice manager is running be first removed from the manager's control via this function!!

long Voicer::noteOn StkFloat  noteNumber,
StkFloat  amplitude,
int  channel = 0
 

Initiate a noteOn event with the given note number and amplitude and return a unique note tag.

Send the noteOn message to the first available unused voice. If all voices are sounding, the oldest voice is interrupted and sent the noteOn message. If the optional channel argument is non-zero, only voices on that channel are used. If no voices are found for a specified non-zero channel value, the function returns -1. The amplitude value should be in the range 0.0 - 128.0.

void Voicer::noteOff StkFloat  noteNumber,
StkFloat  amplitude,
int  channel = 0
 

Send a noteOff to all voices having the given noteNumber and optional channel (default channel = 0).

The amplitude value should be in the range 0.0 - 128.0.

void Voicer::noteOff long  tag,
StkFloat  amplitude
 

Send a noteOff to the voice with the given note tag.

The amplitude value should be in the range 0.0 - 128.0.

void Voicer::setFrequency StkFloat  noteNumber,
int  channel = 0
 

Send a frequency update message to all voices assigned to the optional channel argument (default channel = 0).

The noteNumber argument corresponds to a MIDI note number, though it is a floating-point value and can range beyond the normal 0-127 range.

void Voicer::setFrequency long  tag,
StkFloat  noteNumber
 

Send a frequency update message to the voice with the given note tag.

The noteNumber argument corresponds to a MIDI note number, though it is a floating-point value and can range beyond the normal 0-127 range.

virtual StkFrames& Voicer::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.


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