A ProcessorRouter that encapsulates a cohesive unit of functionality in the synthesizer. More...

#include <synth_module.h>

Inheritance diagram for vital::SynthModule:

Public Member Functions
	SynthModule (int num_inputs, int num_outputs, bool control_rate=false)
	Constructs a SynthModule with specified I/O and control rate.

virtual	~SynthModule ()
	Destructor.

control_map	getControls ()
	Returns a map of all controls from this module and its submodules.

Output *	getModulationSource (std::string name)
	Retrieves a modulation source output by name.

const StatusOutput *	getStatusOutput (std::string name) const
	Retrieves a StatusOutput by name.

Processor *	getModulationDestination (std::string name, bool poly)
	Retrieves a modulation destination Processor by name and poly mode.

Processor *	getMonoModulationDestination (std::string name)
	Retrieves a mono modulation destination by name.

Processor *	getPolyModulationDestination (std::string name)
	Retrieves a poly modulation destination by name.

ValueSwitch *	getModulationSwitch (std::string name, bool poly)
	Retrieves a modulation switch by name and poly mode.

ValueSwitch *	getMonoModulationSwitch (std::string name)
	Retrieves a mono modulation switch by name.

ValueSwitch *	getPolyModulationSwitch (std::string name)
	Retrieves a poly modulation switch by name.

void	updateAllModulationSwitches ()
	Updates all modulation switches based on whether their destinations have inputs.

output_map &	getModulationSources ()
	Returns a reference to the map of modulation sources.

input_map &	getMonoModulationDestinations ()
	Returns a reference to the map of mono modulation destinations.

input_map &	getPolyModulationDestinations ()
	Returns a reference to the map of poly modulation destinations.

virtual output_map &	getMonoModulations ()
	Returns a reference to the map of mono modulation readouts.

virtual output_map &	getPolyModulations ()
	Returns a reference to the map of poly modulation readouts.

virtual void	correctToTime (double seconds)
	Allows correction of module state to a given time (if needed).

void	enableOwnedProcessors (bool enable)
	Enables or disables all owned processors.

virtual void	enable (bool enable) override
	Enables or disables this SynthModule and its owned processors.

void	addMonoProcessor (Processor *processor, bool own=true)
	Adds a mono processor to this module.

void	addIdleMonoProcessor (Processor *processor)
	Adds a mono processor that is considered idle (not part of main processing chain).

virtual Processor *	clone () const override
	Clones this SynthModule.

void	addSubmodule (SynthModule *module)
	Adds a submodule to this SynthModule.

Public Member Functions inherited from vital::ProcessorRouter
	ProcessorRouter (int num_inputs=0, int num_outputs=0, bool control_rate=false)
	Constructs a ProcessorRouter with a specified number of inputs and outputs.

	ProcessorRouter (const ProcessorRouter &original)
	Copy constructor. Creates a new ProcessorRouter from an existing one.

virtual	~ProcessorRouter ()
	Destructor.

virtual void	process (int num_samples) override
	Processes audio through all Processors managed by this router.

virtual void	init () override
	Initializes the ProcessorRouter and all its Processors.

virtual void	setSampleRate (int sample_rate) override
	Sets the sample rate for all Processors in this router.

virtual void	setOversampleAmount (int oversample) override
	Sets the oversampling amount for all Processors in this router.

virtual void	addProcessor (Processor *processor)
	Adds a Processor to be managed by this router.

virtual void	addProcessorRealTime (Processor *processor)
	Adds a Processor to the router in real-time (no memory allocations).

virtual void	addIdleProcessor (Processor *processor)
	Adds a Processor that should remain idle (not processed) in the router.

virtual void	removeProcessor (Processor *processor)
	Removes a Processor from this router.

void	connect (Processor destination, const Output source, int index)
	Connects a source Output to a destination Processor input by index.

void	disconnect (const Processor destination, const Output source)
	Disconnects a source Output from a destination Processor.

bool	isDownstream (const Processor first, const Processor second) const
	Checks if one Processor is downstream from another, i.e., if there's a path from the second to the first.

bool	areOrdered (const Processor first, const Processor second) const
	Checks if the order of two Processors is fixed in the router's processing sequence.

virtual bool	isPolyphonic (const Processor *processor) const
	Determines if a given Processor is polyphonic within this router.

virtual ProcessorRouter *	getMonoRouter ()
	Gets the mono router that corresponds to this ProcessorRouter.

virtual ProcessorRouter *	getPolyRouter ()
	Gets the polyphonic router that corresponds to this ProcessorRouter.

virtual void	resetFeedbacks (poly_mask reset_mask)
	Resets all Feedback nodes within this router using a reset mask.

Public Member Functions inherited from vital::Processor
	Processor (int num_inputs, int num_outputs, bool control_rate=false, int max_oversample=1)
	Constructs a Processor with a given number of inputs/outputs and oversampling.

virtual	~Processor ()
	Virtual destructor.

virtual bool	hasState () const
	Indicates whether this Processor requires per-voice state.

virtual void	processWithInput (const poly_float *audio_in, int num_samples)
	An optional processing function taking explicit input buffer. Fallback is an assertion failure (not supported).

virtual void	reset (poly_mask reset_mask)
	Called to reset the Processor's per-voice state (e.g., on note-on).

virtual void	hardReset ()
	Called to perform a "hard" reset for all voices.

bool	initialized ()
	Returns whether this Processor has been initialized.

force_inline bool	enabled () const
	Checks if this Processor is enabled.

force_inline int	getSampleRate () const
	Retrieves the current (effective) sample rate.

force_inline int	getOversampleAmount () const
	Retrieves the current oversampling factor.

force_inline bool	isControlRate () const
	Checks if this Processor is running at control rate (buffer_size == 1).

virtual void	setControlRate (bool control_rate)
	Sets whether this Processor runs at control rate.

force_inline poly_mask	getResetMask (int input_index) const
	Retrieves a mask indicating which voices triggered a note-on event. Compares the input's trigger_value to kVoiceOn.

force_inline void	clearOutputBufferForReset (poly_mask reset_mask, int input_index, int output_index) const
	Clears output samples for voices that are about to be reset, based on the trigger offset.

bool	inputMatchesBufferSize (int input=0)
	Checks whether the buffer size of a particular input matches the size needed by this Processor.

bool	checkInputAndOutputSize (int num_samples)
	Checks if all inputs and outputs have buffers big enough for `num_samples`.

virtual bool	isPolyphonic () const
	Checks if this Processor is polyphonic by querying its ProcessorRouter.

void	plug (const Output *source)
	Connects an external Output to this Processor's first input.

void	plug (const Output *source, unsigned int input_index)
	Connects an external Output to a specified input index.

void	plug (const Processor *source)
	Connects the first output of a Processor to this Processor's first input.

void	plug (const Processor *source, unsigned int input_index)
	Connects the first output of a Processor to a specified input index.

void	plugNext (const Output *source)
	Connects an external Output to the first available (unplugged) input.

void	plugNext (const Processor *source)
	Connects the first output of a Processor to the first available (unplugged) input.

void	useInput (Input *input)
	Uses an existing Input object as this Processor's first input.

void	useInput (Input *input, int index)
	Uses an existing Input object at a specified input index.

void	useOutput (Output *output)
	Uses an existing Output object as this Processor's first output.

void	useOutput (Output *output, int index)
	Uses an existing Output object at a specified output index.

int	connectedInputs ()
	Counts how many inputs are connected to a real source (not null_source_).

virtual void	unplugIndex (unsigned int input_index)
	Removes the connection at a specified input index, if any.

virtual void	unplug (const Output *source)
	Removes a connection to a given Output from all inputs.

virtual void	unplug (const Processor *source)
	Removes connections to all outputs from a given Processor.

virtual void	numInputsChanged ()
	Called when the number of inputs changes (e.g., new connections). Subclasses may override for dynamic behavior.

force_inline void	router (ProcessorRouter *router)
	Sets the ProcessorRouter that owns or manages this Processor.

force_inline ProcessorRouter *	router () const
	Returns the ProcessorRouter that currently owns this Processor.

ProcessorRouter *	getTopLevelRouter () const
	Gets the topmost (root) ProcessorRouter by traversing parent routers.

virtual void	registerInput (Input *input, int index)
	Registers a new input, appending it to the input list.

virtual Output *	registerOutput (Output *output, int index)
	Registers a new Output in the output list at a specified index.

virtual void	registerInput (Input *input)
	Registers a new Input by appending it to the end of the input list.

virtual Output *	registerOutput (Output *output)
	Registers a new Output by appending it to the end of the output list.

force_inline int	numInputs () const
	Returns the total number of Input pointers (owned or otherwise).

force_inline int	numOutputs () const
	Returns the total number of Output pointers (owned or otherwise).

force_inline int	numOwnedInputs () const
	Returns how many Input objects this Processor owns.

force_inline int	numOwnedOutputs () const
	Returns how many Output objects this Processor owns.

force_inline Input *	input (unsigned int index=0) const
	Retrieves the Input pointer at a given index.

force_inline bool	isInputSourcePolyphonic (int index=0)
	Checks if the input source at a given index is polyphonic.

force_inline Input *	ownedInput (unsigned int index=0) const
	Retrieves an owned Input pointer at a given index.

force_inline Output *	output (unsigned int index=0) const
	Retrieves the Output pointer at a given index.

force_inline Output *	ownedOutput (unsigned int index=0) const
	Retrieves an owned Output pointer at a given index.

void	setPluggingStart (int start)
	Sets the position at which `plugNext` starts searching for an open input.

Protected Member Functions
Value *	createBaseControl (std::string name, bool audio_rate=false, bool smooth_value=false)
	Creates a simple control processor for a given parameter name.

Output *	createBaseModControl (std::string name, bool audio_rate=false, bool smooth_value=false, Output *internal_modulation=nullptr)
	Creates a base mod control, which is a control combined with a modulation input.

Output *	createMonoModControl (std::string name, bool audio_rate=false, bool smooth_value=false, Output *internal_modulation=nullptr)
	Creates a monophonic mod control, including applying parameter scaling.

Output *	createPolyModControl (std::string name, bool audio_rate=false, bool smooth_value=false, Output internal_modulation=nullptr, Input reset=nullptr)
	Creates a polyphonic mod control, including applying parameter scaling.

Output *	createTempoSyncSwitch (std::string name, Processor frequency, const Output beats_per_second, bool poly, Input *midi=nullptr)
	Creates a tempo sync switch that toggles between tempo-based frequency and free-running frequency.

void	createStatusOutput (std::string name, Output *source)
	Creates a status output associated with a given Output.

Protected Member Functions inherited from vital::ProcessorRouter
virtual void	addFeedback (Feedback *feedback)
	Adds a Feedback node to handle a feedback loop introduced by a connection.

virtual void	removeFeedback (Feedback *feedback)
	Removes a previously added Feedback node.

void	reorder (Processor *processor)
	Reorders the internal processing sequence to account for a Processor's dependencies.

virtual void	updateAllProcessors ()
	Updates all processors to match the global order. Called when changes occur.

force_inline bool	shouldUpdate ()
	Checks if local changes need to be synchronized with global changes.

virtual void	createAddedProcessors ()
	Creates any processors that were added at the global level but not yet replicated locally.

virtual void	deleteRemovedProcessors ()
	Deletes any processors that were removed at the global level but not yet removed locally.

const Processor *	getContext (const Processor *processor) const
	Gets the processor context within this router for a global Processor reference.

void	getDependencies (const Processor *processor) const
	Populates the internal dependencies structure for a given Processor.

Processor *	getLocalProcessor (const Processor *global_processor)
	Retrieves the local instance of a globally defined Processor.

Protected Member Functions inherited from vital::Processor
Output *	addOutput (int oversample=1)
	Creates and registers a new Output. Handles control rate vs. audio rate.

Input *	addInput ()
	Creates and registers a new Input, initially connected to null_source_.

Protected Attributes
std::shared_ptr< ModuleData >	data_
	Shared data storage for this SynthModule.

Protected Attributes inherited from vital::ProcessorRouter
std::shared_ptr< CircularQueue< Processor * > >	global_order_
	Global processing order reference.

std::shared_ptr< CircularQueue< Processor * > >	global_reorder_
	Temporary storage for reorder operations.

CircularQueue< Processor * >	local_order_
	Local ordering of Processors.

std::map< const Processor *, std::pair< int, std::unique_ptr< Processor > > >	processors_
	Map of global to local Processors.

std::map< const Processor *, std::unique_ptr< Processor > >	idle_processors_
	Idle Processors that are not active in the graph.

std::shared_ptr< std::vector< const Feedback * > >	global_feedback_order_
	Global order of Feedback nodes.

std::vector< Feedback * >	local_feedback_order_
	Local copies of Feedback nodes.

std::map< const Processor *, std::pair< int, std::unique_ptr< Feedback > > >	feedback_processors_
	Map of global to local Feedback processors.

std::shared_ptr< int >	global_changes_
	Global change counter.

int	local_changes_
	Local change counter to track synchronization with global changes.

std::shared_ptr< CircularQueue< const Processor * > >	dependencies_
	Queue for dependencies calculations.

std::shared_ptr< CircularQueue< const Processor * > >	dependencies_visited_
	Queue of visited processors for dependencies calc.

std::shared_ptr< CircularQueue< const Processor * > >	dependency_inputs_
	Queue of processors to check inputs for dependencies.

Protected Attributes inherited from vital::Processor
std::shared_ptr< ProcessorState >	state_
	Shared state (sample rate, oversample, etc.)

int	plugging_start_
	The index at which `plugNext` starts searching for an unplugged input.

std::vector< std::shared_ptr< Input > >	owned_inputs_
	Inputs owned by this Processor.

std::vector< std::shared_ptr< Output > >	owned_outputs_
	Outputs owned by this Processor.

std::shared_ptr< std::vector< Input * > >	inputs_
	All inputs, owned or external.

std::shared_ptr< std::vector< Output * > >	outputs_
	All outputs, owned or external.

ProcessorRouter *	router_
	The ProcessorRouter that manages this Processor.

Additional Inherited Members
Static Protected Attributes inherited from vital::Processor
static const Output	null_source_
	A null (dummy) source used for unconnected inputs.

Detailed Description

A ProcessorRouter that encapsulates a cohesive unit of functionality in the synthesizer.

A SynthModule groups multiple processors and controls together. It can be nested within other SynthModules, forming a hierarchical structure. It manages mono and poly modulation sources and destinations, provides access to controls, and allows enabling/disabling sets of processors.

Constructor & Destructor Documentation

◆ SynthModule()

vital::SynthModule::SynthModule	(	int	num_inputs,
		int	num_outputs,
		bool	control_rate = false )

inline

Constructs a SynthModule with specified I/O and control rate.

Parameters

num_inputs	Number of inputs to the module.
num_outputs	Number of outputs from the module.
control_rate	True if the module operates at control rate, false for audio rate.

◆ ~SynthModule()

virtual vital::SynthModule::~SynthModule ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ addIdleMonoProcessor()

void vital::SynthModule::addIdleMonoProcessor ( Processor * processor )

Adds a mono processor that is considered idle (not part of main processing chain).

Adds a Processor to the module's mono routing as an "idle" processor, typically for controls or other logic that doesn't require full audio processing.

Parameters

processor The Processor to add.

◆ addMonoProcessor()

void vital::SynthModule::addMonoProcessor	(	Processor *	processor,
		bool	own = true )

Adds a mono processor to this module.

Adds a Processor to the module's mono processing chain.

Parameters

processor	The Processor to add.
own	True if this module should take ownership of the processor.
processor	The Processor to be added.
own	If true, the Processor is owned by the module (added to owned_mono_processors).

◆ addSubmodule()

void vital::SynthModule::addSubmodule ( SynthModule * module )

inline

Adds a submodule to this SynthModule.

Parameters

module The submodule to add.

◆ clone()

virtual Processor * vital::SynthModule::clone ( ) const

inlineoverridevirtual

Clones this SynthModule.

Returns: A new SynthModule instance that is a copy of this one.

Reimplemented from vital::ProcessorRouter.

Reimplemented in vital::ChorusModule, vital::CombModule, vital::CompressorModule, vital::DelayModule, vital::DistortionModule, vital::EffectsModulationHandler, vital::EnvelopeModule, vital::EqualizerModule, vital::FilterModule, vital::FiltersModule, vital::FlangerModule, vital::FormantModule, vital::LfoModule, vital::ModulationConnectionProcessor, vital::OscillatorModule, vital::PhaserModule, vital::ProducersModule, vital::RandomLfoModule, vital::ReorderableEffectChain, vital::ReverbModule, vital::SampleModule, vital::SynthVoiceHandler, and vital::VoiceHandler.

◆ correctToTime()

virtual void vital::SynthModule::correctToTime ( double seconds )

inlinevirtual

Allows correction of module state to a given time (if needed).

Parameters

seconds The time to correct to, in seconds.

Override this method in subclasses if required.

Reimplemented in vital::ChorusModule, vital::EffectsModulationHandler, vital::FlangerModule, vital::LfoModule, vital::PhaserModule, vital::RandomLfoModule, vital::ReorderableEffectChain, vital::SoundEngine, vital::SoundEngine, and vital::SynthVoiceHandler.

◆ createBaseControl()

Value * vital::SynthModule::createBaseControl	(	std::string	name,
		bool	audio_rate = false,
		bool	smooth_value = false )

protected

Creates a simple control processor for a given parameter name.

Creates a basic control (Value or SmoothValue) for a named parameter.

Parameters

name	The name of the parameter.
audio_rate	True if this control should run at audio rate, false otherwise.
smooth_value	True if the control should be smoothed over time.

Returns: A pointer to the created Value processor.

Parameters

name	The parameter name, used to fetch default value from `Parameters`.
audio_rate	If true, the control is processed at audio rate.
smooth_value	If true, use a SmoothValue processor to provide smoothing.

Returns: A pointer to the newly created Value-based Processor (e.g., Value, SmoothValue, cr::Value, etc.).

◆ createBaseModControl()

Output * vital::SynthModule::createBaseModControl	(	std::string	name,
		bool	audio_rate = false,
		bool	smooth_value = false,
		Output *	internal_modulation = nullptr )

protected

Creates a base mod control, which is a control combined with a modulation input.

Creates a base mod control with summation for monophonic mod routing, optionally including an internal mod.

Parameters

name	The parameter name.
audio_rate	True if audio-rate control.
smooth_value	True if smoothing is desired.
internal_modulation	Optional internal modulation source.

Returns: The resulting Output that represents the modulated control.

Parameters

name	Parameter name.
audio_rate	Whether to run at audio rate.
smooth_value	Whether to use a SmoothValue or a plain Value.
internal_modulation	Additional optional mod input.

Returns: The Output of the controlling ValueSwitch.

◆ createMonoModControl()

Output * vital::SynthModule::createMonoModControl	(	std::string	name,
		bool	audio_rate = false,
		bool	smooth_value = false,
		Output *	internal_modulation = nullptr )

protected

Creates a monophonic mod control, including applying parameter scaling.

Creates a named monophonic mod control, optionally applying scaling (exponential, square, etc.) to the final output.

Parameters

name	The parameter name.
audio_rate	True if audio-rate control.
smooth_value	True if smoothing is desired.
internal_modulation	Optional internal modulation source.

Returns: The resulting Output that represents the modulated and scaled control.

Parameters

name	The parameter name.
audio_rate	Whether to run at audio rate.
smooth_value	Whether to use a SmoothValue or plain Value.
internal_modulation	Additional optional mod input.

Returns: The final Output after scaling.

◆ createPolyModControl()

Output * vital::SynthModule::createPolyModControl	(	std::string	name,
		bool	audio_rate = false,
		bool	smooth_value = false,
		Output *	internal_modulation = nullptr,
		Input *	reset = nullptr )

protected

Creates a polyphonic mod control, including applying parameter scaling.

Creates a named polyphonic mod control, optionally with smoothing, an internal mod, and additional resets. Applies post-scaling if requested.

Parameters

name	The parameter name.
audio_rate	True if audio-rate control.
smooth_value	True if smoothing is desired.
internal_modulation	Optional internal modulation source.
reset	An optional Input reset trigger for polyphonic modulation.

Returns: The resulting Output that represents the modulated and scaled control.

Parameters

name	Parameter name for the control.
audio_rate	If true, processes at audio rate.
smooth_value	If true, uses SmoothValue for the base control.
internal_modulation	Optional extra input for the mod sum.
reset	Optional Input for reset signals (used by audio-rate mod).

Returns: The final Output after scaling.

◆ createStatusOutput()

void vital::SynthModule::createStatusOutput	(	std::string	name,
		Output *	source )

protected

Creates a status output associated with a given Output.

Creates a new StatusOutput in this module for a named source Output.

Parameters

name	The status output name.
source	The source Output to track.
name	Identifier for the status output.
source	The underlying Output to observe.

◆ createTempoSyncSwitch()

Output * vital::SynthModule::createTempoSyncSwitch	(	std::string	name,
		Processor *	frequency,
		const Output *	beats_per_second,
		bool	poly,
		Input *	midi = nullptr )

protected

Creates a tempo sync switch that toggles between tempo-based frequency and free-running frequency.

Creates a frequency/tempo switch for a named parameter. The user can switch between free-running frequency and tempo-synced frequency.

Parameters

name	The parameter name prefix.
frequency	A Processor representing the base frequency.
beats_per_second	Output representing beats per second (tempo).
poly	True if polyphonic.
midi	Optional Input for MIDI data, used for keytracking.

Returns: The resulting Output of the tempo sync switch.

Parameters

name	The parameter name (for creating internal controls).
frequency	The Processor that provides the base frequency.
beats_per_second	The BPM-based input (beats per second).
poly	If true, handles polyphonic logic for the tempo parameter.
midi	Optional MIDI input for keytracking if provided.

Returns: The final Output that selects tempo-based or frequency-based approach.

◆ enable()

void vital::SynthModule::enable ( bool enable )

overridevirtual

Enables or disables this SynthModule and its owned processors.

Overrides the base enable method to also enable or disable owned processors within this module.

Parameters

enable True to enable, false to disable.

Reimplemented from vital::Processor.

Reimplemented in vital::ChorusModule, vital::CompressorModule, vital::DelayModule, vital::EqualizerModule, vital::FlangerModule, vital::PhaserModule, and vital::ReverbModule.

◆ enableOwnedProcessors()

void vital::SynthModule::enableOwnedProcessors ( bool enable )

Enables or disables all owned processors.

Enables or disables all owned mono processors and submodules.

Parameters

enable True to enable, false to disable.

◆ getControls()

control_map vital::SynthModule::getControls ( )

Returns a map of all controls from this module and its submodules.

Returns: A control_map containing all controls.

◆ getModulationDestination()

Processor * vital::SynthModule::getModulationDestination	(	std::string	name,
		bool	poly )

Retrieves a modulation destination Processor by name and poly mode.

Parameters

name	The name of the modulation destination.
poly	True for polyphonic, false for monophonic.

Returns: A pointer to the Processor or nullptr if not found.

◆ getModulationSource()

Output * vital::SynthModule::getModulationSource ( std::string name )

Retrieves a modulation source output by name.

Parameters

name	The name of the modulation source.

Returns: A pointer to the Output or nullptr if not found.

◆ getModulationSources()

output_map & vital::SynthModule::getModulationSources ( )

Returns a reference to the map of modulation sources.

Returns: A reference to the output_map of sources.

◆ getModulationSwitch()

ValueSwitch * vital::SynthModule::getModulationSwitch	(	std::string	name,
		bool	poly )

Retrieves a modulation switch by name and poly mode.

Parameters

name	The name of the modulation switch.
poly	True for polyphonic, false for monophonic.

Returns: A pointer to the ValueSwitch or nullptr if not found.

◆ getMonoModulationDestination()

Processor * vital::SynthModule::getMonoModulationDestination ( std::string name )

Retrieves a mono modulation destination by name.

Parameters

name	The name of the destination.

Returns: A pointer to the Processor or nullptr if not found.

◆ getMonoModulationDestinations()

input_map & vital::SynthModule::getMonoModulationDestinations ( )

Returns a reference to the map of mono modulation destinations.

Returns: A reference to the input_map of mono destinations.

◆ getMonoModulations()

output_map & vital::SynthModule::getMonoModulations ( )

virtual

Returns a reference to the map of mono modulation readouts.

Returns: A reference to the output_map of mono modulation readouts.

◆ getMonoModulationSwitch()

ValueSwitch * vital::SynthModule::getMonoModulationSwitch ( std::string name )

Retrieves a mono modulation switch by name.

Parameters

name	The name of the modulation switch.

Returns: A pointer to the ValueSwitch or nullptr if not found.

◆ getPolyModulationDestination()

Processor * vital::SynthModule::getPolyModulationDestination ( std::string name )

Retrieves a poly modulation destination by name.

Parameters

name	The name of the destination.

Returns: A pointer to the Processor or nullptr if not found.

◆ getPolyModulationDestinations()

input_map & vital::SynthModule::getPolyModulationDestinations ( )

Returns a reference to the map of poly modulation destinations.

Returns: A reference to the input_map of poly destinations.

◆ getPolyModulations()

output_map & vital::SynthModule::getPolyModulations ( )

virtual

Returns a reference to the map of poly modulation readouts.

Returns: A reference to the output_map of poly modulation readouts.

Reimplemented in vital::EffectsModulationHandler, and vital::SynthVoiceHandler.

◆ getPolyModulationSwitch()

ValueSwitch * vital::SynthModule::getPolyModulationSwitch ( std::string name )

Retrieves a poly modulation switch by name.

Parameters

name	The name of the modulation switch.

Returns: A pointer to the ValueSwitch or nullptr if not found.

◆ getStatusOutput()

const StatusOutput * vital::SynthModule::getStatusOutput ( std::string name ) const

Retrieves a StatusOutput by name.

Parameters

name	The name of the status output.

Returns: A pointer to the StatusOutput or nullptr if not found.

◆ updateAllModulationSwitches()

void vital::SynthModule::updateAllModulationSwitches ( )

Updates all modulation switches based on whether their destinations have inputs.

Member Data Documentation

◆ data_

std::shared_ptr<ModuleData> vital::SynthModule::data_

protected

Shared data storage for this SynthModule.

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

/Users/davidvogel/repos/VitalHelp/src/synthesis/framework/synth_module.h
/Users/davidvogel/repos/VitalHelp/src/synthesis/framework/synth_module.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SynthModule()

◆ ~SynthModule()

Member Function Documentation

◆ addIdleMonoProcessor()

◆ addMonoProcessor()

◆ addSubmodule()

◆ clone()

◆ correctToTime()

◆ createBaseControl()

◆ createBaseModControl()

◆ createMonoModControl()

◆ createPolyModControl()

◆ createStatusOutput()

◆ createTempoSyncSwitch()

◆ enable()

◆ enableOwnedProcessors()

◆ getControls()

◆ getModulationDestination()

◆ getModulationSource()

◆ getModulationSources()

◆ getModulationSwitch()

◆ getMonoModulationDestination()

◆ getMonoModulationDestinations()

◆ getMonoModulations()

◆ getMonoModulationSwitch()

◆ getPolyModulationDestination()

◆ getPolyModulationDestinations()

◆ getPolyModulations()

◆ getPolyModulationSwitch()

◆ getStatusOutput()

◆ updateAllModulationSwitches()

Member Data Documentation

◆ data_