speaker.h

Go to the documentation of this file.

#pragma once
 
#include <cstddef>
#include <cstdint>
#include <vector>
 
#ifdef USE_ESP32
#include <freertos/FreeRTOS.h>
#endif
 
#include "esphome/core/defines.h"
#include "esphome/core/helpers.h"
 
#include "esphome/components/audio/audio.h"
#ifdef USE_AUDIO_DAC
#include "esphome/components/audio_dac/audio_dac.h"
#endif
 
namespace esphome::speaker {
 
static constexpr float SILENT_VOLUME_THRESHOLD = 0.001f;
 
enum State : uint8_t {
  STATE_STOPPED = 0,
  STATE_STARTING,
  STATE_RUNNING,
  STATE_STOPPING,
};
 
class Speaker {
 public:
#ifdef USE_ESP32
  virtual size_t play(const uint8_t *data, size_t length, TickType_t ticks_to_wait) {
    return this->play(data, length);
  };
#endif
 
  virtual size_t play(const uint8_t *data, size_t length) = 0;
 
  size_t play(const std::vector<uint8_t> &data) { return this->play(data.data(), data.size()); }
 
  virtual void start() = 0;
  virtual void stop() = 0;
  // In compare between *STOP()* and *FINISH()*; *FINISH()* will stop after emptying the play buffer,
  // while *STOP()* will break directly.
  // When finish() is not implemented on the platform component it should just do a normal stop.
  virtual void finish() { this->stop(); }
 
  // Pauses processing incoming audio. Needs to be implemented specifically per speaker component
  virtual void set_pause_state(bool pause_state) {}
  virtual bool get_pause_state() const { return false; }
 
  virtual bool has_buffered_data() const = 0;
 
  bool is_running() const { return this->state_ == STATE_RUNNING; }
  bool is_stopped() const { return this->state_ == STATE_STOPPED; }
 
  // Volume and mute are independent: changing one never alters the other's stored state. Volume control is
  // handled by a configured audio dac component. Individual speaker components can override and implement in
  // software if an audio dac isn't available.
  virtual void set_volume(float volume) {
    this->volume_ = volume;
#ifdef USE_AUDIO_DAC
    if (this->audio_dac_ != nullptr) {
      this->audio_dac_->set_volume(volume);
      this->apply_audio_dac_mute_();
    }
#endif
  };
  virtual float get_volume() { return this->volume_; }
 
  virtual void set_mute_state(bool mute_state) {
    this->mute_state_ = mute_state;
#ifdef USE_AUDIO_DAC
    this->apply_audio_dac_mute_();
#endif
  }
  virtual bool get_mute_state() { return this->mute_state_; }
 
#ifdef USE_AUDIO_DAC
  void set_audio_dac(audio_dac::AudioDac *audio_dac) { this->audio_dac_ = audio_dac; }
#endif
 
  void set_audio_stream_info(const audio::AudioStreamInfo &audio_stream_info) {
    this->audio_stream_info_ = audio_stream_info;
  }
 
  audio::AudioStreamInfo &get_audio_stream_info() { return this->audio_stream_info_; }
 
  template<typename F> void add_audio_output_callback(F &&callback) {
    this->audio_output_callback_.add(std::forward<F>(callback));
  }
 
 protected:
  bool is_silent_() const { return this->mute_state_ || this->volume_ < SILENT_VOLUME_THRESHOLD; }
 
#ifdef USE_AUDIO_DAC
  void apply_audio_dac_mute_() {
    if (this->audio_dac_ == nullptr)
      return;
    if (this->is_silent_()) {
      this->audio_dac_->set_mute_on();
    } else {
      this->audio_dac_->set_mute_off();
    }
  }
#endif
 
  State state_{STATE_STOPPED};
  bool mute_state_{false};
  audio::AudioStreamInfo audio_stream_info_;
  float volume_{1.0f};
 
#ifdef USE_AUDIO_DAC
  audio_dac::AudioDac *audio_dac_{nullptr};
#endif
 
  CallbackManager<void(uint32_t, int64_t)> audio_output_callback_{};
};
 
}  // namespace esphome::speaker