SignalDisplay.hpp

#pragma once
#include <Process/Dataflow/NodeItem.hpp>
 
#include <Scenario/Document/Interval/IntervalModel.hpp>
 
#include <Effect/EffectLayer.hpp>
#include <Effect/EffectLayout.hpp>
 
#include <score/application/GUIApplicationContext.hpp>
 
#include <ossia/detail/math.hpp>
#include <ossia/detail/parse_strict.hpp>
#include <ossia/math/safe_math.hpp>
#include <ossia/network/value/format_value.hpp>
#include <ossia/network/value/value_conversion.hpp>
 
#include <QPainter>
 
#include <halp/audio.hpp>
#include <halp/callback.hpp>
#include <halp/controls.hpp>
#include <halp/meta.hpp>
 
namespace Ui
{
using value_out = halp::callback<"out", ossia::value>;
};
namespace Ui::SignalDisplay
{
struct Node
{
  halp_meta(name, "Signal display")
  halp_meta(c_name, "SignalDisplay")
  halp_meta(category, "Monitoring")
  halp_meta(author, "ossia score")
  halp_meta(
      manual_url,
      "https://ossia.io/score-docs/common-practices/"
      "4-audio.html#analysing-an-audio-signal")
  halp_meta(description, "Visualize an input signal")
  halp_meta(uuid, "9906e563-ddeb-4ecd-908c-952baee2a0a5")
  halp_flag(fully_custom_item);
  halp_flag(temporal);
  halp_flag(loops_by_default);
  halp_flag(ossia_show_ports_by_default);
 
  using vec_type = boost::container::small_vector<float, 8>;
  struct
  {
    struct : halp::val_port<"in", std::optional<ossia::value>>
    {
      enum widget
      {
        control
      };
    } port;
  } inputs;
 
  struct
  {
    struct : halp::val_port<"out", std::optional<vec_type>>
    {
      enum widget
      {
        control
      };
    } port;
  } outputs;
 
  struct value_visitor
  {
    vec_type& ret;
    void operator()() const noexcept { }
    void operator()(ossia::impulse) const noexcept { ret.push_back(1.f); }
    void operator()(int v) const noexcept { ret.push_back(v); }
    void operator()(float v) const noexcept { ret.push_back(v); }
    void operator()(bool v) const noexcept { ret.push_back(v ? 1.f : 0.f); }
    void operator()(std::string_view v) const noexcept
    {
      if(auto res = ossia::parse_strict<float>(v))
        ret.push_back(*res);
    }
    template <std::size_t N>
    void operator()(std::array<float, N> arr) const noexcept
    {
      ret.insert(ret.end(), arr.begin(), arr.end());
    }
    void operator()(const std::vector<ossia::value>& arr) const noexcept
    {
      ret.reserve(1 + arr.size());
      for(auto& val : arr)
      {
        ret.push_back(ossia::convert<float>(val));
      }
    }
    void operator()(const ossia::value_map_type& arr) const noexcept
    {
      ret.reserve(1 + arr.size());
      for(auto& [k, v] : arr)
      {
        ret.push_back(ossia::convert<float>(v));
      }
    }
  };
 
  using tick = halp::tick_flicks;
  void operator()(halp::tick_flicks tk)
  {
    if(auto& opt_v = inputs.port.value)
    {
      const auto& v = *opt_v;
      const float val = ossia::convert<float>(v);
      if(ossia::safe_isnan(val) || ossia::safe_isinf(val))
        return;
 
      vec_type ret;
      ret.push_back(float(tk.relative_position));
 
      v.apply(value_visitor{ret});
 
      outputs.port.value = static_cast<vec_type&&>(ret);
    }
  }
  struct Layer : public Process::EffectLayerView
  {
    static constexpr int timestamp_index = 0;
    static constexpr int first_value_index = 1;
 
  public:
    Scenario::IntervalModel* m_interval{};
 
    std::vector<vec_type> m_values;
    vec_type min = {0.};
    vec_type max = {1.};
    int num_rows = 0;
 
    Layer(
        const Process::ProcessModel& process, const Process::Context& doc,
        QGraphicsItem* parent)
        : Process::EffectLayerView{parent}
        , m_interval{Scenario::closestParentInterval(process.parent())}
    {
      setAcceptedMouseButtons({});
      if(m_interval)
      {
        const Process::PortFactoryList& portFactory
            = doc.app.interfaces<Process::PortFactoryList>();
 
        auto inl = process.inlets().front();
 
        // Signal Display has two dispaly mode, one time-line mode and one
        if(parent->type() == Process::NodeItem::Type)
        {
          inl->hidden = true;
          auto fact = portFactory.get(inl->concreteKey());
          auto port = fact->makePortItem(*inl, doc, this, this);
          port->setPos(0, 5);
        }
        else
        {
          inl->hidden = false;
        }
 
        connect(
            m_interval, &Scenario::IntervalModel::executionEvent, this,
            [this](Scenario::IntervalExecutionEvent ev) {
          switch(ev)
          {
            case Scenario::IntervalExecutionEvent::Playing:
            case Scenario::IntervalExecutionEvent::Stopped:
              reset();
              break;
            default:
              break;
          }
        });
 
        auto outl = safe_cast<Process::ControlOutlet*>(process.outlets().front());
        connect(
            outl, &Process::ControlOutlet::valueChanged, this,
            [this](const ossia::value& v) {
          auto& val = *v.target<std::vector<ossia::value>>();
          const int N = std::ssize(val);
          if(N < 2)
            return;
          this->num_rows = std::max(this->num_rows, N - 1);
          // [0] isn't useful as it is the timestamp row but better for code consistency - less branches.
          if(min.size() < N)
            min.resize(N, std::numeric_limits<float>::max());
          if(max.size() < N)
            max.resize(N, std::numeric_limits<float>::lowest());
 
          vec_type vv;
          vv.resize(N, boost::container::default_init);
 
          int i = 0;
          for(auto it = val.begin(); it != val.end(); ++it)
          {
            const float r = *it->target<float>();
            vv[i] = r;
            if(r < min[i])
              min[i] = r;
            if(r > max[i])
              max[i] = r;
 
            ++i;
          }
 
          // Handle looping: clear when we jump back in time
          if(!m_values.empty() && !m_values.back().empty())
            if(vv[timestamp_index] < m_values.back()[timestamp_index])
            {
              m_values.clear();
              this->num_rows = 0;
            }
 
          m_values.push_back(std::move(vv));
 
          update();
        });
      }
    }
 
    void reset()
    {
      min = {};
      max = {};
      this->num_rows = 0;
      m_values.clear();
      update();
    }
 
    void draw_row_simple(QPainter* p, qreal w, qreal h, int row_index, auto to_01) const
    {
      for(int start_idx = 0; start_idx < std::ssize(m_values) - 1; start_idx++)
      {
        int end_idx = start_idx + 1;
 
        const auto* p0 = &m_values[start_idx];
        const auto& v0 = *p0;
        const auto N0 = std::ssize(*p0);
        if(N0 <= row_index)
          continue;
        const auto* p1 = &m_values[end_idx];
        const auto& v1 = *p1;
        const auto N1 = std::ssize(*p1);
        if(N1 <= row_index)
          continue;
        QPointF start = {v0[timestamp_index] * w, to_01(v0[row_index]) * h};
        QPointF end = {v1[timestamp_index] * w, to_01(v1[row_index]) * h};
        p->drawLine(start, end);
      }
    }
 
    void draw_row(QPainter* p, qreal w, qreal h, int row_index, auto to_01) const
    {
      double quality = std::clamp(std::ceil(std::sqrt(0.1 + num_rows)), 1., 5.);
      std::optional<int> last_idx;
      for(int start_idx = 0; start_idx < std::ssize(m_values) - 1; start_idx++)
      {
        const auto* p0 = &m_values[start_idx];
        const auto& v0 = *p0;
        const auto N0 = std::ssize(*p0);
        if(N0 <= row_index)
          continue;
 
        // To handle long jumps in values
        if(last_idx && *last_idx < start_idx)
        {
          const auto& v0 = m_values[*last_idx];
          const auto& v1 = v0;
          QPointF p0 = {v0[timestamp_index] * w, to_01(v0[row_index]) * h};
          QPointF p1 = {v1[timestamp_index] * w, to_01(v1[row_index]) * h};
 
          if(QLineF l{p0, p1}; l.length() > quality && p0.x() < p1.x())
          {
            p->drawLine(l);
            last_idx = start_idx;
          }
        }
 
        // Find the next point at least "quality" px away
        auto x0 = v0[timestamp_index] * w;
        decltype(p0) p1 = nullptr;
        std::optional<int> last_viable_end;
        double x1 = x0;
        for(int end_idx = start_idx + 1; end_idx < std::ssize(m_values); end_idx++)
        {
          auto pp1 = &m_values[end_idx];
          const auto N1 = std::ssize(*pp1);
          if(N1 <= row_index)
            continue;
 
          last_viable_end = end_idx;
 
          const auto& v1 = *pp1;
          x1 = v1[timestamp_index] * w;
          if((x1 - x0) < quality)
          {
            continue;
          }
          else if(x1 - x0 > 10.)
          {
            break;
          }
          else
          {
            p1 = pp1;
            break;
          }
        }
 
        if(p1)
        {
          const auto& v1 = *p1;
          QPointF p0 = {x0, to_01(v0[row_index]) * h};
          QPointF p1 = {x1, to_01(v1[row_index]) * h};
          p->drawLine(p0, p1);
          last_idx = last_viable_end;
        }
      }
    }
 
    void draw_row_constant(QPainter* p, qreal w, qreal h, int row_index) const
    {
      for(auto& val : m_values)
      {
        if(std::ssize(val) > row_index)
        {
          QPointF p0 = {val[timestamp_index] * w, 0.5 * h};
 
          p->drawPoint(p0);
        }
      }
    }
    void paint_impl(QPainter* p) const override
    {
      if(m_values.size() < 2 || this->num_rows == 0)
        return;
 
      p->save();
      p->setRenderHint(QPainter::Antialiasing, true);
      p->setPen(score::Skin::instance().Light.main.pen1_solid_flat_miter);
 
      const auto w = m_defaultWidth;
      const auto h = height() / num_rows;
 
      for(int row = 0; row < num_rows; ++row)
      {
        const int row_index = row + 1;
 
        const auto min = this->min[row_index];
        const auto max = this->max[row_index];
        if(min != max)
        {
          draw_row_simple(p, w, h, row_index, [min, max](float v) {
            return 1.f - (v - min) / (max - min);
          });
        }
        else
        {
          draw_row_constant(p, w, h, row_index);
        }
 
        p->translate(QPointF{0, h});
      }
 
      p->setRenderHint(QPainter::Antialiasing, false);
      p->restore();
    }
  };
};
}