General pirched oscillator module; use this object for oscillators that do not fit into one of the other categories (wavetable, PCM sample, VA, FM, physical model) More...

#include <oscillator.h>

Inheritance diagram for SynthLab::Oscillator:

Public Member Functions
	Oscillator (std::shared_ptr< MidiInputData > _midiInputData, std::shared_ptr< OscParameters > _parameters, uint32_t blockSize=64)
	Constructs General Purpose Pitched Oscillator module. More...

virtual	~Oscillator ()
	Destructor is empty: all resources are smart pointers. More...

virtual bool	reset (double _sampleRate) override
	Resets object to initialized state. More...

virtual bool	update () override
	Updates the selected core; sets GLOBAL engine variable unisonDetuneCents that may have changed since last operation. More...

virtual bool	render (uint32_t samplesToProcess=1) override
	Renders audio from the selected core. More...

virtual bool	doNoteOn (MIDINoteEvent &noteEvent) override
	Calls the note-on handler for all cores. More...

virtual bool	doNoteOff (MIDINoteEvent &noteEvent) override
	Calls the note-off handler for all cores. More...

std::shared_ptr< OscParameters >	getParameters ()

	Oscillator (std::shared_ptr< MidiInputData > _midiInputData, std::shared_ptr< OscParameters > _parameters, uint32_t blockSize=64)

virtual	~Oscillator ()
	Destructor is empty: all resources are smart pointers. More...

virtual bool	reset (double _sampleRate) override

virtual bool	update () override

virtual bool	render (uint32_t samplesToProcess=1) override

virtual bool	doNoteOn (MIDINoteEvent &noteEvent) override

virtual bool	doNoteOff (MIDINoteEvent &noteEvent) override

std::shared_ptr< OscParameters >	getParameters ()

Public Member Functions inherited from SynthLab::SynthModule
	SynthModule (std::shared_ptr< MidiInputData > _midiInputData)
	Constructs a SynthModule. More...

virtual	~SynthModule ()
	Removes cores, if any.

virtual bool	initialize (const char *_dllDirectory)

virtual int32_t	getState ()

virtual bool	shutdown ()

virtual bool	startGlideModulation (GlideInfo &glideInfo)
	starts the built-in glide modulator More...

std::shared_ptr< Modulators >	getModulationInput ()

std::shared_ptr< Modulators >	getModulationOutput ()

std::shared_ptr< AudioBuffer >	getAudioBuffers ()

void	setUnisonMode (double _unisonDetuneCents, double _unisonStarPhase)

void	setFMBuffer (std::shared_ptr< AudioBuffer > pmBuffer)

void	clearFMBuffer ()

virtual bool	getModuleStrings (std::vector< std::string > &moduleStrings, std::string ignoreStr="")
	Gets a std::vector of Module Strings. More...

virtual bool	getModuleStrings (uint32_t coreIndex, std::vector< std::string > &moduleStrings, std::string ignoreStr)
	Gets a std::vector of Module Strings from a particular core. More...

virtual bool	getAllModuleStrings (std::vector< std::string > &moduleStrings, std::string ignoreStr)
	Gets a std::vector of all Module Strings concatenated from all cores in succession. More...

virtual bool	getModKnobStrings (std::vector< std::string > &modKnobStrings)
	Gets a std::vector of Mod Knob label strings for the selected core. More...

virtual bool	getModKnobStrings (uint32_t coreIndex, std::vector< std::string > &modKnobStrings)
	Gets a std::vector of Mod Knob label strings for a given core; if the core cannot be found returs the mod knob labels of the module itself. More...

virtual bool	getModuleCoreStrings (std::vector< std::string > &moduleCoreStrings)
	Gets a std::vector of the names of the four cores in this module. More...

virtual bool	addModuleCore (std::shared_ptr< ModuleCore > core)
	adds a module core to the module's set of four More...

virtual uint32_t	getSelectedCoreIndex ()
	get the index of the selected core More...

virtual bool	selectModuleCore (uint32_t index)
	Select a core. More...

virtual bool	selectDefaultModuleCore ()
	Select the default core, which is always the first in the list. More...

virtual void	packCores ()
	packs the cores into non-null ordering

virtual bool	clearModuleCores ()
	Clears out the module core pointer list. More...

virtual void	setStandAloneMode (bool b)
	Sets the stand-alone mode flag on all cores. More...

Protected Attributes
std::shared_ptr< OscParameters >	parameters = nullptr

Protected Attributes inherited from SynthLab::SynthModule
std::shared_ptr< Modulators >	modulationInput = std::make_shared<Modulators>()

std::shared_ptr< Modulators >	modulationOutput = std::make_shared<Modulators>()

std::shared_ptr< MidiInputData >	midiInputData = nullptr

std::shared_ptr< AudioBuffer >	audioBuffers = nullptr

std::unique_ptr< GlideModulator >	glideModulator

std::shared_ptr< AudioBuffer >	fmBuffer = nullptr

std::shared_ptr< ModuleCore >	moduleCores [NUM_MODULE_CORES]

std::shared_ptr< ModuleCore >	selectedCore = nullptr

ModuleCoreData	moduleData
	modulestrings (16) and mod knob labels (4) More...

double	unisonDetuneCents = 0.0

double	unisonStartPhase = 0.0

bool	standAloneMode = false

CoreProcData	coreProcessData

std::string	dllDirectory

Detailed Description

General pirched oscillator module; use this object for oscillators that do not fit into one of the other categories (wavetable, PCM sample, VA, FM, physical model)

loads and supports up to NUM_MODULE_CORES (4) cores
it is mainly a wrapper/container for the module cores that do the acutal processing/rendering.

The cores are specialized and #include the wavetable .h files used for operation. The cores demonstrate the variations as documented in Designing Software Synthsizers in C++ 2nd Ed. by Will Pirkle.

The cores include (zero-indexed):

there are no cores for this object, which is included for your own oscillator designs

Base Class: SynthModule

Overrides the five (5) common functions plus a special getParameters() method to return a shared pointer to the parameters structure.

Databases: None

GUI Parameters: OscParameters

getParameters() function allows direct access to std::shared_ptr<WTOscParameters>

std::shared_ptr<OscParameters> getParameters()

call the getParameters() function
set the parameters in the WTOscParameters structure with new values, typically from a GUI To apply these new parameters either:
(a) call the module's update() function OR
(b) call the render() function which in turn calls the update() method.

Ordinarily, this operation happens just prior to calling the render() function so that is the preferred method of operation to avoid multiple calls to the update() function, which is usually the most CPU intensive function of the SynthModule.

Access to Modulators

std::shared_ptr<Modulators> getModulationInput()
std::shared_ptr<Modulators> getModulationOutput()

Access to audio buffers (I/O)

std::shared_ptr<AudioBuffer> getAudioBuffers()

Reads:

Modulation Input values (modulators)
AudioBuffer Input samples for PhaseModulation (FM Synthesis)

Writes:

AudioBuffer Output samples

Construction:

(1) For use within a synth project, the constructor is specialized to use shared recources for:

The owning object (SynthVoice for the SynthLab projects) must pass these valid pointers to the object at construction time. Typically the engine or voice will be the primary synthesizers of these resources. See the 2nd Edition Synth Book for more information.

(2) Standalone:

To use in standalone mode, call the constructor with the shared resoure pointers as null:

Oscillator(nullptr, nullptr, 64);

In standalone mode, the object creates and maintains these resources:

MidiInputData: this has no read access so you cannot access its data. Ordinarily, you pass this shared pointer into the object so that it has access to the current MIDI input data. The object does not write data into this resource, so it is functionally non-opeational.
OscParameters: in standalone mode only, these are synthesized locally on the object, and then the owning object may obtain a shared pointer to them to read/write the parameters directly.

Render:

renders into its own AudioBuffers object; see SynthModule::getAudioBuffers()
renders stereo by default. For wavetables this really means dual-mono where the left buffer is copied to the right.

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

◆ Oscillator() [1/2]

SynthLab::Oscillator::Oscillator	(	std::shared_ptr< MidiInputData >	_midiInputData,
		std::shared_ptr< OscParameters >	_parameters,
		uint32_t	blockSize = `64`
	)

Constructs General Purpose Pitched Oscillator module.

One and only specialized constructor; pointers may be null for stanalone

See class declaration for information on standalone operation

Parameters

_midiInputData	shared MIDI input resource; may be nullptr
_parameters	shared GUI and operational parameters; may be nullptr
blockSize	the synth block process size in frames (stereo)

Returns: the newly constructed object

◆ ~Oscillator() [1/2]

virtual SynthLab::Oscillator::~Oscillator ( )

inlinevirtual

Destructor is empty: all resources are smart pointers.

Destructor is empty: all resources are smart pointers

◆ Oscillator() [2/2]

SynthLab::Oscillator::Oscillator	(	std::shared_ptr< MidiInputData >	_midiInputData,
		std::shared_ptr< OscParameters >	_parameters,
		uint32_t	blockSize = `64`
	)

One and only specialized constructor; pointers may be null for stanalone

◆ ~Oscillator() [2/2]

virtual SynthLab::Oscillator::~Oscillator ( )

inlinevirtual

Destructor is empty: all resources are smart pointers.

Destructor is empty: all resources are smart pointers

Member Function Documentation

◆ doNoteOff()

bool SynthLab::Oscillator::doNoteOff ( MIDINoteEvent & noteEvent )

overridevirtual

Calls the note-off handler for all cores.

Returns: true if successful, false otherwise

Implements SynthLab::SynthModule.

◆ doNoteOn()

bool SynthLab::Oscillator::doNoteOn ( MIDINoteEvent & noteEvent )

overridevirtual

Calls the note-on handler for all cores.

Returns: true if successful, false otherwise

Implements SynthLab::SynthModule.

◆ getParameters() [1/2]

std::shared_ptr<OscParameters> SynthLab::Oscillator::getParameters ( )

inline

For standalone operation only; not used in SynthLab synth projects

◆ getParameters() [2/2]

std::shared_ptr<OscParameters> SynthLab::Oscillator::getParameters ( )

inline

For standalone operation only; not used in SynthLab synth projects

◆ render()

bool SynthLab::Oscillator::render ( uint32_t samplesToProcess = 1 )

overridevirtual

Renders audio from the selected core.

Calls the update function first - NOTE: owning object does not need to call update()
samples to process should normally be the block size, but may be a partial block in some cases due to OS/CPU activity.

Parameters

samplesToProcess the number of samples in this audio block

Returns: true if successful, false otherwise

Implements SynthLab::SynthModule.

◆ reset() [1/2]

bool SynthLab::Oscillator::reset ( double _sampleRate )

overridevirtual

Resets object to initialized state.

SynthModule Overrides

call once during initialization
call any time sample rate changes (after init)
resets all member cores

Parameters

_sampleRate the current sample rate in Hz

Returns: true if successful, false otherwise

Implements SynthLab::SynthModule.

◆ reset() [2/2]

virtual bool SynthLab::Oscillator::reset ( double _sampleRate )

overridevirtual

SynthModule Overrides

Implements SynthLab::SynthModule.

◆ update()

bool SynthLab::Oscillator::update ( )

overridevirtual

Updates the selected core; sets GLOBAL engine variable unisonDetuneCents that may have changed since last operation.

Returns: true if successful, false otherwise

Implements SynthLab::SynthModule.

Member Data Documentation

◆ parameters

std::shared_ptr< OscParameters > SynthLab::Oscillator::parameters = nullptr

protected

For standalone operation only; not used in SynthLab synth projects

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

C:/RackAFX Projects/SynthLab_SDK/examples/programming_guide/oscillator.h
C:/RackAFX Projects/SynthLab_SDK/examples/programming_guide/oscillator.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Oscillator() [1/2]

◆ ~Oscillator() [1/2]

◆ Oscillator() [2/2]

◆ ~Oscillator() [2/2]

Member Function Documentation

◆ doNoteOff()

◆ doNoteOn()

◆ getParameters() [1/2]

◆ getParameters() [2/2]

◆ render()

◆ reset() [1/2]

◆ reset() [2/2]

◆ update()

Member Data Documentation

◆ parameters