Merge remote-tracking branch 'upstream/main'

Author: CircuitSetup

install/dashgauges-A10001986.ino.nodemcu-32s.bin

@@ -115,6 +115,9 @@
 
 /*  Changelog
  *  
+ *  2025/01/15 (A10001986) [1.13]
+ *    - Optimize play_key; keyX will be stopped instead of (re)started if it is 
+ *      currently played when repeatedly triggered
  *  2025/01/13 (A10001986) [1.12]
  *    - BTTFN: Minor code optimization
  *  2024/10/27 (A10001986)

src/dashgauges-A10001986.ino

@@ -109,6 +109,7 @@ static int      sampleCnt = 0;
 
 bool            playingEmpty = false;
 bool            playingEmptyEnds = false;
+uint16_t        key_playing = 0;
 
 bool            playingDoor = false;
 
@@ -117,6 +118,9 @@ static float    append_vol;
 static uint16_t append_flags;
 static bool     appendFile = false;
 
+static char     keySnd[] = "/key3.mp3";   // not const
+static bool     haveKeySnd[10];
+
 static const char *tcdrdone = "/TCD_DONE.TXT";   // leave "TCD", SD is interchangable this way
 unsigned long   renNow1;
 
@@ -183,6 +187,13 @@ void audio_setup()
         endWaitSequence();
     }
 
+    // Check for keyX sounds to avoid unsuccessful file-lookups every time
+    for(int i = 1; i < 10; i++) {
+        if(i == 8) continue;
+        keySnd[4] = '0' + i;
+        haveKeySnd[i] = check_file_SD(keySnd);
+    }
+
     audioInitDone = true;
 }
 
@@ -196,31 +207,33 @@ void audio_loop()
         if(!mp3->loop()) {
             mp3->stop();
             playingEmpty = playingDoor = false;
+            key_playing = 0;
             if(appendFile) {
                 play_file(append_audio_file, append_flags, append_vol);
             } else if(mpActive) {
                 mp_next(true);
             }
-        } else {
+        } else if(dynVol) {
             sampleCnt++;
             if(sampleCnt > 1) {
-                if(dynVol) out->SetGain(getVolume());
+                out->SetGain(getVolume());
                 sampleCnt = 0;
             }
         }
     } else if(wav->isRunning()) {
         if(!wav->loop()) {
             wav->stop();
             playingEmpty = playingDoor = false;
+            key_playing = 0;
             if(appendFile) {
                 play_file(append_audio_file, append_flags, append_vol);
             } else if(mpActive) {
                 mp_next(true);
             }
-        } else {
+        } else if(dynVol) {
             sampleCnt++;
             if(sampleCnt > 1) {
-                if(dynVol) out->SetGain(getVolume());
+                out->SetGain(getVolume());
                 sampleCnt = 0;
             }
         }
@@ -302,8 +315,10 @@ void play_file(const char *audio_file, uint16_t flags, float volumeFactor)
 
     playingEmpty = (flags & PA_ISEMPTY) ? true : false;
     playingEmptyEnds = false;
-
     playingDoor = (flags & PA_DOOR) ? true : false;
+    key_playing = flags & 0xff00;
+
+    sampleCnt = 0;
 
     out->SetGain(getVolume());
 
@@ -317,17 +332,14 @@ void play_file(const char *audio_file, uint16_t flags, float volumeFactor)
             curSeek = findWAVdata(buf);
             mySD0L->setStartPos(curSeek);
             mySD0L->seek(0, SEEK_SET);
-    
             wav->begin(mySD0L, out);
         } else {
             mySD0L->read((void *)buf, 10);
             curSeek = skipID3(buf);
             mySD0L->setStartPos(curSeek);
             mySD0L->seek(curSeek, SEEK_SET);
-    
             mp3->begin(mySD0L, out);
         }
-        
         #ifdef DG_DBG
         Serial.println(F("Playing from SD"));
         #endif
@@ -352,11 +364,12 @@ void play_file(const char *audio_file, uint16_t flags, float volumeFactor)
             myFS0L->seek(curSeek, SEEK_SET);
             mp3->begin(myFS0L, out);
         }
-        
         #ifdef DG_DBG
         Serial.println(F("Playing from flash FS"));
         #endif
     } else {
+        key_playing = 0;
+        playingEmpty = playingDoor = false;
         #ifdef DG_DBG
         Serial.println(F("Audio file not found"));
         #endif
@@ -385,6 +398,26 @@ void remove_appended_empty()
     }
 }
 
+void play_key(int k, bool stopOnly)
+{
+    uint16_t pa_key = (k == 9) ? 0x8000 : (1 << (7+k));
+    
+    if(!haveKeySnd[k]) return;    
+
+    if(pa_key == key_playing) {
+        mp3->stop();
+        key_playing = 0;
+        return;
+    }
+
+    if(stopOnly)
+        return;
+
+    keySnd[4] = '0' + k;
+    
+    play_file(keySnd, pa_key|PA_INTRMUS|PA_ALLOWSD|PA_DYNVOL);
+}
+
 // Returns value for volume based on the position of the pot
 // Since the values vary we do some noise reduction
 #ifdef DG_HAVEVOLKNOB
@@ -479,6 +512,11 @@ static float getVolume()
  * Helpers for external
  */
 
+bool check_file_SD(const char *audio_file)
+{
+    return (haveSD && SD.exists(audio_file));
+}
+
 bool checkAudioDone()
 {
     if(mp3->isRunning() || wav->isRunning()) return false;
@@ -489,13 +527,13 @@ void stopAudio()
 {
     if(mp3->isRunning()) {
         mp3->stop();
-        playingEmpty = playingDoor = false;
     }
     if(wav->isRunning()) {
         wav->stop();
-        playingEmpty = playingDoor = false;
     }
     appendFile = false;   // Clear appended, stop means stop.
+    playingEmpty = playingDoor = false;
+    key_playing = 0;
 }
 
 void stopAudioAtLoopEnd()

src/dg_audio.cpp

@@ -66,21 +66,25 @@
 #define PA_ISEMPTY 0x0010
 #define PA_WAV     0x0020
 #define PA_DOOR    0x0040
+// upper 8 bits all taken
 #define PA_MASKA   (PA_LOOP|PA_INTRMUS|PA_ALLOWSD|PA_DYNVOL|PA_ISEMPTY)
 
 void audio_setup();
 void audio_loop();
 
 void play_file(const char *audio_file, uint16_t flags, float volumeFactor = 1.0);
 void append_file(const char *audio_file, uint16_t flags, float volumeFactor = 1.0);
-bool checkAudioDone();
-void stopAudio();
-void stopAudioAtLoopEnd();
-bool append_pending();
 
 void play_empty();
 //void append_empty();
 void remove_appended_empty();
+void play_key(int k, bool stopOnly = false);
+
+bool check_file_SD(const char *audio_file);
+bool checkAudioDone();
+void stopAudio();
+void stopAudioAtLoopEnd();
+bool append_pending();
 
 void     mp_init(bool isSetup);
 void     mp_play(bool forcePlay = true);

src/dg_audio.h

@@ -15,8 +15,8 @@
  ***                          Version Strings                          ***
  *************************************************************************/
 
-#define DG_VERSION       "V1.12"
-#define DG_VERSION_EXTRA "JAN132025"
+#define DG_VERSION       "V1.13"
+#define DG_VERSION_EXTRA "JAN152025"
 
 //#define DG_DBG              // debug output on Serial
 

src/dg_global.h

@@ -1347,18 +1347,18 @@ static void execute_remote_command()
     if(command < 10) {                                // 900x
         switch(command) {
         case 1:
-            play_file("/key1.mp3", PA_INTRMUS|PA_ALLOWSD|PA_DYNVOL);
+            play_key(1);
             break;
         case 2:
             if(haveMusic) {
                 mp_prev(mpActive);
             }
             break;
         case 3:
-            play_file("/key3.mp3", PA_INTRMUS|PA_ALLOWSD|PA_DYNVOL);
+            play_key(3);
             break;
         case 4:
-            play_file("/key4.mp3", PA_INTRMUS|PA_ALLOWSD|PA_DYNVOL);
+            play_key(4);
             break;
         case 5:
             if(haveMusic) {
@@ -1371,18 +1371,18 @@ static void execute_remote_command()
             }
             break;
         case 6:
-            play_file("/key6.mp3", PA_INTRMUS|PA_ALLOWSD|PA_DYNVOL);
+            play_key(6);
             break;
         case 7:
-            play_file("/key7.mp3", PA_INTRMUS|PA_ALLOWSD|PA_DYNVOL);
+            play_key(7);
             break;
         case 8:
             if(haveMusic) {
                 mp_next(mpActive);
             }
             break;
         case 9:
-            play_file("/key9.mp3", PA_INTRMUS|PA_ALLOWSD|PA_DYNVOL);
+            play_key(9);
             break;
         }