324. Флаг вертикального зеркалирования iNES

Декодировать горизонтальное/вертикальное зеркалирование nametable из бита 0 flags 6 iNES.

Урок 324 из 356 · tests/chapter_12_mirroring/test_324_ines_vertical_mirroring_flag.py

Файл для обновления

emulator/cartridge/ines.py

Справочный материал

https://www.nesdev.org/wiki/Mirroring#Nametable_Mirroring

Зачем нужен этот шаг

Прежде чем реализовывать область просмотра прокрутки, эмулятор должен знать, как картридж подключает логические nametable PPU к физической RAM nametable.

Зеркалирование визуально не переворачивает изображение. Оно управляет отображением памяти между четырьмя логическими областями nametable:

$2000
$2400
$2800
$2C00

Бит 0 flags 6 iNES выбирает базовый режим зеркалирования:

bit 0 clear -> horizontal mirroring
bit 0 set   -> vertical mirroring

Для текущего инкрементального объёма работы предоставим это как одно булево свойство

is_vertical_mirroring is False -> horizontal
is_vertical_mirroring is True  -> vertical

Пример предлагаемой реализации

FLAGS6_VERTICAL_MIRRORING = 1 << 0


@dataclass(frozen=True)
class INesHeader:
    prg_rom_banks: int
    chr_rom_banks: int
    mapper_number: int
    has_trainer: bool
    flags_6: int
    flags_7: int

    @property
    def is_vertical_mirroring(self) -> bool:
        return (self.flags_6 & FLAGS6_VERTICAL_MIRRORING) != 0

Почему вычисляемое свойство? flags_6 остаётся единственным источником истины, а существующий конструктор INesHeader менять не нужно. Это сохраняет совместимость со старыми вызывающими кодами и тестами из туториала.

Будущее расширение

Четырёхэкранное зеркалирование позже сможет добавить свойство is_four_screen, проверяемое перед is_vertical_mirroring. Хранение и маршрутизация для четырёхэкранного режима здесь не реализуются.

Вне рамок

изменение Cartridge
изменение Mapper000
изменение отображения nametable в PpuBus
четырёхэкранная RAM nametable
прокрутка
фикстуры коммерческих ROM

Запустить этот урок

uv run pytest tests/chapter_12_mirroring/test_324_ines_vertical_mirroring_flag.py -v

Пример реализации

Пример предлагаемой реализации

FLAGS6_VERTICAL_MIRRORING = 1 << 0


@dataclass(frozen=True)
class INesHeader:
    prg_rom_banks: int
    chr_rom_banks: int
    mapper_number: int
    has_trainer: bool
    flags_6: int
    flags_7: int

    @property
    def is_vertical_mirroring(self) -> bool:
        return (self.flags_6 & FLAGS6_VERTICAL_MIRRORING) != 0

Показать код тестаtest_324_ines_vertical_mirroring_flag.py

from emulator.cartridge.ines import (
    FLAGS6_VERTICAL_MIRRORING,
    INES_MAGIC,
    INesHeader,
    parse_ines_header,
)


def make_header_bytes(flags_6: int = 0, flags_7: int = 0) -> bytes:
    """Build a minimal 16-byte iNES header with configurable flag bytes."""
    return bytes([
        *INES_MAGIC,
        1,
        1,
        flags_6,
        flags_7,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
    ])


def test_flags6_vertical_mirroring_constant_names_bit_zero():
    """
    Objective:
    Give iNES flags 6 bit 0 a domain-specific name instead of repeating a magic
    binary literal.
    """
    assert FLAGS6_VERTICAL_MIRRORING == 1 << 0


def test_ines_header_exposes_vertical_mirroring_property():
    """
    Objective:
    Mirroring metadata should be available directly from an INesHeader instance.
    """
    header = INesHeader(
        prg_rom_banks=1,
        chr_rom_banks=1,
        mapper_number=0,
        has_trainer=False,
        flags_6=0,
        flags_7=0,
    )

    assert hasattr(header, "is_vertical_mirroring")
    assert isinstance(header.is_vertical_mirroring, bool)


def test_flags6_bit_zero_clear_means_horizontal_mirroring():
    """
    Objective:
    False means horizontal mirroring; it does not mean mirroring is disabled.
    """
    header = parse_ines_header(make_header_bytes(flags_6=0b0000_0000))

    assert header.is_vertical_mirroring is False


def test_flags6_bit_zero_set_means_vertical_mirroring():
    """
    Objective:
    Setting flags 6 bit 0 requests vertical nametable mirroring.
    """
    header = parse_ines_header(
        make_header_bytes(flags_6=FLAGS6_VERTICAL_MIRRORING)
    )

    assert header.is_vertical_mirroring is True


def test_unrelated_flags6_bits_do_not_select_vertical_mirroring():
    """
    Objective:
    Trainer and mapper bits must not be confused with the mirroring bit.
    """
    unrelated_bits = 0b1010_0100
    assert (unrelated_bits & FLAGS6_VERTICAL_MIRRORING) == 0

    header = parse_ines_header(make_header_bytes(flags_6=unrelated_bits))

    assert header.is_vertical_mirroring is False


def test_vertical_mirroring_bit_can_coexist_with_other_flags():
    """
    Objective:
    Mirroring decoding should inspect bit 0 without discarding trainer or mapper
    information from the same flags byte.
    """
    flags_6 = 0b0010_0101

    header = parse_ines_header(make_header_bytes(flags_6=flags_6))

    assert header.is_vertical_mirroring is True
    assert header.has_trainer is True
    assert header.mapper_number == 2


def test_mirroring_property_does_not_change_ines_header_constructor_shape():
    """
    Objective:
    The property is computed from existing flags_6 metadata, so historical direct
    INesHeader construction remains valid.
    """
    header = INesHeader(1, 1, 0, False, 0, 0)

    assert header.prg_rom_banks == 1
    assert header.chr_rom_banks == 1
    assert header.is_vertical_mirroring is False

Тестовые функции (7)

test_flags6_vertical_mirroring_constant_names_bit_zero
test_ines_header_exposes_vertical_mirroring_property
test_flags6_bit_zero_clear_means_horizontal_mirroring
test_flags6_bit_zero_set_means_vertical_mirroring
test_unrelated_flags6_bits_do_not_select_vertical_mirroring
test_vertical_mirroring_bit_can_coexist_with_other_flags
test_mirroring_property_does_not_change_ines_header_constructor_shape