feat: added bufferId arg to enqueueBuffer and attached it to onended payload

Author: Maciej Makowski

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

@@ -64,10 +64,10 @@ class AudioBufferQueueSourceNodeHostObject
 
         auto audioBufferHostObject =
                 args[0].getObject(runtime).asHostObject<AudioBufferHostObject>(runtime);
+        int bufferId = args[1].asNumber();
+        auto isLastBuffer = args[2].asBool();
 
-        auto isLastBuffer = args[1].asBool();
-
-        audioBufferQueueSourceNode->enqueueBuffer(audioBufferHostObject->audioBuffer_, isLastBuffer);
+        audioBufferQueueSourceNode->enqueueBuffer(audioBufferHostObject->audioBuffer_, bufferId, isLastBuffer);
 
         return jsi::Value::undefined();
     }

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

@@ -81,9 +81,7 @@ class BaseAudioContext {
   std::shared_ptr<PeriodicWave> cachedSawtoothWave_ = nullptr;
   std::shared_ptr<PeriodicWave> cachedTriangleWave_ = nullptr;
 
- protected:
-    friend class AudioScheduledSourceNode;
-
+ public:
     std::shared_ptr<AudioEventHandlerRegistry> audioEventHandlerRegistry_;
 };
 

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

@@ -4,6 +4,7 @@
 #include <audioapi/core/sources/AudioBufferQueueSourceNode.h>
 #include <audioapi/core/utils/Locker.h>
 #include <audioapi/dsp/AudioUtils.h>
+#include <audioapi/events/AudioEventHandlerRegistry.h>
 #include <audioapi/utils/AudioArray.h>
 #include <audioapi/utils/AudioBus.h>
 
@@ -52,15 +53,29 @@ void AudioBufferQueueSourceNode::start(double when, double offset) {
 
 void AudioBufferQueueSourceNode::enqueueBuffer(
     const std::shared_ptr<AudioBuffer> &buffer,
+    int bufferId,
     bool isLastBuffer) {
   auto locker = Locker(getBufferLock());
-  buffers_.push(buffer);
+  buffers_.emplace(bufferId, buffer);
 
   isLastBuffer_ = isLastBuffer;
 }
 
 void AudioBufferQueueSourceNode::disable() {
-  AudioScheduledSourceNode::disable();
+  audioapi::AudioNode::disable();
+
+  std::string state = "stopped";
+
+  // if it has not been stopped, it is ended
+  if (stopTime_ < 0) {
+    state = "ended";
+  }
+
+  std::unordered_map<std::string, EventValue> body = {
+      {"value", getStopTime()}, {"state", state}, {"bufferId", bufferId_}};
+
+  context_->audioEventHandlerRegistry_->invokeHandlerWithEventBody(
+      "ended", onEndedCallbackId_, body);
   buffers_ = {};
 }
 
@@ -146,7 +161,10 @@ void AudioBufferQueueSourceNode::processWithoutInterpolation(
   auto readIndex = static_cast<size_t>(vReadIndex_);
   size_t writeIndex = startOffset;
 
-  auto buffer = buffers_.front();
+  auto queueData = buffers_.front();
+  bufferId_ = queueData.first;
+  auto buffer = queueData.second;
+
   size_t framesLeft = offsetLength;
 
   while (framesLeft > 0) {
@@ -177,7 +195,10 @@ void AudioBufferQueueSourceNode::processWithoutInterpolation(
         }
         break;
       } else {
-        buffer = buffers_.front();
+        queueData = buffers_.front();
+        bufferId_ = queueData.first;
+        buffer = queueData.second;
+
         readIndex = 0;
       }
     }

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

@@ -24,7 +24,7 @@ class AudioBufferQueueSourceNode : public AudioScheduledSourceNode {
     [[nodiscard]] std::shared_ptr<AudioParam> getPlaybackRateParam() const;
 
     void start(double when, double offset);
-    void enqueueBuffer(const std::shared_ptr<AudioBuffer> &buffer, bool isLastBuffer);
+    void enqueueBuffer(const std::shared_ptr<AudioBuffer> &buffer, int bufferId, bool isLastBuffer);
     void disable() override;
 
  protected:
@@ -47,7 +47,8 @@ class AudioBufferQueueSourceNode : public AudioScheduledSourceNode {
     double vReadIndex_;
 
     // User provided buffers
-    std::queue<std::shared_ptr<AudioBuffer>> buffers_;
+    std::queue<std::pair<int, std::shared_ptr<AudioBuffer>>> buffers_;
+    int bufferId_ = 0;
     bool isLastBuffer_ = false;
 
     void processWithPitchCorrection(const std::shared_ptr<AudioBus> &processingBus,

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

@@ -43,6 +43,9 @@ class AudioScheduledSourceNode : public AudioNode {
   void disable() override;
 
  protected:
+  double startTime_;
+  double stopTime_;
+
   PlaybackState playbackState_;
 
   void updatePlaybackInfo(
@@ -53,11 +56,7 @@ class AudioScheduledSourceNode : public AudioNode {
 
   void handleStopScheduled();
 
- private:
-  double startTime_;
-  double stopTime_;
-
-  uint64_t onEndedCallbackId_ = 0;
+    uint64_t onEndedCallbackId_ = 0;
 };
 
 } // namespace audioapi

packages/react-native-audio-api/src/core/AudioBufferQueueSourceNode.ts

@@ -18,10 +18,12 @@ export default class AudioBufferQueueSourceNode extends AudioScheduledSourceNode
 
   public enqueueBuffer(
     buffer: AudioBuffer,
+    bufferId: number = 0,
     isLastBuffer: boolean = false
   ): void {
     (this.node as IAudioBufferQueueSourceNode).enqueueBuffer(
       buffer.buffer,
+      bufferId,
       isLastBuffer
     );
   }

packages/react-native-audio-api/src/core/AudioScheduledSourceNode.ts

@@ -1,7 +1,7 @@
 import { IAudioScheduledSourceNode } from '../interfaces';
 import AudioNode from './AudioNode';
 import { InvalidStateError, RangeError } from '../errors';
-import { EventTypeWithValueAndState } from '../events/types';
+import { OnEndedEventType } from '../events/types';
 import { AudioEventEmitter } from '../events';
 
 export default class AudioScheduledSourceNode extends AudioNode {
@@ -42,7 +42,7 @@ export default class AudioScheduledSourceNode extends AudioNode {
   }
 
   // eslint-disable-next-line accessor-pairs
-  public set onended(callback: (event: EventTypeWithValueAndState) => void) {
+  public set onended(callback: (event: OnEndedEventType) => void) {
     const subscription = this.audioEventEmitter.addAudioEventListener(
       'ended',
       callback

packages/react-native-audio-api/src/events/types.ts

@@ -6,9 +6,10 @@ export interface EventTypeWithValue {
   value: number;
 }
 
-export interface EventTypeWithValueAndState {
+export interface OnEndedEventType {
   value: number;
   state: 'stopped' | 'ended';
+  bufferId: number | undefined;
 }
 
 interface OnInterruptionEventType {
@@ -45,7 +46,7 @@ export interface OnAudioReadyEventType {
 }
 
 interface AudioAPIEvents {
-  ended: EventTypeWithValueAndState;
+  ended: OnEndedEventType;
   audioReady: OnAudioReadyEventType;
   audioError: EventEmptyType; // to change
   systemStateChanged: EventEmptyType; // to change

packages/react-native-audio-api/src/interfaces.ts

@@ -114,7 +114,11 @@ export interface IAudioBufferQueueSourceNode extends IAudioScheduledSourceNode {
   detune: IAudioParam;
   playbackRate: IAudioParam;
 
-  enqueueBuffer: (audioBuffer: IAudioBuffer, isLastBuffer: boolean) => void;
+  enqueueBuffer: (
+    audioBuffer: IAudioBuffer,
+    bufferId: number,
+    isLastBuffer: boolean
+  ) => void;
   start: (when?: number, offset?: number) => void;
 }