Program Listing for File dm_fx_phase_shifter.h

↰ Return to documentation for file (src/effects/dm_fx_phase_shifter.h)

// Copyright (c) 2020 Run Jump Labs LLC.  All right reserved.
// This code is licensed under MIT license (see license.txt for details)

#ifndef DM_FX_PHASE_SHIFTER_H
#define DM_FX_PHASE_SHIFTER_H

class fx_phase_shifter: public fx_effect {

  private:

    // Parameters
    float param_depth;
    float param_rate_hz;
    float param_feedback;
    float param_initial_phase_deg;
    OSC_TYPES param_type;


    void init() {
        // Set class
        type = FX_PHASE_SHIFTER;

        // Set name
        strcpy(effect_name, "phase shifter");

            // Assign programmable node names
        input = &node_input;
        output = &node_output;

          // Initialize parameter stack
        int indx = 1;
        param_stack[indx] = &param_rate_hz;
        param_stack_types[indx++] = T_FLOAT;

      param_stack[indx] = &param_depth;
      param_stack_types[indx++] = T_FLOAT;

        param_stack[indx] = &param_feedback;
        param_stack_types[indx++] = T_FLOAT;

      param_stack[indx] = &param_initial_phase_deg;
      param_stack_types[indx++] = T_FLOAT;

      param_stack[indx] = &param_type;
      param_stack_types[indx++] = T_INT16;

        total_params = indx;

      // Add addiitonal notes to the control stack
      control_node_stack[total_control_nodes++] = &node_ctrl_depth;
      control_node_stack[total_control_nodes++] = &node_ctrl_rate_hz;
      control_node_stack[total_control_nodes++] = &node_ctrl_feedback;

        // Assign controls
        depth = &node_ctrl_depth;
        rate_hz = &node_ctrl_rate_hz;
        feedback = &node_ctrl_feedback;

      }

      // Control nodes
      fx_control_node node_ctrl_depth;
      fx_control_node node_ctrl_rate_hz;
      fx_control_node node_ctrl_feedback;

  public:

    fx_audio_node * input;
    fx_audio_node * output;

    fx_control_node * depth;
    fx_control_node * rate_hz;
    fx_control_node * feedback;

    fx_phase_shifter(float rate_hz, float depth, float feedback) :
        node_ctrl_depth(NODE_IN, NODE_FLOAT, "node_ctrl_depth", this, FX_PHASE_SHIFTER_PARAM_ID_DEPTH),
        node_ctrl_rate_hz(NODE_IN, NODE_FLOAT, "node_ctrl_rate_hz", this, FX_PHASE_SHIFTER_PARAM_ID_RATE_HZ),
        node_ctrl_feedback(NODE_IN, NODE_FLOAT, "node_ctrl_feedback", this, FX_PHASE_SHIFTER_PARAM_ID_FEEDBACK) {

        // Set parameters
        param_depth = depth;
        param_rate_hz = rate_hz;
        param_feedback = feedback;
        param_initial_phase_deg = 0.0;
        param_type = OSC_SINE;

        init();

    }

    fx_phase_shifter(float rate_hz, float depth, float feedback, float inital_phase, OSC_TYPES mod_type) :
      node_ctrl_depth(NODE_IN, NODE_FLOAT, "node_ctrl_depth", this, FX_PHASE_SHIFTER_PARAM_ID_DEPTH),
      node_ctrl_rate_hz(NODE_IN, NODE_FLOAT, "node_ctrl_rate_hz", this, FX_PHASE_SHIFTER_PARAM_ID_RATE_HZ),
      node_ctrl_feedback(NODE_IN, NODE_FLOAT, "node_ctrl_feedback", this, FX_PHASE_SHIFTER_PARAM_ID_FEEDBACK) {

        // Set parameters
        param_depth = depth;
        param_rate_hz = rate_hz;
        param_feedback = feedback;
        param_initial_phase_deg = inital_phase;
        param_type = mod_type;

        init();

    }


    void enable() {
      CHECK_LAST_ENABLED();
      param_enabled = true;
      parent_canvas->spi_transmit_param(FX_PHASE_SHIFTER, instance_id, T_BOOL, FX_PHASE_SHIFTER_PARAM_ID_ENABLED, (void *) &param_enabled);
    }

    void bypass() {
      CHECK_LAST_DISABLED();
      param_enabled = false;
      parent_canvas->spi_transmit_param(FX_PHASE_SHIFTER, instance_id, T_BOOL, FX_PHASE_SHIFTER_PARAM_ID_ENABLED, (void *) &param_enabled);
    }

    void set_depth(float depth) {

      CHECK_LAST(depth, param_depth);

      if (node_ctrl_depth.connected) {
        return;
      }

      param_depth = depth;
      parent_canvas->spi_transmit_param(FX_PHASE_SHIFTER, instance_id, T_FLOAT, FX_PHASE_SHIFTER_PARAM_ID_DEPTH, &param_depth);
    }

    void set_rate_hz(float rate_hz) {

      CHECK_LAST(rate_hz, param_rate_hz);

      if (node_ctrl_rate_hz.connected) {
        return;
      }

      param_rate_hz = rate_hz;
      parent_canvas->spi_transmit_param(FX_PHASE_SHIFTER, instance_id, T_FLOAT, FX_PHASE_SHIFTER_PARAM_ID_RATE_HZ, &param_rate_hz);
    }

    void set_feedback(float feedback) {

      CHECK_LAST(feedback, param_feedback);

      if (node_ctrl_rate_hz.connected) {
        return;
      }

      param_feedback = feedback;
      parent_canvas->spi_transmit_param(FX_PHASE_SHIFTER, instance_id, T_FLOAT, FX_PHASE_SHIFTER_PARAM_ID_FEEDBACK, &param_feedback);
    }

    void set_lfo_type(OSC_TYPES new_type) {

      CHECK_LAST(new_type, param_type);

      param_type = new_type;
      parent_canvas->spi_transmit_param(FX_PHASE_SHIFTER, instance_id, T_INT16, FX_PHASE_SHIFTER_PARAM_ID_MOD_TYPE, &param_type);

    }



  void  print_params(void) {

    // void print_parameter( void * val, char * name, PARAM_TYPES type)
    Serial.println("Parameters:");
    print_parameter( &param_enabled, "Enabled", T_BOOL );
    print_parameter( &param_depth, "Depth", T_FLOAT );
    print_parameter( &param_rate_hz, "Rate (Hz)", T_FLOAT );
    print_parameter( &param_feedback, "Feedback", T_FLOAT );

    Serial.println("Control Routing:");
    print_ctrl_node_status(&node_ctrl_depth);
    print_ctrl_node_status(&node_ctrl_rate_hz);
    print_ctrl_node_status(&node_ctrl_feedback);

    Serial.println("Audio Routing:");
    print_audio_node_status(&node_input);
    print_audio_node_status(&node_output);

    Serial.println();
  }

};

#endif // DM_FX_PHASE_SHIFTER_H