ext_port.h

Go to the documentation of this file.

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

 
#include "zrythm-config.h"
 
#include "gui/dsp/port.h"
#include "utils/serialization.h"
#include "utils/types.h"
 
#ifdef HAVE_JACK
#  include "weakjack/weak_libjack.h"
#endif
 
#if HAVE_RTMIDI
#  include <rtmidi_c.h>
#endif
 
class HardwareProcessor;
enum class AudioBackend;
enum class MidiBackend;


class ExtPort final : public IPortOwner
{
public:
  enum class Type
  {
    JACK,
    ALSA,
    WindowsMME,
    RtMidi,
    RtAudio,
  };
 
  using PortType = zrythm::dsp::PortType;
  using PortFlow = zrythm::dsp::PortFlow;
 
public:
  ExtPort () = default;
#ifdef HAVE_JACK
  ExtPort (jack_port_t * jport);
#endif /* defined(HAVE_JACK) */
 
  bool is_in_active_project () const override;
 
  void set_port_metadata_from_owner (dsp::PortIdentifier &id, PortRange &range)
    const override;
 
  utils::Utf8String
  get_full_designation_for_port (const dsp::PortIdentifier &id) const override;

  [[gnu::cold]] void init_loaded (HardwareProcessor * hw_processor)
  {
    hw_processor_ = hw_processor;
  }

  void print () const;

  bool matches_backend () const;

  utils::Utf8String get_id () const;
 
  friend bool operator== (const ExtPort &a, const ExtPort &b);

  utils::Utf8String get_friendly_name () const;

  float * get_buffer (nframes_t nframes) const;

  void clear_buffer (nframes_t nframes);
 
#if 0
void
connect (
  Port *    port,
  int       src);
#endif

  void disconnect (Port * port, int src);

  bool activate (Port * port, bool activate);

  bool get_enabled () const;

  static void ext_ports_get (
    PortType              type,
    PortFlow              flow,
    bool                  hw,
    std::vector<ExtPort> &ports,
    AudioEngine          &engine);
 
private:
  static constexpr std::string_view kTypeKey = "type";
  static constexpr std::string_view kFullNameKey = "fullName";
  static constexpr std::string_view kShortNameKey = "shortName";
  static constexpr std::string_view kAlias1Key = "alias1";
  static constexpr std::string_view kAlias2Key = "alias2";
  static constexpr std::string_view kNumAliasesKey = "numAliases";
  static constexpr std::string_view kRtAudioDeviceNameKey = "rtAudioDeviceName";
  static constexpr std::string_view kRtAudioChannelIndexKey =
    "rtAudioChannelIndex";
  static constexpr std::string_view kIsMidiKey = "isMidi";
  friend void to_json (nlohmann::json &j, const ExtPort &port)
  {
    j = nlohmann::json{
      { kTypeKey,                port.type_                },
      { kFullNameKey,            port.full_name_           },
      { kShortNameKey,           port.short_name_          },
      { kAlias1Key,              port.alias1_              },
      { kAlias2Key,              port.alias2_              },
      { kNumAliasesKey,          port.num_aliases_         },
      { kRtAudioDeviceNameKey,   port.rtaudio_dev_name_    },
      { kRtAudioChannelIndexKey, port.rtaudio_channel_idx_ },
      { kIsMidiKey,              port.is_midi_             },
    };
  }
  friend void from_json (const nlohmann::json &j, ExtPort &port)
  {
    j.at (kTypeKey).get_to (port.type_);
    j.at (kFullNameKey).get_to (port.full_name_);
    j.at (kShortNameKey).get_to (port.short_name_);
    j.at (kAlias1Key).get_to (port.alias1_);
    j.at (kAlias2Key).get_to (port.alias2_);
    j.at (kNumAliasesKey).get_to (port.num_aliases_);
    j.at (kRtAudioDeviceNameKey).get_to (port.rtaudio_dev_name_);
    j.at (kRtAudioChannelIndexKey).get_to (port.rtaudio_channel_idx_);
    j.at (kIsMidiKey).get_to (port.is_midi_);
  }
 
public:
#ifdef HAVE_JACK
  jack_port_t * jport_ = nullptr;
#else
  void * jport_ = nullptr;
#endif

  utils::Utf8String full_name_;

  utils::Utf8String short_name_;

  utils::Utf8String alias1_;

  utils::Utf8String alias2_;
 
  int num_aliases_ = 0;

  unsigned int rtaudio_channel_idx_ = 0;

  utils::Utf8String rtaudio_dev_name_;

  unsigned int rtaudio_id_ = 0;

  bool rtaudio_is_input_ = false;
  bool rtaudio_is_duplex_ = false;
 
  std::shared_ptr<
#if HAVE_RTAUDIO
    RtAudioDevice
#else
    int
#endif
    >
    rtaudio_dev_;

  unsigned int rtmidi_id_ = 0;
 
  std::shared_ptr<
#if HAVE_RTMIDI
    RtMidiDevice
#else
    int
#endif
    >
    rtmidi_dev_;
 
  Type type_ = (Type) 0;

  bool is_midi_ = false;

  int hw_processor_index_ = -1;

  HardwareProcessor * hw_processor_ = nullptr;

  bool active_ = false;

  bool pending_reconnect_ = false;

  Port * port_ = nullptr;
};
 
inline bool
operator== (const ExtPort &a, const ExtPort &b)
{
  return a.type_ == b.type_ && a.full_name_ == b.full_name_;
}

 
#endif