@tmustier/pi-nes 0.2.3 → 0.2.4

package/README.md

@@ -88,7 +88,7 @@ The extension uses the **native Rust core** only (required build step). Battery-
 
 ## Rendering
 
-Default renderer is `image`, which uses Kitty's image protocol for high resolution. On Kitty, we **prefer shared-memory transport (`t=s`)** when the native addon is built, falling back to the **file transport (`t=f`)** path if the addon isn’t available; non-Kitty terminals fall back to PNG. Image mode runs **nearly full-screen** (no overlay) because Kitty graphics sequences can't be safely composited inside overlays; it caps to ~90% height and centers vertically to reduce terminal compositor load. Image mode also **throttles rendering to ~30fps** to keep emulation speed stable. Set `renderer: "text"` if you prefer ANSI half-block rendering in an overlay. You can tweak `pixelScale` to 1.5–2.0 for larger images in PNG mode.
+Default renderer is `image`, which uses Kitty's image protocol for high resolution. On Kitty, we **prefer shared-memory transport (`t=s`)** when the native addon is built, falling back to the **file transport (`t=f`)** path if the addon isn’t available; non-Kitty terminals fall back to PNG. Image mode runs **nearly full-screen** (no overlay) because Kitty graphics sequences can't be safely composited inside overlays; it caps to ~90% height and centers vertically + horizontally to reduce terminal compositor load. Image mode also **throttles rendering to ~30fps** to keep emulation speed stable. Set `renderer: "text"` if you prefer ANSI half-block rendering in an overlay. You can tweak `pixelScale` to 1.5–2.0 for larger images in PNG mode.
 
 ## Audio
 

package/extensions/nes/config.ts

@@ -2,6 +2,7 @@ import { promises as fs } from "node:fs";
 import os from "node:os";
 import path from "node:path";
 import { DEFAULT_INPUT_MAPPING, type InputMapping } from "./input-map.js";
+import { normalizePath } from "./paths.js";
 
 export type RendererMode = "image" | "text";
 
@@ -90,24 +91,6 @@ function normalizePixelScale(raw: unknown): number {
 	return Math.min(4, Math.max(0.5, raw));
 }
 
-function normalizePath(value: string, fallback: string): string {
-	const trimmed = value.trim();
-	if (!trimmed) {
-		return fallback;
-	}
-	return expandHomePath(trimmed);
-}
-
-function expandHomePath(value: string): string {
-	if (value === "~") {
-		return os.homedir();
-	}
-	if (value.startsWith("~/") || value.startsWith("~\\")) {
-		return path.join(os.homedir(), value.slice(2));
-	}
-	return value;
-}
-
 function normalizeKeybindings(raw: unknown): InputMapping {
 	const mapping = cloneMapping(DEFAULT_INPUT_MAPPING);
 	if (!raw || typeof raw !== "object") {

package/extensions/nes/index.ts

@@ -1,5 +1,4 @@
 import { promises as fs } from "node:fs";
-import os from "node:os";
 import path from "node:path";
 import type { ExtensionAPI, ExtensionCommandContext } from "@mariozechner/pi-coding-agent";
 import { NesOverlayComponent } from "./nes-component.js";
@@ -13,6 +12,7 @@ import {
 	normalizeConfig,
 	saveConfig,
 } from "./config.js";
+import { displayPath, resolvePathInput } from "./paths.js";
 import { NesSession } from "./nes-session.js";
 import { listRoms } from "./roms.js";
 import { loadSram } from "./saves.js";
@@ -77,26 +77,6 @@ function parseArgs(args?: string): { debug: boolean; romArg?: string } {
 	return { debug: false, romArg: trimmed };
 }
 
-function displayPath(value: string): string {
-	const home = os.homedir();
-	if (value.startsWith(home)) {
-		return `~${value.slice(home.length)}`;
-	}
-	return value;
-}
-
-function resolvePathInput(input: string, cwd: string): string {
-	if (input.startsWith("~")) {
-		const trimmed = input.slice(1);
-		const suffix = trimmed.startsWith(path.sep) ? trimmed.slice(1) : trimmed;
-		return path.join(os.homedir(), suffix);
-	}
-	if (path.isAbsolute(input)) {
-		return input;
-	}
-	return path.resolve(cwd, input);
-}
-
 async function ensureRomDir(pathValue: string, ctx: ExtensionCommandContext): Promise<boolean> {
 	try {
 		const stat = await fs.stat(pathValue);

package/extensions/nes/nes-component.ts

@@ -11,14 +11,9 @@ const FRAME_WIDTH = 256;
 const FRAME_HEIGHT = 240;
 
 function readRgb(frameBuffer: FrameBuffer, index: number): [number, number, number] {
-	if (frameBuffer.format === "rgb") {
-		const data = frameBuffer.data as ReadonlyArray<number>;
-		const base = index * 3;
-		return [data[base] ?? 0, data[base + 1] ?? 0, data[base + 2] ?? 0];
-	}
-	const data = frameBuffer.data as ReadonlyArray<number>;
-	const color = data[index] ?? 0;
-	return [color & 0xff, (color >> 8) & 0xff, (color >> 16) & 0xff];
+	const data = frameBuffer.data;
+	const base = index * 3;
+	return [data[base] ?? 0, data[base + 1] ?? 0, data[base + 2] ?? 0];
 }
 
 function renderHalfBlock(

package/extensions/nes/nes-core.ts

@@ -4,11 +4,8 @@ const require = createRequire(import.meta.url);
 
 export type NesButton = "up" | "down" | "left" | "right" | "a" | "b" | "start" | "select";
 
-export type FrameBufferFormat = "packed" | "rgb";
-
 export interface FrameBuffer {
-	format: FrameBufferFormat;
-	data: ReadonlyArray<number> | Uint8Array;
+	data: Uint8Array;
 }
 
 export interface NesCore {
@@ -100,7 +97,7 @@ class NativeNesCore implements NesCore {
 	}
 
 	getFrameBuffer(): FrameBuffer {
-		return { format: "rgb", data: this.frameBuffer };
+		return { data: this.frameBuffer };
 	}
 
 	setButton(button: NesButton, pressed: boolean): void {

package/extensions/nes/paths.ts

@@ -0,0 +1,40 @@
+import os from "node:os";
+import path from "node:path";
+
+export function displayPath(value: string): string {
+	const home = os.homedir();
+	if (value.startsWith(home)) {
+		return `~${value.slice(home.length)}`;
+	}
+	return value;
+}
+
+export function expandHomePath(value: string): string {
+	if (value === "~") {
+		return os.homedir();
+	}
+	if (value.startsWith("~/") || value.startsWith("~\\")) {
+		return path.join(os.homedir(), value.slice(2));
+	}
+	return value;
+}
+
+export function normalizePath(value: string, fallback: string): string {
+	const trimmed = value.trim();
+	if (!trimmed) {
+		return fallback;
+	}
+	return expandHomePath(trimmed);
+}
+
+export function resolvePathInput(input: string, cwd: string): string {
+	const trimmed = input.trim();
+	if (!trimmed) {
+		return cwd;
+	}
+	const expanded = expandHomePath(trimmed);
+	if (path.isAbsolute(expanded)) {
+		return expanded;
+	}
+	return path.resolve(cwd, expanded);
+}

package/extensions/nes/renderer.ts

@@ -131,21 +131,8 @@ export class NesImageRenderer {
 			return null;
 		}
 
-		const availableRows = getAvailableRows(tui, footerRows);
-		const maxRows = getMaxImageRows(tui, footerRows);
-		const cell = getCellDimensions();
-		const maxWidthByRows = Math.floor(
-			(maxRows * cell.heightPx * FRAME_WIDTH) / (FRAME_HEIGHT * cell.widthPx),
-		);
-		const maxWidthCells = Math.max(1, Math.min(widthCells, maxWidthByRows));
-		const maxWidthPx = Math.max(1, maxWidthCells * cell.widthPx);
-		const maxHeightPx = Math.max(1, maxRows * cell.heightPx);
-		const maxScale = Math.min(maxWidthPx / FRAME_WIDTH, maxHeightPx / FRAME_HEIGHT);
-		const requestedScale = Math.max(0.5, pixelScale) * maxScale;
-		const scale = Math.min(maxScale, requestedScale);
-		const columns = Math.max(1, Math.min(maxWidthCells, Math.floor((FRAME_WIDTH * scale) / cell.widthPx)));
-		const rows = Math.max(1, Math.min(maxRows, Math.floor((FRAME_HEIGHT * scale) / cell.heightPx)));
-		const padLeft = getHorizontalPadding(widthCells, columns);
+		const layout = computeKittyLayout(tui, widthCells, footerRows, pixelScale);
+		const { availableRows, columns, rows, padLeft } = layout;
 
 		this.fillRawBufferTarget(frameBuffer, shared.buffer);
 		const base64Name = Buffer.from(shared.name).toString("base64");
@@ -178,21 +165,8 @@ export class NesImageRenderer {
 		footerRows: number,
 		pixelScale: number,
 	): string[] {
-		const availableRows = getAvailableRows(tui, footerRows);
-		const maxRows = getMaxImageRows(tui, footerRows);
-		const cell = getCellDimensions();
-		const maxWidthByRows = Math.floor(
-			(maxRows * cell.heightPx * FRAME_WIDTH) / (FRAME_HEIGHT * cell.widthPx),
-		);
-		const maxWidthCells = Math.max(1, Math.min(widthCells, maxWidthByRows));
-		const maxWidthPx = Math.max(1, maxWidthCells * cell.widthPx);
-		const maxHeightPx = Math.max(1, maxRows * cell.heightPx);
-		const maxScale = Math.min(maxWidthPx / FRAME_WIDTH, maxHeightPx / FRAME_HEIGHT);
-		const requestedScale = Math.max(0.5, pixelScale) * maxScale;
-		const scale = Math.min(maxScale, requestedScale);
-		const columns = Math.max(1, Math.min(maxWidthCells, Math.floor((FRAME_WIDTH * scale) / cell.widthPx)));
-		const rows = Math.max(1, Math.min(maxRows, Math.floor((FRAME_HEIGHT * scale) / cell.heightPx)));
-		const padLeft = getHorizontalPadding(widthCells, columns);
+		const layout = computeKittyLayout(tui, widthCells, footerRows, pixelScale);
+		const { availableRows, columns, rows, padLeft } = layout;
 
 		this.fillRawBuffer(frameBuffer);
 		const fd = this.ensureRawFile();
@@ -235,23 +209,8 @@ export class NesImageRenderer {
 		footerRows: number,
 		pixelScale: number,
 	): string[] {
-		const availableRows = getAvailableRows(tui, footerRows);
-		const maxRows = getMaxImageRows(tui, footerRows);
-		const cell = getCellDimensions();
-		const maxWidthByRows = Math.floor(
-			(maxRows * cell.heightPx * FRAME_WIDTH) / (FRAME_HEIGHT * cell.widthPx),
-		);
-		const maxWidthCells = Math.max(1, Math.min(widthCells, maxWidthByRows));
-		const maxWidthPx = Math.max(1, maxWidthCells * cell.widthPx);
-		const maxHeightPx = Math.max(1, maxRows * cell.heightPx);
-		const scale = Math.min(
-			maxWidthPx / FRAME_WIDTH,
-			maxHeightPx / FRAME_HEIGHT,
-		) * pixelScale;
-		const targetWidth = Math.max(1, Math.floor(FRAME_WIDTH * scale));
-		const targetHeight = Math.max(1, Math.floor(FRAME_HEIGHT * scale));
-		const columns = Math.max(1, Math.min(maxWidthCells, Math.floor(targetWidth / cell.widthPx)));
-		const padLeft = getHorizontalPadding(widthCells, columns);
+		const layout = computePngLayout(tui, widthCells, footerRows, pixelScale);
+		const { availableRows, maxWidthCells, padLeft, targetHeight, targetWidth } = layout;
 
 		const hash = hashFrame(frameBuffer, targetWidth, targetHeight);
 		if (!this.cachedImage || this.lastFrameHash !== hash) {
@@ -293,28 +252,13 @@ export class NesImageRenderer {
 	}
 
 	private fillRawBufferTarget(frameBuffer: FrameBuffer, target: Uint8Array): void {
-		if (frameBuffer.format === "rgb") {
-			const source = frameBuffer.data as ReadonlyArray<number>;
-			if (source instanceof Uint8Array) {
-				target.set(source.subarray(0, RAW_FRAME_BYTES));
-				return;
-			}
-			const max = Math.min(source.length, RAW_FRAME_BYTES);
-			for (let i = 0; i < max; i += 1) {
-				target[i] = source[i] ?? 0;
-			}
+		const source = frameBuffer.data;
+		if (source.length >= RAW_FRAME_BYTES) {
+			target.set(source.subarray(0, RAW_FRAME_BYTES));
 			return;
 		}
-
-		let offset = 0;
-		const source = frameBuffer.data as ReadonlyArray<number>;
-		for (let i = 0; i < FRAME_WIDTH * FRAME_HEIGHT; i += 1) {
-			const color = source[i] ?? 0;
-			target[offset] = color & 0xff;
-			target[offset + 1] = (color >> 8) & 0xff;
-			target[offset + 2] = (color >> 16) & 0xff;
-			offset += 3;
-		}
+		target.set(source);
+		target.fill(0, source.length, RAW_FRAME_BYTES);
 	}
 
 	private getSharedMemoryModule(): KittyShmModule | null {
@@ -459,6 +403,40 @@ function getMaxImageRows(tui: TUI, footerRows: number): number {
 	return Math.max(1, Math.floor(availableRows * IMAGE_HEIGHT_RATIO));
 }
 
+function computeLayoutBase(tui: TUI, widthCells: number, footerRows: number) {
+	const availableRows = getAvailableRows(tui, footerRows);
+	const maxRows = getMaxImageRows(tui, footerRows);
+	const cell = getCellDimensions();
+	const maxWidthByRows = Math.floor(
+		(maxRows * cell.heightPx * FRAME_WIDTH) / (FRAME_HEIGHT * cell.widthPx),
+	);
+	const maxWidthCells = Math.max(1, Math.min(widthCells, maxWidthByRows));
+	const maxWidthPx = Math.max(1, maxWidthCells * cell.widthPx);
+	const maxHeightPx = Math.max(1, maxRows * cell.heightPx);
+	return { availableRows, maxRows, cell, maxWidthCells, maxWidthPx, maxHeightPx };
+}
+
+function computeKittyLayout(tui: TUI, widthCells: number, footerRows: number, pixelScale: number) {
+	const base = computeLayoutBase(tui, widthCells, footerRows);
+	const maxScale = Math.min(base.maxWidthPx / FRAME_WIDTH, base.maxHeightPx / FRAME_HEIGHT);
+	const requestedScale = Math.max(0.5, pixelScale) * maxScale;
+	const scale = Math.min(maxScale, requestedScale);
+	const columns = Math.max(1, Math.min(base.maxWidthCells, Math.floor((FRAME_WIDTH * scale) / base.cell.widthPx)));
+	const rows = Math.max(1, Math.min(base.maxRows, Math.floor((FRAME_HEIGHT * scale) / base.cell.heightPx)));
+	const padLeft = getHorizontalPadding(widthCells, columns);
+	return { ...base, columns, rows, padLeft };
+}
+
+function computePngLayout(tui: TUI, widthCells: number, footerRows: number, pixelScale: number) {
+	const base = computeLayoutBase(tui, widthCells, footerRows);
+	const scale = Math.min(base.maxWidthPx / FRAME_WIDTH, base.maxHeightPx / FRAME_HEIGHT) * pixelScale;
+	const targetWidth = Math.max(1, Math.floor(FRAME_WIDTH * scale));
+	const targetHeight = Math.max(1, Math.floor(FRAME_HEIGHT * scale));
+	const columns = Math.max(1, Math.min(base.maxWidthCells, Math.floor(targetWidth / base.cell.widthPx)));
+	const padLeft = getHorizontalPadding(widthCells, columns);
+	return { ...base, targetWidth, targetHeight, padLeft };
+}
+
 function centerLines(lines: string[], totalRows: number): string[] {
 	if (lines.length >= totalRows) {
 		return lines;
@@ -495,37 +473,24 @@ function insertPaddingAfterMoveUp(line: string, padLeft: number): string {
 }
 
 function readRgb(frameBuffer: FrameBuffer, index: number): [number, number, number] {
-	if (frameBuffer.format === "rgb") {
-		const data = frameBuffer.data as ReadonlyArray<number>;
-		const base = index * 3;
-		return [data[base] ?? 0, data[base + 1] ?? 0, data[base + 2] ?? 0];
-	}
-	const data = frameBuffer.data as ReadonlyArray<number>;
-	const color = data[index] ?? 0;
-	return [color & 0xff, (color >> 8) & 0xff, (color >> 16) & 0xff];
-}
-
-function readPacked(frameBuffer: FrameBuffer, index: number): number {
-	if (frameBuffer.format === "packed") {
-		const data = frameBuffer.data as ReadonlyArray<number>;
-		return data[index] ?? 0;
-	}
-	const data = frameBuffer.data as ReadonlyArray<number>;
+	const data = frameBuffer.data;
 	const base = index * 3;
-	const r = data[base] ?? 0;
-	const g = data[base + 1] ?? 0;
-	const b = data[base + 2] ?? 0;
-	return r | (g << 8) | (b << 16);
+	return [data[base] ?? 0, data[base + 1] ?? 0, data[base + 2] ?? 0];
 }
 
 function hashFrame(frameBuffer: FrameBuffer, width: number, height: number): number {
 	let hash = width ^ (height << 16);
 	const stepX = Math.max(1, Math.floor(FRAME_WIDTH / 64));
 	const stepY = Math.max(1, Math.floor(FRAME_HEIGHT / 64));
+	const data = frameBuffer.data;
 	for (let y = 0; y < FRAME_HEIGHT; y += stepY) {
 		const rowOffset = y * FRAME_WIDTH;
 		for (let x = 0; x < FRAME_WIDTH; x += stepX) {
-			const color = readPacked(frameBuffer, rowOffset + x);
+			const base = (rowOffset + x) * 3;
+			const r = data[base] ?? 0;
+			const g = data[base + 1] ?? 0;
+			const b = data[base + 2] ?? 0;
+			const color = r | (g << 8) | (b << 16);
 			hash = ((hash << 5) - hash + color) | 0;
 		}
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmustier/pi-nes",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "NES emulator extension for pi",
   "keywords": [
     "pi-package",