file_audio_source.h

// SPDX-FileCopyrightText: © 2019-2025 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#pragma once
 
#include "utils/audio.h"
#include "utils/audio_file.h"
#include "utils/icloneable.h"
#include "utils/monotonic_time_provider.h"
#include "utils/types.h"
#include "utils/units.h"
#include "utils/uuid_identifiable_object.h"
 
namespace zrythm::dsp
{

class FileAudioSource final
    : public QObject,
      public utils::UuidIdentifiableObject<FileAudioSource>
{
  Q_OBJECT
 
public:
  using BitDepth = zrythm::utils::audio::BitDepth;
  using AudioFile = zrythm::utils::audio::AudioFile;
 
public:
  FileAudioSource (QObject * parent = nullptr) : QObject (parent) { }

  FileAudioSource (
    const fs::path      &full_path,
    units::sample_rate_t project_sample_rate,
    bpm_t                current_bpm,
    QObject *            parent = nullptr);

  FileAudioSource (
    const utils::audio::AudioBuffer &buf,
    utils::audio::BitDepth           bit_depth,
    units::sample_rate_t             project_sample_rate,
    bpm_t                            current_bpm,
    const utils::Utf8String         &name,
    QObject *                        parent = nullptr);

  FileAudioSource (
    const float *                  arr,
    unsigned_frame_t               nframes,
    channels_t                     channels,
    zrythm::utils::audio::BitDepth bit_depth,
    units::sample_rate_t           project_sample_rate,
    bpm_t                          current_bpm,
    const utils::Utf8String       &name,
    QObject *                      parent = nullptr)
      : FileAudioSource (
          *utils::audio::AudioBuffer::from_interleaved (arr, nframes, channels),
          bit_depth,
          project_sample_rate,
          current_bpm,
          name,
          parent)
  {
  }

  FileAudioSource (
    channels_t               channels,
    unsigned_frame_t         nframes,
    units::sample_rate_t     project_sample_rate,
    bpm_t                    current_bpm,
    const utils::Utf8String &name,
    QObject *                parent = nullptr);
 
  // ========================================================================
  // QML Interface
  // ========================================================================

  Q_SIGNAL void samplesChanged ();
 
  // ========================================================================
 
  auto        get_bit_depth () const { return bit_depth_; }
  auto        get_name () const { return name_; }
  auto        get_bpm () const { return bpm_; }
  const auto &get_samples () const { return ch_frames_; }
  auto        get_samplerate () const { return samplerate_; }
 
  void set_name (const utils::Utf8String &name) { name_ = name; }

  void expand_with_frames (const utils::audio::AudioBuffer &frames);

  void replace_frames (
    const utils::audio::AudioBuffer &src_frames,
    unsigned_frame_t                 start_frame);

  void replace_frames_from_interleaved (
    const float *    frames,
    unsigned_frame_t start_frame,
    unsigned_frame_t num_frames_per_channel,
    channels_t       channels);

  void clear_frames ()
  {
    ch_frames_.setSize (ch_frames_.getNumChannels (), 0, false, true);
    Q_EMIT samplesChanged ();
  }
 
  auto get_num_channels () const { return ch_frames_.getNumChannels (); };
  auto get_num_frames () const { return ch_frames_.getNumSamples (); };

  void init_from_file (
    const fs::path      &full_path,
    units::sample_rate_t project_sample_rate,
    std::optional<bpm_t> bpm_to_set);
 
private:
  friend void init_from (
    FileAudioSource       &obj,
    const FileAudioSource &other,
    utils::ObjectCloneType clone_type);
 
  static constexpr auto kNameKey = "name"sv;
  static constexpr auto kBpmKey = "bpm"sv;
  static constexpr auto kBitDepthKey = "bitDepth"sv;
  static constexpr auto kSamplerateKey = "samplerate"sv;
  friend void           to_json (nlohmann::json &j, const FileAudioSource &clip)
  {
    to_json (j, static_cast<const UuidIdentifiableObject &> (clip));
    j[kNameKey] = clip.name_;
    j[kBpmKey] = clip.bpm_;
    j[kBitDepthKey] = clip.bit_depth_;
    j[kSamplerateKey] = clip.samplerate_;
  }
  friend void from_json (const nlohmann::json &j, FileAudioSource &clip)
  {
    from_json (j, static_cast<UuidIdentifiableObject &> (clip));
    j.at (kNameKey).get_to (clip.name_);
    j.at (kBpmKey).get_to (clip.bpm_);
    j.at (kBitDepthKey).get_to (clip.bit_depth_);
    j.at (kSamplerateKey).get_to (clip.samplerate_);
  }
 
private:
  utils::Utf8String name_;

  utils::audio::AudioBuffer ch_frames_;

  bpm_t bpm_{};

  units::sample_rate_t samplerate_;

  utils::audio::BitDepth bit_depth_{};
};
 
// ========================================================================

class FileAudioSourceWriter : private utils::QElapsedTimeProvider
{
public:
  explicit FileAudioSourceWriter (
    const FileAudioSource &source,
    fs::path               path,
    bool                   parts);

  void write_to_file ();

  void finalize_buffered_write ();

  bool enough_time_elapsed_since_last_write () const;
 
private:
  bool parts_;
 
  const FileAudioSource                   &source_;
  std::unique_ptr<juce::AudioFormatWriter> writer_;
  fs::path                                 writer_path_;

  unsigned_frame_t frames_written_{};

  utils::MonotonicTime last_write_{};
};
 
using FileAudioSourcePtrVariant = std::variant<FileAudioSource *>;
using FileAudioSourceRegistry =
  utils::OwningObjectRegistry<FileAudioSourcePtrVariant, FileAudioSource>;
using FileAudioSourceUuidReference =
  utils::UuidReference<FileAudioSourceRegistry>;
 
} // namespace zrythm::dsp
 
DEFINE_UUID_HASH_SPECIALIZATION (zrythm::dsp::FileAudioSource::Uuid)