Remove the use of XPM from the X11 backend.

This enables the setting of higher quality icons.

Idea and some implementation from #1375

Author: SiegeLordEx

CMakeLists.txt

@@ -752,13 +752,6 @@ if(SUPPORT_X11)
         message(FATAL_ERROR "X11 support requires Xcursor library.")
     endif(CAN_XCURSOR)
 
-    check_library_exists(Xpm XpmCreatePixmapFromData "" CAN_XPM)
-    if(CAN_XPM)
-        set(ALLEGRO_XWINDOWS_WITH_XPM 1)
-        find_library(XPM_LIB "Xpm")
-        list(APPEND X11_LIBRARIES "${XPM_LIB}")
-    endif(CAN_XPM)
-
     check_include_file("X11/extensions/XInput2.h" CAN_XINPUT2)
     run_c_compile_test("
         #include <X11/extensions/XInput2.h>

include/allegro5/platform/alplatf.h.cmake

@@ -109,8 +109,6 @@
 /* Define if XInput 2.2 X11 extension is supported. */
 #cmakedefine ALLEGRO_XWINDOWS_WITH_XINPUT2
 
-/* Define if Xpm is found. Useful on Ubuntu Unity to set icon. */
-#cmakedefine ALLEGRO_XWINDOWS_WITH_XPM
 
 /*---------------------------------------------------------------------------*/
 

misc/make_icon.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+"""Generate the icon.c file used for the default icon.
+
+Usage:
+
+    make_icon.py in_file.png out_file.inc
+"""
+
+import numpy as np
+import PIL.Image
+import sys
+
+image = np.array(PIL.Image.open(sys.argv[1]).convert("RGBA"))
+
+with open(sys.argv[2], "w") as f:
+    f.write("/* Generated using make_icon.py */\n")
+    f.write(f"#define ICON_WIDTH {image.shape[1]}\n")
+    f.write(f"#define ICON_HEIGHT {image.shape[0]}\n")
+    f.write("static uint32_t icon_data[] = {\n")
+    for i, row in enumerate(image):
+        for j, col in enumerate(row):
+            # Premultiply alpha.
+            col = col.astype(np.float32) / 255.
+            col = (col * col[-1] * 255.).astype(np.uint32)
+            col = (col[0] << 24) + (col[1] << 16) + (col[2] << 8) + col[3]
+            f.write(f"{col:#010x}")
+            if i + 1 < image.shape[0] or j + 1 < image.shape[1]:
+                f.write(",")
+        f.write("\n")
+    f.write("};\n")

src/x/icon.inc

@@ -18,11 +18,8 @@
 #include <X11/extensions/XInput2.h>
 #endif
 
-#ifdef ALLEGRO_XWINDOWS_WITH_XPM
-#include <X11/xpm.h>
-#endif
-
 #include "xicon.h"
+#include "icon.inc"
 
 ALLEGRO_DEBUG_CHANNEL("display")
 
@@ -529,27 +526,6 @@ static ALLEGRO_DISPLAY_XGLX *xdpy_create_display_locked(
    return NULL;
 }
 
-static void set_initial_icon(Display *x11display, Window window)
-{
-#ifdef ALLEGRO_XWINDOWS_WITH_XPM
-   XWMHints *wm_hints;
-
-   if (x11_xpm == NULL)
-      return;
-
-   wm_hints = XAllocWMHints();
-
-   wm_hints->flags |= IconPixmapHint | IconMaskHint;
-   XpmCreatePixmapFromData(x11display, window, x11_xpm,
-      &wm_hints->icon_pixmap, &wm_hints->icon_mask, NULL);
-
-   XSetWMHints(x11display, window, wm_hints);
-   XFree(wm_hints);
-#else
-   (void)x11display;
-   (void)window;
-#endif
-}
 
 static bool xdpy_create_display_hook_default(ALLEGRO_DISPLAY *display,
    int w, int h)
@@ -559,7 +535,24 @@ static bool xdpy_create_display_hook_default(ALLEGRO_DISPLAY *display,
    (void)w;
    (void)h;
 
-   set_initial_icon(system->x11display, d->window);
+   if (_al_xwin_initial_icon) {
+      ALLEGRO_BITMAP *bitmaps[] = {_al_xwin_initial_icon};
+      _al_xwin_set_icons(display, 1, bitmaps);
+   } else {
+      ALLEGRO_STATE state;
+      al_store_state(&state, ALLEGRO_STATE_NEW_BITMAP_PARAMETERS);
+      ALLEGRO_BITMAP *bitmap = al_create_bitmap(ICON_WIDTH, ICON_HEIGHT);
+
+      ALLEGRO_LOCKED_REGION *lr = al_lock_bitmap(bitmap, ALLEGRO_PIXEL_FORMAT_RGBA_8888, ALLEGRO_LOCK_WRITEONLY);
+      for (int y = 0; y < ICON_HEIGHT; y++) {
+         memcpy((char*)lr->data + lr->pitch * y, &icon_data[ICON_WIDTH * y], ICON_WIDTH * 4);
+      }
+      al_unlock_bitmap(bitmap);
+
+      ALLEGRO_BITMAP *bitmaps[] = {bitmap};
+      _al_xwin_set_icons(display, 1, bitmaps);
+      al_destroy_bitmap(bitmap);
+   }
 
    XLockDisplay(system->x11display);
 

src/x/icon.xpm

@@ -1,6 +1,6 @@
 #ifndef XICON_H
 #define XICON_H
 
-extern char **x11_xpm;
+extern ALLEGRO_BITMAP *_al_xwin_initial_icon;
 
 #endif // XICON_H

src/x/xdisplay.c

@@ -27,144 +27,22 @@ ALLEGRO_DEBUG_CHANNEL("system")
 
 static ALLEGRO_SYSTEM_INTERFACE *xglx_vt;
 
-char **x11_xpm = NULL;
+ALLEGRO_BITMAP *_al_xwin_initial_icon = NULL;
 
 static bool xglx_inhibit_screensaver(bool inhibit);
 
-#ifdef ALLEGRO_XWINDOWS_WITH_XPM
-#include <stdio.h>
-#include "icon.xpm"
-
-static bool x11_xpm_set;
-static int x11_xpm_rows;
-
-static char **bitmap_to_xpm(ALLEGRO_BITMAP *bitmap, int *nrows_ret)
-{
-   _AL_VECTOR v;
-   int w, h, x, y;
-   int ncolors, nrows;
-   char **xpm;
-   char buf[100];
-   int i;
-
-   ALLEGRO_LOCKED_REGION *lr = al_lock_bitmap(bitmap, ALLEGRO_PIXEL_FORMAT_ABGR_8888_LE, ALLEGRO_LOCK_READONLY);
-   if (lr == NULL)
-      return NULL;
-
-   _al_vector_init(&v, sizeof(uint32_t));
-
-   w = al_get_bitmap_width(bitmap);
-   h = al_get_bitmap_height(bitmap);
-
-   for (y = 0; y < h; y++) {
-      for (x = 0; x < w; x++) {
-         uint32_t c = *(uint32_t *)((((char *)lr->data) + lr->pitch * y + x * 4));
-         int alpha = (c >> 24) & 0xff;
-         if (alpha != 255) {
-                 c = 0;
-         }
-         int sz = _al_vector_size(&v);
-         bool found = false;
-         for (i = 0; i < sz; i++) {
-            if (*((uint32_t *)_al_vector_ref(&v, i)) == c) {
-               found = true;
-               break;
-            }
-         }
-         if (found == false) {
-            uint32_t *p = _al_vector_alloc_back(&v);
-            *p = c;
-         }
-      }
-   }
-
-   ncolors = _al_vector_size(&v);
-   nrows = 2 + ncolors + h;
-
-   xpm = malloc(nrows * sizeof(char *));
-   if (xpm == NULL)
-      return NULL;
-
-   snprintf(buf, 100, "%d %d %d 8", w, h, ncolors + 1);
-
-   xpm[0] = strdup(buf);
-
-   xpm[1] = strdup("00000000\tc None");
-
-   for (i = 0; i < ncolors; i++) {
-        uint32_t c = *((uint32_t *)_al_vector_ref(&v, i));
-        int r = c & 0xff;
-        int g = (c >> 8) & 0xff;
-        int b = (c >> 16) & 0xff;
-        snprintf(buf, 100, "%08x\tc #%02x%02x%02x", i+1, r, g, b);
-        xpm[i+2] = strdup(buf);
-   }
-
-   for (y = 0; y < h; y++) {
-        int row = y + 2 + ncolors;
-        xpm[row] = malloc(8 * w + 1);
-        xpm[row][8 * w] = 0;
-        uint32_t *p = (uint32_t *)(((char *)lr->data) + lr->pitch * y);
-        for (x = 0; x < w; x++) {
-                uint32_t pixel = *p;
-                int alpha = (pixel >> 24) & 0xff;
-                if (alpha != 255) {
-                   snprintf(buf, 100, "%s", "00000000");
-                }
-                else {
-                   for (i = 0; i < (int)_al_vector_size(&v); i++) {
-                      uint32_t pixel2 = *((uint32_t *)_al_vector_ref(&v, i));
-                      if (pixel == pixel2)
-                         break;
-                   }
-                   snprintf(buf, 100, "%08x", i+1);
-                }
-                for (i = 0; i < 8; i++) {
-                        xpm[row][8*x+i] = buf[i];
-                }
-                p++;
-        }
-   }
-
-   _al_vector_free(&v);
-
-   *nrows_ret = nrows;
-
-   al_unlock_bitmap(bitmap);
-
-   // debug
-   /*
-   for (i = 0; i < nrows; i++) {
-      printf("%s\n", xpm[i]);
-   }
-   */
-
-   return xpm;
-}
-#endif
 
 /* Function: al_x_set_initial_icon
  */
 bool al_x_set_initial_icon(ALLEGRO_BITMAP *bitmap)
 {
-#ifdef ALLEGRO_XWINDOWS_WITH_XPM
-   if (x11_xpm_set) {
-      int i;
-      for (i = 0; i < x11_xpm_rows; i++) {
-         free(x11_xpm[i]);
-      }
-      free(x11_xpm);
-      x11_xpm_set = false;
-   }
-   x11_xpm = bitmap_to_xpm(bitmap, &x11_xpm_rows);
-   if (x11_xpm == NULL)
-      return false;
-   x11_xpm_set = true;
+   ALLEGRO_STATE state;
+   al_store_state(&state, ALLEGRO_STATE_NEW_BITMAP_PARAMETERS);
+   al_set_new_bitmap_flags(ALLEGRO_MEMORY_BITMAP);
+   al_destroy_bitmap(_al_xwin_initial_icon);
+   _al_xwin_initial_icon = al_clone_bitmap(bitmap);
+   al_restore_state(&state);
    return true;
-#else
-   (void)bitmap;
-   return false;
-#endif
 }
 
 static ALLEGRO_SYSTEM *xglx_initialize(int flags)
@@ -246,10 +124,6 @@ static ALLEGRO_SYSTEM *xglx_initialize(int flags)
       }
    }
 
-#ifdef ALLEGRO_XWINDOWS_WITH_XPM
-   x11_xpm = icon_xpm;
-#endif
-
    return &s->system;
 }