automation_tracklist.h

// SPDX-FileCopyrightText: © 2018-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __AUDIO_AUTOMATION_TRACKLIST_H__
#define __AUDIO_AUTOMATION_TRACKLIST_H__
 
#include "gui/dsp/automation_track.h"
#include "plugins/plugin_slot.h"
 
#include <QAbstractListModel>
 
class AutomatableTrack;
 
using namespace zrythm;
 
namespace zrythm::gui
{
class Channel;
}


class AutomationTracklist final
    : public QAbstractListModel,
      public ICloneable<AutomationTracklist>
{
  Q_OBJECT
  QML_ELEMENT
 
public:
  AutomationTracklist (
    PortRegistry           &port_registry,
    ArrangerObjectRegistry &object_registry,
    AutomatableTrack       &track,
    QObject *               parent = nullptr);
 
public:
  enum Roles
  {
    AutomationTrackPtrRole = Qt::UserRole + 1,
  };
 
  // ========================================================================
  // QML Interface
  // ========================================================================
  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;
 
  Q_INVOKABLE void
  showNextAvailableAutomationTrack (AutomationTrack * current_automation_track);
  Q_INVOKABLE void
  hideAutomationTrack (AutomationTrack * current_automation_track);
 
  // ========================================================================
 
  void init_after_cloning (
    const AutomationTracklist &other,
    ObjectCloneType            clone_type) override;

  [[gnu::cold]] void init_loaded ();
 
  TrackPtrVariant get_track () const;

  AutomationTrack * add_automation_track (AutomationTrack &at);

  void print_ats () const;

  void update_positions (bool from_ticks, bool bpm_change);
 
  AutomationTrack * get_prev_visible_at (const AutomationTrack &at) const;
 
  AutomationTrack * get_next_visible_at (const AutomationTrack &at) const;
 
  void set_at_visible (AutomationTrack &at, bool visible);
 
  AutomationTrack * get_automation_track_at (size_t index)
  {
    return ats_.at (index);
  }
 
  auto &get_automation_tracks_in_record_mode () { return ats_in_record_mode_; }
  auto &get_automation_tracks_in_record_mode () const
  {
    return ats_in_record_mode_;
  }

  AutomationTrack *
  get_visible_at_after_delta (const AutomationTrack &at, int delta) const;
 
  int
  get_visible_at_diff (const AutomationTrack &src, const AutomationTrack &dest)
    const;

  AutomationTrack *
  remove_at (AutomationTrack &at, bool free, bool fire_events);

  void remove_channel_ats (gui::Channel * ch);

  AutomationTrack * get_at_from_port (const ControlPort &port) const;

  AutomationTrack *
  get_automation_track_by_port_id (dsp::PortIdentifier::PortUuid id) const;

  void unselect_all ();

  void clear_objects ();

  void set_at_index (AutomationTrack &at, int index, bool push_down);

  AutomationTrack * get_plugin_at (
    plugins::PluginSlot      slot,
    int                      port_index,
    const utils::Utf8String &symbol);

  AutomationTrack * get_first_invisible_at () const;
 
  void append_objects (std::vector<ArrangerObject *> objects) const;

  int get_num_visible () const;

  bool validate () const;

  int get_num_regions () const;
 
  void print_regions () const;
 
  auto &get_visible_automation_tracks () { return visible_ats_; }
  auto &get_visible_automation_tracks () const { return visible_ats_; }
 
  auto &get_automation_tracks () { return ats_; }
  auto &get_automation_tracks () const { return ats_; }
 
  ControlPort &get_port (dsp::PortIdentifier::PortUuid id) const;
 
  void set_caches (CacheType types);
 
private:
  static constexpr std::string_view kAutomationTracksKey = "automationTracks";
  friend void to_json (nlohmann::json &j, const AutomationTracklist &ats)
  {
    j[kAutomationTracksKey] = ats.ats_;
  }
  friend void from_json (const nlohmann::json &j, AutomationTracklist &ats);
 
  auto &get_port_registry () { return port_registry_; }
  auto &get_port_registry () const { return port_registry_; }
 
private:
  ArrangerObjectRegistry &object_registry_;
  PortRegistry           &port_registry_;

  std::vector<AutomationTrack *> ats_;

  std::vector<AutomationTrack *> ats_in_record_mode_;

  std::vector<AutomationTrack *> visible_ats_;

  AutomatableTrack &track_;
};

 
#endif