Merge pull request #5094 from jepler/quirc

Add qrio: Decode QR codes with quirc lib

.gitmodules

@@ -188,3 +188,6 @@
 [submodule "frozen/Adafruit_CircuitPython_SimpleIO"]
 	path = frozen/Adafruit_CircuitPython_SimpleIO
 	url = https://github.com/adafruit/adafruit_circuitpython_simpleio
+[submodule "lib/quirc"]
+	path = lib/quirc
+	url = https://github.com/adafruit/quirc.git

docs/common_hal.md

@@ -7,7 +7,7 @@ These instructions also apply to `analogio`, `busio`, `pulseio` and `touchio`. M
 Common HAL related files are found in these locations:
 
 * `shared-bindings` Shared home for the Python <-> C bindings which includes inline RST documentation for the created interfaces. The common hal functions are defined in the .h files of the corresponding C files.
-* `shared-modules` Shared home for C code built on the Common HAL and used by all ports. This code only uses `common_hal` methods defined in `shared-bindings`.
+* `shared-module` Shared home for C code built on the Common HAL and used by all ports. This code only uses `common_hal` methods defined in `shared-bindings`.
 * `<port>/common-hal` Port-specific implementation of the Common HAL.
 
 Each folder has the substructure of <python module name>/<class name> and they should match 1:1. `__init__.c` is used for module globals that are not classes (similar to `__init__.py`).

lib/quirc

@@ -0,0 +1 @@
+Subproject commit 8c6ffa228a4c7643daed7039d3c51d38a43991b8

locale/circuitpython.pot

@@ -2063,7 +2063,6 @@ msgid "Size not supported"
 msgstr ""
 
 #: ports/raspberrypi/common-hal/alarm/SleepMemory.c
-#: ports/stm/common-hal/alarm/SleepMemory.c
 msgid "Sleep Memory not available"
 msgstr ""
 

ports/atmel-samd/Makefile

@@ -340,7 +340,7 @@ SRC_SHARED_MODULE_EXPANDED = $(addprefix shared-bindings/, $(SRC_SHARED_MODULE))
                              $(addprefix shared-module/, $(SRC_SHARED_MODULE_INTERNAL))
 
 # There may be duplicates between SRC_COMMON_HAL_EXPANDED and SRC_SHARED_MODULE_EXPANDED,
-# because a few modules have files both in common-hal/ and shared-modules/.
+# because a few modules have files both in common-hal/ and shared-module/.
 # Doing a $(sort ...) removes duplicates as part of sorting.
 SRC_COMMON_HAL_SHARED_MODULE_EXPANDED = $(sort $(SRC_COMMON_HAL_EXPANDED) $(SRC_SHARED_MODULE_EXPANDED))
 

ports/esp32s2/boards/espressif_kaluga_1.3/mpconfigboard.mk

@@ -14,10 +14,4 @@ CIRCUITPY_ESP_FLASH_MODE=dio
 CIRCUITPY_ESP_FLASH_FREQ=80m
 CIRCUITPY_ESP_FLASH_SIZE=4MB
 
-# We only have enough endpoints available in hardware to
-# enable ONE of these at a time.
-CIRCUITPY_USB_MIDI = 1
-CIRCUITPY_USB_HID = 0
-CIRCUITPY_USB_VENDOR = 0
-
 CIRCUITPY_MODULE=wrover

ports/esp32s2/boards/espressif_kaluga_1/mpconfigboard.mk

@@ -14,10 +14,4 @@ CIRCUITPY_ESP_FLASH_MODE=dio
 CIRCUITPY_ESP_FLASH_FREQ=80m
 CIRCUITPY_ESP_FLASH_SIZE=4MB
 
-# We only have enough endpoints available in hardware to
-# enable ONE of these at a time.
-CIRCUITPY_USB_MIDI = 1
-CIRCUITPY_USB_HID = 0
-CIRCUITPY_USB_VENDOR = 0
-
 CIRCUITPY_MODULE=wrover

ports/esp32s2/mpconfigport.mk

@@ -31,7 +31,7 @@ CIRCUITPY_ROTARYIO = 1
 CIRCUITPY_NVM = 1
 CIRCUITPY_PS2IO ?= 1
 CIRCUITPY_TOUCHIO_USE_NATIVE ?= 1
-CIRCUITPY_WIFI = 1
+CIRCUITPY_WIFI ?= 1
 CIRCUITPY_WATCHDOG ?= 1
 
 CIRCUITPY_ESPIDF = 1

ports/nrf/Makefile

@@ -191,7 +191,7 @@ SRC_SHARED_MODULE_EXPANDED = $(addprefix shared-bindings/, $(SRC_SHARED_MODULE))
                              $(addprefix shared-module/, $(SRC_SHARED_MODULE_INTERNAL))
 
 # There may be duplicates between SRC_COMMON_HAL_EXPANDED and SRC_SHARED_MODULE_EXPANDED,
-# because a few modules have files both in common-hal/ and shared-modules/.
+# because a few modules have files both in common-hal/ and shared-module/.
 # Doing a $(sort ...) removes duplicates as part of sorting.
 SRC_COMMON_HAL_SHARED_MODULE_EXPANDED = $(sort $(SRC_COMMON_HAL_EXPANDED) $(SRC_SHARED_MODULE_EXPANDED))
 

ports/raspberrypi/Makefile

@@ -213,7 +213,7 @@ SRC_SHARED_MODULE_EXPANDED = $(addprefix shared-bindings/, $(SRC_SHARED_MODULE))
                              $(addprefix shared-module/, $(SRC_SHARED_MODULE_INTERNAL))
 
 # There may be duplicates between SRC_COMMON_HAL_EXPANDED and SRC_SHARED_MODULE_EXPANDED,
-# because a few modules have files both in common-hal/ and shared-modules/.
+# because a few modules have files both in common-hal/ and shared-module/.
 # Doing a $(sort ...) removes duplicates as part of sorting.
 SRC_COMMON_HAL_SHARED_MODULE_EXPANDED = $(sort $(SRC_COMMON_HAL_EXPANDED) $(SRC_SHARED_MODULE_EXPANDED))
 

ports/unix/variants/coverage/mpconfigvariant.mk

@@ -21,5 +21,12 @@ MICROPY_VFS_LFS2 = 1
 FROZEN_DIR=variants/coverage/frzstr
 FROZEN_MPY_DIR=variants/coverage/frzmpy
 
+SRC_QRIO := $(patsubst ../../%,%,$(wildcard ../../shared-bindings/qrio/*.c ../../shared-module/qrio/*.c ../../lib/quirc/lib/*.c))
+$(info SRC_QRIO = $(SRC_QRIO))
+SRC_C += $(SRC_QRIO)
+
+CFLAGS += -DCIRCUITPY_QRIO=1
+$(BUILD)/lib/quirc/lib/%.o: CFLAGS += -Wno-shadow -Wno-sign-compare -include shared-module/qrio/quirc_alloc.h
+
 SRC_C += coverage.c
 SRC_CXX += coveragecpp.cpp

py/circuitpy_defns.mk

@@ -224,6 +224,9 @@ endif
 ifeq ($(CIRCUITPY_PIXELBUF),1)
 SRC_PATTERNS += adafruit_pixelbuf/%
 endif
+ifeq ($(CIRCUITPY_QRIO),1)
+SRC_PATTERNS += qrio/%
+endif
 ifeq ($(CIRCUITPY_RAINBOWIO),1)
 SRC_PATTERNS += rainbowio/%
 endif
@@ -445,6 +448,8 @@ $(filter $(SRC_PATTERNS), \
 	_eve/__init__.c \
 	camera/ImageFormat.c \
 	canio/Match.c \
+	qrio/PixelPolicy.c \
+	qrio/QRInfo.c \
 	digitalio/Direction.c \
 	digitalio/DriveMode.c \
 	digitalio/Pull.c \
@@ -532,6 +537,8 @@ SRC_SHARED_MODULE_ALL = \
 	network/__init__.c \
 	msgpack/__init__.c \
 	os/__init__.c \
+	qrio/__init__.c \
+	qrio/QRDecoder.c \
 	rainbowio/__init__.c \
 	random/__init__.c \
 	rgbmatrix/RGBMatrix.c \
@@ -668,6 +675,11 @@ SRC_CIRCUITPY_COMMON = \
 	lib/utils/stdout_helpers.c \
 	lib/utils/sys_stdio_mphal.c
 
+ifeq ($(CIRCUITPY_QRIO),1)
+SRC_CIRCUITPY_COMMON += lib/quirc/lib/decode.c lib/quirc/lib/identify.c lib/quirc/lib/quirc.c lib/quirc/lib/version_db.c
+$(BUILD)/lib/quirc/lib/%.o: CFLAGS += -Wno-shadow -Wno-sign-compare -include shared-module/qrio/quirc_alloc.h
+endif
+
 ifdef LD_TEMPLATE_FILE
 # Generate a linker script (.ld file) from a template, for those builds that use it.
 GENERATED_LD_FILE = $(BUILD)/$(notdir $(patsubst %.template.ld,%.ld,$(LD_TEMPLATE_FILE)))

py/circuitpy_mpconfig.h

@@ -621,6 +621,13 @@ extern const struct _mp_obj_module_t pwmio_module;
 #define PWMIO_MODULE
 #endif
 
+#if CIRCUITPY_QRIO
+extern const struct _mp_obj_module_t qrio_module;
+#define QRIO_MODULE            { MP_OBJ_NEW_QSTR(MP_QSTR_qrio), (mp_obj_t)&qrio_module },
+#else
+#define QRIO_MODULE
+#endif
+
 #if CIRCUITPY_RAINBOWIO
 extern const struct _mp_obj_module_t rainbowio_module;
 #define RAINBOWIO_MODULE            { MP_OBJ_NEW_QSTR(MP_QSTR_rainbowio), (mp_obj_t)&rainbowio_module },
@@ -905,6 +912,7 @@ extern const struct _mp_obj_module_t msgpack_module;
     PS2IO_MODULE \
     PULSEIO_MODULE \
     PWMIO_MODULE \
+    QRIO_MODULE \
     RAINBOWIO_MODULE \
     RANDOM_MODULE \
     RE_MODULE \

py/circuitpy_mpconfig.mk

@@ -239,6 +239,9 @@ CFLAGS += -DCIRCUITPY_PULSEIO=$(CIRCUITPY_PULSEIO)
 CIRCUITPY_PWMIO ?= 1
 CFLAGS += -DCIRCUITPY_PWMIO=$(CIRCUITPY_PWMIO)
 
+CIRCUITPY_QRIO ?= $(CIRCUITPY_IMAGECAPTURE)
+CFLAGS += -DCIRCUITPY_QRIO=$(CIRCUITPY_QRIO)
+
 CIRCUITPY_RAINBOWIO ?= 1
 CFLAGS += -DCIRCUITPY_RAINBOWIO=$(CIRCUITPY_RAINBOWIO)
 

shared-bindings/qrio/PixelPolicy.c

@@ -0,0 +1,56 @@
+/*
+ * This file is part of the CircuitPython project, https://github.com/adafruit/circuitpython
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler
+ *
+ * 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/qrio/__init__.h"
+#include "shared-bindings/qrio/PixelPolicy.h"
+#include "py/obj.h"
+#include "py/enum.h"
+
+//| class PixelPolicy:
+//|     EVERY_BYTE: PixelPolicy
+//|     """The input buffer to `QRDecoder.decode` consists of greyscale values in every byte"""
+//|
+//|     EVEN_BYTES: PixelPolicy
+//|     """The input buffer to `QRDecoder.decode` consists of greyscale values in positions 0, 2, …, and ignored bytes in positions 1, 3, ….  This can decode directly from YUV images where the even bytes hold the Y (luminance) data."""
+//|
+//|     ODD_BYTES: PixelPolicy
+//|     """The input buffer to `QRDecoder.decode` consists of greyscale values in positions 1, 3, …, and ignored bytes in positions 0, 2, ….  This can decode directly from YUV images where the odd bytes hold the Y (luminance) data"""
+//|
+
+MAKE_ENUM_VALUE(qrio_pixel_policy_type, qrio_pixel_policy, EVERY_BYTE, QRIO_EVERY_BYTE);
+MAKE_ENUM_VALUE(qrio_pixel_policy_type, qrio_pixel_policy, EVEN_BYTES, QRIO_EVEN_BYTES);
+MAKE_ENUM_VALUE(qrio_pixel_policy_type, qrio_pixel_policy, ODD_BYTES, QRIO_EVEN_BYTES);
+
+MAKE_ENUM_MAP(qrio_pixel_policy) {
+    MAKE_ENUM_MAP_ENTRY(qrio_pixel_policy, EVERY_BYTE),
+    MAKE_ENUM_MAP_ENTRY(qrio_pixel_policy, EVEN_BYTES),
+    MAKE_ENUM_MAP_ENTRY(qrio_pixel_policy, ODD_BYTES),
+};
+STATIC MP_DEFINE_CONST_DICT(qrio_pixel_policy_locals_dict, qrio_pixel_policy_locals_table);
+
+MAKE_PRINTER(qrio, qrio_pixel_policy);
+
+MAKE_ENUM_TYPE(qrio, PixelPolicy, qrio_pixel_policy);

shared-bindings/qrio/PixelPolicy.h

@@ -0,0 +1,39 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler 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.
+ */
+
+#pragma once
+
+#include "py/enum.h"
+#include "py/obj.h"
+#include "py/objnamedtuple.h"
+
+extern const mp_obj_type_t qrio_pixel_policy_type;
+
+typedef enum {
+    QRIO_EVERY_BYTE, QRIO_EVEN_BYTES, QRIO_ODD_BYTES
+} qrio_pixel_policy_t;
+
+extern const cp_enum_obj_t qrio_pixel_policy_EVERY_BYTE_obj;

shared-bindings/qrio/QRDecoder.c

@@ -0,0 +1,155 @@
+/*
+ * This file is part of the CircuitPython project, https://github.com/adafruit/circuitpython
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler
+ *
+ * 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/qrio/__init__.h"
+#include "shared-bindings/qrio/QRDecoder.h"
+#include "shared-module/qrio/QRDecoder.h"
+
+#include "py/obj.h"
+#include "py/objproperty.h"
+#include "py/enum.h"
+
+//| class QRDecoder:
+//|
+//|     def __init__(self, width: int, height: int) -> None:
+//|         """Construct a QRDecoder object
+//|
+//|         :param int width: The pixel width of the image to decode
+//|         :param int height: The pixel height of the image to decode
+//|         """
+//|         ...
+
+STATIC mp_obj_t qrio_qrdecoder_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+    enum { ARG_width, ARG_height };
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_width, MP_ARG_INT | MP_ARG_REQUIRED, {.u_int = 0} },
+        { MP_QSTR_height, MP_ARG_INT | MP_ARG_REQUIRED, {.u_int = 0} },
+    };
+    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);
+
+    qrio_qrdecoder_obj_t *self = m_new_obj(qrio_qrdecoder_obj_t);
+    self->base.type = &qrio_qrdecoder_type_obj;
+    shared_module_qrio_qrdecoder_construct(self, args[ARG_width].u_int, args[ARG_height].u_int);
+
+    return self;
+}
+
+//|     def decode(self, buffer: ReadableBuffer, pixel_policy: PixelPolicy = PixelPolicy.EVERY_BYTE) -> List[QRInfo]:
+//|         """Decode zero or more QR codes from the given image.  The size of the buffer must be at least ``length``×``width`` bytes for `EVERY_BYTE`, and 2×``length``×``width`` bytes for `EVEN_BYTES` or `ODD_BYTES`."""
+//|
+STATIC mp_obj_t qrio_qrdecoder_decode(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+    qrio_qrdecoder_obj_t *self = MP_OBJ_TO_PTR(pos_args[0]);
+
+    enum { ARG_buffer, ARG_pixel_policy };
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_buffer, MP_ARG_OBJ | MP_ARG_REQUIRED, {.u_int = 0} },
+        { MP_QSTR_pixel_policy, MP_ARG_OBJ, {.u_obj = MP_ROM_PTR((mp_obj_t *)&qrio_pixel_policy_EVERY_BYTE_obj)} },
+    };
+    mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+    mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+    mp_buffer_info_t bufinfo;
+    mp_get_buffer_raise(args[ARG_buffer].u_obj, &bufinfo, MP_BUFFER_READ);
+
+    int width = shared_module_qrio_qrdecoder_get_width(self);
+    int height = shared_module_qrio_qrdecoder_get_height(self);
+
+    // verify that the buffer is big enough
+    int sz = width * height;
+    qrio_pixel_policy_t policy = cp_enum_value(&qrio_pixel_policy_type, args[ARG_pixel_policy].u_obj);
+    if (policy != QRIO_EVERY_BYTE) {
+        sz *= 2;
+    }
+    mp_get_index(mp_obj_get_type(args[ARG_buffer].u_obj), bufinfo.len, MP_OBJ_NEW_SMALL_INT(sz - 1), false);
+
+    return shared_module_qrio_qrdecoder_decode(self, &bufinfo, policy);
+}
+MP_DEFINE_CONST_FUN_OBJ_KW(qrio_qrdecoder_decode_obj, 2, qrio_qrdecoder_decode);
+
+//|     width: int
+//|     """The width of image the decoder expects"""
+//|
+STATIC mp_obj_t qrio_qrdecoder_get_width(mp_obj_t self_in) {
+    qrio_qrdecoder_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    return mp_obj_new_int(shared_module_qrio_qrdecoder_get_width(self));
+}
+MP_DEFINE_CONST_FUN_OBJ_1(qrio_qrdecoder_get_width_obj, qrio_qrdecoder_get_width);
+
+STATIC mp_obj_t qrio_qrdecoder_set_width(mp_obj_t self_in, mp_obj_t width_in) {
+    qrio_qrdecoder_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    int width = mp_obj_get_int(width_in);
+    shared_module_qrio_qrdecoder_set_width(self, width);
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_2(qrio_qrdecoder_set_width_obj, qrio_qrdecoder_set_width);
+
+const mp_obj_property_t qrio_qrdecoder_width_obj = {
+    .base.type = &mp_type_property,
+    .proxy = {(mp_obj_t)&qrio_qrdecoder_get_width_obj,
+              (mp_obj_t)&qrio_qrdecoder_set_width_obj,
+              MP_ROM_NONE},
+};
+
+//|     height: int
+//|     """The height of image the decoder expects"""
+//|
+STATIC mp_obj_t qrio_qrdecoder_get_height(mp_obj_t self_in) {
+    qrio_qrdecoder_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    return mp_obj_new_int(shared_module_qrio_qrdecoder_get_height(self));
+}
+MP_DEFINE_CONST_FUN_OBJ_1(qrio_qrdecoder_get_height_obj, qrio_qrdecoder_get_height);
+
+STATIC mp_obj_t qrio_qrdecoder_set_height(mp_obj_t self_in, mp_obj_t height_in) {
+    qrio_qrdecoder_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    int height = mp_obj_get_int(height_in);
+    shared_module_qrio_qrdecoder_set_height(self, height);
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_2(qrio_qrdecoder_set_height_obj, qrio_qrdecoder_set_height);
+
+const mp_obj_property_t qrio_qrdecoder_height_obj = {
+    .base.type = &mp_type_property,
+    .proxy = {(mp_obj_t)&qrio_qrdecoder_get_height_obj,
+              (mp_obj_t)&qrio_qrdecoder_set_height_obj,
+              MP_ROM_NONE},
+};
+
+STATIC const mp_rom_map_elem_t qrio_qrdecoder_locals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_QRDecoder) },
+    { MP_ROM_QSTR(MP_QSTR_width), MP_ROM_PTR(&qrio_qrdecoder_width_obj) },
+    { MP_ROM_QSTR(MP_QSTR_height), MP_ROM_PTR(&qrio_qrdecoder_height_obj) },
+    { MP_ROM_QSTR(MP_QSTR_decode), MP_ROM_PTR(&qrio_qrdecoder_decode_obj) },
+};
+
+STATIC MP_DEFINE_CONST_DICT(qrio_qrdecoder_locals, qrio_qrdecoder_locals_table);
+
+const mp_obj_type_t qrio_qrdecoder_type_obj = {
+    { &mp_type_type },
+    .name = MP_QSTR_QRDecoder,
+    .make_new = qrio_qrdecoder_make_new,
+    .locals_dict = (mp_obj_dict_t *)&qrio_qrdecoder_locals,
+};

shared-bindings/qrio/QRDecoder.h

@@ -0,0 +1,37 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler 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.
+ */
+
+#pragma once
+
+#include "py/obj.h"
+
+typedef struct qrio_qrdecoder_obj qrio_qrdecoder_obj_t;
+
+extern const mp_obj_type_t qrio_qrdecoder_type_obj;
+
+void common_hal_qrio_qrdecoder_construct(qrio_qrdecoder_obj_t *self);
+
+mp_obj_t common_hal_qrio_qrdecoder_decode(qrio_qrdecoder_obj_t *self, int width, int height, mp_buffer_info_t *buf);

shared-bindings/qrio/QRInfo.c

@@ -0,0 +1,64 @@
+/*
+ * This file is part of the CircuitPython project, https://github.com/adafruit/circuitpython
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler
+ *
+ * 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/qrio/__init__.h"
+#include "shared-bindings/qrio/QRInfo.h"
+#include "py/obj.h"
+#include "py/enum.h"
+
+//| class QRInfo:
+//|     """Information about a decoded QR code"""
+//|
+//|     payload: bytes
+//|     """The content of the QR code"""
+//|
+//|     data_type: Union[str, int]
+//|     """The encoding of the payload as a string (if a standard encoding) or int (if not standard)"""
+
+const mp_obj_namedtuple_type_t qrio_qrinfo_type_obj = {
+    .base = {
+        .base = {
+            .type = &mp_type_type
+        },
+        .flags = MP_TYPE_FLAG_EXTENDED,
+        .name = MP_QSTR_QRInfo,
+        .print = namedtuple_print,
+        .parent = &mp_type_tuple,
+        .make_new = namedtuple_make_new,
+        .attr = namedtuple_attr,
+        MP_TYPE_EXTENDED_FIELDS(
+            .unary_op = mp_obj_tuple_unary_op,
+            .binary_op = mp_obj_tuple_binary_op,
+            .subscr = mp_obj_tuple_subscr,
+            .getiter = mp_obj_tuple_getiter,
+            ),
+    },
+    .n_fields = 2,
+    .fields = {
+        MP_QSTR_payload,
+        MP_QSTR_data_type,
+    },
+};

shared-bindings/qrio/QRInfo.h

@@ -0,0 +1,31 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler 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.
+ */
+
+#pragma once
+
+#include "py/objnamedtuple.h"
+
+extern const mp_obj_namedtuple_type_t qrio_qrinfo_type_obj;

shared-bindings/qrio/__init__.c

@@ -0,0 +1,53 @@
+/*
+ * This file is part of the CircuitPython project, https://github.com/adafruit/circuitpython
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler
+ *
+ * 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/qrio/__init__.h"
+#include "shared-bindings/qrio/QRDecoder.h"
+#include "shared-bindings/qrio/QRInfo.h"
+#include "shared-bindings/qrio/PixelPolicy.h"
+#include "py/obj.h"
+#include "py/enum.h"
+
+//| """`qrio` module.
+//|
+//| Provides the `QRDecoder` object."""
+//|
+
+STATIC const mp_rom_map_elem_t qrio_module_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_qrio) },
+    { MP_ROM_QSTR(MP_QSTR_QRInfo), MP_ROM_PTR(&qrio_qrinfo_type_obj) },
+    { MP_ROM_QSTR(MP_QSTR_QRDecoder), MP_ROM_PTR(&qrio_qrdecoder_type_obj) },
+    { MP_ROM_QSTR(MP_QSTR_PixelPolicy), MP_ROM_PTR(&qrio_pixel_policy_type) },
+};
+
+STATIC MP_DEFINE_CONST_DICT(qrio_module_globals, qrio_module_globals_table);
+
+const mp_obj_module_t qrio_module = {
+    .base = { &mp_type_module },
+    .globals = (mp_obj_dict_t *)&qrio_module_globals,
+};
+
+MP_REGISTER_MODULE(MP_QSTR_qrio, qrio_module, CIRCUITPY_QRIO);

shared-bindings/qrio/__init__.h

@@ -0,0 +1,27 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler 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.
+ */
+
+#pragma once

shared-module/qrio/QRDecoder.c

@@ -0,0 +1,137 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler 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 <string.h>
+
+#include "py/gc.h"
+#include "py/objnamedtuple.h"
+#include "shared-bindings/qrio/__init__.h"
+#include "shared-bindings/qrio/QRInfo.h"
+#include "shared-module/qrio/QRDecoder.h"
+
+void shared_module_qrio_qrdecoder_construct(qrdecoder_qrdecoder_obj_t *self, int width, int height) {
+    self->quirc = quirc_new();
+    quirc_resize(self->quirc, width, height);
+}
+
+int shared_module_qrio_qrdecoder_get_height(qrdecoder_qrdecoder_obj_t *self) {
+    int height;
+    quirc_begin(self->quirc, NULL, &height);
+    return height;
+}
+
+int shared_module_qrio_qrdecoder_get_width(qrdecoder_qrdecoder_obj_t *self) {
+    int width;
+    quirc_begin(self->quirc, &width, NULL);
+    return width;
+}
+void shared_module_qrio_qrdecoder_set_height(qrdecoder_qrdecoder_obj_t *self, int height) {
+    if (height != shared_module_qrio_qrdecoder_get_height(self)) {
+        int width = shared_module_qrio_qrdecoder_get_width(self);
+        quirc_resize(self->quirc, width, height);
+    }
+}
+
+void shared_module_qrio_qrdecoder_set_width(qrdecoder_qrdecoder_obj_t *self, int width) {
+    if (width != shared_module_qrio_qrdecoder_get_width(self)) {
+        int height = shared_module_qrio_qrdecoder_get_height(self);
+        quirc_resize(self->quirc, width, height);
+    }
+}
+
+STATIC mp_obj_t data_type(int type) {
+    switch (type) {
+        case QUIRC_ECI_ISO_8859_1:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_iso_8859_hyphen_1);
+        case QUIRC_ECI_IBM437:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_cp437);
+        case QUIRC_ECI_ISO_8859_2:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_iso_8859_hyphen_2);
+        case QUIRC_ECI_ISO_8859_3:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_iso_8859_hyphen_3);
+        case QUIRC_ECI_ISO_8859_4:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_iso_8859_hyphen_4);
+        case QUIRC_ECI_ISO_8859_5:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_iso_8859_hyphen_5);
+        case QUIRC_ECI_ISO_8859_6:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_iso_8859_hyphen_6);
+        case QUIRC_ECI_ISO_8859_7:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_iso_8859_hyphen_7);
+        case QUIRC_ECI_ISO_8859_8:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_iso_8859_hyphen_8);
+        case QUIRC_ECI_ISO_8859_9:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_iso_8859_hyphen_9);
+        case QUIRC_ECI_WINDOWS_874:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_cp874);
+        case QUIRC_ECI_ISO_8859_13:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_iso_8859_hyphen_13);
+        case QUIRC_ECI_ISO_8859_15:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_iso_8859_hyphen_15);
+        case QUIRC_ECI_SHIFT_JIS:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_shift_underscore_jis);
+        case QUIRC_ECI_UTF_8:
+            return MP_OBJ_NEW_QSTR(MP_QSTR_utf_hyphen_8);
+    }
+    return mp_obj_new_int(type);
+}
+
+mp_obj_t shared_module_qrio_qrdecoder_decode(qrdecoder_qrdecoder_obj_t *self, const mp_buffer_info_t *bufinfo, qrio_pixel_policy_t policy) {
+    int width, height;
+    uint8_t *framebuffer = quirc_begin(self->quirc, &width, &height);
+    uint8_t *src = bufinfo->buf;
+
+    switch (policy) {
+        case QRIO_EVERY_BYTE:
+            memcpy(framebuffer, src, width * height);
+            break;
+
+        case QRIO_ODD_BYTES:
+            src++;
+            MP_FALLTHROUGH;
+
+        case QRIO_EVEN_BYTES:
+            for (int i = 0; i < width * height; i++) {
+                framebuffer[i] = src[2 * i];
+            }
+    }
+    quirc_end(self->quirc);
+
+    int count = quirc_count(self->quirc);
+    mp_obj_t result = mp_obj_new_list(0, NULL);
+    for (int i = 0; i < count; i++) {
+        quirc_extract(self->quirc, i, &self->code);
+        if (quirc_decode(&self->code, &self->data) != QUIRC_SUCCESS) {
+            continue;
+        }
+        mp_obj_t elems[2] = {
+            mp_obj_new_bytes(self->data.payload, self->data.payload_len),
+            data_type(self->data.data_type),
+        };
+        mp_obj_t code_obj = namedtuple_make_new((const mp_obj_type_t *)&qrio_qrinfo_type_obj, 2, elems, NULL);
+        mp_obj_list_append(result, code_obj);
+    }
+    return result;
+}

shared-module/qrio/QRDecoder.h

@@ -0,0 +1,45 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2021 Jeff Epler 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.
+ */
+
+#pragma once
+
+#include "py/obj.h"
+#include "lib/quirc/lib/quirc.h"
+#include "shared-bindings/qrio/PixelPolicy.h"
+
+typedef struct qrio_qrdecoder_obj {
+    mp_obj_base_t base;
+    struct quirc *quirc;
+    struct quirc_code code;
+    struct quirc_data data;
+} qrdecoder_qrdecoder_obj_t;
+
+void shared_module_qrio_qrdecoder_construct(qrdecoder_qrdecoder_obj_t *, int width, int height);
+int shared_module_qrio_qrdecoder_get_height(qrdecoder_qrdecoder_obj_t *);
+int shared_module_qrio_qrdecoder_get_width(qrdecoder_qrdecoder_obj_t *);
+void shared_module_qrio_qrdecoder_set_height(qrdecoder_qrdecoder_obj_t *, int height);
+void shared_module_qrio_qrdecoder_set_width(qrdecoder_qrdecoder_obj_t *, int width);
+mp_obj_t shared_module_qrio_qrdecoder_decode(qrdecoder_qrdecoder_obj_t *, const mp_buffer_info_t *bufinfo, qrio_pixel_policy_t policy);

shared-module/qrio/quirc_alloc.h

@@ -0,0 +1,14 @@
+#pragma once
+
+#include "py/gc.h"
+
+#if !MICROPY_GC_CONSERVATIVE_CLEAR
+// so that we can implement calloc as m_malloc
+#error Requires MICROPY_GC_CONSERVATIVE_CLEAR
+#endif
+
+#define QUIRC_MALLOC(x) gc_alloc((x), 0, false)
+#define QUIRC_CALLOC(x,y) gc_alloc((x) * (y), 0, false)
+#define QUIRC_FREE(x) gc_free((x))
+
+#define QUIRC_SMALL_STACK (1)

tests/extmod/qrio.py

@@ -0,0 +1,13 @@
+try:
+    import qrio
+except:
+    print("SKIP")
+    raise SystemExit
+
+loc = __file__.rsplit("/", 1)[0]
+with open(f"{loc}/data/qr.pgm") as f:
+    content = f.read()[-320 * 240 :]
+
+decoder = qrio.QRDecoder(320, 240)
+for r in decoder.decode(content):
+    print(r)

tests/extmod/qrio.py.exp

@@ -0,0 +1 @@
+QRInfo(payload=b'https://adafru.it', data_type='iso_8859-2')

tests/unix/extra_coverage.py.exp

@@ -32,11 +32,11 @@ mport
 builtins        micropython     _thread         array
 btree           cexample        cmath           collections
 cppexample      ffi             framebuf        gc
-hashlib         math            sys             termios
+hashlib         math            qrio            sys
-ubinascii       uctypes         uerrno          uheapq
+termios         ubinascii       uctypes         uerrno
-uio             ujson           ulab            uos
+uheapq          uio             ujson           ulab
-urandom         ure             uselect         ustruct
+uos             urandom         ure             uselect
-utime           utimeq          uzlib
+ustruct         utime           utimeq          uzlib
 ime
 
 utime           utimeq