PCM oscillator using the same multi-samples from the 1st edition of the Synth Book. More...

#include <pcmlegacycore.h>

Inheritance diagram for SynthLab::LegacyPCMCore:

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

virtual	~LegacyPCMCore ()

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 Member Functions
void	checkAddSampleSet (std::string sampleDirectory, std::string sampleName, CoreProcData &processInfo, uint32_t index)
	Query the PCM database and add sample sources as needed. 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	readIndex = 0.0
	must persist between update and render

double	phaseInc = 0.0
	must persist between update and render

uint32_t	currentIndex = 0
	must persist between update and render

IPCMSampleSource *	selectedSampleSource = nullptr
	current PCM sample

SynthLabPCMSource	pcmSources [MODULE_STRINGS]

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

PCM oscillator using the same multi-samples from the 1st edition of the Synth Book.

demonstrates use of IPCMSampleSource interface object
demonstrates simplest PCM oscillator
samples are bass-oriented and culled from FutureMusic magazine's free samples

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

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:

Dagga, DigPuff, Divider, Doom, Dumma, Fazzy, FuzzVibe, Heaver, KickWob, Knocka, MultiWave, OldFlatty, Polsar, Quorum, RazzBass, Wobbular

ModKnob Strings, for fixed GUI controls by index constant

MOD_KNOB_A = "A"
MOD_KNOB_B = "B"
MOD_KNOB_C = "C"
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

◆ LegacyPCMCore()

SynthLab::LegacyPCMCore::LegacyPCMCore ( )

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

Waveform names are the names of folders in the container folder

Returns: the newly constructed object

◆ ~LegacyPCMCore()

virtual SynthLab::LegacyPCMCore::~LegacyPCMCore ( )

inlinevirtual

Destructor is empty: all resources are smart pointers

Member Function Documentation

◆ checkAddSampleSet()

void SynthLab::LegacyPCMCore::checkAddSampleSet	(	std::string	sampleDirectory,
		std::string	sampleName,
		CoreProcData &	processInfo,
		uint32_t	index
	)

protected

Query the PCM database and add sample sources as needed.

Parameters

sampleDirectory	dirctory full of PCM WAV files ]param sampleName name of this sample set to check
processInfo	is the thunk-barrier compliant data structure for passing all needed parameters

Returns: true if successful, false otherwise

◆ doNoteOff()

bool SynthLab::LegacyPCMCore::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::LegacyPCMCore::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 read index values to -1 indicating a new 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.

◆ render()

bool SynthLab::LegacyPCMCore::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:
simple reading of PCM wave buffer
no FM
applies gain/volume
renders one block of audio per render cycle
renders in mono that is copied to the right channel as dual-mono stereo

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::LegacyPCMCore::reset ( CoreProcData & processInfo )

overridevirtual

Resets object to initialized state.

ModuleCore Overrides

parameters are accessed via the processInfo.moduleParameters pointer
initialize timbase and hard synchronizer
parses WAV folders and adds PCM samples to database as needed

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::LegacyPCMCore::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:
calculates the pitch modulation value from GUI controls, input modulator kBipolarMod, and MIDI pitch bend
selects a PCM sample based on the oscillator's modulated frequency
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/pcmlegacycore.h
C:/RackAFX Projects/SynthLab_SDK/source/pcmlegacycore.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LegacyPCMCore()

◆ ~LegacyPCMCore()

Member Function Documentation

◆ checkAddSampleSet()

◆ doNoteOff()

◆ doNoteOn()

◆ render()

◆ reset()

◆ update()