ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
i2s_audio.h
Go to the documentation of this file.
1#pragma once
2
3#ifdef USE_ESP32
4
8#include <esp_idf_version.h>
9#include <driver/i2s_std.h>
10#include <soc/soc_caps.h>
11
12namespace esphome::i2s_audio {
13
14class I2SAudioComponent;
15
16class I2SAudioBase : public Parented<I2SAudioComponent> {
17 public:
18 void set_i2s_role(i2s_role_t role) { this->i2s_role_ = role; }
19 void set_slot_mode(i2s_slot_mode_t slot_mode) { this->slot_mode_ = slot_mode; }
20 void set_std_slot_mask(i2s_std_slot_mask_t std_slot_mask) { this->std_slot_mask_ = std_slot_mask; }
21 void set_slot_bit_width(i2s_slot_bit_width_t slot_bit_width) { this->slot_bit_width_ = slot_bit_width; }
22 void set_sample_rate(uint32_t sample_rate) { this->sample_rate_ = sample_rate; }
23 void set_use_apll(uint32_t use_apll) { this->use_apll_ = use_apll; }
24 void set_mclk_multiple(i2s_mclk_multiple_t mclk_multiple) { this->mclk_multiple_ = mclk_multiple; }
25
26 protected:
27 i2s_clock_src_t get_clock_source_() const {
28#if SOC_CLK_APLL_SUPPORTED
29 if (this->use_apll_) {
30 return I2S_CLK_SRC_APLL;
31 }
32#endif
33 return I2S_CLK_SRC_DEFAULT;
34 }
35
36 i2s_role_t i2s_role_{};
37 i2s_slot_mode_t slot_mode_;
38 i2s_std_slot_mask_t std_slot_mask_;
39 i2s_slot_bit_width_t slot_bit_width_;
42 i2s_mclk_multiple_t mclk_multiple_;
43};
44
45class I2SAudioIn : public I2SAudioBase {
46#ifdef USE_I2S_AUDIO_FULL_DUPLEX
47 public:
49 virtual void build_full_duplex_config(i2s_std_config_t &std_cfg) = 0;
52 virtual void full_duplex_rx_enabling(i2s_chan_handle_t rx_handle, uint32_t dma_desc_num) = 0;
53#endif
54};
55
56class I2SAudioOut : public I2SAudioBase {
57#ifdef USE_I2S_AUDIO_FULL_DUPLEX
58 public:
62 virtual void build_full_duplex_config(i2s_chan_config_t &chan_cfg, i2s_std_config_t &std_cfg) {}
63#endif
64};
65
66class I2SAudioComponent final : public Component {
67 public:
68#ifdef USE_I2S_AUDIO_FULL_DUPLEX
69 void setup() override;
70
71 void set_audio_in(I2SAudioIn *audio_in) { this->audio_in_ = audio_in; }
72 void set_audio_out(I2SAudioOut *audio_out) { this->audio_out_ = audio_out; }
73
75 bool is_full_duplex() const { return this->audio_in_ != nullptr && this->audio_out_ != nullptr; }
76
79 i2s_chan_handle_t acquire_rx_channel();
81 void release_rx_channel();
82
86 i2s_chan_handle_t acquire_tx_channel();
89 void release_tx_channel();
91 bool is_tx_in_use() const { return this->tx_in_use_; }
92#endif
93 i2s_std_gpio_config_t get_pin_config() const {
94 return {.mclk = (gpio_num_t) this->mclk_pin_,
95 .bclk = (gpio_num_t) this->bclk_pin_,
96 .ws = (gpio_num_t) this->lrclk_pin_,
97 .dout = I2S_GPIO_UNUSED, // add local ports
98 .din = I2S_GPIO_UNUSED,
99 .invert_flags = {
100 .mclk_inv = false,
101 .bclk_inv = false,
102 .ws_inv = false,
103 }};
104 }
105
106 void set_mclk_pin(int pin) { this->mclk_pin_ = pin; }
107 void set_bclk_pin(int pin) { this->bclk_pin_ = pin; }
108 void set_lrclk_pin(int pin) { this->lrclk_pin_ = pin; }
109 void set_port(int port) { this->port_ = port; }
110#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(6, 0, 0)
111 int get_port() const { return this->port_; }
112#else
113 i2s_port_t get_port() const { return static_cast<i2s_port_t>(this->port_); }
114#endif
115
116 void lock() { this->lock_.lock(); }
117 bool try_lock() { return this->lock_.try_lock(); }
118 void unlock() { this->lock_.unlock(); }
119
120 protected:
122
123#ifdef USE_I2S_AUDIO_FULL_DUPLEX
125 i2s_chan_handle_t acquire_(bool &in_use, i2s_chan_handle_t handle);
127 bool update_rx_channel_();
128
131 i2s_chan_handle_t rx_handle_{nullptr};
132 i2s_chan_handle_t tx_handle_{nullptr};
134 bool rx_in_use_{false};
135 bool tx_in_use_{false};
136 bool rx_enabled_{false};
137#endif
138 int mclk_pin_{I2S_GPIO_UNUSED};
139 int bclk_pin_{I2S_GPIO_UNUSED};
141 int port_{};
142};
143
144} // namespace esphome::i2s_audio
145
146#endif // USE_ESP32
Mutex implementation, with API based on the unavailable std::mutex.
Definition helpers.h:2183
void unlock()
Definition helpers.h:2194
bool try_lock()
Definition helpers.h:2193
Helper class to easily give an object a parent of type T.
Definition helpers.h:2160
i2s_std_slot_mask_t std_slot_mask_
Definition i2s_audio.h:38
i2s_slot_bit_width_t slot_bit_width_
Definition i2s_audio.h:39
void set_sample_rate(uint32_t sample_rate)
Definition i2s_audio.h:22
void set_mclk_multiple(i2s_mclk_multiple_t mclk_multiple)
Definition i2s_audio.h:24
void set_i2s_role(i2s_role_t role)
Definition i2s_audio.h:18
void set_use_apll(uint32_t use_apll)
Definition i2s_audio.h:23
void set_std_slot_mask(i2s_std_slot_mask_t std_slot_mask)
Definition i2s_audio.h:20
i2s_clock_src_t get_clock_source_() const
Definition i2s_audio.h:27
i2s_mclk_multiple_t mclk_multiple_
Definition i2s_audio.h:42
void set_slot_bit_width(i2s_slot_bit_width_t slot_bit_width)
Definition i2s_audio.h:21
void set_slot_mode(i2s_slot_mode_t slot_mode)
Definition i2s_audio.h:19
void set_audio_out(I2SAudioOut *audio_out)
Definition i2s_audio.h:72
i2s_std_gpio_config_t get_pin_config() const
Definition i2s_audio.h:93
i2s_chan_handle_t acquire_rx_channel()
Enables the full duplex RX channel.
Definition i2s_audio.cpp:57
bool is_full_duplex() const
True when a microphone and a speaker share this bus at the same time.
Definition i2s_audio.h:75
bool is_tx_in_use() const
True while another speaker holds the full duplex TX channel.
Definition i2s_audio.h:91
void set_audio_in(I2SAudioIn *audio_in)
Definition i2s_audio.h:71
i2s_chan_handle_t acquire_(bool &in_use, i2s_chan_handle_t handle)
Marks one side active and brings the shared clocks up; undoes the mark if that fails.
Definition i2s_audio.cpp:46
bool update_rx_channel_()
Enables the RX channel while either side is active, since it drives the shared clocks.
Definition i2s_audio.cpp:78
void release_rx_channel()
Releases the RX channel; it keeps running while the TX side needs its clocks. Main loop only.
Definition i2s_audio.cpp:59
i2s_chan_handle_t acquire_tx_channel()
Starts the shared clocks and hands over the full duplex TX channel, still disabled,...
Definition i2s_audio.cpp:64
void release_tx_channel()
Disables the TX channel and stops the shared clocks if the RX side is idle.
Definition i2s_audio.cpp:71
virtual void full_duplex_rx_enabling(i2s_chan_handle_t rx_handle, uint32_t dma_desc_num)=0
Called by the parent on the main loop just before it enables the full duplex RX channel,...
virtual void build_full_duplex_config(i2s_std_config_t &std_cfg)=0
Builds the RX configuration the parent uses to set up a full duplex channel pair.
virtual void build_full_duplex_config(i2s_chan_config_t &chan_cfg, i2s_std_config_t &std_cfg)
Builds the TX configuration the parent uses to set up a full duplex channel pair.
Definition i2s_audio.h:62
static void uint32_t
spi_device_handle_t handle