plugin_group.h

// SPDX-FileCopyrightText: © 2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include <utility>
 
#include "dsp/fader.h"
#include "plugins/plugin_all.h"
#include "utils/qt.h"
 
#include <QAbstractListModel>
#include <QtQmlIntegration/qqmlintegration.h>
 
#include <nlohmann/json_fwd.hpp>
 
namespace zrythm::plugins
{
class PluginGroup : public QAbstractListModel
{
  Q_OBJECT
  Q_PROPERTY (QString name READ name WRITE setName NOTIFY nameChanged)
  QML_ELEMENT
  QML_UNCREATABLE ("")
 
public:
  enum class ProcessingTypeHint : std::uint8_t
  {
    Serial,

    Parallel,

    Custom,
  };
  Q_ENUM (ProcessingTypeHint)
 
  enum class DeviceGroupType : std::uint8_t
  {
    Audio,
    MIDI,
    Instrument,
    CV,
  };
  Q_ENUM (DeviceGroupType)
 
  PluginGroup (
    utils::IObjectRegistry &registry,
    DeviceGroupType         type,
    ProcessingTypeHint      processing_type,
    QObject *               parent = nullptr);
  Q_DISABLE_COPY_MOVE (PluginGroup)
  ~PluginGroup () override;
 
  // ============================================================================
  // QML Interface
  // ============================================================================
 
  QString       name () const { return name_; }
  void          setName (const QString &name);
  Q_SIGNAL void nameChanged (const QString &name);
 
  enum DeviceGroupListModelRoles
  {
    DeviceGroupPtrRole = Qt::UserRole + 1,
  };
  Q_ENUM (DeviceGroupListModelRoles)
 
  QHash<int, QByteArray> roleNames () const override;
  int rowCount (const QModelIndex &parent = QModelIndex ()) const override;
  QVariant
  data (const QModelIndex &index, int role = Qt::DisplayRole) const override;
  // ============================================================================
 
  // Note: plugin add/remove API does not concern itself with automation tracks
  // or graph rebuilding.
  // When plugins are                                   added or removed,
  // automation tracks should be generated/moved accordingly and the DSP graph
  // should be regenerated.
 
  void insert_plugin (plugins::PluginUuidReference plugin_ref, int index = -1);
  void append_plugin (plugins::PluginUuidReference plugin_ref)
  {
    insert_plugin (std::move (plugin_ref), -1);
  }
  plugins::PluginUuidReference
  remove_plugin (const plugins::Plugin::Uuid &plugin_id);
 
  QVariant element_at_idx (size_t idx) const;
 
  void get_plugins (
    std::vector<plugins::PluginUuidReference> &plugins,
    bool                                       recursive = true) const;
 
private:
  static constexpr auto kDeviceGroupsKey = "deviceGroups"sv;
  static constexpr auto kFaderKey = "fader"sv;
  friend void           to_json (nlohmann::json &j, const PluginGroup &l);
  friend void           from_json (const nlohmann::json &j, PluginGroup &l);
 
private:
  utils::IObjectRegistry             &registry_;
  const ProcessingTypeHint            processing_type_;
  const DeviceGroupType               type_;
  utils::QObjectUniquePtr<dsp::Fader> fader_;
  QString                             name_;
 
  struct DeviceGroupImpl;
  std::unique_ptr<DeviceGroupImpl> pimpl_;
};
}