rubyboy 1.5.0 → 1.6.0

data/lib/rubyboy/lcd.rb

@@ -7,8 +7,9 @@ module Rubyboy
     SCREEN_WIDTH = 160
     SCREEN_HEIGHT = 144
     SCALE = 3
+    SDL_EVENT_SIZE = 56
 
-    def initialize
+    def initialize(vsync: nil)
       raise SDL.GetError() if SDL.InitSubSystem(SDL::INIT_VIDEO) != 0
 
       @buffer = FFI::MemoryPointer.new(:uint32, SCREEN_WIDTH * SCREEN_HEIGHT)
@@ -16,11 +17,19 @@ module Rubyboy
 
       raise SDL.GetError() if @window.null?
 
-      @renderer = SDL.CreateRenderer(@window, -1, 0)
+      begin
+        @renderer = SDL.CreateRenderer(@window, -1, 0)
+        raise SDL.GetError() if @renderer.null?
+        raise SDL.GetError() if !vsync.nil? && SDL.RenderSetVSync(@renderer, vsync ? 1 : 0) != 0
+      rescue StandardError
+        close_window
+        raise
+      end
+
       SDL.SetHint('SDL_HINT_RENDER_SCALE_QUALITY', '2')
       SDL.RenderSetLogicalSize(@renderer, SCREEN_WIDTH * SCALE, SCREEN_HEIGHT * SCALE)
       @texture = SDL.CreateTexture(@renderer, SDL::PIXELFORMAT_ABGR8888, 1, SCREEN_WIDTH, SCREEN_HEIGHT)
-      @event = FFI::MemoryPointer.new(:pointer)
+      @event = FFI::MemoryPointer.new(:uint8, SDL_EVENT_SIZE)
     end
 
     def draw(framebuffer)

data/lib/rubyboy/ram.rb

@@ -4,8 +4,8 @@ module Rubyboy
   class Ram
     attr_accessor :eram, :wram1, :wram2, :hram
 
-    def initialize
-      @eram = Array.new(0x2000, 0)
+    def initialize(rom)
+      @eram = Array.new(rom.ram_size_bytes, 0)
       @wram1 = Array.new(0x1000, 0)
       @wram2 = Array.new(0x1000, 0)
       @hram = Array.new(0x80, 0)

data/lib/rubyboy/rom.rb

@@ -10,11 +10,34 @@ module Rubyboy
       BB BB 67 63 6E 0E EC CC DD DC 99 9F BB B9 33 3E
     ].map(&:hex).freeze
 
+    RAM_SIZE_BYTES = {
+      0x00 => 0,
+      0x01 => 2 * 1024,
+      0x02 => 8 * 1024,
+      0x03 => 32 * 1024,
+      0x04 => 128 * 1024,
+      0x05 => 64 * 1024
+    }.freeze
+
+    BATTERY_CARTRIDGE_TYPES = [0x03, 0x06, 0x09, 0x0d, 0x0f, 0x10, 0x13, 0x1b, 0x1e, 0x22, 0xff].freeze
+
     def initialize(data)
       @data = data
       load_data
     end
 
+    def ram_size_bytes
+      RAM_SIZE_BYTES.fetch(@ram_size, 0)
+    end
+
+    def battery?
+      BATTERY_CARTRIDGE_TYPES.include?(@cartridge_type)
+    end
+
+    def global_checksum_value
+      (@global_checksum[0] << 8) | @global_checksum[1]
+    end
+
     private
 
     def load_data

data/lib/rubyboy/save_file.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Rubyboy
+  class SaveFile
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def read(expected_size)
+      return nil unless File.exist?(@path)
+
+      bytes = File.binread(@path).bytes
+      if bytes.size != expected_size
+        warn "[rubyboy] save file size mismatch (expected #{expected_size} bytes, got #{bytes.size}); ignoring #{@path}"
+        return nil
+      end
+
+      bytes
+    rescue StandardError => e
+      warn "[rubyboy] failed to read save file #{@path}: #{e.message}"
+      nil
+    end
+
+    def write(bytes)
+      tmp_path = "#{@path}.tmp"
+      File.binwrite(tmp_path, bytes.pack('C*'))
+      File.rename(tmp_path, @path)
+      true
+    rescue StandardError => e
+      warn "[rubyboy] failed to write save file #{@path}: #{e.message}"
+      false
+    end
+  end
+end

data/lib/rubyboy/sdl.rb

@@ -25,6 +25,17 @@ module Rubyboy
     SDL_SCANCODE_K = 14
     SDL_SCANCODE_U = 24
     SDL_SCANCODE_I = 12
+    SDL_SCANCODE_1 = 30
+    SDL_SCANCODE_2 = 31
+    SDL_SCANCODE_3 = 32
+    SDL_SCANCODE_4 = 33
+    SDL_SCANCODE_5 = 34
+    SDL_SCANCODE_6 = 35
+    SDL_SCANCODE_7 = 36
+    SDL_SCANCODE_8 = 37
+    SDL_SCANCODE_9 = 38
+    SDL_SCANCODE_0 = 39
+    SDL_SCANCODE_LSHIFT = 225
 
     attach_function :Init, 'SDL_Init', [:uint32], :int
     attach_function :InitSubSystem, 'SDL_InitSubSystem', [:uint32], :int
@@ -42,6 +53,7 @@ module Rubyboy
     attach_function :GetKeyboardState, 'SDL_GetKeyboardState', [:pointer], :pointer
     attach_function :SetHint, 'SDL_SetHint', %i[string string], :int
     attach_function :RenderSetLogicalSize, 'SDL_RenderSetLogicalSize', %i[pointer int int], :int
+    attach_function :RenderSetVSync, 'SDL_RenderSetVSync', %i[pointer int], :int
     attach_function :SetWindowTitle, 'SDL_SetWindowTitle', %i[pointer string], :void
     attach_function :RaiseWindow, 'SDL_RaiseWindow', [:pointer], :void
     attach_function :GetError, 'SDL_GetError', [], :string

data/lib/rubyboy/state_file.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Rubyboy
+  class StateFile
+    MAGIC = 'RBYSTATE'
+    FORMAT_VERSION = 1
+    HEADER_SIZE = 16
+
+    def self.write(path, rom:)
+      payload = Marshal.dump(yield)
+      header = MAGIC.b + [FORMAT_VERSION, rom.global_checksum_value, 0].pack('L<S<S<')
+      tmp_path = "#{path}.tmp"
+      File.binwrite(tmp_path, header + payload)
+      File.rename(tmp_path, path)
+      true
+    rescue StandardError => e
+      warn "[rubyboy] failed to write state file #{path}: #{e.message}"
+      false
+    end
+
+    def self.read(path, rom:)
+      return warn_and_false("state file does not exist: #{path}") unless File.exist?(path)
+
+      data = File.binread(path)
+      return warn_and_false("state file is too small: #{path}") if data.bytesize < HEADER_SIZE
+
+      magic = data.byteslice(0, MAGIC.bytesize)
+      return warn_and_false("invalid state file magic: #{path}") unless magic == MAGIC
+
+      version, checksum = data.byteslice(8, 6).unpack('L<S<')
+      return warn_and_false("unsupported state file version #{version} (expected #{FORMAT_VERSION})") unless version == FORMAT_VERSION
+      return warn_and_false("ROM checksum mismatch for state file #{path}") unless checksum == rom.global_checksum_value
+
+      # State files are local emulator snapshots written by this process.
+      # rubocop:disable Security/MarshalLoad
+      yield Marshal.load(data.byteslice(HEADER_SIZE..))
+      # rubocop:enable Security/MarshalLoad
+      true
+    rescue StandardError => e
+      warn "[rubyboy] failed to read state file #{path}: #{e.message}"
+      false
+    end
+
+    def self.warn_and_false(message)
+      warn "[rubyboy] #{message}"
+      false
+    end
+    private_class_method :warn_and_false
+  end
+end

data/lib/rubyboy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubyboy
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'
 end

data/lib/rubyboy.rb

@@ -9,8 +9,11 @@ require_relative 'rubyboy/emulator'
 require_relative 'rubyboy/ppu'
 require_relative 'rubyboy/rom'
 require_relative 'rubyboy/ram'
+require_relative 'rubyboy/save_file'
+require_relative 'rubyboy/state_file'
 require_relative 'rubyboy/timer'
 require_relative 'rubyboy/lcd'
 require_relative 'rubyboy/joypad'
 require_relative 'rubyboy/interrupt'
 require_relative 'rubyboy/cartridge/factory'
+require_relative 'rubyboy/hardware_state'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubyboy
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - sacckey
 bindir: exe
 cert_chain: []
-date: 2025-02-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -29,6 +29,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.16.3
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 executables:
 - rubyboy
 - rubyboy-bench
@@ -90,6 +104,7 @@ files:
 - lib/rubyboy/emulator.rb
 - lib/rubyboy/emulator_headless.rb
 - lib/rubyboy/emulator_wasm.rb
+- lib/rubyboy/hardware_state.rb
 - lib/rubyboy/interrupt.rb
 - lib/rubyboy/joypad.rb
 - lib/rubyboy/lcd.rb
@@ -100,7 +115,9 @@ files:
 - lib/rubyboy/raylib/raylib_loader.rb
 - lib/rubyboy/registers.rb
 - lib/rubyboy/rom.rb
+- lib/rubyboy/save_file.rb
 - lib/rubyboy/sdl.rb
+- lib/rubyboy/state_file.rb
 - lib/rubyboy/timer.rb
 - lib/rubyboy/version.rb
 - lib/stackprof.rb
@@ -133,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A Game Boy emulator written in Ruby
 test_files: []