From e852df3179641ef9fe411608d69090aa1c2a5f4a Mon Sep 17 00:00:00 2001
From: Christian Schwinne <dev.aircoookie@gmail.com>
Date: Sat, 13 Apr 2024 20:06:33 +0200
Subject: [PATCH] Proper debug statements

---
 wled00/image_loader.cpp | 144 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 144 insertions(+)
 create mode 100644 wled00/image_loader.cpp

diff --git a/wled00/image_loader.cpp b/wled00/image_loader.cpp
new file mode 100644
index 000000000..31a84e660
--- /dev/null
+++ b/wled00/image_loader.cpp
@@ -0,0 +1,144 @@
+#include "wled.h"
+
+#ifndef WLED_DISABLE_GIF
+
+#include "GifDecoder.h"
+
+
+/*
+ * Functions to render images from filesystem to segments, used by the "Image" effect
+ */
+
+File file;
+char lastFilename[34] = "/";
+GifDecoder<320,320,12,true> decoder;
+bool gifDecodeFailed = false;
+unsigned long lastFrameDisplayTime = 0, currentFrameDelay = 0;
+
+bool fileSeekCallback(unsigned long position) {
+  return file.seek(position);
+}
+
+unsigned long filePositionCallback(void) {
+  return file.position();
+}
+
+int fileReadCallback(void) {
+  return file.read();
+}
+
+int fileReadBlockCallback(void * buffer, int numberOfBytes) {
+  return file.read((uint8_t*)buffer, numberOfBytes);
+}
+
+int fileSizeCallback(void) {
+  return file.size();
+}
+
+bool openGif(const char *filename) {
+  file = WLED_FS.open(filename, "r");
+
+  if (!file) return false;
+  return true;
+}
+
+Segment* activeSeg;
+uint16_t gifWidth, gifHeight;
+
+void screenClearCallback(void) {
+  activeSeg->fill(0);
+}
+
+void updateScreenCallback(void) {}
+
+void drawPixelCallback(int16_t x, int16_t y, uint8_t red, uint8_t green, uint8_t blue) {
+  // simple nearest-neighbor scaling 
+  int16_t outY = y * activeSeg->height() / gifHeight;
+  int16_t outX = x * activeSeg->width()  / gifWidth;
+  // set multiple pixels if upscaling
+  for (int16_t i = 0; i < (activeSeg->width()+(gifWidth-1)) / gifWidth; i++) {
+    for (int16_t j = 0; j < (activeSeg->height()+(gifHeight-1)) / gifHeight; j++) {
+      activeSeg->setPixelColorXY(outX + i, outY + j, gamma8(red), gamma8(green), gamma8(blue));
+    }
+  }
+}
+
+#define IMAGE_ERROR_NONE 0
+#define IMAGE_ERROR_NO_NAME 1
+#define IMAGE_ERROR_SEG_LIMIT 2
+#define IMAGE_ERROR_UNSUPPORTED_FORMAT 3
+#define IMAGE_ERROR_FILE_MISSING 4
+#define IMAGE_ERROR_DECODER_ALLOC 5
+#define IMAGE_ERROR_GIF_DECODE 6
+#define IMAGE_ERROR_FRAME_DECODE 7
+#define IMAGE_ERROR_WAITING 254
+#define IMAGE_ERROR_PREV 255
+
+// renders an image (.gif only; .bmp and .fseq to be added soon) from FS to a segment
+byte renderImageToSegment(Segment &seg) {
+  if (!seg.name) return IMAGE_ERROR_NO_NAME;
+  // disable during effect transition, causes flickering, multiple allocations and depending on image, part of old FX remaining
+  if (seg.mode != seg.currentMode()) return IMAGE_ERROR_WAITING;
+  if (activeSeg && activeSeg != &seg) return IMAGE_ERROR_SEG_LIMIT; // only one segment at a time
+  activeSeg = &seg;
+
+  if (strncmp(lastFilename +1, seg.name, 32) != 0) { // segment name changed, load new image
+    strncpy(lastFilename +1, seg.name, 32);
+    gifDecodeFailed = false;
+    if (strcmp(lastFilename + strlen(lastFilename) - 4, ".gif") != 0) {
+      gifDecodeFailed = true;
+      return IMAGE_ERROR_UNSUPPORTED_FORMAT;
+    }
+    if (file) file.close();
+    openGif(lastFilename);
+    if (!file) { gifDecodeFailed = true; return IMAGE_ERROR_FILE_MISSING; }
+    decoder.setScreenClearCallback(screenClearCallback);
+    decoder.setUpdateScreenCallback(updateScreenCallback);
+    decoder.setDrawPixelCallback(drawPixelCallback);
+    decoder.setFileSeekCallback(fileSeekCallback);
+    decoder.setFilePositionCallback(filePositionCallback);
+    decoder.setFileReadCallback(fileReadCallback);
+    decoder.setFileReadBlockCallback(fileReadBlockCallback);
+    decoder.setFileSizeCallback(fileSizeCallback);
+    decoder.alloc();
+    DEBUG_PRINTLN(F("Starting decoding"));
+    if(decoder.startDecoding() < 0) { gifDecodeFailed = true; return IMAGE_ERROR_GIF_DECODE; }
+    DEBUG_PRINTLN(F("Decoding started"));
+  }
+
+  if (gifDecodeFailed) return IMAGE_ERROR_PREV;
+  if (!file) { gifDecodeFailed = true; return IMAGE_ERROR_FILE_MISSING; }
+  //if (!decoder) { gifDecodeFailed = true; return IMAGE_ERROR_DECODER_ALLOC; }
+
+  // speed 0 = half speed, 128 = normal, 255 = full FX FPS
+  // TODO: 0 = 4x slow, 64 = 2x slow, 128 = normal, 192 = 2x fast, 255 = 4x fast
+  uint32_t wait = currentFrameDelay * 2 - seg.speed * currentFrameDelay / 128;
+
+  // TODO consider handling this on FX level with a different frametime, but that would cause slow gifs to speed up during transitions
+  if (millis() - lastFrameDisplayTime < wait) return IMAGE_ERROR_WAITING;
+
+  decoder.getSize(&gifWidth, &gifHeight);
+
+  int result = decoder.decodeFrame(false);
+  if (result < 0) { gifDecodeFailed = true; return IMAGE_ERROR_FRAME_DECODE; }
+
+  currentFrameDelay = decoder.getFrameDelay_ms();
+  unsigned long tooSlowBy = (millis() - lastFrameDisplayTime) - wait; // if last frame was longer than intended, compensate
+  currentFrameDelay = tooSlowBy > currentFrameDelay ? 0 : currentFrameDelay - tooSlowBy;
+  lastFrameDisplayTime = millis();
+
+  return IMAGE_ERROR_NONE;
+}
+
+void endImagePlayback(Segment *seg) {
+  DEBUG_PRINTLN(F("Image playback end called"));
+  if (!activeSeg || activeSeg != seg) return;
+  if (file) file.close();
+  decoder.dealloc();
+  gifDecodeFailed = false;
+  activeSeg = nullptr;
+  lastFilename[1] = '\0';
+  DEBUG_PRINTLN(F("Image playback ended"));
+}
+
+#endif
\ No newline at end of file