A processor that generates an envelope signal based on typical ADSR (Attack, Decay, Sustain, Release) parameters. More...

#include <envelope.h>

Inheritance diagram for vital::Envelope:

Public Types
enum	{ kDelay , kAttack , kAttackPower , kHold , kDecay , kDecayPower , kSustain , kRelease , kReleasePower , kTrigger , kNumInputs }
	Input parameter indices for the Envelope processor. More...

enum	ProcessorOutput { kValue , kPhase , kNumOutputs }
	Output indices for the Envelope processor. More...

Public Member Functions
	Envelope ()
	Constructs a new Envelope processor with default parameters.

virtual	~Envelope ()
	Destroys the Envelope processor.

virtual Processor *	clone () const override
	Clones the Envelope processor, creating a new instance with identical settings.

virtual void	process (int num_samples) override
	Processes a block of samples. The processing mode (control-rate or audio-rate) is determined by the parent Processor class.

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.

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 generates an envelope signal based on typical ADSR (Attack, Decay, Sustain, Release) parameters.

The Envelope class controls the amplitude of a signal over time based on configurable segments (Delay, Attack, Hold, Decay, Sustain, and Release). It inherits from Processor, allowing it to be integrated into a larger signal processing chain. The envelope can be triggered and retriggered, transitioning through states that define its shape.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Input parameter indices for the Envelope processor.

kDelay: The delay time before the envelope starts rising.
kAttack: The time taken for the envelope to rise from 0 to its peak value.
kAttackPower: A curvature parameter for the attack phase.
kHold: The time the envelope stays at its peak level after attack.
kDecay: The time taken for the envelope to fall from its peak to the sustain level.
kDecayPower: A curvature parameter for the decay phase.
kSustain: The level that the envelope holds after decay until release is triggered.
kRelease: The time taken for the envelope to fall from the sustain level back to 0 after release is triggered.
kReleasePower: A curvature parameter for the release phase.
kTrigger: Triggers the envelope (e.g., note on/off events).

Enumerator
kDelay
kAttack
kAttackPower
kHold
kDecay
kDecayPower
kSustain
kRelease
kReleasePower
kTrigger
kNumInputs

◆ ProcessorOutput

enum vital::Envelope::ProcessorOutput

Output indices for the Envelope processor.

kValue: The current amplitude value of the envelope.
kPhase: The current phase/state of the envelope (including position within a segment).

Enumerator
kValue
kPhase
kNumOutputs

Constructor & Destructor Documentation

◆ Envelope()

vital::Envelope::Envelope ( )

Constructs a new Envelope processor with default parameters.

◆ ~Envelope()

virtual vital::Envelope::~Envelope ( )

inlinevirtual

Destroys the Envelope processor.

Member Function Documentation

◆ clone()

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

inlineoverridevirtual

Clones the Envelope processor, creating a new instance with identical settings.

Returns: A pointer to the newly cloned Envelope instance.

Implements vital::Processor.

◆ process()

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

overridevirtual

Processes a block of samples. The processing mode (control-rate or audio-rate) is determined by the parent Processor class.

Parameters

num_samples The number of samples to process.