modulator_macro_processor.h

// SPDX-FileCopyrightText: © 2021-2022, 2024-2026 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include "dsp/graph_node.h"
#include "dsp/parameter.h"
#include "dsp/port_fwd.h"
#include "dsp/processor_base.h"
#include "utils/types.h"
 
namespace zrythm::dsp
{

class ModulatorMacroProcessor final : public QObject, public dsp::ProcessorBase
{
  Q_OBJECT
  Q_PROPERTY (QString name READ name CONSTANT)
  QML_ELEMENT
  QML_UNCREATABLE ("")
 
  struct ProcessingCaches
  {
    dsp::ProcessorParameter * macro_param_{};
    dsp::CVPort *             cv_in_{};
    dsp::CVPort *             cv_out_{};
  };
 
public:
  ModulatorMacroProcessor (
    ProcessorBaseDependencies dependencies,
    int                       idx,
    QObject *                 parent = nullptr);
 
  // ========================================================================
  // QML Interface
  // ========================================================================
 
  QString name () const { return name_.to_qstring (); }
 
  // ========================================================================
 
  utils::Utf8String get_full_designation_for_port (const dsp::Port &port) const;
 
  auto get_name () const { return name_; }
 
  // void set_name (const utils::Utf8String &name) { name_ = name; }
 
  // ============================================================================
  // ProcessorBase Interface
  // ============================================================================
 
  void custom_process_block (
    EngineProcessTimeInfo  time_nfo,
    const dsp::ITransport &transport,
    const dsp::TempoMap   &tempo_map) noexcept override;
 
  void custom_prepare_for_processing (
    const graph::GraphNode * node,
    units::sample_rate_t     sample_rate,
    nframes_t                max_block_length) override;
 
  void custom_release_resources () override;
 
  // ============================================================================
 
  friend void init_from (
    ModulatorMacroProcessor       &obj,
    const ModulatorMacroProcessor &other,
    utils::ObjectCloneType         clone_type);

  auto &get_cv_in_port ()
  {
    return *get_input_ports ().front ().get_object_as<dsp::CVPort> ();
  }

  auto &get_cv_out_port ()
  {
    return *get_output_ports ().front ().get_object_as<dsp::CVPort> ();
  }

  auto &get_macro_param ()
  {
    return *get_parameters ().front ().get_object_as<dsp::ProcessorParameter> ();
  }
 
private:
  static constexpr auto kNameKey = "name"sv;
  friend void to_json (nlohmann::json &j, const ModulatorMacroProcessor &p);
  friend void from_json (const nlohmann::json &j, ModulatorMacroProcessor &p);
 
private:
  ProcessorBaseDependencies dependencies_;

  utils::Utf8String name_;
 
  // Processing caches
  std::unique_ptr<ProcessingCaches> processing_caches_;
 
  BOOST_DESCRIBE_CLASS (ModulatorMacroProcessor, (), (), (), (name_))
};
 
} // namespace zrythm::dsp