itransport.h

// SPDX-FileCopyrightText: © 2024-2026 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include <cstdint>
 
#include "utils/units.h"
 
namespace zrythm::dsp
{
class ITransport
{
public:
  enum class PlayState : std::uint8_t
  {
    RollRequested,
    Rolling,
    PauseRequested,
    Paused
  };
 
public:
  virtual ~ITransport () = default;

  virtual std::pair<units::sample_t, units::sample_t>
  get_loop_range_positions () const noexcept [[clang::nonblocking]] = 0;

  virtual std::pair<units::sample_t, units::sample_t>
  get_punch_range_positions () const noexcept [[clang::nonblocking]] = 0;
 
  virtual PlayState get_play_state () const noexcept [[clang::nonblocking]] = 0;

  virtual units::sample_t
  get_playhead_position_in_audio_thread () const noexcept
    [[clang::nonblocking]] = 0;

  units::sample_t get_playhead_position_after_adding_frames_in_audio_thread (
    const units::sample_t current_playhead_position,
    const units::sample_t frames_to_add) const noexcept [[clang::nonblocking]]
  {
    auto new_pos = current_playhead_position + frames_to_add;
 
    /* if start frames were before the loop-end point and the new frames are
     * after (loop crossed) */
    if (loop_enabled ())
      {
        const auto loop_points = get_loop_range_positions ();
        const auto loop_start = loop_points.first;
        const auto loop_end = loop_points.second;
        while (current_playhead_position < loop_end && new_pos >= loop_end)
          {
            /* adjust the new frames */
            new_pos += loop_start - loop_end;
          }
      }
 
    return new_pos;
  }
 
  virtual bool loop_enabled () const noexcept [[clang::nonblocking]] = 0;
 
  virtual bool punch_enabled () const noexcept [[clang::nonblocking]] = 0;

  virtual bool recording_enabled () const noexcept [[clang::nonblocking]] = 0;

  virtual units::sample_t recording_preroll_frames_remaining () const noexcept
    [[clang::nonblocking]] = 0;
 
  bool
  has_recording_preroll_frames_remaining () const noexcept [[clang::nonblocking]]
  {
    return recording_preroll_frames_remaining () > units::samples (0);
  }

  virtual units::sample_t metronome_countin_frames_remaining () const noexcept
    [[clang::nonblocking]] = 0;

  units::sample_t is_loop_point_met_in_audio_thread (
    units::sample_t g_start_frames,
    units::sample_t nframes) const noexcept [[clang::nonblocking]]
  {
    auto [loop_start_pos, loop_end_pos] = get_loop_range_positions ();
    bool loop_end_between_start_and_end =
      (loop_end_pos > g_start_frames && loop_end_pos <= g_start_frames + nframes);
 
    if (loop_end_between_start_and_end && loop_enabled ()) [[unlikely]]
      {
        return loop_end_pos - g_start_frames;
      }
    return units::samples (0);
  }
};
 
} // namespace zrythm::dsp