channel_track.h

// SPDX-FileCopyrightText: © 2018-2019, 2024-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include "structure/tracks/channel.h"
#include "structure/tracks/processable_track.h"
 
#define DEFINE_CHANNEL_TRACK_QML_PROPERTIES(ClassType) \
public: \
  Q_PROPERTY (Channel * channel READ channel CONSTANT)
 
namespace zrythm::structure::tracks
{
class ChannelTrack : virtual public ProcessableTrack
{
protected:
  ChannelTrack (FinalTrackDependencies dependencies);
 
public:
  ~ChannelTrack () override = default;
 
  Channel * channel () const { return channel_.get (); }

  bool currently_muted () const override
  {
    return channel_->get_fader ().currently_muted ();
  }

  bool currently_listened () const override
  {
    return channel_->get_fader ().currently_listened ();
  }

  bool get_implied_soloed () const override;
 
  bool currently_soloed () const override
  {
    return channel_->get_fader ().currently_soloed ();
  }

  // GMenu * generate_channel_context_menu ();

  void set_listened (
    bool listen,
    bool trigger_undo,
    bool auto_select,
    bool fire_events);

  void
  set_soloed (bool solo, bool trigger_undo, bool auto_select, bool fire_events);

  void
  set_muted (bool mute, bool trigger_undo, bool auto_select, bool fire_events);
 
  void set_output (std::optional<Track::Uuid> id) { output_track_uuid_ = id; }
 
  bool has_output () const { return output_track_uuid_.has_value (); }
 
  auto output_track () const
  {
    return track_registry_.find_by_id_or_throw (output_track_uuid_.value ());
  }
 
  GroupTargetTrack &output_track_as_group_target () const;
 
protected:
  friend void init_from (
    ChannelTrack          &obj,
    const ChannelTrack    &other,
    utils::ObjectCloneType clone_type);

  void init_channel ();
 
private:
  static constexpr auto kChannelKey = "channel"sv;
  static constexpr auto kOutputIdKey = "outputId"sv;
  friend void           to_json (nlohmann::json &j, const ChannelTrack &c)
  {
    j[kChannelKey] = c.channel_;
    j[kOutputIdKey] = c.output_track_uuid_;
  }
  friend void from_json (const nlohmann::json &j, ChannelTrack &c)
  {
    c.channel_ = c.generate_channel ();
    j.at (kChannelKey).get_to (*c.channel_);
    j.at (kOutputIdKey).get_to (c.output_track_uuid_);
  }
 
  utils::QObjectUniquePtr<Channel> generate_channel ();
 
private:
  utils::QObjectUniquePtr<Channel> channel_;

  std::optional<Uuid> output_track_uuid_;
 
  TrackRegistry &track_registry_;
};
 
using ChannelTrackVariant = std::variant<
  AudioBusTrack,
  AudioTrack,
  ChordTrack,
  MidiBusTrack,
  MidiTrack,
  AudioGroupTrack,
  MidiGroupTrack,
  InstrumentTrack,
  MasterTrack>;
using ChannelTrackPtrVariant = to_pointer_variant<ChannelTrackVariant>;
 
} // namespace zrythm::structure::tracks