Sinusoidal-only oscillator and attached EG. More...

#include <fmocore.h>

Inheritance diagram for SynthLab::FMOCore:

Public Member Functions
	FMOCore ()
	Constructs FM oscillator Core including standalone DXEG object. More...

virtual	~FMOCore ()

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 one block of audio data Core Specific: 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
double	sampleRate = 0.0
	sample rate

double	midiPitch = 0.0
	the midi pitch

double	outputAmplitude = 1.0
	amplitude in dB

double	panLeftGain = 0.707
	left channel gain

double	panRightGain = 0.707
	right channel gain

double	outputValue = 0.0
	last output value needed for self Feedback

SynthClock	oscClock
	timebase

SineTableSource	sineTableSource
	a single sinewave table

std::unique_ptr< DXEG >	dxEG = nullptr
	an EG for FM modulation

std::shared_ptr< EGParameters >	dxEGParameters = nullptr
	EG parameters for controlling the EG.

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

Sinusoidal-only oscillator and attached EG.

you may add more waveforms to this object to completely change the DX synth!
includes a standalone DXEG object for FMOperator
demonstrates use of SineTableSource object

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: FMOperatorParameters

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:

sinewave

ModKnob Strings, for fixed GUI controls by index constant

MOD_KNOB_A = "A"
MOD_KNOB_B = "B"
MOD_KNOB_C = "C"
MOD_KNOB_D = "F.Back"

Render:

renders into the output buffer using pointers in the CoreProcData argument to the render function
renders one block of audio per render cycle
renders in mono that is copied to the right channel as dual-mono stereo

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

◆ FMOCore()

SynthLab::FMOCore::FMOCore ( )

Constructs FM oscillator Core including standalone DXEG object.

simple default constructor

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

Returns: the newly constructed object

◆ ~FMOCore()

virtual SynthLab::FMOCore::~FMOCore ( )

inlinevirtual

Destructor is empty: all resources are smart pointers

Member Function Documentation

◆ doNoteOff()

bool SynthLab::FMOCore::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:

sends attached EG into release phase

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::FMOCore::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:

saves MIDI pitch for modulation calculation in update() function
resets timebase
rests DXEG for another 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::FMOCore::render ( CoreProcData & processInfo )

overridevirtual

Renders one block of audio data Core Specific:

gets EG output value for the entire block
applies instantaneous phase modulation to synth clock timebase by addition
runs the oscillator for one sample period
applies EG contour to output of oscillator
includes self-modulation state variable if connected
renders into the output buffer using pointers in the CoreProcData argument to the render function
renders one block of audio per render cycle
renders in mono that is copied to the right channel as dual-mono stereo

Parameters

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

Returns: true if successful, false otherwise

Implements SynthLab::ModuleCore.

◆ reset()

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

overridevirtual

Resets object to initialized state.

ModuleCore Overrides

parameters are accessed via the processInfo.moduleParameters pointer
add the single sinusoidal wavetable to the database
reset the EG

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::FMOCore::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:
forwards EG parameters to the member DXEG object
calcuates and applies pitch mod
calculates final gain and pan values

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/fmocore.h
C:/RackAFX Projects/SynthLab_SDK/source/fmocore.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FMOCore()

◆ ~FMOCore()

Member Function Documentation

◆ doNoteOff()

◆ doNoteOn()

◆ render()

◆ reset()

◆ update()