rnes 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 768392aacc5ad611aa059d5ef7a7c23c78ca1088
-  data.tar.gz: 37881bb61c15ed1f35c5015174bf47d26b8fc50f
+  metadata.gz: 6d3d1d154a09065286af7ca812325aa2b1685cbf
+  data.tar.gz: cfa99900503dd5d59f6553f7ee3c81f4fd292dc3
 SHA512:
-  metadata.gz: 65ec79252019d26f9d6fa5aa471ecb031adcbeb067c7413a54e0c8dd58a7dbb989d9989638861694caab9ea03dce11625743c0bdcfb05919da3f7c5a9d8b11e0
-  data.tar.gz: 5af737101697e45640a8e211423f5dcbd858c0de846fe2b63d52d197bbd3abdf2baf53d089a3fe7c47440d6f3e6b36bd6597332945ab62a180af62ecd96987ec
+  metadata.gz: 859089e4d81fb3888ea5e52b95de2695f48acf3346b219a5e579ebcdd6516ff92ce709a798334afc60e2adf76c078898d6d79fb866c8cb6659fff149360f983e
+  data.tar.gz: 3e69abecdf78153e5ceca5090fbf8b6202fb936f710eb49a659a6b3d25756d4e52d245c93bbad73b4ca7ed8a55419b329276a6d97cf490ec4e1387be0b5ab187

data/.circleci/config.yml

@@ -3,6 +3,9 @@ jobs:
     machine: true
     steps:
       - checkout
+      - run:
+          command: gem install bundler -v 1.17.1
+          name: gem install bundler -v 1.17.1
       - run:
           command: bundle install
           name: bundle install
@@ -13,6 +16,9 @@ jobs:
     machine: true
     steps:
       - checkout
+      - run:
+          command: gem install bundler -v 1.17.1
+          name: gem install bundler -v 1.17.1
       - run:
           command: bundle install
           name: bundle install

data/CHANGELOG.md

@@ -1,13 +1,28 @@
-## 0.1.1 - 2018-11-12
+## Unreleased
 
-### Changed
+## 0.2.0 - 2018-11-17
 
-- Improve logger format for compatibility with nestest.log.
+### Added
+
+- Add CLI options and help message.
+- Add PPU sprite reverse.
+
+### Fixed
+
+- Fix PPU sprites rendering.
+- Fix PPU sprite pattern addressing.
+- Fix PPU background pattern attribute addressing.
+
+## 0.1.1 - 2018-11-12
 
 ### Added
 
 - Allow break-less input on key input.
 
+### Changed
+
+- Improve logger format for compatibility with nestest.log.
+
 ### Fixed
 
 - Fix CPU ADC instruction.

data/Gemfile

@@ -4,3 +4,7 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in rnes.gemspec
 gemspec
+
+gem 'pry'
+gem 'rspec'
+gem 'rubocop'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rnes (0.1.0)
+    rnes (0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -52,8 +52,8 @@ DEPENDENCIES
   pry
   rake (~> 10.0)
   rnes!
-  rspec (= 3.7.0)
-  rubocop (= 0.60.0)
+  rspec
+  rubocop
 
 BUNDLED WITH
    1.17.1

data/README.md

@@ -22,7 +22,7 @@ gem install rnes
 Pass ROM file path to `rnes` executable.
 
 ```sh
-rnes <FILE>
+Usage: rnes [options] <FILE>
 ```
 
 ## Controls

data/exe/rnes

@@ -1,10 +1,24 @@
 #!/usr/bin/env ruby
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'optparse'
 require 'rnes'
 
-path = ARGV[0]
+options = ARGV.getopts('h', 'help', 'log:')
+log_file_path = options['log']
+args = ARGV.parse!
+help_message = "Usage: #{$PROGRAM_NAME} [options] <FILE>"
+if options['h'] || options['help']
+  puts help_message
+  exit
+end
+
+path = args.first
+unless path
+  abort help_message
+end
+
 io = File.binread(path)
 bytes = io.bytes
-emulator = Rnes::Emulator.new
+emulator = Rnes::Emulator.new(log_file_path: log_file_path)
 emulator.load_rom(bytes)
 emulator.run

data/lib/rnes/emulator.rb

@@ -5,9 +5,8 @@ require 'rnes/rom_loader'
 
 module Rnes
   class Emulator
-    LOG_FILE_NAME = 'rnes.log'.freeze
-
-    def initialize
+    # @param [String] log_file_path
+    def initialize(log_file_path: nil)
       parts_factory = ::Rnes::PartsFactory.new
       @cpu = parts_factory.cpu
       @cpu_bus = parts_factory.cpu_bus
@@ -16,7 +15,9 @@ module Rnes
       @keypad2 = parts_factory.keypad2
       @ppu = parts_factory.ppu
       @ppu_bus = parts_factory.ppu_bus
-      @logger = ::Rnes::Logger.new(cpu: @cpu, path: LOG_FILE_NAME, ppu: @ppu)
+      if log_file_path
+        @logger = ::Rnes::Logger.new(cpu: @cpu, path: log_file_path, ppu: @ppu)
+      end
     end
 
     # @param [Array<Integer>] rom_bytes

data/lib/rnes/ppu.rb

@@ -6,6 +6,8 @@ require 'rnes/ram'
 
 module Rnes
   class Ppu
+    ADDRESS_TO_FINISH_SPRITE_PALETTE_TABLE = 0x3F1F
+
     ADDRESS_TO_START_ATTRIBUTE_TABLE = 0x23C0
 
     ADDRESS_TO_START_NAME_TABLE = 0x2000
@@ -20,6 +22,8 @@ module Rnes
 
     CYCLES_PER_LINE = 341
 
+    PALETTE_ADDRESS_RANGE = (ADDRESS_TO_START_BACKGROUND_PALETTE_TABLE..ADDRESS_TO_FINISH_SPRITE_PALETTE_TABLE).freeze
+
     SPRITE_RAM_BYTESIZE = 2**8
 
     SPRITES_COUNT = 64
@@ -34,6 +38,14 @@ module Rnes
 
     WINDOW_WIDTH = 256
 
+    ENCODED_ATTRIBUTES_HEIGHT = BLOCK_HEIGHT * 2
+
+    ENCODED_ATTRIBUTES_WIDTH = BLOCK_WIDTH * 2
+
+    ENCODED_ATTRIBUTES_COUNT_IN_HORIZONTAL_LINE = WINDOW_WIDTH / ENCODED_ATTRIBUTES_WIDTH
+
+    ENCODED_ATTRIBUTES_COUNT_IN_VERTICAL_LINE = 256 / ENCODED_ATTRIBUTES_HEIGHT
+
     TILES_COUNT_IN_HORIZONTAL_LINE = WINDOW_WIDTH / TILE_WIDTH
 
     TILES_COUNT_IN_VERTICAL_LINE = WINDOW_HEIGHT / TILE_HEIGHT
@@ -180,6 +192,23 @@ module Rnes
       end
     end
 
+    # +---+---+
+    # | 0 | 1 |
+    # +---+---+
+    # | 2 | 3 |
+    # +---+---+
+    # @return [Integer] Integer from 0 to 3.
+    def block_id_in_encoded_attributes
+      (x_of_block.even? ? 0 : 1) + (y_of_block.even? ? 0 : 2)
+    end
+
+    # @return [Integer] Integer from 0 to 63.
+    def object_attribute_index
+      (y_of_encoded_attributes % ENCODED_ATTRIBUTES_COUNT_IN_VERTICAL_LINE) * ENCODED_ATTRIBUTES_COUNT_IN_HORIZONTAL_LINE +
+        x_of_encoded_attributes % ENCODED_ATTRIBUTES_COUNT_IN_HORIZONTAL_LINE +
+        background_pattern_index_paging_offset
+    end
+
     def check_sprite_hit
       if read_from_sprite_ram(0) == y && @registers.background_enabled? && @registers.sprite_enabled?
         registers.sprite_hit = true
@@ -199,25 +228,21 @@ module Rnes
     end
 
     def draw_background_8pixels
-      base_pattern_table_address = base_background_pattern_table_address
-      character_index = read_character_index(tile_index)
-      character_line_low_byte_address = TILE_HEIGHT * 2 * character_index + y_in_tile + base_pattern_table_address
-      character_line_low_byte = read_character_data(character_line_low_byte_address)
-      character_line_high_byte = read_character_data(character_line_low_byte_address + TILE_HEIGHT)
-
-      block_id = 0
-      block_id |= 0b01 if (x % BLOCK_WIDTH).odd?
-      block_id |= 0b10 if (y % BLOCK_HEIGHT).odd?
-      mini_palette_ids_byte = read_object_attribute(tile_index)
-      mini_palette_id = (mini_palette_ids_byte >> (block_id * 2)) & 0b11
-
-      TILE_WIDTH.times do |x_in_character|
-        index_in_character_line_byte = TILE_WIDTH - 1 - x_in_character
-        background_palette_index = character_line_low_byte[index_in_character_line_byte] | character_line_high_byte[index_in_character_line_byte] << 1 | mini_palette_id << 2
+      pattern_index = read_pattern_index(background_pattern_index)
+      pattern_line_low_byte_address = TILE_HEIGHT * 2 * pattern_index + y_in_tile
+      pattern_line_low_byte = read_background_pattern_line(pattern_line_low_byte_address)
+      pattern_line_high_byte = read_background_pattern_line(pattern_line_low_byte_address + TILE_HEIGHT)
+
+      mini_palette_ids_byte = read_object_attribute(object_attribute_index)
+      mini_palette_id = (mini_palette_ids_byte >> (block_id_in_encoded_attributes * 2)) & 0b11
+
+      TILE_WIDTH.times do |x_in_pattern|
+        index_in_pattern_line_byte = TILE_WIDTH - 1 - x_in_pattern
+        background_palette_index = pattern_line_low_byte[index_in_pattern_line_byte] | (pattern_line_high_byte[index_in_pattern_line_byte] << 1) | (mini_palette_id << 2)
         color_id = read_color_id(background_palette_index)
         @image.write(
           value: ::Rnes::Ppu::COLORS[color_id],
-          x: x + x_in_character,
+          x: x + x_in_pattern,
           y: y,
         )
       end
@@ -237,31 +262,31 @@ module Rnes
     #      |`------- horizontal flip
     #      `-------- vertical flip
     def draw_sprites
-      base_pattern_table_address = base_sprite_pattern_table_address
-      SPRITES_COUNT.times do |i|
-        base_sprite_ram_address = i * 4
+      0.step(SPRITES_COUNT - 1, 4) do |base_sprite_ram_address|
         y_for_sprite = (read_from_sprite_ram(base_sprite_ram_address) - TILE_HEIGHT)
         next if y_for_sprite.negative?
-        name_table_index = read_from_sprite_ram(base_sprite_ram_address + 1)
+        pattern_index = read_from_sprite_ram(base_sprite_ram_address + 1)
         sprite_attribute_byte = read_from_sprite_ram(base_sprite_ram_address + 2)
         x_for_sprite = read_from_sprite_ram(base_sprite_ram_address + 3)
 
-        character_index = read_character_index(name_table_index)
-
         mini_palette_id = sprite_attribute_byte & 0b11
-
-        TILE_HEIGHT.times do |y_in_character|
-          character_line_low_byte_address = TILE_HEIGHT * 2 * character_index + y_in_character + base_pattern_table_address
-          character_line_low_byte = read_character_data(character_line_low_byte_address)
-          character_line_high_byte = read_character_data(character_line_low_byte_address + TILE_HEIGHT)
-          TILE_WIDTH.times do |x_in_character|
-            index_in_character_line_byte = TILE_WIDTH - 1 - x_in_character
-            background_palette_index = character_line_low_byte[index_in_character_line_byte] | character_line_high_byte[index_in_character_line_byte] << 1 | mini_palette_id << 2
+        reversed_horizontally = sprite_attribute_byte[6] == 1
+        reversed_vertically = sprite_attribute_byte[7] == 1
+
+        TILE_HEIGHT.times do |y_in_pattern|
+          pattern_line_low_byte_address = TILE_HEIGHT * 2 * pattern_index + y_in_pattern
+          pattern_line_low_byte = read_sprite_pattern_line(pattern_line_low_byte_address)
+          pattern_line_high_byte = read_sprite_pattern_line(pattern_line_low_byte_address + TILE_HEIGHT)
+          TILE_WIDTH.times do |x_in_pattern|
+            index_in_pattern_line_byte = TILE_WIDTH - 1 - x_in_pattern
+            background_palette_index = pattern_line_low_byte[index_in_pattern_line_byte] | pattern_line_high_byte[index_in_pattern_line_byte] << 1 | mini_palette_id << 2
             color_id = read_color_id(background_palette_index)
+            y_in_pattern = TILE_HEIGHT - 1 - y_in_pattern if reversed_vertically
+            x_in_pattern = TILE_WIDTH - 1 - x_in_pattern if reversed_horizontally
             @image.write(
               value: ::Rnes::Ppu::COLORS[color_id],
-              x: x_for_sprite + x_in_character,
-              y: y_for_sprite + y_in_character,
+              x: x_for_sprite + x_in_pattern,
+              y: y_for_sprite + y_in_pattern,
             )
           end
         end
@@ -288,16 +313,15 @@ module Rnes
       (0...WINDOW_WIDTH).cover?(x) && (0...WINDOW_HEIGHT).cover?(y)
     end
 
-    # @param [Integer] index
-    # @return [Integer]
-    def read_character_data(index)
-      @bus.read(index)
+    # @return [Boolean]
+    def palette_data_requested?
+      PALETTE_ADDRESS_RANGE.cover?(@registers.video_ram_address % 0x4000)
     end
 
-    # @param [Integer] index
+    # @param [Integer] index.
     # @return [Integer]
-    def read_character_index(index)
-      @bus.read(base_name_table_address + index)
+    def read_background_pattern_line(index)
+      read_pattern_line(base_background_pattern_table_address + index)
     end
 
     # @param [Integer] index
@@ -312,15 +336,9 @@ module Rnes
       @sprite_ram.read(address)
     end
 
-    # @param [Integer] index
-    # @return [Integer] 4-color-palette IDs of 4 blocks, as 8 bit data.
-    def read_object_attribute(index)
-      @bus.read(ADDRESS_TO_START_ATTRIBUTE_TABLE + index)
-    end
-
     # @return [Integer]
     def read_from_video_ram_for_cpu
-      if (0x3F00..0x3F1F).cover?(@registers.video_ram_address % 0x4000)
+      if palette_data_requested?
         value = @bus.read(@registers.video_ram_address)
         @video_ram_reading_buffer = @bus.read(@registers.video_ram_address - 0x1000)
       else
@@ -331,6 +349,30 @@ module Rnes
       value
     end
 
+    # @param [Integer] index
+    # @return [Integer] 4-color-palette IDs of 4 blocks, as 8 bit data.
+    def read_object_attribute(index)
+      @bus.read(ADDRESS_TO_START_ATTRIBUTE_TABLE + index)
+    end
+
+    # @param [Integer] index
+    # @return [Integer]
+    def read_pattern_line(index)
+      @bus.read(index)
+    end
+
+    # @param [Integer] index.
+    # @return [Integer]
+    def read_sprite_pattern_line(index)
+      read_pattern_line(base_sprite_pattern_table_address + index)
+    end
+
+    # @param [Integer] index
+    # @return [Integer]
+    def read_pattern_index(index)
+      @bus.read(base_name_table_address + index)
+    end
+
     def render_image
       @renderer.render(@image)
     end
@@ -345,23 +387,23 @@ module Rnes
     # | 2(0x0800) | 3(0x0C00) |
     # +-----------+-----------+
     # @return [Integer] Integer from 0x0000 to 0x0FC0.
-    def tile_index
-      tile_index_in_window + tile_index_paging_offset
+    def background_pattern_index
+      background_pattern_index_in_window + background_pattern_index_paging_offset
     end
 
     # @return [Integer] Integer from 0x0000 to 0x03C0.
-    def tile_index_in_window
+    def background_pattern_index_in_window
       (y_of_tile % TILES_COUNT_IN_VERTICAL_LINE) * TILES_COUNT_IN_HORIZONTAL_LINE + x_of_tile % TILES_COUNT_IN_HORIZONTAL_LINE
     end
 
     # @return [Integer] Integer from 0 to 3.
-    def tile_index_page
+    def background_pattern_index_page
       x_of_tile / TILES_COUNT_IN_HORIZONTAL_LINE + y_of_tile / TILES_COUNT_IN_VERTICAL_LINE * 2
     end
 
     # @return [Integer] 0x0000, 0x0400, 0x0800, or 0x0C00.
-    def tile_index_paging_offset
-      tile_index_page * 0x0400
+    def background_pattern_index_paging_offset
+      background_pattern_index_page * 0x0400
     end
 
     # @return [Boolean]
@@ -381,7 +423,7 @@ module Rnes
     # @param [Integer] value
     def write_to_sprite_ram_for_cpu(value)
       @sprite_ram.write(@registers.sprite_ram_address, value)
-      @registers.sprite_ram_address += 1
+      @registers.sprite_ram_address = (@registers.sprite_ram_address + 1) & 0xFF
     end
 
     # @param [Integer] value
@@ -397,12 +439,27 @@ module Rnes
 
     # @return [Integer]
     def x_in_tile
-      x % TILE_WIDTH
+      x_with_scroll % TILE_WIDTH
+    end
+
+    # @return [Integer]
+    def x_of_block
+      x_with_scroll / BLOCK_WIDTH
+    end
+
+    # @return [Integer]
+    def x_of_encoded_attributes
+      x_with_scroll / ENCODED_ATTRIBUTES_WIDTH
     end
 
     # @return [Integer]
     def x_of_tile
-      (x + @registers.scroll_x) / TILE_WIDTH
+      x_with_scroll / TILE_WIDTH
+    end
+
+    # @return [Integer]
+    def x_with_scroll
+      x + @registers.scroll_x
     end
 
     # @return [Integer]
@@ -412,12 +469,27 @@ module Rnes
 
     # @return [Integer]
     def y_in_tile
-      y % TILE_HEIGHT
+      y_with_scroll % TILE_HEIGHT
+    end
+
+    # @return [Integer]
+    def y_of_block
+      y_with_scroll / BLOCK_HEIGHT
+    end
+
+    # @return [Integer]
+    def y_of_encoded_attributes
+      y_with_scroll / ENCODED_ATTRIBUTES_HEIGHT
     end
 
     # @return [Integer]
     def y_of_tile
-      (y + @registers.scroll_y) / TILE_HEIGHT
+      y_with_scroll / TILE_HEIGHT
+    end
+
+    # @return [Integer]
+    def y_with_scroll
+      y + @registers.scroll_y
     end
   end
 end

data/lib/rnes/ppu_bus.rb

@@ -6,7 +6,6 @@ module Rnes
     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

data/lib/rnes/ppu_registers.rb

@@ -38,8 +38,8 @@ module Rnes
       @sprite_ram_address = 0x00
       @video_ram_address = 0x0000
 
-      @address_latch = false
-      @scroll_latch = false
+      @buffer = 0x00
+      @latch = false
     end
 
     # @return [Boolean]
@@ -124,12 +124,13 @@ module Rnes
 
     # @param [Integer] value
     def scroll=(value)
-      if @scroll_latch
+      if @latch
+        @scroll_x = @buffer
         @scroll_y = value
       else
-        @scroll_x = value
+        @buffer = value
       end
-      @scroll_latch = !@scroll_latch
+      toggle_latch
     end
 
     # @return [Boolean]
@@ -161,23 +162,26 @@ module Rnes
     def status
       value = @status
       self.in_v_blank = false
-      @address_latch = false
-      @scroll_latch = false
+      @latch = false
       value
     end
 
     # @param [Integer] value
     def video_ram_address=(value)
-      if @address_latch
-        @video_ram_address |= value
+      if @latch
+        @video_ram_address = value + (@buffer << 8)
       else
-        @video_ram_address = value << 8
+        @buffer = value
       end
-      @address_latch = !@address_latch
+      toggle_latch
     end
 
     private
 
+    def toggle_latch
+      @latch = !@latch
+    end
+
     # @param [Integer] index
     # @param [Boolean] boolean
     def toggle_status_bit(index, boolean)

data/lib/rnes/version.rb

@@ -1,3 +1,3 @@
 module Rnes
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/rnes.gemspec

@@ -24,8 +24,5 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.2'
 
   spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '3.7.0'
-  spec.add_development_dependency 'rubocop', '0.60.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rnes
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-12 00:00:00.000000000 Z
+date: 2018-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,34 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.7.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.7.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.60.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.60.0
 description: 
 email:
 - r7kamura@gmail.com