Yamaha DX EG-based. More...

#include <dxegcore.h>

Inheritance diagram for SynthLab::DXEGCore:

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

virtual	~DXEGCore ()

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...

virtual int32_t	getState () override

virtual bool	shutdown () override
	Shutdown handler for EG. More...

virtual void	setSustainOverride (bool b) override
	Sustain pedal handler for EG. More...

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

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 Member Functions
double	setStepInc (double timeMsec, double scale=1.0)
	Calculates linear step increment based on time in millisecs. More...

Protected Attributes
double	egStepInc = 0.0
	linear time stepping More...

double	attackTimeScalar = 0.0
	for MIDI modulations to attack time

double	decayTimeScalar = 0.0
	for MIDI modulations to decay time

EGState	state = EGState::kOff
	state variable for FSM

double	envelopeOutput = 0.0
	current outupt

double	linearEnvOutput = 0.0
	current outupt

double	curveEnvOutput = 0.0
	current outupt

double	dxOutput = 0.0
	final output value

double	releaseLevel = 0.0
	release end point

double	sampleRate = 0.0
	fs

bool	sustainOverride = false
	if true, places the EG into sustain mode

bool	releasePending = false
	a flag set when a note off event occurs while the sustain pedal is held, telling the EG to go to the release state once the pedal is released

bool	resetToZero = false
	notes the EG is in reset-to-zero mode

bool	noteOff = false
	not currently used

bool	retriggered = false
	for retrigger modulation

double	lastTriggerMod = 0.0
	for detecting rising edge of modulator

double	incShutdown = 0.0
	shutdown linear incrementer

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

Yamaha DX EG-based.

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

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:

ADSlSR, ADSlR

ModKnob Strings, for fixed GUI controls by index constant

MOD_KNOB_A = "Start Lvl"
MOD_KNOB_B = "Decay Lvl"
MOD_KNOB_C = "Slope Time"
MOD_KNOB_D = "Curvature"

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:
kEGNormalOutput normal EG output value
kEGBiasedOutput biased EG (sustain level subtracted out)
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

◆ DXEGCore()

SynthLab::DXEGCore::DXEGCore ( )

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:

two EG contours are supported

◆ ~DXEGCore()

virtual SynthLab::DXEGCore::~DXEGCore ( )

inlinevirtual

Destructor is empty: all resources are smart pointers

Member Function Documentation

◆ doNoteOff()

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

checks the sustain override flag and releases the note if needed
goes to release or off mode

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

sets the finite state machine for another run
checks attack and decay scaling (only caclulated once per note-event)

Parameters

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

Returns: true if successful, false otherwise

Implements SynthLab::ModuleCore.

◆ getState()

virtual int32_t SynthLab::DXEGCore::getState ( )

inlineoverridevirtual

ModuleCore Overrides for EG Cores only

Reimplemented from SynthLab::ModuleCore.

◆ render()

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

overridevirtual

Renders the output of the module.

write modulator output with: processInfo.modulationOutputs->setModValue( ) Core Specific:
runs the finite state machine for the EG
runs the FSM on each sample interval, but only use the output of the first loop (see book)

Parameters

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

Returns: true if successful, false otherwise

< current outupt

Implements SynthLab::ModuleCore.

◆ reset()

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

overridevirtual

Resets object to initialized state.

ModuleCore Overrides

parameters are accessed via the processInfo.moduleParameters pointer
initializes sample rate dependent stuff via processInfo.sampleRate
calculates intitial coefficients
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.

◆ setStepInc()

double SynthLab::DXEGCore::setStepInc	(	double	timeMsec,
		double	scale = `1.0`
	)

inlineprotected

Calculates linear step increment based on time in millisecs.

calculate new step size

Parameters

timeMsec the time in milliseconds scalar value for stretching or shrinking the final value

Returns: new step increment value

◆ setSustainOverride()

void SynthLab::DXEGCore::setSustainOverride ( bool b )

overridevirtual

Sustain pedal handler for EG.

all EGs should implement this base class function
if turned off (pedal released), clears the pending release if exists
if turned on, sets the sustain pedal override to keep the EG stuck in the sustain state until the pedal is released

Reimplemented from SynthLab::ModuleCore.

◆ shutdown()

bool SynthLab::DXEGCore::shutdown ( )

overridevirtual

Shutdown handler for EG.

all EGs should implement this base class function
calculates shutdown amp increment based on current output value

Returns: true if successful, false otherwise

Reimplemented from SynthLab::ModuleCore.

◆ update()

bool SynthLab::DXEGCore::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:
is used in a standalone manner with the FMOperator object; the parameter messaging is direct, bypassing mod knobs
checks the re-trigger modulation input to alter state machine

Parameters

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

Returns: true if successful, false otherwise

Implements SynthLab::ModuleCore.

Member Data Documentation

◆ egStepInc

double SynthLab::DXEGCore::egStepInc = 0.0

protected

linear time stepping

local variables

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DXEGCore()

◆ ~DXEGCore()

Member Function Documentation

◆ doNoteOff()

◆ doNoteOn()

◆ getState()

◆ render()

◆ reset()

◆ setStepInc()

◆ setSustainOverride()

◆ shutdown()

◆ update()

Member Data Documentation

◆ egStepInc