mirror of
https://github.com/thestk/stk
synced 2026-01-11 20:11:52 +00:00
68 lines
1.8 KiB
C++
68 lines
1.8 KiB
C++
/***************************************************/
|
|
/*! \class Instrmnt
|
|
\brief STK instrument abstract base class.
|
|
|
|
This class provides a common interface for
|
|
all STK instruments.
|
|
|
|
by Perry R. Cook and Gary P. Scavone, 1995 - 2004.
|
|
*/
|
|
/***************************************************/
|
|
|
|
#ifndef STK_INSTRMNT_H
|
|
#define STK_INSTRMNT_H
|
|
|
|
#include "Stk.h"
|
|
|
|
class Instrmnt : public Stk
|
|
{
|
|
public:
|
|
//! Default constructor.
|
|
Instrmnt();
|
|
|
|
//! Class destructor.
|
|
virtual ~Instrmnt();
|
|
|
|
//! Start a note with the given frequency and amplitude.
|
|
virtual void noteOn(StkFloat frequency, StkFloat amplitude) = 0;
|
|
|
|
//! Stop a note with the given amplitude (speed of decay).
|
|
virtual void noteOff(StkFloat amplitude) = 0;
|
|
|
|
//! Set instrument parameters for a particular frequency.
|
|
virtual void setFrequency(StkFloat frequency);
|
|
|
|
//! Return the last output value.
|
|
StkFloat lastOut() const;
|
|
|
|
//! Return the last left output value.
|
|
StkFloat lastOutLeft() const;
|
|
|
|
//! Return the last right output value.
|
|
StkFloat lastOutRight() const;
|
|
|
|
//! Compute one output sample.
|
|
virtual StkFloat tick() = 0;
|
|
|
|
//! Computer \e vectorSize outputs and return them in \e vector.
|
|
virtual StkFloat *tick(StkFloat *vector, unsigned int vectorSize);
|
|
|
|
//! Fill a channel of the StkFrames object with computed outputs.
|
|
/*!
|
|
The \c channel argument should be one or greater (the first
|
|
channel is specified by 1). An StkError will be thrown if the \c
|
|
channel argument is zero or it is greater than the number of
|
|
channels in the StkFrames object.
|
|
*/
|
|
virtual StkFrames& tick( StkFrames& frames, unsigned int channel = 1 );
|
|
|
|
//! Perform the control change specified by \e number and \e value (0.0 - 128.0).
|
|
virtual void controlChange(int number, StkFloat value);
|
|
|
|
protected:
|
|
StkFloat lastOutput_;
|
|
|
|
};
|
|
|
|
#endif
|