Free open-source image editor for the browser
Split-view comparison and shadow/highlight clipping (#4)
Rodrigo Belfioreeb8e9b320422
diff --git a/README.md b/README.mdindex 9c848f0..708a9b5 100644--- a/README.md+++ b/README.md@@ -80,3 +80,17 @@ they do not yet model Lightroom's spatial processing.State includes the file name, document ID, canvas size, adjustments, tone curve,and undo/redo counts. Loading commands resolve when their batch finishes; imagedecoding failures appear in the editor. The renderer updates when the scene changes.++## Preview aids++Click the split-view icon to compare the original on the left with the edit on the+right. Drag the vertical divider, use arrow keys, or double-click it to recenter.+Hold backslash for the full original; releasing restores the previous view.+Text fields keep normal keyboard input. The histogram's left and right triangles+toggle clipping overlays: blue for pixels with all sRGB channels at or below zero,+red for any channel at or above one. Transparent pixels are excluded.+These controls affect only the canvas; histograms and exports keep the edited result.+Preview settings reset when another image opens and never enter undo history.+Scripts can use `openlight.setPreview({ comparison: "split", split: 0.5 })` and+`openlight.setPreview({ shadows: true, highlights: true })`. Comparison accepts+`"edited"`, `"original"`, or `"split"`; the split position is a fraction from 0 to 1.diff --git a/src/app/controls.ts b/src/app/controls.tsindex e5af013..1794edc 100644--- a/src/app/controls.ts+++ b/src/app/controls.ts@@ -1,4 +1,5 @@import type { Gpu } from "vgpu";+import type { Preview } from "@/app/document";import { setAdjustments, setToneCurve } from "@/app/document/edits";import {type ExportOptions,@@ -28,6 +29,8 @@ export function createControls(gpu: Gpu, workspace: Workspace) {setAdjustments(workspace.getDocument(), change),setToneCurve: (curve?: ToneCurve) =>setToneCurve(workspace.getDocument(), curve),+ setPreview: (change: Partial<Preview>) =>+ workspace.getDocument().preview.setState(change),beginEdit: () => workspace.getDocument().history.begin(),commitEdit: () => workspace.getDocument().history.commit(),cancelEdit: () => workspace.getDocument().history.cancel(),@@ -40,6 +43,7 @@ export function createControls(gpu: Gpu, workspace: Workspace) {const scene = document?.scene.getState();return {file,+ preview: document && { ...document.preview.getState() },documentId: document?.id,size: scene && [...scene.size],adjustments: { ...(scene?.adjustments ?? defaultAdjustments) },diff --git a/src/app/document/index.ts b/src/app/document/index.tsindex a624799..1b6de6c 100644--- a/src/app/document/index.ts+++ b/src/app/document/index.ts@@ -4,6 +4,13 @@ import type { Scene } from "@/app/scene";import { createHistory } from "@/lib/history";import { createResources } from "./resources";+export type Preview = {+ comparison: "edited" | "original" | "split";+ split: number;+ shadows: boolean;+ highlights: boolean;+};+function equal(a: Scene, b: Scene) {return (a.source === b.source &&@@ -33,6 +40,12 @@ export function createDocument(initial: Scene, resources = createResources()) {getInitialState: scene.getInitialState,subscribe: scene.subscribe,},+ preview: createStore<Preview>(() => ({+ comparison: "edited",+ split: 0.5,+ shadows: false,+ highlights: false,+ })),history,resources,edit(next: Scene) {diff --git a/src/app/editor/comparison-divider.tsx b/src/app/editor/comparison-divider.tsxnew file mode 100644index 0000000..b00f13e--- /dev/null+++ b/src/app/editor/comparison-divider.tsx@@ -0,0 +1,86 @@+import type { PointerEvent } from "react";+import { useStore } from "zustand";+import { useDocument } from "@/app/document/provider";++export function ComparisonDivider() {+ const { preview } = useDocument();+ const { comparison, split } = useStore(preview);+ if (comparison !== "split") {+ return null;+ }+ const move = (position: number) =>+ preview.setState({ split: Math.max(0, Math.min(1, position)) });+ function drag(event: PointerEvent<HTMLDivElement>) {+ if (!event.currentTarget.hasPointerCapture(event.pointerId)) {+ return;+ }+ const bounds = event.currentTarget.parentElement?.getBoundingClientRect();+ if (bounds) {+ move((event.clientX - bounds.left) / bounds.width);+ }+ }+ return (+ <div+ role="slider"+ tabIndex={0}+ aria-label="Before and after divider"+ aria-valuemin={0}+ aria-valuemax={100}+ aria-valuenow={Math.round(split * 100)}+ aria-valuetext={`${Math.round(split * 100)}% original`}+ aria-orientation="horizontal"+ className="absolute inset-y-0 z-10 flex w-8 -translate-x-1/2 cursor-ew-resize touch-none items-center justify-center outline-none group"+ style={{ left: `${split * 100}%` }}+ onPointerDown={(event) => {+ if (event.button !== 0) {+ return;+ }+ event.stopPropagation();+ event.currentTarget.focus();+ event.currentTarget.setPointerCapture(event.pointerId);+ }}+ onPointerMove={drag}+ onPointerUp={(event) =>+ event.currentTarget.releasePointerCapture(event.pointerId)+ }+ onDoubleClick={(event) => {+ event.stopPropagation();+ move(0.5);+ }}+ onKeyDown={(event) => {+ const step = event.shiftKey ? 0.1 : 0.01;+ const positions: Record<string, number> = {+ ArrowLeft: split - step,+ ArrowRight: split + step,+ Home: 0,+ End: 1,+ };+ if (!(event.key in positions)) {+ return;+ }+ event.preventDefault();+ move(positions[event.key]);+ }}+ >+ <div className="absolute inset-y-0 w-px bg-white/90 shadow-[0_0_3px_#000]" />+ <span className="absolute top-4 right-6 rounded bg-black/50 px-2 py-1 text-[10px] text-white">+ Before+ </span>+ <span className="absolute top-4 left-6 rounded bg-black/50 px-2 py-1 text-[10px] text-white">+ After+ </span>+ <span className="relative flex size-7 items-center justify-center rounded-full border border-white/80 bg-neutral-900 text-white shadow-md group-focus-visible:ring-2 group-focus-visible:ring-white">+ <svg+ aria-hidden="true"+ viewBox="0 0 20 20"+ className="size-4"+ fill="none"+ stroke="currentColor"+ strokeWidth="1.5"+ >+ <path d="M8 6 4 10 8 14M12 6 16 10 12 14" />+ </svg>+ </span>+ </div>+ );+}diff --git a/src/app/editor/index.tsx b/src/app/editor/index.tsxindex 90bb635..d9b7520 100644--- a/src/app/editor/index.tsx+++ b/src/app/editor/index.tsx@@ -5,6 +5,7 @@ import ResizablePanel from "@/components/ui/resizable-panel";import Spinner from "@/components/ui/spinner";import { usePanZoom } from "@/hooks/use-pan-zoom";import type { Target } from "@/lib/decode";+import { ComparisonDivider } from "./comparison-divider";import { CanvasRenderer } from "./renderer";import { RendererProvider } from "./renderer/provider";import { Sidebar } from "./sidebar";@@ -16,13 +17,14 @@ function ImageCanvas({ image }: WorkspaceProps) {return (<div- className="grid min-h-0 min-w-0 flex-1 cursor-grab touch-none place-items-center active:cursor-grabbing"+ className="relative grid min-h-0 min-w-0 flex-1 overflow-hidden cursor-grab touch-none place-items-center active:cursor-grabbing"ref={ref}{...handlers}><Canvas className="size-full min-h-0"><CanvasRenderer view={view} /></Canvas>+ <ComparisonDivider /></div>);}diff --git a/src/app/editor/renderer/index.tsx b/src/app/editor/renderer/index.tsxindex bdcc7e2..3c24270 100644--- a/src/app/editor/renderer/index.tsx+++ b/src/app/editor/renderer/index.tsx@@ -1,5 +1,7 @@import { useEffect } from "react";import { useCanvas, useFrame } from "vgpu-react";+import { useStore } from "zustand";+import { useDocument } from "@/app/document/provider";import type { View } from "@/hooks/use-pan-zoom";import { useRenderer } from "./provider";@@ -7,8 +9,9 @@ type CanvasRendererProps = { view: View };export function CanvasRenderer({ view }: CanvasRendererProps) {const renderer = useRenderer();+ const preview = useStore(useDocument().preview);const canvas = useCanvas();- const draw = useFrame((frame) => renderer.draw(frame, canvas, view));+ const draw = useFrame((frame) => renderer.draw(frame, canvas, view, preview));useEffect(() => {const unsubscribe = renderer.subscribe(draw);const observer = new ResizeObserver(draw);@@ -20,6 +23,6 @@ export function CanvasRenderer({ view }: CanvasRendererProps) {observer.disconnect();};}, [renderer, canvas, draw]);- useEffect(() => draw(), [draw, view]);+ useEffect(() => draw(), [draw, view, preview]);return null;}diff --git a/src/app/editor/renderer/renderer.ts b/src/app/editor/renderer/renderer.tsindex 35dd0ee..c06fb1a 100644--- a/src/app/editor/renderer/renderer.ts+++ b/src/app/editor/renderer/renderer.ts@@ -6,6 +6,7 @@ import {sampler,type Target,} from "vgpu";+import type { Preview } from "@/app/document";import type { Scene } from "@/app/scene";import { createToneCurves } from "@/features/tone-curves/pass";import type { View } from "@/hooks/use-pan-zoom";@@ -48,19 +49,29 @@ export function createRenderer(gpu: Gpu, source: Target) {listener();}},- draw(frame: Frame, canvas: Target & { dpr: number }, view: View) {+ draw(+ frame: Frame,+ canvas: Target & { dpr: number },+ view: View,+ preview?: Preview,+ ) {if (!rendered) {return;}+ const image = preview?.comparison === "original" ? source : output;frame.pass(canvas,display.set({- source: output.color,+ source: image.color,+ original: source.color,params: {size: canvas.size,- sourceSize: output.size,+ sourceSize: image.size,pan: view.pan.map((p) => p * canvas.dpr),zoom: view.zoom,+ split: preview?.comparison === "split" ? preview.split : -1,+ shadows: Number(preview?.shadows ?? false),+ highlights: Number(preview?.highlights ?? false),},}),);diff --git a/src/app/editor/renderer/renderer.wgsl b/src/app/editor/renderer/renderer.wgslindex 73b84bf..bf2f6ee 100644--- a/src/app/editor/renderer/renderer.wgsl+++ b/src/app/editor/renderer/renderer.wgsl@@ -1,14 +1,18 @@-import { display } from "../../../lib/color.wgsl";+import { display, rec2020ToSrgb } from "../../../lib/color.wgsl";struct Params {size: vec2f,sourceSize: vec2f,pan: vec2f,zoom: f32,+ split: f32,+ shadows: u32,+ highlights: u32,}@group(0) @binding(0) var<uniform> params: Params;@group(0) @binding(1) var source: texture_2d<f32>;@group(0) @binding(2) var sourceSampler: sampler;+@group(0) @binding(3) var original: texture_2d<f32>;const background = vec3f(0.09);@@ -17,6 +21,19 @@ const background = vec3f(0.09);let scale = min(min(params.size.x / params.sourceSize.x, params.size.y / params.sourceSize.y), 1.0) * params.zoom;let p = ((uv - 0.5) * params.size - params.pan) / (params.sourceSize * scale) + 0.5;let inside = all(p >= vec2f(0.0)) && all(p <= vec2f(1.0));- let color = display(textureSampleLevel(source, sourceSampler, p, 0.0).rgb);+ var sample = textureSampleLevel(source, sourceSampler, p, 0.0);+ if (uv.x < params.split) {+ sample = textureSampleLevel(original, sourceSampler, p, 0.0);+ }+ let rgb = rec2020ToSrgb * sample.rgb;+ var color = display(sample.rgb);+ if (sample.a > 0.0) {+ if (params.shadows != 0u && all(rgb <= vec3f(0.0))) {+ color = vec3f(0.0, 0.0, 1.0);+ }+ if (params.highlights != 0u && any(rgb >= vec3f(1.0))) {+ color = vec3f(1.0, 0.0, 0.0);+ }+ }return vec4f(select(background, color, inside), 1.0);}diff --git a/src/app/editor/sidebar/clipping-controls.tsx b/src/app/editor/sidebar/clipping-controls.tsxnew file mode 100644index 0000000..7bcbea3--- /dev/null+++ b/src/app/editor/sidebar/clipping-controls.tsx@@ -0,0 +1,32 @@+import { useStore } from "zustand";+import { useDocument } from "@/app/document/provider";+import Button from "@/components/ui/button";++export function ClippingControls() {+ const { preview } = useDocument();+ const state = useStore(preview);+ return (+ <div className="pointer-events-none absolute inset-x-1 top-1 z-10 flex justify-between">+ {(["shadows", "highlights"] as const).map((range) => (+ <Button+ key={range}+ variant="ghost"+ aria-label={`Show clipped ${range}`}+ title={`Show clipped ${range}`}+ aria-pressed={state[range]}+ className="pointer-events-auto flex size-6 items-center justify-center rounded-sm bg-neutral-900/80 p-0 aria-pressed:bg-neutral-700 aria-pressed:text-white"+ onClick={() => preview.setState({ [range]: !state[range] })}+ >+ <svg+ aria-hidden="true"+ viewBox="0 0 12 12"+ className="size-3"+ fill="currentColor"+ >+ <path d="M6 2 11 10H1Z" />+ </svg>+ </Button>+ ))}+ </div>+ );+}diff --git a/src/app/editor/sidebar/comparison-control.tsx b/src/app/editor/sidebar/comparison-control.tsxnew file mode 100644index 0000000..67a3fe5--- /dev/null+++ b/src/app/editor/sidebar/comparison-control.tsx@@ -0,0 +1,83 @@+import { useEffect } from "react";+import { useStore } from "zustand";+import type { Preview } from "@/app/document";+import { useDocument } from "@/app/document/provider";+import Button from "@/components/ui/button";++export function ComparisonControl() {+ const { preview } = useDocument();+ const comparison = useStore(preview, (state) => state.comparison);+ useEffect(() => {+ let restore: Preview["comparison"] | undefined;+ function release() {+ if (restore === undefined) {+ return;+ }+ preview.setState({ comparison: restore });+ restore = undefined;+ }+ function keyDown(event: KeyboardEvent) {+ if (+ event.code !== "Backslash" ||+ event.repeat ||+ event.metaKey ||+ event.ctrlKey ||+ event.altKey+ ) {+ return;+ }+ const target = event.target;+ if (+ target instanceof HTMLElement &&+ (target.isContentEditable ||+ target.closest(+ 'input:not([type="range"]), textarea, select, [role="dialog"]',+ ))+ ) {+ return;+ }+ event.preventDefault();+ restore = preview.getState().comparison;+ preview.setState({ comparison: "original" });+ }+ function keyUp(event: KeyboardEvent) {+ if (event.code === "Backslash") {+ release();+ }+ }+ window.addEventListener("keydown", keyDown);+ window.addEventListener("keyup", keyUp);+ window.addEventListener("blur", release);+ return () => {+ window.removeEventListener("keydown", keyDown);+ window.removeEventListener("keyup", keyUp);+ window.removeEventListener("blur", release);+ release();+ };+ }, [preview]);+ return (+ <Button+ variant="ghost"+ aria-label="Compare before and after"+ aria-pressed={comparison !== "edited"}+ title="Compare before and after (hold backslash for original)"+ className="flex size-8 items-center justify-center rounded-md p-0 aria-pressed:bg-neutral-700 aria-pressed:text-neutral-100"+ onClick={() =>+ preview.setState({+ comparison: comparison === "split" ? "edited" : "split",+ })+ }+ >+ <svg+ aria-hidden="true"+ viewBox="0 0 20 20"+ className="size-5"+ fill="none"+ stroke="currentColor"+ strokeWidth="1.5"+ >+ <path d="M10 2v16M7 5H3v10h4M13 5h4v10h-4" />+ </svg>+ </Button>+ );+}diff --git a/src/app/editor/sidebar/index.tsx b/src/app/editor/sidebar/index.tsxindex 64c9b85..c8a76bb 100644--- a/src/app/editor/sidebar/index.tsx+++ b/src/app/editor/sidebar/index.tsx@@ -11,6 +11,8 @@ import { createHistogram } from "@/features/histogram/histogram";import { ToneCurves } from "@/features/tone-curves/tone-curves";import { useEditGesture } from "@/hooks/use-edit-gesture";import AdjustmentControls from "./adjustment-controls";+import { ClippingControls } from "./clipping-controls";+import { ComparisonControl } from "./comparison-control";const histogramColors = ["#f25445", "#6bd175", "#5c8ffa"] as const;const curveHistogramColors = ["#a3a3a3"] as const;@@ -55,7 +57,8 @@ export function Sidebar() {{...gesture}className="min-h-0 flex-1 divide-y divide-black overflow-y-auto">- <section className="bg-neutral-900 p-0.5 pb-0">+ <section className="relative bg-neutral-900 p-0.5 pb-0">+ <ClippingControls /><Histogramhistogram={histogram}image={renderer.outputImage}@@ -71,6 +74,7 @@ export function Sidebar() {</div><div className="flex shrink-0 items-center gap-2 bg-neutral-900 px-2 py-1.5"><HistoryControls />+ <ComparisonControl /><ExportButton /></div></div>diff --git a/tests/editing.e2e.ts b/tests/editing.e2e.tsindex d69d20e..d719aea 100644--- a/tests/editing.e2e.ts+++ b/tests/editing.e2e.ts@@ -1,7 +1,7 @@import { readFile } from "node:fs/promises";import { interpolatePchip } from "@/lib/math";import { expect, test } from "./fixtures";-import { readImage } from "./images";+import { readImage, readPreview } from "./images";test("edit a photo, inspect the preview and histograms, undo changes, and export", async ({page,@@ -70,6 +70,117 @@ test("edit a photo, inspect the preview and histograms, undo changes, and exportawait expect.poll(() => canvas.screenshot()).toEqual(original);});+ await test.step("compare and clipping change only the preview", async () => {+ await page.evaluate(() => {+ window.openlight.setAdjustments({ exposure: 3 });+ window.openlight.setToneCurve([+ { x: 0, y: 0 },+ { x: 0.5, y: 1 },+ { x: 1, y: 1 },+ ]);+ });+ const before = page.getByRole("button", {+ name: "Compare before and after",+ exact: true,+ });+ const shadows = page.getByRole("button", { name: "Show clipped shadows" });+ const highlights = page.getByRole("button", {+ name: "Show clipped highlights",+ });+ const edited = await readImage(page);+ const history = (await page.evaluate(() => window.openlight.getState()))+ .history;+ const bins = await output.getAttribute("points");+ await before.focus();+ await page.keyboard.down("Backslash");+ await expect(before).toHaveAttribute("aria-pressed", "true");+ await expect+ .poll(async () => (await readPreview(page)).center)+ .toEqual([128, 128, 128, 255]);+ await page.keyboard.up("Backslash");+ await expect+ .poll(async () => (await readPreview(page)).center)+ .toEqual([255, 255, 255, 255]);+ await before.click();+ const divider = page.getByRole("slider", {+ name: "Before and after divider",+ });+ await expect(divider).toHaveAttribute("aria-valuenow", "50");+ const bounds = await canvas.boundingBox();+ if (!bounds) throw new Error("Preview is missing.");+ await divider.hover();+ await page.mouse.down();+ await page.mouse.move(+ bounds.x + bounds.width * 0.8,+ bounds.y + bounds.height / 2,+ { steps: 8 },+ );+ await page.mouse.up();+ await expect(divider).toHaveAttribute("aria-valuenow", "80");+ await expect+ .poll(async () => (await readPreview(page)).center)+ .toEqual([128, 128, 128, 255]);+ await divider.press("Home");+ await expect+ .poll(async () => (await readPreview(page)).center)+ .toEqual([255, 255, 255, 255]);+ await divider.press("End");+ await expect+ .poll(async () => (await readPreview(page)).center)+ .toEqual([128, 128, 128, 255]);+ await divider.press("Shift+ArrowLeft");+ await expect(divider).toHaveAttribute("aria-valuenow", "90");+ await page.keyboard.down("Backslash");+ await expect(divider).toBeHidden();+ await page.keyboard.up("Backslash");+ await expect(divider).toHaveAttribute("aria-valuenow", "90");+ await before.click();+ await expect(divider).toBeHidden();+ await page.keyboard.down("Backslash");+ await page.evaluate(() => window.dispatchEvent(new Event("blur")));+ await expect(before).toHaveAttribute("aria-pressed", "false");+ await page.keyboard.up("Backslash");+ const field = page.getByRole("textbox", { name: "Exposure", exact: true });+ await field.focus();+ await page.keyboard.press("Backslash");+ await expect(before).toHaveAttribute("aria-pressed", "false");+ await field.press("Escape");+ await shadows.click();+ await expect+ .poll(async () => (await readPreview(page)).blue)+ .toBeGreaterThan(100);+ await highlights.click();+ await expect+ .poll(async () => (await readPreview(page)).center)+ .toEqual([255, 0, 0, 255]);+ await expect+ .poll(async () => (await readPreview(page)).blue)+ .toBeGreaterThan(100);+ await before.click();+ await expect+ .poll(async () => (await readPreview(page)).center)+ .toEqual([128, 128, 128, 255]);+ expect(await readImage(page)).toEqual(edited);+ expect(+ (await page.evaluate(() => window.openlight.getState())).history,+ ).toEqual(history);+ await expect(output).toHaveAttribute("points", bins ?? "");+ await page.evaluate(() =>+ window.openlight.setPreview({+ comparison: "edited",+ shadows: false,+ highlights: false,+ }),+ );+ await expect(highlights).toHaveAttribute("aria-pressed", "false");+ await expect.poll(async () => (await readPreview(page)).blue).toBe(0);+ await page.evaluate(() => {+ window.openlight.setAdjustments({ exposure: 0 });+ window.openlight.setToneCurve();+ });+ await expect.poll(() => canvas.screenshot()).toEqual(original);+ });+await test.step("light and color controls render together and reset", async () => {for (const [label, value] of [["Highlights", -50],diff --git a/tests/images.ts b/tests/images.tsindex 9a5845e..d592511 100644--- a/tests/images.ts+++ b/tests/images.ts@@ -25,3 +25,38 @@ export async function readImage(page: Page, bytes?: Uint8Array) {bytes ? [...bytes] : null,);}++/** Sample the displayed canvas, including preview-only overlays. */+export async function readPreview(page: Page) {+ const bytes = await page.locator("canvas").screenshot();+ return page.evaluate(+ async (bytes) => {+ const image = await createImageBitmap(new Blob([new Uint8Array(bytes)]));+ const canvas = new OffscreenCanvas(image.width, image.height);+ const context = canvas.getContext("2d");+ if (!context) throw new Error("Cannot read preview pixels.");+ context.drawImage(image, 0, 0);+ image.close();+ const { data } = context.getImageData(0, 0, canvas.width, canvas.height);+ let red = 0;+ let blue = 0;+ for (let i = 0; i < data.length; i += 4) {+ if (data[i] === 255 && data[i + 1] === 0 && data[i + 2] === 0) {+ red++;+ }+ if (data[i] === 0 && data[i + 1] === 0 && data[i + 2] === 255) {+ blue++;+ }+ }+ return {+ center: [+ ...context.getImageData(canvas.width / 2, canvas.height / 2, 1, 1)+ .data,+ ],+ red,+ blue,+ };+ },+ [...bytes],+ );+}