Files
by-ae-ComfyUI-ByAE-Ideogram…/tests/caption_layout.test.js
T
by-ae 64d2515b8c fix: offset each paste so copies do not stack
Ctrl+V always nudged the original clipboard by the same amount, so a
second paste landed on the first copy.
2026-11-01 07:31:19 +10:00

414 lines
15 KiB
JavaScript

import assert from "node:assert/strict";
import { describe, it } from "node:test";
import {
captionText,
cleanPalette,
elementToRegion,
dimsFromAspect,
fallbackRegion,
ideogramBboxToRect,
ideogramResolutionWarning,
indexesAfterClearingSelection,
snapLayoutDim,
offsetAddedRegions,
nextPasteNudge,
pasteRegions,
rectToIdeogramBbox,
regionCoordsFinite,
regionLabel,
remapImportedRegions,
topRegionIndex,
staggerLoadedRegion,
swatchHex,
transformBoxesContentUniform,
} from "../web/js/caption_layout.js";
describe("ideogram bbox import", () => {
it("maps ymin, xmin, ymax, xmax onto x, y, w, h", () => {
const box = elementToRegion({
type: "text",
text: "Hello",
desc: "A greeting",
bbox: [100, 200, 300, 400],
color_palette: ["#FF0000"],
}, 0);
assert.equal(box.type, "text");
assert.equal(box.text, "Hello");
assert.equal(box.palette[0], "#FF0000");
assert.equal(box.x, 0.2);
assert.equal(box.y, 0.1);
assert.equal(box.w, 0.2);
assert.equal(box.h, 0.2);
assert.equal(box.nobbox, undefined);
});
it("turns numeric caption text into strings and drops other types", () => {
const box = elementToRegion({ type: "text", text: 12, desc: 5, bbox: [0, 0, 10, 10] }, 0);
assert.equal(box.text, "12");
assert.equal(box.desc, "5");
assert.equal(captionText(true), "");
assert.equal(captionText(Number.NaN), "");
assert.equal(captionText(" keep "), " keep ");
assert.equal(regionLabel({ type: "text", text: 12, desc: 5 }), '"12" — 5');
assert.equal(regionLabel({ type: "obj", desc: true }), "");
assert.equal(regionLabel({ type: "obj", desc: { a: 1 } }), "");
assert.equal(typeof regionLabel({ type: "text", text: 0, desc: false }), "string");
assert.equal(regionLabel(null), "");
});
it("swaps inverted axes so the region can be hit-tested", () => {
const rect = ideogramBboxToRect([400, 300, 100, 200]);
assert.deepEqual(rect, { x: 0.2, y: 0.1, w: 0.1, h: 0.3 });
});
it("clamps coordinates to the 0-1000 caption range", () => {
const rect = ideogramBboxToRect([-100, -50, 1500, 2000]);
assert.deepEqual(rect, { x: 0, y: 0, w: 1, h: 1 });
});
it("accepts numeric strings", () => {
const rect = ideogramBboxToRect(["100", "200", "300", "400"]);
assert.deepEqual(rect, { x: 0.2, y: 0.1, w: 0.2, h: 0.2 });
});
it("places non-numeric bboxes on the non-overlapping grid at their index", () => {
const good = elementToRegion({ type: "obj", desc: "ok", bbox: [0, 0, 100, 100] }, 0);
const bad = elementToRegion({ type: "obj", desc: "bad", bbox: ["nope", 0, 10, 10] }, 1);
assert.equal(good.nobbox, undefined);
assert.equal(bad.nobbox, true);
assert.equal(bad.x, fallbackRegion(1).x);
assert.equal(bad.y, fallbackRegion(1).y);
assert.notEqual(bad.x, fallbackRegion(0).x);
});
it("does not overlap a full row of fallback regions", () => {
const boxes = [0, 1, 2, 3, 4].map((i) => fallbackRegion(i));
for (let i = 0; i < boxes.length; i++) {
for (let j = i + 1; j < boxes.length; j++) {
const a = boxes[i];
const b = boxes[j];
const overlapX = a.x < b.x + b.w && a.x + a.w > b.x;
const overlapY = a.y < b.y + b.h && a.y + a.h > b.y;
assert.equal(overlapX && overlapY, false, `region ${i} overlaps ${j}`);
}
}
});
it("rejects NaN coordinates when restoring saved regions", () => {
assert.equal(regionCoordsFinite({ x: 0.1, y: 0.2, w: 0.3, h: 0.4 }), true);
assert.equal(regionCoordsFinite({ x: NaN, y: 0.2, w: 0.3, h: 0.4 }), false);
assert.equal(regionCoordsFinite({ x: 0.1, y: 0.2, w: 0.3 }), false);
});
it("exports a usable bbox and drops coordinates that are not finite", () => {
assert.deepEqual(rectToIdeogramBbox({ x: 0.1, y: 0.2, w: 0.3, h: 0.4 }), [200, 100, 600, 400]);
assert.deepEqual(rectToIdeogramBbox({ x: "0.1", y: "0.2", w: "0.3", h: "0.4" }), [200, 100, 600, 400]);
assert.deepEqual(rectToIdeogramBbox({ x: 0.5, y: 0.6, w: -0.2, h: -0.1 }), [500, 300, 600, 500]);
assert.equal(rectToIdeogramBbox({ x: Number.NaN, y: 0.2, w: 0.3, h: 0.4 }), null);
assert.equal(rectToIdeogramBbox({ x: "nope", y: 0, w: 0.2, h: 0.2 }), null);
assert.equal(rectToIdeogramBbox({ x: true, y: 0, w: 0.2, h: 0.2 }), null);
assert.deepEqual(rectToIdeogramBbox({}), [0, 0, 0, 0]);
assert.deepEqual(rectToIdeogramBbox({ x: 1e308, y: 0, w: 1e308, h: 0.2 }), [0, 1000, 200, 1000]);
});
});
describe("canvas size fields", () => {
it("snaps a typed size to a multiple of 8 inside 64-16384", () => {
assert.equal(snapLayoutDim(1024), 1024);
assert.equal(snapLayoutDim(1001), 1000);
assert.equal(snapLayoutDim(1004), 1008);
assert.equal(snapLayoutDim(67), 64);
assert.equal(snapLayoutDim(63), 64);
assert.equal(snapLayoutDim(16384), 16384);
assert.equal(snapLayoutDim(16385), 16384);
assert.equal(snapLayoutDim(16380), 16384);
assert.equal(snapLayoutDim(1920), 1920);
assert.equal(snapLayoutDim("1080"), 1080);
});
it("uses the default when the field is empty or not a positive number", () => {
assert.equal(snapLayoutDim(""), 1024);
assert.equal(snapLayoutDim(" "), 1024);
assert.equal(snapLayoutDim(0), 1024);
assert.equal(snapLayoutDim(-20), 1024);
assert.equal(snapLayoutDim(Number.NaN), 1024);
assert.equal(snapLayoutDim(null), 1024);
assert.equal(snapLayoutDim(undefined, 512), 512);
});
});
describe("open model canvas size", () => {
const note = "Open Ideogram 4 model: multiples of 16, each side 256-2048, aspect at most 6:1";
it("accepts sizes the inference reference allows", () => {
assert.equal(ideogramResolutionWarning(1024, 1024), "");
assert.equal(ideogramResolutionWarning(256, 256), "");
assert.equal(ideogramResolutionWarning(2048, 2048), "");
assert.equal(ideogramResolutionWarning(1920, 1088), "");
assert.equal(ideogramResolutionWarning(1536, 256), "");
assert.equal(ideogramResolutionWarning(256, 1536), "");
});
it("notes a size the open model will not run", () => {
assert.equal(ideogramResolutionWarning(1920, 1080), note);
assert.equal(ideogramResolutionWarning(64, 64), note);
assert.equal(ideogramResolutionWarning(2880, 1440), note);
assert.equal(ideogramResolutionWarning(1552, 256), note);
});
});
describe("deleting a selection", () => {
it("removes only the selected regions and leaves nothing active", () => {
const ending = indexesAfterClearingSelection(3, [0, 2]);
assert.deepEqual(ending, { count: 1, selected: [], active: -1 });
});
it("counts each selected index once and ignores indexes outside the list", () => {
const ending = indexesAfterClearingSelection(2, [0, 0, 5, -1]);
assert.deepEqual(ending, { count: 1, selected: [], active: -1 });
});
it("drops every region when the whole canvas is selected", () => {
const ending = indexesAfterClearingSelection(4, [0, 1, 2, 3]);
assert.deepEqual(ending, { count: 0, selected: [], active: -1 });
});
});
describe("overlapping regions", () => {
const boxes = [
{ x: 0, y: 0, w: 0.8, h: 0.8, desc: "under" },
{ x: 0.2, y: 0.2, w: 0.2, h: 0.2, desc: "over" },
{ x: Number.NaN, y: 0.2, w: 0.2, h: 0.2, desc: "bad" },
];
it("picks the later region, which is the one drawn on top", () => {
assert.equal(topRegionIndex(boxes, 0.3, 0.3), 1);
assert.equal(topRegionIndex(boxes, 0.05, 0.05), 0);
assert.equal(topRegionIndex(boxes, 0.95, 0.95), -1);
});
it("still hits a handle that sits just outside the region", () => {
assert.equal(topRegionIndex(boxes, 0.8, 0.4, 0.02, 0.02), 0);
assert.equal(topRegionIndex([{ x: 0.5, y: 0.5, w: 0.1, h: 0.1 }], 0.62, 0.55, 0.03, 0.03), 0);
});
});
describe("color palettes", () => {
it("uppercases #RRGGBB, expands #RGB, and drops values Ideogram rejects", () => {
assert.deepEqual(
cleanPalette([null, "", "red", "#fff", "#aabbcc", 1, true, "#12"]),
["#FFFFFF", "#AABBCC"],
);
});
it("turns a pasted element palette into colors the picker can edit", () => {
const box = elementToRegion({
type: "obj",
desc: "shirt",
bbox: [0, 0, 100, 100],
color_palette: ["#fff", "red", "#aabbcc", "#123456", "#ABCDEF", "#010203", "extra"],
}, 0);
assert.deepEqual(box.palette, ["#FFFFFF", "#AABBCC", "#123456", "#ABCDEF", "#010203"]);
assert.equal(swatchHex("#fff"), "#ffffff");
assert.equal(swatchHex("#AABBCC"), "#aabbcc");
assert.equal(swatchHex("red"), null);
assert.equal(swatchHex("#GG0000"), null);
});
it("stops at the caller limit", () => {
const colors = Array.from({ length: 20 }, (_, i) => `#${i.toString(16).padStart(6, "0")}`);
assert.equal(cleanPalette(colors, 5).length, 5);
assert.equal(cleanPalette(colors, 16).length, 16);
assert.deepEqual(cleanPalette(colors, 2), ["#000000", "#000001"]);
});
});
function near(actual, expected) {
assert.ok(Math.abs(actual - expected) < 1e-9, `${actual} is not near ${expected}`);
}
describe("added scenes", () => {
it("shifts every region by the same amount so the layout stays intact", () => {
const boxes = [
{ x: 0.1, y: 0.2, w: 0.2, h: 0.2, type: "obj", desc: "a" },
{ x: 0.5, y: 0.6, w: 0.2, h: 0.1, type: "text", text: "T", desc: "b" },
];
const placed = offsetAddedRegions(boxes, 0.05);
near(placed[0].x, 0.15);
near(placed[0].y, 0.25);
near(placed[1].x, 0.55);
near(placed[1].y, 0.65);
near(placed[1].x - placed[0].x, boxes[1].x - boxes[0].x);
near(placed[1].y - placed[0].y, boxes[1].y - boxes[0].y);
near(placed[0].w, boxes[0].w);
near(placed[1].h, boxes[1].h);
assert.equal(placed[1].text, "T");
});
it("keeps a nudged region inside the canvas", () => {
const placed = offsetAddedRegions([{ x: 0.9, y: 0.9, w: 0.2, h: 0.2 }], 0.05);
near(placed[0].x, 0.95);
near(placed[0].y, 0.95);
assert.ok(placed[0].x + placed[0].w <= 1 + 1e-9);
assert.ok(placed[0].y + placed[0].h <= 1 + 1e-9);
near(placed[0].w, 0.05);
});
});
describe("pasted regions", () => {
it("nudges by the paste offset and stays inside the canvas", () => {
const placed = pasteRegions([
{ x: 0.9, y: 0.9, w: 0.2, h: 0.2, desc: "edge", palette: ["#FFFFFF"] },
]);
near(placed[0].x, 0.93);
near(placed[0].y, 0.93);
near(placed[0].w, 0.07);
near(placed[0].h, 0.07);
assert.ok(placed[0].x + placed[0].w <= 1 + 1e-9);
assert.ok(placed[0].y + placed[0].h <= 1 + 1e-9);
assert.equal(placed[0].desc, "edge");
});
it("steps the nudge so a second paste does not cover the first", () => {
const box = { x: 0.1, y: 0.2, w: 0.02, h: 0.02, desc: "copy" };
assert.equal(nextPasteNudge(0), 0.03);
assert.equal(nextPasteNudge(1), 0.06);
assert.equal(nextPasteNudge(2), 0.09);
const first = pasteRegions([box], nextPasteNudge(0));
const second = pasteRegions([box], nextPasteNudge(1));
near(first[0].x, 0.13);
near(second[0].x, 0.16);
near(second[0].y - first[0].y, 0.03);
const overlapX = first[0].x < second[0].x + second[0].w && first[0].x + first[0].w > second[0].x;
const overlapY = first[0].y < second[0].y + second[0].h && first[0].y + first[0].h > second[0].y;
assert.equal(overlapX && overlapY, false);
});
it("does not keep the source store link or share its palette array", () => {
const src = [{
x: 0.1, y: 0.2, w: 0.2, h: 0.2,
palette: ["#FFFFFF"],
storeRef: { type: "character", name: "Ada" },
}];
const placed = pasteRegions(src);
near(placed[0].x, 0.13);
near(placed[0].y, 0.23);
near(placed[0].w, 0.2);
assert.equal(placed[0].storeRef, undefined);
placed[0].palette.push("#000000");
assert.deepEqual(src[0].palette, ["#FFFFFF"]);
assert.deepEqual(src[0].storeRef, { type: "character", name: "Ada" });
});
});
describe("pasted caption layout", () => {
const box = { x: 0, y: 0, w: 0.25, h: 0.25, type: "obj", desc: "corner" };
it("leaves normalized coordinates alone when the source size does not matter", () => {
const same = remapImportedRegions([box], {
source: "stretch", destW: 512, destH: 512, mode: "center",
});
assert.equal(same[0].x, 0);
assert.equal(same[0].w, 0.25);
const matched = remapImportedRegions([box], {
source: "dimensions", srcW: 512, srcH: 512, destW: 512, destH: 512, mode: "center",
});
assert.equal(matched[0].w, 0.25);
});
it("fits a source canvas onto the destination even when scale mode is stretch", () => {
// 256px box at the origin of a 1024 canvas, placed on a 512 canvas.
// Stretch used to ignore the source size. The default scale mode is stretch,
// so the dialog's dimension choice did nothing.
const placed = remapImportedRegions([box], {
source: "dimensions",
srcW: 1024,
srcH: 1024,
destW: 512,
destH: 512,
mode: "stretch",
});
near(placed[0].x, 0.25);
near(placed[0].y, 0.25);
near(placed[0].w, 0.5);
near(placed[0].h, 0.5);
assert.equal(placed[0].desc, "corner");
});
it("keeps an anchor mode when the source canvas is a different size", () => {
const placed = remapImportedRegions([box], {
source: "dimensions",
srcW: 1024,
srcH: 1024,
destW: 512,
destH: 512,
mode: "top-left",
});
near(placed[0].x, 0);
near(placed[0].y, 0);
near(placed[0].w, 0.5);
near(placed[0].h, 0.5);
});
it("uses an aspect ratio as the source canvas", () => {
assert.deepEqual(dimsFromAspect("16:9"), { w: 1024, h: 576 });
assert.equal(dimsFromAspect("nope"), null);
const wide = { x: 0, y: 0, w: 1, h: 1, desc: "full" };
const placed = remapImportedRegions([wide], {
source: "aspect",
aspect: "2:1",
destW: 512,
destH: 512,
mode: "center",
});
// Source is 1024x512, content fills it, destination is square.
// Uniform fit is limited by height: 512/512 = 1, width scale 512/1024 = 0.5, s = 0.5.
near(placed[0].w, 1);
near(placed[0].h, 0.5);
near(placed[0].x, 0);
near(placed[0].y, 0.25);
});
it("does not let one bad coordinate destroy the other regions", () => {
const good = { x: 0.25, y: 0.25, w: 0.5, h: 0.5, desc: "ok" };
const bad = { x: 0.1, y: Number.NaN, w: 0.2, h: 0.2, desc: "bad" };
const placed = transformBoxesContentUniform([good, bad], 1024, 1024, 512, 512, "center");
near(placed[0].x, 0);
near(placed[0].y, 0);
near(placed[0].w, 1);
near(placed[0].h, 1);
assert.equal(placed[1].desc, "bad");
});
});
describe("loaded characters and objects", () => {
it("keeps the original diagonal stagger while the region still fits", () => {
for (let i = 0; i <= 16; i++) {
const box = staggerLoadedRegion(i);
near(box.x, 0.1 + i * 0.04);
near(box.y, 0.1 + i * 0.04);
near(box.w, 0.25);
near(box.h, 0.2);
assert.ok(box.x + box.w <= 1 + 1e-9, `index ${i} leaves the canvas`);
}
});
it("tiles later regions inside the canvas instead of sliding off it", () => {
const box = staggerLoadedRegion(17);
near(box.x, 0);
near(box.y, 0);
near(box.w, 0.25);
near(box.h, 0.2);
const next = staggerLoadedRegion(18);
near(next.x, 0.25);
near(next.y, 0);
for (let i = 0; i < 80; i++) {
const placed = staggerLoadedRegion(i);
assert.ok(placed.x >= -1e-9 && placed.y >= -1e-9, `index ${i} origin`);
assert.ok(placed.x + placed.w <= 1 + 1e-9, `index ${i} x`);
assert.ok(placed.y + placed.h <= 1 + 1e-9, `index ${i} y`);
}
});
});