From cafa6f3d61a17cb5954d334f1c184676ea8532a7 Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Wed, 5 Aug 2026 01:48:39 -0300 Subject: [PATCH 01/18] Add Switch OTA launcher with unified SD zip and quiet UI. Ships a dual-NRO native launcher that checks GitHub Releases, updates both NROs from gen1recomp-*-switch.zip with matching NACP versions, and stays silent unless an update needs confirm. --- .gitignore | 8 + docs/switch-build.md | 36 ++ docs/switch-development.md | 10 +- docs/switch-install.md | 40 +- docs/updater.md | 6 + native/switch-ota-launcher/Makefile | 165 +++++++ native/switch-ota-launcher/README.md | 66 +++ .../host/test_ota_protocol.c | 94 ++++ native/switch-ota-launcher/include/ota_fs.h | 32 ++ native/switch-ota-launcher/include/ota_net.h | 22 + .../include/ota_protocol.h | 92 ++++ .../switch-ota-launcher/include/ota_unzip.h | 20 + native/switch-ota-launcher/src/main.c | 330 +++++++++++++ native/switch-ota-launcher/src/ota_fs.c | 136 +++++ native/switch-ota-launcher/src/ota_net.c | 119 +++++ native/switch-ota-launcher/src/ota_protocol.c | 292 +++++++++++ native/switch-ota-launcher/src/ota_unzip.c | 89 ++++ scripts/build_switch.sh | 44 +- scripts/switch/build_ota_launcher.sh | 74 +++ scripts/switch/install_devkitpro_deps.sh | 57 +++ scripts/switch/ota_launcher.manifest | 16 + scripts/switch/pack_sd_zip.sh | 35 +- scripts/switch/selftest_build_switch.sh | 95 +++- src/update/SwitchOta.lua | 186 +++++++ test/switch-nro-ota.spec.test.js | 467 ++++++++++++++++++ 25 files changed, 2505 insertions(+), 26 deletions(-) create mode 100644 native/switch-ota-launcher/Makefile create mode 100644 native/switch-ota-launcher/README.md create mode 100644 native/switch-ota-launcher/host/test_ota_protocol.c create mode 100644 native/switch-ota-launcher/include/ota_fs.h create mode 100644 native/switch-ota-launcher/include/ota_net.h create mode 100644 native/switch-ota-launcher/include/ota_protocol.h create mode 100644 native/switch-ota-launcher/include/ota_unzip.h create mode 100644 native/switch-ota-launcher/src/main.c create mode 100644 native/switch-ota-launcher/src/ota_fs.c create mode 100644 native/switch-ota-launcher/src/ota_net.c create mode 100644 native/switch-ota-launcher/src/ota_protocol.c create mode 100644 native/switch-ota-launcher/src/ota_unzip.c create mode 100755 scripts/switch/build_ota_launcher.sh create mode 100755 scripts/switch/install_devkitpro_deps.sh create mode 100644 scripts/switch/ota_launcher.manifest create mode 100644 src/update/SwitchOta.lua create mode 100644 test/switch-nro-ota.spec.test.js diff --git a/.gitignore b/.gitignore index c7ab5ab3..9ec4ba6b 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,14 @@ mobile/ios/build/ # Final packaged build artifacts (mac/win/web/android/ios/switch) — see scripts/build.sh /dist/ +# Native Switch OTA launcher build outputs +native/switch-ota-launcher/build/ +native/switch-ota-launcher/build-host/ +native/switch-ota-launcher/*.nro +native/switch-ota-launcher/*.nacp +native/switch-ota-launcher/*.elf +native/switch-ota-launcher/*.map + # Legacy manual convenience-copy location (superseded by /dist/android/) mobile/dist/ diff --git a/docs/switch-build.md b/docs/switch-build.md index 74b33567..2cc3d59a 100644 --- a/docs/switch-build.md +++ b/docs/switch-build.md @@ -34,6 +34,42 @@ WSL — not cmd.exe or PowerShell (AD-008). **Optional:** Install [Docker](https://docs.docker.com/get-docker/) so fused builds can fall back to the pinned image when native tools are missing. +### Native OTA launcher (optional but required for in-console updates) + +In-console OTA uses a **separate DEVKITPRO NRO** (not LÖVE). Source: +`native/switch-ota-launcher/`. Host protocol tests (no toolchain): + +```sh +make -C native/switch-ota-launcher host-test +# or +scripts/switch/build_ota_launcher.sh # host-test first; NRO needs DEVKITPRO/Docker +``` + +Extra packages beyond `switch-dev`: + +```sh +sudo dkp-pacman -S --noconfirm --needed switch-curl switch-mbedtls switch-zlib switch-zziplib +# or: bash scripts/switch/install_devkitpro_deps.sh +``` + +Packaging dual-NRO SD zip (launcher entry + fused game): + +```sh +scripts/switch/pack_sd_zip.sh dist/switch/game.nro VERSION out.zip dist/switch/gen1recomp-launcher.nro +``` + +One-shot OTA release build (fused game + launcher + dual-NRO SD zip; +the same `*-switch.zip` is the OTA download asset): + +```sh +# once: bash scripts/switch/install_devkitpro_deps.sh +export DEVKITPRO=/opt/devkitpro +scripts/build_switch.sh --fetch --ota --version X.Y.Z +``` + +See `native/switch-ota-launcher/README.md` and +`scripts/switch/ota_launcher.manifest`. + ### Windows (Git Bash / MSYS2 / WSL) 1. Use a bash environment: diff --git a/docs/switch-development.md b/docs/switch-development.md index 8e00e072..e253f5b1 100644 --- a/docs/switch-development.md +++ b/docs/switch-development.md @@ -32,7 +32,7 @@ the transfer runbook). | Hardware | **OLED** validated (author, title override); **V1 / Erista** boot confirmed (community). Lite, docked soak, and Pro Controller matrices welcome | | Deploy / install | Releases publish SD-ready zip; **extract/merge at microSD root** (MTP / SD / FTP — [switch-transfer.md](switch-transfer.md)); no `nxlink` path yet | | Contributor transfer | Documented for **macOS, Linux, and Windows**; OpenMTP on Mac is one example, not the only contract | -| Network features on NX | Self-update / remote mod download **disabled** (`networkValidated == false`) | +| Network features on NX | LÖVE self-update / remote mod download **disabled** (`networkValidated == false`). In-console OTA is the **native OTA launcher** only (see below) | | Community help | Welcome — especially HOS / love-nx packaging and broader hardware coverage | ### What landed @@ -57,6 +57,14 @@ the transfer runbook). - Switch Lite and fuller Pro Controller / third-party pad matrices - Applet Mode remains unsupported by design (title override required) - `nxlink` / netloader contrib fast-loop (deferred — see [switch-transfer.md](switch-transfer.md)) +- **Native OTA launcher:** in-console updates use a DEVKITPRO + **native OTA launcher** (libnx + switch-curl) before the LÖVE game NRO — + **not** the LÖVE self-updater (`src/update/Check.lua`). Contract: + `src/update/SwitchOta.lua`; packaging gate: + `scripts/switch/ota_launcher.manifest`. The download asset is the same + `gen1recomp-*-switch.zip` as install. UI stays quiet unless an update + needs confirm. Player-facing flow: [switch-install.md](switch-install.md) + § Updating. Transfer runbooks for Linux/Windows (and SD/FTP alternatives) are in [switch-transfer.md](switch-transfer.md). Community mod zip install OLED smoke diff --git a/docs/switch-install.md b/docs/switch-install.md index e173dfc2..788d7a08 100644 --- a/docs/switch-install.md +++ b/docs/switch-install.md @@ -29,12 +29,17 @@ help from [booshankles](https://github.com/booshankles). Extract the zip at the **root** of the microSD so you get: ```text -sdmc:/switch/gen1recomp/gen1recomp.nro +sdmc:/switch/gen1recomp/gen1recomp.nro # native OTA launcher (hbmenu entry) +sdmc:/switch/gen1recomp/gen1recomp-game.nro # fused LÖVE game (when OTA layout ships) +sdmc:/switch/gen1recomp/version.txt sdmc:/switch/gen1recomp/pokemon-love2d/imports/ sdmc:/switch/gen1recomp/pokemon-love2d/imports/mods/ sdmc:/switch/gen1recomp/pokemon-love2d/imports/saves/... ``` +Older single-NRO zips only had `gen1recomp.nro` (the fused game). New OTA-ready +zips use the dual-NRO layout above — open `gen1recomp` in hbmenu (the launcher). + Merge folders if your OS asks. Any method works: **MTP** (DBI → Run MTP responder + a client), **direct SD** (Hekate UMS or a card reader), or **FTP**. Exit MTP / unmount / stop FTP cleanly before launching. Step-by-step for @@ -42,10 +47,35 @@ macOS, Linux, and Windows: [switch-transfer.md](switch-transfer.md). ### Updating -Use the **same** extract/merge. It replaces `gen1recomp.nro` (and the small -help `README.txt` / `INSTALL.txt` files). Saves, imported ROMs, mods, and -options live under `pokemon-love2d/` — **do not delete that folder** when -updating, or you will lose progress. +#### Native OTA launcher (in-console) + +On Switch, over-the-air updates are handled by the **native OTA launcher** +(DEVKITPRO / libnx + curl), **not** by the LÖVE self-updater +(`src/update/Check.lua`). The hbmenu entry is the launcher NRO +(`gen1recomp.nro`). If a newer release exists it may download the same +`gen1recomp-*-switch.zip` used for install, verify SHA-256 from +`sha256sums.txt`, replace **both** `gen1recomp-game.nro` and +`gen1recomp.nro` (so the NACP version matches the release for hbmenu / +Sphaira), then hand off via `envSetNextLoad`. When you are already up to +date (or offline), the launcher stays quiet and opens the game with no +console flash. Saves under `pokemon-love2d/` are never touched. Protocol +contract: `src/update/SwitchOta.lua`. + +The LÖVE self-updater stays **disabled** on NX (`networkValidated == false`). + +**Sphaira forwarder (HOME shortcut):** Sphaira copies name/version/icon into +the installed forwarder at creation time. After an OTA (or zip) update, the +`.nro` on the microSD already has the new version — but the HOME shortcut +keeps the old badge until you **reinstall the forwarder once** in Sphaira +(Install Forwarder again on `gen1recomp.nro`). Browsing the NRO in Sphaira / +hbmenu always shows the live file version. + +#### Manual zip (fallback) + +Use the **same** extract/merge of `gen1recomp-*-switch.zip`. It replaces the +NROs (and the small help `README.txt` / `INSTALL.txt` files). Saves, +imported ROMs, mods, and options live under `pokemon-love2d/` — **do not +delete that folder** when updating, or you will lose progress. ## 3. Launch with title override diff --git a/docs/updater.md b/docs/updater.md index b0de76c8..6a7c6625 100644 --- a/docs/updater.md +++ b/docs/updater.md @@ -124,3 +124,9 @@ bundled game, in that case. `love.filesystem.isFused()` is false, and a working tree's `engine` is the `"0.0.0-dev"` placeholder that always reports up to date, so a source checkout is always "the game" itself; updating it means pulling the repo. +- **Nintendo Switch does not use this LÖVE self-updater.** On NX, + `Platform.networkValidated()` is `false`, so `Boot.run` / `Check` never + download `.love` payloads. In-console OTA is the **native OTA launcher** + (DEVKITPRO) documented in [switch-install.md](switch-install.md) and + [switch-development.md](switch-development.md); protocol contract + `src/update/SwitchOta.lua`. Manual zip install remains the fallback. diff --git a/native/switch-ota-launcher/Makefile b/native/switch-ota-launcher/Makefile new file mode 100644 index 00000000..9509a180 --- /dev/null +++ b/native/switch-ota-launcher/Makefile @@ -0,0 +1,165 @@ +#--------------------------------------------------------------------------------- +# gen1recomp Switch native OTA launcher +# Requires: DEVKITPRO + switch-curl, switch-mbedtls, switch-zlib, switch-zziplib +# Host protocol tests: make host-test (no DEVKITPRO needed) +#--------------------------------------------------------------------------------- +.SUFFIXES: + +#--------------------------------------------------------------------------------- +# Host-only path when DEVKITPRO is unset +#--------------------------------------------------------------------------------- +ifeq ($(strip $(DEVKITPRO)),) + +.PHONY: host-test clean-host +host-test: + @mkdir -p build-host + cc -std=c11 -Wall -Wextra -Iinclude -o build-host/test_ota_protocol \ + src/ota_protocol.c host/test_ota_protocol.c + ./build-host/test_ota_protocol + +clean-host: + rm -rf build-host + +%: + @echo "DEVKITPRO not set — only 'make host-test' is available." + @echo "Run: bash scripts/switch/install_devkitpro_deps.sh" + @false + +else + +#--------------------------------------------------------------------------------- +TOPDIR ?= $(CURDIR) +include $(DEVKITPRO)/libnx/switch_rules + +#--------------------------------------------------------------------------------- +TARGET := gen1recomp +BUILD := build +SOURCES := src +DATA := data +INCLUDES := include + +APP_TITLE := gen1recomp +APP_AUTHOR := bryanthaboi, port by andrewqsantos +# Overridable: scripts/switch/build_ota_launcher.sh passes release X.Y.Z +APP_VERSION ?= 0.0.0 + +# Prefer project Switch icon if present +ICON := $(TOPDIR)/../../assets/switch/icon.jpg + +#--------------------------------------------------------------------------------- +ARCH := -march=armv8-a+crc+crypto -mtune=cortex-a57 -mtp=soft -fPIE + +CFLAGS := -g -Wall -O2 -ffunction-sections $(ARCH) $(DEFINES) +CFLAGS += $(INCLUDE) -D__SWITCH__ + +CXXFLAGS := $(CFLAGS) -fno-rtti -fno-exceptions + +ASFLAGS := -g $(ARCH) +LDFLAGS = -specs=$(DEVKITPRO)/libnx/switch.specs -g $(ARCH) -Wl,-Map,$(notdir $*.map) + +LIBS := -lcurl -lzzip -lmbedtls -lmbedx509 -lmbedcrypto -lz -lnx + +LIBDIRS := $(PORTLIBS) $(LIBNX) + +#--------------------------------------------------------------------------------- +ifneq ($(BUILD),$(notdir $(CURDIR))) +#--------------------------------------------------------------------------------- + +export OUTPUT := $(CURDIR)/$(TARGET) +export TOPDIR := $(CURDIR) + +export VPATH := $(foreach dir,$(SOURCES),$(CURDIR)/$(dir)) \ + $(foreach dir,$(DATA),$(CURDIR)/$(dir)) + +export DEPSDIR := $(CURDIR)/$(BUILD) + +CFILES := $(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.c))) +CPPFILES := $(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.cpp))) +SFILES := $(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.s))) +BINFILES := $(foreach dir,$(DATA),$(notdir $(wildcard $(dir)/*.*))) + +#--------------------------------------------------------------------------------- +# use CXX for linking C++ projects, CC for standard C +#--------------------------------------------------------------------------------- +ifeq ($(strip $(CPPFILES)),) + export LD := $(CC) +else + export LD := $(CXX) +endif +#--------------------------------------------------------------------------------- + +export OFILES_BIN := $(addsuffix .o,$(BINFILES)) +export OFILES_SRC := $(CPPFILES:.cpp=.o) $(CFILES:.c=.o) $(SFILES:.s=.o) +export OFILES := $(OFILES_BIN) $(OFILES_SRC) + +export INCLUDE := $(foreach dir,$(INCLUDES),-I$(CURDIR)/$(dir)) \ + $(foreach dir,$(LIBDIRS),-I$(dir)/include) \ + -I$(CURDIR)/$(BUILD) + +export LIBPATHS := $(foreach dir,$(LIBDIRS),-L$(dir)/lib) + +ifeq ($(strip $(ICON)),) + icons := $(wildcard *.jpg) + ifneq (,$(findstring $(TARGET).jpg,$(icons))) + export APP_ICON := $(TOPDIR)/$(TARGET).jpg + else + ifneq (,$(findstring icon.jpg,$(icons))) + export APP_ICON := $(TOPDIR)/icon.jpg + endif + endif +else + ifeq ($(wildcard $(ICON)),) + # fall back to libnx default if project icon missing + export APP_ICON := $(LIBNX)/default_icon.jpg + else + export APP_ICON := $(ICON) + endif +endif + +ifeq ($(strip $(NO_ICON)),) + export NROFLAGS += --icon=$(APP_ICON) +endif + +ifeq ($(strip $(NO_NACP)),) + export NROFLAGS += --nacp=$(CURDIR)/$(TARGET).nacp +endif + +.PHONY: $(BUILD) clean all host-test + +#--------------------------------------------------------------------------------- +all: $(BUILD) + +$(BUILD): + @[ -d $@ ] || mkdir -p $@ + @$(MAKE) --no-print-directory -C $(BUILD) -f $(CURDIR)/Makefile + +#--------------------------------------------------------------------------------- +clean: + @echo clean ... + @rm -fr $(BUILD) $(TARGET).nro $(TARGET).nacp $(TARGET).elf $(TARGET).lst build-host + +host-test: + @mkdir -p build-host + cc -std=c11 -Wall -Wextra -Iinclude -o build-host/test_ota_protocol \ + src/ota_protocol.c host/test_ota_protocol.c + ./build-host/test_ota_protocol + +#--------------------------------------------------------------------------------- +else +.PHONY: all + +DEPENDS := $(OFILES:.o=.d) + +#--------------------------------------------------------------------------------- +all: $(OUTPUT).nro + +$(OUTPUT).nro: $(OUTPUT).elf $(OUTPUT).nacp + +$(OUTPUT).elf: $(OFILES) + +-include $(DEPENDS) + +#--------------------------------------------------------------------------------- +endif +#--------------------------------------------------------------------------------- +endif diff --git a/native/switch-ota-launcher/README.md b/native/switch-ota-launcher/README.md new file mode 100644 index 00000000..a99db455 --- /dev/null +++ b/native/switch-ota-launcher/README.md @@ -0,0 +1,66 @@ +# Native Switch OTA launcher + +In-console updates for Gen1Recomp on Nintendo Switch. This NRO is the **hbmenu +entry** (`gen1recomp.nro`). It checks GitHub Releases quietly (no console flash +when you are already up to date or offline). Only if a newer release exists +does it prompt to download the same `gen1recomp-*-switch.zip` used for install, +verify SHA-256 from `sha256sums.txt`, replace **both** `gen1recomp-game.nro` +and `gen1recomp.nro` (matching NACP version for hbmenu/Sphaira), then hand off +with `envSetNextLoad`. + +The LÖVE self-updater (`src/update/Check.lua`) stays **disabled** on NX. +Protocol contract (also in Lua): `src/update/SwitchOta.lua`. +NACP icon: `assets/switch/icon.jpg`. + +## Layout on microSD + +```text +sdmc:/switch/gen1recomp/gen1recomp.nro ← this launcher +sdmc:/switch/gen1recomp/gen1recomp-game.nro ← fused LÖVE game +sdmc:/switch/gen1recomp/version.txt ← installed X.Y.Z +sdmc:/switch/gen1recomp/pokemon-love2d/ ← saves (never touched by OTA) +``` + +## Host tests (no DEVKITPRO) + +```bash +cd native/switch-ota-launcher +make host-test +``` + +## Switch build (DEVKITPRO) + +Needs `DEVKITPRO` with packages roughly: + +```bash +(dkp-)pacman -S --needed switch-curl switch-mbedtls switch-zlib switch-zziplib +# or: bash scripts/switch/install_devkitpro_deps.sh +``` + +```bash +export DEVKITPRO=/opt/devkitpro # typical +cd native/switch-ota-launcher +make +# → gen1recomp.nro +``` + +Or from repo root: + +```bash +scripts/switch/build_ota_launcher.sh +``` + +Docker fallback uses the same pin as fused builds (`scripts/switch/dkp-docker.image`). + +## Packaging + +`scripts/switch/pack_sd_zip.sh GAME_NRO VERSION OUT_ZIP LAUNCHER_NRO` writes both +NROs into the SD zip. That zip is also the OTA download asset (unified). +Manifest: `scripts/switch/ota_launcher.manifest`. + +## Status / known gaps + +- Zip extraction uses `switch-zziplib` (`ota_unzip.c`) on device. +- OTA replaces launcher + game from the unified zip (NACP versions stay aligned). +- Sphaira HOME forwarders cache metadata until reinstalled (see docs/switch-install.md). +- Install toolchain deps once: `bash scripts/switch/install_devkitpro_deps.sh` diff --git a/native/switch-ota-launcher/host/test_ota_protocol.c b/native/switch-ota-launcher/host/test_ota_protocol.c new file mode 100644 index 00000000..9f20fe15 --- /dev/null +++ b/native/switch-ota-launcher/host/test_ota_protocol.c @@ -0,0 +1,94 @@ +/* Host-only unit tests for ota_protocol.c — no libnx. */ +#include "ota_protocol.h" + +#include +#include + +static int g_fail = 0; + +static void expect(int cond, const char *msg) { + if (!cond) { + fprintf(stderr, "FAIL: %s\n", msg); + g_fail++; + } else { + printf("PASS: %s\n", msg); + } +} + +int main(void) { + expect(ota_compare_semver("1.2.0", "1.1.0") == 1, "semver newer"); + expect(ota_compare_semver("1.1.0", "1.1.0") == 0, "semver equal"); + expect(ota_compare_semver("1.0.0", "1.1.0") == -1, "semver older"); + expect(ota_is_ota_asset_name("gen1recomp-1.5.0-switch.zip"), "ota asset name"); + expect(!ota_is_ota_asset_name("gen1recomp-1.5.0-switch-ota.zip"), "reject legacy ota zip name"); + expect(!ota_is_ota_asset_name("gen1recomp-1.5.0.love"), "reject love payload"); + + const char *json = + "{" + "\"tag_name\":\"v1.5.0\"," + "\"assets\":[" + "{\"name\":\"gen1recomp-1.5.0-switch.zip\"," + "\"browser_download_url\":\"https://example/switch.zip\"}," + "{\"name\":\"sha256sums.txt\",\"browser_download_url\":\"https://example/sums\"}" + "]" + "}"; + ota_release_t rel; + expect(ota_parse_release(json, &rel) == 1, "parse release"); + expect(strcmp(rel.version, "1.5.0") == 0, "release version"); + expect(strcmp(rel.asset_name, "gen1recomp-1.5.0-switch.zip") == 0, "release asset"); + + ota_decision_t d; + ota_decide_update("1.4.0", &rel, &d); + expect(strcmp(d.status, "available") == 0, "decide available"); + ota_decide_update("1.5.0", &rel, &d); + expect(strcmp(d.status, "uptodate") == 0, "decide uptodate"); + + ota_release_t bad; + expect(ota_parse_release("{\"tag_name\":\"v1.5.0\",\"assets\":[]}", &bad) == 0, + "missing ota asset"); + expect(strcmp(bad.reason, "missing_ota_asset") == 0, "missing_ota_asset reason"); + + const char *sums = "abc123 gen1recomp-1.5.0-switch.zip\n"; + ota_verify_t v; + ota_verify_sha256("gen1recomp-1.5.0-switch.zip", "abc123", sums, &v); + expect(v.ok == 1, "sha ok"); + ota_verify_sha256("gen1recomp-1.5.0-switch.zip", "deadbeef", sums, &v); + expect(v.ok == 0 && strcmp(v.reason, "hash_mismatch") == 0, "sha mismatch"); + ota_verify_sha256("gen1recomp-1.5.0-switch.zip", "abc123", "", &v); + expect(v.ok == 0 && strcmp(v.reason, "sum_not_found") == 0, "sha missing sum rejected"); + + ota_apply_plan_t plan; + ota_plan_atomic_apply("switch/gen1recomp", "/tmp/x", &plan); + expect(strstr(plan.steps[0], "copy_to_part:") != NULL, "plan copy"); + expect(strstr(plan.steps[1], "rename:") != NULL, "plan rename"); + expect(strstr(plan.steps[2], "copy_to_part:launcher") != NULL, "plan launcher copy"); + expect(strstr(plan.steps[3], "rename:") != NULL, "plan launcher rename"); + expect(strstr(plan.steps[4], "env_set_next_load:") != NULL, "plan handoff"); + expect(strstr(plan.preserve, "pokemon-love2d") != NULL, "preserve saves"); + expect(strstr(plan.forbidden_delete, "delete:") != NULL, "forbid delete saves"); + expect(strstr(plan.forbidden_direct, "write_direct:") != NULL, "forbid direct write"); + + ota_offline_t off; + ota_offline_events_t ev = {0}; + ev.user_skip = 1; + ota_offline_policy(1.0, &ev, &off); + expect(strcmp(off.action, "play_installed") == 0, "skip plays installed"); + ev.user_skip = 0; + ev.network_ok = 0; + ota_offline_policy(1.0, &ev, &off); + expect(strcmp(off.action, "play_installed") == 0, "offline plays installed"); + ev.network_ok = 1; + ota_offline_policy(6.0, &ev, &off); + expect(strcmp(off.reason, "timeout") == 0, "timeout 6s"); + ota_offline_policy(2.0, &ev, &off); + expect(strcmp(off.action, "keep_checking") == 0, "still checking"); + + expect(OTA_CHECK_TIMEOUT_SEC == 6, "timeout constant 6"); + + if (g_fail) { + fprintf(stderr, "%d failure(s)\n", g_fail); + return 1; + } + printf("all ota_protocol host tests passed\n"); + return 0; +} diff --git a/native/switch-ota-launcher/include/ota_fs.h b/native/switch-ota-launcher/include/ota_fs.h new file mode 100644 index 00000000..4a43968e --- /dev/null +++ b/native/switch-ota-launcher/include/ota_fs.h @@ -0,0 +1,32 @@ +#ifndef GEN1_OTA_FS_H +#define GEN1_OTA_FS_H + +#include "ota_protocol.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/* Read installed game version from sibling version.txt or NRO nacp-less stamp file. + * Expects switch/gen1recomp/version.txt containing X.Y.Z. Returns 0 on success. */ +int ota_fs_read_installed_version(const char *install_dir, char *out, size_t out_len); + +/* SHA-256 hex (lowercase) of file. Returns 0 on success. */ +int ota_fs_sha256_file(const char *path, char *out_hex, size_t out_len); + +/* Apply verified temp payload (extracted game NRO) using atomic plan. Returns 0 on success. */ +int ota_fs_atomic_replace_game(const char *install_dir, const char *verified_game_nro, + char *err, size_t err_len); + +/* Atomically replace any named NRO under install_dir (copy→.part→rename). */ +int ota_fs_atomic_replace_nro(const char *install_dir, const char *nro_name, + const char *verified_nro, char *err, size_t err_len); + +/* Hand off to game NRO via envSetNextLoad (Switch) or no-op stub (host). */ +int ota_fs_handoff_to_game(const char *game_nro_path, char *err, size_t err_len); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/native/switch-ota-launcher/include/ota_net.h b/native/switch-ota-launcher/include/ota_net.h new file mode 100644 index 00000000..eca59864 --- /dev/null +++ b/native/switch-ota-launcher/include/ota_net.h @@ -0,0 +1,22 @@ +#ifndef GEN1_OTA_NET_H +#define GEN1_OTA_NET_H + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* Download URL into memory buffer (caller frees *out). Returns 0 on success. */ +int ota_net_download_buffer(const char *url, long timeout_ms, char **out, size_t *out_len, + char *err, size_t err_len); + +/* Download URL to a filesystem path. Returns 0 on success. */ +int ota_net_download_file(const char *url, const char *path, long timeout_ms, char *err, + size_t err_len); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/native/switch-ota-launcher/include/ota_protocol.h b/native/switch-ota-launcher/include/ota_protocol.h new file mode 100644 index 00000000..5e24535e --- /dev/null +++ b/native/switch-ota-launcher/include/ota_protocol.h @@ -0,0 +1,92 @@ +#ifndef GEN1_OTA_PROTOCOL_H +#define GEN1_OTA_PROTOCOL_H + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#define OTA_CHECK_TIMEOUT_SEC 6 +#define OTA_GAME_NRO_NAME "gen1recomp-game.nro" +#define OTA_LAUNCHER_NRO_NAME "gen1recomp.nro" +#define OTA_SAVE_DIR_NAME "pokemon-love2d" +#define OTA_INSTALL_DIR "switch/gen1recomp" +#define OTA_RELEASES_API \ + "https://api.github.com/repos/bryanthaboi/gen1recomp/releases/latest" + +/* Mirrors src/update/SwitchOta.lua — keep semantics in lockstep. */ + +int ota_compare_semver(const char *a, const char *b); +int ota_is_ota_asset_name(const char *name); +int ota_version_from_ota_asset(const char *name, char *out, size_t out_len); + +typedef struct { + int ok; /* 1 on success */ + char reason[64]; + char tag[64]; + char version[32]; + char asset_name[128]; + char download_url[512]; +} ota_release_t; + +int ota_parse_release(const char *json_text, ota_release_t *out); + +typedef struct { + char status[32]; /* uptodate | available | error */ + char reason[64]; + char version[32]; + char asset_name[128]; + char download_url[512]; +} ota_decision_t; + +void ota_decide_update(const char *installed_version, const ota_release_t *release, + ota_decision_t *out); + +/* sums: newline-separated sha256sums.txt body */ +int ota_lookup_sum(const char *sums_text, const char *asset_name, char *out_hex, + size_t out_len); + +typedef struct { + int ok; + char reason[64]; +} ota_verify_t; + +void ota_verify_sha256(const char *asset_name, const char *actual_hex, + const char *sums_text, ota_verify_t *out); + +typedef struct { + char steps[5][520]; /* human-readable ops */ + char preserve[256]; + char forbidden_delete[256]; + char forbidden_direct[256]; + char part_path[256]; + char game_nro[240]; + char launcher_nro[240]; + char launcher_part[256]; + char next_load[240]; +} ota_apply_plan_t; + +void ota_plan_atomic_apply(const char *install_dir, const char *verified_temp, + ota_apply_plan_t *out); + +typedef struct { + char action[32]; /* play_installed | keep_checking */ + char reason[64]; + char message[128]; +} ota_offline_t; + +typedef struct { + int user_skip; + int network_ok; /* 0 = offline/fail, 1 = ok, -1 = unknown */ + int api_error; +} ota_offline_events_t; + +void ota_offline_policy(double elapsed_sec, const ota_offline_events_t *events, + ota_offline_t *out); + +#ifdef __cplusplus +} +#endif + +#endif /* GEN1_OTA_PROTOCOL_H */ diff --git a/native/switch-ota-launcher/include/ota_unzip.h b/native/switch-ota-launcher/include/ota_unzip.h new file mode 100644 index 00000000..83e9c9ca --- /dev/null +++ b/native/switch-ota-launcher/include/ota_unzip.h @@ -0,0 +1,20 @@ +#ifndef GEN1_OTA_UNZIP_H +#define GEN1_OTA_UNZIP_H + +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/* Extract member_name from zip_path into dest_path. + * Tries exact member_name, then common prefixes (switch/gen1recomp/). + * Returns 0 on success. */ +int ota_unzip_extract_file(const char *zip_path, const char *member_name, const char *dest_path, + char *err, size_t err_len); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/native/switch-ota-launcher/src/main.c b/native/switch-ota-launcher/src/main.c new file mode 100644 index 00000000..ded6532b --- /dev/null +++ b/native/switch-ota-launcher/src/main.c @@ -0,0 +1,330 @@ +/* + * gen1recomp Switch OTA launcher + * + * Quiet by default: checks GitHub Releases with no console flash. Only shows + * a short prompt when an update is available. Downloads the same SD zip + * published for install (gen1recomp-*-switch.zip), verifies SHA-256, extracts + * switch/gen1recomp/gen1recomp-game.nro, then envSetNextLoad to the game. + * Never touches pokemon-love2d/. LÖVE self-updater stays off on NX. + */ + +#include "ota_fs.h" +#include "ota_net.h" +#include "ota_protocol.h" +#include "ota_unzip.h" + +#include +#include +#include + +#if defined(__SWITCH__) +#include +#include +#include +#else +#include +#include +#endif + +#define SD_INSTALL_DIR "sdmc:/switch/gen1recomp" +#define CHECK_TIMEOUT_MS (OTA_CHECK_TIMEOUT_SEC * 1000L) +#define GAME_MEMBER_IN_ZIP "switch/gen1recomp/" OTA_GAME_NRO_NAME +#define LAUNCHER_MEMBER_IN_ZIP "switch/gen1recomp/" OTA_LAUNCHER_NRO_NAME + +#if defined(__SWITCH__) +static int g_ui = 0; + +static void ui_begin(void) { + if (g_ui) return; + consoleInit(NULL); + consoleClear(); + g_ui = 1; +} + +static void ui_end(void) { + if (!g_ui) return; + consoleExit(NULL); + g_ui = 0; +} + +static void ui_line(const char *msg) { + ui_begin(); + printf("%s\n", msg); + consoleUpdate(NULL); +} + +static void ui_blank(void) { + if (!g_ui) return; + consoleClear(); + consoleUpdate(NULL); +} +#else +static void ui_begin(void) {} +static void ui_end(void) {} +static void ui_line(const char *msg) { fprintf(stderr, "%s\n", msg); } +static void ui_blank(void) {} +#endif + +/* Returns 1 = update, 0 = skip. Only called when UI is already needed. */ +static int wait_confirm_or_skip(void) { +#if defined(__SWITCH__) + PadState pad; + padInitializeDefault(&pad); + ui_line(""); + ui_line(" A — Update"); + ui_line(" B — Play without updating"); + while (appletMainLoop()) { + padUpdate(&pad); + u64 k = padGetButtonsDown(&pad); + if (k & HidNpadButton_A) return 1; + if (k & HidNpadButton_B) return 0; + consoleUpdate(NULL); + } + return 0; +#else + return 0; +#endif +} + +static int run_update_flow(const char *install_dir) { + char installed[64] = "0.0.0"; + (void)ota_fs_read_installed_version(install_dir, installed, sizeof(installed)); + + char *json = NULL; + size_t json_len = 0; + char err[256]; + err[0] = '\0'; + + if (ota_net_download_buffer(OTA_RELEASES_API, CHECK_TIMEOUT_MS, &json, &json_len, err, + sizeof(err)) != 0) { + free(json); + return 0; /* offline / timeout — play installed, no UI */ + } + + ota_release_t rel; + if (!ota_parse_release(json, &rel)) { + free(json); + return 0; + } + free(json); + + ota_decision_t dec; + ota_decide_update(installed, &rel, &dec); + if (strcmp(dec.status, "uptodate") == 0 || strcmp(dec.status, "error") == 0) { + return 0; + } + + /* Update available — only now show UI */ + { + char msg[160]; + ui_blank(); + ui_line(""); + ui_line(" gen1recomp"); + ui_line(""); + snprintf(msg, sizeof(msg), " Update available: %s → %s", installed, dec.version); + ui_line(msg); + } + + if (!wait_confirm_or_skip()) { + ui_end(); + return 0; + } + + char updates_dir[192]; + char zip_path[256]; + char sums_path[256]; + snprintf(updates_dir, sizeof(updates_dir), "%s/updates", install_dir); + snprintf(zip_path, sizeof(zip_path), "%s/updates/%s", install_dir, dec.asset_name); + snprintf(sums_path, sizeof(sums_path), "%s/updates/sha256sums.txt", install_dir); + +#if defined(__SWITCH__) + mkdir(updates_dir, 0755); +#endif + + ui_blank(); + ui_line(""); + ui_line(" Downloading…"); + if (ota_net_download_file(dec.download_url, zip_path, 180000L, err, sizeof(err)) != 0) { + ui_line(""); + ui_line(" Download failed."); + ui_line(" Playing the installed version."); +#if defined(__SWITCH__) + { + PadState pad; + padInitializeDefault(&pad); + ui_line(""); + ui_line(" Press B to continue"); + while (appletMainLoop()) { + padUpdate(&pad); + if (padGetButtonsDown(&pad) & HidNpadButton_B) break; + consoleUpdate(NULL); + } + } +#endif + ui_end(); + return 0; + } + + char sums_url[512]; + snprintf(sums_url, sizeof(sums_url), + "https://github.com/bryanthaboi/gen1recomp/releases/download/%s/sha256sums.txt", + rel.tag); + if (ota_net_download_file(sums_url, sums_path, CHECK_TIMEOUT_MS, err, sizeof(err)) != 0) { + ui_line(""); + ui_line(" Could not verify the update."); + ui_line(" Playing the installed version."); + remove(zip_path); + ui_end(); +#if defined(__SWITCH__) + svcSleepThread(1200000000ULL); +#endif + return 0; + } + + FILE *sf = fopen(sums_path, "rb"); + if (!sf) { + remove(zip_path); + ui_end(); + return 0; + } + fseek(sf, 0, SEEK_END); + long slen = ftell(sf); + fseek(sf, 0, SEEK_SET); + char *sums = (char *)malloc((size_t)slen + 1); + if (!sums) { + fclose(sf); + ui_end(); + return 0; + } + fread(sums, 1, (size_t)slen, sf); + sums[slen] = '\0'; + fclose(sf); + + char hex[96]; + if (ota_fs_sha256_file(zip_path, hex, sizeof(hex)) != 0) { + free(sums); + remove(zip_path); + ui_end(); + return 0; + } + ota_verify_t ver; + ota_verify_sha256(dec.asset_name, hex, sums, &ver); + free(sums); + if (!ver.ok) { + ui_line(""); + ui_line(" Update file failed checks."); + ui_line(" Playing the installed version."); + remove(zip_path); + ui_end(); +#if defined(__SWITCH__) + svcSleepThread(1200000000ULL); +#endif + return 0; + } + + char extracted[256]; + char extracted_launcher[256]; + snprintf(extracted, sizeof(extracted), "%s/updates/gen1recomp-game.nro.verified", install_dir); + snprintf(extracted_launcher, sizeof(extracted_launcher), + "%s/updates/gen1recomp.nro.verified", install_dir); + +#if defined(__SWITCH__) + ui_line(""); + ui_line(" Installing…"); + /* Prefer path inside SD zip; fall back to bare name. */ + if (ota_unzip_extract_file(zip_path, GAME_MEMBER_IN_ZIP, extracted, err, sizeof(err)) != 0) { + if (ota_unzip_extract_file(zip_path, OTA_GAME_NRO_NAME, extracted, err, sizeof(err)) != 0) { + ui_line(""); + ui_line(" Install failed."); + ui_line(" Playing the installed version."); + remove(zip_path); + ui_end(); + svcSleepThread(1200000000ULL); + return 0; + } + } + + if (ota_fs_atomic_replace_game(install_dir, extracted, err, sizeof(err)) != 0) { + ui_line(""); + ui_line(" Install failed."); + ui_line(" Playing the installed version."); + remove(extracted); + remove(zip_path); + ui_end(); + svcSleepThread(1200000000ULL); + return 0; + } + remove(extracted); + + /* Also replace launcher so hbmenu/Sphaira see the matching NACP version. + * Best-effort: game update already succeeded if this fails. */ + if (ota_unzip_extract_file(zip_path, LAUNCHER_MEMBER_IN_ZIP, extracted_launcher, err, + sizeof(err)) == 0 || + ota_unzip_extract_file(zip_path, OTA_LAUNCHER_NRO_NAME, extracted_launcher, err, + sizeof(err)) == 0) { + if (ota_fs_atomic_replace_nro(install_dir, OTA_LAUNCHER_NRO_NAME, extracted_launcher, err, + sizeof(err)) == 0) { + remove(extracted_launcher); + } else { + remove(extracted_launcher); + } + } + + char vpath[192]; + snprintf(vpath, sizeof(vpath), "%s/version.txt", install_dir); + FILE *vf = fopen(vpath, "wb"); + if (vf) { + fprintf(vf, "%s\n", dec.version); + fclose(vf); + } +#else + (void)extracted; + (void)extracted_launcher; +#endif + remove(zip_path); + ui_end(); + return 0; +} + +int main(int argc, char **argv) { + (void)argc; + (void)argv; + +#if defined(__SWITCH__) + socketInitializeDefault(); + padConfigureInput(1, HidNpadStyleSet_NpadStandard); +#endif + + const char *install = SD_INSTALL_DIR; + run_update_flow(install); + + char game[192]; + snprintf(game, sizeof(game), "%s/%s", install, OTA_GAME_NRO_NAME); + char err[128]; + err[0] = '\0'; + if (ota_fs_handoff_to_game(game, err, sizeof(err)) != 0) { + ui_line(""); + ui_line(" gen1recomp"); + ui_line(""); + ui_line(" Game files are missing."); + ui_line(" Copy the Switch zip onto your microSD,"); + ui_line(" then open gen1recomp again."); +#if defined(__SWITCH__) + ui_line(""); + ui_line(" Press + to exit"); + PadState pad; + padInitializeDefault(&pad); + while (appletMainLoop()) { + padUpdate(&pad); + if (padGetButtonsDown(&pad) & HidNpadButton_Plus) break; + consoleUpdate(NULL); + } +#endif + ui_end(); + } + +#if defined(__SWITCH__) + socketExit(); +#endif + return 0; +} diff --git a/native/switch-ota-launcher/src/ota_fs.c b/native/switch-ota-launcher/src/ota_fs.c new file mode 100644 index 00000000..f2d04bc9 --- /dev/null +++ b/native/switch-ota-launcher/src/ota_fs.c @@ -0,0 +1,136 @@ +#include "ota_fs.h" + +#include +#include +#include + +#if defined(__SWITCH__) +#include +#include +#include +#else +#include +#endif + +int ota_fs_read_installed_version(const char *install_dir, char *out, size_t out_len) { + if (!out || out_len == 0) return -1; + out[0] = '\0'; + char path[256]; + snprintf(path, sizeof(path), "%s/version.txt", install_dir ? install_dir : OTA_INSTALL_DIR); + FILE *fp = fopen(path, "rb"); + if (!fp) return -1; + if (!fgets(out, (int)out_len, fp)) { + fclose(fp); + return -1; + } + fclose(fp); + /* trim */ + size_t n = strlen(out); + while (n > 0 && (out[n - 1] == '\n' || out[n - 1] == '\r' || out[n - 1] == ' ')) { + out[--n] = '\0'; + } + return n > 0 ? 0 : -1; +} + +int ota_fs_sha256_file(const char *path, char *out_hex, size_t out_len) { + if (!path || !out_hex || out_len < 65) return -1; + out_hex[0] = '\0'; + FILE *fp = fopen(path, "rb"); + if (!fp) return -1; + +#if defined(__SWITCH__) + mbedtls_sha256_context ctx; + mbedtls_sha256_init(&ctx); + mbedtls_sha256_starts(&ctx, 0); + unsigned char buf[8192]; + size_t n; + while ((n = fread(buf, 1, sizeof(buf), fp)) > 0) { + mbedtls_sha256_update(&ctx, buf, n); + } + fclose(fp); + unsigned char digest[32]; + mbedtls_sha256_finish(&ctx, digest); + mbedtls_sha256_free(&ctx); + for (int i = 0; i < 32; i++) snprintf(out_hex + i * 2, out_len - (size_t)(i * 2), "%02x", digest[i]); + return 0; +#else + /* Host: shell out to shasum/sha256sum for the host test path if needed. + * Protocol host tests do not call this; return not-implemented. */ + fclose(fp); + (void)out_len; + return -1; +#endif +} + +static int copy_file(const char *from, const char *to) { + FILE *in = fopen(from, "rb"); + if (!in) return -1; + FILE *out = fopen(to, "wb"); + if (!out) { + fclose(in); + return -1; + } + char buf[8192]; + size_t n; + while ((n = fread(buf, 1, sizeof(buf), in)) > 0) { + if (fwrite(buf, 1, n, out) != n) { + fclose(in); + fclose(out); + return -1; + } + } + fclose(in); + fclose(out); + return 0; +} + +int ota_fs_atomic_replace_game(const char *install_dir, const char *verified_game_nro, + char *err, size_t err_len) { + return ota_fs_atomic_replace_nro(install_dir, OTA_GAME_NRO_NAME, verified_game_nro, err, + err_len); +} + +int ota_fs_atomic_replace_nro(const char *install_dir, const char *nro_name, + const char *verified_nro, char *err, size_t err_len) { + if (!nro_name || !*nro_name || !verified_nro || !*verified_nro) { + if (err && err_len) snprintf(err, err_len, "missing nro paths"); + return -1; + } + char dest[240]; + char part[256]; + snprintf(dest, sizeof(dest), "%s/%s", install_dir ? install_dir : OTA_INSTALL_DIR, nro_name); + snprintf(part, sizeof(part), "%s.part", dest); + if (copy_file(verified_nro, part) != 0) { + if (err && err_len) snprintf(err, err_len, "copy to .part failed (%s)", nro_name); + return -1; + } +#ifdef _WIN32 + remove(dest); +#endif + if (rename(part, dest) != 0) { + if (err && err_len) snprintf(err, err_len, "rename .part -> %s failed", nro_name); + remove(part); + return -1; + } + return 0; +} + +int ota_fs_handoff_to_game(const char *game_nro_path, char *err, size_t err_len) { + if (!game_nro_path || !*game_nro_path) { + if (err && err_len) snprintf(err, err_len, "missing game path"); + return -1; + } +#if defined(__SWITCH__) + /* argv for next load: empty args string is fine */ + Result rc = envSetNextLoad(game_nro_path, game_nro_path); + if (R_FAILED(rc)) { + if (err && err_len) snprintf(err, err_len, "envSetNextLoad failed: 0x%x", rc); + return -1; + } + return 0; +#else + if (err && err_len) + snprintf(err, err_len, "handoff stub (host): would envSetNextLoad %s", game_nro_path); + return 0; /* host stub succeeds for flow tests */ +#endif +} diff --git a/native/switch-ota-launcher/src/ota_net.c b/native/switch-ota-launcher/src/ota_net.c new file mode 100644 index 00000000..1e0979e6 --- /dev/null +++ b/native/switch-ota-launcher/src/ota_net.c @@ -0,0 +1,119 @@ +#include "ota_net.h" + +#include +#include +#include + +#if defined(__SWITCH__) +#include +#include +#endif + +#if defined(__SWITCH__) +struct mem_buf { + char *data; + size_t len; +}; + +static size_t write_mem(char *ptr, size_t size, size_t nmemb, void *userdata) { + struct mem_buf *m = (struct mem_buf *)userdata; + size_t n = size * nmemb; + char *p = (char *)realloc(m->data, m->len + n + 1); + if (!p) return 0; + m->data = p; + memcpy(m->data + m->len, ptr, n); + m->len += n; + m->data[m->len] = '\0'; + return n; +} + +static size_t write_file(char *ptr, size_t size, size_t nmemb, void *userdata) { + return fwrite(ptr, size, nmemb, (FILE *)userdata); +} +#endif + +int ota_net_download_buffer(const char *url, long timeout_ms, char **out, size_t *out_len, + char *err, size_t err_len) { + if (out) *out = NULL; + if (out_len) *out_len = 0; + if (!url || !out) { + if (err && err_len) snprintf(err, err_len, "bad args"); + return -1; + } +#if defined(__SWITCH__) + CURL *curl = curl_easy_init(); + if (!curl) { + if (err && err_len) snprintf(err, err_len, "curl_easy_init failed"); + return -1; + } + struct mem_buf mem = {0}; + curl_easy_setopt(curl, CURLOPT_URL, url); + curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L); + curl_easy_setopt(curl, CURLOPT_USERAGENT, "gen1recomp-switch-ota"); + curl_easy_setopt(curl, CURLOPT_TIMEOUT_MS, timeout_ms); + curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT_MS, timeout_ms); + curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_mem); + curl_easy_setopt(curl, CURLOPT_WRITEDATA, &mem); + /* Atmosphere / homebrew CA store is limited; match common homebrew practice. */ + curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L); + curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L); + CURLcode rc = curl_easy_perform(curl); + curl_easy_cleanup(curl); + if (rc != CURLE_OK) { + free(mem.data); + if (err && err_len) snprintf(err, err_len, "%s", curl_easy_strerror(rc)); + return -1; + } + *out = mem.data; + if (out_len) *out_len = mem.len; + return 0; +#else + (void)timeout_ms; + if (err && err_len) + snprintf(err, err_len, "ota_net_download_buffer only available on __SWITCH__"); + return -1; +#endif +} + +int ota_net_download_file(const char *url, const char *path, long timeout_ms, char *err, + size_t err_len) { + if (!url || !path) { + if (err && err_len) snprintf(err, err_len, "bad args"); + return -1; + } +#if defined(__SWITCH__) + FILE *fp = fopen(path, "wb"); + if (!fp) { + if (err && err_len) snprintf(err, err_len, "fopen failed: %s", path); + return -1; + } + CURL *curl = curl_easy_init(); + if (!curl) { + fclose(fp); + if (err && err_len) snprintf(err, err_len, "curl_easy_init failed"); + return -1; + } + curl_easy_setopt(curl, CURLOPT_URL, url); + curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L); + curl_easy_setopt(curl, CURLOPT_USERAGENT, "gen1recomp-switch-ota"); + curl_easy_setopt(curl, CURLOPT_TIMEOUT_MS, timeout_ms); + curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT_MS, timeout_ms); + curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_file); + curl_easy_setopt(curl, CURLOPT_WRITEDATA, fp); + curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L); + curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L); + CURLcode rc = curl_easy_perform(curl); + curl_easy_cleanup(curl); + fclose(fp); + if (rc != CURLE_OK) { + if (err && err_len) snprintf(err, err_len, "%s", curl_easy_strerror(rc)); + return -1; + } + return 0; +#else + (void)timeout_ms; + if (err && err_len) + snprintf(err, err_len, "ota_net_download_file only available on __SWITCH__"); + return -1; +#endif +} diff --git a/native/switch-ota-launcher/src/ota_protocol.c b/native/switch-ota-launcher/src/ota_protocol.c new file mode 100644 index 00000000..4e943ec8 --- /dev/null +++ b/native/switch-ota-launcher/src/ota_protocol.c @@ -0,0 +1,292 @@ +#include "ota_protocol.h" + +#include +#include +#include +#include + +typedef struct { + int major; + int minor; + int patch; + int ok; +} semver_t; + +static void set_reason(char *buf, size_t n, const char *r) { + if (!buf || n == 0) return; + snprintf(buf, n, "%s", r ? r : ""); +} + +static int parse_semver(const char *s, semver_t *out) { + memset(out, 0, sizeof(*out)); + if (!s || !*s) return 0; + if (s[0] == 'v' || s[0] == 'V') s++; + int maj = 0, min = 0, pat = 0; + char trail = 0; + if (sscanf(s, "%d.%d.%d%c", &maj, &min, &pat, &trail) != 3) return 0; + if (maj < 0 || min < 0 || pat < 0) return 0; + out->major = maj; + out->minor = min; + out->patch = pat; + out->ok = 1; + return 1; +} + +int ota_compare_semver(const char *a, const char *b) { + semver_t pa, pb; + int oa = parse_semver(a, &pa); + int ob = parse_semver(b, &pb); + if (!oa && !ob) return 0; + if (!oa) return -1; + if (!ob) return 1; + if (pa.major != pb.major) return pa.major < pb.major ? -1 : 1; + if (pa.minor != pb.minor) return pa.minor < pb.minor ? -1 : 1; + if (pa.patch != pb.patch) return pa.patch < pb.patch ? -1 : 1; + return 0; +} + +int ota_is_ota_asset_name(const char *name) { + int maj = 0, min = 0, pat = 0; + if (!name) return 0; + /* Unified SD/OTA asset: gen1recomp-X.Y.Z-switch.zip */ + size_t len = strlen(name); + const char *suffix = "-switch.zip"; + size_t slen = strlen(suffix); + if (len <= slen) return 0; + if (strcmp(name + len - slen, suffix) != 0) return 0; + if (strncmp(name, "gen1recomp-", 11) != 0) return 0; + if (sscanf(name + 11, "%d.%d.%d", &maj, &min, &pat) != 3) return 0; + char rebuilt[128]; + snprintf(rebuilt, sizeof(rebuilt), "gen1recomp-%d.%d.%d-switch.zip", maj, min, pat); + return strcmp(name, rebuilt) == 0; +} + +int ota_version_from_ota_asset(const char *name, char *out, size_t out_len) { + int maj = 0, min = 0, pat = 0; + if (!out || out_len == 0) return 0; + out[0] = '\0'; + if (!ota_is_ota_asset_name(name)) return 0; + if (sscanf(name + 11, "%d.%d.%d", &maj, &min, &pat) != 3) return 0; + snprintf(out, out_len, "%d.%d.%d", maj, min, pat); + return 1; +} + +static const char *find_json_string(const char *json, const char *key, char *out, size_t out_len) { + char pattern[128]; + snprintf(pattern, sizeof(pattern), "\"%s\"", key); + const char *p = strstr(json, pattern); + if (!p) return NULL; + p = strchr(p + strlen(pattern), ':'); + if (!p) return NULL; + p++; + while (*p && isspace((unsigned char)*p)) p++; + if (*p != '"') return NULL; + p++; + size_t i = 0; + while (*p && *p != '"' && i + 1 < out_len) { + if (*p == '\\' && p[1]) { + p++; + out[i++] = *p++; + continue; + } + out[i++] = *p++; + } + out[i] = '\0'; + return out; +} + +int ota_parse_release(const char *json_text, ota_release_t *out) { + memset(out, 0, sizeof(*out)); + if (!json_text || !*json_text) { + set_reason(out->reason, sizeof(out->reason), "empty_json"); + return 0; + } + if (!find_json_string(json_text, "tag_name", out->tag, sizeof(out->tag))) { + set_reason(out->reason, sizeof(out->reason), "missing_tag"); + return 0; + } + semver_t sv; + if (!parse_semver(out->tag, &sv)) { + set_reason(out->reason, sizeof(out->reason), "bad_tag"); + return 0; + } + snprintf(out->version, sizeof(out->version), "%d.%d.%d", sv.major, sv.minor, sv.patch); + + /* Scan for OTA asset name then its browser_download_url in the same object-ish window. */ + const char *cursor = json_text; + while ((cursor = strstr(cursor, "\"name\"")) != NULL) { + char name[128]; + if (!find_json_string(cursor, "name", name, sizeof(name))) { + cursor += 6; + continue; + } + if (ota_is_ota_asset_name(name)) { + snprintf(out->asset_name, sizeof(out->asset_name), "%s", name); + /* Prefer URL after this name key within a limited window. */ + const char *window_end = cursor + 800; + if (window_end > json_text + strlen(json_text)) window_end = json_text + strlen(json_text); + char url[512]; + const char *u = NULL; + const char *scan = cursor; + while (scan < window_end && (scan = strstr(scan, "\"browser_download_url\"")) != NULL && + scan < window_end) { + if (find_json_string(scan, "browser_download_url", url, sizeof(url))) { + u = url; + break; + } + scan += 21; + } + if (!u || !*u) { + set_reason(out->reason, sizeof(out->reason), "missing_download_url"); + return 0; + } + snprintf(out->download_url, sizeof(out->download_url), "%s", u); + out->ok = 1; + return 1; + } + cursor += 6; + } + set_reason(out->reason, sizeof(out->reason), "missing_ota_asset"); + return 0; +} + +void ota_decide_update(const char *installed_version, const ota_release_t *release, + ota_decision_t *out) { + memset(out, 0, sizeof(*out)); + semver_t inst; + if (!parse_semver(installed_version, &inst)) { + snprintf(out->status, sizeof(out->status), "error"); + set_reason(out->reason, sizeof(out->reason), "bad_installed_version"); + return; + } + if (!release || !release->ok) { + snprintf(out->status, sizeof(out->status), "error"); + set_reason(out->reason, sizeof(out->reason), "bad_release"); + return; + } + if (ota_compare_semver(release->version, installed_version) <= 0) { + snprintf(out->status, sizeof(out->status), "uptodate"); + snprintf(out->version, sizeof(out->version), "%s", installed_version); + return; + } + snprintf(out->status, sizeof(out->status), "available"); + snprintf(out->version, sizeof(out->version), "%s", release->version); + snprintf(out->asset_name, sizeof(out->asset_name), "%s", release->asset_name); + snprintf(out->download_url, sizeof(out->download_url), "%s", release->download_url); +} + +int ota_lookup_sum(const char *sums_text, const char *asset_name, char *out_hex, size_t out_len) { + if (out_hex && out_len) out_hex[0] = '\0'; + if (!sums_text || !asset_name || !out_hex || out_len < 65) return 0; + const char *p = sums_text; + while (*p) { + char hex[96]; + char name[256]; + int n = 0; + if (sscanf(p, "%95s %255s%n", hex, name, &n) >= 2 && n > 0) { + const char *nm = name; + if (nm[0] == '*') nm++; + if (strncmp(nm, "./", 2) == 0) nm += 2; + if (strcmp(nm, asset_name) == 0) { + /* normalize hex to lowercase */ + size_t i; + for (i = 0; hex[i] && i + 1 < out_len; i++) + out_hex[i] = (char)tolower((unsigned char)hex[i]); + out_hex[i] = '\0'; + return 1; + } + p += n; + while (*p && *p != '\n') p++; + if (*p == '\n') p++; + continue; + } + while (*p && *p != '\n') p++; + if (*p == '\n') p++; + } + return 0; +} + +void ota_verify_sha256(const char *asset_name, const char *actual_hex, const char *sums_text, + ota_verify_t *out) { + memset(out, 0, sizeof(*out)); + if (!asset_name || !*asset_name) { + set_reason(out->reason, sizeof(out->reason), "bad_asset_name"); + return; + } + if (!sums_text) { + set_reason(out->reason, sizeof(out->reason), "missing_sums"); + return; + } + char expected[96]; + if (!ota_lookup_sum(sums_text, asset_name, expected, sizeof(expected))) { + set_reason(out->reason, sizeof(out->reason), "sum_not_found"); + return; + } + if (!actual_hex || !*actual_hex) { + set_reason(out->reason, sizeof(out->reason), "missing_actual_hash"); + return; + } + char actual[96]; + size_t i; + for (i = 0; actual_hex[i] && i + 1 < sizeof(actual); i++) + actual[i] = (char)tolower((unsigned char)actual_hex[i]); + actual[i] = '\0'; + if (strcmp(actual, expected) != 0) { + set_reason(out->reason, sizeof(out->reason), "hash_mismatch"); + return; + } + out->ok = 1; +} + +void ota_plan_atomic_apply(const char *install_dir, const char *verified_temp, + ota_apply_plan_t *out) { + memset(out, 0, sizeof(*out)); + if (!install_dir || !*install_dir) install_dir = OTA_INSTALL_DIR; + if (!verified_temp) verified_temp = ""; + snprintf(out->game_nro, sizeof(out->game_nro), "%s/%s", install_dir, OTA_GAME_NRO_NAME); + snprintf(out->part_path, sizeof(out->part_path), "%s.part", out->game_nro); + snprintf(out->launcher_nro, sizeof(out->launcher_nro), "%s/%s", install_dir, + OTA_LAUNCHER_NRO_NAME); + snprintf(out->launcher_part, sizeof(out->launcher_part), "%s.part", out->launcher_nro); + snprintf(out->next_load, sizeof(out->next_load), "%s", out->game_nro); + /* verified_temp is the game NRO; launcher replace uses a sibling verified path */ + snprintf(out->steps[0], sizeof(out->steps[0]), "copy_to_part:%s->%s", verified_temp, + out->part_path); + snprintf(out->steps[1], sizeof(out->steps[1]), "rename:%s->%s", out->part_path, out->game_nro); + snprintf(out->steps[2], sizeof(out->steps[2]), "copy_to_part:launcher->%s", out->launcher_part); + snprintf(out->steps[3], sizeof(out->steps[3]), "rename:%s->%s", out->launcher_part, + out->launcher_nro); + snprintf(out->steps[4], sizeof(out->steps[4]), "env_set_next_load:%s", out->game_nro); + snprintf(out->preserve, sizeof(out->preserve), "%s/%s", install_dir, OTA_SAVE_DIR_NAME); + snprintf(out->forbidden_delete, sizeof(out->forbidden_delete), "delete:%s/%s", install_dir, + OTA_SAVE_DIR_NAME); + snprintf(out->forbidden_direct, sizeof(out->forbidden_direct), "write_direct:%s", out->game_nro); +} + +void ota_offline_policy(double elapsed_sec, const ota_offline_events_t *events, ota_offline_t *out) { + memset(out, 0, sizeof(*out)); + ota_offline_events_t ev = {0, -1, 0}; + if (events) ev = *events; + if (ev.user_skip) { + snprintf(out->action, sizeof(out->action), "play_installed"); + set_reason(out->reason, sizeof(out->reason), "user_skip"); + snprintf(out->message, sizeof(out->message), "update skipped"); + return; + } + if (ev.api_error || ev.network_ok == 0) { + snprintf(out->action, sizeof(out->action), "play_installed"); + set_reason(out->reason, sizeof(out->reason), "offline_or_error"); + snprintf(out->message, sizeof(out->message), + "offline or update check failed — play installed version"); + return; + } + if (elapsed_sec >= (double)OTA_CHECK_TIMEOUT_SEC) { + snprintf(out->action, sizeof(out->action), "play_installed"); + set_reason(out->reason, sizeof(out->reason), "timeout"); + snprintf(out->message, sizeof(out->message), "update check timed out after %ds", + OTA_CHECK_TIMEOUT_SEC); + return; + } + snprintf(out->action, sizeof(out->action), "keep_checking"); + set_reason(out->reason, sizeof(out->reason), "in_flight"); +} diff --git a/native/switch-ota-launcher/src/ota_unzip.c b/native/switch-ota-launcher/src/ota_unzip.c new file mode 100644 index 00000000..72c72425 --- /dev/null +++ b/native/switch-ota-launcher/src/ota_unzip.c @@ -0,0 +1,89 @@ +#include "ota_unzip.h" + +#include +#include + +#if defined(__SWITCH__) +#include +#include +#endif + +#if defined(__SWITCH__) +static int extract_member(ZZIP_DIR *dir, const char *member, const char *dest_path, char *err, + size_t err_len) { + ZZIP_FILE *zf = zzip_file_open(dir, member, O_RDONLY); + if (!zf) return 1; /* not found / cannot open */ + + FILE *out = fopen(dest_path, "wb"); + if (!out) { + zzip_file_close(zf); + if (err && err_len) snprintf(err, err_len, "fopen dest failed: %s", dest_path); + return -1; + } + + char buf[8192]; + zzip_ssize_t n; + while ((n = zzip_file_read(zf, buf, sizeof(buf))) > 0) { + if ((zzip_ssize_t)fwrite(buf, 1, (size_t)n, out) != n) { + fclose(out); + zzip_file_close(zf); + if (err && err_len) snprintf(err, err_len, "fwrite failed"); + return -1; + } + } + fclose(out); + zzip_file_close(zf); + if (n < 0) { + if (err && err_len) snprintf(err, err_len, "zzip_file_read failed"); + return -1; + } + return 0; +} +#endif + +int ota_unzip_extract_file(const char *zip_path, const char *member_name, const char *dest_path, + char *err, size_t err_len) { + if (!zip_path || !member_name || !dest_path) { + if (err && err_len) snprintf(err, err_len, "bad args"); + return -1; + } +#if defined(__SWITCH__) + zzip_error_t zerr = ZZIP_NO_ERROR; + ZZIP_DIR *dir = zzip_dir_open(zip_path, &zerr); + if (!dir) { + if (err && err_len) snprintf(err, err_len, "zzip_dir_open failed (%d): %s", (int)zerr, zip_path); + return -1; + } + + char alt1[192]; + char alt2[192]; + snprintf(alt1, sizeof(alt1), "switch/gen1recomp/%s", member_name); + snprintf(alt2, sizeof(alt2), "./%s", member_name); + + const char *candidates[] = {member_name, alt1, alt2, NULL}; + int rc = -1; + if (err && err_len) err[0] = '\0'; + for (int i = 0; candidates[i]; i++) { + int t = extract_member(dir, candidates[i], dest_path, err, err_len); + if (t == 0) { + rc = 0; + break; + } + if (t < 0) { + rc = -1; + break; + } + } + if (rc != 0 && err && err_len && !err[0]) { + snprintf(err, err_len, "member not found in zip: %s", member_name); + } + zzip_dir_close(dir); + return rc; +#else + (void)zip_path; + (void)member_name; + (void)dest_path; + if (err && err_len) snprintf(err, err_len, "ota_unzip only available on __SWITCH__"); + return -1; +#endif +} diff --git a/scripts/build_switch.sh b/scripts/build_switch.sh index 9bb2544f..8fbc86b6 100755 --- a/scripts/build_switch.sh +++ b/scripts/build_switch.sh @@ -5,8 +5,10 @@ # scripts/build_switch.sh --fetch # scripts/build_switch.sh --loose [path/to/game.love] # scripts/build_switch.sh --fused [--version X.Y.Z] +# scripts/build_switch.sh --ota [--version X.Y.Z] # scripts/build_switch.sh --fetch --loose # scripts/build_switch.sh --fetch --fused [--version X.Y.Z] +# scripts/build_switch.sh --fetch --ota [--version X.Y.Z] # # Modes: # --fetch Download pinned love.nro + love.elf into @@ -27,11 +29,17 @@ # Requires the pin (run --fetch or combine). GitHub Releases # publish the zip only; the versioned .nro stays local / PR CI. # -# Combinable: --fetch alone, or --fetch with --loose / --fused. -# XOR: --loose and --fused cannot be used together. +# --ota Like --fused, plus native OTA launcher NRO and dual-NRO SD zip +# (gen1recomp.nro launcher + gen1recomp-game.nro). The same +# gen1recomp--switch.zip is the OTA download asset. Needs +# DEVKITPRO switch-curl/mbedtls/zlib/zziplib — see +# scripts/switch/install_devkitpro_deps.sh. +# +# Combinable: --fetch alone, or --fetch with --loose / --fused / --ota. +# XOR: --loose, --fused, and --ota cannot be combined with each other. # # Non-goals (never done by this script): -# MTP push, ROM install, dkp-pacman auto-install. +# MTP push, ROM install, dkp-pacman auto-install (use install_devkitpro_deps.sh). set -euo pipefail @@ -41,6 +49,7 @@ DIST="$ROOT/dist/switch" LOOSE=0 FUSED=0 FETCH=0 +OTA=0 GAME_LOVE="" VERSION="$(git -C "$ROOT" rev-parse --short HEAD 2>/dev/null || echo dev)" @@ -49,13 +58,14 @@ say() { printf '\033[1;32m==>\033[0m %s\n' "$*" >&2; } fail() { printf '\033[1;31merror:\033[0m %s\n' "$*" >&2; exit 1; } usage() { - sed -n '2,34p' "$0" | sed 's/^# \{0,1\}//' + sed -n '2,40p' "$0" | sed 's/^# \{0,1\}//' } while [ $# -gt 0 ]; do case "$1" in --loose) LOOSE=1; shift ;; --fused) FUSED=1; shift ;; + --ota) OTA=1; shift ;; --fetch) FETCH=1; shift ;; --version) VERSION="$2"; shift 2 ;; -h|--help) @@ -73,12 +83,13 @@ while [ $# -gt 0 ]; do esac done -if [ "$LOOSE" -eq 1 ] && [ "$FUSED" -eq 1 ]; then - fail "choose one of --loose or --fused (XOR)" +MODE_COUNT=$((LOOSE + FUSED + OTA)) +if [ "$MODE_COUNT" -gt 1 ]; then + fail "choose one of --loose, --fused, or --ota (XOR)" fi -if [ "$FETCH" -eq 0 ] && [ "$LOOSE" -eq 0 ] && [ "$FUSED" -eq 0 ]; then - fail "specify --fetch, --loose, and/or --fused (see --help)" +if [ "$FETCH" -eq 0 ] && [ "$LOOSE" -eq 0 ] && [ "$FUSED" -eq 0 ] && [ "$OTA" -eq 0 ]; then + fail "specify --fetch, --loose, --fused, and/or --ota (see --help)" fi if [ "$FETCH" -eq 1 ]; then @@ -128,12 +139,23 @@ if [ "$LOOSE" -eq 1 ]; then exec "$ROOT/scripts/switch/assemble_loose.sh" "$GAME_LOVE" fi -if [ "$FUSED" -eq 1 ]; then +if [ "$FUSED" -eq 1 ] || [ "$OTA" -eq 1 ]; then GAME_LOVE="$(pack_game_love)" OUT_NRO="$DIST/gen1recomp-${VERSION}-switch.nro" OUT_ZIP="$DIST/gen1recomp-${VERSION}-switch.zip" "$ROOT/scripts/switch/build_fused.sh" "$GAME_LOVE" "$VERSION" "$OUT_NRO" - "$ROOT/scripts/switch/pack_sd_zip.sh" "$OUT_NRO" "$VERSION" "$OUT_ZIP" + + if [ "$OTA" -eq 1 ]; then + LAUNCHER_NRO="$DIST/gen1recomp-${VERSION}-launcher.nro" + say "building native OTA launcher" + "$ROOT/scripts/switch/build_ota_launcher.sh" "$LAUNCHER_NRO" "$VERSION" + say "packing dual-NRO SD zip (also the OTA download asset)" + "$ROOT/scripts/switch/pack_sd_zip.sh" "$OUT_NRO" "$VERSION" "$OUT_ZIP" "$LAUNCHER_NRO" + cp "$OUT_NRO" "$DIST/gen1recomp-${VERSION}-game.nro" + else + "$ROOT/scripts/switch/pack_sd_zip.sh" "$OUT_NRO" "$VERSION" "$OUT_ZIP" + fi + cp "$WORK/build-info.json" "$DIST/gen1recomp-${VERSION}-build-info.json" say "done. See $DIST/" exit 0 @@ -145,4 +167,4 @@ if [ "$FETCH" -eq 1 ]; then exit 0 fi -fail "specify --fetch, --loose, and/or --fused (see --help)" +fail "specify --fetch, --loose, --fused, and/or --ota (see --help)" diff --git a/scripts/switch/build_ota_launcher.sh b/scripts/switch/build_ota_launcher.sh new file mode 100755 index 00000000..c1ce80dd --- /dev/null +++ b/scripts/switch/build_ota_launcher.sh @@ -0,0 +1,74 @@ +#!/usr/bin/env bash +# Build the native Switch OTA launcher NRO (DEVKITPRO or Docker). +# +# Usage: scripts/switch/build_ota_launcher.sh [OUT_NRO] [VERSION] +# +# Default OUT_NRO: dist/switch/gen1recomp-launcher.nro +# VERSION (optional X.Y.Z) is written into the NACP so hbmenu shows the +# same release as the fused game; defaults to 0.0.0 when omitted. +# Host-only protocol check: always runs `make host-test` first. + +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" +# shellcheck source=common.sh +. "$SCRIPT_DIR/common.sh" + +LAUNCHER_DIR="$ROOT/native/switch-ota-launcher" +OUT_NRO="${1:-$ROOT/dist/switch/gen1recomp-launcher.nro}" +APP_VERSION="${2:-${GEN1_LAUNCHER_VERSION:-0.0.0}}" +DKP_IMAGE_FILE="$ROOT/scripts/switch/dkp-docker.image" + +[ -d "$LAUNCHER_DIR" ] || fail "missing $LAUNCHER_DIR" +[ -f "$LAUNCHER_DIR/Makefile" ] || fail "missing Makefile" + +say "host-test ota_protocol (no DEVKITPRO required)" +make -C "$LAUNCHER_DIR" host-test + +mkdir -p "$(dirname "$OUT_NRO")" + +if [ -n "${DEVKITPRO:-}" ] && [ -f "$DEVKITPRO/libnx/switch_rules" ]; then + say "building launcher NRO with native DEVKITPRO (NACP $APP_VERSION)" + make -C "$LAUNCHER_DIR" clean || true + make -C "$LAUNCHER_DIR" all APP_VERSION="$APP_VERSION" + cp "$LAUNCHER_DIR/gen1recomp.nro" "$OUT_NRO" + say "wrote $OUT_NRO" + exit 0 +fi + +resolve_dkp_image() { + if [ -n "${GEN1_DKP_IMAGE:-}" ]; then + printf '%s' "$GEN1_DKP_IMAGE" + return 0 + fi + [ -f "$DKP_IMAGE_FILE" ] || fail "missing Docker image pin: $DKP_IMAGE_FILE" + local line + line="$(grep -v '^[[:space:]]*#' "$DKP_IMAGE_FILE" | grep -v '^[[:space:]]*$' | head -1 || true)" + [ -n "$line" ] || fail "empty Docker image pin: $DKP_IMAGE_FILE" + printf '%s' "$line" +} + +if command -v docker >/dev/null 2>&1; then + image="$(resolve_dkp_image)" + say "building launcher NRO via Docker ($image, NACP $APP_VERSION)" + docker run --rm \ + -v "$ROOT:/work" \ + -w /work/native/switch-ota-launcher \ + -e "APP_VERSION=$APP_VERSION" \ + "$image" \ + bash -lc 'pacman -Sy --noconfirm switch-curl switch-mbedtls switch-zlib switch-zziplib >/dev/null 2>&1 || true; make clean; make all APP_VERSION="$APP_VERSION"' + cp "$LAUNCHER_DIR/gen1recomp.nro" "$OUT_NRO" + say "wrote $OUT_NRO" + exit 0 +fi + +fail "$(cat < re-running with sudo…" + exec sudo -E bash "$0" "$@" +fi + +export DEVKITPRO="${DEVKITPRO:-/opt/devkitpro}" +export PATH="/usr/local/bin:$DEVKITPRO/pacman/bin:$DEVKITPRO/tools/bin:$PATH" + +if [ -f /etc/profile.d/devkit-env.sh ]; then + # shellcheck disable=SC1091 + . /etc/profile.d/devkit-env.sh +fi + +if ! command -v dkp-pacman >/dev/null 2>&1; then + echo "error: dkp-pacman not found. Install the pkg from:" >&2 + echo " https://github.com/devkitPro/pacman/releases/latest" >&2 + exit 1 +fi + +echo "==> DEVKITPRO=$DEVKITPRO" +# Named packages only (avoid interactive switch-dev group member prompt). +# ZIP reading uses switch-zziplib (dkp has no minizip port for Switch). +dkp-pacman -Sy --noconfirm --needed \ + switch-curl \ + switch-mbedtls \ + switch-zlib \ + switch-zziplib + +echo "==> installed packages:" +dkp-pacman -Q | grep -E 'switch-(curl|mbedtls|zlib|zziplib|tools)|libnx|devkitA64' || true + +# Ensure zsh/bash sessions see DEVKITPRO +MARKER="# gen1recomp-devkitpro" +for rc in /Users/*/.zshrc /Users/*/.bash_profile; do + [ -f "$rc" ] || continue + if ! grep -q "$MARKER" "$rc" 2>/dev/null; then + { + echo "" + echo "$MARKER" + echo "export DEVKITPRO=/opt/devkitpro" + echo 'export PATH="$DEVKITPRO/tools/bin:$DEVKITPRO/devkitA64/bin:$PATH"' + } >> "$rc" + echo "==> appended DEVKITPRO exports to $rc" + fi +done + +echo "==> done. Open a new shell, then:" +echo " export DEVKITPRO=/opt/devkitpro" +echo " scripts/switch/build_ota_launcher.sh" diff --git a/scripts/switch/ota_launcher.manifest b/scripts/switch/ota_launcher.manifest new file mode 100644 index 00000000..cf84a6d4 --- /dev/null +++ b/scripts/switch/ota_launcher.manifest @@ -0,0 +1,16 @@ +# Switch OTA launcher packaging manifest +# +# Release / SD tree MUST include the native OTA launcher NRO as the hbmenu +# entrypoint. The LÖVE fused game NRO is loaded via envSetNextLoad after the +# update check. Self-update of the launcher itself is out of scope for v1. +# +# OTA download uses the same SD zip as install (unified asset). +# +# Paths relative to microSD root: + +ENTRY_NRO=switch/gen1recomp/gen1recomp.nro +GAME_NRO=switch/gen1recomp/gen1recomp-game.nro +SAVE_DIR=switch/gen1recomp/pokemon-love2d +OTA_ASSET_GLOB=gen1recomp-*-switch.zip +REQUIRE_SHA256SUMS=1 +OTA_ENABLED=1 diff --git a/scripts/switch/pack_sd_zip.sh b/scripts/switch/pack_sd_zip.sh index 8f76cac0..6e7d7a7f 100755 --- a/scripts/switch/pack_sd_zip.sh +++ b/scripts/switch/pack_sd_zip.sh @@ -2,16 +2,18 @@ # Pack a Switch SD-ready zip: extract at microSD root (merge-safe update). # # Usage: -# scripts/switch/pack_sd_zip.sh NRO_PATH VERSION OUT_ZIP +# scripts/switch/pack_sd_zip.sh GAME_NRO VERSION OUT_ZIP [LAUNCHER_NRO] # # Layout inside the zip (SD root): -# switch/gen1recomp/gen1recomp.nro +# switch/gen1recomp/gen1recomp.nro (launcher if LAUNCHER_NRO set, else game) +# switch/gen1recomp/gen1recomp-game.nro (only when LAUNCHER_NRO set) +# switch/gen1recomp/version.txt # switch/gen1recomp/INSTALL.txt # switch/gen1recomp/pokemon-love2d/imports/.../README.txt # switch/gen1recomp/pokemon-love2d/exports/.../README.txt # # Does not ship ROMs, saves, or mods. Re-extracting merges over an existing -# install and only overwrites the NRO + these text placeholders — keep +# install and only overwrites the NRO(s) + these text placeholders — keep # pokemon-love2d/ to preserve progress. set -euo pipefail @@ -23,11 +25,15 @@ SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" NRO_PATH="${1:-}" VERSION="${2:-}" OUT_ZIP="${3:-}" +LAUNCHER_NRO="${4:-}" [ -n "$NRO_PATH" ] && [ -n "$VERSION" ] && [ -n "$OUT_ZIP" ] \ - || fail "usage: scripts/switch/pack_sd_zip.sh NRO_PATH VERSION OUT_ZIP" + || fail "usage: scripts/switch/pack_sd_zip.sh GAME_NRO VERSION OUT_ZIP [LAUNCHER_NRO]" -[ -f "$NRO_PATH" ] || fail "missing NRO at $NRO_PATH" +[ -f "$NRO_PATH" ] || fail "missing game NRO at $NRO_PATH" +if [ -n "$LAUNCHER_NRO" ]; then + [ -f "$LAUNCHER_NRO" ] || fail "missing launcher NRO at $LAUNCHER_NRO" +fi command -v zip >/dev/null 2>&1 || fail "need zip on PATH" @@ -45,7 +51,15 @@ trap cleanup EXIT APP_DIR="$STAGE/switch/gen1recomp" SAVE_ROOT="$APP_DIR/pokemon-love2d" mkdir -p "$APP_DIR" -cp "$NRO_PATH" "$APP_DIR/gen1recomp.nro" + +if [ -n "$LAUNCHER_NRO" ]; then + LAUNCHER_NRO="$(cd "$(dirname "$LAUNCHER_NRO")" && pwd)/$(basename "$LAUNCHER_NRO")" + cp "$LAUNCHER_NRO" "$APP_DIR/gen1recomp.nro" + cp "$NRO_PATH" "$APP_DIR/gen1recomp-game.nro" +else + cp "$NRO_PATH" "$APP_DIR/gen1recomp.nro" +fi +printf '%s\n' "$VERSION" > "$APP_DIR/version.txt" cat > "$APP_DIR/INSTALL.txt" </dev/null || unzip -l "$OUT_ZIP")" printf '%s\n' "$LISTING" | grep -q 'switch/gen1recomp/gen1recomp.nro' \ || fail "zip missing switch/gen1recomp/gen1recomp.nro" +printf '%s\n' "$LISTING" | grep -Fq 'switch/gen1recomp/version.txt' \ + || fail "zip missing switch/gen1recomp/version.txt" +if [ -n "$LAUNCHER_NRO" ]; then + printf '%s\n' "$LISTING" | grep -Fq 'switch/gen1recomp/gen1recomp-game.nro' \ + || fail "zip missing switch/gen1recomp/gen1recomp-game.nro (OTA dual-NRO layout)" +fi REQUIRED=( "switch/gen1recomp/INSTALL.txt" + "switch/gen1recomp/version.txt" "switch/gen1recomp/pokemon-love2d/imports/README.txt" "switch/gen1recomp/pokemon-love2d/imports/mods/README.txt" "switch/gen1recomp/pokemon-love2d/imports/saves/red/README.txt" diff --git a/scripts/switch/selftest_build_switch.sh b/scripts/switch/selftest_build_switch.sh index 7377c5d9..b7eb9109 100755 --- a/scripts/switch/selftest_build_switch.sh +++ b/scripts/switch/selftest_build_switch.sh @@ -51,16 +51,17 @@ MISSING="" printf '%s' "$HELP_LC" | grep -q 'fetch' || MISSING="${MISSING} fetch" printf '%s' "$HELP_LC" | grep -q 'loose' || MISSING="${MISSING} loose" printf '%s' "$HELP_LC" | grep -q 'fused' || MISSING="${MISSING} fused" +printf '%s' "$HELP_LC" | grep -q 'ota' || MISSING="${MISSING} ota" printf '%s' "$HELP_LC" | grep -Eq 'auto-download|downloads' || MISSING="${MISSING} auto-download" printf '%s' "$HELP_LC" | grep -Eq 'non-goal|does not|never' || MISSING="${MISSING} non-goals" if [ -z "$MISSING" ]; then - ok "build_switch.sh --help mentions fetch, loose, fused (+ auto-download/non-goals)" + ok "build_switch.sh --help mentions fetch, loose, fused, ota (+ auto-download/non-goals)" else bad "build_switch.sh --help missing:$MISSING" fi # --------------------------------------------------------------------------- -# 3. XOR --loose --fused exits non-zero +# 3. XOR --loose --fused / --ota exits non-zero # --------------------------------------------------------------------------- XOR_RC=0 "$ROOT/scripts/build_switch.sh" --loose --fused >/dev/null 2>&1 || XOR_RC=$? @@ -69,6 +70,13 @@ if [ "$XOR_RC" -ne 0 ]; then else bad "build_switch.sh --loose --fused should exit non-zero" fi +XOR_OTA_RC=0 +"$ROOT/scripts/build_switch.sh" --fused --ota >/dev/null 2>&1 || XOR_OTA_RC=$? +if [ "$XOR_OTA_RC" -ne 0 ]; then + ok "build_switch.sh --fused --ota exits non-zero ($XOR_OTA_RC)" +else + bad "build_switch.sh --fused --ota should exit non-zero" +fi # --------------------------------------------------------------------------- # 4. assemble_loose without pin → stderr contains --fetch @@ -228,6 +236,7 @@ ZIP_LIST="$(unzip -Z1 "$FAKE_ZIP" 2>/dev/null || unzip -l "$FAKE_ZIP")" PACK_MISSING="" for rel in \ "switch/gen1recomp/gen1recomp.nro" \ + "switch/gen1recomp/version.txt" \ "switch/gen1recomp/INSTALL.txt" \ "switch/gen1recomp/pokemon-love2d/imports/README.txt" \ "switch/gen1recomp/pokemon-love2d/imports/mods/README.txt" \ @@ -311,6 +320,88 @@ else bad "pack_sd_zip.sh merge update lost user data or failed to replace NRO" fi +# --------------------------------------------------------------------------- +# 7. Dual-NRO OTA layout (launcher + game) when 4th arg set +# --------------------------------------------------------------------------- +FAKE_LAUNCHER="$STAGING/fake-launcher.nro" +FAKE_GAME="$STAGING/fake-game.nro" +printf 'fake-launcher\n' > "$FAKE_LAUNCHER" +printf 'fake-game\n' > "$FAKE_GAME" +OTA_ZIP="$STAGING/gen1recomp-0.0.2-ota-layout-switch.zip" +OTA_RC=0 +"$ROOT/scripts/switch/pack_sd_zip.sh" "$FAKE_GAME" "0.0.2" "$OTA_ZIP" "$FAKE_LAUNCHER" \ + >"$STAGING/ota-pack.out" 2>"$STAGING/ota-pack.err" || OTA_RC=$? +OTA_LIST="$(unzip -Z1 "$OTA_ZIP" 2>/dev/null || true)" +if [ "$OTA_RC" -eq 0 ] \ + && printf '%s\n' "$OTA_LIST" | grep -Fq 'switch/gen1recomp/gen1recomp.nro' \ + && printf '%s\n' "$OTA_LIST" | grep -Fq 'switch/gen1recomp/gen1recomp-game.nro' \ + && printf '%s\n' "$OTA_LIST" | grep -Fq 'switch/gen1recomp/version.txt' +then + EXTRACT_OTA="$STAGING/extract-ota" + rm -rf "$EXTRACT_OTA" + mkdir -p "$EXTRACT_OTA" + unzip -q "$OTA_ZIP" -d "$EXTRACT_OTA" + DUAL_OK=1 + cmp -s "$FAKE_LAUNCHER" "$EXTRACT_OTA/switch/gen1recomp/gen1recomp.nro" || DUAL_OK=0 + cmp -s "$FAKE_GAME" "$EXTRACT_OTA/switch/gen1recomp/gen1recomp-game.nro" || DUAL_OK=0 + [ "$(cat "$EXTRACT_OTA/switch/gen1recomp/version.txt")" = "0.0.2" ] || DUAL_OK=0 + if [ "$DUAL_OK" -eq 1 ]; then + ok "pack_sd_zip.sh dual-NRO OTA layout (launcher + game + version.txt)" + else + bad "pack_sd_zip.sh dual-NRO bytes/version mismatch" + fi +else + bad "pack_sd_zip.sh dual-NRO layout failed (rc=$OTA_RC err=$(cat "$STAGING/ota-pack.err"))" +fi + +MANIFEST="$ROOT/scripts/switch/ota_launcher.manifest" +if [ -f "$MANIFEST" ] && grep -q '^OTA_ENABLED=1$' "$MANIFEST" \ + && grep -q 'ENTRY_NRO=switch/gen1recomp/gen1recomp.nro' "$MANIFEST" \ + && grep -q 'GAME_NRO=switch/gen1recomp/gen1recomp-game.nro' "$MANIFEST" +then + ok "ota_launcher.manifest requires dual-NRO when OTA_ENABLED=1" +else + bad "ota_launcher.manifest missing OTA dual-NRO requirements" +fi + +if [ -f "$ROOT/scripts/switch/build_ota_launcher.sh" ] \ + && [ -f "$ROOT/native/switch-ota-launcher/Makefile" ] +then + ok "native OTA launcher sources + build_ota_launcher.sh present" +else + bad "missing native OTA launcher tree or build script" +fi + +# --------------------------------------------------------------------------- +# 8. Unified OTA asset = dual-NRO SD zip (no separate OTA-only archive) +# --------------------------------------------------------------------------- +LEGACY_OTA_PACKER="$ROOT/scripts/switch/pack_ota_zip.sh" +if [ ! -f "$LEGACY_OTA_PACKER" ] \ + && ! grep -Eq 'pack_ota_zip\.sh|switch-ota\.zip' "$ROOT/scripts/build_switch.sh" \ + && grep -q 'OTA_ASSET_GLOB=gen1recomp-\*-switch.zip' "$MANIFEST" +then + ok "unified OTA download is the same SD zip (legacy OTA-only packer gone)" +else + bad "legacy separate OTA-only packer / asset still present" +fi + +if grep -q 'Quiet by default\|stays quiet\|Quiet' "$ROOT/native/switch-ota-launcher/src/main.c" \ + && grep -q 'ui_begin' "$ROOT/native/switch-ota-launcher/src/main.c" +then + ok "launcher UI is quiet by default (console only when needed)" +else + bad "launcher missing quiet-by-default UI gate" +fi + +if [ -f "$ROOT/native/switch-ota-launcher/src/ota_unzip.c" ] \ + && grep -q 'zzip/zzip.h' "$ROOT/native/switch-ota-launcher/src/ota_unzip.c" \ + && grep -q 'ota_unzip_extract_file' "$ROOT/native/switch-ota-launcher/src/main.c" +then + ok "launcher wires zziplib ota_unzip_extract_file" +else + bad "launcher missing zziplib unzip wiring" +fi + # --------------------------------------------------------------------------- # Summary # --------------------------------------------------------------------------- diff --git a/src/update/SwitchOta.lua b/src/update/SwitchOta.lua new file mode 100644 index 00000000..ba87dd35 --- /dev/null +++ b/src/update/SwitchOta.lua @@ -0,0 +1,186 @@ +-- Switch OTA protocol contract (host-testable, no love.*). +-- The native DEVKITPRO launcher (libnx + switch-curl) must implement the +-- same decisions. LÖVE on NX never runs this path — Platform.networkValidated +-- stays false and src/update/Check.lua remains gated off on NX. +-- +-- Asset: gen1recomp--switch.zip (same SD zip used for install). + +local SwitchOta = {} + +SwitchOta.RELEASES_API = + "https://api.github.com/repos/bryanthaboi/gen1recomp/releases/latest" +SwitchOta.OTA_ASSET_PATTERN = "^gen1recomp%-(%d+%.%d+%.%d+)%-switch%.zip$" +SwitchOta.CHECK_TIMEOUT_SEC = 6 +SwitchOta.GAME_NRO_NAME = "gen1recomp-game.nro" +SwitchOta.LAUNCHER_NRO_NAME = "gen1recomp.nro" +SwitchOta.SAVE_DIR_NAME = "pokemon-love2d" +SwitchOta.INSTALL_DIR = "switch/gen1recomp" + +local function parseSemver(s) + if type(s) ~= "string" then return nil end + local body = s:match("^v?(.+)$") + if not body then return nil end + local maj, min, pat = body:match("^(%d+)%.(%d+)%.(%d+)$") + if not maj then return nil end + return { major = tonumber(maj), minor = tonumber(min), patch = tonumber(pat) } +end + +function SwitchOta.compareSemver(a, b) + local pa, pb = parseSemver(a), parseSemver(b) + if not pa and not pb then return 0 end + if not pa then return -1 end + if not pb then return 1 end + for _, field in ipairs({ "major", "minor", "patch" }) do + if pa[field] < pb[field] then return -1 end + if pa[field] > pb[field] then return 1 end + end + return 0 +end + +function SwitchOta.isOtaAssetName(name) + if type(name) ~= "string" then return false end + return name:match(SwitchOta.OTA_ASSET_PATTERN) ~= nil +end + +function SwitchOta.versionFromOtaAsset(name) + if type(name) ~= "string" then return nil end + return name:match(SwitchOta.OTA_ASSET_PATTERN) +end + +-- Parse GitHub releases/latest JSON (minimal: tag_name + assets[].name/browser_download_url). +-- Returns { tag, version, assetName, downloadUrl } or nil + reason. +function SwitchOta.parseRelease(jsonText) + if type(jsonText) ~= "string" or jsonText == "" then + return nil, "empty_json" + end + local tag = jsonText:match('"tag_name"%s*:%s*"(.-)"') + if not tag then return nil, "missing_tag" end + local version = tag:match("^v?(%d+%.%d+%.%d+)$") + if not version then return nil, "bad_tag" end + + local assetName, downloadUrl + for block in jsonText:gmatch("%b{}") do + local name = block:match('"name"%s*:%s*"(.-)"') + if name and SwitchOta.isOtaAssetName(name) then + assetName = name + downloadUrl = block:match('"browser_download_url"%s*:%s*"(.-)"') + break + end + end + if not assetName then return nil, "missing_ota_asset" end + if not downloadUrl or downloadUrl == "" then return nil, "missing_download_url" end + + return { + tag = tag, + version = version, + assetName = assetName, + downloadUrl = downloadUrl, + } +end + +-- Decide check outcome given installed version and parsed release. +-- Returns status: uptodate | available | error +function SwitchOta.decideUpdate(installedVersion, release) + if type(installedVersion) ~= "string" or not parseSemver(installedVersion) then + return { status = "error", reason = "bad_installed_version" } + end + if type(release) ~= "table" or not release.version then + return { status = "error", reason = "bad_release" } + end + local cmp = SwitchOta.compareSemver(release.version, installedVersion) + if cmp <= 0 then + return { status = "uptodate", version = installedVersion } + end + return { + status = "available", + version = release.version, + assetName = release.assetName, + downloadUrl = release.downloadUrl, + } +end + +-- Parse sha256sums.txt lines: " " or " *" +function SwitchOta.parseSums(text) + local sums = {} + if type(text) ~= "string" then return sums end + for line in (text .. "\n"):gmatch("(.-)\n") do + local hex, name = line:match("^(%x+)%s+%*?%./?(.-)%s*$") + if hex and name and name ~= "" then + sums[name] = hex:lower() + end + end + return sums +end + +-- Require a matching sha256. Missing sum is ALWAYS reject (no silent accept). +function SwitchOta.verifySha256(assetName, actualHex, sums) + if type(assetName) ~= "string" or assetName == "" then + return false, "bad_asset_name" + end + if type(sums) ~= "table" then + return false, "missing_sums" + end + local expected = sums[assetName] + if type(expected) ~= "string" or expected == "" then + return false, "sum_not_found" + end + if type(actualHex) ~= "string" or actualHex == "" then + return false, "missing_actual_hash" + end + if actualHex:lower() ~= expected:lower() then + return false, "hash_mismatch" + end + return true, nil +end + +-- Atomic apply plan: never writes live NROs directly; never touches saves. +-- Replaces game + launcher so NACP versions stay in sync (hbmenu / Sphaira). +function SwitchOta.planAtomicApply(installDir, verifiedTempPath) + installDir = installDir or SwitchOta.INSTALL_DIR + local gameNro = installDir .. "/" .. SwitchOta.GAME_NRO_NAME + local launcherNro = installDir .. "/" .. SwitchOta.LAUNCHER_NRO_NAME + local partPath = gameNro .. ".part" + local launcherPart = launcherNro .. ".part" + return { + steps = { + { op = "copy_to_part", from = verifiedTempPath, to = partPath }, + { op = "rename", from = partPath, to = gameNro }, + { op = "copy_to_part", from = "launcher", to = launcherPart }, + { op = "rename", from = launcherPart, to = launcherNro }, + { op = "env_set_next_load", target = gameNro }, + }, + preserve = { installDir .. "/" .. SwitchOta.SAVE_DIR_NAME }, + forbidden = { + "delete:" .. installDir .. "/" .. SwitchOta.SAVE_DIR_NAME, + "write_direct:" .. gameNro, + }, + } +end + +-- Offline / skip / timeout policy. Never blocks forever. +-- elapsedSec: time spent on the network check so far +-- events: { networkOk=bool, userSkip=bool, apiError=bool } +function SwitchOta.offlinePolicy(elapsedSec, events) + events = events or {} + if events.userSkip then + return { action = "play_installed", reason = "user_skip", message = "update skipped" } + end + if events.apiError or events.networkOk == false then + return { + action = "play_installed", + reason = "offline_or_error", + message = "offline or update check failed — play installed version", + } + end + local timeout = SwitchOta.CHECK_TIMEOUT_SEC + if type(elapsedSec) == "number" and elapsedSec >= timeout then + return { + action = "play_installed", + reason = "timeout", + message = "update check timed out after " .. tostring(timeout) .. "s", + } + end + return { action = "keep_checking", reason = "in_flight" } +end + +return SwitchOta diff --git a/test/switch-nro-ota.spec.test.js b/test/switch-nro-ota.spec.test.js new file mode 100644 index 00000000..087433b0 --- /dev/null +++ b/test/switch-nro-ota.spec.test.js @@ -0,0 +1,467 @@ +import { test } from 'node:test'; +import assert from 'node:assert/strict'; +import fs from 'node:fs'; +import path from 'node:path'; +import { createHash } from 'node:crypto'; +import { fileURLToPath } from 'node:url'; +import { spawnSync } from 'node:child_process'; + +const __dirname = path.dirname(fileURLToPath(import.meta.url)); +const root = path.resolve(__dirname, '..'); + +function read(rel) { + return fs.readFileSync(path.join(root, rel), 'utf8'); +} + +function sha256Hex(buf) { + return createHash('sha256').update(buf).digest('hex'); +} + +/** JS mirror of src/update/SwitchOta.lua — contract under test. */ +function createSwitchOta() { + const OTA_RE = /^gen1recomp-(\d+\.\d+\.\d+)-switch\.zip$/; + const CHECK_TIMEOUT_SEC = 6; + const GAME_NRO_NAME = 'gen1recomp-game.nro'; + const LAUNCHER_NRO_NAME = 'gen1recomp.nro'; + const SAVE_DIR_NAME = 'pokemon-love2d'; + const INSTALL_DIR = 'switch/gen1recomp'; + + function parseSemver(s) { + if (typeof s !== 'string') return null; + const m = s.match(/^v?(\d+)\.(\d+)\.(\d+)$/); + if (!m) return null; + return { major: +m[1], minor: +m[2], patch: +m[3] }; + } + + function compareSemver(a, b) { + const pa = parseSemver(a); + const pb = parseSemver(b); + if (!pa && !pb) return 0; + if (!pa) return -1; + if (!pb) return 1; + for (const f of ['major', 'minor', 'patch']) { + if (pa[f] < pb[f]) return -1; + if (pa[f] > pb[f]) return 1; + } + return 0; + } + + function isOtaAssetName(name) { + return typeof name === 'string' && OTA_RE.test(name); + } + + function parseRelease(jsonText) { + if (!jsonText) return { ok: false, reason: 'empty_json' }; + let obj; + try { + obj = JSON.parse(jsonText); + } catch { + return { ok: false, reason: 'bad_json' }; + } + const tag = obj.tag_name; + if (!tag) return { ok: false, reason: 'missing_tag' }; + const version = String(tag).match(/^v?(\d+\.\d+\.\d+)$/)?.[1]; + if (!version) return { ok: false, reason: 'bad_tag' }; + const asset = (obj.assets || []).find((a) => isOtaAssetName(a.name)); + if (!asset) return { ok: false, reason: 'missing_ota_asset' }; + if (!asset.browser_download_url) return { ok: false, reason: 'missing_download_url' }; + return { + ok: true, + tag, + version, + assetName: asset.name, + downloadUrl: asset.browser_download_url, + }; + } + + function decideUpdate(installed, release) { + if (!parseSemver(installed)) return { status: 'error', reason: 'bad_installed_version' }; + if (!release?.ok || !release.version) return { status: 'error', reason: 'bad_release' }; + if (compareSemver(release.version, installed) <= 0) { + return { status: 'uptodate', version: installed }; + } + return { + status: 'available', + version: release.version, + assetName: release.assetName, + downloadUrl: release.downloadUrl, + }; + } + + function parseSums(text) { + const sums = {}; + if (typeof text !== 'string') return sums; + for (const line of text.split(/\r?\n/)) { + const m = line.match(/^([0-9a-fA-F]+)\s+\*?\.?\/?(.*?)\s*$/); + if (m) sums[m[2]] = m[1].toLowerCase(); + } + return sums; + } + + function verifySha256(assetName, actualHex, sums) { + if (!assetName) return { ok: false, reason: 'bad_asset_name' }; + if (!sums || typeof sums !== 'object') return { ok: false, reason: 'missing_sums' }; + const expected = sums[assetName]; + if (!expected) return { ok: false, reason: 'sum_not_found' }; + if (!actualHex) return { ok: false, reason: 'missing_actual_hash' }; + if (actualHex.toLowerCase() !== expected.toLowerCase()) { + return { ok: false, reason: 'hash_mismatch' }; + } + return { ok: true }; + } + + function planAtomicApply(installDir, verifiedTempPath) { + installDir = installDir || INSTALL_DIR; + const gameNro = `${installDir}/${GAME_NRO_NAME}`; + const launcherNro = `${installDir}/${LAUNCHER_NRO_NAME}`; + const partPath = `${gameNro}.part`; + const launcherPart = `${launcherNro}.part`; + return { + steps: [ + { op: 'copy_to_part', from: verifiedTempPath, to: partPath }, + { op: 'rename', from: partPath, to: gameNro }, + { op: 'copy_to_part', from: 'launcher', to: launcherPart }, + { op: 'rename', from: launcherPart, to: launcherNro }, + { op: 'env_set_next_load', target: gameNro }, + ], + preserve: [`${installDir}/${SAVE_DIR_NAME}`], + forbidden: [`delete:${installDir}/${SAVE_DIR_NAME}`, `write_direct:${gameNro}`], + }; + } + + function offlinePolicy(elapsedSec, events = {}) { + if (events.userSkip) { + return { action: 'play_installed', reason: 'user_skip', message: 'update skipped' }; + } + if (events.apiError || events.networkOk === false) { + return { + action: 'play_installed', + reason: 'offline_or_error', + message: 'offline or update check failed — play installed version', + }; + } + if (typeof elapsedSec === 'number' && elapsedSec >= CHECK_TIMEOUT_SEC) { + return { + action: 'play_installed', + reason: 'timeout', + message: `update check timed out after ${CHECK_TIMEOUT_SEC}s`, + }; + } + return { action: 'keep_checking', reason: 'in_flight' }; + } + + return { + CHECK_TIMEOUT_SEC, + GAME_NRO_NAME, + LAUNCHER_NRO_NAME, + SAVE_DIR_NAME, + compareSemver, + isOtaAssetName, + parseRelease, + decideUpdate, + parseSums, + verifySha256, + planAtomicApply, + offlinePolicy, + }; +} + +const M = createSwitchOta(); + +const sampleRelease = M.parseRelease( + JSON.stringify({ + tag_name: 'v1.5.0', + assets: [ + { + name: 'gen1recomp-1.5.0-switch.zip', + browser_download_url: 'https://example/switch.zip', + }, + { name: 'sha256sums.txt', browser_download_url: 'https://example/sums' }, + ], + }) +); + +test('AC-001: Launcher nativo verifica release no GitHub @spec:AC-001', () => { + assert.equal(M.compareSemver('1.2.0', '1.1.0'), 1); + assert.equal(M.compareSemver('1.1.0', '1.1.0'), 0); + assert.equal(M.compareSemver('1.0.0', '1.1.0'), -1); + + assert.equal(sampleRelease.ok, true); + assert.equal(sampleRelease.version, '1.5.0'); + assert.equal(sampleRelease.assetName, 'gen1recomp-1.5.0-switch.zip'); + + assert.equal(M.decideUpdate('1.4.0', sampleRelease).status, 'available'); + assert.equal(M.decideUpdate('1.5.0', sampleRelease).status, 'uptodate'); + assert.equal(M.decideUpdate('1.6.0', sampleRelease).status, 'uptodate'); + + const missing = M.parseRelease(JSON.stringify({ tag_name: 'v1.5.0', assets: [] })); + assert.equal(missing.ok, false); + assert.equal(missing.reason, 'missing_ota_asset'); +}); + +test('AC-002: Download com verificação SHA-256 @spec:AC-002', () => { + const name = 'gen1recomp-1.5.0-switch.zip'; + const payload = Buffer.from('switch-sd-payload'); + const hex = sha256Hex(payload); + const sums = M.parseSums(`${hex} ${name}\n`); + + assert.equal(M.verifySha256(name, hex, sums).ok, true); + assert.equal(M.verifySha256(name, 'deadbeef', sums).reason, 'hash_mismatch'); + // Invisible-error guard: download without a sum MUST NOT verify. + assert.equal(M.verifySha256(name, hex, {}).ok, false); + assert.equal(M.verifySha256(name, hex, {}).reason, 'sum_not_found'); + assert.equal(M.verifySha256(name, '', sums).reason, 'missing_actual_hash'); +}); + +test('AC-003: Aplicação atômica e handoff para o jogo @spec:AC-003', () => { + const plan = M.planAtomicApply('switch/gen1recomp', '/tmp/verified.zip'); + assert.ok(plan.steps.some((s) => s.op === 'copy_to_part')); + assert.ok(plan.steps.some((s) => s.op === 'rename')); + assert.ok(plan.steps.some((s) => s.op === 'env_set_next_load')); + assert.ok(plan.steps.filter((s) => s.op === 'rename').length >= 2, 'renames game + launcher'); + assert.ok(plan.preserve.some((p) => p.endsWith('pokemon-love2d'))); + assert.ok(plan.forbidden.some((f) => f.startsWith('delete:') && f.includes('pokemon-love2d'))); + assert.ok(plan.forbidden.some((f) => f.startsWith('write_direct:'))); + const renameGame = plan.steps.find((s) => s.op === 'rename' && s.to.endsWith('gen1recomp-game.nro')); + assert.ok(renameGame); + assert.ok(renameGame.from.endsWith('.part')); + const renameLauncher = plan.steps.find((s) => s.op === 'rename' && s.to.endsWith('gen1recomp.nro')); + assert.ok(renameLauncher, 'launcher NRO replaced so NACP version stays in sync'); +}); + +test('AC-004: Offline ou falha de rede não trava o jogo @spec:AC-004', () => { + assert.equal(M.CHECK_TIMEOUT_SEC, 6); + assert.equal(M.offlinePolicy(1, { userSkip: true }).action, 'play_installed'); + assert.equal(M.offlinePolicy(1, { networkOk: false }).action, 'play_installed'); + assert.equal(M.offlinePolicy(6, { networkOk: true }).action, 'play_installed'); + assert.equal(M.offlinePolicy(6, { networkOk: true }).reason, 'timeout'); + assert.equal(M.offlinePolicy(2, { networkOk: true }).action, 'keep_checking'); +}); + +test('AC-005: Documentação Switch descreve o launcher OTA @spec:AC-005', () => { + const install = read('docs/switch-install.md'); + const development = read('docs/switch-development.md'); + const updater = read('docs/updater.md'); + + for (const [name, text] of [ + ['switch-install', install], + ['switch-development', development], + ['updater', updater], + ]) { + assert.match(text, /native OTA launcher|launcher nativo/i, `${name} mentions native OTA launcher`); + } + + assert.match(install, /manual|zip|microSD/i, 'manual zip fallback still documented'); + assert.match(install, /gen1recomp-\*-switch\.zip|switch\.zip/i, 'unified Switch zip documented'); + assert.doesNotMatch(install, /switch-ota\.zip/, 'legacy separate OTA zip must not be documented'); + assert.match(install, /Sphaira|forwarder/i, 'Sphaira shortcut version note documented'); + assert.doesNotMatch( + install, + /Switch OTA uses `src\/update\/Check\.lua`/i, + 'must not claim Switch OTA uses LÖVE Check.lua' + ); + assert.match(updater, /Nintendo Switch/i); + assert.match(updater, /networkValidated|disabled|desligado|off/i); +}); + +test('AC-006: LOVE no NX continua sem rede de updater @spec:AC-006', () => { + const platform = read('src/core/Platform.lua'); + assert.match( + platform, + /networkValidated\s*=\s*not nx/, + 'Platform.networkValidated must stay false on NX' + ); + assert.doesNotMatch(platform, /networkValidated\s*=\s*true/); + + const boot = read('src/update/Boot.lua'); + assert.match(boot, /networkValidated/, 'Boot still gates on networkValidated'); + + assert.ok(read('src/update/Check.lua').length > 0); + assert.ok(read('src/update/check_worker.lua').length > 0); + assert.ok(read('src/core/HostShell.lua').length > 0); + assert.match(read('src/import/RomImporter.lua'), /updaterAllowed|networkValidated|Check/); + assert.ok(read('src/import/LauncherView.lua').length > 0); + + const switchOta = read('src/update/SwitchOta.lua'); + assert.doesNotMatch(switchOta, /networkValidated\s*=\s*true/); + assert.match(switchOta, /never runs this path|remains gated off on NX/i); +}); + +test('AC-007: Funções puras do protocolo OTA têm testes host-side @spec:AC-007', () => { + assert.ok(M.isOtaAssetName('gen1recomp-1.2.3-switch.zip')); + assert.equal(M.isOtaAssetName('gen1recomp-1.2.3-switch-ota.zip'), false); + assert.equal(M.isOtaAssetName('gen1recomp-1.2.3.love'), false); + assert.equal(M.compareSemver('2.0.0', '1.9.9'), 1); + assert.equal(M.compareSemver('1.0.0', '1.0.0'), 0); + assert.equal(M.compareSemver('0.9.0', '1.0.0'), -1); + + const rel = M.parseRelease( + JSON.stringify({ + tag_name: 'v9.9.9', + assets: [ + { + name: 'gen1recomp-9.9.9-switch.zip', + browser_download_url: 'https://example/x', + }, + ], + }) + ); + assert.equal(rel.version, '9.9.9'); + + const sums = M.parseSums('deadbeef unexpected-name.zip\n'); + assert.equal( + M.verifySha256('gen1recomp-9.9.9-switch.zip', 'deadbeef', sums).ok, + false, + 'unexpected filename in sums must not verify OTA asset' + ); + assert.equal(M.verifySha256('gen1recomp-9.9.9-switch.zip', 'anything', {}).ok, false); + + const lua = read('src/update/SwitchOta.lua'); + assert.ok(fs.existsSync(path.join(root, 'src/update/SwitchOta.lua'))); + for (const fn of [ + 'compareSemver', + 'parseRelease', + 'decideUpdate', + 'parseSums', + 'verifySha256', + 'planAtomicApply', + 'offlinePolicy', + ]) { + assert.match(lua, new RegExp(`function SwitchOta\\.${fn}`), `Lua exports ${fn}`); + } + assert.match(lua, /CHECK_TIMEOUT_SEC\s*=\s*6/); + assert.match(lua, /switch%.zip|%-switch%.zip/); + assert.doesNotMatch(lua, /switch%-ota%.zip|switch-ota\.zip/); +}); + +test('AC-008: Gates de regressão anti-“erro invisível” @spec:AC-008', () => { + const platform = read('src/core/Platform.lua'); + assert.match(platform, /networkValidated\s*=\s*not nx\s+and\s+not uwp/); + + for (const rel of ['docs/switch-install.md', 'docs/switch-development.md', 'docs/updater.md']) { + const text = read(rel); + assert.match(text, /native OTA launcher|launcher nativo/i, rel); + assert.match( + text, + /LÖVE self-updater|LOVE self-updater|self-updater LÖVE|updater LÖVE|Check\.lua/i, + `${rel} contrasts with LÖVE updater` + ); + } + + const manifest = read('scripts/switch/ota_launcher.manifest'); + assert.match(manifest, /^OTA_ENABLED=1$/m); + assert.match(manifest, /ENTRY_NRO=switch\/gen1recomp\/gen1recomp\.nro/); + assert.match(manifest, /GAME_NRO=switch\/gen1recomp\/gen1recomp-game\.nro/); + assert.match(manifest, /OTA_ASSET_GLOB=gen1recomp-\*-switch\.zip/); + assert.doesNotMatch(manifest, /switch-ota\.zip/); + assert.match(manifest, /REQUIRE_SHA256SUMS=1/); +}); + +test('AC-009: Protocolo C host-testável espelha SwitchOta.lua @spec:AC-009', () => { + const proto = read('native/switch-ota-launcher/src/ota_protocol.c'); + const header = read('native/switch-ota-launcher/include/ota_protocol.h'); + assert.match(header, /OTA_CHECK_TIMEOUT_SEC\s+6/); + assert.match(header, /ota_compare_semver/); + assert.match(header, /ota_parse_release/); + assert.match(header, /ota_verify_sha256/); + assert.match(header, /ota_plan_atomic_apply/); + assert.match(header, /ota_offline_policy/); + assert.match(proto, /sum_not_found/); + assert.match(proto, /env_set_next_load/); + assert.match(header, /pokemon-love2d/); + assert.match(proto, /OTA_SAVE_DIR_NAME/); + + const lua = read('src/update/SwitchOta.lua'); + assert.match(lua, /CHECK_TIMEOUT_SEC\s*=\s*6/); + + // Compile + run C host tests (gcc) + const r = spawnSync( + 'make', + ['-C', path.join(root, 'native/switch-ota-launcher'), 'host-test'], + { encoding: 'utf8' } + ); + assert.equal(r.status, 0, `host-test failed:\n${r.stdout}\n${r.stderr}`); + assert.match(r.stdout, /all ota_protocol host tests passed/); +}); + +test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () => { + for (const rel of [ + 'native/switch-ota-launcher/Makefile', + 'native/switch-ota-launcher/README.md', + 'native/switch-ota-launcher/src/main.c', + 'native/switch-ota-launcher/src/ota_net.c', + 'native/switch-ota-launcher/src/ota_fs.c', + 'scripts/switch/build_ota_launcher.sh', + 'docs/switch-build.md', + ]) { + assert.ok(fs.existsSync(path.join(root, rel)), `missing ${rel}`); + } + const main = read('native/switch-ota-launcher/src/main.c'); + assert.match(main, /envSetNextLoad|ota_fs_handoff_to_game/); + assert.match(main, /gen1recomp-game\.nro|OTA_GAME_NRO_NAME/); + assert.match(main, /Quiet by default|stays quiet|LÖVE self-updater stays off|self-updater stays off/i); + assert.match(main, /consoleInit/, 'UI uses console only when needed'); + assert.match(main, /ui_begin|g_ui/, 'UI is gated behind begin'); + + const mk = read('native/switch-ota-launcher/Makefile'); + assert.match(mk, /libnx\/switch_rules|DEVKITPRO/); + assert.match(mk, /-lcurl/); + assert.match(mk, /-lzzip/); + assert.match(mk, /assets\/switch\/icon\.jpg/, 'uses project Switch icon'); + + assert.ok(fs.existsSync(path.join(root, 'native/switch-ota-launcher/src/ota_unzip.c'))); + assert.match(read('native/switch-ota-launcher/src/ota_unzip.c'), /zzip\/zzip\.h/); + assert.match(read('native/switch-ota-launcher/src/main.c'), /ota_unzip_extract_file/); + assert.match(read('native/switch-ota-launcher/src/main.c'), /GAME_MEMBER_IN_ZIP|switch\/gen1recomp\//); + assert.match(read('native/switch-ota-launcher/src/main.c'), /LAUNCHER_MEMBER_IN_ZIP|ota_fs_atomic_replace_nro/); + assert.match(read('native/switch-ota-launcher/src/ota_fs.c'), /ota_fs_atomic_replace_nro/); + assert.doesNotMatch(read('scripts/switch/install_devkitpro_deps.sh'), /switch-minizip/); + assert.match(read('scripts/switch/install_devkitpro_deps.sh'), /switch-zziplib/); + + const buildDoc = read('docs/switch-build.md'); + assert.match(buildDoc, /native\/switch-ota-launcher|build_ota_launcher/); + assert.match(buildDoc, /switch-curl/); + assert.match(buildDoc, /--ota|install_devkitpro_deps/); + assert.doesNotMatch(buildDoc, /switch-ota\.zip/); + + const readme = read('native/switch-ota-launcher/README.md'); + assert.match(readme, /DEVKITPRO|devkitPro/i); + assert.match(readme, /Docker|devkita64/i); + assert.match(readme, /Quiet|quiet|silen/i); +}); + +test('AC-011: Empacotamento dual-NRO e selftest @spec:AC-011', () => { + const pack = read('scripts/switch/pack_sd_zip.sh'); + assert.match(pack, /LAUNCHER_NRO/); + assert.match(pack, /gen1recomp-game\.nro/); + assert.match(pack, /version\.txt/); + + assert.equal( + fs.existsSync(path.join(root, 'scripts/switch/pack_ota_zip.sh')), + false, + 'separate pack_ota_zip.sh removed — unified *-switch.zip' + ); + + const buildSwitch = read('scripts/build_switch.sh'); + assert.match(buildSwitch, /--ota/); + assert.doesNotMatch(buildSwitch, /pack_ota_zip\.sh/); + assert.match(buildSwitch, /build_ota_launcher\.sh/); + assert.match(buildSwitch, /dual-NRO SD zip|OTA download asset/i); + + const selftest = read('scripts/switch/selftest_build_switch.sh'); + assert.match(selftest, /dual-NRO|gen1recomp-game\.nro/); + assert.match(selftest, /ota_launcher\.manifest/); + assert.match(selftest, /unified OTA|same SD zip|legacy OTA-only/i); + assert.match(selftest, /Quiet by default|quiet by default|ui_begin/); + + const manifest = read('scripts/switch/ota_launcher.manifest'); + assert.match(manifest, /^OTA_ENABLED=1$/m); + assert.match(manifest, /OTA_ASSET_GLOB=gen1recomp-\*-switch\.zip/); + + // Run the dual-NRO portion via full offline selftest (includes legacy + OTA) + const r = spawnSync('bash', [path.join(root, 'scripts/switch/selftest_build_switch.sh')], { + encoding: 'utf8', + }); + assert.equal(r.status, 0, `selftest failed:\n${r.stdout}\n${r.stderr}`); + assert.match(r.stdout, /dual-NRO OTA layout/); +}); From 4dd4c5c4638d86151177af081615c30d762c3ad5 Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Wed, 5 Aug 2026 02:03:51 -0300 Subject: [PATCH 02/18] Add launcher-styled framebuffer UI for Switch OTA prompts. Replace the console flash with a quiet branded screen (RGB rail, logo, A/B buttons) that only appears when an update needs confirm. --- .gitignore | 1 + docs/switch-install.md | 4 +- native/switch-ota-launcher/Makefile | 17 +- native/switch-ota-launcher/README.md | 11 +- native/switch-ota-launcher/include/ota_ui.h | 33 + native/switch-ota-launcher/romfs/.gitkeep | 0 native/switch-ota-launcher/src/main.c | 182 +- native/switch-ota-launcher/src/ota_ui.c | 405 + .../third_party/font8x8_basic.h | 152 + .../third_party/stb_image.h | 7988 +++++++++++++++++ scripts/switch/selftest_build_switch.sh | 9 +- test/switch-nro-ota.spec.test.js | 10 +- 12 files changed, 8644 insertions(+), 168 deletions(-) create mode 100644 native/switch-ota-launcher/include/ota_ui.h create mode 100644 native/switch-ota-launcher/romfs/.gitkeep create mode 100644 native/switch-ota-launcher/src/ota_ui.c create mode 100644 native/switch-ota-launcher/third_party/font8x8_basic.h create mode 100644 native/switch-ota-launcher/third_party/stb_image.h diff --git a/.gitignore b/.gitignore index 9ec4ba6b..a79a8483 100644 --- a/.gitignore +++ b/.gitignore @@ -44,6 +44,7 @@ native/switch-ota-launcher/*.nro native/switch-ota-launcher/*.nacp native/switch-ota-launcher/*.elf native/switch-ota-launcher/*.map +native/switch-ota-launcher/romfs/logo.png # Legacy manual convenience-copy location (superseded by /dist/android/) mobile/dist/ diff --git a/docs/switch-install.md b/docs/switch-install.md index 788d7a08..48d4cea0 100644 --- a/docs/switch-install.md +++ b/docs/switch-install.md @@ -58,7 +58,9 @@ On Switch, over-the-air updates are handled by the **native OTA launcher** `gen1recomp.nro` (so the NACP version matches the release for hbmenu / Sphaira), then hand off via `envSetNextLoad`. When you are already up to date (or offline), the launcher stays quiet and opens the game with no -console flash. Saves under `pokemon-love2d/` are never touched. Protocol +UI. When an update is available it shows a short screen in the same visual +language as the in-game launcher (black field, RGB rail, logo, A/B buttons). +Saves under `pokemon-love2d/` are never touched. Protocol contract: `src/update/SwitchOta.lua`. The LÖVE self-updater stays **disabled** on NX (`networkValidated == false`). diff --git a/native/switch-ota-launcher/Makefile b/native/switch-ota-launcher/Makefile index 9509a180..45779960 100644 --- a/native/switch-ota-launcher/Makefile +++ b/native/switch-ota-launcher/Makefile @@ -37,6 +37,7 @@ BUILD := build SOURCES := src DATA := data INCLUDES := include +ROMFS := romfs APP_TITLE := gen1recomp APP_AUTHOR := bryanthaboi, port by andrewqsantos @@ -45,6 +46,7 @@ APP_VERSION ?= 0.0.0 # Prefer project Switch icon if present ICON := $(TOPDIR)/../../assets/switch/icon.jpg +LOGO_SRC := $(TOPDIR)/../../assets/logo/logo.png #--------------------------------------------------------------------------------- ARCH := -march=armv8-a+crc+crypto -mtune=cortex-a57 -mtp=soft -fPIE @@ -124,12 +126,20 @@ ifeq ($(strip $(NO_NACP)),) export NROFLAGS += --nacp=$(CURDIR)/$(TARGET).nacp endif -.PHONY: $(BUILD) clean all host-test +ifneq ($(ROMFS),) + export NROFLAGS += --romfsdir=$(CURDIR)/$(ROMFS) +endif + +.PHONY: $(BUILD) clean all host-test sync-romfs #--------------------------------------------------------------------------------- -all: $(BUILD) +all: sync-romfs $(BUILD) -$(BUILD): +sync-romfs: + @mkdir -p $(CURDIR)/$(ROMFS) + @cp -f $(LOGO_SRC) $(CURDIR)/$(ROMFS)/logo.png + +$(BUILD): sync-romfs @[ -d $@ ] || mkdir -p $@ @$(MAKE) --no-print-directory -C $(BUILD) -f $(CURDIR)/Makefile @@ -137,6 +147,7 @@ $(BUILD): clean: @echo clean ... @rm -fr $(BUILD) $(TARGET).nro $(TARGET).nacp $(TARGET).elf $(TARGET).lst build-host + @rm -f $(CURDIR)/$(ROMFS)/logo.png host-test: @mkdir -p build-host diff --git a/native/switch-ota-launcher/README.md b/native/switch-ota-launcher/README.md index a99db455..f664131f 100644 --- a/native/switch-ota-launcher/README.md +++ b/native/switch-ota-launcher/README.md @@ -1,11 +1,12 @@ # Native Switch OTA launcher In-console updates for Gen1Recomp on Nintendo Switch. This NRO is the **hbmenu -entry** (`gen1recomp.nro`). It checks GitHub Releases quietly (no console flash -when you are already up to date or offline). Only if a newer release exists -does it prompt to download the same `gen1recomp-*-switch.zip` used for install, -verify SHA-256 from `sha256sums.txt`, replace **both** `gen1recomp-game.nro` -and `gen1recomp.nro` (matching NACP version for hbmenu/Sphaira), then hand off +entry** (`gen1recomp.nro`). It checks GitHub Releases quietly (no UI when you +are already up to date or offline). Only if a newer release exists does it show +a **launcher-style screen** (black + RGB rail + project logo + flat A/B +buttons), download the same `gen1recomp-*-switch.zip` used for install, verify +SHA-256 from `sha256sums.txt`, replace **both** `gen1recomp-game.nro` and +`gen1recomp.nro` (matching NACP version for hbmenu/Sphaira), then hand off with `envSetNextLoad`. The LÖVE self-updater (`src/update/Check.lua`) stays **disabled** on NX. diff --git a/native/switch-ota-launcher/include/ota_ui.h b/native/switch-ota-launcher/include/ota_ui.h new file mode 100644 index 00000000..f46723c4 --- /dev/null +++ b/native/switch-ota-launcher/include/ota_ui.h @@ -0,0 +1,33 @@ +#ifndef GEN1_OTA_UI_H +#define GEN1_OTA_UI_H + +#ifdef __cplusplus +extern "C" { +#endif + +/* Framebuffer UI matching the in-game launcher look (black + RGB rail + + * flat semantic buttons). Silent by default — only call when user-facing. */ + +/* Returns 1 = update, 0 = skip / play installed. */ +int ota_ui_prompt_update(const char *installed, const char *latest); + +/* Status screen (download / install). Redraws each call. */ +void ota_ui_show_status(const char *title, const char *detail); + +/* Progress 0..1; detail optional. */ +void ota_ui_show_progress(const char *title, const char *detail, float progress01); + +/* Error / info + wait for B. */ +void ota_ui_alert(const char *title, const char *line1, const char *line2); + +/* Missing game install screen; wait for +. */ +void ota_ui_missing_game(void); + +/* Tear down framebuffer if active. Safe to call when UI never opened. */ +void ota_ui_shutdown(void); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/native/switch-ota-launcher/romfs/.gitkeep b/native/switch-ota-launcher/romfs/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/native/switch-ota-launcher/src/main.c b/native/switch-ota-launcher/src/main.c index ded6532b..7717c9bc 100644 --- a/native/switch-ota-launcher/src/main.c +++ b/native/switch-ota-launcher/src/main.c @@ -1,16 +1,17 @@ /* * gen1recomp Switch OTA launcher * - * Quiet by default: checks GitHub Releases with no console flash. Only shows - * a short prompt when an update is available. Downloads the same SD zip - * published for install (gen1recomp-*-switch.zip), verifies SHA-256, extracts - * switch/gen1recomp/gen1recomp-game.nro, then envSetNextLoad to the game. - * Never touches pokemon-love2d/. LÖVE self-updater stays off on NX. + * Quiet by default: checks GitHub Releases with no UI. Only shows the + * branded launcher-style screen when an update is available. Downloads the + * same SD zip (gen1recomp-*-switch.zip), verifies SHA-256, replaces game + + * launcher NROs, then envSetNextLoad. Never touches pokemon-love2d/. + * LÖVE self-updater stays off on NX. */ #include "ota_fs.h" #include "ota_net.h" #include "ota_protocol.h" +#include "ota_ui.h" #include "ota_unzip.h" #include @@ -31,61 +32,6 @@ #define GAME_MEMBER_IN_ZIP "switch/gen1recomp/" OTA_GAME_NRO_NAME #define LAUNCHER_MEMBER_IN_ZIP "switch/gen1recomp/" OTA_LAUNCHER_NRO_NAME -#if defined(__SWITCH__) -static int g_ui = 0; - -static void ui_begin(void) { - if (g_ui) return; - consoleInit(NULL); - consoleClear(); - g_ui = 1; -} - -static void ui_end(void) { - if (!g_ui) return; - consoleExit(NULL); - g_ui = 0; -} - -static void ui_line(const char *msg) { - ui_begin(); - printf("%s\n", msg); - consoleUpdate(NULL); -} - -static void ui_blank(void) { - if (!g_ui) return; - consoleClear(); - consoleUpdate(NULL); -} -#else -static void ui_begin(void) {} -static void ui_end(void) {} -static void ui_line(const char *msg) { fprintf(stderr, "%s\n", msg); } -static void ui_blank(void) {} -#endif - -/* Returns 1 = update, 0 = skip. Only called when UI is already needed. */ -static int wait_confirm_or_skip(void) { -#if defined(__SWITCH__) - PadState pad; - padInitializeDefault(&pad); - ui_line(""); - ui_line(" A — Update"); - ui_line(" B — Play without updating"); - while (appletMainLoop()) { - padUpdate(&pad); - u64 k = padGetButtonsDown(&pad); - if (k & HidNpadButton_A) return 1; - if (k & HidNpadButton_B) return 0; - consoleUpdate(NULL); - } - return 0; -#else - return 0; -#endif -} - static int run_update_flow(const char *install_dir) { char installed[64] = "0.0.0"; (void)ota_fs_read_installed_version(install_dir, installed, sizeof(installed)); @@ -114,19 +60,7 @@ static int run_update_flow(const char *install_dir) { return 0; } - /* Update available — only now show UI */ - { - char msg[160]; - ui_blank(); - ui_line(""); - ui_line(" gen1recomp"); - ui_line(""); - snprintf(msg, sizeof(msg), " Update available: %s → %s", installed, dec.version); - ui_line(msg); - } - - if (!wait_confirm_or_skip()) { - ui_end(); + if (!ota_ui_prompt_update(installed, dec.version)) { return 0; } @@ -141,50 +75,27 @@ static int run_update_flow(const char *install_dir) { mkdir(updates_dir, 0755); #endif - ui_blank(); - ui_line(""); - ui_line(" Downloading…"); + ota_ui_show_progress("Downloading…", "This may take a minute.", 0.15f); if (ota_net_download_file(dec.download_url, zip_path, 180000L, err, sizeof(err)) != 0) { - ui_line(""); - ui_line(" Download failed."); - ui_line(" Playing the installed version."); -#if defined(__SWITCH__) - { - PadState pad; - padInitializeDefault(&pad); - ui_line(""); - ui_line(" Press B to continue"); - while (appletMainLoop()) { - padUpdate(&pad); - if (padGetButtonsDown(&pad) & HidNpadButton_B) break; - consoleUpdate(NULL); - } - } -#endif - ui_end(); + ota_ui_alert("Download failed", "Playing the installed version.", NULL); return 0; } + ota_ui_show_progress("Checking update…", "Verifying file integrity.", 0.55f); char sums_url[512]; snprintf(sums_url, sizeof(sums_url), "https://github.com/bryanthaboi/gen1recomp/releases/download/%s/sha256sums.txt", rel.tag); if (ota_net_download_file(sums_url, sums_path, CHECK_TIMEOUT_MS, err, sizeof(err)) != 0) { - ui_line(""); - ui_line(" Could not verify the update."); - ui_line(" Playing the installed version."); remove(zip_path); - ui_end(); -#if defined(__SWITCH__) - svcSleepThread(1200000000ULL); -#endif + ota_ui_alert("Could not verify", "Playing the installed version.", NULL); return 0; } FILE *sf = fopen(sums_path, "rb"); if (!sf) { remove(zip_path); - ui_end(); + ota_ui_shutdown(); return 0; } fseek(sf, 0, SEEK_END); @@ -193,7 +104,7 @@ static int run_update_flow(const char *install_dir) { char *sums = (char *)malloc((size_t)slen + 1); if (!sums) { fclose(sf); - ui_end(); + ota_ui_shutdown(); return 0; } fread(sums, 1, (size_t)slen, sf); @@ -204,70 +115,49 @@ static int run_update_flow(const char *install_dir) { if (ota_fs_sha256_file(zip_path, hex, sizeof(hex)) != 0) { free(sums); remove(zip_path); - ui_end(); + ota_ui_shutdown(); return 0; } ota_verify_t ver; ota_verify_sha256(dec.asset_name, hex, sums, &ver); free(sums); if (!ver.ok) { - ui_line(""); - ui_line(" Update file failed checks."); - ui_line(" Playing the installed version."); remove(zip_path); - ui_end(); -#if defined(__SWITCH__) - svcSleepThread(1200000000ULL); -#endif + ota_ui_alert("Update check failed", "Playing the installed version.", NULL); return 0; } char extracted[256]; char extracted_launcher[256]; snprintf(extracted, sizeof(extracted), "%s/updates/gen1recomp-game.nro.verified", install_dir); - snprintf(extracted_launcher, sizeof(extracted_launcher), - "%s/updates/gen1recomp.nro.verified", install_dir); + snprintf(extracted_launcher, sizeof(extracted_launcher), "%s/updates/gen1recomp.nro.verified", + install_dir); #if defined(__SWITCH__) - ui_line(""); - ui_line(" Installing…"); - /* Prefer path inside SD zip; fall back to bare name. */ + ota_ui_show_progress("Installing…", "Keeping your saves safe.", 0.8f); if (ota_unzip_extract_file(zip_path, GAME_MEMBER_IN_ZIP, extracted, err, sizeof(err)) != 0) { if (ota_unzip_extract_file(zip_path, OTA_GAME_NRO_NAME, extracted, err, sizeof(err)) != 0) { - ui_line(""); - ui_line(" Install failed."); - ui_line(" Playing the installed version."); remove(zip_path); - ui_end(); - svcSleepThread(1200000000ULL); + ota_ui_alert("Install failed", "Playing the installed version.", NULL); return 0; } } if (ota_fs_atomic_replace_game(install_dir, extracted, err, sizeof(err)) != 0) { - ui_line(""); - ui_line(" Install failed."); - ui_line(" Playing the installed version."); remove(extracted); remove(zip_path); - ui_end(); - svcSleepThread(1200000000ULL); + ota_ui_alert("Install failed", "Playing the installed version.", NULL); return 0; } remove(extracted); - /* Also replace launcher so hbmenu/Sphaira see the matching NACP version. - * Best-effort: game update already succeeded if this fails. */ if (ota_unzip_extract_file(zip_path, LAUNCHER_MEMBER_IN_ZIP, extracted_launcher, err, sizeof(err)) == 0 || ota_unzip_extract_file(zip_path, OTA_LAUNCHER_NRO_NAME, extracted_launcher, err, sizeof(err)) == 0) { - if (ota_fs_atomic_replace_nro(install_dir, OTA_LAUNCHER_NRO_NAME, extracted_launcher, err, - sizeof(err)) == 0) { - remove(extracted_launcher); - } else { - remove(extracted_launcher); - } + (void)ota_fs_atomic_replace_nro(install_dir, OTA_LAUNCHER_NRO_NAME, extracted_launcher, err, + sizeof(err)); + remove(extracted_launcher); } char vpath[192]; @@ -277,12 +167,15 @@ static int run_update_flow(const char *install_dir) { fprintf(vf, "%s\n", dec.version); fclose(vf); } + + ota_ui_show_progress("Ready", "Starting the game…", 1.0f); + svcSleepThread(600000000ULL); #else (void)extracted; (void)extracted_launcher; #endif remove(zip_path); - ui_end(); + ota_ui_shutdown(); return 0; } @@ -303,26 +196,11 @@ int main(int argc, char **argv) { char err[128]; err[0] = '\0'; if (ota_fs_handoff_to_game(game, err, sizeof(err)) != 0) { - ui_line(""); - ui_line(" gen1recomp"); - ui_line(""); - ui_line(" Game files are missing."); - ui_line(" Copy the Switch zip onto your microSD,"); - ui_line(" then open gen1recomp again."); -#if defined(__SWITCH__) - ui_line(""); - ui_line(" Press + to exit"); - PadState pad; - padInitializeDefault(&pad); - while (appletMainLoop()) { - padUpdate(&pad); - if (padGetButtonsDown(&pad) & HidNpadButton_Plus) break; - consoleUpdate(NULL); - } -#endif - ui_end(); + ota_ui_missing_game(); } + ota_ui_shutdown(); + #if defined(__SWITCH__) socketExit(); #endif diff --git a/native/switch-ota-launcher/src/ota_ui.c b/native/switch-ota-launcher/src/ota_ui.c new file mode 100644 index 00000000..cfe00ec9 --- /dev/null +++ b/native/switch-ota-launcher/src/ota_ui.c @@ -0,0 +1,405 @@ +/* + * Switch OTA UI — matches in-game launcher language (Theme.lua): + * black field, RGB version rail, flat yellow/white buttons, white ink. + * Quiet until called. Uses framebuffer + 8x8 font + optional romfs logo. + */ +#include "ota_ui.h" + +#include +#include +#include + +#if defined(__SWITCH__) +#include + +#define STB_IMAGE_IMPLEMENTATION +#define STBI_ONLY_PNG +#define STBI_NO_THREAD_LOCALS +#include "../third_party/stb_image.h" +#include "../third_party/font8x8_basic.h" + +#define FB_W 1280 +#define FB_H 720 + +/* Theme.PAL (0–255) → RGBA8 */ +#define COL_BG RGBA8_MAXALPHA(0, 0, 0) +#define COL_INK RGBA8_MAXALPHA(255, 255, 255) +#define COL_DETAIL RGBA8_MAXALPHA(200, 200, 200) +#define COL_MUTED RGBA8_MAXALPHA(150, 150, 150) +#define COL_INVERSE RGBA8_MAXALPHA(0, 0, 0) +#define COL_YELLOW RGBA8_MAXALPHA(255, 214, 0) +#define COL_GREEN RGBA8_MAXALPHA(0, 255, 140) +#define COL_RAIL_R RGBA8_MAXALPHA(255, 60, 72) +#define COL_RAIL_B RGBA8_MAXALPHA(70, 150, 255) +#define COL_RAIL_G RGBA8_MAXALPHA(255, 203, 5) +#define COL_LINE RGBA8_MAXALPHA(90, 90, 90) +#define COL_RAISED RGBA8_MAXALPHA(20, 20, 20) + +static int g_ready = 0; +static Framebuffer g_fb; +static PadState g_pad; +static u32 *g_logo = NULL; +static int g_logo_w = 0, g_logo_h = 0; + +static void fill_rect(u32 *fb, u32 stride_px, int x, int y, int w, int h, u32 color) { + if (w <= 0 || h <= 0) return; + if (x < 0) { + w += x; + x = 0; + } + if (y < 0) { + h += y; + y = 0; + } + if (x + w > FB_W) w = FB_W - x; + if (y + h > FB_H) h = FB_H - y; + if (w <= 0 || h <= 0) return; + for (int row = 0; row < h; row++) { + u32 *line = fb + (y + row) * stride_px + x; + for (int col = 0; col < w; col++) line[col] = color; + } +} + +static void draw_glyph(u32 *fb, u32 stride_px, int x, int y, char ch, u32 color, int scale) { + unsigned char c = (unsigned char)ch; + if (c > 127) c = '?'; + const char *bits = font8x8_basic[c]; + for (int row = 0; row < 8; row++) { + unsigned char line = (unsigned char)bits[row]; + for (int col = 0; col < 8; col++) { + if (line & (1 << col)) { + fill_rect(fb, stride_px, x + col * scale, y + row * scale, scale, scale, color); + } + } + } +} + +static int text_width(const char *s, int scale) { + if (!s) return 0; + return (int)strlen(s) * 8 * scale; +} + +static void draw_text(u32 *fb, u32 stride_px, int x, int y, const char *s, u32 color, int scale) { + if (!s) return; + int cx = x; + for (; *s; s++) { + if (*s == '\n') { + cx = x; + y += 8 * scale + 4; + continue; + } + draw_glyph(fb, stride_px, cx, y, *s, color, scale); + cx += 8 * scale; + } +} + +static void draw_text_centered(u32 *fb, u32 stride_px, int y, const char *s, u32 color, int scale) { + int w = text_width(s, scale); + draw_text(fb, stride_px, (FB_W - w) / 2, y, s, color, scale); +} + +static void draw_rail(u32 *fb, u32 stride_px) { + int h = 6; + int third = FB_W / 3; + fill_rect(fb, stride_px, 0, 0, third, h, COL_RAIL_R); + fill_rect(fb, stride_px, third, 0, third, h, COL_RAIL_B); + fill_rect(fb, stride_px, third * 2, 0, FB_W - third * 2, h, COL_RAIL_G); +} + +static void blit_logo(u32 *fb, u32 stride_px, int dst_x, int dst_y, int max_w) { + if (!g_logo || g_logo_w <= 0 || g_logo_h <= 0) return; + int dw = g_logo_w; + int dh = g_logo_h; + if (dw > max_w) { + dh = dh * max_w / dw; + dw = max_w; + } + for (int y = 0; y < dh; y++) { + int sy = y * g_logo_h / dh; + for (int x = 0; x < dw; x++) { + int sx = x * g_logo_w / dw; + u32 px = g_logo[sy * g_logo_w + sx]; + u8 a = (px >> 24) & 0xff; + if (a < 16) continue; + int dx = dst_x + x; + int dy = dst_y + y; + if (dx < 0 || dy < 0 || dx >= FB_W || dy >= FB_H) continue; + fb[dy * stride_px + dx] = px | 0xff000000u; + } + } +} + +static void load_logo(void) { + if (g_logo) return; + romfsInit(); + int w = 0, h = 0, n = 0; + unsigned char *data = stbi_load("romfs:/logo.png", &w, &h, &n, 4); + if (!data || w <= 0 || h <= 0) { + if (data) stbi_image_free(data); + return; + } + g_logo = (u32 *)malloc((size_t)w * (size_t)h * sizeof(u32)); + if (!g_logo) { + stbi_image_free(data); + return; + } + for (int i = 0; i < w * h; i++) { + unsigned char *p = data + i * 4; + /* Premultiply-ish: keep RGB, store A in high byte for skip */ + g_logo[i] = RGBA8(p[0], p[1], p[2], p[3]); + } + g_logo_w = w; + g_logo_h = h; + stbi_image_free(data); +} + +static int ui_ensure(void) { + if (g_ready) return 1; + NWindow *win = nwindowGetDefault(); + if (R_FAILED(framebufferCreate(&g_fb, win, FB_W, FB_H, PIXEL_FORMAT_RGBA_8888, 2))) return 0; + framebufferMakeLinear(&g_fb); + padInitializeDefault(&g_pad); + load_logo(); + g_ready = 1; + return 1; +} + +void ota_ui_shutdown(void) { + if (!g_ready) return; + framebufferClose(&g_fb); + free(g_logo); + g_logo = NULL; + g_logo_w = g_logo_h = 0; + romfsExit(); + g_ready = 0; +} + +static void draw_button(u32 *fb, u32 stride_px, int x, int y, int w, int h, u32 fill, u32 ink, + const char *label, int focused) { + fill_rect(fb, stride_px, x, y, w, h, fill); + if (focused) { + /* 2px white focus ring (launcher focus outline) */ + fill_rect(fb, stride_px, x - 3, y - 3, w + 6, 2, COL_INK); + fill_rect(fb, stride_px, x - 3, y + h + 1, w + 6, 2, COL_INK); + fill_rect(fb, stride_px, x - 3, y - 3, 2, h + 6, COL_INK); + fill_rect(fb, stride_px, x + w + 1, y - 3, 2, h + 6, COL_INK); + } else { + fill_rect(fb, stride_px, x, y, w, 1, COL_LINE); + fill_rect(fb, stride_px, x, y + h - 1, w, 1, COL_LINE); + fill_rect(fb, stride_px, x, y, 1, h, COL_LINE); + fill_rect(fb, stride_px, x + w - 1, y, 1, h, COL_LINE); + } + int scale = 3; + int tw = text_width(label, scale); + int tx = x + (w - tw) / 2; + int ty = y + (h - 8 * scale) / 2; + draw_text(fb, stride_px, tx, ty, label, ink, scale); +} + +static void draw_chrome(u32 *fb, u32 stride_px) { + fill_rect(fb, stride_px, 0, 0, FB_W, FB_H, COL_BG); + draw_rail(fb, stride_px); + int logo_max = 320; + int logo_h = g_logo ? (g_logo_h * logo_max / g_logo_w) : 40; + if (logo_h > 90) logo_h = 90; + int logo_y = 48; + if (g_logo) { + int logo_w = logo_max; + if (g_logo_w * logo_h / g_logo_h < logo_max) logo_w = g_logo_w * logo_h / g_logo_h; + blit_logo(fb, stride_px, (FB_W - logo_w) / 2, logo_y, logo_max); + } else { + draw_text_centered(fb, stride_px, logo_y + 16, "gen1recomp", COL_INK, 4); + } +} + +static void present(void (*paint)(u32 *fb, u32 stride_px, void *ctx), void *ctx) { + if (!ui_ensure()) return; + u32 stride = 0; + u32 *fb = (u32 *)framebufferBegin(&g_fb, &stride); + u32 stride_px = stride / sizeof(u32); + paint(fb, stride_px, ctx); + framebufferEnd(&g_fb); +} + +typedef struct { + const char *installed; + const char *latest; + int focus; /* 0 = Update, 1 = Play */ +} prompt_ctx_t; + +static void paint_prompt(u32 *fb, u32 stride_px, void *ctx) { + prompt_ctx_t *p = (prompt_ctx_t *)ctx; + draw_chrome(fb, stride_px); + + int y = 180; + draw_text_centered(fb, stride_px, y, "Update available", COL_INK, 3); + y += 48; + + char line[96]; + snprintf(line, sizeof(line), "v%s -> v%s", p->installed ? p->installed : "?", + p->latest ? p->latest : "?"); + draw_text_centered(fb, stride_px, y, line, COL_YELLOW, 3); + y += 56; + + draw_text_centered(fb, stride_px, y, "Your saves stay on this console.", COL_MUTED, 2); + y += 64; + + int bw = 420; + int bh = 64; + int bx = (FB_W - bw) / 2; + draw_button(fb, stride_px, bx, y, bw, bh, COL_YELLOW, COL_INVERSE, "A Update", p->focus == 0); + y += bh + 24; + draw_button(fb, stride_px, bx, y, bw, bh, COL_INK, COL_INVERSE, "B Play without updating", + p->focus == 1); +} + +int ota_ui_prompt_update(const char *installed, const char *latest) { + if (!ui_ensure()) return 0; + prompt_ctx_t ctx = {installed, latest, 0}; + while (appletMainLoop()) { + present(paint_prompt, &ctx); + padUpdate(&g_pad); + u64 k = padGetButtonsDown(&g_pad); + if (k & HidNpadButton_A) { + int do_update = (ctx.focus == 0); + if (!do_update) ota_ui_shutdown(); + return do_update; + } + if (k & HidNpadButton_B) { + ota_ui_shutdown(); + return 0; + } + if (k & (HidNpadButton_Up | HidNpadButton_Down | HidNpadButton_Left | HidNpadButton_Right)) { + ctx.focus = 1 - ctx.focus; + } + svcSleepThread(16000000ULL); + } + ota_ui_shutdown(); + return 0; +} + +typedef struct { + const char *title; + const char *detail; + float progress; + int show_bar; +} status_ctx_t; + +static void paint_status(u32 *fb, u32 stride_px, void *ctx) { + status_ctx_t *s = (status_ctx_t *)ctx; + draw_chrome(fb, stride_px); + int y = 200; + draw_text_centered(fb, stride_px, y, s->title ? s->title : "", COL_INK, 3); + y += 48; + if (s->detail && s->detail[0]) { + draw_text_centered(fb, stride_px, y, s->detail, COL_DETAIL, 2); + y += 40; + } + if (s->show_bar) { + int bw = 520; + int bh = 18; + int bx = (FB_W - bw) / 2; + float t = s->progress; + if (t < 0.f) t = 0.f; + if (t > 1.f) t = 1.f; + fill_rect(fb, stride_px, bx, y, bw, bh, COL_RAISED); + fill_rect(fb, stride_px, bx, y, bw, 1, COL_LINE); + fill_rect(fb, stride_px, bx, y + bh - 1, bw, 1, COL_LINE); + fill_rect(fb, stride_px, bx, y, 1, bh, COL_LINE); + fill_rect(fb, stride_px, bx + bw - 1, y, 1, bh, COL_LINE); + int fw = (int)(bw * t); + if (fw > 0) fill_rect(fb, stride_px, bx, y, fw, bh, COL_GREEN); + } +} + +void ota_ui_show_status(const char *title, const char *detail) { + status_ctx_t s = {title, detail, 0.f, 0}; + present(paint_status, &s); +} + +void ota_ui_show_progress(const char *title, const char *detail, float progress01) { + status_ctx_t s = {title, detail, progress01, 1}; + present(paint_status, &s); +} + +typedef struct { + const char *title; + const char *line1; + const char *line2; +} alert_ctx_t; + +static void paint_alert(u32 *fb, u32 stride_px, void *ctx) { + alert_ctx_t *a = (alert_ctx_t *)ctx; + draw_chrome(fb, stride_px); + int y = 200; + draw_text_centered(fb, stride_px, y, a->title ? a->title : "", COL_YELLOW, 3); + y += 52; + if (a->line1) draw_text_centered(fb, stride_px, y, a->line1, COL_DETAIL, 2); + y += 36; + if (a->line2) draw_text_centered(fb, stride_px, y, a->line2, COL_MUTED, 2); + y += 64; + int bw = 360; + int bh = 56; + draw_button(fb, stride_px, (FB_W - bw) / 2, y, bw, bh, COL_INK, COL_INVERSE, "B Continue", 1); +} + +void ota_ui_alert(const char *title, const char *line1, const char *line2) { + if (!ui_ensure()) return; + alert_ctx_t a = {title, line1, line2}; + while (appletMainLoop()) { + present(paint_alert, &a); + padUpdate(&g_pad); + if (padGetButtonsDown(&g_pad) & HidNpadButton_B) break; + svcSleepThread(16000000ULL); + } + ota_ui_shutdown(); +} + +static void paint_missing(u32 *fb, u32 stride_px, void *ctx) { + (void)ctx; + draw_chrome(fb, stride_px); + int y = 190; + draw_text_centered(fb, stride_px, y, "Game files missing", COL_YELLOW, 3); + y += 52; + draw_text_centered(fb, stride_px, y, "Copy the Switch zip onto your microSD,", COL_DETAIL, 2); + y += 32; + draw_text_centered(fb, stride_px, y, "then open gen1recomp again.", COL_DETAIL, 2); + y += 64; + int bw = 320; + int bh = 56; + draw_button(fb, stride_px, (FB_W - bw) / 2, y, bw, bh, COL_INK, COL_INVERSE, "+ Exit", 1); +} + +void ota_ui_missing_game(void) { + if (!ui_ensure()) return; + while (appletMainLoop()) { + present(paint_missing, NULL); + padUpdate(&g_pad); + if (padGetButtonsDown(&g_pad) & HidNpadButton_Plus) break; + svcSleepThread(16000000ULL); + } + ota_ui_shutdown(); +} + +#else /* host stub */ + +int ota_ui_prompt_update(const char *installed, const char *latest) { + fprintf(stderr, "[ota_ui] update %s -> %s (host stub: skip)\n", installed ? installed : "?", + latest ? latest : "?"); + return 0; +} +void ota_ui_show_status(const char *title, const char *detail) { + fprintf(stderr, "[ota_ui] %s %s\n", title ? title : "", detail ? detail : ""); +} +void ota_ui_show_progress(const char *title, const char *detail, float progress01) { + fprintf(stderr, "[ota_ui] %s %s (%.0f%%)\n", title ? title : "", detail ? detail : "", + progress01 * 100.f); +} +void ota_ui_alert(const char *title, const char *line1, const char *line2) { + fprintf(stderr, "[ota_ui] alert: %s / %s / %s\n", title ? title : "", line1 ? line1 : "", + line2 ? line2 : ""); +} +void ota_ui_missing_game(void) { fprintf(stderr, "[ota_ui] missing game\n"); } +void ota_ui_shutdown(void) {} + +#endif diff --git a/native/switch-ota-launcher/third_party/font8x8_basic.h b/native/switch-ota-launcher/third_party/font8x8_basic.h new file mode 100644 index 00000000..125cf165 --- /dev/null +++ b/native/switch-ota-launcher/third_party/font8x8_basic.h @@ -0,0 +1,152 @@ +/** + * 8x8 monochrome bitmap fonts for rendering + * Author: Daniel Hepper + * + * License: Public Domain + * + * Based on: + * // Summary: font8x8.h + * // 8x8 monochrome bitmap fonts for rendering + * // + * // Author: + * // Marcel Sondaar + * // International Business Machines (public domain VGA fonts) + * // + * // License: + * // Public Domain + * + * Fetched from: http://dimensionalrift.homelinux.net/combuster/mos3/?p=viewsource&file=/modules/gfx/font8_8.asm + **/ + +// Constant: font8x8_basic +// Contains an 8x8 font map for unicode points U+0000 - U+007F (basic latin) +char font8x8_basic[128][8] = { + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0000 (nul) + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0001 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0002 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0003 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0004 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0005 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0006 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0007 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0008 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0009 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+000A + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+000B + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+000C + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+000D + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+000E + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+000F + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0010 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0011 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0012 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0013 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0014 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0015 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0016 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0017 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0018 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0019 + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+001A + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+001B + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+001C + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+001D + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+001E + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+001F + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0020 (space) + { 0x18, 0x3C, 0x3C, 0x18, 0x18, 0x00, 0x18, 0x00}, // U+0021 (!) + { 0x36, 0x36, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0022 (") + { 0x36, 0x36, 0x7F, 0x36, 0x7F, 0x36, 0x36, 0x00}, // U+0023 (#) + { 0x0C, 0x3E, 0x03, 0x1E, 0x30, 0x1F, 0x0C, 0x00}, // U+0024 ($) + { 0x00, 0x63, 0x33, 0x18, 0x0C, 0x66, 0x63, 0x00}, // U+0025 (%) + { 0x1C, 0x36, 0x1C, 0x6E, 0x3B, 0x33, 0x6E, 0x00}, // U+0026 (&) + { 0x06, 0x06, 0x03, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0027 (') + { 0x18, 0x0C, 0x06, 0x06, 0x06, 0x0C, 0x18, 0x00}, // U+0028 (() + { 0x06, 0x0C, 0x18, 0x18, 0x18, 0x0C, 0x06, 0x00}, // U+0029 ()) + { 0x00, 0x66, 0x3C, 0xFF, 0x3C, 0x66, 0x00, 0x00}, // U+002A (*) + { 0x00, 0x0C, 0x0C, 0x3F, 0x0C, 0x0C, 0x00, 0x00}, // U+002B (+) + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x0C, 0x0C, 0x06}, // U+002C (,) + { 0x00, 0x00, 0x00, 0x3F, 0x00, 0x00, 0x00, 0x00}, // U+002D (-) + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x0C, 0x0C, 0x00}, // U+002E (.) + { 0x60, 0x30, 0x18, 0x0C, 0x06, 0x03, 0x01, 0x00}, // U+002F (/) + { 0x3E, 0x63, 0x73, 0x7B, 0x6F, 0x67, 0x3E, 0x00}, // U+0030 (0) + { 0x0C, 0x0E, 0x0C, 0x0C, 0x0C, 0x0C, 0x3F, 0x00}, // U+0031 (1) + { 0x1E, 0x33, 0x30, 0x1C, 0x06, 0x33, 0x3F, 0x00}, // U+0032 (2) + { 0x1E, 0x33, 0x30, 0x1C, 0x30, 0x33, 0x1E, 0x00}, // U+0033 (3) + { 0x38, 0x3C, 0x36, 0x33, 0x7F, 0x30, 0x78, 0x00}, // U+0034 (4) + { 0x3F, 0x03, 0x1F, 0x30, 0x30, 0x33, 0x1E, 0x00}, // U+0035 (5) + { 0x1C, 0x06, 0x03, 0x1F, 0x33, 0x33, 0x1E, 0x00}, // U+0036 (6) + { 0x3F, 0x33, 0x30, 0x18, 0x0C, 0x0C, 0x0C, 0x00}, // U+0037 (7) + { 0x1E, 0x33, 0x33, 0x1E, 0x33, 0x33, 0x1E, 0x00}, // U+0038 (8) + { 0x1E, 0x33, 0x33, 0x3E, 0x30, 0x18, 0x0E, 0x00}, // U+0039 (9) + { 0x00, 0x0C, 0x0C, 0x00, 0x00, 0x0C, 0x0C, 0x00}, // U+003A (:) + { 0x00, 0x0C, 0x0C, 0x00, 0x00, 0x0C, 0x0C, 0x06}, // U+003B (;) + { 0x18, 0x0C, 0x06, 0x03, 0x06, 0x0C, 0x18, 0x00}, // U+003C (<) + { 0x00, 0x00, 0x3F, 0x00, 0x00, 0x3F, 0x00, 0x00}, // U+003D (=) + { 0x06, 0x0C, 0x18, 0x30, 0x18, 0x0C, 0x06, 0x00}, // U+003E (>) + { 0x1E, 0x33, 0x30, 0x18, 0x0C, 0x00, 0x0C, 0x00}, // U+003F (?) + { 0x3E, 0x63, 0x7B, 0x7B, 0x7B, 0x03, 0x1E, 0x00}, // U+0040 (@) + { 0x0C, 0x1E, 0x33, 0x33, 0x3F, 0x33, 0x33, 0x00}, // U+0041 (A) + { 0x3F, 0x66, 0x66, 0x3E, 0x66, 0x66, 0x3F, 0x00}, // U+0042 (B) + { 0x3C, 0x66, 0x03, 0x03, 0x03, 0x66, 0x3C, 0x00}, // U+0043 (C) + { 0x1F, 0x36, 0x66, 0x66, 0x66, 0x36, 0x1F, 0x00}, // U+0044 (D) + { 0x7F, 0x46, 0x16, 0x1E, 0x16, 0x46, 0x7F, 0x00}, // U+0045 (E) + { 0x7F, 0x46, 0x16, 0x1E, 0x16, 0x06, 0x0F, 0x00}, // U+0046 (F) + { 0x3C, 0x66, 0x03, 0x03, 0x73, 0x66, 0x7C, 0x00}, // U+0047 (G) + { 0x33, 0x33, 0x33, 0x3F, 0x33, 0x33, 0x33, 0x00}, // U+0048 (H) + { 0x1E, 0x0C, 0x0C, 0x0C, 0x0C, 0x0C, 0x1E, 0x00}, // U+0049 (I) + { 0x78, 0x30, 0x30, 0x30, 0x33, 0x33, 0x1E, 0x00}, // U+004A (J) + { 0x67, 0x66, 0x36, 0x1E, 0x36, 0x66, 0x67, 0x00}, // U+004B (K) + { 0x0F, 0x06, 0x06, 0x06, 0x46, 0x66, 0x7F, 0x00}, // U+004C (L) + { 0x63, 0x77, 0x7F, 0x7F, 0x6B, 0x63, 0x63, 0x00}, // U+004D (M) + { 0x63, 0x67, 0x6F, 0x7B, 0x73, 0x63, 0x63, 0x00}, // U+004E (N) + { 0x1C, 0x36, 0x63, 0x63, 0x63, 0x36, 0x1C, 0x00}, // U+004F (O) + { 0x3F, 0x66, 0x66, 0x3E, 0x06, 0x06, 0x0F, 0x00}, // U+0050 (P) + { 0x1E, 0x33, 0x33, 0x33, 0x3B, 0x1E, 0x38, 0x00}, // U+0051 (Q) + { 0x3F, 0x66, 0x66, 0x3E, 0x36, 0x66, 0x67, 0x00}, // U+0052 (R) + { 0x1E, 0x33, 0x07, 0x0E, 0x38, 0x33, 0x1E, 0x00}, // U+0053 (S) + { 0x3F, 0x2D, 0x0C, 0x0C, 0x0C, 0x0C, 0x1E, 0x00}, // U+0054 (T) + { 0x33, 0x33, 0x33, 0x33, 0x33, 0x33, 0x3F, 0x00}, // U+0055 (U) + { 0x33, 0x33, 0x33, 0x33, 0x33, 0x1E, 0x0C, 0x00}, // U+0056 (V) + { 0x63, 0x63, 0x63, 0x6B, 0x7F, 0x77, 0x63, 0x00}, // U+0057 (W) + { 0x63, 0x63, 0x36, 0x1C, 0x1C, 0x36, 0x63, 0x00}, // U+0058 (X) + { 0x33, 0x33, 0x33, 0x1E, 0x0C, 0x0C, 0x1E, 0x00}, // U+0059 (Y) + { 0x7F, 0x63, 0x31, 0x18, 0x4C, 0x66, 0x7F, 0x00}, // U+005A (Z) + { 0x1E, 0x06, 0x06, 0x06, 0x06, 0x06, 0x1E, 0x00}, // U+005B ([) + { 0x03, 0x06, 0x0C, 0x18, 0x30, 0x60, 0x40, 0x00}, // U+005C (\) + { 0x1E, 0x18, 0x18, 0x18, 0x18, 0x18, 0x1E, 0x00}, // U+005D (]) + { 0x08, 0x1C, 0x36, 0x63, 0x00, 0x00, 0x00, 0x00}, // U+005E (^) + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF}, // U+005F (_) + { 0x0C, 0x0C, 0x18, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+0060 (`) + { 0x00, 0x00, 0x1E, 0x30, 0x3E, 0x33, 0x6E, 0x00}, // U+0061 (a) + { 0x07, 0x06, 0x06, 0x3E, 0x66, 0x66, 0x3B, 0x00}, // U+0062 (b) + { 0x00, 0x00, 0x1E, 0x33, 0x03, 0x33, 0x1E, 0x00}, // U+0063 (c) + { 0x38, 0x30, 0x30, 0x3e, 0x33, 0x33, 0x6E, 0x00}, // U+0064 (d) + { 0x00, 0x00, 0x1E, 0x33, 0x3f, 0x03, 0x1E, 0x00}, // U+0065 (e) + { 0x1C, 0x36, 0x06, 0x0f, 0x06, 0x06, 0x0F, 0x00}, // U+0066 (f) + { 0x00, 0x00, 0x6E, 0x33, 0x33, 0x3E, 0x30, 0x1F}, // U+0067 (g) + { 0x07, 0x06, 0x36, 0x6E, 0x66, 0x66, 0x67, 0x00}, // U+0068 (h) + { 0x0C, 0x00, 0x0E, 0x0C, 0x0C, 0x0C, 0x1E, 0x00}, // U+0069 (i) + { 0x30, 0x00, 0x30, 0x30, 0x30, 0x33, 0x33, 0x1E}, // U+006A (j) + { 0x07, 0x06, 0x66, 0x36, 0x1E, 0x36, 0x67, 0x00}, // U+006B (k) + { 0x0E, 0x0C, 0x0C, 0x0C, 0x0C, 0x0C, 0x1E, 0x00}, // U+006C (l) + { 0x00, 0x00, 0x33, 0x7F, 0x7F, 0x6B, 0x63, 0x00}, // U+006D (m) + { 0x00, 0x00, 0x1F, 0x33, 0x33, 0x33, 0x33, 0x00}, // U+006E (n) + { 0x00, 0x00, 0x1E, 0x33, 0x33, 0x33, 0x1E, 0x00}, // U+006F (o) + { 0x00, 0x00, 0x3B, 0x66, 0x66, 0x3E, 0x06, 0x0F}, // U+0070 (p) + { 0x00, 0x00, 0x6E, 0x33, 0x33, 0x3E, 0x30, 0x78}, // U+0071 (q) + { 0x00, 0x00, 0x3B, 0x6E, 0x66, 0x06, 0x0F, 0x00}, // U+0072 (r) + { 0x00, 0x00, 0x3E, 0x03, 0x1E, 0x30, 0x1F, 0x00}, // U+0073 (s) + { 0x08, 0x0C, 0x3E, 0x0C, 0x0C, 0x2C, 0x18, 0x00}, // U+0074 (t) + { 0x00, 0x00, 0x33, 0x33, 0x33, 0x33, 0x6E, 0x00}, // U+0075 (u) + { 0x00, 0x00, 0x33, 0x33, 0x33, 0x1E, 0x0C, 0x00}, // U+0076 (v) + { 0x00, 0x00, 0x63, 0x6B, 0x7F, 0x7F, 0x36, 0x00}, // U+0077 (w) + { 0x00, 0x00, 0x63, 0x36, 0x1C, 0x36, 0x63, 0x00}, // U+0078 (x) + { 0x00, 0x00, 0x33, 0x33, 0x33, 0x3E, 0x30, 0x1F}, // U+0079 (y) + { 0x00, 0x00, 0x3F, 0x19, 0x0C, 0x26, 0x3F, 0x00}, // U+007A (z) + { 0x38, 0x0C, 0x0C, 0x07, 0x0C, 0x0C, 0x38, 0x00}, // U+007B ({) + { 0x18, 0x18, 0x18, 0x00, 0x18, 0x18, 0x18, 0x00}, // U+007C (|) + { 0x07, 0x0C, 0x0C, 0x38, 0x0C, 0x0C, 0x07, 0x00}, // U+007D (}) + { 0x6E, 0x3B, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, // U+007E (~) + { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00} // U+007F +}; diff --git a/native/switch-ota-launcher/third_party/stb_image.h b/native/switch-ota-launcher/third_party/stb_image.h new file mode 100644 index 00000000..9eedabed --- /dev/null +++ b/native/switch-ota-launcher/third_party/stb_image.h @@ -0,0 +1,7988 @@ +/* stb_image - v2.30 - public domain image loader - http://nothings.org/stb + no warranty implied; use at your own risk + + Do this: + #define STB_IMAGE_IMPLEMENTATION + before you include this file in *one* C or C++ file to create the implementation. + + // i.e. it should look like this: + #include ... + #include ... + #include ... + #define STB_IMAGE_IMPLEMENTATION + #include "stb_image.h" + + You can #define STBI_ASSERT(x) before the #include to avoid using assert.h. + And #define STBI_MALLOC, STBI_REALLOC, and STBI_FREE to avoid using malloc,realloc,free + + + QUICK NOTES: + Primarily of interest to game developers and other people who can + avoid problematic images and only need the trivial interface + + JPEG baseline & progressive (12 bpc/arithmetic not supported, same as stock IJG lib) + PNG 1/2/4/8/16-bit-per-channel + + TGA (not sure what subset, if a subset) + BMP non-1bpp, non-RLE + PSD (composited view only, no extra channels, 8/16 bit-per-channel) + + GIF (*comp always reports as 4-channel) + HDR (radiance rgbE format) + PIC (Softimage PIC) + PNM (PPM and PGM binary only) + + Animated GIF still needs a proper API, but here's one way to do it: + http://gist.github.com/urraka/685d9a6340b26b830d49 + + - decode from memory or through FILE (define STBI_NO_STDIO to remove code) + - decode from arbitrary I/O callbacks + - SIMD acceleration on x86/x64 (SSE2) and ARM (NEON) + + Full documentation under "DOCUMENTATION" below. + + +LICENSE + + See end of file for license information. + +RECENT REVISION HISTORY: + + 2.30 (2024-05-31) avoid erroneous gcc warning + 2.29 (2023-05-xx) optimizations + 2.28 (2023-01-29) many error fixes, security errors, just tons of stuff + 2.27 (2021-07-11) document stbi_info better, 16-bit PNM support, bug fixes + 2.26 (2020-07-13) many minor fixes + 2.25 (2020-02-02) fix warnings + 2.24 (2020-02-02) fix warnings; thread-local failure_reason and flip_vertically + 2.23 (2019-08-11) fix clang static analysis warning + 2.22 (2019-03-04) gif fixes, fix warnings + 2.21 (2019-02-25) fix typo in comment + 2.20 (2019-02-07) support utf8 filenames in Windows; fix warnings and platform ifdefs + 2.19 (2018-02-11) fix warning + 2.18 (2018-01-30) fix warnings + 2.17 (2018-01-29) bugfix, 1-bit BMP, 16-bitness query, fix warnings + 2.16 (2017-07-23) all functions have 16-bit variants; optimizations; bugfixes + 2.15 (2017-03-18) fix png-1,2,4; all Imagenet JPGs; no runtime SSE detection on GCC + 2.14 (2017-03-03) remove deprecated STBI_JPEG_OLD; fixes for Imagenet JPGs + 2.13 (2016-12-04) experimental 16-bit API, only for PNG so far; fixes + 2.12 (2016-04-02) fix typo in 2.11 PSD fix that caused crashes + 2.11 (2016-04-02) 16-bit PNGS; enable SSE2 in non-gcc x64 + RGB-format JPEG; remove white matting in PSD; + allocate large structures on the stack; + correct channel count for PNG & BMP + 2.10 (2016-01-22) avoid warning introduced in 2.09 + 2.09 (2016-01-16) 16-bit TGA; comments in PNM files; STBI_REALLOC_SIZED + + See end of file for full revision history. + + + ============================ Contributors ========================= + + Image formats Extensions, features + Sean Barrett (jpeg, png, bmp) Jetro Lauha (stbi_info) + Nicolas Schulz (hdr, psd) Martin "SpartanJ" Golini (stbi_info) + Jonathan Dummer (tga) James "moose2000" Brown (iPhone PNG) + Jean-Marc Lienher (gif) Ben "Disch" Wenger (io callbacks) + Tom Seddon (pic) Omar Cornut (1/2/4-bit PNG) + Thatcher Ulrich (psd) Nicolas Guillemot (vertical flip) + Ken Miller (pgm, ppm) Richard Mitton (16-bit PSD) + github:urraka (animated gif) Junggon Kim (PNM comments) + Christopher Forseth (animated gif) Daniel Gibson (16-bit TGA) + socks-the-fox (16-bit PNG) + Jeremy Sawicki (handle all ImageNet JPGs) + Optimizations & bugfixes Mikhail Morozov (1-bit BMP) + Fabian "ryg" Giesen Anael Seghezzi (is-16-bit query) + Arseny Kapoulkine Simon Breuss (16-bit PNM) + John-Mark Allen + Carmelo J Fdez-Aguera + + Bug & warning fixes + Marc LeBlanc David Woo Guillaume George Martins Mozeiko + Christpher Lloyd Jerry Jansson Joseph Thomson Blazej Dariusz Roszkowski + Phil Jordan Dave Moore Roy Eltham + Hayaki Saito Nathan Reed Won Chun + Luke Graham Johan Duparc Nick Verigakis the Horde3D community + Thomas Ruf Ronny Chevalier github:rlyeh + Janez Zemva John Bartholomew Michal Cichon github:romigrou + Jonathan Blow Ken Hamada Tero Hanninen github:svdijk + Eugene Golushkov Laurent Gomila Cort Stratton github:snagar + Aruelien Pocheville Sergio Gonzalez Thibault Reuille github:Zelex + Cass Everitt Ryamond Barbiero github:grim210 + Paul Du Bois Engin Manap Aldo Culquicondor github:sammyhw + Philipp Wiesemann Dale Weiler Oriol Ferrer Mesia github:phprus + Josh Tobin Neil Bickford Matthew Gregan github:poppolopoppo + Julian Raschke Gregory Mullen Christian Floisand github:darealshinji + Baldur Karlsson Kevin Schmidt JR Smith github:Michaelangel007 + Brad Weinberger Matvey Cherevko github:mosra + Luca Sas Alexander Veselov Zack Middleton [reserved] + Ryan C. Gordon [reserved] [reserved] + DO NOT ADD YOUR NAME HERE + + Jacko Dirks + + To add your name to the credits, pick a random blank space in the middle and fill it. + 80% of merge conflicts on stb PRs are due to people adding their name at the end + of the credits. +*/ + +#ifndef STBI_INCLUDE_STB_IMAGE_H +#define STBI_INCLUDE_STB_IMAGE_H + +// DOCUMENTATION +// +// Limitations: +// - no 12-bit-per-channel JPEG +// - no JPEGs with arithmetic coding +// - GIF always returns *comp=4 +// +// Basic usage (see HDR discussion below for HDR usage): +// int x,y,n; +// unsigned char *data = stbi_load(filename, &x, &y, &n, 0); +// // ... process data if not NULL ... +// // ... x = width, y = height, n = # 8-bit components per pixel ... +// // ... replace '0' with '1'..'4' to force that many components per pixel +// // ... but 'n' will always be the number that it would have been if you said 0 +// stbi_image_free(data); +// +// Standard parameters: +// int *x -- outputs image width in pixels +// int *y -- outputs image height in pixels +// int *channels_in_file -- outputs # of image components in image file +// int desired_channels -- if non-zero, # of image components requested in result +// +// The return value from an image loader is an 'unsigned char *' which points +// to the pixel data, or NULL on an allocation failure or if the image is +// corrupt or invalid. The pixel data consists of *y scanlines of *x pixels, +// with each pixel consisting of N interleaved 8-bit components; the first +// pixel pointed to is top-left-most in the image. There is no padding between +// image scanlines or between pixels, regardless of format. The number of +// components N is 'desired_channels' if desired_channels is non-zero, or +// *channels_in_file otherwise. If desired_channels is non-zero, +// *channels_in_file has the number of components that _would_ have been +// output otherwise. E.g. if you set desired_channels to 4, you will always +// get RGBA output, but you can check *channels_in_file to see if it's trivially +// opaque because e.g. there were only 3 channels in the source image. +// +// An output image with N components has the following components interleaved +// in this order in each pixel: +// +// N=#comp components +// 1 grey +// 2 grey, alpha +// 3 red, green, blue +// 4 red, green, blue, alpha +// +// If image loading fails for any reason, the return value will be NULL, +// and *x, *y, *channels_in_file will be unchanged. The function +// stbi_failure_reason() can be queried for an extremely brief, end-user +// unfriendly explanation of why the load failed. Define STBI_NO_FAILURE_STRINGS +// to avoid compiling these strings at all, and STBI_FAILURE_USERMSG to get slightly +// more user-friendly ones. +// +// Paletted PNG, BMP, GIF, and PIC images are automatically depalettized. +// +// To query the width, height and component count of an image without having to +// decode the full file, you can use the stbi_info family of functions: +// +// int x,y,n,ok; +// ok = stbi_info(filename, &x, &y, &n); +// // returns ok=1 and sets x, y, n if image is a supported format, +// // 0 otherwise. +// +// Note that stb_image pervasively uses ints in its public API for sizes, +// including sizes of memory buffers. This is now part of the API and thus +// hard to change without causing breakage. As a result, the various image +// loaders all have certain limits on image size; these differ somewhat +// by format but generally boil down to either just under 2GB or just under +// 1GB. When the decoded image would be larger than this, stb_image decoding +// will fail. +// +// Additionally, stb_image will reject image files that have any of their +// dimensions set to a larger value than the configurable STBI_MAX_DIMENSIONS, +// which defaults to 2**24 = 16777216 pixels. Due to the above memory limit, +// the only way to have an image with such dimensions load correctly +// is for it to have a rather extreme aspect ratio. Either way, the +// assumption here is that such larger images are likely to be malformed +// or malicious. If you do need to load an image with individual dimensions +// larger than that, and it still fits in the overall size limit, you can +// #define STBI_MAX_DIMENSIONS on your own to be something larger. +// +// =========================================================================== +// +// UNICODE: +// +// If compiling for Windows and you wish to use Unicode filenames, compile +// with +// #define STBI_WINDOWS_UTF8 +// and pass utf8-encoded filenames. Call stbi_convert_wchar_to_utf8 to convert +// Windows wchar_t filenames to utf8. +// +// =========================================================================== +// +// Philosophy +// +// stb libraries are designed with the following priorities: +// +// 1. easy to use +// 2. easy to maintain +// 3. good performance +// +// Sometimes I let "good performance" creep up in priority over "easy to maintain", +// and for best performance I may provide less-easy-to-use APIs that give higher +// performance, in addition to the easy-to-use ones. Nevertheless, it's important +// to keep in mind that from the standpoint of you, a client of this library, +// all you care about is #1 and #3, and stb libraries DO NOT emphasize #3 above all. +// +// Some secondary priorities arise directly from the first two, some of which +// provide more explicit reasons why performance can't be emphasized. +// +// - Portable ("ease of use") +// - Small source code footprint ("easy to maintain") +// - No dependencies ("ease of use") +// +// =========================================================================== +// +// I/O callbacks +// +// I/O callbacks allow you to read from arbitrary sources, like packaged +// files or some other source. Data read from callbacks are processed +// through a small internal buffer (currently 128 bytes) to try to reduce +// overhead. +// +// The three functions you must define are "read" (reads some bytes of data), +// "skip" (skips some bytes of data), "eof" (reports if the stream is at the end). +// +// =========================================================================== +// +// SIMD support +// +// The JPEG decoder will try to automatically use SIMD kernels on x86 when +// supported by the compiler. For ARM Neon support, you must explicitly +// request it. +// +// (The old do-it-yourself SIMD API is no longer supported in the current +// code.) +// +// On x86, SSE2 will automatically be used when available based on a run-time +// test; if not, the generic C versions are used as a fall-back. On ARM targets, +// the typical path is to have separate builds for NEON and non-NEON devices +// (at least this is true for iOS and Android). Therefore, the NEON support is +// toggled by a build flag: define STBI_NEON to get NEON loops. +// +// If for some reason you do not want to use any of SIMD code, or if +// you have issues compiling it, you can disable it entirely by +// defining STBI_NO_SIMD. +// +// =========================================================================== +// +// HDR image support (disable by defining STBI_NO_HDR) +// +// stb_image supports loading HDR images in general, and currently the Radiance +// .HDR file format specifically. You can still load any file through the existing +// interface; if you attempt to load an HDR file, it will be automatically remapped +// to LDR, assuming gamma 2.2 and an arbitrary scale factor defaulting to 1; +// both of these constants can be reconfigured through this interface: +// +// stbi_hdr_to_ldr_gamma(2.2f); +// stbi_hdr_to_ldr_scale(1.0f); +// +// (note, do not use _inverse_ constants; stbi_image will invert them +// appropriately). +// +// Additionally, there is a new, parallel interface for loading files as +// (linear) floats to preserve the full dynamic range: +// +// float *data = stbi_loadf(filename, &x, &y, &n, 0); +// +// If you load LDR images through this interface, those images will +// be promoted to floating point values, run through the inverse of +// constants corresponding to the above: +// +// stbi_ldr_to_hdr_scale(1.0f); +// stbi_ldr_to_hdr_gamma(2.2f); +// +// Finally, given a filename (or an open file or memory block--see header +// file for details) containing image data, you can query for the "most +// appropriate" interface to use (that is, whether the image is HDR or +// not), using: +// +// stbi_is_hdr(char *filename); +// +// =========================================================================== +// +// iPhone PNG support: +// +// We optionally support converting iPhone-formatted PNGs (which store +// premultiplied BGRA) back to RGB, even though they're internally encoded +// differently. To enable this conversion, call +// stbi_convert_iphone_png_to_rgb(1). +// +// Call stbi_set_unpremultiply_on_load(1) as well to force a divide per +// pixel to remove any premultiplied alpha *only* if the image file explicitly +// says there's premultiplied data (currently only happens in iPhone images, +// and only if iPhone convert-to-rgb processing is on). +// +// =========================================================================== +// +// ADDITIONAL CONFIGURATION +// +// - You can suppress implementation of any of the decoders to reduce +// your code footprint by #defining one or more of the following +// symbols before creating the implementation. +// +// STBI_NO_JPEG +// STBI_NO_PNG +// STBI_NO_BMP +// STBI_NO_PSD +// STBI_NO_TGA +// STBI_NO_GIF +// STBI_NO_HDR +// STBI_NO_PIC +// STBI_NO_PNM (.ppm and .pgm) +// +// - You can request *only* certain decoders and suppress all other ones +// (this will be more forward-compatible, as addition of new decoders +// doesn't require you to disable them explicitly): +// +// STBI_ONLY_JPEG +// STBI_ONLY_PNG +// STBI_ONLY_BMP +// STBI_ONLY_PSD +// STBI_ONLY_TGA +// STBI_ONLY_GIF +// STBI_ONLY_HDR +// STBI_ONLY_PIC +// STBI_ONLY_PNM (.ppm and .pgm) +// +// - If you use STBI_NO_PNG (or _ONLY_ without PNG), and you still +// want the zlib decoder to be available, #define STBI_SUPPORT_ZLIB +// +// - If you define STBI_MAX_DIMENSIONS, stb_image will reject images greater +// than that size (in either width or height) without further processing. +// This is to let programs in the wild set an upper bound to prevent +// denial-of-service attacks on untrusted data, as one could generate a +// valid image of gigantic dimensions and force stb_image to allocate a +// huge block of memory and spend disproportionate time decoding it. By +// default this is set to (1 << 24), which is 16777216, but that's still +// very big. + +#ifndef STBI_NO_STDIO +#include +#endif // STBI_NO_STDIO + +#define STBI_VERSION 1 + +enum +{ + STBI_default = 0, // only used for desired_channels + + STBI_grey = 1, + STBI_grey_alpha = 2, + STBI_rgb = 3, + STBI_rgb_alpha = 4 +}; + +#include +typedef unsigned char stbi_uc; +typedef unsigned short stbi_us; + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef STBIDEF +#ifdef STB_IMAGE_STATIC +#define STBIDEF static +#else +#define STBIDEF extern +#endif +#endif + +////////////////////////////////////////////////////////////////////////////// +// +// PRIMARY API - works on images of any type +// + +// +// load image by filename, open file, or memory buffer +// + +typedef struct +{ + int (*read) (void *user,char *data,int size); // fill 'data' with 'size' bytes. return number of bytes actually read + void (*skip) (void *user,int n); // skip the next 'n' bytes, or 'unget' the last -n bytes if negative + int (*eof) (void *user); // returns nonzero if we are at end of file/data +} stbi_io_callbacks; + +//////////////////////////////////// +// +// 8-bits-per-channel interface +// + +STBIDEF stbi_uc *stbi_load_from_memory (stbi_uc const *buffer, int len , int *x, int *y, int *channels_in_file, int desired_channels); +STBIDEF stbi_uc *stbi_load_from_callbacks(stbi_io_callbacks const *clbk , void *user, int *x, int *y, int *channels_in_file, int desired_channels); + +#ifndef STBI_NO_STDIO +STBIDEF stbi_uc *stbi_load (char const *filename, int *x, int *y, int *channels_in_file, int desired_channels); +STBIDEF stbi_uc *stbi_load_from_file (FILE *f, int *x, int *y, int *channels_in_file, int desired_channels); +// for stbi_load_from_file, file pointer is left pointing immediately after image +#endif + +#ifndef STBI_NO_GIF +STBIDEF stbi_uc *stbi_load_gif_from_memory(stbi_uc const *buffer, int len, int **delays, int *x, int *y, int *z, int *comp, int req_comp); +#endif + +#ifdef STBI_WINDOWS_UTF8 +STBIDEF int stbi_convert_wchar_to_utf8(char *buffer, size_t bufferlen, const wchar_t* input); +#endif + +//////////////////////////////////// +// +// 16-bits-per-channel interface +// + +STBIDEF stbi_us *stbi_load_16_from_memory (stbi_uc const *buffer, int len, int *x, int *y, int *channels_in_file, int desired_channels); +STBIDEF stbi_us *stbi_load_16_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *channels_in_file, int desired_channels); + +#ifndef STBI_NO_STDIO +STBIDEF stbi_us *stbi_load_16 (char const *filename, int *x, int *y, int *channels_in_file, int desired_channels); +STBIDEF stbi_us *stbi_load_from_file_16(FILE *f, int *x, int *y, int *channels_in_file, int desired_channels); +#endif + +//////////////////////////////////// +// +// float-per-channel interface +// +#ifndef STBI_NO_LINEAR + STBIDEF float *stbi_loadf_from_memory (stbi_uc const *buffer, int len, int *x, int *y, int *channels_in_file, int desired_channels); + STBIDEF float *stbi_loadf_from_callbacks (stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *channels_in_file, int desired_channels); + + #ifndef STBI_NO_STDIO + STBIDEF float *stbi_loadf (char const *filename, int *x, int *y, int *channels_in_file, int desired_channels); + STBIDEF float *stbi_loadf_from_file (FILE *f, int *x, int *y, int *channels_in_file, int desired_channels); + #endif +#endif + +#ifndef STBI_NO_HDR + STBIDEF void stbi_hdr_to_ldr_gamma(float gamma); + STBIDEF void stbi_hdr_to_ldr_scale(float scale); +#endif // STBI_NO_HDR + +#ifndef STBI_NO_LINEAR + STBIDEF void stbi_ldr_to_hdr_gamma(float gamma); + STBIDEF void stbi_ldr_to_hdr_scale(float scale); +#endif // STBI_NO_LINEAR + +// stbi_is_hdr is always defined, but always returns false if STBI_NO_HDR +STBIDEF int stbi_is_hdr_from_callbacks(stbi_io_callbacks const *clbk, void *user); +STBIDEF int stbi_is_hdr_from_memory(stbi_uc const *buffer, int len); +#ifndef STBI_NO_STDIO +STBIDEF int stbi_is_hdr (char const *filename); +STBIDEF int stbi_is_hdr_from_file(FILE *f); +#endif // STBI_NO_STDIO + + +// get a VERY brief reason for failure +// on most compilers (and ALL modern mainstream compilers) this is threadsafe +STBIDEF const char *stbi_failure_reason (void); + +// free the loaded image -- this is just free() +STBIDEF void stbi_image_free (void *retval_from_stbi_load); + +// get image dimensions & components without fully decoding +STBIDEF int stbi_info_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *comp); +STBIDEF int stbi_info_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *comp); +STBIDEF int stbi_is_16_bit_from_memory(stbi_uc const *buffer, int len); +STBIDEF int stbi_is_16_bit_from_callbacks(stbi_io_callbacks const *clbk, void *user); + +#ifndef STBI_NO_STDIO +STBIDEF int stbi_info (char const *filename, int *x, int *y, int *comp); +STBIDEF int stbi_info_from_file (FILE *f, int *x, int *y, int *comp); +STBIDEF int stbi_is_16_bit (char const *filename); +STBIDEF int stbi_is_16_bit_from_file(FILE *f); +#endif + + + +// for image formats that explicitly notate that they have premultiplied alpha, +// we just return the colors as stored in the file. set this flag to force +// unpremultiplication. results are undefined if the unpremultiply overflow. +STBIDEF void stbi_set_unpremultiply_on_load(int flag_true_if_should_unpremultiply); + +// indicate whether we should process iphone images back to canonical format, +// or just pass them through "as-is" +STBIDEF void stbi_convert_iphone_png_to_rgb(int flag_true_if_should_convert); + +// flip the image vertically, so the first pixel in the output array is the bottom left +STBIDEF void stbi_set_flip_vertically_on_load(int flag_true_if_should_flip); + +// as above, but only applies to images loaded on the thread that calls the function +// this function is only available if your compiler supports thread-local variables; +// calling it will fail to link if your compiler doesn't +STBIDEF void stbi_set_unpremultiply_on_load_thread(int flag_true_if_should_unpremultiply); +STBIDEF void stbi_convert_iphone_png_to_rgb_thread(int flag_true_if_should_convert); +STBIDEF void stbi_set_flip_vertically_on_load_thread(int flag_true_if_should_flip); + +// ZLIB client - used by PNG, available for other purposes + +STBIDEF char *stbi_zlib_decode_malloc_guesssize(const char *buffer, int len, int initial_size, int *outlen); +STBIDEF char *stbi_zlib_decode_malloc_guesssize_headerflag(const char *buffer, int len, int initial_size, int *outlen, int parse_header); +STBIDEF char *stbi_zlib_decode_malloc(const char *buffer, int len, int *outlen); +STBIDEF int stbi_zlib_decode_buffer(char *obuffer, int olen, const char *ibuffer, int ilen); + +STBIDEF char *stbi_zlib_decode_noheader_malloc(const char *buffer, int len, int *outlen); +STBIDEF int stbi_zlib_decode_noheader_buffer(char *obuffer, int olen, const char *ibuffer, int ilen); + + +#ifdef __cplusplus +} +#endif + +// +// +//// end header file ///////////////////////////////////////////////////// +#endif // STBI_INCLUDE_STB_IMAGE_H + +#ifdef STB_IMAGE_IMPLEMENTATION + +#if defined(STBI_ONLY_JPEG) || defined(STBI_ONLY_PNG) || defined(STBI_ONLY_BMP) \ + || defined(STBI_ONLY_TGA) || defined(STBI_ONLY_GIF) || defined(STBI_ONLY_PSD) \ + || defined(STBI_ONLY_HDR) || defined(STBI_ONLY_PIC) || defined(STBI_ONLY_PNM) \ + || defined(STBI_ONLY_ZLIB) + #ifndef STBI_ONLY_JPEG + #define STBI_NO_JPEG + #endif + #ifndef STBI_ONLY_PNG + #define STBI_NO_PNG + #endif + #ifndef STBI_ONLY_BMP + #define STBI_NO_BMP + #endif + #ifndef STBI_ONLY_PSD + #define STBI_NO_PSD + #endif + #ifndef STBI_ONLY_TGA + #define STBI_NO_TGA + #endif + #ifndef STBI_ONLY_GIF + #define STBI_NO_GIF + #endif + #ifndef STBI_ONLY_HDR + #define STBI_NO_HDR + #endif + #ifndef STBI_ONLY_PIC + #define STBI_NO_PIC + #endif + #ifndef STBI_ONLY_PNM + #define STBI_NO_PNM + #endif +#endif + +#if defined(STBI_NO_PNG) && !defined(STBI_SUPPORT_ZLIB) && !defined(STBI_NO_ZLIB) +#define STBI_NO_ZLIB +#endif + + +#include +#include // ptrdiff_t on osx +#include +#include +#include + +#if !defined(STBI_NO_LINEAR) || !defined(STBI_NO_HDR) +#include // ldexp, pow +#endif + +#ifndef STBI_NO_STDIO +#include +#endif + +#ifndef STBI_ASSERT +#include +#define STBI_ASSERT(x) assert(x) +#endif + +#ifdef __cplusplus +#define STBI_EXTERN extern "C" +#else +#define STBI_EXTERN extern +#endif + + +#ifndef _MSC_VER + #ifdef __cplusplus + #define stbi_inline inline + #else + #define stbi_inline + #endif +#else + #define stbi_inline __forceinline +#endif + +#ifndef STBI_NO_THREAD_LOCALS + #if defined(__cplusplus) && __cplusplus >= 201103L + #define STBI_THREAD_LOCAL thread_local + #elif defined(__GNUC__) && __GNUC__ < 5 + #define STBI_THREAD_LOCAL __thread + #elif defined(_MSC_VER) + #define STBI_THREAD_LOCAL __declspec(thread) + #elif defined (__STDC_VERSION__) && __STDC_VERSION__ >= 201112L && !defined(__STDC_NO_THREADS__) + #define STBI_THREAD_LOCAL _Thread_local + #endif + + #ifndef STBI_THREAD_LOCAL + #if defined(__GNUC__) + #define STBI_THREAD_LOCAL __thread + #endif + #endif +#endif + +#if defined(_MSC_VER) || defined(__SYMBIAN32__) +typedef unsigned short stbi__uint16; +typedef signed short stbi__int16; +typedef unsigned int stbi__uint32; +typedef signed int stbi__int32; +#else +#include +typedef uint16_t stbi__uint16; +typedef int16_t stbi__int16; +typedef uint32_t stbi__uint32; +typedef int32_t stbi__int32; +#endif + +// should produce compiler error if size is wrong +typedef unsigned char validate_uint32[sizeof(stbi__uint32)==4 ? 1 : -1]; + +#ifdef _MSC_VER +#define STBI_NOTUSED(v) (void)(v) +#else +#define STBI_NOTUSED(v) (void)sizeof(v) +#endif + +#ifdef _MSC_VER +#define STBI_HAS_LROTL +#endif + +#ifdef STBI_HAS_LROTL + #define stbi_lrot(x,y) _lrotl(x,y) +#else + #define stbi_lrot(x,y) (((x) << (y)) | ((x) >> (-(y) & 31))) +#endif + +#if defined(STBI_MALLOC) && defined(STBI_FREE) && (defined(STBI_REALLOC) || defined(STBI_REALLOC_SIZED)) +// ok +#elif !defined(STBI_MALLOC) && !defined(STBI_FREE) && !defined(STBI_REALLOC) && !defined(STBI_REALLOC_SIZED) +// ok +#else +#error "Must define all or none of STBI_MALLOC, STBI_FREE, and STBI_REALLOC (or STBI_REALLOC_SIZED)." +#endif + +#ifndef STBI_MALLOC +#define STBI_MALLOC(sz) malloc(sz) +#define STBI_REALLOC(p,newsz) realloc(p,newsz) +#define STBI_FREE(p) free(p) +#endif + +#ifndef STBI_REALLOC_SIZED +#define STBI_REALLOC_SIZED(p,oldsz,newsz) STBI_REALLOC(p,newsz) +#endif + +// x86/x64 detection +#if defined(__x86_64__) || defined(_M_X64) +#define STBI__X64_TARGET +#elif defined(__i386) || defined(_M_IX86) +#define STBI__X86_TARGET +#endif + +#if defined(__GNUC__) && defined(STBI__X86_TARGET) && !defined(__SSE2__) && !defined(STBI_NO_SIMD) +// gcc doesn't support sse2 intrinsics unless you compile with -msse2, +// which in turn means it gets to use SSE2 everywhere. This is unfortunate, +// but previous attempts to provide the SSE2 functions with runtime +// detection caused numerous issues. The way architecture extensions are +// exposed in GCC/Clang is, sadly, not really suited for one-file libs. +// New behavior: if compiled with -msse2, we use SSE2 without any +// detection; if not, we don't use it at all. +#define STBI_NO_SIMD +#endif + +#if defined(__MINGW32__) && defined(STBI__X86_TARGET) && !defined(STBI_MINGW_ENABLE_SSE2) && !defined(STBI_NO_SIMD) +// Note that __MINGW32__ doesn't actually mean 32-bit, so we have to avoid STBI__X64_TARGET +// +// 32-bit MinGW wants ESP to be 16-byte aligned, but this is not in the +// Windows ABI and VC++ as well as Windows DLLs don't maintain that invariant. +// As a result, enabling SSE2 on 32-bit MinGW is dangerous when not +// simultaneously enabling "-mstackrealign". +// +// See https://github.com/nothings/stb/issues/81 for more information. +// +// So default to no SSE2 on 32-bit MinGW. If you've read this far and added +// -mstackrealign to your build settings, feel free to #define STBI_MINGW_ENABLE_SSE2. +#define STBI_NO_SIMD +#endif + +#if !defined(STBI_NO_SIMD) && (defined(STBI__X86_TARGET) || defined(STBI__X64_TARGET)) +#define STBI_SSE2 +#include + +#ifdef _MSC_VER + +#if _MSC_VER >= 1400 // not VC6 +#include // __cpuid +static int stbi__cpuid3(void) +{ + int info[4]; + __cpuid(info,1); + return info[3]; +} +#else +static int stbi__cpuid3(void) +{ + int res; + __asm { + mov eax,1 + cpuid + mov res,edx + } + return res; +} +#endif + +#define STBI_SIMD_ALIGN(type, name) __declspec(align(16)) type name + +#if !defined(STBI_NO_JPEG) && defined(STBI_SSE2) +static int stbi__sse2_available(void) +{ + int info3 = stbi__cpuid3(); + return ((info3 >> 26) & 1) != 0; +} +#endif + +#else // assume GCC-style if not VC++ +#define STBI_SIMD_ALIGN(type, name) type name __attribute__((aligned(16))) + +#if !defined(STBI_NO_JPEG) && defined(STBI_SSE2) +static int stbi__sse2_available(void) +{ + // If we're even attempting to compile this on GCC/Clang, that means + // -msse2 is on, which means the compiler is allowed to use SSE2 + // instructions at will, and so are we. + return 1; +} +#endif + +#endif +#endif + +// ARM NEON +#if defined(STBI_NO_SIMD) && defined(STBI_NEON) +#undef STBI_NEON +#endif + +#ifdef STBI_NEON +#include +#ifdef _MSC_VER +#define STBI_SIMD_ALIGN(type, name) __declspec(align(16)) type name +#else +#define STBI_SIMD_ALIGN(type, name) type name __attribute__((aligned(16))) +#endif +#endif + +#ifndef STBI_SIMD_ALIGN +#define STBI_SIMD_ALIGN(type, name) type name +#endif + +#ifndef STBI_MAX_DIMENSIONS +#define STBI_MAX_DIMENSIONS (1 << 24) +#endif + +/////////////////////////////////////////////// +// +// stbi__context struct and start_xxx functions + +// stbi__context structure is our basic context used by all images, so it +// contains all the IO context, plus some basic image information +typedef struct +{ + stbi__uint32 img_x, img_y; + int img_n, img_out_n; + + stbi_io_callbacks io; + void *io_user_data; + + int read_from_callbacks; + int buflen; + stbi_uc buffer_start[128]; + int callback_already_read; + + stbi_uc *img_buffer, *img_buffer_end; + stbi_uc *img_buffer_original, *img_buffer_original_end; +} stbi__context; + + +static void stbi__refill_buffer(stbi__context *s); + +// initialize a memory-decode context +static void stbi__start_mem(stbi__context *s, stbi_uc const *buffer, int len) +{ + s->io.read = NULL; + s->read_from_callbacks = 0; + s->callback_already_read = 0; + s->img_buffer = s->img_buffer_original = (stbi_uc *) buffer; + s->img_buffer_end = s->img_buffer_original_end = (stbi_uc *) buffer+len; +} + +// initialize a callback-based context +static void stbi__start_callbacks(stbi__context *s, stbi_io_callbacks *c, void *user) +{ + s->io = *c; + s->io_user_data = user; + s->buflen = sizeof(s->buffer_start); + s->read_from_callbacks = 1; + s->callback_already_read = 0; + s->img_buffer = s->img_buffer_original = s->buffer_start; + stbi__refill_buffer(s); + s->img_buffer_original_end = s->img_buffer_end; +} + +#ifndef STBI_NO_STDIO + +static int stbi__stdio_read(void *user, char *data, int size) +{ + return (int) fread(data,1,size,(FILE*) user); +} + +static void stbi__stdio_skip(void *user, int n) +{ + int ch; + fseek((FILE*) user, n, SEEK_CUR); + ch = fgetc((FILE*) user); /* have to read a byte to reset feof()'s flag */ + if (ch != EOF) { + ungetc(ch, (FILE *) user); /* push byte back onto stream if valid. */ + } +} + +static int stbi__stdio_eof(void *user) +{ + return feof((FILE*) user) || ferror((FILE *) user); +} + +static stbi_io_callbacks stbi__stdio_callbacks = +{ + stbi__stdio_read, + stbi__stdio_skip, + stbi__stdio_eof, +}; + +static void stbi__start_file(stbi__context *s, FILE *f) +{ + stbi__start_callbacks(s, &stbi__stdio_callbacks, (void *) f); +} + +//static void stop_file(stbi__context *s) { } + +#endif // !STBI_NO_STDIO + +static void stbi__rewind(stbi__context *s) +{ + // conceptually rewind SHOULD rewind to the beginning of the stream, + // but we just rewind to the beginning of the initial buffer, because + // we only use it after doing 'test', which only ever looks at at most 92 bytes + s->img_buffer = s->img_buffer_original; + s->img_buffer_end = s->img_buffer_original_end; +} + +enum +{ + STBI_ORDER_RGB, + STBI_ORDER_BGR +}; + +typedef struct +{ + int bits_per_channel; + int num_channels; + int channel_order; +} stbi__result_info; + +#ifndef STBI_NO_JPEG +static int stbi__jpeg_test(stbi__context *s); +static void *stbi__jpeg_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); +static int stbi__jpeg_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_PNG +static int stbi__png_test(stbi__context *s); +static void *stbi__png_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); +static int stbi__png_info(stbi__context *s, int *x, int *y, int *comp); +static int stbi__png_is16(stbi__context *s); +#endif + +#ifndef STBI_NO_BMP +static int stbi__bmp_test(stbi__context *s); +static void *stbi__bmp_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); +static int stbi__bmp_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_TGA +static int stbi__tga_test(stbi__context *s); +static void *stbi__tga_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); +static int stbi__tga_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_PSD +static int stbi__psd_test(stbi__context *s); +static void *stbi__psd_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri, int bpc); +static int stbi__psd_info(stbi__context *s, int *x, int *y, int *comp); +static int stbi__psd_is16(stbi__context *s); +#endif + +#ifndef STBI_NO_HDR +static int stbi__hdr_test(stbi__context *s); +static float *stbi__hdr_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); +static int stbi__hdr_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_PIC +static int stbi__pic_test(stbi__context *s); +static void *stbi__pic_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); +static int stbi__pic_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_GIF +static int stbi__gif_test(stbi__context *s); +static void *stbi__gif_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); +static void *stbi__load_gif_main(stbi__context *s, int **delays, int *x, int *y, int *z, int *comp, int req_comp); +static int stbi__gif_info(stbi__context *s, int *x, int *y, int *comp); +#endif + +#ifndef STBI_NO_PNM +static int stbi__pnm_test(stbi__context *s); +static void *stbi__pnm_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); +static int stbi__pnm_info(stbi__context *s, int *x, int *y, int *comp); +static int stbi__pnm_is16(stbi__context *s); +#endif + +static +#ifdef STBI_THREAD_LOCAL +STBI_THREAD_LOCAL +#endif +const char *stbi__g_failure_reason; + +STBIDEF const char *stbi_failure_reason(void) +{ + return stbi__g_failure_reason; +} + +#ifndef STBI_NO_FAILURE_STRINGS +static int stbi__err(const char *str) +{ + stbi__g_failure_reason = str; + return 0; +} +#endif + +static void *stbi__malloc(size_t size) +{ + return STBI_MALLOC(size); +} + +// stb_image uses ints pervasively, including for offset calculations. +// therefore the largest decoded image size we can support with the +// current code, even on 64-bit targets, is INT_MAX. this is not a +// significant limitation for the intended use case. +// +// we do, however, need to make sure our size calculations don't +// overflow. hence a few helper functions for size calculations that +// multiply integers together, making sure that they're non-negative +// and no overflow occurs. + +// return 1 if the sum is valid, 0 on overflow. +// negative terms are considered invalid. +static int stbi__addsizes_valid(int a, int b) +{ + if (b < 0) return 0; + // now 0 <= b <= INT_MAX, hence also + // 0 <= INT_MAX - b <= INTMAX. + // And "a + b <= INT_MAX" (which might overflow) is the + // same as a <= INT_MAX - b (no overflow) + return a <= INT_MAX - b; +} + +// returns 1 if the product is valid, 0 on overflow. +// negative factors are considered invalid. +static int stbi__mul2sizes_valid(int a, int b) +{ + if (a < 0 || b < 0) return 0; + if (b == 0) return 1; // mul-by-0 is always safe + // portable way to check for no overflows in a*b + return a <= INT_MAX/b; +} + +#if !defined(STBI_NO_JPEG) || !defined(STBI_NO_PNG) || !defined(STBI_NO_TGA) || !defined(STBI_NO_HDR) +// returns 1 if "a*b + add" has no negative terms/factors and doesn't overflow +static int stbi__mad2sizes_valid(int a, int b, int add) +{ + return stbi__mul2sizes_valid(a, b) && stbi__addsizes_valid(a*b, add); +} +#endif + +// returns 1 if "a*b*c + add" has no negative terms/factors and doesn't overflow +static int stbi__mad3sizes_valid(int a, int b, int c, int add) +{ + return stbi__mul2sizes_valid(a, b) && stbi__mul2sizes_valid(a*b, c) && + stbi__addsizes_valid(a*b*c, add); +} + +// returns 1 if "a*b*c*d + add" has no negative terms/factors and doesn't overflow +#if !defined(STBI_NO_LINEAR) || !defined(STBI_NO_HDR) || !defined(STBI_NO_PNM) +static int stbi__mad4sizes_valid(int a, int b, int c, int d, int add) +{ + return stbi__mul2sizes_valid(a, b) && stbi__mul2sizes_valid(a*b, c) && + stbi__mul2sizes_valid(a*b*c, d) && stbi__addsizes_valid(a*b*c*d, add); +} +#endif + +#if !defined(STBI_NO_JPEG) || !defined(STBI_NO_PNG) || !defined(STBI_NO_TGA) || !defined(STBI_NO_HDR) +// mallocs with size overflow checking +static void *stbi__malloc_mad2(int a, int b, int add) +{ + if (!stbi__mad2sizes_valid(a, b, add)) return NULL; + return stbi__malloc(a*b + add); +} +#endif + +static void *stbi__malloc_mad3(int a, int b, int c, int add) +{ + if (!stbi__mad3sizes_valid(a, b, c, add)) return NULL; + return stbi__malloc(a*b*c + add); +} + +#if !defined(STBI_NO_LINEAR) || !defined(STBI_NO_HDR) || !defined(STBI_NO_PNM) +static void *stbi__malloc_mad4(int a, int b, int c, int d, int add) +{ + if (!stbi__mad4sizes_valid(a, b, c, d, add)) return NULL; + return stbi__malloc(a*b*c*d + add); +} +#endif + +// returns 1 if the sum of two signed ints is valid (between -2^31 and 2^31-1 inclusive), 0 on overflow. +static int stbi__addints_valid(int a, int b) +{ + if ((a >= 0) != (b >= 0)) return 1; // a and b have different signs, so no overflow + if (a < 0 && b < 0) return a >= INT_MIN - b; // same as a + b >= INT_MIN; INT_MIN - b cannot overflow since b < 0. + return a <= INT_MAX - b; +} + +// returns 1 if the product of two ints fits in a signed short, 0 on overflow. +static int stbi__mul2shorts_valid(int a, int b) +{ + if (b == 0 || b == -1) return 1; // multiplication by 0 is always 0; check for -1 so SHRT_MIN/b doesn't overflow + if ((a >= 0) == (b >= 0)) return a <= SHRT_MAX/b; // product is positive, so similar to mul2sizes_valid + if (b < 0) return a <= SHRT_MIN / b; // same as a * b >= SHRT_MIN + return a >= SHRT_MIN / b; +} + +// stbi__err - error +// stbi__errpf - error returning pointer to float +// stbi__errpuc - error returning pointer to unsigned char + +#ifdef STBI_NO_FAILURE_STRINGS + #define stbi__err(x,y) 0 +#elif defined(STBI_FAILURE_USERMSG) + #define stbi__err(x,y) stbi__err(y) +#else + #define stbi__err(x,y) stbi__err(x) +#endif + +#define stbi__errpf(x,y) ((float *)(size_t) (stbi__err(x,y)?NULL:NULL)) +#define stbi__errpuc(x,y) ((unsigned char *)(size_t) (stbi__err(x,y)?NULL:NULL)) + +STBIDEF void stbi_image_free(void *retval_from_stbi_load) +{ + STBI_FREE(retval_from_stbi_load); +} + +#ifndef STBI_NO_LINEAR +static float *stbi__ldr_to_hdr(stbi_uc *data, int x, int y, int comp); +#endif + +#ifndef STBI_NO_HDR +static stbi_uc *stbi__hdr_to_ldr(float *data, int x, int y, int comp); +#endif + +static int stbi__vertically_flip_on_load_global = 0; + +STBIDEF void stbi_set_flip_vertically_on_load(int flag_true_if_should_flip) +{ + stbi__vertically_flip_on_load_global = flag_true_if_should_flip; +} + +#ifndef STBI_THREAD_LOCAL +#define stbi__vertically_flip_on_load stbi__vertically_flip_on_load_global +#else +static STBI_THREAD_LOCAL int stbi__vertically_flip_on_load_local, stbi__vertically_flip_on_load_set; + +STBIDEF void stbi_set_flip_vertically_on_load_thread(int flag_true_if_should_flip) +{ + stbi__vertically_flip_on_load_local = flag_true_if_should_flip; + stbi__vertically_flip_on_load_set = 1; +} + +#define stbi__vertically_flip_on_load (stbi__vertically_flip_on_load_set \ + ? stbi__vertically_flip_on_load_local \ + : stbi__vertically_flip_on_load_global) +#endif // STBI_THREAD_LOCAL + +static void *stbi__load_main(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri, int bpc) +{ + memset(ri, 0, sizeof(*ri)); // make sure it's initialized if we add new fields + ri->bits_per_channel = 8; // default is 8 so most paths don't have to be changed + ri->channel_order = STBI_ORDER_RGB; // all current input & output are this, but this is here so we can add BGR order + ri->num_channels = 0; + + // test the formats with a very explicit header first (at least a FOURCC + // or distinctive magic number first) + #ifndef STBI_NO_PNG + if (stbi__png_test(s)) return stbi__png_load(s,x,y,comp,req_comp, ri); + #endif + #ifndef STBI_NO_BMP + if (stbi__bmp_test(s)) return stbi__bmp_load(s,x,y,comp,req_comp, ri); + #endif + #ifndef STBI_NO_GIF + if (stbi__gif_test(s)) return stbi__gif_load(s,x,y,comp,req_comp, ri); + #endif + #ifndef STBI_NO_PSD + if (stbi__psd_test(s)) return stbi__psd_load(s,x,y,comp,req_comp, ri, bpc); + #else + STBI_NOTUSED(bpc); + #endif + #ifndef STBI_NO_PIC + if (stbi__pic_test(s)) return stbi__pic_load(s,x,y,comp,req_comp, ri); + #endif + + // then the formats that can end up attempting to load with just 1 or 2 + // bytes matching expectations; these are prone to false positives, so + // try them later + #ifndef STBI_NO_JPEG + if (stbi__jpeg_test(s)) return stbi__jpeg_load(s,x,y,comp,req_comp, ri); + #endif + #ifndef STBI_NO_PNM + if (stbi__pnm_test(s)) return stbi__pnm_load(s,x,y,comp,req_comp, ri); + #endif + + #ifndef STBI_NO_HDR + if (stbi__hdr_test(s)) { + float *hdr = stbi__hdr_load(s, x,y,comp,req_comp, ri); + return stbi__hdr_to_ldr(hdr, *x, *y, req_comp ? req_comp : *comp); + } + #endif + + #ifndef STBI_NO_TGA + // test tga last because it's a crappy test! + if (stbi__tga_test(s)) + return stbi__tga_load(s,x,y,comp,req_comp, ri); + #endif + + return stbi__errpuc("unknown image type", "Image not of any known type, or corrupt"); +} + +static stbi_uc *stbi__convert_16_to_8(stbi__uint16 *orig, int w, int h, int channels) +{ + int i; + int img_len = w * h * channels; + stbi_uc *reduced; + + reduced = (stbi_uc *) stbi__malloc(img_len); + if (reduced == NULL) return stbi__errpuc("outofmem", "Out of memory"); + + for (i = 0; i < img_len; ++i) + reduced[i] = (stbi_uc)((orig[i] >> 8) & 0xFF); // top half of each byte is sufficient approx of 16->8 bit scaling + + STBI_FREE(orig); + return reduced; +} + +static stbi__uint16 *stbi__convert_8_to_16(stbi_uc *orig, int w, int h, int channels) +{ + int i; + int img_len = w * h * channels; + stbi__uint16 *enlarged; + + enlarged = (stbi__uint16 *) stbi__malloc(img_len*2); + if (enlarged == NULL) return (stbi__uint16 *) stbi__errpuc("outofmem", "Out of memory"); + + for (i = 0; i < img_len; ++i) + enlarged[i] = (stbi__uint16)((orig[i] << 8) + orig[i]); // replicate to high and low byte, maps 0->0, 255->0xffff + + STBI_FREE(orig); + return enlarged; +} + +static void stbi__vertical_flip(void *image, int w, int h, int bytes_per_pixel) +{ + int row; + size_t bytes_per_row = (size_t)w * bytes_per_pixel; + stbi_uc temp[2048]; + stbi_uc *bytes = (stbi_uc *)image; + + for (row = 0; row < (h>>1); row++) { + stbi_uc *row0 = bytes + row*bytes_per_row; + stbi_uc *row1 = bytes + (h - row - 1)*bytes_per_row; + // swap row0 with row1 + size_t bytes_left = bytes_per_row; + while (bytes_left) { + size_t bytes_copy = (bytes_left < sizeof(temp)) ? bytes_left : sizeof(temp); + memcpy(temp, row0, bytes_copy); + memcpy(row0, row1, bytes_copy); + memcpy(row1, temp, bytes_copy); + row0 += bytes_copy; + row1 += bytes_copy; + bytes_left -= bytes_copy; + } + } +} + +#ifndef STBI_NO_GIF +static void stbi__vertical_flip_slices(void *image, int w, int h, int z, int bytes_per_pixel) +{ + int slice; + int slice_size = w * h * bytes_per_pixel; + + stbi_uc *bytes = (stbi_uc *)image; + for (slice = 0; slice < z; ++slice) { + stbi__vertical_flip(bytes, w, h, bytes_per_pixel); + bytes += slice_size; + } +} +#endif + +static unsigned char *stbi__load_and_postprocess_8bit(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + stbi__result_info ri; + void *result = stbi__load_main(s, x, y, comp, req_comp, &ri, 8); + + if (result == NULL) + return NULL; + + // it is the responsibility of the loaders to make sure we get either 8 or 16 bit. + STBI_ASSERT(ri.bits_per_channel == 8 || ri.bits_per_channel == 16); + + if (ri.bits_per_channel != 8) { + result = stbi__convert_16_to_8((stbi__uint16 *) result, *x, *y, req_comp == 0 ? *comp : req_comp); + ri.bits_per_channel = 8; + } + + // @TODO: move stbi__convert_format to here + + if (stbi__vertically_flip_on_load) { + int channels = req_comp ? req_comp : *comp; + stbi__vertical_flip(result, *x, *y, channels * sizeof(stbi_uc)); + } + + return (unsigned char *) result; +} + +static stbi__uint16 *stbi__load_and_postprocess_16bit(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + stbi__result_info ri; + void *result = stbi__load_main(s, x, y, comp, req_comp, &ri, 16); + + if (result == NULL) + return NULL; + + // it is the responsibility of the loaders to make sure we get either 8 or 16 bit. + STBI_ASSERT(ri.bits_per_channel == 8 || ri.bits_per_channel == 16); + + if (ri.bits_per_channel != 16) { + result = stbi__convert_8_to_16((stbi_uc *) result, *x, *y, req_comp == 0 ? *comp : req_comp); + ri.bits_per_channel = 16; + } + + // @TODO: move stbi__convert_format16 to here + // @TODO: special case RGB-to-Y (and RGBA-to-YA) for 8-bit-to-16-bit case to keep more precision + + if (stbi__vertically_flip_on_load) { + int channels = req_comp ? req_comp : *comp; + stbi__vertical_flip(result, *x, *y, channels * sizeof(stbi__uint16)); + } + + return (stbi__uint16 *) result; +} + +#if !defined(STBI_NO_HDR) && !defined(STBI_NO_LINEAR) +static void stbi__float_postprocess(float *result, int *x, int *y, int *comp, int req_comp) +{ + if (stbi__vertically_flip_on_load && result != NULL) { + int channels = req_comp ? req_comp : *comp; + stbi__vertical_flip(result, *x, *y, channels * sizeof(float)); + } +} +#endif + +#ifndef STBI_NO_STDIO + +#if defined(_WIN32) && defined(STBI_WINDOWS_UTF8) +STBI_EXTERN __declspec(dllimport) int __stdcall MultiByteToWideChar(unsigned int cp, unsigned long flags, const char *str, int cbmb, wchar_t *widestr, int cchwide); +STBI_EXTERN __declspec(dllimport) int __stdcall WideCharToMultiByte(unsigned int cp, unsigned long flags, const wchar_t *widestr, int cchwide, char *str, int cbmb, const char *defchar, int *used_default); +#endif + +#if defined(_WIN32) && defined(STBI_WINDOWS_UTF8) +STBIDEF int stbi_convert_wchar_to_utf8(char *buffer, size_t bufferlen, const wchar_t* input) +{ + return WideCharToMultiByte(65001 /* UTF8 */, 0, input, -1, buffer, (int) bufferlen, NULL, NULL); +} +#endif + +static FILE *stbi__fopen(char const *filename, char const *mode) +{ + FILE *f; +#if defined(_WIN32) && defined(STBI_WINDOWS_UTF8) + wchar_t wMode[64]; + wchar_t wFilename[1024]; + if (0 == MultiByteToWideChar(65001 /* UTF8 */, 0, filename, -1, wFilename, sizeof(wFilename)/sizeof(*wFilename))) + return 0; + + if (0 == MultiByteToWideChar(65001 /* UTF8 */, 0, mode, -1, wMode, sizeof(wMode)/sizeof(*wMode))) + return 0; + +#if defined(_MSC_VER) && _MSC_VER >= 1400 + if (0 != _wfopen_s(&f, wFilename, wMode)) + f = 0; +#else + f = _wfopen(wFilename, wMode); +#endif + +#elif defined(_MSC_VER) && _MSC_VER >= 1400 + if (0 != fopen_s(&f, filename, mode)) + f=0; +#else + f = fopen(filename, mode); +#endif + return f; +} + + +STBIDEF stbi_uc *stbi_load(char const *filename, int *x, int *y, int *comp, int req_comp) +{ + FILE *f = stbi__fopen(filename, "rb"); + unsigned char *result; + if (!f) return stbi__errpuc("can't fopen", "Unable to open file"); + result = stbi_load_from_file(f,x,y,comp,req_comp); + fclose(f); + return result; +} + +STBIDEF stbi_uc *stbi_load_from_file(FILE *f, int *x, int *y, int *comp, int req_comp) +{ + unsigned char *result; + stbi__context s; + stbi__start_file(&s,f); + result = stbi__load_and_postprocess_8bit(&s,x,y,comp,req_comp); + if (result) { + // need to 'unget' all the characters in the IO buffer + fseek(f, - (int) (s.img_buffer_end - s.img_buffer), SEEK_CUR); + } + return result; +} + +STBIDEF stbi__uint16 *stbi_load_from_file_16(FILE *f, int *x, int *y, int *comp, int req_comp) +{ + stbi__uint16 *result; + stbi__context s; + stbi__start_file(&s,f); + result = stbi__load_and_postprocess_16bit(&s,x,y,comp,req_comp); + if (result) { + // need to 'unget' all the characters in the IO buffer + fseek(f, - (int) (s.img_buffer_end - s.img_buffer), SEEK_CUR); + } + return result; +} + +STBIDEF stbi_us *stbi_load_16(char const *filename, int *x, int *y, int *comp, int req_comp) +{ + FILE *f = stbi__fopen(filename, "rb"); + stbi__uint16 *result; + if (!f) return (stbi_us *) stbi__errpuc("can't fopen", "Unable to open file"); + result = stbi_load_from_file_16(f,x,y,comp,req_comp); + fclose(f); + return result; +} + + +#endif //!STBI_NO_STDIO + +STBIDEF stbi_us *stbi_load_16_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *channels_in_file, int desired_channels) +{ + stbi__context s; + stbi__start_mem(&s,buffer,len); + return stbi__load_and_postprocess_16bit(&s,x,y,channels_in_file,desired_channels); +} + +STBIDEF stbi_us *stbi_load_16_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *channels_in_file, int desired_channels) +{ + stbi__context s; + stbi__start_callbacks(&s, (stbi_io_callbacks *)clbk, user); + return stbi__load_and_postprocess_16bit(&s,x,y,channels_in_file,desired_channels); +} + +STBIDEF stbi_uc *stbi_load_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *comp, int req_comp) +{ + stbi__context s; + stbi__start_mem(&s,buffer,len); + return stbi__load_and_postprocess_8bit(&s,x,y,comp,req_comp); +} + +STBIDEF stbi_uc *stbi_load_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *comp, int req_comp) +{ + stbi__context s; + stbi__start_callbacks(&s, (stbi_io_callbacks *) clbk, user); + return stbi__load_and_postprocess_8bit(&s,x,y,comp,req_comp); +} + +#ifndef STBI_NO_GIF +STBIDEF stbi_uc *stbi_load_gif_from_memory(stbi_uc const *buffer, int len, int **delays, int *x, int *y, int *z, int *comp, int req_comp) +{ + unsigned char *result; + stbi__context s; + stbi__start_mem(&s,buffer,len); + + result = (unsigned char*) stbi__load_gif_main(&s, delays, x, y, z, comp, req_comp); + if (stbi__vertically_flip_on_load) { + stbi__vertical_flip_slices( result, *x, *y, *z, *comp ); + } + + return result; +} +#endif + +#ifndef STBI_NO_LINEAR +static float *stbi__loadf_main(stbi__context *s, int *x, int *y, int *comp, int req_comp) +{ + unsigned char *data; + #ifndef STBI_NO_HDR + if (stbi__hdr_test(s)) { + stbi__result_info ri; + float *hdr_data = stbi__hdr_load(s,x,y,comp,req_comp, &ri); + if (hdr_data) + stbi__float_postprocess(hdr_data,x,y,comp,req_comp); + return hdr_data; + } + #endif + data = stbi__load_and_postprocess_8bit(s, x, y, comp, req_comp); + if (data) + return stbi__ldr_to_hdr(data, *x, *y, req_comp ? req_comp : *comp); + return stbi__errpf("unknown image type", "Image not of any known type, or corrupt"); +} + +STBIDEF float *stbi_loadf_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *comp, int req_comp) +{ + stbi__context s; + stbi__start_mem(&s,buffer,len); + return stbi__loadf_main(&s,x,y,comp,req_comp); +} + +STBIDEF float *stbi_loadf_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *comp, int req_comp) +{ + stbi__context s; + stbi__start_callbacks(&s, (stbi_io_callbacks *) clbk, user); + return stbi__loadf_main(&s,x,y,comp,req_comp); +} + +#ifndef STBI_NO_STDIO +STBIDEF float *stbi_loadf(char const *filename, int *x, int *y, int *comp, int req_comp) +{ + float *result; + FILE *f = stbi__fopen(filename, "rb"); + if (!f) return stbi__errpf("can't fopen", "Unable to open file"); + result = stbi_loadf_from_file(f,x,y,comp,req_comp); + fclose(f); + return result; +} + +STBIDEF float *stbi_loadf_from_file(FILE *f, int *x, int *y, int *comp, int req_comp) +{ + stbi__context s; + stbi__start_file(&s,f); + return stbi__loadf_main(&s,x,y,comp,req_comp); +} +#endif // !STBI_NO_STDIO + +#endif // !STBI_NO_LINEAR + +// these is-hdr-or-not is defined independent of whether STBI_NO_LINEAR is +// defined, for API simplicity; if STBI_NO_LINEAR is defined, it always +// reports false! + +STBIDEF int stbi_is_hdr_from_memory(stbi_uc const *buffer, int len) +{ + #ifndef STBI_NO_HDR + stbi__context s; + stbi__start_mem(&s,buffer,len); + return stbi__hdr_test(&s); + #else + STBI_NOTUSED(buffer); + STBI_NOTUSED(len); + return 0; + #endif +} + +#ifndef STBI_NO_STDIO +STBIDEF int stbi_is_hdr (char const *filename) +{ + FILE *f = stbi__fopen(filename, "rb"); + int result=0; + if (f) { + result = stbi_is_hdr_from_file(f); + fclose(f); + } + return result; +} + +STBIDEF int stbi_is_hdr_from_file(FILE *f) +{ + #ifndef STBI_NO_HDR + long pos = ftell(f); + int res; + stbi__context s; + stbi__start_file(&s,f); + res = stbi__hdr_test(&s); + fseek(f, pos, SEEK_SET); + return res; + #else + STBI_NOTUSED(f); + return 0; + #endif +} +#endif // !STBI_NO_STDIO + +STBIDEF int stbi_is_hdr_from_callbacks(stbi_io_callbacks const *clbk, void *user) +{ + #ifndef STBI_NO_HDR + stbi__context s; + stbi__start_callbacks(&s, (stbi_io_callbacks *) clbk, user); + return stbi__hdr_test(&s); + #else + STBI_NOTUSED(clbk); + STBI_NOTUSED(user); + return 0; + #endif +} + +#ifndef STBI_NO_LINEAR +static float stbi__l2h_gamma=2.2f, stbi__l2h_scale=1.0f; + +STBIDEF void stbi_ldr_to_hdr_gamma(float gamma) { stbi__l2h_gamma = gamma; } +STBIDEF void stbi_ldr_to_hdr_scale(float scale) { stbi__l2h_scale = scale; } +#endif + +static float stbi__h2l_gamma_i=1.0f/2.2f, stbi__h2l_scale_i=1.0f; + +STBIDEF void stbi_hdr_to_ldr_gamma(float gamma) { stbi__h2l_gamma_i = 1/gamma; } +STBIDEF void stbi_hdr_to_ldr_scale(float scale) { stbi__h2l_scale_i = 1/scale; } + + +////////////////////////////////////////////////////////////////////////////// +// +// Common code used by all image loaders +// + +enum +{ + STBI__SCAN_load=0, + STBI__SCAN_type, + STBI__SCAN_header +}; + +static void stbi__refill_buffer(stbi__context *s) +{ + int n = (s->io.read)(s->io_user_data,(char*)s->buffer_start,s->buflen); + s->callback_already_read += (int) (s->img_buffer - s->img_buffer_original); + if (n == 0) { + // at end of file, treat same as if from memory, but need to handle case + // where s->img_buffer isn't pointing to safe memory, e.g. 0-byte file + s->read_from_callbacks = 0; + s->img_buffer = s->buffer_start; + s->img_buffer_end = s->buffer_start+1; + *s->img_buffer = 0; + } else { + s->img_buffer = s->buffer_start; + s->img_buffer_end = s->buffer_start + n; + } +} + +stbi_inline static stbi_uc stbi__get8(stbi__context *s) +{ + if (s->img_buffer < s->img_buffer_end) + return *s->img_buffer++; + if (s->read_from_callbacks) { + stbi__refill_buffer(s); + return *s->img_buffer++; + } + return 0; +} + +#if defined(STBI_NO_JPEG) && defined(STBI_NO_HDR) && defined(STBI_NO_PIC) && defined(STBI_NO_PNM) +// nothing +#else +stbi_inline static int stbi__at_eof(stbi__context *s) +{ + if (s->io.read) { + if (!(s->io.eof)(s->io_user_data)) return 0; + // if feof() is true, check if buffer = end + // special case: we've only got the special 0 character at the end + if (s->read_from_callbacks == 0) return 1; + } + + return s->img_buffer >= s->img_buffer_end; +} +#endif + +#if defined(STBI_NO_JPEG) && defined(STBI_NO_PNG) && defined(STBI_NO_BMP) && defined(STBI_NO_PSD) && defined(STBI_NO_TGA) && defined(STBI_NO_GIF) && defined(STBI_NO_PIC) +// nothing +#else +static void stbi__skip(stbi__context *s, int n) +{ + if (n == 0) return; // already there! + if (n < 0) { + s->img_buffer = s->img_buffer_end; + return; + } + if (s->io.read) { + int blen = (int) (s->img_buffer_end - s->img_buffer); + if (blen < n) { + s->img_buffer = s->img_buffer_end; + (s->io.skip)(s->io_user_data, n - blen); + return; + } + } + s->img_buffer += n; +} +#endif + +#if defined(STBI_NO_PNG) && defined(STBI_NO_TGA) && defined(STBI_NO_HDR) && defined(STBI_NO_PNM) +// nothing +#else +static int stbi__getn(stbi__context *s, stbi_uc *buffer, int n) +{ + if (s->io.read) { + int blen = (int) (s->img_buffer_end - s->img_buffer); + if (blen < n) { + int res, count; + + memcpy(buffer, s->img_buffer, blen); + + count = (s->io.read)(s->io_user_data, (char*) buffer + blen, n - blen); + res = (count == (n-blen)); + s->img_buffer = s->img_buffer_end; + return res; + } + } + + if (s->img_buffer+n <= s->img_buffer_end) { + memcpy(buffer, s->img_buffer, n); + s->img_buffer += n; + return 1; + } else + return 0; +} +#endif + +#if defined(STBI_NO_JPEG) && defined(STBI_NO_PNG) && defined(STBI_NO_PSD) && defined(STBI_NO_PIC) +// nothing +#else +static int stbi__get16be(stbi__context *s) +{ + int z = stbi__get8(s); + return (z << 8) + stbi__get8(s); +} +#endif + +#if defined(STBI_NO_PNG) && defined(STBI_NO_PSD) && defined(STBI_NO_PIC) +// nothing +#else +static stbi__uint32 stbi__get32be(stbi__context *s) +{ + stbi__uint32 z = stbi__get16be(s); + return (z << 16) + stbi__get16be(s); +} +#endif + +#if defined(STBI_NO_BMP) && defined(STBI_NO_TGA) && defined(STBI_NO_GIF) +// nothing +#else +static int stbi__get16le(stbi__context *s) +{ + int z = stbi__get8(s); + return z + (stbi__get8(s) << 8); +} +#endif + +#ifndef STBI_NO_BMP +static stbi__uint32 stbi__get32le(stbi__context *s) +{ + stbi__uint32 z = stbi__get16le(s); + z += (stbi__uint32)stbi__get16le(s) << 16; + return z; +} +#endif + +#define STBI__BYTECAST(x) ((stbi_uc) ((x) & 255)) // truncate int to byte without warnings + +#if defined(STBI_NO_JPEG) && defined(STBI_NO_PNG) && defined(STBI_NO_BMP) && defined(STBI_NO_PSD) && defined(STBI_NO_TGA) && defined(STBI_NO_GIF) && defined(STBI_NO_PIC) && defined(STBI_NO_PNM) +// nothing +#else +////////////////////////////////////////////////////////////////////////////// +// +// generic converter from built-in img_n to req_comp +// individual types do this automatically as much as possible (e.g. jpeg +// does all cases internally since it needs to colorspace convert anyway, +// and it never has alpha, so very few cases ). png can automatically +// interleave an alpha=255 channel, but falls back to this for other cases +// +// assume data buffer is malloced, so malloc a new one and free that one +// only failure mode is malloc failing + +static stbi_uc stbi__compute_y(int r, int g, int b) +{ + return (stbi_uc) (((r*77) + (g*150) + (29*b)) >> 8); +} +#endif + +#if defined(STBI_NO_PNG) && defined(STBI_NO_BMP) && defined(STBI_NO_PSD) && defined(STBI_NO_TGA) && defined(STBI_NO_GIF) && defined(STBI_NO_PIC) && defined(STBI_NO_PNM) +// nothing +#else +static unsigned char *stbi__convert_format(unsigned char *data, int img_n, int req_comp, unsigned int x, unsigned int y) +{ + int i,j; + unsigned char *good; + + if (req_comp == img_n) return data; + STBI_ASSERT(req_comp >= 1 && req_comp <= 4); + + good = (unsigned char *) stbi__malloc_mad3(req_comp, x, y, 0); + if (good == NULL) { + STBI_FREE(data); + return stbi__errpuc("outofmem", "Out of memory"); + } + + for (j=0; j < (int) y; ++j) { + unsigned char *src = data + j * x * img_n ; + unsigned char *dest = good + j * x * req_comp; + + #define STBI__COMBO(a,b) ((a)*8+(b)) + #define STBI__CASE(a,b) case STBI__COMBO(a,b): for(i=x-1; i >= 0; --i, src += a, dest += b) + // convert source image with img_n components to one with req_comp components; + // avoid switch per pixel, so use switch per scanline and massive macros + switch (STBI__COMBO(img_n, req_comp)) { + STBI__CASE(1,2) { dest[0]=src[0]; dest[1]=255; } break; + STBI__CASE(1,3) { dest[0]=dest[1]=dest[2]=src[0]; } break; + STBI__CASE(1,4) { dest[0]=dest[1]=dest[2]=src[0]; dest[3]=255; } break; + STBI__CASE(2,1) { dest[0]=src[0]; } break; + STBI__CASE(2,3) { dest[0]=dest[1]=dest[2]=src[0]; } break; + STBI__CASE(2,4) { dest[0]=dest[1]=dest[2]=src[0]; dest[3]=src[1]; } break; + STBI__CASE(3,4) { dest[0]=src[0];dest[1]=src[1];dest[2]=src[2];dest[3]=255; } break; + STBI__CASE(3,1) { dest[0]=stbi__compute_y(src[0],src[1],src[2]); } break; + STBI__CASE(3,2) { dest[0]=stbi__compute_y(src[0],src[1],src[2]); dest[1] = 255; } break; + STBI__CASE(4,1) { dest[0]=stbi__compute_y(src[0],src[1],src[2]); } break; + STBI__CASE(4,2) { dest[0]=stbi__compute_y(src[0],src[1],src[2]); dest[1] = src[3]; } break; + STBI__CASE(4,3) { dest[0]=src[0];dest[1]=src[1];dest[2]=src[2]; } break; + default: STBI_ASSERT(0); STBI_FREE(data); STBI_FREE(good); return stbi__errpuc("unsupported", "Unsupported format conversion"); + } + #undef STBI__CASE + } + + STBI_FREE(data); + return good; +} +#endif + +#if defined(STBI_NO_PNG) && defined(STBI_NO_PSD) +// nothing +#else +static stbi__uint16 stbi__compute_y_16(int r, int g, int b) +{ + return (stbi__uint16) (((r*77) + (g*150) + (29*b)) >> 8); +} +#endif + +#if defined(STBI_NO_PNG) && defined(STBI_NO_PSD) +// nothing +#else +static stbi__uint16 *stbi__convert_format16(stbi__uint16 *data, int img_n, int req_comp, unsigned int x, unsigned int y) +{ + int i,j; + stbi__uint16 *good; + + if (req_comp == img_n) return data; + STBI_ASSERT(req_comp >= 1 && req_comp <= 4); + + good = (stbi__uint16 *) stbi__malloc(req_comp * x * y * 2); + if (good == NULL) { + STBI_FREE(data); + return (stbi__uint16 *) stbi__errpuc("outofmem", "Out of memory"); + } + + for (j=0; j < (int) y; ++j) { + stbi__uint16 *src = data + j * x * img_n ; + stbi__uint16 *dest = good + j * x * req_comp; + + #define STBI__COMBO(a,b) ((a)*8+(b)) + #define STBI__CASE(a,b) case STBI__COMBO(a,b): for(i=x-1; i >= 0; --i, src += a, dest += b) + // convert source image with img_n components to one with req_comp components; + // avoid switch per pixel, so use switch per scanline and massive macros + switch (STBI__COMBO(img_n, req_comp)) { + STBI__CASE(1,2) { dest[0]=src[0]; dest[1]=0xffff; } break; + STBI__CASE(1,3) { dest[0]=dest[1]=dest[2]=src[0]; } break; + STBI__CASE(1,4) { dest[0]=dest[1]=dest[2]=src[0]; dest[3]=0xffff; } break; + STBI__CASE(2,1) { dest[0]=src[0]; } break; + STBI__CASE(2,3) { dest[0]=dest[1]=dest[2]=src[0]; } break; + STBI__CASE(2,4) { dest[0]=dest[1]=dest[2]=src[0]; dest[3]=src[1]; } break; + STBI__CASE(3,4) { dest[0]=src[0];dest[1]=src[1];dest[2]=src[2];dest[3]=0xffff; } break; + STBI__CASE(3,1) { dest[0]=stbi__compute_y_16(src[0],src[1],src[2]); } break; + STBI__CASE(3,2) { dest[0]=stbi__compute_y_16(src[0],src[1],src[2]); dest[1] = 0xffff; } break; + STBI__CASE(4,1) { dest[0]=stbi__compute_y_16(src[0],src[1],src[2]); } break; + STBI__CASE(4,2) { dest[0]=stbi__compute_y_16(src[0],src[1],src[2]); dest[1] = src[3]; } break; + STBI__CASE(4,3) { dest[0]=src[0];dest[1]=src[1];dest[2]=src[2]; } break; + default: STBI_ASSERT(0); STBI_FREE(data); STBI_FREE(good); return (stbi__uint16*) stbi__errpuc("unsupported", "Unsupported format conversion"); + } + #undef STBI__CASE + } + + STBI_FREE(data); + return good; +} +#endif + +#ifndef STBI_NO_LINEAR +static float *stbi__ldr_to_hdr(stbi_uc *data, int x, int y, int comp) +{ + int i,k,n; + float *output; + if (!data) return NULL; + output = (float *) stbi__malloc_mad4(x, y, comp, sizeof(float), 0); + if (output == NULL) { STBI_FREE(data); return stbi__errpf("outofmem", "Out of memory"); } + // compute number of non-alpha components + if (comp & 1) n = comp; else n = comp-1; + for (i=0; i < x*y; ++i) { + for (k=0; k < n; ++k) { + output[i*comp + k] = (float) (pow(data[i*comp+k]/255.0f, stbi__l2h_gamma) * stbi__l2h_scale); + } + } + if (n < comp) { + for (i=0; i < x*y; ++i) { + output[i*comp + n] = data[i*comp + n]/255.0f; + } + } + STBI_FREE(data); + return output; +} +#endif + +#ifndef STBI_NO_HDR +#define stbi__float2int(x) ((int) (x)) +static stbi_uc *stbi__hdr_to_ldr(float *data, int x, int y, int comp) +{ + int i,k,n; + stbi_uc *output; + if (!data) return NULL; + output = (stbi_uc *) stbi__malloc_mad3(x, y, comp, 0); + if (output == NULL) { STBI_FREE(data); return stbi__errpuc("outofmem", "Out of memory"); } + // compute number of non-alpha components + if (comp & 1) n = comp; else n = comp-1; + for (i=0; i < x*y; ++i) { + for (k=0; k < n; ++k) { + float z = (float) pow(data[i*comp+k]*stbi__h2l_scale_i, stbi__h2l_gamma_i) * 255 + 0.5f; + if (z < 0) z = 0; + if (z > 255) z = 255; + output[i*comp + k] = (stbi_uc) stbi__float2int(z); + } + if (k < comp) { + float z = data[i*comp+k] * 255 + 0.5f; + if (z < 0) z = 0; + if (z > 255) z = 255; + output[i*comp + k] = (stbi_uc) stbi__float2int(z); + } + } + STBI_FREE(data); + return output; +} +#endif + +////////////////////////////////////////////////////////////////////////////// +// +// "baseline" JPEG/JFIF decoder +// +// simple implementation +// - doesn't support delayed output of y-dimension +// - simple interface (only one output format: 8-bit interleaved RGB) +// - doesn't try to recover corrupt jpegs +// - doesn't allow partial loading, loading multiple at once +// - still fast on x86 (copying globals into locals doesn't help x86) +// - allocates lots of intermediate memory (full size of all components) +// - non-interleaved case requires this anyway +// - allows good upsampling (see next) +// high-quality +// - upsampled channels are bilinearly interpolated, even across blocks +// - quality integer IDCT derived from IJG's 'slow' +// performance +// - fast huffman; reasonable integer IDCT +// - some SIMD kernels for common paths on targets with SSE2/NEON +// - uses a lot of intermediate memory, could cache poorly + +#ifndef STBI_NO_JPEG + +// huffman decoding acceleration +#define FAST_BITS 9 // larger handles more cases; smaller stomps less cache + +typedef struct +{ + stbi_uc fast[1 << FAST_BITS]; + // weirdly, repacking this into AoS is a 10% speed loss, instead of a win + stbi__uint16 code[256]; + stbi_uc values[256]; + stbi_uc size[257]; + unsigned int maxcode[18]; + int delta[17]; // old 'firstsymbol' - old 'firstcode' +} stbi__huffman; + +typedef struct +{ + stbi__context *s; + stbi__huffman huff_dc[4]; + stbi__huffman huff_ac[4]; + stbi__uint16 dequant[4][64]; + stbi__int16 fast_ac[4][1 << FAST_BITS]; + +// sizes for components, interleaved MCUs + int img_h_max, img_v_max; + int img_mcu_x, img_mcu_y; + int img_mcu_w, img_mcu_h; + +// definition of jpeg image component + struct + { + int id; + int h,v; + int tq; + int hd,ha; + int dc_pred; + + int x,y,w2,h2; + stbi_uc *data; + void *raw_data, *raw_coeff; + stbi_uc *linebuf; + short *coeff; // progressive only + int coeff_w, coeff_h; // number of 8x8 coefficient blocks + } img_comp[4]; + + stbi__uint32 code_buffer; // jpeg entropy-coded buffer + int code_bits; // number of valid bits + unsigned char marker; // marker seen while filling entropy buffer + int nomore; // flag if we saw a marker so must stop + + int progressive; + int spec_start; + int spec_end; + int succ_high; + int succ_low; + int eob_run; + int jfif; + int app14_color_transform; // Adobe APP14 tag + int rgb; + + int scan_n, order[4]; + int restart_interval, todo; + +// kernels + void (*idct_block_kernel)(stbi_uc *out, int out_stride, short data[64]); + void (*YCbCr_to_RGB_kernel)(stbi_uc *out, const stbi_uc *y, const stbi_uc *pcb, const stbi_uc *pcr, int count, int step); + stbi_uc *(*resample_row_hv_2_kernel)(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs); +} stbi__jpeg; + +static int stbi__build_huffman(stbi__huffman *h, int *count) +{ + int i,j,k=0; + unsigned int code; + // build size list for each symbol (from JPEG spec) + for (i=0; i < 16; ++i) { + for (j=0; j < count[i]; ++j) { + h->size[k++] = (stbi_uc) (i+1); + if(k >= 257) return stbi__err("bad size list","Corrupt JPEG"); + } + } + h->size[k] = 0; + + // compute actual symbols (from jpeg spec) + code = 0; + k = 0; + for(j=1; j <= 16; ++j) { + // compute delta to add to code to compute symbol id + h->delta[j] = k - code; + if (h->size[k] == j) { + while (h->size[k] == j) + h->code[k++] = (stbi__uint16) (code++); + if (code-1 >= (1u << j)) return stbi__err("bad code lengths","Corrupt JPEG"); + } + // compute largest code + 1 for this size, preshifted as needed later + h->maxcode[j] = code << (16-j); + code <<= 1; + } + h->maxcode[j] = 0xffffffff; + + // build non-spec acceleration table; 255 is flag for not-accelerated + memset(h->fast, 255, 1 << FAST_BITS); + for (i=0; i < k; ++i) { + int s = h->size[i]; + if (s <= FAST_BITS) { + int c = h->code[i] << (FAST_BITS-s); + int m = 1 << (FAST_BITS-s); + for (j=0; j < m; ++j) { + h->fast[c+j] = (stbi_uc) i; + } + } + } + return 1; +} + +// build a table that decodes both magnitude and value of small ACs in +// one go. +static void stbi__build_fast_ac(stbi__int16 *fast_ac, stbi__huffman *h) +{ + int i; + for (i=0; i < (1 << FAST_BITS); ++i) { + stbi_uc fast = h->fast[i]; + fast_ac[i] = 0; + if (fast < 255) { + int rs = h->values[fast]; + int run = (rs >> 4) & 15; + int magbits = rs & 15; + int len = h->size[fast]; + + if (magbits && len + magbits <= FAST_BITS) { + // magnitude code followed by receive_extend code + int k = ((i << len) & ((1 << FAST_BITS) - 1)) >> (FAST_BITS - magbits); + int m = 1 << (magbits - 1); + if (k < m) k += (~0U << magbits) + 1; + // if the result is small enough, we can fit it in fast_ac table + if (k >= -128 && k <= 127) + fast_ac[i] = (stbi__int16) ((k * 256) + (run * 16) + (len + magbits)); + } + } + } +} + +static void stbi__grow_buffer_unsafe(stbi__jpeg *j) +{ + do { + unsigned int b = j->nomore ? 0 : stbi__get8(j->s); + if (b == 0xff) { + int c = stbi__get8(j->s); + while (c == 0xff) c = stbi__get8(j->s); // consume fill bytes + if (c != 0) { + j->marker = (unsigned char) c; + j->nomore = 1; + return; + } + } + j->code_buffer |= b << (24 - j->code_bits); + j->code_bits += 8; + } while (j->code_bits <= 24); +} + +// (1 << n) - 1 +static const stbi__uint32 stbi__bmask[17]={0,1,3,7,15,31,63,127,255,511,1023,2047,4095,8191,16383,32767,65535}; + +// decode a jpeg huffman value from the bitstream +stbi_inline static int stbi__jpeg_huff_decode(stbi__jpeg *j, stbi__huffman *h) +{ + unsigned int temp; + int c,k; + + if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); + + // look at the top FAST_BITS and determine what symbol ID it is, + // if the code is <= FAST_BITS + c = (j->code_buffer >> (32 - FAST_BITS)) & ((1 << FAST_BITS)-1); + k = h->fast[c]; + if (k < 255) { + int s = h->size[k]; + if (s > j->code_bits) + return -1; + j->code_buffer <<= s; + j->code_bits -= s; + return h->values[k]; + } + + // naive test is to shift the code_buffer down so k bits are + // valid, then test against maxcode. To speed this up, we've + // preshifted maxcode left so that it has (16-k) 0s at the + // end; in other words, regardless of the number of bits, it + // wants to be compared against something shifted to have 16; + // that way we don't need to shift inside the loop. + temp = j->code_buffer >> 16; + for (k=FAST_BITS+1 ; ; ++k) + if (temp < h->maxcode[k]) + break; + if (k == 17) { + // error! code not found + j->code_bits -= 16; + return -1; + } + + if (k > j->code_bits) + return -1; + + // convert the huffman code to the symbol id + c = ((j->code_buffer >> (32 - k)) & stbi__bmask[k]) + h->delta[k]; + if(c < 0 || c >= 256) // symbol id out of bounds! + return -1; + STBI_ASSERT((((j->code_buffer) >> (32 - h->size[c])) & stbi__bmask[h->size[c]]) == h->code[c]); + + // convert the id to a symbol + j->code_bits -= k; + j->code_buffer <<= k; + return h->values[c]; +} + +// bias[n] = (-1<code_bits < n) stbi__grow_buffer_unsafe(j); + if (j->code_bits < n) return 0; // ran out of bits from stream, return 0s intead of continuing + + sgn = j->code_buffer >> 31; // sign bit always in MSB; 0 if MSB clear (positive), 1 if MSB set (negative) + k = stbi_lrot(j->code_buffer, n); + j->code_buffer = k & ~stbi__bmask[n]; + k &= stbi__bmask[n]; + j->code_bits -= n; + return k + (stbi__jbias[n] & (sgn - 1)); +} + +// get some unsigned bits +stbi_inline static int stbi__jpeg_get_bits(stbi__jpeg *j, int n) +{ + unsigned int k; + if (j->code_bits < n) stbi__grow_buffer_unsafe(j); + if (j->code_bits < n) return 0; // ran out of bits from stream, return 0s intead of continuing + k = stbi_lrot(j->code_buffer, n); + j->code_buffer = k & ~stbi__bmask[n]; + k &= stbi__bmask[n]; + j->code_bits -= n; + return k; +} + +stbi_inline static int stbi__jpeg_get_bit(stbi__jpeg *j) +{ + unsigned int k; + if (j->code_bits < 1) stbi__grow_buffer_unsafe(j); + if (j->code_bits < 1) return 0; // ran out of bits from stream, return 0s intead of continuing + k = j->code_buffer; + j->code_buffer <<= 1; + --j->code_bits; + return k & 0x80000000; +} + +// given a value that's at position X in the zigzag stream, +// where does it appear in the 8x8 matrix coded as row-major? +static const stbi_uc stbi__jpeg_dezigzag[64+15] = +{ + 0, 1, 8, 16, 9, 2, 3, 10, + 17, 24, 32, 25, 18, 11, 4, 5, + 12, 19, 26, 33, 40, 48, 41, 34, + 27, 20, 13, 6, 7, 14, 21, 28, + 35, 42, 49, 56, 57, 50, 43, 36, + 29, 22, 15, 23, 30, 37, 44, 51, + 58, 59, 52, 45, 38, 31, 39, 46, + 53, 60, 61, 54, 47, 55, 62, 63, + // let corrupt input sample past end + 63, 63, 63, 63, 63, 63, 63, 63, + 63, 63, 63, 63, 63, 63, 63 +}; + +// decode one 64-entry block-- +static int stbi__jpeg_decode_block(stbi__jpeg *j, short data[64], stbi__huffman *hdc, stbi__huffman *hac, stbi__int16 *fac, int b, stbi__uint16 *dequant) +{ + int diff,dc,k; + int t; + + if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); + t = stbi__jpeg_huff_decode(j, hdc); + if (t < 0 || t > 15) return stbi__err("bad huffman code","Corrupt JPEG"); + + // 0 all the ac values now so we can do it 32-bits at a time + memset(data,0,64*sizeof(data[0])); + + diff = t ? stbi__extend_receive(j, t) : 0; + if (!stbi__addints_valid(j->img_comp[b].dc_pred, diff)) return stbi__err("bad delta","Corrupt JPEG"); + dc = j->img_comp[b].dc_pred + diff; + j->img_comp[b].dc_pred = dc; + if (!stbi__mul2shorts_valid(dc, dequant[0])) return stbi__err("can't merge dc and ac", "Corrupt JPEG"); + data[0] = (short) (dc * dequant[0]); + + // decode AC components, see JPEG spec + k = 1; + do { + unsigned int zig; + int c,r,s; + if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); + c = (j->code_buffer >> (32 - FAST_BITS)) & ((1 << FAST_BITS)-1); + r = fac[c]; + if (r) { // fast-AC path + k += (r >> 4) & 15; // run + s = r & 15; // combined length + if (s > j->code_bits) return stbi__err("bad huffman code", "Combined length longer than code bits available"); + j->code_buffer <<= s; + j->code_bits -= s; + // decode into unzigzag'd location + zig = stbi__jpeg_dezigzag[k++]; + data[zig] = (short) ((r >> 8) * dequant[zig]); + } else { + int rs = stbi__jpeg_huff_decode(j, hac); + if (rs < 0) return stbi__err("bad huffman code","Corrupt JPEG"); + s = rs & 15; + r = rs >> 4; + if (s == 0) { + if (rs != 0xf0) break; // end block + k += 16; + } else { + k += r; + // decode into unzigzag'd location + zig = stbi__jpeg_dezigzag[k++]; + data[zig] = (short) (stbi__extend_receive(j,s) * dequant[zig]); + } + } + } while (k < 64); + return 1; +} + +static int stbi__jpeg_decode_block_prog_dc(stbi__jpeg *j, short data[64], stbi__huffman *hdc, int b) +{ + int diff,dc; + int t; + if (j->spec_end != 0) return stbi__err("can't merge dc and ac", "Corrupt JPEG"); + + if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); + + if (j->succ_high == 0) { + // first scan for DC coefficient, must be first + memset(data,0,64*sizeof(data[0])); // 0 all the ac values now + t = stbi__jpeg_huff_decode(j, hdc); + if (t < 0 || t > 15) return stbi__err("can't merge dc and ac", "Corrupt JPEG"); + diff = t ? stbi__extend_receive(j, t) : 0; + + if (!stbi__addints_valid(j->img_comp[b].dc_pred, diff)) return stbi__err("bad delta", "Corrupt JPEG"); + dc = j->img_comp[b].dc_pred + diff; + j->img_comp[b].dc_pred = dc; + if (!stbi__mul2shorts_valid(dc, 1 << j->succ_low)) return stbi__err("can't merge dc and ac", "Corrupt JPEG"); + data[0] = (short) (dc * (1 << j->succ_low)); + } else { + // refinement scan for DC coefficient + if (stbi__jpeg_get_bit(j)) + data[0] += (short) (1 << j->succ_low); + } + return 1; +} + +// @OPTIMIZE: store non-zigzagged during the decode passes, +// and only de-zigzag when dequantizing +static int stbi__jpeg_decode_block_prog_ac(stbi__jpeg *j, short data[64], stbi__huffman *hac, stbi__int16 *fac) +{ + int k; + if (j->spec_start == 0) return stbi__err("can't merge dc and ac", "Corrupt JPEG"); + + if (j->succ_high == 0) { + int shift = j->succ_low; + + if (j->eob_run) { + --j->eob_run; + return 1; + } + + k = j->spec_start; + do { + unsigned int zig; + int c,r,s; + if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); + c = (j->code_buffer >> (32 - FAST_BITS)) & ((1 << FAST_BITS)-1); + r = fac[c]; + if (r) { // fast-AC path + k += (r >> 4) & 15; // run + s = r & 15; // combined length + if (s > j->code_bits) return stbi__err("bad huffman code", "Combined length longer than code bits available"); + j->code_buffer <<= s; + j->code_bits -= s; + zig = stbi__jpeg_dezigzag[k++]; + data[zig] = (short) ((r >> 8) * (1 << shift)); + } else { + int rs = stbi__jpeg_huff_decode(j, hac); + if (rs < 0) return stbi__err("bad huffman code","Corrupt JPEG"); + s = rs & 15; + r = rs >> 4; + if (s == 0) { + if (r < 15) { + j->eob_run = (1 << r); + if (r) + j->eob_run += stbi__jpeg_get_bits(j, r); + --j->eob_run; + break; + } + k += 16; + } else { + k += r; + zig = stbi__jpeg_dezigzag[k++]; + data[zig] = (short) (stbi__extend_receive(j,s) * (1 << shift)); + } + } + } while (k <= j->spec_end); + } else { + // refinement scan for these AC coefficients + + short bit = (short) (1 << j->succ_low); + + if (j->eob_run) { + --j->eob_run; + for (k = j->spec_start; k <= j->spec_end; ++k) { + short *p = &data[stbi__jpeg_dezigzag[k]]; + if (*p != 0) + if (stbi__jpeg_get_bit(j)) + if ((*p & bit)==0) { + if (*p > 0) + *p += bit; + else + *p -= bit; + } + } + } else { + k = j->spec_start; + do { + int r,s; + int rs = stbi__jpeg_huff_decode(j, hac); // @OPTIMIZE see if we can use the fast path here, advance-by-r is so slow, eh + if (rs < 0) return stbi__err("bad huffman code","Corrupt JPEG"); + s = rs & 15; + r = rs >> 4; + if (s == 0) { + if (r < 15) { + j->eob_run = (1 << r) - 1; + if (r) + j->eob_run += stbi__jpeg_get_bits(j, r); + r = 64; // force end of block + } else { + // r=15 s=0 should write 16 0s, so we just do + // a run of 15 0s and then write s (which is 0), + // so we don't have to do anything special here + } + } else { + if (s != 1) return stbi__err("bad huffman code", "Corrupt JPEG"); + // sign bit + if (stbi__jpeg_get_bit(j)) + s = bit; + else + s = -bit; + } + + // advance by r + while (k <= j->spec_end) { + short *p = &data[stbi__jpeg_dezigzag[k++]]; + if (*p != 0) { + if (stbi__jpeg_get_bit(j)) + if ((*p & bit)==0) { + if (*p > 0) + *p += bit; + else + *p -= bit; + } + } else { + if (r == 0) { + *p = (short) s; + break; + } + --r; + } + } + } while (k <= j->spec_end); + } + } + return 1; +} + +// take a -128..127 value and stbi__clamp it and convert to 0..255 +stbi_inline static stbi_uc stbi__clamp(int x) +{ + // trick to use a single test to catch both cases + if ((unsigned int) x > 255) { + if (x < 0) return 0; + if (x > 255) return 255; + } + return (stbi_uc) x; +} + +#define stbi__f2f(x) ((int) (((x) * 4096 + 0.5))) +#define stbi__fsh(x) ((x) * 4096) + +// derived from jidctint -- DCT_ISLOW +#define STBI__IDCT_1D(s0,s1,s2,s3,s4,s5,s6,s7) \ + int t0,t1,t2,t3,p1,p2,p3,p4,p5,x0,x1,x2,x3; \ + p2 = s2; \ + p3 = s6; \ + p1 = (p2+p3) * stbi__f2f(0.5411961f); \ + t2 = p1 + p3*stbi__f2f(-1.847759065f); \ + t3 = p1 + p2*stbi__f2f( 0.765366865f); \ + p2 = s0; \ + p3 = s4; \ + t0 = stbi__fsh(p2+p3); \ + t1 = stbi__fsh(p2-p3); \ + x0 = t0+t3; \ + x3 = t0-t3; \ + x1 = t1+t2; \ + x2 = t1-t2; \ + t0 = s7; \ + t1 = s5; \ + t2 = s3; \ + t3 = s1; \ + p3 = t0+t2; \ + p4 = t1+t3; \ + p1 = t0+t3; \ + p2 = t1+t2; \ + p5 = (p3+p4)*stbi__f2f( 1.175875602f); \ + t0 = t0*stbi__f2f( 0.298631336f); \ + t1 = t1*stbi__f2f( 2.053119869f); \ + t2 = t2*stbi__f2f( 3.072711026f); \ + t3 = t3*stbi__f2f( 1.501321110f); \ + p1 = p5 + p1*stbi__f2f(-0.899976223f); \ + p2 = p5 + p2*stbi__f2f(-2.562915447f); \ + p3 = p3*stbi__f2f(-1.961570560f); \ + p4 = p4*stbi__f2f(-0.390180644f); \ + t3 += p1+p4; \ + t2 += p2+p3; \ + t1 += p2+p4; \ + t0 += p1+p3; + +static void stbi__idct_block(stbi_uc *out, int out_stride, short data[64]) +{ + int i,val[64],*v=val; + stbi_uc *o; + short *d = data; + + // columns + for (i=0; i < 8; ++i,++d, ++v) { + // if all zeroes, shortcut -- this avoids dequantizing 0s and IDCTing + if (d[ 8]==0 && d[16]==0 && d[24]==0 && d[32]==0 + && d[40]==0 && d[48]==0 && d[56]==0) { + // no shortcut 0 seconds + // (1|2|3|4|5|6|7)==0 0 seconds + // all separate -0.047 seconds + // 1 && 2|3 && 4|5 && 6|7: -0.047 seconds + int dcterm = d[0]*4; + v[0] = v[8] = v[16] = v[24] = v[32] = v[40] = v[48] = v[56] = dcterm; + } else { + STBI__IDCT_1D(d[ 0],d[ 8],d[16],d[24],d[32],d[40],d[48],d[56]) + // constants scaled things up by 1<<12; let's bring them back + // down, but keep 2 extra bits of precision + x0 += 512; x1 += 512; x2 += 512; x3 += 512; + v[ 0] = (x0+t3) >> 10; + v[56] = (x0-t3) >> 10; + v[ 8] = (x1+t2) >> 10; + v[48] = (x1-t2) >> 10; + v[16] = (x2+t1) >> 10; + v[40] = (x2-t1) >> 10; + v[24] = (x3+t0) >> 10; + v[32] = (x3-t0) >> 10; + } + } + + for (i=0, v=val, o=out; i < 8; ++i,v+=8,o+=out_stride) { + // no fast case since the first 1D IDCT spread components out + STBI__IDCT_1D(v[0],v[1],v[2],v[3],v[4],v[5],v[6],v[7]) + // constants scaled things up by 1<<12, plus we had 1<<2 from first + // loop, plus horizontal and vertical each scale by sqrt(8) so together + // we've got an extra 1<<3, so 1<<17 total we need to remove. + // so we want to round that, which means adding 0.5 * 1<<17, + // aka 65536. Also, we'll end up with -128 to 127 that we want + // to encode as 0..255 by adding 128, so we'll add that before the shift + x0 += 65536 + (128<<17); + x1 += 65536 + (128<<17); + x2 += 65536 + (128<<17); + x3 += 65536 + (128<<17); + // tried computing the shifts into temps, or'ing the temps to see + // if any were out of range, but that was slower + o[0] = stbi__clamp((x0+t3) >> 17); + o[7] = stbi__clamp((x0-t3) >> 17); + o[1] = stbi__clamp((x1+t2) >> 17); + o[6] = stbi__clamp((x1-t2) >> 17); + o[2] = stbi__clamp((x2+t1) >> 17); + o[5] = stbi__clamp((x2-t1) >> 17); + o[3] = stbi__clamp((x3+t0) >> 17); + o[4] = stbi__clamp((x3-t0) >> 17); + } +} + +#ifdef STBI_SSE2 +// sse2 integer IDCT. not the fastest possible implementation but it +// produces bit-identical results to the generic C version so it's +// fully "transparent". +static void stbi__idct_simd(stbi_uc *out, int out_stride, short data[64]) +{ + // This is constructed to match our regular (generic) integer IDCT exactly. + __m128i row0, row1, row2, row3, row4, row5, row6, row7; + __m128i tmp; + + // dot product constant: even elems=x, odd elems=y + #define dct_const(x,y) _mm_setr_epi16((x),(y),(x),(y),(x),(y),(x),(y)) + + // out(0) = c0[even]*x + c0[odd]*y (c0, x, y 16-bit, out 32-bit) + // out(1) = c1[even]*x + c1[odd]*y + #define dct_rot(out0,out1, x,y,c0,c1) \ + __m128i c0##lo = _mm_unpacklo_epi16((x),(y)); \ + __m128i c0##hi = _mm_unpackhi_epi16((x),(y)); \ + __m128i out0##_l = _mm_madd_epi16(c0##lo, c0); \ + __m128i out0##_h = _mm_madd_epi16(c0##hi, c0); \ + __m128i out1##_l = _mm_madd_epi16(c0##lo, c1); \ + __m128i out1##_h = _mm_madd_epi16(c0##hi, c1) + + // out = in << 12 (in 16-bit, out 32-bit) + #define dct_widen(out, in) \ + __m128i out##_l = _mm_srai_epi32(_mm_unpacklo_epi16(_mm_setzero_si128(), (in)), 4); \ + __m128i out##_h = _mm_srai_epi32(_mm_unpackhi_epi16(_mm_setzero_si128(), (in)), 4) + + // wide add + #define dct_wadd(out, a, b) \ + __m128i out##_l = _mm_add_epi32(a##_l, b##_l); \ + __m128i out##_h = _mm_add_epi32(a##_h, b##_h) + + // wide sub + #define dct_wsub(out, a, b) \ + __m128i out##_l = _mm_sub_epi32(a##_l, b##_l); \ + __m128i out##_h = _mm_sub_epi32(a##_h, b##_h) + + // butterfly a/b, add bias, then shift by "s" and pack + #define dct_bfly32o(out0, out1, a,b,bias,s) \ + { \ + __m128i abiased_l = _mm_add_epi32(a##_l, bias); \ + __m128i abiased_h = _mm_add_epi32(a##_h, bias); \ + dct_wadd(sum, abiased, b); \ + dct_wsub(dif, abiased, b); \ + out0 = _mm_packs_epi32(_mm_srai_epi32(sum_l, s), _mm_srai_epi32(sum_h, s)); \ + out1 = _mm_packs_epi32(_mm_srai_epi32(dif_l, s), _mm_srai_epi32(dif_h, s)); \ + } + + // 8-bit interleave step (for transposes) + #define dct_interleave8(a, b) \ + tmp = a; \ + a = _mm_unpacklo_epi8(a, b); \ + b = _mm_unpackhi_epi8(tmp, b) + + // 16-bit interleave step (for transposes) + #define dct_interleave16(a, b) \ + tmp = a; \ + a = _mm_unpacklo_epi16(a, b); \ + b = _mm_unpackhi_epi16(tmp, b) + + #define dct_pass(bias,shift) \ + { \ + /* even part */ \ + dct_rot(t2e,t3e, row2,row6, rot0_0,rot0_1); \ + __m128i sum04 = _mm_add_epi16(row0, row4); \ + __m128i dif04 = _mm_sub_epi16(row0, row4); \ + dct_widen(t0e, sum04); \ + dct_widen(t1e, dif04); \ + dct_wadd(x0, t0e, t3e); \ + dct_wsub(x3, t0e, t3e); \ + dct_wadd(x1, t1e, t2e); \ + dct_wsub(x2, t1e, t2e); \ + /* odd part */ \ + dct_rot(y0o,y2o, row7,row3, rot2_0,rot2_1); \ + dct_rot(y1o,y3o, row5,row1, rot3_0,rot3_1); \ + __m128i sum17 = _mm_add_epi16(row1, row7); \ + __m128i sum35 = _mm_add_epi16(row3, row5); \ + dct_rot(y4o,y5o, sum17,sum35, rot1_0,rot1_1); \ + dct_wadd(x4, y0o, y4o); \ + dct_wadd(x5, y1o, y5o); \ + dct_wadd(x6, y2o, y5o); \ + dct_wadd(x7, y3o, y4o); \ + dct_bfly32o(row0,row7, x0,x7,bias,shift); \ + dct_bfly32o(row1,row6, x1,x6,bias,shift); \ + dct_bfly32o(row2,row5, x2,x5,bias,shift); \ + dct_bfly32o(row3,row4, x3,x4,bias,shift); \ + } + + __m128i rot0_0 = dct_const(stbi__f2f(0.5411961f), stbi__f2f(0.5411961f) + stbi__f2f(-1.847759065f)); + __m128i rot0_1 = dct_const(stbi__f2f(0.5411961f) + stbi__f2f( 0.765366865f), stbi__f2f(0.5411961f)); + __m128i rot1_0 = dct_const(stbi__f2f(1.175875602f) + stbi__f2f(-0.899976223f), stbi__f2f(1.175875602f)); + __m128i rot1_1 = dct_const(stbi__f2f(1.175875602f), stbi__f2f(1.175875602f) + stbi__f2f(-2.562915447f)); + __m128i rot2_0 = dct_const(stbi__f2f(-1.961570560f) + stbi__f2f( 0.298631336f), stbi__f2f(-1.961570560f)); + __m128i rot2_1 = dct_const(stbi__f2f(-1.961570560f), stbi__f2f(-1.961570560f) + stbi__f2f( 3.072711026f)); + __m128i rot3_0 = dct_const(stbi__f2f(-0.390180644f) + stbi__f2f( 2.053119869f), stbi__f2f(-0.390180644f)); + __m128i rot3_1 = dct_const(stbi__f2f(-0.390180644f), stbi__f2f(-0.390180644f) + stbi__f2f( 1.501321110f)); + + // rounding biases in column/row passes, see stbi__idct_block for explanation. + __m128i bias_0 = _mm_set1_epi32(512); + __m128i bias_1 = _mm_set1_epi32(65536 + (128<<17)); + + // load + row0 = _mm_load_si128((const __m128i *) (data + 0*8)); + row1 = _mm_load_si128((const __m128i *) (data + 1*8)); + row2 = _mm_load_si128((const __m128i *) (data + 2*8)); + row3 = _mm_load_si128((const __m128i *) (data + 3*8)); + row4 = _mm_load_si128((const __m128i *) (data + 4*8)); + row5 = _mm_load_si128((const __m128i *) (data + 5*8)); + row6 = _mm_load_si128((const __m128i *) (data + 6*8)); + row7 = _mm_load_si128((const __m128i *) (data + 7*8)); + + // column pass + dct_pass(bias_0, 10); + + { + // 16bit 8x8 transpose pass 1 + dct_interleave16(row0, row4); + dct_interleave16(row1, row5); + dct_interleave16(row2, row6); + dct_interleave16(row3, row7); + + // transpose pass 2 + dct_interleave16(row0, row2); + dct_interleave16(row1, row3); + dct_interleave16(row4, row6); + dct_interleave16(row5, row7); + + // transpose pass 3 + dct_interleave16(row0, row1); + dct_interleave16(row2, row3); + dct_interleave16(row4, row5); + dct_interleave16(row6, row7); + } + + // row pass + dct_pass(bias_1, 17); + + { + // pack + __m128i p0 = _mm_packus_epi16(row0, row1); // a0a1a2a3...a7b0b1b2b3...b7 + __m128i p1 = _mm_packus_epi16(row2, row3); + __m128i p2 = _mm_packus_epi16(row4, row5); + __m128i p3 = _mm_packus_epi16(row6, row7); + + // 8bit 8x8 transpose pass 1 + dct_interleave8(p0, p2); // a0e0a1e1... + dct_interleave8(p1, p3); // c0g0c1g1... + + // transpose pass 2 + dct_interleave8(p0, p1); // a0c0e0g0... + dct_interleave8(p2, p3); // b0d0f0h0... + + // transpose pass 3 + dct_interleave8(p0, p2); // a0b0c0d0... + dct_interleave8(p1, p3); // a4b4c4d4... + + // store + _mm_storel_epi64((__m128i *) out, p0); out += out_stride; + _mm_storel_epi64((__m128i *) out, _mm_shuffle_epi32(p0, 0x4e)); out += out_stride; + _mm_storel_epi64((__m128i *) out, p2); out += out_stride; + _mm_storel_epi64((__m128i *) out, _mm_shuffle_epi32(p2, 0x4e)); out += out_stride; + _mm_storel_epi64((__m128i *) out, p1); out += out_stride; + _mm_storel_epi64((__m128i *) out, _mm_shuffle_epi32(p1, 0x4e)); out += out_stride; + _mm_storel_epi64((__m128i *) out, p3); out += out_stride; + _mm_storel_epi64((__m128i *) out, _mm_shuffle_epi32(p3, 0x4e)); + } + +#undef dct_const +#undef dct_rot +#undef dct_widen +#undef dct_wadd +#undef dct_wsub +#undef dct_bfly32o +#undef dct_interleave8 +#undef dct_interleave16 +#undef dct_pass +} + +#endif // STBI_SSE2 + +#ifdef STBI_NEON + +// NEON integer IDCT. should produce bit-identical +// results to the generic C version. +static void stbi__idct_simd(stbi_uc *out, int out_stride, short data[64]) +{ + int16x8_t row0, row1, row2, row3, row4, row5, row6, row7; + + int16x4_t rot0_0 = vdup_n_s16(stbi__f2f(0.5411961f)); + int16x4_t rot0_1 = vdup_n_s16(stbi__f2f(-1.847759065f)); + int16x4_t rot0_2 = vdup_n_s16(stbi__f2f( 0.765366865f)); + int16x4_t rot1_0 = vdup_n_s16(stbi__f2f( 1.175875602f)); + int16x4_t rot1_1 = vdup_n_s16(stbi__f2f(-0.899976223f)); + int16x4_t rot1_2 = vdup_n_s16(stbi__f2f(-2.562915447f)); + int16x4_t rot2_0 = vdup_n_s16(stbi__f2f(-1.961570560f)); + int16x4_t rot2_1 = vdup_n_s16(stbi__f2f(-0.390180644f)); + int16x4_t rot3_0 = vdup_n_s16(stbi__f2f( 0.298631336f)); + int16x4_t rot3_1 = vdup_n_s16(stbi__f2f( 2.053119869f)); + int16x4_t rot3_2 = vdup_n_s16(stbi__f2f( 3.072711026f)); + int16x4_t rot3_3 = vdup_n_s16(stbi__f2f( 1.501321110f)); + +#define dct_long_mul(out, inq, coeff) \ + int32x4_t out##_l = vmull_s16(vget_low_s16(inq), coeff); \ + int32x4_t out##_h = vmull_s16(vget_high_s16(inq), coeff) + +#define dct_long_mac(out, acc, inq, coeff) \ + int32x4_t out##_l = vmlal_s16(acc##_l, vget_low_s16(inq), coeff); \ + int32x4_t out##_h = vmlal_s16(acc##_h, vget_high_s16(inq), coeff) + +#define dct_widen(out, inq) \ + int32x4_t out##_l = vshll_n_s16(vget_low_s16(inq), 12); \ + int32x4_t out##_h = vshll_n_s16(vget_high_s16(inq), 12) + +// wide add +#define dct_wadd(out, a, b) \ + int32x4_t out##_l = vaddq_s32(a##_l, b##_l); \ + int32x4_t out##_h = vaddq_s32(a##_h, b##_h) + +// wide sub +#define dct_wsub(out, a, b) \ + int32x4_t out##_l = vsubq_s32(a##_l, b##_l); \ + int32x4_t out##_h = vsubq_s32(a##_h, b##_h) + +// butterfly a/b, then shift using "shiftop" by "s" and pack +#define dct_bfly32o(out0,out1, a,b,shiftop,s) \ + { \ + dct_wadd(sum, a, b); \ + dct_wsub(dif, a, b); \ + out0 = vcombine_s16(shiftop(sum_l, s), shiftop(sum_h, s)); \ + out1 = vcombine_s16(shiftop(dif_l, s), shiftop(dif_h, s)); \ + } + +#define dct_pass(shiftop, shift) \ + { \ + /* even part */ \ + int16x8_t sum26 = vaddq_s16(row2, row6); \ + dct_long_mul(p1e, sum26, rot0_0); \ + dct_long_mac(t2e, p1e, row6, rot0_1); \ + dct_long_mac(t3e, p1e, row2, rot0_2); \ + int16x8_t sum04 = vaddq_s16(row0, row4); \ + int16x8_t dif04 = vsubq_s16(row0, row4); \ + dct_widen(t0e, sum04); \ + dct_widen(t1e, dif04); \ + dct_wadd(x0, t0e, t3e); \ + dct_wsub(x3, t0e, t3e); \ + dct_wadd(x1, t1e, t2e); \ + dct_wsub(x2, t1e, t2e); \ + /* odd part */ \ + int16x8_t sum15 = vaddq_s16(row1, row5); \ + int16x8_t sum17 = vaddq_s16(row1, row7); \ + int16x8_t sum35 = vaddq_s16(row3, row5); \ + int16x8_t sum37 = vaddq_s16(row3, row7); \ + int16x8_t sumodd = vaddq_s16(sum17, sum35); \ + dct_long_mul(p5o, sumodd, rot1_0); \ + dct_long_mac(p1o, p5o, sum17, rot1_1); \ + dct_long_mac(p2o, p5o, sum35, rot1_2); \ + dct_long_mul(p3o, sum37, rot2_0); \ + dct_long_mul(p4o, sum15, rot2_1); \ + dct_wadd(sump13o, p1o, p3o); \ + dct_wadd(sump24o, p2o, p4o); \ + dct_wadd(sump23o, p2o, p3o); \ + dct_wadd(sump14o, p1o, p4o); \ + dct_long_mac(x4, sump13o, row7, rot3_0); \ + dct_long_mac(x5, sump24o, row5, rot3_1); \ + dct_long_mac(x6, sump23o, row3, rot3_2); \ + dct_long_mac(x7, sump14o, row1, rot3_3); \ + dct_bfly32o(row0,row7, x0,x7,shiftop,shift); \ + dct_bfly32o(row1,row6, x1,x6,shiftop,shift); \ + dct_bfly32o(row2,row5, x2,x5,shiftop,shift); \ + dct_bfly32o(row3,row4, x3,x4,shiftop,shift); \ + } + + // load + row0 = vld1q_s16(data + 0*8); + row1 = vld1q_s16(data + 1*8); + row2 = vld1q_s16(data + 2*8); + row3 = vld1q_s16(data + 3*8); + row4 = vld1q_s16(data + 4*8); + row5 = vld1q_s16(data + 5*8); + row6 = vld1q_s16(data + 6*8); + row7 = vld1q_s16(data + 7*8); + + // add DC bias + row0 = vaddq_s16(row0, vsetq_lane_s16(1024, vdupq_n_s16(0), 0)); + + // column pass + dct_pass(vrshrn_n_s32, 10); + + // 16bit 8x8 transpose + { +// these three map to a single VTRN.16, VTRN.32, and VSWP, respectively. +// whether compilers actually get this is another story, sadly. +#define dct_trn16(x, y) { int16x8x2_t t = vtrnq_s16(x, y); x = t.val[0]; y = t.val[1]; } +#define dct_trn32(x, y) { int32x4x2_t t = vtrnq_s32(vreinterpretq_s32_s16(x), vreinterpretq_s32_s16(y)); x = vreinterpretq_s16_s32(t.val[0]); y = vreinterpretq_s16_s32(t.val[1]); } +#define dct_trn64(x, y) { int16x8_t x0 = x; int16x8_t y0 = y; x = vcombine_s16(vget_low_s16(x0), vget_low_s16(y0)); y = vcombine_s16(vget_high_s16(x0), vget_high_s16(y0)); } + + // pass 1 + dct_trn16(row0, row1); // a0b0a2b2a4b4a6b6 + dct_trn16(row2, row3); + dct_trn16(row4, row5); + dct_trn16(row6, row7); + + // pass 2 + dct_trn32(row0, row2); // a0b0c0d0a4b4c4d4 + dct_trn32(row1, row3); + dct_trn32(row4, row6); + dct_trn32(row5, row7); + + // pass 3 + dct_trn64(row0, row4); // a0b0c0d0e0f0g0h0 + dct_trn64(row1, row5); + dct_trn64(row2, row6); + dct_trn64(row3, row7); + +#undef dct_trn16 +#undef dct_trn32 +#undef dct_trn64 + } + + // row pass + // vrshrn_n_s32 only supports shifts up to 16, we need + // 17. so do a non-rounding shift of 16 first then follow + // up with a rounding shift by 1. + dct_pass(vshrn_n_s32, 16); + + { + // pack and round + uint8x8_t p0 = vqrshrun_n_s16(row0, 1); + uint8x8_t p1 = vqrshrun_n_s16(row1, 1); + uint8x8_t p2 = vqrshrun_n_s16(row2, 1); + uint8x8_t p3 = vqrshrun_n_s16(row3, 1); + uint8x8_t p4 = vqrshrun_n_s16(row4, 1); + uint8x8_t p5 = vqrshrun_n_s16(row5, 1); + uint8x8_t p6 = vqrshrun_n_s16(row6, 1); + uint8x8_t p7 = vqrshrun_n_s16(row7, 1); + + // again, these can translate into one instruction, but often don't. +#define dct_trn8_8(x, y) { uint8x8x2_t t = vtrn_u8(x, y); x = t.val[0]; y = t.val[1]; } +#define dct_trn8_16(x, y) { uint16x4x2_t t = vtrn_u16(vreinterpret_u16_u8(x), vreinterpret_u16_u8(y)); x = vreinterpret_u8_u16(t.val[0]); y = vreinterpret_u8_u16(t.val[1]); } +#define dct_trn8_32(x, y) { uint32x2x2_t t = vtrn_u32(vreinterpret_u32_u8(x), vreinterpret_u32_u8(y)); x = vreinterpret_u8_u32(t.val[0]); y = vreinterpret_u8_u32(t.val[1]); } + + // sadly can't use interleaved stores here since we only write + // 8 bytes to each scan line! + + // 8x8 8-bit transpose pass 1 + dct_trn8_8(p0, p1); + dct_trn8_8(p2, p3); + dct_trn8_8(p4, p5); + dct_trn8_8(p6, p7); + + // pass 2 + dct_trn8_16(p0, p2); + dct_trn8_16(p1, p3); + dct_trn8_16(p4, p6); + dct_trn8_16(p5, p7); + + // pass 3 + dct_trn8_32(p0, p4); + dct_trn8_32(p1, p5); + dct_trn8_32(p2, p6); + dct_trn8_32(p3, p7); + + // store + vst1_u8(out, p0); out += out_stride; + vst1_u8(out, p1); out += out_stride; + vst1_u8(out, p2); out += out_stride; + vst1_u8(out, p3); out += out_stride; + vst1_u8(out, p4); out += out_stride; + vst1_u8(out, p5); out += out_stride; + vst1_u8(out, p6); out += out_stride; + vst1_u8(out, p7); + +#undef dct_trn8_8 +#undef dct_trn8_16 +#undef dct_trn8_32 + } + +#undef dct_long_mul +#undef dct_long_mac +#undef dct_widen +#undef dct_wadd +#undef dct_wsub +#undef dct_bfly32o +#undef dct_pass +} + +#endif // STBI_NEON + +#define STBI__MARKER_none 0xff +// if there's a pending marker from the entropy stream, return that +// otherwise, fetch from the stream and get a marker. if there's no +// marker, return 0xff, which is never a valid marker value +static stbi_uc stbi__get_marker(stbi__jpeg *j) +{ + stbi_uc x; + if (j->marker != STBI__MARKER_none) { x = j->marker; j->marker = STBI__MARKER_none; return x; } + x = stbi__get8(j->s); + if (x != 0xff) return STBI__MARKER_none; + while (x == 0xff) + x = stbi__get8(j->s); // consume repeated 0xff fill bytes + return x; +} + +// in each scan, we'll have scan_n components, and the order +// of the components is specified by order[] +#define STBI__RESTART(x) ((x) >= 0xd0 && (x) <= 0xd7) + +// after a restart interval, stbi__jpeg_reset the entropy decoder and +// the dc prediction +static void stbi__jpeg_reset(stbi__jpeg *j) +{ + j->code_bits = 0; + j->code_buffer = 0; + j->nomore = 0; + j->img_comp[0].dc_pred = j->img_comp[1].dc_pred = j->img_comp[2].dc_pred = j->img_comp[3].dc_pred = 0; + j->marker = STBI__MARKER_none; + j->todo = j->restart_interval ? j->restart_interval : 0x7fffffff; + j->eob_run = 0; + // no more than 1<<31 MCUs if no restart_interal? that's plenty safe, + // since we don't even allow 1<<30 pixels +} + +static int stbi__parse_entropy_coded_data(stbi__jpeg *z) +{ + stbi__jpeg_reset(z); + if (!z->progressive) { + if (z->scan_n == 1) { + int i,j; + STBI_SIMD_ALIGN(short, data[64]); + int n = z->order[0]; + // non-interleaved data, we just need to process one block at a time, + // in trivial scanline order + // number of blocks to do just depends on how many actual "pixels" this + // component has, independent of interleaved MCU blocking and such + int w = (z->img_comp[n].x+7) >> 3; + int h = (z->img_comp[n].y+7) >> 3; + for (j=0; j < h; ++j) { + for (i=0; i < w; ++i) { + int ha = z->img_comp[n].ha; + if (!stbi__jpeg_decode_block(z, data, z->huff_dc+z->img_comp[n].hd, z->huff_ac+ha, z->fast_ac[ha], n, z->dequant[z->img_comp[n].tq])) return 0; + z->idct_block_kernel(z->img_comp[n].data+z->img_comp[n].w2*j*8+i*8, z->img_comp[n].w2, data); + // every data block is an MCU, so countdown the restart interval + if (--z->todo <= 0) { + if (z->code_bits < 24) stbi__grow_buffer_unsafe(z); + // if it's NOT a restart, then just bail, so we get corrupt data + // rather than no data + if (!STBI__RESTART(z->marker)) return 1; + stbi__jpeg_reset(z); + } + } + } + return 1; + } else { // interleaved + int i,j,k,x,y; + STBI_SIMD_ALIGN(short, data[64]); + for (j=0; j < z->img_mcu_y; ++j) { + for (i=0; i < z->img_mcu_x; ++i) { + // scan an interleaved mcu... process scan_n components in order + for (k=0; k < z->scan_n; ++k) { + int n = z->order[k]; + // scan out an mcu's worth of this component; that's just determined + // by the basic H and V specified for the component + for (y=0; y < z->img_comp[n].v; ++y) { + for (x=0; x < z->img_comp[n].h; ++x) { + int x2 = (i*z->img_comp[n].h + x)*8; + int y2 = (j*z->img_comp[n].v + y)*8; + int ha = z->img_comp[n].ha; + if (!stbi__jpeg_decode_block(z, data, z->huff_dc+z->img_comp[n].hd, z->huff_ac+ha, z->fast_ac[ha], n, z->dequant[z->img_comp[n].tq])) return 0; + z->idct_block_kernel(z->img_comp[n].data+z->img_comp[n].w2*y2+x2, z->img_comp[n].w2, data); + } + } + } + // after all interleaved components, that's an interleaved MCU, + // so now count down the restart interval + if (--z->todo <= 0) { + if (z->code_bits < 24) stbi__grow_buffer_unsafe(z); + if (!STBI__RESTART(z->marker)) return 1; + stbi__jpeg_reset(z); + } + } + } + return 1; + } + } else { + if (z->scan_n == 1) { + int i,j; + int n = z->order[0]; + // non-interleaved data, we just need to process one block at a time, + // in trivial scanline order + // number of blocks to do just depends on how many actual "pixels" this + // component has, independent of interleaved MCU blocking and such + int w = (z->img_comp[n].x+7) >> 3; + int h = (z->img_comp[n].y+7) >> 3; + for (j=0; j < h; ++j) { + for (i=0; i < w; ++i) { + short *data = z->img_comp[n].coeff + 64 * (i + j * z->img_comp[n].coeff_w); + if (z->spec_start == 0) { + if (!stbi__jpeg_decode_block_prog_dc(z, data, &z->huff_dc[z->img_comp[n].hd], n)) + return 0; + } else { + int ha = z->img_comp[n].ha; + if (!stbi__jpeg_decode_block_prog_ac(z, data, &z->huff_ac[ha], z->fast_ac[ha])) + return 0; + } + // every data block is an MCU, so countdown the restart interval + if (--z->todo <= 0) { + if (z->code_bits < 24) stbi__grow_buffer_unsafe(z); + if (!STBI__RESTART(z->marker)) return 1; + stbi__jpeg_reset(z); + } + } + } + return 1; + } else { // interleaved + int i,j,k,x,y; + for (j=0; j < z->img_mcu_y; ++j) { + for (i=0; i < z->img_mcu_x; ++i) { + // scan an interleaved mcu... process scan_n components in order + for (k=0; k < z->scan_n; ++k) { + int n = z->order[k]; + // scan out an mcu's worth of this component; that's just determined + // by the basic H and V specified for the component + for (y=0; y < z->img_comp[n].v; ++y) { + for (x=0; x < z->img_comp[n].h; ++x) { + int x2 = (i*z->img_comp[n].h + x); + int y2 = (j*z->img_comp[n].v + y); + short *data = z->img_comp[n].coeff + 64 * (x2 + y2 * z->img_comp[n].coeff_w); + if (!stbi__jpeg_decode_block_prog_dc(z, data, &z->huff_dc[z->img_comp[n].hd], n)) + return 0; + } + } + } + // after all interleaved components, that's an interleaved MCU, + // so now count down the restart interval + if (--z->todo <= 0) { + if (z->code_bits < 24) stbi__grow_buffer_unsafe(z); + if (!STBI__RESTART(z->marker)) return 1; + stbi__jpeg_reset(z); + } + } + } + return 1; + } + } +} + +static void stbi__jpeg_dequantize(short *data, stbi__uint16 *dequant) +{ + int i; + for (i=0; i < 64; ++i) + data[i] *= dequant[i]; +} + +static void stbi__jpeg_finish(stbi__jpeg *z) +{ + if (z->progressive) { + // dequantize and idct the data + int i,j,n; + for (n=0; n < z->s->img_n; ++n) { + int w = (z->img_comp[n].x+7) >> 3; + int h = (z->img_comp[n].y+7) >> 3; + for (j=0; j < h; ++j) { + for (i=0; i < w; ++i) { + short *data = z->img_comp[n].coeff + 64 * (i + j * z->img_comp[n].coeff_w); + stbi__jpeg_dequantize(data, z->dequant[z->img_comp[n].tq]); + z->idct_block_kernel(z->img_comp[n].data+z->img_comp[n].w2*j*8+i*8, z->img_comp[n].w2, data); + } + } + } + } +} + +static int stbi__process_marker(stbi__jpeg *z, int m) +{ + int L; + switch (m) { + case STBI__MARKER_none: // no marker found + return stbi__err("expected marker","Corrupt JPEG"); + + case 0xDD: // DRI - specify restart interval + if (stbi__get16be(z->s) != 4) return stbi__err("bad DRI len","Corrupt JPEG"); + z->restart_interval = stbi__get16be(z->s); + return 1; + + case 0xDB: // DQT - define quantization table + L = stbi__get16be(z->s)-2; + while (L > 0) { + int q = stbi__get8(z->s); + int p = q >> 4, sixteen = (p != 0); + int t = q & 15,i; + if (p != 0 && p != 1) return stbi__err("bad DQT type","Corrupt JPEG"); + if (t > 3) return stbi__err("bad DQT table","Corrupt JPEG"); + + for (i=0; i < 64; ++i) + z->dequant[t][stbi__jpeg_dezigzag[i]] = (stbi__uint16)(sixteen ? stbi__get16be(z->s) : stbi__get8(z->s)); + L -= (sixteen ? 129 : 65); + } + return L==0; + + case 0xC4: // DHT - define huffman table + L = stbi__get16be(z->s)-2; + while (L > 0) { + stbi_uc *v; + int sizes[16],i,n=0; + int q = stbi__get8(z->s); + int tc = q >> 4; + int th = q & 15; + if (tc > 1 || th > 3) return stbi__err("bad DHT header","Corrupt JPEG"); + for (i=0; i < 16; ++i) { + sizes[i] = stbi__get8(z->s); + n += sizes[i]; + } + if(n > 256) return stbi__err("bad DHT header","Corrupt JPEG"); // Loop over i < n would write past end of values! + L -= 17; + if (tc == 0) { + if (!stbi__build_huffman(z->huff_dc+th, sizes)) return 0; + v = z->huff_dc[th].values; + } else { + if (!stbi__build_huffman(z->huff_ac+th, sizes)) return 0; + v = z->huff_ac[th].values; + } + for (i=0; i < n; ++i) + v[i] = stbi__get8(z->s); + if (tc != 0) + stbi__build_fast_ac(z->fast_ac[th], z->huff_ac + th); + L -= n; + } + return L==0; + } + + // check for comment block or APP blocks + if ((m >= 0xE0 && m <= 0xEF) || m == 0xFE) { + L = stbi__get16be(z->s); + if (L < 2) { + if (m == 0xFE) + return stbi__err("bad COM len","Corrupt JPEG"); + else + return stbi__err("bad APP len","Corrupt JPEG"); + } + L -= 2; + + if (m == 0xE0 && L >= 5) { // JFIF APP0 segment + static const unsigned char tag[5] = {'J','F','I','F','\0'}; + int ok = 1; + int i; + for (i=0; i < 5; ++i) + if (stbi__get8(z->s) != tag[i]) + ok = 0; + L -= 5; + if (ok) + z->jfif = 1; + } else if (m == 0xEE && L >= 12) { // Adobe APP14 segment + static const unsigned char tag[6] = {'A','d','o','b','e','\0'}; + int ok = 1; + int i; + for (i=0; i < 6; ++i) + if (stbi__get8(z->s) != tag[i]) + ok = 0; + L -= 6; + if (ok) { + stbi__get8(z->s); // version + stbi__get16be(z->s); // flags0 + stbi__get16be(z->s); // flags1 + z->app14_color_transform = stbi__get8(z->s); // color transform + L -= 6; + } + } + + stbi__skip(z->s, L); + return 1; + } + + return stbi__err("unknown marker","Corrupt JPEG"); +} + +// after we see SOS +static int stbi__process_scan_header(stbi__jpeg *z) +{ + int i; + int Ls = stbi__get16be(z->s); + z->scan_n = stbi__get8(z->s); + if (z->scan_n < 1 || z->scan_n > 4 || z->scan_n > (int) z->s->img_n) return stbi__err("bad SOS component count","Corrupt JPEG"); + if (Ls != 6+2*z->scan_n) return stbi__err("bad SOS len","Corrupt JPEG"); + for (i=0; i < z->scan_n; ++i) { + int id = stbi__get8(z->s), which; + int q = stbi__get8(z->s); + for (which = 0; which < z->s->img_n; ++which) + if (z->img_comp[which].id == id) + break; + if (which == z->s->img_n) return 0; // no match + z->img_comp[which].hd = q >> 4; if (z->img_comp[which].hd > 3) return stbi__err("bad DC huff","Corrupt JPEG"); + z->img_comp[which].ha = q & 15; if (z->img_comp[which].ha > 3) return stbi__err("bad AC huff","Corrupt JPEG"); + z->order[i] = which; + } + + { + int aa; + z->spec_start = stbi__get8(z->s); + z->spec_end = stbi__get8(z->s); // should be 63, but might be 0 + aa = stbi__get8(z->s); + z->succ_high = (aa >> 4); + z->succ_low = (aa & 15); + if (z->progressive) { + if (z->spec_start > 63 || z->spec_end > 63 || z->spec_start > z->spec_end || z->succ_high > 13 || z->succ_low > 13) + return stbi__err("bad SOS", "Corrupt JPEG"); + } else { + if (z->spec_start != 0) return stbi__err("bad SOS","Corrupt JPEG"); + if (z->succ_high != 0 || z->succ_low != 0) return stbi__err("bad SOS","Corrupt JPEG"); + z->spec_end = 63; + } + } + + return 1; +} + +static int stbi__free_jpeg_components(stbi__jpeg *z, int ncomp, int why) +{ + int i; + for (i=0; i < ncomp; ++i) { + if (z->img_comp[i].raw_data) { + STBI_FREE(z->img_comp[i].raw_data); + z->img_comp[i].raw_data = NULL; + z->img_comp[i].data = NULL; + } + if (z->img_comp[i].raw_coeff) { + STBI_FREE(z->img_comp[i].raw_coeff); + z->img_comp[i].raw_coeff = 0; + z->img_comp[i].coeff = 0; + } + if (z->img_comp[i].linebuf) { + STBI_FREE(z->img_comp[i].linebuf); + z->img_comp[i].linebuf = NULL; + } + } + return why; +} + +static int stbi__process_frame_header(stbi__jpeg *z, int scan) +{ + stbi__context *s = z->s; + int Lf,p,i,q, h_max=1,v_max=1,c; + Lf = stbi__get16be(s); if (Lf < 11) return stbi__err("bad SOF len","Corrupt JPEG"); // JPEG + p = stbi__get8(s); if (p != 8) return stbi__err("only 8-bit","JPEG format not supported: 8-bit only"); // JPEG baseline + s->img_y = stbi__get16be(s); if (s->img_y == 0) return stbi__err("no header height", "JPEG format not supported: delayed height"); // Legal, but we don't handle it--but neither does IJG + s->img_x = stbi__get16be(s); if (s->img_x == 0) return stbi__err("0 width","Corrupt JPEG"); // JPEG requires + if (s->img_y > STBI_MAX_DIMENSIONS) return stbi__err("too large","Very large image (corrupt?)"); + if (s->img_x > STBI_MAX_DIMENSIONS) return stbi__err("too large","Very large image (corrupt?)"); + c = stbi__get8(s); + if (c != 3 && c != 1 && c != 4) return stbi__err("bad component count","Corrupt JPEG"); + s->img_n = c; + for (i=0; i < c; ++i) { + z->img_comp[i].data = NULL; + z->img_comp[i].linebuf = NULL; + } + + if (Lf != 8+3*s->img_n) return stbi__err("bad SOF len","Corrupt JPEG"); + + z->rgb = 0; + for (i=0; i < s->img_n; ++i) { + static const unsigned char rgb[3] = { 'R', 'G', 'B' }; + z->img_comp[i].id = stbi__get8(s); + if (s->img_n == 3 && z->img_comp[i].id == rgb[i]) + ++z->rgb; + q = stbi__get8(s); + z->img_comp[i].h = (q >> 4); if (!z->img_comp[i].h || z->img_comp[i].h > 4) return stbi__err("bad H","Corrupt JPEG"); + z->img_comp[i].v = q & 15; if (!z->img_comp[i].v || z->img_comp[i].v > 4) return stbi__err("bad V","Corrupt JPEG"); + z->img_comp[i].tq = stbi__get8(s); if (z->img_comp[i].tq > 3) return stbi__err("bad TQ","Corrupt JPEG"); + } + + if (scan != STBI__SCAN_load) return 1; + + if (!stbi__mad3sizes_valid(s->img_x, s->img_y, s->img_n, 0)) return stbi__err("too large", "Image too large to decode"); + + for (i=0; i < s->img_n; ++i) { + if (z->img_comp[i].h > h_max) h_max = z->img_comp[i].h; + if (z->img_comp[i].v > v_max) v_max = z->img_comp[i].v; + } + + // check that plane subsampling factors are integer ratios; our resamplers can't deal with fractional ratios + // and I've never seen a non-corrupted JPEG file actually use them + for (i=0; i < s->img_n; ++i) { + if (h_max % z->img_comp[i].h != 0) return stbi__err("bad H","Corrupt JPEG"); + if (v_max % z->img_comp[i].v != 0) return stbi__err("bad V","Corrupt JPEG"); + } + + // compute interleaved mcu info + z->img_h_max = h_max; + z->img_v_max = v_max; + z->img_mcu_w = h_max * 8; + z->img_mcu_h = v_max * 8; + // these sizes can't be more than 17 bits + z->img_mcu_x = (s->img_x + z->img_mcu_w-1) / z->img_mcu_w; + z->img_mcu_y = (s->img_y + z->img_mcu_h-1) / z->img_mcu_h; + + for (i=0; i < s->img_n; ++i) { + // number of effective pixels (e.g. for non-interleaved MCU) + z->img_comp[i].x = (s->img_x * z->img_comp[i].h + h_max-1) / h_max; + z->img_comp[i].y = (s->img_y * z->img_comp[i].v + v_max-1) / v_max; + // to simplify generation, we'll allocate enough memory to decode + // the bogus oversized data from using interleaved MCUs and their + // big blocks (e.g. a 16x16 iMCU on an image of width 33); we won't + // discard the extra data until colorspace conversion + // + // img_mcu_x, img_mcu_y: <=17 bits; comp[i].h and .v are <=4 (checked earlier) + // so these muls can't overflow with 32-bit ints (which we require) + z->img_comp[i].w2 = z->img_mcu_x * z->img_comp[i].h * 8; + z->img_comp[i].h2 = z->img_mcu_y * z->img_comp[i].v * 8; + z->img_comp[i].coeff = 0; + z->img_comp[i].raw_coeff = 0; + z->img_comp[i].linebuf = NULL; + z->img_comp[i].raw_data = stbi__malloc_mad2(z->img_comp[i].w2, z->img_comp[i].h2, 15); + if (z->img_comp[i].raw_data == NULL) + return stbi__free_jpeg_components(z, i+1, stbi__err("outofmem", "Out of memory")); + // align blocks for idct using mmx/sse + z->img_comp[i].data = (stbi_uc*) (((size_t) z->img_comp[i].raw_data + 15) & ~15); + if (z->progressive) { + // w2, h2 are multiples of 8 (see above) + z->img_comp[i].coeff_w = z->img_comp[i].w2 / 8; + z->img_comp[i].coeff_h = z->img_comp[i].h2 / 8; + z->img_comp[i].raw_coeff = stbi__malloc_mad3(z->img_comp[i].w2, z->img_comp[i].h2, sizeof(short), 15); + if (z->img_comp[i].raw_coeff == NULL) + return stbi__free_jpeg_components(z, i+1, stbi__err("outofmem", "Out of memory")); + z->img_comp[i].coeff = (short*) (((size_t) z->img_comp[i].raw_coeff + 15) & ~15); + } + } + + return 1; +} + +// use comparisons since in some cases we handle more than one case (e.g. SOF) +#define stbi__DNL(x) ((x) == 0xdc) +#define stbi__SOI(x) ((x) == 0xd8) +#define stbi__EOI(x) ((x) == 0xd9) +#define stbi__SOF(x) ((x) == 0xc0 || (x) == 0xc1 || (x) == 0xc2) +#define stbi__SOS(x) ((x) == 0xda) + +#define stbi__SOF_progressive(x) ((x) == 0xc2) + +static int stbi__decode_jpeg_header(stbi__jpeg *z, int scan) +{ + int m; + z->jfif = 0; + z->app14_color_transform = -1; // valid values are 0,1,2 + z->marker = STBI__MARKER_none; // initialize cached marker to empty + m = stbi__get_marker(z); + if (!stbi__SOI(m)) return stbi__err("no SOI","Corrupt JPEG"); + if (scan == STBI__SCAN_type) return 1; + m = stbi__get_marker(z); + while (!stbi__SOF(m)) { + if (!stbi__process_marker(z,m)) return 0; + m = stbi__get_marker(z); + while (m == STBI__MARKER_none) { + // some files have extra padding after their blocks, so ok, we'll scan + if (stbi__at_eof(z->s)) return stbi__err("no SOF", "Corrupt JPEG"); + m = stbi__get_marker(z); + } + } + z->progressive = stbi__SOF_progressive(m); + if (!stbi__process_frame_header(z, scan)) return 0; + return 1; +} + +static stbi_uc stbi__skip_jpeg_junk_at_end(stbi__jpeg *j) +{ + // some JPEGs have junk at end, skip over it but if we find what looks + // like a valid marker, resume there + while (!stbi__at_eof(j->s)) { + stbi_uc x = stbi__get8(j->s); + while (x == 0xff) { // might be a marker + if (stbi__at_eof(j->s)) return STBI__MARKER_none; + x = stbi__get8(j->s); + if (x != 0x00 && x != 0xff) { + // not a stuffed zero or lead-in to another marker, looks + // like an actual marker, return it + return x; + } + // stuffed zero has x=0 now which ends the loop, meaning we go + // back to regular scan loop. + // repeated 0xff keeps trying to read the next byte of the marker. + } + } + return STBI__MARKER_none; +} + +// decode image to YCbCr format +static int stbi__decode_jpeg_image(stbi__jpeg *j) +{ + int m; + for (m = 0; m < 4; m++) { + j->img_comp[m].raw_data = NULL; + j->img_comp[m].raw_coeff = NULL; + } + j->restart_interval = 0; + if (!stbi__decode_jpeg_header(j, STBI__SCAN_load)) return 0; + m = stbi__get_marker(j); + while (!stbi__EOI(m)) { + if (stbi__SOS(m)) { + if (!stbi__process_scan_header(j)) return 0; + if (!stbi__parse_entropy_coded_data(j)) return 0; + if (j->marker == STBI__MARKER_none ) { + j->marker = stbi__skip_jpeg_junk_at_end(j); + // if we reach eof without hitting a marker, stbi__get_marker() below will fail and we'll eventually return 0 + } + m = stbi__get_marker(j); + if (STBI__RESTART(m)) + m = stbi__get_marker(j); + } else if (stbi__DNL(m)) { + int Ld = stbi__get16be(j->s); + stbi__uint32 NL = stbi__get16be(j->s); + if (Ld != 4) return stbi__err("bad DNL len", "Corrupt JPEG"); + if (NL != j->s->img_y) return stbi__err("bad DNL height", "Corrupt JPEG"); + m = stbi__get_marker(j); + } else { + if (!stbi__process_marker(j, m)) return 1; + m = stbi__get_marker(j); + } + } + if (j->progressive) + stbi__jpeg_finish(j); + return 1; +} + +// static jfif-centered resampling (across block boundaries) + +typedef stbi_uc *(*resample_row_func)(stbi_uc *out, stbi_uc *in0, stbi_uc *in1, + int w, int hs); + +#define stbi__div4(x) ((stbi_uc) ((x) >> 2)) + +static stbi_uc *resample_row_1(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) +{ + STBI_NOTUSED(out); + STBI_NOTUSED(in_far); + STBI_NOTUSED(w); + STBI_NOTUSED(hs); + return in_near; +} + +static stbi_uc* stbi__resample_row_v_2(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) +{ + // need to generate two samples vertically for every one in input + int i; + STBI_NOTUSED(hs); + for (i=0; i < w; ++i) + out[i] = stbi__div4(3*in_near[i] + in_far[i] + 2); + return out; +} + +static stbi_uc* stbi__resample_row_h_2(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) +{ + // need to generate two samples horizontally for every one in input + int i; + stbi_uc *input = in_near; + + if (w == 1) { + // if only one sample, can't do any interpolation + out[0] = out[1] = input[0]; + return out; + } + + out[0] = input[0]; + out[1] = stbi__div4(input[0]*3 + input[1] + 2); + for (i=1; i < w-1; ++i) { + int n = 3*input[i]+2; + out[i*2+0] = stbi__div4(n+input[i-1]); + out[i*2+1] = stbi__div4(n+input[i+1]); + } + out[i*2+0] = stbi__div4(input[w-2]*3 + input[w-1] + 2); + out[i*2+1] = input[w-1]; + + STBI_NOTUSED(in_far); + STBI_NOTUSED(hs); + + return out; +} + +#define stbi__div16(x) ((stbi_uc) ((x) >> 4)) + +static stbi_uc *stbi__resample_row_hv_2(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) +{ + // need to generate 2x2 samples for every one in input + int i,t0,t1; + if (w == 1) { + out[0] = out[1] = stbi__div4(3*in_near[0] + in_far[0] + 2); + return out; + } + + t1 = 3*in_near[0] + in_far[0]; + out[0] = stbi__div4(t1+2); + for (i=1; i < w; ++i) { + t0 = t1; + t1 = 3*in_near[i]+in_far[i]; + out[i*2-1] = stbi__div16(3*t0 + t1 + 8); + out[i*2 ] = stbi__div16(3*t1 + t0 + 8); + } + out[w*2-1] = stbi__div4(t1+2); + + STBI_NOTUSED(hs); + + return out; +} + +#if defined(STBI_SSE2) || defined(STBI_NEON) +static stbi_uc *stbi__resample_row_hv_2_simd(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) +{ + // need to generate 2x2 samples for every one in input + int i=0,t0,t1; + + if (w == 1) { + out[0] = out[1] = stbi__div4(3*in_near[0] + in_far[0] + 2); + return out; + } + + t1 = 3*in_near[0] + in_far[0]; + // process groups of 8 pixels for as long as we can. + // note we can't handle the last pixel in a row in this loop + // because we need to handle the filter boundary conditions. + for (; i < ((w-1) & ~7); i += 8) { +#if defined(STBI_SSE2) + // load and perform the vertical filtering pass + // this uses 3*x + y = 4*x + (y - x) + __m128i zero = _mm_setzero_si128(); + __m128i farb = _mm_loadl_epi64((__m128i *) (in_far + i)); + __m128i nearb = _mm_loadl_epi64((__m128i *) (in_near + i)); + __m128i farw = _mm_unpacklo_epi8(farb, zero); + __m128i nearw = _mm_unpacklo_epi8(nearb, zero); + __m128i diff = _mm_sub_epi16(farw, nearw); + __m128i nears = _mm_slli_epi16(nearw, 2); + __m128i curr = _mm_add_epi16(nears, diff); // current row + + // horizontal filter works the same based on shifted vers of current + // row. "prev" is current row shifted right by 1 pixel; we need to + // insert the previous pixel value (from t1). + // "next" is current row shifted left by 1 pixel, with first pixel + // of next block of 8 pixels added in. + __m128i prv0 = _mm_slli_si128(curr, 2); + __m128i nxt0 = _mm_srli_si128(curr, 2); + __m128i prev = _mm_insert_epi16(prv0, t1, 0); + __m128i next = _mm_insert_epi16(nxt0, 3*in_near[i+8] + in_far[i+8], 7); + + // horizontal filter, polyphase implementation since it's convenient: + // even pixels = 3*cur + prev = cur*4 + (prev - cur) + // odd pixels = 3*cur + next = cur*4 + (next - cur) + // note the shared term. + __m128i bias = _mm_set1_epi16(8); + __m128i curs = _mm_slli_epi16(curr, 2); + __m128i prvd = _mm_sub_epi16(prev, curr); + __m128i nxtd = _mm_sub_epi16(next, curr); + __m128i curb = _mm_add_epi16(curs, bias); + __m128i even = _mm_add_epi16(prvd, curb); + __m128i odd = _mm_add_epi16(nxtd, curb); + + // interleave even and odd pixels, then undo scaling. + __m128i int0 = _mm_unpacklo_epi16(even, odd); + __m128i int1 = _mm_unpackhi_epi16(even, odd); + __m128i de0 = _mm_srli_epi16(int0, 4); + __m128i de1 = _mm_srli_epi16(int1, 4); + + // pack and write output + __m128i outv = _mm_packus_epi16(de0, de1); + _mm_storeu_si128((__m128i *) (out + i*2), outv); +#elif defined(STBI_NEON) + // load and perform the vertical filtering pass + // this uses 3*x + y = 4*x + (y - x) + uint8x8_t farb = vld1_u8(in_far + i); + uint8x8_t nearb = vld1_u8(in_near + i); + int16x8_t diff = vreinterpretq_s16_u16(vsubl_u8(farb, nearb)); + int16x8_t nears = vreinterpretq_s16_u16(vshll_n_u8(nearb, 2)); + int16x8_t curr = vaddq_s16(nears, diff); // current row + + // horizontal filter works the same based on shifted vers of current + // row. "prev" is current row shifted right by 1 pixel; we need to + // insert the previous pixel value (from t1). + // "next" is current row shifted left by 1 pixel, with first pixel + // of next block of 8 pixels added in. + int16x8_t prv0 = vextq_s16(curr, curr, 7); + int16x8_t nxt0 = vextq_s16(curr, curr, 1); + int16x8_t prev = vsetq_lane_s16(t1, prv0, 0); + int16x8_t next = vsetq_lane_s16(3*in_near[i+8] + in_far[i+8], nxt0, 7); + + // horizontal filter, polyphase implementation since it's convenient: + // even pixels = 3*cur + prev = cur*4 + (prev - cur) + // odd pixels = 3*cur + next = cur*4 + (next - cur) + // note the shared term. + int16x8_t curs = vshlq_n_s16(curr, 2); + int16x8_t prvd = vsubq_s16(prev, curr); + int16x8_t nxtd = vsubq_s16(next, curr); + int16x8_t even = vaddq_s16(curs, prvd); + int16x8_t odd = vaddq_s16(curs, nxtd); + + // undo scaling and round, then store with even/odd phases interleaved + uint8x8x2_t o; + o.val[0] = vqrshrun_n_s16(even, 4); + o.val[1] = vqrshrun_n_s16(odd, 4); + vst2_u8(out + i*2, o); +#endif + + // "previous" value for next iter + t1 = 3*in_near[i+7] + in_far[i+7]; + } + + t0 = t1; + t1 = 3*in_near[i] + in_far[i]; + out[i*2] = stbi__div16(3*t1 + t0 + 8); + + for (++i; i < w; ++i) { + t0 = t1; + t1 = 3*in_near[i]+in_far[i]; + out[i*2-1] = stbi__div16(3*t0 + t1 + 8); + out[i*2 ] = stbi__div16(3*t1 + t0 + 8); + } + out[w*2-1] = stbi__div4(t1+2); + + STBI_NOTUSED(hs); + + return out; +} +#endif + +static stbi_uc *stbi__resample_row_generic(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) +{ + // resample with nearest-neighbor + int i,j; + STBI_NOTUSED(in_far); + for (i=0; i < w; ++i) + for (j=0; j < hs; ++j) + out[i*hs+j] = in_near[i]; + return out; +} + +// this is a reduced-precision calculation of YCbCr-to-RGB introduced +// to make sure the code produces the same results in both SIMD and scalar +#define stbi__float2fixed(x) (((int) ((x) * 4096.0f + 0.5f)) << 8) +static void stbi__YCbCr_to_RGB_row(stbi_uc *out, const stbi_uc *y, const stbi_uc *pcb, const stbi_uc *pcr, int count, int step) +{ + int i; + for (i=0; i < count; ++i) { + int y_fixed = (y[i] << 20) + (1<<19); // rounding + int r,g,b; + int cr = pcr[i] - 128; + int cb = pcb[i] - 128; + r = y_fixed + cr* stbi__float2fixed(1.40200f); + g = y_fixed + (cr*-stbi__float2fixed(0.71414f)) + ((cb*-stbi__float2fixed(0.34414f)) & 0xffff0000); + b = y_fixed + cb* stbi__float2fixed(1.77200f); + r >>= 20; + g >>= 20; + b >>= 20; + if ((unsigned) r > 255) { if (r < 0) r = 0; else r = 255; } + if ((unsigned) g > 255) { if (g < 0) g = 0; else g = 255; } + if ((unsigned) b > 255) { if (b < 0) b = 0; else b = 255; } + out[0] = (stbi_uc)r; + out[1] = (stbi_uc)g; + out[2] = (stbi_uc)b; + out[3] = 255; + out += step; + } +} + +#if defined(STBI_SSE2) || defined(STBI_NEON) +static void stbi__YCbCr_to_RGB_simd(stbi_uc *out, stbi_uc const *y, stbi_uc const *pcb, stbi_uc const *pcr, int count, int step) +{ + int i = 0; + +#ifdef STBI_SSE2 + // step == 3 is pretty ugly on the final interleave, and i'm not convinced + // it's useful in practice (you wouldn't use it for textures, for example). + // so just accelerate step == 4 case. + if (step == 4) { + // this is a fairly straightforward implementation and not super-optimized. + __m128i signflip = _mm_set1_epi8(-0x80); + __m128i cr_const0 = _mm_set1_epi16( (short) ( 1.40200f*4096.0f+0.5f)); + __m128i cr_const1 = _mm_set1_epi16( - (short) ( 0.71414f*4096.0f+0.5f)); + __m128i cb_const0 = _mm_set1_epi16( - (short) ( 0.34414f*4096.0f+0.5f)); + __m128i cb_const1 = _mm_set1_epi16( (short) ( 1.77200f*4096.0f+0.5f)); + __m128i y_bias = _mm_set1_epi8((char) (unsigned char) 128); + __m128i xw = _mm_set1_epi16(255); // alpha channel + + for (; i+7 < count; i += 8) { + // load + __m128i y_bytes = _mm_loadl_epi64((__m128i *) (y+i)); + __m128i cr_bytes = _mm_loadl_epi64((__m128i *) (pcr+i)); + __m128i cb_bytes = _mm_loadl_epi64((__m128i *) (pcb+i)); + __m128i cr_biased = _mm_xor_si128(cr_bytes, signflip); // -128 + __m128i cb_biased = _mm_xor_si128(cb_bytes, signflip); // -128 + + // unpack to short (and left-shift cr, cb by 8) + __m128i yw = _mm_unpacklo_epi8(y_bias, y_bytes); + __m128i crw = _mm_unpacklo_epi8(_mm_setzero_si128(), cr_biased); + __m128i cbw = _mm_unpacklo_epi8(_mm_setzero_si128(), cb_biased); + + // color transform + __m128i yws = _mm_srli_epi16(yw, 4); + __m128i cr0 = _mm_mulhi_epi16(cr_const0, crw); + __m128i cb0 = _mm_mulhi_epi16(cb_const0, cbw); + __m128i cb1 = _mm_mulhi_epi16(cbw, cb_const1); + __m128i cr1 = _mm_mulhi_epi16(crw, cr_const1); + __m128i rws = _mm_add_epi16(cr0, yws); + __m128i gwt = _mm_add_epi16(cb0, yws); + __m128i bws = _mm_add_epi16(yws, cb1); + __m128i gws = _mm_add_epi16(gwt, cr1); + + // descale + __m128i rw = _mm_srai_epi16(rws, 4); + __m128i bw = _mm_srai_epi16(bws, 4); + __m128i gw = _mm_srai_epi16(gws, 4); + + // back to byte, set up for transpose + __m128i brb = _mm_packus_epi16(rw, bw); + __m128i gxb = _mm_packus_epi16(gw, xw); + + // transpose to interleave channels + __m128i t0 = _mm_unpacklo_epi8(brb, gxb); + __m128i t1 = _mm_unpackhi_epi8(brb, gxb); + __m128i o0 = _mm_unpacklo_epi16(t0, t1); + __m128i o1 = _mm_unpackhi_epi16(t0, t1); + + // store + _mm_storeu_si128((__m128i *) (out + 0), o0); + _mm_storeu_si128((__m128i *) (out + 16), o1); + out += 32; + } + } +#endif + +#ifdef STBI_NEON + // in this version, step=3 support would be easy to add. but is there demand? + if (step == 4) { + // this is a fairly straightforward implementation and not super-optimized. + uint8x8_t signflip = vdup_n_u8(0x80); + int16x8_t cr_const0 = vdupq_n_s16( (short) ( 1.40200f*4096.0f+0.5f)); + int16x8_t cr_const1 = vdupq_n_s16( - (short) ( 0.71414f*4096.0f+0.5f)); + int16x8_t cb_const0 = vdupq_n_s16( - (short) ( 0.34414f*4096.0f+0.5f)); + int16x8_t cb_const1 = vdupq_n_s16( (short) ( 1.77200f*4096.0f+0.5f)); + + for (; i+7 < count; i += 8) { + // load + uint8x8_t y_bytes = vld1_u8(y + i); + uint8x8_t cr_bytes = vld1_u8(pcr + i); + uint8x8_t cb_bytes = vld1_u8(pcb + i); + int8x8_t cr_biased = vreinterpret_s8_u8(vsub_u8(cr_bytes, signflip)); + int8x8_t cb_biased = vreinterpret_s8_u8(vsub_u8(cb_bytes, signflip)); + + // expand to s16 + int16x8_t yws = vreinterpretq_s16_u16(vshll_n_u8(y_bytes, 4)); + int16x8_t crw = vshll_n_s8(cr_biased, 7); + int16x8_t cbw = vshll_n_s8(cb_biased, 7); + + // color transform + int16x8_t cr0 = vqdmulhq_s16(crw, cr_const0); + int16x8_t cb0 = vqdmulhq_s16(cbw, cb_const0); + int16x8_t cr1 = vqdmulhq_s16(crw, cr_const1); + int16x8_t cb1 = vqdmulhq_s16(cbw, cb_const1); + int16x8_t rws = vaddq_s16(yws, cr0); + int16x8_t gws = vaddq_s16(vaddq_s16(yws, cb0), cr1); + int16x8_t bws = vaddq_s16(yws, cb1); + + // undo scaling, round, convert to byte + uint8x8x4_t o; + o.val[0] = vqrshrun_n_s16(rws, 4); + o.val[1] = vqrshrun_n_s16(gws, 4); + o.val[2] = vqrshrun_n_s16(bws, 4); + o.val[3] = vdup_n_u8(255); + + // store, interleaving r/g/b/a + vst4_u8(out, o); + out += 8*4; + } + } +#endif + + for (; i < count; ++i) { + int y_fixed = (y[i] << 20) + (1<<19); // rounding + int r,g,b; + int cr = pcr[i] - 128; + int cb = pcb[i] - 128; + r = y_fixed + cr* stbi__float2fixed(1.40200f); + g = y_fixed + cr*-stbi__float2fixed(0.71414f) + ((cb*-stbi__float2fixed(0.34414f)) & 0xffff0000); + b = y_fixed + cb* stbi__float2fixed(1.77200f); + r >>= 20; + g >>= 20; + b >>= 20; + if ((unsigned) r > 255) { if (r < 0) r = 0; else r = 255; } + if ((unsigned) g > 255) { if (g < 0) g = 0; else g = 255; } + if ((unsigned) b > 255) { if (b < 0) b = 0; else b = 255; } + out[0] = (stbi_uc)r; + out[1] = (stbi_uc)g; + out[2] = (stbi_uc)b; + out[3] = 255; + out += step; + } +} +#endif + +// set up the kernels +static void stbi__setup_jpeg(stbi__jpeg *j) +{ + j->idct_block_kernel = stbi__idct_block; + j->YCbCr_to_RGB_kernel = stbi__YCbCr_to_RGB_row; + j->resample_row_hv_2_kernel = stbi__resample_row_hv_2; + +#ifdef STBI_SSE2 + if (stbi__sse2_available()) { + j->idct_block_kernel = stbi__idct_simd; + j->YCbCr_to_RGB_kernel = stbi__YCbCr_to_RGB_simd; + j->resample_row_hv_2_kernel = stbi__resample_row_hv_2_simd; + } +#endif + +#ifdef STBI_NEON + j->idct_block_kernel = stbi__idct_simd; + j->YCbCr_to_RGB_kernel = stbi__YCbCr_to_RGB_simd; + j->resample_row_hv_2_kernel = stbi__resample_row_hv_2_simd; +#endif +} + +// clean up the temporary component buffers +static void stbi__cleanup_jpeg(stbi__jpeg *j) +{ + stbi__free_jpeg_components(j, j->s->img_n, 0); +} + +typedef struct +{ + resample_row_func resample; + stbi_uc *line0,*line1; + int hs,vs; // expansion factor in each axis + int w_lores; // horizontal pixels pre-expansion + int ystep; // how far through vertical expansion we are + int ypos; // which pre-expansion row we're on +} stbi__resample; + +// fast 0..255 * 0..255 => 0..255 rounded multiplication +static stbi_uc stbi__blinn_8x8(stbi_uc x, stbi_uc y) +{ + unsigned int t = x*y + 128; + return (stbi_uc) ((t + (t >>8)) >> 8); +} + +static stbi_uc *load_jpeg_image(stbi__jpeg *z, int *out_x, int *out_y, int *comp, int req_comp) +{ + int n, decode_n, is_rgb; + z->s->img_n = 0; // make stbi__cleanup_jpeg safe + + // validate req_comp + if (req_comp < 0 || req_comp > 4) return stbi__errpuc("bad req_comp", "Internal error"); + + // load a jpeg image from whichever source, but leave in YCbCr format + if (!stbi__decode_jpeg_image(z)) { stbi__cleanup_jpeg(z); return NULL; } + + // determine actual number of components to generate + n = req_comp ? req_comp : z->s->img_n >= 3 ? 3 : 1; + + is_rgb = z->s->img_n == 3 && (z->rgb == 3 || (z->app14_color_transform == 0 && !z->jfif)); + + if (z->s->img_n == 3 && n < 3 && !is_rgb) + decode_n = 1; + else + decode_n = z->s->img_n; + + // nothing to do if no components requested; check this now to avoid + // accessing uninitialized coutput[0] later + if (decode_n <= 0) { stbi__cleanup_jpeg(z); return NULL; } + + // resample and color-convert + { + int k; + unsigned int i,j; + stbi_uc *output; + stbi_uc *coutput[4] = { NULL, NULL, NULL, NULL }; + + stbi__resample res_comp[4]; + + for (k=0; k < decode_n; ++k) { + stbi__resample *r = &res_comp[k]; + + // allocate line buffer big enough for upsampling off the edges + // with upsample factor of 4 + z->img_comp[k].linebuf = (stbi_uc *) stbi__malloc(z->s->img_x + 3); + if (!z->img_comp[k].linebuf) { stbi__cleanup_jpeg(z); return stbi__errpuc("outofmem", "Out of memory"); } + + r->hs = z->img_h_max / z->img_comp[k].h; + r->vs = z->img_v_max / z->img_comp[k].v; + r->ystep = r->vs >> 1; + r->w_lores = (z->s->img_x + r->hs-1) / r->hs; + r->ypos = 0; + r->line0 = r->line1 = z->img_comp[k].data; + + if (r->hs == 1 && r->vs == 1) r->resample = resample_row_1; + else if (r->hs == 1 && r->vs == 2) r->resample = stbi__resample_row_v_2; + else if (r->hs == 2 && r->vs == 1) r->resample = stbi__resample_row_h_2; + else if (r->hs == 2 && r->vs == 2) r->resample = z->resample_row_hv_2_kernel; + else r->resample = stbi__resample_row_generic; + } + + // can't error after this so, this is safe + output = (stbi_uc *) stbi__malloc_mad3(n, z->s->img_x, z->s->img_y, 1); + if (!output) { stbi__cleanup_jpeg(z); return stbi__errpuc("outofmem", "Out of memory"); } + + // now go ahead and resample + for (j=0; j < z->s->img_y; ++j) { + stbi_uc *out = output + n * z->s->img_x * j; + for (k=0; k < decode_n; ++k) { + stbi__resample *r = &res_comp[k]; + int y_bot = r->ystep >= (r->vs >> 1); + coutput[k] = r->resample(z->img_comp[k].linebuf, + y_bot ? r->line1 : r->line0, + y_bot ? r->line0 : r->line1, + r->w_lores, r->hs); + if (++r->ystep >= r->vs) { + r->ystep = 0; + r->line0 = r->line1; + if (++r->ypos < z->img_comp[k].y) + r->line1 += z->img_comp[k].w2; + } + } + if (n >= 3) { + stbi_uc *y = coutput[0]; + if (z->s->img_n == 3) { + if (is_rgb) { + for (i=0; i < z->s->img_x; ++i) { + out[0] = y[i]; + out[1] = coutput[1][i]; + out[2] = coutput[2][i]; + out[3] = 255; + out += n; + } + } else { + z->YCbCr_to_RGB_kernel(out, y, coutput[1], coutput[2], z->s->img_x, n); + } + } else if (z->s->img_n == 4) { + if (z->app14_color_transform == 0) { // CMYK + for (i=0; i < z->s->img_x; ++i) { + stbi_uc m = coutput[3][i]; + out[0] = stbi__blinn_8x8(coutput[0][i], m); + out[1] = stbi__blinn_8x8(coutput[1][i], m); + out[2] = stbi__blinn_8x8(coutput[2][i], m); + out[3] = 255; + out += n; + } + } else if (z->app14_color_transform == 2) { // YCCK + z->YCbCr_to_RGB_kernel(out, y, coutput[1], coutput[2], z->s->img_x, n); + for (i=0; i < z->s->img_x; ++i) { + stbi_uc m = coutput[3][i]; + out[0] = stbi__blinn_8x8(255 - out[0], m); + out[1] = stbi__blinn_8x8(255 - out[1], m); + out[2] = stbi__blinn_8x8(255 - out[2], m); + out += n; + } + } else { // YCbCr + alpha? Ignore the fourth channel for now + z->YCbCr_to_RGB_kernel(out, y, coutput[1], coutput[2], z->s->img_x, n); + } + } else + for (i=0; i < z->s->img_x; ++i) { + out[0] = out[1] = out[2] = y[i]; + out[3] = 255; // not used if n==3 + out += n; + } + } else { + if (is_rgb) { + if (n == 1) + for (i=0; i < z->s->img_x; ++i) + *out++ = stbi__compute_y(coutput[0][i], coutput[1][i], coutput[2][i]); + else { + for (i=0; i < z->s->img_x; ++i, out += 2) { + out[0] = stbi__compute_y(coutput[0][i], coutput[1][i], coutput[2][i]); + out[1] = 255; + } + } + } else if (z->s->img_n == 4 && z->app14_color_transform == 0) { + for (i=0; i < z->s->img_x; ++i) { + stbi_uc m = coutput[3][i]; + stbi_uc r = stbi__blinn_8x8(coutput[0][i], m); + stbi_uc g = stbi__blinn_8x8(coutput[1][i], m); + stbi_uc b = stbi__blinn_8x8(coutput[2][i], m); + out[0] = stbi__compute_y(r, g, b); + out[1] = 255; + out += n; + } + } else if (z->s->img_n == 4 && z->app14_color_transform == 2) { + for (i=0; i < z->s->img_x; ++i) { + out[0] = stbi__blinn_8x8(255 - coutput[0][i], coutput[3][i]); + out[1] = 255; + out += n; + } + } else { + stbi_uc *y = coutput[0]; + if (n == 1) + for (i=0; i < z->s->img_x; ++i) out[i] = y[i]; + else + for (i=0; i < z->s->img_x; ++i) { *out++ = y[i]; *out++ = 255; } + } + } + } + stbi__cleanup_jpeg(z); + *out_x = z->s->img_x; + *out_y = z->s->img_y; + if (comp) *comp = z->s->img_n >= 3 ? 3 : 1; // report original components, not output + return output; + } +} + +static void *stbi__jpeg_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) +{ + unsigned char* result; + stbi__jpeg* j = (stbi__jpeg*) stbi__malloc(sizeof(stbi__jpeg)); + if (!j) return stbi__errpuc("outofmem", "Out of memory"); + memset(j, 0, sizeof(stbi__jpeg)); + STBI_NOTUSED(ri); + j->s = s; + stbi__setup_jpeg(j); + result = load_jpeg_image(j, x,y,comp,req_comp); + STBI_FREE(j); + return result; +} + +static int stbi__jpeg_test(stbi__context *s) +{ + int r; + stbi__jpeg* j = (stbi__jpeg*)stbi__malloc(sizeof(stbi__jpeg)); + if (!j) return stbi__err("outofmem", "Out of memory"); + memset(j, 0, sizeof(stbi__jpeg)); + j->s = s; + stbi__setup_jpeg(j); + r = stbi__decode_jpeg_header(j, STBI__SCAN_type); + stbi__rewind(s); + STBI_FREE(j); + return r; +} + +static int stbi__jpeg_info_raw(stbi__jpeg *j, int *x, int *y, int *comp) +{ + if (!stbi__decode_jpeg_header(j, STBI__SCAN_header)) { + stbi__rewind( j->s ); + return 0; + } + if (x) *x = j->s->img_x; + if (y) *y = j->s->img_y; + if (comp) *comp = j->s->img_n >= 3 ? 3 : 1; + return 1; +} + +static int stbi__jpeg_info(stbi__context *s, int *x, int *y, int *comp) +{ + int result; + stbi__jpeg* j = (stbi__jpeg*) (stbi__malloc(sizeof(stbi__jpeg))); + if (!j) return stbi__err("outofmem", "Out of memory"); + memset(j, 0, sizeof(stbi__jpeg)); + j->s = s; + result = stbi__jpeg_info_raw(j, x, y, comp); + STBI_FREE(j); + return result; +} +#endif + +// public domain zlib decode v0.2 Sean Barrett 2006-11-18 +// simple implementation +// - all input must be provided in an upfront buffer +// - all output is written to a single output buffer (can malloc/realloc) +// performance +// - fast huffman + +#ifndef STBI_NO_ZLIB + +// fast-way is faster to check than jpeg huffman, but slow way is slower +#define STBI__ZFAST_BITS 9 // accelerate all cases in default tables +#define STBI__ZFAST_MASK ((1 << STBI__ZFAST_BITS) - 1) +#define STBI__ZNSYMS 288 // number of symbols in literal/length alphabet + +// zlib-style huffman encoding +// (jpegs packs from left, zlib from right, so can't share code) +typedef struct +{ + stbi__uint16 fast[1 << STBI__ZFAST_BITS]; + stbi__uint16 firstcode[16]; + int maxcode[17]; + stbi__uint16 firstsymbol[16]; + stbi_uc size[STBI__ZNSYMS]; + stbi__uint16 value[STBI__ZNSYMS]; +} stbi__zhuffman; + +stbi_inline static int stbi__bitreverse16(int n) +{ + n = ((n & 0xAAAA) >> 1) | ((n & 0x5555) << 1); + n = ((n & 0xCCCC) >> 2) | ((n & 0x3333) << 2); + n = ((n & 0xF0F0) >> 4) | ((n & 0x0F0F) << 4); + n = ((n & 0xFF00) >> 8) | ((n & 0x00FF) << 8); + return n; +} + +stbi_inline static int stbi__bit_reverse(int v, int bits) +{ + STBI_ASSERT(bits <= 16); + // to bit reverse n bits, reverse 16 and shift + // e.g. 11 bits, bit reverse and shift away 5 + return stbi__bitreverse16(v) >> (16-bits); +} + +static int stbi__zbuild_huffman(stbi__zhuffman *z, const stbi_uc *sizelist, int num) +{ + int i,k=0; + int code, next_code[16], sizes[17]; + + // DEFLATE spec for generating codes + memset(sizes, 0, sizeof(sizes)); + memset(z->fast, 0, sizeof(z->fast)); + for (i=0; i < num; ++i) + ++sizes[sizelist[i]]; + sizes[0] = 0; + for (i=1; i < 16; ++i) + if (sizes[i] > (1 << i)) + return stbi__err("bad sizes", "Corrupt PNG"); + code = 0; + for (i=1; i < 16; ++i) { + next_code[i] = code; + z->firstcode[i] = (stbi__uint16) code; + z->firstsymbol[i] = (stbi__uint16) k; + code = (code + sizes[i]); + if (sizes[i]) + if (code-1 >= (1 << i)) return stbi__err("bad codelengths","Corrupt PNG"); + z->maxcode[i] = code << (16-i); // preshift for inner loop + code <<= 1; + k += sizes[i]; + } + z->maxcode[16] = 0x10000; // sentinel + for (i=0; i < num; ++i) { + int s = sizelist[i]; + if (s) { + int c = next_code[s] - z->firstcode[s] + z->firstsymbol[s]; + stbi__uint16 fastv = (stbi__uint16) ((s << 9) | i); + z->size [c] = (stbi_uc ) s; + z->value[c] = (stbi__uint16) i; + if (s <= STBI__ZFAST_BITS) { + int j = stbi__bit_reverse(next_code[s],s); + while (j < (1 << STBI__ZFAST_BITS)) { + z->fast[j] = fastv; + j += (1 << s); + } + } + ++next_code[s]; + } + } + return 1; +} + +// zlib-from-memory implementation for PNG reading +// because PNG allows splitting the zlib stream arbitrarily, +// and it's annoying structurally to have PNG call ZLIB call PNG, +// we require PNG read all the IDATs and combine them into a single +// memory buffer + +typedef struct +{ + stbi_uc *zbuffer, *zbuffer_end; + int num_bits; + int hit_zeof_once; + stbi__uint32 code_buffer; + + char *zout; + char *zout_start; + char *zout_end; + int z_expandable; + + stbi__zhuffman z_length, z_distance; +} stbi__zbuf; + +stbi_inline static int stbi__zeof(stbi__zbuf *z) +{ + return (z->zbuffer >= z->zbuffer_end); +} + +stbi_inline static stbi_uc stbi__zget8(stbi__zbuf *z) +{ + return stbi__zeof(z) ? 0 : *z->zbuffer++; +} + +static void stbi__fill_bits(stbi__zbuf *z) +{ + do { + if (z->code_buffer >= (1U << z->num_bits)) { + z->zbuffer = z->zbuffer_end; /* treat this as EOF so we fail. */ + return; + } + z->code_buffer |= (unsigned int) stbi__zget8(z) << z->num_bits; + z->num_bits += 8; + } while (z->num_bits <= 24); +} + +stbi_inline static unsigned int stbi__zreceive(stbi__zbuf *z, int n) +{ + unsigned int k; + if (z->num_bits < n) stbi__fill_bits(z); + k = z->code_buffer & ((1 << n) - 1); + z->code_buffer >>= n; + z->num_bits -= n; + return k; +} + +static int stbi__zhuffman_decode_slowpath(stbi__zbuf *a, stbi__zhuffman *z) +{ + int b,s,k; + // not resolved by fast table, so compute it the slow way + // use jpeg approach, which requires MSbits at top + k = stbi__bit_reverse(a->code_buffer, 16); + for (s=STBI__ZFAST_BITS+1; ; ++s) + if (k < z->maxcode[s]) + break; + if (s >= 16) return -1; // invalid code! + // code size is s, so: + b = (k >> (16-s)) - z->firstcode[s] + z->firstsymbol[s]; + if (b >= STBI__ZNSYMS) return -1; // some data was corrupt somewhere! + if (z->size[b] != s) return -1; // was originally an assert, but report failure instead. + a->code_buffer >>= s; + a->num_bits -= s; + return z->value[b]; +} + +stbi_inline static int stbi__zhuffman_decode(stbi__zbuf *a, stbi__zhuffman *z) +{ + int b,s; + if (a->num_bits < 16) { + if (stbi__zeof(a)) { + if (!a->hit_zeof_once) { + // This is the first time we hit eof, insert 16 extra padding btis + // to allow us to keep going; if we actually consume any of them + // though, that is invalid data. This is caught later. + a->hit_zeof_once = 1; + a->num_bits += 16; // add 16 implicit zero bits + } else { + // We already inserted our extra 16 padding bits and are again + // out, this stream is actually prematurely terminated. + return -1; + } + } else { + stbi__fill_bits(a); + } + } + b = z->fast[a->code_buffer & STBI__ZFAST_MASK]; + if (b) { + s = b >> 9; + a->code_buffer >>= s; + a->num_bits -= s; + return b & 511; + } + return stbi__zhuffman_decode_slowpath(a, z); +} + +static int stbi__zexpand(stbi__zbuf *z, char *zout, int n) // need to make room for n bytes +{ + char *q; + unsigned int cur, limit, old_limit; + z->zout = zout; + if (!z->z_expandable) return stbi__err("output buffer limit","Corrupt PNG"); + cur = (unsigned int) (z->zout - z->zout_start); + limit = old_limit = (unsigned) (z->zout_end - z->zout_start); + if (UINT_MAX - cur < (unsigned) n) return stbi__err("outofmem", "Out of memory"); + while (cur + n > limit) { + if(limit > UINT_MAX / 2) return stbi__err("outofmem", "Out of memory"); + limit *= 2; + } + q = (char *) STBI_REALLOC_SIZED(z->zout_start, old_limit, limit); + STBI_NOTUSED(old_limit); + if (q == NULL) return stbi__err("outofmem", "Out of memory"); + z->zout_start = q; + z->zout = q + cur; + z->zout_end = q + limit; + return 1; +} + +static const int stbi__zlength_base[31] = { + 3,4,5,6,7,8,9,10,11,13, + 15,17,19,23,27,31,35,43,51,59, + 67,83,99,115,131,163,195,227,258,0,0 }; + +static const int stbi__zlength_extra[31]= +{ 0,0,0,0,0,0,0,0,1,1,1,1,2,2,2,2,3,3,3,3,4,4,4,4,5,5,5,5,0,0,0 }; + +static const int stbi__zdist_base[32] = { 1,2,3,4,5,7,9,13,17,25,33,49,65,97,129,193, +257,385,513,769,1025,1537,2049,3073,4097,6145,8193,12289,16385,24577,0,0}; + +static const int stbi__zdist_extra[32] = +{ 0,0,0,0,1,1,2,2,3,3,4,4,5,5,6,6,7,7,8,8,9,9,10,10,11,11,12,12,13,13}; + +static int stbi__parse_huffman_block(stbi__zbuf *a) +{ + char *zout = a->zout; + for(;;) { + int z = stbi__zhuffman_decode(a, &a->z_length); + if (z < 256) { + if (z < 0) return stbi__err("bad huffman code","Corrupt PNG"); // error in huffman codes + if (zout >= a->zout_end) { + if (!stbi__zexpand(a, zout, 1)) return 0; + zout = a->zout; + } + *zout++ = (char) z; + } else { + stbi_uc *p; + int len,dist; + if (z == 256) { + a->zout = zout; + if (a->hit_zeof_once && a->num_bits < 16) { + // The first time we hit zeof, we inserted 16 extra zero bits into our bit + // buffer so the decoder can just do its speculative decoding. But if we + // actually consumed any of those bits (which is the case when num_bits < 16), + // the stream actually read past the end so it is malformed. + return stbi__err("unexpected end","Corrupt PNG"); + } + return 1; + } + if (z >= 286) return stbi__err("bad huffman code","Corrupt PNG"); // per DEFLATE, length codes 286 and 287 must not appear in compressed data + z -= 257; + len = stbi__zlength_base[z]; + if (stbi__zlength_extra[z]) len += stbi__zreceive(a, stbi__zlength_extra[z]); + z = stbi__zhuffman_decode(a, &a->z_distance); + if (z < 0 || z >= 30) return stbi__err("bad huffman code","Corrupt PNG"); // per DEFLATE, distance codes 30 and 31 must not appear in compressed data + dist = stbi__zdist_base[z]; + if (stbi__zdist_extra[z]) dist += stbi__zreceive(a, stbi__zdist_extra[z]); + if (zout - a->zout_start < dist) return stbi__err("bad dist","Corrupt PNG"); + if (len > a->zout_end - zout) { + if (!stbi__zexpand(a, zout, len)) return 0; + zout = a->zout; + } + p = (stbi_uc *) (zout - dist); + if (dist == 1) { // run of one byte; common in images. + stbi_uc v = *p; + if (len) { do *zout++ = v; while (--len); } + } else { + if (len) { do *zout++ = *p++; while (--len); } + } + } + } +} + +static int stbi__compute_huffman_codes(stbi__zbuf *a) +{ + static const stbi_uc length_dezigzag[19] = { 16,17,18,0,8,7,9,6,10,5,11,4,12,3,13,2,14,1,15 }; + stbi__zhuffman z_codelength; + stbi_uc lencodes[286+32+137];//padding for maximum single op + stbi_uc codelength_sizes[19]; + int i,n; + + int hlit = stbi__zreceive(a,5) + 257; + int hdist = stbi__zreceive(a,5) + 1; + int hclen = stbi__zreceive(a,4) + 4; + int ntot = hlit + hdist; + + memset(codelength_sizes, 0, sizeof(codelength_sizes)); + for (i=0; i < hclen; ++i) { + int s = stbi__zreceive(a,3); + codelength_sizes[length_dezigzag[i]] = (stbi_uc) s; + } + if (!stbi__zbuild_huffman(&z_codelength, codelength_sizes, 19)) return 0; + + n = 0; + while (n < ntot) { + int c = stbi__zhuffman_decode(a, &z_codelength); + if (c < 0 || c >= 19) return stbi__err("bad codelengths", "Corrupt PNG"); + if (c < 16) + lencodes[n++] = (stbi_uc) c; + else { + stbi_uc fill = 0; + if (c == 16) { + c = stbi__zreceive(a,2)+3; + if (n == 0) return stbi__err("bad codelengths", "Corrupt PNG"); + fill = lencodes[n-1]; + } else if (c == 17) { + c = stbi__zreceive(a,3)+3; + } else if (c == 18) { + c = stbi__zreceive(a,7)+11; + } else { + return stbi__err("bad codelengths", "Corrupt PNG"); + } + if (ntot - n < c) return stbi__err("bad codelengths", "Corrupt PNG"); + memset(lencodes+n, fill, c); + n += c; + } + } + if (n != ntot) return stbi__err("bad codelengths","Corrupt PNG"); + if (!stbi__zbuild_huffman(&a->z_length, lencodes, hlit)) return 0; + if (!stbi__zbuild_huffman(&a->z_distance, lencodes+hlit, hdist)) return 0; + return 1; +} + +static int stbi__parse_uncompressed_block(stbi__zbuf *a) +{ + stbi_uc header[4]; + int len,nlen,k; + if (a->num_bits & 7) + stbi__zreceive(a, a->num_bits & 7); // discard + // drain the bit-packed data into header + k = 0; + while (a->num_bits > 0) { + header[k++] = (stbi_uc) (a->code_buffer & 255); // suppress MSVC run-time check + a->code_buffer >>= 8; + a->num_bits -= 8; + } + if (a->num_bits < 0) return stbi__err("zlib corrupt","Corrupt PNG"); + // now fill header the normal way + while (k < 4) + header[k++] = stbi__zget8(a); + len = header[1] * 256 + header[0]; + nlen = header[3] * 256 + header[2]; + if (nlen != (len ^ 0xffff)) return stbi__err("zlib corrupt","Corrupt PNG"); + if (a->zbuffer + len > a->zbuffer_end) return stbi__err("read past buffer","Corrupt PNG"); + if (a->zout + len > a->zout_end) + if (!stbi__zexpand(a, a->zout, len)) return 0; + memcpy(a->zout, a->zbuffer, len); + a->zbuffer += len; + a->zout += len; + return 1; +} + +static int stbi__parse_zlib_header(stbi__zbuf *a) +{ + int cmf = stbi__zget8(a); + int cm = cmf & 15; + /* int cinfo = cmf >> 4; */ + int flg = stbi__zget8(a); + if (stbi__zeof(a)) return stbi__err("bad zlib header","Corrupt PNG"); // zlib spec + if ((cmf*256+flg) % 31 != 0) return stbi__err("bad zlib header","Corrupt PNG"); // zlib spec + if (flg & 32) return stbi__err("no preset dict","Corrupt PNG"); // preset dictionary not allowed in png + if (cm != 8) return stbi__err("bad compression","Corrupt PNG"); // DEFLATE required for png + // window = 1 << (8 + cinfo)... but who cares, we fully buffer output + return 1; +} + +static const stbi_uc stbi__zdefault_length[STBI__ZNSYMS] = +{ + 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, + 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, + 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, + 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, + 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, + 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, + 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, + 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, + 7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7, 7,7,7,7,7,7,7,7,8,8,8,8,8,8,8,8 +}; +static const stbi_uc stbi__zdefault_distance[32] = +{ + 5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5 +}; +/* +Init algorithm: +{ + int i; // use <= to match clearly with spec + for (i=0; i <= 143; ++i) stbi__zdefault_length[i] = 8; + for ( ; i <= 255; ++i) stbi__zdefault_length[i] = 9; + for ( ; i <= 279; ++i) stbi__zdefault_length[i] = 7; + for ( ; i <= 287; ++i) stbi__zdefault_length[i] = 8; + + for (i=0; i <= 31; ++i) stbi__zdefault_distance[i] = 5; +} +*/ + +static int stbi__parse_zlib(stbi__zbuf *a, int parse_header) +{ + int final, type; + if (parse_header) + if (!stbi__parse_zlib_header(a)) return 0; + a->num_bits = 0; + a->code_buffer = 0; + a->hit_zeof_once = 0; + do { + final = stbi__zreceive(a,1); + type = stbi__zreceive(a,2); + if (type == 0) { + if (!stbi__parse_uncompressed_block(a)) return 0; + } else if (type == 3) { + return 0; + } else { + if (type == 1) { + // use fixed code lengths + if (!stbi__zbuild_huffman(&a->z_length , stbi__zdefault_length , STBI__ZNSYMS)) return 0; + if (!stbi__zbuild_huffman(&a->z_distance, stbi__zdefault_distance, 32)) return 0; + } else { + if (!stbi__compute_huffman_codes(a)) return 0; + } + if (!stbi__parse_huffman_block(a)) return 0; + } + } while (!final); + return 1; +} + +static int stbi__do_zlib(stbi__zbuf *a, char *obuf, int olen, int exp, int parse_header) +{ + a->zout_start = obuf; + a->zout = obuf; + a->zout_end = obuf + olen; + a->z_expandable = exp; + + return stbi__parse_zlib(a, parse_header); +} + +STBIDEF char *stbi_zlib_decode_malloc_guesssize(const char *buffer, int len, int initial_size, int *outlen) +{ + stbi__zbuf a; + char *p = (char *) stbi__malloc(initial_size); + if (p == NULL) return NULL; + a.zbuffer = (stbi_uc *) buffer; + a.zbuffer_end = (stbi_uc *) buffer + len; + if (stbi__do_zlib(&a, p, initial_size, 1, 1)) { + if (outlen) *outlen = (int) (a.zout - a.zout_start); + return a.zout_start; + } else { + STBI_FREE(a.zout_start); + return NULL; + } +} + +STBIDEF char *stbi_zlib_decode_malloc(char const *buffer, int len, int *outlen) +{ + return stbi_zlib_decode_malloc_guesssize(buffer, len, 16384, outlen); +} + +STBIDEF char *stbi_zlib_decode_malloc_guesssize_headerflag(const char *buffer, int len, int initial_size, int *outlen, int parse_header) +{ + stbi__zbuf a; + char *p = (char *) stbi__malloc(initial_size); + if (p == NULL) return NULL; + a.zbuffer = (stbi_uc *) buffer; + a.zbuffer_end = (stbi_uc *) buffer + len; + if (stbi__do_zlib(&a, p, initial_size, 1, parse_header)) { + if (outlen) *outlen = (int) (a.zout - a.zout_start); + return a.zout_start; + } else { + STBI_FREE(a.zout_start); + return NULL; + } +} + +STBIDEF int stbi_zlib_decode_buffer(char *obuffer, int olen, char const *ibuffer, int ilen) +{ + stbi__zbuf a; + a.zbuffer = (stbi_uc *) ibuffer; + a.zbuffer_end = (stbi_uc *) ibuffer + ilen; + if (stbi__do_zlib(&a, obuffer, olen, 0, 1)) + return (int) (a.zout - a.zout_start); + else + return -1; +} + +STBIDEF char *stbi_zlib_decode_noheader_malloc(char const *buffer, int len, int *outlen) +{ + stbi__zbuf a; + char *p = (char *) stbi__malloc(16384); + if (p == NULL) return NULL; + a.zbuffer = (stbi_uc *) buffer; + a.zbuffer_end = (stbi_uc *) buffer+len; + if (stbi__do_zlib(&a, p, 16384, 1, 0)) { + if (outlen) *outlen = (int) (a.zout - a.zout_start); + return a.zout_start; + } else { + STBI_FREE(a.zout_start); + return NULL; + } +} + +STBIDEF int stbi_zlib_decode_noheader_buffer(char *obuffer, int olen, const char *ibuffer, int ilen) +{ + stbi__zbuf a; + a.zbuffer = (stbi_uc *) ibuffer; + a.zbuffer_end = (stbi_uc *) ibuffer + ilen; + if (stbi__do_zlib(&a, obuffer, olen, 0, 0)) + return (int) (a.zout - a.zout_start); + else + return -1; +} +#endif + +// public domain "baseline" PNG decoder v0.10 Sean Barrett 2006-11-18 +// simple implementation +// - only 8-bit samples +// - no CRC checking +// - allocates lots of intermediate memory +// - avoids problem of streaming data between subsystems +// - avoids explicit window management +// performance +// - uses stb_zlib, a PD zlib implementation with fast huffman decoding + +#ifndef STBI_NO_PNG +typedef struct +{ + stbi__uint32 length; + stbi__uint32 type; +} stbi__pngchunk; + +static stbi__pngchunk stbi__get_chunk_header(stbi__context *s) +{ + stbi__pngchunk c; + c.length = stbi__get32be(s); + c.type = stbi__get32be(s); + return c; +} + +static int stbi__check_png_header(stbi__context *s) +{ + static const stbi_uc png_sig[8] = { 137,80,78,71,13,10,26,10 }; + int i; + for (i=0; i < 8; ++i) + if (stbi__get8(s) != png_sig[i]) return stbi__err("bad png sig","Not a PNG"); + return 1; +} + +typedef struct +{ + stbi__context *s; + stbi_uc *idata, *expanded, *out; + int depth; +} stbi__png; + + +enum { + STBI__F_none=0, + STBI__F_sub=1, + STBI__F_up=2, + STBI__F_avg=3, + STBI__F_paeth=4, + // synthetic filter used for first scanline to avoid needing a dummy row of 0s + STBI__F_avg_first +}; + +static stbi_uc first_row_filter[5] = +{ + STBI__F_none, + STBI__F_sub, + STBI__F_none, + STBI__F_avg_first, + STBI__F_sub // Paeth with b=c=0 turns out to be equivalent to sub +}; + +static int stbi__paeth(int a, int b, int c) +{ + // This formulation looks very different from the reference in the PNG spec, but is + // actually equivalent and has favorable data dependencies and admits straightforward + // generation of branch-free code, which helps performance significantly. + int thresh = c*3 - (a + b); + int lo = a < b ? a : b; + int hi = a < b ? b : a; + int t0 = (hi <= thresh) ? lo : c; + int t1 = (thresh <= lo) ? hi : t0; + return t1; +} + +static const stbi_uc stbi__depth_scale_table[9] = { 0, 0xff, 0x55, 0, 0x11, 0,0,0, 0x01 }; + +// adds an extra all-255 alpha channel +// dest == src is legal +// img_n must be 1 or 3 +static void stbi__create_png_alpha_expand8(stbi_uc *dest, stbi_uc *src, stbi__uint32 x, int img_n) +{ + int i; + // must process data backwards since we allow dest==src + if (img_n == 1) { + for (i=x-1; i >= 0; --i) { + dest[i*2+1] = 255; + dest[i*2+0] = src[i]; + } + } else { + STBI_ASSERT(img_n == 3); + for (i=x-1; i >= 0; --i) { + dest[i*4+3] = 255; + dest[i*4+2] = src[i*3+2]; + dest[i*4+1] = src[i*3+1]; + dest[i*4+0] = src[i*3+0]; + } + } +} + +// create the png data from post-deflated data +static int stbi__create_png_image_raw(stbi__png *a, stbi_uc *raw, stbi__uint32 raw_len, int out_n, stbi__uint32 x, stbi__uint32 y, int depth, int color) +{ + int bytes = (depth == 16 ? 2 : 1); + stbi__context *s = a->s; + stbi__uint32 i,j,stride = x*out_n*bytes; + stbi__uint32 img_len, img_width_bytes; + stbi_uc *filter_buf; + int all_ok = 1; + int k; + int img_n = s->img_n; // copy it into a local for later + + int output_bytes = out_n*bytes; + int filter_bytes = img_n*bytes; + int width = x; + + STBI_ASSERT(out_n == s->img_n || out_n == s->img_n+1); + a->out = (stbi_uc *) stbi__malloc_mad3(x, y, output_bytes, 0); // extra bytes to write off the end into + if (!a->out) return stbi__err("outofmem", "Out of memory"); + + // note: error exits here don't need to clean up a->out individually, + // stbi__do_png always does on error. + if (!stbi__mad3sizes_valid(img_n, x, depth, 7)) return stbi__err("too large", "Corrupt PNG"); + img_width_bytes = (((img_n * x * depth) + 7) >> 3); + if (!stbi__mad2sizes_valid(img_width_bytes, y, img_width_bytes)) return stbi__err("too large", "Corrupt PNG"); + img_len = (img_width_bytes + 1) * y; + + // we used to check for exact match between raw_len and img_len on non-interlaced PNGs, + // but issue #276 reported a PNG in the wild that had extra data at the end (all zeros), + // so just check for raw_len < img_len always. + if (raw_len < img_len) return stbi__err("not enough pixels","Corrupt PNG"); + + // Allocate two scan lines worth of filter workspace buffer. + filter_buf = (stbi_uc *) stbi__malloc_mad2(img_width_bytes, 2, 0); + if (!filter_buf) return stbi__err("outofmem", "Out of memory"); + + // Filtering for low-bit-depth images + if (depth < 8) { + filter_bytes = 1; + width = img_width_bytes; + } + + for (j=0; j < y; ++j) { + // cur/prior filter buffers alternate + stbi_uc *cur = filter_buf + (j & 1)*img_width_bytes; + stbi_uc *prior = filter_buf + (~j & 1)*img_width_bytes; + stbi_uc *dest = a->out + stride*j; + int nk = width * filter_bytes; + int filter = *raw++; + + // check filter type + if (filter > 4) { + all_ok = stbi__err("invalid filter","Corrupt PNG"); + break; + } + + // if first row, use special filter that doesn't sample previous row + if (j == 0) filter = first_row_filter[filter]; + + // perform actual filtering + switch (filter) { + case STBI__F_none: + memcpy(cur, raw, nk); + break; + case STBI__F_sub: + memcpy(cur, raw, filter_bytes); + for (k = filter_bytes; k < nk; ++k) + cur[k] = STBI__BYTECAST(raw[k] + cur[k-filter_bytes]); + break; + case STBI__F_up: + for (k = 0; k < nk; ++k) + cur[k] = STBI__BYTECAST(raw[k] + prior[k]); + break; + case STBI__F_avg: + for (k = 0; k < filter_bytes; ++k) + cur[k] = STBI__BYTECAST(raw[k] + (prior[k]>>1)); + for (k = filter_bytes; k < nk; ++k) + cur[k] = STBI__BYTECAST(raw[k] + ((prior[k] + cur[k-filter_bytes])>>1)); + break; + case STBI__F_paeth: + for (k = 0; k < filter_bytes; ++k) + cur[k] = STBI__BYTECAST(raw[k] + prior[k]); // prior[k] == stbi__paeth(0,prior[k],0) + for (k = filter_bytes; k < nk; ++k) + cur[k] = STBI__BYTECAST(raw[k] + stbi__paeth(cur[k-filter_bytes], prior[k], prior[k-filter_bytes])); + break; + case STBI__F_avg_first: + memcpy(cur, raw, filter_bytes); + for (k = filter_bytes; k < nk; ++k) + cur[k] = STBI__BYTECAST(raw[k] + (cur[k-filter_bytes] >> 1)); + break; + } + + raw += nk; + + // expand decoded bits in cur to dest, also adding an extra alpha channel if desired + if (depth < 8) { + stbi_uc scale = (color == 0) ? stbi__depth_scale_table[depth] : 1; // scale grayscale values to 0..255 range + stbi_uc *in = cur; + stbi_uc *out = dest; + stbi_uc inb = 0; + stbi__uint32 nsmp = x*img_n; + + // expand bits to bytes first + if (depth == 4) { + for (i=0; i < nsmp; ++i) { + if ((i & 1) == 0) inb = *in++; + *out++ = scale * (inb >> 4); + inb <<= 4; + } + } else if (depth == 2) { + for (i=0; i < nsmp; ++i) { + if ((i & 3) == 0) inb = *in++; + *out++ = scale * (inb >> 6); + inb <<= 2; + } + } else { + STBI_ASSERT(depth == 1); + for (i=0; i < nsmp; ++i) { + if ((i & 7) == 0) inb = *in++; + *out++ = scale * (inb >> 7); + inb <<= 1; + } + } + + // insert alpha=255 values if desired + if (img_n != out_n) + stbi__create_png_alpha_expand8(dest, dest, x, img_n); + } else if (depth == 8) { + if (img_n == out_n) + memcpy(dest, cur, x*img_n); + else + stbi__create_png_alpha_expand8(dest, cur, x, img_n); + } else if (depth == 16) { + // convert the image data from big-endian to platform-native + stbi__uint16 *dest16 = (stbi__uint16*)dest; + stbi__uint32 nsmp = x*img_n; + + if (img_n == out_n) { + for (i = 0; i < nsmp; ++i, ++dest16, cur += 2) + *dest16 = (cur[0] << 8) | cur[1]; + } else { + STBI_ASSERT(img_n+1 == out_n); + if (img_n == 1) { + for (i = 0; i < x; ++i, dest16 += 2, cur += 2) { + dest16[0] = (cur[0] << 8) | cur[1]; + dest16[1] = 0xffff; + } + } else { + STBI_ASSERT(img_n == 3); + for (i = 0; i < x; ++i, dest16 += 4, cur += 6) { + dest16[0] = (cur[0] << 8) | cur[1]; + dest16[1] = (cur[2] << 8) | cur[3]; + dest16[2] = (cur[4] << 8) | cur[5]; + dest16[3] = 0xffff; + } + } + } + } + } + + STBI_FREE(filter_buf); + if (!all_ok) return 0; + + return 1; +} + +static int stbi__create_png_image(stbi__png *a, stbi_uc *image_data, stbi__uint32 image_data_len, int out_n, int depth, int color, int interlaced) +{ + int bytes = (depth == 16 ? 2 : 1); + int out_bytes = out_n * bytes; + stbi_uc *final; + int p; + if (!interlaced) + return stbi__create_png_image_raw(a, image_data, image_data_len, out_n, a->s->img_x, a->s->img_y, depth, color); + + // de-interlacing + final = (stbi_uc *) stbi__malloc_mad3(a->s->img_x, a->s->img_y, out_bytes, 0); + if (!final) return stbi__err("outofmem", "Out of memory"); + for (p=0; p < 7; ++p) { + int xorig[] = { 0,4,0,2,0,1,0 }; + int yorig[] = { 0,0,4,0,2,0,1 }; + int xspc[] = { 8,8,4,4,2,2,1 }; + int yspc[] = { 8,8,8,4,4,2,2 }; + int i,j,x,y; + // pass1_x[4] = 0, pass1_x[5] = 1, pass1_x[12] = 1 + x = (a->s->img_x - xorig[p] + xspc[p]-1) / xspc[p]; + y = (a->s->img_y - yorig[p] + yspc[p]-1) / yspc[p]; + if (x && y) { + stbi__uint32 img_len = ((((a->s->img_n * x * depth) + 7) >> 3) + 1) * y; + if (!stbi__create_png_image_raw(a, image_data, image_data_len, out_n, x, y, depth, color)) { + STBI_FREE(final); + return 0; + } + for (j=0; j < y; ++j) { + for (i=0; i < x; ++i) { + int out_y = j*yspc[p]+yorig[p]; + int out_x = i*xspc[p]+xorig[p]; + memcpy(final + out_y*a->s->img_x*out_bytes + out_x*out_bytes, + a->out + (j*x+i)*out_bytes, out_bytes); + } + } + STBI_FREE(a->out); + image_data += img_len; + image_data_len -= img_len; + } + } + a->out = final; + + return 1; +} + +static int stbi__compute_transparency(stbi__png *z, stbi_uc tc[3], int out_n) +{ + stbi__context *s = z->s; + stbi__uint32 i, pixel_count = s->img_x * s->img_y; + stbi_uc *p = z->out; + + // compute color-based transparency, assuming we've + // already got 255 as the alpha value in the output + STBI_ASSERT(out_n == 2 || out_n == 4); + + if (out_n == 2) { + for (i=0; i < pixel_count; ++i) { + p[1] = (p[0] == tc[0] ? 0 : 255); + p += 2; + } + } else { + for (i=0; i < pixel_count; ++i) { + if (p[0] == tc[0] && p[1] == tc[1] && p[2] == tc[2]) + p[3] = 0; + p += 4; + } + } + return 1; +} + +static int stbi__compute_transparency16(stbi__png *z, stbi__uint16 tc[3], int out_n) +{ + stbi__context *s = z->s; + stbi__uint32 i, pixel_count = s->img_x * s->img_y; + stbi__uint16 *p = (stbi__uint16*) z->out; + + // compute color-based transparency, assuming we've + // already got 65535 as the alpha value in the output + STBI_ASSERT(out_n == 2 || out_n == 4); + + if (out_n == 2) { + for (i = 0; i < pixel_count; ++i) { + p[1] = (p[0] == tc[0] ? 0 : 65535); + p += 2; + } + } else { + for (i = 0; i < pixel_count; ++i) { + if (p[0] == tc[0] && p[1] == tc[1] && p[2] == tc[2]) + p[3] = 0; + p += 4; + } + } + return 1; +} + +static int stbi__expand_png_palette(stbi__png *a, stbi_uc *palette, int len, int pal_img_n) +{ + stbi__uint32 i, pixel_count = a->s->img_x * a->s->img_y; + stbi_uc *p, *temp_out, *orig = a->out; + + p = (stbi_uc *) stbi__malloc_mad2(pixel_count, pal_img_n, 0); + if (p == NULL) return stbi__err("outofmem", "Out of memory"); + + // between here and free(out) below, exitting would leak + temp_out = p; + + if (pal_img_n == 3) { + for (i=0; i < pixel_count; ++i) { + int n = orig[i]*4; + p[0] = palette[n ]; + p[1] = palette[n+1]; + p[2] = palette[n+2]; + p += 3; + } + } else { + for (i=0; i < pixel_count; ++i) { + int n = orig[i]*4; + p[0] = palette[n ]; + p[1] = palette[n+1]; + p[2] = palette[n+2]; + p[3] = palette[n+3]; + p += 4; + } + } + STBI_FREE(a->out); + a->out = temp_out; + + STBI_NOTUSED(len); + + return 1; +} + +static int stbi__unpremultiply_on_load_global = 0; +static int stbi__de_iphone_flag_global = 0; + +STBIDEF void stbi_set_unpremultiply_on_load(int flag_true_if_should_unpremultiply) +{ + stbi__unpremultiply_on_load_global = flag_true_if_should_unpremultiply; +} + +STBIDEF void stbi_convert_iphone_png_to_rgb(int flag_true_if_should_convert) +{ + stbi__de_iphone_flag_global = flag_true_if_should_convert; +} + +#ifndef STBI_THREAD_LOCAL +#define stbi__unpremultiply_on_load stbi__unpremultiply_on_load_global +#define stbi__de_iphone_flag stbi__de_iphone_flag_global +#else +static STBI_THREAD_LOCAL int stbi__unpremultiply_on_load_local, stbi__unpremultiply_on_load_set; +static STBI_THREAD_LOCAL int stbi__de_iphone_flag_local, stbi__de_iphone_flag_set; + +STBIDEF void stbi_set_unpremultiply_on_load_thread(int flag_true_if_should_unpremultiply) +{ + stbi__unpremultiply_on_load_local = flag_true_if_should_unpremultiply; + stbi__unpremultiply_on_load_set = 1; +} + +STBIDEF void stbi_convert_iphone_png_to_rgb_thread(int flag_true_if_should_convert) +{ + stbi__de_iphone_flag_local = flag_true_if_should_convert; + stbi__de_iphone_flag_set = 1; +} + +#define stbi__unpremultiply_on_load (stbi__unpremultiply_on_load_set \ + ? stbi__unpremultiply_on_load_local \ + : stbi__unpremultiply_on_load_global) +#define stbi__de_iphone_flag (stbi__de_iphone_flag_set \ + ? stbi__de_iphone_flag_local \ + : stbi__de_iphone_flag_global) +#endif // STBI_THREAD_LOCAL + +static void stbi__de_iphone(stbi__png *z) +{ + stbi__context *s = z->s; + stbi__uint32 i, pixel_count = s->img_x * s->img_y; + stbi_uc *p = z->out; + + if (s->img_out_n == 3) { // convert bgr to rgb + for (i=0; i < pixel_count; ++i) { + stbi_uc t = p[0]; + p[0] = p[2]; + p[2] = t; + p += 3; + } + } else { + STBI_ASSERT(s->img_out_n == 4); + if (stbi__unpremultiply_on_load) { + // convert bgr to rgb and unpremultiply + for (i=0; i < pixel_count; ++i) { + stbi_uc a = p[3]; + stbi_uc t = p[0]; + if (a) { + stbi_uc half = a / 2; + p[0] = (p[2] * 255 + half) / a; + p[1] = (p[1] * 255 + half) / a; + p[2] = ( t * 255 + half) / a; + } else { + p[0] = p[2]; + p[2] = t; + } + p += 4; + } + } else { + // convert bgr to rgb + for (i=0; i < pixel_count; ++i) { + stbi_uc t = p[0]; + p[0] = p[2]; + p[2] = t; + p += 4; + } + } + } +} + +#define STBI__PNG_TYPE(a,b,c,d) (((unsigned) (a) << 24) + ((unsigned) (b) << 16) + ((unsigned) (c) << 8) + (unsigned) (d)) + +static int stbi__parse_png_file(stbi__png *z, int scan, int req_comp) +{ + stbi_uc palette[1024], pal_img_n=0; + stbi_uc has_trans=0, tc[3]={0}; + stbi__uint16 tc16[3]; + stbi__uint32 ioff=0, idata_limit=0, i, pal_len=0; + int first=1,k,interlace=0, color=0, is_iphone=0; + stbi__context *s = z->s; + + z->expanded = NULL; + z->idata = NULL; + z->out = NULL; + + if (!stbi__check_png_header(s)) return 0; + + if (scan == STBI__SCAN_type) return 1; + + for (;;) { + stbi__pngchunk c = stbi__get_chunk_header(s); + switch (c.type) { + case STBI__PNG_TYPE('C','g','B','I'): + is_iphone = 1; + stbi__skip(s, c.length); + break; + case STBI__PNG_TYPE('I','H','D','R'): { + int comp,filter; + if (!first) return stbi__err("multiple IHDR","Corrupt PNG"); + first = 0; + if (c.length != 13) return stbi__err("bad IHDR len","Corrupt PNG"); + s->img_x = stbi__get32be(s); + s->img_y = stbi__get32be(s); + if (s->img_y > STBI_MAX_DIMENSIONS) return stbi__err("too large","Very large image (corrupt?)"); + if (s->img_x > STBI_MAX_DIMENSIONS) return stbi__err("too large","Very large image (corrupt?)"); + z->depth = stbi__get8(s); if (z->depth != 1 && z->depth != 2 && z->depth != 4 && z->depth != 8 && z->depth != 16) return stbi__err("1/2/4/8/16-bit only","PNG not supported: 1/2/4/8/16-bit only"); + color = stbi__get8(s); if (color > 6) return stbi__err("bad ctype","Corrupt PNG"); + if (color == 3 && z->depth == 16) return stbi__err("bad ctype","Corrupt PNG"); + if (color == 3) pal_img_n = 3; else if (color & 1) return stbi__err("bad ctype","Corrupt PNG"); + comp = stbi__get8(s); if (comp) return stbi__err("bad comp method","Corrupt PNG"); + filter= stbi__get8(s); if (filter) return stbi__err("bad filter method","Corrupt PNG"); + interlace = stbi__get8(s); if (interlace>1) return stbi__err("bad interlace method","Corrupt PNG"); + if (!s->img_x || !s->img_y) return stbi__err("0-pixel image","Corrupt PNG"); + if (!pal_img_n) { + s->img_n = (color & 2 ? 3 : 1) + (color & 4 ? 1 : 0); + if ((1 << 30) / s->img_x / s->img_n < s->img_y) return stbi__err("too large", "Image too large to decode"); + } else { + // if paletted, then pal_n is our final components, and + // img_n is # components to decompress/filter. + s->img_n = 1; + if ((1 << 30) / s->img_x / 4 < s->img_y) return stbi__err("too large","Corrupt PNG"); + } + // even with SCAN_header, have to scan to see if we have a tRNS + break; + } + + case STBI__PNG_TYPE('P','L','T','E'): { + if (first) return stbi__err("first not IHDR", "Corrupt PNG"); + if (c.length > 256*3) return stbi__err("invalid PLTE","Corrupt PNG"); + pal_len = c.length / 3; + if (pal_len * 3 != c.length) return stbi__err("invalid PLTE","Corrupt PNG"); + for (i=0; i < pal_len; ++i) { + palette[i*4+0] = stbi__get8(s); + palette[i*4+1] = stbi__get8(s); + palette[i*4+2] = stbi__get8(s); + palette[i*4+3] = 255; + } + break; + } + + case STBI__PNG_TYPE('t','R','N','S'): { + if (first) return stbi__err("first not IHDR", "Corrupt PNG"); + if (z->idata) return stbi__err("tRNS after IDAT","Corrupt PNG"); + if (pal_img_n) { + if (scan == STBI__SCAN_header) { s->img_n = 4; return 1; } + if (pal_len == 0) return stbi__err("tRNS before PLTE","Corrupt PNG"); + if (c.length > pal_len) return stbi__err("bad tRNS len","Corrupt PNG"); + pal_img_n = 4; + for (i=0; i < c.length; ++i) + palette[i*4+3] = stbi__get8(s); + } else { + if (!(s->img_n & 1)) return stbi__err("tRNS with alpha","Corrupt PNG"); + if (c.length != (stbi__uint32) s->img_n*2) return stbi__err("bad tRNS len","Corrupt PNG"); + has_trans = 1; + // non-paletted with tRNS = constant alpha. if header-scanning, we can stop now. + if (scan == STBI__SCAN_header) { ++s->img_n; return 1; } + if (z->depth == 16) { + for (k = 0; k < s->img_n && k < 3; ++k) // extra loop test to suppress false GCC warning + tc16[k] = (stbi__uint16)stbi__get16be(s); // copy the values as-is + } else { + for (k = 0; k < s->img_n && k < 3; ++k) + tc[k] = (stbi_uc)(stbi__get16be(s) & 255) * stbi__depth_scale_table[z->depth]; // non 8-bit images will be larger + } + } + break; + } + + case STBI__PNG_TYPE('I','D','A','T'): { + if (first) return stbi__err("first not IHDR", "Corrupt PNG"); + if (pal_img_n && !pal_len) return stbi__err("no PLTE","Corrupt PNG"); + if (scan == STBI__SCAN_header) { + // header scan definitely stops at first IDAT + if (pal_img_n) + s->img_n = pal_img_n; + return 1; + } + if (c.length > (1u << 30)) return stbi__err("IDAT size limit", "IDAT section larger than 2^30 bytes"); + if ((int)(ioff + c.length) < (int)ioff) return 0; + if (ioff + c.length > idata_limit) { + stbi__uint32 idata_limit_old = idata_limit; + stbi_uc *p; + if (idata_limit == 0) idata_limit = c.length > 4096 ? c.length : 4096; + while (ioff + c.length > idata_limit) + idata_limit *= 2; + STBI_NOTUSED(idata_limit_old); + p = (stbi_uc *) STBI_REALLOC_SIZED(z->idata, idata_limit_old, idata_limit); if (p == NULL) return stbi__err("outofmem", "Out of memory"); + z->idata = p; + } + if (!stbi__getn(s, z->idata+ioff,c.length)) return stbi__err("outofdata","Corrupt PNG"); + ioff += c.length; + break; + } + + case STBI__PNG_TYPE('I','E','N','D'): { + stbi__uint32 raw_len, bpl; + if (first) return stbi__err("first not IHDR", "Corrupt PNG"); + if (scan != STBI__SCAN_load) return 1; + if (z->idata == NULL) return stbi__err("no IDAT","Corrupt PNG"); + // initial guess for decoded data size to avoid unnecessary reallocs + bpl = (s->img_x * z->depth + 7) / 8; // bytes per line, per component + raw_len = bpl * s->img_y * s->img_n /* pixels */ + s->img_y /* filter mode per row */; + z->expanded = (stbi_uc *) stbi_zlib_decode_malloc_guesssize_headerflag((char *) z->idata, ioff, raw_len, (int *) &raw_len, !is_iphone); + if (z->expanded == NULL) return 0; // zlib should set error + STBI_FREE(z->idata); z->idata = NULL; + if ((req_comp == s->img_n+1 && req_comp != 3 && !pal_img_n) || has_trans) + s->img_out_n = s->img_n+1; + else + s->img_out_n = s->img_n; + if (!stbi__create_png_image(z, z->expanded, raw_len, s->img_out_n, z->depth, color, interlace)) return 0; + if (has_trans) { + if (z->depth == 16) { + if (!stbi__compute_transparency16(z, tc16, s->img_out_n)) return 0; + } else { + if (!stbi__compute_transparency(z, tc, s->img_out_n)) return 0; + } + } + if (is_iphone && stbi__de_iphone_flag && s->img_out_n > 2) + stbi__de_iphone(z); + if (pal_img_n) { + // pal_img_n == 3 or 4 + s->img_n = pal_img_n; // record the actual colors we had + s->img_out_n = pal_img_n; + if (req_comp >= 3) s->img_out_n = req_comp; + if (!stbi__expand_png_palette(z, palette, pal_len, s->img_out_n)) + return 0; + } else if (has_trans) { + // non-paletted image with tRNS -> source image has (constant) alpha + ++s->img_n; + } + STBI_FREE(z->expanded); z->expanded = NULL; + // end of PNG chunk, read and skip CRC + stbi__get32be(s); + return 1; + } + + default: + // if critical, fail + if (first) return stbi__err("first not IHDR", "Corrupt PNG"); + if ((c.type & (1 << 29)) == 0) { + #ifndef STBI_NO_FAILURE_STRINGS + // not threadsafe + static char invalid_chunk[] = "XXXX PNG chunk not known"; + invalid_chunk[0] = STBI__BYTECAST(c.type >> 24); + invalid_chunk[1] = STBI__BYTECAST(c.type >> 16); + invalid_chunk[2] = STBI__BYTECAST(c.type >> 8); + invalid_chunk[3] = STBI__BYTECAST(c.type >> 0); + #endif + return stbi__err(invalid_chunk, "PNG not supported: unknown PNG chunk type"); + } + stbi__skip(s, c.length); + break; + } + // end of PNG chunk, read and skip CRC + stbi__get32be(s); + } +} + +static void *stbi__do_png(stbi__png *p, int *x, int *y, int *n, int req_comp, stbi__result_info *ri) +{ + void *result=NULL; + if (req_comp < 0 || req_comp > 4) return stbi__errpuc("bad req_comp", "Internal error"); + if (stbi__parse_png_file(p, STBI__SCAN_load, req_comp)) { + if (p->depth <= 8) + ri->bits_per_channel = 8; + else if (p->depth == 16) + ri->bits_per_channel = 16; + else + return stbi__errpuc("bad bits_per_channel", "PNG not supported: unsupported color depth"); + result = p->out; + p->out = NULL; + if (req_comp && req_comp != p->s->img_out_n) { + if (ri->bits_per_channel == 8) + result = stbi__convert_format((unsigned char *) result, p->s->img_out_n, req_comp, p->s->img_x, p->s->img_y); + else + result = stbi__convert_format16((stbi__uint16 *) result, p->s->img_out_n, req_comp, p->s->img_x, p->s->img_y); + p->s->img_out_n = req_comp; + if (result == NULL) return result; + } + *x = p->s->img_x; + *y = p->s->img_y; + if (n) *n = p->s->img_n; + } + STBI_FREE(p->out); p->out = NULL; + STBI_FREE(p->expanded); p->expanded = NULL; + STBI_FREE(p->idata); p->idata = NULL; + + return result; +} + +static void *stbi__png_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) +{ + stbi__png p; + p.s = s; + return stbi__do_png(&p, x,y,comp,req_comp, ri); +} + +static int stbi__png_test(stbi__context *s) +{ + int r; + r = stbi__check_png_header(s); + stbi__rewind(s); + return r; +} + +static int stbi__png_info_raw(stbi__png *p, int *x, int *y, int *comp) +{ + if (!stbi__parse_png_file(p, STBI__SCAN_header, 0)) { + stbi__rewind( p->s ); + return 0; + } + if (x) *x = p->s->img_x; + if (y) *y = p->s->img_y; + if (comp) *comp = p->s->img_n; + return 1; +} + +static int stbi__png_info(stbi__context *s, int *x, int *y, int *comp) +{ + stbi__png p; + p.s = s; + return stbi__png_info_raw(&p, x, y, comp); +} + +static int stbi__png_is16(stbi__context *s) +{ + stbi__png p; + p.s = s; + if (!stbi__png_info_raw(&p, NULL, NULL, NULL)) + return 0; + if (p.depth != 16) { + stbi__rewind(p.s); + return 0; + } + return 1; +} +#endif + +// Microsoft/Windows BMP image + +#ifndef STBI_NO_BMP +static int stbi__bmp_test_raw(stbi__context *s) +{ + int r; + int sz; + if (stbi__get8(s) != 'B') return 0; + if (stbi__get8(s) != 'M') return 0; + stbi__get32le(s); // discard filesize + stbi__get16le(s); // discard reserved + stbi__get16le(s); // discard reserved + stbi__get32le(s); // discard data offset + sz = stbi__get32le(s); + r = (sz == 12 || sz == 40 || sz == 56 || sz == 108 || sz == 124); + return r; +} + +static int stbi__bmp_test(stbi__context *s) +{ + int r = stbi__bmp_test_raw(s); + stbi__rewind(s); + return r; +} + + +// returns 0..31 for the highest set bit +static int stbi__high_bit(unsigned int z) +{ + int n=0; + if (z == 0) return -1; + if (z >= 0x10000) { n += 16; z >>= 16; } + if (z >= 0x00100) { n += 8; z >>= 8; } + if (z >= 0x00010) { n += 4; z >>= 4; } + if (z >= 0x00004) { n += 2; z >>= 2; } + if (z >= 0x00002) { n += 1;/* >>= 1;*/ } + return n; +} + +static int stbi__bitcount(unsigned int a) +{ + a = (a & 0x55555555) + ((a >> 1) & 0x55555555); // max 2 + a = (a & 0x33333333) + ((a >> 2) & 0x33333333); // max 4 + a = (a + (a >> 4)) & 0x0f0f0f0f; // max 8 per 4, now 8 bits + a = (a + (a >> 8)); // max 16 per 8 bits + a = (a + (a >> 16)); // max 32 per 8 bits + return a & 0xff; +} + +// extract an arbitrarily-aligned N-bit value (N=bits) +// from v, and then make it 8-bits long and fractionally +// extend it to full full range. +static int stbi__shiftsigned(unsigned int v, int shift, int bits) +{ + static unsigned int mul_table[9] = { + 0, + 0xff/*0b11111111*/, 0x55/*0b01010101*/, 0x49/*0b01001001*/, 0x11/*0b00010001*/, + 0x21/*0b00100001*/, 0x41/*0b01000001*/, 0x81/*0b10000001*/, 0x01/*0b00000001*/, + }; + static unsigned int shift_table[9] = { + 0, 0,0,1,0,2,4,6,0, + }; + if (shift < 0) + v <<= -shift; + else + v >>= shift; + STBI_ASSERT(v < 256); + v >>= (8-bits); + STBI_ASSERT(bits >= 0 && bits <= 8); + return (int) ((unsigned) v * mul_table[bits]) >> shift_table[bits]; +} + +typedef struct +{ + int bpp, offset, hsz; + unsigned int mr,mg,mb,ma, all_a; + int extra_read; +} stbi__bmp_data; + +static int stbi__bmp_set_mask_defaults(stbi__bmp_data *info, int compress) +{ + // BI_BITFIELDS specifies masks explicitly, don't override + if (compress == 3) + return 1; + + if (compress == 0) { + if (info->bpp == 16) { + info->mr = 31u << 10; + info->mg = 31u << 5; + info->mb = 31u << 0; + } else if (info->bpp == 32) { + info->mr = 0xffu << 16; + info->mg = 0xffu << 8; + info->mb = 0xffu << 0; + info->ma = 0xffu << 24; + info->all_a = 0; // if all_a is 0 at end, then we loaded alpha channel but it was all 0 + } else { + // otherwise, use defaults, which is all-0 + info->mr = info->mg = info->mb = info->ma = 0; + } + return 1; + } + return 0; // error +} + +static void *stbi__bmp_parse_header(stbi__context *s, stbi__bmp_data *info) +{ + int hsz; + if (stbi__get8(s) != 'B' || stbi__get8(s) != 'M') return stbi__errpuc("not BMP", "Corrupt BMP"); + stbi__get32le(s); // discard filesize + stbi__get16le(s); // discard reserved + stbi__get16le(s); // discard reserved + info->offset = stbi__get32le(s); + info->hsz = hsz = stbi__get32le(s); + info->mr = info->mg = info->mb = info->ma = 0; + info->extra_read = 14; + + if (info->offset < 0) return stbi__errpuc("bad BMP", "bad BMP"); + + if (hsz != 12 && hsz != 40 && hsz != 56 && hsz != 108 && hsz != 124) return stbi__errpuc("unknown BMP", "BMP type not supported: unknown"); + if (hsz == 12) { + s->img_x = stbi__get16le(s); + s->img_y = stbi__get16le(s); + } else { + s->img_x = stbi__get32le(s); + s->img_y = stbi__get32le(s); + } + if (stbi__get16le(s) != 1) return stbi__errpuc("bad BMP", "bad BMP"); + info->bpp = stbi__get16le(s); + if (hsz != 12) { + int compress = stbi__get32le(s); + if (compress == 1 || compress == 2) return stbi__errpuc("BMP RLE", "BMP type not supported: RLE"); + if (compress >= 4) return stbi__errpuc("BMP JPEG/PNG", "BMP type not supported: unsupported compression"); // this includes PNG/JPEG modes + if (compress == 3 && info->bpp != 16 && info->bpp != 32) return stbi__errpuc("bad BMP", "bad BMP"); // bitfields requires 16 or 32 bits/pixel + stbi__get32le(s); // discard sizeof + stbi__get32le(s); // discard hres + stbi__get32le(s); // discard vres + stbi__get32le(s); // discard colorsused + stbi__get32le(s); // discard max important + if (hsz == 40 || hsz == 56) { + if (hsz == 56) { + stbi__get32le(s); + stbi__get32le(s); + stbi__get32le(s); + stbi__get32le(s); + } + if (info->bpp == 16 || info->bpp == 32) { + if (compress == 0) { + stbi__bmp_set_mask_defaults(info, compress); + } else if (compress == 3) { + info->mr = stbi__get32le(s); + info->mg = stbi__get32le(s); + info->mb = stbi__get32le(s); + info->extra_read += 12; + // not documented, but generated by photoshop and handled by mspaint + if (info->mr == info->mg && info->mg == info->mb) { + // ?!?!? + return stbi__errpuc("bad BMP", "bad BMP"); + } + } else + return stbi__errpuc("bad BMP", "bad BMP"); + } + } else { + // V4/V5 header + int i; + if (hsz != 108 && hsz != 124) + return stbi__errpuc("bad BMP", "bad BMP"); + info->mr = stbi__get32le(s); + info->mg = stbi__get32le(s); + info->mb = stbi__get32le(s); + info->ma = stbi__get32le(s); + if (compress != 3) // override mr/mg/mb unless in BI_BITFIELDS mode, as per docs + stbi__bmp_set_mask_defaults(info, compress); + stbi__get32le(s); // discard color space + for (i=0; i < 12; ++i) + stbi__get32le(s); // discard color space parameters + if (hsz == 124) { + stbi__get32le(s); // discard rendering intent + stbi__get32le(s); // discard offset of profile data + stbi__get32le(s); // discard size of profile data + stbi__get32le(s); // discard reserved + } + } + } + return (void *) 1; +} + + +static void *stbi__bmp_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) +{ + stbi_uc *out; + unsigned int mr=0,mg=0,mb=0,ma=0, all_a; + stbi_uc pal[256][4]; + int psize=0,i,j,width; + int flip_vertically, pad, target; + stbi__bmp_data info; + STBI_NOTUSED(ri); + + info.all_a = 255; + if (stbi__bmp_parse_header(s, &info) == NULL) + return NULL; // error code already set + + flip_vertically = ((int) s->img_y) > 0; + s->img_y = abs((int) s->img_y); + + if (s->img_y > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); + if (s->img_x > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); + + mr = info.mr; + mg = info.mg; + mb = info.mb; + ma = info.ma; + all_a = info.all_a; + + if (info.hsz == 12) { + if (info.bpp < 24) + psize = (info.offset - info.extra_read - 24) / 3; + } else { + if (info.bpp < 16) + psize = (info.offset - info.extra_read - info.hsz) >> 2; + } + if (psize == 0) { + // accept some number of extra bytes after the header, but if the offset points either to before + // the header ends or implies a large amount of extra data, reject the file as malformed + int bytes_read_so_far = s->callback_already_read + (int)(s->img_buffer - s->img_buffer_original); + int header_limit = 1024; // max we actually read is below 256 bytes currently. + int extra_data_limit = 256*4; // what ordinarily goes here is a palette; 256 entries*4 bytes is its max size. + if (bytes_read_so_far <= 0 || bytes_read_so_far > header_limit) { + return stbi__errpuc("bad header", "Corrupt BMP"); + } + // we established that bytes_read_so_far is positive and sensible. + // the first half of this test rejects offsets that are either too small positives, or + // negative, and guarantees that info.offset >= bytes_read_so_far > 0. this in turn + // ensures the number computed in the second half of the test can't overflow. + if (info.offset < bytes_read_so_far || info.offset - bytes_read_so_far > extra_data_limit) { + return stbi__errpuc("bad offset", "Corrupt BMP"); + } else { + stbi__skip(s, info.offset - bytes_read_so_far); + } + } + + if (info.bpp == 24 && ma == 0xff000000) + s->img_n = 3; + else + s->img_n = ma ? 4 : 3; + if (req_comp && req_comp >= 3) // we can directly decode 3 or 4 + target = req_comp; + else + target = s->img_n; // if they want monochrome, we'll post-convert + + // sanity-check size + if (!stbi__mad3sizes_valid(target, s->img_x, s->img_y, 0)) + return stbi__errpuc("too large", "Corrupt BMP"); + + out = (stbi_uc *) stbi__malloc_mad3(target, s->img_x, s->img_y, 0); + if (!out) return stbi__errpuc("outofmem", "Out of memory"); + if (info.bpp < 16) { + int z=0; + if (psize == 0 || psize > 256) { STBI_FREE(out); return stbi__errpuc("invalid", "Corrupt BMP"); } + for (i=0; i < psize; ++i) { + pal[i][2] = stbi__get8(s); + pal[i][1] = stbi__get8(s); + pal[i][0] = stbi__get8(s); + if (info.hsz != 12) stbi__get8(s); + pal[i][3] = 255; + } + stbi__skip(s, info.offset - info.extra_read - info.hsz - psize * (info.hsz == 12 ? 3 : 4)); + if (info.bpp == 1) width = (s->img_x + 7) >> 3; + else if (info.bpp == 4) width = (s->img_x + 1) >> 1; + else if (info.bpp == 8) width = s->img_x; + else { STBI_FREE(out); return stbi__errpuc("bad bpp", "Corrupt BMP"); } + pad = (-width)&3; + if (info.bpp == 1) { + for (j=0; j < (int) s->img_y; ++j) { + int bit_offset = 7, v = stbi__get8(s); + for (i=0; i < (int) s->img_x; ++i) { + int color = (v>>bit_offset)&0x1; + out[z++] = pal[color][0]; + out[z++] = pal[color][1]; + out[z++] = pal[color][2]; + if (target == 4) out[z++] = 255; + if (i+1 == (int) s->img_x) break; + if((--bit_offset) < 0) { + bit_offset = 7; + v = stbi__get8(s); + } + } + stbi__skip(s, pad); + } + } else { + for (j=0; j < (int) s->img_y; ++j) { + for (i=0; i < (int) s->img_x; i += 2) { + int v=stbi__get8(s),v2=0; + if (info.bpp == 4) { + v2 = v & 15; + v >>= 4; + } + out[z++] = pal[v][0]; + out[z++] = pal[v][1]; + out[z++] = pal[v][2]; + if (target == 4) out[z++] = 255; + if (i+1 == (int) s->img_x) break; + v = (info.bpp == 8) ? stbi__get8(s) : v2; + out[z++] = pal[v][0]; + out[z++] = pal[v][1]; + out[z++] = pal[v][2]; + if (target == 4) out[z++] = 255; + } + stbi__skip(s, pad); + } + } + } else { + int rshift=0,gshift=0,bshift=0,ashift=0,rcount=0,gcount=0,bcount=0,acount=0; + int z = 0; + int easy=0; + stbi__skip(s, info.offset - info.extra_read - info.hsz); + if (info.bpp == 24) width = 3 * s->img_x; + else if (info.bpp == 16) width = 2*s->img_x; + else /* bpp = 32 and pad = 0 */ width=0; + pad = (-width) & 3; + if (info.bpp == 24) { + easy = 1; + } else if (info.bpp == 32) { + if (mb == 0xff && mg == 0xff00 && mr == 0x00ff0000 && ma == 0xff000000) + easy = 2; + } + if (!easy) { + if (!mr || !mg || !mb) { STBI_FREE(out); return stbi__errpuc("bad masks", "Corrupt BMP"); } + // right shift amt to put high bit in position #7 + rshift = stbi__high_bit(mr)-7; rcount = stbi__bitcount(mr); + gshift = stbi__high_bit(mg)-7; gcount = stbi__bitcount(mg); + bshift = stbi__high_bit(mb)-7; bcount = stbi__bitcount(mb); + ashift = stbi__high_bit(ma)-7; acount = stbi__bitcount(ma); + if (rcount > 8 || gcount > 8 || bcount > 8 || acount > 8) { STBI_FREE(out); return stbi__errpuc("bad masks", "Corrupt BMP"); } + } + for (j=0; j < (int) s->img_y; ++j) { + if (easy) { + for (i=0; i < (int) s->img_x; ++i) { + unsigned char a; + out[z+2] = stbi__get8(s); + out[z+1] = stbi__get8(s); + out[z+0] = stbi__get8(s); + z += 3; + a = (easy == 2 ? stbi__get8(s) : 255); + all_a |= a; + if (target == 4) out[z++] = a; + } + } else { + int bpp = info.bpp; + for (i=0; i < (int) s->img_x; ++i) { + stbi__uint32 v = (bpp == 16 ? (stbi__uint32) stbi__get16le(s) : stbi__get32le(s)); + unsigned int a; + out[z++] = STBI__BYTECAST(stbi__shiftsigned(v & mr, rshift, rcount)); + out[z++] = STBI__BYTECAST(stbi__shiftsigned(v & mg, gshift, gcount)); + out[z++] = STBI__BYTECAST(stbi__shiftsigned(v & mb, bshift, bcount)); + a = (ma ? stbi__shiftsigned(v & ma, ashift, acount) : 255); + all_a |= a; + if (target == 4) out[z++] = STBI__BYTECAST(a); + } + } + stbi__skip(s, pad); + } + } + + // if alpha channel is all 0s, replace with all 255s + if (target == 4 && all_a == 0) + for (i=4*s->img_x*s->img_y-1; i >= 0; i -= 4) + out[i] = 255; + + if (flip_vertically) { + stbi_uc t; + for (j=0; j < (int) s->img_y>>1; ++j) { + stbi_uc *p1 = out + j *s->img_x*target; + stbi_uc *p2 = out + (s->img_y-1-j)*s->img_x*target; + for (i=0; i < (int) s->img_x*target; ++i) { + t = p1[i]; p1[i] = p2[i]; p2[i] = t; + } + } + } + + if (req_comp && req_comp != target) { + out = stbi__convert_format(out, target, req_comp, s->img_x, s->img_y); + if (out == NULL) return out; // stbi__convert_format frees input on failure + } + + *x = s->img_x; + *y = s->img_y; + if (comp) *comp = s->img_n; + return out; +} +#endif + +// Targa Truevision - TGA +// by Jonathan Dummer +#ifndef STBI_NO_TGA +// returns STBI_rgb or whatever, 0 on error +static int stbi__tga_get_comp(int bits_per_pixel, int is_grey, int* is_rgb16) +{ + // only RGB or RGBA (incl. 16bit) or grey allowed + if (is_rgb16) *is_rgb16 = 0; + switch(bits_per_pixel) { + case 8: return STBI_grey; + case 16: if(is_grey) return STBI_grey_alpha; + // fallthrough + case 15: if(is_rgb16) *is_rgb16 = 1; + return STBI_rgb; + case 24: // fallthrough + case 32: return bits_per_pixel/8; + default: return 0; + } +} + +static int stbi__tga_info(stbi__context *s, int *x, int *y, int *comp) +{ + int tga_w, tga_h, tga_comp, tga_image_type, tga_bits_per_pixel, tga_colormap_bpp; + int sz, tga_colormap_type; + stbi__get8(s); // discard Offset + tga_colormap_type = stbi__get8(s); // colormap type + if( tga_colormap_type > 1 ) { + stbi__rewind(s); + return 0; // only RGB or indexed allowed + } + tga_image_type = stbi__get8(s); // image type + if ( tga_colormap_type == 1 ) { // colormapped (paletted) image + if (tga_image_type != 1 && tga_image_type != 9) { + stbi__rewind(s); + return 0; + } + stbi__skip(s,4); // skip index of first colormap entry and number of entries + sz = stbi__get8(s); // check bits per palette color entry + if ( (sz != 8) && (sz != 15) && (sz != 16) && (sz != 24) && (sz != 32) ) { + stbi__rewind(s); + return 0; + } + stbi__skip(s,4); // skip image x and y origin + tga_colormap_bpp = sz; + } else { // "normal" image w/o colormap - only RGB or grey allowed, +/- RLE + if ( (tga_image_type != 2) && (tga_image_type != 3) && (tga_image_type != 10) && (tga_image_type != 11) ) { + stbi__rewind(s); + return 0; // only RGB or grey allowed, +/- RLE + } + stbi__skip(s,9); // skip colormap specification and image x/y origin + tga_colormap_bpp = 0; + } + tga_w = stbi__get16le(s); + if( tga_w < 1 ) { + stbi__rewind(s); + return 0; // test width + } + tga_h = stbi__get16le(s); + if( tga_h < 1 ) { + stbi__rewind(s); + return 0; // test height + } + tga_bits_per_pixel = stbi__get8(s); // bits per pixel + stbi__get8(s); // ignore alpha bits + if (tga_colormap_bpp != 0) { + if((tga_bits_per_pixel != 8) && (tga_bits_per_pixel != 16)) { + // when using a colormap, tga_bits_per_pixel is the size of the indexes + // I don't think anything but 8 or 16bit indexes makes sense + stbi__rewind(s); + return 0; + } + tga_comp = stbi__tga_get_comp(tga_colormap_bpp, 0, NULL); + } else { + tga_comp = stbi__tga_get_comp(tga_bits_per_pixel, (tga_image_type == 3) || (tga_image_type == 11), NULL); + } + if(!tga_comp) { + stbi__rewind(s); + return 0; + } + if (x) *x = tga_w; + if (y) *y = tga_h; + if (comp) *comp = tga_comp; + return 1; // seems to have passed everything +} + +static int stbi__tga_test(stbi__context *s) +{ + int res = 0; + int sz, tga_color_type; + stbi__get8(s); // discard Offset + tga_color_type = stbi__get8(s); // color type + if ( tga_color_type > 1 ) goto errorEnd; // only RGB or indexed allowed + sz = stbi__get8(s); // image type + if ( tga_color_type == 1 ) { // colormapped (paletted) image + if (sz != 1 && sz != 9) goto errorEnd; // colortype 1 demands image type 1 or 9 + stbi__skip(s,4); // skip index of first colormap entry and number of entries + sz = stbi__get8(s); // check bits per palette color entry + if ( (sz != 8) && (sz != 15) && (sz != 16) && (sz != 24) && (sz != 32) ) goto errorEnd; + stbi__skip(s,4); // skip image x and y origin + } else { // "normal" image w/o colormap + if ( (sz != 2) && (sz != 3) && (sz != 10) && (sz != 11) ) goto errorEnd; // only RGB or grey allowed, +/- RLE + stbi__skip(s,9); // skip colormap specification and image x/y origin + } + if ( stbi__get16le(s) < 1 ) goto errorEnd; // test width + if ( stbi__get16le(s) < 1 ) goto errorEnd; // test height + sz = stbi__get8(s); // bits per pixel + if ( (tga_color_type == 1) && (sz != 8) && (sz != 16) ) goto errorEnd; // for colormapped images, bpp is size of an index + if ( (sz != 8) && (sz != 15) && (sz != 16) && (sz != 24) && (sz != 32) ) goto errorEnd; + + res = 1; // if we got this far, everything's good and we can return 1 instead of 0 + +errorEnd: + stbi__rewind(s); + return res; +} + +// read 16bit value and convert to 24bit RGB +static void stbi__tga_read_rgb16(stbi__context *s, stbi_uc* out) +{ + stbi__uint16 px = (stbi__uint16)stbi__get16le(s); + stbi__uint16 fiveBitMask = 31; + // we have 3 channels with 5bits each + int r = (px >> 10) & fiveBitMask; + int g = (px >> 5) & fiveBitMask; + int b = px & fiveBitMask; + // Note that this saves the data in RGB(A) order, so it doesn't need to be swapped later + out[0] = (stbi_uc)((r * 255)/31); + out[1] = (stbi_uc)((g * 255)/31); + out[2] = (stbi_uc)((b * 255)/31); + + // some people claim that the most significant bit might be used for alpha + // (possibly if an alpha-bit is set in the "image descriptor byte") + // but that only made 16bit test images completely translucent.. + // so let's treat all 15 and 16bit TGAs as RGB with no alpha. +} + +static void *stbi__tga_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) +{ + // read in the TGA header stuff + int tga_offset = stbi__get8(s); + int tga_indexed = stbi__get8(s); + int tga_image_type = stbi__get8(s); + int tga_is_RLE = 0; + int tga_palette_start = stbi__get16le(s); + int tga_palette_len = stbi__get16le(s); + int tga_palette_bits = stbi__get8(s); + int tga_x_origin = stbi__get16le(s); + int tga_y_origin = stbi__get16le(s); + int tga_width = stbi__get16le(s); + int tga_height = stbi__get16le(s); + int tga_bits_per_pixel = stbi__get8(s); + int tga_comp, tga_rgb16=0; + int tga_inverted = stbi__get8(s); + // int tga_alpha_bits = tga_inverted & 15; // the 4 lowest bits - unused (useless?) + // image data + unsigned char *tga_data; + unsigned char *tga_palette = NULL; + int i, j; + unsigned char raw_data[4] = {0}; + int RLE_count = 0; + int RLE_repeating = 0; + int read_next_pixel = 1; + STBI_NOTUSED(ri); + STBI_NOTUSED(tga_x_origin); // @TODO + STBI_NOTUSED(tga_y_origin); // @TODO + + if (tga_height > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); + if (tga_width > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); + + // do a tiny bit of precessing + if ( tga_image_type >= 8 ) + { + tga_image_type -= 8; + tga_is_RLE = 1; + } + tga_inverted = 1 - ((tga_inverted >> 5) & 1); + + // If I'm paletted, then I'll use the number of bits from the palette + if ( tga_indexed ) tga_comp = stbi__tga_get_comp(tga_palette_bits, 0, &tga_rgb16); + else tga_comp = stbi__tga_get_comp(tga_bits_per_pixel, (tga_image_type == 3), &tga_rgb16); + + if(!tga_comp) // shouldn't really happen, stbi__tga_test() should have ensured basic consistency + return stbi__errpuc("bad format", "Can't find out TGA pixelformat"); + + // tga info + *x = tga_width; + *y = tga_height; + if (comp) *comp = tga_comp; + + if (!stbi__mad3sizes_valid(tga_width, tga_height, tga_comp, 0)) + return stbi__errpuc("too large", "Corrupt TGA"); + + tga_data = (unsigned char*)stbi__malloc_mad3(tga_width, tga_height, tga_comp, 0); + if (!tga_data) return stbi__errpuc("outofmem", "Out of memory"); + + // skip to the data's starting position (offset usually = 0) + stbi__skip(s, tga_offset ); + + if ( !tga_indexed && !tga_is_RLE && !tga_rgb16 ) { + for (i=0; i < tga_height; ++i) { + int row = tga_inverted ? tga_height -i - 1 : i; + stbi_uc *tga_row = tga_data + row*tga_width*tga_comp; + stbi__getn(s, tga_row, tga_width * tga_comp); + } + } else { + // do I need to load a palette? + if ( tga_indexed) + { + if (tga_palette_len == 0) { /* you have to have at least one entry! */ + STBI_FREE(tga_data); + return stbi__errpuc("bad palette", "Corrupt TGA"); + } + + // any data to skip? (offset usually = 0) + stbi__skip(s, tga_palette_start ); + // load the palette + tga_palette = (unsigned char*)stbi__malloc_mad2(tga_palette_len, tga_comp, 0); + if (!tga_palette) { + STBI_FREE(tga_data); + return stbi__errpuc("outofmem", "Out of memory"); + } + if (tga_rgb16) { + stbi_uc *pal_entry = tga_palette; + STBI_ASSERT(tga_comp == STBI_rgb); + for (i=0; i < tga_palette_len; ++i) { + stbi__tga_read_rgb16(s, pal_entry); + pal_entry += tga_comp; + } + } else if (!stbi__getn(s, tga_palette, tga_palette_len * tga_comp)) { + STBI_FREE(tga_data); + STBI_FREE(tga_palette); + return stbi__errpuc("bad palette", "Corrupt TGA"); + } + } + // load the data + for (i=0; i < tga_width * tga_height; ++i) + { + // if I'm in RLE mode, do I need to get a RLE stbi__pngchunk? + if ( tga_is_RLE ) + { + if ( RLE_count == 0 ) + { + // yep, get the next byte as a RLE command + int RLE_cmd = stbi__get8(s); + RLE_count = 1 + (RLE_cmd & 127); + RLE_repeating = RLE_cmd >> 7; + read_next_pixel = 1; + } else if ( !RLE_repeating ) + { + read_next_pixel = 1; + } + } else + { + read_next_pixel = 1; + } + // OK, if I need to read a pixel, do it now + if ( read_next_pixel ) + { + // load however much data we did have + if ( tga_indexed ) + { + // read in index, then perform the lookup + int pal_idx = (tga_bits_per_pixel == 8) ? stbi__get8(s) : stbi__get16le(s); + if ( pal_idx >= tga_palette_len ) { + // invalid index + pal_idx = 0; + } + pal_idx *= tga_comp; + for (j = 0; j < tga_comp; ++j) { + raw_data[j] = tga_palette[pal_idx+j]; + } + } else if(tga_rgb16) { + STBI_ASSERT(tga_comp == STBI_rgb); + stbi__tga_read_rgb16(s, raw_data); + } else { + // read in the data raw + for (j = 0; j < tga_comp; ++j) { + raw_data[j] = stbi__get8(s); + } + } + // clear the reading flag for the next pixel + read_next_pixel = 0; + } // end of reading a pixel + + // copy data + for (j = 0; j < tga_comp; ++j) + tga_data[i*tga_comp+j] = raw_data[j]; + + // in case we're in RLE mode, keep counting down + --RLE_count; + } + // do I need to invert the image? + if ( tga_inverted ) + { + for (j = 0; j*2 < tga_height; ++j) + { + int index1 = j * tga_width * tga_comp; + int index2 = (tga_height - 1 - j) * tga_width * tga_comp; + for (i = tga_width * tga_comp; i > 0; --i) + { + unsigned char temp = tga_data[index1]; + tga_data[index1] = tga_data[index2]; + tga_data[index2] = temp; + ++index1; + ++index2; + } + } + } + // clear my palette, if I had one + if ( tga_palette != NULL ) + { + STBI_FREE( tga_palette ); + } + } + + // swap RGB - if the source data was RGB16, it already is in the right order + if (tga_comp >= 3 && !tga_rgb16) + { + unsigned char* tga_pixel = tga_data; + for (i=0; i < tga_width * tga_height; ++i) + { + unsigned char temp = tga_pixel[0]; + tga_pixel[0] = tga_pixel[2]; + tga_pixel[2] = temp; + tga_pixel += tga_comp; + } + } + + // convert to target component count + if (req_comp && req_comp != tga_comp) + tga_data = stbi__convert_format(tga_data, tga_comp, req_comp, tga_width, tga_height); + + // the things I do to get rid of an error message, and yet keep + // Microsoft's C compilers happy... [8^( + tga_palette_start = tga_palette_len = tga_palette_bits = + tga_x_origin = tga_y_origin = 0; + STBI_NOTUSED(tga_palette_start); + // OK, done + return tga_data; +} +#endif + +// ************************************************************************************************* +// Photoshop PSD loader -- PD by Thatcher Ulrich, integration by Nicolas Schulz, tweaked by STB + +#ifndef STBI_NO_PSD +static int stbi__psd_test(stbi__context *s) +{ + int r = (stbi__get32be(s) == 0x38425053); + stbi__rewind(s); + return r; +} + +static int stbi__psd_decode_rle(stbi__context *s, stbi_uc *p, int pixelCount) +{ + int count, nleft, len; + + count = 0; + while ((nleft = pixelCount - count) > 0) { + len = stbi__get8(s); + if (len == 128) { + // No-op. + } else if (len < 128) { + // Copy next len+1 bytes literally. + len++; + if (len > nleft) return 0; // corrupt data + count += len; + while (len) { + *p = stbi__get8(s); + p += 4; + len--; + } + } else if (len > 128) { + stbi_uc val; + // Next -len+1 bytes in the dest are replicated from next source byte. + // (Interpret len as a negative 8-bit int.) + len = 257 - len; + if (len > nleft) return 0; // corrupt data + val = stbi__get8(s); + count += len; + while (len) { + *p = val; + p += 4; + len--; + } + } + } + + return 1; +} + +static void *stbi__psd_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri, int bpc) +{ + int pixelCount; + int channelCount, compression; + int channel, i; + int bitdepth; + int w,h; + stbi_uc *out; + STBI_NOTUSED(ri); + + // Check identifier + if (stbi__get32be(s) != 0x38425053) // "8BPS" + return stbi__errpuc("not PSD", "Corrupt PSD image"); + + // Check file type version. + if (stbi__get16be(s) != 1) + return stbi__errpuc("wrong version", "Unsupported version of PSD image"); + + // Skip 6 reserved bytes. + stbi__skip(s, 6 ); + + // Read the number of channels (R, G, B, A, etc). + channelCount = stbi__get16be(s); + if (channelCount < 0 || channelCount > 16) + return stbi__errpuc("wrong channel count", "Unsupported number of channels in PSD image"); + + // Read the rows and columns of the image. + h = stbi__get32be(s); + w = stbi__get32be(s); + + if (h > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); + if (w > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); + + // Make sure the depth is 8 bits. + bitdepth = stbi__get16be(s); + if (bitdepth != 8 && bitdepth != 16) + return stbi__errpuc("unsupported bit depth", "PSD bit depth is not 8 or 16 bit"); + + // Make sure the color mode is RGB. + // Valid options are: + // 0: Bitmap + // 1: Grayscale + // 2: Indexed color + // 3: RGB color + // 4: CMYK color + // 7: Multichannel + // 8: Duotone + // 9: Lab color + if (stbi__get16be(s) != 3) + return stbi__errpuc("wrong color format", "PSD is not in RGB color format"); + + // Skip the Mode Data. (It's the palette for indexed color; other info for other modes.) + stbi__skip(s,stbi__get32be(s) ); + + // Skip the image resources. (resolution, pen tool paths, etc) + stbi__skip(s, stbi__get32be(s) ); + + // Skip the reserved data. + stbi__skip(s, stbi__get32be(s) ); + + // Find out if the data is compressed. + // Known values: + // 0: no compression + // 1: RLE compressed + compression = stbi__get16be(s); + if (compression > 1) + return stbi__errpuc("bad compression", "PSD has an unknown compression format"); + + // Check size + if (!stbi__mad3sizes_valid(4, w, h, 0)) + return stbi__errpuc("too large", "Corrupt PSD"); + + // Create the destination image. + + if (!compression && bitdepth == 16 && bpc == 16) { + out = (stbi_uc *) stbi__malloc_mad3(8, w, h, 0); + ri->bits_per_channel = 16; + } else + out = (stbi_uc *) stbi__malloc(4 * w*h); + + if (!out) return stbi__errpuc("outofmem", "Out of memory"); + pixelCount = w*h; + + // Initialize the data to zero. + //memset( out, 0, pixelCount * 4 ); + + // Finally, the image data. + if (compression) { + // RLE as used by .PSD and .TIFF + // Loop until you get the number of unpacked bytes you are expecting: + // Read the next source byte into n. + // If n is between 0 and 127 inclusive, copy the next n+1 bytes literally. + // Else if n is between -127 and -1 inclusive, copy the next byte -n+1 times. + // Else if n is 128, noop. + // Endloop + + // The RLE-compressed data is preceded by a 2-byte data count for each row in the data, + // which we're going to just skip. + stbi__skip(s, h * channelCount * 2 ); + + // Read the RLE data by channel. + for (channel = 0; channel < 4; channel++) { + stbi_uc *p; + + p = out+channel; + if (channel >= channelCount) { + // Fill this channel with default data. + for (i = 0; i < pixelCount; i++, p += 4) + *p = (channel == 3 ? 255 : 0); + } else { + // Read the RLE data. + if (!stbi__psd_decode_rle(s, p, pixelCount)) { + STBI_FREE(out); + return stbi__errpuc("corrupt", "bad RLE data"); + } + } + } + + } else { + // We're at the raw image data. It's each channel in order (Red, Green, Blue, Alpha, ...) + // where each channel consists of an 8-bit (or 16-bit) value for each pixel in the image. + + // Read the data by channel. + for (channel = 0; channel < 4; channel++) { + if (channel >= channelCount) { + // Fill this channel with default data. + if (bitdepth == 16 && bpc == 16) { + stbi__uint16 *q = ((stbi__uint16 *) out) + channel; + stbi__uint16 val = channel == 3 ? 65535 : 0; + for (i = 0; i < pixelCount; i++, q += 4) + *q = val; + } else { + stbi_uc *p = out+channel; + stbi_uc val = channel == 3 ? 255 : 0; + for (i = 0; i < pixelCount; i++, p += 4) + *p = val; + } + } else { + if (ri->bits_per_channel == 16) { // output bpc + stbi__uint16 *q = ((stbi__uint16 *) out) + channel; + for (i = 0; i < pixelCount; i++, q += 4) + *q = (stbi__uint16) stbi__get16be(s); + } else { + stbi_uc *p = out+channel; + if (bitdepth == 16) { // input bpc + for (i = 0; i < pixelCount; i++, p += 4) + *p = (stbi_uc) (stbi__get16be(s) >> 8); + } else { + for (i = 0; i < pixelCount; i++, p += 4) + *p = stbi__get8(s); + } + } + } + } + } + + // remove weird white matte from PSD + if (channelCount >= 4) { + if (ri->bits_per_channel == 16) { + for (i=0; i < w*h; ++i) { + stbi__uint16 *pixel = (stbi__uint16 *) out + 4*i; + if (pixel[3] != 0 && pixel[3] != 65535) { + float a = pixel[3] / 65535.0f; + float ra = 1.0f / a; + float inv_a = 65535.0f * (1 - ra); + pixel[0] = (stbi__uint16) (pixel[0]*ra + inv_a); + pixel[1] = (stbi__uint16) (pixel[1]*ra + inv_a); + pixel[2] = (stbi__uint16) (pixel[2]*ra + inv_a); + } + } + } else { + for (i=0; i < w*h; ++i) { + unsigned char *pixel = out + 4*i; + if (pixel[3] != 0 && pixel[3] != 255) { + float a = pixel[3] / 255.0f; + float ra = 1.0f / a; + float inv_a = 255.0f * (1 - ra); + pixel[0] = (unsigned char) (pixel[0]*ra + inv_a); + pixel[1] = (unsigned char) (pixel[1]*ra + inv_a); + pixel[2] = (unsigned char) (pixel[2]*ra + inv_a); + } + } + } + } + + // convert to desired output format + if (req_comp && req_comp != 4) { + if (ri->bits_per_channel == 16) + out = (stbi_uc *) stbi__convert_format16((stbi__uint16 *) out, 4, req_comp, w, h); + else + out = stbi__convert_format(out, 4, req_comp, w, h); + if (out == NULL) return out; // stbi__convert_format frees input on failure + } + + if (comp) *comp = 4; + *y = h; + *x = w; + + return out; +} +#endif + +// ************************************************************************************************* +// Softimage PIC loader +// by Tom Seddon +// +// See http://softimage.wiki.softimage.com/index.php/INFO:_PIC_file_format +// See http://ozviz.wasp.uwa.edu.au/~pbourke/dataformats/softimagepic/ + +#ifndef STBI_NO_PIC +static int stbi__pic_is4(stbi__context *s,const char *str) +{ + int i; + for (i=0; i<4; ++i) + if (stbi__get8(s) != (stbi_uc)str[i]) + return 0; + + return 1; +} + +static int stbi__pic_test_core(stbi__context *s) +{ + int i; + + if (!stbi__pic_is4(s,"\x53\x80\xF6\x34")) + return 0; + + for(i=0;i<84;++i) + stbi__get8(s); + + if (!stbi__pic_is4(s,"PICT")) + return 0; + + return 1; +} + +typedef struct +{ + stbi_uc size,type,channel; +} stbi__pic_packet; + +static stbi_uc *stbi__readval(stbi__context *s, int channel, stbi_uc *dest) +{ + int mask=0x80, i; + + for (i=0; i<4; ++i, mask>>=1) { + if (channel & mask) { + if (stbi__at_eof(s)) return stbi__errpuc("bad file","PIC file too short"); + dest[i]=stbi__get8(s); + } + } + + return dest; +} + +static void stbi__copyval(int channel,stbi_uc *dest,const stbi_uc *src) +{ + int mask=0x80,i; + + for (i=0;i<4; ++i, mask>>=1) + if (channel&mask) + dest[i]=src[i]; +} + +static stbi_uc *stbi__pic_load_core(stbi__context *s,int width,int height,int *comp, stbi_uc *result) +{ + int act_comp=0,num_packets=0,y,chained; + stbi__pic_packet packets[10]; + + // this will (should...) cater for even some bizarre stuff like having data + // for the same channel in multiple packets. + do { + stbi__pic_packet *packet; + + if (num_packets==sizeof(packets)/sizeof(packets[0])) + return stbi__errpuc("bad format","too many packets"); + + packet = &packets[num_packets++]; + + chained = stbi__get8(s); + packet->size = stbi__get8(s); + packet->type = stbi__get8(s); + packet->channel = stbi__get8(s); + + act_comp |= packet->channel; + + if (stbi__at_eof(s)) return stbi__errpuc("bad file","file too short (reading packets)"); + if (packet->size != 8) return stbi__errpuc("bad format","packet isn't 8bpp"); + } while (chained); + + *comp = (act_comp & 0x10 ? 4 : 3); // has alpha channel? + + for(y=0; ytype) { + default: + return stbi__errpuc("bad format","packet has bad compression type"); + + case 0: {//uncompressed + int x; + + for(x=0;xchannel,dest)) + return 0; + break; + } + + case 1://Pure RLE + { + int left=width, i; + + while (left>0) { + stbi_uc count,value[4]; + + count=stbi__get8(s); + if (stbi__at_eof(s)) return stbi__errpuc("bad file","file too short (pure read count)"); + + if (count > left) + count = (stbi_uc) left; + + if (!stbi__readval(s,packet->channel,value)) return 0; + + for(i=0; ichannel,dest,value); + left -= count; + } + } + break; + + case 2: {//Mixed RLE + int left=width; + while (left>0) { + int count = stbi__get8(s), i; + if (stbi__at_eof(s)) return stbi__errpuc("bad file","file too short (mixed read count)"); + + if (count >= 128) { // Repeated + stbi_uc value[4]; + + if (count==128) + count = stbi__get16be(s); + else + count -= 127; + if (count > left) + return stbi__errpuc("bad file","scanline overrun"); + + if (!stbi__readval(s,packet->channel,value)) + return 0; + + for(i=0;ichannel,dest,value); + } else { // Raw + ++count; + if (count>left) return stbi__errpuc("bad file","scanline overrun"); + + for(i=0;ichannel,dest)) + return 0; + } + left-=count; + } + break; + } + } + } + } + + return result; +} + +static void *stbi__pic_load(stbi__context *s,int *px,int *py,int *comp,int req_comp, stbi__result_info *ri) +{ + stbi_uc *result; + int i, x,y, internal_comp; + STBI_NOTUSED(ri); + + if (!comp) comp = &internal_comp; + + for (i=0; i<92; ++i) + stbi__get8(s); + + x = stbi__get16be(s); + y = stbi__get16be(s); + + if (y > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); + if (x > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); + + if (stbi__at_eof(s)) return stbi__errpuc("bad file","file too short (pic header)"); + if (!stbi__mad3sizes_valid(x, y, 4, 0)) return stbi__errpuc("too large", "PIC image too large to decode"); + + stbi__get32be(s); //skip `ratio' + stbi__get16be(s); //skip `fields' + stbi__get16be(s); //skip `pad' + + // intermediate buffer is RGBA + result = (stbi_uc *) stbi__malloc_mad3(x, y, 4, 0); + if (!result) return stbi__errpuc("outofmem", "Out of memory"); + memset(result, 0xff, x*y*4); + + if (!stbi__pic_load_core(s,x,y,comp, result)) { + STBI_FREE(result); + result=0; + } + *px = x; + *py = y; + if (req_comp == 0) req_comp = *comp; + result=stbi__convert_format(result,4,req_comp,x,y); + + return result; +} + +static int stbi__pic_test(stbi__context *s) +{ + int r = stbi__pic_test_core(s); + stbi__rewind(s); + return r; +} +#endif + +// ************************************************************************************************* +// GIF loader -- public domain by Jean-Marc Lienher -- simplified/shrunk by stb + +#ifndef STBI_NO_GIF +typedef struct +{ + stbi__int16 prefix; + stbi_uc first; + stbi_uc suffix; +} stbi__gif_lzw; + +typedef struct +{ + int w,h; + stbi_uc *out; // output buffer (always 4 components) + stbi_uc *background; // The current "background" as far as a gif is concerned + stbi_uc *history; + int flags, bgindex, ratio, transparent, eflags; + stbi_uc pal[256][4]; + stbi_uc lpal[256][4]; + stbi__gif_lzw codes[8192]; + stbi_uc *color_table; + int parse, step; + int lflags; + int start_x, start_y; + int max_x, max_y; + int cur_x, cur_y; + int line_size; + int delay; +} stbi__gif; + +static int stbi__gif_test_raw(stbi__context *s) +{ + int sz; + if (stbi__get8(s) != 'G' || stbi__get8(s) != 'I' || stbi__get8(s) != 'F' || stbi__get8(s) != '8') return 0; + sz = stbi__get8(s); + if (sz != '9' && sz != '7') return 0; + if (stbi__get8(s) != 'a') return 0; + return 1; +} + +static int stbi__gif_test(stbi__context *s) +{ + int r = stbi__gif_test_raw(s); + stbi__rewind(s); + return r; +} + +static void stbi__gif_parse_colortable(stbi__context *s, stbi_uc pal[256][4], int num_entries, int transp) +{ + int i; + for (i=0; i < num_entries; ++i) { + pal[i][2] = stbi__get8(s); + pal[i][1] = stbi__get8(s); + pal[i][0] = stbi__get8(s); + pal[i][3] = transp == i ? 0 : 255; + } +} + +static int stbi__gif_header(stbi__context *s, stbi__gif *g, int *comp, int is_info) +{ + stbi_uc version; + if (stbi__get8(s) != 'G' || stbi__get8(s) != 'I' || stbi__get8(s) != 'F' || stbi__get8(s) != '8') + return stbi__err("not GIF", "Corrupt GIF"); + + version = stbi__get8(s); + if (version != '7' && version != '9') return stbi__err("not GIF", "Corrupt GIF"); + if (stbi__get8(s) != 'a') return stbi__err("not GIF", "Corrupt GIF"); + + stbi__g_failure_reason = ""; + g->w = stbi__get16le(s); + g->h = stbi__get16le(s); + g->flags = stbi__get8(s); + g->bgindex = stbi__get8(s); + g->ratio = stbi__get8(s); + g->transparent = -1; + + if (g->w > STBI_MAX_DIMENSIONS) return stbi__err("too large","Very large image (corrupt?)"); + if (g->h > STBI_MAX_DIMENSIONS) return stbi__err("too large","Very large image (corrupt?)"); + + if (comp != 0) *comp = 4; // can't actually tell whether it's 3 or 4 until we parse the comments + + if (is_info) return 1; + + if (g->flags & 0x80) + stbi__gif_parse_colortable(s,g->pal, 2 << (g->flags & 7), -1); + + return 1; +} + +static int stbi__gif_info_raw(stbi__context *s, int *x, int *y, int *comp) +{ + stbi__gif* g = (stbi__gif*) stbi__malloc(sizeof(stbi__gif)); + if (!g) return stbi__err("outofmem", "Out of memory"); + if (!stbi__gif_header(s, g, comp, 1)) { + STBI_FREE(g); + stbi__rewind( s ); + return 0; + } + if (x) *x = g->w; + if (y) *y = g->h; + STBI_FREE(g); + return 1; +} + +static void stbi__out_gif_code(stbi__gif *g, stbi__uint16 code) +{ + stbi_uc *p, *c; + int idx; + + // recurse to decode the prefixes, since the linked-list is backwards, + // and working backwards through an interleaved image would be nasty + if (g->codes[code].prefix >= 0) + stbi__out_gif_code(g, g->codes[code].prefix); + + if (g->cur_y >= g->max_y) return; + + idx = g->cur_x + g->cur_y; + p = &g->out[idx]; + g->history[idx / 4] = 1; + + c = &g->color_table[g->codes[code].suffix * 4]; + if (c[3] > 128) { // don't render transparent pixels; + p[0] = c[2]; + p[1] = c[1]; + p[2] = c[0]; + p[3] = c[3]; + } + g->cur_x += 4; + + if (g->cur_x >= g->max_x) { + g->cur_x = g->start_x; + g->cur_y += g->step; + + while (g->cur_y >= g->max_y && g->parse > 0) { + g->step = (1 << g->parse) * g->line_size; + g->cur_y = g->start_y + (g->step >> 1); + --g->parse; + } + } +} + +static stbi_uc *stbi__process_gif_raster(stbi__context *s, stbi__gif *g) +{ + stbi_uc lzw_cs; + stbi__int32 len, init_code; + stbi__uint32 first; + stbi__int32 codesize, codemask, avail, oldcode, bits, valid_bits, clear; + stbi__gif_lzw *p; + + lzw_cs = stbi__get8(s); + if (lzw_cs > 12) return NULL; + clear = 1 << lzw_cs; + first = 1; + codesize = lzw_cs + 1; + codemask = (1 << codesize) - 1; + bits = 0; + valid_bits = 0; + for (init_code = 0; init_code < clear; init_code++) { + g->codes[init_code].prefix = -1; + g->codes[init_code].first = (stbi_uc) init_code; + g->codes[init_code].suffix = (stbi_uc) init_code; + } + + // support no starting clear code + avail = clear+2; + oldcode = -1; + + len = 0; + for(;;) { + if (valid_bits < codesize) { + if (len == 0) { + len = stbi__get8(s); // start new block + if (len == 0) + return g->out; + } + --len; + bits |= (stbi__int32) stbi__get8(s) << valid_bits; + valid_bits += 8; + } else { + stbi__int32 code = bits & codemask; + bits >>= codesize; + valid_bits -= codesize; + // @OPTIMIZE: is there some way we can accelerate the non-clear path? + if (code == clear) { // clear code + codesize = lzw_cs + 1; + codemask = (1 << codesize) - 1; + avail = clear + 2; + oldcode = -1; + first = 0; + } else if (code == clear + 1) { // end of stream code + stbi__skip(s, len); + while ((len = stbi__get8(s)) > 0) + stbi__skip(s,len); + return g->out; + } else if (code <= avail) { + if (first) { + return stbi__errpuc("no clear code", "Corrupt GIF"); + } + + if (oldcode >= 0) { + p = &g->codes[avail++]; + if (avail > 8192) { + return stbi__errpuc("too many codes", "Corrupt GIF"); + } + + p->prefix = (stbi__int16) oldcode; + p->first = g->codes[oldcode].first; + p->suffix = (code == avail) ? p->first : g->codes[code].first; + } else if (code == avail) + return stbi__errpuc("illegal code in raster", "Corrupt GIF"); + + stbi__out_gif_code(g, (stbi__uint16) code); + + if ((avail & codemask) == 0 && avail <= 0x0FFF) { + codesize++; + codemask = (1 << codesize) - 1; + } + + oldcode = code; + } else { + return stbi__errpuc("illegal code in raster", "Corrupt GIF"); + } + } + } +} + +// this function is designed to support animated gifs, although stb_image doesn't support it +// two back is the image from two frames ago, used for a very specific disposal format +static stbi_uc *stbi__gif_load_next(stbi__context *s, stbi__gif *g, int *comp, int req_comp, stbi_uc *two_back) +{ + int dispose; + int first_frame; + int pi; + int pcount; + STBI_NOTUSED(req_comp); + + // on first frame, any non-written pixels get the background colour (non-transparent) + first_frame = 0; + if (g->out == 0) { + if (!stbi__gif_header(s, g, comp,0)) return 0; // stbi__g_failure_reason set by stbi__gif_header + if (!stbi__mad3sizes_valid(4, g->w, g->h, 0)) + return stbi__errpuc("too large", "GIF image is too large"); + pcount = g->w * g->h; + g->out = (stbi_uc *) stbi__malloc(4 * pcount); + g->background = (stbi_uc *) stbi__malloc(4 * pcount); + g->history = (stbi_uc *) stbi__malloc(pcount); + if (!g->out || !g->background || !g->history) + return stbi__errpuc("outofmem", "Out of memory"); + + // image is treated as "transparent" at the start - ie, nothing overwrites the current background; + // background colour is only used for pixels that are not rendered first frame, after that "background" + // color refers to the color that was there the previous frame. + memset(g->out, 0x00, 4 * pcount); + memset(g->background, 0x00, 4 * pcount); // state of the background (starts transparent) + memset(g->history, 0x00, pcount); // pixels that were affected previous frame + first_frame = 1; + } else { + // second frame - how do we dispose of the previous one? + dispose = (g->eflags & 0x1C) >> 2; + pcount = g->w * g->h; + + if ((dispose == 3) && (two_back == 0)) { + dispose = 2; // if I don't have an image to revert back to, default to the old background + } + + if (dispose == 3) { // use previous graphic + for (pi = 0; pi < pcount; ++pi) { + if (g->history[pi]) { + memcpy( &g->out[pi * 4], &two_back[pi * 4], 4 ); + } + } + } else if (dispose == 2) { + // restore what was changed last frame to background before that frame; + for (pi = 0; pi < pcount; ++pi) { + if (g->history[pi]) { + memcpy( &g->out[pi * 4], &g->background[pi * 4], 4 ); + } + } + } else { + // This is a non-disposal case eithe way, so just + // leave the pixels as is, and they will become the new background + // 1: do not dispose + // 0: not specified. + } + + // background is what out is after the undoing of the previou frame; + memcpy( g->background, g->out, 4 * g->w * g->h ); + } + + // clear my history; + memset( g->history, 0x00, g->w * g->h ); // pixels that were affected previous frame + + for (;;) { + int tag = stbi__get8(s); + switch (tag) { + case 0x2C: /* Image Descriptor */ + { + stbi__int32 x, y, w, h; + stbi_uc *o; + + x = stbi__get16le(s); + y = stbi__get16le(s); + w = stbi__get16le(s); + h = stbi__get16le(s); + if (((x + w) > (g->w)) || ((y + h) > (g->h))) + return stbi__errpuc("bad Image Descriptor", "Corrupt GIF"); + + g->line_size = g->w * 4; + g->start_x = x * 4; + g->start_y = y * g->line_size; + g->max_x = g->start_x + w * 4; + g->max_y = g->start_y + h * g->line_size; + g->cur_x = g->start_x; + g->cur_y = g->start_y; + + // if the width of the specified rectangle is 0, that means + // we may not see *any* pixels or the image is malformed; + // to make sure this is caught, move the current y down to + // max_y (which is what out_gif_code checks). + if (w == 0) + g->cur_y = g->max_y; + + g->lflags = stbi__get8(s); + + if (g->lflags & 0x40) { + g->step = 8 * g->line_size; // first interlaced spacing + g->parse = 3; + } else { + g->step = g->line_size; + g->parse = 0; + } + + if (g->lflags & 0x80) { + stbi__gif_parse_colortable(s,g->lpal, 2 << (g->lflags & 7), g->eflags & 0x01 ? g->transparent : -1); + g->color_table = (stbi_uc *) g->lpal; + } else if (g->flags & 0x80) { + g->color_table = (stbi_uc *) g->pal; + } else + return stbi__errpuc("missing color table", "Corrupt GIF"); + + o = stbi__process_gif_raster(s, g); + if (!o) return NULL; + + // if this was the first frame, + pcount = g->w * g->h; + if (first_frame && (g->bgindex > 0)) { + // if first frame, any pixel not drawn to gets the background color + for (pi = 0; pi < pcount; ++pi) { + if (g->history[pi] == 0) { + g->pal[g->bgindex][3] = 255; // just in case it was made transparent, undo that; It will be reset next frame if need be; + memcpy( &g->out[pi * 4], &g->pal[g->bgindex], 4 ); + } + } + } + + return o; + } + + case 0x21: // Comment Extension. + { + int len; + int ext = stbi__get8(s); + if (ext == 0xF9) { // Graphic Control Extension. + len = stbi__get8(s); + if (len == 4) { + g->eflags = stbi__get8(s); + g->delay = 10 * stbi__get16le(s); // delay - 1/100th of a second, saving as 1/1000ths. + + // unset old transparent + if (g->transparent >= 0) { + g->pal[g->transparent][3] = 255; + } + if (g->eflags & 0x01) { + g->transparent = stbi__get8(s); + if (g->transparent >= 0) { + g->pal[g->transparent][3] = 0; + } + } else { + // don't need transparent + stbi__skip(s, 1); + g->transparent = -1; + } + } else { + stbi__skip(s, len); + break; + } + } + while ((len = stbi__get8(s)) != 0) { + stbi__skip(s, len); + } + break; + } + + case 0x3B: // gif stream termination code + return (stbi_uc *) s; // using '1' causes warning on some compilers + + default: + return stbi__errpuc("unknown code", "Corrupt GIF"); + } + } +} + +static void *stbi__load_gif_main_outofmem(stbi__gif *g, stbi_uc *out, int **delays) +{ + STBI_FREE(g->out); + STBI_FREE(g->history); + STBI_FREE(g->background); + + if (out) STBI_FREE(out); + if (delays && *delays) STBI_FREE(*delays); + return stbi__errpuc("outofmem", "Out of memory"); +} + +static void *stbi__load_gif_main(stbi__context *s, int **delays, int *x, int *y, int *z, int *comp, int req_comp) +{ + if (stbi__gif_test(s)) { + int layers = 0; + stbi_uc *u = 0; + stbi_uc *out = 0; + stbi_uc *two_back = 0; + stbi__gif g; + int stride; + int out_size = 0; + int delays_size = 0; + + STBI_NOTUSED(out_size); + STBI_NOTUSED(delays_size); + + memset(&g, 0, sizeof(g)); + if (delays) { + *delays = 0; + } + + do { + u = stbi__gif_load_next(s, &g, comp, req_comp, two_back); + if (u == (stbi_uc *) s) u = 0; // end of animated gif marker + + if (u) { + *x = g.w; + *y = g.h; + ++layers; + stride = g.w * g.h * 4; + + if (out) { + void *tmp = (stbi_uc*) STBI_REALLOC_SIZED( out, out_size, layers * stride ); + if (!tmp) + return stbi__load_gif_main_outofmem(&g, out, delays); + else { + out = (stbi_uc*) tmp; + out_size = layers * stride; + } + + if (delays) { + int *new_delays = (int*) STBI_REALLOC_SIZED( *delays, delays_size, sizeof(int) * layers ); + if (!new_delays) + return stbi__load_gif_main_outofmem(&g, out, delays); + *delays = new_delays; + delays_size = layers * sizeof(int); + } + } else { + out = (stbi_uc*)stbi__malloc( layers * stride ); + if (!out) + return stbi__load_gif_main_outofmem(&g, out, delays); + out_size = layers * stride; + if (delays) { + *delays = (int*) stbi__malloc( layers * sizeof(int) ); + if (!*delays) + return stbi__load_gif_main_outofmem(&g, out, delays); + delays_size = layers * sizeof(int); + } + } + memcpy( out + ((layers - 1) * stride), u, stride ); + if (layers >= 2) { + two_back = out - 2 * stride; + } + + if (delays) { + (*delays)[layers - 1U] = g.delay; + } + } + } while (u != 0); + + // free temp buffer; + STBI_FREE(g.out); + STBI_FREE(g.history); + STBI_FREE(g.background); + + // do the final conversion after loading everything; + if (req_comp && req_comp != 4) + out = stbi__convert_format(out, 4, req_comp, layers * g.w, g.h); + + *z = layers; + return out; + } else { + return stbi__errpuc("not GIF", "Image was not as a gif type."); + } +} + +static void *stbi__gif_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) +{ + stbi_uc *u = 0; + stbi__gif g; + memset(&g, 0, sizeof(g)); + STBI_NOTUSED(ri); + + u = stbi__gif_load_next(s, &g, comp, req_comp, 0); + if (u == (stbi_uc *) s) u = 0; // end of animated gif marker + if (u) { + *x = g.w; + *y = g.h; + + // moved conversion to after successful load so that the same + // can be done for multiple frames. + if (req_comp && req_comp != 4) + u = stbi__convert_format(u, 4, req_comp, g.w, g.h); + } else if (g.out) { + // if there was an error and we allocated an image buffer, free it! + STBI_FREE(g.out); + } + + // free buffers needed for multiple frame loading; + STBI_FREE(g.history); + STBI_FREE(g.background); + + return u; +} + +static int stbi__gif_info(stbi__context *s, int *x, int *y, int *comp) +{ + return stbi__gif_info_raw(s,x,y,comp); +} +#endif + +// ************************************************************************************************* +// Radiance RGBE HDR loader +// originally by Nicolas Schulz +#ifndef STBI_NO_HDR +static int stbi__hdr_test_core(stbi__context *s, const char *signature) +{ + int i; + for (i=0; signature[i]; ++i) + if (stbi__get8(s) != signature[i]) + return 0; + stbi__rewind(s); + return 1; +} + +static int stbi__hdr_test(stbi__context* s) +{ + int r = stbi__hdr_test_core(s, "#?RADIANCE\n"); + stbi__rewind(s); + if(!r) { + r = stbi__hdr_test_core(s, "#?RGBE\n"); + stbi__rewind(s); + } + return r; +} + +#define STBI__HDR_BUFLEN 1024 +static char *stbi__hdr_gettoken(stbi__context *z, char *buffer) +{ + int len=0; + char c = '\0'; + + c = (char) stbi__get8(z); + + while (!stbi__at_eof(z) && c != '\n') { + buffer[len++] = c; + if (len == STBI__HDR_BUFLEN-1) { + // flush to end of line + while (!stbi__at_eof(z) && stbi__get8(z) != '\n') + ; + break; + } + c = (char) stbi__get8(z); + } + + buffer[len] = 0; + return buffer; +} + +static void stbi__hdr_convert(float *output, stbi_uc *input, int req_comp) +{ + if ( input[3] != 0 ) { + float f1; + // Exponent + f1 = (float) ldexp(1.0f, input[3] - (int)(128 + 8)); + if (req_comp <= 2) + output[0] = (input[0] + input[1] + input[2]) * f1 / 3; + else { + output[0] = input[0] * f1; + output[1] = input[1] * f1; + output[2] = input[2] * f1; + } + if (req_comp == 2) output[1] = 1; + if (req_comp == 4) output[3] = 1; + } else { + switch (req_comp) { + case 4: output[3] = 1; /* fallthrough */ + case 3: output[0] = output[1] = output[2] = 0; + break; + case 2: output[1] = 1; /* fallthrough */ + case 1: output[0] = 0; + break; + } + } +} + +static float *stbi__hdr_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) +{ + char buffer[STBI__HDR_BUFLEN]; + char *token; + int valid = 0; + int width, height; + stbi_uc *scanline; + float *hdr_data; + int len; + unsigned char count, value; + int i, j, k, c1,c2, z; + const char *headerToken; + STBI_NOTUSED(ri); + + // Check identifier + headerToken = stbi__hdr_gettoken(s,buffer); + if (strcmp(headerToken, "#?RADIANCE") != 0 && strcmp(headerToken, "#?RGBE") != 0) + return stbi__errpf("not HDR", "Corrupt HDR image"); + + // Parse header + for(;;) { + token = stbi__hdr_gettoken(s,buffer); + if (token[0] == 0) break; + if (strcmp(token, "FORMAT=32-bit_rle_rgbe") == 0) valid = 1; + } + + if (!valid) return stbi__errpf("unsupported format", "Unsupported HDR format"); + + // Parse width and height + // can't use sscanf() if we're not using stdio! + token = stbi__hdr_gettoken(s,buffer); + if (strncmp(token, "-Y ", 3)) return stbi__errpf("unsupported data layout", "Unsupported HDR format"); + token += 3; + height = (int) strtol(token, &token, 10); + while (*token == ' ') ++token; + if (strncmp(token, "+X ", 3)) return stbi__errpf("unsupported data layout", "Unsupported HDR format"); + token += 3; + width = (int) strtol(token, NULL, 10); + + if (height > STBI_MAX_DIMENSIONS) return stbi__errpf("too large","Very large image (corrupt?)"); + if (width > STBI_MAX_DIMENSIONS) return stbi__errpf("too large","Very large image (corrupt?)"); + + *x = width; + *y = height; + + if (comp) *comp = 3; + if (req_comp == 0) req_comp = 3; + + if (!stbi__mad4sizes_valid(width, height, req_comp, sizeof(float), 0)) + return stbi__errpf("too large", "HDR image is too large"); + + // Read data + hdr_data = (float *) stbi__malloc_mad4(width, height, req_comp, sizeof(float), 0); + if (!hdr_data) + return stbi__errpf("outofmem", "Out of memory"); + + // Load image data + // image data is stored as some number of sca + if ( width < 8 || width >= 32768) { + // Read flat data + for (j=0; j < height; ++j) { + for (i=0; i < width; ++i) { + stbi_uc rgbe[4]; + main_decode_loop: + stbi__getn(s, rgbe, 4); + stbi__hdr_convert(hdr_data + j * width * req_comp + i * req_comp, rgbe, req_comp); + } + } + } else { + // Read RLE-encoded data + scanline = NULL; + + for (j = 0; j < height; ++j) { + c1 = stbi__get8(s); + c2 = stbi__get8(s); + len = stbi__get8(s); + if (c1 != 2 || c2 != 2 || (len & 0x80)) { + // not run-length encoded, so we have to actually use THIS data as a decoded + // pixel (note this can't be a valid pixel--one of RGB must be >= 128) + stbi_uc rgbe[4]; + rgbe[0] = (stbi_uc) c1; + rgbe[1] = (stbi_uc) c2; + rgbe[2] = (stbi_uc) len; + rgbe[3] = (stbi_uc) stbi__get8(s); + stbi__hdr_convert(hdr_data, rgbe, req_comp); + i = 1; + j = 0; + STBI_FREE(scanline); + goto main_decode_loop; // yes, this makes no sense + } + len <<= 8; + len |= stbi__get8(s); + if (len != width) { STBI_FREE(hdr_data); STBI_FREE(scanline); return stbi__errpf("invalid decoded scanline length", "corrupt HDR"); } + if (scanline == NULL) { + scanline = (stbi_uc *) stbi__malloc_mad2(width, 4, 0); + if (!scanline) { + STBI_FREE(hdr_data); + return stbi__errpf("outofmem", "Out of memory"); + } + } + + for (k = 0; k < 4; ++k) { + int nleft; + i = 0; + while ((nleft = width - i) > 0) { + count = stbi__get8(s); + if (count > 128) { + // Run + value = stbi__get8(s); + count -= 128; + if ((count == 0) || (count > nleft)) { STBI_FREE(hdr_data); STBI_FREE(scanline); return stbi__errpf("corrupt", "bad RLE data in HDR"); } + for (z = 0; z < count; ++z) + scanline[i++ * 4 + k] = value; + } else { + // Dump + if ((count == 0) || (count > nleft)) { STBI_FREE(hdr_data); STBI_FREE(scanline); return stbi__errpf("corrupt", "bad RLE data in HDR"); } + for (z = 0; z < count; ++z) + scanline[i++ * 4 + k] = stbi__get8(s); + } + } + } + for (i=0; i < width; ++i) + stbi__hdr_convert(hdr_data+(j*width + i)*req_comp, scanline + i*4, req_comp); + } + if (scanline) + STBI_FREE(scanline); + } + + return hdr_data; +} + +static int stbi__hdr_info(stbi__context *s, int *x, int *y, int *comp) +{ + char buffer[STBI__HDR_BUFLEN]; + char *token; + int valid = 0; + int dummy; + + if (!x) x = &dummy; + if (!y) y = &dummy; + if (!comp) comp = &dummy; + + if (stbi__hdr_test(s) == 0) { + stbi__rewind( s ); + return 0; + } + + for(;;) { + token = stbi__hdr_gettoken(s,buffer); + if (token[0] == 0) break; + if (strcmp(token, "FORMAT=32-bit_rle_rgbe") == 0) valid = 1; + } + + if (!valid) { + stbi__rewind( s ); + return 0; + } + token = stbi__hdr_gettoken(s,buffer); + if (strncmp(token, "-Y ", 3)) { + stbi__rewind( s ); + return 0; + } + token += 3; + *y = (int) strtol(token, &token, 10); + while (*token == ' ') ++token; + if (strncmp(token, "+X ", 3)) { + stbi__rewind( s ); + return 0; + } + token += 3; + *x = (int) strtol(token, NULL, 10); + *comp = 3; + return 1; +} +#endif // STBI_NO_HDR + +#ifndef STBI_NO_BMP +static int stbi__bmp_info(stbi__context *s, int *x, int *y, int *comp) +{ + void *p; + stbi__bmp_data info; + + info.all_a = 255; + p = stbi__bmp_parse_header(s, &info); + if (p == NULL) { + stbi__rewind( s ); + return 0; + } + if (x) *x = s->img_x; + if (y) *y = s->img_y; + if (comp) { + if (info.bpp == 24 && info.ma == 0xff000000) + *comp = 3; + else + *comp = info.ma ? 4 : 3; + } + return 1; +} +#endif + +#ifndef STBI_NO_PSD +static int stbi__psd_info(stbi__context *s, int *x, int *y, int *comp) +{ + int channelCount, dummy, depth; + if (!x) x = &dummy; + if (!y) y = &dummy; + if (!comp) comp = &dummy; + if (stbi__get32be(s) != 0x38425053) { + stbi__rewind( s ); + return 0; + } + if (stbi__get16be(s) != 1) { + stbi__rewind( s ); + return 0; + } + stbi__skip(s, 6); + channelCount = stbi__get16be(s); + if (channelCount < 0 || channelCount > 16) { + stbi__rewind( s ); + return 0; + } + *y = stbi__get32be(s); + *x = stbi__get32be(s); + depth = stbi__get16be(s); + if (depth != 8 && depth != 16) { + stbi__rewind( s ); + return 0; + } + if (stbi__get16be(s) != 3) { + stbi__rewind( s ); + return 0; + } + *comp = 4; + return 1; +} + +static int stbi__psd_is16(stbi__context *s) +{ + int channelCount, depth; + if (stbi__get32be(s) != 0x38425053) { + stbi__rewind( s ); + return 0; + } + if (stbi__get16be(s) != 1) { + stbi__rewind( s ); + return 0; + } + stbi__skip(s, 6); + channelCount = stbi__get16be(s); + if (channelCount < 0 || channelCount > 16) { + stbi__rewind( s ); + return 0; + } + STBI_NOTUSED(stbi__get32be(s)); + STBI_NOTUSED(stbi__get32be(s)); + depth = stbi__get16be(s); + if (depth != 16) { + stbi__rewind( s ); + return 0; + } + return 1; +} +#endif + +#ifndef STBI_NO_PIC +static int stbi__pic_info(stbi__context *s, int *x, int *y, int *comp) +{ + int act_comp=0,num_packets=0,chained,dummy; + stbi__pic_packet packets[10]; + + if (!x) x = &dummy; + if (!y) y = &dummy; + if (!comp) comp = &dummy; + + if (!stbi__pic_is4(s,"\x53\x80\xF6\x34")) { + stbi__rewind(s); + return 0; + } + + stbi__skip(s, 88); + + *x = stbi__get16be(s); + *y = stbi__get16be(s); + if (stbi__at_eof(s)) { + stbi__rewind( s); + return 0; + } + if ( (*x) != 0 && (1 << 28) / (*x) < (*y)) { + stbi__rewind( s ); + return 0; + } + + stbi__skip(s, 8); + + do { + stbi__pic_packet *packet; + + if (num_packets==sizeof(packets)/sizeof(packets[0])) + return 0; + + packet = &packets[num_packets++]; + chained = stbi__get8(s); + packet->size = stbi__get8(s); + packet->type = stbi__get8(s); + packet->channel = stbi__get8(s); + act_comp |= packet->channel; + + if (stbi__at_eof(s)) { + stbi__rewind( s ); + return 0; + } + if (packet->size != 8) { + stbi__rewind( s ); + return 0; + } + } while (chained); + + *comp = (act_comp & 0x10 ? 4 : 3); + + return 1; +} +#endif + +// ************************************************************************************************* +// Portable Gray Map and Portable Pixel Map loader +// by Ken Miller +// +// PGM: http://netpbm.sourceforge.net/doc/pgm.html +// PPM: http://netpbm.sourceforge.net/doc/ppm.html +// +// Known limitations: +// Does not support comments in the header section +// Does not support ASCII image data (formats P2 and P3) + +#ifndef STBI_NO_PNM + +static int stbi__pnm_test(stbi__context *s) +{ + char p, t; + p = (char) stbi__get8(s); + t = (char) stbi__get8(s); + if (p != 'P' || (t != '5' && t != '6')) { + stbi__rewind( s ); + return 0; + } + return 1; +} + +static void *stbi__pnm_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) +{ + stbi_uc *out; + STBI_NOTUSED(ri); + + ri->bits_per_channel = stbi__pnm_info(s, (int *)&s->img_x, (int *)&s->img_y, (int *)&s->img_n); + if (ri->bits_per_channel == 0) + return 0; + + if (s->img_y > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); + if (s->img_x > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); + + *x = s->img_x; + *y = s->img_y; + if (comp) *comp = s->img_n; + + if (!stbi__mad4sizes_valid(s->img_n, s->img_x, s->img_y, ri->bits_per_channel / 8, 0)) + return stbi__errpuc("too large", "PNM too large"); + + out = (stbi_uc *) stbi__malloc_mad4(s->img_n, s->img_x, s->img_y, ri->bits_per_channel / 8, 0); + if (!out) return stbi__errpuc("outofmem", "Out of memory"); + if (!stbi__getn(s, out, s->img_n * s->img_x * s->img_y * (ri->bits_per_channel / 8))) { + STBI_FREE(out); + return stbi__errpuc("bad PNM", "PNM file truncated"); + } + + if (req_comp && req_comp != s->img_n) { + if (ri->bits_per_channel == 16) { + out = (stbi_uc *) stbi__convert_format16((stbi__uint16 *) out, s->img_n, req_comp, s->img_x, s->img_y); + } else { + out = stbi__convert_format(out, s->img_n, req_comp, s->img_x, s->img_y); + } + if (out == NULL) return out; // stbi__convert_format frees input on failure + } + return out; +} + +static int stbi__pnm_isspace(char c) +{ + return c == ' ' || c == '\t' || c == '\n' || c == '\v' || c == '\f' || c == '\r'; +} + +static void stbi__pnm_skip_whitespace(stbi__context *s, char *c) +{ + for (;;) { + while (!stbi__at_eof(s) && stbi__pnm_isspace(*c)) + *c = (char) stbi__get8(s); + + if (stbi__at_eof(s) || *c != '#') + break; + + while (!stbi__at_eof(s) && *c != '\n' && *c != '\r' ) + *c = (char) stbi__get8(s); + } +} + +static int stbi__pnm_isdigit(char c) +{ + return c >= '0' && c <= '9'; +} + +static int stbi__pnm_getinteger(stbi__context *s, char *c) +{ + int value = 0; + + while (!stbi__at_eof(s) && stbi__pnm_isdigit(*c)) { + value = value*10 + (*c - '0'); + *c = (char) stbi__get8(s); + if((value > 214748364) || (value == 214748364 && *c > '7')) + return stbi__err("integer parse overflow", "Parsing an integer in the PPM header overflowed a 32-bit int"); + } + + return value; +} + +static int stbi__pnm_info(stbi__context *s, int *x, int *y, int *comp) +{ + int maxv, dummy; + char c, p, t; + + if (!x) x = &dummy; + if (!y) y = &dummy; + if (!comp) comp = &dummy; + + stbi__rewind(s); + + // Get identifier + p = (char) stbi__get8(s); + t = (char) stbi__get8(s); + if (p != 'P' || (t != '5' && t != '6')) { + stbi__rewind(s); + return 0; + } + + *comp = (t == '6') ? 3 : 1; // '5' is 1-component .pgm; '6' is 3-component .ppm + + c = (char) stbi__get8(s); + stbi__pnm_skip_whitespace(s, &c); + + *x = stbi__pnm_getinteger(s, &c); // read width + if(*x == 0) + return stbi__err("invalid width", "PPM image header had zero or overflowing width"); + stbi__pnm_skip_whitespace(s, &c); + + *y = stbi__pnm_getinteger(s, &c); // read height + if (*y == 0) + return stbi__err("invalid width", "PPM image header had zero or overflowing width"); + stbi__pnm_skip_whitespace(s, &c); + + maxv = stbi__pnm_getinteger(s, &c); // read max value + if (maxv > 65535) + return stbi__err("max value > 65535", "PPM image supports only 8-bit and 16-bit images"); + else if (maxv > 255) + return 16; + else + return 8; +} + +static int stbi__pnm_is16(stbi__context *s) +{ + if (stbi__pnm_info(s, NULL, NULL, NULL) == 16) + return 1; + return 0; +} +#endif + +static int stbi__info_main(stbi__context *s, int *x, int *y, int *comp) +{ + #ifndef STBI_NO_JPEG + if (stbi__jpeg_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_PNG + if (stbi__png_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_GIF + if (stbi__gif_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_BMP + if (stbi__bmp_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_PSD + if (stbi__psd_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_PIC + if (stbi__pic_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_PNM + if (stbi__pnm_info(s, x, y, comp)) return 1; + #endif + + #ifndef STBI_NO_HDR + if (stbi__hdr_info(s, x, y, comp)) return 1; + #endif + + // test tga last because it's a crappy test! + #ifndef STBI_NO_TGA + if (stbi__tga_info(s, x, y, comp)) + return 1; + #endif + return stbi__err("unknown image type", "Image not of any known type, or corrupt"); +} + +static int stbi__is_16_main(stbi__context *s) +{ + #ifndef STBI_NO_PNG + if (stbi__png_is16(s)) return 1; + #endif + + #ifndef STBI_NO_PSD + if (stbi__psd_is16(s)) return 1; + #endif + + #ifndef STBI_NO_PNM + if (stbi__pnm_is16(s)) return 1; + #endif + return 0; +} + +#ifndef STBI_NO_STDIO +STBIDEF int stbi_info(char const *filename, int *x, int *y, int *comp) +{ + FILE *f = stbi__fopen(filename, "rb"); + int result; + if (!f) return stbi__err("can't fopen", "Unable to open file"); + result = stbi_info_from_file(f, x, y, comp); + fclose(f); + return result; +} + +STBIDEF int stbi_info_from_file(FILE *f, int *x, int *y, int *comp) +{ + int r; + stbi__context s; + long pos = ftell(f); + stbi__start_file(&s, f); + r = stbi__info_main(&s,x,y,comp); + fseek(f,pos,SEEK_SET); + return r; +} + +STBIDEF int stbi_is_16_bit(char const *filename) +{ + FILE *f = stbi__fopen(filename, "rb"); + int result; + if (!f) return stbi__err("can't fopen", "Unable to open file"); + result = stbi_is_16_bit_from_file(f); + fclose(f); + return result; +} + +STBIDEF int stbi_is_16_bit_from_file(FILE *f) +{ + int r; + stbi__context s; + long pos = ftell(f); + stbi__start_file(&s, f); + r = stbi__is_16_main(&s); + fseek(f,pos,SEEK_SET); + return r; +} +#endif // !STBI_NO_STDIO + +STBIDEF int stbi_info_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *comp) +{ + stbi__context s; + stbi__start_mem(&s,buffer,len); + return stbi__info_main(&s,x,y,comp); +} + +STBIDEF int stbi_info_from_callbacks(stbi_io_callbacks const *c, void *user, int *x, int *y, int *comp) +{ + stbi__context s; + stbi__start_callbacks(&s, (stbi_io_callbacks *) c, user); + return stbi__info_main(&s,x,y,comp); +} + +STBIDEF int stbi_is_16_bit_from_memory(stbi_uc const *buffer, int len) +{ + stbi__context s; + stbi__start_mem(&s,buffer,len); + return stbi__is_16_main(&s); +} + +STBIDEF int stbi_is_16_bit_from_callbacks(stbi_io_callbacks const *c, void *user) +{ + stbi__context s; + stbi__start_callbacks(&s, (stbi_io_callbacks *) c, user); + return stbi__is_16_main(&s); +} + +#endif // STB_IMAGE_IMPLEMENTATION + +/* + revision history: + 2.20 (2019-02-07) support utf8 filenames in Windows; fix warnings and platform ifdefs + 2.19 (2018-02-11) fix warning + 2.18 (2018-01-30) fix warnings + 2.17 (2018-01-29) change sbti__shiftsigned to avoid clang -O2 bug + 1-bit BMP + *_is_16_bit api + avoid warnings + 2.16 (2017-07-23) all functions have 16-bit variants; + STBI_NO_STDIO works again; + compilation fixes; + fix rounding in unpremultiply; + optimize vertical flip; + disable raw_len validation; + documentation fixes + 2.15 (2017-03-18) fix png-1,2,4 bug; now all Imagenet JPGs decode; + warning fixes; disable run-time SSE detection on gcc; + uniform handling of optional "return" values; + thread-safe initialization of zlib tables + 2.14 (2017-03-03) remove deprecated STBI_JPEG_OLD; fixes for Imagenet JPGs + 2.13 (2016-11-29) add 16-bit API, only supported for PNG right now + 2.12 (2016-04-02) fix typo in 2.11 PSD fix that caused crashes + 2.11 (2016-04-02) allocate large structures on the stack + remove white matting for transparent PSD + fix reported channel count for PNG & BMP + re-enable SSE2 in non-gcc 64-bit + support RGB-formatted JPEG + read 16-bit PNGs (only as 8-bit) + 2.10 (2016-01-22) avoid warning introduced in 2.09 by STBI_REALLOC_SIZED + 2.09 (2016-01-16) allow comments in PNM files + 16-bit-per-pixel TGA (not bit-per-component) + info() for TGA could break due to .hdr handling + info() for BMP to shares code instead of sloppy parse + can use STBI_REALLOC_SIZED if allocator doesn't support realloc + code cleanup + 2.08 (2015-09-13) fix to 2.07 cleanup, reading RGB PSD as RGBA + 2.07 (2015-09-13) fix compiler warnings + partial animated GIF support + limited 16-bpc PSD support + #ifdef unused functions + bug with < 92 byte PIC,PNM,HDR,TGA + 2.06 (2015-04-19) fix bug where PSD returns wrong '*comp' value + 2.05 (2015-04-19) fix bug in progressive JPEG handling, fix warning + 2.04 (2015-04-15) try to re-enable SIMD on MinGW 64-bit + 2.03 (2015-04-12) extra corruption checking (mmozeiko) + stbi_set_flip_vertically_on_load (nguillemot) + fix NEON support; fix mingw support + 2.02 (2015-01-19) fix incorrect assert, fix warning + 2.01 (2015-01-17) fix various warnings; suppress SIMD on gcc 32-bit without -msse2 + 2.00b (2014-12-25) fix STBI_MALLOC in progressive JPEG + 2.00 (2014-12-25) optimize JPG, including x86 SSE2 & NEON SIMD (ryg) + progressive JPEG (stb) + PGM/PPM support (Ken Miller) + STBI_MALLOC,STBI_REALLOC,STBI_FREE + GIF bugfix -- seemingly never worked + STBI_NO_*, STBI_ONLY_* + 1.48 (2014-12-14) fix incorrectly-named assert() + 1.47 (2014-12-14) 1/2/4-bit PNG support, both direct and paletted (Omar Cornut & stb) + optimize PNG (ryg) + fix bug in interlaced PNG with user-specified channel count (stb) + 1.46 (2014-08-26) + fix broken tRNS chunk (colorkey-style transparency) in non-paletted PNG + 1.45 (2014-08-16) + fix MSVC-ARM internal compiler error by wrapping malloc + 1.44 (2014-08-07) + various warning fixes from Ronny Chevalier + 1.43 (2014-07-15) + fix MSVC-only compiler problem in code changed in 1.42 + 1.42 (2014-07-09) + don't define _CRT_SECURE_NO_WARNINGS (affects user code) + fixes to stbi__cleanup_jpeg path + added STBI_ASSERT to avoid requiring assert.h + 1.41 (2014-06-25) + fix search&replace from 1.36 that messed up comments/error messages + 1.40 (2014-06-22) + fix gcc struct-initialization warning + 1.39 (2014-06-15) + fix to TGA optimization when req_comp != number of components in TGA; + fix to GIF loading because BMP wasn't rewinding (whoops, no GIFs in my test suite) + add support for BMP version 5 (more ignored fields) + 1.38 (2014-06-06) + suppress MSVC warnings on integer casts truncating values + fix accidental rename of 'skip' field of I/O + 1.37 (2014-06-04) + remove duplicate typedef + 1.36 (2014-06-03) + convert to header file single-file library + if de-iphone isn't set, load iphone images color-swapped instead of returning NULL + 1.35 (2014-05-27) + various warnings + fix broken STBI_SIMD path + fix bug where stbi_load_from_file no longer left file pointer in correct place + fix broken non-easy path for 32-bit BMP (possibly never used) + TGA optimization by Arseny Kapoulkine + 1.34 (unknown) + use STBI_NOTUSED in stbi__resample_row_generic(), fix one more leak in tga failure case + 1.33 (2011-07-14) + make stbi_is_hdr work in STBI_NO_HDR (as specified), minor compiler-friendly improvements + 1.32 (2011-07-13) + support for "info" function for all supported filetypes (SpartanJ) + 1.31 (2011-06-20) + a few more leak fixes, bug in PNG handling (SpartanJ) + 1.30 (2011-06-11) + added ability to load files via callbacks to accomidate custom input streams (Ben Wenger) + removed deprecated format-specific test/load functions + removed support for installable file formats (stbi_loader) -- would have been broken for IO callbacks anyway + error cases in bmp and tga give messages and don't leak (Raymond Barbiero, grisha) + fix inefficiency in decoding 32-bit BMP (David Woo) + 1.29 (2010-08-16) + various warning fixes from Aurelien Pocheville + 1.28 (2010-08-01) + fix bug in GIF palette transparency (SpartanJ) + 1.27 (2010-08-01) + cast-to-stbi_uc to fix warnings + 1.26 (2010-07-24) + fix bug in file buffering for PNG reported by SpartanJ + 1.25 (2010-07-17) + refix trans_data warning (Won Chun) + 1.24 (2010-07-12) + perf improvements reading from files on platforms with lock-heavy fgetc() + minor perf improvements for jpeg + deprecated type-specific functions so we'll get feedback if they're needed + attempt to fix trans_data warning (Won Chun) + 1.23 fixed bug in iPhone support + 1.22 (2010-07-10) + removed image *writing* support + stbi_info support from Jetro Lauha + GIF support from Jean-Marc Lienher + iPhone PNG-extensions from James Brown + warning-fixes from Nicolas Schulz and Janez Zemva (i.stbi__err. Janez (U+017D)emva) + 1.21 fix use of 'stbi_uc' in header (reported by jon blow) + 1.20 added support for Softimage PIC, by Tom Seddon + 1.19 bug in interlaced PNG corruption check (found by ryg) + 1.18 (2008-08-02) + fix a threading bug (local mutable static) + 1.17 support interlaced PNG + 1.16 major bugfix - stbi__convert_format converted one too many pixels + 1.15 initialize some fields for thread safety + 1.14 fix threadsafe conversion bug + header-file-only version (#define STBI_HEADER_FILE_ONLY before including) + 1.13 threadsafe + 1.12 const qualifiers in the API + 1.11 Support installable IDCT, colorspace conversion routines + 1.10 Fixes for 64-bit (don't use "unsigned long") + optimized upsampling by Fabian "ryg" Giesen + 1.09 Fix format-conversion for PSD code (bad global variables!) + 1.08 Thatcher Ulrich's PSD code integrated by Nicolas Schulz + 1.07 attempt to fix C++ warning/errors again + 1.06 attempt to fix C++ warning/errors again + 1.05 fix TGA loading to return correct *comp and use good luminance calc + 1.04 default float alpha is 1, not 255; use 'void *' for stbi_image_free + 1.03 bugfixes to STBI_NO_STDIO, STBI_NO_HDR + 1.02 support for (subset of) HDR files, float interface for preferred access to them + 1.01 fix bug: possible bug in handling right-side up bmps... not sure + fix bug: the stbi__bmp_load() and stbi__tga_load() functions didn't work at all + 1.00 interface to zlib that skips zlib header + 0.99 correct handling of alpha in palette + 0.98 TGA loader by lonesock; dynamically add loaders (untested) + 0.97 jpeg errors on too large a file; also catch another malloc failure + 0.96 fix detection of invalid v value - particleman@mollyrocket forum + 0.95 during header scan, seek to markers in case of padding + 0.94 STBI_NO_STDIO to disable stdio usage; rename all #defines the same + 0.93 handle jpegtran output; verbose errors + 0.92 read 4,8,16,24,32-bit BMP files of several formats + 0.91 output 24-bit Windows 3.0 BMP files + 0.90 fix a few more warnings; bump version number to approach 1.0 + 0.61 bugfixes due to Marc LeBlanc, Christopher Lloyd + 0.60 fix compiling as c++ + 0.59 fix warnings: merge Dave Moore's -Wall fixes + 0.58 fix bug: zlib uncompressed mode len/nlen was wrong endian + 0.57 fix bug: jpg last huffman symbol before marker was >9 bits but less than 16 available + 0.56 fix bug: zlib uncompressed mode len vs. nlen + 0.55 fix bug: restart_interval not initialized to 0 + 0.54 allow NULL for 'int *comp' + 0.53 fix bug in png 3->4; speedup png decoding + 0.52 png handles req_comp=3,4 directly; minor cleanup; jpeg comments + 0.51 obey req_comp requests, 1-component jpegs return as 1-component, + on 'test' only check type, not whether we support this variant + 0.50 (2006-11-19) + first released version +*/ + + +/* +------------------------------------------------------------------------------ +This software is available under 2 licenses -- choose whichever you prefer. +------------------------------------------------------------------------------ +ALTERNATIVE A - MIT License +Copyright (c) 2017 Sean Barrett +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. +------------------------------------------------------------------------------ +ALTERNATIVE B - Public Domain (www.unlicense.org) +This is free and unencumbered software released into the public domain. +Anyone is free to copy, modify, publish, use, compile, sell, or distribute this +software, either in source code form or as a compiled binary, for any purpose, +commercial or non-commercial, and by any means. +In jurisdictions that recognize copyright laws, the author or authors of this +software dedicate any and all copyright interest in the software to the public +domain. We make this dedication for the benefit of the public at large and to +the detriment of our heirs and successors. We intend this dedication to be an +overt act of relinquishment in perpetuity of all present and future rights to +this software under copyright law. +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 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. +------------------------------------------------------------------------------ +*/ diff --git a/scripts/switch/selftest_build_switch.sh b/scripts/switch/selftest_build_switch.sh index b7eb9109..9bcfbc5b 100755 --- a/scripts/switch/selftest_build_switch.sh +++ b/scripts/switch/selftest_build_switch.sh @@ -385,12 +385,13 @@ else bad "legacy separate OTA-only packer / asset still present" fi -if grep -q 'Quiet by default\|stays quiet\|Quiet' "$ROOT/native/switch-ota-launcher/src/main.c" \ - && grep -q 'ui_begin' "$ROOT/native/switch-ota-launcher/src/main.c" +if grep -q 'ota_ui_prompt_update' "$ROOT/native/switch-ota-launcher/src/main.c" \ + && grep -q 'framebufferCreate\|COL_RAIL' "$ROOT/native/switch-ota-launcher/src/ota_ui.c" \ + && grep -q '^ROMFS' "$ROOT/native/switch-ota-launcher/Makefile" then - ok "launcher UI is quiet by default (console only when needed)" + ok "launcher UI is branded framebuffer (quiet by default)" else - bad "launcher missing quiet-by-default UI gate" + bad "launcher missing branded ota_ui / ROMFS" fi if [ -f "$ROOT/native/switch-ota-launcher/src/ota_unzip.c" ] \ diff --git a/test/switch-nro-ota.spec.test.js b/test/switch-nro-ota.spec.test.js index 087433b0..b9f28e7d 100644 --- a/test/switch-nro-ota.spec.test.js +++ b/test/switch-nro-ota.spec.test.js @@ -400,8 +400,12 @@ test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () = assert.match(main, /envSetNextLoad|ota_fs_handoff_to_game/); assert.match(main, /gen1recomp-game\.nro|OTA_GAME_NRO_NAME/); assert.match(main, /Quiet by default|stays quiet|LÖVE self-updater stays off|self-updater stays off/i); - assert.match(main, /consoleInit/, 'UI uses console only when needed'); - assert.match(main, /ui_begin|g_ui/, 'UI is gated behind begin'); + assert.match(main, /ota_ui_prompt_update|ota_ui_show_progress/); + assert.doesNotMatch(main, /consoleInit/, 'no terminal console UI'); + assert.ok(fs.existsSync(path.join(root, 'native/switch-ota-launcher/src/ota_ui.c'))); + assert.match(read('native/switch-ota-launcher/src/ota_ui.c'), /COL_RAIL_R|rail|FFD600|255,\s*214/); + assert.match(read('native/switch-ota-launcher/src/ota_ui.c'), /logo\.png|stb_image/); + assert.match(read('native/switch-ota-launcher/Makefile'), /^ROMFS\s*:=/m); const mk = read('native/switch-ota-launcher/Makefile'); assert.match(mk, /libnx\/switch_rules|DEVKITPRO/); @@ -452,7 +456,7 @@ test('AC-011: Empacotamento dual-NRO e selftest @spec:AC-011', () => { assert.match(selftest, /dual-NRO|gen1recomp-game\.nro/); assert.match(selftest, /ota_launcher\.manifest/); assert.match(selftest, /unified OTA|same SD zip|legacy OTA-only/i); - assert.match(selftest, /Quiet by default|quiet by default|ui_begin/); + assert.match(selftest, /ota_ui|branded framebuffer|Quiet by default|quiet by default/i); const manifest = read('scripts/switch/ota_launcher.manifest'); assert.match(manifest, /^OTA_ENABLED=1$/m); From ae5276b2d16ba3b744ec85055e888a6549742c52 Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Wed, 5 Aug 2026 02:08:20 -0300 Subject: [PATCH 03/18] Show the running app version on the Switch launcher header. Add an NX-only yellow version chip so players can confirm which build is on the microSD after OTA or zip updates. --- src/import/LauncherView.lua | 16 ++++++++++++ .../engine/launcher_nx_version_chip_test.lua | 26 +++++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 tests/engine/launcher_nx_version_chip_test.lua diff --git a/src/import/LauncherView.lua b/src/import/LauncherView.lua index 7be70f26..713db9a1 100644 --- a/src/import/LauncherView.lua +++ b/src/import/LauncherView.lua @@ -33,6 +33,7 @@ local Theme = require("src.ui.kit.Theme") local Layout = require("src.ui.kit.Layout") local Loader = require("src.ui.kit.Loader") local GameVersion = require("src.core.GameVersion") +local Version = require("src.core.Version") local Strings = require("src.core.Strings") local PAL = Theme.PAL @@ -340,6 +341,21 @@ local function buildHeader(imp, m) local rx = m.x + m.w - m.pad local by = y + (rowH - gear) / 2 + -- Switch-only: show the running app version opposite the settings gear so + -- players can confirm which build is on the microSD (OTA / zip updates). + if imp.isNX then + local label = "v" .. tostring(Version.engine or "?") + local tw = Kit.textWidth("small", label) + local padX = math.floor(12 * m.s) + local chipW = math.max(tw + 2 * padX, gear) + local lx = m.x + m.pad + Theme.fill(lx, by, chipW, gear, PAL.bg, 1) + Theme.stroke(lx, by, chipW, gear, PAL.yellow, Theme.A.hover, 1) + local th = Kit.textHeight("small") + Kit.text("small", label, lx + math.floor((chipW - tw) / 2), + by + math.floor((gear - th) / 2), PAL.yellow) + end + -- Settings gear, top-right corner. imp._gearIcon = imp._gearIcon or love.graphics.newImage("assets/launcher/gear.png") diff --git a/tests/engine/launcher_nx_version_chip_test.lua b/tests/engine/launcher_nx_version_chip_test.lua new file mode 100644 index 00000000..2a76e57e --- /dev/null +++ b/tests/engine/launcher_nx_version_chip_test.lua @@ -0,0 +1,26 @@ +-- Switch launcher shows the running engine version in the header (NX only). +-- Desktop/Android/iOS must not paint that chip. + +local function read(path) + local f = assert(io.open(path, "r")) + local s = f:read("*a") + f:close() + return s +end + +local src = read("src/import/LauncherView.lua") + +assert(src:find('local Version = require%("src%.core%.Version"%)') + or src:find('require%("src%.core%.Version"%)'), + "LauncherView must require Version") + +assert(src:find("imp%.isNX", 1, false), "version chip must gate on isNX") + +-- The chip is inside an isNX block and prints Version.engine +local nxBlock = src:match("if imp%.isNX then(.-)end\n\n %-%- Settings gear") +assert(nxBlock, "expected Switch-only version chip before the settings gear") +assert(nxBlock:find("Version%.engine", 1, false), "chip must show Version.engine") +assert(nxBlock:find('"v"', 1, true) or nxBlock:find('"v" %.%.', 1, false), + "chip label should be a v-prefixed version") + +print("ok — Switch launcher version chip is NX-gated and uses Version.engine") From 1bfc89fdd4b774d619579f966cdc0697e3300a29 Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Wed, 5 Aug 2026 15:15:44 -0300 Subject: [PATCH 04/18] Fix Switch OTA parser for GitHub releases/latest JSON. Scan asset objects by brace bounds instead of an 800-byte window so browser_download_url survives fat uploader blocks; mirror logic in Lua and add realistic API fixtures. --- .../host/test_ota_protocol.c | 50 +++++++ native/switch-ota-launcher/src/ota_protocol.c | 87 +++++++---- src/update/SwitchOta.lua | 75 ++++++++-- test/switch-nro-ota.spec.test.js | 137 +++++++++++++++--- 4 files changed, 289 insertions(+), 60 deletions(-) diff --git a/native/switch-ota-launcher/host/test_ota_protocol.c b/native/switch-ota-launcher/host/test_ota_protocol.c index 9f20fe15..2e432f2a 100644 --- a/native/switch-ota-launcher/host/test_ota_protocol.c +++ b/native/switch-ota-launcher/host/test_ota_protocol.c @@ -48,6 +48,56 @@ int main(void) { "missing ota asset"); expect(strcmp(bad.reason, "missing_ota_asset") == 0, "missing_ota_asset reason"); + /* GitHub releases/latest shape: release-level name + fat uploader before browser_download_url. */ + const char *github_json = + "{" + "\"tag_name\":\"v0.1.70\"," + "\"name\":\"0.1.70\"," + "\"assets\":[" + "{" + "\"url\":\"https://api.github.com/repos/bryanthaboi/gen1recomp/releases/assets/502823880\"," + "\"id\":502823880," + "\"name\":\"gen1recomp-0.1.70-switch.zip\"," + "\"label\":\"\"," + "\"uploader\":{" + "\"login\":\"github-actions[bot]\"," + "\"id\":41898282," + "\"node_id\":\"MDM6Qm90NDE4OTgyODI=\"," + "\"avatar_url\":\"https://avatars.githubusercontent.com/in/15368?v=4\"," + "\"gravatar_id\":\"\"," + "\"url\":\"https://api.github.com/users/github-actions%5Bbot%5D\"," + "\"html_url\":\"https://github.com/apps/github-actions\"," + "\"followers_url\":\"https://api.github.com/users/github-actions%5Bbot%5D/followers\"," + "\"following_url\":\"https://api.github.com/users/github-actions%5Bbot%5D/following{/other_user}\"," + "\"gists_url\":\"https://api.github.com/users/github-actions%5Bbot%5D/gists{/gist_id}\"," + "\"starred_url\":\"https://api.github.com/users/github-actions%5Bbot%5D/starred{/owner}{/repo}\"," + "\"subscriptions_url\":\"https://api.github.com/users/github-actions%5Bbot%5D/subscriptions\"," + "\"organizations_url\":\"https://api.github.com/users/github-actions%5Bbot%5D/orgs\"," + "\"repos_url\":\"https://api.github.com/users/github-actions%5Bbot%5D/repos\"," + "\"events_url\":\"https://api.github.com/users/github-actions%5Bbot%5D/events{/privacy}\"," + "\"received_events_url\":\"https://api.github.com/users/github-actions%5Bbot%5D/received_events\"," + "\"type\":\"Bot\"," + "\"user_view_type\":\"public\"," + "\"site_admin\":false" + "}," + "\"content_type\":\"application/zip\"," + "\"state\":\"uploaded\"," + "\"size\":9000573," + "\"browser_download_url\":\"https://github.com/bryanthaboi/gen1recomp/releases/download/v0.1.70/gen1recomp-0.1.70-switch.zip\"" + "}" + "]" + "}"; + ota_release_t gh; + expect(ota_parse_release(github_json, &gh) == 1, "parse github-shaped release"); + expect(strcmp(gh.version, "0.1.70") == 0, "github release version"); + expect(strcmp(gh.asset_name, "gen1recomp-0.1.70-switch.zip") == 0, "github release asset"); + expect(strcmp(gh.download_url, + "https://github.com/bryanthaboi/gen1recomp/releases/download/v0.1.70/gen1recomp-0.1.70-switch.zip") == + 0, + "github release download url"); + ota_decide_update("0.1.69", &gh, &d); + expect(strcmp(d.status, "available") == 0, "github release decide 0.1.69->0.1.70"); + const char *sums = "abc123 gen1recomp-1.5.0-switch.zip\n"; ota_verify_t v; ota_verify_sha256("gen1recomp-1.5.0-switch.zip", "abc123", sums, &v); diff --git a/native/switch-ota-launcher/src/ota_protocol.c b/native/switch-ota-launcher/src/ota_protocol.c index 4e943ec8..ba41b121 100644 --- a/native/switch-ota-launcher/src/ota_protocol.c +++ b/native/switch-ota-launcher/src/ota_protocol.c @@ -95,6 +95,38 @@ static const char *find_json_string(const char *json, const char *key, char *out return out; } +/* Opening { of the JSON object that contains pos (walk backward). */ +static const char *find_json_object_start(const char *pos, const char *json_start) { + if (!pos || !json_start || pos < json_start) return NULL; + int depth = 0; + const char *p = pos; + while (p >= json_start) { + if (*p == '}') depth++; + else if (*p == '{') { + if (depth == 0) return p; + depth--; + } + p--; + } + return NULL; +} + +/* Pointer just past the closing } of the object that starts at object_start. */ +static const char *find_json_object_end(const char *object_start) { + if (!object_start || *object_start != '{') return NULL; + int depth = 1; + const char *p = object_start + 1; + while (*p) { + if (*p == '{') depth++; + else if (*p == '}') { + depth--; + if (depth == 0) return p + 1; + } + p++; + } + return NULL; +} + int ota_parse_release(const char *json_text, ota_release_t *out) { memset(out, 0, sizeof(*out)); if (!json_text || !*json_text) { @@ -112,7 +144,7 @@ int ota_parse_release(const char *json_text, ota_release_t *out) { } snprintf(out->version, sizeof(out->version), "%d.%d.%d", sv.major, sv.minor, sv.patch); - /* Scan for OTA asset name then its browser_download_url in the same object-ish window. */ + /* Scan for OTA asset name then browser_download_url inside the same asset object. */ const char *cursor = json_text; while ((cursor = strstr(cursor, "\"name\"")) != NULL) { char name[128]; @@ -120,31 +152,36 @@ int ota_parse_release(const char *json_text, ota_release_t *out) { cursor += 6; continue; } - if (ota_is_ota_asset_name(name)) { - snprintf(out->asset_name, sizeof(out->asset_name), "%s", name); - /* Prefer URL after this name key within a limited window. */ - const char *window_end = cursor + 800; - if (window_end > json_text + strlen(json_text)) window_end = json_text + strlen(json_text); - char url[512]; - const char *u = NULL; - const char *scan = cursor; - while (scan < window_end && (scan = strstr(scan, "\"browser_download_url\"")) != NULL && - scan < window_end) { - if (find_json_string(scan, "browser_download_url", url, sizeof(url))) { - u = url; - break; - } - scan += 21; - } - if (!u || !*u) { - set_reason(out->reason, sizeof(out->reason), "missing_download_url"); - return 0; - } - snprintf(out->download_url, sizeof(out->download_url), "%s", u); - out->ok = 1; - return 1; + if (!ota_is_ota_asset_name(name)) { + cursor += 6; + continue; } - cursor += 6; + const char *asset_start = find_json_object_start(cursor, json_text); + const char *asset_end = + asset_start ? find_json_object_end(asset_start) : NULL; + if (!asset_start || !asset_end || asset_end <= cursor) { + cursor += 6; + continue; + } + char url[512]; + const char *u = NULL; + const char *scan = cursor; + while (scan < asset_end && + (scan = strstr(scan, "\"browser_download_url\"")) != NULL && scan < asset_end) { + if (find_json_string(scan, "browser_download_url", url, sizeof(url))) { + u = url; + break; + } + scan += 21; + } + if (!u || !*u) { + cursor += 6; + continue; + } + snprintf(out->asset_name, sizeof(out->asset_name), "%s", name); + snprintf(out->download_url, sizeof(out->download_url), "%s", u); + out->ok = 1; + return 1; } set_reason(out->reason, sizeof(out->reason), "missing_ota_asset"); return 0; diff --git a/src/update/SwitchOta.lua b/src/update/SwitchOta.lua index ba87dd35..db03b22a 100644 --- a/src/update/SwitchOta.lua +++ b/src/update/SwitchOta.lua @@ -47,7 +47,43 @@ function SwitchOta.versionFromOtaAsset(name) return name:match(SwitchOta.OTA_ASSET_PATTERN) end --- Parse GitHub releases/latest JSON (minimal: tag_name + assets[].name/browser_download_url). +local function findJsonObjectStart(jsonText, pos) + if type(jsonText) ~= "string" or not pos or pos < 1 then return nil end + local depth = 0 + local p = pos + while p >= 1 do + local c = jsonText:sub(p, p) + if c == "}" then + depth = depth + 1 + elseif c == "{" then + if depth == 0 then return p end + depth = depth - 1 + end + p = p - 1 + end + return nil +end + +local function findJsonObjectEnd(jsonText, objectStart) + if type(jsonText) ~= "string" or not objectStart then return nil end + if jsonText:sub(objectStart, objectStart) ~= "{" then return nil end + local depth = 1 + local p = objectStart + 1 + local len = #jsonText + while p <= len do + local c = jsonText:sub(p, p) + if c == "{" then + depth = depth + 1 + elseif c == "}" then + depth = depth - 1 + if depth == 0 then return p + 1 end + end + p = p + 1 + end + return nil +end + +-- Parse GitHub releases/latest JSON (tag_name + assets[].name/browser_download_url). -- Returns { tag, version, assetName, downloadUrl } or nil + reason. function SwitchOta.parseRelease(jsonText) if type(jsonText) ~= "string" or jsonText == "" then @@ -58,24 +94,31 @@ function SwitchOta.parseRelease(jsonText) local version = tag:match("^v?(%d+%.%d+%.%d+)$") if not version then return nil, "bad_tag" end - local assetName, downloadUrl - for block in jsonText:gmatch("%b{}") do - local name = block:match('"name"%s*:%s*"(.-)"') + local cursor = 1 + while true do + local nameKeyPos = jsonText:find('"name"', cursor, true) + if not nameKeyPos then break end + local tail = jsonText:sub(nameKeyPos) + local name = tail:match('"name"%s*:%s*"(.-)"') if name and SwitchOta.isOtaAssetName(name) then - assetName = name - downloadUrl = block:match('"browser_download_url"%s*:%s*"(.-)"') - break + local assetStart = findJsonObjectStart(jsonText, nameKeyPos) + local assetEnd = assetStart and findJsonObjectEnd(jsonText, assetStart) + if assetStart and assetEnd and assetEnd > nameKeyPos then + local assetBlock = jsonText:sub(assetStart, assetEnd - 1) + local downloadUrl = assetBlock:match('"browser_download_url"%s*:%s*"(.-)"') + if downloadUrl and downloadUrl ~= "" then + return { + tag = tag, + version = version, + assetName = name, + downloadUrl = downloadUrl, + } + end + end end + cursor = nameKeyPos + 6 end - if not assetName then return nil, "missing_ota_asset" end - if not downloadUrl or downloadUrl == "" then return nil, "missing_download_url" end - - return { - tag = tag, - version = version, - assetName = assetName, - downloadUrl = downloadUrl, - } + return nil, "missing_ota_asset" end -- Decide check outcome given installed version and parsed release. diff --git a/test/switch-nro-ota.spec.test.js b/test/switch-nro-ota.spec.test.js index b9f28e7d..5103bd22 100644 --- a/test/switch-nro-ota.spec.test.js +++ b/test/switch-nro-ota.spec.test.js @@ -50,28 +50,72 @@ function createSwitchOta() { return typeof name === 'string' && OTA_RE.test(name); } + function findJsonObjectStart(jsonText, pos) { + if (!jsonText || pos < 1) return null; + let depth = 0; + for (let p = pos; p >= 1; p--) { + const c = jsonText[p - 1]; + if (c === '}') depth += 1; + else if (c === '{') { + if (depth === 0) return p; + depth -= 1; + } + } + return null; + } + + function findJsonObjectEnd(jsonText, objectStart) { + if (!jsonText || objectStart < 1) return null; + if (jsonText[objectStart - 1] !== '{') return null; + let depth = 1; + for (let p = objectStart + 1; p <= jsonText.length; p++) { + const c = jsonText[p - 1]; + if (c === '{') depth += 1; + else if (c === '}') { + depth -= 1; + if (depth === 0) return p + 1; + } + } + return null; + } + function parseRelease(jsonText) { if (!jsonText) return { ok: false, reason: 'empty_json' }; - let obj; - try { - obj = JSON.parse(jsonText); - } catch { - return { ok: false, reason: 'bad_json' }; + const tagM = jsonText.match(/"tag_name"\s*:\s*"([^"]+)"/); + if (!tagM) return { ok: false, reason: 'missing_tag' }; + const tag = tagM[1]; + const versionM = tag.match(/^v?(\d+\.\d+\.\d+)$/); + if (!versionM) return { ok: false, reason: 'bad_tag' }; + const version = versionM[1]; + + let cursor = 0; + while (true) { + const nameKeyPos = jsonText.indexOf('"name"', cursor); + if (nameKeyPos === -1) break; + const tail = jsonText.slice(nameKeyPos); + const nameM = tail.match(/"name"\s*:\s*"([^"]+)"/); + const name = nameM?.[1]; + if (name && isOtaAssetName(name)) { + const assetStart = findJsonObjectStart(jsonText, nameKeyPos + 1); + const assetEnd = assetStart ? findJsonObjectEnd(jsonText, assetStart) : null; + if (assetStart && assetEnd && assetEnd > nameKeyPos + 1) { + const assetBlock = jsonText.slice(assetStart - 1, assetEnd - 1); + const urlM = assetBlock.match(/"browser_download_url"\s*:\s*"([^"]+)"/); + const downloadUrl = urlM?.[1]; + if (downloadUrl) { + return { + ok: true, + tag, + version, + assetName: name, + downloadUrl, + }; + } + } + } + cursor = nameKeyPos + 6; } - const tag = obj.tag_name; - if (!tag) return { ok: false, reason: 'missing_tag' }; - const version = String(tag).match(/^v?(\d+\.\d+\.\d+)$/)?.[1]; - if (!version) return { ok: false, reason: 'bad_tag' }; - const asset = (obj.assets || []).find((a) => isOtaAssetName(a.name)); - if (!asset) return { ok: false, reason: 'missing_ota_asset' }; - if (!asset.browser_download_url) return { ok: false, reason: 'missing_download_url' }; - return { - ok: true, - tag, - version, - assetName: asset.name, - downloadUrl: asset.browser_download_url, - }; + return { ok: false, reason: 'missing_ota_asset' }; } function decideUpdate(installed, release) { @@ -168,6 +212,51 @@ function createSwitchOta() { const M = createSwitchOta(); +const GITHUB_UPLOADER = + '"login":"github-actions[bot]",' + + '"id":41898282,' + + '"node_id":"MDM6Qm90NDE4OTgyODI=",' + + '"avatar_url":"https://avatars.githubusercontent.com/in/15368?v=4",' + + '"gravatar_id":"",' + + '"url":"https://api.github.com/users/github-actions%5Bbot%5D",' + + '"html_url":"https://github.com/apps/github-actions",' + + '"followers_url":"https://api.github.com/users/github-actions%5Bbot%5D/followers",' + + '"following_url":"https://api.github.com/users/github-actions%5Bbot%5D/following{/other_user}",' + + '"gists_url":"https://api.github.com/users/github-actions%5Bbot%5D/gists{/gist_id}",' + + '"starred_url":"https://api.github.com/users/github-actions%5Bbot%5D/starred{/owner}{/repo}",' + + '"subscriptions_url":"https://api.github.com/users/github-actions%5Bbot%5D/subscriptions",' + + '"organizations_url":"https://api.github.com/users/github-actions%5Bbot%5D/orgs",' + + '"repos_url":"https://api.github.com/users/github-actions%5Bbot%5D/repos",' + + '"events_url":"https://api.github.com/users/github-actions%5Bbot%5D/events{/privacy}",' + + '"received_events_url":"https://api.github.com/users/github-actions%5Bbot%5D/received_events",' + + '"type":"Bot",' + + '"user_view_type":"public",' + + '"site_admin":false'; + +function buildGithubReleaseJson() { + return ( + '{' + + '"tag_name":"v0.1.70",' + + '"name":"0.1.70",' + + '"assets":[' + + '{' + + '"url":"https://api.github.com/repos/bryanthaboi/gen1recomp/releases/assets/502823880",' + + '"id":502823880,' + + '"name":"gen1recomp-0.1.70-switch.zip",' + + '"label":"",' + + '"uploader":{' + + GITHUB_UPLOADER + + '},' + + '"content_type":"application/zip",' + + '"state":"uploaded",' + + '"size":9000573,' + + '"browser_download_url":"https://github.com/bryanthaboi/gen1recomp/releases/download/v0.1.70/gen1recomp-0.1.70-switch.zip"' + + '}' + + ']' + + '}' + ); +} + const sampleRelease = M.parseRelease( JSON.stringify({ tag_name: 'v1.5.0', @@ -197,6 +286,16 @@ test('AC-001: Launcher nativo verifica release no GitHub @spec:AC-001', () => { const missing = M.parseRelease(JSON.stringify({ tag_name: 'v1.5.0', assets: [] })); assert.equal(missing.ok, false); assert.equal(missing.reason, 'missing_ota_asset'); + + const githubRelease = M.parseRelease(buildGithubReleaseJson()); + assert.equal(githubRelease.ok, true); + assert.equal(githubRelease.version, '0.1.70'); + assert.equal(githubRelease.assetName, 'gen1recomp-0.1.70-switch.zip'); + assert.equal( + githubRelease.downloadUrl, + 'https://github.com/bryanthaboi/gen1recomp/releases/download/v0.1.70/gen1recomp-0.1.70-switch.zip' + ); + assert.equal(M.decideUpdate('0.1.69', githubRelease).status, 'available'); }); test('AC-002: Download com verificação SHA-256 @spec:AC-002', () => { From dc04a4e848b31a3ba1ffd47a9868133c11b895c1 Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 07:54:28 -0300 Subject: [PATCH 05/18] Improve Switch OTA flow with download progress and clearer error screens. --- native/switch-ota-launcher/include/ota_net.h | 7 +- native/switch-ota-launcher/include/ota_ui.h | 4 + native/switch-ota-launcher/src/main.c | 62 ++++- native/switch-ota-launcher/src/ota_net.c | 34 ++- native/switch-ota-launcher/src/ota_ui.c | 271 +++++++++++++++---- test/switch-nro-ota.spec.test.js | 13 +- 6 files changed, 321 insertions(+), 70 deletions(-) diff --git a/native/switch-ota-launcher/include/ota_net.h b/native/switch-ota-launcher/include/ota_net.h index eca59864..dcd86916 100644 --- a/native/switch-ota-launcher/include/ota_net.h +++ b/native/switch-ota-launcher/include/ota_net.h @@ -7,13 +7,16 @@ extern "C" { #endif +/* fraction is 0..1 when Content-Length is known, else -1 for indeterminate. */ +typedef void (*ota_net_progress_fn)(void *userdata, double fraction); + /* Download URL into memory buffer (caller frees *out). Returns 0 on success. */ int ota_net_download_buffer(const char *url, long timeout_ms, char **out, size_t *out_len, char *err, size_t err_len); -/* Download URL to a filesystem path. Returns 0 on success. */ +/* Download URL to a filesystem path. progress may be NULL. Returns 0 on success. */ int ota_net_download_file(const char *url, const char *path, long timeout_ms, char *err, - size_t err_len); + size_t err_len, ota_net_progress_fn progress, void *progress_ud); #ifdef __cplusplus } diff --git a/native/switch-ota-launcher/include/ota_ui.h b/native/switch-ota-launcher/include/ota_ui.h index f46723c4..0ad19e6f 100644 --- a/native/switch-ota-launcher/include/ota_ui.h +++ b/native/switch-ota-launcher/include/ota_ui.h @@ -20,6 +20,10 @@ void ota_ui_show_progress(const char *title, const char *detail, float progress0 /* Error / info + wait for B. */ void ota_ui_alert(const char *title, const char *line1, const char *line2); +/* User-friendly error with optional technical detail and installed-version footer. */ +void ota_ui_alert_error(const char *title, const char *friendly, const char *technical, + const char *installed_version); + /* Missing game install screen; wait for +. */ void ota_ui_missing_game(void); diff --git a/native/switch-ota-launcher/src/main.c b/native/switch-ota-launcher/src/main.c index 7717c9bc..70cc6248 100644 --- a/native/switch-ota-launcher/src/main.c +++ b/native/switch-ota-launcher/src/main.c @@ -32,6 +32,27 @@ #define GAME_MEMBER_IN_ZIP "switch/gen1recomp/" OTA_GAME_NRO_NAME #define LAUNCHER_MEMBER_IN_ZIP "switch/gen1recomp/" OTA_LAUNCHER_NRO_NAME +typedef struct { + const char *detail; + float base; + float span; +} download_progress_ctx_t; + +static void on_download_progress(void *userdata, double fraction) { + download_progress_ctx_t *ctx = (download_progress_ctx_t *)userdata; + if (!ctx) return; + float p = ctx->base; + if (fraction >= 0.0) p += ctx->span * (float)fraction; + else p += ctx->span * 0.1f; + if (p > ctx->base + ctx->span) p = ctx->base + ctx->span; + ota_ui_show_progress("Step 1/3: Downloading...", ctx->detail, p); +} + +static void show_update_error(const char *title, const char *friendly, const char *technical, + const char *installed) { + ota_ui_alert_error(title, friendly, technical, installed); +} + static int run_update_flow(const char *install_dir) { char installed[64] = "0.0.0"; (void)ota_fs_read_installed_version(install_dir, installed, sizeof(installed)); @@ -75,27 +96,32 @@ static int run_update_flow(const char *install_dir) { mkdir(updates_dir, 0755); #endif - ota_ui_show_progress("Downloading…", "This may take a minute.", 0.15f); - if (ota_net_download_file(dec.download_url, zip_path, 180000L, err, sizeof(err)) != 0) { - ota_ui_alert("Download failed", "Playing the installed version.", NULL); + download_progress_ctx_t dl_ctx = {"This may take a minute.", 0.f, 0.5f}; + ota_ui_show_progress("Step 1/3: Downloading...", dl_ctx.detail, dl_ctx.base); + if (ota_net_download_file(dec.download_url, zip_path, 180000L, err, sizeof(err), + on_download_progress, &dl_ctx) != 0) { + show_update_error("Download failed", + "Could not download the update. Check Wi-Fi and try again.", err, installed); return 0; } - ota_ui_show_progress("Checking update…", "Verifying file integrity.", 0.55f); + ota_ui_show_progress("Step 2/3: Verifying...", "Checking file integrity.", 0.55f); char sums_url[512]; snprintf(sums_url, sizeof(sums_url), "https://github.com/bryanthaboi/gen1recomp/releases/download/%s/sha256sums.txt", rel.tag); - if (ota_net_download_file(sums_url, sums_path, CHECK_TIMEOUT_MS, err, sizeof(err)) != 0) { + if (ota_net_download_file(sums_url, sums_path, CHECK_TIMEOUT_MS, err, sizeof(err), NULL, + NULL) != 0) { remove(zip_path); - ota_ui_alert("Could not verify", "Playing the installed version.", NULL); + show_update_error("Could not verify", "Downloaded file could not be checked.", err, installed); return 0; } FILE *sf = fopen(sums_path, "rb"); if (!sf) { remove(zip_path); - ota_ui_shutdown(); + show_update_error("Could not verify", "Could not read checksum file.", "fopen sums failed", + installed); return 0; } fseek(sf, 0, SEEK_END); @@ -104,18 +130,22 @@ static int run_update_flow(const char *install_dir) { char *sums = (char *)malloc((size_t)slen + 1); if (!sums) { fclose(sf); - ota_ui_shutdown(); + remove(zip_path); + show_update_error("Could not verify", "Not enough memory to verify update.", "malloc failed", + installed); return 0; } fread(sums, 1, (size_t)slen, sf); sums[slen] = '\0'; fclose(sf); + ota_ui_show_progress("Step 2/3: Verifying...", "Computing checksum...", 0.65f); char hex[96]; if (ota_fs_sha256_file(zip_path, hex, sizeof(hex)) != 0) { free(sums); remove(zip_path); - ota_ui_shutdown(); + show_update_error("Could not verify", "Could not read downloaded update file.", + "sha256 file read failed", installed); return 0; } ota_verify_t ver; @@ -123,7 +153,8 @@ static int run_update_flow(const char *install_dir) { free(sums); if (!ver.ok) { remove(zip_path); - ota_ui_alert("Update check failed", "Playing the installed version.", NULL); + show_update_error("Update check failed", + "Downloaded file did not match expected checksum.", ver.reason, installed); return 0; } @@ -134,11 +165,12 @@ static int run_update_flow(const char *install_dir) { install_dir); #if defined(__SWITCH__) - ota_ui_show_progress("Installing…", "Keeping your saves safe.", 0.8f); + ota_ui_show_progress("Step 3/3: Installing...", "Keeping your saves safe.", 0.8f); if (ota_unzip_extract_file(zip_path, GAME_MEMBER_IN_ZIP, extracted, err, sizeof(err)) != 0) { if (ota_unzip_extract_file(zip_path, OTA_GAME_NRO_NAME, extracted, err, sizeof(err)) != 0) { remove(zip_path); - ota_ui_alert("Install failed", "Playing the installed version.", NULL); + show_update_error("Could not extract", + "Update zip is missing game files or is corrupted.", err, installed); return 0; } } @@ -146,7 +178,9 @@ static int run_update_flow(const char *install_dir) { if (ota_fs_atomic_replace_game(install_dir, extracted, err, sizeof(err)) != 0) { remove(extracted); remove(zip_path); - ota_ui_alert("Install failed", "Playing the installed version.", NULL); + show_update_error("Could not install", + "Could not replace game on microSD. Free up space and try again.", err, + installed); return 0; } remove(extracted); @@ -168,7 +202,7 @@ static int run_update_flow(const char *install_dir) { fclose(vf); } - ota_ui_show_progress("Ready", "Starting the game…", 1.0f); + ota_ui_show_progress("Ready", "Starting the game...", 1.0f); svcSleepThread(600000000ULL); #else (void)extracted; diff --git a/native/switch-ota-launcher/src/ota_net.c b/native/switch-ota-launcher/src/ota_net.c index 1e0979e6..5ce38bb4 100644 --- a/native/switch-ota-launcher/src/ota_net.c +++ b/native/switch-ota-launcher/src/ota_net.c @@ -15,6 +15,11 @@ struct mem_buf { size_t len; }; +struct file_progress { + ota_net_progress_fn fn; + void *userdata; +}; + static size_t write_mem(char *ptr, size_t size, size_t nmemb, void *userdata) { struct mem_buf *m = (struct mem_buf *)userdata; size_t n = size * nmemb; @@ -30,6 +35,23 @@ static size_t write_mem(char *ptr, size_t size, size_t nmemb, void *userdata) { static size_t write_file(char *ptr, size_t size, size_t nmemb, void *userdata) { return fwrite(ptr, size, nmemb, (FILE *)userdata); } + +static int xfer_progress(void *clientp, curl_off_t dltotal, curl_off_t dlnow, curl_off_t ultotal, + curl_off_t ulnow) { + (void)ultotal; + (void)ulnow; + struct file_progress *fp = (struct file_progress *)clientp; + if (!fp || !fp->fn) return 0; + if (dltotal > 0) { + double frac = (double)dlnow / (double)dltotal; + if (frac < 0.0) frac = 0.0; + if (frac > 1.0) frac = 1.0; + fp->fn(fp->userdata, frac); + } else if (dlnow > 0) { + fp->fn(fp->userdata, -1.0); + } + return 0; +} #endif int ota_net_download_buffer(const char *url, long timeout_ms, char **out, size_t *out_len, @@ -54,7 +76,6 @@ int ota_net_download_buffer(const char *url, long timeout_ms, char **out, size_t curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT_MS, timeout_ms); curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_mem); curl_easy_setopt(curl, CURLOPT_WRITEDATA, &mem); - /* Atmosphere / homebrew CA store is limited; match common homebrew practice. */ curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L); curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L); CURLcode rc = curl_easy_perform(curl); @@ -76,7 +97,7 @@ int ota_net_download_buffer(const char *url, long timeout_ms, char **out, size_t } int ota_net_download_file(const char *url, const char *path, long timeout_ms, char *err, - size_t err_len) { + size_t err_len, ota_net_progress_fn progress, void *progress_ud) { if (!url || !path) { if (err && err_len) snprintf(err, err_len, "bad args"); return -1; @@ -93,6 +114,7 @@ int ota_net_download_file(const char *url, const char *path, long timeout_ms, ch if (err && err_len) snprintf(err, err_len, "curl_easy_init failed"); return -1; } + struct file_progress fp_cb = {progress, progress_ud}; curl_easy_setopt(curl, CURLOPT_URL, url); curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L); curl_easy_setopt(curl, CURLOPT_USERAGENT, "gen1recomp-switch-ota"); @@ -102,6 +124,11 @@ int ota_net_download_file(const char *url, const char *path, long timeout_ms, ch curl_easy_setopt(curl, CURLOPT_WRITEDATA, fp); curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L); curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L); + if (progress) { + curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0L); + curl_easy_setopt(curl, CURLOPT_XFERINFOFUNCTION, xfer_progress); + curl_easy_setopt(curl, CURLOPT_XFERINFODATA, &fp_cb); + } CURLcode rc = curl_easy_perform(curl); curl_easy_cleanup(curl); fclose(fp); @@ -109,9 +136,12 @@ int ota_net_download_file(const char *url, const char *path, long timeout_ms, ch if (err && err_len) snprintf(err, err_len, "%s", curl_easy_strerror(rc)); return -1; } + if (progress) progress(progress_ud, 1.0); return 0; #else (void)timeout_ms; + (void)progress; + (void)progress_ud; if (err && err_len) snprintf(err, err_len, "ota_net_download_file only available on __SWITCH__"); return -1; diff --git a/native/switch-ota-launcher/src/ota_ui.c b/native/switch-ota-launcher/src/ota_ui.c index cfe00ec9..e11262db 100644 --- a/native/switch-ota-launcher/src/ota_ui.c +++ b/native/switch-ota-launcher/src/ota_ui.c @@ -21,7 +21,13 @@ #define FB_W 1280 #define FB_H 720 -/* Theme.PAL (0–255) → RGBA8 */ +#define TITLE_Y 200 +#define LINE_TITLE 44 +#define LINE_BODY 36 +#define LINE_SMALL 28 +#define WRAP_MAX_PX 720 + +/* Theme.PAL (0-255) -> RGBA8 */ #define COL_BG RGBA8_MAXALPHA(0, 0, 0) #define COL_INK RGBA8_MAXALPHA(255, 255, 255) #define COL_DETAIL RGBA8_MAXALPHA(200, 200, 200) @@ -60,9 +66,54 @@ static void fill_rect(u32 *fb, u32 stride_px, int x, int y, int w, int h, u32 co } } +/* Normalize UTF-8 punctuation to ASCII; drop other non-ASCII bytes. */ +static size_t ota_ui_sanitize_ascii(const char *src, char *dst, size_t dst_len) { + if (!dst || dst_len == 0) return 0; + dst[0] = '\0'; + if (!src) return 0; + size_t w = 0; + for (size_t i = 0; src[i] && w + 1 < dst_len;) { + unsigned char c = (unsigned char)src[i]; + if (c < 0x80) { + dst[w++] = (char)c; + i++; + continue; + } + if (c == 0xE2 && src[i + 1] && src[i + 2]) { + unsigned char b2 = (unsigned char)src[i + 1]; + unsigned char b3 = (unsigned char)src[i + 2]; + if (b2 == 0x80 && b3 == 0xA6) { + if (w + 3 < dst_len) { + dst[w++] = '.'; + dst[w++] = '.'; + dst[w++] = '.'; + } + i += 3; + continue; + } + if (b2 == 0x80 && (b3 == 0x94 || b3 == 0x93)) { + dst[w++] = '-'; + i += 3; + continue; + } + if (b2 == 0x80 && (b3 == 0x98 || b3 == 0x99)) { + dst[w++] = '\''; + i += 3; + continue; + } + } + if ((c & 0xE0) == 0xC0) i += 2; + else if ((c & 0xF0) == 0xE0) i += 3; + else if ((c & 0xF8) == 0xF0) i += 4; + else i++; + } + dst[w] = '\0'; + return w; +} + static void draw_glyph(u32 *fb, u32 stride_px, int x, int y, char ch, u32 color, int scale) { unsigned char c = (unsigned char)ch; - if (c > 127) c = '?'; + if (c > 127) return; const char *bits = font8x8_basic[c]; for (int row = 0; row < 8; row++) { unsigned char line = (unsigned char)bits[row]; @@ -81,21 +132,100 @@ static int text_width(const char *s, int scale) { static void draw_text(u32 *fb, u32 stride_px, int x, int y, const char *s, u32 color, int scale) { if (!s) return; + char buf[512]; + ota_ui_sanitize_ascii(s, buf, sizeof(buf)); int cx = x; - for (; *s; s++) { - if (*s == '\n') { + for (const char *p = buf; *p; p++) { + if (*p == '\n') { cx = x; y += 8 * scale + 4; continue; } - draw_glyph(fb, stride_px, cx, y, *s, color, scale); + draw_glyph(fb, stride_px, cx, y, *p, color, scale); cx += 8 * scale; } } static void draw_text_centered(u32 *fb, u32 stride_px, int y, const char *s, u32 color, int scale) { - int w = text_width(s, scale); - draw_text(fb, stride_px, (FB_W - w) / 2, y, s, color, scale); + char buf[512]; + ota_ui_sanitize_ascii(s, buf, sizeof(buf)); + int w = text_width(buf, scale); + draw_text(fb, stride_px, (FB_W - w) / 2, y, buf, color, scale); +} + +static int draw_text_wrapped_centered(u32 *fb, u32 stride_px, int y, const char *s, u32 color, + int scale, int max_px) { + if (!s || !*s) return y; + char buf[512]; + ota_ui_sanitize_ascii(s, buf, sizeof(buf)); + int char_w = 8 * scale; + int max_chars = max_px / char_w; + if (max_chars < 8) max_chars = 8; + + char line[128]; + int line_len = 0; + const char *word = buf; + int lines = 0; + + while (*word) { + while (*word == ' ') word++; + if (!*word) break; + + const char *end = word; + while (*end && *end != ' ' && *end != '\n') end++; + int wlen = (int)(end - word); + + if (line_len > 0 && line_len + 1 + wlen > max_chars) { + line[line_len] = '\0'; + draw_text_centered(fb, stride_px, y, line, color, scale); + y += 8 * scale + 4; + lines++; + line_len = 0; + } + + if (wlen > max_chars) { + if (line_len > 0) { + line[line_len] = '\0'; + draw_text_centered(fb, stride_px, y, line, color, scale); + y += 8 * scale + 4; + lines++; + line_len = 0; + } + while (wlen > 0) { + int chunk = wlen > max_chars ? max_chars : wlen; + memcpy(line, word, (size_t)chunk); + line[chunk] = '\0'; + draw_text_centered(fb, stride_px, y, line, color, scale); + y += 8 * scale + 4; + lines++; + word += chunk; + wlen -= chunk; + } + word = end; + continue; + } + + if (line_len > 0) line[line_len++] = ' '; + memcpy(line + line_len, word, (size_t)wlen); + line_len += wlen; + line[line_len] = '\0'; + word = (*end == '\n') ? end + 1 : end; + if (*(end - 1) == '\n' || *end == '\n') { + draw_text_centered(fb, stride_px, y, line, color, scale); + y += 8 * scale + 4; + lines++; + line_len = 0; + if (*end == '\n') word = end + 1; + } + } + + if (line_len > 0) { + draw_text_centered(fb, stride_px, y, line, color, scale); + y += 8 * scale + 4; + lines++; + } + if (lines == 0) return y; + return y; } static void draw_rail(u32 *fb, u32 stride_px) { @@ -145,7 +275,6 @@ static void load_logo(void) { } for (int i = 0; i < w * h; i++) { unsigned char *p = data + i * 4; - /* Premultiply-ish: keep RGB, store A in high byte for skip */ g_logo[i] = RGBA8(p[0], p[1], p[2], p[3]); } g_logo_w = w; @@ -178,7 +307,6 @@ static void draw_button(u32 *fb, u32 stride_px, int x, int y, int w, int h, u32 const char *label, int focused) { fill_rect(fb, stride_px, x, y, w, h, fill); if (focused) { - /* 2px white focus ring (launcher focus outline) */ fill_rect(fb, stride_px, x - 3, y - 3, w + 6, 2, COL_INK); fill_rect(fb, stride_px, x - 3, y + h + 1, w + 6, 2, COL_INK); fill_rect(fb, stride_px, x - 3, y - 3, 2, h + 6, COL_INK); @@ -190,10 +318,17 @@ static void draw_button(u32 *fb, u32 stride_px, int x, int y, int w, int h, u32 fill_rect(fb, stride_px, x + w - 1, y, 1, h, COL_LINE); } int scale = 3; - int tw = text_width(label, scale); + char lbl[128]; + ota_ui_sanitize_ascii(label, lbl, sizeof(lbl)); + int max_tw = w - 24; + int tw = text_width(lbl, scale); + while (scale > 2 && tw > max_tw) { + scale--; + tw = text_width(lbl, scale); + } int tx = x + (w - tw) / 2; int ty = y + (h - 8 * scale) / 2; - draw_text(fb, stride_px, tx, ty, label, ink, scale); + draw_text(fb, stride_px, tx, ty, lbl, ink, scale); } static void draw_chrome(u32 *fb, u32 stride_px) { @@ -231,25 +366,25 @@ static void paint_prompt(u32 *fb, u32 stride_px, void *ctx) { prompt_ctx_t *p = (prompt_ctx_t *)ctx; draw_chrome(fb, stride_px); - int y = 180; + int y = TITLE_Y - 20; draw_text_centered(fb, stride_px, y, "Update available", COL_INK, 3); - y += 48; + y += LINE_TITLE; char line[96]; - snprintf(line, sizeof(line), "v%s -> v%s", p->installed ? p->installed : "?", + snprintf(line, sizeof(line), "v%s to v%s", p->installed ? p->installed : "?", p->latest ? p->latest : "?"); draw_text_centered(fb, stride_px, y, line, COL_YELLOW, 3); - y += 56; + y += LINE_TITLE + 8; draw_text_centered(fb, stride_px, y, "Your saves stay on this console.", COL_MUTED, 2); - y += 64; + y += LINE_BODY + 28; - int bw = 420; + int bw = 600; int bh = 64; int bx = (FB_W - bw) / 2; draw_button(fb, stride_px, bx, y, bw, bh, COL_YELLOW, COL_INVERSE, "A Update", p->focus == 0); y += bh + 24; - draw_button(fb, stride_px, bx, y, bw, bh, COL_INK, COL_INVERSE, "B Play without updating", + draw_button(fb, stride_px, bx, y, bw, bh, COL_INK, COL_INVERSE, "B Play without update", p->focus == 1); } @@ -285,31 +420,32 @@ typedef struct { int show_bar; } status_ctx_t; +static void paint_progress_bar(u32 *fb, u32 stride_px, int y, float t) { + int bw = 520; + int bh = 18; + int bx = (FB_W - bw) / 2; + if (t < 0.f) t = 0.f; + if (t > 1.f) t = 1.f; + fill_rect(fb, stride_px, bx, y, bw, bh, COL_RAISED); + fill_rect(fb, stride_px, bx, y, bw, 1, COL_LINE); + fill_rect(fb, stride_px, bx, y + bh - 1, bw, 1, COL_LINE); + fill_rect(fb, stride_px, bx, y, 1, bh, COL_LINE); + fill_rect(fb, stride_px, bx + bw - 1, y, 1, bh, COL_LINE); + int fw = (int)(bw * t); + if (fw > 0) fill_rect(fb, stride_px, bx, y, fw, bh, COL_GREEN); +} + static void paint_status(u32 *fb, u32 stride_px, void *ctx) { status_ctx_t *s = (status_ctx_t *)ctx; draw_chrome(fb, stride_px); - int y = 200; + int y = TITLE_Y; draw_text_centered(fb, stride_px, y, s->title ? s->title : "", COL_INK, 3); - y += 48; + y += LINE_TITLE; if (s->detail && s->detail[0]) { - draw_text_centered(fb, stride_px, y, s->detail, COL_DETAIL, 2); - y += 40; - } - if (s->show_bar) { - int bw = 520; - int bh = 18; - int bx = (FB_W - bw) / 2; - float t = s->progress; - if (t < 0.f) t = 0.f; - if (t > 1.f) t = 1.f; - fill_rect(fb, stride_px, bx, y, bw, bh, COL_RAISED); - fill_rect(fb, stride_px, bx, y, bw, 1, COL_LINE); - fill_rect(fb, stride_px, bx, y + bh - 1, bw, 1, COL_LINE); - fill_rect(fb, stride_px, bx, y, 1, bh, COL_LINE); - fill_rect(fb, stride_px, bx + bw - 1, y, 1, bh, COL_LINE); - int fw = (int)(bw * t); - if (fw > 0) fill_rect(fb, stride_px, bx, y, fw, bh, COL_GREEN); + y = draw_text_wrapped_centered(fb, stride_px, y, s->detail, COL_DETAIL, 2, WRAP_MAX_PX); + y += LINE_SMALL; } + if (s->show_bar) paint_progress_bar(fb, stride_px, y, s->progress); } void ota_ui_show_status(const char *title, const char *detail) { @@ -326,18 +462,24 @@ typedef struct { const char *title; const char *line1; const char *line2; + const char *line3; } alert_ctx_t; static void paint_alert(u32 *fb, u32 stride_px, void *ctx) { alert_ctx_t *a = (alert_ctx_t *)ctx; draw_chrome(fb, stride_px); - int y = 200; + int y = TITLE_Y; draw_text_centered(fb, stride_px, y, a->title ? a->title : "", COL_YELLOW, 3); - y += 52; - if (a->line1) draw_text_centered(fb, stride_px, y, a->line1, COL_DETAIL, 2); - y += 36; - if (a->line2) draw_text_centered(fb, stride_px, y, a->line2, COL_MUTED, 2); - y += 64; + y += LINE_TITLE; + if (a->line1 && a->line1[0]) + y = draw_text_wrapped_centered(fb, stride_px, y, a->line1, COL_DETAIL, 2, WRAP_MAX_PX); + y += LINE_SMALL; + if (a->line2 && a->line2[0]) + y = draw_text_wrapped_centered(fb, stride_px, y, a->line2, COL_MUTED, 2, WRAP_MAX_PX); + y += LINE_SMALL; + if (a->line3 && a->line3[0]) + y = draw_text_wrapped_centered(fb, stride_px, y, a->line3, COL_MUTED, 2, WRAP_MAX_PX); + y += LINE_BODY + 16; int bw = 360; int bh = 56; draw_button(fb, stride_px, (FB_W - bw) / 2, y, bw, bh, COL_INK, COL_INVERSE, "B Continue", 1); @@ -345,7 +487,30 @@ static void paint_alert(u32 *fb, u32 stride_px, void *ctx) { void ota_ui_alert(const char *title, const char *line1, const char *line2) { if (!ui_ensure()) return; - alert_ctx_t a = {title, line1, line2}; + alert_ctx_t a = {title, line1, line2, NULL}; + while (appletMainLoop()) { + present(paint_alert, &a); + padUpdate(&g_pad); + if (padGetButtonsDown(&g_pad) & HidNpadButton_B) break; + svcSleepThread(16000000ULL); + } + ota_ui_shutdown(); +} + +void ota_ui_alert_error(const char *title, const char *friendly, const char *technical, + const char *installed_version) { + if (!ui_ensure()) return; + char footer[96]; + snprintf(footer, sizeof(footer), "Playing installed version (v%s).", + installed_version && installed_version[0] ? installed_version : "?"); + char tech[256]; + if (technical && technical[0]) { + ota_ui_sanitize_ascii(technical, tech, sizeof(tech)); + if (strlen(tech) > 80) tech[80] = '\0'; + } else { + tech[0] = '\0'; + } + alert_ctx_t a = {title, friendly, tech[0] ? tech : NULL, footer}; while (appletMainLoop()) { present(paint_alert, &a); padUpdate(&g_pad); @@ -358,13 +523,13 @@ void ota_ui_alert(const char *title, const char *line1, const char *line2) { static void paint_missing(u32 *fb, u32 stride_px, void *ctx) { (void)ctx; draw_chrome(fb, stride_px); - int y = 190; + int y = TITLE_Y - 10; draw_text_centered(fb, stride_px, y, "Game files missing", COL_YELLOW, 3); - y += 52; - draw_text_centered(fb, stride_px, y, "Copy the Switch zip onto your microSD,", COL_DETAIL, 2); - y += 32; - draw_text_centered(fb, stride_px, y, "then open gen1recomp again.", COL_DETAIL, 2); - y += 64; + y += LINE_TITLE; + y = draw_text_wrapped_centered(fb, stride_px, y, + "Copy the Switch zip onto your microSD, then open gen1recomp again.", + COL_DETAIL, 2, WRAP_MAX_PX); + y += LINE_BODY + 16; int bw = 320; int bh = 56; draw_button(fb, stride_px, (FB_W - bw) / 2, y, bw, bh, COL_INK, COL_INVERSE, "+ Exit", 1); @@ -399,6 +564,12 @@ void ota_ui_alert(const char *title, const char *line1, const char *line2) { fprintf(stderr, "[ota_ui] alert: %s / %s / %s\n", title ? title : "", line1 ? line1 : "", line2 ? line2 : ""); } +void ota_ui_alert_error(const char *title, const char *friendly, const char *technical, + const char *installed_version) { + fprintf(stderr, "[ota_ui] error: %s / %s / %s / v%s\n", title ? title : "", + friendly ? friendly : "", technical ? technical : "", + installed_version ? installed_version : "?"); +} void ota_ui_missing_game(void) { fprintf(stderr, "[ota_ui] missing game\n"); } void ota_ui_shutdown(void) {} diff --git a/test/switch-nro-ota.spec.test.js b/test/switch-nro-ota.spec.test.js index 5103bd22..3c56cdd9 100644 --- a/test/switch-nro-ota.spec.test.js +++ b/test/switch-nro-ota.spec.test.js @@ -500,10 +500,19 @@ test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () = assert.match(main, /gen1recomp-game\.nro|OTA_GAME_NRO_NAME/); assert.match(main, /Quiet by default|stays quiet|LÖVE self-updater stays off|self-updater stays off/i); assert.match(main, /ota_ui_prompt_update|ota_ui_show_progress/); + assert.match(main, /ota_ui_alert_error/); + assert.match(main, /Step 1\/3: Downloading/); + assert.doesNotMatch(main, /\u2026/, 'OTA UI strings must be ASCII (no Unicode ellipsis)'); + assert.doesNotMatch(main, /ota_ui_alert\([^)]*Install failed/, 'generic install alert removed'); assert.doesNotMatch(main, /consoleInit/, 'no terminal console UI'); assert.ok(fs.existsSync(path.join(root, 'native/switch-ota-launcher/src/ota_ui.c'))); - assert.match(read('native/switch-ota-launcher/src/ota_ui.c'), /COL_RAIL_R|rail|FFD600|255,\s*214/); - assert.match(read('native/switch-ota-launcher/src/ota_ui.c'), /logo\.png|stb_image/); + const otaUi = read('native/switch-ota-launcher/src/ota_ui.c'); + assert.match(otaUi, /COL_RAIL_R|rail|FFD600|255,\s*214/); + assert.match(otaUi, /logo\.png|stb_image/); + assert.match(otaUi, /ota_ui_sanitize_ascii/); + assert.match(otaUi, /draw_text_wrapped_centered/); + assert.match(otaUi, /ota_ui_alert_error/); + assert.match(read('native/switch-ota-launcher/src/ota_net.c'), /XFERINFOFUNCTION|xfer_progress/); assert.match(read('native/switch-ota-launcher/Makefile'), /^ROMFS\s*:=/m); const mk = read('native/switch-ota-launcher/Makefile'); From 15fc97a9963f7a9c15000ab1c6ca58b8730345b4 Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 08:28:31 -0300 Subject: [PATCH 06/18] Unify --fused with OTA launcher and require DEVKITPRO preflight for release builds. --- docs/switch-build.md | 78 ++++++++------ docs/switch-install.md | 6 +- native/switch-ota-launcher/README.md | 10 +- scripts/build_switch.sh | 66 ++++++------ scripts/switch/build_ota_launcher.sh | 27 +++-- scripts/switch/common.sh | 127 ++++++++++++++++++++++- scripts/switch/install_devkitpro_deps.sh | 20 +++- scripts/switch/selftest_build_switch.sh | 52 ++++++++-- test/switch-nro-ota.spec.test.js | 14 ++- 9 files changed, 289 insertions(+), 111 deletions(-) diff --git a/docs/switch-build.md b/docs/switch-build.md index 2cc3d59a..0f1cd3be 100644 --- a/docs/switch-build.md +++ b/docs/switch-build.md @@ -22,19 +22,25 @@ WSL — not cmd.exe or PowerShell (AD-008). ### macOS / Linux 1. Install [devkitPro pacman](https://devkitpro.org/wiki/devkitPro_pacman). -2. Install Switch tools: +2. Install Switch tools (**required for `--fused`**): ```sh sudo dkp-pacman -S switch-dev ``` -3. Ensure `nacptool` and `elf2nro` are on `PATH` (or under - `$DEVKITPRO/tools/bin` — the fused script prepends that when set). +3. OTA launcher toolchain — **native or Docker** (either is fine): -**Optional:** Install [Docker](https://docs.docker.com/get-docker/) so fused -builds can fall back to the pinned image when native tools are missing. + ```sh + bash scripts/switch/install_devkitpro_deps.sh # native + # or install Docker (same pin as fused builds) + ``` -### Native OTA launcher (optional but required for in-console updates) +4. Ensure `DEVKITPRO` is exported (typical macOS: `/opt/devkitpro`) and + `nacptool` / `elf2nro` are on `PATH` (or under `$DEVKITPRO/tools/bin`). + +Fused game builds can also use Docker when native `nacptool`/`elf2nro` are absent. + +### Native OTA launcher (included in `--fused`) In-console OTA uses a **separate DEVKITPRO NRO** (not LÖVE). Source: `native/switch-ota-launcher/`. Host protocol tests (no toolchain): @@ -45,26 +51,14 @@ make -C native/switch-ota-launcher host-test scripts/switch/build_ota_launcher.sh # host-test first; NRO needs DEVKITPRO/Docker ``` -Extra packages beyond `switch-dev`: +`--fused` always builds the fused game, native OTA launcher, and dual-NRO SD +zip. The same `*-switch.zip` is the OTA download asset. **DEVKITPRO is +required.** OTA launcher: native packages **or** Docker — both are supported. + +Release-like build from repo root: ```sh -sudo dkp-pacman -S --noconfirm --needed switch-curl switch-mbedtls switch-zlib switch-zziplib -# or: bash scripts/switch/install_devkitpro_deps.sh -``` - -Packaging dual-NRO SD zip (launcher entry + fused game): - -```sh -scripts/switch/pack_sd_zip.sh dist/switch/game.nro VERSION out.zip dist/switch/gen1recomp-launcher.nro -``` - -One-shot OTA release build (fused game + launcher + dual-NRO SD zip; -the same `*-switch.zip` is the OTA download asset): - -```sh -# once: bash scripts/switch/install_devkitpro_deps.sh -export DEVKITPRO=/opt/devkitpro -scripts/build_switch.sh --fetch --ota --version X.Y.Z +scripts/build_switch.sh --fetch --fused --version X.Y.Z ``` See `native/switch-ota-launcher/README.md` and @@ -86,8 +80,7 @@ See `native/switch-ota-launcher/README.md` and | You install | Script does **not** install | | ----------- | --------------------------- | | bash, git, zip tooling the repo already expects | — | -| `dkp-pacman` + `switch-dev` (native fused) | `dkp-pacman -S …` | -| Docker (optional fused fallback) | Docker Engine | +| `dkp-pacman` + `switch-dev` + OTA packages **or** Docker | `dkp-pacman -S …` | | A legal `.gb` ROM (to play) | Any ROM or game data | --- @@ -100,7 +93,7 @@ See `native/switch-ota-launcher/README.md` and | ---- | ------------ | | `--fetch` | Downloads pinned **love.nro** + **love.elf** into `.bazinga/love-nx/11.5-nx1/` and verifies SHA-256 against `scripts/switch/love-nx-11.5-nx1.sha256`. | | `--loose` | Packs `game.love`, copies pinned `love.nro` → `dist/switch/loose/` as `gen1recomp.nro` + `game.love` side by side. Needs the pin. | -| `--fused` | Builds `dist/switch/gen1recomp--switch.nro` (game in romfs) via `nacptool` + `elf2nro`, then packs `dist/switch/gen1recomp--switch.zip` (SD-ready tree). Needs the pin + toolchain (native or Docker). GitHub Releases publish the **zip only**. | +| `--fused` | Builds fused game NRO, OTA launcher NRO, and dual-NRO SD zip. **Requires DEVKITPRO** + `switch-dev`. OTA launcher: native packages or Docker. GitHub Releases publish the **zip only**. | Rules: @@ -145,13 +138,15 @@ scripts/build_switch.sh --fetch # Loose pair for iteration (fetch + assemble) scripts/build_switch.sh --fetch --loose -# Single fused NRO + SD-ready zip for a release-like artifact +# Fused game + OTA launcher + dual-NRO SD zip for a release-like artifact scripts/build_switch.sh --fetch --fused --version 0.2.0 ``` Outputs land under `dist/switch/` (and `dist/switch/loose/` for loose mode). -The fused path also writes `gen1recomp--switch.nro.sha256` and -`gen1recomp--switch.zip` (+ `.sha256` sidecar for the zip). +The fused path also writes `gen1recomp--switch.nro` (game), +`gen1recomp--launcher.nro`, `gen1recomp--game.nro`, +`gen1recomp--switch.nro.sha256`, and `gen1recomp--switch.zip` +(+ `.sha256` sidecar for the zip). Offline packaging smoke (no network, no nacptool required): @@ -217,9 +212,26 @@ A Switch packaging failure fails the entire release job. The release asset is ### Runner provisioning -The self-hosted Mac runner must have **native switch-tools** (`nacptool` / -`elf2nro`) **and/or Docker** available. CI and release do not silently run -`dkp-pacman -S`; keep the runner image/host provisioned per this guide. +The self-hosted Mac runner **must** have **DEVKITPRO** installed and exported. +`--fused` preflight fails early with setup steps if it is missing. + +**One-time setup on the runner** (if not already present): + +```sh +# devkitPro pacman installer from https://devkitpro.org/wiki/devkitPro_pacman +sudo dkp-pacman -S switch-dev +export DEVKITPRO=/opt/devkitpro +export PATH="$DEVKITPRO/tools/bin:$PATH" + +# OTA launcher — pick one: +bash scripts/switch/install_devkitpro_deps.sh # native +# or ensure Docker is installed (same pin as fused builds) +``` + +CI and release still run `scripts/build_switch.sh --fetch --fused`. Preflight +requires DEVKITPRO and either native OTA packages or Docker. Without all of +that, the job fails with the setup steps above. Scripts never auto-run +`dkp-pacman -S` during CI. --- diff --git a/docs/switch-install.md b/docs/switch-install.md index 48d4cea0..00b03cae 100644 --- a/docs/switch-install.md +++ b/docs/switch-install.md @@ -30,15 +30,15 @@ Extract the zip at the **root** of the microSD so you get: ```text sdmc:/switch/gen1recomp/gen1recomp.nro # native OTA launcher (hbmenu entry) -sdmc:/switch/gen1recomp/gen1recomp-game.nro # fused LÖVE game (when OTA layout ships) +sdmc:/switch/gen1recomp/gen1recomp-game.nro # fused LÖVE game sdmc:/switch/gen1recomp/version.txt sdmc:/switch/gen1recomp/pokemon-love2d/imports/ sdmc:/switch/gen1recomp/pokemon-love2d/imports/mods/ sdmc:/switch/gen1recomp/pokemon-love2d/imports/saves/... ``` -Older single-NRO zips only had `gen1recomp.nro` (the fused game). New OTA-ready -zips use the dual-NRO layout above — open `gen1recomp` in hbmenu (the launcher). +Older single-NRO zips only had `gen1recomp.nro` (the fused game). Current +releases use the dual-NRO layout above — open `gen1recomp` in hbmenu (the launcher). Merge folders if your OS asks. Any method works: **MTP** (DBI → Run MTP responder + a client), **direct SD** (Hekate UMS or a card reader), or **FTP**. diff --git a/native/switch-ota-launcher/README.md b/native/switch-ota-launcher/README.md index f664131f..6d777508 100644 --- a/native/switch-ota-launcher/README.md +++ b/native/switch-ota-launcher/README.md @@ -45,7 +45,13 @@ make # → gen1recomp.nro ``` -Or from repo root: +Or from repo root (as part of `--fused`): + +```bash +scripts/build_switch.sh --fetch --fused --version X.Y.Z +``` + +Standalone launcher build: ```bash scripts/switch/build_ota_launcher.sh @@ -64,4 +70,4 @@ Manifest: `scripts/switch/ota_launcher.manifest`. - Zip extraction uses `switch-zziplib` (`ota_unzip.c`) on device. - OTA replaces launcher + game from the unified zip (NACP versions stay aligned). - Sphaira HOME forwarders cache metadata until reinstalled (see docs/switch-install.md). -- Install toolchain deps once: `bash scripts/switch/install_devkitpro_deps.sh` +- Release runner: `switch-dev` + (`install_devkitpro_deps.sh` **or** Docker) diff --git a/scripts/build_switch.sh b/scripts/build_switch.sh index 8fbc86b6..f9c62e05 100755 --- a/scripts/build_switch.sh +++ b/scripts/build_switch.sh @@ -5,10 +5,8 @@ # scripts/build_switch.sh --fetch # scripts/build_switch.sh --loose [path/to/game.love] # scripts/build_switch.sh --fused [--version X.Y.Z] -# scripts/build_switch.sh --ota [--version X.Y.Z] # scripts/build_switch.sh --fetch --loose # scripts/build_switch.sh --fetch --fused [--version X.Y.Z] -# scripts/build_switch.sh --fetch --ota [--version X.Y.Z] # # Modes: # --fetch Download pinned love.nro + love.elf into @@ -21,22 +19,19 @@ # (gen1recomp.nro + game.love side by side). Requires the pin # (run --fetch first, or combine --fetch --loose). # -# --fused Build a single gen1recomp--switch.nro via nacptool+elf2nro, -# then pack dist/switch/gen1recomp--switch.zip (SD-ready -# tree under switch/gen1recomp/). Uses native tools (PATH or -# $DEVKITPRO/tools/bin) first; else Docker from -# scripts/switch/dkp-docker.image (override GEN1_DKP_IMAGE). -# Requires the pin (run --fetch or combine). GitHub Releases -# publish the zip only; the versioned .nro stays local / PR CI. +# --fused Build fused gen1recomp--switch.nro (game in romfs), native +# OTA launcher NRO, and dual-NRO SD zip (gen1recomp.nro launcher + +# gen1recomp-game.nro under switch/gen1recomp/). The same +# gen1recomp--switch.zip is the OTA download asset. +# Requires DEVKITPRO + switch-dev; OTA launcher via native packages +# (install_devkitpro_deps.sh) or Docker. +# Uses native tools (PATH or $DEVKITPRO/tools/bin) first; else Docker +# from scripts/switch/dkp-docker.image (override GEN1_DKP_IMAGE). +# Requires the pin (run --fetch or combine). GitHub Releases publish +# the zip only; versioned .nro files stay local / PR CI. # -# --ota Like --fused, plus native OTA launcher NRO and dual-NRO SD zip -# (gen1recomp.nro launcher + gen1recomp-game.nro). The same -# gen1recomp--switch.zip is the OTA download asset. Needs -# DEVKITPRO switch-curl/mbedtls/zlib/zziplib — see -# scripts/switch/install_devkitpro_deps.sh. -# -# Combinable: --fetch alone, or --fetch with --loose / --fused / --ota. -# XOR: --loose, --fused, and --ota cannot be combined with each other. +# Combinable: --fetch alone, or --fetch with --loose / --fused. +# XOR: --loose and --fused cannot be combined with each other. # # Non-goals (never done by this script): # MTP push, ROM install, dkp-pacman auto-install (use install_devkitpro_deps.sh). @@ -49,7 +44,6 @@ DIST="$ROOT/dist/switch" LOOSE=0 FUSED=0 FETCH=0 -OTA=0 GAME_LOVE="" VERSION="$(git -C "$ROOT" rev-parse --short HEAD 2>/dev/null || echo dev)" @@ -58,14 +52,13 @@ say() { printf '\033[1;32m==>\033[0m %s\n' "$*" >&2; } fail() { printf '\033[1;31merror:\033[0m %s\n' "$*" >&2; exit 1; } usage() { - sed -n '2,40p' "$0" | sed 's/^# \{0,1\}//' + sed -n '2,38p' "$0" | sed 's/^# \{0,1\}//' } while [ $# -gt 0 ]; do case "$1" in --loose) LOOSE=1; shift ;; --fused) FUSED=1; shift ;; - --ota) OTA=1; shift ;; --fetch) FETCH=1; shift ;; --version) VERSION="$2"; shift 2 ;; -h|--help) @@ -83,13 +76,12 @@ while [ $# -gt 0 ]; do esac done -MODE_COUNT=$((LOOSE + FUSED + OTA)) -if [ "$MODE_COUNT" -gt 1 ]; then - fail "choose one of --loose, --fused, or --ota (XOR)" +if [ "$LOOSE" -eq 1 ] && [ "$FUSED" -eq 1 ]; then + fail "choose one of --loose or --fused (XOR)" fi -if [ "$FETCH" -eq 0 ] && [ "$LOOSE" -eq 0 ] && [ "$FUSED" -eq 0 ] && [ "$OTA" -eq 0 ]; then - fail "specify --fetch, --loose, --fused, and/or --ota (see --help)" +if [ "$FETCH" -eq 0 ] && [ "$LOOSE" -eq 0 ] && [ "$FUSED" -eq 0 ]; then + fail "specify --fetch, --loose, and/or --fused (see --help)" fi if [ "$FETCH" -eq 1 ]; then @@ -139,22 +131,22 @@ if [ "$LOOSE" -eq 1 ]; then exec "$ROOT/scripts/switch/assemble_loose.sh" "$GAME_LOVE" fi -if [ "$FUSED" -eq 1 ] || [ "$OTA" -eq 1 ]; then +if [ "$FUSED" -eq 1 ]; then + # shellcheck source=scripts/switch/common.sh + . "$ROOT/scripts/switch/common.sh" + preflight_fused_build + GAME_LOVE="$(pack_game_love)" OUT_NRO="$DIST/gen1recomp-${VERSION}-switch.nro" OUT_ZIP="$DIST/gen1recomp-${VERSION}-switch.zip" "$ROOT/scripts/switch/build_fused.sh" "$GAME_LOVE" "$VERSION" "$OUT_NRO" - if [ "$OTA" -eq 1 ]; then - LAUNCHER_NRO="$DIST/gen1recomp-${VERSION}-launcher.nro" - say "building native OTA launcher" - "$ROOT/scripts/switch/build_ota_launcher.sh" "$LAUNCHER_NRO" "$VERSION" - say "packing dual-NRO SD zip (also the OTA download asset)" - "$ROOT/scripts/switch/pack_sd_zip.sh" "$OUT_NRO" "$VERSION" "$OUT_ZIP" "$LAUNCHER_NRO" - cp "$OUT_NRO" "$DIST/gen1recomp-${VERSION}-game.nro" - else - "$ROOT/scripts/switch/pack_sd_zip.sh" "$OUT_NRO" "$VERSION" "$OUT_ZIP" - fi + LAUNCHER_NRO="$DIST/gen1recomp-${VERSION}-launcher.nro" + say "building native OTA launcher" + "$ROOT/scripts/switch/build_ota_launcher.sh" "$LAUNCHER_NRO" "$VERSION" + say "packing dual-NRO SD zip (also the OTA download asset)" + "$ROOT/scripts/switch/pack_sd_zip.sh" "$OUT_NRO" "$VERSION" "$OUT_ZIP" "$LAUNCHER_NRO" + cp "$OUT_NRO" "$DIST/gen1recomp-${VERSION}-game.nro" cp "$WORK/build-info.json" "$DIST/gen1recomp-${VERSION}-build-info.json" say "done. See $DIST/" @@ -167,4 +159,4 @@ if [ "$FETCH" -eq 1 ]; then exit 0 fi -fail "specify --fetch, --loose, --fused, and/or --ota (see --help)" +fail "specify --fetch, --loose, and/or --fused (see --help)" diff --git a/scripts/switch/build_ota_launcher.sh b/scripts/switch/build_ota_launcher.sh index c1ce80dd..c8a8facd 100755 --- a/scripts/switch/build_ota_launcher.sh +++ b/scripts/switch/build_ota_launcher.sh @@ -22,15 +22,21 @@ DKP_IMAGE_FILE="$ROOT/scripts/switch/dkp-docker.image" [ -d "$LAUNCHER_DIR" ] || fail "missing $LAUNCHER_DIR" [ -f "$LAUNCHER_DIR/Makefile" ] || fail "missing Makefile" +if ! devkitpro_ready; then + fail_missing_devkitpro +fi + say "host-test ota_protocol (no DEVKITPRO required)" make -C "$LAUNCHER_DIR" host-test mkdir -p "$(dirname "$OUT_NRO")" -if [ -n "${DEVKITPRO:-}" ] && [ -f "$DEVKITPRO/libnx/switch_rules" ]; then +if ota_launcher_deps_ready; then say "building launcher NRO with native DEVKITPRO (NACP $APP_VERSION)" make -C "$LAUNCHER_DIR" clean || true - make -C "$LAUNCHER_DIR" all APP_VERSION="$APP_VERSION" + if ! make -C "$LAUNCHER_DIR" all APP_VERSION="$APP_VERSION"; then + fail_ota_launcher_toolchain + fi cp "$LAUNCHER_DIR/gen1recomp.nro" "$OUT_NRO" say "wrote $OUT_NRO" exit 0 @@ -51,24 +57,17 @@ resolve_dkp_image() { if command -v docker >/dev/null 2>&1; then image="$(resolve_dkp_image)" say "building launcher NRO via Docker ($image, NACP $APP_VERSION)" - docker run --rm \ + if ! docker run --rm \ -v "$ROOT:/work" \ -w /work/native/switch-ota-launcher \ -e "APP_VERSION=$APP_VERSION" \ "$image" \ - bash -lc 'pacman -Sy --noconfirm switch-curl switch-mbedtls switch-zlib switch-zziplib >/dev/null 2>&1 || true; make clean; make all APP_VERSION="$APP_VERSION"' + bash -lc 'pacman -Sy --noconfirm switch-curl switch-mbedtls switch-zlib switch-zziplib >/dev/null 2>&1 || true; make clean; make all APP_VERSION="$APP_VERSION"'; then + fail_ota_launcher_toolchain + fi cp "$LAUNCHER_DIR/gen1recomp.nro" "$OUT_NRO" say "wrote $OUT_NRO" exit 0 fi -fail "$(cat </dev/null 2>&1 || return 1 + local pkg + for pkg in "${OTA_LAUNCHER_PKGS[@]}"; do + dkp-pacman -Q "$pkg" >/dev/null 2>&1 || return 1 + done +} + +# Space-separated list of missing OTA launcher packages (empty when all installed). +ota_launcher_missing_pkgs() { + command -v dkp-pacman >/dev/null 2>&1 || return 0 + local pkg missing="" + for pkg in "${OTA_LAUNCHER_PKGS[@]}"; do + if ! dkp-pacman -Q "$pkg" >/dev/null 2>&1; then + missing="${missing} ${pkg}" + fi + done + printf '%s' "$missing" +} + +devkitpro_ready() { + [ -n "${DEVKITPRO:-}" ] && [ -f "$DEVKITPRO/libnx/switch_rules" ] +} + +fail_missing_devkitpro() { + fail "$(cat <<'EOF' +--fused requires DEVKITPRO (release builds ship the OTA launcher for in-console updates). + +One-time setup on the Mac self-hosted runner (or your dev machine): + + 1. Install devkitPro pacman: https://devkitpro.org/wiki/devkitPro_pacman + 2. Install Switch tools: sudo dkp-pacman -S switch-dev + 3. Export DEVKITPRO (typical macOS): + export DEVKITPRO=/opt/devkitpro + export PATH="$DEVKITPRO/tools/bin:$PATH" + 4. OTA launcher toolchain (native or Docker — pick one): + bash scripts/switch/install_devkitpro_deps.sh + or install Docker (same pin as fused builds) + +Then re-run: scripts/build_switch.sh --fetch --fused + +See docs/switch-build.md (Runner provisioning). +EOF +)" +} + +fail_missing_ota_deps() { + local missing + missing="$(ota_launcher_missing_pkgs)" + fail "$(cat </dev/null 2>&1 && command -v elf2nro >/dev/null 2>&1; then + game_ok=1 + elif command -v docker >/dev/null 2>&1; then + game_ok=1 + fi + if [ "$game_ok" -eq 0 ]; then + fail_fused_toolchain + fi + + if ota_launcher_deps_ready; then + return 0 + fi + if command -v docker >/dev/null 2>&1; then + return 0 + fi + fail_missing_ota_deps +} + # Fused mode needs nacptool/elf2nro (native or Docker). Rich multi-OS hint. fail_fused_toolchain() { fail "$(cat <<'EOF' -fused packaging needs nacptool and elf2nro (devkitPro switch-dev). +fused packaging needs DEVKITPRO, nacptool, and elf2nro (devkitPro switch-dev). Install options: - macOS: https://devkitpro.org/wiki/devkitPro_pacman (installer / pacman) + macOS: https://devkitpro.org/wiki/devkitPro_pacman + sudo dkp-pacman -S switch-dev + OTA launcher (native or Docker): + bash scripts/switch/install_devkitpro_deps.sh + or install Docker Linux: https://devkitpro.org/wiki/devkitPro_pacman Windows: Git Bash / MSYS2 / WSL with devkitPro tools on PATH - Docker: install Docker; build_fused.sh falls back to the pinned image + Docker: install Docker; fused game and OTA launcher can build in-container + +Export DEVKITPRO (typical): export DEVKITPRO=/opt/devkitpro See docs/switch-build.md for details. EOF diff --git a/scripts/switch/install_devkitpro_deps.sh b/scripts/switch/install_devkitpro_deps.sh index 65c4bac2..64bfc2d5 100755 --- a/scripts/switch/install_devkitpro_deps.sh +++ b/scripts/switch/install_devkitpro_deps.sh @@ -4,8 +4,15 @@ # # bash scripts/switch/install_devkitpro_deps.sh # +# Optional: speeds up local native OTA launcher builds. CI/release can fall back +# to Docker when these packages are not installed. +# set -euo pipefail +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" +# shellcheck source=common.sh +. "$SCRIPT_DIR/common.sh" + if [ "$(id -u)" -ne 0 ]; then echo "==> re-running with sudo…" exec sudo -E bash "$0" "$@" @@ -25,14 +32,17 @@ if ! command -v dkp-pacman >/dev/null 2>&1; then exit 1 fi +if ! dkp-pacman -Q switch-dev >/dev/null 2>&1; then + echo "error: switch-dev is not installed (needed for nacptool/elf2nro)." >&2 + echo " sudo dkp-pacman -S switch-dev" >&2 + echo "Then re-run: bash scripts/switch/install_devkitpro_deps.sh" >&2 + exit 1 +fi + echo "==> DEVKITPRO=$DEVKITPRO" # Named packages only (avoid interactive switch-dev group member prompt). # ZIP reading uses switch-zziplib (dkp has no minizip port for Switch). -dkp-pacman -Sy --noconfirm --needed \ - switch-curl \ - switch-mbedtls \ - switch-zlib \ - switch-zziplib +dkp-pacman -Sy --noconfirm --needed "${OTA_LAUNCHER_PKGS[@]}" echo "==> installed packages:" dkp-pacman -Q | grep -E 'switch-(curl|mbedtls|zlib|zziplib|tools)|libnx|devkitA64' || true diff --git a/scripts/switch/selftest_build_switch.sh b/scripts/switch/selftest_build_switch.sh index 9bcfbc5b..b1634c0b 100755 --- a/scripts/switch/selftest_build_switch.sh +++ b/scripts/switch/selftest_build_switch.sh @@ -51,17 +51,17 @@ MISSING="" printf '%s' "$HELP_LC" | grep -q 'fetch' || MISSING="${MISSING} fetch" printf '%s' "$HELP_LC" | grep -q 'loose' || MISSING="${MISSING} loose" printf '%s' "$HELP_LC" | grep -q 'fused' || MISSING="${MISSING} fused" -printf '%s' "$HELP_LC" | grep -q 'ota' || MISSING="${MISSING} ota" +printf '%s' "$HELP_LC" | grep -Eq 'devkitpro' || MISSING="${MISSING} DEVKITPRO" printf '%s' "$HELP_LC" | grep -Eq 'auto-download|downloads' || MISSING="${MISSING} auto-download" printf '%s' "$HELP_LC" | grep -Eq 'non-goal|does not|never' || MISSING="${MISSING} non-goals" if [ -z "$MISSING" ]; then - ok "build_switch.sh --help mentions fetch, loose, fused, ota (+ auto-download/non-goals)" + ok "build_switch.sh --help mentions fetch, loose, fused, DEVKITPRO (+ auto-download/non-goals)" else bad "build_switch.sh --help missing:$MISSING" fi # --------------------------------------------------------------------------- -# 3. XOR --loose --fused / --ota exits non-zero +# 3. XOR --loose --fused exits non-zero # --------------------------------------------------------------------------- XOR_RC=0 "$ROOT/scripts/build_switch.sh" --loose --fused >/dev/null 2>&1 || XOR_RC=$? @@ -70,13 +70,6 @@ if [ "$XOR_RC" -ne 0 ]; then else bad "build_switch.sh --loose --fused should exit non-zero" fi -XOR_OTA_RC=0 -"$ROOT/scripts/build_switch.sh" --fused --ota >/dev/null 2>&1 || XOR_OTA_RC=$? -if [ "$XOR_OTA_RC" -ne 0 ]; then - ok "build_switch.sh --fused --ota exits non-zero ($XOR_OTA_RC)" -else - bad "build_switch.sh --fused --ota should exit non-zero" -fi # --------------------------------------------------------------------------- # 4. assemble_loose without pin → stderr contains --fetch @@ -188,7 +181,41 @@ else fi # --------------------------------------------------------------------------- -# 5c. fail_fused_toolchain mentions docs/switch-build.md +# 5c2. fail_missing_devkitpro cites install_devkitpro_deps.sh +# --------------------------------------------------------------------------- +MDK_ERR="$STAGING/missing-dkp.err" +MDK_RC=0 +( + . "$SCRIPT_DIR/common.sh" + fail_missing_devkitpro +) >"$STAGING/missing-dkp.out" 2>"$MDK_ERR" || MDK_RC=$? + +if [ "$MDK_RC" -ne 0 ] \ + && grep -q 'install_devkitpro_deps.sh' "$MDK_ERR" \ + && grep -q 'DEVKITPRO' "$MDK_ERR" \ + && grep -q 'switch-dev' "$MDK_ERR"; then + ok "fail_missing_devkitpro cites DEVKITPRO + switch-dev + install_devkitpro_deps.sh" +else + bad "fail_missing_devkitpro should cite setup steps (rc=$MDK_RC err=$(cat "$MDK_ERR"))" +fi + +OTA_ERR="$STAGING/missing-ota.err" +OTA_RC=0 +( + . "$SCRIPT_DIR/common.sh" + fail_missing_ota_deps +) >"$STAGING/missing-ota.out" 2>"$OTA_ERR" || OTA_RC=$? + +if [ "$OTA_RC" -ne 0 ] \ + && grep -q 'install_devkitpro_deps.sh' "$OTA_ERR" \ + && grep -qi 'docker' "$OTA_ERR"; then + ok "fail_missing_ota_deps cites native or Docker options" +else + bad "fail_missing_ota_deps should cite native + Docker (rc=$OTA_RC err=$(cat "$OTA_ERR"))" +fi + +# --------------------------------------------------------------------------- +# 5d. fail_fused_toolchain mentions docs/switch-build.md # --------------------------------------------------------------------------- FT_ERR="$STAGING/fused-toolchain.err" FT_RC=0 @@ -365,6 +392,9 @@ else fi if [ -f "$ROOT/scripts/switch/build_ota_launcher.sh" ] \ + && grep -q 'ota_launcher_deps_ready' "$ROOT/scripts/switch/build_ota_launcher.sh" \ + && grep -q 'fail_missing_devkitpro' "$ROOT/scripts/switch/build_ota_launcher.sh" \ + && grep -q 'preflight_fused_build' "$ROOT/scripts/build_switch.sh" \ && [ -f "$ROOT/native/switch-ota-launcher/Makefile" ] then ok "native OTA launcher sources + build_ota_launcher.sh present" diff --git a/test/switch-nro-ota.spec.test.js b/test/switch-nro-ota.spec.test.js index 3c56cdd9..ff1bd95f 100644 --- a/test/switch-nro-ota.spec.test.js +++ b/test/switch-nro-ota.spec.test.js @@ -529,12 +529,15 @@ test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () = assert.match(read('native/switch-ota-launcher/src/ota_fs.c'), /ota_fs_atomic_replace_nro/); assert.doesNotMatch(read('scripts/switch/install_devkitpro_deps.sh'), /switch-minizip/); assert.match(read('scripts/switch/install_devkitpro_deps.sh'), /switch-zziplib/); + assert.match(read('scripts/switch/install_devkitpro_deps.sh'), /switch-dev/); const buildDoc = read('docs/switch-build.md'); assert.match(buildDoc, /native\/switch-ota-launcher|build_ota_launcher/); - assert.match(buildDoc, /switch-curl/); - assert.match(buildDoc, /--ota|install_devkitpro_deps/); + assert.match(buildDoc, /native packages.*or.*Docker|native or Docker/i); + assert.match(buildDoc, /--fused|install_devkitpro_deps/); + assert.match(buildDoc, /Requires DEVKITPRO|DEVKITPRO is[\s\S]*required/i); assert.doesNotMatch(buildDoc, /switch-ota\.zip/); + assert.doesNotMatch(buildDoc, /--ota\b/); const readme = read('native/switch-ota-launcher/README.md'); assert.match(readme, /DEVKITPRO|devkitPro/i); @@ -555,11 +558,16 @@ test('AC-011: Empacotamento dual-NRO e selftest @spec:AC-011', () => { ); const buildSwitch = read('scripts/build_switch.sh'); - assert.match(buildSwitch, /--ota/); + assert.doesNotMatch(buildSwitch, /--ota\b/); assert.doesNotMatch(buildSwitch, /pack_ota_zip\.sh/); assert.match(buildSwitch, /build_ota_launcher\.sh/); assert.match(buildSwitch, /dual-NRO SD zip|OTA download asset/i); + const buildOtaLauncher = read('scripts/switch/build_ota_launcher.sh'); + assert.match(buildOtaLauncher, /ota_launcher_deps_ready/); + assert.match(buildOtaLauncher, /fail_missing_devkitpro/); + assert.match(buildSwitch, /preflight_fused_build/); + const selftest = read('scripts/switch/selftest_build_switch.sh'); assert.match(selftest, /dual-NRO|gen1recomp-game\.nro/); assert.match(selftest, /ota_launcher\.manifest/); From 90a53e509a22cf00b4816bc73a0ecf529b07d014 Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 08:29:03 -0300 Subject: [PATCH 07/18] Remove duplicate Switch port credits from the README footer. --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index c1d4d08e..d1a84c14 100644 --- a/README.md +++ b/README.md @@ -297,7 +297,4 @@ This project would not be possible without [pret](https://github.com/pret) > the pret band of decompiling maniacs > and their [pokered](https://github.com/pret/pokered) disassembly. -Nintendo Switch port: [andrewqsantos](https://github.com/andrewqsantos). -Switch hardware testing (V1 boot): [booshankles](https://github.com/booshankles). -

From ecfca19f116cddd7cb05a98041d10cf844d3ed26 Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 08:36:43 -0300 Subject: [PATCH 08/18] Consolidate Switch docs into three production guides. Remove internal development and hardware-evidence docs, drop issue references, and update cross-links and doc gates. --- .gitignore | 2 +- README.md | 15 +- docs/switch-build.md | 16 +- docs/switch-development.md | 536 ---------------------------- docs/switch-hardware-evidence.md | 187 ---------- docs/switch-install.md | 23 +- docs/switch-transfer.md | 9 +- docs/updater.md | 3 +- src/core/GamepadMap.lua | 2 +- test/switch-nro-ota.spec.test.js | 6 +- tests/switch_ci_workflows_test.lua | 9 +- tests/switch_transfer_docs_test.lua | 37 +- tools/switch-probe/README.md | 8 +- 13 files changed, 54 insertions(+), 799 deletions(-) delete mode 100644 docs/switch-development.md delete mode 100644 docs/switch-hardware-evidence.md diff --git a/.gitignore b/.gitignore index a79a8483..8f519c51 100644 --- a/.gitignore +++ b/.gitignore @@ -31,7 +31,7 @@ mobile/ios/love-src/ mobile/ios/cache/ mobile/ios/build/ -# love-nx vendor binaries (fetch per docs/switch-development.md; also covered by .*) +# love-nx vendor binaries (fetch per docs/switch-build.md; also covered by .*) .bazinga/love-nx/ # Final packaged build artifacts (mac/win/web/android/ios/switch) — see scripts/build.sh diff --git a/README.md b/README.md index d1a84c14..878d612e 100644 --- a/README.md +++ b/README.md @@ -231,11 +231,9 @@ Install steps, controls, and troubleshooting live in ## Nintendo Switch -Releases ship an SD-ready `gen1recomp-*-switch.zip` (issue -[#531](https://github.com/bryanthaboi/gen1recomp/issues/531)). Runtime target -is pinned [love-nx](https://github.com/retronx-team/love-nx) `11.5-nx1`. -Requires a console that can run Switch homebrew. Hardware evidence: **OLED** -(author) and **V1 / Erista** boot (community). +Releases ship an SD-ready `gen1recomp-*-switch.zip`. Runtime target is pinned +[love-nx](https://github.com/retronx-team/love-nx) `11.5-nx1`. Requires a +console that can run Switch homebrew. - Players: [docs/switch-install.md](docs/switch-install.md) — download the zip, extract at the microSD root (install or update), title-override @@ -243,12 +241,7 @@ Requires a console that can run Switch homebrew. Hardware evidence: **OLED** - Builders: [docs/switch-build.md](docs/switch-build.md) — `--fetch` / `--loose` / `--fused`, toolchain, Docker fallback, and **CI vs release** (path-gated ubuntu selftest, canonical fused PR artifact, release hard-fail). - -Limitations, Dusklight-derived method, and how we tested: -[docs/switch-development.md](docs/switch-development.md) and -[docs/switch-hardware-evidence.md](docs/switch-hardware-evidence.md). Community -help — especially HOS / love-nx packaging and broader hardware coverage — is -welcome. +- File transfer (MTP / SD / FTP): [docs/switch-transfer.md](docs/switch-transfer.md). ## Modding diff --git a/docs/switch-build.md b/docs/switch-build.md index 0f1cd3be..5367513c 100644 --- a/docs/switch-build.md +++ b/docs/switch-build.md @@ -4,13 +4,10 @@ Want to play a release build instead? Download the SD-ready zip and extract it at your microSD root — see [switch-install.md](switch-install.md). This guide is for contributors who build Gen1Recomp for Switch from source. -Hardware evidence, MTP operator loops, and deeper notes live in -[switch-development.md](switch-development.md). -> Releases ship `gen1recomp-*-switch.zip` (SD tree under `switch/gen1recomp/`; -> issue [#531](https://github.com/bryanthaboi/gen1recomp/issues/531)). Hardware -> evidence: **OLED** (author) and **V1 boot** (community). See -> [switch-development.md](switch-development.md) for known limitations. +> Releases ship `gen1recomp-*-switch.zip` (SD tree under `switch/gen1recomp/`). +> Runtime target is pinned [love-nx](https://github.com/retronx-team/love-nx) +> `11.5-nx1`. Player install and limitations: [switch-install.md](switch-install.md). --- @@ -42,7 +39,8 @@ Fused game builds can also use Docker when native `nacptool`/`elf2nro` are absen ### Native OTA launcher (included in `--fused`) -In-console OTA uses a **separate DEVKITPRO NRO** (not LÖVE). Source: +In-console OTA uses a **separate DEVKITPRO NRO** (not LÖVE). The LÖVE +self-updater (`Check.lua`) is disabled on NX. Source: `native/switch-ota-launcher/`. Host protocol tests (no toolchain): ```sh @@ -247,6 +245,4 @@ These scripts and this guide do **not**: Player install steps: [switch-install.md](switch-install.md). Manual transfer (MTP / SD / FTP, macOS / Linux / Windows): -[switch-transfer.md](switch-transfer.md). -Hardware depth and evidence: [switch-development.md](switch-development.md), -[switch-hardware-evidence.md](switch-hardware-evidence.md). +[switch-transfer.md](switch-transfer.md). diff --git a/docs/switch-development.md b/docs/switch-development.md deleted file mode 100644 index e253f5b1..00000000 --- a/docs/switch-development.md +++ /dev/null @@ -1,536 +0,0 @@ -# Nintendo Switch development (love-nx) - -> Fused NRO support for issue [#531](https://github.com/bryanthaboi/gen1recomp/issues/531). -> Releases ship `gen1recomp-*-switch.zip` (SD-ready tree). Console copy is -> extract/merge at microSD root; title override required. See -> [Known limitations](#known-limitations-read-before-reviewing). - -**Canonical install / build / transfer docs** (start here unless you need hardware depth): - -- Players → [switch-install.md](switch-install.md) -- Builders → [switch-build.md](switch-build.md) (`scripts/build_switch.sh --fetch` downloads the pinned love-nx pair) -- Transfer (MTP / SD / FTP on macOS, Linux, Windows) → [switch-transfer.md](switch-transfer.md) - -This document covers what landed, known limitations, how hardware was tested, -vendor layout, build/deploy, and the contributor transfer loop (detail lives in -the transfer runbook). - -## Acknowledgments - -- **Port / love-nx packaging:** [andrewqsantos](https://github.com/andrewqsantos) -- **Community hardware testing** (Switch V1 / Erista boot): [booshankles](https://github.com/booshankles) -- **Method guidance:** [Dusklight Switch port](https://github.com/HayatoG/dusklight/tree/main/platforms/switch) / love-nx -- **Upstream project:** [bryanthaboi](https://github.com/bryanthaboi) / Gen1Recomp - -## Status - -| Area | State | -| ---- | ----- | -| Feature | **Available** — playable fused NRO path (issue #531) | -| Runtime | Pinned love-nx **`11.5-nx1`** | -| Product artifact | Releases: SD-ready `gen1recomp-*-switch.zip`; local/PR: fused `.nro`; loose `nro`+`game.love` for iteration | -| Hardware | **OLED** validated (author, title override); **V1 / Erista** boot confirmed (community). Lite, docked soak, and Pro Controller matrices welcome | -| Deploy / install | Releases publish SD-ready zip; **extract/merge at microSD root** (MTP / SD / FTP — [switch-transfer.md](switch-transfer.md)); no `nxlink` path yet | -| Contributor transfer | Documented for **macOS, Linux, and Windows**; OpenMTP on Mac is one example, not the only contract | -| Network features on NX | LÖVE self-update / remote mod download **disabled** (`networkValidated == false`). In-console OTA is the **native OTA launcher** only (see below) | -| Community help | Welcome — especially HOS / love-nx packaging and broader hardware coverage | - -### What landed - -- Detect `NX` via `src/core/Platform.lua` without reusing Android flags -- Writable ROM inbox under `getSaveDirectory()/imports/` + per-tab “Scan again” (SHA-1 match for the open game) -- Joy-Con / gamepad mapping shared by launcher and gameplay (Nintendo A/B UX on NX) -- Launcher L/R tab switch; gameplay L/R game-speed cycle; Select+face display chords -- Focus loss / joystick reconnect recovery; opt-in `switch-debug.txt` diagnostics -- Loose assemble + fused NRO build scripts (`scripts/build_switch.sh`, `scripts/switch/*`) -- Payload gates so ROM / generated cache / saves never enter `game.love` -- Community mod zip inbox at `imports/mods/` (rescan installs; FIND MODS stays network-gated) -- Raw `.sav` inbox at `imports/saves/{red,blue,yellow}/` (**Import save** rescan) + export pull path `exports/{red,blue,yellow}/` (MTP hint; no openURL) -- Hardware evidence for Phase 0 probe, ROM import, naming A/B, save/suspend, fused NRO — see `docs/switch-hardware-evidence.md` -- Path-gated CI selftest + canonical fused PR artifact; release Switch hard-fail -- Save editor pad/touch input (virtual cursor, A click, B close) — see `tools/save-editor/README.md` -- Dynamic display size on NX only: handheld **1280×720**, docked/TV **1920×1080** (`src/core/NxDisplay.lua` + resizable conf so love-nx SDL can follow dock/undock at runtime) - -### Known gaps / welcome contributions - -- Docked vs handheld soak (≥30 min) and Lite coverage — resolution switch is implemented; long soak still welcome -- Switch Lite and fuller Pro Controller / third-party pad matrices -- Applet Mode remains unsupported by design (title override required) -- `nxlink` / netloader contrib fast-loop (deferred — see [switch-transfer.md](switch-transfer.md)) -- **Native OTA launcher:** in-console updates use a DEVKITPRO - **native OTA launcher** (libnx + switch-curl) before the LÖVE game NRO — - **not** the LÖVE self-updater (`src/update/Check.lua`). Contract: - `src/update/SwitchOta.lua`; packaging gate: - `scripts/switch/ota_launcher.manifest`. The download asset is the same - `gen1recomp-*-switch.zip` as install. UI stays quiet unless an update - needs confirm. Player-facing flow: [switch-install.md](switch-install.md) - § Updating. - -Transfer runbooks for Linux/Windows (and SD/FTP alternatives) are in -[switch-transfer.md](switch-transfer.md). Community mod zip install OLED smoke -is **pass** — see NXMOD-12 in [switch-hardware-evidence.md](switch-hardware-evidence.md). - -## Design references (Dusklight) - -This work borrowed method — not the native stack — from the [Dusklight Switch port](https://github.com/HayatoG/dusklight/tree/main/platforms/switch), especially [`LESSONS_AND_REUSE.md`](https://github.com/HayatoG/dusklight/blob/main/platforms/switch/LESSONS_AND_REUSE.md): - -| Dusklight lesson | How Gen1Recomp applied it | -| ---------------- | ------------------------- | -| Emulators hide Tegra failures | Gate milestones on **real OLED hardware**, not Ryujinx/Yuzu alone | -| Prove the lower layer first | `tools/switch-probe` before full launcher | -| Know which binary ran | Embedded `build-info.json` (commit / love-nx tag) | -| Cap continuous logs | Opt-in diagnostics, ≤1 Hz flush; Lua error log rotation | -| Crash symbolization needs the exact ELF | Keep pinned `love.elf` with the NRO under test | -| Full memory matters | Title override; Applet Mode is not the validation path | -| Do not treat SD FS like desktop POSIX | Lua stays on `love.filesystem`; inbox + MTP for user files | -| Isolate platform code | Capability module instead of Android flag overload | -| NVK / WSI / `audren` stacks | **Not** copied — love-nx already supplies video/audio/input/FS | - -The packaging goal matches Dusklight’s **single self-contained `.nro`**; contributor transfer stays multi-host (not Mac-only). - -## Known limitations (read before reviewing) - -1. **Transfer is manual and multi-method.** Runtime only needs files under the LÖVE save directory / NRO install folder. Use MTP, direct SD, or FTP per [switch-transfer.md](switch-transfer.md). macOS + OpenMTP is a documented example for OLED evidence — not “Switch requires a Mac.” -2. **Deploy is manual.** There is no automated push to the console and no `nxlink` path yet. Operators build locally, transfer files, then title-override launch. -3. **Hardware coverage.** Author P0/P1 pass rows were recorded on one Switch OLED; Switch V1 boot was confirmed independently. Treat Lite, docked soak, and other hosts as unknown until someone re-runs the checklist. -4. **No ROM/save/mod zip bytes in git.** Legal dumps and third-party mods stay on the console (or local untracked folders). -5. **AppleDouble sidecars** (`._*`) from some MTP clients can break zip/ROM/`.sav` scans — the launcher skips hidden `.*` names (including `._*.sav`); still prefer clean copies. - -## How we tested - -| Layer | What | Where | -| ----- | ---- | ----- | -| Unit / headless | Platform NX flags, RomImporter inbox, dual-path input, mod zip inbox, save `.sav` inbox, display chords, payload/self-tests | `tests/*`, `scripts/test.sh` | -| Switch CI / packaging | Path-gated offline selftest (`selftest_build_switch.sh`, `verify_payload.sh --self-test`, `switch_ci_workflows_test.lua`); canonical fused PR artifact | `.github/workflows/ci.yml`, [switch-build.md](switch-build.md) § CI and release | -| Probe on hardware | `getOS()==NX`, 1280×720, save path, Joy-Con events | `tools/switch-probe` → OLED | -| Integration on hardware | MTP inbox ROM import, Play Red/Blue, naming A/B, quit/reopen save, suspend×10, reboot, fused NRO alone + NRO-only update | `docs/switch-hardware-evidence.md` | -| Community hardware | Switch V1 / Erista boot with prebuilt NRO | [booshankles](https://github.com/booshankles) — see evidence log | -| Known gaps | Docked soak, ≥30 min long-play, Lite, automated/`nxlink` deploy | Matrix deferred / absent rows | - -Operator evidence must stay in `docs/switch-hardware-evidence.md`. **Do not invent passes** for hardware not run. - -## love-nx 11.5-nx1 (pinned) - -**Tag:** [11.5-nx1](https://github.com/retronx-team/love-nx/releases/tag/11.5-nx1) - -**Local layout (not committed):** - -```text -.bazinga/love-nx/11.5-nx1/ -├── love.nro # homebrew launcher binary (loose mode: copied to gen1recomp.nro) -└── love.elf # required for fused NRO builds (devkitPro nacptool/elf2nro) -``` - -**Manifest:** `scripts/switch/love-nx-11.5-nx1.sha256` lists expected artifact names and SHA-256 checksums. Checksums are filled when binaries are fetched (`TBD_*` placeholders until then). - -### Fetch instructions - -Preferred (automated checksum verify): - -```bash -scripts/build_switch.sh --fetch -``` - -That downloads pinned `love.nro` + `love.elf` into `.bazinga/love-nx/11.5-nx1/` -and checks them against `scripts/switch/love-nx-11.5-nx1.sha256`. See -[switch-build.md](switch-build.md) for the full mode glossary. - -Manual fallback: - -1. Open the [11.5-nx1 release](https://github.com/retronx-team/love-nx/releases/tag/11.5-nx1) and download `love.nro` and `love.elf`. -2. Create the directory: `mkdir -p .bazinga/love-nx/11.5-nx1` -3. Move both files into that directory. -4. Confirm checksums match the manifest: - - ```bash - shasum -a 256 .bazinga/love-nx/11.5-nx1/love.nro \ - .bazinga/love-nx/11.5-nx1/love.elf - ``` - -**Never commit** love-nx binaries, ROM dumps, or generated cache into git. The repo `.gitignore` excludes `.bazinga/` (vendor cache) and `/dist/` (build output). - -## Loose-mode dist layout - -Development builds place `gen1recomp.nro` and `game.love` side by side: - -```text -dist/switch/loose/ -├── gen1recomp.nro -└── game.love -``` - -Assemble with: - -```bash -scripts/build_switch.sh --loose -``` - -(See `scripts/switch/assemble_loose.sh` for the underlying copy + checksum step.) - -## Transfer & deploy (current contributor loop) - -Detail for **macOS / Linux / Windows** and **MTP / SD / FTP** lives in -[switch-transfer.md](switch-transfer.md). Summary: - -| Layer | Intent | -| ----- | ------ | -| **Runtime / players** | Extract the release zip at microSD root (`switch/gen1recomp/`) and land ROMs/mods under the save-dir inboxes. The game does not hard-depend on OpenMTP or macOS. | -| **Contributor loop** | Manual copy via MTP (DBI responder), direct SD (Hekate UMS / reader), or FTP. Fully manual — no CI deploy, no `nxlink` yet. | - -The Mac + OpenMTP steps that remain below are the **OLED evidence reproduction** path; prefer the transfer runbook for day-to-day contrib on other hosts. - -**Still avoided for routine evidence** (keeps SD handling honest): - -- Treating `nxlink` / netloader as the release deploy story (deferred) -- DBI `MicroSD install` / `NAND install` / NSP-style virtual folders for the `.love`/`.nro` pair - -If MTP fails: check cable, USB port, DBI state, and that only one MTP client holds the device — then retry or switch to SD/FTP. Do not silently rewrite evidence using an untested path and claim parity with recorded SHA-256 round-trips. - -### Manual deploy checklist (today) - -1. Build on the contributor host (`scripts/build_switch.sh --loose` or fused). -2. Close Gen1Recomp on the Switch; open DBI → `Run MTP responder`. -3. Copy artifacts with your MTP client into `1: SD Card/switch/gen1recomp/` (and ROMs/mods into the save-dir inboxes when needed). -4. Wait for the transfer queue; refresh; optionally round-trip SHA-256 on first artifacts of a type. -5. Exit MTP; launch via **title override** (hold **R** on a title → hbmenu, not Applet Mode). - -## OpenMTP + DBI transfer (loose build, Mac evidence example) - -Full multi-OS / multi-method steps: [switch-transfer.md](switch-transfer.md). -The numbered Mac loop below reproduces the OLED evidence path. - -### On the Switch - -1. Close Gen1Recomp if it is running. -2. Open **DBI** from hbmenu. -3. Select **`Run MTP responder`** (DBI documents `X` on the main screen). -4. Keep DBI on that screen for the entire transfer. -5. Connect the Switch to the Mac with a USB-C data cable. - -### On the Mac - -1. Close any other MTP clients. -2. Open **OpenMTP** and select the DBI device. -3. In the remote pane, open **`1: SD Card`**. -4. Navigate to **`switch/`** and create **`gen1recomp/`** if needed. -5. Enter **`1: SD Card/switch/gen1recomp/`**. -6. Drag from the local pane: - - ```text - dist/switch/loose/gen1recomp.nro - dist/switch/loose/game.love - ``` - -7. Wait for the OpenMTP queue to finish completely. -8. Refresh the remote listing and confirm file sizes match the local files. -9. On the Switch, exit MTP responder normally in DBI before launching the app. - -Expected layout on SD: - -```text -1: SD Card/ -└── switch/ - └── gen1recomp/ - ├── gen1recomp.nro - └── game.love -``` - -## Round-trip SHA-256 verification - -For the **first deploy** of each artifact type (loose pair, later fused NRO), verify MTP integrity: - -1. **Before send** — record local hashes: - - ```bash - shasum -a 256 dist/switch/loose/gen1recomp.nro \ - dist/switch/loose/game.love - ``` - -2. **After send** — in OpenMTP, copy the same files from `1: SD Card/switch/gen1recomp/` back to an empty local folder, e.g. `dist/switch/mtp-roundtrip/`. - -3. **Compare** round-trip hashes: - - ```bash - shasum -a 256 dist/switch/mtp-roundtrip/gen1recomp.nro \ - dist/switch/mtp-roundtrip/game.love - ``` - -4. Local pre-send and round-trip hashes **must match**. Record results in the test report template below. - -Repeat whenever a cable glitch or interrupted transfer is suspected. - -## Title override launch (full memory) - -Applet Mode is **not** the primary validation path. Use **title override** so hbmenu runs with full memory: - -1. Confirm the OpenMTP transfer queue finished. -2. Exit MTP responder in DBI; disconnect USB if desired. -3. Hold **`R`** while launching any legitimately installed title. -4. Keep holding until **hbmenu** appears. -5. Confirm hbmenu does **not** show **Applet Mode**. -6. Launch **`gen1recomp`** (or the probe NRO during Phase 0). - -Album / applet launches are only useful to document applet-specific limitations; P0/P1 gates use title override. - -## Phase 0 hardware checklist - -Complete **in order** on OLED hardware. Operator fills evidence fields — leave blank until tested. - -| Step | Action | Pass | Evidence / notes | -| ---- | ------ | ---- | ---------------- | -| P0-0a | Fetch love-nx 11.5-nx1; record manifest SHA-256 | yes | See `scripts/switch/love-nx-11.5-nx1.sha256` | -| P0-0b | Build `switch-probe.love` per `tools/switch-probe/README.md` | yes | | -| P0-0c | Assemble loose probe (`game.love` = probe) to `dist/switch/loose/` | yes | | -| P0-0d | MTP deploy to `1: SD Card/switch/gen1recomp/`; round-trip SHA-256 | yes | nro `8290ac15…5918f5`; love `9f198637…fa2e34f` | -| P0-0e | Title override → probe boots; `getOS()` shows `NX` | yes | `getOS()`=`NX`, `love._os`=`NX` | -| P0-0f | Probe lists 1280×720 (or documented dims), save path, gamepad/touch log | yes | save `sdmc:/switch/gen1recomp/switch-probe`; Joy-Con Y→#3 X→#4 | -| P0-1a | Replace `game.love` with unpatched Gen1Recomp build | yes | feat/switch-nx inbox build | -| P0-1b | MTP replace `game.love` only; round-trip SHA-256 | yes | | -| P0-1c | Title override → launcher reaches import screen | yes | | -| P0-1d | Joy-Con: can navigate launcher (no touch-only) | yes | Full report: `docs/switch-hardware-evidence.md` | - -**Operator:** Andrew **Date:** 2026-08-01 **Console:** Switch OLED only -**Deploy:** manual Mac + OpenMTP + DBI MTP (not automated) -**love-nx tag:** 11.5-nx1 **gen1recomp commit:** `df7cea4` - -## Phase 0 test report template - -Copy this block into your hardware notes or PR evidence. **Do not commit ROM files or ROM hashes of private dumps.** - -```markdown -## Switch Phase 0 — hardware report - -- Operator: -- Date: -- Console model: -- Atmosphère / HOS version: -- gen1recomp commit: -- love-nx tag: 11.5-nx1 -- love.nro SHA-256 (local): -- game.love SHA-256 (local, pre-send): -- MTP round-trip SHA-256 (gen1recomp.nro): -- MTP round-trip SHA-256 (game.love): -- Title override used: yes / no -- Applet Mode observed: yes / no (should be no for P0) -- Probe getOS(): -- Probe dimensions: -- Probe save directory shown: -- Gamepad events logged: yes / no -- Touch events logged: yes / no -- Unpatched launcher boot: pass / fail -- Joy-Con launcher navigation: pass / fail / not tested -- Notes: -``` - -## Fast dev loop (loose mode) - -While iterating on Lua/assets: - -1. Edit on Mac; run `scripts/test.sh --quick`. -2. Rebuild `.bazinga/work/game.love` (`scripts/build.sh mac --no-notarize` or project pack step). -3. Close Gen1Recomp on Switch. -4. DBI → `Run MTP responder`. -5. OpenMTP → `1: SD Card/switch/gen1recomp/`. -6. Replace **only** `game.love`; wait for queue + refresh listing. -7. Exit MTP responder; launch via title override. -8. Keep `gen1recomp.nro` unchanged until the love-nx pin changes. - -```bash -scripts/test.sh --quick -scripts/build.sh mac --no-notarize -scripts/build_switch.sh --loose -shasum -a 256 .bazinga/work/game.love -``` - -## Controller input mapping (NX) - -Measured on Switch OLED (`feat/switch-nx`, love-nx `11.5-nx1`, 1280×720). Both `joystickpressed` and `gamepadpressed` fire for Joy-Con; prefer the gamepad path when `joystick:isGamepad()` is true. - -| Path | Control | Mapping | -| ---- | ------- | ------- | -| `gamepadpressed` | D-pad / left stick | move | -| `gamepadpressed` | SDL `a` / `b` on **NX** | swapped via `NX_GAMEPAD_BINDINGS`: physical **A** (east) = GB A confirm, physical **B** (south) = GB B cancel | -| `gamepadpressed` | SDL `a` / `b` on desktop | identity (SDL south = GB A) | -| `gamepadpressed` | `start` / `back` | Start / Select (+ / −) | -| `gamepadpressed` | Right / left shoulder (no Select) | Cycle game speed up / down (same as PC hotkey `1` / speed-down path) | -| `joystickpressed` (raw) | only if **not** `isGamepad()` | face/menu fallback | -| `joystickpressed` (raw) | `#1` / `#2` on NX | Nintendo B / A → GB B / A | -| `joystickpressed` (raw) | `#9` / `#10` | Select / Start (− / +) | - -**Nintendo UX on Switch:** physical A confirms, physical B cancels (explicit NX remap of SDL face labels). - -**Launcher extras** (`RomImporter`): physical **A** clicks at the virtual cursor; **L** / **R** switch tabs; **Start** / **Select** start Play when a ROM is ready (else open Choose ROM). D-pad / left stick move the virtual cursor. - -**Dual-path rule:** love-nx emits both `gamepadpressed` and `joystickpressed` for Joy-Con. When `joystick:isGamepad()` is true, Input and RomImporter **ignore raw** face/menu so NamingScreen does not see A+B in one frame. `NamingScreen` also prefers A over B if both edges still fire. - -Implementation: `src/core/GamepadMap.lua` (`NX_RAW_*`, `ignoreRawForJoystick`, `displayChordDigit`), `src/core/Game.lua` (shoulder speed), `src/import/RomImporter.lua` (launcher tabs). Launcher and gameplay share the same converter. - -## ROM inbox (NX) - -Legal dumps land in a shared MTP inbox; **Scan again** is tab-scoped: - -| Item | Value | -| ---- | ----- | -| Save-relative path | `imports/` (also accepts loose `.gb`/`.gbc` at the save-dir root) | -| MTP destination | `1: SD Card//imports/` (see launcher notice for the live `getSaveDirectory()` path) | -| Candidates | `*.gb` / `*.gbc` (hidden `.*` AppleDouble names skipped) | -| Rescan | Game tab → **Scan again** — imports only the dump whose SHA-1 matches that tab (`GameVersion.forSha1`). Other known dumps stay for their own tabs | -| Already ready | Same SHA already imported → “No new ROM found.” | - -Players may drop Red, Blue, and Yellow into the same folder. Opening Yellow and pressing **Scan again** must not start a Red import. - -## Mod zip inbox (NX) - -Community mods install from a **separate** MTP inbox (not mixed into the ROM `imports/` scan): - -| Item | Value | -| ---- | ----- | -| Save-relative path | `imports/mods/` | -| MTP destination | `1: SD Card//imports/mods/` (see launcher notice for the live `getSaveDirectory()` path) | -| Candidates | `*.zip` only | -| Rescan | MODS tab → **Scan again** (installs each zip via `LauncherMods.installZip`; source zips are retained on success and failure) | -| FIND MODS | Remains network-gated / hidden on NX (`networkValidated == false`) | - -Do **not** commit third-party mod zip bytes into git. Drop the zip over MTP, rescan, enable in MODS, then Play. - -**MTP tip (esp. macOS clients):** OpenMTP/Finder often creates AppleDouble sidecars named `._Something.zip` / `._cart.gb` / `._foo.sav`. Those are not real archives, ROMs, or saves — the launcher ignores hidden `.*` names under `imports/`, `imports/mods/`, and `imports/saves//`. If install still fails with “could not be opened” / “not a zip file”, delete any `._*` under the inbox and confirm the real zip starts with the `PK` magic (re-copy the release asset if unsure). This is a host-side annoyance of the current manual MTP loop, not something players should need forever. - -Drop any community release `.zip` into `imports/mods/`, rescan, enable. -Player-facing install steps: [switch-install.md](switch-install.md#community-mods). -Mods own their OPTIONS / rebinds — do not duplicate third-party control tables here. - -## Save `.sav` inbox (NX) - -Raw Gen1 battery images use a **separate** MTP inbox (not mixed into ROM `imports/` or mod `imports/mods/`): - -| Item | Value | -| ---- | ----- | -| Save-relative path | `imports/saves/red/`, `imports/saves/blue/`, `imports/saves/yellow/` | -| MTP destination | `1: SD Card//imports/saves//` (see launcher notice for the live `getSaveDirectory()` path) | -| Candidates | non-hidden `*.sav` only in **that game’s** folder | -| Rescan | SAVE FILES → **Import save** on the matching game tab (scans only that folder) | -| After success | Retire to `*.sav.imported` + append content hash to `imports/saves//.imported-sha1` | -| Exports | **Export save** writes under `exports//gen1recomp--.sav`; NX shows an MTP path notice (no `openURL`) | - -Do **not** commit `.sav` bytes into git. Drop the file into the matching game folder over MTP, press **Import save** on that tab, then play. Pull exports from `exports//`. - -**MTP tip:** the same AppleDouble `._*.sav` rule applies — see the mod inbox tip above. - -## Joy-Con display chords (Select + face) - -PC digit hotkeys for COLORS / TILT / GBC FX / pipelines have Joy-Con equivalents. Hold **Select** (`back` / −) and press a face/shoulder button; the engine runs the same path as `Game:keypressed` for that digit (including `writeOptions` / Pipelines parity). - -| Chord (Nintendo UX) | Engine key | Stock engine effect | -| ------------------- | ---------- | ------------------- | -| Select + **A** | `2` | COLORS cycle | -| Select + **B** | `3` | TILT / perspective | -| Select + **Y** | `5` | GBC FX | -| Select + **X** | `6` | Mod pipeline hotkey (if registered) | -| Select + **L** (left shoulder) | `7` | Mod pipeline hotkey (if registered) | - -Keys `2` / `3` / `4` / `5` are claimed by the engine before mod pipeline hotkeys run, so a community mod cannot rebind those digits through `Pipelines.hotkey`. Mods that need their own controls should use OPTIONS rows or unclaimed hotkeys. - -Without Select held, face buttons keep normal GB A/B gameplay mapping (no accidental color/tilt cycles). The **Options** menu remains available for the same settings — chords are optional shortcuts, not the only path. - -On NX, A/B chords resolve through the Nintendo UX face remap so physical **A** → key `2` and physical **B** → key `3` match this table. - -**OPTIONS → PERFORMANCE** clamps the port’s own extras (TILT / GBC FX / survey ZOOM) and can cap FPS — useful on weaker handheld budgets. Details: [new-features.md — Performance tier](new-features.md#performance-tier-low-end-devices). - -Community mod zip install smoke (MODS inbox + Play): NXMOD-12 in [switch-hardware-evidence.md](switch-hardware-evidence.md). - -**Opt-in diagnostics:** create an empty `switch-debug.txt` in the save directory; events flush to `switch.log` at ≤1 Hz with build identity (no ROM/save bytes). - -**NX asset probe (always on Play):** every Switch Play writes `nx-asset-probe.log` in the save directory (`pokemon-love2d/`). It lists whether `assets/generated/…` vs `yellow|blue/assets/generated/…` exist, what `Assets.resolve` returns, and whether `newImage` / `newImageData` open — for Yellow/Blue blank-sprite triage. No ROM bytes. - -**Blue/Yellow cache overlay (NX):** fused love-nx cannot reliably mount `yellow|blue/assets/generated` onto the un-prefixed path, so `src/core/NxAssetOverlay.lua` wraps EVERY read-side love API that accepts a filesystem path (`filesystem.read/load/lines/newFileData/getInfo`, `graphics.newImage/newFont`, `image.newImageData`, `audio.newSource`, `sound.newSoundData`, `font.newFontData`) once at boot — only when `Platform.isNX()`. Covering the whole read surface (not just the loaders the boot needs today) keeps future states and mods inside the fallback automatically; write-side functions stay stock. Core code must NOT call love loaders on literal `assets/generated` paths (enforced by `tests/engine/nx_generated_guard_test.lua`); the chip-audio worker is a separate Lua state and gets the prefix explicitly via `audio.programPrefix` from `ChipAudio.slimAudio`. - -**Hardware re-test:** T16 **pass** @ `2699c9a` (naming A=confirm / B=cancel). T19 **pass** (quit/reopen, suspend×10, reboot) — operator 2026-08-01. - -**Suspend/resume audio:** after resume, chip music is stopped to avoid duplicate streams; confirm on hardware during P0-09/10 (T19). - -## Lua error log (save directory) - -On any uncaught Lua error, Gen1Recomp appends a redacted trace to `lua-error.log` in the LÖVE save directory (`love.filesystem.getSaveDirectory()`). The on-screen error overlay includes a hint pointing at that file. Logs rotate to `lua-error.log.1` when the active file exceeds 32 KiB. ROM/save bytes and non-printable data are stripped — never commit or share logs that might contain private paths without reviewing them first. - -## Native crash triage (love-nx / Atmosphère) - -love-nx native faults land under the console’s `crash_reports/` folder on SD (reachable via the same manual MTP workflow used for game deploys). - -1. **Collect** — DBI → `Run MTP responder`; copy `sdmc:/crash_reports/*.bin` (or the dated subfolder) to the contributor host. Prefer keeping the microSD in-console for routine pulls. -2. **Redact** — delete any attached screenshots or notes that mention ROM filenames, save paths, or private hashes before sharing logs publicly. -3. **Symbolize** — use the **pinned** `love.elf` from `.bazinga/love-nx/11.5-nx1/` that matches `build-info.json` / `scripts/switch/love-nx-11.5-nx1.sha256`. Never use a “latest” download. - - ```bash - # Example: aarch64-none-elf-addr2line from devkitPro - aarch64-none-elf-addr2line -e .bazinga/love-nx/11.5-nx1/love.elf -f -C 0xADDRESS_FROM_CRASH_REPORT - ``` - -4. **Correlate** — compare `gitCommit` / `loveNxTag` from embedded `build-info.json` with the operator’s hardware notes. - -If `addr2line` cannot resolve an address, archive the crash `.bin` with the exact `love.elf` SHA-256 used for the build — addresses are only meaningful against that ELF. - -## P0 / P1 hardware matrix (ADR §9) - -Operator evidence lives in `docs/switch-hardware-evidence.md`. **Do not invent passes** for rows that require hardware not yet run. - -| ID | Requirement | Status | Evidence | -| -- | ----------- | ------ | -------- | -| P0-0a–f | love-nx pin, probe, MTP, title override | **pass** | Phase 0 checklist above; T4 | -| P0-1a–d | Unpatched launcher boot + Joy-Con nav | **pass** | T4 / `docs/switch-hardware-evidence.md` | -| P0-02 | MTP inbox import path shown | **pass** | T12 | -| P0-03 | Rescan imports ROM | **pass** | T12 | -| P0-04 | Canonical hash routes version | **pass** | T12 | -| P0-05 | Source dump retained in inbox | **pass** | T12 | -| P0-06 | Play reaches game after import | **pass** | T12 | -| P0-07 | Joy-Con launcher navigation | **pass** | T16 @ `2699c9a` | -| P0-08 | Joy-Con gameplay (incl. naming A/B) | **pass** | T16 @ `2699c9a` | -| P0-09 | Save survives quit + reopen | **pass** | T19 | -| P0-10 | ≥10 suspend cycles, no stuck input/dup audio | **pass** | T19 (operator 2026-08-01) | -| P0-12 | Fused NRO boots without adjacent `game.love` | **pass** | T24 — `docs/switch-hardware-evidence.md` | -| P0-14 | Fused NRO MTP round-trip SHA-256 | **pass** | T24 — first artifact `b019e2e8…` @ `6fb5602` (redeploy after Blue fix) | -| P0-15 | Replace NRO only; saves persist | **pass** | T24 — operator NRO-only update keeps saves | -| P1-01 | Docked vs handheld spot-check | **deferred** | Code: `NxDisplay` 720p↔1080p; OLED dock soak not recorded yet | -| P1-02 | Applet Mode documented unsupported | **pass** | Title override required; Album path not validated | -| P1-03 | Long-play soak (≥30 min) | **deferred** | No soak session recorded | -| P1-04 | Reboot persistence | **pass** | T19 | -| P1-05 | Audio resume after suspend | **pass** | T19 (no dup audio reported) | -| — | Switch V1 / Erista boot | **pass** (boot) | Community — [booshankles](https://github.com/booshankles); see evidence log | -| — | Switch Lite / docked soak | **untested** / **deferred** | Welcome contributions | -| — | Automated / `nxlink` deploy | **absent** | Manual MTP / SD / FTP only (AD-009) | -| — | Multi-OS transfer runbooks | **pass** | [switch-transfer.md](switch-transfer.md) | -| — | Community mod zip OLED smoke (NXMOD-12) | **pass** | `docs/switch-hardware-evidence.md` | - -## Review guidance - -Maintainers may review as one PR or split later. Suggested slices (optional): - -Each slice should declare: **no ROM/save bytes committed**, **love-nx pin with manifest checksums**, **hardware-tested rows listed with linked evidence**, **Applet Mode unsupported**, **network/updater disabled on NX**, **deploy still manual** (MTP / SD / FTP; no nxlink yet), **OpenMTP is one example not the sole contract**. - -### Slice 1 — Platform + import (`platform/import`) - -- `src/core/Platform.lua`, `conf.lua` NX branch -- `src/import/RomImporter.lua` (NX flags, inbox, scan, shell/updater gates) -- Tests: `tests/engine/platform_nx_*`, `tests/engine/rom_importer_nx_*` (ROM-free T2) -- Docs: inbox/MTP import sections only - -### Slice 2 — Input + lifecycle (`input/lifecycle`) - -- `src/core/GamepadMap.lua`, `Input.lua`, `main.lua` focus/joystick hooks -- `src/debug/SwitchDiagnostics.lua` (opt-in probe + error log) -- Tests: input/diagnostics suites -- Docs: controller mapping, suspend/audio notes - -### Slice 3 — Build + docs (`build/docs`) - -- `scripts/pack_love.sh`, `scripts/build_switch.sh`, `scripts/switch/*` -- `assets/switch/icon.jpg`, `docs/switch-development.md`, hardware evidence templates -- Gates: `pack_love.sh --dry-run`, `verify_payload.sh --self-test`, fused build script (devkitPro host) - -**Pre-merge checklist:** - -- [ ] Manifest `scripts/switch/love-nx-11.5-nx1.sha256` filled; binaries not in git -- [ ] `verify_payload.sh` rejects generated cache / ROM / `.sav` / `.bak` -- [ ] P0 matrix rows marked pass only with linked hardware evidence -- [x] Fused NRO P0-12/14/15 pass with T24 evidence (`docs/switch-hardware-evidence.md`) -- [ ] Updater / remote mod download hidden on NX (`networkValidated == false`) - diff --git a/docs/switch-hardware-evidence.md b/docs/switch-hardware-evidence.md deleted file mode 100644 index 12e93c04..00000000 --- a/docs/switch-hardware-evidence.md +++ /dev/null @@ -1,187 +0,0 @@ -# Switch hardware evidence (Phase 0 + import + input) - -> **Hardware evidence log.** Author passes below were recorded on **one -> Nintendo Switch OLED** with a **manual** Mac → DBI MTP deploy loop. A -> separate community row records Switch V1 / Erista boot. These rows do -> **not** claim Lite, docked soak, or automated install. See -> `docs/switch-development.md` for status and limitations. - -**love-nx:** `11.5-nx1` -**Author console:** Switch OLED -**Deploy method (author):** manual OpenMTP + DBI `Run MTP responder` (no CI / no nxlink) -**Operator (author rows):** Andrew ([andrewqsantos](https://github.com/andrewqsantos)) -**Date (author rows):** 2026-08-01 - -Do **not** commit ROM dumps or private dump hashes. Do **not** mark a row **pass** without hardware notes for that row. - ---- - -## Community — Switch V1 / Erista boot — pass (boot) - -| Field | Value | -| ----- | ----- | -| Console | Nintendo Switch V1 (Erista) | -| Check | Prebuilt fused NRO boots under title override | -| Tester | [booshankles](https://github.com/booshankles) | -| Notes | Community confirmation only — not a full P0/P1 matrix re-run on V1 | - ---- - -## Phase 0 — probe (T4) — pass - -| Field | Value | -| ----- | ----- | -| Commit (import era) | `df7cea4` | -| `getOS()` / `love._os` | `NX` | -| Dimensions | 1280×720 | -| Save (probe) | `sdmc:/switch/gen1recomp/switch-probe` | -| Joy-Con | `joystickpressed` + `gamepadpressed` (Y→`#3`, X→`#4`) | - -| Artifact | SHA-256 | -| -------- | ------- | -| `gen1recomp.nro` | `8290ac153d4c630e48c9b26ef9123f5204ed8ee0cef3042511707b5b645918f5` | - ---- - -## T12 — Red import + Play — pass - -Inbox MTP → “Scan again” → Play; Joy-Con launcher/gameplay (not touch-only). - ---- - -# T16 — Joy-Con launcher + gameplay — pass (naming re-verify) - -### Round 1 @ `7504753` — partial - -| Check | Result | -| ----- | ------ | -| Launcher / overworld (Joy-Con only) | **pass** | -| Naming player/rival | **fail** (dual-path a+b; see below) | -| Touch required | **no** | -| `game.love` SHA-256 | `bd3a35461bf453c1f0465a5a289421aef3b5c72d3bf1f8d76e86231256829e0e` | - -### Naming failure (root cause) — fixed in `efd81d8` + `2699c9a` - -- love-nx fires **`gamepadpressed` + `joystickpressed` on the same physical press**. -- `NamingScreen` tested `wasPressed("b")` before `"a"` → if both true in one frame, always deletes. -- Dual-path fix: ignore raw when `isGamepad()` (`efd81d8`). -- SDL-only UX then had physical B confirm / A erase; NX face remap (`2699c9a`) restores Nintendo A=confirm / B=cancel. - -### Round 2 @ `2699c9a` — pass (Nintendo UX) - -| Field | Value | -| ----- | ----- | -| Commit tested | `2699c9a` | -| `game.love` SHA-256 | `a208b21e1f30b00e2e8c6fa6efe14f0e06d1db0ae1e50b810b16d9fb852926bc` | -| Touch required | **no** | - -| Check | Result | -| ----- | ------ | -| Naming — player | **pass** — physical **A** confirms letter, **B** cancels/erases | -| Naming — rival | **pass** (same) | -| Launcher / overworld (prior round) | **pass** (unchanged mapping for d-pad/stick) | - -T16 hardware gate: **closed**. - ---- - -## T19 — save / suspend — pass - -| Check | Result | -| ----- | ------ | -| Save in-game → full quit → title-override reopen → load save | **pass** (@ `7504753` / retained) | -| Suspend/resume ×10 (launcher / gameplay / mixed) | **pass** (operator 2026-08-01) | -| Full console reboot persistence | **pass** (operator 2026-08-01) | - -T19 hardware gate: **closed**. No stuck input, duplicate audio, or crash reported. - ---- - -## T24 — fused NRO alone + NRO-only update — **pass** - -| Field | Value | -| ----- | ----- | -| First fused attempt | `6fb5602` (Blue Play failed — mount) | -| Fix commits | `b1ad7c7` (logs/generated overlay), `ac6dfe7` (Blue/Yellow mount) | -| Deploy | isolated folder, no adjacent `game.love` | -| Boot fused | **pass** | -| ROM import | **pass** | -| Play **Red** | **pass** | -| Play **Blue** (after `ac6dfe7`) | **pass** (operator 2026-08-01) | -| NRO-only replace | **pass** — saves retained; app still boots/plays | -| Touch required | no | - -T24 hardware gate: **closed**. - ---- - -## SWBLD — `build_switch.sh --fetch --fused` + install path — **pass** - -Operator smoke for the switch-build-pipeline packaging CLI (closes matrix-deferred happy paths from validation). - -| Field | Value | -| ----- | ----- | -| Command | `scripts/build_switch.sh --fetch --fused --version 0.0.0-test` | -| Host | macOS + native switch-tools (or Docker fallback if used) | -| Commit / build-info | `9147a64` (`gitCommit` in build-info) | -| love-nx | `11.5-nx1` (manifest checksums match) | -| Artifact | `dist/switch/gen1recomp-0.0.0-test-switch.nro` | -| NRO SHA-256 | `210efb884a8d27443dc1c64ed8f071b0f862d8d0c9b140ad8185093c4e4027db` | -| Install doc | `docs/switch-install.md` — at the time of this row: copy NRO under `sdmc:/switch/gen1recomp/` (releases now ship an SD-ready zip; same folder) | -| Console | Switch OLED | -| Operator | Andrew | -| Date | 2026-08-01 | - -| Check | Result | -| ----- | ------ | -| `--fetch` + `--fused` produce NRO + `.sha256` | **pass** | -| Copy NRO to SD folder per install doc | **pass** (operator) | -| Title-override launch / play | treated as prior T24 path; this row records **packaging + deploy to folder** success | - -SWBLD packaging smoke: **closed** for Mac fused build + file-to-SD install step. - ---- - -## NXMOD-12 — Community mod zip OLED smoke — **pass** - -Closed from existing OLED photo evidence on issue -[#531](https://github.com/bryanthaboi/gen1recomp/issues/531) (operator comment -with launcher MODS + overworld shots). Photos live on the orphan branch -[`switch-oled-photos`](https://github.com/andrewqsantos/gen1recomp/tree/switch-oled-photos) -of the operator fork — **not** committed to this repo. Do **not** commit -third-party mod `.zip` bytes. Community mods own their OPTIONS / rebinds; -this entry only proves the MODS inbox + Play path on OLED. - -| Field | Value | -| ----- | ----- | -| Status | **pass** | -| gen1recomp commit | evidence era on `feat/switch-nx` (see #531); packaging pin love-nx `11.5-nx1` | -| love-nx tag | `11.5-nx1` | -| Console | Switch OLED | -| Mod | community release `.zip` (not vendored; not named here) | -| Zip committed to git? | **no** | -| Photo evidence | [#531 comment](https://github.com/bryanthaboi/gen1recomp/issues/531) — MODS tab + overworld | -| MODS tab photo | https://raw.githubusercontent.com/andrewqsantos/gen1recomp/switch-oled-photos/IMG_1766.jpg | -| Overworld photo | https://raw.githubusercontent.com/andrewqsantos/gen1recomp/switch-oled-photos/IMG_1771.jpg | -| Operator | Andrew | -| Date | 2026-08-01 | - -### Checklist - -| Step | Pass / fail / pending | Notes | -| ---- | --------------------- | ----- | -| MTP zip into save `imports/mods/` | **pass** | Photo evidence + prior inbox path | -| MODS → Scan again → mod listed | **pass** | IMG_1766 — community mod installed | -| Enable mod + Play Red boots without crash | **pass** | Overworld / Pallet / Oak lab photos on #531 | -| Overworld Select+A → visible colors change | **pass** | Stock COLORS chord path exercised | -| Overworld Select+B → visible tilt/perspective change | **pass** | Stock TILT chord path exercised (IMG_1771) | - -### Evidence notes - -```text -Operator: Andrew -Date: 2026-08-01 -Commit tested: feat/switch-nx era documented on issue #531 -Pass / fail summary: PASS — MODS zip install + Play on Switch OLED -Photo branch: andrewqsantos/gen1recomp@switch-oled-photos -``` diff --git a/docs/switch-install.md b/docs/switch-install.md index 00b03cae..4f4c69e4 100644 --- a/docs/switch-install.md +++ b/docs/switch-install.md @@ -6,11 +6,7 @@ Every GitHub Release that includes Switch support ships an SD-ready zip: own legal `.gb` ROM. > You need a console that can run Switch homebrew (custom firmware / hbmenu). -> This project does not help you set that up. Tracks issue -> [#531](https://github.com/bryanthaboi/gen1recomp/issues/531). -> Hardware: **OLED** validated by the porter; **V1 / Erista** boot confirmed -> by the community. Lite and other setups welcome more reports. -> See [switch-development.md](switch-development.md) for limitations. +> This project does not help you set that up. Prefer building from source? See [switch-build.md](switch-build.md). @@ -185,12 +181,23 @@ hotkeys (`2`/`3`/`5` are claimed before any mod pipeline hotkey runs). | Select + **L** | `7` | Mod pipeline hotkey (if a mod registers `7`) | If the handheld stutters with extras on, try **OPTIONS → PERFORMANCE** → -`LOW` or `BALANCED`. Full chord notes for contributors: -[switch-development.md](switch-development.md#joy-con-display-chords-select--face). +`LOW` or `BALANCED`. + +## Limitations + +- **Homebrew required** — custom firmware and hbmenu; this project does not help + set that up. +- **Title override required** — hold **R** when launching a title for full + memory. Applet Mode (Album) is not supported. +- **Manual file transfer** — ROMs, mods, and saves are copied via MTP, direct + SD, or FTP; there is no automated deploy. +- **No LÖVE self-updater** — in-console updates use the native OTA launcher + only. Remote **FIND MODS** / GitHub download stays off on Switch. +- **Hardware** — tested on Switch OLED; Switch V1 / Erista boot confirmed by the + community. Other models may work but are less tested. ## Prefer building it yourself? Building the fused NRO (and SD-ready zip) from source is covered in [switch-build.md](switch-build.md). Copying artifacts and inbox files (MTP / SD / FTP on macOS, Linux, Windows): [switch-transfer.md](switch-transfer.md). -Status, limitations, and how we tested: [switch-development.md](switch-development.md). diff --git a/docs/switch-transfer.md b/docs/switch-transfer.md index f7cd153b..3c1477af 100644 --- a/docs/switch-transfer.md +++ b/docs/switch-transfer.md @@ -6,8 +6,7 @@ Switch. **Any method is valid** if the bytes land in the destinations below. This is the home runbook for contributors on **macOS, Linux, and Windows**. Player install (what to download, title override) stays in [switch-install.md](switch-install.md). Packaging stays in -[switch-build.md](switch-build.md). Hardware evidence lives in -[switch-hardware-evidence.md](switch-hardware-evidence.md). +[switch-build.md](switch-build.md). > **Not supported yet:** `nxlink` / hbmenu netloader automation. Useful later > for a fast contrib rebuild loop; deferred on purpose (AD-009). Do not treat @@ -47,8 +46,8 @@ before launching. #### macOS (example: OpenMTP) -[OpenMTP](https://github.com/ganeshrvel/openmtp) is the loop used for OLED -hardware evidence — **one contributor example**, not a Mac-only product rule. +[OpenMTP](https://github.com/ganeshrvel/openmtp) is a documented example for +macOS — **one contributor workflow**, not a Mac-only product rule. 1. Quit other MTP clients. 2. Open OpenMTP → select the DBI device → **`1: SD Card`**. @@ -164,5 +163,3 @@ Copy the file back from the SD and compare hashes. Round-trip must match. - Players: [switch-install.md](switch-install.md) - Builders: [switch-build.md](switch-build.md) -- Status / hardware matrix: [switch-development.md](switch-development.md) -- Evidence log: [switch-hardware-evidence.md](switch-hardware-evidence.md) diff --git a/docs/updater.md b/docs/updater.md index 6a7c6625..047ffbd1 100644 --- a/docs/updater.md +++ b/docs/updater.md @@ -127,6 +127,5 @@ bundled game, in that case. - **Nintendo Switch does not use this LÖVE self-updater.** On NX, `Platform.networkValidated()` is `false`, so `Boot.run` / `Check` never download `.love` payloads. In-console OTA is the **native OTA launcher** - (DEVKITPRO) documented in [switch-install.md](switch-install.md) and - [switch-development.md](switch-development.md); protocol contract + (DEVKITPRO) documented in [switch-install.md](switch-install.md); protocol contract `src/update/SwitchOta.lua`. Manual zip install remains the fallback. diff --git a/src/core/GamepadMap.lua b/src/core/GamepadMap.lua index c76a1504..9d8b921f 100644 --- a/src/core/GamepadMap.lua +++ b/src/core/GamepadMap.lua @@ -1,5 +1,5 @@ -- Shared gamepad + raw joystick button tables for launcher and gameplay. --- Hardware-measured NX overrides live in NX_* tables (see docs/switch-development.md). +-- Hardware-measured NX overrides live in NX_* tables below. local GamepadMap = {} diff --git a/test/switch-nro-ota.spec.test.js b/test/switch-nro-ota.spec.test.js index ff1bd95f..4f216cb2 100644 --- a/test/switch-nro-ota.spec.test.js +++ b/test/switch-nro-ota.spec.test.js @@ -339,12 +339,12 @@ test('AC-004: Offline ou falha de rede não trava o jogo @spec:AC-004', () => { test('AC-005: Documentação Switch descreve o launcher OTA @spec:AC-005', () => { const install = read('docs/switch-install.md'); - const development = read('docs/switch-development.md'); + const build = read('docs/switch-build.md'); const updater = read('docs/updater.md'); for (const [name, text] of [ ['switch-install', install], - ['switch-development', development], + ['switch-build', build], ['updater', updater], ]) { assert.match(text, /native OTA launcher|launcher nativo/i, `${name} mentions native OTA launcher`); @@ -437,7 +437,7 @@ test('AC-008: Gates de regressão anti-“erro invisível” @spec:AC-008', () = const platform = read('src/core/Platform.lua'); assert.match(platform, /networkValidated\s*=\s*not nx\s+and\s+not uwp/); - for (const rel of ['docs/switch-install.md', 'docs/switch-development.md', 'docs/updater.md']) { + for (const rel of ['docs/switch-install.md', 'docs/switch-build.md', 'docs/updater.md']) { const text = read(rel); assert.match(text, /native OTA launcher|launcher nativo/i, rel); assert.match( diff --git a/tests/switch_ci_workflows_test.lua b/tests/switch_ci_workflows_test.lua index 8225cc46..d43e6ccf 100644 --- a/tests/switch_ci_workflows_test.lua +++ b/tests/switch_ci_workflows_test.lua @@ -152,7 +152,6 @@ check(comment_wf:find("comment-tag: switch-build-result", 1, true) -- --- SWCI-08 / SWCI-09: docs CI vs release --- local build_doc = read("docs/switch-build.md") -local development = read("docs/switch-development.md") local readme = read("README.md") mustContain(build_doc, "Path-gated", "switch-build.md") @@ -167,12 +166,14 @@ mustContain(build_doc, "nacptool", "switch-build.md") mustContain(build_doc, "Docker", "switch-build.md") mustContain(build_doc, "Fork → canonical", "switch-build.md") mustContain(build_doc, "skip Switch fused", "switch-build.md") - -mustContain(development, "Switch CI", "switch-development.md") -mustContain(development, "selftest_build_switch.sh", "switch-development.md") +mustContain(build_doc, "CI and release", "switch-build.md") +mustNotContain(build_doc, "switch-development", "switch-build.md") +mustNotContain(build_doc, "switch-hardware-evidence", "switch-build.md") mustContain(readme, "CI vs release", "README.md") mustContain(readme, "switch-build.md", "README.md") +mustNotContain(readme, "switch-development", "README.md") +mustNotContain(readme, "switch-hardware-evidence", "README.md") -- --- SWFIX-03: headless suite also runs the content gates --- local test_sh = read("scripts/test.sh") diff --git a/tests/switch_transfer_docs_test.lua b/tests/switch_transfer_docs_test.lua index ee80d11d..68cd600b 100644 --- a/tests/switch_transfer_docs_test.lua +++ b/tests/switch_transfer_docs_test.lua @@ -32,7 +32,7 @@ mustContain(transfer, "imports/", "transfer") mustContain(transfer, "imports/mods/", "transfer") mustContain(transfer, "1: SD Card", "transfer") mustContain(transfer, "Scan again", "transfer") -mustContain(transfer, "one contributor example", "transfer") +mustContain(transfer, "one contributor workflow", "transfer") mustContain(transfer, "Linux", "transfer") mustContain(transfer, "Windows", "transfer") mustContain(transfer, "macOS", "transfer") @@ -54,46 +54,27 @@ mustContain(transfer, "USB-C", "transfer") mustContain(transfer, "If MTP is unavailable or flaky on Linux", "transfer") mustContain(transfer, "If MTP is unavailable or flaky on Windows", "transfer") mustContain(transfer, "Joy-Con display chords (stock engine)", "transfer") -mustNotContain(transfer, "VoxelMod", "transfer") +mustNotContain(transfer, "switch-development", "transfer") +mustNotContain(transfer, "switch-hardware-evidence", "transfer") local install = read("docs/switch-install.md") local build = read("docs/switch-build.md") mustContain(install, "switch-transfer.md", "install") mustContain(install, "## Community mods", "install") mustContain(install, "Select + **A**", "install") +mustContain(install, "Select + **L**", "install") mustContain(install, "COLORS", "install") mustContain(install, "TILT", "install") mustContain(install, "GBC FX", "install") mustContain(install, "PERFORMANCE", "install") mustContain(install, "Stock engine effect", "install") +mustContain(install, "## Limitations", "install") +mustContain(install, "Title override required", "install") mustNotContain(install, "VoxelMod", "install") +mustNotContain(install, "switch-development", "install") mustContain(build, "switch-transfer.md", "build") mustContain(build, "nxlink", "build") - -local development = read("docs/switch-development.md") -mustContain(development, "switch-transfer.md", "development") -mustContain(development, "## Joy-Con display chords (Select + face)", "development") -mustContain(development, "Stock engine effect", "development") -mustContain(development, "claimed by the engine before mod pipeline", "development") -mustContain(development, "Select + **L**", "development") -mustContain(development, "OPTIONS → PERFORMANCE", "development") -mustNotContain(development, "VoxelMod", "development") -check(development:find("Non-macOS contributor MTP runbooks", 1, true) == nil, - "development must not list Non-macOS runbooks as absent") - -local evidence = read("docs/switch-hardware-evidence.md") -local nxStart = evidence:find("## NXMOD-12", 1, true) -check(nxStart ~= nil, "NXMOD-12 section present") -local nxmod = evidence:sub(nxStart) -mustContain(nxmod, "**pass**", "NXMOD-12") -mustContain(nxmod, "531", "NXMOD-12") -mustContain(nxmod, "switch-oled-photos", "NXMOD-12") -mustContain(nxmod, "IMG_1766.jpg", "NXMOD-12") -mustContain(nxmod, "IMG_1771.jpg", "NXMOD-12") -mustContain(nxmod, "Community mod zip", "NXMOD-12") -mustNotContain(nxmod, "VoxelMod", "NXMOD-12") -check(nxmod:find("Status | **pending**", 1, true) == nil - and nxmod:find("| **pending** |", 1, true) == nil, - "NXMOD-12 must not keep pending status/checklist") +mustNotContain(build, "switch-development", "build") +mustNotContain(build, "switch-hardware-evidence", "build") T.finish("switch_transfer_docs_test") diff --git a/tools/switch-probe/README.md b/tools/switch-probe/README.md index 616c1300..f0940c85 100644 --- a/tools/switch-probe/README.md +++ b/tools/switch-probe/README.md @@ -11,7 +11,9 @@ Validate Phase 0 runtime facts on real Switch hardware before running the full G - Save directory path (`love.filesystem.getSaveDirectory()`) - Gamepad / joystick / touch event logging -To date this probe has only been run on **Switch OLED** (see `docs/switch-hardware-evidence.md`); other models are untested. Deploy beside `gen1recomp.nro` remains **manual** (MTP); see `docs/switch-development.md`. +To date this probe has only been run on **Switch OLED**; other models are +untested. Deploy beside `gen1recomp.nro` remains **manual** (MTP); see +`docs/switch-transfer.md`. ## Fields shown on screen @@ -36,7 +38,9 @@ mkdir -p .bazinga/work zip -9 -j .bazinga/work/switch-probe.love tools/switch-probe/main.lua tools/switch-probe/conf.lua ``` -Deploy beside `gen1recomp.nro` (loose mode) per `docs/switch-development.md`, renaming to `game.love` only for a probe run — use a separate SD folder so probe and game builds do not mix. +Deploy beside `gen1recomp.nro` (loose mode) per `docs/switch-build.md` and +`docs/switch-transfer.md`, renaming to `game.love` only for a probe run — use a +separate SD folder so probe and game builds do not mix. ## Desktop smoke (optional) From c7e72149f12e18ad955cb2cb391fd3d5832a8fda Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 08:43:32 -0300 Subject: [PATCH 09/18] Tighten Switch docs prose and drop filler patterns. --- README.md | 9 +-- docs/switch-build.md | 34 +++++------ docs/switch-install.md | 77 +++++++++++++------------ docs/switch-transfer.md | 34 +++++------ docs/updater.md | 6 +- native/switch-ota-launcher/README.md | 18 +++--- scripts/switch/ota_launcher.manifest | 2 +- scripts/switch/selftest_build_switch.sh | 4 +- src/update/SwitchOta.lua | 2 +- test/switch-nro-ota.spec.test.js | 4 +- tests/switch_ci_workflows_test.lua | 4 +- tests/switch_transfer_docs_test.lua | 6 +- tools/switch-probe/README.md | 6 +- 13 files changed, 102 insertions(+), 104 deletions(-) diff --git a/README.md b/README.md index 878d612e..7bf9e554 100644 --- a/README.md +++ b/README.md @@ -235,12 +235,13 @@ Releases ship an SD-ready `gen1recomp-*-switch.zip`. Runtime target is pinned [love-nx](https://github.com/retronx-team/love-nx) `11.5-nx1`. Requires a console that can run Switch homebrew. -- Players: [docs/switch-install.md](docs/switch-install.md) — download the +- Players: [docs/switch-install.md](docs/switch-install.md). Download the zip, extract at the microSD root (install or update), title-override launch, import your own legal ROM, Joy-Con controls and shortcuts. -- Builders: [docs/switch-build.md](docs/switch-build.md) — `--fetch` / - `--loose` / `--fused`, toolchain, Docker fallback, and **CI vs release** - (path-gated ubuntu selftest, canonical fused PR artifact, release hard-fail). +- Builders: [docs/switch-build.md](docs/switch-build.md). `--fetch` / + `--loose` / `--fused`, toolchain, Docker fallback, and CI vs release + (path-gated ubuntu selftest, fused PR artifact on the main repo, release + hard-fail). - File transfer (MTP / SD / FTP): [docs/switch-transfer.md](docs/switch-transfer.md). ## Modding diff --git a/docs/switch-build.md b/docs/switch-build.md index 5367513c..9593524c 100644 --- a/docs/switch-build.md +++ b/docs/switch-build.md @@ -1,7 +1,7 @@ -# Build the Nintendo Switch NRO — contributor guide +# Build Gen1Recomp for Nintendo Switch Want to play a release build instead? Download the SD-ready zip and extract it -at your microSD root — see [switch-install.md](switch-install.md). +at your microSD root. See [switch-install.md](switch-install.md). This guide is for contributors who build Gen1Recomp for Switch from source. @@ -14,7 +14,7 @@ This guide is for contributors who build Gen1Recomp for Switch from source. ## Prerequisites by OS All packaging entrypoints are **bash**. On Windows, use Git Bash, MSYS2, or -WSL — not cmd.exe or PowerShell (AD-008). +WSL, not cmd.exe or PowerShell (AD-008). ### macOS / Linux @@ -25,7 +25,7 @@ WSL — not cmd.exe or PowerShell (AD-008). sudo dkp-pacman -S switch-dev ``` -3. OTA launcher toolchain — **native or Docker** (either is fine): +3. OTA launcher toolchain, **native or Docker** (either is fine): ```sh bash scripts/switch/install_devkitpro_deps.sh # native @@ -51,7 +51,7 @@ scripts/switch/build_ota_launcher.sh # host-test first; NRO needs DEVKITPRO/Do `--fused` always builds the fused game, native OTA launcher, and dual-NRO SD zip. The same `*-switch.zip` is the OTA download asset. **DEVKITPRO is -required.** OTA launcher: native packages **or** Docker — both are supported. +required.** OTA launcher: native packages **or** Docker. Both are supported. Release-like build from repo root: @@ -70,14 +70,14 @@ See `native/switch-ota-launcher/README.md` and - **WSL** (Ubuntu/etc.) with the Linux pacman flow above, or - **Git Bash** for `--fetch` / `--loose`; for `--fused` prefer MSYS2 or WSL if Docker bind-mounts from Git Bash paths misbehave. -2. Install `switch-dev` (or rely on Docker fallback — see below). +2. Install `switch-dev` (or rely on Docker fallback; see below). 3. Do **not** expect `scripts/build_switch.sh` to run under cmd/PowerShell. ### What you must install yourself | You install | Script does **not** install | | ----------- | --------------------------- | -| bash, git, zip tooling the repo already expects | — | +| bash, git, zip tooling the repo already expects | (none) | | `dkp-pacman` + `switch-dev` + OTA packages **or** Docker | `dkp-pacman -S …` | | A legal `.gb` ROM (to play) | Any ROM or game data | @@ -96,7 +96,7 @@ See `native/switch-ota-launcher/README.md` and Rules: - `--fetch` alone is fine; combine as `--fetch --loose` or `--fetch --fused`. -- `--loose` and `--fused` are **XOR** — pick one packaging path per run. +- `--loose` and `--fused` are **XOR**. Pick one packaging path per run. - `--version X.Y.Z` sets the NACP / filename version (defaults to short git SHA). ### What `--fetch` downloads @@ -172,7 +172,7 @@ the NX runtime modules `src/core/NxAssetOverlay.lua`, `src/core/Platform.lua`, `tests/engine/switch_diagnostics_test.lua`, `tests/engine/platform_nx_*`, or the Switch-related workflow YAML), CI runs: -1. **Offline selftest** on `ubuntu-latest` (forks **and** the canonical repo): +1. **Offline selftest** on `ubuntu-latest` (forks **and** the main repo): `scripts/switch/selftest_build_switch.sh`, `scripts/switch/verify_payload.sh --self-test`, `luajit tests/switch_ci_workflows_test.lua`, @@ -180,14 +180,10 @@ or the Switch-related workflow YAML), CI runs: headlessly (`luajit tests/engine/assets_version_fallback_test.lua`, `luajit tests/engine/nx_generated_guard_test.lua`, `luajit tests/engine/nx_yellow_boot_test.lua`). -2. **Fused NRO build** only on the **canonical** repository +2. **Fused NRO build** only on the **main** repository (`bryanthaboi/gen1recomp`), on the self-hosted Mac runner (`scripts/build_switch.sh --fetch --fused`), and only when the workflow - head is that repo (same-repo push/PR). **Fork repository** CI never runs - fused. **Fork → canonical PRs** also skip Switch fused (offline selftest - still runs) so untrusted head code is not executed on the self-hosted Mac; - iOS device build eligibility is unchanged. Fused also waits for a successful - offline selftest before starting on the Mac runner. + head is that repo (same-repo push/PR). Fork CI never runs fused. Fork PRs into the main repo also skip Switch fused (offline selftest still runs) so untrusted head code is not executed on the self-hosted Mac; iOS device build eligibility is unchanged. Fused also waits for a successful offline selftest before starting on the Mac runner. 3. On successful PR fused builds, a follow-up workflow posts a PR comment linking the Actions artifact named `gen1recomp-switch-nro` (comment tag `switch-build-result`; see @@ -198,7 +194,7 @@ Unrelated PRs do not burn the self-hosted Mac on Switch packaging. ### Release hard-fail (`.github/workflows/release.yml`) GitHub Releases always build Switch on the same self-hosted Mac runner as the -other platforms — this is a **hard gate** (no `continue-on-error`): +other platforms. This is a **hard gate** (no `continue-on-error`): ```sh scripts/build_switch.sh --fetch --fused --version "" @@ -221,7 +217,7 @@ sudo dkp-pacman -S switch-dev export DEVKITPRO=/opt/devkitpro export PATH="$DEVKITPRO/tools/bin:$PATH" -# OTA launcher — pick one: +# OTA launcher: pick one bash scripts/switch/install_devkitpro_deps.sh # native # or ensure Docker is installed (same pin as fused builds) ``` @@ -240,8 +236,8 @@ These scripts and this guide do **not**: - Push files to the console (no automated MTP / FTP / SD scripting) - Bundle or download any Pokémon ROM - Install `dkp-pacman` / `switch-dev` for you -- Provide `nxlink` / netloader deploy (deferred — see [switch-transfer.md](switch-transfer.md)) -- Validate **Applet Mode** — use title override (hold **R**) for full memory +- Provide `nxlink` / netloader deploy (deferred; see [switch-transfer.md](switch-transfer.md)) +- Validate **Applet Mode**. Use title override (hold **R**) for full memory Player install steps: [switch-install.md](switch-install.md). Manual transfer (MTP / SD / FTP, macOS / Linux / Windows): diff --git a/docs/switch-install.md b/docs/switch-install.md index 4f4c69e4..2a54aa06 100644 --- a/docs/switch-install.md +++ b/docs/switch-install.md @@ -2,7 +2,7 @@ Every GitHub Release that includes Switch support ships an SD-ready zip: `gen1recomp-*-switch.zip`. Extract it at the root of your microSD (install -**or** update — same steps), launch with **title override**, then import your +or update, same steps), launch with **title override**, then import your own legal `.gb` ROM. > You need a console that can run Switch homebrew (custom firmware / hbmenu). @@ -34,7 +34,8 @@ sdmc:/switch/gen1recomp/pokemon-love2d/imports/saves/... ``` Older single-NRO zips only had `gen1recomp.nro` (the fused game). Current -releases use the dual-NRO layout above — open `gen1recomp` in hbmenu (the launcher). +releases use the dual-NRO layout above. Open `gen1recomp` in hbmenu (the +launcher). Merge folders if your OS asks. Any method works: **MTP** (DBI → Run MTP responder + a client), **direct SD** (Hekate UMS or a card reader), or **FTP**. @@ -45,25 +46,25 @@ macOS, Linux, and Windows: [switch-transfer.md](switch-transfer.md). #### Native OTA launcher (in-console) -On Switch, over-the-air updates are handled by the **native OTA launcher** -(DEVKITPRO / libnx + curl), **not** by the LÖVE self-updater -(`src/update/Check.lua`). The hbmenu entry is the launcher NRO -(`gen1recomp.nro`). If a newer release exists it may download the same -`gen1recomp-*-switch.zip` used for install, verify SHA-256 from -`sha256sums.txt`, replace **both** `gen1recomp-game.nro` and -`gen1recomp.nro` (so the NACP version matches the release for hbmenu / -Sphaira), then hand off via `envSetNextLoad`. When you are already up to -date (or offline), the launcher stays quiet and opens the game with no -UI. When an update is available it shows a short screen in the same visual -language as the in-game launcher (black field, RGB rail, logo, A/B buttons). -Saves under `pokemon-love2d/` are never touched. Protocol -contract: `src/update/SwitchOta.lua`. +Switch OTA runs in a separate **native launcher NRO** (libnx + curl), not the +LÖVE self-updater (`src/update/Check.lua`). hbmenu opens `gen1recomp.nro`. + +When a newer release exists, the launcher downloads the same install zip +(`gen1recomp-*-switch.zip`), checks SHA-256 against `sha256sums.txt`, replaces +both `gen1recomp-game.nro` and `gen1recomp.nro` (keeps NACP version in sync +for hbmenu and Sphaira), then loads the game with `envSetNextLoad`. + +If you are up to date or offline, it skips straight to the game with no +prompt. If an update is available, you get a short prompt styled like the +in-game launcher: black background, RGB rail, logo, A/B buttons. Saves under +`pokemon-love2d/` are not touched. See `src/update/SwitchOta.lua` for the +wire format. The LÖVE self-updater stays **disabled** on NX (`networkValidated == false`). **Sphaira forwarder (HOME shortcut):** Sphaira copies name/version/icon into the installed forwarder at creation time. After an OTA (or zip) update, the -`.nro` on the microSD already has the new version — but the HOME shortcut +`.nro` on the microSD already has the new version, but the HOME shortcut keeps the old badge until you **reinstall the forwarder once** in Sphaira (Install Forwarder again on `gen1recomp.nro`). Browsing the NRO in Sphaira / hbmenu always shows the live file version. @@ -72,7 +73,7 @@ hbmenu always shows the live file version. Use the **same** extract/merge of `gen1recomp-*-switch.zip`. It replaces the NROs (and the small help `README.txt` / `INSTALL.txt` files). Saves, -imported ROMs, mods, and options live under `pokemon-love2d/` — **do not +imported ROMs, mods, and options live under `pokemon-love2d/`. **Do not delete that folder** when updating, or you will lose progress. ## 3. Launch with title override @@ -80,7 +81,7 @@ delete that folder** when updating, or you will lose progress. **Applet Mode is not supported** for this game (not enough memory). 1. On the Switch HOME menu, highlight any installed title. -2. Hold **R** and launch that title — this opens hbmenu with full memory +2. Hold **R** and launch that title. This opens hbmenu with full memory (title override). 3. From hbmenu, open `gen1recomp`. @@ -94,14 +95,14 @@ This project ships **no** game data. On first launch: (`.gbc`) dump into `switch/gen1recomp/pokemon-love2d/imports/` (the launcher also shows the live save-dir path). All three can sit in the same folder. -2. Use **Scan again** on that game’s tab (Red / Blue / Yellow). Rescan - matches by ROM SHA-1 for the open tab only — a Red dump never imports +2. Use **Scan again** on that game's tab (Red / Blue / Yellow). Rescan + matches by ROM SHA-1 for the open tab only. A Red dump never imports from the Yellow tab (and vice versa). ## 5. Import / Export a raw `.sav` Continue a cart or PC battery save (or pull a slot off-console) via MTP / -SD / FTP — same transfer methods as ROMs. Paths are **per game**: +SD / FTP, same transfer methods as ROMs. Paths are **per game**: | Game | Import inbox | Export folder | | ---- | ------------ | ------------- | @@ -109,19 +110,19 @@ SD / FTP — same transfer methods as ROMs. Paths are **per game**: | Blue | `imports/saves/blue/` | `exports/blue/` | | Yellow | `imports/saves/yellow/` | `exports/yellow/` | -(Under the save dir `pokemon-love2d/` — the zip already creates these folders.) +(Under the save dir `pokemon-love2d/`. The zip already creates these folders.) -1. Copy a Gen1 `.sav` (32 KB) into that game’s inbox under the save dir +1. Copy a Gen1 `.sav` (32 KB) into that game's inbox under the save dir ([switch-transfer.md](switch-transfer.md)). -2. With the game’s ROM already imported, open **that game’s tab** → +2. With the game's ROM already imported, open **that game's tab** → **SAVE FILES** → **Import save**. Only that folder is scanned. 3. A successful import retires the file to `*.sav.imported` and records its content hash so pressing **Import save** again does not clone slots. Failed imports leave the original `.sav` in place. 4. To pull a slot off the console, use **Export save**, then copy the file - from that game’s **`exports//`** folder via MTP / SD / FTP. + from that game's **`exports//`** folder via MTP / SD / FTP. -Do not put `.sav` files into git. Prefer clean copies — some MTP clients +Do not put `.sav` files into git. Prefer clean copies. Some MTP clients create `._*.sav` AppleDouble sidecars that are not real saves. ## Controls @@ -158,12 +159,12 @@ create `._*.sav` AppleDouble sidecars that are not real saves. Mods install from a zip inbox (same transfer methods as ROMs): 1. Copy a release `.zip` into the save-dir **`imports/mods/`** path the - launcher shows (MTP / SD / FTP — [switch-transfer.md](switch-transfer.md)). + launcher shows (MTP / SD / FTP. See [switch-transfer.md](switch-transfer.md)). 2. In the launcher, open **MODS** → **Scan again** → enable the mod → **Play**. Remote **FIND MODS** / GitHub download stays **off** on Switch. Do not put -mod zips into git. Community mods ship their own OPTIONS / rebinds — this port +mod zips into git. Community mods ship their own OPTIONS / rebinds. This port does not document third-party control tables. ### Joy-Con shortcuts (Select + face) @@ -185,16 +186,16 @@ If the handheld stutters with extras on, try **OPTIONS → PERFORMANCE** → ## Limitations -- **Homebrew required** — custom firmware and hbmenu; this project does not help - set that up. -- **Title override required** — hold **R** when launching a title for full - memory. Applet Mode (Album) is not supported. -- **Manual file transfer** — ROMs, mods, and saves are copied via MTP, direct - SD, or FTP; there is no automated deploy. -- **No LÖVE self-updater** — in-console updates use the native OTA launcher - only. Remote **FIND MODS** / GitHub download stays off on Switch. -- **Hardware** — tested on Switch OLED; Switch V1 / Erista boot confirmed by the - community. Other models may work but are less tested. +- You need homebrew (custom firmware, hbmenu). This project does not set that + up. +- Launch with title override (hold **R** on a title). Applet Mode (Album) is + not supported. The game needs full memory. +- ROMs, mods, and saves are copied manually via MTP, direct SD, or FTP. There + is no automated deploy. +- Updates use the native OTA launcher only. The LÖVE self-updater and remote + **FIND MODS** stay off on Switch. +- Tested on Switch OLED. Switch V1 / Erista boot confirmed by the community. + Other models may work but are less tested. ## Prefer building it yourself? diff --git a/docs/switch-transfer.md b/docs/switch-transfer.md index 3c1477af..1e53de2f 100644 --- a/docs/switch-transfer.md +++ b/docs/switch-transfer.md @@ -1,16 +1,16 @@ # Switch file transfer (MTP / SD / FTP) -Canonical ways to put Gen1Recomp artifacts and inbox files onto a Nintendo -Switch. **Any method is valid** if the bytes land in the destinations below. +Ways to put Gen1Recomp artifacts and inbox files onto a Nintendo Switch. +**Any method is valid** if the bytes land in the destinations below. -This is the home runbook for contributors on **macOS, Linux, and Windows**. +This is the runbook for contributors on **macOS, Linux, and Windows**. Player install (what to download, title override) stays in [switch-install.md](switch-install.md). Packaging stays in [switch-build.md](switch-build.md). > **Not supported yet:** `nxlink` / hbmenu netloader automation. Useful later -> for a fast contrib rebuild loop; deferred on purpose (AD-009). Do not treat -> netloader as the release or ROM/mod install path. +> for a fast contrib rebuild loop; deferred (AD-009). Do not treat netloader as +> the release or ROM/mod install path. --- @@ -22,7 +22,7 @@ Player install (what to download, title override) stays in | Loose iteration pair | `sdmc:/switch/gen1recomp/gen1recomp.nro` **and** `game.love` beside it | | ROM inbox | LÖVE save dir → `imports/` (launcher shows the live `getSaveDirectory()` path; under MTP often `1: SD Card//imports/`) | | Mod zip inbox | Same save dir → `imports/mods/` then MODS → **Scan again** | -| Save `.sav` inbox | Same save dir → `imports/saves/red\|blue\|yellow/` then that game’s SAVE FILES → **Import save** | +| Save `.sav` inbox | Same save dir → `imports/saves/red\|blue\|yellow/` then that game's SAVE FILES → **Import save** | | Save exports | Same save dir → `exports/red\|blue\|yellow/` (pull after **Export save**; MTP / SD / FTP) | | Opt-in diagnostics | Empty `switch-debug.txt` in the save dir → `switch.log` | | Lua error log | `lua-error.log` in the save dir | @@ -33,7 +33,7 @@ files, or third-party mod zips to git. --- -## Canonical methods +## Transfer methods ### 1. MTP (DBI responder + host client) @@ -47,7 +47,7 @@ before launching. #### macOS (example: OpenMTP) [OpenMTP](https://github.com/ganeshrvel/openmtp) is a documented example for -macOS — **one contributor workflow**, not a Mac-only product rule. +macOS, not a Mac-only requirement. 1. Quit other MTP clients. 2. Open OpenMTP → select the DBI device → **`1: SD Card`**. @@ -59,25 +59,25 @@ macOS — **one contributor workflow**, not a Mac-only product rule. 5. Wait for the queue; refresh; exit MTP responder; title-override launch. macOS clients often create AppleDouble sidecars (`._Something.zip`, -`._cart.gb`, `._foo.sav`). Those are not real archives or saves — the +`._cart.gb`, `._foo.sav`). Those are not real archives or saves. The launcher skips hidden `.*` names. Delete `._*` junk if a zip/ROM/`.sav` fails to open. #### Linux 1. Install desktop MTP support if needed (e.g. `gvfs-mtp` on GNOME/GTK - desktops, or your distro’s KDE MTP stack). + desktops, or your distro's KDE MTP stack). 2. With DBI MTP active, open **Files** / **Dolphin** / **Thunar** and select the Switch / DBI device → **`1: SD Card`**. 3. Extract the release zip at SD root (merge), or copy into `switch/gen1recomp/` and the save-dir inboxes as above. 4. Use **only one** MTP accessor at a time. If `mtp-tools` / `mtpfs` reports - “device is busy”, close the file manager’s MTP mount (or the CLI mount) + "device is busy", close the file manager's MTP mount (or the CLI mount) and retry with a single client. 5. Eject/unmount cleanly; exit MTP on the Switch; title-override launch. If MTP is unavailable or flaky on Linux, use **direct SD** (Hekate UMS or a -card reader) or **FTP** instead — same destinations in the table above. +card reader) or **FTP** instead. Same destinations in the table above. #### Windows @@ -92,7 +92,7 @@ card reader) or **FTP** instead — same destinations in the table above. 5. Safely disconnect; exit MTP on the Switch; title-override launch. If MTP is unavailable or flaky on Windows, use **direct SD** (Hekate UMS or a -card reader) or **FTP** instead — same destinations in the table above. +card reader) or **FTP** instead. Same destinations in the table above. ### 2. Direct SD (Hekate UMS or card reader) @@ -108,9 +108,9 @@ Do not yank the card or unplug UMS mid-write. ### 3. FTP (any SD-exposing Switch FTP) -Any homebrew FTP server that can write the microSD is fine — for example -**DBI’s own FTP**, **sys-ftpd-light**, or **Sphaira** (names are illustrations -only; pick what your CFW setup already uses). +Any homebrew FTP server that can write the microSD is fine. For example +**DBI's own FTP**, **sys-ftpd-light**, or **Sphaira**. Names are illustrations +only; pick what your CFW setup already uses. 1. Start the FTP server on the Switch; note IP/port/credentials from that app. 2. From the host, connect with any FTP client and upload to the same @@ -153,7 +153,7 @@ Copy the file back from the SD and compare hashes. Round-trip must match. | Symptom | What to try | | ------- | ----------- | | Device busy / no MTP volume | One client only; different cable/port; Windows MTP USB Device driver; alternate method (SD or FTP) | -| Zip/ROM/`.sav` “could not be opened” | Delete `._*` sidecars (including `._*.sav`); confirm real zip starts with `PK` | +| Zip/ROM/`.sav` "could not be opened" | Delete `._*` sidecars (including `._*.sav`); confirm real zip starts with `PK` | | Half-copied NRO / crash on boot | Re-copy; verify SHA-256; exit transfer mode before launch | | App opens in Applet Mode | Use title override (hold **R**), not Album | diff --git a/docs/updater.md b/docs/updater.md index 047ffbd1..c27615a3 100644 --- a/docs/updater.md +++ b/docs/updater.md @@ -126,6 +126,6 @@ bundled game, in that case. checkout is always "the game" itself; updating it means pulling the repo. - **Nintendo Switch does not use this LÖVE self-updater.** On NX, `Platform.networkValidated()` is `false`, so `Boot.run` / `Check` never - download `.love` payloads. In-console OTA is the **native OTA launcher** - (DEVKITPRO) documented in [switch-install.md](switch-install.md); protocol contract - `src/update/SwitchOta.lua`. Manual zip install remains the fallback. + download `.love` payloads. In-console OTA uses the **native OTA launcher** + (DEVKITPRO), documented in [switch-install.md](switch-install.md). Wire + format: `src/update/SwitchOta.lua`. Manual zip install remains the fallback. diff --git a/native/switch-ota-launcher/README.md b/native/switch-ota-launcher/README.md index 6d777508..ffa02cbc 100644 --- a/native/switch-ota-launcher/README.md +++ b/native/switch-ota-launcher/README.md @@ -6,20 +6,20 @@ are already up to date or offline). Only if a newer release exists does it show a **launcher-style screen** (black + RGB rail + project logo + flat A/B buttons), download the same `gen1recomp-*-switch.zip` used for install, verify SHA-256 from `sha256sums.txt`, replace **both** `gen1recomp-game.nro` and -`gen1recomp.nro` (matching NACP version for hbmenu/Sphaira), then hand off +`gen1recomp.nro` (matching NACP version for hbmenu/Sphaira), then load the game with `envSetNextLoad`. The LÖVE self-updater (`src/update/Check.lua`) stays **disabled** on NX. -Protocol contract (also in Lua): `src/update/SwitchOta.lua`. +Wire format (also in Lua): `src/update/SwitchOta.lua`. NACP icon: `assets/switch/icon.jpg`. ## Layout on microSD ```text -sdmc:/switch/gen1recomp/gen1recomp.nro ← this launcher -sdmc:/switch/gen1recomp/gen1recomp-game.nro ← fused LÖVE game -sdmc:/switch/gen1recomp/version.txt ← installed X.Y.Z -sdmc:/switch/gen1recomp/pokemon-love2d/ ← saves (never touched by OTA) +sdmc:/switch/gen1recomp/gen1recomp.nro <- this launcher +sdmc:/switch/gen1recomp/gen1recomp-game.nro <- fused LÖVE game +sdmc:/switch/gen1recomp/version.txt <- installed X.Y.Z +sdmc:/switch/gen1recomp/pokemon-love2d/ <- saves (never touched by OTA) ``` ## Host tests (no DEVKITPRO) @@ -42,7 +42,7 @@ Needs `DEVKITPRO` with packages roughly: export DEVKITPRO=/opt/devkitpro # typical cd native/switch-ota-launcher make -# → gen1recomp.nro +# -> gen1recomp.nro ``` Or from repo root (as part of `--fused`): @@ -62,12 +62,12 @@ Docker fallback uses the same pin as fused builds (`scripts/switch/dkp-docker.im ## Packaging `scripts/switch/pack_sd_zip.sh GAME_NRO VERSION OUT_ZIP LAUNCHER_NRO` writes both -NROs into the SD zip. That zip is also the OTA download asset (unified). +NROs into the SD zip. That zip is also what OTA downloads. Manifest: `scripts/switch/ota_launcher.manifest`. ## Status / known gaps - Zip extraction uses `switch-zziplib` (`ota_unzip.c`) on device. -- OTA replaces launcher + game from the unified zip (NACP versions stay aligned). +- OTA replaces launcher + game from the install zip (NACP versions stay aligned). - Sphaira HOME forwarders cache metadata until reinstalled (see docs/switch-install.md). - Release runner: `switch-dev` + (`install_devkitpro_deps.sh` **or** Docker) diff --git a/scripts/switch/ota_launcher.manifest b/scripts/switch/ota_launcher.manifest index cf84a6d4..79409299 100644 --- a/scripts/switch/ota_launcher.manifest +++ b/scripts/switch/ota_launcher.manifest @@ -4,7 +4,7 @@ # entrypoint. The LÖVE fused game NRO is loaded via envSetNextLoad after the # update check. Self-update of the launcher itself is out of scope for v1. # -# OTA download uses the same SD zip as install (unified asset). +# OTA downloads the install zip. # # Paths relative to microSD root: diff --git a/scripts/switch/selftest_build_switch.sh b/scripts/switch/selftest_build_switch.sh index b1634c0b..7a796d09 100755 --- a/scripts/switch/selftest_build_switch.sh +++ b/scripts/switch/selftest_build_switch.sh @@ -410,7 +410,7 @@ if [ ! -f "$LEGACY_OTA_PACKER" ] \ && ! grep -Eq 'pack_ota_zip\.sh|switch-ota\.zip' "$ROOT/scripts/build_switch.sh" \ && grep -q 'OTA_ASSET_GLOB=gen1recomp-\*-switch.zip' "$MANIFEST" then - ok "unified OTA download is the same SD zip (legacy OTA-only packer gone)" + ok "OTA uses the same SD zip as install (legacy OTA-only packer gone)" else bad "legacy separate OTA-only packer / asset still present" fi @@ -419,7 +419,7 @@ if grep -q 'ota_ui_prompt_update' "$ROOT/native/switch-ota-launcher/src/main.c" && grep -q 'framebufferCreate\|COL_RAIL' "$ROOT/native/switch-ota-launcher/src/ota_ui.c" \ && grep -q '^ROMFS' "$ROOT/native/switch-ota-launcher/Makefile" then - ok "launcher UI is branded framebuffer (quiet by default)" + ok "launcher UI uses framebuffer (no prompt when up to date)" else bad "launcher missing branded ota_ui / ROMFS" fi diff --git a/src/update/SwitchOta.lua b/src/update/SwitchOta.lua index db03b22a..ca914bb2 100644 --- a/src/update/SwitchOta.lua +++ b/src/update/SwitchOta.lua @@ -1,4 +1,4 @@ --- Switch OTA protocol contract (host-testable, no love.*). +-- Switch OTA wire format (host-testable, no love.*). -- The native DEVKITPRO launcher (libnx + switch-curl) must implement the -- same decisions. LÖVE on NX never runs this path — Platform.networkValidated -- stays false and src/update/Check.lua remains gated off on NX. diff --git a/test/switch-nro-ota.spec.test.js b/test/switch-nro-ota.spec.test.js index 4f216cb2..1f66305e 100644 --- a/test/switch-nro-ota.spec.test.js +++ b/test/switch-nro-ota.spec.test.js @@ -571,8 +571,8 @@ test('AC-011: Empacotamento dual-NRO e selftest @spec:AC-011', () => { const selftest = read('scripts/switch/selftest_build_switch.sh'); assert.match(selftest, /dual-NRO|gen1recomp-game\.nro/); assert.match(selftest, /ota_launcher\.manifest/); - assert.match(selftest, /unified OTA|same SD zip|legacy OTA-only/i); - assert.match(selftest, /ota_ui|branded framebuffer|Quiet by default|quiet by default/i); + assert.match(selftest, /OTA uses the same SD zip|same SD zip|legacy OTA-only/i); + assert.match(selftest, /ota_ui|framebuffer|no prompt when up to date/i); const manifest = read('scripts/switch/ota_launcher.manifest'); assert.match(manifest, /^OTA_ENABLED=1$/m); diff --git a/tests/switch_ci_workflows_test.lua b/tests/switch_ci_workflows_test.lua index d43e6ccf..5ae2d693 100644 --- a/tests/switch_ci_workflows_test.lua +++ b/tests/switch_ci_workflows_test.lua @@ -157,14 +157,14 @@ local readme = read("README.md") mustContain(build_doc, "Path-gated", "switch-build.md") mustContain(build_doc, "ubuntu-latest", "switch-build.md") mustContain(build_doc, "selftest_build_switch.sh", "switch-build.md") -mustContain(build_doc, "canonical", "switch-build.md") +mustContain(build_doc, "main repo", "switch-build.md") mustContain(build_doc, "gen1recomp-switch-nro", "switch-build.md") mustContain(build_doc, "switch-build-result", "switch-build.md") mustContain(build_doc, "hard gate", "switch-build.md") mustContain(build_doc, "continue-on-error", "switch-build.md") mustContain(build_doc, "nacptool", "switch-build.md") mustContain(build_doc, "Docker", "switch-build.md") -mustContain(build_doc, "Fork → canonical", "switch-build.md") +mustContain(build_doc, "Fork PRs into the main repo", "switch-build.md") mustContain(build_doc, "skip Switch fused", "switch-build.md") mustContain(build_doc, "CI and release", "switch-build.md") mustNotContain(build_doc, "switch-development", "switch-build.md") diff --git a/tests/switch_transfer_docs_test.lua b/tests/switch_transfer_docs_test.lua index 68cd600b..808f76a3 100644 --- a/tests/switch_transfer_docs_test.lua +++ b/tests/switch_transfer_docs_test.lua @@ -32,7 +32,7 @@ mustContain(transfer, "imports/", "transfer") mustContain(transfer, "imports/mods/", "transfer") mustContain(transfer, "1: SD Card", "transfer") mustContain(transfer, "Scan again", "transfer") -mustContain(transfer, "one contributor workflow", "transfer") +mustContain(transfer, "documented example", "transfer") mustContain(transfer, "Linux", "transfer") mustContain(transfer, "Windows", "transfer") mustContain(transfer, "macOS", "transfer") @@ -46,7 +46,7 @@ mustContain(transfer, "Portable Devices", "transfer") mustContain(transfer, "MTP USB Device", "transfer") mustContain(transfer, "AppleDouble", "transfer") mustContain(transfer, "card reader", "transfer") -mustContain(transfer, "Canonical methods", "transfer") +mustContain(transfer, "Transfer methods", "transfer") mustContain(transfer, "OpenMTP", "transfer") mustContain(transfer, "only one", "transfer") mustContain(transfer, "USB-C", "transfer") @@ -69,7 +69,7 @@ mustContain(install, "GBC FX", "install") mustContain(install, "PERFORMANCE", "install") mustContain(install, "Stock engine effect", "install") mustContain(install, "## Limitations", "install") -mustContain(install, "Title override required", "install") +mustContain(install, "Launch with title override", "install") mustNotContain(install, "VoxelMod", "install") mustNotContain(install, "switch-development", "install") mustContain(build, "switch-transfer.md", "build") diff --git a/tools/switch-probe/README.md b/tools/switch-probe/README.md index f0940c85..c645324c 100644 --- a/tools/switch-probe/README.md +++ b/tools/switch-probe/README.md @@ -1,4 +1,4 @@ -# switch-probe — love-nx hardware probe +# switch-probe: love-nx hardware probe **NOT FOR RELEASE.** This package is a developer-only diagnostic for Nintendo Switch (love-nx). Do not ship it inside `game.love` or release NRO payloads. @@ -12,7 +12,7 @@ Validate Phase 0 runtime facts on real Switch hardware before running the full G - Gamepad / joystick / touch event logging To date this probe has only been run on **Switch OLED**; other models are -untested. Deploy beside `gen1recomp.nro` remains **manual** (MTP); see +untested. Deploy beside `gen1recomp.nro` remains **manual** (MTP). See `docs/switch-transfer.md`. ## Fields shown on screen @@ -39,7 +39,7 @@ zip -9 -j .bazinga/work/switch-probe.love tools/switch-probe/main.lua tools/swit ``` Deploy beside `gen1recomp.nro` (loose mode) per `docs/switch-build.md` and -`docs/switch-transfer.md`, renaming to `game.love` only for a probe run — use a +`docs/switch-transfer.md`. Rename to `game.love` only for a probe run. Use a separate SD folder so probe and game builds do not mix. ## Desktop smoke (optional) From 84e1a5177b0cd7ba67b9ba7c4d7349243aaa64eb Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 08:58:22 -0300 Subject: [PATCH 10/18] Harden Switch OTA install with TLS verification and reliable NRO replace. Enable HTTPS peer checks via a romfs CA bundle, remove existing NROs before rename on sdmc, and surface launcher replace failures before writing version.txt. --- .gitignore | 1 + native/switch-ota-launcher/Makefile | 6 ++++++ native/switch-ota-launcher/README.md | 1 + native/switch-ota-launcher/src/main.c | 21 ++++++++++++++++++--- native/switch-ota-launcher/src/ota_fs.c | 3 +-- native/switch-ota-launcher/src/ota_net.c | 14 ++++++++++---- test/switch-nro-ota.spec.test.js | 7 +++++++ 7 files changed, 44 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index 8f519c51..b237d83c 100644 --- a/.gitignore +++ b/.gitignore @@ -45,6 +45,7 @@ native/switch-ota-launcher/*.nacp native/switch-ota-launcher/*.elf native/switch-ota-launcher/*.map native/switch-ota-launcher/romfs/logo.png +native/switch-ota-launcher/romfs/cacert.pem # Legacy manual convenience-copy location (superseded by /dist/android/) mobile/dist/ diff --git a/native/switch-ota-launcher/Makefile b/native/switch-ota-launcher/Makefile index 45779960..6c7b463c 100644 --- a/native/switch-ota-launcher/Makefile +++ b/native/switch-ota-launcher/Makefile @@ -135,9 +135,15 @@ endif #--------------------------------------------------------------------------------- all: sync-romfs $(BUILD) +CACERT_URL := https://curl.se/ca/cacert.pem +CACERT_ROMFS := $(CURDIR)/$(ROMFS)/cacert.pem + sync-romfs: @mkdir -p $(CURDIR)/$(ROMFS) @cp -f $(LOGO_SRC) $(CURDIR)/$(ROMFS)/logo.png + @if ! curl -sfL --time-cond $(CACERT_ROMFS) -o $(CACERT_ROMFS) $(CACERT_URL); then \ + [ -f $(CACERT_ROMFS) ] || (echo "sync-romfs: failed to fetch cacert.pem" && exit 1); \ + fi $(BUILD): sync-romfs @[ -d $@ ] || mkdir -p $@ diff --git a/native/switch-ota-launcher/README.md b/native/switch-ota-launcher/README.md index ffa02cbc..010a2767 100644 --- a/native/switch-ota-launcher/README.md +++ b/native/switch-ota-launcher/README.md @@ -69,5 +69,6 @@ Manifest: `scripts/switch/ota_launcher.manifest`. - Zip extraction uses `switch-zziplib` (`ota_unzip.c`) on device. - OTA replaces launcher + game from the install zip (NACP versions stay aligned). +- HTTPS uses Mozilla CA bundle in romfs (`cacert.pem`, fetched at build time). - Sphaira HOME forwarders cache metadata until reinstalled (see docs/switch-install.md). - Release runner: `switch-dev` + (`install_devkitpro_deps.sh` **or** Docker) diff --git a/native/switch-ota-launcher/src/main.c b/native/switch-ota-launcher/src/main.c index 70cc6248..9ee2f5a1 100644 --- a/native/switch-ota-launcher/src/main.c +++ b/native/switch-ota-launcher/src/main.c @@ -185,14 +185,29 @@ static int run_update_flow(const char *install_dir) { } remove(extracted); + int have_launcher = 0; if (ota_unzip_extract_file(zip_path, LAUNCHER_MEMBER_IN_ZIP, extracted_launcher, err, sizeof(err)) == 0 || ota_unzip_extract_file(zip_path, OTA_LAUNCHER_NRO_NAME, extracted_launcher, err, sizeof(err)) == 0) { - (void)ota_fs_atomic_replace_nro(install_dir, OTA_LAUNCHER_NRO_NAME, extracted_launcher, err, - sizeof(err)); - remove(extracted_launcher); + have_launcher = 1; } + if (!have_launcher) { + remove(zip_path); + show_update_error("Could not extract", + "Update zip is missing launcher files.", err, installed); + return 0; + } + if (ota_fs_atomic_replace_nro(install_dir, OTA_LAUNCHER_NRO_NAME, extracted_launcher, err, + sizeof(err)) != 0) { + remove(extracted_launcher); + remove(zip_path); + show_update_error("Could not install", + "Game updated but launcher could not be replaced. Reinstall from the SD zip.", + err, installed); + return 0; + } + remove(extracted_launcher); char vpath[192]; snprintf(vpath, sizeof(vpath), "%s/version.txt", install_dir); diff --git a/native/switch-ota-launcher/src/ota_fs.c b/native/switch-ota-launcher/src/ota_fs.c index f2d04bc9..15d9631b 100644 --- a/native/switch-ota-launcher/src/ota_fs.c +++ b/native/switch-ota-launcher/src/ota_fs.c @@ -104,9 +104,8 @@ int ota_fs_atomic_replace_nro(const char *install_dir, const char *nro_name, if (err && err_len) snprintf(err, err_len, "copy to .part failed (%s)", nro_name); return -1; } -#ifdef _WIN32 + /* sdmc/FAT (Switch) and Windows do not replace an existing dest on rename. */ remove(dest); -#endif if (rename(part, dest) != 0) { if (err && err_len) snprintf(err, err_len, "rename .part -> %s failed", nro_name); remove(part); diff --git a/native/switch-ota-launcher/src/ota_net.c b/native/switch-ota-launcher/src/ota_net.c index 5ce38bb4..80b1510c 100644 --- a/native/switch-ota-launcher/src/ota_net.c +++ b/native/switch-ota-launcher/src/ota_net.c @@ -10,6 +10,14 @@ #endif #if defined(__SWITCH__) +#define OTA_CA_BUNDLE "romfs:/cacert.pem" + +static void ota_net_configure_tls(CURL *curl) { + curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 1L); + curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 2L); + curl_easy_setopt(curl, CURLOPT_CAINFO, OTA_CA_BUNDLE); +} + struct mem_buf { char *data; size_t len; @@ -76,8 +84,7 @@ int ota_net_download_buffer(const char *url, long timeout_ms, char **out, size_t curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT_MS, timeout_ms); curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_mem); curl_easy_setopt(curl, CURLOPT_WRITEDATA, &mem); - curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L); - curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L); + ota_net_configure_tls(curl); CURLcode rc = curl_easy_perform(curl); curl_easy_cleanup(curl); if (rc != CURLE_OK) { @@ -122,8 +129,7 @@ int ota_net_download_file(const char *url, const char *path, long timeout_ms, ch curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT_MS, timeout_ms); curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_file); curl_easy_setopt(curl, CURLOPT_WRITEDATA, fp); - curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L); - curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L); + ota_net_configure_tls(curl); if (progress) { curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 0L); curl_easy_setopt(curl, CURLOPT_XFERINFOFUNCTION, xfer_progress); diff --git a/test/switch-nro-ota.spec.test.js b/test/switch-nro-ota.spec.test.js index 1f66305e..f2688bac 100644 --- a/test/switch-nro-ota.spec.test.js +++ b/test/switch-nro-ota.spec.test.js @@ -513,7 +513,11 @@ test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () = assert.match(otaUi, /draw_text_wrapped_centered/); assert.match(otaUi, /ota_ui_alert_error/); assert.match(read('native/switch-ota-launcher/src/ota_net.c'), /XFERINFOFUNCTION|xfer_progress/); + assert.match(read('native/switch-ota-launcher/src/ota_net.c'), /CURLOPT_SSL_VERIFYPEER,\s*1L/); + assert.match(read('native/switch-ota-launcher/src/ota_net.c'), /romfs:\/cacert\.pem/); + assert.doesNotMatch(read('native/switch-ota-launcher/src/ota_net.c'), /CURLOPT_SSL_VERIFYPEER,\s*0L/); assert.match(read('native/switch-ota-launcher/Makefile'), /^ROMFS\s*:=/m); + assert.match(read('native/switch-ota-launcher/Makefile'), /cacert\.pem/); const mk = read('native/switch-ota-launcher/Makefile'); assert.match(mk, /libnx\/switch_rules|DEVKITPRO/); @@ -526,7 +530,10 @@ test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () = assert.match(read('native/switch-ota-launcher/src/main.c'), /ota_unzip_extract_file/); assert.match(read('native/switch-ota-launcher/src/main.c'), /GAME_MEMBER_IN_ZIP|switch\/gen1recomp\//); assert.match(read('native/switch-ota-launcher/src/main.c'), /LAUNCHER_MEMBER_IN_ZIP|ota_fs_atomic_replace_nro/); + assert.match(read('native/switch-ota-launcher/src/main.c'), /ota_fs_atomic_replace_nro\([\s\S]*\) != 0/); assert.match(read('native/switch-ota-launcher/src/ota_fs.c'), /ota_fs_atomic_replace_nro/); + assert.match(read('native/switch-ota-launcher/src/ota_fs.c'), /remove\(dest\)/); + assert.doesNotMatch(read('native/switch-ota-launcher/src/ota_fs.c'), /#ifdef _WIN32[\s\S]*remove\(dest\)/); assert.doesNotMatch(read('scripts/switch/install_devkitpro_deps.sh'), /switch-minizip/); assert.match(read('scripts/switch/install_devkitpro_deps.sh'), /switch-zziplib/); assert.match(read('scripts/switch/install_devkitpro_deps.sh'), /switch-dev/); From d08fce5fd5eca1652b6ef50ce1e29af467ac4692 Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 09:07:58 -0300 Subject: [PATCH 11/18] Fix fused Switch build polluting GAME_LOVE path capture. Route common.sh say() to stderr so sourcing it before pack_game_love does not mix progress lines into command substitution output. --- scripts/switch/common.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scripts/switch/common.sh b/scripts/switch/common.sh index 61611a4d..b08494dc 100644 --- a/scripts/switch/common.sh +++ b/scripts/switch/common.sh @@ -8,7 +8,8 @@ if [ -z "${ROOT:-}" ]; then fi export ROOT -say() { printf '\033[1;32m==>\033[0m %s\n' "$*"; } +# Progress on stderr so command-substitution (e.g. pack_game_love) stays a bare path. +say() { printf '\033[1;32m==>\033[0m %s\n' "$*" >&2; } fail() { printf '\033[1;31merror:\033[0m %s\n' "$*" >&2; exit 1; } # Print SHA-256 hex digest of PATH. Prefers shasum, falls back to sha256sum. From 287534cf2604689de50701c6a451caf894b0ec3f Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 09:14:35 -0300 Subject: [PATCH 12/18] Mount romfs before the quiet OTA release check so HTTPS can load cacert.pem. ota_net_init() now mounts romfs and initializes curl before the GitHub check runs, fixing silent update-check failures after TLS verification was enabled. --- native/switch-ota-launcher/README.md | 2 +- native/switch-ota-launcher/include/ota_net.h | 4 +++ native/switch-ota-launcher/src/main.c | 11 +++++-- native/switch-ota-launcher/src/ota_net.c | 30 ++++++++++++++++++++ native/switch-ota-launcher/src/ota_ui.c | 3 +- scripts/switch/selftest_build_switch.sh | 4 ++- test/switch-nro-ota.spec.test.js | 3 +- 7 files changed, 49 insertions(+), 8 deletions(-) diff --git a/native/switch-ota-launcher/README.md b/native/switch-ota-launcher/README.md index 010a2767..96417bcc 100644 --- a/native/switch-ota-launcher/README.md +++ b/native/switch-ota-launcher/README.md @@ -69,6 +69,6 @@ Manifest: `scripts/switch/ota_launcher.manifest`. - Zip extraction uses `switch-zziplib` (`ota_unzip.c`) on device. - OTA replaces launcher + game from the install zip (NACP versions stay aligned). -- HTTPS uses Mozilla CA bundle in romfs (`cacert.pem`, fetched at build time). +- HTTPS uses Mozilla CA bundle in romfs (`cacert.pem`, fetched at build time). `ota_net_init()` mounts romfs before the quiet release check. - Sphaira HOME forwarders cache metadata until reinstalled (see docs/switch-install.md). - Release runner: `switch-dev` + (`install_devkitpro_deps.sh` **or** Docker) diff --git a/native/switch-ota-launcher/include/ota_net.h b/native/switch-ota-launcher/include/ota_net.h index dcd86916..cd0c44c1 100644 --- a/native/switch-ota-launcher/include/ota_net.h +++ b/native/switch-ota-launcher/include/ota_net.h @@ -10,6 +10,10 @@ extern "C" { /* fraction is 0..1 when Content-Length is known, else -1 for indeterminate. */ typedef void (*ota_net_progress_fn)(void *userdata, double fraction); +/* Mount romfs (CA bundle) and init libcurl. Call before any HTTPS download. */ +int ota_net_init(void); +void ota_net_shutdown(void); + /* Download URL into memory buffer (caller frees *out). Returns 0 on success. */ int ota_net_download_buffer(const char *url, long timeout_ms, char **out, size_t *out_len, char *err, size_t err_len); diff --git a/native/switch-ota-launcher/src/main.c b/native/switch-ota-launcher/src/main.c index 9ee2f5a1..e2ed7840 100644 --- a/native/switch-ota-launcher/src/main.c +++ b/native/switch-ota-launcher/src/main.c @@ -232,13 +232,18 @@ int main(int argc, char **argv) { (void)argc; (void)argv; + const char *install = SD_INSTALL_DIR; + #if defined(__SWITCH__) socketInitializeDefault(); padConfigureInput(1, HidNpadStyleSet_NpadStandard); -#endif - - const char *install = SD_INSTALL_DIR; + if (ota_net_init() == 0) { + run_update_flow(install); + ota_net_shutdown(); + } +#else run_update_flow(install); +#endif char game[192]; snprintf(game, sizeof(game), "%s/%s", install, OTA_GAME_NRO_NAME); diff --git a/native/switch-ota-launcher/src/ota_net.c b/native/switch-ota-launcher/src/ota_net.c index 80b1510c..7b897b04 100644 --- a/native/switch-ota-launcher/src/ota_net.c +++ b/native/switch-ota-launcher/src/ota_net.c @@ -12,6 +12,31 @@ #if defined(__SWITCH__) #define OTA_CA_BUNDLE "romfs:/cacert.pem" +static int g_net_ready = 0; + +static int ota_ca_bundle_ready(void) { + FILE *f = fopen(OTA_CA_BUNDLE, "rb"); + if (!f) return 0; + fclose(f); + return 1; +} + +int ota_net_init(void) { + if (g_net_ready) return 0; + if (R_FAILED(romfsInit())) return -1; + if (!ota_ca_bundle_ready()) return -1; + if (curl_global_init(CURL_GLOBAL_DEFAULT) != CURLE_OK) return -1; + g_net_ready = 1; + return 0; +} + +void ota_net_shutdown(void) { + if (!g_net_ready) return; + curl_global_cleanup(); + romfsExit(); + g_net_ready = 0; +} + static void ota_net_configure_tls(CURL *curl) { curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 1L); curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 2L); @@ -60,6 +85,11 @@ static int xfer_progress(void *clientp, curl_off_t dltotal, curl_off_t dlnow, cu } return 0; } +#else + +int ota_net_init(void) { return 0; } +void ota_net_shutdown(void) {} + #endif int ota_net_download_buffer(const char *url, long timeout_ms, char **out, size_t *out_len, diff --git a/native/switch-ota-launcher/src/ota_ui.c b/native/switch-ota-launcher/src/ota_ui.c index e11262db..6cf44888 100644 --- a/native/switch-ota-launcher/src/ota_ui.c +++ b/native/switch-ota-launcher/src/ota_ui.c @@ -261,7 +261,7 @@ static void blit_logo(u32 *fb, u32 stride_px, int dst_x, int dst_y, int max_w) { static void load_logo(void) { if (g_logo) return; - romfsInit(); + /* romfs is mounted in ota_net_init() before the release check runs. */ int w = 0, h = 0, n = 0; unsigned char *data = stbi_load("romfs:/logo.png", &w, &h, &n, 4); if (!data || w <= 0 || h <= 0) { @@ -299,7 +299,6 @@ void ota_ui_shutdown(void) { free(g_logo); g_logo = NULL; g_logo_w = g_logo_h = 0; - romfsExit(); g_ready = 0; } diff --git a/scripts/switch/selftest_build_switch.sh b/scripts/switch/selftest_build_switch.sh index 7a796d09..1f8be38d 100755 --- a/scripts/switch/selftest_build_switch.sh +++ b/scripts/switch/selftest_build_switch.sh @@ -416,8 +416,10 @@ else fi if grep -q 'ota_ui_prompt_update' "$ROOT/native/switch-ota-launcher/src/main.c" \ + && grep -q 'ota_net_init' "$ROOT/native/switch-ota-launcher/src/main.c" \ && grep -q 'framebufferCreate\|COL_RAIL' "$ROOT/native/switch-ota-launcher/src/ota_ui.c" \ - && grep -q '^ROMFS' "$ROOT/native/switch-ota-launcher/Makefile" + && grep -q '^ROMFS' "$ROOT/native/switch-ota-launcher/Makefile" \ + && grep -q 'cacert.pem' "$ROOT/native/switch-ota-launcher/Makefile" then ok "launcher UI uses framebuffer (no prompt when up to date)" else diff --git a/test/switch-nro-ota.spec.test.js b/test/switch-nro-ota.spec.test.js index f2688bac..b0f75e2c 100644 --- a/test/switch-nro-ota.spec.test.js +++ b/test/switch-nro-ota.spec.test.js @@ -512,7 +512,8 @@ test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () = assert.match(otaUi, /ota_ui_sanitize_ascii/); assert.match(otaUi, /draw_text_wrapped_centered/); assert.match(otaUi, /ota_ui_alert_error/); - assert.match(read('native/switch-ota-launcher/src/ota_net.c'), /XFERINFOFUNCTION|xfer_progress/); + assert.match(read('native/switch-ota-launcher/src/ota_net.c'), /ota_net_init/); + assert.match(read('native/switch-ota-launcher/src/main.c'), /ota_net_init/); assert.match(read('native/switch-ota-launcher/src/ota_net.c'), /CURLOPT_SSL_VERIFYPEER,\s*1L/); assert.match(read('native/switch-ota-launcher/src/ota_net.c'), /romfs:\/cacert\.pem/); assert.doesNotMatch(read('native/switch-ota-launcher/src/ota_net.c'), /CURLOPT_SSL_VERIFYPEER,\s*0L/); From eeb181bcc0c9511bd7db3c2db86e1f2c5f1c8967 Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 09:17:49 -0300 Subject: [PATCH 13/18] Wrap Switch OTA button labels in parentheses so A/B/+ read as controls. --- native/switch-ota-launcher/src/ota_ui.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/native/switch-ota-launcher/src/ota_ui.c b/native/switch-ota-launcher/src/ota_ui.c index 6cf44888..934c34e9 100644 --- a/native/switch-ota-launcher/src/ota_ui.c +++ b/native/switch-ota-launcher/src/ota_ui.c @@ -381,9 +381,9 @@ static void paint_prompt(u32 *fb, u32 stride_px, void *ctx) { int bw = 600; int bh = 64; int bx = (FB_W - bw) / 2; - draw_button(fb, stride_px, bx, y, bw, bh, COL_YELLOW, COL_INVERSE, "A Update", p->focus == 0); + draw_button(fb, stride_px, bx, y, bw, bh, COL_YELLOW, COL_INVERSE, "(A) Update", p->focus == 0); y += bh + 24; - draw_button(fb, stride_px, bx, y, bw, bh, COL_INK, COL_INVERSE, "B Play without update", + draw_button(fb, stride_px, bx, y, bw, bh, COL_INK, COL_INVERSE, "(B) Play without update", p->focus == 1); } @@ -481,7 +481,7 @@ static void paint_alert(u32 *fb, u32 stride_px, void *ctx) { y += LINE_BODY + 16; int bw = 360; int bh = 56; - draw_button(fb, stride_px, (FB_W - bw) / 2, y, bw, bh, COL_INK, COL_INVERSE, "B Continue", 1); + draw_button(fb, stride_px, (FB_W - bw) / 2, y, bw, bh, COL_INK, COL_INVERSE, "(B) Continue", 1); } void ota_ui_alert(const char *title, const char *line1, const char *line2) { @@ -531,7 +531,7 @@ static void paint_missing(u32 *fb, u32 stride_px, void *ctx) { y += LINE_BODY + 16; int bw = 320; int bh = 56; - draw_button(fb, stride_px, (FB_W - bw) / 2, y, bw, bh, COL_INK, COL_INVERSE, "+ Exit", 1); + draw_button(fb, stride_px, (FB_W - bw) / 2, y, bw, bh, COL_INK, COL_INVERSE, "(+) Exit", 1); } void ota_ui_missing_game(void) { From 3fae3088caf87dba39908efc126bce6d5f7e8e58 Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 09:59:01 -0300 Subject: [PATCH 14/18] Fix Switch OTA launcher self-update via a bootstrap NRO. A running launcher cannot replace its own NRO on sdmc/FAT; stage the new binary and chainload a tiny helper from romfs to swap it in before loading the game. --- .gitignore | 6 ++ native/switch-ota-bootstrap/Makefile | 72 +++++++++++++++++++ native/switch-ota-bootstrap/main.c | 36 ++++++++++ native/switch-ota-launcher/Makefile | 12 +++- native/switch-ota-launcher/README.md | 5 +- native/switch-ota-launcher/include/ota_fs.h | 6 ++ .../include/ota_protocol.h | 3 + native/switch-ota-launcher/src/main.c | 31 ++++++-- native/switch-ota-launcher/src/ota_fs.c | 42 +++++++++++ 9 files changed, 204 insertions(+), 9 deletions(-) create mode 100644 native/switch-ota-bootstrap/Makefile create mode 100644 native/switch-ota-bootstrap/main.c diff --git a/.gitignore b/.gitignore index b237d83c..6f8443fb 100644 --- a/.gitignore +++ b/.gitignore @@ -46,6 +46,12 @@ native/switch-ota-launcher/*.elf native/switch-ota-launcher/*.map native/switch-ota-launcher/romfs/logo.png native/switch-ota-launcher/romfs/cacert.pem +native/switch-ota-launcher/romfs/ota-bootstrap.nro +native/switch-ota-bootstrap/build/ +native/switch-ota-bootstrap/*.nro +native/switch-ota-bootstrap/*.nacp +native/switch-ota-bootstrap/*.elf +native/switch-ota-bootstrap/*.map # Legacy manual convenience-copy location (superseded by /dist/android/) mobile/dist/ diff --git a/native/switch-ota-bootstrap/Makefile b/native/switch-ota-bootstrap/Makefile new file mode 100644 index 00000000..4920b3c3 --- /dev/null +++ b/native/switch-ota-bootstrap/Makefile @@ -0,0 +1,72 @@ +#--------------------------------------------------------------------------------- +# One-shot OTA bootstrap NRO (copied into the main launcher's romfs). +#--------------------------------------------------------------------------------- +.SUFFIXES: + +ifeq ($(strip $(DEVKITPRO)),) + +.PHONY: all +all: + @echo "DEVKITPRO not set — bootstrap builds with the launcher only." + @false + +else + +TOPDIR ?= $(CURDIR) +include $(DEVKITPRO)/libnx/switch_rules + +TARGET := ota-bootstrap +BUILD := build +SOURCES := . +INCLUDES := include +ROMFS := + +APP_TITLE := gen1recomp OTA +APP_AUTHOR := bryanthaboi, port by andrewqsantos +APP_VERSION := 0.0.0 + +ARCH := -march=armv8-a+crc+crypto -mtune=cortex-a57 -mtp=soft -fPIE +CFLAGS := -g -Wall -O2 -ffunction-sections $(ARCH) $(DEFINES) +CFLAGS += $(INCLUDE) -D__SWITCH__ +ASFLAGS := -g $(ARCH) +LDFLAGS = -specs=$(DEVKITPRO)/libnx/switch.specs -g $(ARCH) -Wl,-Map,$(notdir $*.map) +LIBS := -lnx +LIBDIRS := $(LIBNX) + +ifneq ($(BUILD),$(notdir $(CURDIR))) +export OUTPUT := $(CURDIR)/$(TARGET) +export TOPDIR := $(CURDIR) +export VPATH := $(foreach dir,$(SOURCES),$(CURDIR)/$(dir)) +export DEPSDIR := $(CURDIR)/$(BUILD) +CFILES := $(foreach dir,$(SOURCES),$(notdir $(wildcard $(dir)/*.c))) +export LD := $(CC) +export OFILES := $(CFILES:.c=.o) +export INCLUDE := $(foreach dir,$(INCLUDES),-I$(CURDIR)/$(dir)) \ + $(foreach dir,$(LIBDIRS),-I$(dir)/include) \ + -I$(CURDIR)/$(BUILD) +export LIBPATHS := $(foreach dir,$(LIBDIRS),-L$(dir)/lib) +export APP_ICON := $(LIBNX)/default_icon.jpg +export NROFLAGS += --icon=$(APP_ICON) +export NROFLAGS += --nacp=$(CURDIR)/$(TARGET).nacp + +.PHONY: $(BUILD) clean all + +all: $(BUILD) + +$(BUILD): + @[ -d $@ ] || mkdir -p $@ + @$(MAKE) --no-print-directory -C $(BUILD) -f $(CURDIR)/Makefile + +clean: + @echo clean ... + @rm -fr $(BUILD) $(TARGET).nro $(TARGET).nacp $(TARGET).elf + +else +.PHONY: all +DEPENDS := $(OFILES:.o=.d) +all: $(OUTPUT).nro +$(OUTPUT).nro: $(OUTPUT).elf $(OUTPUT).nacp +$(OUTPUT).elf: $(OFILES) +-include $(DEPENDS) +endif +endif diff --git a/native/switch-ota-bootstrap/main.c b/native/switch-ota-bootstrap/main.c new file mode 100644 index 00000000..0aec9352 --- /dev/null +++ b/native/switch-ota-bootstrap/main.c @@ -0,0 +1,36 @@ +/* + * Tiny one-shot helper: swap a staged launcher NRO into place, then load the game. + * The main OTA launcher chainloads here because a running NRO cannot replace itself + * on sdmc/FAT. + */ +#include +#include +#include + +#if defined(__SWITCH__) +#include +#endif + +#define INSTALL_DIR "sdmc:/switch/gen1recomp" +#define STAGED INSTALL_DIR "/gen1recomp.nro.staged" +#define LAUNCHER INSTALL_DIR "/gen1recomp.nro" +#define GAME INSTALL_DIR "/gen1recomp-game.nro" + +int main(int argc, char **argv) { + (void)argc; + (void)argv; + +#if defined(__SWITCH__) + remove(LAUNCHER); + if (rename(STAGED, LAUNCHER) != 0) { + return 1; + } + Result rc = envSetNextLoad(GAME, GAME); + if (R_FAILED(rc)) return 1; + return 0; +#else + fprintf(stderr, "ota-bootstrap: host stub (would rename %s -> %s, load %s)\n", STAGED, LAUNCHER, + GAME); + return 0; +#endif +} diff --git a/native/switch-ota-launcher/Makefile b/native/switch-ota-launcher/Makefile index 6c7b463c..94d368b3 100644 --- a/native/switch-ota-launcher/Makefile +++ b/native/switch-ota-launcher/Makefile @@ -130,7 +130,10 @@ ifneq ($(ROMFS),) export NROFLAGS += --romfsdir=$(CURDIR)/$(ROMFS) endif -.PHONY: $(BUILD) clean all host-test sync-romfs +BOOTSTRAP_DIR := $(TOPDIR)/../switch-ota-bootstrap +BOOTSTRAP_ROMFS := $(CURDIR)/$(ROMFS)/ota-bootstrap.nro + +.PHONY: $(BUILD) clean all host-test sync-romfs bootstrap-romfs #--------------------------------------------------------------------------------- all: sync-romfs $(BUILD) @@ -138,7 +141,12 @@ all: sync-romfs $(BUILD) CACERT_URL := https://curl.se/ca/cacert.pem CACERT_ROMFS := $(CURDIR)/$(ROMFS)/cacert.pem -sync-romfs: +bootstrap-romfs: + @$(MAKE) --no-print-directory -C $(BOOTSTRAP_DIR) all + @mkdir -p $(CURDIR)/$(ROMFS) + @cp -f $(BOOTSTRAP_DIR)/ota-bootstrap.nro $(BOOTSTRAP_ROMFS) + +sync-romfs: bootstrap-romfs @mkdir -p $(CURDIR)/$(ROMFS) @cp -f $(LOGO_SRC) $(CURDIR)/$(ROMFS)/logo.png @if ! curl -sfL --time-cond $(CACERT_ROMFS) -o $(CACERT_ROMFS) $(CACERT_URL); then \ diff --git a/native/switch-ota-launcher/README.md b/native/switch-ota-launcher/README.md index 96417bcc..9879e554 100644 --- a/native/switch-ota-launcher/README.md +++ b/native/switch-ota-launcher/README.md @@ -68,7 +68,10 @@ Manifest: `scripts/switch/ota_launcher.manifest`. ## Status / known gaps - Zip extraction uses `switch-zziplib` (`ota_unzip.c`) on device. -- OTA replaces launcher + game from the install zip (NACP versions stay aligned). +- OTA replaces game + launcher from the install zip (NACP versions stay aligned). + The running launcher cannot overwrite its own NRO on sdmc/FAT; a tiny + `ota-bootstrap.nro` (embedded in romfs) chainloads once to swap the staged + launcher, then loads the game. - HTTPS uses Mozilla CA bundle in romfs (`cacert.pem`, fetched at build time). `ota_net_init()` mounts romfs before the quiet release check. - Sphaira HOME forwarders cache metadata until reinstalled (see docs/switch-install.md). - Release runner: `switch-dev` + (`install_devkitpro_deps.sh` **or** Docker) diff --git a/native/switch-ota-launcher/include/ota_fs.h b/native/switch-ota-launcher/include/ota_fs.h index 4a43968e..f94d98bd 100644 --- a/native/switch-ota-launcher/include/ota_fs.h +++ b/native/switch-ota-launcher/include/ota_fs.h @@ -22,6 +22,12 @@ int ota_fs_atomic_replace_game(const char *install_dir, const char *verified_gam int ota_fs_atomic_replace_nro(const char *install_dir, const char *nro_name, const char *verified_nro, char *err, size_t err_len); +/* Stage a new launcher + copy romfs bootstrap; chainload bootstrap_out next. + * The running launcher cannot replace its own NRO on sdmc/FAT. */ +int ota_fs_stage_launcher_bootstrap(const char *install_dir, const char *verified_launcher, + char *bootstrap_out, size_t bootstrap_out_len, char *err, + size_t err_len); + /* Hand off to game NRO via envSetNextLoad (Switch) or no-op stub (host). */ int ota_fs_handoff_to_game(const char *game_nro_path, char *err, size_t err_len); diff --git a/native/switch-ota-launcher/include/ota_protocol.h b/native/switch-ota-launcher/include/ota_protocol.h index 5e24535e..995efd7c 100644 --- a/native/switch-ota-launcher/include/ota_protocol.h +++ b/native/switch-ota-launcher/include/ota_protocol.h @@ -12,6 +12,9 @@ extern "C" { #define OTA_LAUNCHER_NRO_NAME "gen1recomp.nro" #define OTA_SAVE_DIR_NAME "pokemon-love2d" #define OTA_INSTALL_DIR "switch/gen1recomp" +#define OTA_LAUNCHER_STAGED_SUFFIX ".staged" +#define OTA_BOOTSTRAP_ROMFS "romfs:/ota-bootstrap.nro" +#define OTA_BOOTSTRAP_SD_NAME "ota-bootstrap.nro" #define OTA_RELEASES_API \ "https://api.github.com/repos/bryanthaboi/gen1recomp/releases/latest" diff --git a/native/switch-ota-launcher/src/main.c b/native/switch-ota-launcher/src/main.c index e2ed7840..f187e421 100644 --- a/native/switch-ota-launcher/src/main.c +++ b/native/switch-ota-launcher/src/main.c @@ -198,12 +198,15 @@ static int run_update_flow(const char *install_dir) { "Update zip is missing launcher files.", err, installed); return 0; } - if (ota_fs_atomic_replace_nro(install_dir, OTA_LAUNCHER_NRO_NAME, extracted_launcher, err, - sizeof(err)) != 0) { + + char bootstrap_path[256]; + bootstrap_path[0] = '\0'; + if (ota_fs_stage_launcher_bootstrap(install_dir, extracted_launcher, bootstrap_path, + sizeof(bootstrap_path), err, sizeof(err)) != 0) { remove(extracted_launcher); remove(zip_path); show_update_error("Could not install", - "Game updated but launcher could not be replaced. Reinstall from the SD zip.", + "Game updated but launcher could not be staged. Reinstall from the SD zip.", err, installed); return 0; } @@ -217,8 +220,16 @@ static int run_update_flow(const char *install_dir) { fclose(vf); } - ota_ui_show_progress("Ready", "Starting the game...", 1.0f); + ota_ui_show_progress("Ready", "Finishing update...", 1.0f); svcSleepThread(600000000ULL); + remove(zip_path); + ota_ui_shutdown(); + + if (ota_fs_handoff_to_game(bootstrap_path, err, sizeof(err)) != 0) { + show_update_error("Could not install", "Launcher bootstrap failed.", err, installed); + return 0; + } + return 2; /* chainload bootstrap; main must not hand off to game */ #else (void)extracted; (void)extracted_launcher; @@ -233,18 +244,26 @@ int main(int argc, char **argv) { (void)argv; const char *install = SD_INSTALL_DIR; + int update_rc = 0; #if defined(__SWITCH__) socketInitializeDefault(); padConfigureInput(1, HidNpadStyleSet_NpadStandard); if (ota_net_init() == 0) { - run_update_flow(install); + update_rc = run_update_flow(install); ota_net_shutdown(); } #else - run_update_flow(install); + update_rc = run_update_flow(install); #endif + if (update_rc == 2) { +#if defined(__SWITCH__) + socketExit(); +#endif + return 0; + } + char game[192]; snprintf(game, sizeof(game), "%s/%s", install, OTA_GAME_NRO_NAME); char err[128]; diff --git a/native/switch-ota-launcher/src/ota_fs.c b/native/switch-ota-launcher/src/ota_fs.c index 15d9631b..5adca96b 100644 --- a/native/switch-ota-launcher/src/ota_fs.c +++ b/native/switch-ota-launcher/src/ota_fs.c @@ -7,6 +7,7 @@ #if defined(__SWITCH__) #include #include +#include #include #else #include @@ -114,6 +115,47 @@ int ota_fs_atomic_replace_nro(const char *install_dir, const char *nro_name, return 0; } +int ota_fs_stage_launcher_bootstrap(const char *install_dir, const char *verified_launcher, + char *bootstrap_out, size_t bootstrap_out_len, char *err, + size_t err_len) { + if (!verified_launcher || !*verified_launcher) { + if (err && err_len) snprintf(err, err_len, "missing staged launcher path"); + return -1; + } + if (!bootstrap_out || bootstrap_out_len == 0) { + if (err && err_len) snprintf(err, err_len, "missing bootstrap output buffer"); + return -1; + } + bootstrap_out[0] = '\0'; + + const char *base = install_dir ? install_dir : OTA_INSTALL_DIR; + char staged[256]; + char bootstrap[256]; + char updates[192]; + snprintf(staged, sizeof(staged), "%s/%s%s", base, OTA_LAUNCHER_NRO_NAME, + OTA_LAUNCHER_STAGED_SUFFIX); + snprintf(updates, sizeof(updates), "%s/updates", base); + snprintf(bootstrap, sizeof(bootstrap), "%s/updates/%s", base, OTA_BOOTSTRAP_SD_NAME); + + remove(staged); + if (copy_file(verified_launcher, staged) != 0) { + if (err && err_len) snprintf(err, err_len, "stage launcher failed"); + return -1; + } + +#if defined(__SWITCH__) + mkdir(updates, 0755); +#endif + if (copy_file(OTA_BOOTSTRAP_ROMFS, bootstrap) != 0) { + remove(staged); + if (err && err_len) snprintf(err, err_len, "extract bootstrap failed"); + return -1; + } + + snprintf(bootstrap_out, bootstrap_out_len, "%s", bootstrap); + return 0; +} + int ota_fs_handoff_to_game(const char *game_nro_path, char *err, size_t err_len) { if (!game_nro_path || !*game_nro_path) { if (err && err_len) snprintf(err, err_len, "missing game path"); From e94d8e32efffe0a1dcd1d19ac1af3446e9473f0d Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 10:14:11 -0300 Subject: [PATCH 15/18] Drop stb_image from Switch OTA launcher with a pre-baked logo asset. --- .gitignore | 1 + native/switch-ota-launcher/Makefile | 8 +- native/switch-ota-launcher/README.md | 12 + native/switch-ota-launcher/assets/logo.rgba | Bin 0 -> 110528 bytes native/switch-ota-launcher/src/ota_ui.c | 44 +- .../third_party/stb_image.h | 7988 ----------------- scripts/switch/bake_ota_logo.py | 156 + test/switch-nro-ota.spec.test.js | 17 +- 8 files changed, 220 insertions(+), 8006 deletions(-) create mode 100644 native/switch-ota-launcher/assets/logo.rgba delete mode 100644 native/switch-ota-launcher/third_party/stb_image.h create mode 100644 scripts/switch/bake_ota_logo.py diff --git a/.gitignore b/.gitignore index 6f8443fb..862484ca 100644 --- a/.gitignore +++ b/.gitignore @@ -44,6 +44,7 @@ native/switch-ota-launcher/*.nro native/switch-ota-launcher/*.nacp native/switch-ota-launcher/*.elf native/switch-ota-launcher/*.map +native/switch-ota-launcher/romfs/logo.rgba native/switch-ota-launcher/romfs/logo.png native/switch-ota-launcher/romfs/cacert.pem native/switch-ota-launcher/romfs/ota-bootstrap.nro diff --git a/native/switch-ota-launcher/Makefile b/native/switch-ota-launcher/Makefile index 94d368b3..d5545f00 100644 --- a/native/switch-ota-launcher/Makefile +++ b/native/switch-ota-launcher/Makefile @@ -46,7 +46,8 @@ APP_VERSION ?= 0.0.0 # Prefer project Switch icon if present ICON := $(TOPDIR)/../../assets/switch/icon.jpg -LOGO_SRC := $(TOPDIR)/../../assets/logo/logo.png +LOGO_RGBA_SRC := $(TOPDIR)/assets/logo.rgba +LOGO_ROMFS := $(CURDIR)/$(ROMFS)/logo.rgba #--------------------------------------------------------------------------------- ARCH := -march=armv8-a+crc+crypto -mtune=cortex-a57 -mtp=soft -fPIE @@ -148,7 +149,8 @@ bootstrap-romfs: sync-romfs: bootstrap-romfs @mkdir -p $(CURDIR)/$(ROMFS) - @cp -f $(LOGO_SRC) $(CURDIR)/$(ROMFS)/logo.png + @[ -f "$(LOGO_RGBA_SRC)" ] || (echo "missing $(LOGO_RGBA_SRC) — run: python3 scripts/switch/bake_ota_logo.py" && exit 1) + @cp -f "$(LOGO_RGBA_SRC)" "$(LOGO_ROMFS)" @if ! curl -sfL --time-cond $(CACERT_ROMFS) -o $(CACERT_ROMFS) $(CACERT_URL); then \ [ -f $(CACERT_ROMFS) ] || (echo "sync-romfs: failed to fetch cacert.pem" && exit 1); \ fi @@ -161,7 +163,7 @@ $(BUILD): sync-romfs clean: @echo clean ... @rm -fr $(BUILD) $(TARGET).nro $(TARGET).nacp $(TARGET).elf $(TARGET).lst build-host - @rm -f $(CURDIR)/$(ROMFS)/logo.png + @rm -f $(CURDIR)/$(ROMFS)/logo.rgba $(CURDIR)/$(ROMFS)/logo.png host-test: @mkdir -p build-host diff --git a/native/switch-ota-launcher/README.md b/native/switch-ota-launcher/README.md index 9879e554..b61d5761 100644 --- a/native/switch-ota-launcher/README.md +++ b/native/switch-ota-launcher/README.md @@ -59,6 +59,18 @@ scripts/switch/build_ota_launcher.sh Docker fallback uses the same pin as fused builds (`scripts/switch/dkp-docker.image`). +## OTA logo asset + +The launcher draws a pre-scaled logo from `romfs:/logo.rgba` (no PNG decoder in +the NRO). The baked blob lives at `assets/logo.rgba` and is copied into romfs at +build time. After changing `assets/logo/logo.png`, regenerate: + +```bash +python3 scripts/switch/bake_ota_logo.py +``` + +Requires Pillow, or on macOS uses `sips` when Pillow is not installed. + ## Packaging `scripts/switch/pack_sd_zip.sh GAME_NRO VERSION OUT_ZIP LAUNCHER_NRO` writes both diff --git a/native/switch-ota-launcher/assets/logo.rgba b/native/switch-ota-launcher/assets/logo.rgba new file mode 100644 index 0000000000000000000000000000000000000000..cb97707a985f8751e37dae6978890a5ea65c31c5 GIT binary patch literal 110528 zcmeI52Y6Lgy7!&A-@SK6opE|~Mn^*EH53a%La2%b6;TvvDF~t<5|YqDlU_tRNJ*op z*!y4?dzo=`9Cbz=d+!Z__5FYEKI>%Xs|l#_LcU%0}dE) zK>fdO0|nY=mE^R~*)*+vZfXCtoYEd?ImI2*a>^U0<&^xk<-p>Dn)TcIKLm(T|7K(SaH90!#AaO$SrA=GHS{H?w`G^Z&f`7>M8JDra;S! ziVqS#J=$UTX5m*!#gS9$gjI%XU|aj#a@T(NCdYLh&fOY0gnjzEeeNdvtzA~hC+)M# zn|+t*Ro}OI3e;0z|D-@#cF8j+2mRdEstU#&yc?PMf>cs*56fn)%UBO0`(Nw|0vL5~yz$#Q-;Z;rVXj ztO@SiNf*10ImHp#Ex^O}xn-UAzuwljsGb7#6!@-EKr+G~GcQ{cNx zfsR?Fhf2468NZ~rksT#l*TYwLlB{)LjTq)JZr39RySMH-!X1D9>Uu2u?y^gL&*~|# zUs9l`sObChOKz#GTW)nLmS&sI=y58Ub3!c3F7L8mcD}w*^%SV5z;}iMikTSZZT-k( zEr)J$Lki})k9YjW?Rw-#Ny}tlT~#bAQOudesGXQB!N?_OJ$U_3+7DUxhmN_WP1_AC zZccn!`yreD&~a4hkNfr8`d`UDtNyxr3e;2J{{{ux4J~QZE~o6Rux{CD_(u1)8`{g3 zpS*7AWw!WOw#6yu>Ew76MYm1MDa%m4z!=5Ut`e5sqCA49bbhT}cJaG9f1=~l;3$4q zzr7;teYjnA*+#|co=ZMeyyxyO-zn$ok8QI`j!hd@lBNDlk^H+jd`PdiJPGBB4QV&5 z^qBS|HvM6LX?uM;_74giHGJdmgE>-?E1sXGd9hY8p6l(%D%k)(iFfkaW|y4aHfv+c zw4AMn>>n-PcdbavS@qw-g`2{7{`ABc>kW_l~vO@*>pc5z38-J;)E!@7B-k(zkWqA%F74!og0K@0##c^*?-9 zDbO*utfA(|IL(_o;30U!c;0erf}FzO@5pEIR74)xsl3AHb>HRaTSpGxboh6bM&W)5 z&o2t+C=us6V)9J)#e=_eU)55#^mv9&`u;tKxs%7NaIJ@tzezj>*i?Fn#%7(yh0_P_tG?8~=RZe*4nr?%rL}pz*1->g^}4n^ zqQtRvS-_>=o-SCZV+U1sg;O83g6B#4cxo2-`QzzZhV;LCu$&TN< zeivOD#WLoym!%?WN2U2qUP0?&<*tS7bj_4Q&`Ppl8|4(FWeEehH@ld5t$4K{&!D-k z;aYO4!Z;DgY2_cZ%i3_xzU0RCxf?nwuVK6KP*lFEz}}#LWoCzLuJwYLJ^IO+zp+n( z`@|)O`$M07uB*mLdUZ+CHphM0|N3`*eF|u;Iz*T=OBnVsIOON0=LdKL9)a(T|Cs~E zLjfNVKgE2AUGsU4f1W6SmN zm95`nm_P54jqR%kf8|b(!7@K4oXO{GCG28MT5D|5M{ICs}hq=dTj(ZLW-&Il{l(@?G*5 z4E(04oj!Q|4W+ua0?4Rs}@`-%YeXD=|zM}wjw8XQIfH}gl=(saaSm($Q z#D?Afq9tzh)G2Ppf)Q@XB{}X=9rG9Ey8KxexvUBEG#^&F4%uZkuedLEZN!cd;iEg+ zW)*kccRl>(-XuHoG^3m59P@=aH+I@&Vc1WlTmHCCSQg{~9OT|qY}ux@X9}Nu+<)*6 z)(ekcM@siUd;9`7f8j`X$CmEy-?uh(U)=u-=N|sCbB`*Ifa4L41NEJ94D3)&0e}17 zAO4Yh=g!03X$>>_w%0K9kyQ$qbMMdnf!m(RS7sQ?yp{1>z;yrM7 z+T5}3woN_V3%4|vtoj?b`=LYB2m1JO5Ax|Ujmy}1gj-S(a*jYE_0hN>+jwc z&N|W4`0bH{+%DntSHiMH2fsUA7hL}%_saIhZr#d30Z!|=VL1(bUB{>LFPyt~xugDR z`;r3fhLxPBHFuZhV{|QKy>BPm%EVdYZBFer?E0bGBi{H*JhJm44&~p(9Q?LR>$`hY z>%A~;*F!&*KGV`IyEMlgr*##5v=XM7FF`izoYJShjroQ6Y9&kj6*-eR5B_79y1w+p zI_s8ul!N)yjcr^f(I!{}f_gyc@90a%U$D~hIiI+uqx%xs%VaLiZH-B7u`AK_?%{)M zUCNt2!R!eh&zSS=vdd51oBY{kSlMA3|G$OhTGj*E%iO}nBi*}q3B$B*?iODq!mVV! z-=q8qc=Fx54|A&&vy6@ru0Mhu#O6R&N#Wk?U;VT84F%d|Z9I)yG-10K`qAmqBk#K+ zL+e_AONp>67R##s{bR#F;;P6;Jz*SU9ql&qGWX|Ay@WlIF-4DL zuqxSWcB5bGxlhSnh+NBwqhMW>tWWIY{t?$y?I0-Dr*$hGyY2!pXzcQy2D5J{oYNPooD`pN_a** zisEakWq|r0_X`TN8(!R8aW=08Izylvp})*tFxu_ZoY^g1vZ{<#6`$&I&2D6U**)&R zvWw)uOQQ3{)iMdmG6UrK`^omL2Zik-eTc z3NUF8_Gqi=gFJwaUUO{>e4lGp3^tje^{~zE_RZb&j34YX4D;BBuKD*HTDv2Kr#9CE zo8ZoN!#1^vLzd*f(%vkx(ax`oV}YIV@B0A9JoX{;?UMau;i7Y;Z-(VF(>Hgv%PKuB z`A*eexvwb@@fSU5anTW(2;1_-^T*h@V(+R8M%DHnZ@ZWzn;bYAw#A~i3D2%b%eij9 zjAxV%vOcU^1~^=zSb_D@kJh<9su$Z&diub^izQ!8aT6{s&^j^J6|WlNKDqx_HR_+} zKo4Er+2X;7o0>KM0<&X#jM-P`J@N&-q1tIZMy)k{mwwv%msOJfb@;Y%&&gvI<01cH zAk#AT_?Yg!LYR$ATa8VBZ~ulJZnx|KixyYLGh3%}%HLw2n6J~<@AAEhLuitgTQ-rn z(S6;|w0^4&QSQ;5;q?&vSl;wW?#l;%Zg%_HV$#>S9vN+y;ug?j&^g0?0mBN#weN5G zruIS_AX|U5CYi@E&d4szOYB_OuUiqzqJwz6#;SRJqA-ryWi{!a#QMK|muzP8hjQ;3 z;}*Hkjal6juTvxSRB*t+V+G?LTxK(i5B58l^vb$@+dD`ID|ONT1{;AWjaIdat1 zT9ZnO_HBF9|6hy#OSXpP3G7wGlfNyU=$q6ltHV2Nz3Nm1F;~Q0slCV-;UgmN`hIY3C2Siwev$k1fnO&TbGG}D zpD6!nx^(bO?ij_jJa^Q+J?OLvKn>y+1&lAd>Hqwa+-v>mcODwBcrxf5r}Z~9AHOOwH#Z{iy8 z4EqZ4#pDn8u?yDy;yH=A;=BI~HCE&&JV`uIs$hD_SkwmsDtU{PYQF zS@PFJ;F_O2*R?oxfosukv1@t8QrGJ26|T)Wt6kf{m$|k>*15JrH%LEZ zKN50<0v{Rv|J;dlBzOFxMjaFTKlK_{Egxn!GvbuDtv}6hDH$vS$39oQ#?$iEtzU7D z8(J{O9h3x#(YKY?i2e-?g*jjNW^drFSl6R;TRQvI8-)q=q zTv>}#7wS1)w=6MR+!KmN{7=bbVO+$1M$AV4af>VbQpSVjpKHH`PPOmzxAzWm4Q1y! zT6nQYWB)ulH@F^_r{M|vZdmd9ebv(jT`tUMIbiwcVOuq^UW*o=XLjkt7_)Ej%{}qo z?&^(wgWSOg21Mka52%%}x9P=rQD*{Qi14zf)|_m~&2uzY znKkv{t2!CRwvG6xO$Ny--I3C}uKO#y@1-k0ix`xnhHw2nb!6HNFYC~5*v1Z=+h=cR z)-kL6*W|)sQ{gkRug0&BcT#E;Q#J?PsHU1Luf;^K{G+7R}bW zF;?H5NzTSGLofSL?0vC+(-ytEK>qWGr9196tO~`Rf?p=1N9JcBx0YOm?8ZKa)NIil z>dir262)Ntac|`-9+8%FNaN$D|5b5hQ5gYSPTw)hv<4k+wf_FoSQhA+ier=yaM2|r zW%sYVUnIPwae1P}fU=*)(!R#OHSh2{!awbYmGmNpP0w1aF}X^|qdMNuxPK+AE_BU=cXpk|oj9fm zv&SSIL%UnJ^_FaAJ!CUO59@p3rS9WpD3<_K2h}j)bzaDo1HXUGz;WZ^a651o>5$|Vd{Q@ zW$2ph8#8V0IMeUN1A$Bm4`vmQZ6jZRu%WyBu>BPaa7O#wl3s1I%F>P+w)JP87dz^2 z)ft(|zBS^JEA@;!br1W|zoO6Y>-b#9&d~9h=03IMo|f+Ph|cU`zcY}9D)xKUceLe0 z@#;N#)&;EZ!j%ifW3pY9yrpB0@h|)eAKMXp)^Dm^Q%3EY6}tCm-&W4}1A}#(nj|Hk za$gYt9mvo6&hQJH6gonO2u=8&IiT~0>ffuuJd!TO{9vwV{^)%lsC|!g$SI#go@DsF zwf!s`MN#XsSNmt%xR9TF)y7ly1Km=(lw^aQ@;i_>chVT;0cx!d<398f4u2(DuP07} zwX4mLb-yGZ*y^HYt@*Y0cQ(?xqgoXw!E+k7OEqt<*WCM?o0ilvyZD8!K6DtZRl`2IlEEJ|ez|egK*Qjm z@1jLc>F##JHyl$F4;F3|u9B85?3S$J!`I?yjw0KL*3+ zCK+9zjn+nFtJ>fp_w3TT@#oDwZEg^2=KJm28=Ql=S@}Eq6JQZ|VAz&bqB?0YSfan- zmEd4~2^}$d2={Uw{&0AbIZJ!Er}A?v{|&Fgljb`Yf5M}D4)`>DEpeR84KSvv4UFd) ze@o^$N&4G@MI+tg*Bs@(c;M&G{q?_OLp|Q+Yvs16&AN|v@;;7AYk~R$olK6%Et6bY zI;S=W;~o!VlKJi{)-Zfz@J=Mh+;TPbeNFd!eezA| zFXT=WS47-FEL|%7t#!+<8y=g$i0C1_@?%r!KBHg2Q_vMU!xy}dxGm&mYI+@Gdx)=e zXO3H6HnV%KOxGHyxDLr?7fmk|-GA&J+IFn$VVyN+iLZ!n?*i}U zsLjm=Q>!GxR~k z==gYfBr+b%(eBDqdf}GV5o{JN*HXtc3{xEPOSd(ZOyAe75azF4G1T34d8TSt{=uGG zQ~tT}uxx^lU44u@f67#&Gvn_29PbRqcwS<@`aH9E*ZS|cjB%!?pZcSQua6%5 zt^F4){{Y@JJx=q2wFI8T|9z5j$&S`_JSW^n@Pm8MwT{&@sbh0)(PY&I$lbV!XozGN^1l2+3XdiH?kMD=cz>Jlw-y>OYJ`K6MSmmA@5Zluk?!* z=Bue|Osw^ZIu6&jSACe%75_QFT_L%Xypyji&qg|<_%hys-tvWf@6`1oM;h8z#qO%> zS(xUYe$jPJ{fhlP{I}+t_Wa%`Oxhs5VWk^XFw0Gtsk&ZEv)nbsecS``(rt~^FRe$6XZX;VqL18rc~|)-FSfC)=!@tLe#n;Q z+rm1xZR6>+!ZP;8eErT8*X_Kuw$61sZ;j^MbghY7gr%~*J(@Td09u!??Qgb!u&nuz za?7!LU9qp^S|-9kWU|-(oa(xckgYAk_onw`m)!5`XksJMnzF;zbzxUk-6A4?=>A}w zg16r?rg1I#y~KB?Yh0P%9PktM+ptw^UDsdFQVt7v zAA^&DEO(%L;nrrZNWKU3ckqCD8E&Kh%(zlB28_X$OZ}ieqgUxYD`ZbxYwIyFay+Ag z2ZCo&6Z6dRb2auSxI4G>kbKk0{qwda?xpQVxEFPB{-JtrOO_0GJ;Y1&#rKUfZ9Xcu#Q69M&COT0Hw>O3StS-H0xat;{0j6Gazchr znqfAgf2kku$+q#~y@v_|4|T6fw%?((c)_9(hRe)>Fnz!?YHmu_uQn&HLHfAGO;4Uz ziO(2o;sKeH@vx?*@94+hZ*1#EDOZqq4#pN9Le}djemGZsdiW~*W5mE#=Z)R=li z>tB{+9O%GW6{cr(pXoo?Py3-qdt@omo`XFnkz4$4tXV#99o{@fu~BOk+wkh28@Ug) zUhh(Dm5sIG619qg{AIKGs-2r9cimWeg8N*Ui`)s{n+y{(ADAEX(d63)e<4|IAmb99 z|FQj{-M4K`7nap#{}S1f6iYlzG^1ah4$PSx;pbP9`4h#@f@Sw!-bKENa+A$Y8okUt zubL&uYl(1-@9FDjipxDiaS6;r`hm=)^V)R9jADnRt_pHmxR1VVejKQ?a&%;jj?NXP znQR%1pN)~ml(m}cJ8O*QYA^RU??|!nh{c}p-{2Vi=r{IK^(+2b=;feEv+~?$_y01g zbJ`edOo>BAch3-Bg9qSkxG(-Q?SsF`bsw)hxCtGs*^3i%pTpv4+`3|}<@2P!6{R6O&F=LFg3g=n<NTe4@`bNA)ltY)c=zn&Q6?z{46$$F=m9ynn9!jL>2*cduVhn&6Oe61POn5aIsd=If*x~3-mBs{-7 zroqqjA0CPA53=@-ZKA#C7+V{oy1(%iEW9MwH5qhy^qI`D6Qy%}aQE*M`ZbZg{-rtJ zPP{sB{CxQ}o7IS89^>HG+4D!+Jhy(BUAg2{$x`mOKjkj>HXeDxT^HTY$z{l@yr^T`jKIqyQdZ*SFVFn%M)SMTH9$?;WzBfMbG>`~ z2lDrIke)8PiEtFUo3Ee!wT6}*5rb#nOGzJpV`JH#{rGTZF3(yps@C+R-Jb~`hN^xR za##47)qPgXjp`b&)>u~E69fBA%QKd{#yzIHW_=e{dM0C!{o>LkIg+C^2bmk1hl%vO zSgf&nqRbuf%{$U1mP$?_2gu|H>08)=9=rNzn_IE>e%-%m;~uSf)RAF+disFPorafa z&2C$#TC?tnAG(#xhTD3;Gnu2vd3SHgR6i2Oh=EPeuDaL@k6+<4HnW#x(;-)$w)=kg zGk#sBFJljuF#g+B3!Aa`V}kzjigdeh zt#B}_h4L;MWE8q1x{P;6bRO?gx=%K2^ESMI_8U!Ju4x_S{p=C2O};T?xmcOU3=uXE&D}FWp}DAaaq! z&t^N*-eO@aYn+~cc!P}bA2#hfFREX1ZELNex0D}mG_I*_;osr6o3u`{276vk_6%QE zxfcFAU2$05r^(khyVCEBIkB0hXXw50?6#h_lR29mLeF{Znj__NT&#I19arx-QL#g; zxwfvxv4bV^>_peV|M+O}Z7?_JKl7>U$o1~!?afrDF}b+^u-@q&Kgg{JVHwY4Z7Pur zSQD0oF)G>5VDgu;Go4c~zlt1=-SV`tOWe~prr8=BE0=_MCz;P)_qaoL@jlZ1pcQoM zDy;m+O~QU`K&)yFl>w{rvWqd;3qORX%D+al<@)o%+!`E3}*trwtxce^eZtaYf zMUX)@s#d(W(~p@tRefQ8SAKRfbowT)p}pX8&cxX!ryzISQhr>mFajLIPccEZ$>UUe zu3h#9i_y-TR%Ci8?}()fec2=Iqi(fd^CR|wcf)%#3&+k$QM{(|$fH=sSRNyP?muNS zfj5$+3)l_qeOwjl1V3)ziLI0pXHsOD;E=zX` z<5V)A!LpUhbE9$@&x8l2TmFycdV;u&uk$@~cdq1k)@wgT;25^5S8s2mG1`0jlF0~) zwO_29I^F>vA)Dbx@?(U~iCzJ}(H?jonGEdmI974acdZAmu4K3H_kdw7PFvtw4OkZa zo%g{Lf8Nx?@HuvVFkhd%zJu$hy`7rN-$0CBkCAI^AC53|LHSr`O9@3-O)Lsi)ar{V^@roHRH7toqwCw7h*-4 zi6;2U`^d+1pY-{UWy=cg`H6hae=_@X_!)cjUi^sYOy2im`8J_F7aC*~Y-reRqVkS_>ya@tcx*t$Fs35+<&FUS!-*cfP}B42 zKR%4tZa>0&Mak;9-1pJFio4go8{Q^>{cnTf=#!264`UoTHRT&lHe0qI1L_H7O_(A5 zv8t`CCJe*(naKa??}cu}7eO!H8LTyHOi$X|a}n$(ZkG83FCfQkUK@$$jjU--x_kc2 zN#d)ZJ@B@2j9r7Sg_Yzo@GM2Su;lrBJ=16=3?uI#wOfI5W%I?86>+=R=U2O>a-L@(?u9*gM%^Bf;}JbN!=ZZ>|shj&E}ja5y) zM#hx72kf`Tngh=+l^u?;s|lBQ_Lqvam@GM%wS)RvLB35@|5`juWUN;&A8LK0kBq^& z+LwwLi=BFQ7^`af43=%)*ryVf5i5A2;^p3xU#~XyFlv(Rdf;cOho%}k)zmQ~cH6f$}J@$F|Y~aoCT#Nk- zhCVI~y!VPs!_(N`6aCG7HHXeWq!D>#*(!_N-fZmT;wluj!xJKE#_IZ^#Sz z@ZR5OFS=G*chg<*>a&Ia7g-!Vwqx*&_5Nh#Nqlh6AFJ5M;AQ;I>@%@y=}_efoNIe> zZk5gXui8hAIGZrPhcN}&h?-azP78PlJ{mt`l6dTA#)IK&<9!B;u2kG0akI1$8r&a^ z7YNqXc=!45nA`a0kCwbiKfwd~%o<-?n;BTPDF(~X@xj>VZ*G#%m+56Je+HjEkj-bJ z)}ig_Q`N+pQ6qzxFN*;c?dC6{rb<=*Vcfa)Y4sJK>Et=16#p_pdwLGg7SiTQ#F$1!+%0L zTbNeNhim1>^zo%zWPhkmN9TFOl%FYmkGNRYRF93mZHdmbY5t-MT#Lb%tF}7+lL{Fz z(LG=fYX|$@GEcCFJZE@Yb-Z~7xIhd?8_6W9-68%C>aX-TZCp#>C^4C|K0}NcWc!bGC%oFSY_(h>##dYy9iS?GfV%d+t`@WDD zMi))B^=g;Kspe+{@-_Jbtu*G$oi<@~5gFUTFOy?~pv5mlfL)Z%k<`acW>sm=_I~^j$0T z&GdYS&nv83vW8T;Ue|goV@%PlSTDo<@}J?!J4Ii{4IJ}FD`D=0i}NL$D8^pbU^lu! zSOpDQsNdIaJk`GU&!Nugziw?VOq5+o{9btRc-@m2V~~@cR9`LMNo(QL-v2GW^Uq9l zradK!gGwEAg~c>kEgbQ4qU-(l+;^Q~S3KU9DF=b?{O{p&@Q%}6(?P@;2Uy0rrR-&6 zg@><4VxD(C^mEJQ`!N?0wD2lcZmuXD}{7uKvc}iYqH2K0q$P>U0&l>Pg%^UDK zj1Tk~`4hhJwYNOoTBxSrX|luOFO28wgx1?s2L#<8nTqz>o*0_X;ddnZ44>VjxL|K9 zg2wc_vv~1^ThR|Hw>9B&)Q))z&oeyb8SwE6>@u~A{nt7uEW1^56#en@kTde}M#(DX zD~W?i9;d+GKX2-7IgsFbpr0<6jCN>T{gnPMSB@8W#5;%=jmOtu&RX_Zkt`C}MUg?_ zZQ8cUot?MPe1BnG%<}^8Sf|)Q<_>&74#z`RDPA+-7zsCJUmv5n!rC0BL-1L1N%k<_ z?|);=;4f_M*ckZR{|3I1m+-WB5j(VRSNKeyuPZ)DJQ(Pg9?LkxmuJXEJV$v{7fzjQ zIEKu|8hdq2zB8ErsdTba?+F|IB+!*PLw_&sqHkTCTl7`@a%%QQJEnUH#<^wRjyCzD!Hszk=BrkF*Vtz4p@f$0Nvm6 zzqCHX2goUBibp@&@jI<&TJME9%q4gb-i9Xe><*sZT)S>nFiy-Xa&g!bn0|RoK+k_& zxm-QZTP>MJ>#F+V4{+@$*@z!iJ{0fv_xLm8_OO1#4$1s#tM*>KAy_BhDFWjbnSe|q0A9PSIf%S7JT`m|+sJGUQ%u)i zu06)xv8B6g4U-Mmd|np3cYZ|9PNcuV)AwxcuK6h2bVx4qpIeJQ_%x{pXK_-x2EEJY zE_j~jOujyO{ous$io0YV_IMc2wa9q|7Y8wl$n@-uYI_+xUS?l>${(q;d5(YI@r}xIOe}^tIrQBUnf>Z2QLOs zoT_;q@#!cxPByd2DVh2ImhC@|j;Wlm<+6EeZiU;P%xCUl?|N^iKtAhq?m9O_SbEX) zA~$#Oa96T=fY$xv-IL1GdP#ZO@5%NB4_1ACpqHOtRAlR9fU&Ikl`#ogty67h^h!?) ze}->LsaX?qk70*+{bl(d$RURZuv2vs-@kZkE6v&DWGV9}*qF}MSXAU$Fjv5i$+M)B z2(!a;EYWAKds22i(~DTkSqGF)^u>d+4YTIqi%H@D%WjDym+?G!@2dxXn$V7qzWCy; zjYNkHPW4Hn^B>xiPZWz~{7s%)dtn6_oUc4Y=2q-j^4&DqKG7*#%g@wM{=^ol-v)mm zn*`WYRYw7jp1HBLWW*p}9&DK>yBsmbiEN)?`f@+dM%MD!9E)juPtGoRweXT1qVo%? zsZpT%58xPnpsQ=B;l~~_#94Gxy$5Xm9>WryTWh`^FMXUiv{(#4#wk=y1F(!5A^65) zb#`cstVYZiwJ{i9(}P5-*A-8I4LEijV*iFd#2ewOLEi15cunjB^dF2r~ao;a;4mI=pX`;UWV zn-wcGx(X)xwpDlDrMW;Z?#aq0!gd1R7{BT>ayxSZc?H`|n)ttq@`$%@>SJ+1vCn0E z-xJpNR;>>79PH^P8;IXLzrxQul`}m|bJY7tJYA?+Gj94sU5ov`LXP8J=!=bueK2U3 zwKIZc|Dv``EwJq49lvsY##~xu?T5Fh1^=1q7R0{aw?BMFM}Pf}MlSQbAf^T0I!=2U zy>+MJkn~$JIL0+#89qevv%|I@Xn34>B$2L&jAnHiMe|ca@gdNL`Ody~pNeMTeN3pm zv0-IIZq~fpCOsc42#+P>_`cSwJ{rf?8pCFN=d14ILYF2#6xcRJc#j+sEAKEy+;_HY zmtN;1hv}^(a>_kjy+4TBo#3I>Zqj&TZv&%ve|ORQCdHLAul;?Ti4~Zux*Xg?e1G6i ztguCg`{+OK5oXWPo_k|3Cs!g7aOvcerzGrFz`dm!>m<2QQ>x5;r zow3=W*e_(9SXsrdiL?c~!gAFc+?gP@8QdqY-fCM2_c9f4_=eUSWCzc4%mH#Cx}AqT zutL8?UOiE9c;vLk+N;17a^Q#^_41>~GT!x%8&!`rhOhnmV$X&@w>OUBkMAF6c%!rA z8}fUS^C8GiqCG@Tx$qJjEABs5_y0?>Yi)d)@W4ac(v2^}SjO|PGhx%OZjYut8pGj} zrrBKg{oy&-mY=vrKDVgvKzv^QG@W*Pe<$dE<^hRiP2@L-u;@&Of?iM?llSz6Vd2s}4}?n&NRK ze1?W^+|SE^#6#ih;(dmu_bUbj86$Wn_N|Ioh44MlfoQlBs_XG0Hub=;%gMGw<^(y{6tMGA}j2Y2aX;1JR)w;f^rRHKS{w?9wdVE4f(r(%vuc|G66?-z(#qDSIVx?eLr* zL(Z&8f4#P?>md5HWiCsvWZfY~ho=ap|SQg{d{i z{e@}HSTVo%$d~$=*7x0#*X?h8AHI&y_=w(9ot_gEGYy{PPMWH*uH3KKHv7NnFE+zb zio0s9d%-mCo5MfSLF@92xfd!oQ@#|v+u!HUydNAtGjG1(_^D%;S&grF^MpPpC?B$kRiv^J?(#B_n;6SSTBm#ZJZW5behgh>x}-aZBQ5^FQa5e3q88z6ExF!!zlb z_^3UWfqA{P2S#=F#zeFUe^0;g@ov7XzieewY_GC0vY&30z3df@bs+mB#!BulSv|<; zi>x?W`XaJ-nD1DZ-V|16jMSbP5v*?^yV+`LKnb(L*YX+O#pj59z+(@(7xq%aL-ifo z^44|oF^hJw_s9MXFMKH5ckj_ltLT_u2lIc;inHy#vG>OQ4L0D{IB)XBQF#_S&yFi2 zzUd@vWu{|_Zi%oA{eI(0^qK&V;^7&;ZPL2VybJI&u$zIe=LomHknCu=0BY|i_x)1# z1l6MymYt$F=MV3d4jRLU7F#LXD0Y9tGGsE%nG(eh#^Zgy`?GBQ;d)4IHAdtC`Y~dS zC|gU+V$EX|OJ~++#tnK`{mrkD2djo%L)pFpKV5<9^58QG^LKTh!5Hx9PQ?{W6K;)E z-17yJ2Nzv3!fLO8i`Zl0Jp+7uRduhZg9eU{kbD-ztyi5Z;KS25cC;8}k7d}!vnNj1 zJyoxdeINF=PvkQ_b6lVcpm%3$&xo%SA5js*8qb!Eo#sc%Pt)9!eGn|0v+zRkRs25r z_tH1|@>j|4E0zti7#HGP*2};C>`k)m=>Ay#@%J)!v3=sphA&Mf%Px75{i1|pAA)5K zGV)yW)7XbF?6<;?&`Hm(S=RLLig%`6!CEM~Di5B1@OQlRDE5AMdZ}t#!uQOXC9UD6U4-l(&-1)MX36qdh@}^G^J>-v$nQx2{JdF*@j}haatNHbX_C2OvySL+` z^AZD5(->8ybA>FN=r^$F-?ycz4()ow6Y`B}gJtkCeWPtQKcy1~ynm4Xu3lb(2KQc( zVQVUD;bP%mJj~}ECL77#6_(4Oo8=(h`-g-&kDqI_k(x?569V5A_nszO>4%D0jVA~C z`#6JT=)OH=hXl)}&4otE$gb%8qJz;!_#hpK&-5ky{MgUPG3;OC=Z57lX@4|oWu$Z+ ze;@j#^2=S5J~J!D3_`=z*d_Ij*k{)D@7n6CjNk0}=SQ(@!NQT&o>=}f%u}tN)PY+y zUsjs^1G?o^z(wI`0A8SFpaQZf+v{FSi~+E|{b=;g7jm#_?)o^Cd!s&X0p!hD`8KW4*$ zSE#o8Qj7JA@l zZ&0i1Wz{aPS!N(M{l{*sbRKjc?(K$MS~j>u@{xbP$Fd#~ESoaBFi9+nFX#E^#yiuG zS5@zcm>;iCncY9DbR<~TFf)H{!)_A-`#-V&p?a;@CI%^v0y(+17!jAniayb z`3bO$eiHvpeK_))WBEE5lb#EPF_zou zv!4TUyAG8cyIONR979*? zp1M(X)+F$ku_&Bv}EJH49A{xzEsMy6Cbj-TYgnRHQY*4H;YbpE~ z(IG$b^%zsSPB?+M|G)$x_8WajB$t5=*alv@ zty!SARKg47*@KlglcTZPYI>mgrR0+c_8O=xzrh>e*<97gW?e+C0?(?G&)|jGi*k+U z!}FfcevSOM+7>G-#$pG>4*d@E1ZyRF#>!>c5t&$f z4rr{X6HJZdSUU%J#yq0_X0YazTg}A>xj@;5jzM)DZ^(nEWWkT;UZ#ue_* z*ZItxy}slG>lgetn|i3#=%j{y+SBe-vvSb9yWDyY@WOx zU8VYY<R-xVJ8fA8o2!jzzKu`86lrd+Pcf{6wvD{1d*9k=pBxCV0?hU^m48it4BBZYdSca^byuAz_d;PA%T<4IVKHMf^f$o%lxO$t}fo|&D3k=W0 z_wu=g>J)5Ur?~rw&NodyPv$#qC5D_aN;J0da1M;Wx$Fe(HK0ASHIGiy7_D5ErPzi) z=^gRslgBfkLyLSyP4*qyC#xnphiP8jXJ}5`H*y)+K;7&_?Mc+%+I){}iVtr<#129Z zHT5WBb@A{sp~Dx-wHaKX8f#j2{aAtV*A-XJ0Sez2{>*qST!dX(F(evaWSGaVt=U#i zyPlE#89!z-<)&{~Bc4!BfB4yZ<1^!VNyKg*^pE{T%XcZhCEb8b|D~nn{I_uI@u;5Z z)G}iE_~PMq3j-170G2otSHMLi||7iC}N9jt9fPVW)aR`*Pi-I;8AD z^NDYGXwll;@Zr344tg^aZ@$o0oI8&GKv8#`@ylmz!wK9S+s@{%ldYAZNw&GcXF=Ahh z4JLEeBm;YzS9eD4Bo6~Q1)9weX5%+a+>grgW^J#d&+A2VpRYYdadgP5H9d#*dhCn> zjX?$fF>Yn6HO2|zy~59ge<#j~=$PVH;>Gaw!vo>#Vn1`=y{eJR8rDkd+l`VZlX+k4 zbE^BBcRZ-rE^H0n9*9iVKD+q31B!~i@3D-tYB4Tp*nN`endZ+tbwO0mgnzLIlAlXW zCDwrI-n+MdGu&5PC-I%wd9mxWpB^|<9S_F-Mhw5n5IWZe2caWzu3cnD1xrs*&Ka_9 z?EAr}yDwKRx5hL&=am!cKf{~X7Lz|%y?vUteX4k^lNBp#c@Cogky`Vfy|uC0FS~P+ zwttUh;rL1478_IX{0!OQEw>>NmT4Z}p?CtH_ZGgNHI91puPJ7Mxc|Q^-hvz!FfMDt zEUf`Q)A-bmSMa?;AHyKlkr+KR(cjFS=Or5umyc}LTRA~*C@&y(jAD5rnZJXzJQ#;@@>sncKQ0gfjp;t0gDw(AV=4QF3hXfZcj1Wpnd~*pbM_!*4^M2+taIg&c<9(?ATvFAgZ5*SF6ntGoU6~h#qzz?gk@k5`AXg8 zI|DBaGi0lKg}nx9fo0^K?7^Wn2^(o2_Is-_`=HjRgjjZv`^OE6LDo9r*TZPv z^bB;E>n$GQ2Nu6P0NYDv_U7vkNAzDi9*WJLPJ{H5j{@=fd*)%9<5rt4MP zhJ10JZ*|%BvTPR2*@m`xb*zdTmeC^ql+wec&p?$(FpwUboY1$mMvY9T_cu(pU-Lk zjbkIZanuj6TCmz{uQvIZVA*?W|4HPrR`P8HSZ2Oe?W4`!afxco@;xzOz2!%X_YB4& zpZHPH1DSWt@}QmoYx{yl!~xb;&#aw(h8zcuu@5b60RyPDMvm>?kjWTh_<)#EYDTsb z9T{76od>pQJxxM)OOC&ZCqGQJ7nDz|ez0Z_(O$a5%p|J^LF>CNKemz#oh+6id$RvP zKgkQ&)dSldw+K6 zZAXpS`onlw#&-=e^2eo09t&hMhv-%ku`csPGWyA#y0jIcmclt=$^xr-&>I<)=qUX z+eK=`gTpiC6Yp5Pj>+74NPFJ0rz$)J%?C)o`SKyEJx2H7Wwr%*te?g@mTSAJopZJ z2YZQAmj_;lFR11EjP^N2j*1O(#J%i_fWeb-`7pTD&<Tbxj$X; zX<#)nc&BqOb1&acj%;FGpZlnx%UFvDbj} z)c+kue1P81+BH$R%&Mk^t zi{^e_7yw!v469E z5m!!3{3+Up+0zM{vo|Ms<8RBJ$+$2+tTTShsy`Di8sus^-NU}5Gv-`8_mY*Le1G6u@P~e|M^5-1JbUDnnet~RwmC8Q&R)Zf3pv`>xi3f~|8 z4E=Z>^<=OSP)~t%+|%3kn9nVHFD++N$Les*|JI=E_=_5L3w!|JndJhUI4k-*|6FXr z$SKsugRkJPaJy>z89#JQya2t~cL#q7HMOvtE!W;9AK&+T(clMl)+tP;0+Ym7FKK;5 zf5jio+6zyeCVu^!_6Fk}QC^qb3jLG1D2p%2wLF53vXe2d{Mv1_!uB7r|HG@JwYSV3 z{3qBa#0&ngI1JIi@KO8ptWf@fpQGTy+=UU}S(0{tunZaQQ}M+B)q(S`5lGnh4X4mo&W411Tfwc04iY@Jlwk{ZgaL-1)` zG0pfqGDiPY?Ekd67g@cIFt5`V<}i8a*!~wOKlusm?}JT%b%6KVVb5W_gLQ~;rR~JQ zkPCjD_6Zw3ZAyS)qP@q3*naaj>m2id{UPy-)znA$Jb3ScmTNh8;V9(=^w8e!$meSB+jkwIddsb?rW!FZXQ(bmhn$MNqTrp$vkR>M&_4D6 zPYqL__+Pg{_`z86e)xr4G|LOoHHqdk^I?K&cjMnpmrXa=hd%N3jH93HoN13A2kN)7 z-|3Kod7^6!-Q`1WpSx*KT2AR8k5x6Df8FDvgM?v^u)mzwHNmrHr_Qe=o6%omx_MKE~VIN>IE>z{qM17eq%qWi|1cxu|BNB^!W_s!*1Kq*L;i7 zHA=h*E`U?9hv5ZlyYcpcmWPJ#Xtrv#5f97wgGbDhvC>~YR6d&%zEGbSf96f4$1CP+ ztoc>Y0~vp=t%PB^pZtBx)7PG!&3W%ME+u`%z;Cqw5 zB4b3n)gy}6o~fE(DA|G-YlaBp=pq-CtFcA9)p7-})gMh1>3*dAf29u3CSJ+qV8>aAL{U?FX0ENxDP=s-X6l-K)_>c73GT07W2gX51@i{UlZVWz$#bs0v; zzvX!jY&}DK!@kMTzM?Oo^+59WJF>O*k{k$@p@&nCyt+Bevp&;)2cO^nTk-qv#1DsQ z&zAO9_xx<-QU`Gzm2sW1?T}OMTAgv}r8VJK?C*-tI7a*aermC^k=ka|YHY4Jjlf4& zL3`#e<3X+*{L9`6=vy{^@F8C(PjnP7yV#el4p{b?^03dbTBGshGB7w> zd7|i4ABkR%C{Js}(qZy(%(l1y^ajQ^OqbYs$KTPqf5JlcpCe{vxawPiC+I7@hxrEI z7s@t3tww5`QFD&^3|~C(E7PZt->7l_p4#${o6;oj^iodD`Br#cG?8Rou03n`&r_jVUiI?xje;wkqgy9*yHKq?~iw;Ey$SRgSMhKf>E>= z+E(E~wZ%V=->41DJ|C5j6_#U44GueGC+iTpkNe?4>dI4llQCPfVwk(Wtf%lgUA5*r z$)<9od_BW#tzv9zs<(>_w|vP+#Xv80XN_O1T1J;xzF~XQX99V^w>x?^TfO4?PM&>r z$^j|=8;e!R{M{fke{5Jb^Y*i*$_cRjPDA6!d!Z@(04AIzKhpGh=WBnkv)%1lr|#X> z(cQD{NIR~R9f)}QJk?O9rWxxdGB7MV)ft;c%HGZe3aXq3wSd$M|3^=J3puW_3+u%N-jgjk-uPgD1RWzBN4u( zJzZ5NX`*VnlKbc7Op6K7Z?V@$|Be}d#@_svTDQh8&`J_48yO8Y2Z$jsEi9*aKbzFZ~hkJ=B;B`V;hpaidN#^Oky9=w-}1#xdAuJh7hu zd3=_1s>XvZw>gKdkPwUMhmJM_*SN;Li*7l*_28c*gIn>hao=m0k-y5v&xZBQM!lz6 z&BnmL8B4cd4Yv8Oeh2fFx$BRBkHH*2uF#rzq`xZ%Hd(tHcI`b6|GY}hh93{c0J(~H zfIR?tv=KdxJuBXq4o;uzf@QfDGZZ7Yhu+J3!sAh;uUs4M?@-xf2P`wp_Oc0dWiLJO z3)>%fW;&~|?PclZm#r9Ndna4mcI4fRJM+ko5j+x%Q!qcOjFHCF=LzFqM@EwG-LQok zeBexKkI7cIioJa4haaO#F@KTwSLtV{kF3|N&RSvle5u_h+n(k@oj+>*k?WUlez8_( zuMFg~+VGBlf8>32SmKDzv9fk^b--v}k_vT-Pvj{PlnAbnZ{%V^s3r9-dzG1L>KU$Ko0K zrgTt~H`2t{o|bXjmjvCQM`vOKZVqBB;>lvM-(gpwj#X^_8Er6rV5}3qJBAN*U7JCw zWhUOOdXK+0m`6ODn!fN%%l=EOMpCM5i{KXc)u`KKuoc%R3B*-zs=3`Oo5S z*>^btUJcq>-CBUXv=8=D?A@{f#m-g#H+H8rsu7HwQ;9arDbcR2<`i;v(>^maj|yFC z#zo5xJ!(wC7_#J%EV%M_ClEtBezlDwx#!+~##!;S><>)+Mq3AMtbE^-Ul*9SnIoyQ zRC9e1PZ#De`&18*KEhh=X#-C(#ja{jsK(0!&uLe(E=JR z5>_g|Uv1-A)bEWRXG+EqF18)AKH3lF`#|l(;-35;9secYgKUgXV1Fd;iQ13UFZ`+1 zV)|VA_NS_6@sVm#ejwZGYqvL%FQ%#GBmPtIPa}$`TUQZJL5z*X*+ekN(=NI$!dsgA z$R*8AnJ*bX(qHw(%bO;9iUzC!UN(bAms{=ZK+g>OMfps;%c~ZPRJD${(HczghvpJI zh1>%kp|dyC_<&uK#a`Dw6EqOUr{b+pr48ub3 zkfSm4hW?3ZR zU>!U`>!5Ho=(}Rl=&R;MrNh>iV0?Xl(6^z*o64WVw(s$(x--{N^YT>o3DUaY-vv$} zBOxm_(wKug@M`qX7-7e|qfbLt@d-P4+} zK&G^{CpTEP`HpqCjd<2@L-I_ja&sH1P3oUZm248}%d5(ByDk;%i1ew2aK_{twV5@A z+Sy-5YG=n{8GrAR9x_7p@6jiHn|OC4-l=&E-lX=_ncQIGwE&Y$KFTcoQarekx-KEU z6>k>w5zgGCHtn=_nh!n(*P=8J<~|q~9PqK;VR#tmlHv*FzZ8!9Q)c0>L+`PV4KfQ( z7XCcfFoE7_*eQN88=m?AUU8t?RLmXm9P(b*{Kxd}9Uhmg9o!o^D%wa}E57%*2d2`F z$o;$Qd-|ert9-BTYvOZ&`;~FgKLd=nwLtR$oNXjb1>^jiPMq@GoEd81(2j^c4I2sGTGUdvx7X zIzBT@({G8d7hjtERrtAR{)p%>HzlK>OH0MD#G`Y=%)IXKSnyo&0+`A3D;=Tl#4oG? zhWn8*4(wR?5%FDZHUE{_kZnIy?2nc0fY6Zx-U=U{XY3roGISecD&)bY(vcd8PidR2 z>uM`~wf<%nzMGm^c%y3EjZW>Be?-IXg{{@EFRdSY$K?IUKQrE$m~zozj@tNE@ND6d z#;*cPXn%ky72o;(aP5TWQ@R!8^B!T;xW>I^1eipd5*@zXI*T4(3cp{|`=$HlFV=c< zigZhh3pJjD?~*;hL&N@pU4~h_NB2Viind4k6Twr{hb6Cvv8?m(jmjUX-rh|N)UD+` z&FAKM2HjPDlvh*J^VXzxozNj3y}zmNOy|tZA0c}Fjddo#HToUGG(LNI!_IjoyZP^s z<64HWj98XaE?THq4&~@n6JHjV(-O&LZ3eE6&O<*RS*siAK)w(Ud@5dlG_`BtLa-<` zz33O3CvT;8mkg$H435b4jC0q5FEp3`p=-D3-rUrT@vYL+i~e6t^iAnDsg35x`#LmF z3U*7z0XOx0o(YE8-#hgkhuT#Y%PPjZVh#J+-+^V)e~j0eZxNga-=Pt06K!75{3vah zQ8?fT>C551rlqa=Z?N2GY5j@pLl{|?khhjB9;sNH4vKs1qS%X5wEwbV5*D4O7_ST6 zsHqbqLuzkd;jQlrYZ~%&YA>yG%t6sa^XL`v)U^$|7LJOM!@|vp``Kz(WsGlzY^-sc zsyVt*bMso^+-<>8cs<`~3}z_L7cUi-N+I-3#!`Gf5zXL4WuG(E~BK8i$!mN@vn)hGQz|-SDac-7A;$X=zr;6{& z1HRLIWS*KVt+U}ASQp@(=`5x*1en)Kb|WvBfo1*2&sC0U5C@-#7UA#XVHvbhJl!hU z@h;YwT&A{Nsd-nd^P+}bCtSq(h5VY*dsI{xJm7$$?`!O)XbxS$^%~F3sTqY!HI@@3 z@Ahxdqp*3i^rC}nOJne^v3Olr(4tZIf@Adl&T3P4n_pe?d%(l+q;%7@;9II_1IBp% z@bkRl%-q)jX2cwUjn?}nBKBVNN7Er=uGe?i|AKdVS+n4?)Qp0M)xNpo`sDom+f_REZJOVKZp}2&Ke(8GoMcU<*Jl|@-(upbQd8cVS z+R8>%X|C3m{`>g)?}7QkUhU6Vm?iw3pmCn8<3i!r+2Xs7&3b;b{ej<7)5rco?KmXa z1D(R=Ld@EHc>3s{&}L!XVCIJUwMKLNavk^TZ(IKwOV0}PDs|%?y@ovW#JQOKMh$a| z?SoH<9m^{IcUsQYL-z4_C45~mU9Y)7B+SjJkOJAvG@iagmcZpHfymc6Z*W8xLCJ=)w5Z93+ZWh89qe)vP9ZUyrq zx?F%|!W!#~*}(B91$KJ;0(QtAPP|iF;ZYm>2s-c~wB$HLxrx#l@lmumO?!OnXnx8( zt9OFW0zJR!$@8#FeI|_mhvdvs$zWNHGV&TFBWrr{X$+5&toju)9I`fc`AU2(K4q;A z<5hK^+Ygt%nN_;OKfnIGe^P+87uge89=~aL%<)y-s~FOnu3~*Xs8V zly94TMCb7>yl<{96k#nF7XBsBGv#NIEFSoOYrwB6@}!p`%@6(Ak%QMCUYGXN-?MKh zV1DCF+10=@+3WrMWt}39^ro_tEH5yg?7?@$jy|nD4v+G+@Zg8+(vMXW?sxm92Yc@= z$|cZ#Pl5iK7K%S0AERJquzznNI>dgDT=w00 zFZz;3J*EkFuw4Z{2lG>4L)PCF{s@mtI!7=|vKD@YFC-(qr}H~HWG^qkZu_i0|4qkZ z`t5efPq*ouU42Vx_bc`kJ%5*uKc9-I6~ zOpNTQ8RMThEN%3+PS2YjV$-S;Hbv( zD{#PL*q*WdVz&+SNB6yNvfsQz?R^Sdjbc+sudO0m#>kU~$N0uFCwwS>%(u!e@J-Tn ze|~nO?s>lxmc3zEru8X2hrzN{s!322mc4%GA3}TSSiJx4Z=3wV7|B+%4J;$qB1{MJ z{#UFRn2-*{_*;!7U#CYgchrn{Mf(|a)}DNAy?-yeYAmG_X@yU+e+ zpC+E3Z+d1}zcsx!@Q)&2HuAA99`lH2?OO1O@b6XO*;B+se6y{rfBN2{0KQn{e(e9m zhz2&&!0!f@En1wLa1MK2iW)V?YwscAAbnm``(dS-d#jE6<~iC%KNBx-~iQ{zCd+p6yxG;GJ(AM zEyS{YL;Y{!E#x`~k3N5?B? zH0Uwm55)B)iZlKu+FJk2uTKGDlZ0i@Sqz~3P?jec%sb1moILNm8nNs>VOh9lJ8>Bu zhLs%u^;@?upHTFD#bw+Jmf-^-m(=4BHF~zJJ>9*h8Vi5dUJ2Vb_i!cpd(HyIR!*7X z`i)!cx+^D#xFzcJum+I(7tX_s*dae@H}tYb`?6R6m)}K9D)Agmx=uJudg9M3$L;-J zrp$M=@7jk_aaVt_{40xxR4tMymTh+9RX2(~I=vkz_KbeTo-)+k^0h%#D^@WYrF+dM zwJ#{I_{$$iE_+hAuG$haqBsVg5sTDYHTu{CqoZ6iE%v$i znLFF+K?HG>#1;z6&i*#h&-Sd#%zsvRW_9d*oUE74h!NwU?wJ3s`m?SReg!e_l2a8A z&^Bx1do2bm|Jt>VzD;zkZ)-gT_9X>`Ww(;ggiI2ykwR{8uJ#pj!ZK>4Q^BQc?>dobd1V*f|(%RYSFcct_$`mu2A4dU#Yo-`|n zL-Mw+>dqm&GWz^r&xZJq5mv6j0v$3b0JMnXZNMe=Er()#+Dpe=BtzM_eI$S@EoI6D=BL z7Pb`Td~R}-Fv`nU)Lb?BN*GmvS>P4*Gy=S`_}WnY4LxIzj<WaAF(*cG}~xPD8;Z|GfZtp>E}JD+(;(tBR+4|KEo zN*Uv+OJ#bYuVp6Mn0yuFX)4Dhf?4`rbuuN#buD;aG32-D`nAHXLLH}B&ArYS{-Hhw zV1F3d`ZoMuqJS`LlE*UYr?*r74)xUiK`j@nTa0Z;HC(7u$esk$ZlP{>6V+=Wx6Nt@ ztLF0&8TkuEzi%{0Wp9s<)mfE1W^w<9S5|8q`RZdG@^2QXo?Sk*#wIEUy+3<&l9y8- zPr0{8qW*dH6sS7|G*3rUx71`3;{VC9t#l}-P2XE>AjvI?M>82t`^=c$W%`zMF0;91 zj5S&M80FfxQC59v+!Z^himih{pQ+!TmNgnX-j=W>M2l9 zfjUt@_%$%KhxUf3B#R-N1$DIbyL7FBPh<;vQ|Et3F1uTKyIWN!XsPmkCLqI5ySPD* zqF>di0rfZ4Q=py#^%U3(6d-4-f$MJLff_)-<_32ORLt K)@zCF(*Fl+#GN$& literal 0 HcmV?d00001 diff --git a/native/switch-ota-launcher/src/ota_ui.c b/native/switch-ota-launcher/src/ota_ui.c index 934c34e9..972310b1 100644 --- a/native/switch-ota-launcher/src/ota_ui.c +++ b/native/switch-ota-launcher/src/ota_ui.c @@ -12,12 +12,10 @@ #if defined(__SWITCH__) #include -#define STB_IMAGE_IMPLEMENTATION -#define STBI_ONLY_PNG -#define STBI_NO_THREAD_LOCALS -#include "../third_party/stb_image.h" #include "../third_party/font8x8_basic.h" +#define OTA_LOGO_ROMFS "romfs:/logo.rgba" + #define FB_W 1280 #define FB_H 720 @@ -261,25 +259,47 @@ static void blit_logo(u32 *fb, u32 stride_px, int dst_x, int dst_y, int max_w) { static void load_logo(void) { if (g_logo) return; - /* romfs is mounted in ota_net_init() before the release check runs. */ - int w = 0, h = 0, n = 0; - unsigned char *data = stbi_load("romfs:/logo.png", &w, &h, &n, 4); - if (!data || w <= 0 || h <= 0) { - if (data) stbi_image_free(data); + FILE *fp = fopen(OTA_LOGO_ROMFS, "rb"); + if (!fp) return; + + unsigned char header[8]; + if (fread(header, 1, sizeof(header), fp) != sizeof(header)) { + fclose(fp); return; } + + int w = (int)(header[0] | (header[1] << 8) | (header[2] << 16) | (header[3] << 24)); + int h = (int)(header[4] | (header[5] << 8) | (header[6] << 16) | (header[7] << 24)); + if (w <= 0 || h <= 0 || w > 2048 || h > 2048) { + fclose(fp); + return; + } + + size_t nbytes = (size_t)w * (size_t)h * 4u; + unsigned char *data = (unsigned char *)malloc(nbytes); + if (!data) { + fclose(fp); + return; + } + if (fread(data, 1, nbytes, fp) != nbytes) { + free(data); + fclose(fp); + return; + } + fclose(fp); + g_logo = (u32 *)malloc((size_t)w * (size_t)h * sizeof(u32)); if (!g_logo) { - stbi_image_free(data); + free(data); return; } for (int i = 0; i < w * h; i++) { - unsigned char *p = data + i * 4; + unsigned char *p = data + (size_t)i * 4u; g_logo[i] = RGBA8(p[0], p[1], p[2], p[3]); } + free(data); g_logo_w = w; g_logo_h = h; - stbi_image_free(data); } static int ui_ensure(void) { diff --git a/native/switch-ota-launcher/third_party/stb_image.h b/native/switch-ota-launcher/third_party/stb_image.h deleted file mode 100644 index 9eedabed..00000000 --- a/native/switch-ota-launcher/third_party/stb_image.h +++ /dev/null @@ -1,7988 +0,0 @@ -/* stb_image - v2.30 - public domain image loader - http://nothings.org/stb - no warranty implied; use at your own risk - - Do this: - #define STB_IMAGE_IMPLEMENTATION - before you include this file in *one* C or C++ file to create the implementation. - - // i.e. it should look like this: - #include ... - #include ... - #include ... - #define STB_IMAGE_IMPLEMENTATION - #include "stb_image.h" - - You can #define STBI_ASSERT(x) before the #include to avoid using assert.h. - And #define STBI_MALLOC, STBI_REALLOC, and STBI_FREE to avoid using malloc,realloc,free - - - QUICK NOTES: - Primarily of interest to game developers and other people who can - avoid problematic images and only need the trivial interface - - JPEG baseline & progressive (12 bpc/arithmetic not supported, same as stock IJG lib) - PNG 1/2/4/8/16-bit-per-channel - - TGA (not sure what subset, if a subset) - BMP non-1bpp, non-RLE - PSD (composited view only, no extra channels, 8/16 bit-per-channel) - - GIF (*comp always reports as 4-channel) - HDR (radiance rgbE format) - PIC (Softimage PIC) - PNM (PPM and PGM binary only) - - Animated GIF still needs a proper API, but here's one way to do it: - http://gist.github.com/urraka/685d9a6340b26b830d49 - - - decode from memory or through FILE (define STBI_NO_STDIO to remove code) - - decode from arbitrary I/O callbacks - - SIMD acceleration on x86/x64 (SSE2) and ARM (NEON) - - Full documentation under "DOCUMENTATION" below. - - -LICENSE - - See end of file for license information. - -RECENT REVISION HISTORY: - - 2.30 (2024-05-31) avoid erroneous gcc warning - 2.29 (2023-05-xx) optimizations - 2.28 (2023-01-29) many error fixes, security errors, just tons of stuff - 2.27 (2021-07-11) document stbi_info better, 16-bit PNM support, bug fixes - 2.26 (2020-07-13) many minor fixes - 2.25 (2020-02-02) fix warnings - 2.24 (2020-02-02) fix warnings; thread-local failure_reason and flip_vertically - 2.23 (2019-08-11) fix clang static analysis warning - 2.22 (2019-03-04) gif fixes, fix warnings - 2.21 (2019-02-25) fix typo in comment - 2.20 (2019-02-07) support utf8 filenames in Windows; fix warnings and platform ifdefs - 2.19 (2018-02-11) fix warning - 2.18 (2018-01-30) fix warnings - 2.17 (2018-01-29) bugfix, 1-bit BMP, 16-bitness query, fix warnings - 2.16 (2017-07-23) all functions have 16-bit variants; optimizations; bugfixes - 2.15 (2017-03-18) fix png-1,2,4; all Imagenet JPGs; no runtime SSE detection on GCC - 2.14 (2017-03-03) remove deprecated STBI_JPEG_OLD; fixes for Imagenet JPGs - 2.13 (2016-12-04) experimental 16-bit API, only for PNG so far; fixes - 2.12 (2016-04-02) fix typo in 2.11 PSD fix that caused crashes - 2.11 (2016-04-02) 16-bit PNGS; enable SSE2 in non-gcc x64 - RGB-format JPEG; remove white matting in PSD; - allocate large structures on the stack; - correct channel count for PNG & BMP - 2.10 (2016-01-22) avoid warning introduced in 2.09 - 2.09 (2016-01-16) 16-bit TGA; comments in PNM files; STBI_REALLOC_SIZED - - See end of file for full revision history. - - - ============================ Contributors ========================= - - Image formats Extensions, features - Sean Barrett (jpeg, png, bmp) Jetro Lauha (stbi_info) - Nicolas Schulz (hdr, psd) Martin "SpartanJ" Golini (stbi_info) - Jonathan Dummer (tga) James "moose2000" Brown (iPhone PNG) - Jean-Marc Lienher (gif) Ben "Disch" Wenger (io callbacks) - Tom Seddon (pic) Omar Cornut (1/2/4-bit PNG) - Thatcher Ulrich (psd) Nicolas Guillemot (vertical flip) - Ken Miller (pgm, ppm) Richard Mitton (16-bit PSD) - github:urraka (animated gif) Junggon Kim (PNM comments) - Christopher Forseth (animated gif) Daniel Gibson (16-bit TGA) - socks-the-fox (16-bit PNG) - Jeremy Sawicki (handle all ImageNet JPGs) - Optimizations & bugfixes Mikhail Morozov (1-bit BMP) - Fabian "ryg" Giesen Anael Seghezzi (is-16-bit query) - Arseny Kapoulkine Simon Breuss (16-bit PNM) - John-Mark Allen - Carmelo J Fdez-Aguera - - Bug & warning fixes - Marc LeBlanc David Woo Guillaume George Martins Mozeiko - Christpher Lloyd Jerry Jansson Joseph Thomson Blazej Dariusz Roszkowski - Phil Jordan Dave Moore Roy Eltham - Hayaki Saito Nathan Reed Won Chun - Luke Graham Johan Duparc Nick Verigakis the Horde3D community - Thomas Ruf Ronny Chevalier github:rlyeh - Janez Zemva John Bartholomew Michal Cichon github:romigrou - Jonathan Blow Ken Hamada Tero Hanninen github:svdijk - Eugene Golushkov Laurent Gomila Cort Stratton github:snagar - Aruelien Pocheville Sergio Gonzalez Thibault Reuille github:Zelex - Cass Everitt Ryamond Barbiero github:grim210 - Paul Du Bois Engin Manap Aldo Culquicondor github:sammyhw - Philipp Wiesemann Dale Weiler Oriol Ferrer Mesia github:phprus - Josh Tobin Neil Bickford Matthew Gregan github:poppolopoppo - Julian Raschke Gregory Mullen Christian Floisand github:darealshinji - Baldur Karlsson Kevin Schmidt JR Smith github:Michaelangel007 - Brad Weinberger Matvey Cherevko github:mosra - Luca Sas Alexander Veselov Zack Middleton [reserved] - Ryan C. Gordon [reserved] [reserved] - DO NOT ADD YOUR NAME HERE - - Jacko Dirks - - To add your name to the credits, pick a random blank space in the middle and fill it. - 80% of merge conflicts on stb PRs are due to people adding their name at the end - of the credits. -*/ - -#ifndef STBI_INCLUDE_STB_IMAGE_H -#define STBI_INCLUDE_STB_IMAGE_H - -// DOCUMENTATION -// -// Limitations: -// - no 12-bit-per-channel JPEG -// - no JPEGs with arithmetic coding -// - GIF always returns *comp=4 -// -// Basic usage (see HDR discussion below for HDR usage): -// int x,y,n; -// unsigned char *data = stbi_load(filename, &x, &y, &n, 0); -// // ... process data if not NULL ... -// // ... x = width, y = height, n = # 8-bit components per pixel ... -// // ... replace '0' with '1'..'4' to force that many components per pixel -// // ... but 'n' will always be the number that it would have been if you said 0 -// stbi_image_free(data); -// -// Standard parameters: -// int *x -- outputs image width in pixels -// int *y -- outputs image height in pixels -// int *channels_in_file -- outputs # of image components in image file -// int desired_channels -- if non-zero, # of image components requested in result -// -// The return value from an image loader is an 'unsigned char *' which points -// to the pixel data, or NULL on an allocation failure or if the image is -// corrupt or invalid. The pixel data consists of *y scanlines of *x pixels, -// with each pixel consisting of N interleaved 8-bit components; the first -// pixel pointed to is top-left-most in the image. There is no padding between -// image scanlines or between pixels, regardless of format. The number of -// components N is 'desired_channels' if desired_channels is non-zero, or -// *channels_in_file otherwise. If desired_channels is non-zero, -// *channels_in_file has the number of components that _would_ have been -// output otherwise. E.g. if you set desired_channels to 4, you will always -// get RGBA output, but you can check *channels_in_file to see if it's trivially -// opaque because e.g. there were only 3 channels in the source image. -// -// An output image with N components has the following components interleaved -// in this order in each pixel: -// -// N=#comp components -// 1 grey -// 2 grey, alpha -// 3 red, green, blue -// 4 red, green, blue, alpha -// -// If image loading fails for any reason, the return value will be NULL, -// and *x, *y, *channels_in_file will be unchanged. The function -// stbi_failure_reason() can be queried for an extremely brief, end-user -// unfriendly explanation of why the load failed. Define STBI_NO_FAILURE_STRINGS -// to avoid compiling these strings at all, and STBI_FAILURE_USERMSG to get slightly -// more user-friendly ones. -// -// Paletted PNG, BMP, GIF, and PIC images are automatically depalettized. -// -// To query the width, height and component count of an image without having to -// decode the full file, you can use the stbi_info family of functions: -// -// int x,y,n,ok; -// ok = stbi_info(filename, &x, &y, &n); -// // returns ok=1 and sets x, y, n if image is a supported format, -// // 0 otherwise. -// -// Note that stb_image pervasively uses ints in its public API for sizes, -// including sizes of memory buffers. This is now part of the API and thus -// hard to change without causing breakage. As a result, the various image -// loaders all have certain limits on image size; these differ somewhat -// by format but generally boil down to either just under 2GB or just under -// 1GB. When the decoded image would be larger than this, stb_image decoding -// will fail. -// -// Additionally, stb_image will reject image files that have any of their -// dimensions set to a larger value than the configurable STBI_MAX_DIMENSIONS, -// which defaults to 2**24 = 16777216 pixels. Due to the above memory limit, -// the only way to have an image with such dimensions load correctly -// is for it to have a rather extreme aspect ratio. Either way, the -// assumption here is that such larger images are likely to be malformed -// or malicious. If you do need to load an image with individual dimensions -// larger than that, and it still fits in the overall size limit, you can -// #define STBI_MAX_DIMENSIONS on your own to be something larger. -// -// =========================================================================== -// -// UNICODE: -// -// If compiling for Windows and you wish to use Unicode filenames, compile -// with -// #define STBI_WINDOWS_UTF8 -// and pass utf8-encoded filenames. Call stbi_convert_wchar_to_utf8 to convert -// Windows wchar_t filenames to utf8. -// -// =========================================================================== -// -// Philosophy -// -// stb libraries are designed with the following priorities: -// -// 1. easy to use -// 2. easy to maintain -// 3. good performance -// -// Sometimes I let "good performance" creep up in priority over "easy to maintain", -// and for best performance I may provide less-easy-to-use APIs that give higher -// performance, in addition to the easy-to-use ones. Nevertheless, it's important -// to keep in mind that from the standpoint of you, a client of this library, -// all you care about is #1 and #3, and stb libraries DO NOT emphasize #3 above all. -// -// Some secondary priorities arise directly from the first two, some of which -// provide more explicit reasons why performance can't be emphasized. -// -// - Portable ("ease of use") -// - Small source code footprint ("easy to maintain") -// - No dependencies ("ease of use") -// -// =========================================================================== -// -// I/O callbacks -// -// I/O callbacks allow you to read from arbitrary sources, like packaged -// files or some other source. Data read from callbacks are processed -// through a small internal buffer (currently 128 bytes) to try to reduce -// overhead. -// -// The three functions you must define are "read" (reads some bytes of data), -// "skip" (skips some bytes of data), "eof" (reports if the stream is at the end). -// -// =========================================================================== -// -// SIMD support -// -// The JPEG decoder will try to automatically use SIMD kernels on x86 when -// supported by the compiler. For ARM Neon support, you must explicitly -// request it. -// -// (The old do-it-yourself SIMD API is no longer supported in the current -// code.) -// -// On x86, SSE2 will automatically be used when available based on a run-time -// test; if not, the generic C versions are used as a fall-back. On ARM targets, -// the typical path is to have separate builds for NEON and non-NEON devices -// (at least this is true for iOS and Android). Therefore, the NEON support is -// toggled by a build flag: define STBI_NEON to get NEON loops. -// -// If for some reason you do not want to use any of SIMD code, or if -// you have issues compiling it, you can disable it entirely by -// defining STBI_NO_SIMD. -// -// =========================================================================== -// -// HDR image support (disable by defining STBI_NO_HDR) -// -// stb_image supports loading HDR images in general, and currently the Radiance -// .HDR file format specifically. You can still load any file through the existing -// interface; if you attempt to load an HDR file, it will be automatically remapped -// to LDR, assuming gamma 2.2 and an arbitrary scale factor defaulting to 1; -// both of these constants can be reconfigured through this interface: -// -// stbi_hdr_to_ldr_gamma(2.2f); -// stbi_hdr_to_ldr_scale(1.0f); -// -// (note, do not use _inverse_ constants; stbi_image will invert them -// appropriately). -// -// Additionally, there is a new, parallel interface for loading files as -// (linear) floats to preserve the full dynamic range: -// -// float *data = stbi_loadf(filename, &x, &y, &n, 0); -// -// If you load LDR images through this interface, those images will -// be promoted to floating point values, run through the inverse of -// constants corresponding to the above: -// -// stbi_ldr_to_hdr_scale(1.0f); -// stbi_ldr_to_hdr_gamma(2.2f); -// -// Finally, given a filename (or an open file or memory block--see header -// file for details) containing image data, you can query for the "most -// appropriate" interface to use (that is, whether the image is HDR or -// not), using: -// -// stbi_is_hdr(char *filename); -// -// =========================================================================== -// -// iPhone PNG support: -// -// We optionally support converting iPhone-formatted PNGs (which store -// premultiplied BGRA) back to RGB, even though they're internally encoded -// differently. To enable this conversion, call -// stbi_convert_iphone_png_to_rgb(1). -// -// Call stbi_set_unpremultiply_on_load(1) as well to force a divide per -// pixel to remove any premultiplied alpha *only* if the image file explicitly -// says there's premultiplied data (currently only happens in iPhone images, -// and only if iPhone convert-to-rgb processing is on). -// -// =========================================================================== -// -// ADDITIONAL CONFIGURATION -// -// - You can suppress implementation of any of the decoders to reduce -// your code footprint by #defining one or more of the following -// symbols before creating the implementation. -// -// STBI_NO_JPEG -// STBI_NO_PNG -// STBI_NO_BMP -// STBI_NO_PSD -// STBI_NO_TGA -// STBI_NO_GIF -// STBI_NO_HDR -// STBI_NO_PIC -// STBI_NO_PNM (.ppm and .pgm) -// -// - You can request *only* certain decoders and suppress all other ones -// (this will be more forward-compatible, as addition of new decoders -// doesn't require you to disable them explicitly): -// -// STBI_ONLY_JPEG -// STBI_ONLY_PNG -// STBI_ONLY_BMP -// STBI_ONLY_PSD -// STBI_ONLY_TGA -// STBI_ONLY_GIF -// STBI_ONLY_HDR -// STBI_ONLY_PIC -// STBI_ONLY_PNM (.ppm and .pgm) -// -// - If you use STBI_NO_PNG (or _ONLY_ without PNG), and you still -// want the zlib decoder to be available, #define STBI_SUPPORT_ZLIB -// -// - If you define STBI_MAX_DIMENSIONS, stb_image will reject images greater -// than that size (in either width or height) without further processing. -// This is to let programs in the wild set an upper bound to prevent -// denial-of-service attacks on untrusted data, as one could generate a -// valid image of gigantic dimensions and force stb_image to allocate a -// huge block of memory and spend disproportionate time decoding it. By -// default this is set to (1 << 24), which is 16777216, but that's still -// very big. - -#ifndef STBI_NO_STDIO -#include -#endif // STBI_NO_STDIO - -#define STBI_VERSION 1 - -enum -{ - STBI_default = 0, // only used for desired_channels - - STBI_grey = 1, - STBI_grey_alpha = 2, - STBI_rgb = 3, - STBI_rgb_alpha = 4 -}; - -#include -typedef unsigned char stbi_uc; -typedef unsigned short stbi_us; - -#ifdef __cplusplus -extern "C" { -#endif - -#ifndef STBIDEF -#ifdef STB_IMAGE_STATIC -#define STBIDEF static -#else -#define STBIDEF extern -#endif -#endif - -////////////////////////////////////////////////////////////////////////////// -// -// PRIMARY API - works on images of any type -// - -// -// load image by filename, open file, or memory buffer -// - -typedef struct -{ - int (*read) (void *user,char *data,int size); // fill 'data' with 'size' bytes. return number of bytes actually read - void (*skip) (void *user,int n); // skip the next 'n' bytes, or 'unget' the last -n bytes if negative - int (*eof) (void *user); // returns nonzero if we are at end of file/data -} stbi_io_callbacks; - -//////////////////////////////////// -// -// 8-bits-per-channel interface -// - -STBIDEF stbi_uc *stbi_load_from_memory (stbi_uc const *buffer, int len , int *x, int *y, int *channels_in_file, int desired_channels); -STBIDEF stbi_uc *stbi_load_from_callbacks(stbi_io_callbacks const *clbk , void *user, int *x, int *y, int *channels_in_file, int desired_channels); - -#ifndef STBI_NO_STDIO -STBIDEF stbi_uc *stbi_load (char const *filename, int *x, int *y, int *channels_in_file, int desired_channels); -STBIDEF stbi_uc *stbi_load_from_file (FILE *f, int *x, int *y, int *channels_in_file, int desired_channels); -// for stbi_load_from_file, file pointer is left pointing immediately after image -#endif - -#ifndef STBI_NO_GIF -STBIDEF stbi_uc *stbi_load_gif_from_memory(stbi_uc const *buffer, int len, int **delays, int *x, int *y, int *z, int *comp, int req_comp); -#endif - -#ifdef STBI_WINDOWS_UTF8 -STBIDEF int stbi_convert_wchar_to_utf8(char *buffer, size_t bufferlen, const wchar_t* input); -#endif - -//////////////////////////////////// -// -// 16-bits-per-channel interface -// - -STBIDEF stbi_us *stbi_load_16_from_memory (stbi_uc const *buffer, int len, int *x, int *y, int *channels_in_file, int desired_channels); -STBIDEF stbi_us *stbi_load_16_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *channels_in_file, int desired_channels); - -#ifndef STBI_NO_STDIO -STBIDEF stbi_us *stbi_load_16 (char const *filename, int *x, int *y, int *channels_in_file, int desired_channels); -STBIDEF stbi_us *stbi_load_from_file_16(FILE *f, int *x, int *y, int *channels_in_file, int desired_channels); -#endif - -//////////////////////////////////// -// -// float-per-channel interface -// -#ifndef STBI_NO_LINEAR - STBIDEF float *stbi_loadf_from_memory (stbi_uc const *buffer, int len, int *x, int *y, int *channels_in_file, int desired_channels); - STBIDEF float *stbi_loadf_from_callbacks (stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *channels_in_file, int desired_channels); - - #ifndef STBI_NO_STDIO - STBIDEF float *stbi_loadf (char const *filename, int *x, int *y, int *channels_in_file, int desired_channels); - STBIDEF float *stbi_loadf_from_file (FILE *f, int *x, int *y, int *channels_in_file, int desired_channels); - #endif -#endif - -#ifndef STBI_NO_HDR - STBIDEF void stbi_hdr_to_ldr_gamma(float gamma); - STBIDEF void stbi_hdr_to_ldr_scale(float scale); -#endif // STBI_NO_HDR - -#ifndef STBI_NO_LINEAR - STBIDEF void stbi_ldr_to_hdr_gamma(float gamma); - STBIDEF void stbi_ldr_to_hdr_scale(float scale); -#endif // STBI_NO_LINEAR - -// stbi_is_hdr is always defined, but always returns false if STBI_NO_HDR -STBIDEF int stbi_is_hdr_from_callbacks(stbi_io_callbacks const *clbk, void *user); -STBIDEF int stbi_is_hdr_from_memory(stbi_uc const *buffer, int len); -#ifndef STBI_NO_STDIO -STBIDEF int stbi_is_hdr (char const *filename); -STBIDEF int stbi_is_hdr_from_file(FILE *f); -#endif // STBI_NO_STDIO - - -// get a VERY brief reason for failure -// on most compilers (and ALL modern mainstream compilers) this is threadsafe -STBIDEF const char *stbi_failure_reason (void); - -// free the loaded image -- this is just free() -STBIDEF void stbi_image_free (void *retval_from_stbi_load); - -// get image dimensions & components without fully decoding -STBIDEF int stbi_info_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *comp); -STBIDEF int stbi_info_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *comp); -STBIDEF int stbi_is_16_bit_from_memory(stbi_uc const *buffer, int len); -STBIDEF int stbi_is_16_bit_from_callbacks(stbi_io_callbacks const *clbk, void *user); - -#ifndef STBI_NO_STDIO -STBIDEF int stbi_info (char const *filename, int *x, int *y, int *comp); -STBIDEF int stbi_info_from_file (FILE *f, int *x, int *y, int *comp); -STBIDEF int stbi_is_16_bit (char const *filename); -STBIDEF int stbi_is_16_bit_from_file(FILE *f); -#endif - - - -// for image formats that explicitly notate that they have premultiplied alpha, -// we just return the colors as stored in the file. set this flag to force -// unpremultiplication. results are undefined if the unpremultiply overflow. -STBIDEF void stbi_set_unpremultiply_on_load(int flag_true_if_should_unpremultiply); - -// indicate whether we should process iphone images back to canonical format, -// or just pass them through "as-is" -STBIDEF void stbi_convert_iphone_png_to_rgb(int flag_true_if_should_convert); - -// flip the image vertically, so the first pixel in the output array is the bottom left -STBIDEF void stbi_set_flip_vertically_on_load(int flag_true_if_should_flip); - -// as above, but only applies to images loaded on the thread that calls the function -// this function is only available if your compiler supports thread-local variables; -// calling it will fail to link if your compiler doesn't -STBIDEF void stbi_set_unpremultiply_on_load_thread(int flag_true_if_should_unpremultiply); -STBIDEF void stbi_convert_iphone_png_to_rgb_thread(int flag_true_if_should_convert); -STBIDEF void stbi_set_flip_vertically_on_load_thread(int flag_true_if_should_flip); - -// ZLIB client - used by PNG, available for other purposes - -STBIDEF char *stbi_zlib_decode_malloc_guesssize(const char *buffer, int len, int initial_size, int *outlen); -STBIDEF char *stbi_zlib_decode_malloc_guesssize_headerflag(const char *buffer, int len, int initial_size, int *outlen, int parse_header); -STBIDEF char *stbi_zlib_decode_malloc(const char *buffer, int len, int *outlen); -STBIDEF int stbi_zlib_decode_buffer(char *obuffer, int olen, const char *ibuffer, int ilen); - -STBIDEF char *stbi_zlib_decode_noheader_malloc(const char *buffer, int len, int *outlen); -STBIDEF int stbi_zlib_decode_noheader_buffer(char *obuffer, int olen, const char *ibuffer, int ilen); - - -#ifdef __cplusplus -} -#endif - -// -// -//// end header file ///////////////////////////////////////////////////// -#endif // STBI_INCLUDE_STB_IMAGE_H - -#ifdef STB_IMAGE_IMPLEMENTATION - -#if defined(STBI_ONLY_JPEG) || defined(STBI_ONLY_PNG) || defined(STBI_ONLY_BMP) \ - || defined(STBI_ONLY_TGA) || defined(STBI_ONLY_GIF) || defined(STBI_ONLY_PSD) \ - || defined(STBI_ONLY_HDR) || defined(STBI_ONLY_PIC) || defined(STBI_ONLY_PNM) \ - || defined(STBI_ONLY_ZLIB) - #ifndef STBI_ONLY_JPEG - #define STBI_NO_JPEG - #endif - #ifndef STBI_ONLY_PNG - #define STBI_NO_PNG - #endif - #ifndef STBI_ONLY_BMP - #define STBI_NO_BMP - #endif - #ifndef STBI_ONLY_PSD - #define STBI_NO_PSD - #endif - #ifndef STBI_ONLY_TGA - #define STBI_NO_TGA - #endif - #ifndef STBI_ONLY_GIF - #define STBI_NO_GIF - #endif - #ifndef STBI_ONLY_HDR - #define STBI_NO_HDR - #endif - #ifndef STBI_ONLY_PIC - #define STBI_NO_PIC - #endif - #ifndef STBI_ONLY_PNM - #define STBI_NO_PNM - #endif -#endif - -#if defined(STBI_NO_PNG) && !defined(STBI_SUPPORT_ZLIB) && !defined(STBI_NO_ZLIB) -#define STBI_NO_ZLIB -#endif - - -#include -#include // ptrdiff_t on osx -#include -#include -#include - -#if !defined(STBI_NO_LINEAR) || !defined(STBI_NO_HDR) -#include // ldexp, pow -#endif - -#ifndef STBI_NO_STDIO -#include -#endif - -#ifndef STBI_ASSERT -#include -#define STBI_ASSERT(x) assert(x) -#endif - -#ifdef __cplusplus -#define STBI_EXTERN extern "C" -#else -#define STBI_EXTERN extern -#endif - - -#ifndef _MSC_VER - #ifdef __cplusplus - #define stbi_inline inline - #else - #define stbi_inline - #endif -#else - #define stbi_inline __forceinline -#endif - -#ifndef STBI_NO_THREAD_LOCALS - #if defined(__cplusplus) && __cplusplus >= 201103L - #define STBI_THREAD_LOCAL thread_local - #elif defined(__GNUC__) && __GNUC__ < 5 - #define STBI_THREAD_LOCAL __thread - #elif defined(_MSC_VER) - #define STBI_THREAD_LOCAL __declspec(thread) - #elif defined (__STDC_VERSION__) && __STDC_VERSION__ >= 201112L && !defined(__STDC_NO_THREADS__) - #define STBI_THREAD_LOCAL _Thread_local - #endif - - #ifndef STBI_THREAD_LOCAL - #if defined(__GNUC__) - #define STBI_THREAD_LOCAL __thread - #endif - #endif -#endif - -#if defined(_MSC_VER) || defined(__SYMBIAN32__) -typedef unsigned short stbi__uint16; -typedef signed short stbi__int16; -typedef unsigned int stbi__uint32; -typedef signed int stbi__int32; -#else -#include -typedef uint16_t stbi__uint16; -typedef int16_t stbi__int16; -typedef uint32_t stbi__uint32; -typedef int32_t stbi__int32; -#endif - -// should produce compiler error if size is wrong -typedef unsigned char validate_uint32[sizeof(stbi__uint32)==4 ? 1 : -1]; - -#ifdef _MSC_VER -#define STBI_NOTUSED(v) (void)(v) -#else -#define STBI_NOTUSED(v) (void)sizeof(v) -#endif - -#ifdef _MSC_VER -#define STBI_HAS_LROTL -#endif - -#ifdef STBI_HAS_LROTL - #define stbi_lrot(x,y) _lrotl(x,y) -#else - #define stbi_lrot(x,y) (((x) << (y)) | ((x) >> (-(y) & 31))) -#endif - -#if defined(STBI_MALLOC) && defined(STBI_FREE) && (defined(STBI_REALLOC) || defined(STBI_REALLOC_SIZED)) -// ok -#elif !defined(STBI_MALLOC) && !defined(STBI_FREE) && !defined(STBI_REALLOC) && !defined(STBI_REALLOC_SIZED) -// ok -#else -#error "Must define all or none of STBI_MALLOC, STBI_FREE, and STBI_REALLOC (or STBI_REALLOC_SIZED)." -#endif - -#ifndef STBI_MALLOC -#define STBI_MALLOC(sz) malloc(sz) -#define STBI_REALLOC(p,newsz) realloc(p,newsz) -#define STBI_FREE(p) free(p) -#endif - -#ifndef STBI_REALLOC_SIZED -#define STBI_REALLOC_SIZED(p,oldsz,newsz) STBI_REALLOC(p,newsz) -#endif - -// x86/x64 detection -#if defined(__x86_64__) || defined(_M_X64) -#define STBI__X64_TARGET -#elif defined(__i386) || defined(_M_IX86) -#define STBI__X86_TARGET -#endif - -#if defined(__GNUC__) && defined(STBI__X86_TARGET) && !defined(__SSE2__) && !defined(STBI_NO_SIMD) -// gcc doesn't support sse2 intrinsics unless you compile with -msse2, -// which in turn means it gets to use SSE2 everywhere. This is unfortunate, -// but previous attempts to provide the SSE2 functions with runtime -// detection caused numerous issues. The way architecture extensions are -// exposed in GCC/Clang is, sadly, not really suited for one-file libs. -// New behavior: if compiled with -msse2, we use SSE2 without any -// detection; if not, we don't use it at all. -#define STBI_NO_SIMD -#endif - -#if defined(__MINGW32__) && defined(STBI__X86_TARGET) && !defined(STBI_MINGW_ENABLE_SSE2) && !defined(STBI_NO_SIMD) -// Note that __MINGW32__ doesn't actually mean 32-bit, so we have to avoid STBI__X64_TARGET -// -// 32-bit MinGW wants ESP to be 16-byte aligned, but this is not in the -// Windows ABI and VC++ as well as Windows DLLs don't maintain that invariant. -// As a result, enabling SSE2 on 32-bit MinGW is dangerous when not -// simultaneously enabling "-mstackrealign". -// -// See https://github.com/nothings/stb/issues/81 for more information. -// -// So default to no SSE2 on 32-bit MinGW. If you've read this far and added -// -mstackrealign to your build settings, feel free to #define STBI_MINGW_ENABLE_SSE2. -#define STBI_NO_SIMD -#endif - -#if !defined(STBI_NO_SIMD) && (defined(STBI__X86_TARGET) || defined(STBI__X64_TARGET)) -#define STBI_SSE2 -#include - -#ifdef _MSC_VER - -#if _MSC_VER >= 1400 // not VC6 -#include // __cpuid -static int stbi__cpuid3(void) -{ - int info[4]; - __cpuid(info,1); - return info[3]; -} -#else -static int stbi__cpuid3(void) -{ - int res; - __asm { - mov eax,1 - cpuid - mov res,edx - } - return res; -} -#endif - -#define STBI_SIMD_ALIGN(type, name) __declspec(align(16)) type name - -#if !defined(STBI_NO_JPEG) && defined(STBI_SSE2) -static int stbi__sse2_available(void) -{ - int info3 = stbi__cpuid3(); - return ((info3 >> 26) & 1) != 0; -} -#endif - -#else // assume GCC-style if not VC++ -#define STBI_SIMD_ALIGN(type, name) type name __attribute__((aligned(16))) - -#if !defined(STBI_NO_JPEG) && defined(STBI_SSE2) -static int stbi__sse2_available(void) -{ - // If we're even attempting to compile this on GCC/Clang, that means - // -msse2 is on, which means the compiler is allowed to use SSE2 - // instructions at will, and so are we. - return 1; -} -#endif - -#endif -#endif - -// ARM NEON -#if defined(STBI_NO_SIMD) && defined(STBI_NEON) -#undef STBI_NEON -#endif - -#ifdef STBI_NEON -#include -#ifdef _MSC_VER -#define STBI_SIMD_ALIGN(type, name) __declspec(align(16)) type name -#else -#define STBI_SIMD_ALIGN(type, name) type name __attribute__((aligned(16))) -#endif -#endif - -#ifndef STBI_SIMD_ALIGN -#define STBI_SIMD_ALIGN(type, name) type name -#endif - -#ifndef STBI_MAX_DIMENSIONS -#define STBI_MAX_DIMENSIONS (1 << 24) -#endif - -/////////////////////////////////////////////// -// -// stbi__context struct and start_xxx functions - -// stbi__context structure is our basic context used by all images, so it -// contains all the IO context, plus some basic image information -typedef struct -{ - stbi__uint32 img_x, img_y; - int img_n, img_out_n; - - stbi_io_callbacks io; - void *io_user_data; - - int read_from_callbacks; - int buflen; - stbi_uc buffer_start[128]; - int callback_already_read; - - stbi_uc *img_buffer, *img_buffer_end; - stbi_uc *img_buffer_original, *img_buffer_original_end; -} stbi__context; - - -static void stbi__refill_buffer(stbi__context *s); - -// initialize a memory-decode context -static void stbi__start_mem(stbi__context *s, stbi_uc const *buffer, int len) -{ - s->io.read = NULL; - s->read_from_callbacks = 0; - s->callback_already_read = 0; - s->img_buffer = s->img_buffer_original = (stbi_uc *) buffer; - s->img_buffer_end = s->img_buffer_original_end = (stbi_uc *) buffer+len; -} - -// initialize a callback-based context -static void stbi__start_callbacks(stbi__context *s, stbi_io_callbacks *c, void *user) -{ - s->io = *c; - s->io_user_data = user; - s->buflen = sizeof(s->buffer_start); - s->read_from_callbacks = 1; - s->callback_already_read = 0; - s->img_buffer = s->img_buffer_original = s->buffer_start; - stbi__refill_buffer(s); - s->img_buffer_original_end = s->img_buffer_end; -} - -#ifndef STBI_NO_STDIO - -static int stbi__stdio_read(void *user, char *data, int size) -{ - return (int) fread(data,1,size,(FILE*) user); -} - -static void stbi__stdio_skip(void *user, int n) -{ - int ch; - fseek((FILE*) user, n, SEEK_CUR); - ch = fgetc((FILE*) user); /* have to read a byte to reset feof()'s flag */ - if (ch != EOF) { - ungetc(ch, (FILE *) user); /* push byte back onto stream if valid. */ - } -} - -static int stbi__stdio_eof(void *user) -{ - return feof((FILE*) user) || ferror((FILE *) user); -} - -static stbi_io_callbacks stbi__stdio_callbacks = -{ - stbi__stdio_read, - stbi__stdio_skip, - stbi__stdio_eof, -}; - -static void stbi__start_file(stbi__context *s, FILE *f) -{ - stbi__start_callbacks(s, &stbi__stdio_callbacks, (void *) f); -} - -//static void stop_file(stbi__context *s) { } - -#endif // !STBI_NO_STDIO - -static void stbi__rewind(stbi__context *s) -{ - // conceptually rewind SHOULD rewind to the beginning of the stream, - // but we just rewind to the beginning of the initial buffer, because - // we only use it after doing 'test', which only ever looks at at most 92 bytes - s->img_buffer = s->img_buffer_original; - s->img_buffer_end = s->img_buffer_original_end; -} - -enum -{ - STBI_ORDER_RGB, - STBI_ORDER_BGR -}; - -typedef struct -{ - int bits_per_channel; - int num_channels; - int channel_order; -} stbi__result_info; - -#ifndef STBI_NO_JPEG -static int stbi__jpeg_test(stbi__context *s); -static void *stbi__jpeg_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); -static int stbi__jpeg_info(stbi__context *s, int *x, int *y, int *comp); -#endif - -#ifndef STBI_NO_PNG -static int stbi__png_test(stbi__context *s); -static void *stbi__png_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); -static int stbi__png_info(stbi__context *s, int *x, int *y, int *comp); -static int stbi__png_is16(stbi__context *s); -#endif - -#ifndef STBI_NO_BMP -static int stbi__bmp_test(stbi__context *s); -static void *stbi__bmp_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); -static int stbi__bmp_info(stbi__context *s, int *x, int *y, int *comp); -#endif - -#ifndef STBI_NO_TGA -static int stbi__tga_test(stbi__context *s); -static void *stbi__tga_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); -static int stbi__tga_info(stbi__context *s, int *x, int *y, int *comp); -#endif - -#ifndef STBI_NO_PSD -static int stbi__psd_test(stbi__context *s); -static void *stbi__psd_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri, int bpc); -static int stbi__psd_info(stbi__context *s, int *x, int *y, int *comp); -static int stbi__psd_is16(stbi__context *s); -#endif - -#ifndef STBI_NO_HDR -static int stbi__hdr_test(stbi__context *s); -static float *stbi__hdr_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); -static int stbi__hdr_info(stbi__context *s, int *x, int *y, int *comp); -#endif - -#ifndef STBI_NO_PIC -static int stbi__pic_test(stbi__context *s); -static void *stbi__pic_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); -static int stbi__pic_info(stbi__context *s, int *x, int *y, int *comp); -#endif - -#ifndef STBI_NO_GIF -static int stbi__gif_test(stbi__context *s); -static void *stbi__gif_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); -static void *stbi__load_gif_main(stbi__context *s, int **delays, int *x, int *y, int *z, int *comp, int req_comp); -static int stbi__gif_info(stbi__context *s, int *x, int *y, int *comp); -#endif - -#ifndef STBI_NO_PNM -static int stbi__pnm_test(stbi__context *s); -static void *stbi__pnm_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri); -static int stbi__pnm_info(stbi__context *s, int *x, int *y, int *comp); -static int stbi__pnm_is16(stbi__context *s); -#endif - -static -#ifdef STBI_THREAD_LOCAL -STBI_THREAD_LOCAL -#endif -const char *stbi__g_failure_reason; - -STBIDEF const char *stbi_failure_reason(void) -{ - return stbi__g_failure_reason; -} - -#ifndef STBI_NO_FAILURE_STRINGS -static int stbi__err(const char *str) -{ - stbi__g_failure_reason = str; - return 0; -} -#endif - -static void *stbi__malloc(size_t size) -{ - return STBI_MALLOC(size); -} - -// stb_image uses ints pervasively, including for offset calculations. -// therefore the largest decoded image size we can support with the -// current code, even on 64-bit targets, is INT_MAX. this is not a -// significant limitation for the intended use case. -// -// we do, however, need to make sure our size calculations don't -// overflow. hence a few helper functions for size calculations that -// multiply integers together, making sure that they're non-negative -// and no overflow occurs. - -// return 1 if the sum is valid, 0 on overflow. -// negative terms are considered invalid. -static int stbi__addsizes_valid(int a, int b) -{ - if (b < 0) return 0; - // now 0 <= b <= INT_MAX, hence also - // 0 <= INT_MAX - b <= INTMAX. - // And "a + b <= INT_MAX" (which might overflow) is the - // same as a <= INT_MAX - b (no overflow) - return a <= INT_MAX - b; -} - -// returns 1 if the product is valid, 0 on overflow. -// negative factors are considered invalid. -static int stbi__mul2sizes_valid(int a, int b) -{ - if (a < 0 || b < 0) return 0; - if (b == 0) return 1; // mul-by-0 is always safe - // portable way to check for no overflows in a*b - return a <= INT_MAX/b; -} - -#if !defined(STBI_NO_JPEG) || !defined(STBI_NO_PNG) || !defined(STBI_NO_TGA) || !defined(STBI_NO_HDR) -// returns 1 if "a*b + add" has no negative terms/factors and doesn't overflow -static int stbi__mad2sizes_valid(int a, int b, int add) -{ - return stbi__mul2sizes_valid(a, b) && stbi__addsizes_valid(a*b, add); -} -#endif - -// returns 1 if "a*b*c + add" has no negative terms/factors and doesn't overflow -static int stbi__mad3sizes_valid(int a, int b, int c, int add) -{ - return stbi__mul2sizes_valid(a, b) && stbi__mul2sizes_valid(a*b, c) && - stbi__addsizes_valid(a*b*c, add); -} - -// returns 1 if "a*b*c*d + add" has no negative terms/factors and doesn't overflow -#if !defined(STBI_NO_LINEAR) || !defined(STBI_NO_HDR) || !defined(STBI_NO_PNM) -static int stbi__mad4sizes_valid(int a, int b, int c, int d, int add) -{ - return stbi__mul2sizes_valid(a, b) && stbi__mul2sizes_valid(a*b, c) && - stbi__mul2sizes_valid(a*b*c, d) && stbi__addsizes_valid(a*b*c*d, add); -} -#endif - -#if !defined(STBI_NO_JPEG) || !defined(STBI_NO_PNG) || !defined(STBI_NO_TGA) || !defined(STBI_NO_HDR) -// mallocs with size overflow checking -static void *stbi__malloc_mad2(int a, int b, int add) -{ - if (!stbi__mad2sizes_valid(a, b, add)) return NULL; - return stbi__malloc(a*b + add); -} -#endif - -static void *stbi__malloc_mad3(int a, int b, int c, int add) -{ - if (!stbi__mad3sizes_valid(a, b, c, add)) return NULL; - return stbi__malloc(a*b*c + add); -} - -#if !defined(STBI_NO_LINEAR) || !defined(STBI_NO_HDR) || !defined(STBI_NO_PNM) -static void *stbi__malloc_mad4(int a, int b, int c, int d, int add) -{ - if (!stbi__mad4sizes_valid(a, b, c, d, add)) return NULL; - return stbi__malloc(a*b*c*d + add); -} -#endif - -// returns 1 if the sum of two signed ints is valid (between -2^31 and 2^31-1 inclusive), 0 on overflow. -static int stbi__addints_valid(int a, int b) -{ - if ((a >= 0) != (b >= 0)) return 1; // a and b have different signs, so no overflow - if (a < 0 && b < 0) return a >= INT_MIN - b; // same as a + b >= INT_MIN; INT_MIN - b cannot overflow since b < 0. - return a <= INT_MAX - b; -} - -// returns 1 if the product of two ints fits in a signed short, 0 on overflow. -static int stbi__mul2shorts_valid(int a, int b) -{ - if (b == 0 || b == -1) return 1; // multiplication by 0 is always 0; check for -1 so SHRT_MIN/b doesn't overflow - if ((a >= 0) == (b >= 0)) return a <= SHRT_MAX/b; // product is positive, so similar to mul2sizes_valid - if (b < 0) return a <= SHRT_MIN / b; // same as a * b >= SHRT_MIN - return a >= SHRT_MIN / b; -} - -// stbi__err - error -// stbi__errpf - error returning pointer to float -// stbi__errpuc - error returning pointer to unsigned char - -#ifdef STBI_NO_FAILURE_STRINGS - #define stbi__err(x,y) 0 -#elif defined(STBI_FAILURE_USERMSG) - #define stbi__err(x,y) stbi__err(y) -#else - #define stbi__err(x,y) stbi__err(x) -#endif - -#define stbi__errpf(x,y) ((float *)(size_t) (stbi__err(x,y)?NULL:NULL)) -#define stbi__errpuc(x,y) ((unsigned char *)(size_t) (stbi__err(x,y)?NULL:NULL)) - -STBIDEF void stbi_image_free(void *retval_from_stbi_load) -{ - STBI_FREE(retval_from_stbi_load); -} - -#ifndef STBI_NO_LINEAR -static float *stbi__ldr_to_hdr(stbi_uc *data, int x, int y, int comp); -#endif - -#ifndef STBI_NO_HDR -static stbi_uc *stbi__hdr_to_ldr(float *data, int x, int y, int comp); -#endif - -static int stbi__vertically_flip_on_load_global = 0; - -STBIDEF void stbi_set_flip_vertically_on_load(int flag_true_if_should_flip) -{ - stbi__vertically_flip_on_load_global = flag_true_if_should_flip; -} - -#ifndef STBI_THREAD_LOCAL -#define stbi__vertically_flip_on_load stbi__vertically_flip_on_load_global -#else -static STBI_THREAD_LOCAL int stbi__vertically_flip_on_load_local, stbi__vertically_flip_on_load_set; - -STBIDEF void stbi_set_flip_vertically_on_load_thread(int flag_true_if_should_flip) -{ - stbi__vertically_flip_on_load_local = flag_true_if_should_flip; - stbi__vertically_flip_on_load_set = 1; -} - -#define stbi__vertically_flip_on_load (stbi__vertically_flip_on_load_set \ - ? stbi__vertically_flip_on_load_local \ - : stbi__vertically_flip_on_load_global) -#endif // STBI_THREAD_LOCAL - -static void *stbi__load_main(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri, int bpc) -{ - memset(ri, 0, sizeof(*ri)); // make sure it's initialized if we add new fields - ri->bits_per_channel = 8; // default is 8 so most paths don't have to be changed - ri->channel_order = STBI_ORDER_RGB; // all current input & output are this, but this is here so we can add BGR order - ri->num_channels = 0; - - // test the formats with a very explicit header first (at least a FOURCC - // or distinctive magic number first) - #ifndef STBI_NO_PNG - if (stbi__png_test(s)) return stbi__png_load(s,x,y,comp,req_comp, ri); - #endif - #ifndef STBI_NO_BMP - if (stbi__bmp_test(s)) return stbi__bmp_load(s,x,y,comp,req_comp, ri); - #endif - #ifndef STBI_NO_GIF - if (stbi__gif_test(s)) return stbi__gif_load(s,x,y,comp,req_comp, ri); - #endif - #ifndef STBI_NO_PSD - if (stbi__psd_test(s)) return stbi__psd_load(s,x,y,comp,req_comp, ri, bpc); - #else - STBI_NOTUSED(bpc); - #endif - #ifndef STBI_NO_PIC - if (stbi__pic_test(s)) return stbi__pic_load(s,x,y,comp,req_comp, ri); - #endif - - // then the formats that can end up attempting to load with just 1 or 2 - // bytes matching expectations; these are prone to false positives, so - // try them later - #ifndef STBI_NO_JPEG - if (stbi__jpeg_test(s)) return stbi__jpeg_load(s,x,y,comp,req_comp, ri); - #endif - #ifndef STBI_NO_PNM - if (stbi__pnm_test(s)) return stbi__pnm_load(s,x,y,comp,req_comp, ri); - #endif - - #ifndef STBI_NO_HDR - if (stbi__hdr_test(s)) { - float *hdr = stbi__hdr_load(s, x,y,comp,req_comp, ri); - return stbi__hdr_to_ldr(hdr, *x, *y, req_comp ? req_comp : *comp); - } - #endif - - #ifndef STBI_NO_TGA - // test tga last because it's a crappy test! - if (stbi__tga_test(s)) - return stbi__tga_load(s,x,y,comp,req_comp, ri); - #endif - - return stbi__errpuc("unknown image type", "Image not of any known type, or corrupt"); -} - -static stbi_uc *stbi__convert_16_to_8(stbi__uint16 *orig, int w, int h, int channels) -{ - int i; - int img_len = w * h * channels; - stbi_uc *reduced; - - reduced = (stbi_uc *) stbi__malloc(img_len); - if (reduced == NULL) return stbi__errpuc("outofmem", "Out of memory"); - - for (i = 0; i < img_len; ++i) - reduced[i] = (stbi_uc)((orig[i] >> 8) & 0xFF); // top half of each byte is sufficient approx of 16->8 bit scaling - - STBI_FREE(orig); - return reduced; -} - -static stbi__uint16 *stbi__convert_8_to_16(stbi_uc *orig, int w, int h, int channels) -{ - int i; - int img_len = w * h * channels; - stbi__uint16 *enlarged; - - enlarged = (stbi__uint16 *) stbi__malloc(img_len*2); - if (enlarged == NULL) return (stbi__uint16 *) stbi__errpuc("outofmem", "Out of memory"); - - for (i = 0; i < img_len; ++i) - enlarged[i] = (stbi__uint16)((orig[i] << 8) + orig[i]); // replicate to high and low byte, maps 0->0, 255->0xffff - - STBI_FREE(orig); - return enlarged; -} - -static void stbi__vertical_flip(void *image, int w, int h, int bytes_per_pixel) -{ - int row; - size_t bytes_per_row = (size_t)w * bytes_per_pixel; - stbi_uc temp[2048]; - stbi_uc *bytes = (stbi_uc *)image; - - for (row = 0; row < (h>>1); row++) { - stbi_uc *row0 = bytes + row*bytes_per_row; - stbi_uc *row1 = bytes + (h - row - 1)*bytes_per_row; - // swap row0 with row1 - size_t bytes_left = bytes_per_row; - while (bytes_left) { - size_t bytes_copy = (bytes_left < sizeof(temp)) ? bytes_left : sizeof(temp); - memcpy(temp, row0, bytes_copy); - memcpy(row0, row1, bytes_copy); - memcpy(row1, temp, bytes_copy); - row0 += bytes_copy; - row1 += bytes_copy; - bytes_left -= bytes_copy; - } - } -} - -#ifndef STBI_NO_GIF -static void stbi__vertical_flip_slices(void *image, int w, int h, int z, int bytes_per_pixel) -{ - int slice; - int slice_size = w * h * bytes_per_pixel; - - stbi_uc *bytes = (stbi_uc *)image; - for (slice = 0; slice < z; ++slice) { - stbi__vertical_flip(bytes, w, h, bytes_per_pixel); - bytes += slice_size; - } -} -#endif - -static unsigned char *stbi__load_and_postprocess_8bit(stbi__context *s, int *x, int *y, int *comp, int req_comp) -{ - stbi__result_info ri; - void *result = stbi__load_main(s, x, y, comp, req_comp, &ri, 8); - - if (result == NULL) - return NULL; - - // it is the responsibility of the loaders to make sure we get either 8 or 16 bit. - STBI_ASSERT(ri.bits_per_channel == 8 || ri.bits_per_channel == 16); - - if (ri.bits_per_channel != 8) { - result = stbi__convert_16_to_8((stbi__uint16 *) result, *x, *y, req_comp == 0 ? *comp : req_comp); - ri.bits_per_channel = 8; - } - - // @TODO: move stbi__convert_format to here - - if (stbi__vertically_flip_on_load) { - int channels = req_comp ? req_comp : *comp; - stbi__vertical_flip(result, *x, *y, channels * sizeof(stbi_uc)); - } - - return (unsigned char *) result; -} - -static stbi__uint16 *stbi__load_and_postprocess_16bit(stbi__context *s, int *x, int *y, int *comp, int req_comp) -{ - stbi__result_info ri; - void *result = stbi__load_main(s, x, y, comp, req_comp, &ri, 16); - - if (result == NULL) - return NULL; - - // it is the responsibility of the loaders to make sure we get either 8 or 16 bit. - STBI_ASSERT(ri.bits_per_channel == 8 || ri.bits_per_channel == 16); - - if (ri.bits_per_channel != 16) { - result = stbi__convert_8_to_16((stbi_uc *) result, *x, *y, req_comp == 0 ? *comp : req_comp); - ri.bits_per_channel = 16; - } - - // @TODO: move stbi__convert_format16 to here - // @TODO: special case RGB-to-Y (and RGBA-to-YA) for 8-bit-to-16-bit case to keep more precision - - if (stbi__vertically_flip_on_load) { - int channels = req_comp ? req_comp : *comp; - stbi__vertical_flip(result, *x, *y, channels * sizeof(stbi__uint16)); - } - - return (stbi__uint16 *) result; -} - -#if !defined(STBI_NO_HDR) && !defined(STBI_NO_LINEAR) -static void stbi__float_postprocess(float *result, int *x, int *y, int *comp, int req_comp) -{ - if (stbi__vertically_flip_on_load && result != NULL) { - int channels = req_comp ? req_comp : *comp; - stbi__vertical_flip(result, *x, *y, channels * sizeof(float)); - } -} -#endif - -#ifndef STBI_NO_STDIO - -#if defined(_WIN32) && defined(STBI_WINDOWS_UTF8) -STBI_EXTERN __declspec(dllimport) int __stdcall MultiByteToWideChar(unsigned int cp, unsigned long flags, const char *str, int cbmb, wchar_t *widestr, int cchwide); -STBI_EXTERN __declspec(dllimport) int __stdcall WideCharToMultiByte(unsigned int cp, unsigned long flags, const wchar_t *widestr, int cchwide, char *str, int cbmb, const char *defchar, int *used_default); -#endif - -#if defined(_WIN32) && defined(STBI_WINDOWS_UTF8) -STBIDEF int stbi_convert_wchar_to_utf8(char *buffer, size_t bufferlen, const wchar_t* input) -{ - return WideCharToMultiByte(65001 /* UTF8 */, 0, input, -1, buffer, (int) bufferlen, NULL, NULL); -} -#endif - -static FILE *stbi__fopen(char const *filename, char const *mode) -{ - FILE *f; -#if defined(_WIN32) && defined(STBI_WINDOWS_UTF8) - wchar_t wMode[64]; - wchar_t wFilename[1024]; - if (0 == MultiByteToWideChar(65001 /* UTF8 */, 0, filename, -1, wFilename, sizeof(wFilename)/sizeof(*wFilename))) - return 0; - - if (0 == MultiByteToWideChar(65001 /* UTF8 */, 0, mode, -1, wMode, sizeof(wMode)/sizeof(*wMode))) - return 0; - -#if defined(_MSC_VER) && _MSC_VER >= 1400 - if (0 != _wfopen_s(&f, wFilename, wMode)) - f = 0; -#else - f = _wfopen(wFilename, wMode); -#endif - -#elif defined(_MSC_VER) && _MSC_VER >= 1400 - if (0 != fopen_s(&f, filename, mode)) - f=0; -#else - f = fopen(filename, mode); -#endif - return f; -} - - -STBIDEF stbi_uc *stbi_load(char const *filename, int *x, int *y, int *comp, int req_comp) -{ - FILE *f = stbi__fopen(filename, "rb"); - unsigned char *result; - if (!f) return stbi__errpuc("can't fopen", "Unable to open file"); - result = stbi_load_from_file(f,x,y,comp,req_comp); - fclose(f); - return result; -} - -STBIDEF stbi_uc *stbi_load_from_file(FILE *f, int *x, int *y, int *comp, int req_comp) -{ - unsigned char *result; - stbi__context s; - stbi__start_file(&s,f); - result = stbi__load_and_postprocess_8bit(&s,x,y,comp,req_comp); - if (result) { - // need to 'unget' all the characters in the IO buffer - fseek(f, - (int) (s.img_buffer_end - s.img_buffer), SEEK_CUR); - } - return result; -} - -STBIDEF stbi__uint16 *stbi_load_from_file_16(FILE *f, int *x, int *y, int *comp, int req_comp) -{ - stbi__uint16 *result; - stbi__context s; - stbi__start_file(&s,f); - result = stbi__load_and_postprocess_16bit(&s,x,y,comp,req_comp); - if (result) { - // need to 'unget' all the characters in the IO buffer - fseek(f, - (int) (s.img_buffer_end - s.img_buffer), SEEK_CUR); - } - return result; -} - -STBIDEF stbi_us *stbi_load_16(char const *filename, int *x, int *y, int *comp, int req_comp) -{ - FILE *f = stbi__fopen(filename, "rb"); - stbi__uint16 *result; - if (!f) return (stbi_us *) stbi__errpuc("can't fopen", "Unable to open file"); - result = stbi_load_from_file_16(f,x,y,comp,req_comp); - fclose(f); - return result; -} - - -#endif //!STBI_NO_STDIO - -STBIDEF stbi_us *stbi_load_16_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *channels_in_file, int desired_channels) -{ - stbi__context s; - stbi__start_mem(&s,buffer,len); - return stbi__load_and_postprocess_16bit(&s,x,y,channels_in_file,desired_channels); -} - -STBIDEF stbi_us *stbi_load_16_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *channels_in_file, int desired_channels) -{ - stbi__context s; - stbi__start_callbacks(&s, (stbi_io_callbacks *)clbk, user); - return stbi__load_and_postprocess_16bit(&s,x,y,channels_in_file,desired_channels); -} - -STBIDEF stbi_uc *stbi_load_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *comp, int req_comp) -{ - stbi__context s; - stbi__start_mem(&s,buffer,len); - return stbi__load_and_postprocess_8bit(&s,x,y,comp,req_comp); -} - -STBIDEF stbi_uc *stbi_load_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *comp, int req_comp) -{ - stbi__context s; - stbi__start_callbacks(&s, (stbi_io_callbacks *) clbk, user); - return stbi__load_and_postprocess_8bit(&s,x,y,comp,req_comp); -} - -#ifndef STBI_NO_GIF -STBIDEF stbi_uc *stbi_load_gif_from_memory(stbi_uc const *buffer, int len, int **delays, int *x, int *y, int *z, int *comp, int req_comp) -{ - unsigned char *result; - stbi__context s; - stbi__start_mem(&s,buffer,len); - - result = (unsigned char*) stbi__load_gif_main(&s, delays, x, y, z, comp, req_comp); - if (stbi__vertically_flip_on_load) { - stbi__vertical_flip_slices( result, *x, *y, *z, *comp ); - } - - return result; -} -#endif - -#ifndef STBI_NO_LINEAR -static float *stbi__loadf_main(stbi__context *s, int *x, int *y, int *comp, int req_comp) -{ - unsigned char *data; - #ifndef STBI_NO_HDR - if (stbi__hdr_test(s)) { - stbi__result_info ri; - float *hdr_data = stbi__hdr_load(s,x,y,comp,req_comp, &ri); - if (hdr_data) - stbi__float_postprocess(hdr_data,x,y,comp,req_comp); - return hdr_data; - } - #endif - data = stbi__load_and_postprocess_8bit(s, x, y, comp, req_comp); - if (data) - return stbi__ldr_to_hdr(data, *x, *y, req_comp ? req_comp : *comp); - return stbi__errpf("unknown image type", "Image not of any known type, or corrupt"); -} - -STBIDEF float *stbi_loadf_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *comp, int req_comp) -{ - stbi__context s; - stbi__start_mem(&s,buffer,len); - return stbi__loadf_main(&s,x,y,comp,req_comp); -} - -STBIDEF float *stbi_loadf_from_callbacks(stbi_io_callbacks const *clbk, void *user, int *x, int *y, int *comp, int req_comp) -{ - stbi__context s; - stbi__start_callbacks(&s, (stbi_io_callbacks *) clbk, user); - return stbi__loadf_main(&s,x,y,comp,req_comp); -} - -#ifndef STBI_NO_STDIO -STBIDEF float *stbi_loadf(char const *filename, int *x, int *y, int *comp, int req_comp) -{ - float *result; - FILE *f = stbi__fopen(filename, "rb"); - if (!f) return stbi__errpf("can't fopen", "Unable to open file"); - result = stbi_loadf_from_file(f,x,y,comp,req_comp); - fclose(f); - return result; -} - -STBIDEF float *stbi_loadf_from_file(FILE *f, int *x, int *y, int *comp, int req_comp) -{ - stbi__context s; - stbi__start_file(&s,f); - return stbi__loadf_main(&s,x,y,comp,req_comp); -} -#endif // !STBI_NO_STDIO - -#endif // !STBI_NO_LINEAR - -// these is-hdr-or-not is defined independent of whether STBI_NO_LINEAR is -// defined, for API simplicity; if STBI_NO_LINEAR is defined, it always -// reports false! - -STBIDEF int stbi_is_hdr_from_memory(stbi_uc const *buffer, int len) -{ - #ifndef STBI_NO_HDR - stbi__context s; - stbi__start_mem(&s,buffer,len); - return stbi__hdr_test(&s); - #else - STBI_NOTUSED(buffer); - STBI_NOTUSED(len); - return 0; - #endif -} - -#ifndef STBI_NO_STDIO -STBIDEF int stbi_is_hdr (char const *filename) -{ - FILE *f = stbi__fopen(filename, "rb"); - int result=0; - if (f) { - result = stbi_is_hdr_from_file(f); - fclose(f); - } - return result; -} - -STBIDEF int stbi_is_hdr_from_file(FILE *f) -{ - #ifndef STBI_NO_HDR - long pos = ftell(f); - int res; - stbi__context s; - stbi__start_file(&s,f); - res = stbi__hdr_test(&s); - fseek(f, pos, SEEK_SET); - return res; - #else - STBI_NOTUSED(f); - return 0; - #endif -} -#endif // !STBI_NO_STDIO - -STBIDEF int stbi_is_hdr_from_callbacks(stbi_io_callbacks const *clbk, void *user) -{ - #ifndef STBI_NO_HDR - stbi__context s; - stbi__start_callbacks(&s, (stbi_io_callbacks *) clbk, user); - return stbi__hdr_test(&s); - #else - STBI_NOTUSED(clbk); - STBI_NOTUSED(user); - return 0; - #endif -} - -#ifndef STBI_NO_LINEAR -static float stbi__l2h_gamma=2.2f, stbi__l2h_scale=1.0f; - -STBIDEF void stbi_ldr_to_hdr_gamma(float gamma) { stbi__l2h_gamma = gamma; } -STBIDEF void stbi_ldr_to_hdr_scale(float scale) { stbi__l2h_scale = scale; } -#endif - -static float stbi__h2l_gamma_i=1.0f/2.2f, stbi__h2l_scale_i=1.0f; - -STBIDEF void stbi_hdr_to_ldr_gamma(float gamma) { stbi__h2l_gamma_i = 1/gamma; } -STBIDEF void stbi_hdr_to_ldr_scale(float scale) { stbi__h2l_scale_i = 1/scale; } - - -////////////////////////////////////////////////////////////////////////////// -// -// Common code used by all image loaders -// - -enum -{ - STBI__SCAN_load=0, - STBI__SCAN_type, - STBI__SCAN_header -}; - -static void stbi__refill_buffer(stbi__context *s) -{ - int n = (s->io.read)(s->io_user_data,(char*)s->buffer_start,s->buflen); - s->callback_already_read += (int) (s->img_buffer - s->img_buffer_original); - if (n == 0) { - // at end of file, treat same as if from memory, but need to handle case - // where s->img_buffer isn't pointing to safe memory, e.g. 0-byte file - s->read_from_callbacks = 0; - s->img_buffer = s->buffer_start; - s->img_buffer_end = s->buffer_start+1; - *s->img_buffer = 0; - } else { - s->img_buffer = s->buffer_start; - s->img_buffer_end = s->buffer_start + n; - } -} - -stbi_inline static stbi_uc stbi__get8(stbi__context *s) -{ - if (s->img_buffer < s->img_buffer_end) - return *s->img_buffer++; - if (s->read_from_callbacks) { - stbi__refill_buffer(s); - return *s->img_buffer++; - } - return 0; -} - -#if defined(STBI_NO_JPEG) && defined(STBI_NO_HDR) && defined(STBI_NO_PIC) && defined(STBI_NO_PNM) -// nothing -#else -stbi_inline static int stbi__at_eof(stbi__context *s) -{ - if (s->io.read) { - if (!(s->io.eof)(s->io_user_data)) return 0; - // if feof() is true, check if buffer = end - // special case: we've only got the special 0 character at the end - if (s->read_from_callbacks == 0) return 1; - } - - return s->img_buffer >= s->img_buffer_end; -} -#endif - -#if defined(STBI_NO_JPEG) && defined(STBI_NO_PNG) && defined(STBI_NO_BMP) && defined(STBI_NO_PSD) && defined(STBI_NO_TGA) && defined(STBI_NO_GIF) && defined(STBI_NO_PIC) -// nothing -#else -static void stbi__skip(stbi__context *s, int n) -{ - if (n == 0) return; // already there! - if (n < 0) { - s->img_buffer = s->img_buffer_end; - return; - } - if (s->io.read) { - int blen = (int) (s->img_buffer_end - s->img_buffer); - if (blen < n) { - s->img_buffer = s->img_buffer_end; - (s->io.skip)(s->io_user_data, n - blen); - return; - } - } - s->img_buffer += n; -} -#endif - -#if defined(STBI_NO_PNG) && defined(STBI_NO_TGA) && defined(STBI_NO_HDR) && defined(STBI_NO_PNM) -// nothing -#else -static int stbi__getn(stbi__context *s, stbi_uc *buffer, int n) -{ - if (s->io.read) { - int blen = (int) (s->img_buffer_end - s->img_buffer); - if (blen < n) { - int res, count; - - memcpy(buffer, s->img_buffer, blen); - - count = (s->io.read)(s->io_user_data, (char*) buffer + blen, n - blen); - res = (count == (n-blen)); - s->img_buffer = s->img_buffer_end; - return res; - } - } - - if (s->img_buffer+n <= s->img_buffer_end) { - memcpy(buffer, s->img_buffer, n); - s->img_buffer += n; - return 1; - } else - return 0; -} -#endif - -#if defined(STBI_NO_JPEG) && defined(STBI_NO_PNG) && defined(STBI_NO_PSD) && defined(STBI_NO_PIC) -// nothing -#else -static int stbi__get16be(stbi__context *s) -{ - int z = stbi__get8(s); - return (z << 8) + stbi__get8(s); -} -#endif - -#if defined(STBI_NO_PNG) && defined(STBI_NO_PSD) && defined(STBI_NO_PIC) -// nothing -#else -static stbi__uint32 stbi__get32be(stbi__context *s) -{ - stbi__uint32 z = stbi__get16be(s); - return (z << 16) + stbi__get16be(s); -} -#endif - -#if defined(STBI_NO_BMP) && defined(STBI_NO_TGA) && defined(STBI_NO_GIF) -// nothing -#else -static int stbi__get16le(stbi__context *s) -{ - int z = stbi__get8(s); - return z + (stbi__get8(s) << 8); -} -#endif - -#ifndef STBI_NO_BMP -static stbi__uint32 stbi__get32le(stbi__context *s) -{ - stbi__uint32 z = stbi__get16le(s); - z += (stbi__uint32)stbi__get16le(s) << 16; - return z; -} -#endif - -#define STBI__BYTECAST(x) ((stbi_uc) ((x) & 255)) // truncate int to byte without warnings - -#if defined(STBI_NO_JPEG) && defined(STBI_NO_PNG) && defined(STBI_NO_BMP) && defined(STBI_NO_PSD) && defined(STBI_NO_TGA) && defined(STBI_NO_GIF) && defined(STBI_NO_PIC) && defined(STBI_NO_PNM) -// nothing -#else -////////////////////////////////////////////////////////////////////////////// -// -// generic converter from built-in img_n to req_comp -// individual types do this automatically as much as possible (e.g. jpeg -// does all cases internally since it needs to colorspace convert anyway, -// and it never has alpha, so very few cases ). png can automatically -// interleave an alpha=255 channel, but falls back to this for other cases -// -// assume data buffer is malloced, so malloc a new one and free that one -// only failure mode is malloc failing - -static stbi_uc stbi__compute_y(int r, int g, int b) -{ - return (stbi_uc) (((r*77) + (g*150) + (29*b)) >> 8); -} -#endif - -#if defined(STBI_NO_PNG) && defined(STBI_NO_BMP) && defined(STBI_NO_PSD) && defined(STBI_NO_TGA) && defined(STBI_NO_GIF) && defined(STBI_NO_PIC) && defined(STBI_NO_PNM) -// nothing -#else -static unsigned char *stbi__convert_format(unsigned char *data, int img_n, int req_comp, unsigned int x, unsigned int y) -{ - int i,j; - unsigned char *good; - - if (req_comp == img_n) return data; - STBI_ASSERT(req_comp >= 1 && req_comp <= 4); - - good = (unsigned char *) stbi__malloc_mad3(req_comp, x, y, 0); - if (good == NULL) { - STBI_FREE(data); - return stbi__errpuc("outofmem", "Out of memory"); - } - - for (j=0; j < (int) y; ++j) { - unsigned char *src = data + j * x * img_n ; - unsigned char *dest = good + j * x * req_comp; - - #define STBI__COMBO(a,b) ((a)*8+(b)) - #define STBI__CASE(a,b) case STBI__COMBO(a,b): for(i=x-1; i >= 0; --i, src += a, dest += b) - // convert source image with img_n components to one with req_comp components; - // avoid switch per pixel, so use switch per scanline and massive macros - switch (STBI__COMBO(img_n, req_comp)) { - STBI__CASE(1,2) { dest[0]=src[0]; dest[1]=255; } break; - STBI__CASE(1,3) { dest[0]=dest[1]=dest[2]=src[0]; } break; - STBI__CASE(1,4) { dest[0]=dest[1]=dest[2]=src[0]; dest[3]=255; } break; - STBI__CASE(2,1) { dest[0]=src[0]; } break; - STBI__CASE(2,3) { dest[0]=dest[1]=dest[2]=src[0]; } break; - STBI__CASE(2,4) { dest[0]=dest[1]=dest[2]=src[0]; dest[3]=src[1]; } break; - STBI__CASE(3,4) { dest[0]=src[0];dest[1]=src[1];dest[2]=src[2];dest[3]=255; } break; - STBI__CASE(3,1) { dest[0]=stbi__compute_y(src[0],src[1],src[2]); } break; - STBI__CASE(3,2) { dest[0]=stbi__compute_y(src[0],src[1],src[2]); dest[1] = 255; } break; - STBI__CASE(4,1) { dest[0]=stbi__compute_y(src[0],src[1],src[2]); } break; - STBI__CASE(4,2) { dest[0]=stbi__compute_y(src[0],src[1],src[2]); dest[1] = src[3]; } break; - STBI__CASE(4,3) { dest[0]=src[0];dest[1]=src[1];dest[2]=src[2]; } break; - default: STBI_ASSERT(0); STBI_FREE(data); STBI_FREE(good); return stbi__errpuc("unsupported", "Unsupported format conversion"); - } - #undef STBI__CASE - } - - STBI_FREE(data); - return good; -} -#endif - -#if defined(STBI_NO_PNG) && defined(STBI_NO_PSD) -// nothing -#else -static stbi__uint16 stbi__compute_y_16(int r, int g, int b) -{ - return (stbi__uint16) (((r*77) + (g*150) + (29*b)) >> 8); -} -#endif - -#if defined(STBI_NO_PNG) && defined(STBI_NO_PSD) -// nothing -#else -static stbi__uint16 *stbi__convert_format16(stbi__uint16 *data, int img_n, int req_comp, unsigned int x, unsigned int y) -{ - int i,j; - stbi__uint16 *good; - - if (req_comp == img_n) return data; - STBI_ASSERT(req_comp >= 1 && req_comp <= 4); - - good = (stbi__uint16 *) stbi__malloc(req_comp * x * y * 2); - if (good == NULL) { - STBI_FREE(data); - return (stbi__uint16 *) stbi__errpuc("outofmem", "Out of memory"); - } - - for (j=0; j < (int) y; ++j) { - stbi__uint16 *src = data + j * x * img_n ; - stbi__uint16 *dest = good + j * x * req_comp; - - #define STBI__COMBO(a,b) ((a)*8+(b)) - #define STBI__CASE(a,b) case STBI__COMBO(a,b): for(i=x-1; i >= 0; --i, src += a, dest += b) - // convert source image with img_n components to one with req_comp components; - // avoid switch per pixel, so use switch per scanline and massive macros - switch (STBI__COMBO(img_n, req_comp)) { - STBI__CASE(1,2) { dest[0]=src[0]; dest[1]=0xffff; } break; - STBI__CASE(1,3) { dest[0]=dest[1]=dest[2]=src[0]; } break; - STBI__CASE(1,4) { dest[0]=dest[1]=dest[2]=src[0]; dest[3]=0xffff; } break; - STBI__CASE(2,1) { dest[0]=src[0]; } break; - STBI__CASE(2,3) { dest[0]=dest[1]=dest[2]=src[0]; } break; - STBI__CASE(2,4) { dest[0]=dest[1]=dest[2]=src[0]; dest[3]=src[1]; } break; - STBI__CASE(3,4) { dest[0]=src[0];dest[1]=src[1];dest[2]=src[2];dest[3]=0xffff; } break; - STBI__CASE(3,1) { dest[0]=stbi__compute_y_16(src[0],src[1],src[2]); } break; - STBI__CASE(3,2) { dest[0]=stbi__compute_y_16(src[0],src[1],src[2]); dest[1] = 0xffff; } break; - STBI__CASE(4,1) { dest[0]=stbi__compute_y_16(src[0],src[1],src[2]); } break; - STBI__CASE(4,2) { dest[0]=stbi__compute_y_16(src[0],src[1],src[2]); dest[1] = src[3]; } break; - STBI__CASE(4,3) { dest[0]=src[0];dest[1]=src[1];dest[2]=src[2]; } break; - default: STBI_ASSERT(0); STBI_FREE(data); STBI_FREE(good); return (stbi__uint16*) stbi__errpuc("unsupported", "Unsupported format conversion"); - } - #undef STBI__CASE - } - - STBI_FREE(data); - return good; -} -#endif - -#ifndef STBI_NO_LINEAR -static float *stbi__ldr_to_hdr(stbi_uc *data, int x, int y, int comp) -{ - int i,k,n; - float *output; - if (!data) return NULL; - output = (float *) stbi__malloc_mad4(x, y, comp, sizeof(float), 0); - if (output == NULL) { STBI_FREE(data); return stbi__errpf("outofmem", "Out of memory"); } - // compute number of non-alpha components - if (comp & 1) n = comp; else n = comp-1; - for (i=0; i < x*y; ++i) { - for (k=0; k < n; ++k) { - output[i*comp + k] = (float) (pow(data[i*comp+k]/255.0f, stbi__l2h_gamma) * stbi__l2h_scale); - } - } - if (n < comp) { - for (i=0; i < x*y; ++i) { - output[i*comp + n] = data[i*comp + n]/255.0f; - } - } - STBI_FREE(data); - return output; -} -#endif - -#ifndef STBI_NO_HDR -#define stbi__float2int(x) ((int) (x)) -static stbi_uc *stbi__hdr_to_ldr(float *data, int x, int y, int comp) -{ - int i,k,n; - stbi_uc *output; - if (!data) return NULL; - output = (stbi_uc *) stbi__malloc_mad3(x, y, comp, 0); - if (output == NULL) { STBI_FREE(data); return stbi__errpuc("outofmem", "Out of memory"); } - // compute number of non-alpha components - if (comp & 1) n = comp; else n = comp-1; - for (i=0; i < x*y; ++i) { - for (k=0; k < n; ++k) { - float z = (float) pow(data[i*comp+k]*stbi__h2l_scale_i, stbi__h2l_gamma_i) * 255 + 0.5f; - if (z < 0) z = 0; - if (z > 255) z = 255; - output[i*comp + k] = (stbi_uc) stbi__float2int(z); - } - if (k < comp) { - float z = data[i*comp+k] * 255 + 0.5f; - if (z < 0) z = 0; - if (z > 255) z = 255; - output[i*comp + k] = (stbi_uc) stbi__float2int(z); - } - } - STBI_FREE(data); - return output; -} -#endif - -////////////////////////////////////////////////////////////////////////////// -// -// "baseline" JPEG/JFIF decoder -// -// simple implementation -// - doesn't support delayed output of y-dimension -// - simple interface (only one output format: 8-bit interleaved RGB) -// - doesn't try to recover corrupt jpegs -// - doesn't allow partial loading, loading multiple at once -// - still fast on x86 (copying globals into locals doesn't help x86) -// - allocates lots of intermediate memory (full size of all components) -// - non-interleaved case requires this anyway -// - allows good upsampling (see next) -// high-quality -// - upsampled channels are bilinearly interpolated, even across blocks -// - quality integer IDCT derived from IJG's 'slow' -// performance -// - fast huffman; reasonable integer IDCT -// - some SIMD kernels for common paths on targets with SSE2/NEON -// - uses a lot of intermediate memory, could cache poorly - -#ifndef STBI_NO_JPEG - -// huffman decoding acceleration -#define FAST_BITS 9 // larger handles more cases; smaller stomps less cache - -typedef struct -{ - stbi_uc fast[1 << FAST_BITS]; - // weirdly, repacking this into AoS is a 10% speed loss, instead of a win - stbi__uint16 code[256]; - stbi_uc values[256]; - stbi_uc size[257]; - unsigned int maxcode[18]; - int delta[17]; // old 'firstsymbol' - old 'firstcode' -} stbi__huffman; - -typedef struct -{ - stbi__context *s; - stbi__huffman huff_dc[4]; - stbi__huffman huff_ac[4]; - stbi__uint16 dequant[4][64]; - stbi__int16 fast_ac[4][1 << FAST_BITS]; - -// sizes for components, interleaved MCUs - int img_h_max, img_v_max; - int img_mcu_x, img_mcu_y; - int img_mcu_w, img_mcu_h; - -// definition of jpeg image component - struct - { - int id; - int h,v; - int tq; - int hd,ha; - int dc_pred; - - int x,y,w2,h2; - stbi_uc *data; - void *raw_data, *raw_coeff; - stbi_uc *linebuf; - short *coeff; // progressive only - int coeff_w, coeff_h; // number of 8x8 coefficient blocks - } img_comp[4]; - - stbi__uint32 code_buffer; // jpeg entropy-coded buffer - int code_bits; // number of valid bits - unsigned char marker; // marker seen while filling entropy buffer - int nomore; // flag if we saw a marker so must stop - - int progressive; - int spec_start; - int spec_end; - int succ_high; - int succ_low; - int eob_run; - int jfif; - int app14_color_transform; // Adobe APP14 tag - int rgb; - - int scan_n, order[4]; - int restart_interval, todo; - -// kernels - void (*idct_block_kernel)(stbi_uc *out, int out_stride, short data[64]); - void (*YCbCr_to_RGB_kernel)(stbi_uc *out, const stbi_uc *y, const stbi_uc *pcb, const stbi_uc *pcr, int count, int step); - stbi_uc *(*resample_row_hv_2_kernel)(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs); -} stbi__jpeg; - -static int stbi__build_huffman(stbi__huffman *h, int *count) -{ - int i,j,k=0; - unsigned int code; - // build size list for each symbol (from JPEG spec) - for (i=0; i < 16; ++i) { - for (j=0; j < count[i]; ++j) { - h->size[k++] = (stbi_uc) (i+1); - if(k >= 257) return stbi__err("bad size list","Corrupt JPEG"); - } - } - h->size[k] = 0; - - // compute actual symbols (from jpeg spec) - code = 0; - k = 0; - for(j=1; j <= 16; ++j) { - // compute delta to add to code to compute symbol id - h->delta[j] = k - code; - if (h->size[k] == j) { - while (h->size[k] == j) - h->code[k++] = (stbi__uint16) (code++); - if (code-1 >= (1u << j)) return stbi__err("bad code lengths","Corrupt JPEG"); - } - // compute largest code + 1 for this size, preshifted as needed later - h->maxcode[j] = code << (16-j); - code <<= 1; - } - h->maxcode[j] = 0xffffffff; - - // build non-spec acceleration table; 255 is flag for not-accelerated - memset(h->fast, 255, 1 << FAST_BITS); - for (i=0; i < k; ++i) { - int s = h->size[i]; - if (s <= FAST_BITS) { - int c = h->code[i] << (FAST_BITS-s); - int m = 1 << (FAST_BITS-s); - for (j=0; j < m; ++j) { - h->fast[c+j] = (stbi_uc) i; - } - } - } - return 1; -} - -// build a table that decodes both magnitude and value of small ACs in -// one go. -static void stbi__build_fast_ac(stbi__int16 *fast_ac, stbi__huffman *h) -{ - int i; - for (i=0; i < (1 << FAST_BITS); ++i) { - stbi_uc fast = h->fast[i]; - fast_ac[i] = 0; - if (fast < 255) { - int rs = h->values[fast]; - int run = (rs >> 4) & 15; - int magbits = rs & 15; - int len = h->size[fast]; - - if (magbits && len + magbits <= FAST_BITS) { - // magnitude code followed by receive_extend code - int k = ((i << len) & ((1 << FAST_BITS) - 1)) >> (FAST_BITS - magbits); - int m = 1 << (magbits - 1); - if (k < m) k += (~0U << magbits) + 1; - // if the result is small enough, we can fit it in fast_ac table - if (k >= -128 && k <= 127) - fast_ac[i] = (stbi__int16) ((k * 256) + (run * 16) + (len + magbits)); - } - } - } -} - -static void stbi__grow_buffer_unsafe(stbi__jpeg *j) -{ - do { - unsigned int b = j->nomore ? 0 : stbi__get8(j->s); - if (b == 0xff) { - int c = stbi__get8(j->s); - while (c == 0xff) c = stbi__get8(j->s); // consume fill bytes - if (c != 0) { - j->marker = (unsigned char) c; - j->nomore = 1; - return; - } - } - j->code_buffer |= b << (24 - j->code_bits); - j->code_bits += 8; - } while (j->code_bits <= 24); -} - -// (1 << n) - 1 -static const stbi__uint32 stbi__bmask[17]={0,1,3,7,15,31,63,127,255,511,1023,2047,4095,8191,16383,32767,65535}; - -// decode a jpeg huffman value from the bitstream -stbi_inline static int stbi__jpeg_huff_decode(stbi__jpeg *j, stbi__huffman *h) -{ - unsigned int temp; - int c,k; - - if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); - - // look at the top FAST_BITS and determine what symbol ID it is, - // if the code is <= FAST_BITS - c = (j->code_buffer >> (32 - FAST_BITS)) & ((1 << FAST_BITS)-1); - k = h->fast[c]; - if (k < 255) { - int s = h->size[k]; - if (s > j->code_bits) - return -1; - j->code_buffer <<= s; - j->code_bits -= s; - return h->values[k]; - } - - // naive test is to shift the code_buffer down so k bits are - // valid, then test against maxcode. To speed this up, we've - // preshifted maxcode left so that it has (16-k) 0s at the - // end; in other words, regardless of the number of bits, it - // wants to be compared against something shifted to have 16; - // that way we don't need to shift inside the loop. - temp = j->code_buffer >> 16; - for (k=FAST_BITS+1 ; ; ++k) - if (temp < h->maxcode[k]) - break; - if (k == 17) { - // error! code not found - j->code_bits -= 16; - return -1; - } - - if (k > j->code_bits) - return -1; - - // convert the huffman code to the symbol id - c = ((j->code_buffer >> (32 - k)) & stbi__bmask[k]) + h->delta[k]; - if(c < 0 || c >= 256) // symbol id out of bounds! - return -1; - STBI_ASSERT((((j->code_buffer) >> (32 - h->size[c])) & stbi__bmask[h->size[c]]) == h->code[c]); - - // convert the id to a symbol - j->code_bits -= k; - j->code_buffer <<= k; - return h->values[c]; -} - -// bias[n] = (-1<code_bits < n) stbi__grow_buffer_unsafe(j); - if (j->code_bits < n) return 0; // ran out of bits from stream, return 0s intead of continuing - - sgn = j->code_buffer >> 31; // sign bit always in MSB; 0 if MSB clear (positive), 1 if MSB set (negative) - k = stbi_lrot(j->code_buffer, n); - j->code_buffer = k & ~stbi__bmask[n]; - k &= stbi__bmask[n]; - j->code_bits -= n; - return k + (stbi__jbias[n] & (sgn - 1)); -} - -// get some unsigned bits -stbi_inline static int stbi__jpeg_get_bits(stbi__jpeg *j, int n) -{ - unsigned int k; - if (j->code_bits < n) stbi__grow_buffer_unsafe(j); - if (j->code_bits < n) return 0; // ran out of bits from stream, return 0s intead of continuing - k = stbi_lrot(j->code_buffer, n); - j->code_buffer = k & ~stbi__bmask[n]; - k &= stbi__bmask[n]; - j->code_bits -= n; - return k; -} - -stbi_inline static int stbi__jpeg_get_bit(stbi__jpeg *j) -{ - unsigned int k; - if (j->code_bits < 1) stbi__grow_buffer_unsafe(j); - if (j->code_bits < 1) return 0; // ran out of bits from stream, return 0s intead of continuing - k = j->code_buffer; - j->code_buffer <<= 1; - --j->code_bits; - return k & 0x80000000; -} - -// given a value that's at position X in the zigzag stream, -// where does it appear in the 8x8 matrix coded as row-major? -static const stbi_uc stbi__jpeg_dezigzag[64+15] = -{ - 0, 1, 8, 16, 9, 2, 3, 10, - 17, 24, 32, 25, 18, 11, 4, 5, - 12, 19, 26, 33, 40, 48, 41, 34, - 27, 20, 13, 6, 7, 14, 21, 28, - 35, 42, 49, 56, 57, 50, 43, 36, - 29, 22, 15, 23, 30, 37, 44, 51, - 58, 59, 52, 45, 38, 31, 39, 46, - 53, 60, 61, 54, 47, 55, 62, 63, - // let corrupt input sample past end - 63, 63, 63, 63, 63, 63, 63, 63, - 63, 63, 63, 63, 63, 63, 63 -}; - -// decode one 64-entry block-- -static int stbi__jpeg_decode_block(stbi__jpeg *j, short data[64], stbi__huffman *hdc, stbi__huffman *hac, stbi__int16 *fac, int b, stbi__uint16 *dequant) -{ - int diff,dc,k; - int t; - - if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); - t = stbi__jpeg_huff_decode(j, hdc); - if (t < 0 || t > 15) return stbi__err("bad huffman code","Corrupt JPEG"); - - // 0 all the ac values now so we can do it 32-bits at a time - memset(data,0,64*sizeof(data[0])); - - diff = t ? stbi__extend_receive(j, t) : 0; - if (!stbi__addints_valid(j->img_comp[b].dc_pred, diff)) return stbi__err("bad delta","Corrupt JPEG"); - dc = j->img_comp[b].dc_pred + diff; - j->img_comp[b].dc_pred = dc; - if (!stbi__mul2shorts_valid(dc, dequant[0])) return stbi__err("can't merge dc and ac", "Corrupt JPEG"); - data[0] = (short) (dc * dequant[0]); - - // decode AC components, see JPEG spec - k = 1; - do { - unsigned int zig; - int c,r,s; - if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); - c = (j->code_buffer >> (32 - FAST_BITS)) & ((1 << FAST_BITS)-1); - r = fac[c]; - if (r) { // fast-AC path - k += (r >> 4) & 15; // run - s = r & 15; // combined length - if (s > j->code_bits) return stbi__err("bad huffman code", "Combined length longer than code bits available"); - j->code_buffer <<= s; - j->code_bits -= s; - // decode into unzigzag'd location - zig = stbi__jpeg_dezigzag[k++]; - data[zig] = (short) ((r >> 8) * dequant[zig]); - } else { - int rs = stbi__jpeg_huff_decode(j, hac); - if (rs < 0) return stbi__err("bad huffman code","Corrupt JPEG"); - s = rs & 15; - r = rs >> 4; - if (s == 0) { - if (rs != 0xf0) break; // end block - k += 16; - } else { - k += r; - // decode into unzigzag'd location - zig = stbi__jpeg_dezigzag[k++]; - data[zig] = (short) (stbi__extend_receive(j,s) * dequant[zig]); - } - } - } while (k < 64); - return 1; -} - -static int stbi__jpeg_decode_block_prog_dc(stbi__jpeg *j, short data[64], stbi__huffman *hdc, int b) -{ - int diff,dc; - int t; - if (j->spec_end != 0) return stbi__err("can't merge dc and ac", "Corrupt JPEG"); - - if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); - - if (j->succ_high == 0) { - // first scan for DC coefficient, must be first - memset(data,0,64*sizeof(data[0])); // 0 all the ac values now - t = stbi__jpeg_huff_decode(j, hdc); - if (t < 0 || t > 15) return stbi__err("can't merge dc and ac", "Corrupt JPEG"); - diff = t ? stbi__extend_receive(j, t) : 0; - - if (!stbi__addints_valid(j->img_comp[b].dc_pred, diff)) return stbi__err("bad delta", "Corrupt JPEG"); - dc = j->img_comp[b].dc_pred + diff; - j->img_comp[b].dc_pred = dc; - if (!stbi__mul2shorts_valid(dc, 1 << j->succ_low)) return stbi__err("can't merge dc and ac", "Corrupt JPEG"); - data[0] = (short) (dc * (1 << j->succ_low)); - } else { - // refinement scan for DC coefficient - if (stbi__jpeg_get_bit(j)) - data[0] += (short) (1 << j->succ_low); - } - return 1; -} - -// @OPTIMIZE: store non-zigzagged during the decode passes, -// and only de-zigzag when dequantizing -static int stbi__jpeg_decode_block_prog_ac(stbi__jpeg *j, short data[64], stbi__huffman *hac, stbi__int16 *fac) -{ - int k; - if (j->spec_start == 0) return stbi__err("can't merge dc and ac", "Corrupt JPEG"); - - if (j->succ_high == 0) { - int shift = j->succ_low; - - if (j->eob_run) { - --j->eob_run; - return 1; - } - - k = j->spec_start; - do { - unsigned int zig; - int c,r,s; - if (j->code_bits < 16) stbi__grow_buffer_unsafe(j); - c = (j->code_buffer >> (32 - FAST_BITS)) & ((1 << FAST_BITS)-1); - r = fac[c]; - if (r) { // fast-AC path - k += (r >> 4) & 15; // run - s = r & 15; // combined length - if (s > j->code_bits) return stbi__err("bad huffman code", "Combined length longer than code bits available"); - j->code_buffer <<= s; - j->code_bits -= s; - zig = stbi__jpeg_dezigzag[k++]; - data[zig] = (short) ((r >> 8) * (1 << shift)); - } else { - int rs = stbi__jpeg_huff_decode(j, hac); - if (rs < 0) return stbi__err("bad huffman code","Corrupt JPEG"); - s = rs & 15; - r = rs >> 4; - if (s == 0) { - if (r < 15) { - j->eob_run = (1 << r); - if (r) - j->eob_run += stbi__jpeg_get_bits(j, r); - --j->eob_run; - break; - } - k += 16; - } else { - k += r; - zig = stbi__jpeg_dezigzag[k++]; - data[zig] = (short) (stbi__extend_receive(j,s) * (1 << shift)); - } - } - } while (k <= j->spec_end); - } else { - // refinement scan for these AC coefficients - - short bit = (short) (1 << j->succ_low); - - if (j->eob_run) { - --j->eob_run; - for (k = j->spec_start; k <= j->spec_end; ++k) { - short *p = &data[stbi__jpeg_dezigzag[k]]; - if (*p != 0) - if (stbi__jpeg_get_bit(j)) - if ((*p & bit)==0) { - if (*p > 0) - *p += bit; - else - *p -= bit; - } - } - } else { - k = j->spec_start; - do { - int r,s; - int rs = stbi__jpeg_huff_decode(j, hac); // @OPTIMIZE see if we can use the fast path here, advance-by-r is so slow, eh - if (rs < 0) return stbi__err("bad huffman code","Corrupt JPEG"); - s = rs & 15; - r = rs >> 4; - if (s == 0) { - if (r < 15) { - j->eob_run = (1 << r) - 1; - if (r) - j->eob_run += stbi__jpeg_get_bits(j, r); - r = 64; // force end of block - } else { - // r=15 s=0 should write 16 0s, so we just do - // a run of 15 0s and then write s (which is 0), - // so we don't have to do anything special here - } - } else { - if (s != 1) return stbi__err("bad huffman code", "Corrupt JPEG"); - // sign bit - if (stbi__jpeg_get_bit(j)) - s = bit; - else - s = -bit; - } - - // advance by r - while (k <= j->spec_end) { - short *p = &data[stbi__jpeg_dezigzag[k++]]; - if (*p != 0) { - if (stbi__jpeg_get_bit(j)) - if ((*p & bit)==0) { - if (*p > 0) - *p += bit; - else - *p -= bit; - } - } else { - if (r == 0) { - *p = (short) s; - break; - } - --r; - } - } - } while (k <= j->spec_end); - } - } - return 1; -} - -// take a -128..127 value and stbi__clamp it and convert to 0..255 -stbi_inline static stbi_uc stbi__clamp(int x) -{ - // trick to use a single test to catch both cases - if ((unsigned int) x > 255) { - if (x < 0) return 0; - if (x > 255) return 255; - } - return (stbi_uc) x; -} - -#define stbi__f2f(x) ((int) (((x) * 4096 + 0.5))) -#define stbi__fsh(x) ((x) * 4096) - -// derived from jidctint -- DCT_ISLOW -#define STBI__IDCT_1D(s0,s1,s2,s3,s4,s5,s6,s7) \ - int t0,t1,t2,t3,p1,p2,p3,p4,p5,x0,x1,x2,x3; \ - p2 = s2; \ - p3 = s6; \ - p1 = (p2+p3) * stbi__f2f(0.5411961f); \ - t2 = p1 + p3*stbi__f2f(-1.847759065f); \ - t3 = p1 + p2*stbi__f2f( 0.765366865f); \ - p2 = s0; \ - p3 = s4; \ - t0 = stbi__fsh(p2+p3); \ - t1 = stbi__fsh(p2-p3); \ - x0 = t0+t3; \ - x3 = t0-t3; \ - x1 = t1+t2; \ - x2 = t1-t2; \ - t0 = s7; \ - t1 = s5; \ - t2 = s3; \ - t3 = s1; \ - p3 = t0+t2; \ - p4 = t1+t3; \ - p1 = t0+t3; \ - p2 = t1+t2; \ - p5 = (p3+p4)*stbi__f2f( 1.175875602f); \ - t0 = t0*stbi__f2f( 0.298631336f); \ - t1 = t1*stbi__f2f( 2.053119869f); \ - t2 = t2*stbi__f2f( 3.072711026f); \ - t3 = t3*stbi__f2f( 1.501321110f); \ - p1 = p5 + p1*stbi__f2f(-0.899976223f); \ - p2 = p5 + p2*stbi__f2f(-2.562915447f); \ - p3 = p3*stbi__f2f(-1.961570560f); \ - p4 = p4*stbi__f2f(-0.390180644f); \ - t3 += p1+p4; \ - t2 += p2+p3; \ - t1 += p2+p4; \ - t0 += p1+p3; - -static void stbi__idct_block(stbi_uc *out, int out_stride, short data[64]) -{ - int i,val[64],*v=val; - stbi_uc *o; - short *d = data; - - // columns - for (i=0; i < 8; ++i,++d, ++v) { - // if all zeroes, shortcut -- this avoids dequantizing 0s and IDCTing - if (d[ 8]==0 && d[16]==0 && d[24]==0 && d[32]==0 - && d[40]==0 && d[48]==0 && d[56]==0) { - // no shortcut 0 seconds - // (1|2|3|4|5|6|7)==0 0 seconds - // all separate -0.047 seconds - // 1 && 2|3 && 4|5 && 6|7: -0.047 seconds - int dcterm = d[0]*4; - v[0] = v[8] = v[16] = v[24] = v[32] = v[40] = v[48] = v[56] = dcterm; - } else { - STBI__IDCT_1D(d[ 0],d[ 8],d[16],d[24],d[32],d[40],d[48],d[56]) - // constants scaled things up by 1<<12; let's bring them back - // down, but keep 2 extra bits of precision - x0 += 512; x1 += 512; x2 += 512; x3 += 512; - v[ 0] = (x0+t3) >> 10; - v[56] = (x0-t3) >> 10; - v[ 8] = (x1+t2) >> 10; - v[48] = (x1-t2) >> 10; - v[16] = (x2+t1) >> 10; - v[40] = (x2-t1) >> 10; - v[24] = (x3+t0) >> 10; - v[32] = (x3-t0) >> 10; - } - } - - for (i=0, v=val, o=out; i < 8; ++i,v+=8,o+=out_stride) { - // no fast case since the first 1D IDCT spread components out - STBI__IDCT_1D(v[0],v[1],v[2],v[3],v[4],v[5],v[6],v[7]) - // constants scaled things up by 1<<12, plus we had 1<<2 from first - // loop, plus horizontal and vertical each scale by sqrt(8) so together - // we've got an extra 1<<3, so 1<<17 total we need to remove. - // so we want to round that, which means adding 0.5 * 1<<17, - // aka 65536. Also, we'll end up with -128 to 127 that we want - // to encode as 0..255 by adding 128, so we'll add that before the shift - x0 += 65536 + (128<<17); - x1 += 65536 + (128<<17); - x2 += 65536 + (128<<17); - x3 += 65536 + (128<<17); - // tried computing the shifts into temps, or'ing the temps to see - // if any were out of range, but that was slower - o[0] = stbi__clamp((x0+t3) >> 17); - o[7] = stbi__clamp((x0-t3) >> 17); - o[1] = stbi__clamp((x1+t2) >> 17); - o[6] = stbi__clamp((x1-t2) >> 17); - o[2] = stbi__clamp((x2+t1) >> 17); - o[5] = stbi__clamp((x2-t1) >> 17); - o[3] = stbi__clamp((x3+t0) >> 17); - o[4] = stbi__clamp((x3-t0) >> 17); - } -} - -#ifdef STBI_SSE2 -// sse2 integer IDCT. not the fastest possible implementation but it -// produces bit-identical results to the generic C version so it's -// fully "transparent". -static void stbi__idct_simd(stbi_uc *out, int out_stride, short data[64]) -{ - // This is constructed to match our regular (generic) integer IDCT exactly. - __m128i row0, row1, row2, row3, row4, row5, row6, row7; - __m128i tmp; - - // dot product constant: even elems=x, odd elems=y - #define dct_const(x,y) _mm_setr_epi16((x),(y),(x),(y),(x),(y),(x),(y)) - - // out(0) = c0[even]*x + c0[odd]*y (c0, x, y 16-bit, out 32-bit) - // out(1) = c1[even]*x + c1[odd]*y - #define dct_rot(out0,out1, x,y,c0,c1) \ - __m128i c0##lo = _mm_unpacklo_epi16((x),(y)); \ - __m128i c0##hi = _mm_unpackhi_epi16((x),(y)); \ - __m128i out0##_l = _mm_madd_epi16(c0##lo, c0); \ - __m128i out0##_h = _mm_madd_epi16(c0##hi, c0); \ - __m128i out1##_l = _mm_madd_epi16(c0##lo, c1); \ - __m128i out1##_h = _mm_madd_epi16(c0##hi, c1) - - // out = in << 12 (in 16-bit, out 32-bit) - #define dct_widen(out, in) \ - __m128i out##_l = _mm_srai_epi32(_mm_unpacklo_epi16(_mm_setzero_si128(), (in)), 4); \ - __m128i out##_h = _mm_srai_epi32(_mm_unpackhi_epi16(_mm_setzero_si128(), (in)), 4) - - // wide add - #define dct_wadd(out, a, b) \ - __m128i out##_l = _mm_add_epi32(a##_l, b##_l); \ - __m128i out##_h = _mm_add_epi32(a##_h, b##_h) - - // wide sub - #define dct_wsub(out, a, b) \ - __m128i out##_l = _mm_sub_epi32(a##_l, b##_l); \ - __m128i out##_h = _mm_sub_epi32(a##_h, b##_h) - - // butterfly a/b, add bias, then shift by "s" and pack - #define dct_bfly32o(out0, out1, a,b,bias,s) \ - { \ - __m128i abiased_l = _mm_add_epi32(a##_l, bias); \ - __m128i abiased_h = _mm_add_epi32(a##_h, bias); \ - dct_wadd(sum, abiased, b); \ - dct_wsub(dif, abiased, b); \ - out0 = _mm_packs_epi32(_mm_srai_epi32(sum_l, s), _mm_srai_epi32(sum_h, s)); \ - out1 = _mm_packs_epi32(_mm_srai_epi32(dif_l, s), _mm_srai_epi32(dif_h, s)); \ - } - - // 8-bit interleave step (for transposes) - #define dct_interleave8(a, b) \ - tmp = a; \ - a = _mm_unpacklo_epi8(a, b); \ - b = _mm_unpackhi_epi8(tmp, b) - - // 16-bit interleave step (for transposes) - #define dct_interleave16(a, b) \ - tmp = a; \ - a = _mm_unpacklo_epi16(a, b); \ - b = _mm_unpackhi_epi16(tmp, b) - - #define dct_pass(bias,shift) \ - { \ - /* even part */ \ - dct_rot(t2e,t3e, row2,row6, rot0_0,rot0_1); \ - __m128i sum04 = _mm_add_epi16(row0, row4); \ - __m128i dif04 = _mm_sub_epi16(row0, row4); \ - dct_widen(t0e, sum04); \ - dct_widen(t1e, dif04); \ - dct_wadd(x0, t0e, t3e); \ - dct_wsub(x3, t0e, t3e); \ - dct_wadd(x1, t1e, t2e); \ - dct_wsub(x2, t1e, t2e); \ - /* odd part */ \ - dct_rot(y0o,y2o, row7,row3, rot2_0,rot2_1); \ - dct_rot(y1o,y3o, row5,row1, rot3_0,rot3_1); \ - __m128i sum17 = _mm_add_epi16(row1, row7); \ - __m128i sum35 = _mm_add_epi16(row3, row5); \ - dct_rot(y4o,y5o, sum17,sum35, rot1_0,rot1_1); \ - dct_wadd(x4, y0o, y4o); \ - dct_wadd(x5, y1o, y5o); \ - dct_wadd(x6, y2o, y5o); \ - dct_wadd(x7, y3o, y4o); \ - dct_bfly32o(row0,row7, x0,x7,bias,shift); \ - dct_bfly32o(row1,row6, x1,x6,bias,shift); \ - dct_bfly32o(row2,row5, x2,x5,bias,shift); \ - dct_bfly32o(row3,row4, x3,x4,bias,shift); \ - } - - __m128i rot0_0 = dct_const(stbi__f2f(0.5411961f), stbi__f2f(0.5411961f) + stbi__f2f(-1.847759065f)); - __m128i rot0_1 = dct_const(stbi__f2f(0.5411961f) + stbi__f2f( 0.765366865f), stbi__f2f(0.5411961f)); - __m128i rot1_0 = dct_const(stbi__f2f(1.175875602f) + stbi__f2f(-0.899976223f), stbi__f2f(1.175875602f)); - __m128i rot1_1 = dct_const(stbi__f2f(1.175875602f), stbi__f2f(1.175875602f) + stbi__f2f(-2.562915447f)); - __m128i rot2_0 = dct_const(stbi__f2f(-1.961570560f) + stbi__f2f( 0.298631336f), stbi__f2f(-1.961570560f)); - __m128i rot2_1 = dct_const(stbi__f2f(-1.961570560f), stbi__f2f(-1.961570560f) + stbi__f2f( 3.072711026f)); - __m128i rot3_0 = dct_const(stbi__f2f(-0.390180644f) + stbi__f2f( 2.053119869f), stbi__f2f(-0.390180644f)); - __m128i rot3_1 = dct_const(stbi__f2f(-0.390180644f), stbi__f2f(-0.390180644f) + stbi__f2f( 1.501321110f)); - - // rounding biases in column/row passes, see stbi__idct_block for explanation. - __m128i bias_0 = _mm_set1_epi32(512); - __m128i bias_1 = _mm_set1_epi32(65536 + (128<<17)); - - // load - row0 = _mm_load_si128((const __m128i *) (data + 0*8)); - row1 = _mm_load_si128((const __m128i *) (data + 1*8)); - row2 = _mm_load_si128((const __m128i *) (data + 2*8)); - row3 = _mm_load_si128((const __m128i *) (data + 3*8)); - row4 = _mm_load_si128((const __m128i *) (data + 4*8)); - row5 = _mm_load_si128((const __m128i *) (data + 5*8)); - row6 = _mm_load_si128((const __m128i *) (data + 6*8)); - row7 = _mm_load_si128((const __m128i *) (data + 7*8)); - - // column pass - dct_pass(bias_0, 10); - - { - // 16bit 8x8 transpose pass 1 - dct_interleave16(row0, row4); - dct_interleave16(row1, row5); - dct_interleave16(row2, row6); - dct_interleave16(row3, row7); - - // transpose pass 2 - dct_interleave16(row0, row2); - dct_interleave16(row1, row3); - dct_interleave16(row4, row6); - dct_interleave16(row5, row7); - - // transpose pass 3 - dct_interleave16(row0, row1); - dct_interleave16(row2, row3); - dct_interleave16(row4, row5); - dct_interleave16(row6, row7); - } - - // row pass - dct_pass(bias_1, 17); - - { - // pack - __m128i p0 = _mm_packus_epi16(row0, row1); // a0a1a2a3...a7b0b1b2b3...b7 - __m128i p1 = _mm_packus_epi16(row2, row3); - __m128i p2 = _mm_packus_epi16(row4, row5); - __m128i p3 = _mm_packus_epi16(row6, row7); - - // 8bit 8x8 transpose pass 1 - dct_interleave8(p0, p2); // a0e0a1e1... - dct_interleave8(p1, p3); // c0g0c1g1... - - // transpose pass 2 - dct_interleave8(p0, p1); // a0c0e0g0... - dct_interleave8(p2, p3); // b0d0f0h0... - - // transpose pass 3 - dct_interleave8(p0, p2); // a0b0c0d0... - dct_interleave8(p1, p3); // a4b4c4d4... - - // store - _mm_storel_epi64((__m128i *) out, p0); out += out_stride; - _mm_storel_epi64((__m128i *) out, _mm_shuffle_epi32(p0, 0x4e)); out += out_stride; - _mm_storel_epi64((__m128i *) out, p2); out += out_stride; - _mm_storel_epi64((__m128i *) out, _mm_shuffle_epi32(p2, 0x4e)); out += out_stride; - _mm_storel_epi64((__m128i *) out, p1); out += out_stride; - _mm_storel_epi64((__m128i *) out, _mm_shuffle_epi32(p1, 0x4e)); out += out_stride; - _mm_storel_epi64((__m128i *) out, p3); out += out_stride; - _mm_storel_epi64((__m128i *) out, _mm_shuffle_epi32(p3, 0x4e)); - } - -#undef dct_const -#undef dct_rot -#undef dct_widen -#undef dct_wadd -#undef dct_wsub -#undef dct_bfly32o -#undef dct_interleave8 -#undef dct_interleave16 -#undef dct_pass -} - -#endif // STBI_SSE2 - -#ifdef STBI_NEON - -// NEON integer IDCT. should produce bit-identical -// results to the generic C version. -static void stbi__idct_simd(stbi_uc *out, int out_stride, short data[64]) -{ - int16x8_t row0, row1, row2, row3, row4, row5, row6, row7; - - int16x4_t rot0_0 = vdup_n_s16(stbi__f2f(0.5411961f)); - int16x4_t rot0_1 = vdup_n_s16(stbi__f2f(-1.847759065f)); - int16x4_t rot0_2 = vdup_n_s16(stbi__f2f( 0.765366865f)); - int16x4_t rot1_0 = vdup_n_s16(stbi__f2f( 1.175875602f)); - int16x4_t rot1_1 = vdup_n_s16(stbi__f2f(-0.899976223f)); - int16x4_t rot1_2 = vdup_n_s16(stbi__f2f(-2.562915447f)); - int16x4_t rot2_0 = vdup_n_s16(stbi__f2f(-1.961570560f)); - int16x4_t rot2_1 = vdup_n_s16(stbi__f2f(-0.390180644f)); - int16x4_t rot3_0 = vdup_n_s16(stbi__f2f( 0.298631336f)); - int16x4_t rot3_1 = vdup_n_s16(stbi__f2f( 2.053119869f)); - int16x4_t rot3_2 = vdup_n_s16(stbi__f2f( 3.072711026f)); - int16x4_t rot3_3 = vdup_n_s16(stbi__f2f( 1.501321110f)); - -#define dct_long_mul(out, inq, coeff) \ - int32x4_t out##_l = vmull_s16(vget_low_s16(inq), coeff); \ - int32x4_t out##_h = vmull_s16(vget_high_s16(inq), coeff) - -#define dct_long_mac(out, acc, inq, coeff) \ - int32x4_t out##_l = vmlal_s16(acc##_l, vget_low_s16(inq), coeff); \ - int32x4_t out##_h = vmlal_s16(acc##_h, vget_high_s16(inq), coeff) - -#define dct_widen(out, inq) \ - int32x4_t out##_l = vshll_n_s16(vget_low_s16(inq), 12); \ - int32x4_t out##_h = vshll_n_s16(vget_high_s16(inq), 12) - -// wide add -#define dct_wadd(out, a, b) \ - int32x4_t out##_l = vaddq_s32(a##_l, b##_l); \ - int32x4_t out##_h = vaddq_s32(a##_h, b##_h) - -// wide sub -#define dct_wsub(out, a, b) \ - int32x4_t out##_l = vsubq_s32(a##_l, b##_l); \ - int32x4_t out##_h = vsubq_s32(a##_h, b##_h) - -// butterfly a/b, then shift using "shiftop" by "s" and pack -#define dct_bfly32o(out0,out1, a,b,shiftop,s) \ - { \ - dct_wadd(sum, a, b); \ - dct_wsub(dif, a, b); \ - out0 = vcombine_s16(shiftop(sum_l, s), shiftop(sum_h, s)); \ - out1 = vcombine_s16(shiftop(dif_l, s), shiftop(dif_h, s)); \ - } - -#define dct_pass(shiftop, shift) \ - { \ - /* even part */ \ - int16x8_t sum26 = vaddq_s16(row2, row6); \ - dct_long_mul(p1e, sum26, rot0_0); \ - dct_long_mac(t2e, p1e, row6, rot0_1); \ - dct_long_mac(t3e, p1e, row2, rot0_2); \ - int16x8_t sum04 = vaddq_s16(row0, row4); \ - int16x8_t dif04 = vsubq_s16(row0, row4); \ - dct_widen(t0e, sum04); \ - dct_widen(t1e, dif04); \ - dct_wadd(x0, t0e, t3e); \ - dct_wsub(x3, t0e, t3e); \ - dct_wadd(x1, t1e, t2e); \ - dct_wsub(x2, t1e, t2e); \ - /* odd part */ \ - int16x8_t sum15 = vaddq_s16(row1, row5); \ - int16x8_t sum17 = vaddq_s16(row1, row7); \ - int16x8_t sum35 = vaddq_s16(row3, row5); \ - int16x8_t sum37 = vaddq_s16(row3, row7); \ - int16x8_t sumodd = vaddq_s16(sum17, sum35); \ - dct_long_mul(p5o, sumodd, rot1_0); \ - dct_long_mac(p1o, p5o, sum17, rot1_1); \ - dct_long_mac(p2o, p5o, sum35, rot1_2); \ - dct_long_mul(p3o, sum37, rot2_0); \ - dct_long_mul(p4o, sum15, rot2_1); \ - dct_wadd(sump13o, p1o, p3o); \ - dct_wadd(sump24o, p2o, p4o); \ - dct_wadd(sump23o, p2o, p3o); \ - dct_wadd(sump14o, p1o, p4o); \ - dct_long_mac(x4, sump13o, row7, rot3_0); \ - dct_long_mac(x5, sump24o, row5, rot3_1); \ - dct_long_mac(x6, sump23o, row3, rot3_2); \ - dct_long_mac(x7, sump14o, row1, rot3_3); \ - dct_bfly32o(row0,row7, x0,x7,shiftop,shift); \ - dct_bfly32o(row1,row6, x1,x6,shiftop,shift); \ - dct_bfly32o(row2,row5, x2,x5,shiftop,shift); \ - dct_bfly32o(row3,row4, x3,x4,shiftop,shift); \ - } - - // load - row0 = vld1q_s16(data + 0*8); - row1 = vld1q_s16(data + 1*8); - row2 = vld1q_s16(data + 2*8); - row3 = vld1q_s16(data + 3*8); - row4 = vld1q_s16(data + 4*8); - row5 = vld1q_s16(data + 5*8); - row6 = vld1q_s16(data + 6*8); - row7 = vld1q_s16(data + 7*8); - - // add DC bias - row0 = vaddq_s16(row0, vsetq_lane_s16(1024, vdupq_n_s16(0), 0)); - - // column pass - dct_pass(vrshrn_n_s32, 10); - - // 16bit 8x8 transpose - { -// these three map to a single VTRN.16, VTRN.32, and VSWP, respectively. -// whether compilers actually get this is another story, sadly. -#define dct_trn16(x, y) { int16x8x2_t t = vtrnq_s16(x, y); x = t.val[0]; y = t.val[1]; } -#define dct_trn32(x, y) { int32x4x2_t t = vtrnq_s32(vreinterpretq_s32_s16(x), vreinterpretq_s32_s16(y)); x = vreinterpretq_s16_s32(t.val[0]); y = vreinterpretq_s16_s32(t.val[1]); } -#define dct_trn64(x, y) { int16x8_t x0 = x; int16x8_t y0 = y; x = vcombine_s16(vget_low_s16(x0), vget_low_s16(y0)); y = vcombine_s16(vget_high_s16(x0), vget_high_s16(y0)); } - - // pass 1 - dct_trn16(row0, row1); // a0b0a2b2a4b4a6b6 - dct_trn16(row2, row3); - dct_trn16(row4, row5); - dct_trn16(row6, row7); - - // pass 2 - dct_trn32(row0, row2); // a0b0c0d0a4b4c4d4 - dct_trn32(row1, row3); - dct_trn32(row4, row6); - dct_trn32(row5, row7); - - // pass 3 - dct_trn64(row0, row4); // a0b0c0d0e0f0g0h0 - dct_trn64(row1, row5); - dct_trn64(row2, row6); - dct_trn64(row3, row7); - -#undef dct_trn16 -#undef dct_trn32 -#undef dct_trn64 - } - - // row pass - // vrshrn_n_s32 only supports shifts up to 16, we need - // 17. so do a non-rounding shift of 16 first then follow - // up with a rounding shift by 1. - dct_pass(vshrn_n_s32, 16); - - { - // pack and round - uint8x8_t p0 = vqrshrun_n_s16(row0, 1); - uint8x8_t p1 = vqrshrun_n_s16(row1, 1); - uint8x8_t p2 = vqrshrun_n_s16(row2, 1); - uint8x8_t p3 = vqrshrun_n_s16(row3, 1); - uint8x8_t p4 = vqrshrun_n_s16(row4, 1); - uint8x8_t p5 = vqrshrun_n_s16(row5, 1); - uint8x8_t p6 = vqrshrun_n_s16(row6, 1); - uint8x8_t p7 = vqrshrun_n_s16(row7, 1); - - // again, these can translate into one instruction, but often don't. -#define dct_trn8_8(x, y) { uint8x8x2_t t = vtrn_u8(x, y); x = t.val[0]; y = t.val[1]; } -#define dct_trn8_16(x, y) { uint16x4x2_t t = vtrn_u16(vreinterpret_u16_u8(x), vreinterpret_u16_u8(y)); x = vreinterpret_u8_u16(t.val[0]); y = vreinterpret_u8_u16(t.val[1]); } -#define dct_trn8_32(x, y) { uint32x2x2_t t = vtrn_u32(vreinterpret_u32_u8(x), vreinterpret_u32_u8(y)); x = vreinterpret_u8_u32(t.val[0]); y = vreinterpret_u8_u32(t.val[1]); } - - // sadly can't use interleaved stores here since we only write - // 8 bytes to each scan line! - - // 8x8 8-bit transpose pass 1 - dct_trn8_8(p0, p1); - dct_trn8_8(p2, p3); - dct_trn8_8(p4, p5); - dct_trn8_8(p6, p7); - - // pass 2 - dct_trn8_16(p0, p2); - dct_trn8_16(p1, p3); - dct_trn8_16(p4, p6); - dct_trn8_16(p5, p7); - - // pass 3 - dct_trn8_32(p0, p4); - dct_trn8_32(p1, p5); - dct_trn8_32(p2, p6); - dct_trn8_32(p3, p7); - - // store - vst1_u8(out, p0); out += out_stride; - vst1_u8(out, p1); out += out_stride; - vst1_u8(out, p2); out += out_stride; - vst1_u8(out, p3); out += out_stride; - vst1_u8(out, p4); out += out_stride; - vst1_u8(out, p5); out += out_stride; - vst1_u8(out, p6); out += out_stride; - vst1_u8(out, p7); - -#undef dct_trn8_8 -#undef dct_trn8_16 -#undef dct_trn8_32 - } - -#undef dct_long_mul -#undef dct_long_mac -#undef dct_widen -#undef dct_wadd -#undef dct_wsub -#undef dct_bfly32o -#undef dct_pass -} - -#endif // STBI_NEON - -#define STBI__MARKER_none 0xff -// if there's a pending marker from the entropy stream, return that -// otherwise, fetch from the stream and get a marker. if there's no -// marker, return 0xff, which is never a valid marker value -static stbi_uc stbi__get_marker(stbi__jpeg *j) -{ - stbi_uc x; - if (j->marker != STBI__MARKER_none) { x = j->marker; j->marker = STBI__MARKER_none; return x; } - x = stbi__get8(j->s); - if (x != 0xff) return STBI__MARKER_none; - while (x == 0xff) - x = stbi__get8(j->s); // consume repeated 0xff fill bytes - return x; -} - -// in each scan, we'll have scan_n components, and the order -// of the components is specified by order[] -#define STBI__RESTART(x) ((x) >= 0xd0 && (x) <= 0xd7) - -// after a restart interval, stbi__jpeg_reset the entropy decoder and -// the dc prediction -static void stbi__jpeg_reset(stbi__jpeg *j) -{ - j->code_bits = 0; - j->code_buffer = 0; - j->nomore = 0; - j->img_comp[0].dc_pred = j->img_comp[1].dc_pred = j->img_comp[2].dc_pred = j->img_comp[3].dc_pred = 0; - j->marker = STBI__MARKER_none; - j->todo = j->restart_interval ? j->restart_interval : 0x7fffffff; - j->eob_run = 0; - // no more than 1<<31 MCUs if no restart_interal? that's plenty safe, - // since we don't even allow 1<<30 pixels -} - -static int stbi__parse_entropy_coded_data(stbi__jpeg *z) -{ - stbi__jpeg_reset(z); - if (!z->progressive) { - if (z->scan_n == 1) { - int i,j; - STBI_SIMD_ALIGN(short, data[64]); - int n = z->order[0]; - // non-interleaved data, we just need to process one block at a time, - // in trivial scanline order - // number of blocks to do just depends on how many actual "pixels" this - // component has, independent of interleaved MCU blocking and such - int w = (z->img_comp[n].x+7) >> 3; - int h = (z->img_comp[n].y+7) >> 3; - for (j=0; j < h; ++j) { - for (i=0; i < w; ++i) { - int ha = z->img_comp[n].ha; - if (!stbi__jpeg_decode_block(z, data, z->huff_dc+z->img_comp[n].hd, z->huff_ac+ha, z->fast_ac[ha], n, z->dequant[z->img_comp[n].tq])) return 0; - z->idct_block_kernel(z->img_comp[n].data+z->img_comp[n].w2*j*8+i*8, z->img_comp[n].w2, data); - // every data block is an MCU, so countdown the restart interval - if (--z->todo <= 0) { - if (z->code_bits < 24) stbi__grow_buffer_unsafe(z); - // if it's NOT a restart, then just bail, so we get corrupt data - // rather than no data - if (!STBI__RESTART(z->marker)) return 1; - stbi__jpeg_reset(z); - } - } - } - return 1; - } else { // interleaved - int i,j,k,x,y; - STBI_SIMD_ALIGN(short, data[64]); - for (j=0; j < z->img_mcu_y; ++j) { - for (i=0; i < z->img_mcu_x; ++i) { - // scan an interleaved mcu... process scan_n components in order - for (k=0; k < z->scan_n; ++k) { - int n = z->order[k]; - // scan out an mcu's worth of this component; that's just determined - // by the basic H and V specified for the component - for (y=0; y < z->img_comp[n].v; ++y) { - for (x=0; x < z->img_comp[n].h; ++x) { - int x2 = (i*z->img_comp[n].h + x)*8; - int y2 = (j*z->img_comp[n].v + y)*8; - int ha = z->img_comp[n].ha; - if (!stbi__jpeg_decode_block(z, data, z->huff_dc+z->img_comp[n].hd, z->huff_ac+ha, z->fast_ac[ha], n, z->dequant[z->img_comp[n].tq])) return 0; - z->idct_block_kernel(z->img_comp[n].data+z->img_comp[n].w2*y2+x2, z->img_comp[n].w2, data); - } - } - } - // after all interleaved components, that's an interleaved MCU, - // so now count down the restart interval - if (--z->todo <= 0) { - if (z->code_bits < 24) stbi__grow_buffer_unsafe(z); - if (!STBI__RESTART(z->marker)) return 1; - stbi__jpeg_reset(z); - } - } - } - return 1; - } - } else { - if (z->scan_n == 1) { - int i,j; - int n = z->order[0]; - // non-interleaved data, we just need to process one block at a time, - // in trivial scanline order - // number of blocks to do just depends on how many actual "pixels" this - // component has, independent of interleaved MCU blocking and such - int w = (z->img_comp[n].x+7) >> 3; - int h = (z->img_comp[n].y+7) >> 3; - for (j=0; j < h; ++j) { - for (i=0; i < w; ++i) { - short *data = z->img_comp[n].coeff + 64 * (i + j * z->img_comp[n].coeff_w); - if (z->spec_start == 0) { - if (!stbi__jpeg_decode_block_prog_dc(z, data, &z->huff_dc[z->img_comp[n].hd], n)) - return 0; - } else { - int ha = z->img_comp[n].ha; - if (!stbi__jpeg_decode_block_prog_ac(z, data, &z->huff_ac[ha], z->fast_ac[ha])) - return 0; - } - // every data block is an MCU, so countdown the restart interval - if (--z->todo <= 0) { - if (z->code_bits < 24) stbi__grow_buffer_unsafe(z); - if (!STBI__RESTART(z->marker)) return 1; - stbi__jpeg_reset(z); - } - } - } - return 1; - } else { // interleaved - int i,j,k,x,y; - for (j=0; j < z->img_mcu_y; ++j) { - for (i=0; i < z->img_mcu_x; ++i) { - // scan an interleaved mcu... process scan_n components in order - for (k=0; k < z->scan_n; ++k) { - int n = z->order[k]; - // scan out an mcu's worth of this component; that's just determined - // by the basic H and V specified for the component - for (y=0; y < z->img_comp[n].v; ++y) { - for (x=0; x < z->img_comp[n].h; ++x) { - int x2 = (i*z->img_comp[n].h + x); - int y2 = (j*z->img_comp[n].v + y); - short *data = z->img_comp[n].coeff + 64 * (x2 + y2 * z->img_comp[n].coeff_w); - if (!stbi__jpeg_decode_block_prog_dc(z, data, &z->huff_dc[z->img_comp[n].hd], n)) - return 0; - } - } - } - // after all interleaved components, that's an interleaved MCU, - // so now count down the restart interval - if (--z->todo <= 0) { - if (z->code_bits < 24) stbi__grow_buffer_unsafe(z); - if (!STBI__RESTART(z->marker)) return 1; - stbi__jpeg_reset(z); - } - } - } - return 1; - } - } -} - -static void stbi__jpeg_dequantize(short *data, stbi__uint16 *dequant) -{ - int i; - for (i=0; i < 64; ++i) - data[i] *= dequant[i]; -} - -static void stbi__jpeg_finish(stbi__jpeg *z) -{ - if (z->progressive) { - // dequantize and idct the data - int i,j,n; - for (n=0; n < z->s->img_n; ++n) { - int w = (z->img_comp[n].x+7) >> 3; - int h = (z->img_comp[n].y+7) >> 3; - for (j=0; j < h; ++j) { - for (i=0; i < w; ++i) { - short *data = z->img_comp[n].coeff + 64 * (i + j * z->img_comp[n].coeff_w); - stbi__jpeg_dequantize(data, z->dequant[z->img_comp[n].tq]); - z->idct_block_kernel(z->img_comp[n].data+z->img_comp[n].w2*j*8+i*8, z->img_comp[n].w2, data); - } - } - } - } -} - -static int stbi__process_marker(stbi__jpeg *z, int m) -{ - int L; - switch (m) { - case STBI__MARKER_none: // no marker found - return stbi__err("expected marker","Corrupt JPEG"); - - case 0xDD: // DRI - specify restart interval - if (stbi__get16be(z->s) != 4) return stbi__err("bad DRI len","Corrupt JPEG"); - z->restart_interval = stbi__get16be(z->s); - return 1; - - case 0xDB: // DQT - define quantization table - L = stbi__get16be(z->s)-2; - while (L > 0) { - int q = stbi__get8(z->s); - int p = q >> 4, sixteen = (p != 0); - int t = q & 15,i; - if (p != 0 && p != 1) return stbi__err("bad DQT type","Corrupt JPEG"); - if (t > 3) return stbi__err("bad DQT table","Corrupt JPEG"); - - for (i=0; i < 64; ++i) - z->dequant[t][stbi__jpeg_dezigzag[i]] = (stbi__uint16)(sixteen ? stbi__get16be(z->s) : stbi__get8(z->s)); - L -= (sixteen ? 129 : 65); - } - return L==0; - - case 0xC4: // DHT - define huffman table - L = stbi__get16be(z->s)-2; - while (L > 0) { - stbi_uc *v; - int sizes[16],i,n=0; - int q = stbi__get8(z->s); - int tc = q >> 4; - int th = q & 15; - if (tc > 1 || th > 3) return stbi__err("bad DHT header","Corrupt JPEG"); - for (i=0; i < 16; ++i) { - sizes[i] = stbi__get8(z->s); - n += sizes[i]; - } - if(n > 256) return stbi__err("bad DHT header","Corrupt JPEG"); // Loop over i < n would write past end of values! - L -= 17; - if (tc == 0) { - if (!stbi__build_huffman(z->huff_dc+th, sizes)) return 0; - v = z->huff_dc[th].values; - } else { - if (!stbi__build_huffman(z->huff_ac+th, sizes)) return 0; - v = z->huff_ac[th].values; - } - for (i=0; i < n; ++i) - v[i] = stbi__get8(z->s); - if (tc != 0) - stbi__build_fast_ac(z->fast_ac[th], z->huff_ac + th); - L -= n; - } - return L==0; - } - - // check for comment block or APP blocks - if ((m >= 0xE0 && m <= 0xEF) || m == 0xFE) { - L = stbi__get16be(z->s); - if (L < 2) { - if (m == 0xFE) - return stbi__err("bad COM len","Corrupt JPEG"); - else - return stbi__err("bad APP len","Corrupt JPEG"); - } - L -= 2; - - if (m == 0xE0 && L >= 5) { // JFIF APP0 segment - static const unsigned char tag[5] = {'J','F','I','F','\0'}; - int ok = 1; - int i; - for (i=0; i < 5; ++i) - if (stbi__get8(z->s) != tag[i]) - ok = 0; - L -= 5; - if (ok) - z->jfif = 1; - } else if (m == 0xEE && L >= 12) { // Adobe APP14 segment - static const unsigned char tag[6] = {'A','d','o','b','e','\0'}; - int ok = 1; - int i; - for (i=0; i < 6; ++i) - if (stbi__get8(z->s) != tag[i]) - ok = 0; - L -= 6; - if (ok) { - stbi__get8(z->s); // version - stbi__get16be(z->s); // flags0 - stbi__get16be(z->s); // flags1 - z->app14_color_transform = stbi__get8(z->s); // color transform - L -= 6; - } - } - - stbi__skip(z->s, L); - return 1; - } - - return stbi__err("unknown marker","Corrupt JPEG"); -} - -// after we see SOS -static int stbi__process_scan_header(stbi__jpeg *z) -{ - int i; - int Ls = stbi__get16be(z->s); - z->scan_n = stbi__get8(z->s); - if (z->scan_n < 1 || z->scan_n > 4 || z->scan_n > (int) z->s->img_n) return stbi__err("bad SOS component count","Corrupt JPEG"); - if (Ls != 6+2*z->scan_n) return stbi__err("bad SOS len","Corrupt JPEG"); - for (i=0; i < z->scan_n; ++i) { - int id = stbi__get8(z->s), which; - int q = stbi__get8(z->s); - for (which = 0; which < z->s->img_n; ++which) - if (z->img_comp[which].id == id) - break; - if (which == z->s->img_n) return 0; // no match - z->img_comp[which].hd = q >> 4; if (z->img_comp[which].hd > 3) return stbi__err("bad DC huff","Corrupt JPEG"); - z->img_comp[which].ha = q & 15; if (z->img_comp[which].ha > 3) return stbi__err("bad AC huff","Corrupt JPEG"); - z->order[i] = which; - } - - { - int aa; - z->spec_start = stbi__get8(z->s); - z->spec_end = stbi__get8(z->s); // should be 63, but might be 0 - aa = stbi__get8(z->s); - z->succ_high = (aa >> 4); - z->succ_low = (aa & 15); - if (z->progressive) { - if (z->spec_start > 63 || z->spec_end > 63 || z->spec_start > z->spec_end || z->succ_high > 13 || z->succ_low > 13) - return stbi__err("bad SOS", "Corrupt JPEG"); - } else { - if (z->spec_start != 0) return stbi__err("bad SOS","Corrupt JPEG"); - if (z->succ_high != 0 || z->succ_low != 0) return stbi__err("bad SOS","Corrupt JPEG"); - z->spec_end = 63; - } - } - - return 1; -} - -static int stbi__free_jpeg_components(stbi__jpeg *z, int ncomp, int why) -{ - int i; - for (i=0; i < ncomp; ++i) { - if (z->img_comp[i].raw_data) { - STBI_FREE(z->img_comp[i].raw_data); - z->img_comp[i].raw_data = NULL; - z->img_comp[i].data = NULL; - } - if (z->img_comp[i].raw_coeff) { - STBI_FREE(z->img_comp[i].raw_coeff); - z->img_comp[i].raw_coeff = 0; - z->img_comp[i].coeff = 0; - } - if (z->img_comp[i].linebuf) { - STBI_FREE(z->img_comp[i].linebuf); - z->img_comp[i].linebuf = NULL; - } - } - return why; -} - -static int stbi__process_frame_header(stbi__jpeg *z, int scan) -{ - stbi__context *s = z->s; - int Lf,p,i,q, h_max=1,v_max=1,c; - Lf = stbi__get16be(s); if (Lf < 11) return stbi__err("bad SOF len","Corrupt JPEG"); // JPEG - p = stbi__get8(s); if (p != 8) return stbi__err("only 8-bit","JPEG format not supported: 8-bit only"); // JPEG baseline - s->img_y = stbi__get16be(s); if (s->img_y == 0) return stbi__err("no header height", "JPEG format not supported: delayed height"); // Legal, but we don't handle it--but neither does IJG - s->img_x = stbi__get16be(s); if (s->img_x == 0) return stbi__err("0 width","Corrupt JPEG"); // JPEG requires - if (s->img_y > STBI_MAX_DIMENSIONS) return stbi__err("too large","Very large image (corrupt?)"); - if (s->img_x > STBI_MAX_DIMENSIONS) return stbi__err("too large","Very large image (corrupt?)"); - c = stbi__get8(s); - if (c != 3 && c != 1 && c != 4) return stbi__err("bad component count","Corrupt JPEG"); - s->img_n = c; - for (i=0; i < c; ++i) { - z->img_comp[i].data = NULL; - z->img_comp[i].linebuf = NULL; - } - - if (Lf != 8+3*s->img_n) return stbi__err("bad SOF len","Corrupt JPEG"); - - z->rgb = 0; - for (i=0; i < s->img_n; ++i) { - static const unsigned char rgb[3] = { 'R', 'G', 'B' }; - z->img_comp[i].id = stbi__get8(s); - if (s->img_n == 3 && z->img_comp[i].id == rgb[i]) - ++z->rgb; - q = stbi__get8(s); - z->img_comp[i].h = (q >> 4); if (!z->img_comp[i].h || z->img_comp[i].h > 4) return stbi__err("bad H","Corrupt JPEG"); - z->img_comp[i].v = q & 15; if (!z->img_comp[i].v || z->img_comp[i].v > 4) return stbi__err("bad V","Corrupt JPEG"); - z->img_comp[i].tq = stbi__get8(s); if (z->img_comp[i].tq > 3) return stbi__err("bad TQ","Corrupt JPEG"); - } - - if (scan != STBI__SCAN_load) return 1; - - if (!stbi__mad3sizes_valid(s->img_x, s->img_y, s->img_n, 0)) return stbi__err("too large", "Image too large to decode"); - - for (i=0; i < s->img_n; ++i) { - if (z->img_comp[i].h > h_max) h_max = z->img_comp[i].h; - if (z->img_comp[i].v > v_max) v_max = z->img_comp[i].v; - } - - // check that plane subsampling factors are integer ratios; our resamplers can't deal with fractional ratios - // and I've never seen a non-corrupted JPEG file actually use them - for (i=0; i < s->img_n; ++i) { - if (h_max % z->img_comp[i].h != 0) return stbi__err("bad H","Corrupt JPEG"); - if (v_max % z->img_comp[i].v != 0) return stbi__err("bad V","Corrupt JPEG"); - } - - // compute interleaved mcu info - z->img_h_max = h_max; - z->img_v_max = v_max; - z->img_mcu_w = h_max * 8; - z->img_mcu_h = v_max * 8; - // these sizes can't be more than 17 bits - z->img_mcu_x = (s->img_x + z->img_mcu_w-1) / z->img_mcu_w; - z->img_mcu_y = (s->img_y + z->img_mcu_h-1) / z->img_mcu_h; - - for (i=0; i < s->img_n; ++i) { - // number of effective pixels (e.g. for non-interleaved MCU) - z->img_comp[i].x = (s->img_x * z->img_comp[i].h + h_max-1) / h_max; - z->img_comp[i].y = (s->img_y * z->img_comp[i].v + v_max-1) / v_max; - // to simplify generation, we'll allocate enough memory to decode - // the bogus oversized data from using interleaved MCUs and their - // big blocks (e.g. a 16x16 iMCU on an image of width 33); we won't - // discard the extra data until colorspace conversion - // - // img_mcu_x, img_mcu_y: <=17 bits; comp[i].h and .v are <=4 (checked earlier) - // so these muls can't overflow with 32-bit ints (which we require) - z->img_comp[i].w2 = z->img_mcu_x * z->img_comp[i].h * 8; - z->img_comp[i].h2 = z->img_mcu_y * z->img_comp[i].v * 8; - z->img_comp[i].coeff = 0; - z->img_comp[i].raw_coeff = 0; - z->img_comp[i].linebuf = NULL; - z->img_comp[i].raw_data = stbi__malloc_mad2(z->img_comp[i].w2, z->img_comp[i].h2, 15); - if (z->img_comp[i].raw_data == NULL) - return stbi__free_jpeg_components(z, i+1, stbi__err("outofmem", "Out of memory")); - // align blocks for idct using mmx/sse - z->img_comp[i].data = (stbi_uc*) (((size_t) z->img_comp[i].raw_data + 15) & ~15); - if (z->progressive) { - // w2, h2 are multiples of 8 (see above) - z->img_comp[i].coeff_w = z->img_comp[i].w2 / 8; - z->img_comp[i].coeff_h = z->img_comp[i].h2 / 8; - z->img_comp[i].raw_coeff = stbi__malloc_mad3(z->img_comp[i].w2, z->img_comp[i].h2, sizeof(short), 15); - if (z->img_comp[i].raw_coeff == NULL) - return stbi__free_jpeg_components(z, i+1, stbi__err("outofmem", "Out of memory")); - z->img_comp[i].coeff = (short*) (((size_t) z->img_comp[i].raw_coeff + 15) & ~15); - } - } - - return 1; -} - -// use comparisons since in some cases we handle more than one case (e.g. SOF) -#define stbi__DNL(x) ((x) == 0xdc) -#define stbi__SOI(x) ((x) == 0xd8) -#define stbi__EOI(x) ((x) == 0xd9) -#define stbi__SOF(x) ((x) == 0xc0 || (x) == 0xc1 || (x) == 0xc2) -#define stbi__SOS(x) ((x) == 0xda) - -#define stbi__SOF_progressive(x) ((x) == 0xc2) - -static int stbi__decode_jpeg_header(stbi__jpeg *z, int scan) -{ - int m; - z->jfif = 0; - z->app14_color_transform = -1; // valid values are 0,1,2 - z->marker = STBI__MARKER_none; // initialize cached marker to empty - m = stbi__get_marker(z); - if (!stbi__SOI(m)) return stbi__err("no SOI","Corrupt JPEG"); - if (scan == STBI__SCAN_type) return 1; - m = stbi__get_marker(z); - while (!stbi__SOF(m)) { - if (!stbi__process_marker(z,m)) return 0; - m = stbi__get_marker(z); - while (m == STBI__MARKER_none) { - // some files have extra padding after their blocks, so ok, we'll scan - if (stbi__at_eof(z->s)) return stbi__err("no SOF", "Corrupt JPEG"); - m = stbi__get_marker(z); - } - } - z->progressive = stbi__SOF_progressive(m); - if (!stbi__process_frame_header(z, scan)) return 0; - return 1; -} - -static stbi_uc stbi__skip_jpeg_junk_at_end(stbi__jpeg *j) -{ - // some JPEGs have junk at end, skip over it but if we find what looks - // like a valid marker, resume there - while (!stbi__at_eof(j->s)) { - stbi_uc x = stbi__get8(j->s); - while (x == 0xff) { // might be a marker - if (stbi__at_eof(j->s)) return STBI__MARKER_none; - x = stbi__get8(j->s); - if (x != 0x00 && x != 0xff) { - // not a stuffed zero or lead-in to another marker, looks - // like an actual marker, return it - return x; - } - // stuffed zero has x=0 now which ends the loop, meaning we go - // back to regular scan loop. - // repeated 0xff keeps trying to read the next byte of the marker. - } - } - return STBI__MARKER_none; -} - -// decode image to YCbCr format -static int stbi__decode_jpeg_image(stbi__jpeg *j) -{ - int m; - for (m = 0; m < 4; m++) { - j->img_comp[m].raw_data = NULL; - j->img_comp[m].raw_coeff = NULL; - } - j->restart_interval = 0; - if (!stbi__decode_jpeg_header(j, STBI__SCAN_load)) return 0; - m = stbi__get_marker(j); - while (!stbi__EOI(m)) { - if (stbi__SOS(m)) { - if (!stbi__process_scan_header(j)) return 0; - if (!stbi__parse_entropy_coded_data(j)) return 0; - if (j->marker == STBI__MARKER_none ) { - j->marker = stbi__skip_jpeg_junk_at_end(j); - // if we reach eof without hitting a marker, stbi__get_marker() below will fail and we'll eventually return 0 - } - m = stbi__get_marker(j); - if (STBI__RESTART(m)) - m = stbi__get_marker(j); - } else if (stbi__DNL(m)) { - int Ld = stbi__get16be(j->s); - stbi__uint32 NL = stbi__get16be(j->s); - if (Ld != 4) return stbi__err("bad DNL len", "Corrupt JPEG"); - if (NL != j->s->img_y) return stbi__err("bad DNL height", "Corrupt JPEG"); - m = stbi__get_marker(j); - } else { - if (!stbi__process_marker(j, m)) return 1; - m = stbi__get_marker(j); - } - } - if (j->progressive) - stbi__jpeg_finish(j); - return 1; -} - -// static jfif-centered resampling (across block boundaries) - -typedef stbi_uc *(*resample_row_func)(stbi_uc *out, stbi_uc *in0, stbi_uc *in1, - int w, int hs); - -#define stbi__div4(x) ((stbi_uc) ((x) >> 2)) - -static stbi_uc *resample_row_1(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) -{ - STBI_NOTUSED(out); - STBI_NOTUSED(in_far); - STBI_NOTUSED(w); - STBI_NOTUSED(hs); - return in_near; -} - -static stbi_uc* stbi__resample_row_v_2(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) -{ - // need to generate two samples vertically for every one in input - int i; - STBI_NOTUSED(hs); - for (i=0; i < w; ++i) - out[i] = stbi__div4(3*in_near[i] + in_far[i] + 2); - return out; -} - -static stbi_uc* stbi__resample_row_h_2(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) -{ - // need to generate two samples horizontally for every one in input - int i; - stbi_uc *input = in_near; - - if (w == 1) { - // if only one sample, can't do any interpolation - out[0] = out[1] = input[0]; - return out; - } - - out[0] = input[0]; - out[1] = stbi__div4(input[0]*3 + input[1] + 2); - for (i=1; i < w-1; ++i) { - int n = 3*input[i]+2; - out[i*2+0] = stbi__div4(n+input[i-1]); - out[i*2+1] = stbi__div4(n+input[i+1]); - } - out[i*2+0] = stbi__div4(input[w-2]*3 + input[w-1] + 2); - out[i*2+1] = input[w-1]; - - STBI_NOTUSED(in_far); - STBI_NOTUSED(hs); - - return out; -} - -#define stbi__div16(x) ((stbi_uc) ((x) >> 4)) - -static stbi_uc *stbi__resample_row_hv_2(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) -{ - // need to generate 2x2 samples for every one in input - int i,t0,t1; - if (w == 1) { - out[0] = out[1] = stbi__div4(3*in_near[0] + in_far[0] + 2); - return out; - } - - t1 = 3*in_near[0] + in_far[0]; - out[0] = stbi__div4(t1+2); - for (i=1; i < w; ++i) { - t0 = t1; - t1 = 3*in_near[i]+in_far[i]; - out[i*2-1] = stbi__div16(3*t0 + t1 + 8); - out[i*2 ] = stbi__div16(3*t1 + t0 + 8); - } - out[w*2-1] = stbi__div4(t1+2); - - STBI_NOTUSED(hs); - - return out; -} - -#if defined(STBI_SSE2) || defined(STBI_NEON) -static stbi_uc *stbi__resample_row_hv_2_simd(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) -{ - // need to generate 2x2 samples for every one in input - int i=0,t0,t1; - - if (w == 1) { - out[0] = out[1] = stbi__div4(3*in_near[0] + in_far[0] + 2); - return out; - } - - t1 = 3*in_near[0] + in_far[0]; - // process groups of 8 pixels for as long as we can. - // note we can't handle the last pixel in a row in this loop - // because we need to handle the filter boundary conditions. - for (; i < ((w-1) & ~7); i += 8) { -#if defined(STBI_SSE2) - // load and perform the vertical filtering pass - // this uses 3*x + y = 4*x + (y - x) - __m128i zero = _mm_setzero_si128(); - __m128i farb = _mm_loadl_epi64((__m128i *) (in_far + i)); - __m128i nearb = _mm_loadl_epi64((__m128i *) (in_near + i)); - __m128i farw = _mm_unpacklo_epi8(farb, zero); - __m128i nearw = _mm_unpacklo_epi8(nearb, zero); - __m128i diff = _mm_sub_epi16(farw, nearw); - __m128i nears = _mm_slli_epi16(nearw, 2); - __m128i curr = _mm_add_epi16(nears, diff); // current row - - // horizontal filter works the same based on shifted vers of current - // row. "prev" is current row shifted right by 1 pixel; we need to - // insert the previous pixel value (from t1). - // "next" is current row shifted left by 1 pixel, with first pixel - // of next block of 8 pixels added in. - __m128i prv0 = _mm_slli_si128(curr, 2); - __m128i nxt0 = _mm_srli_si128(curr, 2); - __m128i prev = _mm_insert_epi16(prv0, t1, 0); - __m128i next = _mm_insert_epi16(nxt0, 3*in_near[i+8] + in_far[i+8], 7); - - // horizontal filter, polyphase implementation since it's convenient: - // even pixels = 3*cur + prev = cur*4 + (prev - cur) - // odd pixels = 3*cur + next = cur*4 + (next - cur) - // note the shared term. - __m128i bias = _mm_set1_epi16(8); - __m128i curs = _mm_slli_epi16(curr, 2); - __m128i prvd = _mm_sub_epi16(prev, curr); - __m128i nxtd = _mm_sub_epi16(next, curr); - __m128i curb = _mm_add_epi16(curs, bias); - __m128i even = _mm_add_epi16(prvd, curb); - __m128i odd = _mm_add_epi16(nxtd, curb); - - // interleave even and odd pixels, then undo scaling. - __m128i int0 = _mm_unpacklo_epi16(even, odd); - __m128i int1 = _mm_unpackhi_epi16(even, odd); - __m128i de0 = _mm_srli_epi16(int0, 4); - __m128i de1 = _mm_srli_epi16(int1, 4); - - // pack and write output - __m128i outv = _mm_packus_epi16(de0, de1); - _mm_storeu_si128((__m128i *) (out + i*2), outv); -#elif defined(STBI_NEON) - // load and perform the vertical filtering pass - // this uses 3*x + y = 4*x + (y - x) - uint8x8_t farb = vld1_u8(in_far + i); - uint8x8_t nearb = vld1_u8(in_near + i); - int16x8_t diff = vreinterpretq_s16_u16(vsubl_u8(farb, nearb)); - int16x8_t nears = vreinterpretq_s16_u16(vshll_n_u8(nearb, 2)); - int16x8_t curr = vaddq_s16(nears, diff); // current row - - // horizontal filter works the same based on shifted vers of current - // row. "prev" is current row shifted right by 1 pixel; we need to - // insert the previous pixel value (from t1). - // "next" is current row shifted left by 1 pixel, with first pixel - // of next block of 8 pixels added in. - int16x8_t prv0 = vextq_s16(curr, curr, 7); - int16x8_t nxt0 = vextq_s16(curr, curr, 1); - int16x8_t prev = vsetq_lane_s16(t1, prv0, 0); - int16x8_t next = vsetq_lane_s16(3*in_near[i+8] + in_far[i+8], nxt0, 7); - - // horizontal filter, polyphase implementation since it's convenient: - // even pixels = 3*cur + prev = cur*4 + (prev - cur) - // odd pixels = 3*cur + next = cur*4 + (next - cur) - // note the shared term. - int16x8_t curs = vshlq_n_s16(curr, 2); - int16x8_t prvd = vsubq_s16(prev, curr); - int16x8_t nxtd = vsubq_s16(next, curr); - int16x8_t even = vaddq_s16(curs, prvd); - int16x8_t odd = vaddq_s16(curs, nxtd); - - // undo scaling and round, then store with even/odd phases interleaved - uint8x8x2_t o; - o.val[0] = vqrshrun_n_s16(even, 4); - o.val[1] = vqrshrun_n_s16(odd, 4); - vst2_u8(out + i*2, o); -#endif - - // "previous" value for next iter - t1 = 3*in_near[i+7] + in_far[i+7]; - } - - t0 = t1; - t1 = 3*in_near[i] + in_far[i]; - out[i*2] = stbi__div16(3*t1 + t0 + 8); - - for (++i; i < w; ++i) { - t0 = t1; - t1 = 3*in_near[i]+in_far[i]; - out[i*2-1] = stbi__div16(3*t0 + t1 + 8); - out[i*2 ] = stbi__div16(3*t1 + t0 + 8); - } - out[w*2-1] = stbi__div4(t1+2); - - STBI_NOTUSED(hs); - - return out; -} -#endif - -static stbi_uc *stbi__resample_row_generic(stbi_uc *out, stbi_uc *in_near, stbi_uc *in_far, int w, int hs) -{ - // resample with nearest-neighbor - int i,j; - STBI_NOTUSED(in_far); - for (i=0; i < w; ++i) - for (j=0; j < hs; ++j) - out[i*hs+j] = in_near[i]; - return out; -} - -// this is a reduced-precision calculation of YCbCr-to-RGB introduced -// to make sure the code produces the same results in both SIMD and scalar -#define stbi__float2fixed(x) (((int) ((x) * 4096.0f + 0.5f)) << 8) -static void stbi__YCbCr_to_RGB_row(stbi_uc *out, const stbi_uc *y, const stbi_uc *pcb, const stbi_uc *pcr, int count, int step) -{ - int i; - for (i=0; i < count; ++i) { - int y_fixed = (y[i] << 20) + (1<<19); // rounding - int r,g,b; - int cr = pcr[i] - 128; - int cb = pcb[i] - 128; - r = y_fixed + cr* stbi__float2fixed(1.40200f); - g = y_fixed + (cr*-stbi__float2fixed(0.71414f)) + ((cb*-stbi__float2fixed(0.34414f)) & 0xffff0000); - b = y_fixed + cb* stbi__float2fixed(1.77200f); - r >>= 20; - g >>= 20; - b >>= 20; - if ((unsigned) r > 255) { if (r < 0) r = 0; else r = 255; } - if ((unsigned) g > 255) { if (g < 0) g = 0; else g = 255; } - if ((unsigned) b > 255) { if (b < 0) b = 0; else b = 255; } - out[0] = (stbi_uc)r; - out[1] = (stbi_uc)g; - out[2] = (stbi_uc)b; - out[3] = 255; - out += step; - } -} - -#if defined(STBI_SSE2) || defined(STBI_NEON) -static void stbi__YCbCr_to_RGB_simd(stbi_uc *out, stbi_uc const *y, stbi_uc const *pcb, stbi_uc const *pcr, int count, int step) -{ - int i = 0; - -#ifdef STBI_SSE2 - // step == 3 is pretty ugly on the final interleave, and i'm not convinced - // it's useful in practice (you wouldn't use it for textures, for example). - // so just accelerate step == 4 case. - if (step == 4) { - // this is a fairly straightforward implementation and not super-optimized. - __m128i signflip = _mm_set1_epi8(-0x80); - __m128i cr_const0 = _mm_set1_epi16( (short) ( 1.40200f*4096.0f+0.5f)); - __m128i cr_const1 = _mm_set1_epi16( - (short) ( 0.71414f*4096.0f+0.5f)); - __m128i cb_const0 = _mm_set1_epi16( - (short) ( 0.34414f*4096.0f+0.5f)); - __m128i cb_const1 = _mm_set1_epi16( (short) ( 1.77200f*4096.0f+0.5f)); - __m128i y_bias = _mm_set1_epi8((char) (unsigned char) 128); - __m128i xw = _mm_set1_epi16(255); // alpha channel - - for (; i+7 < count; i += 8) { - // load - __m128i y_bytes = _mm_loadl_epi64((__m128i *) (y+i)); - __m128i cr_bytes = _mm_loadl_epi64((__m128i *) (pcr+i)); - __m128i cb_bytes = _mm_loadl_epi64((__m128i *) (pcb+i)); - __m128i cr_biased = _mm_xor_si128(cr_bytes, signflip); // -128 - __m128i cb_biased = _mm_xor_si128(cb_bytes, signflip); // -128 - - // unpack to short (and left-shift cr, cb by 8) - __m128i yw = _mm_unpacklo_epi8(y_bias, y_bytes); - __m128i crw = _mm_unpacklo_epi8(_mm_setzero_si128(), cr_biased); - __m128i cbw = _mm_unpacklo_epi8(_mm_setzero_si128(), cb_biased); - - // color transform - __m128i yws = _mm_srli_epi16(yw, 4); - __m128i cr0 = _mm_mulhi_epi16(cr_const0, crw); - __m128i cb0 = _mm_mulhi_epi16(cb_const0, cbw); - __m128i cb1 = _mm_mulhi_epi16(cbw, cb_const1); - __m128i cr1 = _mm_mulhi_epi16(crw, cr_const1); - __m128i rws = _mm_add_epi16(cr0, yws); - __m128i gwt = _mm_add_epi16(cb0, yws); - __m128i bws = _mm_add_epi16(yws, cb1); - __m128i gws = _mm_add_epi16(gwt, cr1); - - // descale - __m128i rw = _mm_srai_epi16(rws, 4); - __m128i bw = _mm_srai_epi16(bws, 4); - __m128i gw = _mm_srai_epi16(gws, 4); - - // back to byte, set up for transpose - __m128i brb = _mm_packus_epi16(rw, bw); - __m128i gxb = _mm_packus_epi16(gw, xw); - - // transpose to interleave channels - __m128i t0 = _mm_unpacklo_epi8(brb, gxb); - __m128i t1 = _mm_unpackhi_epi8(brb, gxb); - __m128i o0 = _mm_unpacklo_epi16(t0, t1); - __m128i o1 = _mm_unpackhi_epi16(t0, t1); - - // store - _mm_storeu_si128((__m128i *) (out + 0), o0); - _mm_storeu_si128((__m128i *) (out + 16), o1); - out += 32; - } - } -#endif - -#ifdef STBI_NEON - // in this version, step=3 support would be easy to add. but is there demand? - if (step == 4) { - // this is a fairly straightforward implementation and not super-optimized. - uint8x8_t signflip = vdup_n_u8(0x80); - int16x8_t cr_const0 = vdupq_n_s16( (short) ( 1.40200f*4096.0f+0.5f)); - int16x8_t cr_const1 = vdupq_n_s16( - (short) ( 0.71414f*4096.0f+0.5f)); - int16x8_t cb_const0 = vdupq_n_s16( - (short) ( 0.34414f*4096.0f+0.5f)); - int16x8_t cb_const1 = vdupq_n_s16( (short) ( 1.77200f*4096.0f+0.5f)); - - for (; i+7 < count; i += 8) { - // load - uint8x8_t y_bytes = vld1_u8(y + i); - uint8x8_t cr_bytes = vld1_u8(pcr + i); - uint8x8_t cb_bytes = vld1_u8(pcb + i); - int8x8_t cr_biased = vreinterpret_s8_u8(vsub_u8(cr_bytes, signflip)); - int8x8_t cb_biased = vreinterpret_s8_u8(vsub_u8(cb_bytes, signflip)); - - // expand to s16 - int16x8_t yws = vreinterpretq_s16_u16(vshll_n_u8(y_bytes, 4)); - int16x8_t crw = vshll_n_s8(cr_biased, 7); - int16x8_t cbw = vshll_n_s8(cb_biased, 7); - - // color transform - int16x8_t cr0 = vqdmulhq_s16(crw, cr_const0); - int16x8_t cb0 = vqdmulhq_s16(cbw, cb_const0); - int16x8_t cr1 = vqdmulhq_s16(crw, cr_const1); - int16x8_t cb1 = vqdmulhq_s16(cbw, cb_const1); - int16x8_t rws = vaddq_s16(yws, cr0); - int16x8_t gws = vaddq_s16(vaddq_s16(yws, cb0), cr1); - int16x8_t bws = vaddq_s16(yws, cb1); - - // undo scaling, round, convert to byte - uint8x8x4_t o; - o.val[0] = vqrshrun_n_s16(rws, 4); - o.val[1] = vqrshrun_n_s16(gws, 4); - o.val[2] = vqrshrun_n_s16(bws, 4); - o.val[3] = vdup_n_u8(255); - - // store, interleaving r/g/b/a - vst4_u8(out, o); - out += 8*4; - } - } -#endif - - for (; i < count; ++i) { - int y_fixed = (y[i] << 20) + (1<<19); // rounding - int r,g,b; - int cr = pcr[i] - 128; - int cb = pcb[i] - 128; - r = y_fixed + cr* stbi__float2fixed(1.40200f); - g = y_fixed + cr*-stbi__float2fixed(0.71414f) + ((cb*-stbi__float2fixed(0.34414f)) & 0xffff0000); - b = y_fixed + cb* stbi__float2fixed(1.77200f); - r >>= 20; - g >>= 20; - b >>= 20; - if ((unsigned) r > 255) { if (r < 0) r = 0; else r = 255; } - if ((unsigned) g > 255) { if (g < 0) g = 0; else g = 255; } - if ((unsigned) b > 255) { if (b < 0) b = 0; else b = 255; } - out[0] = (stbi_uc)r; - out[1] = (stbi_uc)g; - out[2] = (stbi_uc)b; - out[3] = 255; - out += step; - } -} -#endif - -// set up the kernels -static void stbi__setup_jpeg(stbi__jpeg *j) -{ - j->idct_block_kernel = stbi__idct_block; - j->YCbCr_to_RGB_kernel = stbi__YCbCr_to_RGB_row; - j->resample_row_hv_2_kernel = stbi__resample_row_hv_2; - -#ifdef STBI_SSE2 - if (stbi__sse2_available()) { - j->idct_block_kernel = stbi__idct_simd; - j->YCbCr_to_RGB_kernel = stbi__YCbCr_to_RGB_simd; - j->resample_row_hv_2_kernel = stbi__resample_row_hv_2_simd; - } -#endif - -#ifdef STBI_NEON - j->idct_block_kernel = stbi__idct_simd; - j->YCbCr_to_RGB_kernel = stbi__YCbCr_to_RGB_simd; - j->resample_row_hv_2_kernel = stbi__resample_row_hv_2_simd; -#endif -} - -// clean up the temporary component buffers -static void stbi__cleanup_jpeg(stbi__jpeg *j) -{ - stbi__free_jpeg_components(j, j->s->img_n, 0); -} - -typedef struct -{ - resample_row_func resample; - stbi_uc *line0,*line1; - int hs,vs; // expansion factor in each axis - int w_lores; // horizontal pixels pre-expansion - int ystep; // how far through vertical expansion we are - int ypos; // which pre-expansion row we're on -} stbi__resample; - -// fast 0..255 * 0..255 => 0..255 rounded multiplication -static stbi_uc stbi__blinn_8x8(stbi_uc x, stbi_uc y) -{ - unsigned int t = x*y + 128; - return (stbi_uc) ((t + (t >>8)) >> 8); -} - -static stbi_uc *load_jpeg_image(stbi__jpeg *z, int *out_x, int *out_y, int *comp, int req_comp) -{ - int n, decode_n, is_rgb; - z->s->img_n = 0; // make stbi__cleanup_jpeg safe - - // validate req_comp - if (req_comp < 0 || req_comp > 4) return stbi__errpuc("bad req_comp", "Internal error"); - - // load a jpeg image from whichever source, but leave in YCbCr format - if (!stbi__decode_jpeg_image(z)) { stbi__cleanup_jpeg(z); return NULL; } - - // determine actual number of components to generate - n = req_comp ? req_comp : z->s->img_n >= 3 ? 3 : 1; - - is_rgb = z->s->img_n == 3 && (z->rgb == 3 || (z->app14_color_transform == 0 && !z->jfif)); - - if (z->s->img_n == 3 && n < 3 && !is_rgb) - decode_n = 1; - else - decode_n = z->s->img_n; - - // nothing to do if no components requested; check this now to avoid - // accessing uninitialized coutput[0] later - if (decode_n <= 0) { stbi__cleanup_jpeg(z); return NULL; } - - // resample and color-convert - { - int k; - unsigned int i,j; - stbi_uc *output; - stbi_uc *coutput[4] = { NULL, NULL, NULL, NULL }; - - stbi__resample res_comp[4]; - - for (k=0; k < decode_n; ++k) { - stbi__resample *r = &res_comp[k]; - - // allocate line buffer big enough for upsampling off the edges - // with upsample factor of 4 - z->img_comp[k].linebuf = (stbi_uc *) stbi__malloc(z->s->img_x + 3); - if (!z->img_comp[k].linebuf) { stbi__cleanup_jpeg(z); return stbi__errpuc("outofmem", "Out of memory"); } - - r->hs = z->img_h_max / z->img_comp[k].h; - r->vs = z->img_v_max / z->img_comp[k].v; - r->ystep = r->vs >> 1; - r->w_lores = (z->s->img_x + r->hs-1) / r->hs; - r->ypos = 0; - r->line0 = r->line1 = z->img_comp[k].data; - - if (r->hs == 1 && r->vs == 1) r->resample = resample_row_1; - else if (r->hs == 1 && r->vs == 2) r->resample = stbi__resample_row_v_2; - else if (r->hs == 2 && r->vs == 1) r->resample = stbi__resample_row_h_2; - else if (r->hs == 2 && r->vs == 2) r->resample = z->resample_row_hv_2_kernel; - else r->resample = stbi__resample_row_generic; - } - - // can't error after this so, this is safe - output = (stbi_uc *) stbi__malloc_mad3(n, z->s->img_x, z->s->img_y, 1); - if (!output) { stbi__cleanup_jpeg(z); return stbi__errpuc("outofmem", "Out of memory"); } - - // now go ahead and resample - for (j=0; j < z->s->img_y; ++j) { - stbi_uc *out = output + n * z->s->img_x * j; - for (k=0; k < decode_n; ++k) { - stbi__resample *r = &res_comp[k]; - int y_bot = r->ystep >= (r->vs >> 1); - coutput[k] = r->resample(z->img_comp[k].linebuf, - y_bot ? r->line1 : r->line0, - y_bot ? r->line0 : r->line1, - r->w_lores, r->hs); - if (++r->ystep >= r->vs) { - r->ystep = 0; - r->line0 = r->line1; - if (++r->ypos < z->img_comp[k].y) - r->line1 += z->img_comp[k].w2; - } - } - if (n >= 3) { - stbi_uc *y = coutput[0]; - if (z->s->img_n == 3) { - if (is_rgb) { - for (i=0; i < z->s->img_x; ++i) { - out[0] = y[i]; - out[1] = coutput[1][i]; - out[2] = coutput[2][i]; - out[3] = 255; - out += n; - } - } else { - z->YCbCr_to_RGB_kernel(out, y, coutput[1], coutput[2], z->s->img_x, n); - } - } else if (z->s->img_n == 4) { - if (z->app14_color_transform == 0) { // CMYK - for (i=0; i < z->s->img_x; ++i) { - stbi_uc m = coutput[3][i]; - out[0] = stbi__blinn_8x8(coutput[0][i], m); - out[1] = stbi__blinn_8x8(coutput[1][i], m); - out[2] = stbi__blinn_8x8(coutput[2][i], m); - out[3] = 255; - out += n; - } - } else if (z->app14_color_transform == 2) { // YCCK - z->YCbCr_to_RGB_kernel(out, y, coutput[1], coutput[2], z->s->img_x, n); - for (i=0; i < z->s->img_x; ++i) { - stbi_uc m = coutput[3][i]; - out[0] = stbi__blinn_8x8(255 - out[0], m); - out[1] = stbi__blinn_8x8(255 - out[1], m); - out[2] = stbi__blinn_8x8(255 - out[2], m); - out += n; - } - } else { // YCbCr + alpha? Ignore the fourth channel for now - z->YCbCr_to_RGB_kernel(out, y, coutput[1], coutput[2], z->s->img_x, n); - } - } else - for (i=0; i < z->s->img_x; ++i) { - out[0] = out[1] = out[2] = y[i]; - out[3] = 255; // not used if n==3 - out += n; - } - } else { - if (is_rgb) { - if (n == 1) - for (i=0; i < z->s->img_x; ++i) - *out++ = stbi__compute_y(coutput[0][i], coutput[1][i], coutput[2][i]); - else { - for (i=0; i < z->s->img_x; ++i, out += 2) { - out[0] = stbi__compute_y(coutput[0][i], coutput[1][i], coutput[2][i]); - out[1] = 255; - } - } - } else if (z->s->img_n == 4 && z->app14_color_transform == 0) { - for (i=0; i < z->s->img_x; ++i) { - stbi_uc m = coutput[3][i]; - stbi_uc r = stbi__blinn_8x8(coutput[0][i], m); - stbi_uc g = stbi__blinn_8x8(coutput[1][i], m); - stbi_uc b = stbi__blinn_8x8(coutput[2][i], m); - out[0] = stbi__compute_y(r, g, b); - out[1] = 255; - out += n; - } - } else if (z->s->img_n == 4 && z->app14_color_transform == 2) { - for (i=0; i < z->s->img_x; ++i) { - out[0] = stbi__blinn_8x8(255 - coutput[0][i], coutput[3][i]); - out[1] = 255; - out += n; - } - } else { - stbi_uc *y = coutput[0]; - if (n == 1) - for (i=0; i < z->s->img_x; ++i) out[i] = y[i]; - else - for (i=0; i < z->s->img_x; ++i) { *out++ = y[i]; *out++ = 255; } - } - } - } - stbi__cleanup_jpeg(z); - *out_x = z->s->img_x; - *out_y = z->s->img_y; - if (comp) *comp = z->s->img_n >= 3 ? 3 : 1; // report original components, not output - return output; - } -} - -static void *stbi__jpeg_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) -{ - unsigned char* result; - stbi__jpeg* j = (stbi__jpeg*) stbi__malloc(sizeof(stbi__jpeg)); - if (!j) return stbi__errpuc("outofmem", "Out of memory"); - memset(j, 0, sizeof(stbi__jpeg)); - STBI_NOTUSED(ri); - j->s = s; - stbi__setup_jpeg(j); - result = load_jpeg_image(j, x,y,comp,req_comp); - STBI_FREE(j); - return result; -} - -static int stbi__jpeg_test(stbi__context *s) -{ - int r; - stbi__jpeg* j = (stbi__jpeg*)stbi__malloc(sizeof(stbi__jpeg)); - if (!j) return stbi__err("outofmem", "Out of memory"); - memset(j, 0, sizeof(stbi__jpeg)); - j->s = s; - stbi__setup_jpeg(j); - r = stbi__decode_jpeg_header(j, STBI__SCAN_type); - stbi__rewind(s); - STBI_FREE(j); - return r; -} - -static int stbi__jpeg_info_raw(stbi__jpeg *j, int *x, int *y, int *comp) -{ - if (!stbi__decode_jpeg_header(j, STBI__SCAN_header)) { - stbi__rewind( j->s ); - return 0; - } - if (x) *x = j->s->img_x; - if (y) *y = j->s->img_y; - if (comp) *comp = j->s->img_n >= 3 ? 3 : 1; - return 1; -} - -static int stbi__jpeg_info(stbi__context *s, int *x, int *y, int *comp) -{ - int result; - stbi__jpeg* j = (stbi__jpeg*) (stbi__malloc(sizeof(stbi__jpeg))); - if (!j) return stbi__err("outofmem", "Out of memory"); - memset(j, 0, sizeof(stbi__jpeg)); - j->s = s; - result = stbi__jpeg_info_raw(j, x, y, comp); - STBI_FREE(j); - return result; -} -#endif - -// public domain zlib decode v0.2 Sean Barrett 2006-11-18 -// simple implementation -// - all input must be provided in an upfront buffer -// - all output is written to a single output buffer (can malloc/realloc) -// performance -// - fast huffman - -#ifndef STBI_NO_ZLIB - -// fast-way is faster to check than jpeg huffman, but slow way is slower -#define STBI__ZFAST_BITS 9 // accelerate all cases in default tables -#define STBI__ZFAST_MASK ((1 << STBI__ZFAST_BITS) - 1) -#define STBI__ZNSYMS 288 // number of symbols in literal/length alphabet - -// zlib-style huffman encoding -// (jpegs packs from left, zlib from right, so can't share code) -typedef struct -{ - stbi__uint16 fast[1 << STBI__ZFAST_BITS]; - stbi__uint16 firstcode[16]; - int maxcode[17]; - stbi__uint16 firstsymbol[16]; - stbi_uc size[STBI__ZNSYMS]; - stbi__uint16 value[STBI__ZNSYMS]; -} stbi__zhuffman; - -stbi_inline static int stbi__bitreverse16(int n) -{ - n = ((n & 0xAAAA) >> 1) | ((n & 0x5555) << 1); - n = ((n & 0xCCCC) >> 2) | ((n & 0x3333) << 2); - n = ((n & 0xF0F0) >> 4) | ((n & 0x0F0F) << 4); - n = ((n & 0xFF00) >> 8) | ((n & 0x00FF) << 8); - return n; -} - -stbi_inline static int stbi__bit_reverse(int v, int bits) -{ - STBI_ASSERT(bits <= 16); - // to bit reverse n bits, reverse 16 and shift - // e.g. 11 bits, bit reverse and shift away 5 - return stbi__bitreverse16(v) >> (16-bits); -} - -static int stbi__zbuild_huffman(stbi__zhuffman *z, const stbi_uc *sizelist, int num) -{ - int i,k=0; - int code, next_code[16], sizes[17]; - - // DEFLATE spec for generating codes - memset(sizes, 0, sizeof(sizes)); - memset(z->fast, 0, sizeof(z->fast)); - for (i=0; i < num; ++i) - ++sizes[sizelist[i]]; - sizes[0] = 0; - for (i=1; i < 16; ++i) - if (sizes[i] > (1 << i)) - return stbi__err("bad sizes", "Corrupt PNG"); - code = 0; - for (i=1; i < 16; ++i) { - next_code[i] = code; - z->firstcode[i] = (stbi__uint16) code; - z->firstsymbol[i] = (stbi__uint16) k; - code = (code + sizes[i]); - if (sizes[i]) - if (code-1 >= (1 << i)) return stbi__err("bad codelengths","Corrupt PNG"); - z->maxcode[i] = code << (16-i); // preshift for inner loop - code <<= 1; - k += sizes[i]; - } - z->maxcode[16] = 0x10000; // sentinel - for (i=0; i < num; ++i) { - int s = sizelist[i]; - if (s) { - int c = next_code[s] - z->firstcode[s] + z->firstsymbol[s]; - stbi__uint16 fastv = (stbi__uint16) ((s << 9) | i); - z->size [c] = (stbi_uc ) s; - z->value[c] = (stbi__uint16) i; - if (s <= STBI__ZFAST_BITS) { - int j = stbi__bit_reverse(next_code[s],s); - while (j < (1 << STBI__ZFAST_BITS)) { - z->fast[j] = fastv; - j += (1 << s); - } - } - ++next_code[s]; - } - } - return 1; -} - -// zlib-from-memory implementation for PNG reading -// because PNG allows splitting the zlib stream arbitrarily, -// and it's annoying structurally to have PNG call ZLIB call PNG, -// we require PNG read all the IDATs and combine them into a single -// memory buffer - -typedef struct -{ - stbi_uc *zbuffer, *zbuffer_end; - int num_bits; - int hit_zeof_once; - stbi__uint32 code_buffer; - - char *zout; - char *zout_start; - char *zout_end; - int z_expandable; - - stbi__zhuffman z_length, z_distance; -} stbi__zbuf; - -stbi_inline static int stbi__zeof(stbi__zbuf *z) -{ - return (z->zbuffer >= z->zbuffer_end); -} - -stbi_inline static stbi_uc stbi__zget8(stbi__zbuf *z) -{ - return stbi__zeof(z) ? 0 : *z->zbuffer++; -} - -static void stbi__fill_bits(stbi__zbuf *z) -{ - do { - if (z->code_buffer >= (1U << z->num_bits)) { - z->zbuffer = z->zbuffer_end; /* treat this as EOF so we fail. */ - return; - } - z->code_buffer |= (unsigned int) stbi__zget8(z) << z->num_bits; - z->num_bits += 8; - } while (z->num_bits <= 24); -} - -stbi_inline static unsigned int stbi__zreceive(stbi__zbuf *z, int n) -{ - unsigned int k; - if (z->num_bits < n) stbi__fill_bits(z); - k = z->code_buffer & ((1 << n) - 1); - z->code_buffer >>= n; - z->num_bits -= n; - return k; -} - -static int stbi__zhuffman_decode_slowpath(stbi__zbuf *a, stbi__zhuffman *z) -{ - int b,s,k; - // not resolved by fast table, so compute it the slow way - // use jpeg approach, which requires MSbits at top - k = stbi__bit_reverse(a->code_buffer, 16); - for (s=STBI__ZFAST_BITS+1; ; ++s) - if (k < z->maxcode[s]) - break; - if (s >= 16) return -1; // invalid code! - // code size is s, so: - b = (k >> (16-s)) - z->firstcode[s] + z->firstsymbol[s]; - if (b >= STBI__ZNSYMS) return -1; // some data was corrupt somewhere! - if (z->size[b] != s) return -1; // was originally an assert, but report failure instead. - a->code_buffer >>= s; - a->num_bits -= s; - return z->value[b]; -} - -stbi_inline static int stbi__zhuffman_decode(stbi__zbuf *a, stbi__zhuffman *z) -{ - int b,s; - if (a->num_bits < 16) { - if (stbi__zeof(a)) { - if (!a->hit_zeof_once) { - // This is the first time we hit eof, insert 16 extra padding btis - // to allow us to keep going; if we actually consume any of them - // though, that is invalid data. This is caught later. - a->hit_zeof_once = 1; - a->num_bits += 16; // add 16 implicit zero bits - } else { - // We already inserted our extra 16 padding bits and are again - // out, this stream is actually prematurely terminated. - return -1; - } - } else { - stbi__fill_bits(a); - } - } - b = z->fast[a->code_buffer & STBI__ZFAST_MASK]; - if (b) { - s = b >> 9; - a->code_buffer >>= s; - a->num_bits -= s; - return b & 511; - } - return stbi__zhuffman_decode_slowpath(a, z); -} - -static int stbi__zexpand(stbi__zbuf *z, char *zout, int n) // need to make room for n bytes -{ - char *q; - unsigned int cur, limit, old_limit; - z->zout = zout; - if (!z->z_expandable) return stbi__err("output buffer limit","Corrupt PNG"); - cur = (unsigned int) (z->zout - z->zout_start); - limit = old_limit = (unsigned) (z->zout_end - z->zout_start); - if (UINT_MAX - cur < (unsigned) n) return stbi__err("outofmem", "Out of memory"); - while (cur + n > limit) { - if(limit > UINT_MAX / 2) return stbi__err("outofmem", "Out of memory"); - limit *= 2; - } - q = (char *) STBI_REALLOC_SIZED(z->zout_start, old_limit, limit); - STBI_NOTUSED(old_limit); - if (q == NULL) return stbi__err("outofmem", "Out of memory"); - z->zout_start = q; - z->zout = q + cur; - z->zout_end = q + limit; - return 1; -} - -static const int stbi__zlength_base[31] = { - 3,4,5,6,7,8,9,10,11,13, - 15,17,19,23,27,31,35,43,51,59, - 67,83,99,115,131,163,195,227,258,0,0 }; - -static const int stbi__zlength_extra[31]= -{ 0,0,0,0,0,0,0,0,1,1,1,1,2,2,2,2,3,3,3,3,4,4,4,4,5,5,5,5,0,0,0 }; - -static const int stbi__zdist_base[32] = { 1,2,3,4,5,7,9,13,17,25,33,49,65,97,129,193, -257,385,513,769,1025,1537,2049,3073,4097,6145,8193,12289,16385,24577,0,0}; - -static const int stbi__zdist_extra[32] = -{ 0,0,0,0,1,1,2,2,3,3,4,4,5,5,6,6,7,7,8,8,9,9,10,10,11,11,12,12,13,13}; - -static int stbi__parse_huffman_block(stbi__zbuf *a) -{ - char *zout = a->zout; - for(;;) { - int z = stbi__zhuffman_decode(a, &a->z_length); - if (z < 256) { - if (z < 0) return stbi__err("bad huffman code","Corrupt PNG"); // error in huffman codes - if (zout >= a->zout_end) { - if (!stbi__zexpand(a, zout, 1)) return 0; - zout = a->zout; - } - *zout++ = (char) z; - } else { - stbi_uc *p; - int len,dist; - if (z == 256) { - a->zout = zout; - if (a->hit_zeof_once && a->num_bits < 16) { - // The first time we hit zeof, we inserted 16 extra zero bits into our bit - // buffer so the decoder can just do its speculative decoding. But if we - // actually consumed any of those bits (which is the case when num_bits < 16), - // the stream actually read past the end so it is malformed. - return stbi__err("unexpected end","Corrupt PNG"); - } - return 1; - } - if (z >= 286) return stbi__err("bad huffman code","Corrupt PNG"); // per DEFLATE, length codes 286 and 287 must not appear in compressed data - z -= 257; - len = stbi__zlength_base[z]; - if (stbi__zlength_extra[z]) len += stbi__zreceive(a, stbi__zlength_extra[z]); - z = stbi__zhuffman_decode(a, &a->z_distance); - if (z < 0 || z >= 30) return stbi__err("bad huffman code","Corrupt PNG"); // per DEFLATE, distance codes 30 and 31 must not appear in compressed data - dist = stbi__zdist_base[z]; - if (stbi__zdist_extra[z]) dist += stbi__zreceive(a, stbi__zdist_extra[z]); - if (zout - a->zout_start < dist) return stbi__err("bad dist","Corrupt PNG"); - if (len > a->zout_end - zout) { - if (!stbi__zexpand(a, zout, len)) return 0; - zout = a->zout; - } - p = (stbi_uc *) (zout - dist); - if (dist == 1) { // run of one byte; common in images. - stbi_uc v = *p; - if (len) { do *zout++ = v; while (--len); } - } else { - if (len) { do *zout++ = *p++; while (--len); } - } - } - } -} - -static int stbi__compute_huffman_codes(stbi__zbuf *a) -{ - static const stbi_uc length_dezigzag[19] = { 16,17,18,0,8,7,9,6,10,5,11,4,12,3,13,2,14,1,15 }; - stbi__zhuffman z_codelength; - stbi_uc lencodes[286+32+137];//padding for maximum single op - stbi_uc codelength_sizes[19]; - int i,n; - - int hlit = stbi__zreceive(a,5) + 257; - int hdist = stbi__zreceive(a,5) + 1; - int hclen = stbi__zreceive(a,4) + 4; - int ntot = hlit + hdist; - - memset(codelength_sizes, 0, sizeof(codelength_sizes)); - for (i=0; i < hclen; ++i) { - int s = stbi__zreceive(a,3); - codelength_sizes[length_dezigzag[i]] = (stbi_uc) s; - } - if (!stbi__zbuild_huffman(&z_codelength, codelength_sizes, 19)) return 0; - - n = 0; - while (n < ntot) { - int c = stbi__zhuffman_decode(a, &z_codelength); - if (c < 0 || c >= 19) return stbi__err("bad codelengths", "Corrupt PNG"); - if (c < 16) - lencodes[n++] = (stbi_uc) c; - else { - stbi_uc fill = 0; - if (c == 16) { - c = stbi__zreceive(a,2)+3; - if (n == 0) return stbi__err("bad codelengths", "Corrupt PNG"); - fill = lencodes[n-1]; - } else if (c == 17) { - c = stbi__zreceive(a,3)+3; - } else if (c == 18) { - c = stbi__zreceive(a,7)+11; - } else { - return stbi__err("bad codelengths", "Corrupt PNG"); - } - if (ntot - n < c) return stbi__err("bad codelengths", "Corrupt PNG"); - memset(lencodes+n, fill, c); - n += c; - } - } - if (n != ntot) return stbi__err("bad codelengths","Corrupt PNG"); - if (!stbi__zbuild_huffman(&a->z_length, lencodes, hlit)) return 0; - if (!stbi__zbuild_huffman(&a->z_distance, lencodes+hlit, hdist)) return 0; - return 1; -} - -static int stbi__parse_uncompressed_block(stbi__zbuf *a) -{ - stbi_uc header[4]; - int len,nlen,k; - if (a->num_bits & 7) - stbi__zreceive(a, a->num_bits & 7); // discard - // drain the bit-packed data into header - k = 0; - while (a->num_bits > 0) { - header[k++] = (stbi_uc) (a->code_buffer & 255); // suppress MSVC run-time check - a->code_buffer >>= 8; - a->num_bits -= 8; - } - if (a->num_bits < 0) return stbi__err("zlib corrupt","Corrupt PNG"); - // now fill header the normal way - while (k < 4) - header[k++] = stbi__zget8(a); - len = header[1] * 256 + header[0]; - nlen = header[3] * 256 + header[2]; - if (nlen != (len ^ 0xffff)) return stbi__err("zlib corrupt","Corrupt PNG"); - if (a->zbuffer + len > a->zbuffer_end) return stbi__err("read past buffer","Corrupt PNG"); - if (a->zout + len > a->zout_end) - if (!stbi__zexpand(a, a->zout, len)) return 0; - memcpy(a->zout, a->zbuffer, len); - a->zbuffer += len; - a->zout += len; - return 1; -} - -static int stbi__parse_zlib_header(stbi__zbuf *a) -{ - int cmf = stbi__zget8(a); - int cm = cmf & 15; - /* int cinfo = cmf >> 4; */ - int flg = stbi__zget8(a); - if (stbi__zeof(a)) return stbi__err("bad zlib header","Corrupt PNG"); // zlib spec - if ((cmf*256+flg) % 31 != 0) return stbi__err("bad zlib header","Corrupt PNG"); // zlib spec - if (flg & 32) return stbi__err("no preset dict","Corrupt PNG"); // preset dictionary not allowed in png - if (cm != 8) return stbi__err("bad compression","Corrupt PNG"); // DEFLATE required for png - // window = 1 << (8 + cinfo)... but who cares, we fully buffer output - return 1; -} - -static const stbi_uc stbi__zdefault_length[STBI__ZNSYMS] = -{ - 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, - 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, - 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, - 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, - 8,8,8,8,8,8,8,8,8,8,8,8,8,8,8,8, 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, - 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, - 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, - 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, 9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, - 7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7, 7,7,7,7,7,7,7,7,8,8,8,8,8,8,8,8 -}; -static const stbi_uc stbi__zdefault_distance[32] = -{ - 5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5,5 -}; -/* -Init algorithm: -{ - int i; // use <= to match clearly with spec - for (i=0; i <= 143; ++i) stbi__zdefault_length[i] = 8; - for ( ; i <= 255; ++i) stbi__zdefault_length[i] = 9; - for ( ; i <= 279; ++i) stbi__zdefault_length[i] = 7; - for ( ; i <= 287; ++i) stbi__zdefault_length[i] = 8; - - for (i=0; i <= 31; ++i) stbi__zdefault_distance[i] = 5; -} -*/ - -static int stbi__parse_zlib(stbi__zbuf *a, int parse_header) -{ - int final, type; - if (parse_header) - if (!stbi__parse_zlib_header(a)) return 0; - a->num_bits = 0; - a->code_buffer = 0; - a->hit_zeof_once = 0; - do { - final = stbi__zreceive(a,1); - type = stbi__zreceive(a,2); - if (type == 0) { - if (!stbi__parse_uncompressed_block(a)) return 0; - } else if (type == 3) { - return 0; - } else { - if (type == 1) { - // use fixed code lengths - if (!stbi__zbuild_huffman(&a->z_length , stbi__zdefault_length , STBI__ZNSYMS)) return 0; - if (!stbi__zbuild_huffman(&a->z_distance, stbi__zdefault_distance, 32)) return 0; - } else { - if (!stbi__compute_huffman_codes(a)) return 0; - } - if (!stbi__parse_huffman_block(a)) return 0; - } - } while (!final); - return 1; -} - -static int stbi__do_zlib(stbi__zbuf *a, char *obuf, int olen, int exp, int parse_header) -{ - a->zout_start = obuf; - a->zout = obuf; - a->zout_end = obuf + olen; - a->z_expandable = exp; - - return stbi__parse_zlib(a, parse_header); -} - -STBIDEF char *stbi_zlib_decode_malloc_guesssize(const char *buffer, int len, int initial_size, int *outlen) -{ - stbi__zbuf a; - char *p = (char *) stbi__malloc(initial_size); - if (p == NULL) return NULL; - a.zbuffer = (stbi_uc *) buffer; - a.zbuffer_end = (stbi_uc *) buffer + len; - if (stbi__do_zlib(&a, p, initial_size, 1, 1)) { - if (outlen) *outlen = (int) (a.zout - a.zout_start); - return a.zout_start; - } else { - STBI_FREE(a.zout_start); - return NULL; - } -} - -STBIDEF char *stbi_zlib_decode_malloc(char const *buffer, int len, int *outlen) -{ - return stbi_zlib_decode_malloc_guesssize(buffer, len, 16384, outlen); -} - -STBIDEF char *stbi_zlib_decode_malloc_guesssize_headerflag(const char *buffer, int len, int initial_size, int *outlen, int parse_header) -{ - stbi__zbuf a; - char *p = (char *) stbi__malloc(initial_size); - if (p == NULL) return NULL; - a.zbuffer = (stbi_uc *) buffer; - a.zbuffer_end = (stbi_uc *) buffer + len; - if (stbi__do_zlib(&a, p, initial_size, 1, parse_header)) { - if (outlen) *outlen = (int) (a.zout - a.zout_start); - return a.zout_start; - } else { - STBI_FREE(a.zout_start); - return NULL; - } -} - -STBIDEF int stbi_zlib_decode_buffer(char *obuffer, int olen, char const *ibuffer, int ilen) -{ - stbi__zbuf a; - a.zbuffer = (stbi_uc *) ibuffer; - a.zbuffer_end = (stbi_uc *) ibuffer + ilen; - if (stbi__do_zlib(&a, obuffer, olen, 0, 1)) - return (int) (a.zout - a.zout_start); - else - return -1; -} - -STBIDEF char *stbi_zlib_decode_noheader_malloc(char const *buffer, int len, int *outlen) -{ - stbi__zbuf a; - char *p = (char *) stbi__malloc(16384); - if (p == NULL) return NULL; - a.zbuffer = (stbi_uc *) buffer; - a.zbuffer_end = (stbi_uc *) buffer+len; - if (stbi__do_zlib(&a, p, 16384, 1, 0)) { - if (outlen) *outlen = (int) (a.zout - a.zout_start); - return a.zout_start; - } else { - STBI_FREE(a.zout_start); - return NULL; - } -} - -STBIDEF int stbi_zlib_decode_noheader_buffer(char *obuffer, int olen, const char *ibuffer, int ilen) -{ - stbi__zbuf a; - a.zbuffer = (stbi_uc *) ibuffer; - a.zbuffer_end = (stbi_uc *) ibuffer + ilen; - if (stbi__do_zlib(&a, obuffer, olen, 0, 0)) - return (int) (a.zout - a.zout_start); - else - return -1; -} -#endif - -// public domain "baseline" PNG decoder v0.10 Sean Barrett 2006-11-18 -// simple implementation -// - only 8-bit samples -// - no CRC checking -// - allocates lots of intermediate memory -// - avoids problem of streaming data between subsystems -// - avoids explicit window management -// performance -// - uses stb_zlib, a PD zlib implementation with fast huffman decoding - -#ifndef STBI_NO_PNG -typedef struct -{ - stbi__uint32 length; - stbi__uint32 type; -} stbi__pngchunk; - -static stbi__pngchunk stbi__get_chunk_header(stbi__context *s) -{ - stbi__pngchunk c; - c.length = stbi__get32be(s); - c.type = stbi__get32be(s); - return c; -} - -static int stbi__check_png_header(stbi__context *s) -{ - static const stbi_uc png_sig[8] = { 137,80,78,71,13,10,26,10 }; - int i; - for (i=0; i < 8; ++i) - if (stbi__get8(s) != png_sig[i]) return stbi__err("bad png sig","Not a PNG"); - return 1; -} - -typedef struct -{ - stbi__context *s; - stbi_uc *idata, *expanded, *out; - int depth; -} stbi__png; - - -enum { - STBI__F_none=0, - STBI__F_sub=1, - STBI__F_up=2, - STBI__F_avg=3, - STBI__F_paeth=4, - // synthetic filter used for first scanline to avoid needing a dummy row of 0s - STBI__F_avg_first -}; - -static stbi_uc first_row_filter[5] = -{ - STBI__F_none, - STBI__F_sub, - STBI__F_none, - STBI__F_avg_first, - STBI__F_sub // Paeth with b=c=0 turns out to be equivalent to sub -}; - -static int stbi__paeth(int a, int b, int c) -{ - // This formulation looks very different from the reference in the PNG spec, but is - // actually equivalent and has favorable data dependencies and admits straightforward - // generation of branch-free code, which helps performance significantly. - int thresh = c*3 - (a + b); - int lo = a < b ? a : b; - int hi = a < b ? b : a; - int t0 = (hi <= thresh) ? lo : c; - int t1 = (thresh <= lo) ? hi : t0; - return t1; -} - -static const stbi_uc stbi__depth_scale_table[9] = { 0, 0xff, 0x55, 0, 0x11, 0,0,0, 0x01 }; - -// adds an extra all-255 alpha channel -// dest == src is legal -// img_n must be 1 or 3 -static void stbi__create_png_alpha_expand8(stbi_uc *dest, stbi_uc *src, stbi__uint32 x, int img_n) -{ - int i; - // must process data backwards since we allow dest==src - if (img_n == 1) { - for (i=x-1; i >= 0; --i) { - dest[i*2+1] = 255; - dest[i*2+0] = src[i]; - } - } else { - STBI_ASSERT(img_n == 3); - for (i=x-1; i >= 0; --i) { - dest[i*4+3] = 255; - dest[i*4+2] = src[i*3+2]; - dest[i*4+1] = src[i*3+1]; - dest[i*4+0] = src[i*3+0]; - } - } -} - -// create the png data from post-deflated data -static int stbi__create_png_image_raw(stbi__png *a, stbi_uc *raw, stbi__uint32 raw_len, int out_n, stbi__uint32 x, stbi__uint32 y, int depth, int color) -{ - int bytes = (depth == 16 ? 2 : 1); - stbi__context *s = a->s; - stbi__uint32 i,j,stride = x*out_n*bytes; - stbi__uint32 img_len, img_width_bytes; - stbi_uc *filter_buf; - int all_ok = 1; - int k; - int img_n = s->img_n; // copy it into a local for later - - int output_bytes = out_n*bytes; - int filter_bytes = img_n*bytes; - int width = x; - - STBI_ASSERT(out_n == s->img_n || out_n == s->img_n+1); - a->out = (stbi_uc *) stbi__malloc_mad3(x, y, output_bytes, 0); // extra bytes to write off the end into - if (!a->out) return stbi__err("outofmem", "Out of memory"); - - // note: error exits here don't need to clean up a->out individually, - // stbi__do_png always does on error. - if (!stbi__mad3sizes_valid(img_n, x, depth, 7)) return stbi__err("too large", "Corrupt PNG"); - img_width_bytes = (((img_n * x * depth) + 7) >> 3); - if (!stbi__mad2sizes_valid(img_width_bytes, y, img_width_bytes)) return stbi__err("too large", "Corrupt PNG"); - img_len = (img_width_bytes + 1) * y; - - // we used to check for exact match between raw_len and img_len on non-interlaced PNGs, - // but issue #276 reported a PNG in the wild that had extra data at the end (all zeros), - // so just check for raw_len < img_len always. - if (raw_len < img_len) return stbi__err("not enough pixels","Corrupt PNG"); - - // Allocate two scan lines worth of filter workspace buffer. - filter_buf = (stbi_uc *) stbi__malloc_mad2(img_width_bytes, 2, 0); - if (!filter_buf) return stbi__err("outofmem", "Out of memory"); - - // Filtering for low-bit-depth images - if (depth < 8) { - filter_bytes = 1; - width = img_width_bytes; - } - - for (j=0; j < y; ++j) { - // cur/prior filter buffers alternate - stbi_uc *cur = filter_buf + (j & 1)*img_width_bytes; - stbi_uc *prior = filter_buf + (~j & 1)*img_width_bytes; - stbi_uc *dest = a->out + stride*j; - int nk = width * filter_bytes; - int filter = *raw++; - - // check filter type - if (filter > 4) { - all_ok = stbi__err("invalid filter","Corrupt PNG"); - break; - } - - // if first row, use special filter that doesn't sample previous row - if (j == 0) filter = first_row_filter[filter]; - - // perform actual filtering - switch (filter) { - case STBI__F_none: - memcpy(cur, raw, nk); - break; - case STBI__F_sub: - memcpy(cur, raw, filter_bytes); - for (k = filter_bytes; k < nk; ++k) - cur[k] = STBI__BYTECAST(raw[k] + cur[k-filter_bytes]); - break; - case STBI__F_up: - for (k = 0; k < nk; ++k) - cur[k] = STBI__BYTECAST(raw[k] + prior[k]); - break; - case STBI__F_avg: - for (k = 0; k < filter_bytes; ++k) - cur[k] = STBI__BYTECAST(raw[k] + (prior[k]>>1)); - for (k = filter_bytes; k < nk; ++k) - cur[k] = STBI__BYTECAST(raw[k] + ((prior[k] + cur[k-filter_bytes])>>1)); - break; - case STBI__F_paeth: - for (k = 0; k < filter_bytes; ++k) - cur[k] = STBI__BYTECAST(raw[k] + prior[k]); // prior[k] == stbi__paeth(0,prior[k],0) - for (k = filter_bytes; k < nk; ++k) - cur[k] = STBI__BYTECAST(raw[k] + stbi__paeth(cur[k-filter_bytes], prior[k], prior[k-filter_bytes])); - break; - case STBI__F_avg_first: - memcpy(cur, raw, filter_bytes); - for (k = filter_bytes; k < nk; ++k) - cur[k] = STBI__BYTECAST(raw[k] + (cur[k-filter_bytes] >> 1)); - break; - } - - raw += nk; - - // expand decoded bits in cur to dest, also adding an extra alpha channel if desired - if (depth < 8) { - stbi_uc scale = (color == 0) ? stbi__depth_scale_table[depth] : 1; // scale grayscale values to 0..255 range - stbi_uc *in = cur; - stbi_uc *out = dest; - stbi_uc inb = 0; - stbi__uint32 nsmp = x*img_n; - - // expand bits to bytes first - if (depth == 4) { - for (i=0; i < nsmp; ++i) { - if ((i & 1) == 0) inb = *in++; - *out++ = scale * (inb >> 4); - inb <<= 4; - } - } else if (depth == 2) { - for (i=0; i < nsmp; ++i) { - if ((i & 3) == 0) inb = *in++; - *out++ = scale * (inb >> 6); - inb <<= 2; - } - } else { - STBI_ASSERT(depth == 1); - for (i=0; i < nsmp; ++i) { - if ((i & 7) == 0) inb = *in++; - *out++ = scale * (inb >> 7); - inb <<= 1; - } - } - - // insert alpha=255 values if desired - if (img_n != out_n) - stbi__create_png_alpha_expand8(dest, dest, x, img_n); - } else if (depth == 8) { - if (img_n == out_n) - memcpy(dest, cur, x*img_n); - else - stbi__create_png_alpha_expand8(dest, cur, x, img_n); - } else if (depth == 16) { - // convert the image data from big-endian to platform-native - stbi__uint16 *dest16 = (stbi__uint16*)dest; - stbi__uint32 nsmp = x*img_n; - - if (img_n == out_n) { - for (i = 0; i < nsmp; ++i, ++dest16, cur += 2) - *dest16 = (cur[0] << 8) | cur[1]; - } else { - STBI_ASSERT(img_n+1 == out_n); - if (img_n == 1) { - for (i = 0; i < x; ++i, dest16 += 2, cur += 2) { - dest16[0] = (cur[0] << 8) | cur[1]; - dest16[1] = 0xffff; - } - } else { - STBI_ASSERT(img_n == 3); - for (i = 0; i < x; ++i, dest16 += 4, cur += 6) { - dest16[0] = (cur[0] << 8) | cur[1]; - dest16[1] = (cur[2] << 8) | cur[3]; - dest16[2] = (cur[4] << 8) | cur[5]; - dest16[3] = 0xffff; - } - } - } - } - } - - STBI_FREE(filter_buf); - if (!all_ok) return 0; - - return 1; -} - -static int stbi__create_png_image(stbi__png *a, stbi_uc *image_data, stbi__uint32 image_data_len, int out_n, int depth, int color, int interlaced) -{ - int bytes = (depth == 16 ? 2 : 1); - int out_bytes = out_n * bytes; - stbi_uc *final; - int p; - if (!interlaced) - return stbi__create_png_image_raw(a, image_data, image_data_len, out_n, a->s->img_x, a->s->img_y, depth, color); - - // de-interlacing - final = (stbi_uc *) stbi__malloc_mad3(a->s->img_x, a->s->img_y, out_bytes, 0); - if (!final) return stbi__err("outofmem", "Out of memory"); - for (p=0; p < 7; ++p) { - int xorig[] = { 0,4,0,2,0,1,0 }; - int yorig[] = { 0,0,4,0,2,0,1 }; - int xspc[] = { 8,8,4,4,2,2,1 }; - int yspc[] = { 8,8,8,4,4,2,2 }; - int i,j,x,y; - // pass1_x[4] = 0, pass1_x[5] = 1, pass1_x[12] = 1 - x = (a->s->img_x - xorig[p] + xspc[p]-1) / xspc[p]; - y = (a->s->img_y - yorig[p] + yspc[p]-1) / yspc[p]; - if (x && y) { - stbi__uint32 img_len = ((((a->s->img_n * x * depth) + 7) >> 3) + 1) * y; - if (!stbi__create_png_image_raw(a, image_data, image_data_len, out_n, x, y, depth, color)) { - STBI_FREE(final); - return 0; - } - for (j=0; j < y; ++j) { - for (i=0; i < x; ++i) { - int out_y = j*yspc[p]+yorig[p]; - int out_x = i*xspc[p]+xorig[p]; - memcpy(final + out_y*a->s->img_x*out_bytes + out_x*out_bytes, - a->out + (j*x+i)*out_bytes, out_bytes); - } - } - STBI_FREE(a->out); - image_data += img_len; - image_data_len -= img_len; - } - } - a->out = final; - - return 1; -} - -static int stbi__compute_transparency(stbi__png *z, stbi_uc tc[3], int out_n) -{ - stbi__context *s = z->s; - stbi__uint32 i, pixel_count = s->img_x * s->img_y; - stbi_uc *p = z->out; - - // compute color-based transparency, assuming we've - // already got 255 as the alpha value in the output - STBI_ASSERT(out_n == 2 || out_n == 4); - - if (out_n == 2) { - for (i=0; i < pixel_count; ++i) { - p[1] = (p[0] == tc[0] ? 0 : 255); - p += 2; - } - } else { - for (i=0; i < pixel_count; ++i) { - if (p[0] == tc[0] && p[1] == tc[1] && p[2] == tc[2]) - p[3] = 0; - p += 4; - } - } - return 1; -} - -static int stbi__compute_transparency16(stbi__png *z, stbi__uint16 tc[3], int out_n) -{ - stbi__context *s = z->s; - stbi__uint32 i, pixel_count = s->img_x * s->img_y; - stbi__uint16 *p = (stbi__uint16*) z->out; - - // compute color-based transparency, assuming we've - // already got 65535 as the alpha value in the output - STBI_ASSERT(out_n == 2 || out_n == 4); - - if (out_n == 2) { - for (i = 0; i < pixel_count; ++i) { - p[1] = (p[0] == tc[0] ? 0 : 65535); - p += 2; - } - } else { - for (i = 0; i < pixel_count; ++i) { - if (p[0] == tc[0] && p[1] == tc[1] && p[2] == tc[2]) - p[3] = 0; - p += 4; - } - } - return 1; -} - -static int stbi__expand_png_palette(stbi__png *a, stbi_uc *palette, int len, int pal_img_n) -{ - stbi__uint32 i, pixel_count = a->s->img_x * a->s->img_y; - stbi_uc *p, *temp_out, *orig = a->out; - - p = (stbi_uc *) stbi__malloc_mad2(pixel_count, pal_img_n, 0); - if (p == NULL) return stbi__err("outofmem", "Out of memory"); - - // between here and free(out) below, exitting would leak - temp_out = p; - - if (pal_img_n == 3) { - for (i=0; i < pixel_count; ++i) { - int n = orig[i]*4; - p[0] = palette[n ]; - p[1] = palette[n+1]; - p[2] = palette[n+2]; - p += 3; - } - } else { - for (i=0; i < pixel_count; ++i) { - int n = orig[i]*4; - p[0] = palette[n ]; - p[1] = palette[n+1]; - p[2] = palette[n+2]; - p[3] = palette[n+3]; - p += 4; - } - } - STBI_FREE(a->out); - a->out = temp_out; - - STBI_NOTUSED(len); - - return 1; -} - -static int stbi__unpremultiply_on_load_global = 0; -static int stbi__de_iphone_flag_global = 0; - -STBIDEF void stbi_set_unpremultiply_on_load(int flag_true_if_should_unpremultiply) -{ - stbi__unpremultiply_on_load_global = flag_true_if_should_unpremultiply; -} - -STBIDEF void stbi_convert_iphone_png_to_rgb(int flag_true_if_should_convert) -{ - stbi__de_iphone_flag_global = flag_true_if_should_convert; -} - -#ifndef STBI_THREAD_LOCAL -#define stbi__unpremultiply_on_load stbi__unpremultiply_on_load_global -#define stbi__de_iphone_flag stbi__de_iphone_flag_global -#else -static STBI_THREAD_LOCAL int stbi__unpremultiply_on_load_local, stbi__unpremultiply_on_load_set; -static STBI_THREAD_LOCAL int stbi__de_iphone_flag_local, stbi__de_iphone_flag_set; - -STBIDEF void stbi_set_unpremultiply_on_load_thread(int flag_true_if_should_unpremultiply) -{ - stbi__unpremultiply_on_load_local = flag_true_if_should_unpremultiply; - stbi__unpremultiply_on_load_set = 1; -} - -STBIDEF void stbi_convert_iphone_png_to_rgb_thread(int flag_true_if_should_convert) -{ - stbi__de_iphone_flag_local = flag_true_if_should_convert; - stbi__de_iphone_flag_set = 1; -} - -#define stbi__unpremultiply_on_load (stbi__unpremultiply_on_load_set \ - ? stbi__unpremultiply_on_load_local \ - : stbi__unpremultiply_on_load_global) -#define stbi__de_iphone_flag (stbi__de_iphone_flag_set \ - ? stbi__de_iphone_flag_local \ - : stbi__de_iphone_flag_global) -#endif // STBI_THREAD_LOCAL - -static void stbi__de_iphone(stbi__png *z) -{ - stbi__context *s = z->s; - stbi__uint32 i, pixel_count = s->img_x * s->img_y; - stbi_uc *p = z->out; - - if (s->img_out_n == 3) { // convert bgr to rgb - for (i=0; i < pixel_count; ++i) { - stbi_uc t = p[0]; - p[0] = p[2]; - p[2] = t; - p += 3; - } - } else { - STBI_ASSERT(s->img_out_n == 4); - if (stbi__unpremultiply_on_load) { - // convert bgr to rgb and unpremultiply - for (i=0; i < pixel_count; ++i) { - stbi_uc a = p[3]; - stbi_uc t = p[0]; - if (a) { - stbi_uc half = a / 2; - p[0] = (p[2] * 255 + half) / a; - p[1] = (p[1] * 255 + half) / a; - p[2] = ( t * 255 + half) / a; - } else { - p[0] = p[2]; - p[2] = t; - } - p += 4; - } - } else { - // convert bgr to rgb - for (i=0; i < pixel_count; ++i) { - stbi_uc t = p[0]; - p[0] = p[2]; - p[2] = t; - p += 4; - } - } - } -} - -#define STBI__PNG_TYPE(a,b,c,d) (((unsigned) (a) << 24) + ((unsigned) (b) << 16) + ((unsigned) (c) << 8) + (unsigned) (d)) - -static int stbi__parse_png_file(stbi__png *z, int scan, int req_comp) -{ - stbi_uc palette[1024], pal_img_n=0; - stbi_uc has_trans=0, tc[3]={0}; - stbi__uint16 tc16[3]; - stbi__uint32 ioff=0, idata_limit=0, i, pal_len=0; - int first=1,k,interlace=0, color=0, is_iphone=0; - stbi__context *s = z->s; - - z->expanded = NULL; - z->idata = NULL; - z->out = NULL; - - if (!stbi__check_png_header(s)) return 0; - - if (scan == STBI__SCAN_type) return 1; - - for (;;) { - stbi__pngchunk c = stbi__get_chunk_header(s); - switch (c.type) { - case STBI__PNG_TYPE('C','g','B','I'): - is_iphone = 1; - stbi__skip(s, c.length); - break; - case STBI__PNG_TYPE('I','H','D','R'): { - int comp,filter; - if (!first) return stbi__err("multiple IHDR","Corrupt PNG"); - first = 0; - if (c.length != 13) return stbi__err("bad IHDR len","Corrupt PNG"); - s->img_x = stbi__get32be(s); - s->img_y = stbi__get32be(s); - if (s->img_y > STBI_MAX_DIMENSIONS) return stbi__err("too large","Very large image (corrupt?)"); - if (s->img_x > STBI_MAX_DIMENSIONS) return stbi__err("too large","Very large image (corrupt?)"); - z->depth = stbi__get8(s); if (z->depth != 1 && z->depth != 2 && z->depth != 4 && z->depth != 8 && z->depth != 16) return stbi__err("1/2/4/8/16-bit only","PNG not supported: 1/2/4/8/16-bit only"); - color = stbi__get8(s); if (color > 6) return stbi__err("bad ctype","Corrupt PNG"); - if (color == 3 && z->depth == 16) return stbi__err("bad ctype","Corrupt PNG"); - if (color == 3) pal_img_n = 3; else if (color & 1) return stbi__err("bad ctype","Corrupt PNG"); - comp = stbi__get8(s); if (comp) return stbi__err("bad comp method","Corrupt PNG"); - filter= stbi__get8(s); if (filter) return stbi__err("bad filter method","Corrupt PNG"); - interlace = stbi__get8(s); if (interlace>1) return stbi__err("bad interlace method","Corrupt PNG"); - if (!s->img_x || !s->img_y) return stbi__err("0-pixel image","Corrupt PNG"); - if (!pal_img_n) { - s->img_n = (color & 2 ? 3 : 1) + (color & 4 ? 1 : 0); - if ((1 << 30) / s->img_x / s->img_n < s->img_y) return stbi__err("too large", "Image too large to decode"); - } else { - // if paletted, then pal_n is our final components, and - // img_n is # components to decompress/filter. - s->img_n = 1; - if ((1 << 30) / s->img_x / 4 < s->img_y) return stbi__err("too large","Corrupt PNG"); - } - // even with SCAN_header, have to scan to see if we have a tRNS - break; - } - - case STBI__PNG_TYPE('P','L','T','E'): { - if (first) return stbi__err("first not IHDR", "Corrupt PNG"); - if (c.length > 256*3) return stbi__err("invalid PLTE","Corrupt PNG"); - pal_len = c.length / 3; - if (pal_len * 3 != c.length) return stbi__err("invalid PLTE","Corrupt PNG"); - for (i=0; i < pal_len; ++i) { - palette[i*4+0] = stbi__get8(s); - palette[i*4+1] = stbi__get8(s); - palette[i*4+2] = stbi__get8(s); - palette[i*4+3] = 255; - } - break; - } - - case STBI__PNG_TYPE('t','R','N','S'): { - if (first) return stbi__err("first not IHDR", "Corrupt PNG"); - if (z->idata) return stbi__err("tRNS after IDAT","Corrupt PNG"); - if (pal_img_n) { - if (scan == STBI__SCAN_header) { s->img_n = 4; return 1; } - if (pal_len == 0) return stbi__err("tRNS before PLTE","Corrupt PNG"); - if (c.length > pal_len) return stbi__err("bad tRNS len","Corrupt PNG"); - pal_img_n = 4; - for (i=0; i < c.length; ++i) - palette[i*4+3] = stbi__get8(s); - } else { - if (!(s->img_n & 1)) return stbi__err("tRNS with alpha","Corrupt PNG"); - if (c.length != (stbi__uint32) s->img_n*2) return stbi__err("bad tRNS len","Corrupt PNG"); - has_trans = 1; - // non-paletted with tRNS = constant alpha. if header-scanning, we can stop now. - if (scan == STBI__SCAN_header) { ++s->img_n; return 1; } - if (z->depth == 16) { - for (k = 0; k < s->img_n && k < 3; ++k) // extra loop test to suppress false GCC warning - tc16[k] = (stbi__uint16)stbi__get16be(s); // copy the values as-is - } else { - for (k = 0; k < s->img_n && k < 3; ++k) - tc[k] = (stbi_uc)(stbi__get16be(s) & 255) * stbi__depth_scale_table[z->depth]; // non 8-bit images will be larger - } - } - break; - } - - case STBI__PNG_TYPE('I','D','A','T'): { - if (first) return stbi__err("first not IHDR", "Corrupt PNG"); - if (pal_img_n && !pal_len) return stbi__err("no PLTE","Corrupt PNG"); - if (scan == STBI__SCAN_header) { - // header scan definitely stops at first IDAT - if (pal_img_n) - s->img_n = pal_img_n; - return 1; - } - if (c.length > (1u << 30)) return stbi__err("IDAT size limit", "IDAT section larger than 2^30 bytes"); - if ((int)(ioff + c.length) < (int)ioff) return 0; - if (ioff + c.length > idata_limit) { - stbi__uint32 idata_limit_old = idata_limit; - stbi_uc *p; - if (idata_limit == 0) idata_limit = c.length > 4096 ? c.length : 4096; - while (ioff + c.length > idata_limit) - idata_limit *= 2; - STBI_NOTUSED(idata_limit_old); - p = (stbi_uc *) STBI_REALLOC_SIZED(z->idata, idata_limit_old, idata_limit); if (p == NULL) return stbi__err("outofmem", "Out of memory"); - z->idata = p; - } - if (!stbi__getn(s, z->idata+ioff,c.length)) return stbi__err("outofdata","Corrupt PNG"); - ioff += c.length; - break; - } - - case STBI__PNG_TYPE('I','E','N','D'): { - stbi__uint32 raw_len, bpl; - if (first) return stbi__err("first not IHDR", "Corrupt PNG"); - if (scan != STBI__SCAN_load) return 1; - if (z->idata == NULL) return stbi__err("no IDAT","Corrupt PNG"); - // initial guess for decoded data size to avoid unnecessary reallocs - bpl = (s->img_x * z->depth + 7) / 8; // bytes per line, per component - raw_len = bpl * s->img_y * s->img_n /* pixels */ + s->img_y /* filter mode per row */; - z->expanded = (stbi_uc *) stbi_zlib_decode_malloc_guesssize_headerflag((char *) z->idata, ioff, raw_len, (int *) &raw_len, !is_iphone); - if (z->expanded == NULL) return 0; // zlib should set error - STBI_FREE(z->idata); z->idata = NULL; - if ((req_comp == s->img_n+1 && req_comp != 3 && !pal_img_n) || has_trans) - s->img_out_n = s->img_n+1; - else - s->img_out_n = s->img_n; - if (!stbi__create_png_image(z, z->expanded, raw_len, s->img_out_n, z->depth, color, interlace)) return 0; - if (has_trans) { - if (z->depth == 16) { - if (!stbi__compute_transparency16(z, tc16, s->img_out_n)) return 0; - } else { - if (!stbi__compute_transparency(z, tc, s->img_out_n)) return 0; - } - } - if (is_iphone && stbi__de_iphone_flag && s->img_out_n > 2) - stbi__de_iphone(z); - if (pal_img_n) { - // pal_img_n == 3 or 4 - s->img_n = pal_img_n; // record the actual colors we had - s->img_out_n = pal_img_n; - if (req_comp >= 3) s->img_out_n = req_comp; - if (!stbi__expand_png_palette(z, palette, pal_len, s->img_out_n)) - return 0; - } else if (has_trans) { - // non-paletted image with tRNS -> source image has (constant) alpha - ++s->img_n; - } - STBI_FREE(z->expanded); z->expanded = NULL; - // end of PNG chunk, read and skip CRC - stbi__get32be(s); - return 1; - } - - default: - // if critical, fail - if (first) return stbi__err("first not IHDR", "Corrupt PNG"); - if ((c.type & (1 << 29)) == 0) { - #ifndef STBI_NO_FAILURE_STRINGS - // not threadsafe - static char invalid_chunk[] = "XXXX PNG chunk not known"; - invalid_chunk[0] = STBI__BYTECAST(c.type >> 24); - invalid_chunk[1] = STBI__BYTECAST(c.type >> 16); - invalid_chunk[2] = STBI__BYTECAST(c.type >> 8); - invalid_chunk[3] = STBI__BYTECAST(c.type >> 0); - #endif - return stbi__err(invalid_chunk, "PNG not supported: unknown PNG chunk type"); - } - stbi__skip(s, c.length); - break; - } - // end of PNG chunk, read and skip CRC - stbi__get32be(s); - } -} - -static void *stbi__do_png(stbi__png *p, int *x, int *y, int *n, int req_comp, stbi__result_info *ri) -{ - void *result=NULL; - if (req_comp < 0 || req_comp > 4) return stbi__errpuc("bad req_comp", "Internal error"); - if (stbi__parse_png_file(p, STBI__SCAN_load, req_comp)) { - if (p->depth <= 8) - ri->bits_per_channel = 8; - else if (p->depth == 16) - ri->bits_per_channel = 16; - else - return stbi__errpuc("bad bits_per_channel", "PNG not supported: unsupported color depth"); - result = p->out; - p->out = NULL; - if (req_comp && req_comp != p->s->img_out_n) { - if (ri->bits_per_channel == 8) - result = stbi__convert_format((unsigned char *) result, p->s->img_out_n, req_comp, p->s->img_x, p->s->img_y); - else - result = stbi__convert_format16((stbi__uint16 *) result, p->s->img_out_n, req_comp, p->s->img_x, p->s->img_y); - p->s->img_out_n = req_comp; - if (result == NULL) return result; - } - *x = p->s->img_x; - *y = p->s->img_y; - if (n) *n = p->s->img_n; - } - STBI_FREE(p->out); p->out = NULL; - STBI_FREE(p->expanded); p->expanded = NULL; - STBI_FREE(p->idata); p->idata = NULL; - - return result; -} - -static void *stbi__png_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) -{ - stbi__png p; - p.s = s; - return stbi__do_png(&p, x,y,comp,req_comp, ri); -} - -static int stbi__png_test(stbi__context *s) -{ - int r; - r = stbi__check_png_header(s); - stbi__rewind(s); - return r; -} - -static int stbi__png_info_raw(stbi__png *p, int *x, int *y, int *comp) -{ - if (!stbi__parse_png_file(p, STBI__SCAN_header, 0)) { - stbi__rewind( p->s ); - return 0; - } - if (x) *x = p->s->img_x; - if (y) *y = p->s->img_y; - if (comp) *comp = p->s->img_n; - return 1; -} - -static int stbi__png_info(stbi__context *s, int *x, int *y, int *comp) -{ - stbi__png p; - p.s = s; - return stbi__png_info_raw(&p, x, y, comp); -} - -static int stbi__png_is16(stbi__context *s) -{ - stbi__png p; - p.s = s; - if (!stbi__png_info_raw(&p, NULL, NULL, NULL)) - return 0; - if (p.depth != 16) { - stbi__rewind(p.s); - return 0; - } - return 1; -} -#endif - -// Microsoft/Windows BMP image - -#ifndef STBI_NO_BMP -static int stbi__bmp_test_raw(stbi__context *s) -{ - int r; - int sz; - if (stbi__get8(s) != 'B') return 0; - if (stbi__get8(s) != 'M') return 0; - stbi__get32le(s); // discard filesize - stbi__get16le(s); // discard reserved - stbi__get16le(s); // discard reserved - stbi__get32le(s); // discard data offset - sz = stbi__get32le(s); - r = (sz == 12 || sz == 40 || sz == 56 || sz == 108 || sz == 124); - return r; -} - -static int stbi__bmp_test(stbi__context *s) -{ - int r = stbi__bmp_test_raw(s); - stbi__rewind(s); - return r; -} - - -// returns 0..31 for the highest set bit -static int stbi__high_bit(unsigned int z) -{ - int n=0; - if (z == 0) return -1; - if (z >= 0x10000) { n += 16; z >>= 16; } - if (z >= 0x00100) { n += 8; z >>= 8; } - if (z >= 0x00010) { n += 4; z >>= 4; } - if (z >= 0x00004) { n += 2; z >>= 2; } - if (z >= 0x00002) { n += 1;/* >>= 1;*/ } - return n; -} - -static int stbi__bitcount(unsigned int a) -{ - a = (a & 0x55555555) + ((a >> 1) & 0x55555555); // max 2 - a = (a & 0x33333333) + ((a >> 2) & 0x33333333); // max 4 - a = (a + (a >> 4)) & 0x0f0f0f0f; // max 8 per 4, now 8 bits - a = (a + (a >> 8)); // max 16 per 8 bits - a = (a + (a >> 16)); // max 32 per 8 bits - return a & 0xff; -} - -// extract an arbitrarily-aligned N-bit value (N=bits) -// from v, and then make it 8-bits long and fractionally -// extend it to full full range. -static int stbi__shiftsigned(unsigned int v, int shift, int bits) -{ - static unsigned int mul_table[9] = { - 0, - 0xff/*0b11111111*/, 0x55/*0b01010101*/, 0x49/*0b01001001*/, 0x11/*0b00010001*/, - 0x21/*0b00100001*/, 0x41/*0b01000001*/, 0x81/*0b10000001*/, 0x01/*0b00000001*/, - }; - static unsigned int shift_table[9] = { - 0, 0,0,1,0,2,4,6,0, - }; - if (shift < 0) - v <<= -shift; - else - v >>= shift; - STBI_ASSERT(v < 256); - v >>= (8-bits); - STBI_ASSERT(bits >= 0 && bits <= 8); - return (int) ((unsigned) v * mul_table[bits]) >> shift_table[bits]; -} - -typedef struct -{ - int bpp, offset, hsz; - unsigned int mr,mg,mb,ma, all_a; - int extra_read; -} stbi__bmp_data; - -static int stbi__bmp_set_mask_defaults(stbi__bmp_data *info, int compress) -{ - // BI_BITFIELDS specifies masks explicitly, don't override - if (compress == 3) - return 1; - - if (compress == 0) { - if (info->bpp == 16) { - info->mr = 31u << 10; - info->mg = 31u << 5; - info->mb = 31u << 0; - } else if (info->bpp == 32) { - info->mr = 0xffu << 16; - info->mg = 0xffu << 8; - info->mb = 0xffu << 0; - info->ma = 0xffu << 24; - info->all_a = 0; // if all_a is 0 at end, then we loaded alpha channel but it was all 0 - } else { - // otherwise, use defaults, which is all-0 - info->mr = info->mg = info->mb = info->ma = 0; - } - return 1; - } - return 0; // error -} - -static void *stbi__bmp_parse_header(stbi__context *s, stbi__bmp_data *info) -{ - int hsz; - if (stbi__get8(s) != 'B' || stbi__get8(s) != 'M') return stbi__errpuc("not BMP", "Corrupt BMP"); - stbi__get32le(s); // discard filesize - stbi__get16le(s); // discard reserved - stbi__get16le(s); // discard reserved - info->offset = stbi__get32le(s); - info->hsz = hsz = stbi__get32le(s); - info->mr = info->mg = info->mb = info->ma = 0; - info->extra_read = 14; - - if (info->offset < 0) return stbi__errpuc("bad BMP", "bad BMP"); - - if (hsz != 12 && hsz != 40 && hsz != 56 && hsz != 108 && hsz != 124) return stbi__errpuc("unknown BMP", "BMP type not supported: unknown"); - if (hsz == 12) { - s->img_x = stbi__get16le(s); - s->img_y = stbi__get16le(s); - } else { - s->img_x = stbi__get32le(s); - s->img_y = stbi__get32le(s); - } - if (stbi__get16le(s) != 1) return stbi__errpuc("bad BMP", "bad BMP"); - info->bpp = stbi__get16le(s); - if (hsz != 12) { - int compress = stbi__get32le(s); - if (compress == 1 || compress == 2) return stbi__errpuc("BMP RLE", "BMP type not supported: RLE"); - if (compress >= 4) return stbi__errpuc("BMP JPEG/PNG", "BMP type not supported: unsupported compression"); // this includes PNG/JPEG modes - if (compress == 3 && info->bpp != 16 && info->bpp != 32) return stbi__errpuc("bad BMP", "bad BMP"); // bitfields requires 16 or 32 bits/pixel - stbi__get32le(s); // discard sizeof - stbi__get32le(s); // discard hres - stbi__get32le(s); // discard vres - stbi__get32le(s); // discard colorsused - stbi__get32le(s); // discard max important - if (hsz == 40 || hsz == 56) { - if (hsz == 56) { - stbi__get32le(s); - stbi__get32le(s); - stbi__get32le(s); - stbi__get32le(s); - } - if (info->bpp == 16 || info->bpp == 32) { - if (compress == 0) { - stbi__bmp_set_mask_defaults(info, compress); - } else if (compress == 3) { - info->mr = stbi__get32le(s); - info->mg = stbi__get32le(s); - info->mb = stbi__get32le(s); - info->extra_read += 12; - // not documented, but generated by photoshop and handled by mspaint - if (info->mr == info->mg && info->mg == info->mb) { - // ?!?!? - return stbi__errpuc("bad BMP", "bad BMP"); - } - } else - return stbi__errpuc("bad BMP", "bad BMP"); - } - } else { - // V4/V5 header - int i; - if (hsz != 108 && hsz != 124) - return stbi__errpuc("bad BMP", "bad BMP"); - info->mr = stbi__get32le(s); - info->mg = stbi__get32le(s); - info->mb = stbi__get32le(s); - info->ma = stbi__get32le(s); - if (compress != 3) // override mr/mg/mb unless in BI_BITFIELDS mode, as per docs - stbi__bmp_set_mask_defaults(info, compress); - stbi__get32le(s); // discard color space - for (i=0; i < 12; ++i) - stbi__get32le(s); // discard color space parameters - if (hsz == 124) { - stbi__get32le(s); // discard rendering intent - stbi__get32le(s); // discard offset of profile data - stbi__get32le(s); // discard size of profile data - stbi__get32le(s); // discard reserved - } - } - } - return (void *) 1; -} - - -static void *stbi__bmp_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) -{ - stbi_uc *out; - unsigned int mr=0,mg=0,mb=0,ma=0, all_a; - stbi_uc pal[256][4]; - int psize=0,i,j,width; - int flip_vertically, pad, target; - stbi__bmp_data info; - STBI_NOTUSED(ri); - - info.all_a = 255; - if (stbi__bmp_parse_header(s, &info) == NULL) - return NULL; // error code already set - - flip_vertically = ((int) s->img_y) > 0; - s->img_y = abs((int) s->img_y); - - if (s->img_y > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); - if (s->img_x > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); - - mr = info.mr; - mg = info.mg; - mb = info.mb; - ma = info.ma; - all_a = info.all_a; - - if (info.hsz == 12) { - if (info.bpp < 24) - psize = (info.offset - info.extra_read - 24) / 3; - } else { - if (info.bpp < 16) - psize = (info.offset - info.extra_read - info.hsz) >> 2; - } - if (psize == 0) { - // accept some number of extra bytes after the header, but if the offset points either to before - // the header ends or implies a large amount of extra data, reject the file as malformed - int bytes_read_so_far = s->callback_already_read + (int)(s->img_buffer - s->img_buffer_original); - int header_limit = 1024; // max we actually read is below 256 bytes currently. - int extra_data_limit = 256*4; // what ordinarily goes here is a palette; 256 entries*4 bytes is its max size. - if (bytes_read_so_far <= 0 || bytes_read_so_far > header_limit) { - return stbi__errpuc("bad header", "Corrupt BMP"); - } - // we established that bytes_read_so_far is positive and sensible. - // the first half of this test rejects offsets that are either too small positives, or - // negative, and guarantees that info.offset >= bytes_read_so_far > 0. this in turn - // ensures the number computed in the second half of the test can't overflow. - if (info.offset < bytes_read_so_far || info.offset - bytes_read_so_far > extra_data_limit) { - return stbi__errpuc("bad offset", "Corrupt BMP"); - } else { - stbi__skip(s, info.offset - bytes_read_so_far); - } - } - - if (info.bpp == 24 && ma == 0xff000000) - s->img_n = 3; - else - s->img_n = ma ? 4 : 3; - if (req_comp && req_comp >= 3) // we can directly decode 3 or 4 - target = req_comp; - else - target = s->img_n; // if they want monochrome, we'll post-convert - - // sanity-check size - if (!stbi__mad3sizes_valid(target, s->img_x, s->img_y, 0)) - return stbi__errpuc("too large", "Corrupt BMP"); - - out = (stbi_uc *) stbi__malloc_mad3(target, s->img_x, s->img_y, 0); - if (!out) return stbi__errpuc("outofmem", "Out of memory"); - if (info.bpp < 16) { - int z=0; - if (psize == 0 || psize > 256) { STBI_FREE(out); return stbi__errpuc("invalid", "Corrupt BMP"); } - for (i=0; i < psize; ++i) { - pal[i][2] = stbi__get8(s); - pal[i][1] = stbi__get8(s); - pal[i][0] = stbi__get8(s); - if (info.hsz != 12) stbi__get8(s); - pal[i][3] = 255; - } - stbi__skip(s, info.offset - info.extra_read - info.hsz - psize * (info.hsz == 12 ? 3 : 4)); - if (info.bpp == 1) width = (s->img_x + 7) >> 3; - else if (info.bpp == 4) width = (s->img_x + 1) >> 1; - else if (info.bpp == 8) width = s->img_x; - else { STBI_FREE(out); return stbi__errpuc("bad bpp", "Corrupt BMP"); } - pad = (-width)&3; - if (info.bpp == 1) { - for (j=0; j < (int) s->img_y; ++j) { - int bit_offset = 7, v = stbi__get8(s); - for (i=0; i < (int) s->img_x; ++i) { - int color = (v>>bit_offset)&0x1; - out[z++] = pal[color][0]; - out[z++] = pal[color][1]; - out[z++] = pal[color][2]; - if (target == 4) out[z++] = 255; - if (i+1 == (int) s->img_x) break; - if((--bit_offset) < 0) { - bit_offset = 7; - v = stbi__get8(s); - } - } - stbi__skip(s, pad); - } - } else { - for (j=0; j < (int) s->img_y; ++j) { - for (i=0; i < (int) s->img_x; i += 2) { - int v=stbi__get8(s),v2=0; - if (info.bpp == 4) { - v2 = v & 15; - v >>= 4; - } - out[z++] = pal[v][0]; - out[z++] = pal[v][1]; - out[z++] = pal[v][2]; - if (target == 4) out[z++] = 255; - if (i+1 == (int) s->img_x) break; - v = (info.bpp == 8) ? stbi__get8(s) : v2; - out[z++] = pal[v][0]; - out[z++] = pal[v][1]; - out[z++] = pal[v][2]; - if (target == 4) out[z++] = 255; - } - stbi__skip(s, pad); - } - } - } else { - int rshift=0,gshift=0,bshift=0,ashift=0,rcount=0,gcount=0,bcount=0,acount=0; - int z = 0; - int easy=0; - stbi__skip(s, info.offset - info.extra_read - info.hsz); - if (info.bpp == 24) width = 3 * s->img_x; - else if (info.bpp == 16) width = 2*s->img_x; - else /* bpp = 32 and pad = 0 */ width=0; - pad = (-width) & 3; - if (info.bpp == 24) { - easy = 1; - } else if (info.bpp == 32) { - if (mb == 0xff && mg == 0xff00 && mr == 0x00ff0000 && ma == 0xff000000) - easy = 2; - } - if (!easy) { - if (!mr || !mg || !mb) { STBI_FREE(out); return stbi__errpuc("bad masks", "Corrupt BMP"); } - // right shift amt to put high bit in position #7 - rshift = stbi__high_bit(mr)-7; rcount = stbi__bitcount(mr); - gshift = stbi__high_bit(mg)-7; gcount = stbi__bitcount(mg); - bshift = stbi__high_bit(mb)-7; bcount = stbi__bitcount(mb); - ashift = stbi__high_bit(ma)-7; acount = stbi__bitcount(ma); - if (rcount > 8 || gcount > 8 || bcount > 8 || acount > 8) { STBI_FREE(out); return stbi__errpuc("bad masks", "Corrupt BMP"); } - } - for (j=0; j < (int) s->img_y; ++j) { - if (easy) { - for (i=0; i < (int) s->img_x; ++i) { - unsigned char a; - out[z+2] = stbi__get8(s); - out[z+1] = stbi__get8(s); - out[z+0] = stbi__get8(s); - z += 3; - a = (easy == 2 ? stbi__get8(s) : 255); - all_a |= a; - if (target == 4) out[z++] = a; - } - } else { - int bpp = info.bpp; - for (i=0; i < (int) s->img_x; ++i) { - stbi__uint32 v = (bpp == 16 ? (stbi__uint32) stbi__get16le(s) : stbi__get32le(s)); - unsigned int a; - out[z++] = STBI__BYTECAST(stbi__shiftsigned(v & mr, rshift, rcount)); - out[z++] = STBI__BYTECAST(stbi__shiftsigned(v & mg, gshift, gcount)); - out[z++] = STBI__BYTECAST(stbi__shiftsigned(v & mb, bshift, bcount)); - a = (ma ? stbi__shiftsigned(v & ma, ashift, acount) : 255); - all_a |= a; - if (target == 4) out[z++] = STBI__BYTECAST(a); - } - } - stbi__skip(s, pad); - } - } - - // if alpha channel is all 0s, replace with all 255s - if (target == 4 && all_a == 0) - for (i=4*s->img_x*s->img_y-1; i >= 0; i -= 4) - out[i] = 255; - - if (flip_vertically) { - stbi_uc t; - for (j=0; j < (int) s->img_y>>1; ++j) { - stbi_uc *p1 = out + j *s->img_x*target; - stbi_uc *p2 = out + (s->img_y-1-j)*s->img_x*target; - for (i=0; i < (int) s->img_x*target; ++i) { - t = p1[i]; p1[i] = p2[i]; p2[i] = t; - } - } - } - - if (req_comp && req_comp != target) { - out = stbi__convert_format(out, target, req_comp, s->img_x, s->img_y); - if (out == NULL) return out; // stbi__convert_format frees input on failure - } - - *x = s->img_x; - *y = s->img_y; - if (comp) *comp = s->img_n; - return out; -} -#endif - -// Targa Truevision - TGA -// by Jonathan Dummer -#ifndef STBI_NO_TGA -// returns STBI_rgb or whatever, 0 on error -static int stbi__tga_get_comp(int bits_per_pixel, int is_grey, int* is_rgb16) -{ - // only RGB or RGBA (incl. 16bit) or grey allowed - if (is_rgb16) *is_rgb16 = 0; - switch(bits_per_pixel) { - case 8: return STBI_grey; - case 16: if(is_grey) return STBI_grey_alpha; - // fallthrough - case 15: if(is_rgb16) *is_rgb16 = 1; - return STBI_rgb; - case 24: // fallthrough - case 32: return bits_per_pixel/8; - default: return 0; - } -} - -static int stbi__tga_info(stbi__context *s, int *x, int *y, int *comp) -{ - int tga_w, tga_h, tga_comp, tga_image_type, tga_bits_per_pixel, tga_colormap_bpp; - int sz, tga_colormap_type; - stbi__get8(s); // discard Offset - tga_colormap_type = stbi__get8(s); // colormap type - if( tga_colormap_type > 1 ) { - stbi__rewind(s); - return 0; // only RGB or indexed allowed - } - tga_image_type = stbi__get8(s); // image type - if ( tga_colormap_type == 1 ) { // colormapped (paletted) image - if (tga_image_type != 1 && tga_image_type != 9) { - stbi__rewind(s); - return 0; - } - stbi__skip(s,4); // skip index of first colormap entry and number of entries - sz = stbi__get8(s); // check bits per palette color entry - if ( (sz != 8) && (sz != 15) && (sz != 16) && (sz != 24) && (sz != 32) ) { - stbi__rewind(s); - return 0; - } - stbi__skip(s,4); // skip image x and y origin - tga_colormap_bpp = sz; - } else { // "normal" image w/o colormap - only RGB or grey allowed, +/- RLE - if ( (tga_image_type != 2) && (tga_image_type != 3) && (tga_image_type != 10) && (tga_image_type != 11) ) { - stbi__rewind(s); - return 0; // only RGB or grey allowed, +/- RLE - } - stbi__skip(s,9); // skip colormap specification and image x/y origin - tga_colormap_bpp = 0; - } - tga_w = stbi__get16le(s); - if( tga_w < 1 ) { - stbi__rewind(s); - return 0; // test width - } - tga_h = stbi__get16le(s); - if( tga_h < 1 ) { - stbi__rewind(s); - return 0; // test height - } - tga_bits_per_pixel = stbi__get8(s); // bits per pixel - stbi__get8(s); // ignore alpha bits - if (tga_colormap_bpp != 0) { - if((tga_bits_per_pixel != 8) && (tga_bits_per_pixel != 16)) { - // when using a colormap, tga_bits_per_pixel is the size of the indexes - // I don't think anything but 8 or 16bit indexes makes sense - stbi__rewind(s); - return 0; - } - tga_comp = stbi__tga_get_comp(tga_colormap_bpp, 0, NULL); - } else { - tga_comp = stbi__tga_get_comp(tga_bits_per_pixel, (tga_image_type == 3) || (tga_image_type == 11), NULL); - } - if(!tga_comp) { - stbi__rewind(s); - return 0; - } - if (x) *x = tga_w; - if (y) *y = tga_h; - if (comp) *comp = tga_comp; - return 1; // seems to have passed everything -} - -static int stbi__tga_test(stbi__context *s) -{ - int res = 0; - int sz, tga_color_type; - stbi__get8(s); // discard Offset - tga_color_type = stbi__get8(s); // color type - if ( tga_color_type > 1 ) goto errorEnd; // only RGB or indexed allowed - sz = stbi__get8(s); // image type - if ( tga_color_type == 1 ) { // colormapped (paletted) image - if (sz != 1 && sz != 9) goto errorEnd; // colortype 1 demands image type 1 or 9 - stbi__skip(s,4); // skip index of first colormap entry and number of entries - sz = stbi__get8(s); // check bits per palette color entry - if ( (sz != 8) && (sz != 15) && (sz != 16) && (sz != 24) && (sz != 32) ) goto errorEnd; - stbi__skip(s,4); // skip image x and y origin - } else { // "normal" image w/o colormap - if ( (sz != 2) && (sz != 3) && (sz != 10) && (sz != 11) ) goto errorEnd; // only RGB or grey allowed, +/- RLE - stbi__skip(s,9); // skip colormap specification and image x/y origin - } - if ( stbi__get16le(s) < 1 ) goto errorEnd; // test width - if ( stbi__get16le(s) < 1 ) goto errorEnd; // test height - sz = stbi__get8(s); // bits per pixel - if ( (tga_color_type == 1) && (sz != 8) && (sz != 16) ) goto errorEnd; // for colormapped images, bpp is size of an index - if ( (sz != 8) && (sz != 15) && (sz != 16) && (sz != 24) && (sz != 32) ) goto errorEnd; - - res = 1; // if we got this far, everything's good and we can return 1 instead of 0 - -errorEnd: - stbi__rewind(s); - return res; -} - -// read 16bit value and convert to 24bit RGB -static void stbi__tga_read_rgb16(stbi__context *s, stbi_uc* out) -{ - stbi__uint16 px = (stbi__uint16)stbi__get16le(s); - stbi__uint16 fiveBitMask = 31; - // we have 3 channels with 5bits each - int r = (px >> 10) & fiveBitMask; - int g = (px >> 5) & fiveBitMask; - int b = px & fiveBitMask; - // Note that this saves the data in RGB(A) order, so it doesn't need to be swapped later - out[0] = (stbi_uc)((r * 255)/31); - out[1] = (stbi_uc)((g * 255)/31); - out[2] = (stbi_uc)((b * 255)/31); - - // some people claim that the most significant bit might be used for alpha - // (possibly if an alpha-bit is set in the "image descriptor byte") - // but that only made 16bit test images completely translucent.. - // so let's treat all 15 and 16bit TGAs as RGB with no alpha. -} - -static void *stbi__tga_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) -{ - // read in the TGA header stuff - int tga_offset = stbi__get8(s); - int tga_indexed = stbi__get8(s); - int tga_image_type = stbi__get8(s); - int tga_is_RLE = 0; - int tga_palette_start = stbi__get16le(s); - int tga_palette_len = stbi__get16le(s); - int tga_palette_bits = stbi__get8(s); - int tga_x_origin = stbi__get16le(s); - int tga_y_origin = stbi__get16le(s); - int tga_width = stbi__get16le(s); - int tga_height = stbi__get16le(s); - int tga_bits_per_pixel = stbi__get8(s); - int tga_comp, tga_rgb16=0; - int tga_inverted = stbi__get8(s); - // int tga_alpha_bits = tga_inverted & 15; // the 4 lowest bits - unused (useless?) - // image data - unsigned char *tga_data; - unsigned char *tga_palette = NULL; - int i, j; - unsigned char raw_data[4] = {0}; - int RLE_count = 0; - int RLE_repeating = 0; - int read_next_pixel = 1; - STBI_NOTUSED(ri); - STBI_NOTUSED(tga_x_origin); // @TODO - STBI_NOTUSED(tga_y_origin); // @TODO - - if (tga_height > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); - if (tga_width > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); - - // do a tiny bit of precessing - if ( tga_image_type >= 8 ) - { - tga_image_type -= 8; - tga_is_RLE = 1; - } - tga_inverted = 1 - ((tga_inverted >> 5) & 1); - - // If I'm paletted, then I'll use the number of bits from the palette - if ( tga_indexed ) tga_comp = stbi__tga_get_comp(tga_palette_bits, 0, &tga_rgb16); - else tga_comp = stbi__tga_get_comp(tga_bits_per_pixel, (tga_image_type == 3), &tga_rgb16); - - if(!tga_comp) // shouldn't really happen, stbi__tga_test() should have ensured basic consistency - return stbi__errpuc("bad format", "Can't find out TGA pixelformat"); - - // tga info - *x = tga_width; - *y = tga_height; - if (comp) *comp = tga_comp; - - if (!stbi__mad3sizes_valid(tga_width, tga_height, tga_comp, 0)) - return stbi__errpuc("too large", "Corrupt TGA"); - - tga_data = (unsigned char*)stbi__malloc_mad3(tga_width, tga_height, tga_comp, 0); - if (!tga_data) return stbi__errpuc("outofmem", "Out of memory"); - - // skip to the data's starting position (offset usually = 0) - stbi__skip(s, tga_offset ); - - if ( !tga_indexed && !tga_is_RLE && !tga_rgb16 ) { - for (i=0; i < tga_height; ++i) { - int row = tga_inverted ? tga_height -i - 1 : i; - stbi_uc *tga_row = tga_data + row*tga_width*tga_comp; - stbi__getn(s, tga_row, tga_width * tga_comp); - } - } else { - // do I need to load a palette? - if ( tga_indexed) - { - if (tga_palette_len == 0) { /* you have to have at least one entry! */ - STBI_FREE(tga_data); - return stbi__errpuc("bad palette", "Corrupt TGA"); - } - - // any data to skip? (offset usually = 0) - stbi__skip(s, tga_palette_start ); - // load the palette - tga_palette = (unsigned char*)stbi__malloc_mad2(tga_palette_len, tga_comp, 0); - if (!tga_palette) { - STBI_FREE(tga_data); - return stbi__errpuc("outofmem", "Out of memory"); - } - if (tga_rgb16) { - stbi_uc *pal_entry = tga_palette; - STBI_ASSERT(tga_comp == STBI_rgb); - for (i=0; i < tga_palette_len; ++i) { - stbi__tga_read_rgb16(s, pal_entry); - pal_entry += tga_comp; - } - } else if (!stbi__getn(s, tga_palette, tga_palette_len * tga_comp)) { - STBI_FREE(tga_data); - STBI_FREE(tga_palette); - return stbi__errpuc("bad palette", "Corrupt TGA"); - } - } - // load the data - for (i=0; i < tga_width * tga_height; ++i) - { - // if I'm in RLE mode, do I need to get a RLE stbi__pngchunk? - if ( tga_is_RLE ) - { - if ( RLE_count == 0 ) - { - // yep, get the next byte as a RLE command - int RLE_cmd = stbi__get8(s); - RLE_count = 1 + (RLE_cmd & 127); - RLE_repeating = RLE_cmd >> 7; - read_next_pixel = 1; - } else if ( !RLE_repeating ) - { - read_next_pixel = 1; - } - } else - { - read_next_pixel = 1; - } - // OK, if I need to read a pixel, do it now - if ( read_next_pixel ) - { - // load however much data we did have - if ( tga_indexed ) - { - // read in index, then perform the lookup - int pal_idx = (tga_bits_per_pixel == 8) ? stbi__get8(s) : stbi__get16le(s); - if ( pal_idx >= tga_palette_len ) { - // invalid index - pal_idx = 0; - } - pal_idx *= tga_comp; - for (j = 0; j < tga_comp; ++j) { - raw_data[j] = tga_palette[pal_idx+j]; - } - } else if(tga_rgb16) { - STBI_ASSERT(tga_comp == STBI_rgb); - stbi__tga_read_rgb16(s, raw_data); - } else { - // read in the data raw - for (j = 0; j < tga_comp; ++j) { - raw_data[j] = stbi__get8(s); - } - } - // clear the reading flag for the next pixel - read_next_pixel = 0; - } // end of reading a pixel - - // copy data - for (j = 0; j < tga_comp; ++j) - tga_data[i*tga_comp+j] = raw_data[j]; - - // in case we're in RLE mode, keep counting down - --RLE_count; - } - // do I need to invert the image? - if ( tga_inverted ) - { - for (j = 0; j*2 < tga_height; ++j) - { - int index1 = j * tga_width * tga_comp; - int index2 = (tga_height - 1 - j) * tga_width * tga_comp; - for (i = tga_width * tga_comp; i > 0; --i) - { - unsigned char temp = tga_data[index1]; - tga_data[index1] = tga_data[index2]; - tga_data[index2] = temp; - ++index1; - ++index2; - } - } - } - // clear my palette, if I had one - if ( tga_palette != NULL ) - { - STBI_FREE( tga_palette ); - } - } - - // swap RGB - if the source data was RGB16, it already is in the right order - if (tga_comp >= 3 && !tga_rgb16) - { - unsigned char* tga_pixel = tga_data; - for (i=0; i < tga_width * tga_height; ++i) - { - unsigned char temp = tga_pixel[0]; - tga_pixel[0] = tga_pixel[2]; - tga_pixel[2] = temp; - tga_pixel += tga_comp; - } - } - - // convert to target component count - if (req_comp && req_comp != tga_comp) - tga_data = stbi__convert_format(tga_data, tga_comp, req_comp, tga_width, tga_height); - - // the things I do to get rid of an error message, and yet keep - // Microsoft's C compilers happy... [8^( - tga_palette_start = tga_palette_len = tga_palette_bits = - tga_x_origin = tga_y_origin = 0; - STBI_NOTUSED(tga_palette_start); - // OK, done - return tga_data; -} -#endif - -// ************************************************************************************************* -// Photoshop PSD loader -- PD by Thatcher Ulrich, integration by Nicolas Schulz, tweaked by STB - -#ifndef STBI_NO_PSD -static int stbi__psd_test(stbi__context *s) -{ - int r = (stbi__get32be(s) == 0x38425053); - stbi__rewind(s); - return r; -} - -static int stbi__psd_decode_rle(stbi__context *s, stbi_uc *p, int pixelCount) -{ - int count, nleft, len; - - count = 0; - while ((nleft = pixelCount - count) > 0) { - len = stbi__get8(s); - if (len == 128) { - // No-op. - } else if (len < 128) { - // Copy next len+1 bytes literally. - len++; - if (len > nleft) return 0; // corrupt data - count += len; - while (len) { - *p = stbi__get8(s); - p += 4; - len--; - } - } else if (len > 128) { - stbi_uc val; - // Next -len+1 bytes in the dest are replicated from next source byte. - // (Interpret len as a negative 8-bit int.) - len = 257 - len; - if (len > nleft) return 0; // corrupt data - val = stbi__get8(s); - count += len; - while (len) { - *p = val; - p += 4; - len--; - } - } - } - - return 1; -} - -static void *stbi__psd_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri, int bpc) -{ - int pixelCount; - int channelCount, compression; - int channel, i; - int bitdepth; - int w,h; - stbi_uc *out; - STBI_NOTUSED(ri); - - // Check identifier - if (stbi__get32be(s) != 0x38425053) // "8BPS" - return stbi__errpuc("not PSD", "Corrupt PSD image"); - - // Check file type version. - if (stbi__get16be(s) != 1) - return stbi__errpuc("wrong version", "Unsupported version of PSD image"); - - // Skip 6 reserved bytes. - stbi__skip(s, 6 ); - - // Read the number of channels (R, G, B, A, etc). - channelCount = stbi__get16be(s); - if (channelCount < 0 || channelCount > 16) - return stbi__errpuc("wrong channel count", "Unsupported number of channels in PSD image"); - - // Read the rows and columns of the image. - h = stbi__get32be(s); - w = stbi__get32be(s); - - if (h > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); - if (w > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); - - // Make sure the depth is 8 bits. - bitdepth = stbi__get16be(s); - if (bitdepth != 8 && bitdepth != 16) - return stbi__errpuc("unsupported bit depth", "PSD bit depth is not 8 or 16 bit"); - - // Make sure the color mode is RGB. - // Valid options are: - // 0: Bitmap - // 1: Grayscale - // 2: Indexed color - // 3: RGB color - // 4: CMYK color - // 7: Multichannel - // 8: Duotone - // 9: Lab color - if (stbi__get16be(s) != 3) - return stbi__errpuc("wrong color format", "PSD is not in RGB color format"); - - // Skip the Mode Data. (It's the palette for indexed color; other info for other modes.) - stbi__skip(s,stbi__get32be(s) ); - - // Skip the image resources. (resolution, pen tool paths, etc) - stbi__skip(s, stbi__get32be(s) ); - - // Skip the reserved data. - stbi__skip(s, stbi__get32be(s) ); - - // Find out if the data is compressed. - // Known values: - // 0: no compression - // 1: RLE compressed - compression = stbi__get16be(s); - if (compression > 1) - return stbi__errpuc("bad compression", "PSD has an unknown compression format"); - - // Check size - if (!stbi__mad3sizes_valid(4, w, h, 0)) - return stbi__errpuc("too large", "Corrupt PSD"); - - // Create the destination image. - - if (!compression && bitdepth == 16 && bpc == 16) { - out = (stbi_uc *) stbi__malloc_mad3(8, w, h, 0); - ri->bits_per_channel = 16; - } else - out = (stbi_uc *) stbi__malloc(4 * w*h); - - if (!out) return stbi__errpuc("outofmem", "Out of memory"); - pixelCount = w*h; - - // Initialize the data to zero. - //memset( out, 0, pixelCount * 4 ); - - // Finally, the image data. - if (compression) { - // RLE as used by .PSD and .TIFF - // Loop until you get the number of unpacked bytes you are expecting: - // Read the next source byte into n. - // If n is between 0 and 127 inclusive, copy the next n+1 bytes literally. - // Else if n is between -127 and -1 inclusive, copy the next byte -n+1 times. - // Else if n is 128, noop. - // Endloop - - // The RLE-compressed data is preceded by a 2-byte data count for each row in the data, - // which we're going to just skip. - stbi__skip(s, h * channelCount * 2 ); - - // Read the RLE data by channel. - for (channel = 0; channel < 4; channel++) { - stbi_uc *p; - - p = out+channel; - if (channel >= channelCount) { - // Fill this channel with default data. - for (i = 0; i < pixelCount; i++, p += 4) - *p = (channel == 3 ? 255 : 0); - } else { - // Read the RLE data. - if (!stbi__psd_decode_rle(s, p, pixelCount)) { - STBI_FREE(out); - return stbi__errpuc("corrupt", "bad RLE data"); - } - } - } - - } else { - // We're at the raw image data. It's each channel in order (Red, Green, Blue, Alpha, ...) - // where each channel consists of an 8-bit (or 16-bit) value for each pixel in the image. - - // Read the data by channel. - for (channel = 0; channel < 4; channel++) { - if (channel >= channelCount) { - // Fill this channel with default data. - if (bitdepth == 16 && bpc == 16) { - stbi__uint16 *q = ((stbi__uint16 *) out) + channel; - stbi__uint16 val = channel == 3 ? 65535 : 0; - for (i = 0; i < pixelCount; i++, q += 4) - *q = val; - } else { - stbi_uc *p = out+channel; - stbi_uc val = channel == 3 ? 255 : 0; - for (i = 0; i < pixelCount; i++, p += 4) - *p = val; - } - } else { - if (ri->bits_per_channel == 16) { // output bpc - stbi__uint16 *q = ((stbi__uint16 *) out) + channel; - for (i = 0; i < pixelCount; i++, q += 4) - *q = (stbi__uint16) stbi__get16be(s); - } else { - stbi_uc *p = out+channel; - if (bitdepth == 16) { // input bpc - for (i = 0; i < pixelCount; i++, p += 4) - *p = (stbi_uc) (stbi__get16be(s) >> 8); - } else { - for (i = 0; i < pixelCount; i++, p += 4) - *p = stbi__get8(s); - } - } - } - } - } - - // remove weird white matte from PSD - if (channelCount >= 4) { - if (ri->bits_per_channel == 16) { - for (i=0; i < w*h; ++i) { - stbi__uint16 *pixel = (stbi__uint16 *) out + 4*i; - if (pixel[3] != 0 && pixel[3] != 65535) { - float a = pixel[3] / 65535.0f; - float ra = 1.0f / a; - float inv_a = 65535.0f * (1 - ra); - pixel[0] = (stbi__uint16) (pixel[0]*ra + inv_a); - pixel[1] = (stbi__uint16) (pixel[1]*ra + inv_a); - pixel[2] = (stbi__uint16) (pixel[2]*ra + inv_a); - } - } - } else { - for (i=0; i < w*h; ++i) { - unsigned char *pixel = out + 4*i; - if (pixel[3] != 0 && pixel[3] != 255) { - float a = pixel[3] / 255.0f; - float ra = 1.0f / a; - float inv_a = 255.0f * (1 - ra); - pixel[0] = (unsigned char) (pixel[0]*ra + inv_a); - pixel[1] = (unsigned char) (pixel[1]*ra + inv_a); - pixel[2] = (unsigned char) (pixel[2]*ra + inv_a); - } - } - } - } - - // convert to desired output format - if (req_comp && req_comp != 4) { - if (ri->bits_per_channel == 16) - out = (stbi_uc *) stbi__convert_format16((stbi__uint16 *) out, 4, req_comp, w, h); - else - out = stbi__convert_format(out, 4, req_comp, w, h); - if (out == NULL) return out; // stbi__convert_format frees input on failure - } - - if (comp) *comp = 4; - *y = h; - *x = w; - - return out; -} -#endif - -// ************************************************************************************************* -// Softimage PIC loader -// by Tom Seddon -// -// See http://softimage.wiki.softimage.com/index.php/INFO:_PIC_file_format -// See http://ozviz.wasp.uwa.edu.au/~pbourke/dataformats/softimagepic/ - -#ifndef STBI_NO_PIC -static int stbi__pic_is4(stbi__context *s,const char *str) -{ - int i; - for (i=0; i<4; ++i) - if (stbi__get8(s) != (stbi_uc)str[i]) - return 0; - - return 1; -} - -static int stbi__pic_test_core(stbi__context *s) -{ - int i; - - if (!stbi__pic_is4(s,"\x53\x80\xF6\x34")) - return 0; - - for(i=0;i<84;++i) - stbi__get8(s); - - if (!stbi__pic_is4(s,"PICT")) - return 0; - - return 1; -} - -typedef struct -{ - stbi_uc size,type,channel; -} stbi__pic_packet; - -static stbi_uc *stbi__readval(stbi__context *s, int channel, stbi_uc *dest) -{ - int mask=0x80, i; - - for (i=0; i<4; ++i, mask>>=1) { - if (channel & mask) { - if (stbi__at_eof(s)) return stbi__errpuc("bad file","PIC file too short"); - dest[i]=stbi__get8(s); - } - } - - return dest; -} - -static void stbi__copyval(int channel,stbi_uc *dest,const stbi_uc *src) -{ - int mask=0x80,i; - - for (i=0;i<4; ++i, mask>>=1) - if (channel&mask) - dest[i]=src[i]; -} - -static stbi_uc *stbi__pic_load_core(stbi__context *s,int width,int height,int *comp, stbi_uc *result) -{ - int act_comp=0,num_packets=0,y,chained; - stbi__pic_packet packets[10]; - - // this will (should...) cater for even some bizarre stuff like having data - // for the same channel in multiple packets. - do { - stbi__pic_packet *packet; - - if (num_packets==sizeof(packets)/sizeof(packets[0])) - return stbi__errpuc("bad format","too many packets"); - - packet = &packets[num_packets++]; - - chained = stbi__get8(s); - packet->size = stbi__get8(s); - packet->type = stbi__get8(s); - packet->channel = stbi__get8(s); - - act_comp |= packet->channel; - - if (stbi__at_eof(s)) return stbi__errpuc("bad file","file too short (reading packets)"); - if (packet->size != 8) return stbi__errpuc("bad format","packet isn't 8bpp"); - } while (chained); - - *comp = (act_comp & 0x10 ? 4 : 3); // has alpha channel? - - for(y=0; ytype) { - default: - return stbi__errpuc("bad format","packet has bad compression type"); - - case 0: {//uncompressed - int x; - - for(x=0;xchannel,dest)) - return 0; - break; - } - - case 1://Pure RLE - { - int left=width, i; - - while (left>0) { - stbi_uc count,value[4]; - - count=stbi__get8(s); - if (stbi__at_eof(s)) return stbi__errpuc("bad file","file too short (pure read count)"); - - if (count > left) - count = (stbi_uc) left; - - if (!stbi__readval(s,packet->channel,value)) return 0; - - for(i=0; ichannel,dest,value); - left -= count; - } - } - break; - - case 2: {//Mixed RLE - int left=width; - while (left>0) { - int count = stbi__get8(s), i; - if (stbi__at_eof(s)) return stbi__errpuc("bad file","file too short (mixed read count)"); - - if (count >= 128) { // Repeated - stbi_uc value[4]; - - if (count==128) - count = stbi__get16be(s); - else - count -= 127; - if (count > left) - return stbi__errpuc("bad file","scanline overrun"); - - if (!stbi__readval(s,packet->channel,value)) - return 0; - - for(i=0;ichannel,dest,value); - } else { // Raw - ++count; - if (count>left) return stbi__errpuc("bad file","scanline overrun"); - - for(i=0;ichannel,dest)) - return 0; - } - left-=count; - } - break; - } - } - } - } - - return result; -} - -static void *stbi__pic_load(stbi__context *s,int *px,int *py,int *comp,int req_comp, stbi__result_info *ri) -{ - stbi_uc *result; - int i, x,y, internal_comp; - STBI_NOTUSED(ri); - - if (!comp) comp = &internal_comp; - - for (i=0; i<92; ++i) - stbi__get8(s); - - x = stbi__get16be(s); - y = stbi__get16be(s); - - if (y > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); - if (x > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); - - if (stbi__at_eof(s)) return stbi__errpuc("bad file","file too short (pic header)"); - if (!stbi__mad3sizes_valid(x, y, 4, 0)) return stbi__errpuc("too large", "PIC image too large to decode"); - - stbi__get32be(s); //skip `ratio' - stbi__get16be(s); //skip `fields' - stbi__get16be(s); //skip `pad' - - // intermediate buffer is RGBA - result = (stbi_uc *) stbi__malloc_mad3(x, y, 4, 0); - if (!result) return stbi__errpuc("outofmem", "Out of memory"); - memset(result, 0xff, x*y*4); - - if (!stbi__pic_load_core(s,x,y,comp, result)) { - STBI_FREE(result); - result=0; - } - *px = x; - *py = y; - if (req_comp == 0) req_comp = *comp; - result=stbi__convert_format(result,4,req_comp,x,y); - - return result; -} - -static int stbi__pic_test(stbi__context *s) -{ - int r = stbi__pic_test_core(s); - stbi__rewind(s); - return r; -} -#endif - -// ************************************************************************************************* -// GIF loader -- public domain by Jean-Marc Lienher -- simplified/shrunk by stb - -#ifndef STBI_NO_GIF -typedef struct -{ - stbi__int16 prefix; - stbi_uc first; - stbi_uc suffix; -} stbi__gif_lzw; - -typedef struct -{ - int w,h; - stbi_uc *out; // output buffer (always 4 components) - stbi_uc *background; // The current "background" as far as a gif is concerned - stbi_uc *history; - int flags, bgindex, ratio, transparent, eflags; - stbi_uc pal[256][4]; - stbi_uc lpal[256][4]; - stbi__gif_lzw codes[8192]; - stbi_uc *color_table; - int parse, step; - int lflags; - int start_x, start_y; - int max_x, max_y; - int cur_x, cur_y; - int line_size; - int delay; -} stbi__gif; - -static int stbi__gif_test_raw(stbi__context *s) -{ - int sz; - if (stbi__get8(s) != 'G' || stbi__get8(s) != 'I' || stbi__get8(s) != 'F' || stbi__get8(s) != '8') return 0; - sz = stbi__get8(s); - if (sz != '9' && sz != '7') return 0; - if (stbi__get8(s) != 'a') return 0; - return 1; -} - -static int stbi__gif_test(stbi__context *s) -{ - int r = stbi__gif_test_raw(s); - stbi__rewind(s); - return r; -} - -static void stbi__gif_parse_colortable(stbi__context *s, stbi_uc pal[256][4], int num_entries, int transp) -{ - int i; - for (i=0; i < num_entries; ++i) { - pal[i][2] = stbi__get8(s); - pal[i][1] = stbi__get8(s); - pal[i][0] = stbi__get8(s); - pal[i][3] = transp == i ? 0 : 255; - } -} - -static int stbi__gif_header(stbi__context *s, stbi__gif *g, int *comp, int is_info) -{ - stbi_uc version; - if (stbi__get8(s) != 'G' || stbi__get8(s) != 'I' || stbi__get8(s) != 'F' || stbi__get8(s) != '8') - return stbi__err("not GIF", "Corrupt GIF"); - - version = stbi__get8(s); - if (version != '7' && version != '9') return stbi__err("not GIF", "Corrupt GIF"); - if (stbi__get8(s) != 'a') return stbi__err("not GIF", "Corrupt GIF"); - - stbi__g_failure_reason = ""; - g->w = stbi__get16le(s); - g->h = stbi__get16le(s); - g->flags = stbi__get8(s); - g->bgindex = stbi__get8(s); - g->ratio = stbi__get8(s); - g->transparent = -1; - - if (g->w > STBI_MAX_DIMENSIONS) return stbi__err("too large","Very large image (corrupt?)"); - if (g->h > STBI_MAX_DIMENSIONS) return stbi__err("too large","Very large image (corrupt?)"); - - if (comp != 0) *comp = 4; // can't actually tell whether it's 3 or 4 until we parse the comments - - if (is_info) return 1; - - if (g->flags & 0x80) - stbi__gif_parse_colortable(s,g->pal, 2 << (g->flags & 7), -1); - - return 1; -} - -static int stbi__gif_info_raw(stbi__context *s, int *x, int *y, int *comp) -{ - stbi__gif* g = (stbi__gif*) stbi__malloc(sizeof(stbi__gif)); - if (!g) return stbi__err("outofmem", "Out of memory"); - if (!stbi__gif_header(s, g, comp, 1)) { - STBI_FREE(g); - stbi__rewind( s ); - return 0; - } - if (x) *x = g->w; - if (y) *y = g->h; - STBI_FREE(g); - return 1; -} - -static void stbi__out_gif_code(stbi__gif *g, stbi__uint16 code) -{ - stbi_uc *p, *c; - int idx; - - // recurse to decode the prefixes, since the linked-list is backwards, - // and working backwards through an interleaved image would be nasty - if (g->codes[code].prefix >= 0) - stbi__out_gif_code(g, g->codes[code].prefix); - - if (g->cur_y >= g->max_y) return; - - idx = g->cur_x + g->cur_y; - p = &g->out[idx]; - g->history[idx / 4] = 1; - - c = &g->color_table[g->codes[code].suffix * 4]; - if (c[3] > 128) { // don't render transparent pixels; - p[0] = c[2]; - p[1] = c[1]; - p[2] = c[0]; - p[3] = c[3]; - } - g->cur_x += 4; - - if (g->cur_x >= g->max_x) { - g->cur_x = g->start_x; - g->cur_y += g->step; - - while (g->cur_y >= g->max_y && g->parse > 0) { - g->step = (1 << g->parse) * g->line_size; - g->cur_y = g->start_y + (g->step >> 1); - --g->parse; - } - } -} - -static stbi_uc *stbi__process_gif_raster(stbi__context *s, stbi__gif *g) -{ - stbi_uc lzw_cs; - stbi__int32 len, init_code; - stbi__uint32 first; - stbi__int32 codesize, codemask, avail, oldcode, bits, valid_bits, clear; - stbi__gif_lzw *p; - - lzw_cs = stbi__get8(s); - if (lzw_cs > 12) return NULL; - clear = 1 << lzw_cs; - first = 1; - codesize = lzw_cs + 1; - codemask = (1 << codesize) - 1; - bits = 0; - valid_bits = 0; - for (init_code = 0; init_code < clear; init_code++) { - g->codes[init_code].prefix = -1; - g->codes[init_code].first = (stbi_uc) init_code; - g->codes[init_code].suffix = (stbi_uc) init_code; - } - - // support no starting clear code - avail = clear+2; - oldcode = -1; - - len = 0; - for(;;) { - if (valid_bits < codesize) { - if (len == 0) { - len = stbi__get8(s); // start new block - if (len == 0) - return g->out; - } - --len; - bits |= (stbi__int32) stbi__get8(s) << valid_bits; - valid_bits += 8; - } else { - stbi__int32 code = bits & codemask; - bits >>= codesize; - valid_bits -= codesize; - // @OPTIMIZE: is there some way we can accelerate the non-clear path? - if (code == clear) { // clear code - codesize = lzw_cs + 1; - codemask = (1 << codesize) - 1; - avail = clear + 2; - oldcode = -1; - first = 0; - } else if (code == clear + 1) { // end of stream code - stbi__skip(s, len); - while ((len = stbi__get8(s)) > 0) - stbi__skip(s,len); - return g->out; - } else if (code <= avail) { - if (first) { - return stbi__errpuc("no clear code", "Corrupt GIF"); - } - - if (oldcode >= 0) { - p = &g->codes[avail++]; - if (avail > 8192) { - return stbi__errpuc("too many codes", "Corrupt GIF"); - } - - p->prefix = (stbi__int16) oldcode; - p->first = g->codes[oldcode].first; - p->suffix = (code == avail) ? p->first : g->codes[code].first; - } else if (code == avail) - return stbi__errpuc("illegal code in raster", "Corrupt GIF"); - - stbi__out_gif_code(g, (stbi__uint16) code); - - if ((avail & codemask) == 0 && avail <= 0x0FFF) { - codesize++; - codemask = (1 << codesize) - 1; - } - - oldcode = code; - } else { - return stbi__errpuc("illegal code in raster", "Corrupt GIF"); - } - } - } -} - -// this function is designed to support animated gifs, although stb_image doesn't support it -// two back is the image from two frames ago, used for a very specific disposal format -static stbi_uc *stbi__gif_load_next(stbi__context *s, stbi__gif *g, int *comp, int req_comp, stbi_uc *two_back) -{ - int dispose; - int first_frame; - int pi; - int pcount; - STBI_NOTUSED(req_comp); - - // on first frame, any non-written pixels get the background colour (non-transparent) - first_frame = 0; - if (g->out == 0) { - if (!stbi__gif_header(s, g, comp,0)) return 0; // stbi__g_failure_reason set by stbi__gif_header - if (!stbi__mad3sizes_valid(4, g->w, g->h, 0)) - return stbi__errpuc("too large", "GIF image is too large"); - pcount = g->w * g->h; - g->out = (stbi_uc *) stbi__malloc(4 * pcount); - g->background = (stbi_uc *) stbi__malloc(4 * pcount); - g->history = (stbi_uc *) stbi__malloc(pcount); - if (!g->out || !g->background || !g->history) - return stbi__errpuc("outofmem", "Out of memory"); - - // image is treated as "transparent" at the start - ie, nothing overwrites the current background; - // background colour is only used for pixels that are not rendered first frame, after that "background" - // color refers to the color that was there the previous frame. - memset(g->out, 0x00, 4 * pcount); - memset(g->background, 0x00, 4 * pcount); // state of the background (starts transparent) - memset(g->history, 0x00, pcount); // pixels that were affected previous frame - first_frame = 1; - } else { - // second frame - how do we dispose of the previous one? - dispose = (g->eflags & 0x1C) >> 2; - pcount = g->w * g->h; - - if ((dispose == 3) && (two_back == 0)) { - dispose = 2; // if I don't have an image to revert back to, default to the old background - } - - if (dispose == 3) { // use previous graphic - for (pi = 0; pi < pcount; ++pi) { - if (g->history[pi]) { - memcpy( &g->out[pi * 4], &two_back[pi * 4], 4 ); - } - } - } else if (dispose == 2) { - // restore what was changed last frame to background before that frame; - for (pi = 0; pi < pcount; ++pi) { - if (g->history[pi]) { - memcpy( &g->out[pi * 4], &g->background[pi * 4], 4 ); - } - } - } else { - // This is a non-disposal case eithe way, so just - // leave the pixels as is, and they will become the new background - // 1: do not dispose - // 0: not specified. - } - - // background is what out is after the undoing of the previou frame; - memcpy( g->background, g->out, 4 * g->w * g->h ); - } - - // clear my history; - memset( g->history, 0x00, g->w * g->h ); // pixels that were affected previous frame - - for (;;) { - int tag = stbi__get8(s); - switch (tag) { - case 0x2C: /* Image Descriptor */ - { - stbi__int32 x, y, w, h; - stbi_uc *o; - - x = stbi__get16le(s); - y = stbi__get16le(s); - w = stbi__get16le(s); - h = stbi__get16le(s); - if (((x + w) > (g->w)) || ((y + h) > (g->h))) - return stbi__errpuc("bad Image Descriptor", "Corrupt GIF"); - - g->line_size = g->w * 4; - g->start_x = x * 4; - g->start_y = y * g->line_size; - g->max_x = g->start_x + w * 4; - g->max_y = g->start_y + h * g->line_size; - g->cur_x = g->start_x; - g->cur_y = g->start_y; - - // if the width of the specified rectangle is 0, that means - // we may not see *any* pixels or the image is malformed; - // to make sure this is caught, move the current y down to - // max_y (which is what out_gif_code checks). - if (w == 0) - g->cur_y = g->max_y; - - g->lflags = stbi__get8(s); - - if (g->lflags & 0x40) { - g->step = 8 * g->line_size; // first interlaced spacing - g->parse = 3; - } else { - g->step = g->line_size; - g->parse = 0; - } - - if (g->lflags & 0x80) { - stbi__gif_parse_colortable(s,g->lpal, 2 << (g->lflags & 7), g->eflags & 0x01 ? g->transparent : -1); - g->color_table = (stbi_uc *) g->lpal; - } else if (g->flags & 0x80) { - g->color_table = (stbi_uc *) g->pal; - } else - return stbi__errpuc("missing color table", "Corrupt GIF"); - - o = stbi__process_gif_raster(s, g); - if (!o) return NULL; - - // if this was the first frame, - pcount = g->w * g->h; - if (first_frame && (g->bgindex > 0)) { - // if first frame, any pixel not drawn to gets the background color - for (pi = 0; pi < pcount; ++pi) { - if (g->history[pi] == 0) { - g->pal[g->bgindex][3] = 255; // just in case it was made transparent, undo that; It will be reset next frame if need be; - memcpy( &g->out[pi * 4], &g->pal[g->bgindex], 4 ); - } - } - } - - return o; - } - - case 0x21: // Comment Extension. - { - int len; - int ext = stbi__get8(s); - if (ext == 0xF9) { // Graphic Control Extension. - len = stbi__get8(s); - if (len == 4) { - g->eflags = stbi__get8(s); - g->delay = 10 * stbi__get16le(s); // delay - 1/100th of a second, saving as 1/1000ths. - - // unset old transparent - if (g->transparent >= 0) { - g->pal[g->transparent][3] = 255; - } - if (g->eflags & 0x01) { - g->transparent = stbi__get8(s); - if (g->transparent >= 0) { - g->pal[g->transparent][3] = 0; - } - } else { - // don't need transparent - stbi__skip(s, 1); - g->transparent = -1; - } - } else { - stbi__skip(s, len); - break; - } - } - while ((len = stbi__get8(s)) != 0) { - stbi__skip(s, len); - } - break; - } - - case 0x3B: // gif stream termination code - return (stbi_uc *) s; // using '1' causes warning on some compilers - - default: - return stbi__errpuc("unknown code", "Corrupt GIF"); - } - } -} - -static void *stbi__load_gif_main_outofmem(stbi__gif *g, stbi_uc *out, int **delays) -{ - STBI_FREE(g->out); - STBI_FREE(g->history); - STBI_FREE(g->background); - - if (out) STBI_FREE(out); - if (delays && *delays) STBI_FREE(*delays); - return stbi__errpuc("outofmem", "Out of memory"); -} - -static void *stbi__load_gif_main(stbi__context *s, int **delays, int *x, int *y, int *z, int *comp, int req_comp) -{ - if (stbi__gif_test(s)) { - int layers = 0; - stbi_uc *u = 0; - stbi_uc *out = 0; - stbi_uc *two_back = 0; - stbi__gif g; - int stride; - int out_size = 0; - int delays_size = 0; - - STBI_NOTUSED(out_size); - STBI_NOTUSED(delays_size); - - memset(&g, 0, sizeof(g)); - if (delays) { - *delays = 0; - } - - do { - u = stbi__gif_load_next(s, &g, comp, req_comp, two_back); - if (u == (stbi_uc *) s) u = 0; // end of animated gif marker - - if (u) { - *x = g.w; - *y = g.h; - ++layers; - stride = g.w * g.h * 4; - - if (out) { - void *tmp = (stbi_uc*) STBI_REALLOC_SIZED( out, out_size, layers * stride ); - if (!tmp) - return stbi__load_gif_main_outofmem(&g, out, delays); - else { - out = (stbi_uc*) tmp; - out_size = layers * stride; - } - - if (delays) { - int *new_delays = (int*) STBI_REALLOC_SIZED( *delays, delays_size, sizeof(int) * layers ); - if (!new_delays) - return stbi__load_gif_main_outofmem(&g, out, delays); - *delays = new_delays; - delays_size = layers * sizeof(int); - } - } else { - out = (stbi_uc*)stbi__malloc( layers * stride ); - if (!out) - return stbi__load_gif_main_outofmem(&g, out, delays); - out_size = layers * stride; - if (delays) { - *delays = (int*) stbi__malloc( layers * sizeof(int) ); - if (!*delays) - return stbi__load_gif_main_outofmem(&g, out, delays); - delays_size = layers * sizeof(int); - } - } - memcpy( out + ((layers - 1) * stride), u, stride ); - if (layers >= 2) { - two_back = out - 2 * stride; - } - - if (delays) { - (*delays)[layers - 1U] = g.delay; - } - } - } while (u != 0); - - // free temp buffer; - STBI_FREE(g.out); - STBI_FREE(g.history); - STBI_FREE(g.background); - - // do the final conversion after loading everything; - if (req_comp && req_comp != 4) - out = stbi__convert_format(out, 4, req_comp, layers * g.w, g.h); - - *z = layers; - return out; - } else { - return stbi__errpuc("not GIF", "Image was not as a gif type."); - } -} - -static void *stbi__gif_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) -{ - stbi_uc *u = 0; - stbi__gif g; - memset(&g, 0, sizeof(g)); - STBI_NOTUSED(ri); - - u = stbi__gif_load_next(s, &g, comp, req_comp, 0); - if (u == (stbi_uc *) s) u = 0; // end of animated gif marker - if (u) { - *x = g.w; - *y = g.h; - - // moved conversion to after successful load so that the same - // can be done for multiple frames. - if (req_comp && req_comp != 4) - u = stbi__convert_format(u, 4, req_comp, g.w, g.h); - } else if (g.out) { - // if there was an error and we allocated an image buffer, free it! - STBI_FREE(g.out); - } - - // free buffers needed for multiple frame loading; - STBI_FREE(g.history); - STBI_FREE(g.background); - - return u; -} - -static int stbi__gif_info(stbi__context *s, int *x, int *y, int *comp) -{ - return stbi__gif_info_raw(s,x,y,comp); -} -#endif - -// ************************************************************************************************* -// Radiance RGBE HDR loader -// originally by Nicolas Schulz -#ifndef STBI_NO_HDR -static int stbi__hdr_test_core(stbi__context *s, const char *signature) -{ - int i; - for (i=0; signature[i]; ++i) - if (stbi__get8(s) != signature[i]) - return 0; - stbi__rewind(s); - return 1; -} - -static int stbi__hdr_test(stbi__context* s) -{ - int r = stbi__hdr_test_core(s, "#?RADIANCE\n"); - stbi__rewind(s); - if(!r) { - r = stbi__hdr_test_core(s, "#?RGBE\n"); - stbi__rewind(s); - } - return r; -} - -#define STBI__HDR_BUFLEN 1024 -static char *stbi__hdr_gettoken(stbi__context *z, char *buffer) -{ - int len=0; - char c = '\0'; - - c = (char) stbi__get8(z); - - while (!stbi__at_eof(z) && c != '\n') { - buffer[len++] = c; - if (len == STBI__HDR_BUFLEN-1) { - // flush to end of line - while (!stbi__at_eof(z) && stbi__get8(z) != '\n') - ; - break; - } - c = (char) stbi__get8(z); - } - - buffer[len] = 0; - return buffer; -} - -static void stbi__hdr_convert(float *output, stbi_uc *input, int req_comp) -{ - if ( input[3] != 0 ) { - float f1; - // Exponent - f1 = (float) ldexp(1.0f, input[3] - (int)(128 + 8)); - if (req_comp <= 2) - output[0] = (input[0] + input[1] + input[2]) * f1 / 3; - else { - output[0] = input[0] * f1; - output[1] = input[1] * f1; - output[2] = input[2] * f1; - } - if (req_comp == 2) output[1] = 1; - if (req_comp == 4) output[3] = 1; - } else { - switch (req_comp) { - case 4: output[3] = 1; /* fallthrough */ - case 3: output[0] = output[1] = output[2] = 0; - break; - case 2: output[1] = 1; /* fallthrough */ - case 1: output[0] = 0; - break; - } - } -} - -static float *stbi__hdr_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) -{ - char buffer[STBI__HDR_BUFLEN]; - char *token; - int valid = 0; - int width, height; - stbi_uc *scanline; - float *hdr_data; - int len; - unsigned char count, value; - int i, j, k, c1,c2, z; - const char *headerToken; - STBI_NOTUSED(ri); - - // Check identifier - headerToken = stbi__hdr_gettoken(s,buffer); - if (strcmp(headerToken, "#?RADIANCE") != 0 && strcmp(headerToken, "#?RGBE") != 0) - return stbi__errpf("not HDR", "Corrupt HDR image"); - - // Parse header - for(;;) { - token = stbi__hdr_gettoken(s,buffer); - if (token[0] == 0) break; - if (strcmp(token, "FORMAT=32-bit_rle_rgbe") == 0) valid = 1; - } - - if (!valid) return stbi__errpf("unsupported format", "Unsupported HDR format"); - - // Parse width and height - // can't use sscanf() if we're not using stdio! - token = stbi__hdr_gettoken(s,buffer); - if (strncmp(token, "-Y ", 3)) return stbi__errpf("unsupported data layout", "Unsupported HDR format"); - token += 3; - height = (int) strtol(token, &token, 10); - while (*token == ' ') ++token; - if (strncmp(token, "+X ", 3)) return stbi__errpf("unsupported data layout", "Unsupported HDR format"); - token += 3; - width = (int) strtol(token, NULL, 10); - - if (height > STBI_MAX_DIMENSIONS) return stbi__errpf("too large","Very large image (corrupt?)"); - if (width > STBI_MAX_DIMENSIONS) return stbi__errpf("too large","Very large image (corrupt?)"); - - *x = width; - *y = height; - - if (comp) *comp = 3; - if (req_comp == 0) req_comp = 3; - - if (!stbi__mad4sizes_valid(width, height, req_comp, sizeof(float), 0)) - return stbi__errpf("too large", "HDR image is too large"); - - // Read data - hdr_data = (float *) stbi__malloc_mad4(width, height, req_comp, sizeof(float), 0); - if (!hdr_data) - return stbi__errpf("outofmem", "Out of memory"); - - // Load image data - // image data is stored as some number of sca - if ( width < 8 || width >= 32768) { - // Read flat data - for (j=0; j < height; ++j) { - for (i=0; i < width; ++i) { - stbi_uc rgbe[4]; - main_decode_loop: - stbi__getn(s, rgbe, 4); - stbi__hdr_convert(hdr_data + j * width * req_comp + i * req_comp, rgbe, req_comp); - } - } - } else { - // Read RLE-encoded data - scanline = NULL; - - for (j = 0; j < height; ++j) { - c1 = stbi__get8(s); - c2 = stbi__get8(s); - len = stbi__get8(s); - if (c1 != 2 || c2 != 2 || (len & 0x80)) { - // not run-length encoded, so we have to actually use THIS data as a decoded - // pixel (note this can't be a valid pixel--one of RGB must be >= 128) - stbi_uc rgbe[4]; - rgbe[0] = (stbi_uc) c1; - rgbe[1] = (stbi_uc) c2; - rgbe[2] = (stbi_uc) len; - rgbe[3] = (stbi_uc) stbi__get8(s); - stbi__hdr_convert(hdr_data, rgbe, req_comp); - i = 1; - j = 0; - STBI_FREE(scanline); - goto main_decode_loop; // yes, this makes no sense - } - len <<= 8; - len |= stbi__get8(s); - if (len != width) { STBI_FREE(hdr_data); STBI_FREE(scanline); return stbi__errpf("invalid decoded scanline length", "corrupt HDR"); } - if (scanline == NULL) { - scanline = (stbi_uc *) stbi__malloc_mad2(width, 4, 0); - if (!scanline) { - STBI_FREE(hdr_data); - return stbi__errpf("outofmem", "Out of memory"); - } - } - - for (k = 0; k < 4; ++k) { - int nleft; - i = 0; - while ((nleft = width - i) > 0) { - count = stbi__get8(s); - if (count > 128) { - // Run - value = stbi__get8(s); - count -= 128; - if ((count == 0) || (count > nleft)) { STBI_FREE(hdr_data); STBI_FREE(scanline); return stbi__errpf("corrupt", "bad RLE data in HDR"); } - for (z = 0; z < count; ++z) - scanline[i++ * 4 + k] = value; - } else { - // Dump - if ((count == 0) || (count > nleft)) { STBI_FREE(hdr_data); STBI_FREE(scanline); return stbi__errpf("corrupt", "bad RLE data in HDR"); } - for (z = 0; z < count; ++z) - scanline[i++ * 4 + k] = stbi__get8(s); - } - } - } - for (i=0; i < width; ++i) - stbi__hdr_convert(hdr_data+(j*width + i)*req_comp, scanline + i*4, req_comp); - } - if (scanline) - STBI_FREE(scanline); - } - - return hdr_data; -} - -static int stbi__hdr_info(stbi__context *s, int *x, int *y, int *comp) -{ - char buffer[STBI__HDR_BUFLEN]; - char *token; - int valid = 0; - int dummy; - - if (!x) x = &dummy; - if (!y) y = &dummy; - if (!comp) comp = &dummy; - - if (stbi__hdr_test(s) == 0) { - stbi__rewind( s ); - return 0; - } - - for(;;) { - token = stbi__hdr_gettoken(s,buffer); - if (token[0] == 0) break; - if (strcmp(token, "FORMAT=32-bit_rle_rgbe") == 0) valid = 1; - } - - if (!valid) { - stbi__rewind( s ); - return 0; - } - token = stbi__hdr_gettoken(s,buffer); - if (strncmp(token, "-Y ", 3)) { - stbi__rewind( s ); - return 0; - } - token += 3; - *y = (int) strtol(token, &token, 10); - while (*token == ' ') ++token; - if (strncmp(token, "+X ", 3)) { - stbi__rewind( s ); - return 0; - } - token += 3; - *x = (int) strtol(token, NULL, 10); - *comp = 3; - return 1; -} -#endif // STBI_NO_HDR - -#ifndef STBI_NO_BMP -static int stbi__bmp_info(stbi__context *s, int *x, int *y, int *comp) -{ - void *p; - stbi__bmp_data info; - - info.all_a = 255; - p = stbi__bmp_parse_header(s, &info); - if (p == NULL) { - stbi__rewind( s ); - return 0; - } - if (x) *x = s->img_x; - if (y) *y = s->img_y; - if (comp) { - if (info.bpp == 24 && info.ma == 0xff000000) - *comp = 3; - else - *comp = info.ma ? 4 : 3; - } - return 1; -} -#endif - -#ifndef STBI_NO_PSD -static int stbi__psd_info(stbi__context *s, int *x, int *y, int *comp) -{ - int channelCount, dummy, depth; - if (!x) x = &dummy; - if (!y) y = &dummy; - if (!comp) comp = &dummy; - if (stbi__get32be(s) != 0x38425053) { - stbi__rewind( s ); - return 0; - } - if (stbi__get16be(s) != 1) { - stbi__rewind( s ); - return 0; - } - stbi__skip(s, 6); - channelCount = stbi__get16be(s); - if (channelCount < 0 || channelCount > 16) { - stbi__rewind( s ); - return 0; - } - *y = stbi__get32be(s); - *x = stbi__get32be(s); - depth = stbi__get16be(s); - if (depth != 8 && depth != 16) { - stbi__rewind( s ); - return 0; - } - if (stbi__get16be(s) != 3) { - stbi__rewind( s ); - return 0; - } - *comp = 4; - return 1; -} - -static int stbi__psd_is16(stbi__context *s) -{ - int channelCount, depth; - if (stbi__get32be(s) != 0x38425053) { - stbi__rewind( s ); - return 0; - } - if (stbi__get16be(s) != 1) { - stbi__rewind( s ); - return 0; - } - stbi__skip(s, 6); - channelCount = stbi__get16be(s); - if (channelCount < 0 || channelCount > 16) { - stbi__rewind( s ); - return 0; - } - STBI_NOTUSED(stbi__get32be(s)); - STBI_NOTUSED(stbi__get32be(s)); - depth = stbi__get16be(s); - if (depth != 16) { - stbi__rewind( s ); - return 0; - } - return 1; -} -#endif - -#ifndef STBI_NO_PIC -static int stbi__pic_info(stbi__context *s, int *x, int *y, int *comp) -{ - int act_comp=0,num_packets=0,chained,dummy; - stbi__pic_packet packets[10]; - - if (!x) x = &dummy; - if (!y) y = &dummy; - if (!comp) comp = &dummy; - - if (!stbi__pic_is4(s,"\x53\x80\xF6\x34")) { - stbi__rewind(s); - return 0; - } - - stbi__skip(s, 88); - - *x = stbi__get16be(s); - *y = stbi__get16be(s); - if (stbi__at_eof(s)) { - stbi__rewind( s); - return 0; - } - if ( (*x) != 0 && (1 << 28) / (*x) < (*y)) { - stbi__rewind( s ); - return 0; - } - - stbi__skip(s, 8); - - do { - stbi__pic_packet *packet; - - if (num_packets==sizeof(packets)/sizeof(packets[0])) - return 0; - - packet = &packets[num_packets++]; - chained = stbi__get8(s); - packet->size = stbi__get8(s); - packet->type = stbi__get8(s); - packet->channel = stbi__get8(s); - act_comp |= packet->channel; - - if (stbi__at_eof(s)) { - stbi__rewind( s ); - return 0; - } - if (packet->size != 8) { - stbi__rewind( s ); - return 0; - } - } while (chained); - - *comp = (act_comp & 0x10 ? 4 : 3); - - return 1; -} -#endif - -// ************************************************************************************************* -// Portable Gray Map and Portable Pixel Map loader -// by Ken Miller -// -// PGM: http://netpbm.sourceforge.net/doc/pgm.html -// PPM: http://netpbm.sourceforge.net/doc/ppm.html -// -// Known limitations: -// Does not support comments in the header section -// Does not support ASCII image data (formats P2 and P3) - -#ifndef STBI_NO_PNM - -static int stbi__pnm_test(stbi__context *s) -{ - char p, t; - p = (char) stbi__get8(s); - t = (char) stbi__get8(s); - if (p != 'P' || (t != '5' && t != '6')) { - stbi__rewind( s ); - return 0; - } - return 1; -} - -static void *stbi__pnm_load(stbi__context *s, int *x, int *y, int *comp, int req_comp, stbi__result_info *ri) -{ - stbi_uc *out; - STBI_NOTUSED(ri); - - ri->bits_per_channel = stbi__pnm_info(s, (int *)&s->img_x, (int *)&s->img_y, (int *)&s->img_n); - if (ri->bits_per_channel == 0) - return 0; - - if (s->img_y > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); - if (s->img_x > STBI_MAX_DIMENSIONS) return stbi__errpuc("too large","Very large image (corrupt?)"); - - *x = s->img_x; - *y = s->img_y; - if (comp) *comp = s->img_n; - - if (!stbi__mad4sizes_valid(s->img_n, s->img_x, s->img_y, ri->bits_per_channel / 8, 0)) - return stbi__errpuc("too large", "PNM too large"); - - out = (stbi_uc *) stbi__malloc_mad4(s->img_n, s->img_x, s->img_y, ri->bits_per_channel / 8, 0); - if (!out) return stbi__errpuc("outofmem", "Out of memory"); - if (!stbi__getn(s, out, s->img_n * s->img_x * s->img_y * (ri->bits_per_channel / 8))) { - STBI_FREE(out); - return stbi__errpuc("bad PNM", "PNM file truncated"); - } - - if (req_comp && req_comp != s->img_n) { - if (ri->bits_per_channel == 16) { - out = (stbi_uc *) stbi__convert_format16((stbi__uint16 *) out, s->img_n, req_comp, s->img_x, s->img_y); - } else { - out = stbi__convert_format(out, s->img_n, req_comp, s->img_x, s->img_y); - } - if (out == NULL) return out; // stbi__convert_format frees input on failure - } - return out; -} - -static int stbi__pnm_isspace(char c) -{ - return c == ' ' || c == '\t' || c == '\n' || c == '\v' || c == '\f' || c == '\r'; -} - -static void stbi__pnm_skip_whitespace(stbi__context *s, char *c) -{ - for (;;) { - while (!stbi__at_eof(s) && stbi__pnm_isspace(*c)) - *c = (char) stbi__get8(s); - - if (stbi__at_eof(s) || *c != '#') - break; - - while (!stbi__at_eof(s) && *c != '\n' && *c != '\r' ) - *c = (char) stbi__get8(s); - } -} - -static int stbi__pnm_isdigit(char c) -{ - return c >= '0' && c <= '9'; -} - -static int stbi__pnm_getinteger(stbi__context *s, char *c) -{ - int value = 0; - - while (!stbi__at_eof(s) && stbi__pnm_isdigit(*c)) { - value = value*10 + (*c - '0'); - *c = (char) stbi__get8(s); - if((value > 214748364) || (value == 214748364 && *c > '7')) - return stbi__err("integer parse overflow", "Parsing an integer in the PPM header overflowed a 32-bit int"); - } - - return value; -} - -static int stbi__pnm_info(stbi__context *s, int *x, int *y, int *comp) -{ - int maxv, dummy; - char c, p, t; - - if (!x) x = &dummy; - if (!y) y = &dummy; - if (!comp) comp = &dummy; - - stbi__rewind(s); - - // Get identifier - p = (char) stbi__get8(s); - t = (char) stbi__get8(s); - if (p != 'P' || (t != '5' && t != '6')) { - stbi__rewind(s); - return 0; - } - - *comp = (t == '6') ? 3 : 1; // '5' is 1-component .pgm; '6' is 3-component .ppm - - c = (char) stbi__get8(s); - stbi__pnm_skip_whitespace(s, &c); - - *x = stbi__pnm_getinteger(s, &c); // read width - if(*x == 0) - return stbi__err("invalid width", "PPM image header had zero or overflowing width"); - stbi__pnm_skip_whitespace(s, &c); - - *y = stbi__pnm_getinteger(s, &c); // read height - if (*y == 0) - return stbi__err("invalid width", "PPM image header had zero or overflowing width"); - stbi__pnm_skip_whitespace(s, &c); - - maxv = stbi__pnm_getinteger(s, &c); // read max value - if (maxv > 65535) - return stbi__err("max value > 65535", "PPM image supports only 8-bit and 16-bit images"); - else if (maxv > 255) - return 16; - else - return 8; -} - -static int stbi__pnm_is16(stbi__context *s) -{ - if (stbi__pnm_info(s, NULL, NULL, NULL) == 16) - return 1; - return 0; -} -#endif - -static int stbi__info_main(stbi__context *s, int *x, int *y, int *comp) -{ - #ifndef STBI_NO_JPEG - if (stbi__jpeg_info(s, x, y, comp)) return 1; - #endif - - #ifndef STBI_NO_PNG - if (stbi__png_info(s, x, y, comp)) return 1; - #endif - - #ifndef STBI_NO_GIF - if (stbi__gif_info(s, x, y, comp)) return 1; - #endif - - #ifndef STBI_NO_BMP - if (stbi__bmp_info(s, x, y, comp)) return 1; - #endif - - #ifndef STBI_NO_PSD - if (stbi__psd_info(s, x, y, comp)) return 1; - #endif - - #ifndef STBI_NO_PIC - if (stbi__pic_info(s, x, y, comp)) return 1; - #endif - - #ifndef STBI_NO_PNM - if (stbi__pnm_info(s, x, y, comp)) return 1; - #endif - - #ifndef STBI_NO_HDR - if (stbi__hdr_info(s, x, y, comp)) return 1; - #endif - - // test tga last because it's a crappy test! - #ifndef STBI_NO_TGA - if (stbi__tga_info(s, x, y, comp)) - return 1; - #endif - return stbi__err("unknown image type", "Image not of any known type, or corrupt"); -} - -static int stbi__is_16_main(stbi__context *s) -{ - #ifndef STBI_NO_PNG - if (stbi__png_is16(s)) return 1; - #endif - - #ifndef STBI_NO_PSD - if (stbi__psd_is16(s)) return 1; - #endif - - #ifndef STBI_NO_PNM - if (stbi__pnm_is16(s)) return 1; - #endif - return 0; -} - -#ifndef STBI_NO_STDIO -STBIDEF int stbi_info(char const *filename, int *x, int *y, int *comp) -{ - FILE *f = stbi__fopen(filename, "rb"); - int result; - if (!f) return stbi__err("can't fopen", "Unable to open file"); - result = stbi_info_from_file(f, x, y, comp); - fclose(f); - return result; -} - -STBIDEF int stbi_info_from_file(FILE *f, int *x, int *y, int *comp) -{ - int r; - stbi__context s; - long pos = ftell(f); - stbi__start_file(&s, f); - r = stbi__info_main(&s,x,y,comp); - fseek(f,pos,SEEK_SET); - return r; -} - -STBIDEF int stbi_is_16_bit(char const *filename) -{ - FILE *f = stbi__fopen(filename, "rb"); - int result; - if (!f) return stbi__err("can't fopen", "Unable to open file"); - result = stbi_is_16_bit_from_file(f); - fclose(f); - return result; -} - -STBIDEF int stbi_is_16_bit_from_file(FILE *f) -{ - int r; - stbi__context s; - long pos = ftell(f); - stbi__start_file(&s, f); - r = stbi__is_16_main(&s); - fseek(f,pos,SEEK_SET); - return r; -} -#endif // !STBI_NO_STDIO - -STBIDEF int stbi_info_from_memory(stbi_uc const *buffer, int len, int *x, int *y, int *comp) -{ - stbi__context s; - stbi__start_mem(&s,buffer,len); - return stbi__info_main(&s,x,y,comp); -} - -STBIDEF int stbi_info_from_callbacks(stbi_io_callbacks const *c, void *user, int *x, int *y, int *comp) -{ - stbi__context s; - stbi__start_callbacks(&s, (stbi_io_callbacks *) c, user); - return stbi__info_main(&s,x,y,comp); -} - -STBIDEF int stbi_is_16_bit_from_memory(stbi_uc const *buffer, int len) -{ - stbi__context s; - stbi__start_mem(&s,buffer,len); - return stbi__is_16_main(&s); -} - -STBIDEF int stbi_is_16_bit_from_callbacks(stbi_io_callbacks const *c, void *user) -{ - stbi__context s; - stbi__start_callbacks(&s, (stbi_io_callbacks *) c, user); - return stbi__is_16_main(&s); -} - -#endif // STB_IMAGE_IMPLEMENTATION - -/* - revision history: - 2.20 (2019-02-07) support utf8 filenames in Windows; fix warnings and platform ifdefs - 2.19 (2018-02-11) fix warning - 2.18 (2018-01-30) fix warnings - 2.17 (2018-01-29) change sbti__shiftsigned to avoid clang -O2 bug - 1-bit BMP - *_is_16_bit api - avoid warnings - 2.16 (2017-07-23) all functions have 16-bit variants; - STBI_NO_STDIO works again; - compilation fixes; - fix rounding in unpremultiply; - optimize vertical flip; - disable raw_len validation; - documentation fixes - 2.15 (2017-03-18) fix png-1,2,4 bug; now all Imagenet JPGs decode; - warning fixes; disable run-time SSE detection on gcc; - uniform handling of optional "return" values; - thread-safe initialization of zlib tables - 2.14 (2017-03-03) remove deprecated STBI_JPEG_OLD; fixes for Imagenet JPGs - 2.13 (2016-11-29) add 16-bit API, only supported for PNG right now - 2.12 (2016-04-02) fix typo in 2.11 PSD fix that caused crashes - 2.11 (2016-04-02) allocate large structures on the stack - remove white matting for transparent PSD - fix reported channel count for PNG & BMP - re-enable SSE2 in non-gcc 64-bit - support RGB-formatted JPEG - read 16-bit PNGs (only as 8-bit) - 2.10 (2016-01-22) avoid warning introduced in 2.09 by STBI_REALLOC_SIZED - 2.09 (2016-01-16) allow comments in PNM files - 16-bit-per-pixel TGA (not bit-per-component) - info() for TGA could break due to .hdr handling - info() for BMP to shares code instead of sloppy parse - can use STBI_REALLOC_SIZED if allocator doesn't support realloc - code cleanup - 2.08 (2015-09-13) fix to 2.07 cleanup, reading RGB PSD as RGBA - 2.07 (2015-09-13) fix compiler warnings - partial animated GIF support - limited 16-bpc PSD support - #ifdef unused functions - bug with < 92 byte PIC,PNM,HDR,TGA - 2.06 (2015-04-19) fix bug where PSD returns wrong '*comp' value - 2.05 (2015-04-19) fix bug in progressive JPEG handling, fix warning - 2.04 (2015-04-15) try to re-enable SIMD on MinGW 64-bit - 2.03 (2015-04-12) extra corruption checking (mmozeiko) - stbi_set_flip_vertically_on_load (nguillemot) - fix NEON support; fix mingw support - 2.02 (2015-01-19) fix incorrect assert, fix warning - 2.01 (2015-01-17) fix various warnings; suppress SIMD on gcc 32-bit without -msse2 - 2.00b (2014-12-25) fix STBI_MALLOC in progressive JPEG - 2.00 (2014-12-25) optimize JPG, including x86 SSE2 & NEON SIMD (ryg) - progressive JPEG (stb) - PGM/PPM support (Ken Miller) - STBI_MALLOC,STBI_REALLOC,STBI_FREE - GIF bugfix -- seemingly never worked - STBI_NO_*, STBI_ONLY_* - 1.48 (2014-12-14) fix incorrectly-named assert() - 1.47 (2014-12-14) 1/2/4-bit PNG support, both direct and paletted (Omar Cornut & stb) - optimize PNG (ryg) - fix bug in interlaced PNG with user-specified channel count (stb) - 1.46 (2014-08-26) - fix broken tRNS chunk (colorkey-style transparency) in non-paletted PNG - 1.45 (2014-08-16) - fix MSVC-ARM internal compiler error by wrapping malloc - 1.44 (2014-08-07) - various warning fixes from Ronny Chevalier - 1.43 (2014-07-15) - fix MSVC-only compiler problem in code changed in 1.42 - 1.42 (2014-07-09) - don't define _CRT_SECURE_NO_WARNINGS (affects user code) - fixes to stbi__cleanup_jpeg path - added STBI_ASSERT to avoid requiring assert.h - 1.41 (2014-06-25) - fix search&replace from 1.36 that messed up comments/error messages - 1.40 (2014-06-22) - fix gcc struct-initialization warning - 1.39 (2014-06-15) - fix to TGA optimization when req_comp != number of components in TGA; - fix to GIF loading because BMP wasn't rewinding (whoops, no GIFs in my test suite) - add support for BMP version 5 (more ignored fields) - 1.38 (2014-06-06) - suppress MSVC warnings on integer casts truncating values - fix accidental rename of 'skip' field of I/O - 1.37 (2014-06-04) - remove duplicate typedef - 1.36 (2014-06-03) - convert to header file single-file library - if de-iphone isn't set, load iphone images color-swapped instead of returning NULL - 1.35 (2014-05-27) - various warnings - fix broken STBI_SIMD path - fix bug where stbi_load_from_file no longer left file pointer in correct place - fix broken non-easy path for 32-bit BMP (possibly never used) - TGA optimization by Arseny Kapoulkine - 1.34 (unknown) - use STBI_NOTUSED in stbi__resample_row_generic(), fix one more leak in tga failure case - 1.33 (2011-07-14) - make stbi_is_hdr work in STBI_NO_HDR (as specified), minor compiler-friendly improvements - 1.32 (2011-07-13) - support for "info" function for all supported filetypes (SpartanJ) - 1.31 (2011-06-20) - a few more leak fixes, bug in PNG handling (SpartanJ) - 1.30 (2011-06-11) - added ability to load files via callbacks to accomidate custom input streams (Ben Wenger) - removed deprecated format-specific test/load functions - removed support for installable file formats (stbi_loader) -- would have been broken for IO callbacks anyway - error cases in bmp and tga give messages and don't leak (Raymond Barbiero, grisha) - fix inefficiency in decoding 32-bit BMP (David Woo) - 1.29 (2010-08-16) - various warning fixes from Aurelien Pocheville - 1.28 (2010-08-01) - fix bug in GIF palette transparency (SpartanJ) - 1.27 (2010-08-01) - cast-to-stbi_uc to fix warnings - 1.26 (2010-07-24) - fix bug in file buffering for PNG reported by SpartanJ - 1.25 (2010-07-17) - refix trans_data warning (Won Chun) - 1.24 (2010-07-12) - perf improvements reading from files on platforms with lock-heavy fgetc() - minor perf improvements for jpeg - deprecated type-specific functions so we'll get feedback if they're needed - attempt to fix trans_data warning (Won Chun) - 1.23 fixed bug in iPhone support - 1.22 (2010-07-10) - removed image *writing* support - stbi_info support from Jetro Lauha - GIF support from Jean-Marc Lienher - iPhone PNG-extensions from James Brown - warning-fixes from Nicolas Schulz and Janez Zemva (i.stbi__err. Janez (U+017D)emva) - 1.21 fix use of 'stbi_uc' in header (reported by jon blow) - 1.20 added support for Softimage PIC, by Tom Seddon - 1.19 bug in interlaced PNG corruption check (found by ryg) - 1.18 (2008-08-02) - fix a threading bug (local mutable static) - 1.17 support interlaced PNG - 1.16 major bugfix - stbi__convert_format converted one too many pixels - 1.15 initialize some fields for thread safety - 1.14 fix threadsafe conversion bug - header-file-only version (#define STBI_HEADER_FILE_ONLY before including) - 1.13 threadsafe - 1.12 const qualifiers in the API - 1.11 Support installable IDCT, colorspace conversion routines - 1.10 Fixes for 64-bit (don't use "unsigned long") - optimized upsampling by Fabian "ryg" Giesen - 1.09 Fix format-conversion for PSD code (bad global variables!) - 1.08 Thatcher Ulrich's PSD code integrated by Nicolas Schulz - 1.07 attempt to fix C++ warning/errors again - 1.06 attempt to fix C++ warning/errors again - 1.05 fix TGA loading to return correct *comp and use good luminance calc - 1.04 default float alpha is 1, not 255; use 'void *' for stbi_image_free - 1.03 bugfixes to STBI_NO_STDIO, STBI_NO_HDR - 1.02 support for (subset of) HDR files, float interface for preferred access to them - 1.01 fix bug: possible bug in handling right-side up bmps... not sure - fix bug: the stbi__bmp_load() and stbi__tga_load() functions didn't work at all - 1.00 interface to zlib that skips zlib header - 0.99 correct handling of alpha in palette - 0.98 TGA loader by lonesock; dynamically add loaders (untested) - 0.97 jpeg errors on too large a file; also catch another malloc failure - 0.96 fix detection of invalid v value - particleman@mollyrocket forum - 0.95 during header scan, seek to markers in case of padding - 0.94 STBI_NO_STDIO to disable stdio usage; rename all #defines the same - 0.93 handle jpegtran output; verbose errors - 0.92 read 4,8,16,24,32-bit BMP files of several formats - 0.91 output 24-bit Windows 3.0 BMP files - 0.90 fix a few more warnings; bump version number to approach 1.0 - 0.61 bugfixes due to Marc LeBlanc, Christopher Lloyd - 0.60 fix compiling as c++ - 0.59 fix warnings: merge Dave Moore's -Wall fixes - 0.58 fix bug: zlib uncompressed mode len/nlen was wrong endian - 0.57 fix bug: jpg last huffman symbol before marker was >9 bits but less than 16 available - 0.56 fix bug: zlib uncompressed mode len vs. nlen - 0.55 fix bug: restart_interval not initialized to 0 - 0.54 allow NULL for 'int *comp' - 0.53 fix bug in png 3->4; speedup png decoding - 0.52 png handles req_comp=3,4 directly; minor cleanup; jpeg comments - 0.51 obey req_comp requests, 1-component jpegs return as 1-component, - on 'test' only check type, not whether we support this variant - 0.50 (2006-11-19) - first released version -*/ - - -/* ------------------------------------------------------------------------------- -This software is available under 2 licenses -- choose whichever you prefer. ------------------------------------------------------------------------------- -ALTERNATIVE A - MIT License -Copyright (c) 2017 Sean Barrett -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. ------------------------------------------------------------------------------- -ALTERNATIVE B - Public Domain (www.unlicense.org) -This is free and unencumbered software released into the public domain. -Anyone is free to copy, modify, publish, use, compile, sell, or distribute this -software, either in source code form or as a compiled binary, for any purpose, -commercial or non-commercial, and by any means. -In jurisdictions that recognize copyright laws, the author or authors of this -software dedicate any and all copyright interest in the software to the public -domain. We make this dedication for the benefit of the public at large and to -the detriment of our heirs and successors. We intend this dedication to be an -overt act of relinquishment in perpetuity of all present and future rights to -this software under copyright law. -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 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. ------------------------------------------------------------------------------- -*/ diff --git a/scripts/switch/bake_ota_logo.py b/scripts/switch/bake_ota_logo.py new file mode 100644 index 00000000..1703730e --- /dev/null +++ b/scripts/switch/bake_ota_logo.py @@ -0,0 +1,156 @@ +#!/usr/bin/env python3 +"""Bake assets/logo/logo.png into a pre-scaled RGBA blob for the Switch OTA UI. + +Output format (little-endian): + uint32 width, uint32 height, then width*height RGBA8888 pixels. + +Regenerate after editing the source PNG: + python3 scripts/switch/bake_ota_logo.py + +Uses Pillow when available (see scripts/setup.sh). On macOS without Pillow, +falls back to sips + BMP export. +""" + +from __future__ import annotations + +import math +import platform +import struct +import subprocess +import sys +import tempfile +from pathlib import Path + +ROOT = Path(__file__).resolve().parents[2] +DEFAULT_SRC = ROOT / "assets/logo/logo.png" +DEFAULT_OUT = ROOT / "native/switch-ota-launcher/assets/logo.rgba" +DEFAULT_MAX_W = 320 +DEFAULT_MAX_H = 90 + + +def fit_size(src_w: int, src_h: int, max_w: int, max_h: int) -> tuple[int, int]: + scale = min(max_w / src_w, max_h / src_h, 1.0) + w = max(1, int(math.floor(src_w * scale + 0.5))) + h = max(1, int(math.floor(src_h * scale + 0.5))) + return w, h + + +def read_png_size(path: Path) -> tuple[int, int]: + with path.open("rb") as fp: + sig = fp.read(8) + if sig != b"\x89PNG\r\n\x1a\n": + raise SystemExit(f"not a PNG: {path}") + while True: + raw = fp.read(8) + if len(raw) < 8: + raise SystemExit(f"truncated PNG: {path}") + length, ctype = struct.unpack(">I4s", raw) + data = fp.read(length) + fp.read(4) + if ctype == b"IHDR": + return struct.unpack(">II", data[:8]) + if ctype == b"IEND": + break + raise SystemExit(f"missing IHDR in PNG: {path}") + + +def read_bmp_rgba(path: Path) -> tuple[int, int, bytes]: + data = path.read_bytes() + if len(data) < 54 or data[:2] != b"BM": + raise SystemExit(f"not a BMP: {path}") + pixel_offset = struct.unpack_from(" tuple[int, int, bytes]: + if platform.system() != "Darwin": + raise SystemExit( + "Pillow is required to bake the OTA logo on this platform. " + "Run scripts/setup.sh or: pip install pillow" + ) + + with tempfile.TemporaryDirectory() as tmp: + tmp_dir = Path(tmp) + scaled_png = tmp_dir / "scaled.png" + scaled_bmp = tmp_dir / "scaled.bmp" + subprocess.run( + ["sips", "-z", str(out_h), str(out_w), str(src), "--out", str(scaled_png)], + check=True, + stdout=subprocess.DEVNULL, + stderr=subprocess.PIPE, + ) + subprocess.run( + ["sips", "-s", "format", "bmp", str(scaled_png), "--out", str(scaled_bmp)], + check=True, + stdout=subprocess.DEVNULL, + stderr=subprocess.PIPE, + ) + return read_bmp_rgba(scaled_bmp) + + +def bake_with_pillow(src: Path, out_w: int, out_h: int) -> tuple[int, int, bytes]: + from PIL import Image + + with Image.open(src) as image: + image = image.convert("RGBA") + if image.size != (out_w, out_h): + image = image.resize((out_w, out_h), Image.LANCZOS) + w, h = image.size + return w, h, image.tobytes() + + +def bake(src: Path, out: Path, max_w: int, max_h: int) -> tuple[int, int]: + if not src.is_file(): + raise SystemExit(f"missing source PNG: {src}") + + src_w, src_h = read_png_size(src) + out_w, out_h = fit_size(src_w, src_h, max_w, max_h) + + try: + from PIL import Image # noqa: F401 + + w, h, pixels = bake_with_pillow(src, out_w, out_h) + except ImportError: + w, h, pixels = bake_with_sips(src, out_w, out_h) + + if len(pixels) != w * h * 4: + raise SystemExit(f"unexpected pixel buffer size for {w}x{h}") + + out.parent.mkdir(parents=True, exist_ok=True) + with out.open("wb") as fp: + fp.write(struct.pack(" int: + src = Path(argv[1]) if len(argv) > 1 else DEFAULT_SRC + out = Path(argv[2]) if len(argv) > 2 else DEFAULT_OUT + max_w = int(argv[3]) if len(argv) > 3 else DEFAULT_MAX_W + max_h = int(argv[4]) if len(argv) > 4 else DEFAULT_MAX_H + + w, h = bake(src, out, max_w, max_h) + print(f"wrote {out} ({w}x{h}, {8 + w * h * 4} bytes)") + return 0 + + +if __name__ == "__main__": + raise SystemExit(main(sys.argv)) diff --git a/test/switch-nro-ota.spec.test.js b/test/switch-nro-ota.spec.test.js index b0f75e2c..6d25f97d 100644 --- a/test/switch-nro-ota.spec.test.js +++ b/test/switch-nro-ota.spec.test.js @@ -508,7 +508,16 @@ test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () = assert.ok(fs.existsSync(path.join(root, 'native/switch-ota-launcher/src/ota_ui.c'))); const otaUi = read('native/switch-ota-launcher/src/ota_ui.c'); assert.match(otaUi, /COL_RAIL_R|rail|FFD600|255,\s*214/); - assert.match(otaUi, /logo\.png|stb_image/); + assert.match(otaUi, /logo\.rgba/); + assert.doesNotMatch(otaUi, /stb_image/); + assert.ok( + fs.existsSync(path.join(root, 'native/switch-ota-launcher/assets/logo.rgba')), + 'pre-baked OTA logo asset' + ); + assert.ok( + fs.existsSync(path.join(root, 'scripts/switch/bake_ota_logo.py')), + 'logo bake script for regenerating logo.rgba' + ); assert.match(otaUi, /ota_ui_sanitize_ascii/); assert.match(otaUi, /draw_text_wrapped_centered/); assert.match(otaUi, /ota_ui_alert_error/); @@ -519,6 +528,7 @@ test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () = assert.doesNotMatch(read('native/switch-ota-launcher/src/ota_net.c'), /CURLOPT_SSL_VERIFYPEER,\s*0L/); assert.match(read('native/switch-ota-launcher/Makefile'), /^ROMFS\s*:=/m); assert.match(read('native/switch-ota-launcher/Makefile'), /cacert\.pem/); + assert.match(read('native/switch-ota-launcher/Makefile'), /logo\.rgba/); const mk = read('native/switch-ota-launcher/Makefile'); assert.match(mk, /libnx\/switch_rules|DEVKITPRO/); @@ -530,8 +540,9 @@ test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () = assert.match(read('native/switch-ota-launcher/src/ota_unzip.c'), /zzip\/zzip\.h/); assert.match(read('native/switch-ota-launcher/src/main.c'), /ota_unzip_extract_file/); assert.match(read('native/switch-ota-launcher/src/main.c'), /GAME_MEMBER_IN_ZIP|switch\/gen1recomp\//); - assert.match(read('native/switch-ota-launcher/src/main.c'), /LAUNCHER_MEMBER_IN_ZIP|ota_fs_atomic_replace_nro/); - assert.match(read('native/switch-ota-launcher/src/main.c'), /ota_fs_atomic_replace_nro\([\s\S]*\) != 0/); + assert.match(read('native/switch-ota-launcher/src/main.c'), /LAUNCHER_MEMBER_IN_ZIP|ota_fs_stage_launcher_bootstrap/); + assert.match(read('native/switch-ota-launcher/src/main.c'), /ota_fs_stage_launcher_bootstrap\([\s\S]*\) != 0/); + assert.match(read('native/switch-ota-launcher/src/main.c'), /return 2.*bootstrap|bootstrap.*return 2/i); assert.match(read('native/switch-ota-launcher/src/ota_fs.c'), /ota_fs_atomic_replace_nro/); assert.match(read('native/switch-ota-launcher/src/ota_fs.c'), /remove\(dest\)/); assert.doesNotMatch(read('native/switch-ota-launcher/src/ota_fs.c'), /#ifdef _WIN32[\s\S]*remove\(dest\)/); From 9aa8b4e371edc4fc8b1ba160b1969447e532af33 Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 10:22:51 -0300 Subject: [PATCH 16/18] Move Switch OTA launcher sources under ports/switch. Consolidate the native OTA launcher, bootstrap, and assets into the Switch port tree. --- {assets/switch => ports/switch/assets}/icon.jpg | Bin .../switch}/assets/logo.rgba | Bin .../switch/ota-bootstrap}/Makefile | 0 .../switch/ota-bootstrap}/main.c | 0 .../switch/ota-launcher}/Makefile | 0 .../switch/ota-launcher}/README.md | 0 .../switch/ota-launcher}/host/test_ota_protocol.c | 0 .../switch/ota-launcher}/include/ota_fs.h | 0 .../switch/ota-launcher}/include/ota_net.h | 0 .../switch/ota-launcher}/include/ota_protocol.h | 0 .../switch/ota-launcher}/include/ota_ui.h | 0 .../switch/ota-launcher}/include/ota_unzip.h | 0 .../switch/ota-launcher}/romfs/.gitkeep | 0 .../switch/ota-launcher}/src/main.c | 0 .../switch/ota-launcher}/src/ota_fs.c | 0 .../switch/ota-launcher}/src/ota_net.c | 0 .../switch/ota-launcher}/src/ota_protocol.c | 0 .../switch/ota-launcher}/src/ota_ui.c | 0 .../switch/ota-launcher}/src/ota_unzip.c | 0 .../ota-launcher}/third_party/font8x8_basic.h | 0 20 files changed, 0 insertions(+), 0 deletions(-) rename {assets/switch => ports/switch/assets}/icon.jpg (100%) rename {native/switch-ota-launcher => ports/switch}/assets/logo.rgba (100%) rename {native/switch-ota-bootstrap => ports/switch/ota-bootstrap}/Makefile (100%) rename {native/switch-ota-bootstrap => ports/switch/ota-bootstrap}/main.c (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/Makefile (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/README.md (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/host/test_ota_protocol.c (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/include/ota_fs.h (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/include/ota_net.h (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/include/ota_protocol.h (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/include/ota_ui.h (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/include/ota_unzip.h (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/romfs/.gitkeep (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/src/main.c (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/src/ota_fs.c (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/src/ota_net.c (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/src/ota_protocol.c (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/src/ota_ui.c (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/src/ota_unzip.c (100%) rename {native/switch-ota-launcher => ports/switch/ota-launcher}/third_party/font8x8_basic.h (100%) diff --git a/assets/switch/icon.jpg b/ports/switch/assets/icon.jpg similarity index 100% rename from assets/switch/icon.jpg rename to ports/switch/assets/icon.jpg diff --git a/native/switch-ota-launcher/assets/logo.rgba b/ports/switch/assets/logo.rgba similarity index 100% rename from native/switch-ota-launcher/assets/logo.rgba rename to ports/switch/assets/logo.rgba diff --git a/native/switch-ota-bootstrap/Makefile b/ports/switch/ota-bootstrap/Makefile similarity index 100% rename from native/switch-ota-bootstrap/Makefile rename to ports/switch/ota-bootstrap/Makefile diff --git a/native/switch-ota-bootstrap/main.c b/ports/switch/ota-bootstrap/main.c similarity index 100% rename from native/switch-ota-bootstrap/main.c rename to ports/switch/ota-bootstrap/main.c diff --git a/native/switch-ota-launcher/Makefile b/ports/switch/ota-launcher/Makefile similarity index 100% rename from native/switch-ota-launcher/Makefile rename to ports/switch/ota-launcher/Makefile diff --git a/native/switch-ota-launcher/README.md b/ports/switch/ota-launcher/README.md similarity index 100% rename from native/switch-ota-launcher/README.md rename to ports/switch/ota-launcher/README.md diff --git a/native/switch-ota-launcher/host/test_ota_protocol.c b/ports/switch/ota-launcher/host/test_ota_protocol.c similarity index 100% rename from native/switch-ota-launcher/host/test_ota_protocol.c rename to ports/switch/ota-launcher/host/test_ota_protocol.c diff --git a/native/switch-ota-launcher/include/ota_fs.h b/ports/switch/ota-launcher/include/ota_fs.h similarity index 100% rename from native/switch-ota-launcher/include/ota_fs.h rename to ports/switch/ota-launcher/include/ota_fs.h diff --git a/native/switch-ota-launcher/include/ota_net.h b/ports/switch/ota-launcher/include/ota_net.h similarity index 100% rename from native/switch-ota-launcher/include/ota_net.h rename to ports/switch/ota-launcher/include/ota_net.h diff --git a/native/switch-ota-launcher/include/ota_protocol.h b/ports/switch/ota-launcher/include/ota_protocol.h similarity index 100% rename from native/switch-ota-launcher/include/ota_protocol.h rename to ports/switch/ota-launcher/include/ota_protocol.h diff --git a/native/switch-ota-launcher/include/ota_ui.h b/ports/switch/ota-launcher/include/ota_ui.h similarity index 100% rename from native/switch-ota-launcher/include/ota_ui.h rename to ports/switch/ota-launcher/include/ota_ui.h diff --git a/native/switch-ota-launcher/include/ota_unzip.h b/ports/switch/ota-launcher/include/ota_unzip.h similarity index 100% rename from native/switch-ota-launcher/include/ota_unzip.h rename to ports/switch/ota-launcher/include/ota_unzip.h diff --git a/native/switch-ota-launcher/romfs/.gitkeep b/ports/switch/ota-launcher/romfs/.gitkeep similarity index 100% rename from native/switch-ota-launcher/romfs/.gitkeep rename to ports/switch/ota-launcher/romfs/.gitkeep diff --git a/native/switch-ota-launcher/src/main.c b/ports/switch/ota-launcher/src/main.c similarity index 100% rename from native/switch-ota-launcher/src/main.c rename to ports/switch/ota-launcher/src/main.c diff --git a/native/switch-ota-launcher/src/ota_fs.c b/ports/switch/ota-launcher/src/ota_fs.c similarity index 100% rename from native/switch-ota-launcher/src/ota_fs.c rename to ports/switch/ota-launcher/src/ota_fs.c diff --git a/native/switch-ota-launcher/src/ota_net.c b/ports/switch/ota-launcher/src/ota_net.c similarity index 100% rename from native/switch-ota-launcher/src/ota_net.c rename to ports/switch/ota-launcher/src/ota_net.c diff --git a/native/switch-ota-launcher/src/ota_protocol.c b/ports/switch/ota-launcher/src/ota_protocol.c similarity index 100% rename from native/switch-ota-launcher/src/ota_protocol.c rename to ports/switch/ota-launcher/src/ota_protocol.c diff --git a/native/switch-ota-launcher/src/ota_ui.c b/ports/switch/ota-launcher/src/ota_ui.c similarity index 100% rename from native/switch-ota-launcher/src/ota_ui.c rename to ports/switch/ota-launcher/src/ota_ui.c diff --git a/native/switch-ota-launcher/src/ota_unzip.c b/ports/switch/ota-launcher/src/ota_unzip.c similarity index 100% rename from native/switch-ota-launcher/src/ota_unzip.c rename to ports/switch/ota-launcher/src/ota_unzip.c diff --git a/native/switch-ota-launcher/third_party/font8x8_basic.h b/ports/switch/ota-launcher/third_party/font8x8_basic.h similarity index 100% rename from native/switch-ota-launcher/third_party/font8x8_basic.h rename to ports/switch/ota-launcher/third_party/font8x8_basic.h From 75cd28435c24f4ca8646a5f62d15b055346a713f Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 10:24:04 -0300 Subject: [PATCH 17/18] Update build scripts and tests for ports/switch OTA paths. Point launcher, fused build, docs, and gitignore at the relocated Switch port tree. --- .gitignore | 32 ++++++------ docs/switch-build.md | 6 +-- ports/switch/ota-launcher/Makefile | 6 +-- ports/switch/ota-launcher/README.md | 8 +-- scripts/switch/bake_ota_logo.py | 2 +- scripts/switch/build_fused.sh | 4 +- scripts/switch/build_ota_launcher.sh | 4 +- scripts/switch/common.sh | 4 +- scripts/switch/selftest_build_switch.sh | 18 +++---- test/switch-nro-ota.spec.test.js | 68 ++++++++++++------------- 10 files changed, 76 insertions(+), 76 deletions(-) diff --git a/.gitignore b/.gitignore index 862484ca..d68dbada 100644 --- a/.gitignore +++ b/.gitignore @@ -37,22 +37,22 @@ mobile/ios/build/ # Final packaged build artifacts (mac/win/web/android/ios/switch) — see scripts/build.sh /dist/ -# Native Switch OTA launcher build outputs -native/switch-ota-launcher/build/ -native/switch-ota-launcher/build-host/ -native/switch-ota-launcher/*.nro -native/switch-ota-launcher/*.nacp -native/switch-ota-launcher/*.elf -native/switch-ota-launcher/*.map -native/switch-ota-launcher/romfs/logo.rgba -native/switch-ota-launcher/romfs/logo.png -native/switch-ota-launcher/romfs/cacert.pem -native/switch-ota-launcher/romfs/ota-bootstrap.nro -native/switch-ota-bootstrap/build/ -native/switch-ota-bootstrap/*.nro -native/switch-ota-bootstrap/*.nacp -native/switch-ota-bootstrap/*.elf -native/switch-ota-bootstrap/*.map +# Switch OTA launcher build outputs +ports/switch/ota-launcher/build/ +ports/switch/ota-launcher/build-host/ +ports/switch/ota-launcher/*.nro +ports/switch/ota-launcher/*.nacp +ports/switch/ota-launcher/*.elf +ports/switch/ota-launcher/*.map +ports/switch/ota-launcher/romfs/logo.rgba +ports/switch/ota-launcher/romfs/logo.png +ports/switch/ota-launcher/romfs/cacert.pem +ports/switch/ota-launcher/romfs/ota-bootstrap.nro +ports/switch/ota-bootstrap/build/ +ports/switch/ota-bootstrap/*.nro +ports/switch/ota-bootstrap/*.nacp +ports/switch/ota-bootstrap/*.elf +ports/switch/ota-bootstrap/*.map # Legacy manual convenience-copy location (superseded by /dist/android/) mobile/dist/ diff --git a/docs/switch-build.md b/docs/switch-build.md index 9593524c..61f8a574 100644 --- a/docs/switch-build.md +++ b/docs/switch-build.md @@ -41,10 +41,10 @@ Fused game builds can also use Docker when native `nacptool`/`elf2nro` are absen In-console OTA uses a **separate DEVKITPRO NRO** (not LÖVE). The LÖVE self-updater (`Check.lua`) is disabled on NX. Source: -`native/switch-ota-launcher/`. Host protocol tests (no toolchain): +`ports/switch/ota-launcher/`. Host protocol tests (no toolchain): ```sh -make -C native/switch-ota-launcher host-test +make -C ports/switch/ota-launcher host-test # or scripts/switch/build_ota_launcher.sh # host-test first; NRO needs DEVKITPRO/Docker ``` @@ -59,7 +59,7 @@ Release-like build from repo root: scripts/build_switch.sh --fetch --fused --version X.Y.Z ``` -See `native/switch-ota-launcher/README.md` and +See `ports/switch/ota-launcher/README.md` and `scripts/switch/ota_launcher.manifest`. ### Windows (Git Bash / MSYS2 / WSL) diff --git a/ports/switch/ota-launcher/Makefile b/ports/switch/ota-launcher/Makefile index d5545f00..d468c86a 100644 --- a/ports/switch/ota-launcher/Makefile +++ b/ports/switch/ota-launcher/Makefile @@ -45,8 +45,8 @@ APP_AUTHOR := bryanthaboi, port by andrewqsantos APP_VERSION ?= 0.0.0 # Prefer project Switch icon if present -ICON := $(TOPDIR)/../../assets/switch/icon.jpg -LOGO_RGBA_SRC := $(TOPDIR)/assets/logo.rgba +ICON := $(TOPDIR)/../assets/icon.jpg +LOGO_RGBA_SRC := $(TOPDIR)/../assets/logo.rgba LOGO_ROMFS := $(CURDIR)/$(ROMFS)/logo.rgba #--------------------------------------------------------------------------------- @@ -131,7 +131,7 @@ ifneq ($(ROMFS),) export NROFLAGS += --romfsdir=$(CURDIR)/$(ROMFS) endif -BOOTSTRAP_DIR := $(TOPDIR)/../switch-ota-bootstrap +BOOTSTRAP_DIR := $(TOPDIR)/../ota-bootstrap BOOTSTRAP_ROMFS := $(CURDIR)/$(ROMFS)/ota-bootstrap.nro .PHONY: $(BUILD) clean all host-test sync-romfs bootstrap-romfs diff --git a/ports/switch/ota-launcher/README.md b/ports/switch/ota-launcher/README.md index b61d5761..f6865955 100644 --- a/ports/switch/ota-launcher/README.md +++ b/ports/switch/ota-launcher/README.md @@ -11,7 +11,7 @@ with `envSetNextLoad`. The LÖVE self-updater (`src/update/Check.lua`) stays **disabled** on NX. Wire format (also in Lua): `src/update/SwitchOta.lua`. -NACP icon: `assets/switch/icon.jpg`. +NACP icon: `ports/switch/assets/icon.jpg`. ## Layout on microSD @@ -25,7 +25,7 @@ sdmc:/switch/gen1recomp/pokemon-love2d/ <- saves (never touched by OTA) ## Host tests (no DEVKITPRO) ```bash -cd native/switch-ota-launcher +cd ports/switch/ota-launcher make host-test ``` @@ -40,7 +40,7 @@ Needs `DEVKITPRO` with packages roughly: ```bash export DEVKITPRO=/opt/devkitpro # typical -cd native/switch-ota-launcher +cd ports/switch/ota-launcher make # -> gen1recomp.nro ``` @@ -62,7 +62,7 @@ Docker fallback uses the same pin as fused builds (`scripts/switch/dkp-docker.im ## OTA logo asset The launcher draws a pre-scaled logo from `romfs:/logo.rgba` (no PNG decoder in -the NRO). The baked blob lives at `assets/logo.rgba` and is copied into romfs at +the NRO). The baked blob lives at `../assets/logo.rgba` and is copied into romfs at build time. After changing `assets/logo/logo.png`, regenerate: ```bash diff --git a/scripts/switch/bake_ota_logo.py b/scripts/switch/bake_ota_logo.py index 1703730e..bbfc989f 100644 --- a/scripts/switch/bake_ota_logo.py +++ b/scripts/switch/bake_ota_logo.py @@ -23,7 +23,7 @@ from pathlib import Path ROOT = Path(__file__).resolve().parents[2] DEFAULT_SRC = ROOT / "assets/logo/logo.png" -DEFAULT_OUT = ROOT / "native/switch-ota-launcher/assets/logo.rgba" +DEFAULT_OUT = ROOT / "ports/switch/assets/logo.rgba" DEFAULT_MAX_W = 320 DEFAULT_MAX_H = 90 diff --git a/scripts/switch/build_fused.sh b/scripts/switch/build_fused.sh index 26024386..b6dbf5e3 100755 --- a/scripts/switch/build_fused.sh +++ b/scripts/switch/build_fused.sh @@ -15,7 +15,7 @@ SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" LOVE_NX_TAG="11.5-nx1" LOVE_NX_DIR="$ROOT/.bazinga/love-nx/$LOVE_NX_TAG" LOVE_ELF="$LOVE_NX_DIR/love.elf" -ICON="$ROOT/assets/switch/icon.jpg" +ICON="$ROOT/ports/switch/assets/icon.jpg" APP_NAME="gen1recomp" APP_AUTHOR="bryanthaboi, port by andrewqsantos" DKP_IMAGE_FILE="$ROOT/scripts/switch/dkp-docker.image" @@ -93,7 +93,7 @@ run_fused_docker() { set -euo pipefail nacptool --create '$APP_NAME' '$APP_AUTHOR' '$VERSION' /work/control.nacp elf2nro /src/.bazinga/love-nx/$LOVE_NX_TAG/love.elf /out/$out_base \ - --icon=/src/assets/switch/icon.jpg \ + --icon=/src/ports/switch/assets/icon.jpg \ --nacp=/work/control.nacp \ --romfsdir=/work/romfs " diff --git a/scripts/switch/build_ota_launcher.sh b/scripts/switch/build_ota_launcher.sh index c8a8facd..4de830fb 100755 --- a/scripts/switch/build_ota_launcher.sh +++ b/scripts/switch/build_ota_launcher.sh @@ -14,7 +14,7 @@ SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" # shellcheck source=common.sh . "$SCRIPT_DIR/common.sh" -LAUNCHER_DIR="$ROOT/native/switch-ota-launcher" +LAUNCHER_DIR="$ROOT/ports/switch/ota-launcher" OUT_NRO="${1:-$ROOT/dist/switch/gen1recomp-launcher.nro}" APP_VERSION="${2:-${GEN1_LAUNCHER_VERSION:-0.0.0}}" DKP_IMAGE_FILE="$ROOT/scripts/switch/dkp-docker.image" @@ -59,7 +59,7 @@ if command -v docker >/dev/null 2>&1; then say "building launcher NRO via Docker ($image, NACP $APP_VERSION)" if ! docker run --rm \ -v "$ROOT:/work" \ - -w /work/native/switch-ota-launcher \ + -w /work/ports/switch/ota-launcher \ -e "APP_VERSION=$APP_VERSION" \ "$image" \ bash -lc 'pacman -Sy --noconfirm switch-curl switch-mbedtls switch-zlib switch-zziplib >/dev/null 2>&1 || true; make clean; make all APP_VERSION="$APP_VERSION"'; then diff --git a/scripts/switch/common.sh b/scripts/switch/common.sh index b08494dc..eb4cfb15 100644 --- a/scripts/switch/common.sh +++ b/scripts/switch/common.sh @@ -102,7 +102,7 @@ Pick one: Then re-run: scripts/build_switch.sh --fetch --fused -See docs/switch-build.md and native/switch-ota-launcher/README.md. +See docs/switch-build.md and ports/switch/ota-launcher/README.md. EOF )" } @@ -121,7 +121,7 @@ Re-run with a clean tree: If packages look wrong, reinstall: bash scripts/switch/install_devkitpro_deps.sh -See native/switch-ota-launcher/README.md. +See ports/switch/ota-launcher/README.md. EOF )" fi diff --git a/scripts/switch/selftest_build_switch.sh b/scripts/switch/selftest_build_switch.sh index 1f8be38d..99928faf 100755 --- a/scripts/switch/selftest_build_switch.sh +++ b/scripts/switch/selftest_build_switch.sh @@ -395,7 +395,7 @@ if [ -f "$ROOT/scripts/switch/build_ota_launcher.sh" ] \ && grep -q 'ota_launcher_deps_ready' "$ROOT/scripts/switch/build_ota_launcher.sh" \ && grep -q 'fail_missing_devkitpro' "$ROOT/scripts/switch/build_ota_launcher.sh" \ && grep -q 'preflight_fused_build' "$ROOT/scripts/build_switch.sh" \ - && [ -f "$ROOT/native/switch-ota-launcher/Makefile" ] + && [ -f "$ROOT/ports/switch/ota-launcher/Makefile" ] then ok "native OTA launcher sources + build_ota_launcher.sh present" else @@ -415,20 +415,20 @@ else bad "legacy separate OTA-only packer / asset still present" fi -if grep -q 'ota_ui_prompt_update' "$ROOT/native/switch-ota-launcher/src/main.c" \ - && grep -q 'ota_net_init' "$ROOT/native/switch-ota-launcher/src/main.c" \ - && grep -q 'framebufferCreate\|COL_RAIL' "$ROOT/native/switch-ota-launcher/src/ota_ui.c" \ - && grep -q '^ROMFS' "$ROOT/native/switch-ota-launcher/Makefile" \ - && grep -q 'cacert.pem' "$ROOT/native/switch-ota-launcher/Makefile" +if grep -q 'ota_ui_prompt_update' "$ROOT/ports/switch/ota-launcher/src/main.c" \ + && grep -q 'ota_net_init' "$ROOT/ports/switch/ota-launcher/src/main.c" \ + && grep -q 'framebufferCreate\|COL_RAIL' "$ROOT/ports/switch/ota-launcher/src/ota_ui.c" \ + && grep -q '^ROMFS' "$ROOT/ports/switch/ota-launcher/Makefile" \ + && grep -q 'cacert.pem' "$ROOT/ports/switch/ota-launcher/Makefile" then ok "launcher UI uses framebuffer (no prompt when up to date)" else bad "launcher missing branded ota_ui / ROMFS" fi -if [ -f "$ROOT/native/switch-ota-launcher/src/ota_unzip.c" ] \ - && grep -q 'zzip/zzip.h' "$ROOT/native/switch-ota-launcher/src/ota_unzip.c" \ - && grep -q 'ota_unzip_extract_file' "$ROOT/native/switch-ota-launcher/src/main.c" +if [ -f "$ROOT/ports/switch/ota-launcher/src/ota_unzip.c" ] \ + && grep -q 'zzip/zzip.h' "$ROOT/ports/switch/ota-launcher/src/ota_unzip.c" \ + && grep -q 'ota_unzip_extract_file' "$ROOT/ports/switch/ota-launcher/src/main.c" then ok "launcher wires zziplib ota_unzip_extract_file" else diff --git a/test/switch-nro-ota.spec.test.js b/test/switch-nro-ota.spec.test.js index 6d25f97d..7d64934b 100644 --- a/test/switch-nro-ota.spec.test.js +++ b/test/switch-nro-ota.spec.test.js @@ -457,8 +457,8 @@ test('AC-008: Gates de regressão anti-“erro invisível” @spec:AC-008', () = }); test('AC-009: Protocolo C host-testável espelha SwitchOta.lua @spec:AC-009', () => { - const proto = read('native/switch-ota-launcher/src/ota_protocol.c'); - const header = read('native/switch-ota-launcher/include/ota_protocol.h'); + const proto = read('ports/switch/ota-launcher/src/ota_protocol.c'); + const header = read('ports/switch/ota-launcher/include/ota_protocol.h'); assert.match(header, /OTA_CHECK_TIMEOUT_SEC\s+6/); assert.match(header, /ota_compare_semver/); assert.match(header, /ota_parse_release/); @@ -476,7 +476,7 @@ test('AC-009: Protocolo C host-testável espelha SwitchOta.lua @spec:AC-009', () // Compile + run C host tests (gcc) const r = spawnSync( 'make', - ['-C', path.join(root, 'native/switch-ota-launcher'), 'host-test'], + ['-C', path.join(root, 'ports/switch/ota-launcher'), 'host-test'], { encoding: 'utf8' } ); assert.equal(r.status, 0, `host-test failed:\n${r.stdout}\n${r.stderr}`); @@ -485,17 +485,17 @@ test('AC-009: Protocolo C host-testável espelha SwitchOta.lua @spec:AC-009', () test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () => { for (const rel of [ - 'native/switch-ota-launcher/Makefile', - 'native/switch-ota-launcher/README.md', - 'native/switch-ota-launcher/src/main.c', - 'native/switch-ota-launcher/src/ota_net.c', - 'native/switch-ota-launcher/src/ota_fs.c', + 'ports/switch/ota-launcher/Makefile', + 'ports/switch/ota-launcher/README.md', + 'ports/switch/ota-launcher/src/main.c', + 'ports/switch/ota-launcher/src/ota_net.c', + 'ports/switch/ota-launcher/src/ota_fs.c', 'scripts/switch/build_ota_launcher.sh', 'docs/switch-build.md', ]) { assert.ok(fs.existsSync(path.join(root, rel)), `missing ${rel}`); } - const main = read('native/switch-ota-launcher/src/main.c'); + const main = read('ports/switch/ota-launcher/src/main.c'); assert.match(main, /envSetNextLoad|ota_fs_handoff_to_game/); assert.match(main, /gen1recomp-game\.nro|OTA_GAME_NRO_NAME/); assert.match(main, /Quiet by default|stays quiet|LÖVE self-updater stays off|self-updater stays off/i); @@ -505,13 +505,13 @@ test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () = assert.doesNotMatch(main, /\u2026/, 'OTA UI strings must be ASCII (no Unicode ellipsis)'); assert.doesNotMatch(main, /ota_ui_alert\([^)]*Install failed/, 'generic install alert removed'); assert.doesNotMatch(main, /consoleInit/, 'no terminal console UI'); - assert.ok(fs.existsSync(path.join(root, 'native/switch-ota-launcher/src/ota_ui.c'))); - const otaUi = read('native/switch-ota-launcher/src/ota_ui.c'); + assert.ok(fs.existsSync(path.join(root, 'ports/switch/ota-launcher/src/ota_ui.c'))); + const otaUi = read('ports/switch/ota-launcher/src/ota_ui.c'); assert.match(otaUi, /COL_RAIL_R|rail|FFD600|255,\s*214/); assert.match(otaUi, /logo\.rgba/); assert.doesNotMatch(otaUi, /stb_image/); assert.ok( - fs.existsSync(path.join(root, 'native/switch-ota-launcher/assets/logo.rgba')), + fs.existsSync(path.join(root, 'ports/switch/assets/logo.rgba')), 'pre-baked OTA logo asset' ); assert.ok( @@ -521,44 +521,44 @@ test('AC-010: Fonte do launcher e Makefile DEVKITPRO existem @spec:AC-010', () = assert.match(otaUi, /ota_ui_sanitize_ascii/); assert.match(otaUi, /draw_text_wrapped_centered/); assert.match(otaUi, /ota_ui_alert_error/); - assert.match(read('native/switch-ota-launcher/src/ota_net.c'), /ota_net_init/); - assert.match(read('native/switch-ota-launcher/src/main.c'), /ota_net_init/); - assert.match(read('native/switch-ota-launcher/src/ota_net.c'), /CURLOPT_SSL_VERIFYPEER,\s*1L/); - assert.match(read('native/switch-ota-launcher/src/ota_net.c'), /romfs:\/cacert\.pem/); - assert.doesNotMatch(read('native/switch-ota-launcher/src/ota_net.c'), /CURLOPT_SSL_VERIFYPEER,\s*0L/); - assert.match(read('native/switch-ota-launcher/Makefile'), /^ROMFS\s*:=/m); - assert.match(read('native/switch-ota-launcher/Makefile'), /cacert\.pem/); - assert.match(read('native/switch-ota-launcher/Makefile'), /logo\.rgba/); + assert.match(read('ports/switch/ota-launcher/src/ota_net.c'), /ota_net_init/); + assert.match(read('ports/switch/ota-launcher/src/main.c'), /ota_net_init/); + assert.match(read('ports/switch/ota-launcher/src/ota_net.c'), /CURLOPT_SSL_VERIFYPEER,\s*1L/); + assert.match(read('ports/switch/ota-launcher/src/ota_net.c'), /romfs:\/cacert\.pem/); + assert.doesNotMatch(read('ports/switch/ota-launcher/src/ota_net.c'), /CURLOPT_SSL_VERIFYPEER,\s*0L/); + assert.match(read('ports/switch/ota-launcher/Makefile'), /^ROMFS\s*:=/m); + assert.match(read('ports/switch/ota-launcher/Makefile'), /cacert\.pem/); + assert.match(read('ports/switch/ota-launcher/Makefile'), /logo\.rgba/); - const mk = read('native/switch-ota-launcher/Makefile'); + const mk = read('ports/switch/ota-launcher/Makefile'); assert.match(mk, /libnx\/switch_rules|DEVKITPRO/); assert.match(mk, /-lcurl/); assert.match(mk, /-lzzip/); - assert.match(mk, /assets\/switch\/icon\.jpg/, 'uses project Switch icon'); + assert.match(mk, /ports\/switch\/assets\/icon\.jpg|assets\/icon\.jpg/, 'uses project Switch icon'); - assert.ok(fs.existsSync(path.join(root, 'native/switch-ota-launcher/src/ota_unzip.c'))); - assert.match(read('native/switch-ota-launcher/src/ota_unzip.c'), /zzip\/zzip\.h/); - assert.match(read('native/switch-ota-launcher/src/main.c'), /ota_unzip_extract_file/); - assert.match(read('native/switch-ota-launcher/src/main.c'), /GAME_MEMBER_IN_ZIP|switch\/gen1recomp\//); - assert.match(read('native/switch-ota-launcher/src/main.c'), /LAUNCHER_MEMBER_IN_ZIP|ota_fs_stage_launcher_bootstrap/); - assert.match(read('native/switch-ota-launcher/src/main.c'), /ota_fs_stage_launcher_bootstrap\([\s\S]*\) != 0/); - assert.match(read('native/switch-ota-launcher/src/main.c'), /return 2.*bootstrap|bootstrap.*return 2/i); - assert.match(read('native/switch-ota-launcher/src/ota_fs.c'), /ota_fs_atomic_replace_nro/); - assert.match(read('native/switch-ota-launcher/src/ota_fs.c'), /remove\(dest\)/); - assert.doesNotMatch(read('native/switch-ota-launcher/src/ota_fs.c'), /#ifdef _WIN32[\s\S]*remove\(dest\)/); + assert.ok(fs.existsSync(path.join(root, 'ports/switch/ota-launcher/src/ota_unzip.c'))); + assert.match(read('ports/switch/ota-launcher/src/ota_unzip.c'), /zzip\/zzip\.h/); + assert.match(read('ports/switch/ota-launcher/src/main.c'), /ota_unzip_extract_file/); + assert.match(read('ports/switch/ota-launcher/src/main.c'), /GAME_MEMBER_IN_ZIP|switch\/gen1recomp\//); + assert.match(read('ports/switch/ota-launcher/src/main.c'), /LAUNCHER_MEMBER_IN_ZIP|ota_fs_stage_launcher_bootstrap/); + assert.match(read('ports/switch/ota-launcher/src/main.c'), /ota_fs_stage_launcher_bootstrap\([\s\S]*\) != 0/); + assert.match(read('ports/switch/ota-launcher/src/main.c'), /return 2.*bootstrap|bootstrap.*return 2/i); + assert.match(read('ports/switch/ota-launcher/src/ota_fs.c'), /ota_fs_atomic_replace_nro/); + assert.match(read('ports/switch/ota-launcher/src/ota_fs.c'), /remove\(dest\)/); + assert.doesNotMatch(read('ports/switch/ota-launcher/src/ota_fs.c'), /#ifdef _WIN32[\s\S]*remove\(dest\)/); assert.doesNotMatch(read('scripts/switch/install_devkitpro_deps.sh'), /switch-minizip/); assert.match(read('scripts/switch/install_devkitpro_deps.sh'), /switch-zziplib/); assert.match(read('scripts/switch/install_devkitpro_deps.sh'), /switch-dev/); const buildDoc = read('docs/switch-build.md'); - assert.match(buildDoc, /native\/switch-ota-launcher|build_ota_launcher/); + assert.match(buildDoc, /ports\/switch\/ota-launcher|build_ota_launcher/); assert.match(buildDoc, /native packages.*or.*Docker|native or Docker/i); assert.match(buildDoc, /--fused|install_devkitpro_deps/); assert.match(buildDoc, /Requires DEVKITPRO|DEVKITPRO is[\s\S]*required/i); assert.doesNotMatch(buildDoc, /switch-ota\.zip/); assert.doesNotMatch(buildDoc, /--ota\b/); - const readme = read('native/switch-ota-launcher/README.md'); + const readme = read('ports/switch/ota-launcher/README.md'); assert.match(readme, /DEVKITPRO|devkitPro/i); assert.match(readme, /Docker|devkita64/i); assert.match(readme, /Quiet|quiet|silen/i); From 52d1ddc5af49f93de2d0ba8de284867490693b8a Mon Sep 17 00:00:00 2001 From: Andrew Quenehen Date: Thu, 6 Aug 2026 10:29:43 -0300 Subject: [PATCH 18/18] Fix Switch OTA clean and NX version chip test after launcher layout changes. --- ports/switch/ota-launcher/Makefile | 1 + tests/engine/launcher_nx_version_chip_test.lua | 8 +++++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/ports/switch/ota-launcher/Makefile b/ports/switch/ota-launcher/Makefile index d468c86a..2f2c710d 100644 --- a/ports/switch/ota-launcher/Makefile +++ b/ports/switch/ota-launcher/Makefile @@ -162,6 +162,7 @@ $(BUILD): sync-romfs #--------------------------------------------------------------------------------- clean: @echo clean ... + @$(MAKE) --no-print-directory -C $(BOOTSTRAP_DIR) clean || true @rm -fr $(BUILD) $(TARGET).nro $(TARGET).nacp $(TARGET).elf $(TARGET).lst build-host @rm -f $(CURDIR)/$(ROMFS)/logo.rgba $(CURDIR)/$(ROMFS)/logo.png diff --git a/tests/engine/launcher_nx_version_chip_test.lua b/tests/engine/launcher_nx_version_chip_test.lua index 2a76e57e..9fefbb1b 100644 --- a/tests/engine/launcher_nx_version_chip_test.lua +++ b/tests/engine/launcher_nx_version_chip_test.lua @@ -16,9 +16,11 @@ assert(src:find('local Version = require%("src%.core%.Version"%)') assert(src:find("imp%.isNX", 1, false), "version chip must gate on isNX") --- The chip is inside an isNX block and prints Version.engine -local nxBlock = src:match("if imp%.isNX then(.-)end\n\n %-%- Settings gear") -assert(nxBlock, "expected Switch-only version chip before the settings gear") +-- The chip is inside an isNX block and prints Version.engine (layout between +-- the chip and the settings gear may change; anchor on the Switch-only comment). +local nxBlock = src:match( + "Switch%-only: show the running app version.-if imp%.isNX then(.-)end") +assert(nxBlock, "expected Switch-only version chip in the header row") assert(nxBlock:find("Version%.engine", 1, false), "chip must show Version.engine") assert(nxBlock:find('"v"', 1, true) or nxBlock:find('"v" %.%.', 1, false), "chip label should be a v-prefixed version")