audio_http_media_source.h

Go to the documentation of this file.

#pragma once
 
#include "esphome/core/defines.h"
 
#ifdef USE_ESP32
 
#include "esphome/components/audio/audio.h"
#include "esphome/components/media_source/media_source.h"
#include "esphome/core/component.h"
 
#include <micro_decoder/decoder_source.h>
#include <micro_decoder/types.h>
 
#include <atomic>
#include <memory>
#include <string>
 
namespace esphome::audio_http {
 
// Inherits from two unrelated listener-style interfaces:
//   - media_source::MediaSource: this source reports state and writes audio *to* an orchestrator
//     (the orchestrator calls set_listener() on us with a MediaSourceListener*).
//   - micro_decoder::DecoderListener: the underlying decoder calls back *into* us with decoded
//     audio and state changes (we call decoder_->set_listener(this) in setup()).
// The two set_listener() methods live on different base classes and serve opposite directions.
class AudioHTTPMediaSource final : public Component,
                                   public media_source::MediaSource,
                                   public micro_decoder::DecoderListener {
 public:
  void setup() override;
  void loop() override;
  void dump_config() override;
 
  void set_buffer_size(size_t buffer_size) { this->buffer_size_ = buffer_size; }
  void set_task_stack_in_psram(bool task_stack_in_psram) { this->decoder_task_stack_in_psram_ = task_stack_in_psram; }
  void set_persistent_ring_buffer(bool persistent) { this->persistent_ring_buffer_ = persistent; }
#ifdef USE_AUDIO_HTTP_CA_CERTIFICATE
  void set_http_ca_certificate(const char *ca_certificate) { this->http_ca_certificate_ = ca_certificate; }
#endif
 
  // MediaSource interface implementation
  bool play_uri(const std::string &uri) override;
  void handle_command(media_source::MediaSourceCommand command) override;
  bool can_handle(const std::string &uri) const override;
 
  // DecoderListener interface implementation
  size_t on_audio_write(const uint8_t *data, size_t length, uint32_t timeout_ms) override;
  void on_stream_info(const micro_decoder::AudioStreamInfo &info) override;
  void on_state_change(micro_decoder::DecoderState state) override;
 
 protected:
  std::unique_ptr<micro_decoder::DecoderSource> decoder_;
  audio::AudioStreamInfo stream_info_;
 
  size_t buffer_size_{50000};
 
  // Written from the main loop in handle_command(), read from the decoder task in
  // on_audio_write(). Must be atomic to avoid a data race.
  std::atomic<bool> pause_{false};
  bool decoder_task_stack_in_psram_{false};
  bool persistent_ring_buffer_{false};
#ifdef USE_AUDIO_HTTP_CA_CERTIFICATE
  const char *http_ca_certificate_{nullptr};
#endif
};
 
}  // namespace esphome::audio_http
 
#endif  // USE_ESP32