ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
microphone.h
Go to the documentation of this file.
1#pragma once
2
4
5#include <cstddef>
6#include <cstdint>
7#include <cstring>
8#include <span>
9#include <type_traits>
10#include <utility>
11#include <vector>
13
14namespace esphome::microphone {
15
22
25 std::span<const uint8_t> data;
29 int64_t capture_time_us{0};
30};
31
32// Remove before 2027.5.0. A template, so it only warns for the callbacks that use it.
33template<typename F>
34ESPDEPRECATED("Take const microphone::AudioCapture & in data callbacks instead. Removed in 2027.5.0", "2026.11.0")
35constexpr void warn_vector_data_callback() {}
36
37template<typename F> auto as_capture_callback(F &&callback) {
38 using Fn = std::decay_t<F>;
39 if constexpr (std::is_invocable_v<const Fn &, const AudioCapture &>) {
40 return Fn(std::forward<F>(callback));
41 } else {
42 // Remove before 2027.5.0
43 static_assert(std::is_invocable_v<const Fn &, const std::vector<uint8_t> &>,
44 "A data callback takes (const microphone::AudioCapture &)");
45 warn_vector_data_callback<Fn>();
46 return [callback = Fn(std::forward<F>(callback))](const AudioCapture &capture) {
47 const std::vector<uint8_t> copy(capture.data.begin(), capture.data.end());
48 callback(copy);
49 };
50 }
51}
52
54
56 public:
57 DataCallbackManager(const audio::AudioStreamInfo *stream_info, const bool *mute_state)
58 : stream_info_(stream_info), mute_state_(mute_state) {}
59
60 using DataCallbackManagerBase::call;
61
62 // Remove before 2027.5.0, along with this class (use a plain CallbackManager)
63 ESPDEPRECATED("Use Microphone::publish_audio_() instead. Removed in 2027.5.0", "2026.11.0")
64 void call(const std::vector<uint8_t> &data) {
65 if (*this->mute_state_) {
66 const std::vector<uint8_t> zeros(data.size(), 0);
67 this->call(AudioCapture{zeros, *this->stream_info_, 0});
68 } else {
69 this->call(AudioCapture{data, *this->stream_info_, 0});
70 }
71 }
72
73 protected:
75 const bool *mute_state_;
76};
77
79 public:
80 virtual void start() = 0;
81 virtual void stop() = 0;
82
84 template<typename F> void add_data_callback(F &&data_callback) {
85 this->data_callbacks_.add(as_capture_callback(std::forward<F>(data_callback)));
86 }
87
88 bool is_running() const { return this->state_ == STATE_RUNNING; }
89 bool is_stopped() const { return this->state_ == STATE_STOPPED; }
90
91 void set_mute_state(bool is_muted) { this->mute_state_ = is_muted; }
92 bool get_mute_state() { return this->mute_state_; }
93
95
96 protected:
98 void publish_audio_(std::span<uint8_t> data, const audio::AudioStreamInfo &stream_info, int64_t capture_time_us = 0) {
99 if (this->mute_state_) {
100 std::memset(data.data(), 0, data.size());
101 }
102 this->data_callbacks_.call(AudioCapture{data, stream_info, capture_time_us});
103 }
104
105 bool has_data_callbacks_() const { return this->data_callbacks_.size() > 0; }
106
108 bool mute_state_{false};
109
111
112 // Make private when the deprecated call(data) is removed in 2027.5.0
114};
115
116} // namespace esphome::microphone
ESPDEPRECATED("Use Microphone::publish_audio_() instead. Removed in 2027.5.0", "2026.11.0") void call(const std
Definition microphone.h:63
const audio::AudioStreamInfo * stream_info_
Definition microphone.h:74
DataCallbackManager(const audio::AudioStreamInfo *stream_info, const bool *mute_state)
Definition microphone.h:57
audio::AudioStreamInfo get_audio_stream_info()
Definition microphone.h:94
void set_mute_state(bool is_muted)
Definition microphone.h:91
void publish_audio_(std::span< uint8_t > data, const audio::AudioStreamInfo &stream_info, int64_t capture_time_us=0)
While muted, data is zeroed first, so it must be a buffer the platform owns.
Definition microphone.h:98
DataCallbackManager data_callbacks_
Definition microphone.h:113
audio::AudioStreamInfo audio_stream_info_
Definition microphone.h:110
void add_data_callback(F &&data_callback)
Callbacks take (const AudioCapture &) and run on the microphone's task.
Definition microphone.h:84
auto as_capture_callback(F &&callback)
Definition microphone.h:37
ESPDEPRECATED("Take const microphone::AudioCapture & in data callbacks instead. Removed in 2027.5.0", "2026.11.0") const expr void warn_vector_data_callback()
Definition microphone.h:34
STL namespace.
int64_t capture_time_us
esp_timer_get_time() of the first frame, or 0 if unknown
Definition microphone.h:29
audio::AudioStreamInfo stream_info
Format of data.
Definition microphone.h:27
std::span< const uint8_t > data
Only valid during the callback.
Definition microphone.h:25