Refactor/onEnded (#583)

* refactor: refactored onEnded

* ci: yarn format

* fix: override onEnded in ABSN

* docs: added overridden `onEnded` callback to AudioBufferQueueSourceNode docs

---------

Co-authored-by: Maciej Makowski <[email protected]>

Author: maciejmakowski2003

packages/audiodocs/docs/sources/audio-buffer-queue-source-node.mdx

@@ -2,7 +2,7 @@
 sidebar_position: 5
 ---
 
-import { Optional, Experimental } from '@site/src/components/Badges';
+import { Optional, Experimental, Overridden } from '@site/src/components/Badges';
 
 # AudioBufferQueueSourceNode
 
@@ -44,12 +44,29 @@ function App() {
 
 ### `enqueueBuffer`
 
-The above method lets you add another buffer to queue.
+The above method lets you add another buffer to queue. Returns `bufferId` that can be used to identify the buffer in `onEnded` event.
 
 | Parameters | Type | Description |
 | :---: | :---: | :---- |
-| `buffer` | [`AudioBuffer`](/docs/sources/audio-buffer) | Buffer with next data. |
-| `isLastBuffer` | `boolean` | Boolean indicating if it is a last buffer. Default value is `false`. Queue will stop after buffer marked as `last` will end. |
+| `buffer` | [`AudioBuffer`](/sources/audio-buffer) | Buffer with next data. |
 
-#### Returns `undefined`.
+#### Returns `string`.
 
+## Events
+
+### `onEnded` <Overridden />
+
+Allows to set (or remove) callback that will be fired when queue source node has stopped playing with payload `event.bufferId = undefined`
+or when a specific buffer has ended with payload `event.bufferId = <bufferId>`.
+
+You can remove callback by passing `null`.
+
+```ts
+audioBufferSourceNode.onEnded = (event) => { //setting callback
+  if (event.bufferId === undefined) {
+    console.log('queue source node has been stopped');
+  } else {
+    console.log(`buffer with id {event.bufferId} ended`);
+  }
+};
+```

packages/audiodocs/docs/sources/audio-scheduled-source-node.mdx

@@ -53,6 +53,8 @@ If you invoke this method multiple times on the same node before the designated
 
 ## Events
 
+### `onEnded`
+
 Allows to set (or remove) callback that will be fired when source node has stopped playing,
 either because it's reached a predetermined stop time, the full duration of the audio has been performed, or because the entire buffer has been played.
 You can remove callback by passing `null`.

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

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

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

@@ -18,10 +18,11 @@ AudioParam::AudioParam(
       minValue_(minValue),
       maxValue_(maxValue),
       context_(context),
-      audioBus_(std::make_shared<AudioBus>(
-          RENDER_QUANTUM_SIZE,
-          1,
-          context->getSampleRate())) {
+      audioBus_(
+          std::make_shared<AudioBus>(
+              RENDER_QUANTUM_SIZE,
+              1,
+              context->getSampleRate())) {
   startTime_ = 0;
   endTime_ = 0;
   startValue_ = value_;

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

@@ -35,13 +35,12 @@ void AudioBufferQueueSourceNode::pause() {
   isPaused_ = true;
 }
 
-void AudioBufferQueueSourceNode::enqueueBuffer(
-    const std::shared_ptr<AudioBuffer> &buffer,
-    bool isLastBuffer) {
+std::string AudioBufferQueueSourceNode::enqueueBuffer(
+    const std::shared_ptr<AudioBuffer> &buffer) {
   auto locker = Locker(getBufferLock());
-  buffers_.emplace(buffer);
+  buffers_.emplace(bufferId_, buffer);
 
-  isLastBuffer_ = isLastBuffer;
+  return std::to_string(bufferId_++);
 }
 
 void AudioBufferQueueSourceNode::disable() {
@@ -93,7 +92,9 @@ void AudioBufferQueueSourceNode::processWithoutInterpolation(
   auto readIndex = static_cast<size_t>(vReadIndex_);
   size_t writeIndex = startOffset;
 
-  auto buffer = buffers_.front();
+  auto data = buffers_.front();
+  auto bufferId = data.first;
+  auto buffer = data.second;
 
   size_t framesLeft = offsetLength;
 
@@ -117,16 +118,20 @@ void AudioBufferQueueSourceNode::processWithoutInterpolation(
       playedBuffersDuration_ += buffer->getDuration();
       buffers_.pop();
 
+      std::unordered_map<std::string, EventValue> body = {
+          {"bufferId", std::to_string(bufferId)}};
+      context_->audioEventHandlerRegistry_->invokeHandlerWithEventBody(
+          "ended", onEndedCallbackId_, body);
+
       if (buffers_.empty()) {
         processingBus->zero(writeIndex, framesLeft);
         readIndex = 0;
 
-        if (isLastBuffer_) {
-          playbackState_ = PlaybackState::STOP_SCHEDULED;
-        }
         break;
       } else {
-        buffer = buffers_.front();
+        data = buffers_.front();
+        bufferId = data.first;
+        buffer = data.second;
 
         readIndex = 0;
       }

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

@@ -23,7 +23,7 @@ class AudioBufferQueueSourceNode : public AudioBufferBaseSourceNode {
     void stop(double when) override;
     void pause();
 
-    void enqueueBuffer(const std::shared_ptr<AudioBuffer> &buffer, bool isLastBuffer);
+    std::string enqueueBuffer(const std::shared_ptr<AudioBuffer> &buffer);
     void disable() override;
 
  protected:
@@ -32,8 +32,9 @@ class AudioBufferQueueSourceNode : public AudioBufferBaseSourceNode {
 
  private:
     // User provided buffers
-    std::queue<std::shared_ptr<AudioBuffer>> buffers_;
-    bool isLastBuffer_ = false;
+    std::queue<std::pair<size_t, std::shared_ptr<AudioBuffer>>> buffers_;
+    size_t bufferId_ = 0;
+
     bool isPaused_ = false;
 
     double playedBuffersDuration_ = 0;

packages/react-native-audio-api/ios/audioapi/ios/AudioAPIModule.mm

@@ -85,8 +85,9 @@ - (void)invalidate
   return [self.audioSessionManager getDevicePreferredSampleRate];
 }
 
-RCT_EXPORT_METHOD(setAudioSessionActivity : (BOOL)enabled resolve : (RCTPromiseResolveBlock)
-                      resolve reject : (RCTPromiseRejectBlock)reject)
+RCT_EXPORT_METHOD(
+    setAudioSessionActivity : (BOOL)enabled resolve : (RCTPromiseResolveBlock)resolve reject : (RCTPromiseRejectBlock)
+        reject)
 {
   if ([self.audioSessionManager setActive:enabled]) {
     resolve(@"true");
@@ -96,8 +97,9 @@ - (void)invalidate
   resolve(@"false");
 }
 
-RCT_EXPORT_METHOD(setAudioSessionOptions : (NSString *)category mode : (NSString *)mode options : (NSArray *)
-                      options allowHaptics : (BOOL)allowHaptics)
+RCT_EXPORT_METHOD(
+    setAudioSessionOptions : (NSString *)category mode : (NSString *)mode options : (NSArray *)
+        options allowHaptics : (BOOL)allowHaptics)
 {
   [self.audioSessionManager setAudioSessionOptions:category mode:mode options:options allowHaptics:allowHaptics];
 }
@@ -132,20 +134,21 @@ - (void)invalidate
   [self.notificationManager observeVolumeChanges:(BOOL)enabled];
 }
 
-RCT_EXPORT_METHOD(requestRecordingPermissions : (nonnull RCTPromiseResolveBlock)
-                      resolve reject : (nonnull RCTPromiseRejectBlock)reject)
+RCT_EXPORT_METHOD(
+    requestRecordingPermissions : (nonnull RCTPromiseResolveBlock)resolve reject : (nonnull RCTPromiseRejectBlock)
+        reject)
 {
   [self.audioSessionManager requestRecordingPermissions:resolve reject:reject];
 }
 
-RCT_EXPORT_METHOD(checkRecordingPermissions : (nonnull RCTPromiseResolveBlock)
-                      resolve reject : (nonnull RCTPromiseRejectBlock)reject)
+RCT_EXPORT_METHOD(
+    checkRecordingPermissions : (nonnull RCTPromiseResolveBlock)resolve reject : (nonnull RCTPromiseRejectBlock)reject)
 {
   [self.audioSessionManager checkRecordingPermissions:resolve reject:reject];
 }
 
-RCT_EXPORT_METHOD(getDevicesInfo : (nonnull RCTPromiseResolveBlock)resolve reject : (nonnull RCTPromiseRejectBlock)
-                      reject)
+RCT_EXPORT_METHOD(
+    getDevicesInfo : (nonnull RCTPromiseResolveBlock)resolve reject : (nonnull RCTPromiseRejectBlock)reject)
 {
   [self.audioSessionManager getDevicesInfo:resolve reject:reject];
 }

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

@@ -4,13 +4,9 @@ import AudioBuffer from './AudioBuffer';
 import { RangeError } from '../errors';
 
 export default class AudioBufferQueueSourceNode extends AudioBufferBaseSourceNode {
-  public enqueueBuffer(
-    buffer: AudioBuffer,
-    isLastBuffer: boolean = false
-  ): void {
-    (this.node as IAudioBufferQueueSourceNode).enqueueBuffer(
-      buffer.buffer,
-      isLastBuffer
+  public enqueueBuffer(buffer: AudioBuffer): string {
+    return (this.node as IAudioBufferQueueSourceNode).enqueueBuffer(
+      buffer.buffer
     );
   }
 

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

@@ -2,6 +2,7 @@ import { IAudioBufferSourceNode } from '../interfaces';
 import AudioBufferBaseSourceNode from './AudioBufferBaseSourceNode';
 import AudioBuffer from './AudioBuffer';
 import { InvalidStateError, RangeError } from '../errors';
+import { EventEmptyType } from '../events/types';
 
 export default class AudioBufferSourceNode extends AudioBufferBaseSourceNode {
   public get buffer(): AudioBuffer | null {
@@ -79,4 +80,14 @@ export default class AudioBufferSourceNode extends AudioBufferBaseSourceNode {
     this.hasBeenStarted = true;
     (this.node as IAudioBufferSourceNode).start(when, offset, duration);
   }
+
+  public override get onEnded(): ((event: EventEmptyType) => void) | undefined {
+    return super.onEnded as ((event: EventEmptyType) => void) | undefined;
+  }
+
+  public override set onEnded(
+    callback: ((event: EventEmptyType) => void) | null
+  ) {
+    super.onEnded = callback;
+  }
 }

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 { EventEmptyType } from '../events/types';
+import { OnEndedEventType } from '../events/types';
 import { AudioEventEmitter, AudioEventSubscription } from '../events';
 
 export default class AudioScheduledSourceNode extends AudioNode {
@@ -11,7 +11,7 @@ export default class AudioScheduledSourceNode extends AudioNode {
   );
 
   private onendedSubscription?: AudioEventSubscription;
-  private onEndedCallback?: (event: EventEmptyType) => void;
+  private onEndedCallback?: (event: OnEndedEventType) => void;
 
   public start(when: number = 0): void {
     if (when < 0) {
@@ -44,11 +44,11 @@ export default class AudioScheduledSourceNode extends AudioNode {
     (this.node as IAudioScheduledSourceNode).stop(when);
   }
 
-  public get onEnded(): ((event: EventEmptyType) => void) | undefined {
+  public get onEnded(): ((event: OnEndedEventType) => void) | undefined {
     return this.onEndedCallback;
   }
 
-  public set onEnded(callback: ((event: EventEmptyType) => void) | null) {
+  public set onEnded(callback: ((event: OnEndedEventType) => void) | null) {
     if (!callback) {
       (this.node as IAudioScheduledSourceNode).onEnded = '0';
       this.onendedSubscription?.remove();