tKarplusStrong

Stiff Karplus-Strong model. More...

Functions
void	tKarplusStrong_init (tKarplusStrong *const, float lowestFrequency, LEAF *const leaf)
	Initialize a tKarplusStrong to the default mempool of a LEAF instance. More...
void	tKarplusStrong_initToPool (tKarplusStrong *const, float lowestFrequency, tMempool *const)
	Initialize a tKarplusStrong to a specified mempool. More...
void	tKarplusStrong_free (tKarplusStrong *const)
	Free a tKarplusStrong from its mempool. More...
float	tKarplusStrong_tick (tKarplusStrong *const)
void	tKarplusStrong_pluck (tKarplusStrong *const, float amplitude)
	Pluck the string. More...
void	tKarplusStrong_noteOn (tKarplusStrong *const, float frequency, float amplitude)
	Start a note with the given frequency and amplitude. More...
void	tKarplusStrong_noteOff (tKarplusStrong *const, float amplitude)
	Stop a note with the given amplitude (speed of decay). More...
void	tKarplusStrong_setFrequency (tKarplusStrong *const, float frequency)
	Set instrument parameters for a particular frequency. More...
void	tKarplusStrong_controlChange (tKarplusStrong *const, SKControlType type, float value)
	Perform the control change specified by number and value (0.0 - 128.0). Use SKPickPosition, SKStringDamping, or SKDetune for type. More...
void	tKarplusStrong_setStretch (tKarplusStrong *const, float stretch)
	Set the stretch "factor" of the string (0.0 - 1.0). More...
void	tKarplusStrong_setPickupPosition (tKarplusStrong *const, float position)
	Set the pluck or "excitation" position along the string (0.0 - 1.0). More...
void	tKarplusStrong_setBaseLoopGain (tKarplusStrong *const, float aGain)
	Set the base loop gain. More...
float	tKarplusStrong_getLastOut (tKarplusStrong *const)

Detailed Description

Stiff Karplus-Strong model.

Function Documentation

tKarplusStrong_init()

void tKarplusStrong_init	(	tKarplusStrong * const	,
		float	lowestFrequency,
		LEAF *const	leaf
	)

Initialize a tKarplusStrong to the default mempool of a LEAF instance.

Parameters

string	A pointer to the tKarplusStrong to initialize.
leaf	A pointer to the leaf instance.

tKarplusStrong_initToPool()

void tKarplusStrong_initToPool	(	tKarplusStrong * const	,
		float	lowestFrequency,
		tMempool * const
	)

Initialize a tKarplusStrong to a specified mempool.

Parameters

string	A pointer to the tKarplusStrong to initialize.
mempool	A pointer to the tMempool to use.

tKarplusStrong_free()

void tKarplusStrong_free

(

tKarplusStrong * const

)

Free a tKarplusStrong from its mempool.

Parameters

string

A pointer to the tKarplusStrong to free.

tKarplusStrong_tick()

float tKarplusStrong_tick

(

tKarplusStrong * const

)

Parameters

string

A pointer to the relevant tKarplusStrong.

tKarplusStrong_pluck()

void tKarplusStrong_pluck	(	tKarplusStrong * const	,
		float	amplitude
	)

Pluck the string.

Parameters

string

A pointer to the relevant tKarplusStrong.

tKarplusStrong_noteOn()

void tKarplusStrong_noteOn	(	tKarplusStrong * const	,
		float	frequency,
		float	amplitude
	)

Start a note with the given frequency and amplitude.

Parameters

string

A pointer to the relevant tKarplusStrong.

tKarplusStrong_noteOff()

void tKarplusStrong_noteOff	(	tKarplusStrong * const	,
		float	amplitude
	)

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

Parameters

string

A pointer to the relevant tKarplusStrong.

tKarplusStrong_setFrequency()

void tKarplusStrong_setFrequency	(	tKarplusStrong * const	,
		float	frequency
	)

Set instrument parameters for a particular frequency.

Parameters

string

A pointer to the relevant tKarplusStrong.

tKarplusStrong_controlChange()

void tKarplusStrong_controlChange	(	tKarplusStrong * const	,
		SKControlType	type,
		float	value
	)

Perform the control change specified by number and value (0.0 - 128.0). Use SKPickPosition, SKStringDamping, or SKDetune for type.

Parameters

string

A pointer to the relevant tKarplusStrong.

tKarplusStrong_setStretch()

void tKarplusStrong_setStretch	(	tKarplusStrong * const	,
		float	stretch
	)

Set the stretch "factor" of the string (0.0 - 1.0).

Parameters

string

A pointer to the relevant tKarplusStrong.

tKarplusStrong_setPickupPosition()

void tKarplusStrong_setPickupPosition	(	tKarplusStrong * const	,
		float	position
	)

Set the pluck or "excitation" position along the string (0.0 - 1.0).

Parameters

string

A pointer to the relevant tKarplusStrong.

tKarplusStrong_setBaseLoopGain()

void tKarplusStrong_setBaseLoopGain	(	tKarplusStrong * const	,
		float	aGain
	)

Set the base loop gain.

Parameters

string

A pointer to the relevant tKarplusStrong.

tKarplusStrong_getLastOut()

float tKarplusStrong_getLastOut

(

tKarplusStrong * const

)

Parameters

string

A pointer to the relevant tKarplusStrong.