feat/fix: possibility of onended and positionChange events removal (#519)

* feat: possibility of onended and positionChange events removal

* fix: misplacement of sending events

Author: mdydek

apps/common-app/src/examples/AudioFile/AudioPlayer.ts

@@ -51,6 +51,10 @@ class AudioPlayer {
       this.offset = event.value;
     };
 
+    this.sourceNode.onended = (event) => {
+      console.log("ended");
+    }
+
     this.sourceNode.start(this.audioContext.currentTime, this.offset);
 
     AudioManager.setLockScreenInfo({
@@ -103,8 +107,12 @@ class AudioPlayer {
   };
 
   reset = () => {
+    if (this.sourceNode) {
+      this.sourceNode.onended = null;
+      this.sourceNode.onPositionChanged = null;
+      this.sourceNode.stop(this.audioContext.currentTime);
+    }
     this.audioBuffer = null;
-    this.sourceNode?.stop(this.audioContext.currentTime);
     this.sourceNode = null;
     this.offset = 0;
     this.seekOffset = 0;

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

@@ -47,7 +47,8 @@ std::mutex &AudioBufferBaseSourceNode::getBufferLock() {
 }
 
 void AudioBufferBaseSourceNode::sendOnPositionChangedEvent() {
-  if (onPositionChangedTime_ > onPositionChangedInterval_) {
+  if (onPositionChangedCallbackId_ != 0 &&
+      onPositionChangedTime_ > onPositionChangedInterval_) {
     std::unordered_map<std::string, EventValue> body = {
         {"value", getCurrentPosition()}};
 
@@ -99,6 +100,7 @@ void AudioBufferBaseSourceNode::processWithPitchCorrection(
   if (detune != 0.0f) {
     stretch_->setTransposeSemitones(detune);
   }
+  sendOnPositionChangedEvent();
 }
 
 } // namespace audioapi

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

@@ -34,7 +34,7 @@ class AudioBufferBaseSourceNode : public AudioScheduledSourceNode {
     // internal helper
     double vReadIndex_;
 
-    uint64_t onPositionChangedCallbackId_ = 0;
+    uint64_t onPositionChangedCallbackId_ = 0; // 0 means no callback
     int onPositionChangedInterval_;
     int onPositionChangedTime_ = 0;
 

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

@@ -70,7 +70,6 @@ void AudioBufferQueueSourceNode::processNode(
     processWithPitchCorrection(processingBus, framesToProcess);
 
     handleStopScheduled();
-    sendOnPositionChangedEvent();
   } else {
     processingBus->zero();
   }

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

@@ -141,7 +141,6 @@ void AudioBufferSourceNode::processNode(
     }
 
     handleStopScheduled();
-    sendOnPositionChangedEvent();
   } else {
     processingBus->zero();
   }
@@ -177,6 +176,8 @@ void AudioBufferSourceNode::processWithoutPitchCorrection(
     processWithInterpolation(
         processingBus, startOffset, offsetLength, computedPlaybackRate);
   }
+
+  sendOnPositionChangedEvent();
 }
 
 void AudioBufferSourceNode::processWithoutInterpolation(

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

@@ -73,7 +73,7 @@ void AudioScheduledSourceNode::updatePlaybackInfo(
       ? std::numeric_limits<size_t>::max()
       : dsp::timeToSampleFrame(stopTime_, sampleRate);
 
-  if (isUnscheduled() || isFinished()) {
+  if (isFinished()) {
     startOffset = 0;
     nonSilentFramesToProcess = 0;
     return;
@@ -135,6 +135,12 @@ void AudioScheduledSourceNode::updatePlaybackInfo(
     return;
   }
 
+  if (isUnscheduled()) {
+    startOffset = 0;
+    nonSilentFramesToProcess = 0;
+    return;
+  }
+
   // normal "mid-buffer" playback
   startOffset = 0;
   nonSilentFramesToProcess = framesToProcess;

packages/react-native-audio-api/common/cpp/audioapi/events/AudioEventHandlerRegistry.cpp

@@ -24,7 +24,7 @@ AudioEventHandlerRegistry::~AudioEventHandlerRegistry() {
 uint64_t AudioEventHandlerRegistry::registerHandler(
     const std::string &eventName,
     const std::shared_ptr<jsi::Function> &handler) {
-  static uint64_t LISTENER_ID = 0;
+  static uint64_t LISTENER_ID = 1;
 
   eventHandlers_[eventName][LISTENER_ID] = handler;
 

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

@@ -3,10 +3,12 @@ import AudioScheduledSourceNode from './AudioScheduledSourceNode';
 import BaseAudioContext from './BaseAudioContext';
 import AudioParam from './AudioParam';
 import { EventTypeWithValue } from '../events/types';
+import { AudioEventSubscription } from '../events';
 
 export default class AudioBufferBaseSourceNode extends AudioScheduledSourceNode {
   readonly playbackRate: AudioParam;
   readonly detune: AudioParam;
+  private positionChangedSubscription?: AudioEventSubscription;
 
   constructor(context: BaseAudioContext, node: IAudioBufferBaseSourceNode) {
     super(context, node);
@@ -16,14 +18,20 @@ export default class AudioBufferBaseSourceNode extends AudioScheduledSourceNode
   }
 
   // eslint-disable-next-line accessor-pairs
-  public set onPositionChanged(callback: (event: EventTypeWithValue) => void) {
-    const subscription = this.audioEventEmitter.addAudioEventListener(
-      'positionChanged',
-      callback
-    );
+  public set onPositionChanged(
+    callback: ((event: EventTypeWithValue) => void) | null
+  ) {
+    if (!callback) {
+      this.positionChangedSubscription?.remove();
+      this.positionChangedSubscription = undefined;
+      (this.node as IAudioBufferBaseSourceNode).onPositionChanged = '0';
+      return;
+    }
+    this.positionChangedSubscription =
+      this.audioEventEmitter.addAudioEventListener('positionChanged', callback);
 
     (this.node as IAudioBufferBaseSourceNode).onPositionChanged =
-      subscription.subscriptionId;
+      this.positionChangedSubscription.subscriptionId;
   }
 
   // eslint-disable-next-line accessor-pairs

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

@@ -2,14 +2,16 @@ import { IAudioScheduledSourceNode } from '../interfaces';
 import AudioNode from './AudioNode';
 import { InvalidStateError, RangeError } from '../errors';
 import { EventEmptyType } from '../events/types';
-import { AudioEventEmitter } from '../events';
+import { AudioEventEmitter, AudioEventSubscription } from '../events';
 
 export default class AudioScheduledSourceNode extends AudioNode {
   protected hasBeenStarted: boolean = false;
   protected readonly audioEventEmitter = new AudioEventEmitter(
     global.AudioEventEmitter
   );
 
+  private onendedSubscription?: AudioEventSubscription;
+
   public start(when: number = 0): void {
     if (when < 0) {
       throw new RangeError(
@@ -42,13 +44,18 @@ export default class AudioScheduledSourceNode extends AudioNode {
   }
 
   // eslint-disable-next-line accessor-pairs
-  public set onended(callback: (event: EventEmptyType) => void) {
-    const subscription = this.audioEventEmitter.addAudioEventListener(
+  public set onended(callback: ((event: EventEmptyType) => void) | null) {
+    if (!callback) {
+      this.onendedSubscription?.remove();
+      this.onendedSubscription = undefined;
+      return;
+    }
+    this.onendedSubscription = this.audioEventEmitter.addAudioEventListener(
       'ended',
       callback
     );
 
     (this.node as IAudioScheduledSourceNode).onended =
-      subscription.subscriptionId;
+      this.onendedSubscription.subscriptionId;
   }
 }