AudioLib adampt examples, cleanup

pschatzmann · pschatzmann · commit 8248001ce56a · 2021-11-15T19:53:46.000+01:00
diff --git a/examples/examples-basic-api/base-file_mp3-a2dp/base-file_mp3-a2dp.ino b/examples/examples-basic-api/base-file_mp3-a2dp/base-file_mp3-a2dp.ino
@@ -15,7 +15,6 @@
 #include <SD.h>
 #include "AudioFileSourceSD.h"
 #include "AudioGeneratorMP3.h"
-#include "AudioESP8266.h"
 #include "BluetoothA2DPSource.h"
 #include "AudioTools.h"
 
diff --git a/examples/examples-basic-api/base-i2s-a2dp/base-i2s-a2dp.ino b/examples/examples-basic-api/base-i2s-a2dp/base-i2s-a2dp.ino
@@ -10,9 +10,7 @@
 // Add this in your sketch or change the setting in AudioConfig.h
 #define USE_A2DP
 
-#include "Arduino.h"
 #include "AudioTools.h"
-#include "AudioA2DP.h"
 
 using namespace audio_tools;  
 
diff --git a/examples/examples-player/player-sd-a2dp/player-sd-a2dp.ino b/examples/examples-player/player-sd-a2dp/player-sd-a2dp.ino
@@ -12,7 +12,6 @@
 #define USE_SDFAT
 
 #include "AudioTools.h"
-#include "AudioA2DP.h"
 #include "AudioCodecs/CodecMP3Helix.h"
 
 using namespace audio_tools;  
diff --git a/examples/examples-stream/streams-analog-serial/streams-analog-serial.ino b/examples/examples-stream/streams-analog-serial/streams-analog-serial.ino
@@ -17,7 +17,7 @@ const uint16_t sample_rate = 44100;
 const uint8_t channels = 2;
 AnalogAudioStream in; 
 CsvStream<int16_t> out(Serial, channels); // ASCII output stream 
-StreamCopy copier(out, in); // copy i2sStream to a2dpStream
+StreamCopy copier(out, in); // copy i2sStream to CsvStream
 ConverterAutoCenter<int16_t> center; // set avg to 0
 
 // Arduino Setup
diff --git a/examples/examples-stream/streams-generator-a2dp/streams-generator-a2dp.ino b/examples/examples-stream/streams-generator-a2dp/streams-generator-a2dp.ino
@@ -12,7 +12,6 @@
 #define USE_A2DP
 
 #include "AudioTools.h"
-#include "AudioA2DP.h"
 
 using namespace audio_tools;  
 
diff --git a/examples/examples-stream/streams-i2s-a2dp/streams-i2s-a2dp.ino b/examples/examples-stream/streams-i2s-a2dp/streams-i2s-a2dp.ino
@@ -10,9 +10,7 @@
 // Add this in your sketch or change the setting in AudioConfig.h
 #define USE_A2DP
 
-#include "Arduino.h"
 #include "AudioTools.h"
-#include "AudioA2DP.h"
 
 using namespace audio_tools;  
 
diff --git a/examples/examples-stream/streams-i2s-csv/README.md b/examples/examples-stream/streams-i2s-csv/README.md
@@ -0,0 +1,32 @@
+
+# Stream I2S Input to CSV Output
+
+## General Description:
+We implement a A2DP source: We stream the sound input which we read in from the I2S interface and displays it on the Arduino Serial Plotter. 
+
+We can use any device which provides the sound data via I2S. In this case it is a 'I2S ADC Audio I2S Capture Card Module'
+
+
+## Pins
+
+![i2s-adc](https://pschatzmann.github.io/arduino-audio-tools/resources/I2S-ADC.jpg)
+
+
+| i2s-ADC |  ESP32
+| --------| ---------------
+| VDD     |  3.3
+| GND     |  GND
+| SD      |  IN (GPIO32)
+| WS      |  WS (GPIO15)
+| SCK     |  BCK (GPIO14)
+
+
+- SCK: Serial data clock for I²S interface
+- WS: Select serial data words for the I²S interface
+- L/R: Left / right channel selection
+        When set to low, the microphone emits signals on the left channel of the I²S frame.
+        When the high level is set, the microphone will send signals on the right channel.
+- ExSD: Serial data output of the I²S interface
+- VCC: input power 1.8V to 3.3V
+- GND: Power groundHigh PSR: -75 dBFS.
+
diff --git a/examples/examples-stream/streams-i2s-csv/streams-i2s-csv.ino b/examples/examples-stream/streams-i2s-csv/streams-i2s-csv.ino
@@ -0,0 +1,44 @@
+/**
+ * @file streams-i2s-csv.ino
+ * @author Phil Schatzmann
+ * @brief see https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/examples-stream/stream-i2s-csv/README.md
+ * 
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ */
+
+
+#include "AudioTools.h"
+
+using namespace audio_tools;  
+ConverterSwapBytes<int32_t> swap;
+ConverterOutlierFilter<int32_t> outlier;
+MultiConverter<int32_t> mc(outlier);
+
+I2SStream i2sStream; // Access I2S as stream
+CsvStream<int32_t> csvStream(Serial);
+//HexDumpStream csvStream(Serial);
+StreamCopy copier(csvStream, i2sStream); // copy i2sStream to csvStream
+
+// Arduino Setup
+void setup(void) {
+    Serial.begin(115200);
+    AudioLogger::instance().begin(Serial, AudioLogger::Info);
+    
+    auto cfg = i2sStream.defaultConfig(RX_MODE);
+    cfg.bits_per_sample = 32;
+    cfg.channels = 2;
+    cfg.sample_rate = 96000;
+    cfg.is_master = false;
+    cfg.i2s_format = I2S_MSB_FORMAT;
+    i2sStream.begin(cfg);
+
+    // make sure that we have the correct channels set up
+    csvStream.begin(cfg);
+
+}
+
+// Arduino loop - copy data
+void loop() {
+    copier.copy(mc);
+}
diff --git a/examples/examples-webserver/streams-effect-webserver_wav/streams-effect-webserver_wav.ino b/examples/examples-webserver/streams-effect-webserver_wav/streams-effect-webserver_wav.ino
@@ -9,7 +9,6 @@
  */
 
 #include "AudioTools.h"
-#include "AudioExperiments.h"
 
 using namespace audio_tools;
 
diff --git a/examples/sandbox/experiment-effect_ads1015-webserver_wav/experiment-effect_ads1015-webserver_wav.ino b/examples/sandbox/experiment-effect_ads1015-webserver_wav/experiment-effect_ads1015-webserver_wav.ino
@@ -9,7 +9,6 @@
  */
 
 #include "AudioTools.h"
-#include "AudioExperiments.h"
 #include "ADS1X15.h"
 
 using namespace audio_tools;
diff --git a/examples/sandbox/streams-a2dp-analog/streams-a2dp-analog.ino b/examples/sandbox/streams-a2dp-analog/streams-a2dp-analog.ino
@@ -10,7 +10,6 @@
 #define USE_A2DP
 
 #include "AudioTools.h"
-#include "AudioA2DP.h"
 
 using namespace audio_tools;  
 
diff --git a/examples/sandbox/streams-a2dp-i2s/streams-a2dp-i2s.ino b/examples/sandbox/streams-a2dp-i2s/streams-a2dp-i2s.ino
@@ -11,7 +11,6 @@
 #define USE_A2DP
 
 #include "AudioTools.h"
-#include "AudioA2DP.h"
 
 using namespace audio_tools;  
 
diff --git a/examples/sandbox/streams-a2dp-serial/streams-a2dp-serial.ino b/examples/sandbox/streams-a2dp-serial/streams-a2dp-serial.ino
@@ -10,9 +10,7 @@
 // Add this in your sketch or change the setting in AudioConfig.h
 #define USE_A2DP
 
-#include "Arduino.h"
 #include "AudioTools.h"
-#include "AudioA2DP.h"
 
 using namespace audio_tools;  
 
diff --git a/examples/sandbox/streams-adc-a2dp/streams-adc-a2dp.ino b/examples/sandbox/streams-adc-a2dp/streams-adc-a2dp.ino
@@ -11,9 +11,7 @@
 // Add this in your sketch or change the setting in AudioConfig.h
 #define USE_A2DP
 
-#include "Arduino.h"
 #include "AudioTools.h"
-#include "AudioA2DP.h"
 
 using namespace audio_tools;  
 
diff --git a/examples/sandbox/streams-mozzi-a2dp/streams-mozzi-a2dp.ino b/examples/sandbox/streams-mozzi-a2dp/streams-mozzi-a2dp.ino
@@ -12,8 +12,6 @@
 #define USE_MOZZI
 
 #include "AudioTools.h"
-#include "AudioA2DP.h"
-#include "AudioMozzi.h"
 #include <Oscil.h>
 #include <tables/cos2048_int8.h> // table for Oscils to play
 #include <mozzi_fixmath.h>
diff --git a/examples/sandbox/streams-stk-a2dp/streams-STK-a2dp.ino b/examples/sandbox/streams-stk-a2dp/streams-STK-a2dp.ino
@@ -10,10 +10,7 @@
 #define USE_A2DP
 #define USE_STK
 
-#include "Arduino.h"
 #include "AudioTools.h"
-#include "AudioSTK.h"
-#include "AudioA2DP.h"
 #include "Clarinet.h"
 
 using namespace audio_tools;  
diff --git a/examples/sandbox/streams-stk-analog/streams-stk-analog.ino b/examples/sandbox/streams-stk-analog/streams-stk-analog.ino
@@ -10,10 +10,7 @@
 #define USE_A2DP
 #define USE_STK
 
-#include "Arduino.h"
 #include "AudioTools.h"
-#include "AudioSTK.h"
-#include "AudioA2DP.h"
 #include "Clarinet.h"
 
 using namespace audio_tools;  
diff --git a/src/AudioI2S/I2SConfig.h b/src/AudioI2S/I2SConfig.h
@@ -4,6 +4,18 @@
 
 namespace audio_tools {
 
+enum I2SFormat {
+  I2S_STD_FORMAT,
+  I2S_LSB_FORMAT,
+  I2S_MSB_FORMAT,
+  I2S_PHILIPS_FORMAT,
+  I2S_RIGHT_JUSTIFIED_FORMAT,
+  I2S_LEFT_JUSTIFIED_FORMAT,
+  I2S_PCM_LONG,
+  I2S_PCM_SHORT
+};
+
+
 /**
  * @brief configuration for all common i2s settings
  * @author Phil Schatzmann
diff --git a/src/AudioI2S/I2SESP32.h b/src/AudioI2S/I2SESP32.h
@@ -220,6 +220,11 @@ class I2SBase {
           case I2S_MSB_FORMAT:
           case I2S_LEFT_JUSTIFIED_FORMAT:
             return (i2s_comm_format_t) I2S_COMM_FORMAT_STAND_MSB;
+          case I2S_PCM_LONG:
+            return (i2s_comm_format_t) I2S_COMM_FORMAT_PCM_LONG;
+          case I2S_PCM_SHORT:
+            return (i2s_comm_format_t) I2S_COMM_FORMAT_PCM_SHORT;
+
           default:
             LOGE("unsupported mode");
             return (i2s_comm_format_t) I2S_COMM_FORMAT_STAND_I2S;
diff --git a/src/AudioPWM/PWMAudioBase.h b/src/AudioPWM/PWMAudioBase.h
@@ -84,7 +84,7 @@ struct PWMConfig : public AudioBaseInfo {
  * @brief Common functionality for PWM output
  * 
  */
-class PWMAudioStreamBase : public AudioPrint {
+class PWMAudioStreamBase : public AudioPrint, public AudioBaseInfoDependent {
     public:
         ~PWMAudioStreamBase(){
             if (is_timer_started){
diff --git a/src/AudioTools/AudioOutput.h b/src/AudioTools/AudioOutput.h
@@ -69,17 +69,21 @@ class CsvStream : public AudioPrint, public AudioBaseInfoDependent {
             this->active = active;
         }
 
+        // Starts the processing with 2 channels
         void begin(){
              LOGD(LOG_METHOD);
             this->active = true;
+            this->channels = 2;
         }
 
+        // Starts the processing with the number of channels defined in AudioBaseInfo
         void begin(AudioBaseInfo info){
              LOGD(LOG_METHOD);
             this->active = true;
             this->channels = info.channels;
         }
 
+        // Starts the processing with the defined number of channels 
         void begin(int channels, Print &out=Serial){
              LOGD(LOG_METHOD);
             this->channels = channels;
@@ -102,12 +106,14 @@ class CsvStream : public AudioPrint, public AudioBaseInfoDependent {
 
         virtual size_t write(const uint8_t* data, size_t len) {   
             if (!active) return 0;
-             LOGD(LOG_METHOD);
+            LOGD(LOG_METHOD);
             size_t lenChannels = len / (sizeof(T)*channels); 
             data_ptr = (T*)data;
             for (int j=0;j<lenChannels;j++){
                 for (int ch=0;ch<channels;ch++){
-                    out_ptr->print(*data_ptr);
+                    if (out_ptr!=nullptr && data_ptr!=nullptr){
+                        out_ptr->print(*data_ptr);
+                    }
                     data_ptr++;
                     if (ch<channels-1) Serial.print(", ");
                 }
@@ -142,6 +148,13 @@ class HexDumpStream : public AudioPrint {
             this->active = active;
         }
 
+        void begin(AudioBaseInfo info){
+            LOGD(LOG_METHOD);
+            info.logInfo();
+            this->active = true;
+            pos = 0;
+        }
+
         void begin(){
              LOGD(LOG_METHOD);
             this->active = true;
diff --git a/src/AudioTools/AudioRuntime.h b/src/AudioTools/AudioRuntime.h
@@ -1,8 +1,26 @@
 #pragma once
+/**
+ * @brief Public generic methods 
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ */
 
-inline static void checkMemory(bool stackCheck=false){
-#ifdef ESP32
-    assert(heap_caps_check_integrity_all(true)); 
-    if (stackCheck) printf("stack available: %d \n'", uxTaskGetStackHighWaterMark(NULL));
-#endif    
+
+/// stops any further processing by spinning in an endless loop
+void stop() {
+  #ifdef EXIT_ON_STOP
+    exit(0);
+  #else
+    while(true){
+      delay(1000);
+    }
+  #endif
+}
+
+/// Executes heap_caps_check_integrity_all()
+inline static void checkMemory(bool stackCheck=false) {
+    #ifdef ESP32
+        assert(heap_caps_check_integrity_all(true)); 
+        if (stackCheck) printf("stack available: %d \n'", uxTaskGetStackHighWaterMark(NULL));
+    #endif    
 }
diff --git a/src/AudioTools/AudioTypes.h b/src/AudioTools/AudioTypes.h
diff --git a/src/AudioTools/Converter.h b/src/AudioTools/Converter.h
diff --git a/src/AudioTools/Int24.h b/src/AudioTools/Int24.h
diff --git a/tests/build-examples-log.txt b/tests/build-examples-log.txt
