neser 0.1.0

NESER - NES Emulator in Rust - is a NES emulator written in Rust. It aims to be a high-quality, hardware-accurate emulator that is also easy to use and extend. It supports a wide range of NES games and features, including various mappers, audio processing, and input handling. NESER is designed to be modular and extensible, allowing developers to easily add new features or support for additional hardware. It can be run using one of two frontends: a native desktop application using SDL2, or a web application using WebAssembly. The desktop application provides a high-performance, feature-rich experience with support for various input devices and display options, while the web application allows users to play NES games directly in their browsers without needing to install any software in a BYOR manner (Bring Your Own Roms).
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
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
use crate::bus::bus::BusDevice;
use crate::input::ArkanoidController;
use crate::input::Controller;
use crate::input::PowerPad;
use crate::input::Zapper;
use std::cell::RefCell;
use std::ops::RangeInclusive;
use std::rc::Rc;

pub(crate) struct ControllerDevice {
    controllers: [Rc<RefCell<Box<dyn Controller>>>; 2],
    four_score_extra_button_states: Rc<RefCell<[u8; 2]>>,
    four_score_enabled: bool,
    four_score_strobe: bool,
    four_score_index: [u8; 2],
    famicom_four_players_enabled: bool,
    famicom_four_players_strobe: bool,
    famicom_four_players_index: [u8; 2],
    famicom_mode: bool,
    arkanoid_expansion: Option<Rc<RefCell<ArkanoidController>>>,
    arkanoid_famicom_enabled: bool,
    zapper_expansion: Option<Rc<RefCell<Zapper>>>,
    zapper_famicom_enabled: bool,
    power_pad_expansion: Option<Rc<RefCell<PowerPad>>>,
    power_pad_famicom_enabled: bool,
}

impl ControllerDevice {
    #[cfg(test)]
    pub(crate) fn new(
        port1_controller: Rc<RefCell<Box<dyn Controller>>>,
        port2_controller: Rc<RefCell<Box<dyn Controller>>>,
    ) -> Self {
        Self::new_with_four_score_state(
            port1_controller,
            port2_controller,
            false,
            false,
            Rc::new(RefCell::new([0, 0])),
        )
    }

    pub(crate) fn new_with_four_score_state(
        port1_controller: Rc<RefCell<Box<dyn Controller>>>,
        port2_controller: Rc<RefCell<Box<dyn Controller>>>,
        four_score_enabled: bool,
        famicom_four_players_enabled: bool,
        four_score_extra_button_states: Rc<RefCell<[u8; 2]>>,
    ) -> Self {
        Self {
            controllers: [port1_controller, port2_controller],
            four_score_extra_button_states,
            four_score_enabled,
            four_score_strobe: false,
            four_score_index: [0, 0],
            famicom_four_players_enabled,
            famicom_four_players_strobe: false,
            famicom_four_players_index: [0, 0],
            famicom_mode: false,
            arkanoid_expansion: None,
            arkanoid_famicom_enabled: false,
            zapper_expansion: None,
            zapper_famicom_enabled: false,
            power_pad_expansion: None,
            power_pad_famicom_enabled: false,
        }
    }

    pub(crate) fn set_four_score_enabled(&mut self, enabled: bool) {
        self.four_score_enabled = enabled;
        self.four_score_index = [0, 0];
        self.four_score_strobe = false;
    }

    pub(crate) fn set_famicom_four_players_enabled(&mut self, enabled: bool) {
        self.famicom_four_players_enabled = enabled;
        self.famicom_four_players_index = [0, 0];
        self.famicom_four_players_strobe = false;
    }

    pub(crate) fn set_arkanoid_famicom_expansion(
        &mut self,
        expansion: Option<Rc<RefCell<ArkanoidController>>>,
    ) {
        self.arkanoid_expansion = expansion;
    }

    pub(crate) fn set_arkanoid_famicom_enabled(&mut self, enabled: bool) {
        self.arkanoid_famicom_enabled = enabled;
    }

    pub(crate) fn set_zapper_famicom_expansion(&mut self, expansion: Option<Rc<RefCell<Zapper>>>) {
        self.zapper_expansion = expansion;
    }

    pub(crate) fn set_zapper_famicom_enabled(&mut self, enabled: bool) {
        self.zapper_famicom_enabled = enabled;
    }

    pub(crate) fn set_power_pad_famicom_expansion(
        &mut self,
        expansion: Option<Rc<RefCell<PowerPad>>>,
    ) {
        self.power_pad_expansion = expansion;
    }

    pub(crate) fn set_power_pad_famicom_enabled(&mut self, enabled: bool) {
        self.power_pad_famicom_enabled = enabled;
    }

    fn read_arkanoid_famicom_bit(&mut self, port_index: usize, is_dummy_read: bool) -> u8 {
        let mut controller_state = self.controllers[port_index]
            .borrow_mut()
            .read(is_dummy_read);

        if let Some(ref arkanoid) = self.arkanoid_expansion {
            let expansion_bit = if port_index == 0 {
                // $4016: fire button on bit 1
                arkanoid.borrow().read_expansion_trigger()
            } else {
                // $4017: serial knob data on bit 1
                arkanoid.borrow_mut().read_expansion_knob(is_dummy_read)
            };
            controller_state = (controller_state & !0x02) | expansion_bit;
        }

        controller_state
    }

    fn read_four_score_bit(&mut self, port_index: usize, is_dummy_read: bool) -> u8 {
        let idx = self.four_score_index[port_index];

        // Always read the full controller state once so we can preserve any
        // non-joypad bits (e.g., Zapper, Arkanoid) while still applying
        // Four Score's serial protocol on bit 0.
        let mut controller_state = self.controllers[port_index]
            .borrow_mut()
            .read(is_dummy_read);

        let serial_bit = if idx < 8 {
            // First 8 bits are the underlying controller's serial data (bit 0).
            controller_state & 0x01
        } else if idx < 16 {
            // Next 8 bits are extra buttons (players 3/4).
            let extra_state = self.four_score_extra_button_states.borrow();
            let player_state = extra_state[port_index];
            (player_state >> (idx - 8)) & 0x01
        } else if idx < 24 {
            // Next 8 bits are the Four Score signature.
            let signature = if port_index == 0 { 0x10 } else { 0x20 };
            (signature >> (idx - 16)) & 0x01
        } else {
            // Remaining reads return 1.
            1
        };

        // Preserve all higher bits from the underlying controller and only
        // override bit 0 with the Four Score serial bit.
        controller_state = (controller_state & !0x01) | serial_bit;

        if !is_dummy_read && !self.four_score_strobe {
            self.four_score_index[port_index] = self.four_score_index[port_index].saturating_add(1);
        }

        controller_state
    }

    fn read_famicom_four_players_bit(&mut self, port_index: usize, is_dummy_read: bool) -> u8 {
        let mut controller_state = self.controllers[port_index]
            .borrow_mut()
            .read(is_dummy_read);

        let idx = self.famicom_four_players_index[port_index];
        let extra_state = self.four_score_extra_button_states.borrow()[port_index];
        let serial_bit = if idx < 8 {
            (extra_state >> idx) & 0x01
        } else {
            1
        };

        controller_state = (controller_state & !0x02) | (serial_bit << 1);

        if !is_dummy_read && !self.famicom_four_players_strobe {
            self.famicom_four_players_index[port_index] =
                self.famicom_four_players_index[port_index].saturating_add(1);
        }

        controller_state
    }

    fn read_zapper_famicom_bit(&mut self, port_index: usize, is_dummy_read: bool) -> u8 {
        let mut controller_state = self.controllers[port_index]
            .borrow_mut()
            .read(is_dummy_read);

        // Famicom expansion connector only routes bits 1-4 on $4017;
        // $4016 only exposes bit 1 from expansion, so Zapper bits 3-4
        // are not connected on $4016 reads.
        if let (1, Some(zapper)) = (port_index, &self.zapper_expansion) {
            // Zapper expansion port: trigger on bit 4, light sense on bit 3
            let zapper_bits = zapper.borrow_mut().read(is_dummy_read);
            controller_state = (controller_state & !0x18) | (zapper_bits & 0x18);
        }

        controller_state
    }

    fn read_power_pad_famicom_bit(&mut self, port_index: usize, is_dummy_read: bool) -> u8 {
        if port_index != 1 {
            return self.controllers[port_index]
                .borrow_mut()
                .read(is_dummy_read);
        }

        let mut controller_state = self.controllers[port_index]
            .borrow_mut()
            .read(is_dummy_read);

        if let Some(power_pad) = &self.power_pad_expansion {
            let power_pad_bits = power_pad.borrow_mut().read(is_dummy_read);
            controller_state = (controller_state & !0x18) | (power_pad_bits & 0x18);
        }

        controller_state
    }
}

impl BusDevice for ControllerDevice {
    fn read(&mut self, addr: u16, open_bus: u8, is_dummy_read: bool) -> Option<u8> {
        let index = (addr - 0x4016) as usize;

        let mut controller_state = if self.four_score_enabled {
            self.read_four_score_bit(index, is_dummy_read)
        } else if self.famicom_four_players_enabled {
            self.read_famicom_four_players_bit(index, is_dummy_read)
        } else if self.arkanoid_famicom_enabled {
            self.read_arkanoid_famicom_bit(index, is_dummy_read)
        } else if self.zapper_famicom_enabled {
            self.read_zapper_famicom_bit(index, is_dummy_read)
        } else if self.power_pad_famicom_enabled {
            self.read_power_pad_famicom_bit(index, is_dummy_read)
        } else {
            self.controllers[index].borrow_mut().read(is_dummy_read)
        };
        // In Famicom mode, $4016 bit 2 is the controller 2 microphone line.
        // Until mic input is implemented, we explicitly stub it as always 0
        // to match hardware docs/tests and avoid leaking controller state.
        if self.famicom_mode && addr == 0x4016 {
            controller_state &= !0x04;
        }
        // Open bus behavior differs by hardware model:
        // NES-001: bits 5-7 are open bus; bits 0-4 driven by controller I/O.
        // Famicom (HVC-001): bits 3-7 are open bus; bits 0-2 driven
        //   (bit 0 = serial data, bit 1 = expansion port, bit 2 = mic/$4016 only).
        // When Zapper expansion is active on $4017, bits 3-4 are driven by
        //   the Zapper via the expansion port pins, so only bits 5-7 are open bus.
        //   $4016 keeps the standard Famicom mask since bits 3-4 are not routed
        //   to the expansion connector on that port.
        let open_bus_mask = if self.famicom_mode
            && !(self.zapper_famicom_enabled && addr == 0x4017)
            && !(self.power_pad_famicom_enabled && addr == 0x4017)
        {
            0xF8
        } else {
            0xE0
        };
        Some((open_bus & open_bus_mask) | (controller_state & !open_bus_mask))
    }

    fn write(&mut self, addr: u16, value: u8, _is_dummy_write: bool) -> bool {
        match addr {
            0x4016 => {
                let new_strobe = value & 0x01 != 0;
                if self.four_score_strobe && !new_strobe {
                    self.four_score_index = [0, 0];
                }
                self.four_score_strobe = new_strobe;

                if self.famicom_four_players_strobe && !new_strobe {
                    self.famicom_four_players_index = [0, 0];
                }
                self.famicom_four_players_strobe = new_strobe;

                self.controllers[0].borrow_mut().write_strobe(value);
                self.controllers[1].borrow_mut().write_strobe(value);

                if let Some(ref arkanoid) = self.arkanoid_expansion {
                    arkanoid.borrow_mut().write_strobe(value);
                }
                if let Some(ref power_pad) = self.power_pad_expansion {
                    power_pad.borrow_mut().write_strobe(value);
                }

                true
            }
            0x4017 => false,
            _ => false,
        }
    }

    fn address_range(&self) -> RangeInclusive<u16> {
        0x4016..=0x4017
    }

    fn sync_controller_modes(
        &mut self,
        four_score_enabled: bool,
        famicom_four_players_enabled: bool,
        famicom_mode: bool,
        arkanoid_famicom_enabled: bool,
        zapper_famicom_enabled: bool,
        power_pad_famicom_enabled: bool,
    ) {
        self.set_four_score_enabled(four_score_enabled);
        self.set_famicom_four_players_enabled(famicom_four_players_enabled);
        self.famicom_mode = famicom_mode;
        self.set_arkanoid_famicom_enabled(arkanoid_famicom_enabled);
        self.set_zapper_famicom_enabled(zapper_famicom_enabled);
        self.set_power_pad_famicom_enabled(power_pad_famicom_enabled);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::input::{Button, ControllerInput, PowerPad};

    fn read_24_bits(device: &mut ControllerDevice, addr: u16) -> u32 {
        let mut value = 0u32;
        for bit in 0..24 {
            let sample = device.read(addr, 0x00, false).unwrap() & 0x01;
            value |= (sample as u32) << bit;
        }
        value
    }

    struct TestController {
        reads: Rc<RefCell<u32>>,
        dummy_reads: Rc<RefCell<u32>>,
    }

    impl TestController {
        fn new(reads: Rc<RefCell<u32>>, dummy_reads: Rc<RefCell<u32>>) -> Self {
            Self { reads, dummy_reads }
        }
    }

    impl Controller for TestController {
        fn write_strobe(&mut self, _value: u8) {}

        fn read(&mut self, is_dummy_read: bool) -> u8 {
            if is_dummy_read {
                *self.dummy_reads.borrow_mut() += 1;
            } else {
                *self.reads.borrow_mut() += 1;
            }
            0
        }

        fn capture_state(&self) -> crate::input::ControllerState {
            crate::input::ControllerState::Joypad(crate::input::JoypadState {
                strobe: false,
                button_index: 0,
                button_states: 0,
            })
        }

        fn restore_state(&mut self, _state: &crate::input::ControllerState) {}

        fn set_button(&mut self, _button: Button, _pressed: bool) -> bool {
            true
        }

        fn set_mouse_x_position(&mut self, _position: u8) -> bool {
            false
        }

        fn set_mouse_y_position(&mut self, _position: u8) -> bool {
            false
        }

        fn set_mouse_left_button(&mut self, _pressed: bool) -> bool {
            false
        }

        fn input_type(&self) -> ControllerInput {
            ControllerInput::Gamepad
        }
    }

    fn create_test_controller_device() -> ControllerDevice {
        let reads = Rc::new(RefCell::new(0));
        let dummy_reads = Rc::new(RefCell::new(0));
        let controller1: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads.clone(), dummy_reads.clone()),
        )));
        let controller2: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads, dummy_reads),
        )));
        ControllerDevice::new(controller1, controller2)
    }

    #[test]
    fn test_dummy_read_uses_no_clock() {
        let reads = Rc::new(RefCell::new(0));
        let dummy_reads = Rc::new(RefCell::new(0));
        let reads_check = reads.clone();
        let dummy_reads_check = dummy_reads.clone();
        let controller1 = Rc::new(RefCell::new(Box::new(TestController::new(
            reads.clone(),
            dummy_reads.clone(),
        )) as Box<dyn Controller>));
        let controller2 = Rc::new(RefCell::new(
            Box::new(TestController::new(reads, dummy_reads)) as Box<dyn Controller>,
        ));

        let mut device = ControllerDevice::new(controller1, controller2);

        device.read(0x4016, 0xFF, true);

        assert_eq!(*reads_check.borrow(), 0);
        assert_eq!(*dummy_reads_check.borrow(), 1);
    }

    /// On NES-001, only bits 5-7 of $4016/$4017 are open bus.
    /// Bits 0-4 are driven by the controller I/O register.
    /// With open_bus = $BF and controller returning 0,
    /// the result should be $A0 (bits 5,7 from open bus).
    #[test]
    fn test_gamepad_open_bus_only_on_bits_5_to_7() {
        let mut device = create_test_controller_device();

        let result = device.read(0x4016, 0xBF, false).unwrap();
        assert_eq!(
            result, 0xA0,
            "Expected $A0 (only bits 5-7 from open bus), got ${:02X}",
            result
        );
    }

    /// With open_bus = $40, only bits 5-7 should reflect open bus.
    /// Controller returns 0, so result should be $40.
    #[test]
    fn test_gamepad_open_bus_with_40() {
        let mut device = create_test_controller_device();

        let result = device.read(0x4016, 0x40, false).unwrap();
        assert_eq!(
            result, 0x40,
            "Expected $40 (bits 5-7 from open bus $40), got ${:02X}",
            result
        );
    }

    /// On Famicom (HVC-001), bits 3-7 of $4016/$4017 are open bus.
    /// Bits 0-2 are driven (serial data, expansion, microphone).
    /// With open_bus = $40 and controller returning 0,
    /// the result should be $40 (bits 3-7 from open bus).
    #[test]
    fn test_famicom_open_bus_bits_3_to_7() {
        let mut device = create_test_controller_device();
        device.famicom_mode = true;

        let result = device.read(0x4016, 0x40, false).unwrap();
        assert_eq!(
            result, 0x40,
            "Expected $40 (bits 3-7 from open bus $40), got ${:02X}",
            result
        );
    }

    /// On Famicom, bits 3-4 should come from open bus, unlike NES-001.
    /// With open_bus = $18 (bits 3-4 set), controller returning 0,
    /// the result should be $18 on Famicom but $00 on NES-001.
    #[test]
    fn test_famicom_open_bus_bits_3_4_differ_from_nes() {
        let mut device = create_test_controller_device();

        // NES-001: bits 3-4 are driven (grounded), not open bus
        let nes_result = device.read(0x4016, 0x18, false).unwrap();
        assert_eq!(
            nes_result, 0x00,
            "NES-001 should ground bits 3-4, got ${:02X}",
            nes_result
        );

        // Famicom: bits 3-4 are open bus
        device.famicom_mode = true;
        let famicom_result = device.read(0x4016, 0x18, false).unwrap();
        assert_eq!(
            famicom_result, 0x18,
            "Famicom should pass bits 3-4 from open bus, got ${:02X}",
            famicom_result
        );
    }

    #[test]
    fn test_four_score_port1_sequence() {
        let reads = Rc::new(RefCell::new(0));
        let dummy_reads = Rc::new(RefCell::new(0));
        let controller1: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads.clone(), dummy_reads.clone()),
        )));
        let controller2: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads, dummy_reads),
        )));
        let mut device = ControllerDevice::new(controller1, controller2);
        device.set_four_score_enabled(true);

        // Strobe high->low latches and resets shift state.
        assert!(device.write(0x4016, 1, false));
        assert!(device.write(0x4016, 0, false));

        // Expected Four Score sequence on $4016:
        // P1 byte (all 0 in this fixture), P3 byte (all 0 in this fixture), signature $10.
        let bits = read_24_bits(&mut device, 0x4016);
        assert_eq!(bits, 0x0010_0000);
    }

    #[test]
    fn test_four_score_port2_sequence() {
        let reads = Rc::new(RefCell::new(0));
        let dummy_reads = Rc::new(RefCell::new(0));
        let controller1: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads.clone(), dummy_reads.clone()),
        )));
        let controller2: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads, dummy_reads),
        )));
        let mut device = ControllerDevice::new(controller1, controller2);
        device.set_four_score_enabled(true);

        // Strobe high->low latches and resets shift state.
        assert!(device.write(0x4016, 1, false));
        assert!(device.write(0x4016, 0, false));

        // Expected Four Score sequence on $4017:
        // P2 byte (all 0 in this fixture), P4 byte (all 0 in this fixture), signature $20.
        let bits = read_24_bits(&mut device, 0x4017);
        assert_eq!(bits, 0x0020_0000);
    }

    #[test]
    fn test_famicom_four_players_sets_player3_serial_on_4016_bit1() {
        let reads = Rc::new(RefCell::new(0));
        let dummy_reads = Rc::new(RefCell::new(0));
        let controller1: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads.clone(), dummy_reads.clone()),
        )));
        let controller2: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads, dummy_reads),
        )));
        let extra_states = Rc::new(RefCell::new([0x01, 0x00]));
        let mut device = ControllerDevice::new_with_four_score_state(
            controller1,
            controller2,
            false,
            true,
            extra_states,
        );

        assert!(device.write(0x4016, 1, false));
        assert!(device.write(0x4016, 0, false));

        let first = device.read(0x4016, 0x00, false).unwrap();
        assert_eq!(first & 0x02, 0x02);
    }

    #[test]
    fn test_famicom_four_players_sets_player4_serial_on_4017_bit1() {
        let reads = Rc::new(RefCell::new(0));
        let dummy_reads = Rc::new(RefCell::new(0));
        let controller1: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads.clone(), dummy_reads.clone()),
        )));
        let controller2: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads, dummy_reads),
        )));
        let extra_states = Rc::new(RefCell::new([0x00, 0x01]));
        let mut device = ControllerDevice::new_with_four_score_state(
            controller1,
            controller2,
            false,
            true,
            extra_states,
        );

        assert!(device.write(0x4016, 1, false));
        assert!(device.write(0x4016, 0, false));

        let first = device.read(0x4017, 0x00, false).unwrap();
        assert_eq!(first & 0x02, 0x02);
    }

    /// Famicom controller 2 has a microphone whose state is read on $4016 bit 2.
    /// This is a silent stub: bit 2 always reads 0 (no microphone input).
    #[test]
    fn test_famicom_microphone_bit2_of_4016_is_always_zero() {
        let reads = Rc::new(RefCell::new(0));
        let dummy_reads = Rc::new(RefCell::new(0));
        let controller1: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads.clone(), dummy_reads.clone()),
        )));
        let controller2: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads, dummy_reads),
        )));
        let mut device = ControllerDevice::new_with_four_score_state(
            controller1,
            controller2,
            false,
            true,                                // famicom_four_players_enabled (Famicom mode)
            Rc::new(RefCell::new([0xFF, 0xFF])), // all buttons pressed
        );

        // Strobe and read multiple times
        assert!(device.write(0x4016, 1, false));
        assert!(device.write(0x4016, 0, false));

        for _ in 0..16 {
            let value = device.read(0x4016, 0x00, false).unwrap();
            assert_eq!(
                value & 0x04,
                0,
                "Microphone bit (bit 2) should always be 0, got ${:02X}",
                value
            );
        }
    }

    fn create_arkanoid_expansion_device() -> (ControllerDevice, Rc<RefCell<ArkanoidController>>) {
        let reads = Rc::new(RefCell::new(0));
        let dummy_reads = Rc::new(RefCell::new(0));
        let controller1: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads.clone(), dummy_reads.clone()),
        )));
        let controller2: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads, dummy_reads),
        )));
        let arkanoid = Rc::new(RefCell::new(ArkanoidController::new()));
        let mut device = ControllerDevice::new(controller1, controller2);
        device.set_arkanoid_famicom_expansion(Some(arkanoid.clone()));
        device.set_arkanoid_famicom_enabled(true);
        device.famicom_mode = true;
        (device, arkanoid)
    }

    #[test]
    fn test_arkanoid_famicom_expansion_fire_on_4016_bit1() {
        let (mut device, arkanoid) = create_arkanoid_expansion_device();

        // Fire not pressed
        let value = device.read(0x4016, 0x00, false).unwrap();
        assert_eq!(
            value & 0x02,
            0x00,
            "Fire should be 0 when not pressed, got ${:02X}",
            value
        );

        // Fire pressed
        arkanoid.borrow_mut().set_trigger(true);
        let value = device.read(0x4016, 0x00, false).unwrap();
        assert_eq!(
            value & 0x02,
            0x02,
            "Fire should be 1 on bit 1 when pressed, got ${:02X}",
            value
        );
    }

    #[test]
    fn test_arkanoid_famicom_expansion_knob_on_4017_bit1() {
        let (mut device, arkanoid) = create_arkanoid_expansion_device();
        arkanoid.borrow_mut().set_position(0x92); // inverted: 0b0110_1101

        // Strobe to latch position
        assert!(device.write(0x4016, 1, false));
        assert!(device.write(0x4016, 0, false));

        // Read MSB first (inverted) on bit 1 of $4017
        let expected_bits = [0, 1, 1, 0, 1, 1, 0, 1];
        for (i, expected) in expected_bits.iter().enumerate() {
            let value = device.read(0x4017, 0x00, false).unwrap();
            assert_eq!(
                (value >> 1) & 0x01,
                *expected,
                "Bit {} expected {}, got value 0x{:02X}",
                i,
                expected,
                value
            );
        }
    }

    #[test]
    fn test_arkanoid_famicom_expansion_strobe_forwarded() {
        let (mut device, arkanoid) = create_arkanoid_expansion_device();
        arkanoid.borrow_mut().set_position(0x92);

        // Strobe and read first bit
        assert!(device.write(0x4016, 1, false));
        assert!(device.write(0x4016, 0, false));

        let first = device.read(0x4017, 0x00, false).unwrap();
        let _ = device.read(0x4017, 0x00, false).unwrap(); // advance

        // Strobe again - should reset shift register
        assert!(device.write(0x4016, 1, false));
        assert!(device.write(0x4016, 0, false));

        let after_strobe = device.read(0x4017, 0x00, false).unwrap();
        assert_eq!(
            first & 0x02,
            after_strobe & 0x02,
            "Strobe should reset shift register to first bit"
        );
    }

    #[test]
    fn test_arkanoid_famicom_expansion_does_not_affect_port_controller_bit0() {
        let (mut device, _arkanoid) = create_arkanoid_expansion_device();

        // Port controller returns 0 for all reads (TestController always returns 0)
        // Arkanoid expansion should only set bit 1, leaving bit 0 from port controller
        let value = device.read(0x4016, 0x00, false).unwrap();
        assert_eq!(
            value & 0x01,
            0x00,
            "Bit 0 should come from port controller, got ${:02X}",
            value
        );
    }

    fn create_zapper_expansion_device() -> (ControllerDevice, Rc<RefCell<crate::input::Zapper>>) {
        let reads = Rc::new(RefCell::new(0));
        let dummy_reads = Rc::new(RefCell::new(0));
        let controller1: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads.clone(), dummy_reads.clone()),
        )));
        let controller2: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads, dummy_reads),
        )));

        let ppu = Rc::new(RefCell::new(crate::ppu::Ppu::new_for_testing(
            crate::console::TimingMode::Ntsc,
        )));
        let app_context = Rc::new(RefCell::new(
            crate::app_context::AppContext::new_with_config(crate::console::Config::default()),
        ));
        let zapper = Rc::new(RefCell::new(crate::input::Zapper::new(ppu, app_context)));

        let mut device = ControllerDevice::new(controller1, controller2);
        device.set_zapper_famicom_expansion(Some(zapper.clone()));
        device.set_zapper_famicom_enabled(true);
        device.famicom_mode = true;
        (device, zapper)
    }

    fn create_power_pad_expansion_device() -> (ControllerDevice, Rc<RefCell<PowerPad>>) {
        let reads = Rc::new(RefCell::new(0));
        let dummy_reads = Rc::new(RefCell::new(0));
        let controller1: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads.clone(), dummy_reads.clone()),
        )));
        let controller2: Rc<RefCell<Box<dyn Controller>>> = Rc::new(RefCell::new(Box::new(
            TestController::new(reads, dummy_reads),
        )));

        let power_pad = Rc::new(RefCell::new(PowerPad::new()));
        let mut device = ControllerDevice::new(controller1, controller2);
        device.set_power_pad_famicom_expansion(Some(power_pad.clone()));
        device.set_power_pad_famicom_enabled(true);
        device.famicom_mode = true;
        (device, power_pad)
    }

    #[test]
    fn test_power_pad_famicom_expansion_serial_on_4017_bits_3_4() {
        let (mut device, power_pad) = create_power_pad_expansion_device();
        power_pad
            .borrow_mut()
            .set_button(crate::input::PowerPadButton::One, true);
        power_pad
            .borrow_mut()
            .set_button(crate::input::PowerPadButton::Four, true);

        assert!(device.write(0x4016, 1, false));
        assert!(device.write(0x4016, 0, false));

        let first = device.read(0x4017, 0x00, false).unwrap();
        let second = device.read(0x4017, 0x00, false).unwrap();
        assert_eq!(first & 0x18, 0x10);
        assert_eq!(second & 0x18, 0x08);
    }

    /// Famicom Zapper expansion port: trigger should appear on bit 4 of $4017 reads.
    #[test]
    fn test_zapper_famicom_expansion_trigger_on_4017_bit4() {
        let (mut device, zapper) = create_zapper_expansion_device();

        // Trigger not pressed
        let value = device.read(0x4017, 0x00, false).unwrap();
        assert_eq!(
            value & 0x10,
            0x00,
            "Trigger bit 4 should be 0 when not pressed, got ${:02X}",
            value
        );

        // Trigger pressed
        zapper.borrow_mut().set_mouse_left_button(true);
        let value = device.read(0x4017, 0x00, false).unwrap();
        assert_eq!(
            value & 0x10,
            0x10,
            "Trigger bit 4 should be 1 when pressed, got ${:02X}",
            value
        );
    }

    /// Famicom expansion connector only routes bits 1-4 on $4017; $4016 does
    /// not carry Zapper bits 3-4, so trigger must NOT appear on $4016.
    #[test]
    fn test_zapper_famicom_expansion_trigger_not_on_4016() {
        let (mut device, zapper) = create_zapper_expansion_device();

        zapper.borrow_mut().set_mouse_left_button(true);
        let value = device.read(0x4016, 0x00, false).unwrap();
        assert_eq!(
            value & 0x10,
            0x00,
            "Trigger bit 4 should NOT appear on $4016 (expansion bits only on $4017), got ${:02X}",
            value
        );
    }

    /// Famicom Zapper expansion port: light sense (no light) should set bit 3.
    #[test]
    fn test_zapper_famicom_expansion_light_sense_no_light_on_bit3() {
        let (mut device, _zapper) = create_zapper_expansion_device();

        // With no light detected (default state), bit 3 should be 1
        let value = device.read(0x4017, 0x00, false).unwrap();
        assert_eq!(
            value & 0x08,
            0x08,
            "Light sense bit 3 should be 1 when no light detected, got ${:02X}",
            value
        );
    }

    /// Famicom Zapper expansion port: standard controller bit 0 is preserved.
    #[test]
    fn test_zapper_famicom_expansion_does_not_affect_bit0() {
        let (mut device, _zapper) = create_zapper_expansion_device();

        // TestController always returns 0, so bit 0 should be 0
        let value = device.read(0x4017, 0x00, false).unwrap();
        assert_eq!(
            value & 0x01,
            0x00,
            "Bit 0 should come from port controller, got ${:02X}",
            value
        );
    }

    /// When Zapper expansion is active in Famicom mode, bits 3-4 on $4017
    /// should NOT be masked as open bus (the Zapper drives these expansion port pins).
    /// With open_bus = 0x00, the only source for bits 3-4 is the Zapper.
    #[test]
    fn test_zapper_famicom_expansion_open_bus_preserves_bits_3_4_on_4017() {
        let (mut device, zapper) = create_zapper_expansion_device();

        // Trigger pressed (bit 4), no light (bit 3) → both should come from Zapper, not open bus
        zapper.borrow_mut().set_mouse_left_button(true);
        let value = device.read(0x4017, 0x00, false).unwrap();
        assert_eq!(
            value & 0x18,
            0x18,
            "Bits 3-4 should be driven by Zapper expansion (not open bus 0x00). Got ${:02X}",
            value
        );
    }

    /// On $4016, bits 3-4 should remain open bus even with Zapper expansion active,
    /// since the Famicom expansion connector doesn't route those bits to $4016.
    #[test]
    fn test_zapper_famicom_expansion_open_bus_4016_keeps_famicom_mask() {
        let (mut device, zapper) = create_zapper_expansion_device();

        // Trigger pressed, but $4016 should use Famicom open bus mask (0xF8)
        zapper.borrow_mut().set_mouse_left_button(true);
        let value = device.read(0x4016, 0xFF, false).unwrap();
        assert_eq!(
            value & 0xF8,
            0xF8,
            "$4016 bits 3-7 should be open bus (mask 0xF8) even with Zapper expansion. Got ${:02X}",
            value
        );
    }
}