M166 Gradients, LCD Menu for 2-channel Mixer (Geeetech A10M/A20M) (#13022)

2019-02-10 04:54:23 -06:00
parent 7ee35c2611
commit 6de3d34378
114 changed files with 9901 additions and 61 deletions
--- a/Marlin/src/feature/mixing.h
+++ b/Marlin/src/feature/mixing.h
@@ -23,42 +23,70 @@

 #include "../inc/MarlinConfig.h"

-#ifdef __AVR__
+//#define MIXER_NORMALIZER_DEBUG
+
+#if !defined(__AVR__) // || DUAL_MIXING_EXTRUDER
+  // Use 16-bit (or fastest) data for the integer mix factors
+  typedef uint_fast16_t mixer_comp_t;
+  typedef uint_fast16_t mixer_accu_t;
+  #define COLOR_A_MASK 0x8000
+  #define COLOR_MASK 0x7FFF
+#else
+  // Use 8-bit data for the integer mix factors
+  // Exactness is sacrificed for speed
  #define MIXER_ACCU_SIGNED
  typedef uint8_t mixer_comp_t;
  typedef int8_t mixer_accu_t;
  #define COLOR_A_MASK 0x80
  #define COLOR_MASK 0x7F
-#else
-  typedef uint_fast16_t mixer_comp_t;
-  typedef uint_fast16_t mixer_accu_t;
-  #define COLOR_A_MASK 0x8000
-  #define COLOR_MASK 0x7FFF
 #endif

+typedef int8_t mixer_perc_t;
+
 #ifndef MIXING_VIRTUAL_TOOLS
  #define MIXING_VIRTUAL_TOOLS 1
 #endif

+enum MixTool {
+  FIRST_USER_VIRTUAL_TOOL = 0,
+  LAST_USER_VIRTUAL_TOOL = MIXING_VIRTUAL_TOOLS - 1,
+  NR_USER_VIRTUAL_TOOLS,
+  #ifdef RETRACT_SYNC_MIXING
+    MIXER_AUTORETRACT_TOOL = NR_USER_VIRTUAL_TOOLS,
+    NR_MIXING_VIRTUAL_TOOLS
+  #else
+    NR_MIXING_VIRTUAL_TOOLS = NR_USER_VIRTUAL_TOOLS
+  #endif
+};
+
 #ifdef RETRACT_SYNC_MIXING
-  #define NR_MIXING_VIRTUAL_TOOLS (MIXING_VIRTUAL_TOOLS + 1)
-  #define MIXER_AUTORETRACT_TOOL MIXING_VIRTUAL_TOOLS
-  #if NR_MIXING_VIRTUAL_TOOLS > 254
-    #error "MIXING_VIRTUAL_TOOLS must be <= 254!"
-  #endif
+  static_assert(NR_MIXING_VIRTUAL_TOOLS <= 254, "MIXING_VIRTUAL_TOOLS must be <= 254!");
 #else
-  #define NR_MIXING_VIRTUAL_TOOLS (MIXING_VIRTUAL_TOOLS)
-  #if NR_MIXING_VIRTUAL_TOOLS > 255
-    #error "MIXING_VIRTUAL_TOOLS must be <= 255!"
-  #endif
+  static_assert(NR_MIXING_VIRTUAL_TOOLS <= 255, "MIXING_VIRTUAL_TOOLS must be <= 255!");
 #endif

 #define MIXER_STEPPER_LOOP(VAR) \
  for (uint_fast8_t VAR = 0; VAR < MIXING_STEPPERS; VAR++)

-#define MIXER_BLOCK_FIELD      mixer_comp_t b_color[MIXING_STEPPERS]
-#define MIXER_POPULATE_BLOCK() mixer.populate_block(block->b_color)
-#define MIXER_STEPPER_SETUP()  mixer.stepper_setup(current_block->b_color)
+#define MIXER_BLOCK_FIELD       mixer_comp_t b_color[MIXING_STEPPERS]
+#define MIXER_POPULATE_BLOCK()  mixer.populate_block(block->b_color)
+#define MIXER_STEPPER_SETUP()   mixer.stepper_setup(current_block->b_color)
+
+#if ENABLED(GRADIENT_MIX)
+
+  typedef struct {
+    bool enabled;                         // This gradient is enabled
+    mixer_comp_t color[MIXING_STEPPERS];  // The current gradient color
+    float start_z, end_z;                 // Region for gradient
+    int8_t start_vtool, end_vtool;        // Start and end virtual tools
+    mixer_perc_t start_mix[MIXING_STEPPERS],   // Start and end mixes from those tools
+                 end_mix[MIXING_STEPPERS];
+    #if ENABLED(GRADIENT_VTOOL)
+      int8_t vtool_index;                 // Use this virtual tool number as index
+    #endif
+  } gradient_t;
+
+#endif

 /**
 * @brief Mixer class
@@ -67,27 +95,157 @@
 class Mixer {
  public:

-  static void init();
+  static float collector[MIXING_STEPPERS];    // M163 components, also editable from LCD
+
+  static void init(); // Populate colors at boot time

  static void reset_vtools();
+  static void refresh_collector(const float proportion=1.0, const uint8_t t=selected_vtool);

  // Used up to Planner level
+  FORCE_INLINE static void set_collector(const uint8_t c, const float f) { collector[c] = MAX(f, 0.0f); }
+
  static void normalize(const uint8_t tool_index);
+  FORCE_INLINE static void normalize() { normalize(selected_vtool); }
+
  FORCE_INLINE static uint8_t get_current_vtool() { return selected_vtool; }
-  FORCE_INLINE static void T(const uint_fast8_t c) { selected_vtool = c; }
-  FORCE_INLINE static void set_collector(const uint8_t c, const float f) { collector[c] = f; }
+
+  FORCE_INLINE static void T(const uint_fast8_t c) {
+    selected_vtool = c;
+    #if ENABLED(GRADIENT_VTOOL)
+      refresh_gradient();
+    #endif
+    #if DUAL_MIXING_EXTRUDER
+      update_mix_from_vtool();
+    #endif
+  }

  // Used when dealing with blocks
-  FORCE_INLINE static void populate_block(mixer_comp_t b_color[]) {
-    uint_fast8_t j = get_current_vtool();
-    MIXER_STEPPER_LOOP(i) b_color[i] = color[j][i];
+  FORCE_INLINE static void populate_block(mixer_comp_t b_color[MIXING_STEPPERS]) {
+    #if ENABLED(GRADIENT_MIX)
+      if (gradient.enabled) {
+        MIXER_STEPPER_LOOP(i) b_color[i] = gradient.color[i];
+        return;
+      }
+    #endif
+    MIXER_STEPPER_LOOP(i) b_color[i] = color[selected_vtool][i];
  }
-  FORCE_INLINE static void stepper_setup(mixer_comp_t b_color[]) { MIXER_STEPPER_LOOP(i) s_color[i] = b_color[i]; }
+
+  FORCE_INLINE static void stepper_setup(mixer_comp_t b_color[MIXING_STEPPERS]) {
+    MIXER_STEPPER_LOOP(i) s_color[i] = b_color[i];
+  }
+
+  #if DUAL_MIXING_EXTRUDER || ENABLED(GRADIENT_MIX)
+
+    static mixer_perc_t mix[MIXING_STEPPERS];  // Scratch array for the Mix in proportion to 100
+
+    static inline void copy_mix_to_color(mixer_comp_t (&tcolor)[MIXING_STEPPERS]) {
+      // Scale each component to the largest one in terms of COLOR_A_MASK
+      // So the largest component will be COLOR_A_MASK and the other will be in proportion to it
+      const float scale = (COLOR_A_MASK) * RECIPROCAL(float(MAX(mix[0], mix[1])));
+
+      // Scale all values so their maximum is COLOR_A_MASK
+      MIXER_STEPPER_LOOP(i) tcolor[i] = mix[i] * scale;
+
+      #ifdef MIXER_NORMALIZER_DEBUG
+        SERIAL_ECHOPAIR("Mix [", int(mix[0]));
+        SERIAL_ECHOPAIR(", ", int(mix[1]));
+        SERIAL_ECHOPAIR("] to Color [", int(tcolor[0]));
+        SERIAL_ECHOPAIR(", ", int(tcolor[1]));
+        SERIAL_ECHOLNPGM("]");
+      #endif
+    }
+
+    static inline void update_mix_from_vtool(const uint8_t j=selected_vtool) {
+      float ctot = 0;
+      MIXER_STEPPER_LOOP(i) ctot += color[j][i];
+      //MIXER_STEPPER_LOOP(i) mix[i] = 100.0f * color[j][i] / ctot;
+      mix[0] = mixer_perc_t(100.0f * color[j][0] / ctot);
+      mix[1] = 100 - mix[0];
+      #ifdef MIXER_NORMALIZER_DEBUG
+        SERIAL_ECHOPAIR("V-tool ", int(j));
+        SERIAL_ECHOPAIR(" [", int(color[j][0]));
+        SERIAL_ECHOPAIR(", ", int(color[j][1]));
+        SERIAL_ECHOPAIR("] to Mix [", int(mix[0]));
+        SERIAL_ECHOPAIR(", ", int(mix[1]));
+        SERIAL_ECHOLNPGM("]");
+      #endif
+    }
+
+  #endif // DUAL_MIXING_EXTRUDER || GRADIENT_MIX
+
+  #if DUAL_MIXING_EXTRUDER
+
+    // Update the virtual tool from an edited mix
+    static inline void update_vtool_from_mix() {
+      copy_mix_to_color(color[selected_vtool]);
+      #if ENABLED(GRADIENT_MIX)
+        refresh_gradient();
+      #endif
+      // MIXER_STEPPER_LOOP(i) collector[i] = mix[i];
+      // normalize();
+    }
+
+  #endif // DUAL_MIXING_EXTRUDER
+
+  #if ENABLED(GRADIENT_MIX)
+
+    static gradient_t gradient;
+    static float prev_z;
+
+    // Update the current mix from the gradient for a given Z
+    static void update_gradient_for_z(const float z);
+    static void update_gradient_for_planner_z();
+    static inline void gradient_control(const float z) {
+      if (gradient.enabled) {
+        if (z >= gradient.end_z)
+          T(gradient.end_vtool);
+        else
+          update_gradient_for_z(z);
+      }
+    }
+
+    static inline void update_mix_from_gradient() {
+      float ctot = 0;
+      MIXER_STEPPER_LOOP(i) ctot += gradient.color[i];
+      mix[0] = (mixer_perc_t)CEIL(100.0f * gradient.color[0] / ctot);
+      mix[1] = 100 - mix[0];
+      #ifdef MIXER_NORMALIZER_DEBUG
+        SERIAL_ECHOPAIR("Gradient [", int(gradient.color[0]));
+        SERIAL_ECHOPAIR(", ", int(gradient.color[1]));
+        SERIAL_ECHOPAIR("] to Mix [", int(mix[0]));
+        SERIAL_ECHOPAIR(", ", int(mix[1]));
+        SERIAL_ECHOLNPGM("]");
+      #endif
+    }
+
+    // Refresh the gradient after a change
+    static void refresh_gradient() {
+      #if ENABLED(GRADIENT_VTOOL)
+        const bool is_grd = (selected_vtool == gradient.vtool_index);
+      #else
+        constexpr bool is_grd = true;
+      #endif
+      gradient.enabled = is_grd && gradient.start_vtool != gradient.end_vtool && gradient.start_z < gradient.end_z;
+      if (gradient.enabled) {
+        mixer_perc_t mix_bak[MIXING_STEPPERS];
+        COPY(mix_bak, mix);
+        update_mix_from_vtool(gradient.start_vtool);
+        COPY(gradient.start_mix, mix);
+        update_mix_from_vtool(gradient.end_vtool);
+        COPY(gradient.end_mix, mix);
+        update_gradient_for_planner_z();
+        COPY(mix, mix_bak);
+        prev_z = -1;
+      }
+    }
+
+  #endif // GRADIENT_MIX

  // Used in Stepper
  FORCE_INLINE static uint8_t get_stepper() { return runner; }
  FORCE_INLINE static uint8_t get_next_stepper() {
-    do {
+    for (;;) {
      if (--runner < 0) runner = MIXING_STEPPERS - 1;
      accu[runner] += s_color[runner];
      if (
@@ -100,14 +258,13 @@ class Mixer {
        accu[runner] &= COLOR_MASK;
        return runner;
      }
-    } while( true );
+    }
  }

  private:

  // Used up to Planner level
  static uint_fast8_t selected_vtool;
-  static float        collector[MIXING_STEPPERS];
  static mixer_comp_t color[NR_MIXING_VIRTUAL_TOOLS][MIXING_STEPPERS];

  // Used in Stepper