Introduce displayio to render graphics to displays.

It's designed to minimize RAM footprint by using Sprites to
represent objects on the screen. The object model also facilitates
partial screen updating which reduces the bandwidth needed to display.

This is all handled in C. Python simply manipulates the objects with
the ability to synchronize to frame timing.

1 files changed, 157 insertions, 0 deletions

diff --git a/shared-bindings/displayio/Palette.c b/shared-bindings/displayio/Palette.c
new file mode 100644
index 000000000..bb2af9410
--- /dev/null
+++ b/shared-bindings/displayio/Palette.c
@@ -0,0 +1,157 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Scott Shawcroft for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "shared-bindings/displayio/Palette.h"
+
+#include <stdint.h>
+
+#include "lib/utils/context_manager_helpers.h"
+#include "py/binary.h"
+#include "py/objproperty.h"
+#include "py/runtime.h"
+#include "shared-bindings/microcontroller/Pin.h"
+#include "shared-bindings/util.h"
+#include "supervisor/shared/translate.h"
+
+//| .. currentmodule:: displayio
+//|
+//| :class:`Palette` -- Stores a mapping from bitmap pixel values to display colors
+//| ===============================================================================
+//|
+//| Manage updating a display over SPI four wire protocol in the background while Python code runs.
+//| It doesn't handle display initialization.
+//|
+//| .. warning:: This will be changed before 4.0.0. Consider it very experimental.
+//|
+//| .. class:: Palette(color_count)
+//|
+//|   Create a Palette object to store a set number of colors.
+//|
+//|   :param int color_count: The number of colors in the Palette
+// TODO(tannewt): Add support for other color formats.
+// TODO(tannewt): Add support for 8-bit alpha blending.
+//|
+STATIC mp_obj_t displayio_palette_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *pos_args) {
+    mp_arg_check_num(n_args, n_kw, 1, 1, true);
+    mp_map_t kw_args;
+    mp_map_init_fixed_table(&kw_args, n_kw, pos_args + n_args);
+    enum { ARG_color_count };
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_color_count, MP_ARG_INT | MP_ARG_REQUIRED },
+    };
+    mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+    mp_arg_parse_all(n_args, pos_args, &kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+    displayio_palette_t *self = m_new_obj(displayio_palette_t);
+    self->base.type = &displayio_palette_type;
+    common_hal_displayio_palette_construct(self, args[ARG_color_count].u_int);
+
+    return MP_OBJ_FROM_PTR(self);
+}
+
+STATIC mp_obj_t palette_subscr(mp_obj_t self_in, mp_obj_t index_in, mp_obj_t value) {
+    if (value == MP_OBJ_NULL) {
+        // delete item
+        return MP_OBJ_NULL; // op not supported
+    } else {
+        displayio_palette_t *self = MP_OBJ_TO_PTR(self_in);
+        if (MP_OBJ_IS_TYPE(index_in, &mp_type_slice)) {
+            return MP_OBJ_NULL; // Slicing not supported. Use a duplicate Palette to swap multiple colors atomically.
+        } else {
+            if (value == MP_OBJ_SENTINEL) {
+                return MP_OBJ_NULL; // index read is not supported
+            } else {
+                size_t index = mp_get_index(&displayio_palette_type, self->max_value, index_in, false);
+
+                uint32_t color;
+                mp_int_t int_value;
+                mp_buffer_info_t bufinfo;
+                if (mp_get_buffer(value, &bufinfo, MP_BUFFER_READ)) {
+                    if (bufinfo.typecode != 'b' && bufinfo.typecode != 'B' && bufinfo.typecode != BYTEARRAY_TYPECODE) {
+                        mp_raise_ValueError(translate("color buffer must be a bytearray or array of type 'b' or 'B'"));
+                    }
+                    uint8_t* buf = bufinfo.buf;
+                    if (bufinfo.len == 3 || bufinfo.len == 4) {
+                        color = buf[0] << 16 | buf[1] << 8 | buf[2];
+                    } else {
+                        mp_raise_ValueError(translate("color buffer must be 3 bytes (RGB) or 4 bytes (RGBA)"));
+                    }
+                } else if (mp_obj_get_int_maybe(value, &int_value)) {
+                    if (int_value < 0 || int_value > 0xffffff) {
+                        mp_raise_TypeError(translate("color must be between 0x000000 and 0xffffff"));
+                    }
+                    color = int_value;
+                } else {
+                    mp_raise_TypeError(translate("color buffer must be a buffer or int"));
+                }
+                common_hal_displayio_palette_set_color(self, index, color);
+                return mp_const_none;
+            }
+        }
+    }
+}
+
+//|   .. method:: make_transparent(value)
+//|
+STATIC mp_obj_t displayio_palette_obj_make_transparent(mp_obj_t self_in, mp_obj_t value_obj) {
+    displayio_palette_t *self = MP_OBJ_TO_PTR(self_in);
+
+    mp_int_t value;
+    if (!mp_obj_get_int_maybe(value_obj, &value)) {
+        mp_raise_ValueError(translate("value should be an int"));
+    }
+    common_hal_displayio_palette_make_transparent(self, value);
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_2(displayio_palette_make_transparent_obj, displayio_palette_obj_make_transparent);
+
+//|   .. method:: make_opaque(value)
+//|
+STATIC mp_obj_t displayio_palette_obj_make_opaque(mp_obj_t self_in, mp_obj_t value_obj) {
+    displayio_palette_t *self = MP_OBJ_TO_PTR(self_in);
+
+    mp_int_t value;
+    if (!mp_obj_get_int_maybe(value_obj, &value)) {
+        mp_raise_ValueError(translate("value should be an int"));
+    }
+    common_hal_displayio_palette_make_opaque(self, value);
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_2(displayio_palette_make_opaque_obj, displayio_palette_obj_make_opaque);
+
+STATIC const mp_rom_map_elem_t displayio_palette_locals_dict_table[] = {
+    { MP_ROM_QSTR(MP_QSTR_make_transparent), MP_ROM_PTR(&displayio_palette_make_transparent_obj) },
+    { MP_ROM_QSTR(MP_QSTR_make_opaque), MP_ROM_PTR(&displayio_palette_make_opaque_obj) },
+};
+STATIC MP_DEFINE_CONST_DICT(displayio_palette_locals_dict, displayio_palette_locals_dict_table);
+
+const mp_obj_type_t displayio_palette_type = {
+    { &mp_type_type },
+    .name = MP_QSTR_Palette,
+    .make_new = displayio_palette_make_new,
+    .subscr = palette_subscr,
+    .locals_dict = (mp_obj_dict_t*)&displayio_palette_locals_dict,
+};