Loading...
Searching...
No Matches
MayaFlux::Nodes::Filters::Filter Class Referenceabstract
Base class for computational signal transformers implementing difference equations. More...
#include <Filter.hpp>
Inheritance diagram for MayaFlux::Nodes::Filters::Filter: Collaboration diagram for MayaFlux::Nodes::Filters::Filter:Public Member Functions | |
| void | add_coef (int index, double value, coefficients type=coefficients::ALL) |
| Modifies a specific coefficient. | |
| void | clear_input_context () |
| Clear external input context, resume internal accumulation. | |
| Filter (const std::shared_ptr< Node > &input, const std::string &zindex_shifts) | |
| Constructor using string-based filter configuration. | |
| Filter (const std::shared_ptr< Node > &input, const std::vector< double > &a_coef, const std::vector< double > &b_coef) | |
| Constructor using explicit coefficient vectors. | |
| Filter (const std::vector< double > &a_coef, const std::vector< double > &b_coef) | |
| Constructor using explicit coefficient vectors (no input node) | |
| int | get_current_latency () const |
| Gets the current processing latency of the filter. | |
| std::pair< int, int > | get_current_shift () const |
| Gets the current shift configuration. | |
| std::complex< double > | get_frequency_response (double frequency, double sample_rate) const |
| Calculates the complex frequency response at a specific frequency. | |
| double | get_gain () const |
| Gets the current gain value. | |
| const std::vector< double > & | get_input_history () const |
| Gets the input history buffer. | |
| std::shared_ptr< Node > | get_input_node () |
| Gets the input node for the filter. | |
| NodeContext & | get_last_context () override |
| Gets the last created context object. | |
| double | get_magnitude_response (double frequency, double sample_rate) const |
| Calculates the magnitude response at a specific frequency. | |
| int | get_order () const |
| Gets the filter's order. | |
| const std::vector< double > & | get_output_history () const |
| Gets the output history buffer. | |
| double | get_phase_response (double frequency, double sample_rate) const |
| Calculates the phase response at a specific frequency. | |
| const std::vector< double > & | getACoefficients () const |
| Gets the feedback (denominator) coefficients. | |
| const std::vector< double > & | getBCoefficients () const |
| Gets the feedforward (numerator) coefficients. | |
| bool | is_bypass_enabled () const |
| Checks if bypass is currently enabled. | |
| void | normalize_coefficients (coefficients type=coefficients::ALL) |
| Normalizes filter coefficients. | |
| std::vector< double > | process_batch (unsigned int num_samples) override |
| Calculates the phase response at a specific frequency. | |
| double | process_sample (double input=0.) override=0 |
| Processes a single sample through the filter. | |
| virtual void | reset () |
| Resets the filter's internal state. | |
| void | set_bypass (bool enable) |
| Enables or disables filter bypass. | |
| void | set_coefs (const std::vector< double > &new_coefs, coefficients type=coefficients::ALL) |
| Updates filter coefficients. | |
| void | set_gain (double new_gain) |
| Sets the filter's output gain. | |
| void | set_gpu_compatible (bool compatible) override |
| Sets whether the node is compatible with GPU processing. | |
| void | set_input_context (std::span< double > context) |
| Provide external buffer context for input history. | |
| void | set_input_node (const std::shared_ptr< Node > &input_node) |
| Sets the input node for the filter. | |
| void | set_shift (std::string &zindex_shifts) |
| Updates the filter's shift configuration. | |
| void | setACoefficients (const std::vector< double > &new_coefs) |
| Updates the feedback (denominator) coefficients. | |
| void | setBCoefficients (const std::vector< double > &new_coefs) |
| Updates the feedforward (numerator) coefficients. | |
| void | update_coef_from_input (int length, coefficients type=coefficients::ALL) |
| Updates coefficients from the filter's own input. | |
| void | update_coefs_from_node (int length, const std::shared_ptr< Node > &source, coefficients type=coefficients::ALL) |
| Updates coefficients from another node's output. | |
| bool | using_external_input_context () const |
| ~Filter () override=default | |
| Virtual destructor. | |
| Public Member Functions inherited from MayaFlux::Nodes::Node | |
| void | add_buffer_reference () |
| Increments the buffer reference count This method is called when a new buffer starts using this node to ensure proper lifecycle management. | |
| uint64_t | get_active_snapshot_context () const |
| Get the active snapshot context ID. | |
| const std::atomic< uint32_t > & | get_channel_mask () const |
| Retrieves the current bitmask of active channels using this node. | |
| uint32_t | get_frame_rate () const |
| std::span< const float > | get_gpu_data_buffer () const |
| Provides access to the GPU data buffer. | |
| virtual double | get_last_output () |
| Retrieves the most recent output value produced by the node. | |
| RoutingState & | get_routing_state () |
| Retrieves the current routing state of the network (non-const) | |
| const RoutingState & | get_routing_state () const |
| Retrieves the current routing state of the network. | |
| uint32_t | get_sample_rate () const |
| bool | has_active_snapshot () const |
| Check if node is currently being snapshotted by any context. | |
| bool | has_capability (NodeCapability cap) const |
| Query a single capability. | |
| bool | is_buffer_processed () const |
| Checks if the buffer has been processed. | |
| bool | is_gpu_compatible () const |
| Checks if the node supports GPU processing. | |
| bool | is_in_network () const |
| Sets whether the node is part of a NodeNetwork. | |
| bool | is_in_snapshot_context (uint64_t context_id) const |
| Check if currently in a snapshot context. | |
| bool | is_used_by_channel (uint32_t channel_id) const |
| Checks if the node is currently used by a specific channel. | |
| bool | mark_buffer_processed () |
| Marks the node as having been processed by a buffer. | |
| bool | needs_channel_routing () const |
| Checks if the network is currently in a routing transition phase. | |
| virtual uint8_t | node_capabilities () const |
| Declare which data shapes this node's context can produce. | |
| virtual void | on_tick (const NodeHook &callback) |
| Registers a callback to be called on each tick. | |
| virtual void | on_tick_if (const NodeCondition &condition, const NodeHook &callback) |
| Registers a conditional callback. | |
| void | register_channel_usage (uint32_t channel_id) |
| Mark the specificed channel as a processor/user. | |
| void | release_snapshot_context (uint64_t context_id) |
| Release snapshot context. | |
| virtual void | remove_all_hooks () |
| Removes all registered callbacks. | |
| void | remove_buffer_reference () |
| Decrements the buffer reference count This method is called when a buffer stops using this node to ensure proper lifecycle management. | |
| virtual bool | remove_conditional_hook (const NodeCondition &callback) |
| Removes a previously registered conditional callback. | |
| virtual bool | remove_hook (const NodeHook &callback) |
| Removes a previously registered callback. | |
| void | request_buffer_reset () |
| Requests a reset of the buffer state. | |
| void | request_reset_from_channel (uint32_t channel_id) |
| Requests a reset of the processed state from a specific channel. | |
| virtual void | reset_processed_state () |
| Resets the processed state of the node and any attached input nodes. | |
| virtual void | restore_state ()=0 |
| Restores the node's state from the last save Recursively cascades through all connected modulator nodes Protected - only NodeSourceProcessor and NodeBuffer can call. | |
| virtual void | save_state ()=0 |
| Saves the node's current state for later restoration Recursively cascades through all connected modulator nodes Protected - only NodeSourceProcessor and NodeBuffer can call. | |
| void | set_frame_rate (uint32_t frame_rate) |
| void | set_in_network (bool networked) |
| Marks the node as being part of a NodeNetwork. | |
| void | set_sample_rate (uint32_t sample_rate) |
| bool | try_claim_snapshot_context (uint64_t context_id) |
| Attempt to claim snapshot context for this processing cycle. | |
| void | unregister_channel_usage (uint32_t channel_id) |
| Removes the specified channel from the usage tracking. | |
| virtual | ~Node ()=default |
| Virtual destructor for proper cleanup of derived classes. | |
Protected Member Functions | |
| void | add_coef_internal (uint64_t index, double value, std::vector< double > &buffer) |
| Modifies a specific coefficient in a coefficient buffer. | |
| void | build_input_history (double current_sample) |
| Builds input history from external context or internal accumulation. | |
| virtual void | initialize_shift_buffers () |
| Initializes the input and output history buffers. | |
| void | notify_tick (double value) override |
| Notifies all registered callbacks with the current filter context. | |
| void | update_context (double value) override |
| Updates filter-specific context object. | |
| virtual void | update_inputs (double current_sample) |
| Updates the input history buffer with a new sample. | |
| virtual void | update_outputs (double current_sample) |
| Updates the output history buffer with a new sample. | |
| Protected Member Functions inherited from MayaFlux::Nodes::Node | |
| virtual void | reset_processed_state_internal () |
| Resets the processed state of the node directly. | |
Protected Attributes | |
| bool | m_bypass_enabled {} |
| Flag to bypass filter processing. | |
| std::vector< double > | m_coef_a |
| Feedback (denominator) coefficients. | |
| std::vector< double > | m_coef_b |
| Feedforward (numerator) coefficients. | |
| FilterContext | m_context |
| FilterContextGpu | m_context_gpu |
| std::span< double > | m_external_input_context |
| External input context for input history. | |
| double | m_gain = 1.0 |
| Overall gain factor applied to the filter output. | |
| std::vector< double > | m_input_history |
| Buffer storing previous input samples. | |
| std::shared_ptr< Node > | m_input_node |
| The most recent sample value generated by this oscillator. | |
| std::vector< double > | m_output_history |
| Buffer storing previous output samples. | |
| std::vector< double > | m_saved_input_history |
| std::vector< double > | m_saved_output_history |
| std::pair< int, int > | m_shift_config |
| Configuration for input and output buffer sizes. | |
| bool | m_use_external_input_context {} |
| Protected Attributes inherited from MayaFlux::Nodes::Node | |
| std::vector< NodeHook > | m_callbacks |
| Collection of standard callback functions. | |
| std::vector< std::pair< NodeHook, NodeCondition > > | m_conditional_callbacks |
| Collection of conditional callback functions with their predicates. | |
| uint32_t | m_frame_rate { 60 } |
| Frame rate for time-based processing, used for normalization. | |
| bool | m_gpu_compatible {} |
| Flag indicating if the node supports GPU processing This flag is set by derived classes to indicate whether the node can be processed on the GPU. | |
| std::vector< float > | m_gpu_data_buffer |
| GPU data buffer for context objects. | |
| double | m_last_output { 0 } |
| The most recent sample value generated by this oscillator. | |
| bool | m_networked_node {} |
| Flag indicating if the node is part of a NodeNetwork This flag is used to disable event firing when the node is managed within a NodeNetwork, preventing redundant or conflicting event notifications. | |
| uint8_t | m_node_capability { NodeCapability::SCALAR } |
| Bitmask of capabilities declared by this node. | |
| uint32_t | m_sample_rate { 48000 } |
| Sample rate for audio processing, used for normalization. | |
| bool | m_state_saved {} |
| tracks if the node's state has been saved by a snapshot operation | |
| uint32_t | m_timing_rate { m_sample_rate } |
| Current timing rate for the node, used for timing calculations (can be sample rate or frame rate) | |
Additional Inherited Members | |
| Public Attributes inherited from MayaFlux::Nodes::Node | |
| bool | m_fire_events_during_snapshot = false |
| Internal flag controlling whether notify_tick fires during state snapshots Default: false (events don't fire during isolated buffer processing) Can be exposed in future if needed via concrete implementation in parent. | |
| std::atomic< uint32_t > | m_modulator_count { 0 } |
| Counter tracking how many other nodes are using this node as a modulator. | |
| std::atomic< NodeState > | m_state { NodeState::INACTIVE } |
| Atomic state flag tracking the node's processing status. | |
Detailed Description
Base class for computational signal transformers implementing difference equations.
The Filter class provides a comprehensive framework for implementing digital transformations based on difference equations. It transcends traditional audio filtering concepts, offering a flexible foundation for:
- Complex resonant systems for generative synthesis
- Computational physical modeling components
- Recursive signal transformation algorithms
- Data-driven transformation design from frequency responses
- Dynamic coefficient modulation for emergent behaviors
At its core, the Filter implements the general difference equation: y[n] = (b₀x[n] + b₁x[n-1] + ... + bₘx[n-m]) - (a₁y[n-1] + ... + aₙy[n-n])
Where:
- x[n] are input values
- y[n] are output values
- b coefficients apply to input values (feedforward)
- a coefficients apply to previous output values (feedback)
This mathematical structure can represent virtually any linear time-invariant system, making it a powerful tool for signal transformation across domains. The same equations can process audio, control data, or even be applied to visual or physical simulation parameters.
Definition at line 149 of file Filter.hpp.
The documentation for this class was generated from the following files:
