CsvStream example

Author: pschatzmann

examples/examples-stream/streams-generator-csv/README.md

@@ -0,0 +1,5 @@
+# I2S Analog Output Test
+
+This is a simple basic test for any processor type
+
+We just send a generated sine wave to the Serial Output

examples/examples-stream/streams-generator-csv/streams-generator-csv.ino

@@ -0,0 +1,37 @@
+/**
+ * @file streams-generator-csv.ino
+ * @author Phil Schatzmann
+ * @brief see https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/examples-stream/streams-generator-csv/README.md 
+ * @copyright GPLv3
+ **/
+ 
+#include "AudioTools.h"
+
+
+uint16_t sample_rate=44100;
+uint8_t channels = 2;                                      // The stream will have 2 channels 
+SineWaveGenerator<int16_t> sineWave(32000);                // subclass of SoundGenerator with max amplitude of 32000
+GeneratedSoundStream<int16_t> sound(sineWave);             // Stream generated from sine wave
+CsvStream<int16_t> out(Serial); 
+StreamCopy copier(out, sound);                             // copies sound into i2s
+
+// Arduino Setup
+void setup(void) {  
+  // Open Serial 
+  Serial.begin(115200);
+  AudioLogger::instance().begin(Serial, AudioLogger::Warning);
+
+  // start the bluetooth
+  auto config = out.defaultConfig();
+  config.sample_rate = sample_rate; 
+  out.begin(config);
+
+  // Setup sine wave
+  sineWave.begin(channels, sample_rate, N_B4);
+  Serial.println("started...");
+}
+
+// Arduino loop - copy sound to out 
+void loop() {
+  copier.copy();
+}

src/AudioTools/AudioOutput.h

@@ -69,21 +69,27 @@ class CsvStream : public AudioPrint, public AudioBaseInfoDependent {
             this->active = active;
         }
 
-        // Starts the processing with 2 channels
+        /// 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
+        /// Provides the default configuration
+        AudioBaseInfo defaultConfig(){
+            AudioBaseInfo info;
+            return info;
+        }
+
+        /// 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 
+        /// Starts the processing with the defined number of channels 
         void begin(int channels, Print &out=Serial){
              LOGD(LOG_METHOD);
             this->channels = channels;
@@ -104,6 +110,7 @@ class CsvStream : public AudioPrint, public AudioBaseInfoDependent {
             this->channels = info.channels;
         };
 
+        /// Writes the data - formatted as CSV -  to the output stream
         virtual size_t write(const uint8_t* data, size_t len) {   
             if (!active) return 0;
             LOGD(LOG_METHOD);