parameter.h

// SPDX-FileCopyrightText: © 2025-2026 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include "dsp/audio_port.h"
#include "dsp/cv_port.h"
#include "dsp/graph_node.h"
#include "dsp/midi_port.h"
#include "utils/iobject_registry.h"
#include "utils/math_utils.h"
#include "utils/traits.h"
#include "utils/typed_uuid_reference.h"
#include "utils/units.h"
#include "utils/uuid_identifiable_object.h"
 
#include <QtQmlIntegration/qqmlintegration.h>
 
#include <nlohmann/json_fwd.hpp>
 
using namespace std::string_view_literals;
 
namespace zrythm::dsp
{
 
class ParameterRange
{
  Q_GADGET
  QML_VALUE_TYPE (parameterRange)
 
public:
  enum class Type : std::uint8_t
  {
    Linear,

    Toggle,

    Integer,

    GainAmplitude,

    Logarithmic,

    Enumeration,

    Trigger,
  };
  Q_ENUM (Type)
 
  
  enum class Unit : std::uint8_t
  {
    None,
    Hz,
    MHz,
    Db,
    Degrees,
    Seconds,

    Ms,

    Us,
  };
 
  static utils::Utf8String unit_to_string (Unit unit);
 
public:
  ParameterRange () = default;
 
  ParameterRange (Type type, float min, float max, float zero = 0.f, float def = 0.f)
      : type_ (type), minf_ (min), maxf_ (max),
        zerof_ (std::clamp (zero, min, max)), deff_ (std::clamp (def, min, max))
  {
  }
 
  static ParameterRange make_toggle (bool default_val)
  {
    return { Type::Toggle, 0.f, 1.f, 0.f, default_val ? 1.f : 0.f };
  }
  static ParameterRange make_gain (float max_val)
  {
    return { Type::GainAmplitude, 0.f, max_val, 0.f, 1.f };
  }
 
  static ParameterRange make_enumeration (
    std::vector<utils::Utf8String> labels,
    size_t                         default_index = 0)
  {
    if (labels.empty ())
      {
        throw std::invalid_argument (
          "Enumeration parameter requires at least one label");
      }
    if (default_index >= labels.size ())
      {
        throw std::invalid_argument (
          "default_index out of range for enumeration labels");
      }
    const auto     count = static_cast<float> (labels.size ());
    ParameterRange range{
      Type::Enumeration, 0.f, count - 1.f, 0.f,
      static_cast<float> (default_index)
    };
    range.enum_labels_ = std::move (labels);
    return range;
  }

  Q_INVOKABLE size_t enumCount () const { return enum_labels_.size (); }

  Q_INVOKABLE size_t enumIndex (float normalized_val) const
  {
    const auto real = convertFrom0To1 (normalized_val);
    assert (!enum_labels_.empty ());
    const auto idx = static_cast<size_t> (std::max (std::round (real), 0.f));
    return std::min (idx, enum_labels_.size () - 1);
  }

  Q_INVOKABLE float normalizedEnumValue (size_t index) const
  {
    assert (index < enum_labels_.size ());
    if (enum_labels_.size () == 1)
      return 0.f;
    return convertTo0To1 (static_cast<float> (index));
  }

  const auto &enum_label (size_t index) const
  {
    return enum_labels_.at (index);
  }
 
  Q_INVOKABLE QString enumLabel (int index) const
  {
    if (index < 0 || static_cast<size_t> (index) >= enum_labels_.size ())
      return {};
    return enum_label (static_cast<size_t> (index)).to_qstring ();
  }
 
  template <utils::EnumType E> float normalized_from_enum (E value) const
  {
    assert (type_ == Type::Enumeration);
    const auto index = static_cast<size_t> (value);
    assert (index < enum_labels_.size ());
    return normalizedEnumValue (index);
  }
 
  template <utils::EnumType E> E enum_value (float normalized_val) const
  {
    assert (type_ == Type::Enumeration);
    return static_cast<E> (enumIndex (normalized_val));
  }
 
  constexpr float clamp_to_range (float val) const
  {
    return std::clamp (val, minf_, maxf_);
  }
 
  Q_INVOKABLE float convertFrom0To1 (float normalized_val) const;
  Q_INVOKABLE float convertTo0To1 (float real_val) const;
 
  Q_INVOKABLE bool isToggled (float normalized_val) const
  {
    assert (type_ == ParameterRange::Type::Toggle);
    return utils::math::floats_equal (convertFrom0To1 (normalized_val), 1.f);
  }
 
  friend void to_json (nlohmann::json &j, const ParameterRange &p);
  friend void from_json (const nlohmann::json &j, ParameterRange &p);
 
public:
  Type type_{ Type::Linear };

  Unit unit_{};

  float minf_{ 0.f };
  float maxf_{ 1.f };

  float zerof_{ 0.f };

  float deff_{ 0.f };

  std::vector<utils::Utf8String> enum_labels_;
 
  BOOST_DESCRIBE_CLASS (
    ParameterRange,
    (),
    (type_, unit_, minf_, maxf_, zerof_, deff_),
    (),
    ())
};

class ProcessorParameter
    : public utils::UuidIdentifiableObject<ProcessorParameter>,
      public dsp::graph::IProcessable
{
  Q_OBJECT
  Q_PROPERTY (
    float baseValue READ baseValue WRITE setBaseValue NOTIFY baseValueChanged)
  Q_PROPERTY (QString label READ label CONSTANT)
  Q_PROPERTY (QString description READ description CONSTANT)
  Q_PROPERTY (zrythm::dsp::ParameterRange range READ range CONSTANT)
  Q_PROPERTY (bool automatable READ automatable CONSTANT)
  QML_ELEMENT
  QML_UNCREATABLE ("")
 
public:
  struct UniqueId final
      : type_safe::strong_typedef<UniqueId, utils::Utf8String>,
        type_safe::strong_typedef_op::equality_comparison<UniqueId>,
        type_safe::strong_typedef_op::relational_comparison<UniqueId>
  {
    using type_safe::strong_typedef<UniqueId, utils::Utf8String>::strong_typedef;
 
    explicit UniqueId () = default;
 
    static_assert (utils::StrongTypedef<UniqueId>);
 
    std::size_t hash () const { return qHash (type_safe::get (*this).view ()); }
  };
  static_assert (std::regular<UniqueId>);
 
  using Resolver =
    std::function<QPointer<ProcessorParameter> (const UniqueId &unique_id)>;
 
  ProcessorParameter (
    utils::IObjectRegistry &registry,
    UniqueId                unique_id,
    ParameterRange          range,
    utils::Utf8String       label,
    QObject *               parent = nullptr);

  using AutomationValueProvider =
    std::function<std::optional<float> (units::sample_t sample_position)>;
 
  // ========================================================================
  // QML Interface
  // ========================================================================
 
  QString label () const { return label_.to_qstring (); }
  QString description () const { return description_->to_qstring (); }
  bool    automatable () const { return automatable_; }
 
  const auto &range () const { return range_; }
 
  float baseValue () const { return base_value_.load (); }
  void  setBaseValue (float newValue) [[clang::blocking]]
  {
    newValue = std::clamp (newValue, 0.f, 1.f);
    if (qFuzzyCompare (base_value_, newValue))
      return;
    base_value_ = newValue;
    Q_EMIT baseValueChanged (newValue);
  }
  Q_INVOKABLE void resetBaseValueToDefault ()
  {
    setBaseValue (range_.convertTo0To1 (range_.deff_));
  }
  Q_SIGNAL void baseValueChanged (float value);

  Q_INVOKABLE float currentValue () const { return last_modulated_value_; }

   */
  Q_INVOKABLE float valueAfterAutomationApplied () const
  {
    return last_automated_value_.load ();
  }
 
  Q_INVOKABLE void beginUserGesture ()
  {
    during_gesture_.store (true);
    Q_EMIT userGestureStarted ();
  }
  Q_INVOKABLE void endUserGesture ()
  {
    during_gesture_.store (false);
    Q_EMIT userGestureFinished ();
  }
  Q_SIGNAL void userGestureStarted ();
  Q_SIGNAL void userGestureFinished ();
 
  // ========================================================================
 
  // ========================================================================
  // IProcessable Implementation
  // ========================================================================
 
  utils::Utf8String get_node_name () const override;

  void process_block (
    dsp::graph::ProcessBlockInfo time_nfo,
    const dsp::ITransport       &transport,
    const dsp::TempoMap         &tempo_map) noexcept override;
 
  void prepare_for_processing (
    const graph::GraphNode * node,
    units::sample_rate_t     sample_rate,
    units::sample_u32_t      max_block_length) override;
  void release_resources () override;
 
  // ========================================================================
 
  void set_automation_provider (AutomationValueProvider provider)
  {
    automation_value_provider_ = provider;
  }
  void unset_automation_provider () { automation_value_provider_.reset (); }
 
  PortUuidReference get_modulation_input_port_ref () const
  {
    return modulation_input_uuid_;
  }
 
  void set_description (utils::Utf8String descr)
  {
    description_ = std::move (descr);
  }
 
  void set_automatable (bool automatable) { automatable_ = automatable; }
 
  bool hidden () const { return hidden_; }
 
  const auto &get_unique_id () const { return unique_id_; }
 
private:
  // Serialization keys
  static constexpr auto kUniqueIdKey = "uniqueId"sv;
  static constexpr auto kRangeKey = "range"sv;
  static constexpr auto kLabelKey = "label"sv;
  static constexpr auto kSymbolKey = "symbol"sv;
  static constexpr auto kDescriptionKey = "description"sv;
  static constexpr auto kAutomatableKey = "automatable"sv;
  static constexpr auto kHiddenKey = "hidden"sv;
  static constexpr auto kBaseValueKey = "baseValue"sv;
  static constexpr auto kModulationSourcePortIdKey = "modulationSourcePortId"sv;
  friend void to_json (nlohmann::json &j, const ProcessorParameter &p);
  friend void from_json (const nlohmann::json &j, ProcessorParameter &p);
 
private:
  UniqueId unique_id_;

  ParameterRange range_;

  utils::Utf8String label_;

  std::atomic<float> base_value_;

  std::atomic_bool during_gesture_;

  std::atomic<float> last_automated_value_;

  std::atomic<float> last_modulated_value_;

  PortUuidReference modulation_input_uuid_;
 
  // Processing cache
  dsp::CVPort * modulation_input_{};

  std::optional<AutomationValueProvider> automation_value_provider_;

  std::optional<utils::Utf8String> symbol_;

  std::optional<utils::Utf8String> description_;
 
  // Automatable (via automation provider or modulation)
  bool automatable_{ true };
 
  // Not on GUI
  bool hidden_{};
 
  BOOST_DESCRIBE_CLASS (
    ProcessorParameter,
    (utils::UuidIdentifiableObject<ProcessorParameter>),
    (),
    (),
    (unique_id_,
     range_,
     label_,
     base_value_,
     modulation_input_uuid_,
     symbol_,
     description_,
     automatable_,
     hidden_))
};
 
inline auto
format_as (const ProcessorParameter::UniqueId &id)
{
  return type_safe::get (id).view ();
}
 
using ProcessorParameterPtrVariant = std::variant<ProcessorParameter *>;
}
 
DEFINE_UUID_HASH_SPECIALIZATION (zrythm::dsp::ProcessorParameter::Uuid)
 
namespace zrythm::dsp
{
 
using ProcessorParameterUuidReference =
  utils::TypedUuidReference<ProcessorParameter>;
 
} // namespace zrythm::dsp
 
namespace std
{
template <> struct hash<zrythm::dsp::ProcessorParameter::UniqueId>
{
  size_t operator() (const zrythm::dsp::ProcessorParameter::UniqueId &id) const
  {
    return id.hash ();
  }
};
}