setOnEOFCallback

Author: pschatzmann

src/AudioTools/CoreAudio/AudioPlayer.h

@@ -62,7 +62,7 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
    * @param output
    * @param decoder
    */
-  AudioPlayer(AudioSource &source, AudioOutput &output, AudioDecoder &decoder) {
+  AudioPlayer(AudioSource& source, AudioOutput& output, AudioDecoder& decoder) {
     TRACED();
     this->p_source = &source;
     this->p_decoder = &decoder;
@@ -81,8 +81,8 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
    * @param decoder
    * @param notify
    */
-  AudioPlayer(AudioSource &source, Print &output, AudioDecoder &decoder,
-              AudioInfoSupport *notify = nullptr) {
+  AudioPlayer(AudioSource& source, Print& output, AudioDecoder& decoder,
+              AudioInfoSupport* notify = nullptr) {
     TRACED();
     this->p_source = &source;
     this->p_decoder = &decoder;
@@ -99,7 +99,7 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
    * @param output
    * @param decoder
    */
-  AudioPlayer(AudioSource &source, AudioStream &output, AudioDecoder &decoder) {
+  AudioPlayer(AudioSource& source, AudioStream& output, AudioDecoder& decoder) {
     TRACED();
     this->p_source = &source;
     this->p_decoder = &decoder;
@@ -109,13 +109,13 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   }
 
   /// Non-copyable: copy constructor is deleted
-  AudioPlayer(AudioPlayer const &) = delete;
+  AudioPlayer(AudioPlayer const&) = delete;
 
   /// Non-assignable: assignment operator is deleted
-  AudioPlayer &operator=(AudioPlayer const &) = delete;
+  AudioPlayer& operator=(AudioPlayer const&) = delete;
 
   /// Sets the final output to an AudioOutput (adds Volume/Fade for PCM)
-  void setOutput(AudioOutput &output) {
+  void setOutput(AudioOutput& output) {
     if (p_decoder->isResultPCM()) {
       this->fade.setOutput(output);
       this->volume_out.setOutput(fade);
@@ -130,7 +130,7 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   }
 
   /// Sets the final output to a Print (adds Volume/Fade for PCM)
-  void setOutput(Print &output) {
+  void setOutput(Print& output) {
     if (p_decoder->isResultPCM()) {
       this->fade.setOutput(output);
       this->volume_out.setOutput(fade);
@@ -145,7 +145,7 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   }
 
   /// Sets the final output to an AudioStream (adds Volume/Fade for PCM)
-  void setOutput(AudioStream &output) {
+  void setOutput(AudioStream& output) {
     if (p_decoder->isResultPCM()) {
       this->fade.setOutput(output);
       this->volume_out.setOutput(fade);
@@ -182,15 +182,15 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
     // start dependent objects
     out_decoding.begin();
 
-    if (!p_source->begin()){
+    if (!p_source->begin()) {
       LOGE("Could not start audio source");
       return false;
     }
-    if (!meta_out.begin()){
+    if (!meta_out.begin()) {
       LOGE("Could not start metadata output");
       return false;
     }
-    if (!volume_out.begin()){
+    if (!volume_out.begin()) {
       LOGE("Could not start volume control");
       return false;
     }
@@ -222,6 +222,7 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   void end() {
     TRACED();
     active = false;
+    eof_called = false;
     out_decoding.end();
     meta_out.end();
     // remove any data in the decoder
@@ -233,19 +234,19 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   }
 
   /// Returns the active AudioSource
-  AudioSource &audioSource() { return *p_source; }
+  AudioSource& audioSource() { return *p_source; }
 
   /// Sets or replaces the AudioSource
-  void setAudioSource(AudioSource &source) { this->p_source = &source; }
+  void setAudioSource(AudioSource& source) { this->p_source = &source; }
 
   /// Sets or replaces the AudioDecoder
-  void setDecoder(AudioDecoder &decoder) {
+  void setDecoder(AudioDecoder& decoder) {
     this->p_decoder = &decoder;
     out_decoding.setDecoder(p_decoder);
   }
 
   /// Adds/updates a listener notified on audio info changes
-  void addNotifyAudioChange(AudioInfoSupport *notify) {
+  void addNotifyAudioChange(AudioInfoSupport* notify) {
     this->p_final_notify = notify;
     // notification for audio configuration
     if (p_decoder != nullptr) {
@@ -282,7 +283,7 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   /// plays a complete audio file or url from start to finish (blocking call)
   /// @param path path to the audio file or url to play (depending on source)
   /// @return true if file was found and played successfully, false otherwise
-  bool playPath(const char *path) {
+  bool playPath(const char* path) {
     TRACED();
     if (!setPath(path)) {
       LOGW("Could not open file: %s", path);
@@ -300,8 +301,7 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   }
 
   /// Obsolete: use PlayPath!
-  bool playFile(const char *path) { return playPath(path); }
-
+  bool playFile(const char* path) { return playPath(path); }
 
   /// Halts playback; equivalent to setActive(false)
   void stop() {
@@ -328,7 +328,7 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   }
 
   /// Selects stream by path without changing the source iterator
-  bool setPath(const char *path) {
+  bool setPath(const char* path) {
     TRACED();
     writeEnd();
     stream_increment = 1;
@@ -346,10 +346,11 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   }
 
   /// Activates the provided Stream as current input
-  bool setStream(Stream *input) {
+  bool setStream(Stream* input) {
     end();
     out_decoding.begin();
     p_input_stream = input;
+    eof_called = false;  // reset EOF state for new stream
     if (p_input_stream != nullptr) {
       LOGD("open selected stream");
       meta_out.begin();
@@ -362,7 +363,7 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   }
 
   /// Returns the currently active input Stream (e.g., file)
-  Stream *getStream() { return p_input_stream; }
+  Stream* getStream() { return p_input_stream; }
 
   /// Checks whether playback is active
   bool isActive() { return active; }
@@ -437,12 +438,21 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
         LOGD("copy: %d -> 0", (int)bytes);
         return 0;
       }
+      // EOF callback: when no bytes were copied, trigger once per stream
+      if (result == 0 && p_input_stream != nullptr && !eof_called) {
+        eof_called = true;
+        if (on_eof_callback != nullptr) {
+          on_eof_callback(*this);
+        }
+      }
+
       // handle sound
       result = copier.copyBytes(bytes);
       if (result > 0 || timeout == 0) {
         // reset timeout if we had any data
         timeout = millis() + p_source->timeoutAutoNext();
       }
+
       // move to next stream after timeout
       moveToNextFileOnTimeout();
 
@@ -462,11 +472,11 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   }
 
   /// Sets a custom VolumeControl implementation
-  void setVolumeControl(VolumeControl &vc) { volume_out.setVolumeControl(vc); }
+  void setVolumeControl(VolumeControl& vc) { volume_out.setVolumeControl(vc); }
 
   /// Provides access to StreamCopy to register additional callbacks
   /// callbacks
-  StreamCopy &getStreamCopy() { return copier; }
+  StreamCopy& getStreamCopy() { return copier; }
 
   /// When enabled, writes zeros while inactive to keep sinks alive
   void setSilenceOnInactive(bool active) { silence_on_inactive = active; }
@@ -485,7 +495,7 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   }
 
   /// Returns the VolumeStream used by the player
-  VolumeStream &getVolumeStream() { return volume_out; }
+  VolumeStream& getVolumeStream() { return volume_out; }
 
   /// Enables/disables automatic fade in/out to prevent pops
   void setAutoFade(bool active) { is_auto_fade = active; }
@@ -497,10 +507,10 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   void setMetaDataSize(int size) { meta_out.resize(size); }
 
   /// Sets a user reference passed to the stream-change callback
-  void setReference(void *ref) { p_reference = ref; }
+  void setReference(void* ref) { p_reference = ref; }
 
   /// Defines the metadata callback
-  void setMetadataCallback(void (*callback)(MetaDataType type, const char *str,
+  void setMetadataCallback(void (*callback)(MetaDataType type, const char* str,
                                             int len),
                            ID3TypeSelection sel = SELECT_ID3) {
     TRACEI();
@@ -518,12 +528,19 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   }
 
   /// Defines a callback that is called when the stream is changed
-  void setOnStreamChangeCallback(void (*callback)(Stream *stream_ptr,
-                                                  void *reference)) {
+  void setOnStreamChangeCallback(void (*callback)(Stream* stream_ptr,
+                                                  void* reference)) {
     on_stream_change_callback = callback;
-    if (p_input_stream!=nullptr) callback(p_input_stream, p_reference);
+    if (p_input_stream != nullptr) callback(p_input_stream, p_reference);
   }
-  
+
+  /// Defines a callback that is invoked exactly once when the current stream
+  /// reaches EOF (no more bytes can be read from the input stream).
+  /// Signature: void onEOF(AudioPlayer& player)
+  void setOnEOFCallback(void (*callback)(AudioPlayer& player)) {
+    on_eof_callback = callback;
+  }
+
   /// Mutes or unmutes the audio player
   void setMuted(bool muted) {
     if (muted) {
@@ -542,22 +559,21 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   /// Returns true if the player is currently muted
   bool isMuted() { return current_volume == 0.0f; }
 
-
  protected:
   bool active = false;
   bool autonext = true;
   bool silence_on_inactive = false;
-  AudioSource *p_source = nullptr;
+  AudioSource* p_source = nullptr;
   VolumeStream volume_out;  // Volume control
   FadeStream fade;          // Phase in / Phase Out to avoid popping noise
   MetaDataID3 meta_out;     // Metadata parser
   EncodedAudioOutput out_decoding;  // Decoding stream
   CopyDecoder no_decoder{true};
-  AudioDecoder *p_decoder = &no_decoder;
-  Stream *p_input_stream = nullptr;
-  AudioOutput *p_final_print = nullptr;
-  AudioStream *p_final_stream = nullptr;
-  AudioInfoSupport *p_final_notify = nullptr;
+  AudioDecoder* p_decoder = &no_decoder;
+  Stream* p_input_stream = nullptr;
+  AudioOutput* p_final_print = nullptr;
+  AudioStream* p_final_stream = nullptr;
+  AudioInfoSupport* p_final_notify = nullptr;
   StreamCopy copier;  // copies sound into i2s
   AudioInfo info;
   bool meta_active = false;
@@ -567,9 +583,12 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
   float muted_volume = 0.0f;
   int delay_if_full = 100;
   bool is_auto_fade = true;
-  void *p_reference = nullptr;
-  void (*on_stream_change_callback)(Stream *stream_ptr,
-                                    void *reference) = nullptr;
+  void* p_reference = nullptr;
+  void (*on_stream_change_callback)(Stream* stream_ptr,
+                                    void* reference) = nullptr;
+  // EOF callback and guard (invoked once when current stream reaches end)
+  void (*on_eof_callback)(AudioPlayer& player) = nullptr;
+  bool eof_called = false;
 
   void setupFade() {
     if (p_final_print != nullptr) {
@@ -609,14 +628,15 @@ class AudioPlayer : public AudioInfoSupport, public VolumeSupport {
     // restart the decoder to make sure it does not contain any audio when we
     // continue
     p_decoder->begin();
+    eof_called = false;  // prepare for next stream
   }
 
   /// Callback implementation which writes to metadata
-  static void decodeMetaData(void *obj, void *data, size_t len) {
+  static void decodeMetaData(void* obj, void* data, size_t len) {
     LOGD("%s, %zu", LOG_METHOD, len);
-    AudioPlayer *p = (AudioPlayer *)obj;
+    AudioPlayer* p = (AudioPlayer*)obj;
     if (p->meta_active) {
-      p->meta_out.write((const uint8_t *)data, len);
+      p->meta_out.write((const uint8_t*)data, len);
     }
   }
 };