ValueDisplay.hpp

#pragma once
#include <State/ValuePrettyPrint.hpp>
 
#include <Process/Dataflow/Port.hpp>
#include <Process/Dataflow/PortFactory.hpp>
#include <Process/Dataflow/PortItem.hpp>
#include <Process/Process.hpp>
 
#include <Effect/EffectLayer.hpp>
#include <Effect/EffectLayout.hpp>
 
#include <score/application/ApplicationContext.hpp>
#include <score/model/Skin.hpp>
 
#include <ossia/dataflow/port.hpp>
#include <ossia/network/value/format_value.hpp>
#include <ossia/network/value/value_conversion.hpp>
 
#include <boost/container/devector.hpp>
 
#include <QApplication>
#include <QClipboard>
#include <QElapsedTimer>
#include <QTimer>
#include <QMenu>
#include <QPainter>
 
#include <halp/audio.hpp>
#include <halp/controls.hpp>
#include <halp/meta.hpp>
#include <halp/polyfill.hpp>
#include <halp/static_string.hpp>
 
#include <Ui/Monitor/LayerHelpers.hpp>
 
#include <cmath>
 
#include <algorithm>
#include <iterator>
#include <optional>
#include <vector>
 
namespace Ui::ValueDisplay
{
template <halp::static_string lit, typename T>
struct raw_port
{
  halp_meta(is_event, true)
  static clang_buggy_consteval auto name() { return std::string_view{lit.value}; }
 
  T* value{};
};
 
struct Node
{
  halp_meta(name, "Value display")
  halp_meta(c_name, "Display")
  halp_meta(category, "Monitoring/Control")
  halp_meta(author, "ossia score")
  halp_meta(manual_url, "")
  halp_meta(description, "Visualize an input value")
  halp_meta(uuid, "3f4a41f2-fa39-420f-ab0f-0af6b8409edb")
  halp_flag(fully_custom_item);
 
  static constexpr int max_log = 100;
 
  enum class Format
  {
    Ordinary,
    Pretty,
    Hex
  };
 
  static std::optional<unsigned char> byteValue(float value) noexcept
  {
    if(value >= 0.f && value <= 255.f && std::trunc(value) == value)
      return static_cast<unsigned char>(value);
    return std::nullopt;
  }
 
  static std::optional<unsigned char> byteValue(const ossia::value& value) noexcept
  {
    if(auto* number = value.target<int>())
    {
      if(*number >= 0 && *number <= 255)
        return static_cast<unsigned char>(*number);
    }
    else if(auto* number = value.target<float>())
      return byteValue(*number);
    else if(auto* boolean = value.target<bool>())
      return static_cast<unsigned char>(*boolean);
    return std::nullopt;
  }
 
  static void printHexValue(std::string& out, const ossia::value& value)
  {
    // Match the state value editor's HexEdit: lowercase pairs, spaces, sixteen
    // bytes per row. Write directly to the retained buffer, not a temporary
    // QByteArray / QString pair.
    constexpr char digits[] = "0123456789abcdef";
    const auto start = out.size();
    std::size_t count = 0;
    auto append = [&](unsigned char byte) {
      if(count != 0)
        out.push_back(count % 16 == 0 ? '\n' : ' ');
      out.push_back(digits[byte >> 4]);
      out.push_back(digits[byte & 0x0f]);
      ++count;
    };
    auto appendNumbers = [&](const auto& numbers) {
      for(const auto& number : numbers)
      {
        auto byte = byteValue(number);
        if(!byte)
          return false;
        append(*byte);
      }
      return true;
    };
 
    bool valid = true;
    if(auto* bytes = value.target<std::string>())
    {
      for(unsigned char byte : *bytes)
        append(byte);
    }
    else if(auto* numbers = value.target<std::vector<ossia::value>>())
      valid = appendNumbers(*numbers);
    else if(auto* numbers = value.target<ossia::vec2f>())
      valid = appendNumbers(*numbers);
    else if(auto* numbers = value.target<ossia::vec3f>())
      valid = appendNumbers(*numbers);
    else if(auto* numbers = value.target<ossia::vec4f>())
      valid = appendNumbers(*numbers);
    else if(auto byte = byteValue(value))
      append(*byte);
    else
      valid = false;
 
    if(!valid)
    {
      // Do not truncate, wrap, flatten or reinterpret non-byte values. A bad
      // element rejects the entire list, including any already appended bytes.
      out.resize(start);
      out += "[not byte data] ";
      State::printValue(out, value);
    }
    else if(count == 0)
      out += "[empty]";
  }
 
  struct
  {
    // Reading the port directly rather than through a control input: a control
    // input is fed with get_data().back(), so only the last value of a tick
    // would ever be seen, and a burst - a note-off immediately followed by a
    // note-on, several values written at the same sample - would show up as a
    // single entry.
    struct : raw_port<"Input", ossia::value_port>
    {
      halp_meta(description, "Values to display, including every event in a tick.")
    } port;
 
    struct : halp::spinbox_i32<"Log", halp::range{1, max_log, 1}>
    {
      halp_meta(description, "Number of recent values to retain, newest first.")
    } log;
 
    struct : halp::combobox_t<"Format", Format>
    {
      halp_meta(
          description,
          "Ordinary text, indented Pretty text, or Hex bytes. Pretty puts each "
          "element of a list or map that holds lists, maps or vectors on its "
          "own line, indented by depth: a list of vec2f reads one point per "
          "line; long lists of numbers wrap eight per line. Hex shows raw "
          "string bytes, including UTF-8 bytes, NUL and high-bit bytes. Numbers "
          "must be exact integers from 0 to 255; booleans are 00 or 01. Flat "
          "numeric lists and vectors use one byte per element. Empty strings "
          "and lists show [empty]. Other values show [not byte data] followed "
          "by ordinary text; no wrapping, truncation or memory reinterpretation.")
      struct range
      {
        std::string_view values[3]{"Ordinary", "Pretty", "Hex"};
        Format init{Format::Ordinary};
      };
    } format;
  } inputs;
 
  struct
  {
    // [sequence number of the first entry, values...]
    struct : halp::val_port<"values", std::optional<ossia::value>>
    {
      halp_meta(description, "Recent values and their sequence number for the display.")
      enum widget
      {
        control
      };
    } values;
  } outputs;
 
  // The engine -> UI queue for control outputs is drained keeping only the last
  // entry, so a push has to carry everything the layer may still need. That is
  // never more than the log length, which bounds the ring exactly.
  boost::container::devector<ossia::value> m_ring;
  int m_next_seq = 0;
 
  void prepare(halp::setup) noexcept
  {
    m_ring.clear();
    m_next_seq = 0;
  }
 
  void operator()()
  {
    outputs.values.value.reset();
 
    if(!inputs.port.value)
      return;
 
    const auto& data = inputs.port.value->get_data();
    if(data.empty())
      return;
 
    // Never more than what the layer displays: with a log of 1 this sends the
    // last value and nothing else.
    const int keep = std::clamp(inputs.log.value, 1, max_log);
 
    for(const ossia::timed_value& tv : data)
    {
      m_ring.push_back(tv.value);
      m_next_seq++;
      if(std::ssize(m_ring) > keep)
        m_ring.pop_front();
    }
    while(std::ssize(m_ring) > keep)
      m_ring.pop_front();
 
    std::vector<ossia::value> payload;
    payload.reserve(1 + m_ring.size());
    payload.push_back(int(m_next_seq - std::ssize(m_ring)));
    for(const auto& v : m_ring)
      payload.push_back(v);
 
    outputs.values.value = ossia::value{std::move(payload)};
  }
 
  struct Layer : public Process::EffectLayerView
  {
  public:
    boost::container::devector<ossia::value> values;
    int m_next_seq = 0;
 
    Process::ControlInlet* log_inlet{};
    Process::ControlInlet* format_inlet{};
 
    // The rendered text. Rebuilt when values, log length or format change,
    // never on paint; m_buf retains its capacity across rebuilds.
    QString txt_cache;
    std::string m_buf;
 
    static constexpr int flash_ms = 300;
    static constexpr int flash_step_ms = 50;
    QElapsedTimer m_flash;
    QTimer m_flashTimer;
 
    int logging() const noexcept
    {
      return std::clamp(ossia::convert<int>(log_inlet->value()), 1, max_log);
    }
 
    Format format() const noexcept
    {
      return format_inlet
                 ? static_cast<Format>(ossia::convert<int>(format_inlet->value()))
                 : Format::Ordinary;
    }
 
    void rebuildText()
    {
      m_buf.clear();
      const auto mode = format();
      for(const auto& line : this->values)
      {
        switch(mode)
        {
          case Format::Hex:
            printHexValue(m_buf, line);
            break;
          case Format::Pretty:
            State::prettyPrintValue(m_buf, line);
            break;
          default:
            State::printValue(m_buf, line);
            break;
        }
        m_buf.push_back('\n');
      }
      txt_cache = QString::fromUtf8(m_buf.data(), m_buf.size());
      update();
    }
 
    Layer(
        const Process::ProcessModel& process, const Process::Context& doc,
        QGraphicsItem* parent)
        : Process::EffectLayerView{parent}
    {
      setAcceptedMouseButtons(Qt::NoButton);
 
      Ui::Monitor::showInlet(process, 0, doc, this, this);
 
      log_inlet = static_cast<Process::ControlInlet*>(process.inlets()[1]);
      if(process.inlets().size() > 2)
        format_inlet = qobject_cast<Process::ControlInlet*>(process.inlets()[2]);
 
      m_flashTimer.setInterval(flash_step_ms);
      connect(&m_flashTimer, &QTimer::timeout, this, [this] {
        if(!m_flash.isValid() || m_flash.elapsed() > flash_ms)
          m_flashTimer.stop();
        update(flashRect());
      });
 
      auto* out = static_cast<Process::ControlOutlet*>(process.outlets()[0]);
      connect(
          out, &Process::ControlOutlet::valueChanged, this,
          [this](const ossia::value& v) { on_values(v); });
 
      connect(
          log_inlet, &Process::ControlInlet::valueChanged, this,
          [this](const ossia::value& v) {
        while(std::ssize(values) > logging())
          values.pop_back();
        rebuildText();
          });
 
      if(format_inlet)
        connect(
            format_inlet, &Process::ControlInlet::valueChanged, this,
            [this](const ossia::value&) { rebuildText(); });
    }
 
    void on_values(const ossia::value& v)
    {
      auto* list = v.target<std::vector<ossia::value>>();
      if(!list || list->size() < 2)
        return;
 
      const int base = ossia::convert<int>((*list)[0]);
      const int n = std::ssize(*list) - 1;
 
      // The batch is entirely older than what we hold: the process restarted.
      if(base + n < m_next_seq)
      {
        values.clear();
        m_next_seq = base;
      }
 
      for(int i = 0; i < n; i++)
      {
        const int seq = base + i;
        if(seq < m_next_seq)
          continue;
        values.push_front((*list)[i + 1]);
        m_next_seq = seq + 1;
      }
 
      while(std::ssize(values) > logging())
        values.pop_back();
 
      // Restarted: while values keep arriving, rebuildText() repaints and the
      // light stays lit; the fade only runs once they stop.
      m_flash.start();
      m_flashTimer.start();
      rebuildText();
    }
 
    QRectF flashRect() const noexcept { return {boundingRect().right() - 8., 2., 6., 6.}; }
 
    double flashLevel() const noexcept
    {
      if(!m_flash.isValid())
        return 0.;
      const auto t = m_flash.elapsed();
      return t >= flash_ms ? 0. : 1. - double(t) / flash_ms;
    }
 
    void reset()
    {
      values.clear();
      m_next_seq = 0;
      rebuildText();
    }
 
    void paint_impl(QPainter* p) const override
    {
      const auto& skin = score::Skin::instance();
      if(const double level = flashLevel(); level > 0.)
      {
        QColor c = skin.Base4.main.brush.color();
        c.setAlphaF(level);
        p->setRenderHint(QPainter::Antialiasing, true);
        p->setPen(Qt::NoPen);
        p->setBrush(c);
        p->drawEllipse(flashRect());
        p->setRenderHint(QPainter::Antialiasing, false);
      }
 
      if(txt_cache.isEmpty())
        return;
 
      p->setFont(skin.MonoFontSmall);
      p->setRenderHint(QPainter::Antialiasing, true);
      p->setPen(skin.Light.main.pen1_solid_flat_miter);
      // Between the inlet and the arrival light
      p->drawText(boundingRect().adjusted(12, 0, -10, 0), txt_cache);
      p->setRenderHint(QPainter::Antialiasing, false);
    }
  };
 
  struct Presenter : public Process::EffectLayerPresenter
  {
    using Process::EffectLayerPresenter::EffectLayerPresenter;
    void fillContextMenu(
        QMenu& menu, QPoint pos, QPointF scenepos,
        const Process::LayerContextMenuManager&) override
    {
      auto cp = menu.addAction(tr("Copy value"));
      connect(cp, &QAction::triggered, this, [this] {
        auto& v = *static_cast<Layer*>(this->m_view);
        qApp->clipboard()->setText(v.txt_cache);
      });
    }
  };
};
}