Centralize use of constants

Author: Baekalfen

pyboy/core/cpu.py

@@ -5,9 +5,9 @@
 import pyboy
 
 from . import opcodes
+from pyboy.utils import INTR_VBLANK, INTR_LCDC, INTR_TIMER, INTR_SERIAL, INTR_HIGHTOLOW
 
 FLAGC, FLAGH, FLAGN, FLAGZ = range(4, 8)
-INTR_VBLANK, INTR_LCDC, INTR_TIMER, INTR_SERIAL, INTR_HIGHTOLOW = [1 << x for x in range(5)]
 
 
 logger = pyboy.logging.get_logger(__name__)

pyboy/core/lcd.pxd

@@ -14,7 +14,7 @@ from pyboy.logging.logging cimport Logger
 from pyboy.utils cimport IntIOInterface
 
 
-cdef uint8_t INTR_VBLANK, INTR_LCDC, INTR_TIMER, INTR_SERIAL, INTR_HIGHTOLOW
+cdef uint8_t INTR_VBLANK, INTR_LCDC
 cdef uint16_t LCDC, STAT, SCY, SCX, LY, LYC, DMA, BGP, OBP0, OBP1, WY, WX
 cdef int ROWS, COLS, TILES, FRAME_CYCLES, VIDEO_RAM, OBJECT_ATTRIBUTE_MEMORY
 cdef uint32_t COL0_FLAG, BG_PRIORITY_FLAG

pyboy/core/lcd.py

@@ -8,17 +8,13 @@
 from random import getrandbits
 
 import pyboy
-from pyboy.utils import PyBoyException
+from pyboy.utils import PyBoyException, INTR_VBLANK, INTR_LCDC, FRAME_CYCLES
+from pyboy.api.constants import ROWS, COLS, TILES
 
 logger = pyboy.logging.get_logger(__name__)
 
 VIDEO_RAM = 8 * 1024  # 8KB
 OBJECT_ATTRIBUTE_MEMORY = 0xA0
-INTR_VBLANK, INTR_LCDC, INTR_TIMER, INTR_SERIAL, INTR_HIGHTOLOW = [1 << x for x in range(5)]
-ROWS, COLS = 144, 160
-TILES = 384
-
-FRAME_CYCLES = 70224
 
 
 def rgb_to_bgr(color):
@@ -622,7 +618,7 @@ def scanline_sprites(self, lcd, ly, buffer, buffer_attributes, ignore_priority):
         # The lowest X-coordinate has priority, when overlapping
         spriteheight = 16 if lcd._LCDC.sprite_height else 8
         sprite_count = 0
-        for n in range(0x00, 0xA0, 4):
+        for n in range(0x00, OBJECT_ATTRIBUTE_MEMORY, 4):
             y = lcd.OAM[n] - 16  # Documentation states the y coordinate needs to be subtracted by 16
             x = lcd.OAM[n + 1] - 8  # Documentation states the x coordinate needs to be subtracted by 8
 

pyboy/core/mb.pxd

@@ -23,8 +23,8 @@ cdef Logger logger
 
 cdef int64_t MAX_CYCLES
 cdef uint16_t STAT, LY, LYC
-cdef short VBLANK, LCDC, TIMER, SERIAL, HIGHTOLOW
-cdef int INTR_VBLANK, INTR_LCDC, INTR_TIMER, INTR_SERIAL, INTR_HIGHTOLOW
+cdef int INTR_TIMER, INTR_HIGHTOLOW
+cdef uint16_t OPCODE_BRK
 cdef int STATE_VERSION
 
 

pyboy/core/mb.py

@@ -4,16 +4,18 @@
 #
 
 import pyboy
-from pyboy.utils import STATE_VERSION, PyBoyException, PyBoyOutOfBoundsException
+from pyboy.utils import (
+    STATE_VERSION,
+    PyBoyException,
+    PyBoyOutOfBoundsException,
+    INTR_TIMER,
+    INTR_HIGHTOLOW,
+    OPCODE_BRK,
+)
 
 from . import bootrom, cartridge, cpu, interaction, lcd, ram, sound, timer
 
-INTR_VBLANK, INTR_LCDC, INTR_TIMER, INTR_SERIAL, INTR_HIGHTOLOW = [1 << x for x in range(5)]
-OPCODE_BRK = 0xDB
-
-
 logger = pyboy.logging.get_logger(__name__)
-
 MAX_CYCLES = 1 << 31
 
 

pyboy/core/sound.pxd

@@ -8,7 +8,8 @@ from libc.stdint cimport int8_t, int64_t, uint8_t, uint16_t, uint64_t
 
 from pyboy.logging.logging cimport Logger
 from pyboy.utils cimport IntIOInterface, double_to_uint64_ceil
-from pyboy.core.lcd cimport FRAME_CYCLES
+
+cdef int FRAME_CYCLES
 
 
 cdef Logger logger

pyboy/core/sound.py

@@ -12,10 +12,9 @@
 
 import pyboy
 from pyboy.utils import PyBoyAssertException, cython_compiled
+from pyboy.utils import FRAME_CYCLES
 
 if not cython_compiled:
-    from pyboy.core.lcd import FRAME_CYCLES
-
     # Hide it from Cython in 'exec' statement
     exec("from pyboy.utils import double_to_uint64_ceil")
 

pyboy/plugins/game_wrapper_super_mario_land.pxd

@@ -11,7 +11,7 @@ from pyboy.plugins.base_plugin cimport PyBoyGameWrapper
 
 cdef Logger logger
 
-cdef int ROWS, COLS
+cdef int TILES
 
 
 cdef class GameWrapperSuperMarioLand(PyBoyGameWrapper):

pyboy/plugins/game_wrapper_super_mario_land.py

@@ -11,6 +11,7 @@
 
 import pyboy
 from pyboy.utils import PyBoyException, PyBoyInvalidInputException, _bcd_to_dec, bcd_to_dec, dec_to_bcd
+from pyboy.api.constants import TILES
 
 from .base_plugin import PyBoyGameWrapper
 
@@ -86,7 +87,6 @@
 explosion = [157, 158]
 spike = [237]
 
-TILES = 384
 mapping_minimal = np.zeros(TILES, dtype=np.uint8)
 minimal_list = [
     base_scripts + plane + submarine,

pyboy/plugins/game_wrapper_tetris.pxd

@@ -11,7 +11,7 @@ from pyboy.plugins.base_plugin cimport PyBoyGameWrapper
 
 cdef Logger logger
 
-cdef int ROWS, COLS
+cdef int TILES
 cdef int NEXT_TETROMINO_ADDR
 
 cdef class GameWrapperTetris(PyBoyGameWrapper):

pyboy/plugins/game_wrapper_tetris.py

@@ -13,6 +13,7 @@
 import pyboy
 
 from .base_plugin import PyBoyGameWrapper
+from pyboy.api.constants import TILES
 
 logger = pyboy.logging.get_logger(__name__)
 
@@ -31,8 +32,6 @@
 NEXT_TETROMINO_ADDR = 0xC213
 
 # Construct a translation table for tile ID's to a minimal/compressed id system
-TILES = 384
-
 # Compressed assigns an ID to each Tetromino type
 mapping_compressed = np.zeros(TILES, dtype=np.uint8)
 # BLANK, J, Z, O, L, T, S, I, BLACK

pyboy/pyboy.pxd

@@ -19,6 +19,7 @@ from pyboy.logging.logging cimport Logger
 from pyboy.plugins.manager cimport PluginManager
 from pyboy.utils cimport IntIOInterface, IntIOWrapper
 
+cdef int TILES, TILES_CGB, OPCODE_BRK
 
 cdef Logger logger
 

pyboy/pyboy.py

@@ -13,6 +13,7 @@
 
 import numpy as np
 
+from pyboy.api.constants import TILES, TILES_CGB
 from pyboy.api.gameshark import GameShark
 from pyboy.api.memory_scanner import MemoryScanner
 from pyboy.api.screen import Screen
@@ -28,6 +29,7 @@
     PyBoyOutOfBoundsException,
     WindowEvent,
     cython_compiled,
+    OPCODE_BRK,
 )
 
 try:
@@ -997,7 +999,8 @@ def game_area_mapping(self, mapping, sprite_offset=0):
 
         Example of custom mapping:
         ```python
-        >>> mapping = [x for x in range(384)] # 1:1 mapping
+        >>> from pyboy.api.constants import TILES
+        >>> mapping = [x for x in range(TILES)] # 1:1 mapping of 384 tiles
         >>> mapping[0] = 0 # Map tile identifier 0 -> 0
         >>> mapping[1] = 0 # Map tile identifier 1 -> 0
         >>> mapping[2] = 0 # Map tile identifier 2 -> 0
@@ -1019,11 +1022,11 @@ def game_area_mapping(self, mapping, sprite_offset=0):
         """
 
         if mapping is None:
-            mapping = [x for x in range(768)]
+            mapping = [x for x in range(TILES_CGB)]
 
         assert isinstance(sprite_offset, int)
         assert isinstance(mapping, (np.ndarray, list))
-        assert len(mapping) == 384 or len(mapping) == 768
+        assert len(mapping) == TILES or len(mapping) == TILES_CGB
 
         self.game_wrapper.game_area_mapping(mapping, sprite_offset)
 
@@ -1231,7 +1234,7 @@ def hook_register(self, bank, addr, callback, context):
             bank, addr = self._lookup_symbol(addr)
 
         opcode = self.memory[bank, addr]
-        if opcode == 0xDB:
+        if opcode == OPCODE_BRK:
             raise ValueError("Hook already registered for this bank and address.")
         self.mb.breakpoint_add(bank, addr)
         bank_addr_opcode = (bank & 0xFF) << 24 | (addr & 0xFFFF) << 8 | (opcode & 0xFF)

pyboy/utils.py

@@ -22,6 +22,10 @@
 
 STATE_VERSION = 14
 
+INTR_VBLANK, INTR_LCDC, INTR_TIMER, INTR_SERIAL, INTR_HIGHTOLOW = [1 << x for x in range(5)]
+OPCODE_BRK = 0xDB
+FRAME_CYCLES = 70224
+
 
 class PyBoyException(Exception):
     """

tests/test_game_wrapper.py

@@ -6,7 +6,7 @@
 import numpy as np
 
 from pyboy import PyBoy
-from pyboy.api.constants import LCDC_OFFSET, OAM_OFFSET, VRAM_OFFSET
+from pyboy.api.constants import LCDC_OFFSET, OAM_OFFSET, VRAM_OFFSET, TILES
 
 
 def test_game_wrapper_basics(default_rom):
@@ -74,7 +74,7 @@ def test_game_wrapper_mapping(default_rom):
     )
 
     # List-based mapping, don't call tick
-    mapping = [x for x in range(384)]  # 1:1 mapping
+    mapping = [x for x in range(TILES)]  # 1:1 mapping
     mapping[0] = 10
     mapping[1] = 10
     mapping[2] = 10

tests/test_lcd.py

@@ -10,17 +10,14 @@
 import numpy as np
 from pyboy import PyBoy
 from pyboy.core.lcd import LCD, Renderer
-from pyboy.utils import cython_compiled
-
-INTR_VBLANK, INTR_LCDC, INTR_TIMER, INTR_SERIAL, INTR_HIGHTOLOW = [1 << x for x in range(5)]
+from pyboy.utils import cython_compiled, INTR_LCDC, FRAME_CYCLES
 
 color_palette = (0xFFFFFF, 0x999999, 0x555555, 0x000000)
 cgb_color_palette = (
     (0xFFFFFF, 0x7BFF31, 0x0063C5, 0x000000),
     (0xFFFFFF, 0xFF8484, 0xFF8484, 0x000000),
     (0xFFFFFF, 0xFF8484, 0xFF8484, 0x000000),
 )
-FRAME_CYCLES = 70224
 
 
 @pytest.mark.skipif(cython_compiled, reason="This test requires access to internal registers not available in Cython")