marker.h

// SPDX-FileCopyrightText: © 2019-2021, 2024-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __AUDIO_MARKER_H__
#define __AUDIO_MARKER_H__

 
#include "gui/dsp/bounded_object.h"
#include "gui/dsp/named_object.h"
#include "gui/dsp/timeline_object.h"
#include "utils/icloneable.h"

class Marker final
    : public QObject,
      public TimelineObject,
      public NamedObject,
      public ICloneable<Marker>
{
  Q_OBJECT
  QML_ELEMENT
  DEFINE_ARRANGER_OBJECT_QML_PROPERTIES (Marker)
  DEFINE_NAMEABLE_OBJECT_QML_PROPERTIES (Marker)
 
public:
  enum class Type
  {
    Start,
    End,
    Custom,
  };
 
  Marker (
    ArrangerObjectRegistry &obj_registry,
    TrackResolver           track_resolver,
    NameValidator           name_validator,
    QObject *               parent = nullptr);
 
  bool is_start () const { return marker_type_ == Type::Start; }
  bool is_end () const { return marker_type_ == Type::End; }
 
  bool is_deletable () const override
  {
    return marker_type_ != Type::Start && marker_type_ != Type::End;
  }
 
  void
  init_after_cloning (const Marker &other, ObjectCloneType clone_type) override;
 
  ArrangerObjectPtrVariant
  add_clone_to_project (bool fire_events) const override;
 
  ArrangerObjectPtrVariant insert_clone_to_project () const override;
 
  bool
  validate (bool is_project, dsp::FramesPerTick frames_per_tick) const override;
 
private:
  static constexpr std::string_view kMarkerTypeKey = "markerType";
  friend void                       to_json (nlohmann::json &j, const Marker &m)
  {
    to_json (j, static_cast<const ArrangerObject &> (m));
    to_json (j, static_cast<const NamedObject &> (m));
    j[kMarkerTypeKey] = m.marker_type_;
  }
  friend void from_json (const nlohmann::json &j, Marker &m)
  {
    from_json (j, static_cast<ArrangerObject &> (m));
    from_json (j, static_cast<NamedObject &> (m));
    j.at (kMarkerTypeKey).get_to (m.marker_type_);
  }
 
public:
  Type marker_type_ = Type::Custom;
};
 
DEFINE_OBJECT_FORMATTER (Marker, Marker, [] (const Marker &m) {
  return fmt::format (
    "Marker[name: {}, type: {}, position: {}]", m.get_name (),
    ENUM_NAME (m.marker_type_), m.get_position ());
})

 
#endif