ESP32 onboard ADC for more than 2 channels. (#1633)

uutzinger · web-flow · commit 8fbfefb17ff5 · 2024-07-27T07:56:15.000+02:00
* Reapply previous changes

* Updating ESP32 continuous ADC driver

work in progress

* ESP32 onboard ADC, multichannel sorted

1-6 channels tested on ESP32 module
other modules not tested yet
diff --git a/examples/README_ESP32.md b/examples/README_ESP32.md
@@ -1,13 +1,12 @@
 # ESP32 Configuration
 
 If you are using ESP32 by Espressif Systems version 3.0.0 and later, audio tools will use the new adc_continuous API.
-This board option is under development and changing.
 
 For the adc_continuous API, audio tools provides the following options:
 
 - **sample_rate** (per channel), the effective ADC sampling rate is the number of channels x sample rate and can be:
     - ESP32: 20kHz to 2MHz
-    - other ESP32 eg. ESP32S3 611Hz to 83kHz
+    - ESP32 S2, S3, H2, C6, C3: 611Hz to 83.333kHz
 
 for example:
 
@@ -55,6 +54,12 @@ for example:
     - D5 on Adafruit ESP32-S3 is ADC_CHANNEL_4
     - D6 on Adafruit ESP32-S3 is ADC_CHANNEL_5
 
+- **buffer_size**
+    - maximum is 2048
+    - minimum is number of channels
+    - number needs to be devisible by number of channels
+    - care must be taken because some streams in audio tools can not exceed 1024 bytes
+
 ## Example Configuration
 ```
 auto adcConfig = adc.defaultConfig(RX_MODE);
diff --git a/examples/tests/adc/read-esp32-multi-channel-csv/read-esp32-multi-channel-csv.ino b/examples/tests/adc/read-esp32-multi-channel-csv/read-esp32-multi-channel-csv.ino
@@ -0,0 +1,89 @@
+/**
+ * @file read-esp32-multi-channel-csv.ino
+ * @author Urs Utzinger
+ * @copyright GPLv3
+ */
+
+// | attenuation     | range   | accurate range |
+// | ------------    | --------| -------------- |
+// | ADC_ATTEN_DB_0  | 0..1.1V | 100-950mV      |
+// | ADC_ATTEN_DB_2_5| 0..1.5V | 100-1250mV     |
+// | ADC_ATTEN_DB_6  | 0..2.2V | 150-1750mV     |
+// | ADC_ATTEN_DB_12 | 0..3.9V | 150-2450mV     |
+
+#include "Arduino.h"
+#include "AudioTools.h"
+
+#define NUM_CHANNELS 6                          // number of channels
+#define DEC_FACTOR 48                           // decimating
+#define ADC_ATTENUATION ADC_ATTEN_DB_11         // ADC attenuation, see above
+#define ADC_BIT_WIDTH 12                        // the ADC bit width 9..12, values will be stored in 16 bit integers
+#define BIT_DEPTH 16                            // default bit width of data returned from analgo_in. Do not change.
+
+// It looks like Buffer larger than 1024 is capped by stream copy for decimater or csvoutput
+#define BUFFER_SIZE_FACTOR (1024/ (NUM_CHANNELS*DEC_FACTOR*BIT_DEPTH/8)) // 3.5
+#define ADC_BUFFER_SIZE (NUM_CHANNELS*DEC_FACTOR*BUFFER_SIZE_FACTOR) // Total number of samples (not bytes), needs to be divisible by 4 // 3*3*96 = 864
+#define BUFFER_SIZE ADC_BUFFER_SIZE*BIT_DEPTH/8 // Number of bytes for processing buffer
+#define SERIAL_BUFFER_SIZE BUFFER_SIZE/DEC_FACTOR   // There will be factor times less data after decimating
+
+// Sampling rates
+#define SERIAL_SAMPLE_RATE 300                           // samples per channel per second
+#define SAMPLE_RATE        SERIAL_SAMPLE_RATE*DEC_FACTOR // number of samples per channel before decimating
+#define ADC_SAMPLE_RATE    SAMPLE_RATE*NUM_CHANNELS      // actual sampling rate of ADC
+// BAUD rate required: SERIAL_SAMPLE_RATE * (NUM_CHANNELS * approx 6 chars + 2 EOL) * 10  approx 40,000 baud
+
+#define ADC0 ADC_CHANNEL_7 // ADC channel 0
+#define ADC1 ADC_CHANNEL_0 // ADC channel 1
+#define ADC2 ADC_CHANNEL_3 // ADC channel 2
+#define ADC3 ADC_CHANNEL_6 // ADC channel 3
+#define ADC4 ADC_CHANNEL_4 // ADC channel 4
+#define ADC5 ADC_CHANNEL_5 // ADC channel 5
+#define ADC6 ADC_CHANNEL_1 // ADC channel 6, not routed on the ESP32 WROOM module
+#define ADC7 ADC_CHANNEL_2 // ADC channel 7, not routed on ESP32 WROOM module
+#define ADC8 ADC_CHANNEL_8 // ADC channel 8, only ESP32S3,S2
+#define ADC9 ADC_CHANNEL_9 // ADC channel 9, only ESP32S3,S2
+
+AudioInfo                     info_serial(SERIAL_SAMPLE_RATE, NUM_CHANNELS, BIT_DEPTH);
+
+AnalogAudioStream             analog_in; // on board analog to digital converter
+Decimate                      decimater(DEC_FACTOR, NUM_CHANNELS, BIT_DEPTH); // skip samples
+ConverterStream<int16_t>      decimated_stream(analog_in, decimater); // pipe the sound to the decimater
+CsvOutput<int16_t>            serial_out(Serial, NUM_CHANNELS, SERIAL_BUFFER_SIZE); // serial output
+StreamCopy                    copier(serial_out, decimated_stream, BUFFER_SIZE); // stream the decimated output to serial port
+
+// Arduino Setup
+void setup(void) {
+
+  Serial.begin(115200);
+  while (!Serial);
+
+  // Include logging to serial, If you want no logging comment this line
+  AudioLogger::instance().begin(Serial, AudioLogger::Warning); // Error, Warning, Info, Debug
+
+  auto adcConfig = analog_in.defaultConfig(RX_MODE);
+
+  // For ESP32 by Espressif Systems version 3.0.0 and later:
+  // see examples/README_ESP32.md
+  adcConfig.sample_rate = SAMPLE_RATE;                          // sample rate per channel
+  adcConfig.channels = NUM_CHANNELS;                            // up to 6 channels
+  adcConfig.adc_bit_width = ADC_BIT_WIDTH;                      // Supports only 12
+  adcConfig.buffer_size = ADC_BUFFER_SIZE;                      // in total number of samples
+  adcConfig.adc_calibration_active = true;                      // use and apply the calibration settings of ADC stored in ESP32
+  adcConfig.is_auto_center_read = false;                        // do not engage auto-centering of signal (would subtract average of signal)
+  adcConfig.adc_attenuation = ADC_ATTENUATION;                  // set analog input range
+  adcConfig.adc_channels[0] = ADC0;                             // ensure configuration for each channel
+  adcConfig.adc_channels[1] = ADC1;
+  adcConfig.adc_channels[2] = ADC2; 
+  adcConfig.adc_channels[3] = ADC3; 
+  adcConfig.adc_channels[4] = ADC4; 
+  adcConfig.adc_channels[5] = ADC5; 
+
+  analog_in.begin(adcConfig);
+  serial_out.begin(info_serial);
+
+}
+
+// Arduino loop 
+void loop() {
+  copier.copy();
+}
diff --git a/examples/tests/conversion/channel-converter-decimate/channel-converter-decimate.ino b/examples/tests/conversion/channel-converter-decimate/channel-converter-decimate.ino
@@ -10,16 +10,16 @@
 
 AudioInfo                     info1(44100, 1, 16);
 AudioInfo                     info2(44100, 2, 16);
-AudioInfo                     infoO(44100/FACTOR, 2, 16);
-SineWaveGenerator<int16_t>    sineWave1(16000);         // subclass of SoundGenerator with max amplitude of 32000
-SineWaveGenerator<int16_t>    sineWave2(16000);         // subclass of SoundGenerator with max amplitude of 32000
-GeneratedSoundStream<int16_t> sound1(sineWave1);         // stream generated from sine wave
-GeneratedSoundStream<int16_t> sound2(sineWave2);         // stream generated from sine wave
-InputMerge<int16_t>           imerge;
-Decimate                      decimater;        // decimate by 4 on 1 channel
-ConverterStream<int16_t>      decimated_stream(imerge, decimater);  // pipe the sound to the binner
-CsvOutput<int16_t>            serial_out(Serial);             // serial output
-StreamCopy                    copier(serial_out, decimated_stream);    // stream the binner output to serial port
+AudioInfo                     info_out(44100/FACTOR, 2, 16);
+SineWaveGenerator<int16_t>    sineWave1(16000); // subclass of SoundGenerator with max amplitude of 16000
+SineWaveGenerator<int16_t>    sineWave2(16000); // subclass of SoundGenerator with max amplitude of 16000
+GeneratedSoundStream<int16_t> sound1(sineWave1); // stream generated from sine wave
+GeneratedSoundStream<int16_t> sound2(sineWave2); // stream generated from sine wave
+InputMerge<int16_t>           imerge(sound1,sound2);
+Decimate                      decimater(FACTOR, 2, 16);  // decimate by FACTOR on each channel
+ConverterStream<int16_t>      decimated_stream(imerge, decimater);  // pipe the sounds to the decimater
+CsvOutput<int16_t>            serial_out(Serial);  // serial output
+StreamCopy                    copier(serial_out, decimated_stream); // stream the decimater output to serial port
 
 // Arduino Setup
 void setup(void) {  
@@ -30,25 +30,19 @@ void setup(void) {
 
   AudioLogger::instance().begin(Serial, AudioLogger::Warning);
 
-  //
-  decimater.setChannels(2);
-  decimater.setFactor(FACTOR);
-
-  // Merge input to stereo
-  imerge.add(sound1);
-  imerge.add(sound2);
-  imerge.begin(info2);
-
   // Setup sine wave
   sineWave1.begin(info1, N_B4);
   sineWave2.begin(info1, N_B5);
 
+  // Merge input to stereo
+  imerge.begin(info2);
+
   // Define CSV Output
-  serial_out.begin(infoO);
+  serial_out.begin(info_out);
 
  }
 
 // Arduino loop - copy sound to out with conversion
 void loop() {
   copier.copy();
-}
+}
diff --git a/src/AudioAnalog/AnalogConfigESP32V1.h b/src/AudioAnalog/AnalogConfigESP32V1.h
@@ -12,44 +12,72 @@
 #if CONFIG_IDF_TARGET_ESP32
 #  define ADC_CONV_MODE       ADC_CONV_SINGLE_UNIT_1
 #  define ADC_OUTPUT_TYPE     ADC_DIGI_OUTPUT_FORMAT_TYPE1
-#  define ADC_CHANNELS        {ADC_CHANNEL_7, ADC_CHANNEL_0, ADC_CHANNEL_3, ADC_CHANNEL_6, ADC_CHANNEL_4, ADC_CHANNEL_5}
+#  define ADC_CHANNELS        {ADC_CHANNEL_0, ADC_CHANNEL_3, ADC_CHANNEL_4, ADC_CHANNEL_5, ADC_CHANNEL_6, ADC_CHANNEL_7}
+#  define NUM_ADC_CHANNELS    6 
 #  define AUDIO_ADC_GET_CHANNEL(p_data)     ((p_data)->type1.channel)
 #  define AUDIO_ADC_GET_DATA(p_data)        ((p_data)->type1.data)
 #  define HAS_ESP32_DAC
+#  define ADC_CHANNEL_TYPE    uint16_t
+#  define ADC_DATA_TYPE       uint16_t
 #elif CONFIG_IDF_TARGET_ESP32S2
 #  define ADC_CONV_MODE       ADC_CONV_SINGLE_UNIT_1
 #  define ADC_OUTPUT_TYPE     ADC_DIGI_OUTPUT_FORMAT_TYPE2
 #  define AUDIO_ADC_GET_CHANNEL(p_data)     ((p_data)->type2.channel)
 #  define AUDIO_ADC_GET_DATA(p_data)        ((p_data)->type2.data)
-#  define ADC_CHANNELS        {ADC_CHANNEL_7, ADC_CHANNEL_0, ADC_CHANNEL_3, ADC_CHANNEL_6, ADC_CHANNEL_4, ADC_CHANNEL_5}
+#  define ADC_CHANNELS        {ADC_CHANNEL_0, ADC_CHANNEL_1, ADC_CHANNEL_2, ADC_CHANNEL_3, ADC_CHANNEL_4, ADC_CHANNEL_5, ADC_CHANNEL_6, ADC_CHANNEL_7, ADC_CHANNEL_8, ADC_CHANNEL_9}
+#  define NUM_ADC_CHANNELS    10
 #  define HAS_ESP32_DAC
+#  define ADC_CHANNEL_TYPE    uint16_t
+#  define ADC_DATA_TYPE       uint16_t
 #elif CONFIG_IDF_TARGET_ESP32C3 || CONFIG_IDF_TARGET_ESP32H2 || CONFIG_IDF_TARGET_ESP32C2 || CONFIG_IDF_TARGET_ESP32C6
 #  define ADC_CONV_MODE       ADC_CONV_ALTER_UNIT     //ESP32C3 only supports alter mode
 #  define ADC_OUTPUT_TYPE     ADC_DIGI_OUTPUT_FORMAT_TYPE2
 #  define AUDIO_ADC_GET_CHANNEL(p_data)     ((p_data)->type2.channel)
 #  define AUDIO_ADC_GET_DATA(p_data)        ((p_data)->type2.data)
-#  define ADC_CHANNELS       {ADC_CHANNEL_7, ADC_CHANNEL_0, ADC_CHANNEL_3, ADC_CHANNEL_6, ADC_CHANNEL_4, ADC_CHANNEL_5}
+#  define ADC_CHANNELS        {ADC_CHANNEL_0, ADC_CHANNEL_1, ADC_CHANNEL_2, ADC_CHANNEL_3, ADC_CHANNEL_4}
+#  define NUM_ADC_CHANNELS    5
+#  define ADC_CHANNEL_TYPE    uint32_t
+#  define ADC_DATA_TYPE       uint32_t
+#elif CONFIG_IDF_TARGET_ESP32C6
+#  define ADC_CONV_MODE       ADC_CONV_ALTER_UNIT
+#  define ADC_OUTPUT_TYPE     ADC_DIGI_OUTPUT_FORMAT_TYPE2
+#  define AUDIO_ADC_GET_CHANNEL(p_data)     ((p_data)->type2.channel)
+#  define AUDIO_ADC_GET_DATA(p_data)        ((p_data)->type2.data)
+#  define ADC_CHANNELS        {ADC_CHANNEL_0, ADC_CHANNEL_1, ADC_CHANNEL_2, ADC_CHANNEL_3, ADC_CHANNEL_4, ADC_CHANNEL_5, ADC_CHANNEL_6}
+#  define NUM_ADC_CHANNELS    7
+#  define ADC_CHANNEL_TYPE    uint32_t
+#  define ADC_DATA_TYPE       uint32_t
 #elif CONFIG_IDF_TARGET_ESP32S3
 #  define ADC_CONV_MODE       ADC_CONV_SINGLE_UNIT_1
 #  define ADC_OUTPUT_TYPE     ADC_DIGI_OUTPUT_FORMAT_TYPE2
 #  define AUDIO_ADC_GET_CHANNEL(p_data)     ((p_data)->type2.channel)
 #  define AUDIO_ADC_GET_DATA(p_data)        ((p_data)->type2.data)
-#  define ADC_CHANNELS        {ADC_CHANNEL_8, ADC_CHANNEL_9, ADC_CHANNEL_4, ADC_CHANNEL_5, ADC_CHANNEL_4, ADC_CHANNEL_5}
+#  define ADC_CHANNELS        {ADC_CHANNEL_0, ADC_CHANNEL_1, ADC_CHANNEL_2, ADC_CHANNEL_3, ADC_CHANNEL_4, ADC_CHANNEL_5, ADC_CHANNEL_6, ADC_CHANNEL_7, ADC_CHANNEL_8, ADC_CHANNEL_9}
+#  define NUM_ADC_CHANNELS    10
+#  define ADC_CHANNEL_TYPE    uint32_t
+#  define ADC_DATA_TYPE       uint32_t
+#elif CONFIG_IDF_TARGET_ESP32P4
+#  define ADC_CONV_MODE       ADC_CONV_SINGLE_UNIT_1
+#  define ADC_OUTPUT_TYPE     ADC_DIGI_OUTPUT_FORMAT_TYPE2
+#  define AUDIO_ADC_GET_CHANNEL(p_data)     ((p_data)->type2.channel)
+#  define AUDIO_ADC_GET_DATA(p_data)        ((p_data)->type2.data)
+#  define ADC_CHANNELS        {ADC_CHANNEL_0, ADC_CHANNEL_1, ADC_CHANNEL_2, ADC_CHANNEL_3, ADC_CHANNEL_4, ADC_CHANNEL_5, ADC_CHANNEL_6, ADC_CHANNEL_7}
+#  define NUM_ADC_CHANNELS    8
+#  define ADC_CHANNEL_TYPE    uint32_t
+#  define ADC_DATA_TYPE       uint32_t
 #endif
 
-// #define GET_ADC_UNIT_FROM_CHANNEL(x) ((x >> 3) & 0x1)
-#  define ADC_UNIT            ADC_UNIT_1 // continuous ADC API only supports ADC1
+// continuous ADC API should run on ADC1
 
+#  define ADC_UNIT            ADC_UNIT_1 
 #ifdef HAS_ESP32_DAC
 #  include "driver/dac_continuous.h"
 #endif
 
 namespace audio_tools {
 
 /**
- * @brief ESP32 specific configuration for i2s input via adc using the 
- * adc_continuous API
- * 
+ * @brief ESP32 specific configuration for i2s input via adc using the adc_continuous API
  * @author Phil Schatzmann
  * @ingroup platform
  * @copyright GPLv3
@@ -63,12 +91,12 @@ class AnalogConfigESP32V1 : public AudioInfo {
     RxTxMode rx_tx_mode;
     TickType_t timeout = portMAX_DELAY;
 
-#ifdef HAS_ESP32_DAC
-    bool is_blocking_write = true;
-    bool use_apll = false;
-    /// ESP32: DAC_CHANNEL_MASK_CH0 or DAC_CHANNEL_MASK_CH1
-    dac_channel_mask_t dac_mono_channel = DAC_CHANNEL_MASK_CH0;
-#endif
+    #ifdef HAS_ESP32_DAC
+      bool is_blocking_write = true;
+      bool use_apll = false;
+      /// ESP32: DAC_CHANNEL_MASK_CH0 or DAC_CHANNEL_MASK_CH1
+      dac_channel_mask_t dac_mono_channel = DAC_CHANNEL_MASK_CH0;
+    #endif
 
     // ADC config parameters
     bool adc_calibration_active = false;
@@ -77,7 +105,8 @@ class AnalogConfigESP32V1 : public AudioInfo {
     adc_digi_output_format_t adc_output_type = ADC_OUTPUT_TYPE;
     uint8_t adc_attenuation = ADC_ATTEN_DB_12; // full voltage range of 3.9V
     uint8_t adc_bit_width = SOC_ADC_DIGI_MAX_BITWIDTH;
-    adc_channel_t adc_channels[6] = ADC_CHANNELS;
+
+    adc_channel_t adc_channels[NUM_ADC_CHANNELS] = ADC_CHANNELS;
 
     /// Default constructor
     AnalogConfigESP32V1(RxTxMode rxtxMode=TX_MODE) {
@@ -113,5 +142,6 @@ class AnalogConfigESP32V1 : public AudioInfo {
 using AnalogConfig = AnalogConfigESP32V1;
 #endif
 
-} // ns
+} // namespace audio_tools
+
 #endif
diff --git a/src/AudioAnalog/AnalogDriverESP32V1.h b/src/AudioAnalog/AnalogDriverESP32V1.h
diff --git a/src/AudioTools/BaseConverter.h b/src/AudioTools/BaseConverter.h
