LFO that renders all classical and many noisy wavforms. More...

#include <lfocore.h>

Inheritance diagram for SynthLab::LFOCore:

Public Member Functions
	LFOCore ()
	Construction: Cores follow the same construction pattern. More...

virtual	~LFOCore ()

virtual bool	reset (CoreProcData &processInfo) override
	Resets object to initialized state. More...

virtual bool	update (CoreProcData &processInfo) override
	Updates the object for the next block of audio processing. More...

virtual bool	render (CoreProcData &processInfo) override
	Renders the output of the module. More...

virtual bool	doNoteOn (CoreProcData &processInfo) override
	Note-on handler for the ModuleCore. More...

virtual bool	doNoteOff (CoreProcData &processInfo) override
	Note-off handler for the ModuleCore. More...

Public Member Functions inherited from SynthLab::ModuleCore
	ModuleCore ()
	Constructs a ModuleCore. More...

virtual int32_t	getState ()

virtual bool	shutdown ()

virtual void	setSustainOverride (bool sustain)

virtual void	setStandAloneMode (bool b)

bool	startGlideModulation (GlideInfo &glideInfo)

uint32_t	getModuleType ()

const char *	getModuleName ()

void *	getModuleHandle ()

void	setModuleHandle (void *handle)

uint32_t	getModuleIndex ()

void	setModuleIndex (uint32_t index)

int32_t	getPreferredModuleIndex ()

void	setPreferredModuleIndex (uint32_t index)

ModuleCoreData &	getModuleData ()
	provides access to the core data: More...

Protected Attributes
std::unique_ptr< BasicLookupTables >	lookupTables = nullptr
	LUTs for some waveforms.

double	sampleRate = 0.0
	sample rate

double	outputValue = 0.0
	current output,

double	rshOutputValue = 0.0
	current output,

SynthClock	lfoClock
	timbase

bool	renderComplete = false
	flag for one-shot

NoiseGenerator	noiseGen
	for noise based LFOs

Timer	sampleHoldTimer
	for sample and hold waveforms

Timer	delayTimer
	LFO turn on delay.

RampModulator	fadeInModulator
	LFO fade-in modulator.

Protected Attributes inherited from SynthLab::ModuleCore
uint32_t	moduleType = UNDEFINED_MODULE
	type of module, LFO_MODULE, EG_MODULE, etc...

const char *	moduleName = nullptr
	module name must be set in derived constructor

void *	moduleHandle = nullptr
	used for dynamically loading cores from DLLs

uint32_t	moduleIndex = 0
	index of this core

int32_t	preferredIndex = -1
	preferred index of this DYNAMIC core

ModuleCoreData	coreData
	core strings (16) and mod knob labels (4)

bool	standAloneMode = false
	flag for stand-alone mode of operation outside of SynthLab

std::unique_ptr< GlideModulator >	glideModulator
	built-in glide modulator for oscillators

Detailed Description

LFO that renders all classical and many noisy wavforms.

demonstrates use of BasicLookupTables
demonstrates use of NoiseGenerator
demonstrates use of RampModulator for fade-in
demonstrates use of Timers for sample and hold and simple time delay

Base Class: ModuleCore

Overrides the five (5) common functions plus a special getParameters() method to return a shared pointer to the parameters structure.
NOTE: These functions have identical names as the SynthModules that own them, however the arguments are different. ModuleCores use the CoreProcData structure for passing arguments into the cores because they are thunk-barrier compliant.
This means that the owning SynthModule must prepare this structure and populate it prior to function calls. The large majority of this preparation is done in the SynthModule constructor and is one-time in nature.

GUI Parameters: LFOParameters

GUI parameters are delivered into the core via the thunk-barrier compliant CoreProcData argument that is passed into each function identically
processInfo.moduleParameters contains a void* version of the GUI parameter structure pointer
the Core function casts the GUI parameter pointer prior to usage

Access to Modulators is done via the thunk-barrier compliant CoreProcData argument

processInfo.modulationInputs
processInfo.modulationOutputs

Access to audio buffers (I/O/FM) is done via the thunk-barrier compliant CoreProcData argument

processInfo.inputBuffers
processInfo.outputBuffers
processInfo.fmBuffers

Construction: Cores follow the same construction pattern

set the Module type and name parameters
expose the 16 module strings
expose the 4 mod knob label strings
intialize any internal variables

Standalone Mode:

These objects are designed to be internal members of the outer SynthModule that owns them. They may be used in standalone mode without modification, and you will use the CoreProcData structure to pass information into the functions.

Module Strings, zero-indexed for your GUI Control:

triangle, sine ,ramp_up, ramp_dn, exp_up, exp_dn, exp_tri, square, rand_SH1, pluck

ModKnob Strings, for fixed GUI controls by index constant

MOD_KNOB_A = "Shape"
MOD_KNOB_B = "Delay"
MOD_KNOB_C = "FadeIn"
MOD_KNOB_D = "BPM Sync"

Render:

renders into the modulation output array that is passed into the function via the CoreProcData structure and populates the arrays with index values of:
kLFONormalOutput normal LFO output value
kLFOInvertedOutput 180 degrees out of phase with normal output
kUnipolarFromMax unipolar version of the waveform that sits at +1 when the output amplitude is at 0, and descends from +1 downward as the output amplitude is increased; used for tremolo
kUnipolarFromMin unipolar version of the waveform that sits at 0 when the output amplitude is at 0, and ascends from 0 upward as the output amplitude is increased; the ordinary unipolar version
designed to operate in a block-fasion, knowing that only the first output sample will be used

Author: Will Pirkle http://www.willpirkle.com

Remarks: This object is included and described in further detail in Designing Software Synthesizer Plugins in C++ 2nd Ed. by Will Pirkle

Version: Revision : 1.0

Date: Date : 2021 / 04 / 26

Constructor & Destructor Documentation

◆ LFOCore()

SynthLab::LFOCore::LFOCore ( )

Construction: Cores follow the same construction pattern.

simple default constructor

set the Module type and name parameters
expose the 16 module strings
expose the 4 mod knob label strings
intialize any internal variables

Core Specific:

creates new lookup table, which are compact in nature (no reason to share the resource)

Returns: the newly constructed object

◆ ~LFOCore()

virtual SynthLab::LFOCore::~LFOCore ( )

inlinevirtual

Destructor is empty: all resources are smart pointers

Member Function Documentation

◆ doNoteOff()

bool SynthLab::LFOCore::doNoteOff ( CoreProcData & processInfo )

overridevirtual

Note-off handler for the ModuleCore.

parameters are accessed via the processInfo.moduleParameters pointer
MIDI note information is accessed via processInfo.noteEvent

Core Specific:

nothing to do

Parameters

processInfo is the thunk-barrier compliant data structure for passing all needed parameters

Returns: true if successful, false otherwise

Implements SynthLab::ModuleCore.

◆ doNoteOn()

bool SynthLab::LFOCore::doNoteOn ( CoreProcData & processInfo )

overridevirtual

Note-on handler for the ModuleCore.

parameters are accessed via the processInfo.moduleParameters pointer
MIDI note information is accessed via processInfo.noteEvent

Core Specific:

reset delay timer and fade-in ramp modulator
reset sample and hold timer
reset timebase for next run

Parameters

processInfo is the thunk-barrier compliant data structure for passing all needed parameters

Returns: true if successful, false otherwise

Implements SynthLab::ModuleCore.

◆ render()

bool SynthLab::LFOCore::render ( CoreProcData & processInfo )

overridevirtual

Renders the output of the module.

write modulator output with: processInfo.modulationOutputs->setModValue( ) Core Specific:
runs delay timer first
runs LFO next,
applies fade-in modulation if needed
then modifies outputs:
kLFONormalOutput normal LFO output value
kLFOInvertedOutput 180 degrees out of phase with normal output
kUnipolarFromMax unipolar version of the waveform that sits at +1 when the output amplitude is at 0, and descends from +1 downward as the output amplitude is increases; used for tremolo
kUnipolarFromMin unipolar version of the waveform that sits at 0 when the output amplitude is at 0, and ascends from 0 upward as the output amplitude is increases; the ordinary unipolar version

Parameters

processInfo the thunk-barrier compliant data structure for passing all needed parameters

Returns: true if successful, false otherwise

Implements SynthLab::ModuleCore.

◆ reset()

bool SynthLab::LFOCore::reset ( CoreProcData & processInfo )

overridevirtual

Resets object to initialized state.

ModuleCore Overrides

parameters are accessed via the processInfo.moduleParameters pointer
resets and initializes clocks and timers
sets initial state variables

Parameters

processInfo the thunk-barrier compliant data structure for passing all needed parameters

Returns: true if successful, false otherwise

Implements SynthLab::ModuleCore.

◆ update()

bool SynthLab::LFOCore::update ( CoreProcData & processInfo )

overridevirtual

Updates the object for the next block of audio processing.

parameters are accessed via the processInfo.moduleParameters pointer
modulator inputs are accessied via processInfo.modulationInputs
mod knob values are accessed via parameters->modKnobValue[] Core Specific:
sets BPM Sync clocking if wanted
applies FM if needed (LFO1 can modulate LFO2's fo)
updates clock with current frquency
generates modulation values from RampModulator
generates timing values for sample/hold and delay

Parameters

processInfo the thunk-barrier compliant data structure for passing all needed parameters

Returns: true if successful, false otherwise

Implements SynthLab::ModuleCore.

The documentation for this class was generated from the following files:

C:/RackAFX Projects/SynthLab_SDK/source/lfocore.h
C:/RackAFX Projects/SynthLab_SDK/source/lfocore.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LFOCore()

◆ ~LFOCore()

Member Function Documentation

◆ doNoteOff()

◆ doNoteOn()

◆ render()

◆ reset()

◆ update()