A Processor that reads from a Sample object, providing audio output with controls for looping, pitch transposition, and panning. More...

#include <sample_source.h>

Inheritance diagram for vital::SampleSource:

Public Types
enum	{ kReset , kMidi , kKeytrack , kLevel , kRandomPhase , kTranspose , kTransposeQuantize , kTune , kLoop , kBounce , kPan , kNoteCount , kNumInputs }
	Indices for input parameters in this Processor. More...

enum	{ kRaw , kLevelled , kNumOutputs }
	Indices for output signals from this Processor. More...

Public Member Functions
	SampleSource ()
	Default constructor initializes internal state and random generator.

virtual void	process (int num_samples) override
	Processes audio for `num_samples`, reading from the Sample and applying pitch, loop, etc.

virtual Processor *	clone () const override
	Clones the SampleSource (copy constructor).

Sample *	getSample ()
	Provides access to the owned Sample object.

force_inline Output *	getPhaseOutput () const
	Retrieves an additional output that reflects the playback phase (in [0..1]) for debugging or usage.

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	kMaxTranspose = 96.0f
	Maximum positive transposition in semitones.

static constexpr mono_float	kMinTranspose = -96.0f
	Minimum negative transposition in semitones.

static constexpr mono_float	kMaxAmplitude = 1.41421356237f
	Maximum amplitude scale (usually sqrt(2) for stereo).

static constexpr int	kNumDownsampleTaps = 55
	Number of taps used in the downsampling filter.

static constexpr int	kNumUpsampleTaps = 52
	Number of taps used in the upsampling filter.

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_.

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.

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 reads from a Sample object, providing audio output with controls for looping, pitch transposition, and panning.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Indices for input parameters in this Processor.

Enumerator
kReset	Reset signal (trigger) to re-initialize playback.
kMidi	MIDI note input.
kKeytrack	Boolean-like input indicating if MIDI note should track pitch.
kLevel	Overall amplitude scale.
kRandomPhase	If true, randomize phase on note start.
kTranspose	Transposition in semitones from the current note.
kTransposeQuantize	Quantize transposition to scale or semitones.
kTune	Fine-tune in cents.
kLoop	If non-zero, the sample loops.
kBounce	If non-zero, sample playback bounces (back/forth).
kPan	Stereo panning control.
kNoteCount	Tracks how many notes have been pressed.
kNumInputs

◆ anonymous enum

anonymous enum

Indices for output signals from this Processor.

Enumerator
kRaw	The raw sample output (before final amplitude).
kLevelled	The amplitude-scaled output.
kNumOutputs

Constructor & Destructor Documentation

◆ SampleSource()

vital::SampleSource::SampleSource ( )

Default constructor initializes internal state and random generator.

Member Function Documentation

◆ clone()

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

inlineoverridevirtual

Clones the SampleSource (copy constructor).

Returns: A new allocated SampleSource pointer.

Implements vital::Processor.

◆ getPhaseOutput()

force_inline Output * vital::SampleSource::getPhaseOutput ( ) const

inline

Retrieves an additional output that reflects the playback phase (in [0..1]) for debugging or usage.

Returns: A pointer to a control-rate Output that stores the current playback phase.

◆ getSample()

Sample * vital::SampleSource::getSample ( )

inline

Provides access to the owned Sample object.

Returns: A pointer to the Sample owned by this SampleSource.

◆ process()

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

overridevirtual

Processes audio for num_samples, reading from the Sample and applying pitch, loop, etc.

Parameters

num_samples Number of samples to process.

Implements vital::Processor.

Member Data Documentation

◆ kMaxAmplitude

mono_float vital::SampleSource::kMaxAmplitude = 1.41421356237f

staticconstexpr

Maximum amplitude scale (usually sqrt(2) for stereo).

◆ kMaxTranspose

mono_float vital::SampleSource::kMaxTranspose = 96.0f

staticconstexpr

Maximum positive transposition in semitones.

◆ kMinTranspose

mono_float vital::SampleSource::kMinTranspose = -96.0f

staticconstexpr

Minimum negative transposition in semitones.

◆ kNumDownsampleTaps

int vital::SampleSource::kNumDownsampleTaps = 55

staticconstexpr

Number of taps used in the downsampling filter.

◆ kNumUpsampleTaps

int vital::SampleSource::kNumUpsampleTaps = 52

staticconstexpr

Number of taps used in the upsampling filter.

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

/Users/davidvogel/repos/VitalHelp/src/synthesis/producers/sample_source.h
/Users/davidvogel/repos/VitalHelp/src/synthesis/producers/sample_source.cpp

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ SampleSource()

Member Function Documentation

◆ clone()

◆ getPhaseOutput()

◆ getSample()

◆ process()

Member Data Documentation

◆ kMaxAmplitude

◆ kMaxTranspose

◆ kMinTranspose

◆ kNumDownsampleTaps

◆ kNumUpsampleTaps