refactor: added separate input and output buffers getters to satisfy StereoPannerNode constraints

Author: maciejmakowski2003

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

@@ -22,12 +22,6 @@ AudioNode::AudioNode(
       RENDER_QUANTUM_SIZE, channelCount_, context->getSampleRate());
 }
 
-AudioNode::~AudioNode() {
-  if (isInitialized_.load(std::memory_order_acquire)) {
-    cleanup();
-  }
-}
-
 bool AudioNode::canBeDestructed() const {
   return true;
 }

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

@@ -11,9 +11,7 @@
 #include <cassert>
 #include <cstddef>
 #include <memory>
-#include <unordered_set>
 #include <utility>
-#include <vector>
 
 namespace audioapi {
 
@@ -24,18 +22,17 @@ class AudioNode : public utils::graph::GraphObject, public std::enable_shared_fr
   explicit AudioNode(
       const std::shared_ptr<BaseAudioContext> &context,
       const AudioNodeOptions &options = AudioNodeOptions());
-  virtual ~AudioNode();
 
   size_t getChannelCount() const;
 
   template <std::ranges::input_range R>
     requires std::same_as<std::ranges::range_reference_t<R>, const GraphObject &>
   void process(R &&inputs, int numFrames) {
-    audioBuffer_->zero();
+    getInputBuffer()->zero();
 
     for (const auto &input : inputs) {
       if (const AudioNode *audioNode = input.asAudioNode()) {
-        audioBuffer_->sum(*audioNode->audioBuffer_, channelInterpretation_);
+        getInputBuffer()->sum(*audioNode->getOutputBuffer(), channelInterpretation_);
       }
     }
 
@@ -54,7 +51,21 @@ class AudioNode : public utils::graph::GraphObject, public std::enable_shared_fr
     return getContextSampleRate() / 2.0f;
   }
 
-  std::shared_ptr<DSPAudioBuffer> getAudioBuffer() const {
+  /// @brief Returns the input buffer for this node. By default, this is the same as the output buffer.
+  /// @note Audio Thread only.
+  /// @note For StereoPannerNode and PannerNode due to channel limitations -
+  /// https://webaudio.github.io/web-audio-api/#StereoPanner-channel-limitations
+  /// the input buffer is negotiate with inputs, but output buffer is always stereo.
+  std::shared_ptr<DSPAudioBuffer> getInputBuffer() const {
+    return audioBuffer_;
+  }
+
+  /// @brief Returns the output buffer for this node. By default, this is the same as the input buffer.
+  /// @note Audio Thread only.
+  /// @note For StereoPannerNode and PannerNode due to channel limitations -
+  /// https://webaudio.github.io/web-audio-api/#StereoPanner-channel-limitations
+  /// the input buffer is negotiate with inputs, but output buffer is always stereo.
+  virtual std::shared_ptr<DSPAudioBuffer> getOutputBuffer() const {
     return audioBuffer_;
   }
 
@@ -81,8 +92,7 @@ class AudioNode : public utils::graph::GraphObject, public std::enable_shared_fr
   }
 
  protected:
-  friend class AudioDestinationNode;
-  friend class ConvolverNode;
+  //  friend class ConvolverNode;
   friend class DelayNodeHostObject;
 
   std::weak_ptr<BaseAudioContext> context_;
@@ -97,14 +107,11 @@ class AudioNode : public utils::graph::GraphObject, public std::enable_shared_fr
 
   std::atomic<bool> isInitialized_ = false;
 
-  std::size_t lastRenderedFrame_{SIZE_MAX};
-
   virtual void disable() {
     cleanup();
   };
 
   virtual void processNode(int) = 0;
-
   void cleanup();
 };
 

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

@@ -123,7 +123,7 @@ void BaseAudioContext::processGraph(DSPAudioBuffer *buffer, int numFrames) {
     if (audioNode != nullptr) {
       audioNode->process(inputs, numFrames);
       if (audioNode == destination_.get()) {
-        buffer->copy(*audioNode->getAudioBuffer(), 0, 0, numFrames);
+        buffer->copy(*audioNode->getOutputBuffer(), 0, 0, numFrames);
       }
     }
   }

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

@@ -105,6 +105,7 @@ void ConvolverNode::processNode(int framesToProcess) {
       return;
     }
   }
+
   if (internalBufferIndex_ < framesToProcess) {
     performConvolution(audioBuffer_); // reads from audioBuffer_, result goes to intermediateBuffer_
     audioBuffer_->zero();
@@ -113,6 +114,7 @@ void ConvolverNode::processNode(int framesToProcess) {
     internalBuffer_->copy(*audioBuffer_, 0, internalBufferIndex_, RENDER_QUANTUM_SIZE);
     internalBufferIndex_ += RENDER_QUANTUM_SIZE;
   }
+
   audioBuffer_->zero();
   audioBuffer_->copy(*internalBuffer_, 0, 0, framesToProcess);
   int remainingFrames = internalBufferIndex_ - framesToProcess;

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

@@ -14,14 +14,23 @@ StereoPannerNode::StereoPannerNode(
     const std::shared_ptr<BaseAudioContext> &context,
     const StereoPannerOptions &options)
     : AudioNode(context, options),
-      panParam_(std::make_shared<AudioParam>(options.pan, -1.0f, 1.0f, context)) {
+      panParam_(std::make_shared<AudioParam>(options.pan, -1.0f, 1.0f, context)),
+      outputBuffer_(
+          std::make_shared<DSPAudioBuffer>(
+              RENDER_QUANTUM_SIZE,
+              channelCount_,
+              context->getSampleRate())) {
   isInitialized_.store(true, std::memory_order_release);
 }
 
 std::shared_ptr<AudioParam> StereoPannerNode::getPanParam() const {
   return panParam_;
 }
 
+std::shared_ptr<DSPAudioBuffer> StereoPannerNode::getOutputBuffer() const {
+  return outputBuffer_;
+}
+
 void StereoPannerNode::processNode(int framesToProcess) {
   std::shared_ptr<BaseAudioContext> context = context_.lock();
   if (context == nullptr)
@@ -31,8 +40,8 @@ void StereoPannerNode::processNode(int framesToProcess) {
 
   auto panParamValues = panParam_->processARateParam(framesToProcess, time)->getChannel(0)->span();
 
-  auto outputLeft = audioBuffer_->getChannelByType(AudioBuffer::ChannelLeft)->span();
-  auto outputRight = audioBuffer_->getChannelByType(AudioBuffer::ChannelRight)->span();
+  auto outputLeft = outputBuffer_->getChannelByType(AudioBuffer::ChannelLeft)->span();
+  auto outputRight = outputBuffer_->getChannelByType(AudioBuffer::ChannelRight)->span();
 
   // Input is mono
   if (audioBuffer_->getNumberOfChannels() == 1) {

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

@@ -19,11 +19,14 @@ class StereoPannerNode : public AudioNode {
 
   [[nodiscard]] std::shared_ptr<AudioParam> getPanParam() const;
 
+  std::shared_ptr<DSPAudioBuffer> getOutputBuffer() const override;
+
  protected:
   void processNode(int framesToProcess) override;
 
  private:
   const std::shared_ptr<AudioParam> panParam_;
+  const std::shared_ptr<DSPAudioBuffer> outputBuffer_;
 };
 
 } // namespace audioapi

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

@@ -95,10 +95,6 @@ void AudioBufferSourceNode::start(double when, double offset, double duration) {
   vReadIndex_ = static_cast<double>(buffer_->getSampleRate() * offset);
 }
 
-void AudioBufferSourceNode::disable() {
-  AudioScheduledSourceNode::disable();
-}
-
 void AudioBufferSourceNode::setOnLoopEndedCallbackId(uint64_t callbackId) {
   onLoopEndedCallbackId_ = callbackId;
 }

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

@@ -39,9 +39,6 @@ class AudioBufferSourceNode : public AudioBufferBaseSourceNode {
   /// @note Audio Thread only
   void start(double when, double offset, double duration = -1);
 
-  /// @note Audio Thread only
-  void disable() override;
-
   /// @note Audio Thread only
   void setOnLoopEndedCallbackId(uint64_t callbackId);
 

packages/react-native-audio-api/common/cpp/test/src/core/effects/DelayTest.cpp

@@ -33,13 +33,8 @@ class TestableDelayNode : public DelayNode {
     getDelayTimeParam()->setValue(value);
   }
 
-  void setInput(const std::shared_ptr<DSPAudioBuffer> &input) {
-    size_t copyChannels = std::min(
-        static_cast<size_t>(input->getNumberOfChannels()),
-        static_cast<size_t>(audioBuffer_->getNumberOfChannels()));
-    for (size_t ch = 0; ch < copyChannels; ch++) {
-      audioBuffer_->getChannel(ch)->copy(*input->getChannel(ch), 0, 0, input->getSize());
-    }
+  void setInputBuffer(const std::shared_ptr<DSPAudioBuffer> &input) {
+    audioBuffer_ = input;
   }
 
   void processNode(int framesToProcess) override {
@@ -65,9 +60,9 @@ TEST_F(DelayTest, DelayWithZeroDelayOutputsInputSignal) {
     (*buffer->getChannel(0))[i] = i + 1;
   }
 
-  delayNode.setInput(buffer);
+  delayNode.setInputBuffer(buffer);
   delayNode.processNode(FRAMES_TO_PROCESS);
-  auto resultBuffer = delayNode.getAudioBuffer();
+  auto resultBuffer = delayNode.getOutputBuffer();
   for (size_t i = 0; i < FRAMES_TO_PROCESS; ++i) {
     EXPECT_FLOAT_EQ((*resultBuffer->getChannel(0))[i], static_cast<float>(i + 1));
   }
@@ -86,9 +81,9 @@ TEST_F(DelayTest, DelayAppliesTimeShiftCorrectly) {
     (*buffer->getChannel(0))[i] = i + 1;
   }
 
-  delayNode.setInput(buffer);
+  delayNode.setInputBuffer(buffer);
   delayNode.processNode(FRAMES_TO_PROCESS);
-  auto resultBuffer = delayNode.getAudioBuffer();
+  auto resultBuffer = delayNode.getOutputBuffer();
   for (size_t i = 0; i < FRAMES_TO_PROCESS; ++i) {
     if (i < FRAMES_TO_PROCESS / 2) { // First 64 samples should be zero due to delay
       EXPECT_FLOAT_EQ((*resultBuffer->getChannel(0))[i], 0.0f);
@@ -114,12 +109,12 @@ TEST_F(DelayTest, DelayHandlesTailCorrectly) {
     (*buffer->getChannel(0))[i] = i + 1;
   }
 
-  delayNode.setInput(buffer);
+  delayNode.setInputBuffer(buffer);
   delayNode.processNode(FRAMES_TO_PROCESS);
   // Second call uses the result of the first call as input (same as old behavior
   // where the same buffer object was passed to both calls)
   delayNode.processNode(FRAMES_TO_PROCESS);
-  auto resultBuffer = delayNode.getAudioBuffer();
+  auto resultBuffer = delayNode.getOutputBuffer();
   for (size_t i = 0; i < FRAMES_TO_PROCESS; ++i) {
     if (i < FRAMES_TO_PROCESS / 2) { // First 64 samples should be 2nd part of buffer
       EXPECT_FLOAT_EQ(

packages/react-native-audio-api/common/cpp/test/src/core/effects/GainTest.cpp

@@ -33,13 +33,8 @@ class TestableGainNode : public GainNode {
     getGainParam()->setValue(value);
   }
 
-  void setInput(const std::shared_ptr<DSPAudioBuffer> &input) {
-    size_t copyChannels = std::min(
-        static_cast<size_t>(input->getNumberOfChannels()),
-        static_cast<size_t>(audioBuffer_->getNumberOfChannels()));
-    for (size_t ch = 0; ch < copyChannels; ch++) {
-      audioBuffer_->getChannel(ch)->copy(*input->getChannel(ch), 0, 0, input->getSize());
-    }
+  void setInputBuffer(const std::shared_ptr<DSPAudioBuffer> &input) {
+    audioBuffer_ = input;
   }
 
   void processNode(int framesToProcess) override {
@@ -63,9 +58,9 @@ TEST_F(GainTest, GainModulatesVolumeCorrectly) {
     (*buffer->getChannel(0))[i] = i + 1;
   }
 
-  gainNode.setInput(buffer);
+  gainNode.setInputBuffer(buffer);
   gainNode.processNode(FRAMES_TO_PROCESS);
-  auto resultBuffer = gainNode.getAudioBuffer();
+  auto resultBuffer = gainNode.getOutputBuffer();
   for (size_t i = 0; i < FRAMES_TO_PROCESS; ++i) {
     EXPECT_FLOAT_EQ((*resultBuffer->getChannel(0))[i], (i + 1) * GAIN_VALUE);
   }
@@ -83,9 +78,9 @@ TEST_F(GainTest, GainModulatesVolumeCorrectlyMultiChannel) {
     (*buffer->getChannel(1))[i] = -i - 1;
   }
 
-  gainNode.setInput(buffer);
+  gainNode.setInputBuffer(buffer);
   gainNode.processNode(FRAMES_TO_PROCESS);
-  auto resultBuffer = gainNode.getAudioBuffer();
+  auto resultBuffer = gainNode.getOutputBuffer();
   for (size_t i = 0; i < FRAMES_TO_PROCESS; ++i) {
     EXPECT_FLOAT_EQ((*resultBuffer->getChannel(0))[i], (i + 1) * GAIN_VALUE);
     EXPECT_FLOAT_EQ((*resultBuffer->getChannel(1))[i], (-i - 1) * GAIN_VALUE);