[BACKUP] Latest experiments with internal buffer

Author: PilnyTomas

Diff for: libraries/I2S/examples/ADCPlotter/ADCPlotter.ino

@@ -1,5 +1,6 @@
 /*
- This example is only for ESP devices
+ This example is only for ESP devices.
+
  This example demonstrates usage of integrated Digital to Analog Converter (DAC)
  You can display sound wave from audio device, or just measure voltage.
 
@@ -41,20 +42,20 @@ Second option to measure voltage on trimmer / potentiometer has following connec
                       |
                       |
                       V GND
-Optional resistor will decrease read value.
+ Optional resistor will decrease read value.
 
-Steps to run:
-1. Select target board:
-  Tools -> Board -> ESP32 Arduino -> your board
-2. Upload sketch
-  Press upload button (arrow in top left corner)
-  When you see in console line like this: "Connecting........_____.....__"
-    On your board press and hold Boot button and press EN button shortly. Now you can release both buttons.
-    You should see lines like this: "Writing at 0x00010000... (12 %)" with rising percentage on each line.
-    If this fails, try the board buttons right after pressing upload button, or reconnect the USB cable.
-3. Open plotter
-  Tools -> Serial Plotter
-    Enjoy
+ Steps to run:
+ 1. Select target board:
+   Tools -> Board -> ESP32 Arduino -> your board
+ 2. Upload sketch
+   Press upload button (arrow in top left corner)
+   When you see in console line like this: "Connecting........_____.....__"
+     On your board press and hold Boot button and press EN button shortly. Now you can release both buttons.
+     You should see lines like this: "Writing at 0x00010000... (12 %)" with rising percentage on each line.
+     If this fails, try the board buttons right after pressing upload button, or reconnect the USB cable.
+ 3. Open plotter
+   Tools -> Serial Plotter
+     Enjoy
 
 Created by Tomas Pilny
 on 17th June 2021
@@ -82,5 +83,4 @@ void loop() {
   // read a sample
   int sample = I2S.read();
   Serial.println(sample);
-  delay(100);
-  }
+}

Diff for: libraries/I2S/examples/Callbacks/Callbacks.ino

@@ -51,10 +51,10 @@ on 23rd June 2021
 
 // If you need to change any of the default pins, simply uncomment chosen line and change the pin number
 /*
-#define PIN_I2S_SCK      33
-#define PIN_I2S_FS       16
-#define PIN_I2S_SD       17
-#define PIN_I2S_SD_OUT   4
+#define PIN_I2S_SCK      5
+#define PIN_I2S_FS       25
+#define PIN_I2S_SD       35
+#define PIN_I2S_SD_OUT   26
 */
 
 #include <I2S.h>
@@ -67,18 +67,21 @@ const int amplitude = 32767; // amplitude of square wave
 
 const int halfWavelength = (sampleRate / frequency); // half wavelength of square wave
 
-short sample = amplitude; // current sample value
+short out_sample = amplitude; // current sample value
 int count = 0;
 
 void outputCallback(){
+
   if (count % halfWavelength == 0) {
     // invert the sample every half wavelength count multiple to generate square wave
-    sample = -1 * sample;
+    out_sample = -1 * out_sample;
   }
 
+  Serial.printf("write %d\n", out_sample); // only for debug
+
   // write the same sample twice, once for left and once for the right channel
-  I2S.write(sample);
-  I2S.write(sample);
+  I2S.write(out_sample);
+  I2S.write(out_sample);
 
   // increment the counter for the next sample
   count++;
@@ -87,13 +90,11 @@ void outputCallback(){
 // code from InputSerialPlotter example
 void inputCallback(){
   // read a sample
-  int sample = I2S.read();
+  int in_sample = I2S.read();
 
-  Serial.println(sample); // only for debug
-
-  if (sample) {
+  if (in_sample) {
     // if it's non-zero print value to serial
-    Serial.println(sample);
+    Serial.println(in_sample);
   }
 }
 
@@ -111,7 +112,7 @@ void setup() {
     Serial.println("Failed to initialize I2S!");
     while (1) delay(100); // do nothing
   }
-  I2S.setAllPins();
+  I2S.setAllPins(PIN_I2S_SCK, PIN_I2S_FS, PIN_I2S_SD, PIN_I2S_SD_OUT);
 
   // Register our callback functions
   I2S.onTransmit(outputCallback); // Function outputCallback will be called each time I2S finishes transmit operation (audio output)
@@ -121,5 +122,5 @@ void setup() {
 
 void loop() {
   // loop task remains free for other work
-  delay(100); // Let the FreeRTOS reset the watchDogTimer
-}
+  delay(10); // Let the FreeRTOS reset the watchDogTimer
+}

Diff for: libraries/I2S/examples/InputSerialPlotter/InputSerialPlotter.ino

@@ -32,7 +32,6 @@ void setup() {
     Serial.println("Failed to initialize I2S!");
     while (1); // do nothing
   }
-  I2S.setAllPins(27,25,33,26);
 }
 
 void loop() {

Diff for: libraries/I2S/examples/SimpleTone/SimpleTone.ino

@@ -17,10 +17,9 @@
  */
 
 #include <I2S.h>
-
-const int frequency = 1250; // frequency of square wave in Hz
-const int amplitude = 32767; // amplitude of square wave
-const int sampleRate = 16000; // sample rate in Hz
+const int frequency = 440; // frequency of square wave in Hz
+const int amplitude = 500; // amplitude of square wave
+const int sampleRate = 8000; // sample rate in Hz
 
 const int halfWavelength = (sampleRate / frequency); // half wavelength of square wave
 

Diff for: libraries/I2S/src/I2S.cpp

@@ -24,7 +24,6 @@
 #define _I2S_EVENT_QUEUE_LENGTH 100
 #define _I2S_DMA_BUFFER_SIZE 512 // BUFFER SIZE must be between 8 and 1024
 #define _I2S_DMA_BUFFER_COUNT 8 // BUFFER COUNT must be between 2 and 128
-
 #define I2S_INTERFACES_COUNT SOC_I2S_NUM
 
 #ifndef I2S_DEVICE
@@ -35,27 +34,6 @@
   #define I2S_CLOCK_GENERATOR 0 // does nothing for ESP
 #endif
 
-#ifndef PIN_I2S_SCK
-  #define PIN_I2S_SCK 5
-#endif
-
-#ifndef PIN_I2S_FS
-  #define PIN_I2S_FS 25
-#endif
-
-#ifndef PIN_I2S_SD
-  #define PIN_I2S_SD 26
-#endif
-
-
-#ifndef PIN_I2S_SD_IN
-  #define PIN_I2S_SD_IN 35 // 35 can be only input pin
-#endif
-
-#ifndef PIN_I2S_SD_OUT
-  #define PIN_I2S_SD_OUT 26
-#endif
-
 I2SClass::I2SClass(uint8_t deviceIndex, uint8_t clockGenerator, uint8_t sdPin, uint8_t sckPin, uint8_t fsPin) :
   _deviceIndex(deviceIndex),
   _sdPin(sdPin),    // shared data pin
@@ -168,7 +146,6 @@ int I2SClass::begin(int mode, long sampleRate, int bitsPerSample, bool driveCloc
   }
 
   if (_state != I2S_STATE_IDLE && _state != I2S_STATE_DUPLEX) {
-    Serial.println("ERROR I2SClass::begin invalid state"); // debug
     return 0; // ERR
   }
 
@@ -182,7 +159,6 @@ int I2SClass::begin(int mode, long sampleRate, int bitsPerSample, bool driveCloc
     case I2S_LEFT_JUSTIFIED_MODE: // normally this should work, but i don't how to set it up for ESP
     default:
       // invalid mode
-      Serial.println("ERROR I2SClass::begin invalid mode"); // debug
       return 0; // ERR
   }
 
@@ -203,7 +179,6 @@ int I2SClass::begin(int mode, long sampleRate, int bitsPerSample, bool driveCloc
 
   if(_mode == I2S_ADC_DAC){
     if(_bitsPerSample != 16){ // ADC/DAC can only work in 16-bit sample mode
-      Serial.println("ERROR I2SClass::begin invalid bps for ADC/DAC"); // debug
       return 0; // ERR
     }
     i2s_mode = (esp_i2s::i2s_mode_t)(i2s_mode | esp_i2s::I2S_MODE_DAC_BUILT_IN | esp_i2s::I2S_MODE_ADC_BUILT_IN);
@@ -261,7 +236,6 @@ int I2SClass::begin(int mode, long sampleRate, int bitsPerSample, bool driveCloc
   //xSemaphoreGive(_out_buf_semaphore);
 
   if (ESP_OK != esp_i2s::i2s_driver_install((esp_i2s::i2s_port_t) _deviceIndex, &i2s_config, _I2S_EVENT_QUEUE_LENGTH, &_i2sEventQueue)){ // Install and start i2s driver
-    Serial.println("ERROR I2SClass::begin error installing i2s driver"); // debug
     return 0; // ERR
   }
 
@@ -450,6 +424,7 @@ int I2SClass::read(void* buffer, size_t size){
     }
   }
   size_t cpy_size = 0;
+
   //esp_i2s::i2s_read((esp_i2s::i2s_port_t) _deviceIndex, buffer, size, (size_t*) &read, 0);
   //if(_in_buf_semaphore != NULL && xSemaphoreTake(_in_buf_semaphore, portMAX_DELAY) == pdTRUE){
   if(_in_buf_semaphore != NULL && xSemaphoreTake(_in_buf_semaphore, 10) == pdTRUE){
@@ -488,12 +463,16 @@ size_t I2SClass::write(const void *buffer, size_t size)
   }
   size_t bytes_written;
   //esp_i2s::i2s_write((esp_i2s::i2s_port_t) _deviceIndex, buffer, size, &bytes_written, 0);
-  size_t cpy_size = size <= _buffer_byte_size - _output_buffer_pointer ? size : _buffer_byte_size - _output_buffer_pointer;
   if(_out_buf_semaphore != NULL && xSemaphoreTake(_out_buf_semaphore, portMAX_DELAY) == pdTRUE){
+    size_t cpy_size = size <= _buffer_byte_size - _output_buffer_pointer ? size : _buffer_byte_size - _output_buffer_pointer;
     memcpy((void*)((uint)_outputBuffer+_output_buffer_pointer), buffer, cpy_size);
+    _output_buffer_pointer = (_output_buffer_pointer + cpy_size) > _buffer_byte_size ? _output_buffer_pointer : _output_buffer_pointer + cpy_size;
+    if(_output_buffer_pointer == _buffer_byte_size){ // when full flush it
+      esp_i2s::i2s_write((esp_i2s::i2s_port_t) _deviceIndex, _outputBuffer, _output_buffer_pointer, &bytes_written, 0);
+      _output_buffer_pointer = 0;
+    }
     xSemaphoreGive(_out_buf_semaphore);
   }
-  _output_buffer_pointer = (_output_buffer_pointer + cpy_size) > _buffer_byte_size ? _output_buffer_pointer : _output_buffer_pointer + cpy_size;
   return bytes_written;
 }
 
@@ -593,7 +572,6 @@ void I2SClass::onTransferComplete()
       break; // from the infinite loop
     }else if(xActivatedMember == _i2sEventQueue){
       xQueueReceive(_i2sEventQueue, &i2s_event, 0);
-      //if((i2s_event == esp_i2s::I2S_EVENT_TX_DONE) && (_state == I2S_STATE_DUPLEX || _state == I2S_STATE_TRANSMITTER)){
       if(i2s_event == esp_i2s::I2S_EVENT_TX_DONE){
         size_t bytes_written;
         if(_out_buf_semaphore != NULL && xSemaphoreTake(_out_buf_semaphore, portMAX_DELAY) == pdTRUE){
@@ -602,14 +580,12 @@ void I2SClass::onTransferComplete()
           if(xSemaphoreGive(_out_buf_semaphore) != pdTRUE){
             // We would not expect this call to fail because we must have
             // obtained the semaphore to get here.
-          }
-        }
+          } // semaphore give
+        } // output buffer semaphore
         if(_onTransmit){
           _onTransmit();
         } // user callback
-      //}else if(i2s_event == esp_i2s::I2S_EVENT_RX_DONE && (_state == I2S_STATE_RECEIVER || _state == I2S_STATE_DUPLEX)){
       }else if(i2s_event == esp_i2s::I2S_EVENT_RX_DONE){
-        //if(_in_buf_semaphore != NULL && xSemaphoreTake(_in_buf_semaphore, portMAX_DELAY == pdTRUE)){
         if(_in_buf_semaphore != NULL && xSemaphoreTake(_in_buf_semaphore, 10) == pdTRUE){
           esp_i2s::i2s_read((esp_i2s::i2s_port_t) _deviceIndex, _inputBuffer, _buffer_byte_size, (size_t*) &_read_available, 0);
           _input_buffer_pointer = 0;
@@ -620,10 +596,10 @@ void I2SClass::onTransferComplete()
           if (_onReceive) {
             _onReceive();
           } // user callback
-        } // semaphore
-      } // if event TX or RX
-    }
-  }
+        } // input buffer semaphore
+      } // RX Done
+    } // I2S event
+  } // infinite loop
   _callbackTaskHandle = NULL; // prevent secondary termination to non-existing task
   vTaskDelete(NULL);
 }

Diff for: libraries/I2S/src/I2S.h

@@ -25,6 +25,23 @@ namespace esp_i2s {
   #include "driver/i2s.h" // ESP specific i2s driver
 }
 
+// Default pins
+#ifndef PIN_I2S_SCK
+  #define PIN_I2S_SCK 5
+#endif
+
+#ifndef PIN_I2S_FS
+  #define PIN_I2S_FS 25
+#endif
+
+#ifndef PIN_I2S_SD
+  #define PIN_I2S_SD 35 // Input if used in duplex
+#endif
+
+#ifndef PIN_I2S_SD_OUT
+  #define PIN_I2S_SD_OUT 26
+#endif
+
 typedef enum {
   I2S_PHILIPS_MODE,
   I2S_RIGHT_JUSTIFIED_MODE,