arranger_object_creator.h

// SPDX-FileCopyrightText: © 2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include <utility>
 
#include "commands/add_arranger_object_command.h"
#include "dsp/snap_grid.h"
#include "structure/arrangement/arranger_object_all.h"
#include "structure/arrangement/arranger_object_factory.h"
#include "structure/arrangement/arranger_object_owner.h"
#include "structure/arrangement/tempo_object_manager.h"
#include "structure/scenes/clip_slot.h"
#include "structure/tracks/track_all.h"
#include "undo/undo_stack.h"
 
namespace zrythm::actions
{
class ArrangerObjectCreator : public QObject
{
  Q_OBJECT
  QML_ELEMENT
  QML_UNCREATABLE ("One instance per project")
 
public:
  explicit ArrangerObjectCreator (
    undo::UndoStack                               &undo_stack,
    structure::arrangement::ArrangerObjectFactory &arranger_object_factory,
    dsp::SnapGrid                                 &snap_grid_timeline,
    dsp::SnapGrid                                 &snap_grid_editor,
    QObject *                                      parent = nullptr)
      : QObject (parent), arranger_object_factory_ (arranger_object_factory),
        snap_grid_timeline_ (snap_grid_timeline),
        snap_grid_editor_ (snap_grid_editor), undo_stack_ (undo_stack)
  {
  }
 
  Q_INVOKABLE structure::arrangement::Marker * addMarker (
    structure::arrangement::Marker::MarkerType markerType,
    structure::tracks::MarkerTrack *           markerTrack,
    const QString                             &name,
    double                                     startTicks);
 
  Q_INVOKABLE structure::arrangement::TempoObject * addTempoObject (
    structure::arrangement::TempoObjectManager *   tempoObjectManager,
    double                                         bpm,
    structure::arrangement::TempoObject::CurveType curveType,
    double                                         startTicks);
 
  Q_INVOKABLE structure::arrangement::TimeSignatureObject *
              addTimeSignatureObject (
                structure::arrangement::TempoObjectManager * tempoObjectManager,
                int                                          numerator,
                int                                          denominator,
                double                                       startTicks);
 
  Q_INVOKABLE structure::arrangement::MidiRegion * addEmptyMidiRegion (
    structure::tracks::Track *     track,
    structure::tracks::TrackLane * lane,
    double                         startTicks);
 
  Q_INVOKABLE structure::arrangement::MidiRegion * addEmptyMidiRegionToClip (
    structure::tracks::Track *    track,
    structure::scenes::ClipSlot * clipSlot)
  {
    auto mr_ref =
      arranger_object_factory_
        .get_builder<structure::arrangement::MidiRegion> ()
        .with_start_ticks (0)
        .build_in_registry ();
    clipSlot->setRegion (
      mr_ref.get_object_as<structure::arrangement::MidiRegion> ());
    return mr_ref.get_object_as<structure::arrangement::MidiRegion> ();
  }
 
  Q_INVOKABLE structure::arrangement::ChordRegion *
  addEmptyChordRegion (structure::tracks::ChordTrack * track, double startTicks);
 
  Q_INVOKABLE structure::arrangement::AutomationRegion *
              addEmptyAutomationRegion (
                structure::tracks::Track *           track,
                structure::tracks::AutomationTrack * automationTrack,
                double                               startTicks);

  structure::arrangement::AudioRegion * add_audio_region_with_clip (
    structure::tracks::Track         &track,
    structure::tracks::TrackLane     &lane,
    dsp::FileAudioSourceUuidReference clip_id,
    double                            start_ticks)
  {
    auto obj_ref = arranger_object_factory_.create_audio_region_with_clip (
      std::move (clip_id), start_ticks);
    add_laned_object (track, lane, obj_ref);
    return obj_ref.get_object_as<structure::arrangement::AudioRegion> ();
  }
 
  structure::arrangement::ScaleObject * add_scale_object (
    structure::tracks::ChordTrack             &chord_track,
    utils::QObjectUniquePtr<dsp::MusicalScale> scale,
    double                                     start_ticks)
  {
    auto obj_ref =
      arranger_object_factory_
        .get_builder<structure::arrangement::ScaleObject> ()
        .with_start_ticks (start_ticks)
        .with_scale (std::move (scale))
        .build_in_registry ();
    undo_stack_.push (
      new commands::AddArrangerObjectCommand<
        structure::arrangement::ScaleObject> (chord_track, obj_ref));
    return obj_ref.get_object_as<structure::arrangement::ScaleObject> ();
  }
 
  structure::arrangement::AudioRegion * add_empty_audio_region_for_recording (
    structure::tracks::Track     &track,
    structure::tracks::TrackLane &lane,
    int                           num_channels,
    const utils::Utf8String      &clip_name,
    double                        start_ticks)
  {
    auto region_ref =
      arranger_object_factory_.create_empty_audio_region_for_recording (
        num_channels, clip_name, start_ticks);
    add_laned_object (track, lane, region_ref);
    return region_ref.get_object_as<structure::arrangement::AudioRegion> ();
  }
 
  Q_INVOKABLE structure::arrangement::AudioRegion * addAudioRegionFromFile (
    structure::tracks::Track *     track,
    structure::tracks::TrackLane * lane,
    const QString                 &absPath,
    double                         startTicks)
  {
    auto ar_ref = arranger_object_factory_.create_audio_region_from_file (
      absPath, startTicks);
    add_laned_object (*track, *lane, ar_ref);
    return ar_ref.get_object_as<structure::arrangement::AudioRegion> ();
  }
 
  Q_INVOKABLE structure::arrangement::AudioRegion *
              addAudioRegionToClipSlotFromFile (
                structure::tracks::Track *    track,
                structure::scenes::ClipSlot * clipSlot,
                const QString                &absPath);
  Q_INVOKABLE structure::arrangement::AudioRegion *
              addMidiRegionToClipSlotFromFile (
                structure::tracks::Track *    track,
                structure::scenes::ClipSlot * clipSlot,
                const QString                &absPath);

  Q_INVOKABLE structure::arrangement::MidiRegion *
              addMidiRegionFromChordDescriptor (
                structure::tracks::Track *     track,
                structure::tracks::TrackLane * lane,
                const dsp::ChordDescriptor    &descr,
                double                         startTicks);

  Q_INVOKABLE structure::arrangement::MidiRegion * addMidiRegionFromMidiFile (
    structure::tracks::Track *     track,
    structure::tracks::TrackLane * lane,
    const QString                 &absolutePath,
    double                         startTicks,
    int                            midiTrackIndex);
 
  Q_INVOKABLE structure::arrangement::MidiNote * addMidiNote (
    structure::arrangement::MidiRegion * region,
    double                               startTicks,
    int                                  pitch);
 
  Q_INVOKABLE structure::arrangement::AutomationPoint * addAutomationPoint (
    structure::arrangement::AutomationRegion * region,
    double                                     startTicks,
    double                                     value)
 
  {
    return add_editor_object (*region, startTicks, value);
  }
 
  Q_INVOKABLE structure::arrangement::ChordObject * addChordObject (
    structure::arrangement::ChordRegion * region,
    double                                startTicks,
    const int                             chordIndex)
 
  {
    return add_editor_object (*region, startTicks, chordIndex);
  }
 
private:
  void add_laned_object (
    structure::tracks::Track                           &track,
    structure::tracks::TrackLane                       &lane,
    structure::arrangement::ArrangerObjectUuidReference obj_ref);
 
  void add_object_to_clip_slot (
    structure::tracks::Track                           &track,
    structure::scenes::ClipSlot                        &clip_slot,
    structure::arrangement::ArrangerObjectUuidReference obj_ref);

  template <structure::arrangement::RegionObject RegionT>
  auto add_editor_object (
    RegionT                  &region,
    double                    startTicks,
    std::variant<int, double> value) -> RegionT::ArrangerObjectChildType *
    requires (!std::is_same_v<RegionT, structure::arrangement::AudioRegion>)
  {
    using ChildT = typename RegionT::ArrangerObjectChildType;
    auto obj_ref = arranger_object_factory_.create_editor_object<RegionT> (
      startTicks, value);
    undo_stack_.push (
      new commands::AddArrangerObjectCommand<ChildT> (region, obj_ref));
    auto obj = obj_ref.template get_object_as<ChildT> ();
    return obj;
  }
 
private:
  structure::arrangement::ArrangerObjectFactory &arranger_object_factory_;
  dsp::SnapGrid                                 &snap_grid_timeline_;
  dsp::SnapGrid                                 &snap_grid_editor_;
  undo::UndoStack                               &undo_stack_;
};
} // namespace zrythm::actions