vital::LineMap Class Reference

A processor that maps a phase input through a line generator, producing a value and phase output. More...

#include <line_map.h>

Inheritance diagram for vital::LineMap:

Public Types
enum	MapOutput { kValue , kPhase , kNumOutputs }
	Indices of the outputs produced by LineMap. More...

Public Member Functions
	LineMap (LineGenerator *source)
	Constructs a LineMap processor.
virtual Processor *	clone () const override
	Creates a duplicate of this LineMap processor.
void	process (int num_samples) override
	Processes a given number of samples at the current rate (audio or control).
void	process (poly_float phase)
	Processes a given phase value by interpolating from the line generator's data.
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	init ()
	Called after constructor, used for any additional initialization. Subclasses can override. Sets the initialized flag.
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.
virtual void	setSampleRate (int sample_rate)
	Updates the sample rate of this Processor (scaled by oversampling).
virtual void	setOversampleAmount (int oversample)
	Sets the oversampling amount and updates the effective sample rate.
force_inline bool	enabled () const
	Checks if this Processor is enabled.
virtual void	enable (bool enable)
	Enables or disables this Processor.
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.

Static Public Attributes
static constexpr mono_float	kMaxPower = 20.0f
	The maximum allowable curvature/power for certain operations within the line mapping.

Protected Attributes
poly_float	offset_
	An offset that could be applied to the output (not currently set in this code).
LineGenerator *	source_
	The associated LineGenerator used for generating the values.
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
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_.
Static Protected Attributes inherited from vital::Processor
static const Output	null_source_
	A null (dummy) source used for unconnected inputs.

Detailed Description

A processor that maps a phase input through a line generator, producing a value and phase output.

The LineMap class is designed to take a phase input (e.g., from an oscillator or another modulation source) and use it to index into a line generator's data. It uses cubic interpolation to produce a continuous output value corresponding to the given phase. The result is clamped to a specified range to ensure output stability.

Member Enumeration Documentation

MapOutput

enum vital::LineMap::MapOutput

Indices of the outputs produced by LineMap.

• kValue: The interpolated value derived from the line generator for the given phase.
• kPhase: The input phase value, passed through to the output for reference.

Enumerator
kValue
kPhase
kNumOutputs

Constructor & Destructor Documentation

LineMap()

vital::LineMap::LineMap

(

LineGenerator *

source

)

Constructs a LineMap processor.

Parameters

source

Pointer to the LineGenerator object this LineMap will use for data lookup.

Member Function Documentation

clone()

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

inlineoverridevirtual

Creates a duplicate of this LineMap processor.

Returns

A pointer to the newly cloned LineMap instance.

Implements vital::Processor.

process() [1/2]

void vital::LineMap::process ( int num_samples )

overridevirtual

Processes a given number of samples at the current rate (audio or control).

This reads the input phase from the first input and calls the other process method to handle the interpolation and output generation.

Parameters

num_samples

Number of samples to process (unused directly, as we process a single value here).

High-level process call that retrieves the input phase and delegates to process(poly_float phase).

The input phase is taken from the first input's buffer at index 0. The num_samples parameter is not directly used since this processor works on a per-sample (or per-block) basis.

Implements vital::Processor.

process() [2/2]

void vital::LineMap::process

(

poly_float

phase

)

Processes a given phase value by interpolating from the line generator's data.

Parameters

phase

The input phase (0 to 1) that indexes into the line generator's precomputed line.

Interpolates a value from the line generator's data buffer based on the input phase.

The phase is scaled by the resolution of the line generator and then used to select the appropriate segment of the line. Cubic interpolation is performed to achieve smooth transitions between points. The result is clamped between -1.0f and 1.0f and written to the output buffer.

Member Data Documentation

kMaxPower

mono_float vital::LineMap::kMaxPower = 20.0f

staticconstexpr

The maximum allowable curvature/power for certain operations within the line mapping.

offset_

poly_float vital::LineMap::offset_

protected

An offset that could be applied to the output (not currently set in this code).

source_

LineGenerator* vital::LineMap::source_

protected

The associated LineGenerator used for generating the values.

---

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

• /Users/davidvogel/repos/VitalHelp/src/synthesis/modulators/line_map.h
• /Users/davidvogel/repos/VitalHelp/src/synthesis/modulators/line_map.cpp