neser 1.1.0

NESER - Nintendo Emulation Systems Engine (Rust). Desktop and WebAssembly frontends.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
//! Integration tests for RAM initialization modes.

#![cfg(test)]

use crate::nes::cartridge::Cartridge;
use crate::nes::console::{Config, Nes, RamInitMode};

/// Helper to create a minimal NROM ROM (mapper 0) for testing.
fn create_test_rom() -> Vec<u8> {
    let mut rom = vec![0u8; 16 + 16 * 1024]; // Header + 16KB PRG ROM

    // iNES header
    rom[0..4].copy_from_slice(b"NES\x1A");
    rom[4] = 1; // 1 * 16KB PRG ROM
    rom[5] = 0; // CHR RAM (no CHR ROM)
    rom[6] = 0x00; // Mapper 0, horizontal mirroring
    rom[7] = 0x00; // Mapper 0 (upper bits)

    rom
}

fn load_test_cartridge(rom_data: &[u8], rom_name: &str) -> Cartridge {
    Cartridge::load_from_file(rom_data, rom_name, None).expect("Failed to create cartridge")
}

#[test]
fn test_cpu_ram_initialization_zero_mode() {
    let mut config = Config::with_defaults();
    config.frontend.ram_init_mode = RamInitMode::Zero;
    let nes = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config,
    ));

    // Check that CPU RAM is initialized to zero (first 2KB mirrored 4 times)
    let bus = nes.bus().borrow();
    let ram = bus.cpu_ram_ref();
    let ram_data = ram.borrow();

    // Check first 2KB
    for i in 0..0x800 {
        assert_eq!(ram_data[i], 0x00, "CPU RAM[{:#04X}] should be 0x00", i);
    }
}

#[test]
fn test_cpu_ram_initialization_seeded_random_mode_deterministic() {
    let mut config1 = Config::with_defaults();
    config1.frontend.ram_init_mode = RamInitMode::SeededRandom(42);
    let nes1 = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config1,
    ));

    let mut config2 = Config::with_defaults();
    config2.frontend.ram_init_mode = RamInitMode::SeededRandom(42);
    let nes2 = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config2,
    ));

    // Check that both have identical RAM
    let bus1 = nes1.bus().borrow();
    let ram1 = bus1.cpu_ram_ref();
    let ram1_data = ram1.borrow();

    let bus2 = nes2.bus().borrow();
    let ram2 = bus2.cpu_ram_ref();
    let ram2_data = ram2.borrow();

    for i in 0..0x800 {
        assert_eq!(
            ram1_data[i], ram2_data[i],
            "CPU RAM[{:#04X}] should match with same seed",
            i
        );
    }
}

#[test]
fn test_cpu_ram_initialization_different_seeds_produce_different_values() {
    let mut config1 = Config::with_defaults();
    config1.frontend.ram_init_mode = RamInitMode::SeededRandom(42);
    let nes1 = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config1,
    ));

    let mut config2 = Config::with_defaults();
    config2.frontend.ram_init_mode = RamInitMode::SeededRandom(43);
    let nes2 = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config2,
    ));

    let bus1 = nes1.bus().borrow();
    let ram1 = bus1.cpu_ram_ref();
    let ram1_data = ram1.borrow();

    let bus2 = nes2.bus().borrow();
    let ram2 = bus2.cpu_ram_ref();
    let ram2_data = ram2.borrow();

    // At least some bytes should be different
    let mut differences = 0;
    for i in 0..0x800 {
        if ram1_data[i] != ram2_data[i] {
            differences += 1;
        }
    }

    assert!(
        differences > 100,
        "Different seeds should produce many different values (got {} differences)",
        differences
    );
}

#[test]
fn test_ppu_ram_initialization_zero_mode() {
    let mut config = Config::with_defaults();
    config.frontend.ram_init_mode = RamInitMode::Zero;
    let nes = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config,
    ));

    // Check nametable RAM (0x2000-0x2FFF range)
    for addr in 0x2000..0x3000 {
        assert_eq!(
            nes.ppu().borrow().read_nametable_for_debug(addr),
            0x00,
            "PPU nametable[{:#04X}] should be 0x00",
            addr
        );
    }
}

#[test]
fn test_ppu_ram_initialization_seeded_random_deterministic() {
    let mut config1 = Config::with_defaults();
    config1.frontend.ram_init_mode = RamInitMode::SeededRandom(42);
    let nes1 = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config1,
    ));

    let mut config2 = Config::with_defaults();
    config2.frontend.ram_init_mode = RamInitMode::SeededRandom(42);
    let nes2 = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config2,
    ));

    // Check that nametable RAM is identical
    for addr in 0x2000..0x3000 {
        assert_eq!(
            nes1.ppu().borrow().read_nametable_for_debug(addr),
            nes2.ppu().borrow().read_nametable_for_debug(addr),
            "PPU nametable[{:#04X}] should match with same seed",
            addr
        );
    }
}

#[test]
fn test_cartridge_ram_initialization_zero_mode() {
    let mut config = Config::with_defaults();
    config.frontend.ram_init_mode = RamInitMode::Zero;
    let mut nes = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config,
    ));

    let rom_data = create_test_rom();
    let cartridge = load_test_cartridge(&rom_data, "ram-init-zero.nes");
    nes.insert_cartridge(cartridge);

    let mut bus = nes.bus().borrow_mut();
    // Check PRG-RAM at $6000-$7FFF
    for addr in 0x6000..=0x7FFF {
        assert_eq!(
            bus.read(addr, false),
            0x00,
            "PRG-RAM[{:#04X}] should be 0x00",
            addr
        );
    }
}

#[test]
fn test_cartridge_ram_initialization_seeded_random_deterministic() {
    let mut config1 = Config::with_defaults();
    config1.frontend.ram_init_mode = RamInitMode::SeededRandom(42);
    let mut nes1 = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config1,
    ));

    let rom_data1 = create_test_rom();
    let cartridge1 = load_test_cartridge(&rom_data1, "ram-init-seeded-a.nes");
    nes1.insert_cartridge(cartridge1);

    let mut config2 = Config::with_defaults();
    config2.frontend.ram_init_mode = RamInitMode::SeededRandom(42);
    let mut nes2 = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config2,
    ));

    let rom_data2 = create_test_rom();
    let cartridge2 = load_test_cartridge(&rom_data2, "ram-init-seeded-b.nes");
    nes2.insert_cartridge(cartridge2);

    let mut bus1 = nes1.bus().borrow_mut();
    let mut bus2 = nes2.bus().borrow_mut();

    // Check PRG-RAM at $6000-$7FFF
    for addr in 0x6000..=0x6100 {
        assert_eq!(
            bus1.read(addr, false),
            bus2.read(addr, false),
            "PRG-RAM[{:#04X}] should match with same seed",
            addr
        );
    }
}

#[test]
fn test_hard_reset_reinitializes_ram() {
    let mut config = Config::with_defaults();
    config.frontend.ram_init_mode = RamInitMode::Zero;
    let mut nes = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config,
    ));

    // Insert a cartridge so reset works
    let rom_data = create_test_rom();
    let cartridge = load_test_cartridge(&rom_data, "ram-init-hard-reset.nes");
    nes.insert_cartridge(cartridge);

    // Write some non-zero data to RAM
    {
        let bus = nes.bus().borrow();
        let ram_rc = bus.cpu_ram_ref();
        let mut ram = ram_rc.borrow_mut();
        ram[0x100] = 0xFF;
        ram[0x200] = 0xAA;
    }

    // Hard reset (soft_reset = false) should re-initialize RAM to zero
    nes.reset(false);

    let bus = nes.bus().borrow();
    let ram_rc = bus.cpu_ram_ref();
    let ram = ram_rc.borrow();
    assert_eq!(ram[0x100], 0x00, "Hard reset should zero RAM[0x100]");
    assert_eq!(ram[0x200], 0x00, "Hard reset should zero RAM[0x200]");
}

#[test]
fn test_soft_reset_preserves_ram() {
    let mut config = Config::with_defaults();
    config.frontend.ram_init_mode = RamInitMode::Zero;
    let mut nes = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config,
    ));

    // Insert a cartridge so reset works
    let rom_data = create_test_rom();
    let cartridge = load_test_cartridge(&rom_data, "ram-init-soft-reset.nes");
    nes.insert_cartridge(cartridge);

    // Write some non-zero data to RAM
    {
        let bus = nes.bus().borrow();
        let ram_rc = bus.cpu_ram_ref();
        let mut ram = ram_rc.borrow_mut();
        ram[0x100] = 0xFF;
        ram[0x200] = 0xAA;
    }

    // Soft reset (soft_reset = true) should preserve RAM
    nes.reset(true);

    let bus = nes.bus().borrow();
    let ram_rc = bus.cpu_ram_ref();
    let ram = ram_rc.borrow();
    assert_eq!(ram[0x100], 0xFF, "Soft reset should preserve RAM[0x100]");
    assert_eq!(ram[0x200], 0xAA, "Soft reset should preserve RAM[0x200]");
}

#[test]
fn test_ppu_hard_reset_reinitializes_ram() {
    let mut config = Config::with_defaults();
    config.frontend.ram_init_mode = RamInitMode::Zero;
    let mut nes = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config,
    ));

    // Insert a cartridge so reset works
    let rom_data = create_test_rom();
    let cartridge = load_test_cartridge(&rom_data, "ram-init-ppu-hard-reset.nes");
    nes.insert_cartridge(cartridge);

    // Write some non-zero data to PPU nametable
    {
        let mut bus = nes.bus().borrow_mut();
        // Write via PPU registers
        bus.write(0x2006, 0x20, false); // PPUADDR high
        bus.write(0x2006, 0x00, false); // PPUADDR low
        bus.write(0x2007, 0xFF, false); // PPUDATA
    }

    // Hard reset should re-initialize PPU RAM to zero
    nes.reset(false);

    assert_eq!(
        nes.ppu().borrow().read_nametable_for_debug(0x2000),
        0x00,
        "Hard reset should zero PPU nametable"
    );
}

#[test]
fn test_ppu_soft_reset_preserves_ram() {
    let mut config = Config::with_defaults();
    config.frontend.ram_init_mode = RamInitMode::Zero;
    let mut nes = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config,
    ));

    // Insert a cartridge so reset works
    let rom_data = create_test_rom();
    let cartridge = load_test_cartridge(&rom_data, "ram-init-ppu-soft-reset.nes");
    nes.insert_cartridge(cartridge);

    // Write some non-zero data to PPU nametable
    {
        let mut bus = nes.bus().borrow_mut();
        bus.write(0x2006, 0x20, false); // PPUADDR high
        bus.write(0x2006, 0x00, false); // PPUADDR low
        bus.write(0x2007, 0xFF, false); // PPUDATA
    }

    // Soft reset should preserve PPU RAM
    nes.reset(true);

    assert_eq!(
        nes.ppu().borrow().read_nametable_for_debug(0x2000),
        0xFF,
        "Soft reset should preserve PPU nametable"
    );
}

#[test]
fn test_ppu_palette_ram_init_zero_mode() {
    // Verify that PPU palette RAM ($3F00-$3F1F) is initialized according to
    // the configured RAM init mode, using the PPU register interface.
    let mut config = Config::with_defaults();
    config.frontend.ram_init_mode = RamInitMode::Zero;
    let nes = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config,
    ));

    // Access palette RAM via PPUADDR ($2006) and PPUDATA ($2007).
    // For Zero mode, all palette entries should read back as 0x00.
    {
        let mut bus = nes.bus().borrow_mut();

        for offset in 0u16..32 {
            let addr = 0x3F00u16 + offset;
            let high = (addr >> 8) as u8;
            let low = (addr & 0x00FF) as u8;

            // Set PPU address to the palette entry.
            bus.write(0x2006, high, false);
            bus.write(0x2006, low, false);

            let value = bus.read(0x2007, false);
            assert_eq!(
                value, 0x00,
                "Palette RAM at ${:04X} should be initialized to 0x00 in Zero mode",
                addr
            );
        }
    }
}

#[test]
fn test_oam_ram_initialization_zero_mode() {
    let mut config = Config::with_defaults();
    config.frontend.ram_init_mode = RamInitMode::Zero;
    let nes = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config,
    ));

    // Access OAM via OAMDATA ($2004) after setting OAMADDR ($2003)
    {
        let mut bus = nes.bus().borrow_mut();

        // Check all 256 bytes of OAM
        for addr in 0u8..=255 {
            bus.write(0x2003, addr, false); // OAMADDR
            let value = bus.read(0x2004, false); // OAMDATA
            assert_eq!(
                value, 0x00,
                "OAM[{:#04X}] should be initialized to 0x00 in Zero mode",
                addr
            );
        }
    }
}

#[test]
fn test_oam_ram_initialization_seeded_random_deterministic() {
    let mut config1 = Config::with_defaults();
    config1.frontend.ram_init_mode = RamInitMode::SeededRandom(42);
    let nes1 = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config1,
    ));

    let mut config2 = Config::with_defaults();
    config2.frontend.ram_init_mode = RamInitMode::SeededRandom(42);
    let nes2 = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config2,
    ));

    // OAM should be identical for same seed
    {
        let mut bus1 = nes1.bus().borrow_mut();
        let mut bus2 = nes2.bus().borrow_mut();

        // Sample OAM values at various addresses
        for addr in [0u8, 1, 10, 50, 100, 200, 255] {
            bus1.write(0x2003, addr, false);
            bus2.write(0x2003, addr, false);

            let value1 = bus1.read(0x2004, false);
            let value2 = bus2.read(0x2004, false);

            assert_eq!(
                value1, value2,
                "OAM[{:#04X}] should match with same seed",
                addr
            );
        }
    }
}

#[test]
fn test_oam_hard_reset_reinitializes() {
    let mut config = Config::with_defaults();
    config.frontend.ram_init_mode = RamInitMode::Zero;
    let mut nes = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config,
    ));

    // Insert a cartridge so reset works
    let rom_data = create_test_rom();
    let cartridge = load_test_cartridge(&rom_data, "ram-init-oam-hard-reset.nes");
    nes.insert_cartridge(cartridge);

    // Write some non-zero data to OAM
    {
        let mut bus = nes.bus().borrow_mut();
        bus.write(0x2003, 5, false); // OAMADDR = 5
        bus.write(0x2004, 0xFF, false); // OAMDATA = 0xFF (writes to addr 5, increments to 6)
        bus.write(0x2003, 20, false); // OAMADDR = 20
        bus.write(0x2004, 0xAA, false); // OAMDATA = 0xAA (writes to addr 20, increments to 21)
    }

    // Hard reset should re-initialize OAM to zero
    nes.reset(false);

    {
        let mut bus = nes.bus().borrow_mut();
        bus.write(0x2003, 5, false);
        assert_eq!(
            bus.read(0x2004, false),
            0x00,
            "Hard reset should zero OAM[5]"
        );
        bus.write(0x2003, 20, false);
        assert_eq!(
            bus.read(0x2004, false),
            0x00,
            "Hard reset should zero OAM[20]"
        );
    }
}

#[test]
fn test_oam_soft_reset_preserves() {
    let mut config = Config::with_defaults();
    config.frontend.ram_init_mode = RamInitMode::Zero;
    let mut nes = Nes::new(crate::platform::app_context::AppContext::new_with_config(
        config,
    ));

    // Insert a cartridge so reset works
    let rom_data = create_test_rom();
    let cartridge = load_test_cartridge(&rom_data, "ram-init-oam-soft-reset.nes");
    nes.insert_cartridge(cartridge);

    // Write some non-zero data to OAM
    {
        let mut bus = nes.bus().borrow_mut();
        bus.write(0x2003, 5, false); // OAMADDR = 5
        bus.write(0x2004, 0xFF, false); // OAMDATA = 0xFF (writes to addr 5, increments to 6)
        bus.write(0x2003, 20, false); // OAMADDR = 20
        bus.write(0x2004, 0xAA, false); // OAMDATA = 0xAA (writes to addr 20, increments to 21)
    }

    // Soft reset should preserve OAM
    nes.reset(true);

    {
        let mut bus = nes.bus().borrow_mut();
        bus.write(0x2003, 5, false);
        assert_eq!(
            bus.read(0x2004, false),
            0xFF,
            "Soft reset should preserve OAM[5]"
        );
        bus.write(0x2003, 20, false);
        assert_eq!(
            bus.read(0x2004, false),
            0xAA,
            "Soft reset should preserve OAM[20]"
        );
    }
}