SynthLab SDK
SynthLab::SFXWTCore Class Reference

Wavetable oscillator with one-shot sound-effects (SFX) extracted into wavetables from WAV files. More...

#include <sfxwtcore.h>

Inheritance diagram for SynthLab::SFXWTCore:
SynthLab::ModuleCore

Public Member Functions

 SFXWTCore ()
 Construction: Cores follow the same construction pattern. More...
 
virtual ~SFXWTCore ()
 
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...
 
double renderSample (SynthClock &clock, bool forceLoop)
 Renders one sample out of the wavetable Core Specific: 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)
 
ModuleCoreDatagetModuleData ()
 provides access to the core data: More...
 

Protected Attributes

double sampleRate = 0.0
 sample rate
 
double outputAmplitude = 1.0
 amplitude in dB
 
double panLeftGain = 0.707
 left channel gain
 
double panRightGain = 0.707
 right channel gain
 
bool oneShotDone = false
 one shot flag
 
int32_t currentWaveIndex = -1
 to minimize dictionary (map) lookup iterating
 
SynthClock oscClock
 timebase
 
IWavetableSourceselectedTableSource = nullptr
 selected table
 
DrumWTSource sfxTables [MODULE_STRINGS]
 pitchless wavetable sets
 
- 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< GlideModulatorglideModulator
 built-in glide modulator for oscillators
 

Detailed Description

Wavetable oscillator with one-shot sound-effects (SFX) extracted into wavetables from WAV files.

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

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

  • Creme, JawBreak, Laser, Minipop, Noisey, Ploppy, Pop, RobotPunch, Seeit, Speeder, Splok, Sploop, SprinGun, Swish, Swoosh, WackaBot

ModKnob Strings, for fixed GUI controls by index constant

  • MOD_KNOB_A = "Shape"
  • MOD_KNOB_B = "HSync"
  • MOD_KNOB_C = "Phase"
  • MOD_KNOB_D = "D"

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

◆ SFXWTCore()

SynthLab::SFXWTCore::SFXWTCore ( )

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:

  • note use of DrumWTSource structures to hold table information here; this is not dynamic data and is small in size and nature
Returns
the newly constructed object

◆ ~SFXWTCore()

virtual SynthLab::SFXWTCore::~SFXWTCore ( )
inlinevirtual

Destructor is empty: all resources are smart pointers

Member Function Documentation

◆ doNoteOff()

bool SynthLab::SFXWTCore::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
processInfois the thunk-barrier compliant data structure for passing all needed parameters
Returns
true if successful, false otherwise

Implements SynthLab::ModuleCore.

◆ doNoteOn()

bool SynthLab::SFXWTCore::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 clock
  • reset one-shot flag
Parameters
processInfois the thunk-barrier compliant data structure for passing all needed parameters
Returns
true if successful, false otherwise

Implements SynthLab::ModuleCore.

◆ render()

bool SynthLab::SFXWTCore::render ( CoreProcData processInfo)
overridevirtual

Renders the output of the module.

  • renders to output buffer using pointers in the CoreProcData argument
  • supports FM via the pmBuffer if avaialble; if pmBuffer is NULL then there is no FM Core Specific:
  • call rendering sub-function
  • apply and remove phase offsets for phase modulation (FM)
  • renders one block of audio per render cycle
  • renders in mono that is copied to the right channel as dual-mono stereo
Parameters
processInfothe thunk-barrier compliant data structure for passing all needed parameters
Returns
true if successful, false otherwise

Implements SynthLab::ModuleCore.

◆ renderSample()

double SynthLab::SFXWTCore::renderSample ( SynthClock clock,
bool  forceLoop 
)

Renders one sample out of the wavetable Core Specific:

Helper function for rendering

  • applies phase distortion for shape modulation
Parameters
clockthe current timebase
forceLooptrue to force this sample to loop (repeated over duration)
Returns
true if successful, false otherwise

◆ reset()

bool SynthLab::SFXWTCore::reset ( CoreProcData processInfo)
overridevirtual

Resets object to initialized state.

ModuleCore Overrides

  • parameters are accessed via the processInfo.moduleParameters pointer
  • initialize timbase and hard synchronizer
  • check and add wavetables to the database
Parameters
processInfothe thunk-barrier compliant data structure for passing all needed parameters
Returns
true if successful, false otherwise

Implements SynthLab::ModuleCore.

◆ update()

bool SynthLab::SFXWTCore::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:
  • NO pitch modulation for these SFX samples
  • selects a wavetable based on waveform name
  • calculates final gain and pan values
Parameters
processInfothe 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: