recordable_track.h

// SPDX-FileCopyrightText: © 2024-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include "dsp/parameter.h"
#include "dsp/processor_base.h"
 
#include <QtQmlIntegration>
 
namespace zrythm::structure::tracks
{
class RecordableTrackMixin : public QObject
{
  Q_OBJECT
  Q_PROPERTY (
    bool recording READ recording WRITE setRecording NOTIFY recordingChanged)
  QML_ELEMENT
  QML_UNCREATABLE ("")
 
public:
  using NameProvider = std::function<utils::Utf8String ()>;
 
  RecordableTrackMixin (
    dsp::ProcessorBase::ProcessorBaseDependencies dependencies,
    NameProvider                                  name_provider,
    QObject *                                     parent = nullptr);
  ~RecordableTrackMixin () override = default;
  Z_DISABLE_COPY_MOVE (RecordableTrackMixin)
 
  // ========================================================================
  // QML Interface
  // ========================================================================
 
  [[gnu::hot]] bool recording () const
  {
    const auto &recording_param = get_recording_param ();
    return recording_param.range ().is_toggled (recording_param.baseValue ());
  }
  void          setRecording (bool recording);
  Q_SIGNAL void recordingChanged (bool recording);
 
  // ========================================================================
 
  dsp::ProcessorParameter &get_recording_param () const
  {
    return *recording_id_.get_object_as<dsp::ProcessorParameter> ();
  }
 
private:
  static constexpr auto kRecordingIdKey = "recordingId"sv;
  static constexpr auto kRecordSetAutomaticallyKey = "recordSetAutomatically"sv;
  friend void to_json (nlohmann::json &j, const RecordableTrackMixin &track)
  {
    j[kRecordingIdKey] = track.recording_id_;
    j[kRecordSetAutomaticallyKey] = track.record_set_automatically_;
  }
  friend void from_json (const nlohmann::json &j, RecordableTrackMixin &track)
  {
    track.recording_id_ = { track.dependencies_.param_registry_ };
    j.at (kRecordingIdKey).get_to (track.recording_id_);
    j.at (kRecordSetAutomaticallyKey).get_to (track.record_set_automatically_);
  }
 
  friend void init_from (
    RecordableTrackMixin       &obj,
    const RecordableTrackMixin &other,
    utils::ObjectCloneType      clone_type)
  {
    obj.recording_id_ = other.recording_id_;
    obj.record_set_automatically_ = other.record_set_automatically_;
  }
 
private:
  dsp::ProcessorBase::ProcessorBaseDependencies dependencies_;
 
  // Used for debugging.
  NameProvider name_provider_;

  dsp::ProcessorParameterUuidReference recording_id_;
 
public:
  bool record_set_automatically_ = false;
};
}