STK drum sample player class. More...

#include <Drummer.h>

Inheritance diagram for stk::Drummer:

Public Member Functions
	Drummer (void)
	Class constructor.

	~Drummer (void)
	Class destructor.

void	noteOn (StkFloat instrument, StkFloat amplitude)
	Start a note with the given drum type and amplitude.

void	noteOff (StkFloat amplitude)
	Stop a note with the given amplitude (speed of decay).

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.

Public Member Functions inherited from stk::Instrmnt
	Instrmnt (void)
	Class constructor.

virtual void	clear (void)
	Reset and clear all internal state (for subclasses).

virtual void	noteOn (StkFloat frequency, StkFloat amplitude)=0
	Start a note with the given frequency and amplitude.

virtual void	noteOff (StkFloat amplitude)=0
	Stop a note with the given amplitude (speed of decay).

virtual void	setFrequency (StkFloat frequency)
	Set instrument parameters for a particular frequency.

virtual void	controlChange (int number, StkFloat value)
	Perform the control change specified by number and value (0.0 - 128.0).

unsigned int	channelsOut (void) const
	Return the number of output channels for the class.

const StkFrames &	lastFrame (void) const
	Return an StkFrames reference to the last output sample frame.

StkFloat	lastOut (unsigned int channel=0)
	Return the specified channel value of the last computed frame.

virtual StkFloat	tick (unsigned int channel=0)=0
	Compute one sample frame and return the specified `channel` value.

virtual StkFrames &	tick (StkFrames &frames, unsigned int channel=0)=0
	Fill the StkFrames object with computed sample frames, starting at the specified channel.

Public Member Functions inherited from stk::Stk
void	ignoreSampleRateChange (bool ignore=true)
	A function to enable/disable the automatic updating of class data when the STK sample rate changes.

Additional Inherited Members
Static Public Member Functions inherited from stk::Stk
static StkFloat	sampleRate (void)
	Static method that returns the current STK sample rate.

static void	setSampleRate (StkFloat rate)
	Static method that sets the STK sample rate.

static void	clear_alertList ()
	Static method that frees memory from alertList_.

static std::string	rawwavePath (void)
	Static method that returns the current rawwave path.

static void	setRawwavePath (std::string path)
	Static method that sets the STK rawwave path.

static void	swap16 (unsigned char *ptr)
	Static method that byte-swaps a 16-bit data type.

static void	swap32 (unsigned char *ptr)
	Static method that byte-swaps a 32-bit data type.

static void	swap64 (unsigned char *ptr)
	Static method that byte-swaps a 64-bit data type.

static void	sleep (unsigned long milliseconds)
	Static cross-platform method to sleep for a number of milliseconds.

static bool	inRange (StkFloat value, StkFloat min, StkFloat max)
	Static method to check whether a value is within a specified range.

static void	handleError (const char *message, StkError::Type type)
	Static function for error reporting and handling using c-strings.

static void	handleError (std::string message, StkError::Type type)
	Static function for error reporting and handling using c++ strings.

static void	showWarnings (bool status)
	Toggle display of WARNING and STATUS messages.

static void	printErrors (bool status)
	Toggle display of error messages before throwing exceptions.

Static Public Attributes inherited from stk::Stk
static const StkFormat	STK_SINT8

static const StkFormat	STK_SINT16

static const StkFormat	STK_SINT24

static const StkFormat	STK_SINT32

static const StkFormat	STK_FLOAT32

static const StkFormat	STK_FLOAT64

Protected Member Functions inherited from stk::Stk
	Stk (void)
	Default constructor.

virtual	~Stk (void)
	Class destructor.

virtual void	sampleRateChanged (StkFloat newRate, StkFloat oldRate)
	This function should be implemented in subclasses that depend on the sample rate.

void	addSampleRateAlert (Stk *ptr)
	Add class pointer to list for sample rate change notification.

void	removeSampleRateAlert (Stk *ptr)
	Remove class pointer from list for sample rate change notification.

void	handleError (StkError::Type type) const
	Internal function for error reporting that assumes message in `oStream_` variable.

Detailed Description

STK drum sample player class.

This class implements a drum sampling synthesizer using WvIn objects and one-pole filters. The drum rawwave files are sampled at 22050 Hz, but will be appropriately interpolated for other sample rates. You can specify the maximum polyphony (maximum number of simultaneous voices) via a #define in the Drummer.h.

by Perry R. Cook and Gary P. Scavone, 1995–2023.

Constructor & Destructor Documentation

◆ Drummer()

stk::Drummer::Drummer ( void )

Class constructor.

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

Member Function Documentation

◆ noteOn()

void stk::Drummer::noteOn	(	StkFloat	instrument,
		StkFloat	amplitude
	)

virtual

Start a note with the given drum type and amplitude.

Use general MIDI drum instrument numbers, converted to frequency values as if MIDI note numbers, to select a particular instrument. An StkError will be thrown if the rawwave path is incorrectly set.

Implements stk::Instrmnt.

◆ tick()

StkFrames & stk::Drummer::tick	(	StkFrames &	frames,
		unsigned int	channel = `0`
	)

inlinevirtual

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.