A WavetableComponent that acts as a direct source of waveforms. More...

#include <wave_source.h>

Inheritance diagram for WaveSource:

Public Types
enum	InterpolationMode { kTime , kFrequency }
	Defines how keyframes should be interpolated. More...

Public Types inherited from WavetableComponent
enum	InterpolationStyle { kNone , kLinear , kCubic , kNumInterpolationStyles }
	Defines how interpolation is performed between keyframes. More...

Public Member Functions
	WaveSource ()
	Constructs a WaveSource with a default frequency-domain interpolation mode.

virtual	~WaveSource ()

WavetableKeyframe *	createKeyframe (int position) override
	Creates a new keyframe at a given position.

void	render (vital::WaveFrame *wave_frame, float position) override
	Renders the waveform at a given position into a WaveFrame.

WavetableComponentFactory::ComponentType	getType () override
	Returns the type of this WavetableComponent.

json	stateToJson () override
	Serializes the component’s state and all keyframes to a JSON object.

void	jsonToState (json data) override
	Restores the component’s state from a JSON object.

vital::WaveFrame *	getWaveFrame (int index)
	Gets a WaveFrame from a specified keyframe index.

WaveSourceKeyframe *	getKeyframe (int index)
	Retrieves a WaveSourceKeyframe by index.

void	setInterpolationMode (InterpolationMode mode)
	Sets the interpolation mode for morphing between keyframes.

InterpolationMode	getInterpolationMode () const
	Gets the current interpolation mode.

Public Member Functions inherited from WavetableComponent
	WavetableComponent ()
	Constructs a WavetableComponent with a default linear interpolation style.

virtual	~WavetableComponent ()

virtual void	prerender ()
	Called before rendering to perform any needed precomputation.

virtual bool	hasKeyframes ()
	Indicates whether this component relies on multiple keyframes.

void	reset ()
	Clears all keyframes and inserts a default one at position 0.

void	interpolate (WavetableKeyframe *dest, float position)
	Interpolates a destination keyframe at a given position.

WavetableKeyframe *	insertNewKeyframe (int position)
	Inserts a new keyframe at the given position, creating and sorting it into the array.

void	reposition (WavetableKeyframe *keyframe)
	Repositions a keyframe in the keyframe list after its position changed.

void	remove (WavetableKeyframe *keyframe)
	Removes a specific keyframe from the component.

int	numFrames () const
	Gets the number of keyframes.

int	indexOf (WavetableKeyframe *keyframe) const
	Finds the index of a given keyframe.

WavetableKeyframe *	getFrameAt (int index) const
	Gets a keyframe by index.

int	getIndexFromPosition (int position) const
	Finds the insertion index for a given position to keep keyframes sorted.

WavetableKeyframe *	getFrameAtPosition (int position)
	Gets a keyframe by position if one matches exactly, or nullptr otherwise.

int	getLastKeyframePosition ()
	Gets the highest position among all keyframes.

void	setInterpolationStyle (InterpolationStyle type)
	Sets the global interpolation style.

InterpolationStyle	getInterpolationStyle () const
	Gets the current global interpolation style.

Protected Attributes
std::unique_ptr< WaveSourceKeyframe >	compute_frame_
	A keyframe for intermediate interpolation computations.

InterpolationMode	interpolation_mode_
	The mode of interpolation.

Protected Attributes inherited from WavetableComponent
std::vector< std::unique_ptr< WavetableKeyframe > >	keyframes_
	The list of keyframes sorted by position.

InterpolationStyle	interpolation_style_
	Current interpolation style (none, linear, cubic).

Detailed Description

A WavetableComponent that acts as a direct source of waveforms.

WaveSource stores a series of WaveSourceKeyframes, each holding a WaveFrame (time and frequency domain data). It supports two interpolation modes:

Time interpolation: Interpolates directly between time-domain waveforms.
Frequency interpolation: Interpolates between frequency-domain representations, allowing smoother transitions with more control over harmonic phases and amplitudes.

This component provides a flexible basis for representing waves as raw data and morphing between them.

Member Enumeration Documentation

◆ InterpolationMode

enum WaveSource::InterpolationMode

Defines how keyframes should be interpolated.

Enumerator
kTime	Interpolate directly in time domain.
kFrequency	Interpolate in frequency domain.

Constructor & Destructor Documentation

◆ WaveSource()

WaveSource::WaveSource ( )

Constructs a WaveSource with a default frequency-domain interpolation mode.

◆ ~WaveSource()

WaveSource::~WaveSource ( )

virtual

Member Function Documentation

◆ createKeyframe()

WavetableKeyframe * WaveSource::createKeyframe ( int position )

overridevirtual

Creates a new keyframe at a given position.

Implemented by subclasses to produce a keyframe type suited to their functionality.

Parameters

position The wavetable frame index (0 to kNumOscillatorWaveFrames-1).

Returns: A pointer to the newly created WavetableKeyframe.

Implements WavetableComponent.

◆ getInterpolationMode()

InterpolationMode WaveSource::getInterpolationMode ( ) const

inline

Gets the current interpolation mode.

Returns: The current InterpolationMode.

◆ getKeyframe()

WaveSourceKeyframe * WaveSource::getKeyframe ( int index )

Retrieves a WaveSourceKeyframe by index.

Parameters

index The index of the desired keyframe.

Returns: A pointer to the WaveSourceKeyframe at that index.

◆ getType()

WavetableComponentFactory::ComponentType WaveSource::getType ( )

overridevirtual

Returns the type of this WavetableComponent.

Used to identify the specific component for serialization and UI mapping.

Returns: The component type enumerated in WavetableComponentFactory.

Implements WavetableComponent.

◆ getWaveFrame()

vital::WaveFrame * WaveSource::getWaveFrame ( int index )

Gets a WaveFrame from a specified keyframe index.

Parameters

index The index of the desired keyframe.

Returns: A pointer to the WaveFrame associated with the keyframe.

◆ jsonToState()

void WaveSource::jsonToState ( json data )

overridevirtual

Restores the component’s state from a JSON object.

Clears existing keyframes and reconstructs them from the provided JSON data.

Parameters

data	The JSON object containing saved state data.

Reimplemented from WavetableComponent.

◆ render()

void WaveSource::render	(	vital::WaveFrame *	wave_frame,
		float	position )

overridevirtual

Renders the waveform at a given position into a WaveFrame.

Uses interpolation between keyframes based on the current interpolation style to produce a waveform for the given position.

Parameters

wave_frame	The WaveFrame to fill with the resulting waveform.
position	The position along the wavetable dimension [0, kNumOscillatorWaveFrames-1].

Implements WavetableComponent.

◆ setInterpolationMode()

void WaveSource::setInterpolationMode ( InterpolationMode mode )

inline

Sets the interpolation mode for morphing between keyframes.

Parameters

mode	The InterpolationMode to use (time or frequency).

◆ stateToJson()

json WaveSource::stateToJson ( )

overridevirtual

Serializes the component’s state and all keyframes to a JSON object.

Returns: A JSON object representing the entire state.

Reimplemented from WavetableComponent.

Member Data Documentation

◆ compute_frame_

std::unique_ptr<WaveSourceKeyframe> WaveSource::compute_frame_

protected

A keyframe for intermediate interpolation computations.

◆ interpolation_mode_

InterpolationMode WaveSource::interpolation_mode_

protected

The mode of interpolation.

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

/Users/davidvogel/repos/VitalHelp/src/common/wavetable/wave_source.h
/Users/davidvogel/repos/VitalHelp/src/common/wavetable/wave_source.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ InterpolationMode

Constructor & Destructor Documentation

◆ WaveSource()

◆ ~WaveSource()

Member Function Documentation

◆ createKeyframe()

◆ getInterpolationMode()

◆ getKeyframe()

◆ getType()

◆ getWaveFrame()

◆ jsonToState()

◆ render()

◆ setInterpolationMode()

◆ stateToJson()

Member Data Documentation

◆ compute_frame_

◆ interpolation_mode_