enable jpegio in zephyr port and add test for it. add more to jpegio docstring example

FoamyGuy · FoamyGuy · commit 68fc784df040 · 2026-04-16T13:28:34.000-05:00
diff --git a/ports/zephyr-cp/boards/adafruit/feather_nrf52840_sense_zephyr/autogen_board_info.toml b/ports/zephyr-cp/boards/adafruit/feather_nrf52840_sense_zephyr/autogen_board_info.toml
@@ -50,15 +50,15 @@ frequencyio = false
 getpass = false
 gifio = false
 gnss = false
-hashlib = false
+hashlib = true
 hostnetwork = false
 i2cdisplaybus = true # Zephyr board has busio
 i2cioexpander = false
 i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
@@ -117,4 +117,4 @@ watchdog = false
 wifi = false
 zephyr_display = false
 zephyr_kernel = false
-zlib = false
+zlib = true
diff --git a/ports/zephyr-cp/boards/adafruit/feather_nrf52840_zephyr/autogen_board_info.toml b/ports/zephyr-cp/boards/adafruit/feather_nrf52840_zephyr/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/adafruit/feather_rp2040_zephyr/autogen_board_info.toml b/ports/zephyr-cp/boards/adafruit/feather_rp2040_zephyr/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/native/native_sim/autogen_board_info.toml b/ports/zephyr-cp/boards/native/native_sim/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = true # Zephyr networking enabled
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/native/nrf5340bsim/autogen_board_info.toml b/ports/zephyr-cp/boards/native/nrf5340bsim/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/nordic/nrf5340dk/autogen_board_info.toml b/ports/zephyr-cp/boards/nordic/nrf5340dk/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/nordic/nrf54h20dk/autogen_board_info.toml b/ports/zephyr-cp/boards/nordic/nrf54h20dk/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = 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
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/nordic/nrf7002dk/circuitpython.toml b/ports/zephyr-cp/boards/nordic/nrf7002dk/circuitpython.toml
@@ -2,4 +2,4 @@ CIRCUITPY_BUILD_EXTENSIONS = ["elf"]
 USB_VID=0x239A
 USB_PID=0x8168
 BLOBS=["nrf_wifi"]
-DISABLED_MODULES=["aesio", "adafruit_bus_device", "zlib"]
+DISABLED_MODULES=["aesio", "adafruit_bus_device", "zlib", "jpegio"]
diff --git a/ports/zephyr-cp/boards/nxp/frdm_mcxn947/autogen_board_info.toml b/ports/zephyr-cp/boards/nxp/frdm_mcxn947/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/nxp/frdm_rw612/autogen_board_info.toml b/ports/zephyr-cp/boards/nxp/frdm_rw612/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = true # Zephyr networking enabled
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/nxp/mimxrt1170_evk/autogen_board_info.toml b/ports/zephyr-cp/boards/nxp/mimxrt1170_evk/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/raspberrypi/rpi_pico2_w_zephyr/autogen_board_info.toml b/ports/zephyr-cp/boards/raspberrypi/rpi_pico2_w_zephyr/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = true # Zephyr networking enabled
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/raspberrypi/rpi_pico2_zephyr/autogen_board_info.toml b/ports/zephyr-cp/boards/raspberrypi/rpi_pico2_zephyr/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/raspberrypi/rpi_pico_w_zephyr/autogen_board_info.toml b/ports/zephyr-cp/boards/raspberrypi/rpi_pico_w_zephyr/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = true # Zephyr networking enabled
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/raspberrypi/rpi_pico_zephyr/autogen_board_info.toml b/ports/zephyr-cp/boards/raspberrypi/rpi_pico_zephyr/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/renesas/da14695_dk_usb/autogen_board_info.toml b/ports/zephyr-cp/boards/renesas/da14695_dk_usb/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = 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
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/renesas/ek_ra8d1/autogen_board_info.toml b/ports/zephyr-cp/boards/renesas/ek_ra8d1/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/st/nucleo_n657x0_q/autogen_board_info.toml b/ports/zephyr-cp/boards/st/nucleo_n657x0_q/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = 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
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/st/stm32h750b_dk/autogen_board_info.toml b/ports/zephyr-cp/boards/st/stm32h750b_dk/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = 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
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/boards/st/stm32wba65i_dk1/autogen_board_info.toml b/ports/zephyr-cp/boards/st/stm32wba65i_dk1/autogen_board_info.toml
@@ -58,7 +58,7 @@ i2ctarget = false
 imagecapture = false
 ipaddress = false
 is31fl3741 = false
-jpegio = false
+jpegio = true
 keypad = false
 keypad_demux = false
 locale = false
diff --git a/ports/zephyr-cp/cptools/build_circuitpython.py b/ports/zephyr-cp/cptools/build_circuitpython.py
@@ -65,6 +65,7 @@
     "hashlib",
     "zlib",
     "adafruit_bus_device",
+    "jpegio",
 ]
 # Flags that don't match with with a *bindings module. Some used by adafruit_requests
 MPCONFIG_FLAGS = ["array", "errno", "io", "json", "math"]
@@ -118,6 +119,9 @@
         "lib/uzlib/adler32.c",
         "lib/uzlib/crc32.c",
     ],
+    "jpegio": [
+        "lib/tjpgd/src/tjpgd.c"
+    ]
 }
 
 SHARED_MODULE_AND_COMMON_HAL = ["_bleio", "os", "rotaryio"]
diff --git a/ports/zephyr-cp/tests/zephyr_display/golden/jpegio_test_pattern_320x240.png b/ports/zephyr-cp/tests/zephyr_display/golden/jpegio_test_pattern_320x240.png
diff --git a/ports/zephyr-cp/tests/zephyr_display/test.jpg b/ports/zephyr-cp/tests/zephyr_display/test.jpg
diff --git a/ports/zephyr-cp/tests/zephyr_display/test_jpegio.py b/ports/zephyr-cp/tests/zephyr_display/test_jpegio.py
@@ -0,0 +1,87 @@
+# SPDX-FileCopyrightText: 2026 Scott Shawcroft for Adafruit Industries
+# SPDX-License-Identifier: MIT
+
+import shutil
+from pathlib import Path
+
+import pytest
+from PIL import Image
+
+
+_TEST_JPG_PATH = Path(__file__).parent / "test.jpg"
+_TEST_JPG_BYTES = _TEST_JPG_PATH.read_bytes()
+
+
+def _read_image(path: Path) -> tuple[int, int, bytes]:
+    with Image.open(path) as img:
+        rgb = img.convert("RGB")
+        return rgb.width, rgb.height, rgb.tobytes()
+
+
+def _golden_compare_or_update(request, captures, golden_path):
+    if not captures or not captures[0].exists():
+        pytest.skip("display capture was not produced")
+
+    if request.config.getoption("--update-goldens"):
+        golden_path.parent.mkdir(parents=True, exist_ok=True)
+        shutil.copy2(captures[0], golden_path)
+        return
+
+    gw, gh, gpx = _read_image(golden_path)
+    dw, dh, dpx = _read_image(captures[0])
+    assert (dw, dh) == (gw, gh)
+    assert gpx == dpx
+
+
+JPEGIO_DECODE_CODE = """\
+import board
+import displayio
+import time
+from jpegio import JpegDecoder
+
+decoder = JpegDecoder()
+width, height = decoder.open("/test.jpg")
+print('size', width, height)
+
+bitmap = displayio.Bitmap(width, height, 65535)
+decoder.decode(bitmap)
+
+for i in range(min(width, 8)):
+    print('px', i, hex(bitmap[i, 0]))
+
+scale = 10
+tg = displayio.TileGrid(
+    bitmap,
+    pixel_shader=displayio.ColorConverter(
+        input_colorspace=displayio.Colorspace.RGB565_SWAPPED
+    ),
+)
+g = displayio.Group(scale=scale)
+g.x = (board.DISPLAY.width - width * scale) // 2
+g.y = (board.DISPLAY.height - height * scale) // 2
+g.append(tg)
+
+board.DISPLAY.auto_refresh = False
+board.DISPLAY.root_group = g
+board.DISPLAY.refresh()
+print('rendered')
+while True:
+    time.sleep(1)
+"""
+
+
+_JPEGIO_DRIVE = {"code.py": JPEGIO_DECODE_CODE, "test.jpg": _TEST_JPG_BYTES}
+
+
+@pytest.mark.circuitpy_drive(_JPEGIO_DRIVE)
+@pytest.mark.display(capture_times_ns=[14_000_000_000])
+@pytest.mark.duration(18)
+def test_jpegio_decode(request, circuitpython):
+    circuitpython.wait_until_done()
+
+    output = circuitpython.serial.all_output
+    assert "size 20 20" in output
+    assert "rendered" in output
+
+    golden = Path(__file__).parent / "golden" / "jpegio_test_pattern_320x240.png"
+    _golden_compare_or_update(request, circuitpython.display_capture_paths(), golden)
diff --git a/shared-bindings/jpegio/JpegDecoder.c b/shared-bindings/jpegio/JpegDecoder.c
@@ -23,13 +23,18 @@
 //|     Example::
 //|
 //|         from jpegio import JpegDecoder
-//|         from displayio import Bitmap
+//|         from displayio import Bitmap, TileGrid, ColorConverter, Colorspace
+//|         import supervisor
 //|
 //|         decoder = JpegDecoder()
 //|         width, height = decoder.open("/sd/example.jpg")
 //|         bitmap = Bitmap(width, height, 65535)
 //|         decoder.decode(bitmap)
-//|         # .. do something with bitmap
+//|         tg = TileGrid(bitmap, pixel_shader=ColorConverter(input_colorspace=Colorspace.RGB565_SWAPPED))
+//|         supervisor.runtime.display.root_group = tg
+//|         while True:
+//|             pass
+//|
 //|     """
 //|
 //|     def __init__(self) -> None:
