chord_object.h

// SPDX-FileCopyrightText: © 2018-2022, 2024-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include "dsp/chord_descriptor.h"
#include "gui/dsp/arranger_object.h"
#include "gui/dsp/muteable_object.h"
#include "gui/dsp/region_owned_object.h"
#include "utils/icloneable.h"

 
using namespace zrythm;
 
namespace zrythm::dsp
{
class ChordDescriptor;
}
class ChordRegion;

class ChordObject final
    : public QObject,
      public MuteableObject,
      public RegionOwnedObject,
      public ICloneable<ChordObject>
{
  Q_OBJECT
  QML_ELEMENT
  DEFINE_ARRANGER_OBJECT_QML_PROPERTIES (ChordObject)
  Q_PROPERTY (
    ChordDescriptor * chordDescriptor READ getChordDescriptor WRITE
      setChordDescriptor NOTIFY chordDescriptorChanged)
 
public:
  using RegionT = ChordRegion;
  using ChordDescriptor = dsp::ChordDescriptor;
 
  static constexpr int WIDGET_TRIANGLE_WIDTH = 10;
 
public:
  DECLARE_FINAL_ARRANGER_OBJECT_CONSTRUCTORS (ChordObject)
 
  // ========================================================================
  // QML Interface
  // ========================================================================
 
  ChordDescriptor * getChordDescriptor () const;
 
  void          setChordDescriptor (ChordDescriptor * descr);
  Q_SIGNAL void chordDescriptorChanged (ChordDescriptor *);
 
  // ========================================================================
 
  void set_chord_descriptor (int index);
 
  ArrangerObjectPtrVariant
  add_clone_to_project (bool fire_events) const override;
 
  ArrangerObjectPtrVariant insert_clone_to_project () const override;
 
  utils::Utf8String gen_human_friendly_name () const override;
 
  friend bool operator== (const ChordObject &lhs, const ChordObject &rhs)
  {
    return static_cast<const ArrangerObject &> (lhs)
             == static_cast<const ArrangerObject &> (rhs)
           && lhs.chord_index_ == rhs.chord_index_
           && static_cast<const RegionOwnedObject &> (lhs)
                == static_cast<const RegionOwnedObject &> (rhs)
           && static_cast<const MuteableObject &> (lhs)
                == static_cast<const MuteableObject &> (rhs);
  }
 
  bool
  validate (bool is_project, dsp::FramesPerTick frames_per_tick) const override;
 
  void init_after_cloning (const ChordObject &other, ObjectCloneType clone_type)
    override;
 
private:
  static constexpr std::string_view kChordIndexKey = "chordIndex";
  friend void to_json (nlohmann::json &j, const ChordObject &co)
  {
    to_json (j, static_cast<const ArrangerObject &> (co));
    to_json (j, static_cast<const MuteableObject &> (co));
    to_json (j, static_cast<const RegionOwnedObject &> (co));
    j[kChordIndexKey] = co.chord_index_;
  }
  friend void from_json (const nlohmann::json &j, ChordObject &co)
  {
    from_json (j, static_cast<ArrangerObject &> (co));
    from_json (j, static_cast<MuteableObject &> (co));
    from_json (j, static_cast<RegionOwnedObject &> (co));
    j.at (kChordIndexKey).get_to (co.chord_index_);
  }
 
public:
  int chord_index_ = 0;
};
 
DEFINE_OBJECT_FORMATTER (ChordObject, ChordObject, [] (const ChordObject &co) {
  return fmt::format (
    "ChordObject [{}]: chord ID {}", co.get_position (), co.chord_index_);
});