refactor: destination node initialization and ownership

Author: maciejmakowski2003

packages/react-native-audio-api/common/cpp/audioapi/HostObjects/BaseAudioContextHostObject.cpp

@@ -35,9 +35,8 @@ BaseAudioContextHostObject::BaseAudioContextHostObject(
     : context_(context),
       promiseVendor_(std::make_shared<PromiseVendor>(runtime, callInvoker)),
       callInvoker_(callInvoker) {
-  auto *destinationNode = context_->initialize();
   destination_ =
-      std::make_shared<AudioDestinationNodeHostObject>(destinationNode, context_->getDestination());
+      std::make_shared<AudioDestinationNodeHostObject>(context_);
 
   addGetters(
       JSI_EXPORT_PROPERTY_GETTER(BaseAudioContextHostObject, destination),

packages/react-native-audio-api/common/cpp/audioapi/HostObjects/destinations/AudioDestinationNodeHostObject.cpp

@@ -1,50 +1,24 @@
 #pragma once
 
+#include <audioapi/HostObjects/AudioNodeHostObject.h>
 #include <audioapi/core/destinations/AudioDestinationNode.h>
-#include <audioapi/core/utils/graph/HostGraph.hpp>
-#include <audioapi/jsi/JsiHostObject.h>
 #include <audioapi/types/NodeOptions.h>
 
 #include <memory>
 
 namespace audioapi {
 using namespace facebook;
 
-/// HostObject for AudiodestinationNode, which is the end point of the audio graph.
-/// It is treated differently than other AudioNodes, because it shares ownership of underlying AudioDestinationNode with BaseAudioContext.
-/// Hence all AudioNodeHostObject methods and proprties has to be implemented duplicated.
-class AudioDestinationNodeHostObject : public JsiHostObject {
+class AudioDestinationNodeHostObject : public AudioNodeHostObject {
  public:
   explicit AudioDestinationNodeHostObject(
-      utils::graph::HostGraph::Node *node,
-      std::shared_ptr<AudioDestinationNode> destination,
-      const AudioDestinationOptions &options = AudioDestinationOptions());
-
-  [[nodiscard]] utils::graph::HostGraph::Node *rawNode() const {
-    return node_;
-  }
-
-  JSI_PROPERTY_GETTER_DECL(numberOfInputs);
-  JSI_PROPERTY_GETTER_DECL(numberOfOutputs);
-  JSI_PROPERTY_GETTER_DECL(channelCount);
-  JSI_PROPERTY_GETTER_DECL(channelCountMode);
-  JSI_PROPERTY_GETTER_DECL(channelInterpretation);
-
-  JSI_HOST_FUNCTION_DECL(connect);
-  JSI_HOST_FUNCTION_DECL(disconnect);
-
- private:
-  // borrowed from BaseAudioContext's graph - non-owning
-  // no risk of dangling pointer here since destination node in TS holds ref to context =>
-  // destination HO will not outlive context HO => graph is owned by context HO
-  utils::graph::HostGraph::Node *node_; // borrowed from BaseAudioContext's graph - non-owning
-  std::shared_ptr<AudioDestinationNode> destination_;
-
-  const int numberOfInputs_;
-  const int numberOfOutputs_;
-  size_t channelCount_;
-  const ChannelCountMode channelCountMode_;
-  const ChannelInterpretation channelInterpretation_;
+      const std::shared_ptr<BaseAudioContext> &context,
+      const AudioDestinationOptions &options = AudioDestinationOptions())
+      : AudioNodeHostObject(context->getGraph(),
+                            std::make_unique<AudioDestinationNode>(context),
+                            options) {
+        context->initialize(static_cast<AudioDestinationNode*>(node_->handle->audioNode.get()));
+      }
 };
 
 } // namespace audioapi

packages/react-native-audio-api/common/cpp/audioapi/HostObjects/destinations/AudioDestinationNodeHostObject.h

@@ -22,8 +22,8 @@ AudioContext::~AudioContext() {
   }
 }
 
-utils::graph::HostGraph::Node *AudioContext::initialize() {
-  auto *destinationNode = BaseAudioContext::initialize();
+void AudioContext::initialize(const AudioDestinationNode *destination) {
+  BaseAudioContext::initialize(destination);
 #ifdef ANDROID
   audioPlayer_ = std::make_shared<AudioPlayer>(
       [this](DSPAudioBuffer *buf, int n) { processGraph(buf, n); },
@@ -35,7 +35,6 @@ utils::graph::HostGraph::Node *AudioContext::initialize() {
       getSampleRate(),
       destination_->getChannelCount());
 #endif
-  return destinationNode;
 }
 
 void AudioContext::close() {

packages/react-native-audio-api/common/cpp/audioapi/core/AudioContext.cpp

@@ -4,7 +4,6 @@
 #include <audioapi/core/utils/worklets/SafeIncludes.h>
 #include <audioapi/utils/AudioBuffer.hpp>
 
-#include <functional>
 #include <memory>
 
 namespace audioapi {
@@ -26,7 +25,11 @@ class AudioContext : public BaseAudioContext {
   bool resume();
   bool suspend();
   bool start();
-  utils::graph::HostGraph::Node *initialize() override;
+
+  /// @brief Initializes native audio player and assigns the audio destination node to the context.
+  /// @param destination The audio destination node to be associated with the context.
+  /// @note This method must be called before the audio context can be used for processing audio.
+  void initialize(const AudioDestinationNode *destination) final;
 
  private:
 #ifdef ANDROID

packages/react-native-audio-api/common/cpp/audioapi/core/AudioContext.h

@@ -1,13 +1,11 @@
 #include <audioapi/core/BaseAudioContext.h>
 #include <audioapi/core/destinations/AudioDestinationNode.h>
 #include <audioapi/core/utils/AudioDecoder.h>
-#include <audioapi/core/utils/graph/DestinationGraphObject.hpp>
 #include <audioapi/core/utils/worklets/SafeIncludes.h>
 #include <audioapi/events/AudioEventHandlerRegistry.h>
 #include <audioapi/utils/AudioArray.hpp>
 #include <audioapi/utils/CircularArray.hpp>
 #include <memory>
-#include <utility>
 #include <vector>
 
 namespace audioapi {
@@ -26,9 +24,8 @@ BaseAudioContext::BaseAudioContext(
               AUDIO_SCHEDULER_CAPACITY)),
       graph_(std::make_shared<utils::graph::Graph>(AUDIO_SCHEDULER_CAPACITY, disposer_.get())) {}
 
-utils::graph::HostGraph::Node *BaseAudioContext::initialize() {
-  destination_ = std::make_shared<AudioDestinationNode>(shared_from_this());
-  return graph_->addNode(std::make_unique<DestinationGraphObject>(destination_.get()));
+void BaseAudioContext::initialize(const AudioDestinationNode *destination) {
+  destination_ = destination;
 }
 
 ContextState BaseAudioContext::getState() {
@@ -53,10 +50,6 @@ double BaseAudioContext::getCurrentTime() const {
   return static_cast<double>(getCurrentSampleFrame()) / getSampleRate();
 }
 
-std::shared_ptr<AudioDestinationNode> BaseAudioContext::getDestination() const {
-  return destination_;
-}
-
 void BaseAudioContext::setState(audioapi::ContextState state) {
   state_.store(state, std::memory_order_release);
 }
@@ -122,7 +115,7 @@ void BaseAudioContext::processGraph(DSPAudioBuffer *buffer, int numFrames) {
     auto audioNode = node.asAudioNode();
     if (audioNode != nullptr) {
       audioNode->process(inputs, numFrames);
-      if (audioNode == destination_.get()) {
+      if (audioNode == destination_) {
         buffer->copy(*audioNode->getOutputBuffer(), 0, 0, numFrames);
       }
     }

packages/react-native-audio-api/common/cpp/audioapi/core/BaseAudioContext.cpp

@@ -36,7 +36,6 @@ class BaseAudioContext : public std::enable_shared_from_this<BaseAudioContext> {
   [[nodiscard]] float getSampleRate() const;
   [[nodiscard]] double getCurrentTime() const;
   [[nodiscard]] std::size_t getCurrentSampleFrame() const;
-  std::shared_ptr<AudioDestinationNode> getDestination() const;
 
   void setState(ContextState state);
 
@@ -51,9 +50,10 @@ class BaseAudioContext : public std::enable_shared_from_this<BaseAudioContext> {
   const RuntimeRegistry &getRuntimeRegistry() const;
   utils::DisposerImpl<utils::graph::Graph::kDisposerPayloadSize> *getDisposer() const;
 
-  /// @brief Initializes audio destination and its corresponding graph node and adds it to graph. Must be called before using the context.
-  /// @return The graph node corresponding to the audio destination.
-  virtual utils::graph::HostGraph::Node *initialize();
+  /// @brief Assigns the audio destination node to the context.
+  /// @param destination The audio destination node to be associated with the context.
+  /// @note This method must be called before the audio context can be used for processing audio.
+  virtual void initialize(const AudioDestinationNode *destination);
 
   void inline processAudioEvents() {
     audioEventScheduler_.processAllEvents(*this);
@@ -74,7 +74,7 @@ class BaseAudioContext : public std::enable_shared_from_this<BaseAudioContext> {
 
  protected:
   std::atomic<std::size_t> currentSampleFrame_{0};
-  std::shared_ptr<AudioDestinationNode> destination_;
+  const AudioDestinationNode *destination_;
 
  private:
   std::atomic<ContextState> state_;

packages/react-native-audio-api/common/cpp/audioapi/core/BaseAudioContext.h

@@ -1,4 +1,5 @@
 #include <audioapi/core/OfflineAudioContext.h>
+#include <audioapi/core/destinations/AudioDestinationNode.h>
 #include <audioapi/core/effects/DelayNode.h>
 #include <audioapi/core/utils/worklets/SafeIncludes.h>
 #include <audioapi/types/NodeOptions.h>
@@ -14,13 +15,15 @@ class DelayTest : public ::testing::Test {
  protected:
   std::shared_ptr<MockAudioEventHandlerRegistry> eventRegistry;
   std::shared_ptr<OfflineAudioContext> context;
+  std::shared_ptr<AudioDestinationNode> destination;
   static constexpr int sampleRate = 44100;
 
   void SetUp() override {
     eventRegistry = std::make_shared<MockAudioEventHandlerRegistry>();
     context = std::make_shared<OfflineAudioContext>(
         2, 5 * sampleRate, sampleRate, eventRegistry, RuntimeRegistry{});
-    context->initialize();
+    destination = std::make_shared<AudioDestinationNode>(context);
+    context->initialize(destination.get());
   }
 };
 

packages/react-native-audio-api/common/cpp/audioapi/core/utils/graph/DestinationGraphObject.hpp

@@ -1,4 +1,5 @@
 #include <audioapi/core/OfflineAudioContext.h>
+#include <audioapi/core/destinations/AudioDestinationNode.h>
 #include <audioapi/core/effects/GainNode.h>
 #include <audioapi/core/utils/worklets/SafeIncludes.h>
 #include <audioapi/types/NodeOptions.h>
@@ -14,13 +15,15 @@ class GainTest : public ::testing::Test {
  protected:
   std::shared_ptr<MockAudioEventHandlerRegistry> eventRegistry;
   std::shared_ptr<OfflineAudioContext> context;
+  std::shared_ptr<AudioDestinationNode> destination;
   static constexpr int sampleRate = 44100;
 
   void SetUp() override {
     eventRegistry = std::make_shared<MockAudioEventHandlerRegistry>();
     context = std::make_shared<OfflineAudioContext>(
         2, 5 * sampleRate, sampleRate, eventRegistry, RuntimeRegistry{});
-    context->initialize();
+    destination = std::make_shared<AudioDestinationNode>(context);
+    context->initialize(destination.get());
   }
 };