@tmustier/pi-nes 0.2.18 → 0.2.19

package/extensions/nes/native/nes-core/index.d.ts

@@ -1,5 +1,32 @@
 export function nativeVersion(): string;
 
+export interface CpuDebugState {
+  pc: number;
+  a: number;
+  x: number;
+  y: number;
+  sp: number;
+  p: number;
+  lastPc: number;
+  lastOpcode: number;
+}
+
+export interface MapperDebugState {
+  mapperNum: number;
+  control: number;
+  prg: number;
+  chr0: number;
+  chr1: number;
+  prgMode: number;
+  chrMode: number;
+  outerPrg: number;
+}
+
+export interface NesDebugState {
+  cpu: CpuDebugState;
+  mapper: MapperDebugState;
+}
+
 export class NativeNes {
   constructor();
   setRom(data: Uint8Array): void;
@@ -14,6 +41,7 @@ export class NativeNes {
   setSram(data: Uint8Array): void;
   isSramDirty(): boolean;
   markSramSaved(): void;
+  getDebugState(): NesDebugState;
   getFramebuffer(): Uint8Array;
 }
 

package/extensions/nes/native/nes-core/native.d.ts

@@ -4,6 +4,30 @@
 /* auto-generated by NAPI-RS */
 
 export declare function nativeVersion(): string
+export interface CpuDebugState {
+  pc: number
+  a: number
+  x: number
+  y: number
+  sp: number
+  p: number
+  lastPc: number
+  lastOpcode: number
+}
+export interface MapperDebugState {
+  mapperNum: number
+  control: number
+  prg: number
+  chr0: number
+  chr1: number
+  prgMode: number
+  chrMode: number
+  outerPrg: number
+}
+export interface NesDebugState {
+  cpu: CpuDebugState
+  mapper: MapperDebugState
+}
 export declare class NativeNes {
   constructor()
   setRom(data: Uint8Array): void
@@ -18,5 +42,6 @@ export declare class NativeNes {
   setSram(data: Uint8Array): void
   isSramDirty(): boolean
   markSramSaved(): void
+  getDebugState(): NesDebugState
   getFramebuffer(): Uint8Array
 }

package/extensions/nes/native/nes-core/src/lib.rs

@@ -48,6 +48,36 @@ impl Display for NativeDisplay {
 	}
 }
 
+#[napi(object)]
+pub struct CpuDebugState {
+	pub pc: u16,
+	pub a: u8,
+	pub x: u8,
+	pub y: u8,
+	pub sp: u8,
+	pub p: u8,
+	pub last_pc: u16,
+	pub last_opcode: u8,
+}
+
+#[napi(object)]
+pub struct MapperDebugState {
+	pub mapper_num: u8,
+	pub control: u8,
+	pub prg: u8,
+	pub chr0: u8,
+	pub chr1: u8,
+	pub prg_mode: u8,
+	pub chr_mode: u8,
+	pub outer_prg: u8,
+}
+
+#[napi(object)]
+pub struct NesDebugState {
+	pub cpu: CpuDebugState,
+	pub mapper: MapperDebugState,
+}
+
 #[napi]
 pub struct NativeNes {
 	nes: Nes,
@@ -133,6 +163,33 @@ impl NativeNes {
 		self.nes.mark_sram_saved();
 	}
 
+	#[napi]
+	pub fn get_debug_state(&self) -> NesDebugState {
+		let state = self.nes.debug_state();
+		NesDebugState {
+			cpu: CpuDebugState {
+				pc: state.cpu.pc,
+				a: state.cpu.a,
+				x: state.cpu.x,
+				y: state.cpu.y,
+				sp: state.cpu.sp,
+				p: state.cpu.p,
+				last_pc: state.cpu.last_pc,
+				last_opcode: state.cpu.last_opcode,
+			},
+			mapper: MapperDebugState {
+				mapper_num: state.mapper.mapper_num,
+				control: state.mapper.control,
+				prg: state.mapper.prg,
+				chr0: state.mapper.chr0,
+				chr1: state.mapper.chr1,
+				prg_mode: state.mapper.prg_mode,
+				chr_mode: state.mapper.chr_mode,
+				outer_prg: state.mapper.outer_prg,
+			},
+		}
+	}
+
 	#[napi]
 	pub fn get_framebuffer(&mut self) -> Uint8Array {
 		let ptr = self.framebuffer.as_mut_ptr();

package/extensions/nes/native/nes-core/vendor/nes_rust/src/cpu.rs

@@ -14,6 +14,17 @@ const SRAM_START: usize = 0x6000;
 const SRAM_END: usize = 0x8000;
 const SRAM_SIZE: usize = SRAM_END - SRAM_START;
 
+pub struct CpuDebugState {
+	pub pc: u16,
+	pub a: u8,
+	pub x: u8,
+	pub y: u8,
+	pub sp: u8,
+	pub p: u8,
+	pub last_pc: u16,
+	pub last_opcode: u8,
+}
+
 fn to_joypad_button(button: button::Button) -> joypad::Button {
 	match button {
 		button::Button::Joypad1A |
@@ -46,6 +57,8 @@ pub struct Cpu {
 	x: Register<u8>,
 	y: Register<u8>,
 	p: CpuStatusRegister,
+	last_pc: u16,
+	last_opcode: u8,
 
 	// CPU inside RAM
 	ram: Memory,
@@ -1106,6 +1119,8 @@ impl Cpu {
 			x: Register::<u8>::new(),
 			y: Register::<u8>::new(),
 			p: CpuStatusRegister::new(),
+			last_pc: 0,
+			last_opcode: 0,
 			ram: Memory::new(vec![0; 64 * 1024]), // 64KB
 			sram_dirty: false,
 			stall_cycles: 0,
@@ -1159,6 +1174,23 @@ impl Cpu {
 		self.p.set_i();
 	}
 
+	pub fn debug_state(&self) -> CpuDebugState {
+		CpuDebugState {
+			pc: self.pc.load(),
+			a: self.a.load(),
+			x: self.x.load(),
+			y: self.y.load(),
+			sp: self.sp.load(),
+			p: self.p.load(),
+			last_pc: self.last_pc,
+			last_opcode: self.last_opcode,
+		}
+	}
+
+	pub fn mapper_debug_state(&self) -> crate::mapper::MapperDebugState {
+		self.rom.mapper_debug_state()
+	}
+
 	pub fn get_ppu(&self) -> &Ppu {
 		&self.ppu
 	}
@@ -1301,7 +1333,10 @@ impl Cpu {
 	}
 
 	fn fetch(&mut self) -> u8 {
-		let opc = self.load(self.pc.load());
+		let pc = self.pc.load();
+		let opc = self.load(pc);
+		self.last_pc = pc;
+		self.last_opcode = opc;
 		self.pc.increment();
 		opc
 	}

package/extensions/nes/native/nes-core/vendor/nes_rust/src/lib.rs

@@ -14,7 +14,8 @@ pub mod default_input;
 pub mod default_audio;
 pub mod default_display;
 
-use cpu::Cpu;
+use cpu::{Cpu, CpuDebugState};
+use mapper::MapperDebugState;
 use rom::Rom;
 use button::Button;
 use input::Input;
@@ -62,6 +63,11 @@ pub struct Nes {
 	cpu: Cpu
 }
 
+pub struct NesDebugState {
+	pub cpu: CpuDebugState,
+	pub mapper: MapperDebugState,
+}
+
 impl Nes {
 	/// Creates a new `Nes`.
     /// You need to pass [`input::Input`](./input/trait.Input.html),
@@ -165,4 +171,11 @@ impl Nes {
 	pub fn mark_sram_saved(&mut self) {
 		self.cpu.mark_sram_saved();
 	}
+
+	pub fn debug_state(&self) -> NesDebugState {
+		NesDebugState {
+			cpu: self.cpu.debug_state(),
+			mapper: self.cpu.mapper_debug_state(),
+		}
+	}
 }

package/extensions/nes/native/nes-core/vendor/nes_rust/src/mapper.rs

@@ -3,6 +3,18 @@ use rom::Mirrorings;
 use rom::RomHeader;
 use register::Register;
 
+#[derive(Clone, Copy, Default)]
+pub struct MapperDebugState {
+	pub mapper_num: u8,
+	pub control: u8,
+	pub prg: u8,
+	pub chr0: u8,
+	pub chr1: u8,
+	pub prg_mode: u8,
+	pub chr_mode: u8,
+	pub outer_prg: u8,
+}
+
 impl MapperFactory {
 	pub fn create(header: &RomHeader) -> Box<dyn Mapper> {
 		match header.mapper_num() {
@@ -32,6 +44,10 @@ pub trait Mapper {
 
 	// @TODO: MMC3Mapper specific. Should this method be here?
 	fn drive_irq_counter(&mut self) -> bool;
+
+	fn debug_state(&self) -> MapperDebugState {
+		MapperDebugState::default()
+	}
 }
 
 pub struct NRomMapper {
@@ -196,6 +212,23 @@ impl Mapper for MMC1Mapper {
 		}
 	}
 
+	fn debug_state(&self) -> MapperDebugState {
+		MapperDebugState {
+			mapper_num: 1,
+			control: self.control_register.load(),
+			prg: self.prg_bank_register.load(),
+			chr0: self.chr_bank0_register.load(),
+			chr1: self.chr_bank1_register.load(),
+			prg_mode: self.control_register.load_bits(2, 2),
+			chr_mode: self.control_register.load_bit(4),
+			outer_prg: if self.program_bank_num > 16 {
+				(self.chr_bank0_register.load() >> 4) & 1
+			} else {
+				0
+			},
+		}
+	}
+
 	fn has_mirroring_type(&self) -> bool {
 		true
 	}

package/extensions/nes/native/nes-core/vendor/nes_rust/src/rom.rs

@@ -1,5 +1,5 @@
 use memory::Memory;
-use mapper::{Mapper, MapperFactory};
+use mapper::{Mapper, MapperFactory, MapperDebugState};
 
 pub struct Rom {
 	header: RomHeader,
@@ -132,6 +132,10 @@ impl Rom {
 		}
 	}
 
+	pub fn mapper_debug_state(&self) -> MapperDebugState {
+		self.mapper.debug_state()
+	}
+
 	// @TODO: MMC3Mapper specific. Should this method be here?
 	pub fn irq_interrupted(&mut self) -> bool {
 		self.mapper.drive_irq_counter()

package/extensions/nes/nes-component.ts

@@ -148,8 +148,8 @@ export class NesOverlayComponent implements Component {
 
 		const footer = " NES | Ctrl+Q=Detach | Q=Quit | WASD/Arrows=Move | Z/X=A/B | Enter/Space=Start | Tab=Select";
 		const frameBuffer = this.core.getFrameBuffer();
-		const debugLine = this.debug ? this.buildDebugLine() : null;
-		const footerRows = this.debug ? 2 : 1;
+		const debugLines = this.debug ? this.buildDebugLines() : [];
+		const footerRows = this.debug ? 1 + debugLines.length : 1;
 		if (this.rendererMode === "image") {
 			const lines = this.imageRenderer.render(
 				frameBuffer,
@@ -159,8 +159,8 @@ export class NesOverlayComponent implements Component {
 				this.pixelScale,
 				!this.windowed,
 			);
-			if (debugLine) {
-				lines.push(truncateToWidth(debugLine, width));
+			for (const line of debugLines) {
+				lines.push(truncateToWidth(line, width));
 			}
 			lines.push(truncateToWidth(`\x1b[2m${footer}\x1b[0m`, width));
 			return lines;
@@ -176,8 +176,8 @@ export class NesOverlayComponent implements Component {
 
 		const rawLines = renderHalfBlock(frameBuffer, targetCols, targetRows, scaleX, scaleY);
 		const lines = rawLines.map((line) => truncateToWidth(`${padPrefix}${line}`, width));
-		if (debugLine) {
-			lines.push(truncateToWidth(`${padPrefix}${debugLine}`, width));
+		for (const line of debugLines) {
+			lines.push(truncateToWidth(`${padPrefix}${line}`, width));
 		}
 		lines.push(truncateToWidth(`\x1b[2m${padPrefix}${footer}\x1b[0m`, width));
 		return lines;
@@ -201,19 +201,40 @@ export class NesOverlayComponent implements Component {
 		this.imageCleared = true;
 	}
 
-	private buildDebugLine(): string | null {
+	private buildDebugLines(): string[] {
 		const stats = this.statsProvider?.();
 		if (!stats) {
-			return null;
+			return [];
 		}
 		const label = this.debugLabel ? ` core=${this.debugLabel}` : "";
 		const mem = stats.memory;
-		const line = `DEBUG${label} fps=${stats.tickFps.toFixed(1)} render=${stats.renderFps.toFixed(1)} `
+		const lines: string[] = [];
+		const statsLine = `DEBUG${label} fps=${stats.tickFps.toFixed(1)} render=${stats.renderFps.toFixed(1)} `
 			+ `frames/tick=${stats.avgFramesPerTick.toFixed(2)} dropped=${stats.droppedFrames} `
 			+ `catch=${stats.lastCatchUpFrames}/${stats.maxCatchUpFrames} `
 			+ `eld=${stats.eventLoopDelayMs.toFixed(2)}ms `
 			+ `mem=${mem.heapUsedMb.toFixed(1)}/${mem.rssMb.toFixed(1)}MB ext=${mem.externalMb.toFixed(1)}MB ab=${mem.arrayBuffersMb.toFixed(1)}MB`;
-		return `\x1b[33m${line}\x1b[0m`;
+		lines.push(`\x1b[33m${statsLine}\x1b[0m`);
+
+		const debugState = this.core.getDebugState();
+		if (debugState) {
+			const cpu = debugState.cpu;
+			const mapper = debugState.mapper;
+			const cpuLine = `CPU pc=${this.formatHex(cpu.pc, 4)} op=${this.formatHex(cpu.lastOpcode, 2)} `
+				+ `a=${this.formatHex(cpu.a, 2)} x=${this.formatHex(cpu.x, 2)} y=${this.formatHex(cpu.y, 2)} `
+				+ `sp=${this.formatHex(cpu.sp, 2)} p=${this.formatHex(cpu.p, 2)} `
+				+ `last=${this.formatHex(cpu.lastPc, 4)}`;
+			const mapperLine = `MMC1 ctrl=${this.formatHex(mapper.control, 2)} prg=${this.formatHex(mapper.prg, 2)} `
+				+ `chr0=${this.formatHex(mapper.chr0, 2)} chr1=${this.formatHex(mapper.chr1, 2)} `
+				+ `prgMode=${mapper.prgMode} chrMode=${mapper.chrMode} outer=${mapper.outerPrg}`;
+			lines.push(`\x1b[36m${cpuLine}\x1b[0m`);
+			lines.push(`\x1b[36m${mapperLine}\x1b[0m`);
+		}
+		return lines;
+	}
+
+	private formatHex(value: number, width: number): string {
+		return value.toString(16).padStart(width, "0");
 	}
 
 	private tapButton(button: "start" | "select"): void {

package/extensions/nes/nes-core.ts

@@ -8,6 +8,33 @@ export interface FrameBuffer {
 	data: Uint8Array;
 }
 
+export interface NesCpuDebugState {
+	pc: number;
+	a: number;
+	x: number;
+	y: number;
+	sp: number;
+	p: number;
+	lastPc: number;
+	lastOpcode: number;
+}
+
+export interface NesMapperDebugState {
+	mapperNum: number;
+	control: number;
+	prg: number;
+	chr0: number;
+	chr1: number;
+	prgMode: number;
+	chrMode: number;
+	outerPrg: number;
+}
+
+export interface NesDebugState {
+	cpu: NesCpuDebugState;
+	mapper: NesMapperDebugState;
+}
+
 export interface NesCore {
 	loadRom(rom: Uint8Array): void;
 	tick(): void;
@@ -18,6 +45,7 @@ export interface NesCore {
 	isSramDirty(): boolean;
 	markSramSaved(): void;
 	getAudioWarning(): string | null;
+	getDebugState(): NesDebugState | null;
 	reset(): void;
 	dispose(): void;
 }
@@ -39,6 +67,7 @@ interface NativeNesInstance {
 	setSram(data: Uint8Array): void;
 	isSramDirty(): boolean;
 	markSramSaved(): void;
+	getDebugState(): NesDebugState;
 	getFramebuffer(): Uint8Array;
 }
 
@@ -148,6 +177,10 @@ class NativeNesCore implements NesCore {
 		return this.audioWarning;
 	}
 
+	getDebugState(): NesDebugState | null {
+		return this.nes.getDebugState();
+	}
+
 	reset(): void {
 		this.nes.reset();
 	}

package/package.json

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