mirror of
https://github.com/esphome/esphome.git
synced 2025-09-02 03:12:20 +01:00
254 lines
8.3 KiB
Python
254 lines
8.3 KiB
Python
from esphome import pins
|
|
import esphome.codegen as cg
|
|
from esphome.components.esp32 import get_esp32_variant
|
|
from esphome.components.esp32.const import (
|
|
VARIANT_ESP32,
|
|
VARIANT_ESP32C3,
|
|
VARIANT_ESP32S2,
|
|
VARIANT_ESP32S3,
|
|
)
|
|
import esphome.config_validation as cv
|
|
from esphome.const import (
|
|
CONF_BITS_PER_SAMPLE,
|
|
CONF_CHANNEL,
|
|
CONF_ID,
|
|
CONF_SAMPLE_RATE,
|
|
KEY_CORE,
|
|
KEY_FRAMEWORK_VERSION,
|
|
)
|
|
from esphome.core import CORE
|
|
from esphome.cpp_generator import MockObjClass
|
|
import esphome.final_validate as fv
|
|
|
|
CODEOWNERS = ["@jesserockz"]
|
|
DEPENDENCIES = ["esp32"]
|
|
MULTI_CONF = True
|
|
|
|
CONF_I2S_DOUT_PIN = "i2s_dout_pin"
|
|
CONF_I2S_DIN_PIN = "i2s_din_pin"
|
|
CONF_I2S_MCLK_PIN = "i2s_mclk_pin"
|
|
CONF_I2S_BCLK_PIN = "i2s_bclk_pin"
|
|
CONF_I2S_LRCLK_PIN = "i2s_lrclk_pin"
|
|
|
|
CONF_I2S_AUDIO = "i2s_audio"
|
|
CONF_I2S_AUDIO_ID = "i2s_audio_id"
|
|
|
|
CONF_I2S_MODE = "i2s_mode"
|
|
CONF_PRIMARY = "primary"
|
|
CONF_SECONDARY = "secondary"
|
|
|
|
CONF_USE_APLL = "use_apll"
|
|
CONF_BITS_PER_CHANNEL = "bits_per_channel"
|
|
CONF_MONO = "mono"
|
|
CONF_LEFT = "left"
|
|
CONF_RIGHT = "right"
|
|
CONF_STEREO = "stereo"
|
|
CONF_BOTH = "both"
|
|
|
|
CONF_USE_LEGACY = "use_legacy"
|
|
|
|
i2s_audio_ns = cg.esphome_ns.namespace("i2s_audio")
|
|
I2SAudioComponent = i2s_audio_ns.class_("I2SAudioComponent", cg.Component)
|
|
I2SAudioBase = i2s_audio_ns.class_(
|
|
"I2SAudioBase", cg.Parented.template(I2SAudioComponent)
|
|
)
|
|
I2SAudioIn = i2s_audio_ns.class_("I2SAudioIn", I2SAudioBase)
|
|
I2SAudioOut = i2s_audio_ns.class_("I2SAudioOut", I2SAudioBase)
|
|
|
|
i2s_mode_t = cg.global_ns.enum("i2s_mode_t")
|
|
I2S_MODE_OPTIONS = {
|
|
CONF_PRIMARY: i2s_mode_t.I2S_MODE_MASTER, # NOLINT
|
|
CONF_SECONDARY: i2s_mode_t.I2S_MODE_SLAVE, # NOLINT
|
|
}
|
|
|
|
i2s_role_t = cg.global_ns.enum("i2s_role_t")
|
|
I2S_ROLE_OPTIONS = {
|
|
CONF_PRIMARY: i2s_role_t.I2S_ROLE_MASTER, # NOLINT
|
|
CONF_SECONDARY: i2s_role_t.I2S_ROLE_SLAVE, # NOLINT
|
|
}
|
|
|
|
# https://github.com/espressif/esp-idf/blob/master/components/soc/{variant}/include/soc/soc_caps.h
|
|
I2S_PORTS = {
|
|
VARIANT_ESP32: 2,
|
|
VARIANT_ESP32S2: 1,
|
|
VARIANT_ESP32S3: 2,
|
|
VARIANT_ESP32C3: 1,
|
|
}
|
|
|
|
i2s_channel_fmt_t = cg.global_ns.enum("i2s_channel_fmt_t")
|
|
I2S_CHANNELS = {
|
|
CONF_MONO: i2s_channel_fmt_t.I2S_CHANNEL_FMT_ALL_LEFT, # left data to both channels
|
|
CONF_LEFT: i2s_channel_fmt_t.I2S_CHANNEL_FMT_ONLY_LEFT, # mono data
|
|
CONF_RIGHT: i2s_channel_fmt_t.I2S_CHANNEL_FMT_ONLY_RIGHT, # mono data
|
|
CONF_STEREO: i2s_channel_fmt_t.I2S_CHANNEL_FMT_RIGHT_LEFT, # stereo data to both channels
|
|
}
|
|
|
|
i2s_slot_mode_t = cg.global_ns.enum("i2s_slot_mode_t")
|
|
I2S_SLOT_MODE = {
|
|
CONF_MONO: i2s_slot_mode_t.I2S_SLOT_MODE_MONO,
|
|
CONF_STEREO: i2s_slot_mode_t.I2S_SLOT_MODE_STEREO,
|
|
}
|
|
|
|
i2s_std_slot_mask_t = cg.global_ns.enum("i2s_std_slot_mask_t")
|
|
I2S_STD_SLOT_MASK = {
|
|
CONF_LEFT: i2s_std_slot_mask_t.I2S_STD_SLOT_LEFT,
|
|
CONF_RIGHT: i2s_std_slot_mask_t.I2S_STD_SLOT_RIGHT,
|
|
CONF_BOTH: i2s_std_slot_mask_t.I2S_STD_SLOT_BOTH,
|
|
}
|
|
|
|
i2s_bits_per_sample_t = cg.global_ns.enum("i2s_bits_per_sample_t")
|
|
I2S_BITS_PER_SAMPLE = {
|
|
8: i2s_bits_per_sample_t.I2S_BITS_PER_SAMPLE_8BIT,
|
|
16: i2s_bits_per_sample_t.I2S_BITS_PER_SAMPLE_16BIT,
|
|
24: i2s_bits_per_sample_t.I2S_BITS_PER_SAMPLE_24BIT,
|
|
32: i2s_bits_per_sample_t.I2S_BITS_PER_SAMPLE_32BIT,
|
|
}
|
|
|
|
i2s_bits_per_chan_t = cg.global_ns.enum("i2s_bits_per_chan_t")
|
|
I2S_BITS_PER_CHANNEL = {
|
|
"default": i2s_bits_per_chan_t.I2S_BITS_PER_CHAN_DEFAULT,
|
|
8: i2s_bits_per_chan_t.I2S_BITS_PER_CHAN_8BIT,
|
|
16: i2s_bits_per_chan_t.I2S_BITS_PER_CHAN_16BIT,
|
|
24: i2s_bits_per_chan_t.I2S_BITS_PER_CHAN_24BIT,
|
|
32: i2s_bits_per_chan_t.I2S_BITS_PER_CHAN_32BIT,
|
|
}
|
|
|
|
i2s_slot_bit_width_t = cg.global_ns.enum("i2s_slot_bit_width_t")
|
|
I2S_SLOT_BIT_WIDTH = {
|
|
"default": i2s_slot_bit_width_t.I2S_SLOT_BIT_WIDTH_AUTO,
|
|
8: i2s_slot_bit_width_t.I2S_SLOT_BIT_WIDTH_8BIT,
|
|
16: i2s_slot_bit_width_t.I2S_SLOT_BIT_WIDTH_16BIT,
|
|
24: i2s_slot_bit_width_t.I2S_SLOT_BIT_WIDTH_24BIT,
|
|
32: i2s_slot_bit_width_t.I2S_SLOT_BIT_WIDTH_32BIT,
|
|
}
|
|
|
|
_validate_bits = cv.float_with_unit("bits", "bit")
|
|
|
|
_use_legacy_driver = None
|
|
|
|
|
|
def i2s_audio_component_schema(
|
|
class_: MockObjClass,
|
|
*,
|
|
default_sample_rate: int,
|
|
default_channel: str,
|
|
default_bits_per_sample: str,
|
|
):
|
|
return cv.Schema(
|
|
{
|
|
cv.GenerateID(): cv.declare_id(class_),
|
|
cv.GenerateID(CONF_I2S_AUDIO_ID): cv.use_id(I2SAudioComponent),
|
|
cv.Optional(CONF_CHANNEL, default=default_channel): cv.one_of(
|
|
*I2S_CHANNELS
|
|
),
|
|
cv.Optional(CONF_SAMPLE_RATE, default=default_sample_rate): cv.int_range(
|
|
min=1
|
|
),
|
|
cv.Optional(CONF_BITS_PER_SAMPLE, default=default_bits_per_sample): cv.All(
|
|
_validate_bits, cv.one_of(*I2S_BITS_PER_SAMPLE)
|
|
),
|
|
cv.Optional(CONF_I2S_MODE, default=CONF_PRIMARY): cv.one_of(
|
|
*I2S_MODE_OPTIONS, lower=True
|
|
),
|
|
cv.Optional(CONF_USE_APLL, default=False): cv.boolean,
|
|
cv.Optional(CONF_BITS_PER_CHANNEL, default="default"): cv.All(
|
|
cv.Any(cv.float_with_unit("bits", "bit"), "default"),
|
|
cv.one_of(*I2S_BITS_PER_CHANNEL),
|
|
),
|
|
}
|
|
)
|
|
|
|
|
|
async def register_i2s_audio_component(var, config):
|
|
await cg.register_parented(var, config[CONF_I2S_AUDIO_ID])
|
|
if use_legacy():
|
|
cg.add(var.set_i2s_mode(I2S_MODE_OPTIONS[config[CONF_I2S_MODE]]))
|
|
cg.add(var.set_channel(I2S_CHANNELS[config[CONF_CHANNEL]]))
|
|
cg.add(
|
|
var.set_bits_per_sample(I2S_BITS_PER_SAMPLE[config[CONF_BITS_PER_SAMPLE]])
|
|
)
|
|
cg.add(
|
|
var.set_bits_per_channel(
|
|
I2S_BITS_PER_CHANNEL[config[CONF_BITS_PER_CHANNEL]]
|
|
)
|
|
)
|
|
else:
|
|
cg.add(var.set_i2s_role(I2S_ROLE_OPTIONS[config[CONF_I2S_MODE]]))
|
|
slot_mode = config[CONF_CHANNEL]
|
|
if slot_mode != CONF_STEREO:
|
|
slot_mode = CONF_MONO
|
|
slot_mask = config[CONF_CHANNEL]
|
|
if slot_mask not in [CONF_LEFT, CONF_RIGHT]:
|
|
slot_mask = CONF_BOTH
|
|
cg.add(var.set_slot_mode(I2S_SLOT_MODE[slot_mode]))
|
|
cg.add(var.set_std_slot_mask(I2S_STD_SLOT_MASK[slot_mask]))
|
|
cg.add(
|
|
var.set_slot_bit_width(I2S_SLOT_BIT_WIDTH[config[CONF_BITS_PER_CHANNEL]])
|
|
)
|
|
cg.add(var.set_sample_rate(config[CONF_SAMPLE_RATE]))
|
|
cg.add(var.set_use_apll(config[CONF_USE_APLL]))
|
|
|
|
|
|
def validate_use_legacy(value):
|
|
global _use_legacy_driver # noqa: PLW0603
|
|
if CONF_USE_LEGACY in value:
|
|
if (_use_legacy_driver is not None) and (
|
|
_use_legacy_driver != value[CONF_USE_LEGACY]
|
|
):
|
|
raise cv.Invalid(
|
|
f"All i2s_audio components must set {CONF_USE_LEGACY} to the same value."
|
|
)
|
|
if (not value[CONF_USE_LEGACY]) and (CORE.using_arduino):
|
|
raise cv.Invalid("Arduino supports only the legacy i2s driver.")
|
|
_use_legacy_driver = value[CONF_USE_LEGACY]
|
|
return value
|
|
|
|
|
|
CONFIG_SCHEMA = cv.All(
|
|
cv.Schema(
|
|
{
|
|
cv.GenerateID(): cv.declare_id(I2SAudioComponent),
|
|
cv.Required(CONF_I2S_LRCLK_PIN): pins.internal_gpio_output_pin_number,
|
|
cv.Optional(CONF_I2S_BCLK_PIN): pins.internal_gpio_output_pin_number,
|
|
cv.Optional(CONF_I2S_MCLK_PIN): pins.internal_gpio_output_pin_number,
|
|
cv.Optional(CONF_USE_LEGACY): cv.boolean,
|
|
},
|
|
),
|
|
validate_use_legacy,
|
|
)
|
|
|
|
|
|
def _final_validate(_):
|
|
i2s_audio_configs = fv.full_config.get()[CONF_I2S_AUDIO]
|
|
variant = get_esp32_variant()
|
|
if variant not in I2S_PORTS:
|
|
raise cv.Invalid(f"Unsupported variant {variant}")
|
|
if len(i2s_audio_configs) > I2S_PORTS[variant]:
|
|
raise cv.Invalid(
|
|
f"Only {I2S_PORTS[variant]} I2S audio ports are supported on {variant}"
|
|
)
|
|
|
|
|
|
def use_legacy():
|
|
framework_version = CORE.data[KEY_CORE][KEY_FRAMEWORK_VERSION]
|
|
if CORE.using_esp_idf and framework_version >= cv.Version(5, 0, 0):
|
|
if not _use_legacy_driver:
|
|
return False
|
|
return True
|
|
|
|
|
|
FINAL_VALIDATE_SCHEMA = _final_validate
|
|
|
|
|
|
async def to_code(config):
|
|
var = cg.new_Pvariable(config[CONF_ID])
|
|
await cg.register_component(var, config)
|
|
if use_legacy():
|
|
cg.add_define("USE_I2S_LEGACY")
|
|
|
|
cg.add(var.set_lrclk_pin(config[CONF_I2S_LRCLK_PIN]))
|
|
if CONF_I2S_BCLK_PIN in config:
|
|
cg.add(var.set_bclk_pin(config[CONF_I2S_BCLK_PIN]))
|
|
if CONF_I2S_MCLK_PIN in config:
|
|
cg.add(var.set_mclk_pin(config[CONF_I2S_MCLK_PIN]))
|