Support for Arduino ESP 3.0.0

Author: pschatzmann

src/AudioKitHAL.h

@@ -41,7 +41,7 @@ struct AudioKitConfig {
  /// @brief driver which selects the codec implementation: AUDIO_CODEC_ES8388_DEFAULT_HANDLE, AUDIO_CODEC_AC101_CODEC_HANDLE, AUDIO_CODEC_ES8311_DEFAULT_HANDLE, AUDIO_CODEC_ES7243_DEFAULT_HANDLE
  audio_hal_func_t driver = AUDIO_DRIVER;
 
- i2s_port_t i2s_num = (i2s_port_t)pins.i2s_num;
+ int i2s_num = pins.i2s_num;
  bool sd_active = true;
  bool auto_clear = true;
  bool use_apll = true;
@@ -291,7 +291,7 @@ class AudioKit {
 #if AUDIOKIT_ESP32_I2S && defined(ESP32)
  if (cfg.i2s_active) {
  // uninstall i2s driver
- i2s_driver_uninstall(cfg.i2s_num);
+ i2s_driver_uninstall((i2s_port_t)cfg.i2s_num);
  }
 #endif
  // stop codec driver
@@ -343,7 +343,7 @@ class AudioKit {
  {
  KIT_LOGD("write: %zu", size);
  size_t bytes_written = 0;
- if (i2s_write(cfg.i2s_num, src, size, &bytes_written, ticks_to_wait) != ESP_OK) {
+ if (i2s_write((i2s_port_t)cfg.i2s_num, src, size, &bytes_written, ticks_to_wait) != ESP_OK) {
  KIT_LOGE("i2s_write");
  }
  return bytes_written;
@@ -354,7 +354,7 @@ class AudioKit {
  {
  KIT_LOGD("read: %zu", size);
  size_t bytes_read = 0;
- if (i2s_read(cfg.i2s_num, dest, size, &bytes_read, ticks_to_wait) != ESP_OK) {
+ if (i2s_read((i2s_port_t)cfg.i2s_num, dest, size, &bytes_read, ticks_to_wait) != ESP_OK) {
  KIT_LOGE("i2s_read");
  }
  return bytes_read;
@@ -383,7 +383,7 @@ class AudioKit {
 #if AUDIOKIT_ESP32_I2S && defined(ESP32)
  // update I2S
  if (cfg.i2s_active) {
- if (i2s_set_sample_rates(cfg.i2s_num, cfg.sampleRate()) != ESP_OK) {
+ if (i2s_set_sample_rates((i2s_port_t)cfg.i2s_num, cfg.sampleRate()) != ESP_OK) {
  KIT_LOGE("i2s_set_sample_rates");
  result = false;
  }
@@ -636,8 +636,7 @@ class AudioKit {
  }
 #else
 #if defined(ARDUINO)
-#warning \
- "SPI initialization for the SD drive not supported - you might need to take care of this yourself"
+#warning "SPI initialization for the SD drive not supported - you might need to take care of this yourself"
 #endif
  cfg.sd_active = false;
 #endif
@@ -650,7 +649,7 @@ class AudioKit {
  KIT_LOGD("setupI2S");
  // setup i2s driver - with no queue
  i2s_config_t i2s_config = cfg.i2sConfig();
- if (i2s_driver_install(cfg.i2s_num, &i2s_config, 0, NULL) != ESP_OK) {
+ if (i2s_driver_install((i2s_port_t)cfg.i2s_num, &i2s_config, 0, NULL) != ESP_OK) {
  KIT_LOGE("i2s_driver_install");
  return false;
  }
@@ -667,7 +666,7 @@ class AudioKit {
  KIT_LOGI("- mck_io_num: %d", pin_config.mck_io_num);
 #endif
 
- if (i2s_set_pin(cfg.i2s_num, &pin_config) != ESP_OK) {
+ if (i2s_set_pin((i2s_port_t)cfg.i2s_num, &pin_config) != ESP_OK) {
  KIT_LOGE("i2s_set_pin");
  return false;
  }

src/AudioKitSettings.h

@@ -21,6 +21,7 @@
  */
 
 #pragma once
+#include "esp_idf_version.h"
 
 // Select your specific board
 #ifndef AUDIOKIT_BOARD
@@ -56,14 +57,19 @@
 # define WORKAROUND_ES8388_LINE1_GAIN 0
 #endif
 
-// Special rules for IDF build
-#if defined(AUDIOKIT_USE_IDF)
+// Special rules for IDF build 
+#if defined(AUDIOKIT_USE_IDF) 
 #define AUDIOKIT_SETUP_SD 0
 #define AUDIOKIT_FREE_RTOS 1
 #define AUDIOKIT_ESP32_I2S 0
 #define AUDIOKIT_ESP32_AUDIOKIT_USE_WIRE 0
 #endif
 
+// Special rules for IDF 5 
+#if defined(ARDUINO) && ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 0, 0)
+#define AUDIOKIT_ESP32_I2S 0
+#endif
+
 // 1 = Using Arduino Wire Library; 0 = Use ESP32 I2C API
 #ifndef AUDIOKIT_USE_WIRE
 #define AUDIOKIT_USE_WIRE 1

src/audio_driver/es7243/es7243.c

@@ -81,11 +81,11 @@ esp_err_t es7243_adc_set_addr(int addr)
 
 static esp_err_t es7243_mclk_active(uint8_t mclk_gpio)
 {
-#ifdef ESP32
+#ifdef ARDUINO
+ pinMode(mclk_gpio, OUTPUT);
+#elif defined(ESP32)
  gpio_pad_select_gpio(mclk_gpio);
  gpio_set_direction(mclk_gpio, GPIO_MODE_OUTPUT);
-#else
- pinMode(mclk_gpio, OUTPUT);
 #endif
  /*
  Before initializing es7243, it is necessary to output

src/audio_hal/audiokit_board.h

@@ -14,8 +14,8 @@
 #include "driver/spi_slave.h"
 #include "driver/spi_master.h"
 #include "driver/i2c.h"
-#include "driver/i2s.h"
 #endif
+
 #include <string.h>
 #include "AudioKitSettings.h"
 #include "audio_hal/audio_error.h"
@@ -157,7 +157,7 @@ class board_driver {
  return ESP_OK;
  }
 
- esp_err_t get_i2s_pins(i2s_port_t port, i2s_pin_config_t* i2s_config)
+ esp_err_t get_i2s_pins(int port, i2s_pin_config_t* i2s_config)
  {
  AUDIO_NULL_CHECK(TAG, i2s_config, return ESP_FAIL);
  if (port == I2S_NUM_0) {
@@ -188,6 +188,7 @@ class board_driver {
  return ESP_OK;
  }
 
+
  esp_err_t get_spi_pins(
  spi_bus_config_t* spi_config, spi_device_interface_config_t* spi_device_interface_config)
  {

src/audio_hal/common_defines.h

@@ -14,7 +14,6 @@
 # include "audio_hal/audio_system.h"
 # include "audio_hal/audio_type_def.h"
 # include "audio_hal/audio_version.h"
-# include "driver/i2s.h"
 # if !defined(CONFIG_IDF_TARGET_ESP32S3) && !defined(CONFIG_IDF_TARGET_ESP32S2) \
  && !defined(CONFIG_IDF_TARGET_ESP32C3)
 SPIClass SPI_VSPI(VSPI);

src/audio_hal/driver_pins.h

@@ -8,13 +8,31 @@
  * @copyright Copyright (c) 2021
 */
 #pragma once
+
 #include "audio_hal/audio_gpio.h"
 #ifdef ESP32
 #include "hal/spi_types.h"
 #include "driver/spi_slave.h"
 #include "driver/spi_master.h"
 #include "driver/i2c.h"
+
+#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 0, 0)
 #include "driver/i2s.h"
+#else
+#define I2S_NUM_0 0
+#ifndef I2S_PIN_NO_CHANGE
+#define I2S_PIN_NO_CHANGE -1
+#endif
+typedef struct {
+ int mck_io_num;
+ int bck_io_num; /*!< BCK in out pin*/
+ int ws_io_num; /*!< WS in out pin*/
+ int data_out_num; /*!< DATA out pin*/
+ int data_in_num; /*!< DATA in pin*/
+} i2s_pin_config_t;
+
+#endif
+
 #endif
 
 #ifdef __cplusplus