update class docstring, return tuple from subscr, refactor and fix get_color to work with more than 2 colors, disable for samd21 instead of individaul boards, input_color_count arg.

FoamyGuy · FoamyGuy · commit 7e8bcae481d2 · 2025-03-06T08:54:20.000-06:00
diff --git a/ports/atmel-samd/boards/circuitbrains_basic_m0/mpconfigboard.mk b/ports/atmel-samd/boards/circuitbrains_basic_m0/mpconfigboard.mk
@@ -11,4 +11,3 @@ EXTERNAL_FLASH_DEVICES = "W25Q32JVxQ"
 LONGINT_IMPL = MPZ
 
 CIRCUITPY_JPEGIO = 0
-CIRCUITPY_TILEPALETTEMAPPER = 0
diff --git a/ports/atmel-samd/boards/feather_m0_express/mpconfigboard.mk b/ports/atmel-samd/boards/feather_m0_express/mpconfigboard.mk
@@ -11,4 +11,3 @@ EXTERNAL_FLASH_DEVICES = "S25FL216K, GD25Q16C, W25Q16JVxQ"
 LONGINT_IMPL = MPZ
 
 CIRCUITPY_RAINBOWIO = 0
-CIRCUITPY_TILEPALETTEMAPPER = 0
diff --git a/ports/atmel-samd/boards/feather_m0_supersized/mpconfigboard.mk b/ports/atmel-samd/boards/feather_m0_supersized/mpconfigboard.mk
@@ -9,5 +9,3 @@ CHIP_FAMILY = samd21
 SPI_FLASH_FILESYSTEM = 1
 EXTERNAL_FLASH_DEVICES = "S25FL064L"
 LONGINT_IMPL = MPZ
-
-CIRCUITPY_TILEPALETTEMAPPER = 0
diff --git a/ports/atmel-samd/boards/huntercat_nfc/mpconfigboard.mk b/ports/atmel-samd/boards/huntercat_nfc/mpconfigboard.mk
@@ -9,5 +9,3 @@ CHIP_FAMILY = samd21
 SPI_FLASH_FILESYSTEM = 1
 EXTERNAL_FLASH_DEVICES = "W25Q16JVxQ"
 LONGINT_IMPL = MPZ
-
-CIRCUITPY_TILEPALETTEMAPPER = 0
diff --git a/ports/atmel-samd/boards/itsybitsy_m0_express/mpconfigboard.mk b/ports/atmel-samd/boards/itsybitsy_m0_express/mpconfigboard.mk
@@ -13,4 +13,3 @@ LONGINT_IMPL = MPZ
 CIRCUITPY_BITBANG_APA102 = 1
 
 CIRCUITPY_PULSEIO = 0
-CIRCUITPY_TILEPALETTEMAPPER = 0
diff --git a/ports/atmel-samd/boards/metro_m0_express/mpconfigboard.mk b/ports/atmel-samd/boards/metro_m0_express/mpconfigboard.mk
@@ -12,4 +12,3 @@ LONGINT_IMPL = MPZ
 
 CIRCUITPY_CODEOP = 0
 CIRCUITPY_RAINBOWIO = 0
-CIRCUITPY_TILEPALETTEMAPPER = 0
diff --git a/ports/atmel-samd/boards/qtpy_m0_haxpress/mpconfigboard.mk b/ports/atmel-samd/boards/qtpy_m0_haxpress/mpconfigboard.mk
@@ -9,5 +9,3 @@ CHIP_FAMILY = samd21
 LONGINT_IMPL = MPZ
 SPI_FLASH_FILESYSTEM = 1
 EXTERNAL_FLASH_DEVICES = "GD25Q16C,W25Q16JVxQ,W25Q32FV"
-
-CIRCUITPY_TILEPALETTEMAPPER = 0
diff --git a/ports/atmel-samd/boards/snekboard/mpconfigboard.mk b/ports/atmel-samd/boards/snekboard/mpconfigboard.mk
@@ -9,5 +9,3 @@ CHIP_FAMILY = samd21
 SPI_FLASH_FILESYSTEM = 1
 EXTERNAL_FLASH_DEVICES = "W25Q16JVxQ"
 LONGINT_IMPL = MPZ
-
-CIRCUITPY_TILEPALETTEMAPPER = 0
diff --git a/ports/atmel-samd/boards/sparkfun_redboard_turbo/mpconfigboard.mk b/ports/atmel-samd/boards/sparkfun_redboard_turbo/mpconfigboard.mk
@@ -12,4 +12,3 @@ LONGINT_IMPL = MPZ
 
 CIRCUITPY_CODEOP = 0
 CIRCUITPY_RAINBOWIO = 0
-CIRCUITPY_TILEPALETTEMAPPER = 0
diff --git a/ports/atmel-samd/boards/trinket_m0_haxpress/mpconfigboard.mk b/ports/atmel-samd/boards/trinket_m0_haxpress/mpconfigboard.mk
@@ -11,4 +11,3 @@ EXTERNAL_FLASH_DEVICES = W25Q32BV
 LONGINT_IMPL = MPZ
 
 CIRCUITPY_CODEOP = 0
-CIRCUITPY_TILEPALETTEMAPPER = 0
diff --git a/ports/atmel-samd/mpconfigport.mk b/ports/atmel-samd/mpconfigport.mk
@@ -60,6 +60,7 @@ CIRCUITPY_ZLIB = 0
 # Turn off a few more things that don't fit in 192kB
 
 CIRCUITPY_TERMINALIO_VT100 = 0
+CIRCUITPY_TILEPALETTEMAPPER = 0
 
 ifeq ($(INTERNAL_FLASH_FILESYSTEM),1)
 CIRCUITPY_ONEWIREIO ?= 0
diff --git a/ports/zephyr-cp/boards/nordic/nrf5340dk/autogen_board_info.toml b/ports/zephyr-cp/boards/nordic/nrf5340dk/autogen_board_info.toml
@@ -90,6 +90,7 @@ struct = true
 supervisor = false
 synthio = false
 terminalio = false
+tilepalettemapper = false
 time = true
 touchio = false
 traceback = false
diff --git a/ports/zephyr-cp/boards/nordic/nrf54l15dk/autogen_board_info.toml b/ports/zephyr-cp/boards/nordic/nrf54l15dk/autogen_board_info.toml
@@ -90,6 +90,7 @@ struct = true
 supervisor = false
 synthio = false
 terminalio = false
+tilepalettemapper = false
 time = true
 touchio = false
 traceback = false
diff --git a/ports/zephyr-cp/boards/nordic/nrf7002dk/autogen_board_info.toml b/ports/zephyr-cp/boards/nordic/nrf7002dk/autogen_board_info.toml
@@ -90,6 +90,7 @@ struct = true
 supervisor = false
 synthio = false
 terminalio = false
+tilepalettemapper = false
 time = true
 touchio = false
 traceback = false
diff --git a/ports/zephyr-cp/boards/renesas/ek_ra6m5/autogen_board_info.toml b/ports/zephyr-cp/boards/renesas/ek_ra6m5/autogen_board_info.toml
@@ -90,6 +90,7 @@ struct = true
 supervisor = false
 synthio = false
 terminalio = false
+tilepalettemapper = false
 time = true
 touchio = false
 traceback = false
diff --git a/ports/zephyr-cp/boards/st/nucleo_u575zi_q/autogen_board_info.toml b/ports/zephyr-cp/boards/st/nucleo_u575zi_q/autogen_board_info.toml
@@ -90,6 +90,7 @@ struct = true
 supervisor = false
 synthio = false
 terminalio = false
+tilepalettemapper = false
 time = true
 touchio = false
 traceback = false
diff --git a/ports/zephyr-cp/boards/st/stm32h7b3i_dk/autogen_board_info.toml b/ports/zephyr-cp/boards/st/stm32h7b3i_dk/autogen_board_info.toml
@@ -90,6 +90,7 @@ struct = true
 supervisor = false
 synthio = false
 terminalio = false
+tilepalettemapper = false
 time = true
 touchio = false
 traceback = false
diff --git a/shared-bindings/tilepalettemapper/TilePaletteMapper.c b/shared-bindings/tilepalettemapper/TilePaletteMapper.c
@@ -14,23 +14,28 @@
 #include "shared-bindings/tilepalettemapper/TilePaletteMapper.h"
 
 //| class TilePaletteMapper:
-//|     """Contains a displayio.Palette a series of mappings from one palette color_index to another palette color_index.
-//|     One mapping for tile in a 2D grid. Can be set as the pixel_shader for a TileGrid to re-map the colors for
-//|     specific tile(s) within the TileGrid."""
+//|     """Remaps color indices from the source bitmap to alternate indices on a
+//|		   per-tile basis. This allows for altering coloring of tiles based on
+//|		   their tilegrid location. It also allows for using a limited color
+//|                                                        bitmap with a wider array of colors."""
 //|
-//|     def __init__(self, palette: displayio.Palette, width: int, height: int) -> None:
+//|     def __init__(
+//|         self, palette: displayio.Palette, input_color_count: int, width: int, height: int
+//|     ) -> None:
 //|         """Create a TilePaletteMApper object to store a set of color mappings for tiles.
 //|
 //|         :param displayio.Palette palette: The palette to get mapped colors from.
+//|         :param int input_color_count: The number of colors in in the input bitmap.
 //|         :param int width: The width of the grid in tiles.
 //|         :param int height: The height of the grid in tiles.
 //|         """
 //|         ...
 //|
 static mp_obj_t tilepalettemapper_tilepalettemapper_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
-    enum { ARG_palette, ARG_width, ARG_height };
+    enum { ARG_palette, ARG_input_color_count, ARG_width, ARG_height };
     static const mp_arg_t allowed_args[] = {
         { MP_QSTR_palette, MP_ARG_OBJ | MP_ARG_REQUIRED },
+        { MP_QSTR_input_color_count, MP_ARG_INT | MP_ARG_REQUIRED, {.u_int = 1} },
         { MP_QSTR_width, MP_ARG_INT | MP_ARG_REQUIRED, {.u_int = 1} },
         { MP_QSTR_height, MP_ARG_INT | MP_ARG_REQUIRED, {.u_int = 1} },
     };
@@ -41,7 +46,7 @@ static mp_obj_t tilepalettemapper_tilepalettemapper_make_new(const mp_obj_type_t
         mp_raise_TypeError_varg(MP_ERROR_TEXT("unsupported %q type"), MP_QSTR_pixel_shader);
     }
     tilepalettemapper_tilepalettemapper_t *self = mp_obj_malloc(tilepalettemapper_tilepalettemapper_t, &tilepalettemapper_tilepalettemapper_type);
-    common_hal_tilepalettemapper_tilepalettemapper_construct(self, palette, args[ARG_width].u_int, args[ARG_height].u_int);
+    common_hal_tilepalettemapper_tilepalettemapper_construct(self, palette, args[ARG_input_color_count].u_int, args[ARG_width].u_int, args[ARG_height].u_int);
 
     return MP_OBJ_FROM_PTR(self);
 }
@@ -137,9 +142,7 @@ static mp_obj_t tilepalettemapper_subscr(mp_obj_t self_in, mp_obj_t index_obj, m
             size_t len = 0;
             mp_obj_t *items;
             mp_obj_list_get(value_obj, &len, &items);
-            uint32_t palette_len = common_hal_displayio_palette_get_len(self->palette);
-
-            mp_arg_validate_int_range(len, 0, palette_len, MP_QSTR_mapping_length);
+            mp_arg_validate_int_range(len, 0, self->input_color_count, MP_QSTR_mapping_length);
             common_hal_tilepalettemapper_tilepalettemapper_set_mapping(self, x, y, len, items);
         }
     }
diff --git a/shared-bindings/tilepalettemapper/TilePaletteMapper.h b/shared-bindings/tilepalettemapper/TilePaletteMapper.h
@@ -8,7 +8,7 @@
 extern const mp_obj_type_t tilepalettemapper_tilepalettemapper_type;
 
 void common_hal_tilepalettemapper_tilepalettemapper_construct(tilepalettemapper_tilepalettemapper_t *self,
-    mp_obj_t paltte, uint16_t bitmap_width_in_tiles, uint16_t bitmap_height_in_tiles);
+    mp_obj_t paltte, uint16_t input_color_count, uint16_t bitmap_width_in_tiles, uint16_t bitmap_height_in_tiles);
 
 
 uint16_t common_hal_tilepalettemapper_tilepalettemapper_get_width(tilepalettemapper_tilepalettemapper_t *self);
diff --git a/shared-module/displayio/TileGrid.c b/shared-module/displayio/TileGrid.c
@@ -471,7 +471,9 @@ bool displayio_tilegrid_fill_area(displayio_tilegrid_t *self,
                 continue;
             }
             int16_t local_x = input_pixel.x / self->absolute_transform->scale;
-            uint16_t tile_location = ((local_y / self->tile_height + self->top_left_y) % self->height_in_tiles) * self->width_in_tiles + (local_x / self->tile_width + self->top_left_x) % self->width_in_tiles;
+            uint16_t x_tile_index = (local_x / self->tile_width + self->top_left_x) % self->width_in_tiles;
+            uint16_t y_tile_index = (local_y / self->tile_height + self->top_left_y) % self->height_in_tiles;
+            uint16_t tile_location = y_tile_index * self->width_in_tiles + x_tile_index;
             input_pixel.tile = tiles[tile_location];
             input_pixel.tile_x = (input_pixel.tile % self->bitmap_width_in_tiles) * self->tile_width + local_x % self->tile_width;
             input_pixel.tile_y = (input_pixel.tile / self->bitmap_width_in_tiles) * self->tile_height + local_y % self->tile_height;
@@ -490,7 +492,7 @@ bool displayio_tilegrid_fill_area(displayio_tilegrid_t *self,
             output_pixel.opaque = true;
             #if CIRCUITPY_TILEPALETTEMAPPER
             if (mp_obj_is_type(self->pixel_shader, &tilepalettemapper_tilepalettemapper_type)) {
-                output_pixel.pixel = tilepalettemapper_tilepalettemapper_get_color(self->pixel_shader, tile_location, input_pixel.pixel);
+                tilepalettemapper_tilepalettemapper_get_color(self->pixel_shader, colorspace, &input_pixel, &output_pixel, x_tile_index, y_tile_index);
             }
             #endif
             if (self->pixel_shader == mp_const_none) {
diff --git a/shared-module/tilepalettemapper/TilePaletteMapper.c b/shared-module/tilepalettemapper/TilePaletteMapper.c
@@ -9,18 +9,18 @@
 #include "shared-bindings/displayio/Palette.h"
 
 void common_hal_tilepalettemapper_tilepalettemapper_construct(tilepalettemapper_tilepalettemapper_t *self,
-    mp_obj_t palette, uint16_t width, uint16_t height) {
+    mp_obj_t palette, uint16_t input_color_count, uint16_t width, uint16_t height) {
 
     self->palette = palette;
     self->width_in_tiles = width;
     self->height_in_tiles = height;
+    self->input_color_count = input_color_count;
     self->needs_refresh = false;
     int mappings_len = width * height;
     self->tile_mappings = (uint16_t **)m_malloc(mappings_len * sizeof(uint16_t *));
-    uint32_t palette_len = common_hal_displayio_palette_get_len(self->palette);
     for (int i = 0; i < mappings_len; i++) {
-        self->tile_mappings[i] = (uint16_t *)m_malloc(palette_len * sizeof(uint16_t));
-        for (uint16_t j = 0; j < palette_len; j++) {
+        self->tile_mappings[i] = (uint16_t *)m_malloc(input_color_count * sizeof(uint16_t));
+        for (uint16_t j = 0; j < input_color_count; j++) {
             self->tile_mappings[i][j] = j;
         }
     }
@@ -39,13 +39,12 @@ mp_obj_t common_hal_tilepalettemapper_tilepalettemapper_get_palette(tilepalettem
 }
 
 mp_obj_t common_hal_tilepalettemapper_tilepalettemapper_get_mapping(tilepalettemapper_tilepalettemapper_t *self, uint16_t x, uint16_t y) {
-    mp_obj_list_t *list = MP_OBJ_TO_PTR(mp_obj_new_list(0, NULL));
-    uint32_t palette_len = common_hal_displayio_palette_get_len(self->palette);
     int index = x + y * self->width_in_tiles;
-    for (uint32_t i = 0; i < palette_len; i++) {
-        mp_obj_list_append(list, mp_obj_new_int(self->tile_mappings[index][i]));
+    mp_obj_t result[self->input_color_count];
+    for (uint32_t i = 0; i < self->input_color_count; i++) {
+        result[i] = mp_obj_new_int(self->tile_mappings[index][i]);
     }
-    return MP_OBJ_FROM_PTR(list);
+    return mp_obj_new_tuple(self->input_color_count, result);
 }
 
 void common_hal_tilepalettemapper_tilepalettemapper_set_mapping(tilepalettemapper_tilepalettemapper_t *self, uint16_t x, uint16_t y, size_t len, mp_obj_t *items) {
@@ -58,9 +57,16 @@ void common_hal_tilepalettemapper_tilepalettemapper_set_mapping(tilepalettemappe
     self->needs_refresh = true;
 }
 
-uint32_t tilepalettemapper_tilepalettemapper_get_color(tilepalettemapper_tilepalettemapper_t *self, uint16_t tile_index, uint32_t palette_index) {
-    uint32_t mapped_index = self->tile_mappings[tile_index][palette_index];
-    return common_hal_displayio_palette_get_color(self->palette, mapped_index);
+void tilepalettemapper_tilepalettemapper_get_color(tilepalettemapper_tilepalettemapper_t *self, const _displayio_colorspace_t *colorspace, displayio_input_pixel_t *input_pixel, displayio_output_pixel_t *output_color, uint16_t x_tile_index, uint16_t y_tile_index) {
+    if (x_tile_index >= self->width_in_tiles || y_tile_index >= self->height_in_tiles) {
+        displayio_palette_get_color(self->palette, colorspace, input_pixel, output_color);
+        return;
+    }
+    uint16_t tile_index = y_tile_index * self->width_in_tiles + x_tile_index;
+    uint32_t mapped_index = self->tile_mappings[tile_index][input_pixel->pixel];
+    displayio_input_pixel_t tmp_pixel;
+    tmp_pixel.pixel = mapped_index;
+    displayio_palette_get_color(self->palette, colorspace, &tmp_pixel, output_color);
 }
 
 bool tilepalettemapper_tilepalettemapper_needs_refresh(tilepalettemapper_tilepalettemapper_t *self) {
diff --git a/shared-module/tilepalettemapper/TilePaletteMapper.h b/shared-module/tilepalettemapper/TilePaletteMapper.h
@@ -11,17 +11,19 @@
 #include <stdint.h>
 
 #include "py/obj.h"
+#include "shared-module/displayio/Palette.h"
 
 typedef struct {
     mp_obj_base_t base;
     mp_obj_t palette;
     uint16_t width_in_tiles;
     uint16_t height_in_tiles;
+    uint16_t input_color_count;
     uint16_t **tile_mappings;
     bool needs_refresh;
 } tilepalettemapper_tilepalettemapper_t;
 
 bool tilepalettemapper_tilepalettemapper_needs_refresh(tilepalettemapper_tilepalettemapper_t *self);
 void tilepalettemapper_tilepalettemapper_finish_refresh(tilepalettemapper_tilepalettemapper_t *self);
 
-uint32_t tilepalettemapper_tilepalettemapper_get_color(tilepalettemapper_tilepalettemapper_t *self, uint16_t tile_index, uint32_t palette_index);
+void tilepalettemapper_tilepalettemapper_get_color(tilepalettemapper_tilepalettemapper_t *self, const _displayio_colorspace_t *colorspace, displayio_input_pixel_t *input_pixel, displayio_output_pixel_t *output_color, uint16_t x_tile_index, uint16_t y_tile_index);

Original file line number	Diff line number	Diff line change
`@@ -11,4 +11,3 @@ EXTERNAL_FLASH_DEVICES = "W25Q32JVxQ"`
`11`	`11`	`LONGINT_IMPL = MPZ`
`12`	`12`
`13`	`13`	`CIRCUITPY_JPEGIO = 0`
`14`		`-CIRCUITPY_TILEPALETTEMAPPER = 0`
Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,3 @@ LONGINT_IMPL = MPZ`
`13`	`13`	`CIRCUITPY_BITBANG_APA102 = 1`
`14`	`14`
`15`	`15`	`CIRCUITPY_PULSEIO = 0`
`16`		`-CIRCUITPY_TILEPALETTEMAPPER = 0`
Original file line number	Diff line number	Diff line change
`@@ -12,4 +12,3 @@ LONGINT_IMPL = MPZ`
`12`	`12`
`13`	`13`	`CIRCUITPY_CODEOP = 0`
`14`	`14`	`CIRCUITPY_RAINBOWIO = 0`
`15`		`-CIRCUITPY_TILEPALETTEMAPPER = 0`