playback_cache_activity_tracker.h

// SPDX-FileCopyrightText: © 2026 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include <functional>
#include <vector>
 
#include "dsp/timeline_data_cache.h"
#include "utils/playback_cache_scheduler.h"
 
#include <QTimer>
#include <QtQmlIntegration/qqmlintegration.h>
 
namespace zrythm::structure::tracks
{

struct PlaybackCacheActivityEntry
{
  Q_GADGET
  Q_PROPERTY (qint64 id MEMBER id)
  Q_PROPERTY (double startTick MEMBER startTick)
  Q_PROPERTY (double endTick MEMBER endTick)
  Q_PROPERTY (bool isFullContent MEMBER isFullContent)
  QML_VALUE_TYPE (playbackCacheActivityEntry)
  QML_UNCREATABLE ("")
 
public:
  qint64                    id{};
  double                    startTick{};
  double                    endTick{};
  bool                      isFullContent{};
  std::chrono::milliseconds createdAtMs;
};

struct CachedTickRange
{
  Q_GADGET
  Q_PROPERTY (double startTick MEMBER startTick)
  Q_PROPERTY (double endTick MEMBER endTick)
  QML_VALUE_TYPE (cachedTickRange)
  QML_UNCREATABLE ("")
 
public:
  double startTick{};
  double endTick{};
};

class PlaybackCacheActivityTracker : public QObject
{
  Q_OBJECT
  Q_PROPERTY (bool pending READ isPending NOTIFY pendingChanged)
  Q_PROPERTY (QVariantList entries READ entries NOTIFY entriesChanged)
  Q_PROPERTY (
    QVariantList cachedRanges READ cachedRanges NOTIFY cachedRangesChanged)
  QML_ELEMENT
  QML_UNCREATABLE ("")
 
public:
  static constexpr auto kMaxEntries = 100zu;
  static constexpr auto kEntryLifetimeMs = std::chrono::milliseconds (300);

  using SampleToTickConverter = std::function<double (units::sample_t)>;

  explicit PlaybackCacheActivityTracker (
    utils::PlaybackCacheScheduler * scheduler,
    const dsp::TimelineDataCache   &cache,
    SampleToTickConverter           sample_to_tick,
    QObject *                       parent = nullptr);

  void onRegenerationComplete (utils::ExpandableTickRange affectedRange);
 
  [[nodiscard]] bool         isPending () const { return pending_; }
  [[nodiscard]] QVariantList entries () const;
  [[nodiscard]] size_t       entryCount () const { return entries_.size (); }
  [[nodiscard]] QVariantList cachedRanges () const;
 
Q_SIGNALS:
  void pendingChanged ();
  void entriesChanged ();
  void cachedRangesChanged ();
 
private:
  void sweepExpiredEntries ();
 
  bool                                    pending_ = false;
  std::vector<PlaybackCacheActivityEntry> entries_;
  std::vector<CachedTickRange>            cached_ranges_;
  qint64                                  next_id_ = 0;
 
  QTimer sweep_timer_;
};
 
} // namespace zrythm::structure::tracks
 
Q_DECLARE_METATYPE (zrythm::structure::tracks::PlaybackCacheActivityEntry)
Q_DECLARE_METATYPE (zrythm::structure::tracks::CachedTickRange)