feat(esp_jpeg): Add configuration option for working buffer size

Author: tore-espressif

esp_jpeg/CHANGELOG.md

@@ -0,0 +1,28 @@
+## 1.2.0
+
+- Added option to define working buffer size
+
+## 1.1.0
+
+- Added support for decoding images without Huffman tables
+- Fixed undefined configuration options from Kconfig
+
+## 1.0.5~3
+
+- Added option to swap output color bytes regardless of JD_FORMAT
+
+## 1.0.4
+
+- Added ROM implementation support for ESP32-C6
+
+## 1.0.2
+
+- Fixed compiler warnings
+
+## 1.0.1
+
+- Fixed: exclude ESP32-C2 from list of ROM implementations
+
+## 1.0.0
+
+- Initial version

esp_jpeg/README.md

@@ -1,6 +1,7 @@
 # JPEG Decoder: TJpgDec - Tiny JPEG Decompressor
 
 [![Component Registry](https://components.espressif.com/components/espressif/esp_jpeg/badge.svg)](https://components.espressif.com/components/espressif/esp_jpeg)
+![maintenance-status](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)
 
 TJpgDec is a lightweight JPEG image decompressor optimized for embedded systems with minimal memory consumption.
 
@@ -25,6 +26,7 @@ On some microcontrollers, TJpgDec is available in ROM and will be used by defaul
 - Pixel format options: RGB888, RGB565
 - Selectable scaling ratios: 1/1, 1/2, 1/4, or 1/8 (chosen at decompression)
 - Option to swap the first and last bytes of color values
+- Size of Tjpgd working buffer: Adjustable to optimize performance or memory usage, allowing increases for handling complex formats or reductions to conserve memory
 
 ## TJpgDec in ROM
 

esp_jpeg/examples/get_started/sdkconfig.defaults

@@ -0,0 +1,4 @@
+# This file was generated using idf.py save-defconfig. It can be edited manually.
+# Espressif IoT Development Framework (ESP-IDF) 5.5.0 Project Minimal Configuration
+#
+CONFIG_TOUCH_SUPPRESS_DEPRECATE_WARN=y

esp_jpeg/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.1.0"
+version: "1.2.0"
 description: "JPEG Decoder: TJpgDec"
 url: https://github.com/espressif/idf-extra-components/tree/master/esp_jpeg/
 dependencies:

esp_jpeg/include/jpeg_decoder.h

@@ -48,6 +48,12 @@ typedef struct esp_jpeg_image_cfg_s {
         uint8_t swap_color_bytes: 1; /*!< Swap first and last color bytes */
     } flags;
 
+    struct {
+        size_t working_buffer_size; /*!< Size of working memory for the decoder. Set to 0 for default value.
+                                         Default size is 3.1kB or 65kB if JD_FASTDECODE == 2
+                                         Tjpgd does not use dynamic allocation, se we pass this buffer to Tjpgd that uses it as scratchpad */
+    } advanced;
+
     struct {
         uint32_t read;  /*!< Internal count of read bytes */
     } priv;

esp_jpeg/jpeg_decoder.c

@@ -79,13 +79,14 @@ esp_err_t esp_jpeg_decode(esp_jpeg_image_cfg_t *cfg, esp_jpeg_image_output_t *im
     assert(cfg != NULL);
     assert(img != NULL);
 
-    workbuf = heap_caps_malloc(JPEG_WORK_BUF_SIZE, MALLOC_CAP_DEFAULT);
+    const size_t workbuf_size = cfg->advanced.working_buffer_size ? cfg->advanced.working_buffer_size : JPEG_WORK_BUF_SIZE;
+    workbuf = heap_caps_malloc(workbuf_size, MALLOC_CAP_DEFAULT);
     ESP_GOTO_ON_FALSE(workbuf, ESP_ERR_NO_MEM, err, TAG, "no mem for JPEG work buffer");
 
     cfg->priv.read = 0;
 
     /* Prepare image */
-    res = jd_prepare(&JDEC, jpeg_decode_in_cb, workbuf, JPEG_WORK_BUF_SIZE, cfg);
+    res = jd_prepare(&JDEC, jpeg_decode_in_cb, workbuf, workbuf_size, cfg);
     ESP_GOTO_ON_FALSE((res == JDR_OK), ESP_FAIL, err, TAG, "Error in preparing JPEG image! %d", res);
 
     uint8_t scale_div = jpeg_get_div_by_scale(cfg->out_scale);