Merge pull request #5094 from jepler/quirc

Add qrio: Decode QR codes with quirc lib

Author: microdev1

.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

@@ -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 ""
 

locale/circuitpython.pot

@@ -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/atmel-samd/Makefile

@@ -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.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

@@ -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/esp32s2/mpconfigport.mk

@@ -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/nrf/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/raspberrypi/Makefile

@@ -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

ports/unix/variants/coverage/mpconfigvariant.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_defns.mk

@@ -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.h

@@ -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)
 

py/circuitpy_mpconfig.mk

@@ -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.c

@@ -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;