A WavetableComponent that applies frequency-domain filtering to a wavetable frame. More...

#include <frequency_filter_modifier.h>

Inheritance diagram for FrequencyFilterModifier:

Classes
class	FrequencyFilterModifierKeyframe
	A keyframe class for frequency filtering parameters at a given position. More...

Public Types
enum	FilterStyle { kLowPass , kBandPass , kHighPass , kComb , kNumFilterStyles }
	Specifies the type of frequency-domain filter to apply. More...

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

Public Member Functions
	FrequencyFilterModifier ()
	Constructs a FrequencyFilterModifier with default low-pass style and normalization enabled.

virtual	~FrequencyFilterModifier ()

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

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

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

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

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

FrequencyFilterModifierKeyframe *	getKeyframe (int index)

FilterStyle	getStyle ()

bool	getNormalize ()

void	setStyle (FilterStyle style)

void	setNormalize (bool normalize)

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
FilterStyle	style_
	The filtering style currently used.

bool	normalize_
	Whether to normalize waves after filtering.

FrequencyFilterModifierKeyframe	compute_frame_
	A keyframe used for intermediate computation.

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 applies frequency-domain filtering to a wavetable frame.

The FrequencyFilterModifier allows shaping the frequency content of a wave by applying a low-pass, band-pass, high-pass, or comb filter directly to the frequency domain of a wavetable frame. It can also optionally normalize the resulting frame to maintain consistent amplitude.

Member Enumeration Documentation

◆ FilterStyle

enum FrequencyFilterModifier::FilterStyle

Specifies the type of frequency-domain filter to apply.

Enumerator
kLowPass	Attenuates frequencies above a cutoff.
kBandPass	Allows frequencies around the cutoff and attenuates others.
kHighPass	Attenuates frequencies below a cutoff.
kComb	A comb-like filter pattern in frequency domain.
kNumFilterStyles

Constructor & Destructor Documentation

◆ FrequencyFilterModifier()

FrequencyFilterModifier::FrequencyFilterModifier ( )

inline

Constructs a FrequencyFilterModifier with default low-pass style and normalization enabled.

◆ ~FrequencyFilterModifier()

virtual FrequencyFilterModifier::~FrequencyFilterModifier ( )

inlinevirtual

Member Function Documentation

◆ createKeyframe()

WavetableKeyframe * FrequencyFilterModifier::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.

◆ getKeyframe()

FrequencyFilterModifier::FrequencyFilterModifierKeyframe * FrequencyFilterModifier::getKeyframe ( int index )

◆ getNormalize()

bool FrequencyFilterModifier::getNormalize ( )

inline

◆ getStyle()

FilterStyle FrequencyFilterModifier::getStyle ( )

inline

◆ getType()

WavetableComponentFactory::ComponentType FrequencyFilterModifier::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.

◆ jsonToState()

void FrequencyFilterModifier::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 FrequencyFilterModifier::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.

◆ setNormalize()

void FrequencyFilterModifier::setNormalize ( bool normalize )

inline

◆ setStyle()

void FrequencyFilterModifier::setStyle ( FilterStyle style )

inline

◆ stateToJson()

json FrequencyFilterModifier::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_

FrequencyFilterModifierKeyframe FrequencyFilterModifier::compute_frame_

protected

A keyframe used for intermediate computation.

◆ normalize_

bool FrequencyFilterModifier::normalize_

protected

Whether to normalize waves after filtering.

◆ style_

FilterStyle FrequencyFilterModifier::style_

protected

The filtering style currently used.

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

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

Classes

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ FilterStyle

Constructor & Destructor Documentation

◆ FrequencyFilterModifier()

◆ ~FrequencyFilterModifier()

Member Function Documentation

◆ createKeyframe()

◆ getKeyframe()

◆ getNormalize()

◆ getStyle()

◆ getType()

◆ jsonToState()

◆ render()

◆ setNormalize()

◆ setStyle()

◆ stateToJson()

Member Data Documentation

◆ compute_frame_

◆ normalize_

◆ style_