chord_editor.h

// SPDX-FileCopyrightText: © 2019-2022, 2024-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include "dsp/chord_descriptor.h"
#include "dsp/musical_scale.h"
#include "structure/arrangement/editor_settings.h"
#include "utils/icloneable.h"
 
class ChordPreset;
 
namespace zrythm::structure::arrangement
{
 
constexpr int CHORD_EDITOR_NUM_CHORDS = 12;

class ChordEditor : public QObject
{
  Q_OBJECT
  Q_PROPERTY (
    zrythm::structure::arrangement::EditorSettings * editorSettings READ
      getEditorSettings CONSTANT FINAL)
  QML_ELEMENT
  QML_UNCREATABLE ("")
 
public:
  using ChordDescriptor = dsp::ChordDescriptor;
  using ChordAccent = dsp::ChordAccent;
  using ChordType = dsp::ChordType;
  using MusicalScale = dsp::MusicalScale;
  using MusicalNote = dsp::MusicalNote;
 
  ChordEditor (QObject * parent = nullptr);
 
  // =========================================================
  // QML interface
  // =========================================================
 
  auto getEditorSettings () const { return editor_settings_.get (); }
 
  // =========================================================

  void init ();
 
  void
  apply_single_chord (const ChordDescriptor &chord, int idx, bool undoable);
 
  void apply_chords (const std::vector<ChordDescriptor> &chords, bool undoable);
 
  void apply_preset_from_scale (
    MusicalScale::ScaleType scale,
    MusicalNote             root_note,
    bool                    undoable);
 
  void transpose_chords (bool up, bool undoable);

  ChordDescriptor * get_chord_from_note_number (midi_byte_t note_number);
 
  int get_chord_index (const ChordDescriptor &chord) const;
 
  auto &get_chord_at_index (size_t index) { return chords_.at (index); }
  auto &get_chord_at_index (size_t index) const { return chords_.at (index); }
 
  friend void init_from (
    ChordEditor           &obj,
    const ChordEditor     &other,
    utils::ObjectCloneType clone_type)
 
  {
    obj.editor_settings_ =
      utils::clone_unique_qobject (*other.editor_settings_, &obj);
  }
 
  void add_chord_descriptor (ChordDescriptor &&chord_descr)
  {
    chords_.emplace_back (std::move (chord_descr));
    chords_.back ().update_notes ();
  }
 
  void
  replace_chord_descriptor (const auto index, ChordDescriptor &&chord_descr)
  {
    chords_.erase (chords_.begin () + index);
    chords_.insert (chords_.begin () + index, std::move (chord_descr));
    get_chord_at_index (index).update_notes ();
  }
 
private:
  static constexpr auto kEditorSettingsKey = "editorSettings"sv;
  static constexpr auto kChordsKey = "chords"sv;
  friend void           to_json (nlohmann::json &j, const ChordEditor &editor)
  {
    j[kEditorSettingsKey] = editor.editor_settings_;
    j[kChordsKey] = editor.chords_;
  }
  friend void from_json (const nlohmann::json &j, ChordEditor &editor)
  {
    j.at (kEditorSettingsKey).get_to (editor.editor_settings_);
    j.at (kChordsKey).get_to (editor.chords_);
  }
 
public:
  std::vector<ChordDescriptor> chords_;
 
private:
  utils::QObjectUniquePtr<EditorSettings> editor_settings_;
};
 
}