Buffer read (#1975)

* Buffer read and peek return bool

* cmake build errors (#1972)

* Compile errors other platforms

* RingBufferFile

* Reviewd RingBufferFile

* RingBufferFile: remove pos0

* NBufferFile

* Buffers comments

* Correct compile errors

* Tests

* VFS  open

* Compile warnings

* VFS_SDMMC 4 bits as default

Author: pschatzmann

examples/build-arch-log.txt

@@ -10,5 +10,3 @@ arduino:avr:nano ./examples-stream/streams-generator-serial -> rc=0
 arduino:samd:arduino_zero_native ./examples-stream/streams-generator-serial -> rc=0
 arduino:renesas_uno:unor4wifi ./examples-stream/streams-generator-serial -> rc=0
 arduino:mbed_nano:nano33ble ./examples-stream/streams-generator-serial -> rc=0
-arduino:zephyr:nano33ble ./examples-stream/streams-generator-serial -> rc=0
-arduino:mbed_rp2040:pico ./examples-stream/streams-generator-serial -> rc=0

examples/build-arch.sh

@@ -30,8 +30,8 @@ compile_example "arduino:avr:nano"
 compile_example "arduino:samd:arduino_zero_native"
 compile_example "arduino:renesas_uno:unor4wifi"
 compile_example "arduino:mbed_nano:nano33ble"
-compile_example "arduino:zephyr:nano33ble"
 compile_example "arduino:mbed_rp2040:pico" 
+#compile_example "arduino:zephyr:nano33ble"
 #compile_example "STMicroelectronics:stm32:GenF4" 
 
 ./cleanup.sh

examples/build-examples-log.txt

@@ -72,7 +72,7 @@
 ../examples/examples-audiokit/streams-memory_mp3-audiokit -> rc=0
 ../examples/examples-audiokit/streams-memory_pcm-mixer-audiokit -> rc=0
 ../examples/examples-audiokit/streams-pins-audiokit -> rc=0
-../examples/examples-audiokit/streams-sd_flac-audiokit -> rc=1
+../examples/examples-audiokit/streams-sd_flac-audiokit -> rc=0
 ../examples/examples-audiokit/streams-sdmmc_wav-audiokit -> rc=0
 ../examples/examples-audiokit/streams-sd_mp3-audiokit -> rc=0
 ../examples/examples-audiokit/streams-synth-audiokit -> rc=0
@@ -148,6 +148,7 @@
 ../examples/examples-communication/a2dp/basic-a2dp-mixer-i2s -> rc=0
 ../examples/examples-communication/a2dp/basic-adc-a2dp -> rc=0
 ../examples/examples-communication/a2dp/basic-audiokit-a2dp -> rc=0
+../examples/examples-communication/a2dp/basic-file_mp3-a2dp -> rc=0
 ../examples/examples-communication/a2dp/basic-generator-a2dp -> rc=0
 ../examples/examples-communication/a2dp/basic-i2s-a2dp -> rc=0
 ../examples/examples-communication/a2dp/basic-player-a2dp -> rc=0
@@ -263,7 +264,7 @@
 ../examples/tests/codecs/test-codec-opusogg -> rc=0
 ../examples/tests/codecs/test-codec-sbc -> rc=0
 ../examples/tests/codecs/test-codec-wav-adpcm -> rc=0
-../examples/tests/codecs/test-compile-all -> rc=1
+../examples/tests/codecs/test-compile-all -> rc=0
 ../examples/tests/codecs/test-container-binary -> rc=0
 ../examples/tests/codecs/test-container-binary-meta -> rc=0
 ../examples/tests/codecs/test-container-ogg -> rc=0
@@ -304,6 +305,7 @@
 ../examples/tests/effects/pitch-shift-simple -> rc=0
 ../examples/tests/etc/callback-write -> rc=0
 ../examples/tests/etc/test-ads1015 -> rc=0
+../examples/tests/etc/test-audiolibs -> rc=0
 ../examples/tests/etc/test-mulit-compilation-units -> rc=0
 ../examples/tests/etc/test-pins -> rc=0
 ../examples/tests/etc/test-ringbufferfile -> rc=0
@@ -332,6 +334,7 @@
 ../examples/tests/player/test-index-sdfat -> rc=0
 ../examples/tests/player/test-index-sdmmc -> rc=0
 ../examples/tests/player/test-player -> rc=0
+../examples/tests/player/test-vfs -> rc=0
 ../examples/tests/timer/test-timer -> rc=0
 ../examples/tests/timer/test-timercb_rx -> rc=0
 ../examples/tests/timer/test-timercb_tx -> rc=0

examples/examples-communication/a2dp/basic-file_mp3-a2dp/basic-file_mp3-a2dp.ino

@@ -11,7 +11,7 @@ File file;
 MP3DecoderHelix mp3;  // or change to MP3DecoderMAD
 EncodedAudioStream decoder(&file, &mp3);
 BluetoothA2DPSource a2dp_source;
-const int chipSelect = SS //PIN_AUDIO_KIT_SD_CARD_CS;
+const int chipSelect = SS; //PIN_AUDIO_KIT_SD_CARD_CS;
 
 // callback used by A2DP to provide the sound data - usually len is 128 2 channel int16 frames
 int32_t get_sound_data(uint8_t* data, int32_t size) {
@@ -35,7 +35,7 @@ void setup(void) {
   }
 
   // make sure we have enough space for the pcm data
-  decoder.transformationReader().resizeResultQueue(1024 * 8)
+  decoder.transformationReader().resizeResultQueue(1024 * 8);
   if (!decoder.begin()) {
     Serial.println("decoder failed");
     stop();

examples/examples-communication/http-client/player-url_subclass-i2s/AudioSourceIcyUrl.h

@@ -1,5 +1,7 @@
 #pragma once
 #include "AudioTools.h"
+#include "AudioTools/CoreAudio/AudioHttp/URLStream.h"
+#include "AudioTools/Disk/AudioSourceURL.h"
 
 namespace audio_tools {
 

examples/tests/basic/test-buffer/test-buffer.ino

@@ -10,7 +10,8 @@ void test(BaseBuffer<int16_t>& b, const char* title) {
   }
   assert(b.isFull());
   for (int j = 0; j < 200; j++) {
-    int16_t v = b.read();
+    int16_t v = 0;
+    assert(b.read(v));
     assert(v == j);
   }
   assert(b.isEmpty());
@@ -21,10 +22,10 @@ void test(BaseBuffer<int16_t>& b, const char* title) {
   b.clear();
   int len = b.writeArray(array, 200);
   Serial.println(len);
-  len = b.readArray(array,200);
+  len = b.readArray(array, 200);
   Serial.println(len);
-  for (int j=0;j<200;j++){
-      assert(array[j]==j);
+  for (int j = 0; j < 200; j++) {
+    assert(array[j] == j);
   }
 
   Serial.println("Test OK");
@@ -38,10 +39,10 @@ void setup() {
   test(b1, "SingleBuffer");
 
   RingBuffer<int16_t> b2(200);
-  test(b2,"RingBuffer");
+  test(b2, "RingBuffer");
 
   NBuffer<int16_t> b3(50, 4);
-  test(b3,"NBuffer");
+  test(b3, "NBuffer");
 
   Serial.println("Tests OK");
 }

examples/tests/etc/test-audiolibs/test-audiolibs.ino

@@ -0,0 +1,6 @@
+#include "AudioTools.h"
+#include "AudioTools/AudioLibs/All.h"
+
+void setup(){}
+
+void loop(){}

examples/tests/etc/test-ringbufferfile/test-ringbufferfile.ino

@@ -4,15 +4,16 @@
  * @brief genTest for the file backed ringbuffer
  * @version 0.1
  * @date 2023-04-30
- * 
+ *
  * @copyright Copyright (c) 2022
- * 
+ *
  */
 /**
  * Test for the file backed ringbuffer
  */
-#include "AudioTools.h"
 #include <SdFat.h>
+
+#include "AudioTools.h"
 // SD pins
 #define PIN_SD_CARD_CS 13
 #define PIN_SD_CARD_MISO 2
@@ -24,25 +25,29 @@ SdFs SD;
 FsFile file;
 RingBufferFile<FsFile, int16_t> buffer(file);
 
-
 void setup() {
   Serial.begin(115200);
   AudioToolsLogger.begin(Serial, AudioToolsLogLevel::Info);
 
   // setup SD
-  SPI.begin(PIN_SD_CARD_CLK, PIN_SD_CARD_MISO, PIN_SD_CARD_MOSI, PIN_SD_CARD_CS);
+  SPI.begin(PIN_SD_CARD_CLK, PIN_SD_CARD_MISO, PIN_SD_CARD_MOSI,
+            PIN_SD_CARD_CS);
   while (!SD.begin(PIN_SD_CARD_CS, SPI_HALF_SPEED)) {
     Serial.println("Card Mount Failed");
     delay(500);
   }
 
   // create file and setup buffer
-  file = SD.open(file_name, O_RDWR | O_CREAT );
+  file = SD.open(file_name, O_RDWR | O_CREAT);
   if (!file) {
     Serial.println("Failed to open file for writing");
     return;
   }
-  
+  if (!buffer.begin(file)) {
+    Serial.println("Failed to create buffer");
+    return;
+  }
+
   // test write
   for (int j = 0; j < 10; j++) {
     buffer.write(j);
@@ -58,9 +63,11 @@ void setup() {
   // test read
   Serial.println("read");
   for (int j = 0; j < 10; j++) {
-    int16_t result = buffer.read();
-    Serial.print(result);
-    Serial.print(" ");
+    int16_t result;
+    if (buffer.read(result)) {
+      Serial.print(result);
+      Serial.print(" ");
+    }
     assert(result == j);
   }
   Serial.println();
@@ -70,7 +77,7 @@ void setup() {
   Serial.print(" ");
   Serial.println(buffer.available());
   memset(tmp, 0, 10 * sizeof(int16_t));
-  
+
   int max = buffer.readArray(tmp, buffer.available());
   for (int j = 0; j < max; j++) {
     Serial.print(tmp[j]);

examples/tests/performance/file-speeds/file-speeds.ino

@@ -0,0 +1,84 @@
+#include "SPI.h"
+#include "SD.h"
+#include "SD_MMC.h"
+#include <SdFat.h>
+#include "AudioTools.h"
+#define AUDIOBOARD_SD
+#include "AudioTools/Disk/VFS_SDSPI.h"
+#include "AudioTools/Disk/VFS_SDMMC.h"
+#include "AudioTools/Disk/VFSFile.h"
+#define PIN_AUDIO_KIT_SD_CARD_CS 13
+#define PIN_AUDIO_KIT_SD_CARD_MISO 2
+#define PIN_AUDIO_KIT_SD_CARD_MOSI 15
+#define PIN_AUDIO_KIT_SD_CARD_CLK  14
+
+Vector<uint8_t> data;
+int len[] = { 1, 10, 100, 1024, 1024 * 10, 1024 * 100, 1024 * 1000 };
+int totalSize = 1024 * 1024 * 100;
+
+void testWrite(Stream& file, int writeSize, int totalSize, const char* name) {
+  data.resize(writeSize);
+  memset(data.data(), 0, data.size());
+  int32_t start = millis();
+  while (totalSize > 0) {
+    int written = file.write(data.data(), min(writeSize, totalSize));
+    totalSize -= written;
+  }
+  int32_t time = millis() - start;
+  float thru = (float)totalSize / (float)time;
+  Serial.printf("Write, %s, %d, %f\n", name, writeSize, thru);
+}
+
+void testRead(Stream& file, int writeSize, int totalSize, const char* name) {
+  data.resize(writeSize);
+  memset(data.data(), 0, data.size());
+  int32_t start = millis();
+  while (totalSize > 0) {
+    int written = file.readBytes(data.data(), min(writeSize, totalSize));
+    totalSize -= written;
+  }
+  int32_t time = millis() - start;
+  float thru = (float)totalSize / (float)time;
+  Serial.printf("Read, %s, %d, %f\n", name, writeSize, time);
+}
+
+
+template<typename SD, typename Open>
+void testFS(SD& sd, Open write, Open read, int cs = -1) {
+  bool ok = cs != -1 ? sd.begin(cs) : sd.begin();
+  if (!ok){
+    Serial.println("SD error");
+    return;
+  }
+
+  auto file = sd.open("/test.txt", write);
+  for (int i : len) {
+    testWrite(file, len[i], totalSize, "VFS_SDMMC, Write");
+  }
+  file.close();
+  file = sd.open("/sdmmc/test.txt", read);
+  for (int i : len) {
+    testRead(file, len[i], totalSize, "VFS_SDMMC, Read");
+  }
+  file.close();
+  sd.end();
+}
+
+void setup() {
+  VFS_SDSPI sd;
+  VFS_SDMMC sdmmc;
+  SdFat sdfat;
+
+  Serial.begin(115200);
+
+  SPI.begin(PIN_AUDIO_KIT_SD_CARD_CLK, PIN_AUDIO_KIT_SD_CARD_MISO, PIN_AUDIO_KIT_SD_CARD_MOSI, PIN_AUDIO_KIT_SD_CARD_CS);
+
+  testFS<fs::SDFS, const char*>(SD, FILE_WRITE, FILE_READ, PIN_AUDIO_KIT_SD_CARD_CS);
+  testFS<fs::SDMMCFS, const char*>(SD_MMC, FILE_WRITE, FILE_READ);
+  testFS<SdFat, int>(sdfat, O_WRITE | O_CREAT, O_RDONLY, PIN_AUDIO_KIT_SD_CARD_CS);
+  testFS<VFS_SDSPI, FileMode>(sd, VFS_FILE_WRITE, VFS_FILE_READ);
+  testFS<VFS_SDMMC, FileMode>(sdmmc, VFS_FILE_WRITE, VFS_FILE_READ);
+  stop();
+}
+
+void loop() {}