announcement_volume.h

Go to the documentation of this file.

#pragma once
 
#include <cmath>
#include <utility>
 
namespace esphome::speaker {
 
class AnnouncementVolume {
 public:
  template<typename F> void set_volume(float volume, F &&apply) {
    this->volume_ = volume;
    if (this->active_) {
      std::forward<F>(apply)(volume);
    }
  }
  float get_volume() const { return this->volume_; }
  bool is_configured() const { return !std::isnan(this->volume_); }
  bool is_active() const { return this->active_; }
 
  template<typename F> void begin(bool other_audio_playing, F &&apply) {
    if (this->active_ || other_audio_playing || !this->is_configured()) {
      return;
    }
    this->active_ = true;
    this->log_begin_();
    std::forward<F>(apply)(this->volume_);
  }
 
  template<typename F> void end(float media_volume, F &&apply) {
    if (!this->active_) {
      return;
    }
    this->active_ = false;
    this->log_end_(media_volume);
    std::forward<F>(apply)(media_volume);
  }
 
  void cancel() { this->active_ = false; }
 
  template<typename F>
  void item_started(bool is_announcement, bool other_audio_playing, float media_volume, F &&apply) {
    if (!is_announcement) {
      this->end(media_volume, apply);
    } else if (!this->last_item_announcement_) {
      this->begin(other_audio_playing, apply);
    }
    this->last_item_announcement_ = is_announcement;
  }
 
  template<typename F> void playlist_finished(float media_volume, F &&apply) {
    this->last_item_announcement_ = false;
    this->end(media_volume, std::forward<F>(apply));
  }
 
 protected:
  void log_begin_() const;
  void log_end_(float media_volume) const;
 
  float volume_{NAN};
  bool active_{false};
  bool last_item_announcement_{false};
};
 
}  // namespace esphome::speaker