Lyrat Using AI_THINKER_ES8388_VOLUME_HACK=3

Author: pschatzmann

src/AudioBoard.h

@@ -120,9 +120,9 @@ static AudioBoard AudioKitEs8388V2{AudioDriverES8388, PinsAudioKitEs8388v2};
 /// @ingroup audio_driver
 static AudioBoard AudioKitAC101{AudioDriverAC101, PinsAudioKitAC101};
 /// @ingroup audio_driver
-static AudioBoard LyratV43{AudioDriverES8388, PinsLyrat43};
+static AudioBoard LyratV43{AudioDriverES8388H3, PinsLyrat43};
 /// @ingroup audio_driver
-static AudioBoard LyratV42{AudioDriverES8388, PinsLyrat42};
+static AudioBoard LyratV42{AudioDriverES8388H3, PinsLyrat42};
 /// @ingroup audio_driver
 static AudioBoard LyratMini{AudioDriverLyratMini, PinsLyratMini};
 /// @ingroup audio_driver

src/Driver.h

@@ -202,7 +202,7 @@ class AudioDriver {
     setupI2CAddress();
 
     p_pins->setSPIActiveForSD(codec_cfg.sd_active);
-    if (!p_pins->begin()){
+    if (!p_pins->begin()) {
       AD_LOGE("AudioBoard::pins::begin failed");
       return false;
     }
@@ -802,6 +802,10 @@ class AudioDriverES8374Class : public AudioDriver {
  */
 class AudioDriverES8388Class : public AudioDriver {
  public:
+  AudioDriverES8388Class(int volumeHack) {
+    i2c_default_address = 0x10;
+    volume_hack = volumeHack;
+  }
   AudioDriverES8388Class() { i2c_default_address = 0x10; }
   bool setMute(bool mute) {
     line_active[0] = !mute;
@@ -879,11 +883,16 @@ class AudioDriverES8388Class : public AudioDriver {
 
   bool isInputVolumeSupported() { return true; }
 
+  void setVolumeHack(int volume_hack) { this->volume_hack = volume_hack; }
+  int getVolumeHack() { return volume_hack; }
+
  protected:
   bool line_active[2] = {true};
+  int volume_hack = AI_THINKER_ES8388_VOLUME_HACK;
 
   bool init(codec_config_t codec_cfg) {
-    return es8388_init(&codec_cfg, getI2C(), getI2CAddress()) == RESULT_OK;
+    return es8388_init(&codec_cfg, getI2C(), getI2CAddress(), volume_hack) ==
+           RESULT_OK;
   }
   bool deinit() { return es8388_deinit() == RESULT_OK; }
 
@@ -968,7 +977,8 @@ class AudioDriverWM8960Class : public AudioDriver {
   /// Defines the Volume (in %) if volume is 0, mute is enabled,range is 0-100.
   bool setVolume(int volume) {
     volume_out = limitValue(volume, 0, 100);
-    int vol_int = volume_out == 0.0 ? 0 : mapVolume(volume_out, 0, 100, 30, 0x7F);
+    int vol_int =
+        volume_out == 0.0 ? 0 : mapVolume(volume_out, 0, 100, 30, 0x7F);
     return mtb_wm8960_set_output_volume(vol_int);
   }
 
@@ -1540,6 +1550,14 @@ static AudioDriverES8374Class AudioDriverES8374;
 /// @ingroup audio_driver
 static AudioDriverES8388Class AudioDriverES8388;
 /// @ingroup audio_driver
+static AudioDriverES8388Class AudioDriverES8388H0{0};
+/// @ingroup audio_driver
+static AudioDriverES8388Class AudioDriverES8388H1{1};
+/// @ingroup audio_driver
+static AudioDriverES8388Class AudioDriverES8388H2{2};
+/// @ingroup audio_driver
+static AudioDriverES8388Class AudioDriverES8388H3{3};
+/// @ingroup audio_driver
 static AudioDriverWM8960Class AudioDriverWM8960;
 /// @ingroup audio_driver
 static AudioDriverWM8978Class AudioDriverWM8978;

src/Driver/es8388/es8388.c

@@ -43,6 +43,7 @@ typedef enum {
 static i2c_bus_handle_t i2c_handle = NULL;
 static int dac_power = 0x3c;
 static int address = ES8388_ADDR;
+static int esp8388_volume_hack = AI_THINKER_ES8388_VOLUME_HACK;
 
 #define ES_ASSERT(a, format, b, ...) \
   if ((a) != 0) {                    \
@@ -260,9 +261,10 @@ error_t es8388_deinit(void) {
  *     - (-1)  Error
  *     - (0)   Success
  */
-error_t es8388_init(codec_config_t *cfg, i2c_bus_handle_t handle, int addr) {
+error_t es8388_init(codec_config_t *cfg, i2c_bus_handle_t handle, int addr, int volumeHack) {
   AD_TRACED();
   i2c_handle = handle;
+  esp8388_volume_hack = volumeHack;
   // set address
   if (addr>0) address = addr;
 
@@ -389,17 +391,25 @@ error_t es8388_config_fmt(codec_mode_t mode, i2s_format_t fmt) {
   return res;
 }
 
-/**
- * @brief Sets the output volume
- * @param volume: 0 ~ 100
- *
- * @return
- *     - (-1)  Error
- *     - (0)   Success
- */
-#if AI_THINKER_ES8388_VOLUME_HACK == 1
+error_t es8388_set_voice_volume_0(int volume) {
+  AD_LOGD("es8388_set_voice_volume: %d", volume);
+  error_t res = RESULT_OK;
+  if (volume < 0)
+    volume = 0;
+  else if (volume > 100)
+    volume = 100;
+  volume /= 3;
+  // ROUT1VOL LOUT1VOL 0 -> -45dB; 33 -> – 4.5dB
+  res = es_write_reg(address, ES8388_DACCONTROL24, volume);
+  res |= es_write_reg(address, ES8388_DACCONTROL25, volume);
+  // DAC LDACVOL RDACVOL default 0 = 0DB; Default value 192 = – -96 dB
+  res |= es_write_reg(address, ES8388_DACCONTROL26, 0);
+  res |= es_write_reg(address, ES8388_DACCONTROL27, 0);
+  return res;
+}
 
-error_t es8388_set_voice_volume(int volume) {
+
+error_t es8388_set_voice_volume_1(int volume) {
   AD_LOGD("es8388_set_voice_volume (HACK 1): %d", volume);
   error_t res = RESULT_OK;
   if (volume < 0)
@@ -419,9 +429,8 @@ error_t es8388_set_voice_volume(int volume) {
   return res;
 }
 
-#elif AI_THINKER_ES8388_VOLUME_HACK == 2
 
-error_t es8388_set_voice_volume(int volume) {
+error_t es8388_set_voice_volume_2(int volume) {
   AD_LOGD("es8388_set_voice_volume (HACK 2): %d", volume);
   error_t res = RESULT_OK;
   if (volume < 0)
@@ -441,25 +450,28 @@ error_t es8388_set_voice_volume(int volume) {
   return res;
 }
 
-#else
+/**
+ * @brief Sets the output volume
+ * @param volume: 0 ~ 100
+ *
+ * @return
+ *     - (-1)  Error
+ *     - (0)   Success
+ */
+
+ error_t es8388_set_voice_volume(int volume) {
+  switch(esp8388_volume_hack) {
+    case 0:
+      return es8388_set_voice_volume_0(volume);
+    case 1:
+      return es8388_set_voice_volume_1(volume);
+    case 2:
+      return es8388_set_voice_volume_2(volume);
+    default:
+      return es8388_set_voice_volume_0(volume);
+  }
+ }
 
-error_t es8388_set_voice_volume(int volume) {
-  AD_LOGD("es8388_set_voice_volume: %d", volume);
-  error_t res = RESULT_OK;
-  if (volume < 0)
-    volume = 0;
-  else if (volume > 100)
-    volume = 100;
-  volume /= 3;
-  // ROUT1VOL LOUT1VOL 0 -> -45dB; 33 -> – 4.5dB
-  res = es_write_reg(address, ES8388_DACCONTROL24, volume);
-  res |= es_write_reg(address, ES8388_DACCONTROL25, volume);
-  // DAC LDACVOL RDACVOL default 0 = 0DB; Default value 192 = – -96 dB
-  res |= es_write_reg(address, ES8388_DACCONTROL26, 0);
-  res |= es_write_reg(address, ES8388_DACCONTROL27, 0);
-  return res;
-}
-#endif
 
 /**
  * Provides the volume

src/Driver/es8388/es8388.h

@@ -107,7 +107,6 @@ typedef enum {
   ESP8388_INPUT_MAX,
 } es8388_input_device_t;
 
-
 /**
  * @brief Initialize ES8388 codec chip
  *
@@ -117,7 +116,7 @@ typedef enum {
  *     - RESULT_OK
  *     - RESULT_FAIL
  */
-error_t es8388_init(codec_config_t *cfg, i2c_bus_handle_t handle, int addr);
+error_t es8388_init(codec_config_t *cfg, i2c_bus_handle_t handle, int addr, int volumeHack);
 
 /**
  * @brief Deinitialize ES8388 codec chip