animation.h

Go to the documentation of this file.

#pragma once
#include "esphome/core/defines.h"
 
#ifdef USE_LVGL_ANIMATION
#include "lvgl_esphome.h"
#include "esphome/core/hal.h"
#include "esphome/core/helpers.h"
 
namespace esphome::lvgl {
 
enum class AnimationState {
  STOPPED,
  STARTED,
  RUNNING,
};
 
class LvAnimationTiming {
 public:
  // Map progress in the range [0, 1]
  virtual float map_progress(float value) = 0;
};
 
class LvAnimationTimingRoundTrip : public LvAnimationTiming {
 public:
  // moving_length_ is the fraction of progress spent moving in each direction, in (0, 0.5].
  // Callers must pass pause in [0, 1) -- pause == 1.0 would make moving_length_ zero and divide by zero below.
  LvAnimationTimingRoundTrip(float pause) : moving_length_((1.0f - pause) / 2.0f) {}
  float map_progress(float value) override {
    if (value < this->moving_length_) {
      return value / this->moving_length_;
    }
    if (value > 1.0f - this->moving_length_) {
      return (1.0f - value) / this->moving_length_;
    }
    // pause in the middle
    return 1.0f;
  }
 
 protected:
  float moving_length_{};
};
 
class LvAnimationTimingGravity : public LvAnimationTiming {
 public:
  LvAnimationTimingGravity(float acceleration, float bounce) : acceleration_(acceleration), bounce_(bounce) {}
  float map_progress(float value) override {
    if (value == 0.0f) {
      this->initial_position_ = 0.0f;
      this->initial_speed_ = 0.0f;
      this->initial_time_ = 0.0f;
    }
    auto position = this->calc_pos_(value);
    if (position > 1.0f) {
      auto initial_time = this->calc_end_time_();
      this->initial_speed_ = -this->calc_speed_(initial_time) * this->bounce_;
      this->initial_position_ = 1.0f;
      this->initial_time_ = initial_time;
      position = calc_pos_(value);
      if (position > 1.0f) {
        position = 1.0f;
      }
    }
    return position;
  }
 
 protected:
  float calc_pos_(float value) const {
    value -= this->initial_time_;
    return (0.5 * value * this->acceleration_ + this->initial_speed_) * value + this->initial_position_;
  }
 
  float calc_speed_(float value) const {
    value -= this->initial_time_;
    return this->acceleration_ * value + this->initial_speed_;
  }
 
  float calc_end_time_() const {
    return (-this->initial_speed_ + std::sqrt(this->initial_speed_ * this->initial_speed_ -
                                              4.0f * this->acceleration_ / 2.0 * (this->initial_position_ - 1.0f))) /
               this->acceleration_ +
           this->initial_time_;
  }
 
  float acceleration_;
  float bounce_;
  float initial_position_{0.0f};
  float initial_time_{0.0f};
  float initial_speed_{0.0f};
};
 
class LvAnimationTimingEaseInOut : public LvAnimationTiming {
 public:
  LvAnimationTimingEaseInOut(float slope) : slope_(slope) {}
  float map_progress(float value) override {
    float sqr = value * value;
    sqr = sqr / (2.0f * (sqr - value) + 1.0f);
    return this->slope_ * sqr + (1.0 - this->slope_) * value;
  }
 
 protected:
  float slope_;
};
 
class LvAnimationTimingEaseIn : public LvAnimationTiming {
 public:
  LvAnimationTimingEaseIn(float slope) : slope_(slope) {}
  float map_progress(float value) override {
    const float sqr = value * value;
    return this->slope_ * sqr + (1.0f - this->slope_) * value;
  }
 
 protected:
  float slope_;
};
 
class LvAnimationTimingEaseOut : public LvAnimationTiming {
 public:
  LvAnimationTimingEaseOut(float slope) : slope_(slope) {}
  float map_progress(float value) override {
    const float inv = 1.0f - value;
    const float sqr = 1.0f - inv * inv;
    return this->slope_ * sqr + (1.0f - this->slope_) * value;
  }
 
 protected:
  float slope_;
};
 
template<size_t DATA_SIZE, bool AUTO_START = false> class LvAnimation : public Component {
 public:
  LvAnimation(void (*update_callback)(const lv_coord_t *data), std::vector<TemplatableValue<lv_coord_t>> from,
              std::vector<TemplatableValue<lv_coord_t>> to)
      : update_callback_(update_callback) {
    std::copy(from.begin(), from.end(), this->from_);
    std::copy(to.begin(), to.end(), this->to_);
  }
 
  void start() {
    if (!this->prepare_())
      return;
    this->loop();
    this->start_callback_.call();
  }
 
  void stop() {
    // Only fire the stop callback on a genuine running -> stopped transition, so that
    // repeated stop() calls (e.g. start() pre-clearing a stopped animation) don't re-fire it.
    if (this->state_ == AnimationState::STOPPED)
      return;
    this->state_ = AnimationState::STOPPED;
    this->stop_callback_.call();
  }
 
  void setup() override {
    if constexpr (AUTO_START)
      this->start();
  }
 
  void loop() override {
    if (this->state_ == AnimationState::STOPPED)
      return;
    uint32_t elapsed = millis() - this->start_time_;
    float progress = clamp_at_most(elapsed / static_cast<float>(this->duration_), 1.0f);
    switch (this->state_) {
      case AnimationState::STARTED:
        if (elapsed < this->start_delay_)
          return;
        this->state_ = AnimationState::RUNNING;
        this->start_time_ = millis();
        elapsed = 0;
        progress = 0.0f;
        break;
      case AnimationState::RUNNING:
        break;
      default:
        return;
    }
 
    // state here is RUNNING.
    for (auto *timing : this->timings_) {
      // avoid overshooting
      progress = clamp_at_most(timing->map_progress(progress), 1.0f);
    }
    lv_coord_t data[DATA_SIZE];
    for (size_t i = 0; i != DATA_SIZE; i++) {
      data[i] = static_cast<lv_coord_t>(
          roundf(this->data_from_[i] + static_cast<lv_coord_t>(this->data_to_[i] - this->data_from_[i]) * progress));
    }
    this->update_callback_(data);
    if (elapsed >= this->duration_) {
      this->stop();
      // Restart without drawing the first frame now, so the final frame is not overwritten before it is shown
      if (this->loop_ && this->prepare_())
        this->start_callback_.call();
    }
  }
 
  float get_setup_priority() const override { return setup_priority::PROCESSOR - 20.0; }
  void set_duration(uint32_t duration) { this->duration_ = duration; }
  void set_start_delay(uint32_t start_delay) { this->start_delay_ = start_delay; }
  void add_timing(LvAnimationTiming *timing) { this->timings_.push_back(timing); }
  void set_loop(bool loop) { this->loop_ = loop; }
 
  template<typename F> void add_on_start_callback(F &&callback) {
    this->start_callback_.add(std::forward<F>(callback));
  }
  template<typename F> void add_on_stop_callback(F &&callback) { this->stop_callback_.add(std::forward<F>(callback)); }
 
 protected:
  // Arms a new run. Returns false if there is nothing to run.
  bool prepare_() {
    if (this->state_ > AnimationState::STOPPED)
      this->stop();
    if (this->duration_ == 0)
      return false;
    // evaluate any lambdas
    for (size_t i = 0; i != DATA_SIZE; i++) {
      this->data_from_[i] = this->from_[i].value();
      this->data_to_[i] = this->to_[i].value();
    }
    this->start_time_ = millis();
    this->state_ = AnimationState::STARTED;
    return true;
  }
 
  void (*const update_callback_)(const lv_coord_t *data);
  LazyCallbackManager<void()> start_callback_{};
  LazyCallbackManager<void()> stop_callback_{};
  TemplatableValue<lv_coord_t> from_[DATA_SIZE]{};
  TemplatableValue<lv_coord_t> to_[DATA_SIZE]{};
  uint32_t duration_{0};
  uint32_t start_delay_{0};
  uint32_t start_time_{0};
  lv_coord_t data_from_[DATA_SIZE]{0};
  lv_coord_t data_to_[DATA_SIZE]{0};
  AnimationState state_{AnimationState::STOPPED};
  std::vector<LvAnimationTiming *> timings_{};
  bool loop_{false};
};
 
}  // namespace esphome::lvgl
 
#endif  // USE_LVGL_ANIMATION