rnes 0.1.0

data/lib/rnes/ppu/colors.rb

@@ -0,0 +1,70 @@
+module Rnes
+  class Ppu
+    COLORS = [
+      [0x52, 0x52, 0x52],
+      [0x01, 0x1a, 0x51],
+      [0x0f, 0x0f, 0x65],
+      [0x23, 0x06, 0x63],
+      [0x36, 0x03, 0x4b],
+      [0x40, 0x04, 0x26],
+      [0x3f, 0x09, 0x04],
+      [0x32, 0x13, 0x00],
+      [0x1f, 0x20, 0x00],
+      [0x0b, 0x2a, 0x00],
+      [0x00, 0x2f, 0x00],
+      [0x00, 0x2e, 0x0a],
+      [0x00, 0x26, 0x2d],
+      [0x00, 0x00, 0x00],
+      [0x00, 0x00, 0x00],
+      [0x00, 0x00, 0x00],
+      [0xa0, 0xa0, 0xa0],
+      [0x1e, 0x4a, 0x9d],
+      [0x38, 0x37, 0xbc],
+      [0x58, 0x28, 0xb8],
+      [0x75, 0x21, 0x94],
+      [0x84, 0x23, 0x5c],
+      [0x82, 0x2e, 0x24],
+      [0x6f, 0x3f, 0x00],
+      [0x51, 0x52, 0x00],
+      [0x31, 0x63, 0x00],
+      [0x1a, 0x6b, 0x05],
+      [0x0e, 0x69, 0x2e],
+      [0x10, 0x5c, 0x68],
+      [0x00, 0x00, 0x00],
+      [0x00, 0x00, 0x00],
+      [0x00, 0x00, 0x00],
+      [0xfe, 0xff, 0xff],
+      [0x69, 0x9e, 0xfc],
+      [0x89, 0x87, 0xff],
+      [0xae, 0x76, 0xff],
+      [0xce, 0x6d, 0xf1],
+      [0xe0, 0x70, 0xb2],
+      [0xde, 0x7c, 0x70],
+      [0xc8, 0x91, 0x3e],
+      [0xa6, 0xa7, 0x25],
+      [0x81, 0xba, 0x28],
+      [0x63, 0xc4, 0x46],
+      [0x54, 0xc1, 0x7d],
+      [0x56, 0xb3, 0xc0],
+      [0x3c, 0x3c, 0x3c],
+      [0x00, 0x00, 0x00],
+      [0x00, 0x00, 0x00],
+      [0xfe, 0xff, 0xff],
+      [0xbe, 0xd6, 0xfd],
+      [0xcc, 0xcc, 0xff],
+      [0xdd, 0xc4, 0xff],
+      [0xea, 0xc0, 0xf9],
+      [0xf2, 0xc1, 0xdf],
+      [0xf1, 0xc7, 0xc2],
+      [0xe8, 0xd0, 0xaa],
+      [0xd9, 0xda, 0x9d],
+      [0xc9, 0xe2, 0x9e],
+      [0xbc, 0xe6, 0xae],
+      [0xb4, 0xe5, 0xc7],
+      [0xb5, 0xdf, 0xe4],
+      [0xa9, 0xa9, 0xa9],
+      [0x00, 0x00, 0x00],
+      [0x00, 0x00, 0x00],
+    ].freeze
+  end
+end

data/lib/rnes/ppu_bus.rb

@@ -0,0 +1,60 @@
+require 'rnes/errors'
+
+module Rnes
+  class PpuBus
+    # @return [Rnes::Ram]
+    attr_reader :character_ram
+
+    # @param [Rnes::Ram] character_ram
+    # @param [Rnes::Ram] sprite_ram
+    # @param [Rnes::Ram] video_ram
+    def initialize(character_ram:, video_ram:)
+      @character_ram = character_ram
+      @video_ram = video_ram
+    end
+
+    # @param [Integer] address
+    # @return [Integer]
+    def read(address)
+      case address
+      when 0x0000..0x1FFF
+        @character_ram.read(address)
+      when 0x2000..0x27FF
+        @video_ram.read(address - 0x2000)
+      when 0x2800..0x2FFF
+        read(address - 0x0800)
+      when 0x3000..0x3EFF
+        read(address - 0x1000)
+      when 0x3F00..0x3F1F
+        @video_ram.read(address - 0x2000)
+      when 0x3F20..0x3FFF
+        read(address - 0x20) # mirror to 0x3F00..0x3F1F
+      when 0x4000..0xFFFF
+        read(address - 0x4000) # mirror to 0x0000..0x3FFF
+      else
+        raise ::Rnes::Errors::InvalidPpuBusAddressError, address
+      end
+    end
+
+    # @param [Integer] address
+    # @param [Integer] value
+    def write(address, value)
+      case address
+      when 0x0000..0x1FFF
+        @character_ram.write(address, value)
+      when 0x2000..0x27FF
+        @video_ram.write(address - 0x2000, value)
+      when 0x2800..0x2FFF
+        @video_ram.write(address - 0x0800, value)
+      when 0x3000..0x3EFF
+        @video_ram.write(address - 0x1000, value)
+      when 0x3F00..0x3F1F
+        @video_ram.write(address - 0x2000, value)
+      when 0x3F00..0xFFFF
+        write(address - 0x1000, value)
+      else
+        raise ::Rnes::Errors::InvalidPpuBusAddressError, address
+      end
+    end
+  end
+end

data/lib/rnes/ppu_registers.rb

@@ -0,0 +1,111 @@
+module Rnes
+  class PpuRegisters
+    STATUS_IN_V_BLANK_BIT_INDEX = 7
+    STATUS_SPRITE_HIT_BIT_INDEX = 5
+
+    # @param [Integer]
+    # @return [Integer]
+    attr_accessor :control1
+
+    # @param [Integer]
+    # @return [Integer]
+    attr_accessor :control2
+
+    # @param [Integer]
+    # @return [Integer]
+    attr_accessor :scroll_horizontal
+
+    # @param [Integer]
+    # @return [Integer]
+    attr_accessor :scroll_vertical
+
+    # @param [Integer]
+    # @return [Integer]
+    attr_accessor :status
+
+    def initialize
+      @control1 = 0x0
+      @control2 = 0x0
+      @scroll_horizontal = 0x0
+      @scroll_vertical = 0x0
+      @status = 0x0
+    end
+
+    # @return [Boolean]
+    def has_background_bank_bit?
+      @control1[4] == 1
+    end
+
+    # @return [Boolean]
+    def has_background_enabled_bit?
+      @control2[3] == 1
+    end
+
+    # @return [Boolean]
+    def has_in_v_blank_bit?
+      @status[STATUS_IN_V_BLANK_BIT_INDEX] == 1
+    end
+
+    # @return [Boolean]
+    def has_large_video_ram_address_offset_bit?
+      @control1[4] == 1
+    end
+
+    # @return [Boolean]
+    def has_sprite_enabled_bit?
+      @control2[4] == 1
+    end
+
+    # @return [Boolean]
+    def has_sprite_hit_bit?
+      @status[STATUS_SPRITE_HIT_BIT_INDEX] == 1
+    end
+
+    # @return [Boolean]
+    def has_sprite_bank_bit?
+      @control1[3] == 1
+    end
+
+    # @return [Boolean]
+    def has_v_blank_irq_enabled_bit?
+      @control1[7] == 1
+    end
+
+    # Name table id (address)
+    # +------------+------------|
+    # | 0 (0x2000) | 1 (0x2400) |
+    # +------------+------------|
+    # | 2 (0x2800) | 3 (0x2C00) |
+    # +------------+------------|
+    # @return [Integer] An integer from 0 to 3.
+    def name_table_id
+      @status & 0b11
+    end
+
+    def set_in_v_blank_bit
+      @status |= (1 << STATUS_IN_V_BLANK_BIT_INDEX)
+    end
+
+    # @param [Boolean] boolean
+    def toggle_in_v_blank_bit(boolean)
+      toggle_status_bit(STATUS_IN_V_BLANK_BIT_INDEX, boolean)
+    end
+
+    # @param [Boolean] boolean
+    def toggle_sprite_hit_bit(boolean)
+      toggle_status_bit(STATUS_SPRITE_HIT_BIT_INDEX, boolean)
+    end
+
+    private
+
+    # @param [Integer] index
+    # @param [Boolean] boolean
+    def toggle_status_bit(index, boolean)
+      if boolean
+        @status |= 1 << index
+      else
+        @status &= ~(1 << index)
+      end
+    end
+  end
+end

data/lib/rnes/ram.rb

@@ -0,0 +1,23 @@
+module Rnes
+  class Ram
+    # @param [Integer] bytesize
+    def initialize(bytesize:)
+      @bytes = Array.new(bytesize).map do
+        0
+      end
+    end
+
+    # @param [Integer] address
+    # @return [Integer]
+    def read(address)
+      @bytes[address]
+    end
+
+    # @param [Integer] address
+    # @param [Integer] value
+    # @return [Integer]
+    def write(address, value)
+      @bytes[address] = value
+    end
+  end
+end

data/lib/rnes/rom.rb

@@ -0,0 +1,19 @@
+module Rnes
+  class Rom
+    # @param [Integer] bytes
+    def initialize(bytes:)
+      @bytes = bytes
+    end
+
+    # @return [Integer]
+    def bytesize
+      @bytes.length
+    end
+
+    # @param [Integer] address
+    # @param [Integer] value
+    def read(address)
+      @bytes[address]
+    end
+  end
+end

data/lib/rnes/rom_loader.rb

@@ -0,0 +1,97 @@
+require 'rnes/errors'
+require 'rnes/ines_header'
+require 'rnes/rom'
+
+module Rnes
+  class RomLoader
+    # @param [Array<Integer>] bytes
+    def initialize(bytes)
+      @bytes = bytes
+    end
+
+    # @return [Rnes::Rom]
+    # @raise [Rnes::Errors::InvalidInesFormatError]
+    def character_rom
+      validate!
+      ::Rnes::Rom.new(bytes: character_rom_bytes)
+    end
+
+    # @return [Rnes::Rom]
+    # @raise [Rnes::Errors::InvalidInesFormatError]
+    def program_rom
+      validate!
+      ::Rnes::Rom.new(bytes: program_rom_bytes)
+    end
+
+    # @return [Rnes::Rom]
+    # @raise [Rnes::Errors::InvalidInesFormatError]
+    def trainer_rom
+      validate!
+      ::Rnes::Rom.new(bytes: trainer_bytes)
+    end
+
+    private
+
+    # @return [Array<Integer>]
+    def character_rom_bytes
+      @bytes.slice(character_rom_index, character_rom_bytesize)
+    end
+
+    # @return [Integer]
+    def character_rom_bytesize
+      ines_header.character_rom_bytesize
+    end
+
+    # @return [Integer]
+    def character_rom_index
+      program_rom_index + program_rom_bytesize
+    end
+
+    # @return [Rnes::InesHeader]
+    def ines_header
+      @ines_header ||= ::Rnes::InesHeader.new(@bytes)
+    end
+
+    # @return [Array<Integer>]
+    def program_rom_bytes
+      @bytes.slice(program_rom_index, program_rom_bytesize)
+    end
+
+    # @return [Integer]
+    def program_rom_bytesize
+      @program_rom_bytesize ||= ines_header.program_rom_bytesize
+    end
+
+    # @return [Integer]
+    def program_rom_index
+      @program_rom_index ||= trainer_index + trainer_bytesize
+    end
+
+    # @return [Array<Integer>]
+    def trainer_bytes
+      @bytes.slice(trainer_index, trainer_bytesize)
+    end
+
+    # @return [Integer]
+    def trainer_bytesize
+      ines_header.trainer_bytesize
+    end
+
+    # @return [Integer]
+    def trainer_index
+      ines_header.bytesize
+    end
+
+    # @return [Boolean]
+    def valid?
+      ines_header.valid?
+    end
+
+    # @raise [Rnes::Errors::InvalidInesFormatError]
+    def validate!
+      unless valid?
+        raise ::Rnes::Errors::InvalidInesFormatError
+      end
+    end
+  end
+end

data/lib/rnes/terminal_renderer.rb

@@ -0,0 +1,59 @@
+module Rnes
+  class TerminalRenderer
+    BRAILLE_BASE_CODE_POINT = 0x2800
+
+    BRAILLE_HEIGHT = 4
+
+    BRAILLE_WIDTH = 2
+
+    BRIGHTNESS_SUM_THRESHOLD = 128 * 3
+
+    TEXT_HEIGHT = 61
+
+    TEXT_WIDTH = 128
+
+    ESCAPE_TO_CLEAR_TEXT = "\e[#{TEXT_HEIGHT}A\e[#{TEXT_WIDTH}D".freeze
+
+    def initialize
+      @fps = 0
+      @previous_fps = 0
+    end
+
+    def render(image)
+      brailles = convert_image_to_string(image)
+      fps_counter = "FPS:#{@previous_fps}"
+      puts "#{ESCAPE_TO_CLEAR_TEXT}#{fps_counter}\n#{brailles}"
+      second = ::Time.now.sec
+      if @second == second
+        @fps += 1
+      else
+        @previous_fps = @fps
+        @fps = 0
+        @second = second
+      end
+    end
+
+    private
+
+    # @return [String]
+    def convert_image_to_string(image)
+      0.step(image.height - 1, BRAILLE_HEIGHT).map do |y|
+        0.step(image.width - 1, BRAILLE_WIDTH).map do |x|
+          offset = [
+            image.read(x: x + 0, y: y + 0),
+            image.read(x: x + 0, y: y + 1),
+            image.read(x: x + 0, y: y + 2),
+            image.read(x: x + 1, y: y + 0),
+            image.read(x: x + 1, y: y + 1),
+            image.read(x: x + 1, y: y + 2),
+            image.read(x: x + 0, y: y + 3),
+            image.read(x: x + 1, y: y + 3),
+          ].map.with_index do |rgb, i|
+            (rgb.sum < BRIGHTNESS_SUM_THRESHOLD ? 0 : 1) << i
+          end.reduce(:|)
+          (BRAILLE_BASE_CODE_POINT + offset).chr('UTF-8')
+        end.join
+      end.join("\n")
+    end
+  end
+end

data/lib/rnes/version.rb

@@ -0,0 +1,3 @@
+module Rnes
+  VERSION = '0.1.0'.freeze
+end