timeline_data_provider.h

// SPDX-FileCopyrightText: © 2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include "dsp/graph_node.h"
#include "dsp/itransport.h"
#include "dsp/midi_event_buffer.h"
#include "dsp/timeline_data_cache.h"
#include "structure/arrangement/region_renderer.h"
#include "utils/expandable_tick_range.h"
#include "utils/qt.h"
 
#include <farbot/RealtimeObject.hpp>
 
namespace zrythm::structure::arrangement
{

class TimelineDataProvider : public QObject
{
  Q_OBJECT
 
public:
  using IntervalType = std::pair<units::sample_t, units::sample_t>;
 
  explicit TimelineDataProvider (QObject * parent = nullptr) : QObject (parent)
  {
  }
 
  ~TimelineDataProvider () override;

  template <RegionObject RegionType>
  void generate_events (
    this auto                              &self,
    const dsp::TempoMap                    &tempo_map,
    utils::RangeOf<const RegionType *> auto regions,
    utils::ExpandableTickRange              affected_range)
  {
    // Convert tick range to sample range
    const auto sample_interval = [&affected_range, &tempo_map] ()
      -> std::pair<units::sample_t, units::sample_t> {
      if (!affected_range.is_full_content ())
        {
          const auto tick_range = affected_range.range ().value ();
          return std::make_pair (
            tempo_map.tick_to_samples_rounded (units::ticks (tick_range.first)),
            tempo_map.tick_to_samples_rounded (units::ticks (tick_range.second)));
        }
      return std::make_pair (
        units::samples (static_cast<int64_t> (0)),
        units::samples (std::numeric_limits<int64_t>::max ()));
    }();
 
    // Remove existing caches at given interval (or all caches if no interval
    // given)
 
    if (affected_range.is_full_content ())
      {
        self.get_base_cache ()->clear ();
      }
    else
      {
        self.get_base_cache ()->remove_sequences_matching_interval (
          sample_interval);
      }
 
    const auto regions_inside_interval_filter_func =
      [&affected_range, sample_interval] (const auto &region) {
        if (affected_range.is_full_content ())
          return true;
 
        return region->bounds ()->is_hit_by_range (sample_interval);
      };
 
    const auto cache_region = [&] (const auto * r) {
      // Skip muted regions
      if (r->mute ()->muted ())
        return;
 
      if constexpr (
        std::is_same_v<RegionType, arrangement::MidiRegion>
        || std::is_same_v<RegionType, arrangement::ChordRegion>)
        {
          self.cache_midi_region (*r, tempo_map);
        }
      else if constexpr (std::is_same_v<RegionType, arrangement::AudioRegion>)
        {
          self.cache_audio_region (*r);
        }
      else if constexpr (
        std::is_same_v<RegionType, arrangement::AutomationRegion>)
        {
          self.cache_automation_region (*r, tempo_map);
        }
    };
 
    // Go through each region and add a cache
    std::ranges::for_each (
      std::views::filter (regions, regions_inside_interval_filter_func),
      cache_region);
 
    // Finalize
    self.get_base_cache ()->finalize_changes ();
  }
 
  virtual void clear_all_caches () = 0;
  virtual void
  remove_sequences_matching_interval_from_all_caches (IntervalType interval) = 0;
 
  virtual const dsp::TimelineDataCache * get_base_cache () const = 0;
 
protected:
  virtual dsp::TimelineDataCache * get_base_cache () = 0;
  dsp::ITransport::PlayState last_seen_transport_state_{
    dsp::ITransport::PlayState::Paused
  };

  units::sample_t next_expected_transport_position_;
};

class MidiTimelineDataProvider : public TimelineDataProvider
{
  friend class TimelineDataProvider;
 
public:
  explicit MidiTimelineDataProvider (QObject * parent = nullptr);
 
  const dsp::TimelineDataCache * get_base_cache () const override
  {
    return midi_cache_.get ();
  }

  void process_midi_events (
    const dsp::graph::ProcessBlockInfo &time_nfo,
    dsp::ITransport::PlayState          transport_state,
    dsp::MidiEventBuffer &output_buffer) noexcept [[clang::nonblocking]];
 
  void clear_all_caches () override;
  void remove_sequences_matching_interval_from_all_caches (
    IntervalType interval) override;
 
  std::span<const dsp::SampleBasedMidiEvent> midi_events () const;

  void generate_midi_events (
    const dsp::TempoMap                                 &tempo_map,
    utils::RangeOf<const arrangement::MidiRegion *> auto midi_regions,
    utils::ExpandableTickRange                           affected_range)
  {
    generate_events<arrangement::MidiRegion> (
      tempo_map, midi_regions, affected_range);
    set_midi_events (midi_cache_->midi_events ());
  }

  void generate_midi_events (
    const dsp::TempoMap                                  &tempo_map,
    utils::RangeOf<const arrangement::ChordRegion *> auto chord_regions,
    utils::ExpandableTickRange                            affected_range)
  {
    generate_events<arrangement::ChordRegion> (
      tempo_map, chord_regions, affected_range);
    set_midi_events (midi_cache_->midi_events ());
  }
 
protected:
  dsp::TimelineDataCache * get_base_cache () override
  {
    return midi_cache_.get ();
  }
 
private:
  template <typename MidiRegionType>
  void
  cache_midi_region (const MidiRegionType &region, const dsp::TempoMap &tempo_map)
  {
    // MIDI region processing
    juce::MidiMessageSequence region_seq;
 
    // Serialize region (timings in timeline ticks)
    arrangement::RegionRenderer::serialize_to_sequence (region, region_seq);
    region_seq.addTimeToMessages (region.position ()->ticks ());
 
    // Convert JUCE sequence to native events with sample timestamps
    std::vector<dsp::SampleBasedMidiEvent> native_events;
    native_events.reserve (region_seq.getNumEvents ());
    for (const auto &event : region_seq)
      {
        const auto sample_time = tempo_map.tick_to_samples_rounded (
          units::ticks (event->message.getTimeStamp ()));
        const auto * raw = event->message.getRawData ();
        const auto   raw_size =
          static_cast<size_t> (event->message.getRawDataSize ());
        native_events.push_back (
          dsp::midi_event::make_raw (
            std::span<const midi_byte_t>{ raw, raw_size }, sample_time));
      }
 
    // Add to cache
    midi_cache_->add_midi_sequence (
      std::make_pair (
        units::samples (region.position ()->samples ()),
        region.bounds ()->get_end_position_samples (true)),
      native_events);
  }

  void set_midi_events (std::span<const dsp::SampleBasedMidiEvent> events);
 
  utils::QObjectUniquePtr<dsp::MidiTimelineDataCache> midi_cache_;
 
  farbot::RealtimeObject<
    std::vector<dsp::SampleBasedMidiEvent>,
    farbot::RealtimeObjectOptions::nonRealtimeMutatable>
    active_midi_playback_sequence_;
};

class AudioTimelineDataProvider : public TimelineDataProvider
{
  friend class TimelineDataProvider;
 
public:
  explicit AudioTimelineDataProvider (QObject * parent = nullptr);
 
  const dsp::TimelineDataCache * get_base_cache () const override
  {
    return audio_cache_.get ();
  }

  void process_audio_events (
    const dsp::graph::ProcessBlockInfo &time_nfo,
    dsp::ITransport::PlayState          transport_state,
    std::span<float>                    output_left,
    std::span<float> output_right) noexcept [[clang::nonblocking]];
 
  void clear_all_caches () override;
  void remove_sequences_matching_interval_from_all_caches (
    IntervalType interval) override;
 
  std::span<const dsp::AudioTimelineDataCache::AudioRegionEntry>
  audio_regions () const;

  void generate_audio_events (
    const dsp::TempoMap                                  &tempo_map,
    utils::RangeOf<const arrangement::AudioRegion *> auto audio_regions,
    utils::ExpandableTickRange                            affected_range)
  {
    generate_events<arrangement::AudioRegion> (
      tempo_map, audio_regions, affected_range);
    set_audio_regions (audio_cache_->audio_regions ());
  }
 
protected:
  dsp::TimelineDataCache * get_base_cache () override
  {
    return audio_cache_.get ();
  }
 
private:
  void cache_audio_region (const arrangement::AudioRegion &region);

  void set_audio_regions (
    std::span<const dsp::AudioTimelineDataCache::AudioRegionEntry> regions);
 
  utils::QObjectUniquePtr<dsp::AudioTimelineDataCache> audio_cache_;
 
  farbot::RealtimeObject<
    std::vector<dsp::AudioTimelineDataCache::AudioRegionEntry>,
    farbot::RealtimeObjectOptions::nonRealtimeMutatable>
    active_audio_regions_;
};

class AutomationTimelineDataProvider : public TimelineDataProvider
{
  friend class TimelineDataProvider;
 
public:
  explicit AutomationTimelineDataProvider (QObject * parent = nullptr);
 
  const dsp::TimelineDataCache * get_base_cache () const override
  {
    return automation_cache_.get ();
  }

  void process_automation_events (
    const dsp::graph::ProcessBlockInfo &time_nfo,
    dsp::ITransport::PlayState          transport_state,
    std::span<float> output_values) noexcept [[clang::nonblocking]];

  std::optional<float>
  get_automation_value_rt (units::sample_t sample_position) noexcept
    [[clang::nonblocking]];
 
  void clear_all_caches () override;
  void remove_sequences_matching_interval_from_all_caches (
    IntervalType interval) override;
 
  std::span<const dsp::AutomationTimelineDataCache::AutomationCacheEntry>
  automation_sequences () const;

  void generate_automation_events (
    const dsp::TempoMap &tempo_map,
    utils::RangeOf<const arrangement::AutomationRegion *> auto automation_regions,
    utils::ExpandableTickRange affected_range)
  {
    generate_events<arrangement::AutomationRegion> (
      tempo_map, automation_regions, affected_range);
    set_automation_sequences (automation_cache_->automation_sequences ());
  }
 
protected:
  dsp::TimelineDataCache * get_base_cache () override
  {
    return automation_cache_.get ();
  }
 
private:
  void cache_automation_region (
    const arrangement::AutomationRegion &region,
    const dsp::TempoMap                 &tempo_map);

  void set_automation_sequences (
    std::span<const dsp::AutomationTimelineDataCache::AutomationCacheEntry>
      sequences);
 
  utils::QObjectUniquePtr<dsp::AutomationTimelineDataCache> automation_cache_;
 
  farbot::RealtimeObject<
    std::vector<dsp::AutomationTimelineDataCache::AutomationCacheEntry>,
    farbot::RealtimeObjectOptions::nonRealtimeMutatable>
    active_automation_sequences_;
};
 
} // namespace zrythm::structure::arrangement