Fix for wled#5703

- also remove delayed file close
- handle presets and playlists even in realtime mode

Author: blazoncek

wled00/fcn_declare.h

@@ -159,7 +159,7 @@ bool presetNeedsSaving();
 void initPresetsFile();
 void handlePresets();
 bool applyPreset(byte index, byte callMode = CALL_MODE_DIRECT_CHANGE);
-bool applyPresetFromPlaylist(byte index);
+bool doApplyPreset(uint8_t index, uint8_t callMode);
 void applyPresetWithFallback(uint8_t presetID, uint8_t callMode, uint8_t effectID = 0, uint8_t paletteID = 0);
 inline bool applyTemporaryPreset() {return applyPreset(255);};
 void savePreset(byte index, const char* pname = nullptr, JsonObject saveobj = JsonObject());

wled00/file.cpp

@@ -42,17 +42,6 @@ static volatile size_t knownLargestSpace = MAX_SPACE;
 
 static File f; // don't export to other cpp files
 
-//wrapper to find out how long closing takes
-void closeFile() {
-  #ifdef WLED_DEBUG_FS
-    DEBUGFS_PRINT(F("Close -> "));
-    uint32_t s = millis();
-  #endif
-  f.close();
-  DEBUGFS_PRINTF("took %lu ms\n", millis() - s);
-  doCloseFile = false;
-}
-
 //find() that reads and buffers data from file stream in 256-byte blocks.
 //Significantly faster, f.find(key) can take SECONDS for multi-kB files
 static bool bufferedFind(const char *target, bool fromStart = true) {
@@ -186,7 +175,7 @@ static void writeSpace(size_t l)
   if (knownLargestSpace < l) knownLargestSpace = l;
 }
 
-static bool appendObjectToFile(const char* key, const JsonDocument* content, uint32_t s, uint32_t contentLen = 0)
+static bool appendObjectToFileAndClose(const char* key, const JsonDocument* content, uint32_t s, uint32_t contentLen = 0)
 {
   #ifdef WLED_DEBUG_FS
     DEBUGFS_PRINTLN(F("Append"));
@@ -198,7 +187,7 @@ static bool appendObjectToFile(const char* key, const JsonDocument* content, uin
   if (f.size() < 3) f.print(F("{\"0\":{}}"));
 
   if (content->isNull()) {
-    doCloseFile = true;
+    f.close();
     return true; //nothing  to append
   }
 
@@ -210,7 +199,7 @@ static bool appendObjectToFile(const char* key, const JsonDocument* content, uin
     f.print(key);
     serializeJson(*content, f);
     DEBUGFS_PRINTF("Inserted, took %lu ms (total %lu)", millis() - s1, millis() - s);
-    doCloseFile = true;
+    f.close();
     return true;
   }
 
@@ -221,7 +210,7 @@ static bool appendObjectToFile(const char* key, const JsonDocument* content, uin
 
   if (f.size() + 9000 > (fsBytesTotal - fsBytesUsed)) { //make sure there is enough space to at least copy the file once
     errorFlag = ERR_FS_QUOTA;
-    doCloseFile = true;
+    f.close();
     return false;
   }
 
@@ -255,8 +244,7 @@ static bool appendObjectToFile(const char* key, const JsonDocument* content, uin
   //Append object
   serializeJson(*content, f);
   f.write('}');
-
-  doCloseFile = true;
+  f.close();
   DEBUGFS_PRINTF("Appended, took %lu ms (total %lu)", millis() - s1, millis() - s);
   return true;
 }
@@ -270,8 +258,6 @@ bool writeObjectToFileUsingId(const char* file, uint16_t id, const JsonDocument*
 
 bool writeObjectToFile(const char* file, const char* key, const JsonDocument* content)
 {
-  if (doCloseFile) closeFile();
-
   uint32_t s = 0; //timing
   #ifdef WLED_DEBUG_FS
     DEBUGFS_PRINTF("Write to %s with key %s >>>\n", file, (key==nullptr)?"nullptr":key);
@@ -289,7 +275,7 @@ bool writeObjectToFile(const char* file, const char* key, const JsonDocument* co
 
   if (!bufferedFind(key)) //key does not exist in file
   {
-    return appendObjectToFile(key, content, s);
+    return appendObjectToFileAndClose(key, content, s);
   }
 
   //an object with this key already exists, replace or delete it
@@ -325,10 +311,10 @@ bool writeObjectToFile(const char* file, const char* key, const JsonDocument* co
     if (pos > 3) pos--; //also delete leading comma if not first object
     f.seek(pos);
     writeSpace(pos2 - pos);
-    if (contentLen) return appendObjectToFile(key, content, s, contentLen);
+    if (contentLen) return appendObjectToFileAndClose(key, content, s, contentLen);
   }
 
-  doCloseFile = true;
+  f.close();
   DEBUGFS_PRINTF("Replaced/deleted, took %lu ms\n", millis() - s);
   return true;
 }
@@ -343,7 +329,6 @@ bool readObjectFromFileUsingId(const char* file, uint16_t id, JsonDocument* dest
 //if the key is a nullptr, deserialize entire object
 bool readObjectFromFile(const char* file, const char* key, JsonDocument* dest, const JsonDocument* filter)
 {
-  if (doCloseFile) closeFile();
   #ifdef WLED_DEBUG_FS
     DEBUGFS_PRINTF("Read from %s with key %s >>>\n", file, (key==nullptr)?"nullptr":key);
     uint32_t s = millis();

wled00/playlist.cpp

@@ -153,9 +153,9 @@ void handlePlaylist() {
       if (playlistRepeat == 1) { //stop if all repetitions are done
         unloadPlaylist();
         if (parentPlaylistPresetId > 0) {
-          applyPresetFromPlaylist(parentPlaylistPresetId); // reload previous playlist (unfortunately asynchronous)
+          doApplyPreset(parentPlaylistPresetId, CALL_MODE_DIRECT_CHANGE); // reload previous playlist
           parentPlaylistPresetId = 0; // reset previous playlist but do not reset Index or Repeat (they will be loaded & reset in loadPlaylist())
-        } else if (playlistEndPreset) applyPresetFromPlaylist(playlistEndPreset);
+        } else if (playlistEndPreset) doApplyPreset(playlistEndPreset, CALL_MODE_DIRECT_CHANGE);
         return;
       }
       if (playlistRepeat > 1) playlistRepeat--; // decrease repeat count on each index reset if not an endless playlist
@@ -166,7 +166,7 @@ void handlePlaylist() {
     jsonTransitionOnce = true;
     strip.setTransition(playlistEntries[playlistIndex].tr * 100);
     playlistEntryDur = playlistEntries[playlistIndex].dur > 0 ? playlistEntries[playlistIndex].dur : UINT16_MAX;
-    applyPresetFromPlaylist(playlistEntries[playlistIndex].preset);
+    doApplyPreset(playlistEntries[playlistIndex].preset, CALL_MODE_DIRECT_CHANGE);
     doAdvancePlaylist = false;
   }
 }

wled00/presets.cpp

@@ -120,17 +120,8 @@ void initPresetsFile()
   f.close();
 }
 
-bool applyPresetFromPlaylist(byte index)
-{
-  DEBUG_PRINTF_P(PSTR("Request to apply preset: %d\n"), index);
-  presetToApply = index;
-  callModeToApply = CALL_MODE_DIRECT_CHANGE;
-  return true;
-}
-
 bool applyPreset(byte index, byte callMode)
 {
-  unloadPlaylist(); // applying a preset unloads the playlist (#3827)
   DEBUG_PRINTF_P(PSTR("Request to apply preset: %u\n"), index);
   presetToApply = index;
   callModeToApply = callMode;
@@ -149,22 +140,24 @@ void applyPresetWithFallback(uint8_t index, uint8_t callMode, uint8_t effectID,
 void handlePresets()
 {
   // handlePreset() is called from loop(), so there is no need to suspend strip
-  byte presetErrFlag = ERR_NONE;
   if (presetToSave) {
     doSaveState();
-    return;
+  } else {    
+    if (presetToApply) { // preset waiting to apply
+      if (doApplyPreset(presetToApply, callModeToApply)) {
+        presetToApply = 0; //clear request for preset
+        callModeToApply = CALL_MODE_INIT;
+      }
+    }
   }
+}
 
-  if (presetToApply == 0 || !requestJSONBufferLock(9)) return; // no preset waiting to apply, or JSON buffer is already allocated, return to loop until free
+bool doApplyPreset(uint8_t tmpPreset, uint8_t tmpMode)
+{
+  if (!requestJSONBufferLock(9)) return false; // JSON buffer is already allocated
 
   bool changePreset = false;
-  uint8_t tmpPreset = presetToApply; // store temporary since deserializeState() may call applyPreset()
-  uint8_t tmpMode   = callModeToApply;
-
-  JsonObject fdo;
-
-  presetToApply = 0; //clear request for preset
-  callModeToApply = CALL_MODE_INIT;
+  byte presetErrFlag = ERR_NONE;
 
   DEBUG_PRINTF_P(PSTR("Applying preset: %u\n"), (unsigned)tmpPreset);
 
@@ -181,19 +174,21 @@ void handlePresets()
   {
   presetErrFlag = readObjectFromFileUsingId(getPresetsFileName(tmpPreset < 255), tmpPreset, pDoc) ? ERR_NONE : ERR_FS_PLOAD;
   }
-  fdo = pDoc->as<JsonObject>();
+  JsonObject fdo = pDoc->as<JsonObject>();
 
   // only reset errorflag if previous error was preset-related
   if ((errorFlag == ERR_NONE) || (errorFlag == ERR_FS_PLOAD)) errorFlag = presetErrFlag;
 
   //HTTP API commands
   const char* httpwin = fdo["win"];
   if (httpwin) {
+    if (currentPlaylist && fdo["win"].as<String>().indexOf(F("NP")) < 0) unloadPlaylist(); // #5703
     String apireq = "win"; apireq += '&'; // reduce RAM string usage
     apireq += httpwin;
     handleSet(nullptr, apireq, false);    // may call applyPreset() via PL=
     setValuesFromFirstSelectedSeg();      // fills legacy values
   } else {
+    if (currentPlaylist && fdo[F("np")].isNull()) unloadPlaylist(); // applying a preset unloads the playlist (#3827 & #5703)
     // remove load request for presets to prevent recursive crash, except if:
     // - called by button preset which contains preset cycling string "1~5~"
     // - or boot preset (i.e. with preset chaining like {"lor":2,"udpn":{"send":true},"MultiRelay":{"relay":1,"on":true},"ps":"1~5r"})
@@ -216,6 +211,7 @@ void handlePresets()
   #endif
 
   releaseJSONBufferLock();
+  return true;
 }
 
 //called from handleSet(PS=) [network callback (sObj is empty)], IR (irrational) [loop context] and deserializeState() [network callback]

wled00/wled.cpp

@@ -94,10 +94,12 @@ void WLED::loop()
   //handle still pending interface update
   updateInterfaces(interfaceUpdateCallMode);
 
-  if (doCloseFile) {
-    closeFile();
+  if (!presetNeedsSaving()) {
+    handlePlaylist();
     yield();
   }
+  handlePresets();
+  yield();
 
   #if defined(WLED_DEBUG) && defined(WLED_DEBUG_STATS)
   stripMillis = millis();
@@ -117,13 +119,6 @@ void WLED::loop()
     yield();
     #endif
 
-    if (!presetNeedsSaving()) {
-      handlePlaylist();
-      yield();
-    }
-    handlePresets();
-    yield();
-
     if (!offMode || strip.isOffRefreshRequired() || strip.needsUpdate())
       strip.service();
     else {

wled00/wled.h

@@ -9,7 +9,7 @@
 
 // version code in format yymmddb (b = daily build)
 #ifndef AUTOBUILD
-#define VERSION 2606020
+#define VERSION 2606270
 #else
 #define VERSION BUILD
 #endif
@@ -687,7 +687,6 @@ WLED_GLOBAL Toki toki _INIT(Toki());
 WLED_GLOBAL size_t fsBytesUsed _INIT(0);
 WLED_GLOBAL size_t fsBytesTotal _INIT(0);
 WLED_GLOBAL unsigned long presetsModifiedTime _INIT(0L);
-WLED_GLOBAL bool doCloseFile _INIT(false);
 
 // presets
 WLED_GLOBAL byte currentPreset _INIT(0);