ci: update screenshot compare from v9 to automatically create missing reference images

tests/unity/unity_support.c

@@ -28,6 +28,8 @@
  *********************/
 //#define REF_IMGS_PATH "lvgl/tests/lv_test_ref_imgs/"
 #define REF_IMGS_PATH "ref_imgs/"
+#define ERR_FILE_NOT_FOUND  -1
+#define ERR_PNG             -2
 
 /**********************
  *      TYPEDEFS
@@ -47,6 +49,7 @@ typedef struct {
  *  STATIC PROTOTYPES
  **********************/
 static int read_png_file(png_img_t * p, const char * file_name);
+static int write_png_file(void * raw_img, uint32_t width, uint32_t height, char * file_name);
 static void png_release(png_img_t * p);
 
 /**********************
@@ -66,18 +69,28 @@ bool lv_test_assert_img_eq(const char * fn_ref)
     char fn_ref_full[512];
     sprintf(fn_ref_full, "%s%s", REF_IMGS_PATH, fn_ref);
 
-  png_img_t p;
-  int res = read_png_file(&p, fn_ref_full);
-  if(res < 0) return false;
     uint8_t * screen_buf;
 
     lv_obj_invalidate(lv_scr_act());
     lv_refr_now(NULL);
 
-  extern lv_color_t test_fb[];
+    extern lv_color32_t test_fb[];
 
     screen_buf = (uint8_t *)test_fb;
 
+    png_img_t p;
+    int res = read_png_file(&p, fn_ref_full);
+    if(res == ERR_FILE_NOT_FOUND) {
+        TEST_PRINTF("%s%s", fn_ref_full, " was not found, creating is now from the rendered screen");
+        fflush(stderr);
+        write_png_file(screen_buf, 800, 480, fn_ref_full);
+
+        return true;
+    }
+    else if(res == ERR_PNG) {
+        return false;
+    }
+
     uint8_t * ptr_act = NULL;
     const png_byte * ptr_ref = NULL;
 
@@ -108,46 +121,15 @@ bool lv_test_assert_img_eq(const char * fn_ref)
     }
 
     if(err) {
-      uint32_t ref_px = 0;
+        char fn_ref_no_ext[64];
-      uint32_t act_px = 0;
+        strcpy(fn_ref_no_ext, fn_ref);
-      memcpy(&ref_px, ptr_ref, 3);
+        fn_ref_no_ext[strlen(fn_ref_no_ext) - 4] = '\0';
-      memcpy(&act_px, ptr_act, 3);
 
-      FILE * f = fopen("../test_screenshot_error.h", "w");
+        char fn_err_full[512];
+        sprintf(fn_err_full, "%s%s_err.png", REF_IMGS_PATH, fn_ref_no_ext);
 
-      fprintf(f, "//Diff in %s at (%d;%d), %x instead of %x)\n\n", fn_ref, x, y, act_px, ref_px);
+        write_png_file(screen_buf, 800, 480, fn_err_full);
-      fprintf(f, "static const uint32_t test_screenshot_error_data[] = {\n");
-
-      i_buf = 0;
-      for (y = 0; y < 480; y++) {
-        fprintf(f, "\n");
-        for (x = 0; x < 800; x++) {
-          ptr_act = &(screen_buf[i_buf * 4]);
-          act_px = 0;
-          memcpy(&act_px, ptr_act, 3);
-          fprintf(f, "0xFF%06X, ", act_px);
-          i_buf++;
     }
-      }
-      fprintf(f, "};\n\n");
-
-      fprintf(f, "static lv_img_dsc_t test_screenshot_error_dsc = { \n"
-      "  .header.w = 800,\n"
-      "  .header.h = 480,\n"
-      "  .header.always_zero = 0,\n"
-      "  .header.cf = LV_IMG_CF_TRUE_COLOR,\n"
-      "  .data_size = 800 * 480 * 4,\n"
-      "  .data = test_screenshot_error_data};\n\n"
-      "static inline void test_screenshot_error_show(void)\n"
-      "{\n"
-      "  lv_obj_t * img = lv_img_create(lv_scr_act());\n"
-      "  lv_img_set_src(img, &test_screenshot_error_dsc);\n"
-      "}\n");
-
-      fclose(f);
-
-  }
-
 
     png_release(&p);
 
@@ -166,32 +148,32 @@ static int read_png_file(png_img_t * p, const char* file_name)
     /*open file and test for it being a png*/
     FILE * fp = fopen(file_name, "rb");
     if(!fp) {
-       TEST_PRINTF("%s", "PNG file %s could not be opened for reading");
+        TEST_PRINTF("[read_png_file %s] could not be opened for reading", file_name);
-        return -1;
+        return ERR_FILE_NOT_FOUND;
     }
 
     size_t rcnt = fread(header, 1, 8, fp);
     if(rcnt != 8 || png_sig_cmp((png_const_bytep)header, 0, 8)) {
-        TEST_PRINTF("%s is not recognized as a PNG file", file_name);
+        TEST_PRINTF("[read_png_file %s]  not recognized as a PNG file", file_name);
-        return -1;
+        return ERR_PNG;
     }
 
     /*initialize stuff*/
     p->png_ptr = png_create_read_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
 
     if(!p->png_ptr) {
-        TEST_PRINTF("%s", "png_create_read_struct failed");
+        TEST_PRINTF("[read_png_file %s] png_create_read_struct failed", file_name);
-        return -1;
+        return ERR_PNG;
     }
 
     p->info_ptr = png_create_info_struct(p->png_ptr);
     if(!p->info_ptr) {
-        TEST_PRINTF("%s", "png_create_info_struct failed");
+        TEST_PRINTF("[read_png_file %s] png_create_info_struct failed", file_name);
-        return -1;
+        return ERR_PNG;
     }
     if(setjmp(png_jmpbuf(p->png_ptr))) {
-        TEST_PRINTF("%s", "Error during init_io");
+        TEST_PRINTF("[read_png_file %s] Error during init_io", file_name);
-        return -1;
+        return ERR_PNG;
     }
     png_init_io(p->png_ptr, fp);
     png_set_sig_bytes(p->png_ptr, 8);
@@ -208,8 +190,8 @@ static int read_png_file(png_img_t * p, const char* file_name)
 
     /*read file*/
     if(setjmp(png_jmpbuf(p->png_ptr))) {
-        TEST_PRINTF("%s", "Error during read_image");
+        TEST_PRINTF("[read_png_file %s] Error during read_image", file_name);
-        return -1;
+        return ERR_PNG;
     }
     p->row_pointers = (png_bytep *) malloc(sizeof(png_bytep) * p->height);
 
@@ -223,6 +205,94 @@ static int read_png_file(png_img_t * p, const char* file_name)
     return 0;
 }
 
+
+static int write_png_file(void * raw_img, uint32_t width, uint32_t height, char * file_name)
+{
+    png_structp png_ptr;
+    png_infop info_ptr;
+
+    /* create file */
+    FILE * fp = fopen(file_name, "wb");
+    if(!fp) {
+        printf("###### %s\n", file_name);
+        fflush(stdout);
+        TEST_PRINTF("[write_png_file %s] could not be opened for writing", file_name);
+        TEST_PRINTF("%s", file_name);
+        return -1;
+    }
+
+    /* initialize stuff */
+    png_ptr = png_create_write_struct(PNG_LIBPNG_VER_STRING, NULL, NULL, NULL);
+
+    if(!png_ptr) {
+        TEST_PRINTF("[write_png_file %s] png_create_write_struct failed", file_name);
+        return -1;
+    }
+
+    info_ptr = png_create_info_struct(png_ptr);
+    if(!info_ptr) {
+        TEST_PRINTF("[write_png_file %s] png_create_info_struct failed", file_name);
+        return -1;
+    }
+
+    if(setjmp(png_jmpbuf(png_ptr))) {
+        TEST_PRINTF("[write_png_file %s] Error during init_io", file_name);
+        return -1;
+    }
+
+    png_init_io(png_ptr, fp);
+
+    /* write header */
+    if(setjmp(png_jmpbuf(png_ptr))) {
+        TEST_PRINTF("[write_png_file %s] Error during writing header", file_name);
+        return -1;
+    }
+
+    png_set_IHDR(png_ptr, info_ptr, width, height,
+                 8, PNG_COLOR_TYPE_RGB, PNG_INTERLACE_NONE,
+                 PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
+
+    png_write_info(png_ptr, info_ptr);
+
+
+    /* write bytes */
+    if(setjmp(png_jmpbuf(png_ptr))) {
+        TEST_PRINTF("[write_png_file %s] Error during writing bytes", file_name);
+        return -1;
+    }
+
+    uint8_t * raw_img8 = (uint8_t *)raw_img;
+    png_bytep * row_pointers = (png_bytep *) malloc(sizeof(png_bytep) * height);
+    for(uint32_t y = 0; y < height; y++) {
+        row_pointers[y] = malloc(3 * width);
+        uint8_t * line = raw_img8 + y * width * 4;
+        for(uint32_t x = 0; x < width; x++) {
+            row_pointers[y][x * 3 + 0] = line[x * 4 + 2];
+            row_pointers[y][x * 3 + 1] = line[x * 4 + 1];
+            row_pointers[y][x * 3 + 2] = line[x * 4 + 0];
+        }
+    }
+    png_write_image(png_ptr, row_pointers);
+
+
+    /* end write */
+    if(setjmp(png_jmpbuf(png_ptr))) {
+        TEST_PRINTF("[write_png_file %s] Error during end of write", file_name);
+        return -1;
+    }
+    png_write_end(png_ptr, NULL);
+
+    /* cleanup heap allocation */
+    for(uint32_t y = 0; y < height; y++) free(row_pointers[y]);
+    free(row_pointers);
+
+    png_destroy_write_struct(&png_ptr, &info_ptr);
+
+    fclose(fp);
+    return 0;
+}
+
+
 static void png_release(png_img_t * p)
 {
     int y;