imgtune 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,351 @@
-# Temporary Holding Version
+# ImgTune
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![npm version](https://img.shields.io/npm/v/imgtune.svg)](https://www.npmjs.com/package/imgtune)
+
+**ImgTune measures image waste on any live site.**
+
+Website: https://indicozy.github.io/imgtune/ · [Try the demo](https://indicozy.github.io/imgtune/demo) · [Docs](https://indicozy.github.io/imgtune/guide/getting-started)
+
+Lighthouse tells you your images are too big. ImgTune tells you the `sizes`, quality and format to set for each image,
+points at the line of code that renders it (when your dev server is running), and checks each quality target with
+SSIMULACRA2. Your coding agent applies the change, and a rescan checks it.
+
+**Works with your image CDN.** Cloudinary, imgix and `next/image` resize to whatever width `sizes` asks for, so a wrong
+`sizes` is waste that no CDN removes. ImgTune works on top of a CDN, not instead of one. Already on Cloudinary auto
+quality (`q_auto`)? ImgTune focuses on `sizes`, which no CDN can fix for you. A format the CDN picks per request
+(Cloudinary `f_auto`, imgix `auto=format`) is not proposed as a change.
+
+**Built for image-heavy sites:** e-commerce catalogs, media, marketplaces.
+
+## Two ways to measure
+
+- **`npx imgtune check https://your-site`** measures any live site, in a browser, with no source. It reads the site's
+  sitemap, groups the URLs into route types (templates such as product or listing pages), deep-scans the heaviest page of
+  each type at six viewports, and writes a Markdown report, `report.md`.
+- **`npx imgtune audit --app . --prod http://localhost:3000 --dev http://localhost:3001`** is the deep mode for your own
+  Next.js app. It reads the route files and `next.config`, measures the production build, and with `--dev` locates each
+  fix at its `file:line` in the source.
+
+Each page's report shows one line above its numbers for its LCP image (the largest contentful paint element, when it is an
+image). Where `next.config` lists several `images.qualities`, ImgTune clusters them into at most
+`--max-qualities` values (default 2), and each target is raised to the nearest value kept, so the SSIMULACRA2 bar still holds.
+
+## Install
+
+```sh
+npm i -D imgtune
+```
+
+Then run it with `npx imgtune`. Without installing, `npx imgtune` fetches it for one run. ImgTune needs Chromium for
+Playwright; see [Requirements](#requirements).
+
+## Quick start
+
+Measure a live site, with no access to its source:
+
+```sh
+npx imgtune scan https://your-site.example/
+```
+
+The scan writes one JSON file per page to `.imgtune/scan/`, for example `.imgtune/scan/your-site.example-index.json`, and
+prints a count of the images with fix hints. Read the hints in batches of ten:
+
+```sh
+npx imgtune hints .imgtune/scan/your-site.example-index.json
+```
+
+Each hint names the image, its component and `file:line` when they resolve, the `sizes` and quality to use, and the bytes
+the fix saves per view, with the bytes it adds for sharpness shown separately. Run `npx imgtune --help`, or
+`npx imgtune scan --help` for every option.
+
+For the whole site in one report, run `npx imgtune check https://your-site.example/` instead. It writes `report.md` to
+`.imgtune/check/`, and `imgtune summary` prints its one-screen summary.
+
+## Why one lever is not enough
+
+It looks at three levers for each image: **resolution** (the pixels the browser actually needs), **quality** (the
+encoder setting), and **format** (for example AVIF or WebP instead of JPEG). Measurements are per page view, per
+viewport, and quality is scored with SSIMULACRA2.
+
+- **Compressors** squeeze the file you hand them, but never learn how wide it is shown. A 6,000 px logo in a 150 px
+  slot stays 6,000 px, only better compressed.
+- **Image CDNs and `next/image`** resize on request, but only to the widths your `sizes` attribute asks for. A wrong or
+  missing `sizes` makes every phone fetch a file several times too wide.
+- **Lighthouse** flags oversized, poorly encoded and old-format images, at one viewport per run, with a fixed estimate.
+  It tells you something is wrong, not which `sizes` or quality to set.
+- **ImgTune** measures size, quality and format together, per image, on the live page at six viewports, accepts a
+  saving only when SSIMULACRA2 says nobody can see it.
+
+## Fix it with your agent
+
+ImgTune measures; it does not edit your project. The agent skill does the editing: it scans, matches each hint to the
+source, fixes it, verifies with a rescan, and reports from a ledger it keeps in the project.
+
+- **Claude Code**: copy the skill folder into your project. From the project root:
+
+  ```sh
+  mkdir -p .claude/skills && cp -r node_modules/imgtune/skills/imgtune .claude/skills/
+  ```
+
+  Then ask Claude Code to optimise the images of the site. The skill is `.claude/skills/imgtune/SKILL.md`, with a
+  `reference.md` beside it.
+- **Cursor, Codex, Copilot, and other agents**: paste `node_modules/imgtune/skills/imgtune/AGENTS.snippet.md` into your
+  `AGENTS.md` or `CLAUDE.md`. It is the short form of the same loop and rules, and points to `npx imgtune --help`.
+
+The skill works in batches of about ten hints, starting with the LCP image, and writes `.imgtune/ledger.jsonl` (one line
+per image usage). When its context fills, it writes `.imgtune/HANDOFF.md`, so a new session can resume. Use a built or
+preview server for the before and after numbers, and the dev server for the edit loop: source locations only resolve in
+dev builds, or in a built page that ships source maps.
+
+## What `scan` measures
+
+`scan` loads each page in headless Chromium at six viewports (four phones, a 1440 px desktop at 2x, and a 1280 px
+desktop at 1x), scrolls it to the end, and records every image.
+
+- **Exact** savings come from the site's own smaller `srcset` candidates. Each one is fetched and measured, so the
+  number is the real byte difference.
+- **Estimated** savings come from a local re-encode of the image: a different quality, a different format, or a resize of
+  a plain `<img>`. They are estimates.
+- The CLI prints `exact` and `exact + est.`. The `exact + est.` figure is the estimated saving: the exact part plus the
+  estimate.
+- Quality is judged with SSIMULACRA2 at a delta of 2 points. `--aggressive` adds a delta 4 column, which is reported
+  beside the main numbers and never used for the headline.
+- Undersized images (a file smaller than the slot it fills) are reported as sharpness growth, separately. Growth from
+  undersized images is never subtracted from other images' savings, and an undersized image itself contributes no
+  saving.
+- For each image, the scan records its locator (the component and `file:line` in dev builds, `data-testid`, `alt`, and the
+  loader URL pattern), the `sizes` the browser resolved at each viewport, the layout chain above it, and a fix hint with
+  two numbers: bytes saved, and bytes added for sharpness. The two are never netted.
+- Pages are scanned after their `robots.txt` is checked for the `*` user agent. A disallowed page is skipped and
+  recorded as `robots`. Pages that return a challenge or bot wall are recorded as `blocked` and not retried. The
+  scanner identifies itself with the default Chromium user agent, uses no stealth plugins, and fetches each image URL
+  at most once per scan.
+- Besides the page itself, scan fetches the page's own srcset candidates and, for quality estimates, the original of a
+  sampled image (derived from the loader URL), each at most once per scan. It never requests new transformations from
+  the CDN.
+- Large sites: `--urls-from` reads a URL list or a sitemap, `--sample-per-pattern` samples each route type, and
+  `--resume`, `--max-pages` and `--max-images` split a long run into parts. `--survey` is a fast pass over every URL
+  (two viewports, exact savings only, labelled as such); full-scan the heaviest page of each route type after it.
+- Production check: `imgtune check` (see [Two ways to measure](#two-ways-to-measure)) and `imgtune audit` do the same
+  survey and deep scan for a whole site, with no source needed for `check`.
+
+## The evidence ladder
+
+Every fix hint is labelled with the strength of its evidence, the rung it stands on:
+
+1. **measured-page** (exact): the usage was measured on the live page, at each viewport. This is what `scan` produces.
+2. **measured-harness**: the usage was measured in isolation, through a temporary route such as `/__imgtune/<component>`
+   that renders each state, or through Storybook. The agent removes the route afterwards.
+3. **ceiling-code**: derived from the resolved classes and the layout constraints (container width, grid columns,
+   padding). It is an upper bound on the width needed, never a measured saving.
+4. **not-measured**: no number, with the reason (hidden, behind a login, not rendered at scan time).
+
+A ceiling is never derived from the existing `sizes` value. When a usage is measured, its `sizes` comes from the layout
+the browser resolved, not from a guess.
+
+## GIFs and video
+
+`scan` also measures animated media: animated GIFs in an `<img>` or a CSS background, animated WebP and APNG, and
+self-hosted `<video>` elements with a plain file source. Static GIFs get the normal image hints.
+
+- **Out of scope, not reported:** adaptive streams (HLS, DASH, Mux, Cloudflare Stream) and third-party iframes (YouTube,
+  Vimeo). A video hosted on another site follows the third-party rules (`--block-third-party`, `--allow-host`).
+- **ffmpeg** is used from `PATH`; ImgTune does not bundle it. Without it, `scan` still reports each animated image's and
+  video's bytes and the width it needs, and prints one note: `install ffmpeg for verified video and GIF hints`. The encodes,
+  and so the fix hints with a size, need it.
+- **Encodes run on the CPU by default.** `--gpu-encode` is **experimental**: it moves the sample encodes to the GPU (NVENC
+  `av1_nvenc` / `h264_nvenc`, preset p4, constant quality in VBR; `libvmaf_cuda` for the VMAF). It uses the `--gpu-device`
+  list, else GPU 0, in workers beside the CPU ones. Each GPU is proven by a tiny test encode first; a width under 144 px or
+  an NVENC failure is encoded on the CPU for that candidate. NVENC is larger at equal quality, so its bytes are reported as
+  NVENC bytes ÷ 1.4, labelled `est. (GPU-encoded, scaled to a CPU encode ÷1.4)`. In our measurements `--gpu-encode` was
+  slower than the CPU (per-process CUDA start-up); see the report before using it. `--gpu` and `--gpu-device` only pick the
+  SSIMULACRA2 GPU scorer (the first device) unless `--gpu-encode` is given. The hint's recipe is the CPU one (`libsvtav1` / `libx264`), and an NVENC
+  quality is marked `approx.` (CRF = cq).
+- **Hints.** A large animated GIF gets `<video autoplay muted loop playsinline>` with AV1 first and an H.264 fallback, and
+  the animated-image alternative with its size. A small `<img>` GIF or a CSS background gets an animated AVIF or WebP. A
+  `<video>` hint names each lever: the width per breakpoint (`<source media>`), the CRF, the codec, the audio track of a
+  muted video, and `preload`. A poster is audited as an image. Duration and frame rate are informational only.
+- **Bytes: per view and per play.** Per view is what the first view fetches. An autoplay video counts its full file,
+  `preload="auto"` counts the bytes the scan saw (browser-dependent), and `preload="metadata"` or `"none"` counts 0. Per
+  play is the full file. Both are shown for every video, so a large click-to-play file is not missed. Animated images stay
+  in the image totals; `<video>` has its own Video section, and posters count as images.
+- **Estimates come from 2 s samples.** One sample for a video of up to 6 s, three for a longer one. The full-file bytes
+  are extrapolated from the samples and labelled as an estimate; nothing is encoded in full.
+- **Quality bars.** VMAF must reach `--video-bar` (default 93) against the served file at its display size. A still-frame
+  guard (SSIMULACRA2 on the stillest frames) catches blurred text in screen recordings and must reach `--video-still-bar`
+  (default 65), lowered to at most 10 points below the best the codec reaches on that content, and never below 20. The
+  relative bar catches the loss the encode adds, not what the format can never reproduce, such as GIF dither.
+- **Budget and widths.** Encodes run on the heaviest animated assets first, at most `--media-budget` per run (default 20)
+  and within `--media-time` seconds (default 600). Assets over the budget keep their cheap hints and are marked "over
+  --media-budget". A video is served at most `--max-video-widths` widths (default 2): each viewport gets the smallest
+  kept width that covers its display width times its device pixel ratio. `audit` reports the bytes at one, two and three
+  widths instead, and the agent chooses. `--no-quality` and `--survey` make no encodes.
+- **Check an agent's output** with `imgtune image <candidate> --reference <original>`: the same VMAF and still-frame bar,
+  exit 0 on pass and 1 on fail (see the table below).
+
+## Commands
+
+| command | what it does |
+| --- | --- |
+| `imgtune check <origin \| sitemap-url \| page-url>` | the production check, in a browser only: surveys the URLs, deep-scans the heaviest page of each route type, writes `report.md` and `run.json` to `--out` (default `.imgtune/check/<timestamp>`); `--urls-from <file\|sitemap>` instead of the URL; `--sample-per-pattern` (default 3), `--deep` (default 20), `--route-map` |
+| `imgtune audit --app <dir> --prod <origin> [--dev <origin>]` | the deep mode for a Next.js app: the check, plus the route files and `images.qualities` from `next.config`; with `--dev`, the `file:line` of each located fix; `--urls-from <file\|sitemap>`, `--max-locales` (default 3, how many values of a dynamic first segment the crawl expands) |
+| `imgtune run <url> [<url> ...] \| --urls-from <file\|sitemap>` | the whole flow in one command: survey, deep scan, locate (`--dev`), hints, and one run directory with a summary |
+| `imgtune scan <url> [<url> ...]` | measures live pages, one JSON file per page in `--out` (default `.imgtune/scan`); `--urls-from`, `--max-qualities <N>` (1 to 4, default 2) |
+| `imgtune hints <scan.json>` | prints a batch of fix hints: `--limit` (default 10), `--offset`, `--page`, `--component`, `--min-kb`, `--top`, `--flat`, `--qualities`, `--max-qualities`, `--format json` |
+| `imgtune summary <run dir \| scan.json ...>` | the one-screen summary of a run directory (`run.json`) or of scan files |
+| `imgtune scan --recheck <scan.json> [--ids a,b,c]` | rescans only the named images at the viewports where they rendered; prints before and after; exits 1 on a failed check |
+| `imgtune image <file\|url\|glob>` | measures image files without a page: bytes now, the lowest quality per format that meets the bar, and at a `--width` the bytes at each needed width; `--min-score` sets the bar (default 90), `--write <dir>` writes optimised copies |
+| `imgtune image <animated.gif\|.webp\|.png\|video> --reference <original>` | checks a re-encoded video or animated file against the original: `VMAF … still p10 …: pass\|fail` with exit 0 or 1; `--video-bar` (default 93) and `--video-still-bar` (default 65) set the bars; without `--reference` an animated file gets its candidates (needs ffmpeg) |
+| `imgtune compare <before.json> <after.json>` | compares two scans of one page image by image: the bytes saved and the sharpness bytes added, as two numbers; drift (a changed layout, server variance, a view not loaded) is excluded and its totals printed; `--format json`, `--limit` |
+| `imgtune report` | a Markdown run report from the agent's ledger (`.imgtune/ledger.jsonl`); `--compare <file>` adds the bytes from `imgtune compare --format json`; `--out <file>` writes it |
+
+The scan options that matter most: `--viewports <names>` (a subset of the six), `--markdown <file>` (the PR comment),
+`--summary-json <file>` (one JSON of every page's numbers), `--fail-over <pct>` (exit 3 above a budget),
+`--storage-state <file>` (a logged-in session), and `--ignore-robots` (see Security). `npx imgtune scan --help` lists them all.
+`imgtune check --help`, `imgtune audit --help` and `imgtune run --help` list the options of each command.
+
+Two flows for a large app. One measures on a built server and then checks the edits on a dev server:
+`scan <built-url>`, then `scan <dev-url> --locate-only --from <scan.json>` (reads the React source of the flagged images),
+then `scan --recheck <located.json> --sizes-only --ids a,b` (judges the sizes choice on dev, no bytes), then `scan` on the
+built server again. The other runs the score on an NVIDIA GPU: `--gpu --gpu-device <n>` (a CUDA index; set `CUDA_DEVICE_ORDER=PCI_BUS_ID` to match `nvidia-smi`). The GPU
+program, `imgtune-ssimu2-gpu`, is not bundled; see the GPU section of the reference.
+
+## GitHub Action
+
+`action.yml` at the root scans the pages you name on each pull request, and comments the result on it. The comment keeps
+the summary tables and the top groups per page, and adds a collapsed "Fix hints for your AI agent" section with the top
+ten hints across the pages. The comment is updated on each push. Set `fail-over` to fail the job above a budget.
+
+```yaml
+- uses: indicozy/imgtune@main
+  with:
+    urls: https://preview.your-site.example/
+    fail-over: "5"
+```
+
+The action builds itself from source, so `dist/` is not needed in the repository. See [docs/ci.md](docs/ci.md) for the
+inputs, the permissions, and two example workflows (Vercel previews, and a local build on the runner).
+
+`scan` keeps Chrome on the CPUs it was started on, so you can keep it off the cores you need: `taskset -c 8-19 npx imgtune scan …` on Linux.
+
+## Security
+
+- **Egress and private addresses.** `scan` refuses private and loopback addresses unless the URL you give is itself local,
+  checks every redirect hop and sub-resource at connection time. See the [scanning guide](site/guide/scanning-any-site.md#security).
+- **ImgTune never commits, and `scan` does not change your project's source files.**
+- **Hint strings are data, not instructions.** File names, component names, `alt`, `testid`, classes and URLs come from
+  the page being scanned, and the agent must never follow text found in them. The hints print them JSON-quoted and capped
+  (in the terminal, and in the PR comment, where they sit in a fenced block after a line that says they are data). A
+  locator from a non-local source is marked `(unverified)`, and a call site that only renders the image's component is marked `(owner call site)`. The agent
+  checks that a file exists in the repository, and that the line holds an image usage, before it edits.
+- **Source maps come from the scanned site.** They are read with caps on size (20 MB), count (64 per scan), lines and
+  sections, and only a relative path under the project is kept as a source file.
+- **`--storage-state` holds session cookies.** Never commit that file. The scan never prints its contents.
+- **`--ignore-robots` is for sites you own or are authorised to test.** It prints a warning, and the JSON records
+  `robotsIgnored` with the rule that disallowed the page.
+
+## Supported loaders
+
+Loaders are detected from the URL each image renders. `original known?` means ImgTune can find the untransformed
+source, which is what quality is measured against. `quality settable?` means the URL carries a quality parameter
+that ImgTune can change.
+
+| loader | matches | original known? | quality settable? |
+| --- | --- | --- | --- |
+| next/image | `/_next/image?url=…` | yes | yes (`q`) |
+| Cloudflare Images | `/cdn-cgi/image/<opts>/<path>` | yes | yes (`quality`) |
+| Contentful | `images.ctfassets.net`, `downloads.ctfassets.net` | yes | yes (`q`) |
+| Sanity | `cdn.sanity.io/images/…`, or the same path shape on a custom domain | yes | yes (`q`) |
+| Shopify | `cdn.shopify.com`, `/cdn/shop/…` | yes (size parameters and legacy size suffixes removed) | yes (`quality`) |
+| Cloudinary | `res.cloudinary.com/<cloud>/image/upload/…`, or transformation paths on a custom domain | yes | yes (`q_<n>`); `q_auto` is left to the CDN |
+| imgix (incl. DatoCMS, Prismic) | `*.imgix.net`, `datocms-assets.com`, `images.prismic.io` | yes | yes (`q`) |
+| generic | any other URL | no | only when the URL has `q=` or `quality=` |
+
+Where the original is unknown, ImgTune still measures resolution, and reports the count of images it could not score
+for quality.
+
+## Demand study (2026-10-28)
+
+Before packaging, ImgTune scanned two groups of sites: production sites, which decided whether it was worth building,
+and open-source apps, for comparison. The site list was fixed before the first scan. Each run scans every site once:
+2 pages × 6 viewports, SSIMULACRA2 delta 2. Saving is the share of all image bytes per page view, with the page fully
+scrolled, averaged over viewports and then over the two pages. When the tool changed, every site was scanned again
+with the same version; v1 is the first run, v4 the current tool (loader adapters and the fixes found since).
+
+The `exact + est.` columns are the estimated saving: the exact saving plus the local re-encode estimate.
+
+### Production sites (decide)
+
+| site | image KB / view | exact | exact + est. (v4) | exact + est. (v1) |
+| --- | --- | --- | --- | --- |
+| A1 fashion retail, UK | 3,250 | 0.0% | 33.2% | 33.0% |
+| A2 home audio, DK | 1,263 | 5.7% | 53.1% | 47.8% |
+| A3 home audio, US | 3,355 | 13.1% | 38.2% | 13.1% |
+| A4 sportswear, UK | 9,254 | 26.8% | 35.9% | 26.8% |
+| A5 home/rugs, US | 7,714 | 12.7% | 16.5% | 12.7% |
+| A6 outdoor stays, US | 9,078 | 20.7% | 27.7% | 20.8% |
+
+Sharpness growth: about 2 KB per view on A4, 0 elsewhere.
+
+Kill criterion: a pass needs at least 2 of 6 sites above 15%.
+
+- exact only: 2 of 6 (v1 and v4), a pass at the bar
+- exact + est.: 6 of 6 in v4 (4 of 6 in v1), a pass
+
+### Open-source apps (do not decide)
+
+| site | image KB / view | exact | exact + est. | of fixable |
+| --- | --- | --- | --- | --- |
+| tailwindcss.com | 4,508 | 0.0% | 4.2% | 9.6% |
+| ui.shadcn.com | 238 | 0.0% | 33.7% | 42.0% |
+| supabase.com | 671 | 1.9% | 20.8% | 48.0% |
+| nextjs.org | 162 | 9.1% | 19.2% | 21.4% |
+| turborepo.com | 77 | 12.0% | 21.4% | 21.4% |
+| langfuse.com | 3,149 | 0.2% | 1.8% | 21.7% |
+| docs.sentry.io | 85 | 0.0% | 0.0% | 0.0% |
+| www.openstatus.dev | 152 | 0.0% | 4.2% | 31.7% |
+
+v4: 4 of 8 above 15% (exact + est.), 0 of 8 on exact alone. Developer sites carry few image bytes; the waste sits in
+image-heavy commerce.
+
+### Limits
+
+- **Six deciders.** A signal, not proof; the sample is biased to sites without bot walls.
+- **Exact is measured, est. is estimated.** On measured savings alone, 2 of 6 pass. The est. part
+  is a local re-encode scored with SSIMULACRA2 against the original; it is a floor where images could not be scored
+  (counted per page in the JSON as `qualityNA`, e.g. images that appear only at viewports where no sample was scored).
+- **Plain `<img>` resize** (A1, A2): local resize at the quality that matches the served bytes, so it doesn't add a
+  hidden quality saving.
+- A3's jump from v1 to v4 comes from Sanity images on a custom domain served at `q=100`, which v1 could not score.
+- tailwindcss.com/blog rendered no `<img>` at scan time (0 images); counted as 0%.
+
+## Requirements
+
+- Node.js 20.9 or later.
+- Chromium for Playwright. Install it once with `npx playwright install chromium`. If it is missing, ImgTune prints
+  that command and exits with status 2.
+- GPU scoring is optional. `--gpu` runs SSIMULACRA2 on an NVIDIA GPU through `imgtune-ssimu2-gpu`, an external program
+  that is not bundled with the package. If it is missing or fails, the run prints a warning and scores on the CPU.
+
+## Limitations
+
+- **Only `<img>`, `srcset`, `<picture>` and CSS background images are measured.** Background layers are kept in their own
+  records (`kind: css-background`), and the headline numbers stay `<img>`-only. Their fixes are `not-measured`, or a
+  `ceiling-code` from the layout.
+- **Source locations need dev builds.** A production build has no component names or `file:line` in its scan. A built
+  page that ships source maps gives the owner component's definition (`via: prod-sourcemap`, never verified as the image's
+  own line). The agent matches the other hints by `find` clues, `alt`, `testid` and the loader URL, and marks the
+  unmatched usages.
+- **Savings are measured on the pages and viewports scanned.** A usage that does not render on them (a hidden tab, a
+  modal, a logged-out view) is not measured. A lazy image that never loads is counted as not loaded.
+- **Est. numbers are estimates.** They come from a local re-encode judged by SSIMULACRA2. Quality is `qualityNA` where the
+  original cannot be found. Only exact numbers come from the site's own candidates.
+- **Bot walls and challenges stop a scan.** A page that returns one is recorded as `blocked`, and is not retried.
+- **Quality targets follow the loader.** Only the loaders in the table below expose a quality parameter, so only they get
+  quality proposals.
+- **ImgTune does not edit code.** The fixes are made by you, or by the agent skill, and checked by `scan --recheck`.
+
+## License
+
+MIT. See [LICENSE](LICENSE). Third-party attributions, including the Optiq-derived SSIM code and the vendored
+SSIMULACRA2 WebAssembly module, are in [NOTICE](NOTICE).

package/THIRD_PARTY_LICENSES

@@ -0,0 +1,295 @@
+Third-party licenses for code shipped in the imgtune package.
+See NOTICE for what each one covers.
+
+================================================================================
+Optiq (src/ssim.ts, adapted; shipped compiled in dist/ssim.js)
+Copyright 2026 Optiq contributors. Licensed under the Apache License, Version 2.0:
+================================================================================
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+================================================================================
+ssimulacra2 0.5.0 (vendored scorer and blur, compiled into vendor/ssimulacra2/ssim_wasm_bg.wasm)
+================================================================================
+
+BSD 2-Clause License
+
+Copyright (c) 2022-2022, the rav1e contributors
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+================================================================================
+yuvxyb 0.4.0 (compiled into vendor/ssimulacra2/ssim_wasm_bg.wasm)
+================================================================================
+
+MIT License
+
+Copyright (c) 2022 Josh Holmer
+
+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.
+
+================================================================================
+wasm-bindgen 0.2.129 (glue in vendor/ssimulacra2; used under the MIT option)
+================================================================================
+
+Copyright (c) 2014 Alex Crichton
+
+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.