Merge branch 'master' into patch-1

earlephilhower · Oct 8, 2024 · 70cd8a8 · 70cd8a8
2 parents c46f3d3 + 96dc79c
commit 70cd8a8
Show file tree

Hide file tree

Showing 33 changed files with 214 additions and 155 deletions.
diff --git a/.github/workflows/pr-or-master-push.yml b/.github/workflows/pr-or-master-push.yml
@@ -20,10 +20,10 @@ jobs:
       matrix:
         chunk: [0, 1, 2, 3, 4]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         submodules: true
-    - uses: actions/setup-python@v2
+    - uses: actions/setup-python@v5
       with:
         python-version: '3.x'
     - name: Build Sketches
@@ -43,10 +43,10 @@ jobs:
       matrix:
         chunk: [0, 1, 2, 3, 4]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         submodules: true
-    - uses: actions/setup-python@v2
+    - uses: actions/setup-python@v5
       with:
         python-version: '3.x'
     - name: Build Sketches
@@ -66,10 +66,10 @@ jobs:
       matrix:
         chunk: [0, 1, 2, 3, 4]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         submodules: true
-    - uses: actions/setup-python@v2
+    - uses: actions/setup-python@v5
       with:
         python-version: '3.x'
     - name: Build Sketches
@@ -87,10 +87,10 @@ jobs:
     name: Host tests
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         submodules: true
-    - uses: actions/setup-python@v2
+    - uses: actions/setup-python@v5
       with:
         python-version: '3.x'
     - name: Run host tests
@@ -115,7 +115,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: arduino/arduino-lint-action@v1
         with:
           library-manager: 'update'
@@ -128,7 +128,7 @@ jobs:
       run:
         shell: bash
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         submodules: true
     - name: Run codespell

diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@ Arduino library for parsing and decoding MOD, WAV, MP3, FLAC, MIDI, AAC, and RTT
 
 ESP8266 is fully supported and most mature, but ESP32 is also mostly there with built-in DAC as well as external ones.
 
-For real-time, autonomous speech synthesis, check out [ESP8266SAM](https://github.com/earlephilhower/ESP8266SAM), a library which uses this one and a port of an ancient format-based synthesis program to allow your ESP8266 to talk with low memory and no network required.
+For real-time, autonomous speech synthesis, check out [ESP8266SAM](https://github.com/earlephilhower/ESP8266SAM), a library which uses this one and a port of an ancient formant-based synthesis program to allow your ESP8266 to talk with low memory and no network required.
 
 ## Disclaimer
 All this code is released under the GPL, and all of it is to be used at your own risk.  If you find any bugs, please let me know via the GitHub issue tracker or drop me an email.

diff --git a/examples/PlayMIDIFromSPIFFS/PlayMIDIFromSPIFFS.ino b/examples/PlayMIDIFromSPIFFS/PlayMIDIFromSPIFFS.ino
@@ -1,8 +1,8 @@
 #include <Arduino.h>
 
-// Do not build on GCC8, GCC8 has a compiler bug
+// Do not build on Espressif GCC8+, compiler bug
 
-#if defined(ARDUINO_ARCH_RP2040) || ((__GNUC__ == 8) && (__XTENSA__))
+#if defined(ARDUINO_ARCH_RP2040) || (defined(ESP32) && (__GNUC__ >= 8) && (__XTENSA__))
 void setup() {}
 void loop() {}
 #else

diff --git a/library.json b/library.json
@@ -14,7 +14,7 @@
         "type": "git",
          "url": "https://github.com/earlephilhower/ESP8266Audio"
     },
-    "version": "1.9.7",
+    "version": "1.9.9",
     "homepage": "https://github.com/earlephilhower/ESP8266Audio",
     "frameworks": "Arduino",
     "examples": [

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=ESP8266Audio
-version=1.9.7
+version=1.9.9
 author=Earle F. Philhower, III
 maintainer=Earle F. Philhower, III
 sentence=Audio file and I2S sound playing routines for ESP8266, ESP32, and Raspberry Pi Pico RP2040

diff --git a/src/AudioFileSourceHTTPStream.cpp b/src/AudioFileSourceHTTPStream.cpp
@@ -102,7 +102,11 @@ uint32_t AudioFileSourceHTTPStream::readInternal(void *data, uint32_t len, bool
   }
   if ((size > 0) && (pos >= size)) return 0;
 
+#if defined(ESP_ARDUINO_VERSION_MAJOR) && ESP_ARDUINO_VERSION_MAJOR >= 3
+  NetworkClient *stream = http.getStreamPtr();
+#else
   WiFiClient *stream = http.getStreamPtr();
+#endif
 
   // Can't read past EOF...
   if ( (size > 0) && (len > (uint32_t)(pos - size)) ) len = pos - size;

diff --git a/src/AudioFileSourceHTTPStream.h b/src/AudioFileSourceHTTPStream.h
@@ -53,7 +53,11 @@ class AudioFileSourceHTTPStream : public AudioFileSource
 
   private:
     virtual uint32_t readInternal(void *data, uint32_t len, bool nonBlock);
+#if defined(ESP_ARDUINO_VERSION_MAJOR) && ESP_ARDUINO_VERSION_MAJOR >= 3
+    NetworkClient client;
+#else
     WiFiClient client;
+#endif
     HTTPClient http;
     int pos;
     int size;

diff --git a/src/AudioFileSourceICYStream.cpp b/src/AudioFileSourceICYStream.cpp
@@ -115,7 +115,11 @@ uint32_t AudioFileSourceICYStream::readInternal(void *data, uint32_t len, bool n
   }
   if ((size > 0) && (pos >= size)) return 0;
 
+#if defined(ESP_ARDUINO_VERSION_MAJOR) && ESP_ARDUINO_VERSION_MAJOR >= 3
+  NetworkClient *stream = http.getStreamPtr();
+#else
   WiFiClient *stream = http.getStreamPtr();
+#endif
 
   // Can't read past EOF...
   if ( (size > 0) && (len > (uint32_t)(pos - size)) ) len = pos - size;

diff --git a/src/AudioGeneratorFLAC.cpp b/src/AudioGeneratorFLAC.cpp
@@ -196,7 +196,7 @@ char AudioGeneratorFLAC::error_cb_str[64];
 void AudioGeneratorFLAC::error_cb(const FLAC__StreamDecoder *decoder, FLAC__StreamDecoderErrorStatus status)
 {
   (void) decoder;
-  strncpy_P(error_cb_str, FLAC__StreamDecoderErrorStatusString[status], 64);
+  strncpy_P(error_cb_str, FLAC__StreamDecoderErrorStatusString[status], sizeof(AudioGeneratorFLAC::error_cb_str) - 1);
   cb.st((int)status, error_cb_str);
 }
 
diff --git a/src/AudioGeneratorMIDI.cpp b/src/AudioGeneratorMIDI.cpp
@@ -58,8 +58,8 @@
 
 #include "AudioGeneratorMIDI.h"
 
-#if (__GNUC__ == 8) && (__XTENSA__)
-// Do not build, GCC8 has a compiler bug
+#if defined(ESP32) && (__GNUC__ >= 8) && (__XTENSA__)
+// Do not build, Espressif's GCC8+ has a compiler bug
 #else // __GNUC__ == 8
 
 #pragma GCC optimize ("O3")

diff --git a/src/AudioGeneratorMIDI.h b/src/AudioGeneratorMIDI.h
@@ -21,8 +21,8 @@
 #ifndef _AUDIOGENERATORMIDI_H
 #define _AUDIOGENERATORMIDI_H
 
-#if (__GNUC__ == 8) && (__XTENSA__)
-// Do not build, GCC8 has a compiler bug
+#if defined(ESP32) && (__GNUC__ >= 8) && (__XTENSA__)
+// Do not build, Espressif's GCC8+ has a compiler bug
 #else // __GNUC__ == 8
 
 #include "AudioGenerator.h"

diff --git a/src/AudioGeneratorMP3.cpp b/src/AudioGeneratorMP3.cpp
@@ -1,7 +1,7 @@
 /*
   AudioGeneratorMP3
   Wrap libmad MP3 library to play audio
-  
+
   Copyright (C) 2017  Earle F. Philhower, III
 
   This program is free software: you can redistribute it and/or modify
@@ -62,7 +62,7 @@ AudioGeneratorMP3::~AudioGeneratorMP3()
     free(synth);
     free(frame);
     free(stream);
-  } 
+  }
 }
 
 
@@ -182,15 +182,15 @@ bool AudioGeneratorMP3::GetOneSample(int16_t sample[2])
     output->SetChannels(synth->pcm.channels);
     lastChannels = synth->pcm.channels;
   }
-    
+
   // If we're here, we have one decoded frame and sent 0 or more samples out
   if (samplePtr < synth->pcm.length) {
     sample[AudioOutput::LEFTCHANNEL ] = synth->pcm.samples[0][samplePtr];
     sample[AudioOutput::RIGHTCHANNEL] = synth->pcm.samples[1][samplePtr];
     samplePtr++;
   } else {
     samplePtr = 0;
-    
+
     switch ( mad_synth_frame_onens(synth, frame, nsCount++) ) {
         case MAD_FLOW_STOP:
         case MAD_FLOW_BREAK: audioLogger->printf_P(PSTR("msf1ns failed\n"));
@@ -302,6 +302,7 @@ bool AudioGeneratorMP3::begin(AudioFileSource *source, AudioOutput *output)
       synth = reinterpret_cast<struct mad_synth *>(preallocateSynthSpace);
     }
     else {
+      output->stop();
       audioLogger->printf_P("OOM error in MP3:  Want %d/%d/%d/%d bytes, have %d/%d/%d/%d bytes preallocated.\n",
           preAllocBuffSize(), preAllocStreamSize(), preAllocFrameSize(), preAllocSynthSize(),
           preallocateSize, preallocateStreamSize, preallocateFrameSize, preallocateSynthSize);
@@ -319,6 +320,7 @@ bool AudioGeneratorMP3::begin(AudioFileSource *source, AudioOutput *output)
     p += preAllocSynthSize();
     int neededBytes = p - reinterpret_cast<uint8_t *>(preallocateSpace);
     if (neededBytes > preallocateSize) {
+      output->stop();
       audioLogger->printf_P("OOM error in MP3:  Want %d bytes, have %d bytes preallocated.\n", neededBytes, preallocateSize);
       return false;
     }
@@ -336,17 +338,20 @@ bool AudioGeneratorMP3::begin(AudioFileSource *source, AudioOutput *output)
       stream = NULL;
       frame = NULL;
       synth = NULL;
+
+      output->stop();
+      audioLogger->printf_P("OOM error in MP3\n");
       return false;
     }
   }
- 
+
   mad_stream_init(stream);
   mad_frame_init(frame);
   mad_synth_init(synth);
   synth->pcm.length = 0;
   mad_stream_options(stream, 0); // TODO - add options support
   madInitted = true;
- 
+
   running = true;
   return true;
 }
@@ -413,4 +418,3 @@ extern "C" {
   }
 #endif
 }
-
diff --git a/src/AudioGeneratorRTTTL.cpp b/src/AudioGeneratorRTTTL.cpp
@@ -236,13 +236,13 @@ bool AudioGeneratorRTTTL::GetNextNote()
     ptr++;
     note++;
   }
+  if (!ReadInt(&scale)) {
+    scale = defaultOctave;
+  }
   if ((ptr < len) && (buff[ptr] == '.')) {
     ptr++;
     dur += dur / 2;
   }
-  if (!ReadInt(&scale)) {
-    scale = defaultOctave;
-  }
   // Eat any trailing whitespace and comma
   SkipWhitespace();
   if ((ptr < len) && (buff[ptr]==',')) {

diff --git a/src/AudioOutputI2S.cpp b/src/AudioOutputI2S.cpp
@@ -152,7 +152,7 @@ bool AudioOutputI2S::SetPinout(int bclk, int wclk, int dout, int mclk)
   bclkPin = bclk;
   wclkPin = wclk;
   doutPin = dout;
-  #ifdef ESP32
+  #if defined(ESP32) || defined(ARDUINO_ARCH_RP2040)
     mclkPin = mclk;
     if (i2sOn)
       return SetPinout();
@@ -220,6 +220,8 @@ bool AudioOutputI2S::SetMclk(bool enabled){
     if (output_mode == INTERNAL_DAC || output_mode == INTERNAL_PDM)
       return false; // Not allowed
 
+    use_mclk = enabled;
+  #elif defined(ARDUINO_ARCH_RP2040)
     use_mclk = enabled;
   #endif
   return true;
@@ -234,9 +236,9 @@ bool AudioOutputI2S::begin(bool txDAC)
       {
         // don't use audio pll on buggy rev0 chips
         use_apll = APLL_DISABLE;
-        esp_chip_info_t out_info;
-        esp_chip_info(&out_info);
-        if (out_info.revision > 0)
+        //esp_chip_info_t out_info;
+        //esp_chip_info(&out_info);
+        //if (out_info.revision > 0)
         {
           use_apll = APLL_ENABLE;
         }
@@ -334,12 +336,16 @@ bool AudioOutputI2S::begin(bool txDAC)
   #elif defined(ARDUINO_ARCH_RP2040)
     (void)txDAC;
     if (!i2sOn) {
-        i2s.setBCLK(bclkPin);
-	i2s.setDATA(doutPin);
-	if (swap_clocks) {
-	  i2s.swapClocks();
-	}
-        i2s.begin(hertz);
+      i2s.setSysClk(hertz);
+      i2s.setBCLK(bclkPin);
+      i2s.setDATA(doutPin);
+      i2s.setMCLK(mclkPin);
+      i2s.setMCLKmult(256);
+      if (swap_clocks) {
+        i2s.swapClocks();
+      }
+      i2s.setBitsPerSample(bps);
+      i2s.begin(hertz);
     }
   #endif
   i2sOn = true;

diff --git a/src/AudioOutputMixer.cpp b/src/AudioOutputMixer.cpp
@@ -71,8 +71,8 @@ bool AudioOutputMixerStub::stop()
 AudioOutputMixer::AudioOutputMixer(int buffSizeSamples, AudioOutput *dest) : AudioOutput()
 {
   buffSize = buffSizeSamples;
-  leftAccum = (int32_t*)calloc(sizeof(int32_t), buffSize);
-  rightAccum = (int32_t*)calloc(sizeof(int32_t), buffSize);
+  leftAccum = (int32_t*)calloc(buffSize, sizeof(int32_t));
+  rightAccum = (int32_t*)calloc(buffSize, sizeof(int32_t));
   for (int i=0; i<maxStubs; i++) {
     stubAllocated[i] = false;
     stubRunning[i] = false;

diff --git a/src/AudioOutputPWM.cpp b/src/AudioOutputPWM.cpp
@@ -89,6 +89,9 @@ bool AudioOutputPWM::ConsumeSample(int16_t sample[2]) {
     ms[LEFTCHANNEL] = ms[RIGHTCHANNEL] = (ttl>>1) & 0xffff;
   }
 
+  ms[LEFTCHANNEL] = Amplify(ms[LEFTCHANNEL]);
+  ms[RIGHTCHANNEL] = Amplify(ms[RIGHTCHANNEL]);
+
   if (pwm.available()) {
       pwm.write((int16_t) ms[0]);
       pwm.write((int16_t) ms[1]);

diff --git a/src/AudioOutputSPDIF.cpp b/src/AudioOutputSPDIF.cpp
@@ -7,7 +7,7 @@
   See: https://www.epanorama.net/documents/audio/spdif.html
 
   Original idea and sources: 
-    Forum thread dicussing implementation
+    Forum thread discussing implementation
       https://forum.pjrc.com/threads/28639-S-pdif
     Teensy Audio Library 
       https://github.com/PaulStoffregen/Audio/blob/master/output_spdif2.cpp
@@ -105,7 +105,10 @@ AudioOutputSPDIF::AudioOutputSPDIF(int dout_pin, int port, int dma_buf_count)
     .use_apll = true, // Audio PLL is needed for low clock jitter
     .tx_desc_auto_clear = true, // Silence on underflow
     .fixed_mclk = 0, // Unused
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 0)
+#if defined(ESP_ARDUINO_VERSION_MAJOR) && ESP_ARDUINO_VERSION_MAJOR >= 3
+    .mclk_multiple = I2S_MCLK_MULTIPLE_512, // Unused
+    .bits_per_chan = I2S_BITS_PER_CHAN_DEFAULT // Use bits per sample
+#elif ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 0)
     .mclk_multiple = I2S_MCLK_MULTIPLE_DEFAULT, // Unused
     .bits_per_chan = I2S_BITS_PER_CHAN_DEFAULT // Use bits per sample
 #endif
@@ -183,12 +186,14 @@ bool AudioOutputSPDIF::SetRate(int hz)
   int adjustedHz = AdjustI2SRate(hz);
 #if defined(ESP32)
   if (i2s_set_sample_rates((i2s_port_t)portNo, adjustedHz) == ESP_OK) {
+#if defined(ESP_ARDUINO_VERSION_MAJOR) && (ESP_ARDUINO_VERSION_MAJOR < 3)
     if (adjustedHz == 88200) {
       // Manually fix the APLL rate for 44100. 
       // See: https://github.com/espressif/esp-idf/issues/2634
       // sdm0 = 28, sdm1 = 8, sdm2 = 5, odir = 0 -> 88199.977
       rtc_clk_apll_enable(1, 28, 8, 5, 0); 
     }
+#endif
   } else {
     audioLogger->println("ERROR changing S/PDIF sample rate");
   } 

diff --git a/src/AudioOutputSPDIF.h b/src/AudioOutputSPDIF.h
@@ -7,7 +7,7 @@
   See: https://www.epanorama.net/documents/audio/spdif.html
 
   Original idea and sources: 
-    Forum thread dicussing implementation
+    Forum thread discussing implementation
       https://forum.pjrc.com/threads/28639-S-pdif
     Teensy Audio Library 
       https://github.com/PaulStoffregen/Audio/blob/master/output_spdif2.cpp