carla_native_plugin.h

// SPDX-FileCopyrightText: © 2019-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include "zrythm-config.h"
 
#include <utility>
#include <vector>
 
#include "plugins/plugin.h"
#include "utils/icloneable.h"
#include "utils/types.h"
 
#if HAVE_CARLA
#  include "carla_wrapper.h"
#endif
 
namespace zrythm::plugins
{
 
using CarlaPluginHandle = void *;

 
constexpr auto CARLA_STATE_FILENAME = "state.carla"sv;

enum class CarlaPluginType
{
  CARLA_PLUGIN_NONE,
  CARLA_PLUGIN_RACK,
  CARLA_PLUGIN_PATCHBAY,
  CARLA_PLUGIN_PATCHBAY16,
  CARLA_PLUGIN_PATCHBAY32,
  CARLA_PLUGIN_PATCHBAY64,
};
 
struct CarlaPatchbayPortInfo
{
  CarlaPatchbayPortInfo () = default;
  CarlaPatchbayPortInfo (
    unsigned int _plugin_id,
    unsigned int _port_hints,
    unsigned int _port_id,
    std::string  _port_name)
      : plugin_id (_plugin_id), port_hints (_port_hints), port_id (_port_id),
        port_name (std::move (_port_name))
  {
  }
  unsigned int plugin_id = 0;
  unsigned int port_hints = 0;
  unsigned int port_id = 0;
  std::string  port_name;
};
 
class CarlaNativePlugin : public Plugin
{
public:
  CarlaNativePlugin (ProcessorBaseDependencies dependencies);

  ~CarlaNativePlugin () override;
  Z_DISABLE_COPY_MOVE (CarlaNativePlugin)
 
#if HAVE_CARLA
  static std::unique_ptr<PluginDescriptor>
  get_descriptor_from_cached (const CarlaCachedPluginInfo &info, PluginType type);
#endif
 
  void
  save_state (bool is_backup, std::optional<std::filesystem::path> abs_state_dir)
    override;

  void load_state (std::optional<std::filesystem::path> abs_path);
 
  void update_buffer_size_and_sample_rate ();

  void open_custom_ui (bool show) override;

  dsp::ProcessorParameter * get_param_from_param_id (uint32_t id);

  dsp::MidiPort * get_midi_out_port ();
 
  float get_param_value (uint32_t id);

 
  void set_param_value (uint32_t id, float val);
 
  void close () override;
 
  static bool has_custom_ui (const PluginDescriptor &descr);

 
  units::sample_u32_t get_single_playback_latency () const override;

  bool add_internal_plugin_from_descr (const PluginDescriptor &descr);
 
  friend void init_from (
    CarlaNativePlugin       &obj,
    const CarlaNativePlugin &other,
    utils::ObjectCloneType   clone_type);
 
private:
  friend void to_json (nlohmann::json &j, const CarlaNativePlugin &plugin)
  {
    to_json (j, static_cast<const Plugin &> (plugin));
  }
  friend void from_json (const nlohmann::json &j, CarlaNativePlugin &plugin)
  {
    from_json (j, static_cast<Plugin &> (plugin));
  }
 
  void populate_banks () override;
 
  void set_selected_preset_from_index_impl (int idx) override;
 
  void activate_impl (bool activate) override;

  void instantiate_impl (bool loading, bool use_state_file) override;

  [[gnu::hot]] void process_impl (EngineProcessTimeInfo time_nfo) override;
 
  void cleanup_impl () override;

  bool idle_cb ();
 
  void create_ports (bool loading);
 
public:
#if HAVE_CARLA
  NativePluginHandle             native_plugin_handle_ = nullptr;
  NativeHostDescriptor           native_host_descriptor_ = {};
  const NativePluginDescriptor * native_plugin_descriptor_ = nullptr;
 
  CarlaHostHandle host_handle_ = nullptr;
 
  NativeTimeInfo time_info_ = {};
#endif

  unsigned int carla_plugin_id_ = 0;

  bool ports_created_ = false;

  bool loading_state_ = false;

  unsigned int audio_input_port_id_ = 0;
  unsigned int audio_output_port_id_ = 0;

  unsigned int cv_input_port_id_ = 0;
  unsigned int cv_output_port_id_ = 0;

  unsigned int midi_input_port_id_ = 0;
  unsigned int midi_output_port_id_ = 0;

  std::vector<CarlaPatchbayPortInfo> patchbay_port_info_;

  // sigc::scoped_connection idle_connection_;

  std::vector<std::vector<float>> zero_inbufs_;
  std::vector<std::vector<float>> zero_outbufs_;
  std::vector<const float *>      inbufs_;
  std::vector<float *>            outbufs_;
 
  unsigned int max_variant_audio_ins_ = 0;
  unsigned int max_variant_audio_outs_ = 0;
  unsigned int max_variant_cv_ins_ = 0;
  unsigned int max_variant_cv_outs_ = 0;
  unsigned int max_variant_midi_ins_ = 0;
  unsigned int max_variant_midi_outs_ = 0;
};
 
} // namespace zrythm::plugins