project.h

// SPDX-FileCopyrightText: © 2018-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include "dsp/audio_pool.h"
#include "dsp/engine.h"
#include "dsp/metronome.h"
#include "dsp/port_connections_manager.h"
#include "dsp/snap_grid.h"
#include "dsp/tempo_map_qml_adapter.h"
#include "dsp/transport.h"
#include "plugins/plugin.h"
#include "plugins/plugin_factory.h"
#include "structure/arrangement/arranger_object_factory.h"
#include "structure/arrangement/tempo_object_manager.h"
#include "structure/scenes/clip_launcher.h"
#include "structure/scenes/clip_playback_service.h"
#include "structure/tracks/track_factory.h"
#include "structure/tracks/tracklist.h"
#include "utils/app_settings.h"
 
namespace zrythm::structure::project
{
 
#define PORT_CONNECTIONS_MGR (PROJECT->port_connections_manager_.get ())
#define AUDIO_POOL (PROJECT->audio_pool_.get ())
#define TRANSPORT (PROJECT->transport_)
 
#define TRACKLIST (PROJECT->tracklist_)
#define P_CHORD_TRACK (TRACKLIST->singletonTracks ()->chordTrack ())
#define P_MARKER_TRACK (TRACKLIST->singletonTracks ()->markerTrack ())
#define P_MASTER_TRACK (TRACKLIST->singletonTracks ()->masterTrack ())
#define P_MODULATOR_TRACK (TRACKLIST->singletonTracks ()->modulatorTrack ())
#define SNAP_GRID_TIMELINE (PROJECT->snapGridTimeline ())
#define SNAP_GRID_EDITOR (PROJECT->snapGridEditor ())
#define MONITOR_FADER (PROJECT->controlRoom ()->monitor_fader_)
#define ROUTER (&PROJECT->engine ()->graph_dispatcher ())
#define AUDIO_ENGINE (PROJECT->engine ())

class Project final : public QObject
{
  Q_OBJECT
  QML_ELEMENT
  Q_PROPERTY (
    QString title READ getTitle WRITE setTitle NOTIFY titleChanged FINAL)
  Q_PROPERTY (
    QString directory READ directory WRITE setDirectory NOTIFY directoryChanged
      FINAL)
  Q_PROPERTY (
    zrythm::structure::tracks::Tracklist * tracklist READ tracklist CONSTANT
      FINAL)
  Q_PROPERTY (
    zrythm::structure::scenes::ClipLauncher * clipLauncher READ clipLauncher
      CONSTANT FINAL)
  Q_PROPERTY (
    zrythm::structure::scenes::ClipPlaybackService * clipPlaybackService READ
      clipPlaybackService CONSTANT FINAL)
  Q_PROPERTY (zrythm::dsp::AudioEngine * engine READ engine CONSTANT FINAL)
  Q_PROPERTY (zrythm::dsp::Metronome * metronome READ metronome CONSTANT)
  Q_PROPERTY (
    zrythm::dsp::Transport * transport READ getTransport CONSTANT FINAL)
  Q_PROPERTY (
    zrythm::dsp::TempoMapWrapper * tempoMap READ getTempoMap CONSTANT FINAL)
  Q_PROPERTY (
    zrythm::structure::arrangement::TempoObjectManager * tempoObjectManager READ
      tempoObjectManager CONSTANT FINAL)
  Q_PROPERTY (
    zrythm::dsp::SnapGrid * snapGridTimeline READ snapGridTimeline CONSTANT FINAL)
  Q_PROPERTY (
    zrythm::dsp::SnapGrid * snapGridEditor READ snapGridEditor CONSTANT FINAL)
  QML_UNCREATABLE ("")
 
  friend struct PluginBuilderForDeserialization;
 
public:
  using TrackUuid = structure::tracks::TrackUuid;
  using PluginPtrVariant = plugins::PluginPtrVariant;
  using PluginRegistry = plugins::PluginRegistry;
 
public:
  Project (
    utils::AppSettings                             &app_settings,
    std::shared_ptr<juce::AudioDeviceManager>       device_manager,
    std::shared_ptr<juce::AudioPluginFormatManager> plugin_format_manager,
    plugins::PluginHostWindowFactory                plugin_host_window_provider,
    dsp::Fader                                     &monitor_fader,
    utils::Utf8String                               zrythm_version,
    QObject *                                       parent = nullptr);
  ~Project () override;
  Z_DISABLE_COPY_MOVE (Project)
 
  // =========================================================
  // QML interface
  // =========================================================
 
  QString                           getTitle () const;
  void                              setTitle (const QString &title);
  QString                           directory () const;
  void                              setDirectory (const QString &directory);
  structure::tracks::Tracklist *    tracklist () const;
  structure::scenes::ClipLauncher * clipLauncher () const;
  structure::scenes::ClipPlaybackService *     clipPlaybackService () const;
  dsp::Metronome *                             metronome () const;
  dsp::Transport *                             getTransport () const;
  dsp::AudioEngine *                           engine () const;
  dsp::TempoMapWrapper *                       getTempoMap () const;
  dsp::SnapGrid *                              snapGridTimeline () const;
  dsp::SnapGrid *                              snapGridEditor () const;
  structure::arrangement::TempoObjectManager * tempoObjectManager () const;
 
  Q_SIGNAL void titleChanged (const QString &title);
  Q_SIGNAL void directoryChanged (const QString &directory);
  Q_SIGNAL void aboutToBeDeleted ();
 
  // =========================================================
 
  // static Project * get_active_instance ();
 
  dsp::Fader &monitor_fader ();
 
  fs::path get_directory (bool for_backup) const;
 
  // TODO: delete this getter, no one else should use factory directly
  auto * arrangerObjectFactory () const
  {
    return arranger_object_factory_.get ();
  }
 
  friend void init_from (
    Project               &obj,
    const Project         &other,
    utils::ObjectCloneType clone_type);

  Q_INVOKABLE Project * clone (bool for_backup) const;

  std::optional<fs::path> get_newer_backup ();

  Q_INVOKABLE void activate ();

  void add_default_tracks ();
 
  structure::tracks::FinalTrackDependencies
  get_final_track_dependencies () const;
 
  auto &get_file_audio_source_registry () const
  {
    return *file_audio_source_registry_;
  }
  auto &get_track_registry () const { return *track_registry_; }
  auto &get_plugin_registry () const { return *plugin_registry_; }
  auto &get_port_registry () const { return *port_registry_; }
  auto &get_param_registry () const { return *param_registry_; }
  auto &get_arranger_object_registry () const
  {
    return *arranger_object_registry_;
  }

  std::optional<dsp::PortPtrVariant>
  find_port_by_id (const dsp::Port::Uuid &id) const
  {
    return get_port_registry ().find_by_id (id);
  }
 
  dsp::ProcessorParameter *
  find_param_by_id (const dsp::ProcessorParameter::Uuid &id) const
  {
    const auto opt_var = get_param_registry ().find_by_id (id);
    if (opt_var.has_value ())
      {
        return std::get<dsp::ProcessorParameter *> (opt_var.value ());
      }
    return nullptr;
  }
 
  std::optional<plugins::PluginPtrVariant>
  find_plugin_by_id (plugins::Plugin::Uuid id) const
  {
    return get_plugin_registry ().find_by_id (id);
  }
 
  std::optional<zrythm::structure::tracks::TrackPtrVariant>
  find_track_by_id (structure::tracks::Track::Uuid id) const
  {
    return get_track_registry ().find_by_id (id);
  }
 
  std::optional<zrythm::structure::arrangement::ArrangerObjectPtrVariant>
  find_arranger_object_by_id (
    structure::arrangement::ArrangerObject::Uuid id) const
  {
    return get_arranger_object_registry ().find_by_id (id);
  }
 
  const auto &get_tempo_map () const { return tempo_map_; }
 
private:
  static constexpr auto kTempoMapKey = "tempoMap"sv;
  static constexpr auto kFileAudioSourceRegistryKey =
    "fileAudioSourceRegistry"sv;
  static constexpr auto kPortRegistryKey = "portRegistry"sv;
  static constexpr auto kParameterRegistryKey = "paramRegistry"sv;
  static constexpr auto kPluginRegistryKey = "pluginRegistry"sv;
  static constexpr auto kArrangerObjectRegistryKey = "arrangerObjectRegistry"sv;
  static constexpr auto kTrackRegistryKey = "trackRegistry"sv;
  static constexpr auto kTitleKey = "title"sv;
  static constexpr auto kDatetimeKey = "datetime"sv;
  static constexpr auto kVersionKey = "version"sv;
  static constexpr auto kSnapGridTimelineKey = "snapGridTimeline"sv;
  static constexpr auto kSnapGridEditorKey = "snapGridEditor"sv;
  static constexpr auto kTransportKey = "transport"sv;
  static constexpr auto kAudioPoolKey = "audioPool"sv;
  static constexpr auto kTracklistKey = "tracklist"sv;
  static constexpr auto kRegionLinkGroupManagerKey = "regionLinkGroupManager"sv;
  static constexpr auto kPortConnectionsManagerKey = "portConnectionsManager"sv;
  static constexpr auto kTempoObjectManagerKey = "tempoObjectManager"sv;
  static constexpr auto DOCUMENT_TYPE = "ZrythmProject"sv;
  static constexpr auto FORMAT_MAJOR_VER = 2;
  static constexpr auto FORMAT_MINOR_VER = 1;
  friend void           to_json (nlohmann::json &j, const Project &project);
  friend void           from_json (const nlohmann::json &j, Project &project);
 
private:
  utils::AppSettings                           &app_settings_;
  dsp::TempoMap                                 tempo_map_;
  utils::QObjectUniquePtr<dsp::TempoMapWrapper> tempo_map_wrapper_;
 
  plugins::PluginHostWindowFactory plugin_host_window_provider_;
 
  dsp::FileAudioSourceRegistry *    file_audio_source_registry_{};
  dsp::PortRegistry *               port_registry_{};
  dsp::ProcessorParameterRegistry * param_registry_{};
  PluginRegistry *                  plugin_registry_{};
  structure::arrangement::ArrangerObjectRegistry * arranger_object_registry_{};
  structure::tracks::TrackRegistry *               track_registry_{};
 
public:
  utils::Utf8String title_;

  utils::Utf8String datetime_str_;

  fs::path dir_;

  std::optional<fs::path> backup_dir_;
 
  /* !!! IMPORTANT: order matters (for destruction) !!! */

  utils::Utf8String version_;

  bool loading_from_backup_ = false;
 
  std::shared_ptr<juce::AudioDeviceManager> device_manager_;
 
  std::shared_ptr<juce::AudioPluginFormatManager> plugin_format_manager_;

  utils::QObjectUniquePtr<dsp::PortConnectionsManager> port_connections_manager_;

  utils::QObjectUniquePtr<dsp::SnapGrid> snap_grid_editor_;

  utils::QObjectUniquePtr<dsp::SnapGrid> snap_grid_timeline_;
 
  utils::QObjectUniquePtr<dsp::Metronome> metronome_;

  utils::QObjectUniquePtr<dsp::Transport> transport_;

  utils::QObjectUniquePtr<dsp::AudioEngine> audio_engine_;

  std::unique_ptr<dsp::AudioPool> pool_;

  // structure::arrangement::RegionLinkGroupManager region_link_group_manager_;

  utils::QObjectUniquePtr<structure::tracks::Tracklist> tracklist_;

  boost::unordered_flat_map<
    structure::tracks::TrackUuid,
    structure::tracks::TrackPtrVariant>
    tracks_rt_;
 
  utils::QObjectUniquePtr<structure::scenes::ClipLauncher> clip_launcher_;
  utils::QObjectUniquePtr<structure::scenes::ClipPlaybackService>
    clip_playback_service_;
 
  std::unique_ptr<structure::arrangement::ArrangerObjectFactory>
                                                   arranger_object_factory_;
  utils::QObjectUniquePtr<plugins::PluginFactory>  plugin_factory_;
  std::unique_ptr<structure::tracks::TrackFactory> track_factory_;
 
  utils::QObjectUniquePtr<structure::arrangement::TempoObjectManager>
    tempo_object_manager_;
 
  dsp::Fader &monitor_fader_;

  dsp::DspGraphDispatcher graph_dispatcher_;

  int format_major_ = 0;
  int format_minor_ = 0;
};
 
}