automation_track.h

// SPDX-FileCopyrightText: © 2018-2022, 2024-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include <utility>
 
#include "dsp/processor_base.h"
#include "dsp/tempo_map_qml_adapter.h"
#include "structure/arrangement/arranger_object_owner.h"
#include "structure/arrangement/automation_region.h"
#include "structure/arrangement/timeline_data_provider.h"
#include "structure/tracks/playback_cache_activity_tracker.h"
#include "utils/playback_cache_scheduler.h"
#include "utils/units.h"
 
#include <QtQmlIntegration/qqmlintegration.h>
 
namespace zrythm::structure::tracks
{
class AutomationTrack
    : public QObject,
      public arrangement::ArrangerObjectOwner<arrangement::AutomationRegion>
{
  Q_OBJECT
  QML_ELEMENT
  Q_PROPERTY (
    zrythm::dsp::ProcessorParameter * parameter READ parameter CONSTANT)
  Q_PROPERTY (
    AutomationMode automationMode READ getAutomationMode WRITE setAutomationMode
      NOTIFY automationModeChanged)
  Q_PROPERTY (
    AutomationRecordMode recordMode READ getRecordMode WRITE setRecordMode
      NOTIFY recordModeChanged)
  DEFINE_ARRANGER_OBJECT_OWNER_QML_PROPERTIES (
    AutomationTrack,
    regions,
    arrangement::AutomationRegion)
  Q_PROPERTY (
    zrythm::structure::tracks::PlaybackCacheActivityTracker *
      playbackCacheActivityTracker READ playbackCacheActivityTracker CONSTANT)
  QML_UNCREATABLE ("")
 
public:
  using AutomationRegion = arrangement::AutomationRegion;
  using AutomationPoint = arrangement::AutomationPoint;

  static constexpr int AUTOMATION_RECORDING_TOUCH_REL_MS = 800;
 
  enum class AutomationMode : uint8_t
  {
    Read,
    Record,
    Off,
  };
  Q_ENUM (AutomationMode)
 
  enum class AutomationRecordMode : uint8_t
  {
    Touch,
    Latch,
  };
  Q_ENUM (AutomationRecordMode)
 
public:
  AutomationTrack (
    const dsp::TempoMapWrapper          &tempo_map,
    utils::IObjectRegistry              &registry,
    dsp::ProcessorParameterUuidReference param_id,
    QObject *                            parent = nullptr);
 
public:
  // ========================================================================
  // QML Interface
  // ========================================================================
 
  dsp::ProcessorParameter * parameter () const { return param_id_.get (); }
 
  AutomationMode getAutomationMode () const { return automation_mode_.load (); }
  void           setAutomationMode (AutomationMode automation_mode);
  Q_SIGNAL void  automationModeChanged (AutomationMode automation_mode);
 
  AutomationRecordMode getRecordMode () const { return record_mode_; }
  void                 setRecordMode (AutomationRecordMode record_mode);
  Q_INVOKABLE void     swapRecordMode ();
  Q_SIGNAL void        recordModeChanged (AutomationRecordMode record_mode);

  Q_INVOKABLE void
  regeneratePlaybackCaches (utils::ExpandableTickRange affectedRange);

  Q_SIGNAL void
  automationObjectsNeedRecache (utils::ExpandableTickRange affectedRange);
 
  // cache activity tracking
  [[nodiscard]] PlaybackCacheActivityTracker *
  playbackCacheActivityTracker () const
  {
    return playback_cache_activity_tracker_.get ();
  }
 
  // ========================================================================

  [[gnu::hot]] bool should_read_automation () const;

  [[gnu::hot]] bool should_be_recording (bool record_aps) const;

  AutomationPoint * get_automation_point_around (
    units::precise_tick_t position_ticks,
    units::precise_tick_t delta_ticks,
    bool                  search_only_backwards = false);

  AutomationPoint * get_automation_point_before (
    units::sample_t timeline_position,
    bool            search_only_regions_enclosing_position) const;

  auto get_region_before (
    units::sample_t pos_samples,
    bool search_only_regions_enclosing_position) const -> AutomationRegion *;

  std::optional<float> get_normalized_value (
    units::sample_t timeline_frames,
    bool            search_only_regions_enclosing_position) const;
 
  bool contains_automation () const { return !get_children_vector ().empty (); }
 
  std::string
  get_field_name_for_serialization (const AutomationRegion *) const override
  {
    return "regions";
  }
 
public:
  static constexpr auto kParameterKey = "parameter"sv;
 
private:
  static constexpr auto kAutomationModeKey = "automationMode"sv;
  static constexpr auto kRecordModeKey = "recordMode"sv;
  friend void to_json (nlohmann::json &j, const AutomationTrack &track);
  friend void from_json (const nlohmann::json &j, AutomationTrack &track);
 
  friend void init_from (
    AutomationTrack       &obj,
    const AutomationTrack &other,
    utils::ObjectCloneType clone_type);
 
private:
  const dsp::TempoMapWrapper &tempo_map_;
  utils::IObjectRegistry     &registry_;

  dsp::ProcessorParameterUuidReference param_id_;

  std::atomic<AutomationMode> automation_mode_{ AutomationMode::Read };

  AutomationRecordMode record_mode_{};

  utils::QObjectUniquePtr<arrangement::AutomationTimelineDataProvider>
    automation_data_provider_;

  utils::QObjectUniquePtr<utils::PlaybackCacheScheduler>
    automation_cache_request_debouncer_;
 
  utils::QObjectUniquePtr<PlaybackCacheActivityTracker>
    playback_cache_activity_tracker_;
};

inline void
generate_automation_tracks_for_processor (
  std::vector<utils::QObjectUniquePtr<AutomationTrack>> &ret,
  const dsp::ProcessorBase                              &processor,
  const dsp::TempoMapWrapper                            &tempo_map,
  utils::IObjectRegistry                                &registry)
{
  z_debug ("generating automation tracks for {}...", processor.get_node_name ());
  for (const auto &param_ref : processor.get_parameters ())
    {
      auto * const param = param_ref.get ();
      if (!param->automatable ())
        continue;
 
      ret.emplace_back (
        utils::make_qobject_unique<AutomationTrack> (
          tempo_map, registry, param_ref));
    }
}
}
 
DEFINE_ENUM_FORMATTER (
  zrythm::structure::tracks::AutomationTrack::AutomationRecordMode,
  AutomationRecordMode,
  QT_TR_NOOP_UTF8 ("Touch"),
  QT_TR_NOOP_UTF8 ("Latch"));
 
DEFINE_ENUM_FORMATTER (
  zrythm::structure::tracks::AutomationTrack::AutomationMode,
  AutomationMode,
  "On",
  "Rec",
  "Off");