feat(xz): Make xz multi call decompression APIs public

Author: Harshal5

components/utilities/xz/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ChangeLog
 
+## v1.1.0 - 2025-3-25
+
+### Features:
+
+- Make the xz_embedded library's multi-call APIs public
+
 ## v1.0.1 - 2025-2-20
 
 ### bugfix:

components/utilities/xz/CMakeLists.txt

@@ -1,7 +1,7 @@
-set(incs "include")
+set(incs "include"
+         "xz-embedded/linux/include/linux")
 
 set(priv_incs "port/include"
-              "xz-embedded/linux/include/linux"
               "xz-embedded/linux/lib/xz")
 
 set(srcs "src/xz_decompress.c"
@@ -11,4 +11,4 @@ set(srcs "src/xz_decompress.c"
 
 idf_component_register(SRCS ${srcs}
                        INCLUDE_DIRS ${incs}
-                       PRIV_INCLUDE_DIRS ${priv_incs})
+                       PRIV_INCLUDE_DIRS ${priv_incs})

components/utilities/xz/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.0.1"
+version: "1.1.0"
 description: xz decompression utility
 url: https://github.com/espressif/esp-iot-solution/tree/master/components/utilities/xz
 dependencies:

examples/utilities/xz_decompress_file/main/idf_component.yml

@@ -1,5 +1,5 @@
 dependencies:
   xz:
-    version: "~1.0.0"
+    version: "~1.1.0"
     # Please comment the following line, if this example is installed by idf.py create-project-from-example.
     override_path: "../../../../components/utilities/xz"

examples/utilities/xz_decompress_file/main/xz_decompress_file_example_main.c

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: CC0-1.0
  */
@@ -10,6 +10,7 @@
 #include "esp_log.h"
 
 #include "xz_decompress.h"
+#include "xz.h"
 
 #define IO_BUFFER_LEN (2048)
 
@@ -100,6 +101,87 @@ static void test_cb_to_buf(void)
     free(in_buf);
 }
 
+#define CHUNK_SIZE 4096
+static void test_chunked_api(void)
+{
+    ESP_LOGI(TAG, "Using chunked decompression API");
+
+    // Initialize the decoder with prealloc mode to control memory usage
+    // Using a smaller dictionary size reduces memory requirements
+    struct xz_dec *decoder = xz_dec_init(XZ_PREALLOC, 1 << 16); // 64KB dictionary
+    if (!decoder) {
+        ESP_LOGE(TAG, "Failed to initialize XZ decoder");
+        return;
+    }
+
+    uint8_t *in_buffer = malloc(CHUNK_SIZE);
+    uint8_t *out_buffer = malloc(CHUNK_SIZE);
+
+    if (!in_buffer || !out_buffer) {
+        ESP_LOGE(TAG, "Failed to allocate buffers");
+        free(in_buffer);
+        free(out_buffer);
+        xz_dec_end(decoder);
+        return;
+    }
+
+    struct xz_buf buffer = {
+        .in = in_buffer,
+        .in_pos = 0,
+        .in_size = 0,
+        .out = out_buffer,
+        .out_pos = 0,
+        .out_size = CHUNK_SIZE
+    };
+
+    // Track total bytes processed
+    size_t total_in = 0;
+    size_t total_out = 0;
+    size_t remaining = compressed_file_length;
+
+    // Process the compressed data in chunks
+    enum xz_ret ret = XZ_OK;
+    while (ret != XZ_STREAM_END) {
+        if (buffer.in_pos == buffer.in_size && remaining > 0) {
+            size_t read_size = remaining > CHUNK_SIZE ? CHUNK_SIZE : remaining;
+
+            memcpy(in_buffer, xz_compressed_file_start + total_in, read_size);
+
+            buffer.in_pos = 0;
+            buffer.in_size = read_size;
+
+            total_in += read_size;
+            remaining -= read_size;
+        }
+
+        ret = xz_dec_run(decoder, &buffer);
+
+        if (buffer.out_pos > 0) {
+            // Only for this example, as we would be printing the entire decompressed data
+            out_buffer[buffer.out_pos] = '\0';
+            ESP_LOGI(TAG, "Decompressed chunk (%u bytes)", buffer.out_pos);
+
+            total_out += buffer.out_pos;
+            buffer.out_pos = 0;
+        }
+
+        if (ret != XZ_OK && ret != XZ_STREAM_END) {
+            ESP_LOGE(TAG, "Decompression error: %d", ret);
+            break;
+        }
+    }
+
+    ESP_LOGI(TAG, "Chunked decompression stats:");
+    ESP_LOGI(TAG, "Input bytes processed: %u", total_in);
+    ESP_LOGI(TAG, "Output bytes produced: %u", total_out);
+    ESP_LOGI(TAG, "Decompressed data:\n%s", out_buffer);
+
+    // Clean up
+    free(in_buffer);
+    free(out_buffer);
+    xz_dec_end(decoder);
+}
+
 void app_main(void)
 {
     size_t origin_file_length = origin_file_end - origin_file_start;
@@ -126,6 +208,10 @@ void app_main(void)
     test_buf_to_cb();
     ESP_LOGI(TAG, "*****************test buf to callback end*************\n");
 
+    ESP_LOGI(TAG, "*****************test chunked API begin***************\n");
+    test_chunked_api();
+    ESP_LOGI(TAG, "*****************test chunked API end*****************\n");
+
     // All done
     ESP_LOGI(TAG, "TASK FINISH");
 }