rubyboy 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 909f97d8e2a7de6573d735d5d949bd7a8533c6096c24f4f74cede36e2c3651bc
-  data.tar.gz: 2a0e0b87e8053143389a6970c910859229ec9001da32f91eb805ea0ebcea6bae
+  metadata.gz: f641e78dedf235a5ac8bab34c18fbd624150e5e6c9df92a710d2bc458fab3d62
+  data.tar.gz: 7ab941409fcbec7b0eff98241231e002c249f84be16a19c28216e33f91ac14d2
 SHA512:
-  metadata.gz: 01fa425096d955d638c55e2489642d2532af9772c3a78aa1f11797bd952396472e78b0851605e7e81abdf49adc746725fb6c96eee904811b65a4edee74204221
-  data.tar.gz: dc45f065ed0c3e93d14ad190bdb9b0a6947b3634e2907759fe909af61a1d6cdc9acae338955ecaeefa94411aa98847369691f77c1cf242ed8c2ea77e8d0d216e
+  metadata.gz: f220a9aeff3fa642f334c0248c4f155cf648c53a4bb132801e86a8008039f50d3cb9d3519af07b47e44f5aa2032419ba370e8ddcbb41ffebcb7937e8ed397b92
+  data.tar.gz: 63065e706e48de9fc26dcd9f7bb75332876374769db0914c54843c3f60aa1dd53a950fe0f33755539331e8f02b5b71cc0d4cf0bdca31421911d23911454a8108

data/.rubocop.yml

@@ -17,6 +17,9 @@ Metrics/AbcSize:
 Metrics/BlockNesting:
   Enabled: false
 
+Metrics/BlockLength:
+  Enabled: false
+
 Metrics/CyclomaticComplexity:
   Enabled: false
 
@@ -41,6 +44,9 @@ Style/Documentation:
 Style/FormatString:
   Enabled: false
 
+Style/MultipleComparison:
+  Enabled: false
+
 Style/NumericLiterals:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [1.3.0] - 2024-03-09
+
+- Add ffi to dependencies
+- Add SDL2 wrapper
+- Add audio
+- Optimize cpu
+- Cache R/W methods
+
 ## [1.2.0] - 2024-01-09
 
 - Add logo

data/lib/rubyboy/apu.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require_relative 'audio'
+require_relative 'apu_channels/channel1'
+require_relative 'apu_channels/channel2'
+require_relative 'apu_channels/channel3'
+require_relative 'apu_channels/channel4'
+
+module Rubyboy
+  class Apu
+    def initialize
+      @audio = Audio.new
+      @nr50 = 0
+      @nr51 = 0
+      @cycles = 0
+      @sampling_cycles = 0
+      @fs = 0
+      @samples = Array.new(1024, 0.0)
+      @sample_idx = 0
+      @channel1 = ApuChannels::Channel1.new
+      @channel2 = ApuChannels::Channel2.new
+      @channel3 = ApuChannels::Channel3.new
+      @channel4 = ApuChannels::Channel4.new
+    end
+
+    def step(cycles)
+      @cycles += cycles
+      @sampling_cycles += cycles
+
+      @channel1.step(cycles)
+      @channel2.step(cycles)
+      @channel3.step(cycles)
+      @channel4.step(cycles)
+
+      if @cycles >= 0x1fff
+        @cycles -= 0x1fff
+
+        @channel1.step_fs(@fs)
+        @channel2.step_fs(@fs)
+        @channel3.step_fs(@fs)
+        @channel4.step_fs(@fs)
+
+        @fs = (@fs + 1) % 8
+      end
+
+      if @sampling_cycles >= 87
+        @sampling_cycles -= 87
+
+        left_sample = (
+          @nr51[7] * @channel4.dac_output +
+          @nr51[6] * @channel3.dac_output +
+          @nr51[5] * @channel2.dac_output +
+          @nr51[4] * @channel1.dac_output
+        ) / 4.0
+
+        right_sample = (
+          @nr51[3] * @channel4.dac_output +
+          @nr51[2] * @channel3.dac_output +
+          @nr51[1] * @channel2.dac_output +
+          @nr51[0] * @channel1.dac_output
+        ) / 4.0
+
+        raise "#{@nr51} #{@channel4.dac_output}, #{@channel3.dac_output}, #{@channel2.dac_output},#{@channel1.dac_output}" if left_sample.abs > 1.0 || right_sample.abs > 1.0
+
+        @samples[@sample_idx * 2] = (@nr50[4..6] / 7.0) * left_sample
+        @samples[@sample_idx * 2 + 1] = (@nr50[0..2] / 7.0) * right_sample
+        @sample_idx += 1
+      end
+
+      return if @sample_idx < 512
+
+      @sample_idx = 0
+      @audio.queue(@samples)
+    end
+
+    def read_byte(addr)
+      case addr
+      when 0xff10..0xff14 then @channel1.read_nr1x(addr - 0xff10)
+      when 0xff15..0xff19 then @channel2.read_nr2x(addr - 0xff15)
+      when 0xff1a..0xff1e then @channel3.read_nr3x(addr - 0xff1a)
+      when 0xff1f..0xff23 then @channel4.read_nr4x(addr - 0xff1f)
+      when 0xff24 then @nr50
+      when 0xff25 then @nr51
+      when 0xff26 then (@channel1.enabled ? 0x01 : 0x00) | (@channel2.enabled ? 0x02 : 0x00) | (@channel3.enabled ? 0x04 : 0x00) | (@channel4.enabled ? 0x08 : 0x00) | 0x70 | (@enabled ? 0x80 : 0x00)
+      when 0xff30..0xff3f then @channel3.wave_ram[(addr - 0xff30)]
+      else raise "Invalid APU read at #{addr.to_s(16)}"
+      end
+    end
+
+    def write_byte(addr, val)
+      return if !@enabled && ![0xff11, 0xff16, 0xff1b, 0xff20, 0xff26].include?(addr) && !(0xff30..0xff3f).include?(addr)
+
+      val &= 0x3f if !@enabled && [0xff11, 0xff16, 0xff1b, 0xff20].include?(addr)
+
+      case addr
+      when 0xff10..0xff14 then @channel1.write_nr1x(addr - 0xff10, val)
+      when 0xff15..0xff19 then @channel2.write_nr2x(addr - 0xff15, val)
+      when 0xff1a..0xff1e then @channel3.write_nr3x(addr - 0xff1a, val)
+      when 0xff1f..0xff23 then @channel4.write_nr4x(addr - 0xff1f, val)
+      when 0xff24 then @nr50 = val
+      when 0xff25 then @nr51 = val
+      when 0xff26
+        flg = val & 0x80 > 0
+        if !flg && @enabled
+          (0xff10..0xff25).each { |a| write_byte(a, 0) }
+        elsif flg && !@enabled
+          @fs = 0
+          @channel1.wave_duty_position = 0
+          @channel2.wave_duty_position = 0
+          @channel3.wave_duty_position = 0
+        end
+        @enabled = flg
+      when 0xff30..0xff3f then @channel3.wave_ram[(addr - 0xff30)] = val
+      else raise "Invalid APU write at #{addr.to_s(16)}"
+      end
+    end
+  end
+end

data/lib/rubyboy/apu_channels/channel1.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Rubyboy
+  module ApuChannels
+    class Channel1
+      attr_accessor :enabled, :wave_duty_position
+
+      WAVE_DUTY = [
+        [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0], # 12.5%
+        [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0], # 25%
+        [0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 1.0, 1.0], # 50%
+        [0.0, 0.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]  # 75%
+      ].freeze
+
+      def initialize
+        @cycles = 0
+        @frequency = 0
+        @frequency_timer = 0
+        @wave_duty_position = 0
+
+        @enabled = false
+        @dac_enabled = false
+        @length_enabled = false
+        @is_upwards = false
+        @is_decrementing = false
+        @sweep_enabled = false
+        @sweep_period = 0
+        @sweep_shift = 0
+        @period = 0
+        @period_timer = 0
+        @current_volume = 0
+        @initial_volume = 0
+        @shadow_frequency = 0
+        @sweep_timer = 0
+        @length_timer = 0
+        @wave_duty_pattern = 0
+      end
+
+      def step(cycles)
+        @cycles += cycles
+
+        return if @cycles < @frequency_timer
+
+        @cycles -= @frequency_timer
+        @frequency_timer = (2048 - @frequency) * 4
+        @wave_duty_position = (@wave_duty_position + 1) % 8
+      end
+
+      def step_fs(fs)
+        length if fs & 0x01 == 0
+        envelope if fs == 7
+        sweep if fs == 2 || fs == 6
+      end
+
+      def length
+        return unless @length_enabled && @length_timer > 0
+
+        @length_timer -= 1
+        @enabled &= @length_timer > 0
+      end
+
+      def envelope
+        return if @period == 0
+
+        @period_timer -= 1 if @period_timer > 0
+
+        return if @period_timer != 0
+
+        @period_timer = @period
+
+        if @current_volume < 15 && @is_upwards
+          @current_volume += 1
+        elsif @current_volume > 0 && !@is_upwards
+          @current_volume -= 1
+        end
+      end
+
+      def sweep
+        @sweep_timer -= 1 if @sweep_timer > 0
+
+        return if @sweep_timer != 0
+
+        @sweep_timer = @sweep_period
+
+        return unless @sweep_enabled
+
+        @frequency = calculate_frequency
+        @shadow_frequency = @frequency
+      end
+
+      def calculate_frequency
+        if @is_decrementing
+          if @shadow_frequency >= (@shadow_frequency >> @sweep_shift)
+            @shadow_frequency - (@shadow_frequency >> @sweep_shift)
+          else
+            0
+          end
+        else
+          [0x3ff, @shadow_frequency + (@shadow_frequency >> @sweep_shift)].min
+        end
+      end
+
+      def dac_output
+        return 0.0 unless @dac_enabled && @enabled
+
+        ret = WAVE_DUTY[@wave_duty_pattern][@wave_duty_position] * @current_volume
+        (ret / 7.5) - 1.0
+      end
+
+      def read_nr1x(x)
+        case x
+        when 0 then (@sweep_period << 4) | @sweep_shift | (@is_decrementing ? 0x08 : 0x00) | 0x80
+        when 1 then (@wave_duty_pattern << 6) | 0x3f
+        when 2 then (@initial_volume << 4) | (@is_upwards ? 0x08 : 0x00) | @period
+        when 3 then 0xff
+        when 4 then (@length_enabled ? 0x40 : 0x00) | 0xbf
+        else 0xff
+        end
+      end
+
+      def write_nr1x(x, val)
+        case x
+        when 0
+          @sweep_period = (val >> 4) & 0x07
+          @is_decrementing = (val & 0x08) > 0
+          @sweep_shift = val & 0x07
+        when 1
+          @wave_duty_pattern = (val >> 6) & 0x03
+          @length_timer = 64 - (val & 0x3f)
+        when 2
+          @is_upwards = (val & 0x08) > 0
+          @initial_volume = (val >> 4)
+          @period = val & 0x07
+          @dac_enabled = val & 0xf8 > 0
+          @enabled &= @dac_enabled
+        when 3
+          @frequency = (@frequency & 0x700) | val
+        when 4
+          @frequency = (@frequency & 0xff) | ((val & 0x07) << 8)
+          @length_enabled = (val & 0x40) > 0
+          @length_timer = 64 if @length_timer == 0
+          return unless (val & 0x80) > 0 && @dac_enabled
+
+          @enabled = true
+          @period_timer = @period
+          @current_volume = @initial_volume
+          @shadow_frequency = @frequency
+          @sweep_timer = @sweep_period
+          @sweep_enabled = @sweep_period > 0 || @sweep_shift > 0
+        end
+      end
+    end
+  end
+end

data/lib/rubyboy/apu_channels/channel2.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Rubyboy
+  module ApuChannels
+    class Channel2
+      attr_accessor :enabled, :wave_duty_position
+
+      WAVE_DUTY = [
+        [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0], # 12.5%
+        [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0], # 25%
+        [0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 1.0, 1.0], # 50%
+        [0.0, 0.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]  # 75%
+      ].freeze
+
+      def initialize
+        @cycles = 0
+        @frequency = 0
+        @frequency_timer = 0
+        @wave_duty_position = 0
+
+        @enabled = false
+        @dac_enabled = false
+        @length_enabled = false
+        @is_upwards = false
+        @is_decrementing = false
+        @period = 0
+        @period_timer = 0
+        @current_volume = 0
+        @initial_volume = 0
+        @shadow_frequency = 0
+        @length_timer = 0
+        @wave_duty_pattern = 0
+      end
+
+      def step(cycles)
+        @cycles += cycles
+
+        return if @cycles < @frequency_timer
+
+        @cycles -= @frequency_timer
+        @frequency_timer = (2048 - @frequency) * 4
+        @wave_duty_position = (@wave_duty_position + 1) % 8
+      end
+
+      def step_fs(fs)
+        length if fs & 0x01 == 0
+        envelope if fs == 7
+      end
+
+      def length
+        return unless @length_enabled && @length_timer > 0
+
+        @length_timer -= 1
+        @enabled &= @length_timer > 0
+      end
+
+      def envelope
+        return if @period == 0
+
+        @period_timer -= 1 if @period_timer > 0
+
+        return if @period_timer != 0
+
+        @period_timer = @period
+
+        if @current_volume < 15 && @is_upwards
+          @current_volume += 1
+        elsif @current_volume > 0 && !@is_upwards
+          @current_volume -= 1
+        end
+      end
+
+      def dac_output
+        return 0.0 unless @dac_enabled && @enabled
+
+        ret = WAVE_DUTY[@wave_duty_pattern][@wave_duty_position] * @current_volume
+        (ret / 7.5) - 1.0
+      end
+
+      def read_nr2x(x)
+        case x
+        when 1 then (@wave_duty_pattern << 6) | 0x3f
+        when 2 then (@initial_volume << 4) | (@is_upwards ? 0x08 : 0x00) | @period
+        when 3 then 0xff
+        when 4 then (@length_enabled ? 0x40 : 0x00) | 0xbf
+        else 0xff
+        end
+      end
+
+      def write_nr2x(x, val)
+        case x
+        when 1
+          @wave_duty_pattern = (val >> 6) & 0x03
+          @length_timer = 64 - (val & 0x3f)
+        when 2
+          @is_upwards = (val & 0x08) > 0
+          @initial_volume = (val >> 4)
+          @period = val & 0x07
+          @dac_enabled = val & 0xf8 > 0
+          @enabled &= @dac_enabled
+        when 3
+          @frequency = (@frequency & 0x700) | val
+        when 4
+          @frequency = (@frequency & 0xff) | ((val & 0x07) << 8)
+          @length_enabled = (val & 0x40) > 0
+          @length_timer = 64 if @length_timer == 0
+          return unless (val & 0x80) > 0 && @dac_enabled
+
+          @enabled = true
+          @period_timer = @period
+          @current_volume = @initial_volume
+        end
+      end
+    end
+  end
+end

data/lib/rubyboy/apu_channels/channel3.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Rubyboy
+  module ApuChannels
+    class Channel3
+      attr_accessor :enabled, :wave_duty_position, :wave_ram
+
+      WAVE_DUTY = [
+        [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0], # 12.5%
+        [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0], # 25%
+        [0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 1.0, 1.0], # 50%
+        [0.0, 0.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]  # 75%
+      ].freeze
+
+      def initialize
+        @cycles = 0
+        @frequency = 0
+        @frequency_timer = 0
+        @wave_duty_position = 0
+
+        @enabled = false
+        @dac_enabled = false
+        @length_enabled = false
+        @is_upwards = false
+        @is_decrementing = false
+        @sweep_enabled = false
+        @sweep_period = 0
+        @sweep_shift = 0
+        @period = 0
+        @period_timer = 0
+        @current_volume = 0
+        @initial_volume = 0
+        @shadow_frequency = 0
+        @sweep_timer = 0
+        @length_timer = 0
+        @wave_duty_pattern = 0
+
+        @output_level = 0
+        @volume_shift = 0
+        @wave_ram = Array.new(16, 0)
+      end
+
+      def step(cycles)
+        @cycles += cycles
+
+        return if @cycles < @frequency_timer
+
+        @cycles -= @frequency_timer
+        @frequency_timer = (2048 - @frequency) * 2
+        @wave_duty_position = (@wave_duty_position + 1) % 32
+      end
+
+      def step_fs(fs)
+        length if fs & 0x01 == 0
+      end
+
+      def length
+        return unless @length_enabled && @length_timer > 0
+
+        @length_timer -= 1
+        @enabled &= @length_timer > 0
+      end
+
+      def calculate_frequency
+        if @is_decrementing
+          if @shadow_frequency >= (@shadow_frequency >> @sweep_shift)
+            @shadow_frequency - (@shadow_frequency >> @sweep_shift)
+          else
+            0
+          end
+        else
+          [0x3ff, @shadow_frequency + (@shadow_frequency >> @sweep_shift)].min
+        end
+      end
+
+      def dac_output
+        return 0.0 unless @dac_enabled && @enabled
+
+        ret = ((0xf & (
+          @wave_ram[@wave_duty_position >> 1] >> ((@wave_duty_position & 0x01) << 2)
+        ))) >> @volume_shift
+
+        (ret / 7.5) - 1.0
+      end
+
+      def read_nr3x(x)
+        case x
+        when 0 then ((@dac_enabled ? 0x80 : 0x00) | 0x7f)
+        when 1 then 0xff
+        when 2 then (@output_level << 5) | 0x9f
+        when 3 then 0xff
+        when 4 then (@length_enabled ? 0x40 : 0x00) | 0xbf
+        else 0xff
+        end
+      end
+
+      def write_nr3x(x, val)
+        case x
+        when 0
+          @dac_enabled = val & 0x80 > 0
+          @enabled &= @dac_enabled
+        when 1
+          @length_timer = 256 - val
+        when 2
+          @output_level = (val >> 5) & 0x03
+        when 3
+          @frequency = (@frequency & 0x700) | val
+        when 4
+          @frequency = (@frequency & 0xff) | ((val & 0x07) << 8)
+          @length_enabled = val & 0x40 > 0
+          @length_timer = 256 if @length_timer == 0
+          @enabled = true if (val & 0x80) > 0 && @dac_enabled
+        end
+      end
+    end
+  end
+end

data/lib/rubyboy/apu_channels/channel4.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module Rubyboy
+  module ApuChannels
+    class Channel4
+      attr_accessor :enabled, :wave_duty_position
+
+      WAVE_DUTY = [
+        [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0], # 12.5%
+        [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0], # 25%
+        [0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 1.0, 1.0], # 50%
+        [0.0, 0.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0]  # 75%
+      ].freeze
+
+      def initialize
+        @cycles = 0
+        @frequency = 0
+        @frequency_timer = 0
+        @wave_duty_position = 0
+
+        @enabled = false
+        @dac_enabled = false
+        @length_enabled = false
+        @is_upwards = false
+        @is_decrementing = false
+        @sweep_enabled = false
+        @sweep_period = 0
+        @sweep_shift = 0
+        @period = 0
+        @period_timer = 0
+        @current_volume = 0
+        @initial_volume = 0
+        @shadow_frequency = 0
+        @sweep_timer = 0
+        @length_timer = 0
+        @wave_duty_pattern = 0
+
+        @lfsr = 0x7fff
+        @width_mode = false
+        @shift_amount = 0
+        @divisor_code = 0
+      end
+
+      def step(cycles)
+        @cycles += cycles
+
+        return if @cycles < @frequency_timer
+
+        @cycles -= @frequency_timer
+        @frequency_timer = [8, @divisor_code << 4].max << @shift_amount
+
+        xor = (@lfsr & 0x01) ^ ((@lfsr & 0b10) >> 1)
+        @lfsr = (@lfsr >> 1) | (xor << 14)
+        return unless @width_mode
+
+        @lfsr &= ~(1 << 6)
+        @lfsr |= xor << 6
+      end
+
+      def step_fs(fs)
+        length if fs & 0x01 == 0
+        envelope if fs == 7
+      end
+
+      def length
+        return unless @length_enabled && @length_timer > 0
+
+        @length_timer -= 1
+        @enabled &= @length_timer > 0
+      end
+
+      def envelope
+        return if @period == 0
+
+        @period_timer -= 1 if @period_timer > 0
+
+        return if @period_timer != 0
+
+        @period_timer = @period
+
+        if @current_volume < 15 && @is_upwards
+          @current_volume += 1
+        elsif @current_volume > 0 && !@is_upwards
+          @current_volume -= 1
+        end
+      end
+
+      def calculate_frequency
+        if @is_decrementing
+          if @shadow_frequency >= (@shadow_frequency >> @sweep_shift)
+            @shadow_frequency - (@shadow_frequency >> @sweep_shift)
+          else
+            0
+          end
+        else
+          [0x3ff, @shadow_frequency + (@shadow_frequency >> @sweep_shift)].min
+        end
+      end
+
+      def dac_output
+        return 0.0 unless @dac_enabled && @enabled
+
+        ret = (@lfsr & 0x01) * @current_volume
+        (ret / 7.5) - 1.0
+      end
+
+      def read_nr4x(x)
+        case x
+        when 0 then 0xff
+        when 1 then 0xff
+        when 2 then (@initial_volume << 4) | (@is_upwards ? 0x08 : 0x00) | @period
+        when 3 then (@shift_amount << 4) | (@width_mode ? 0x08 : 0x00) | @divisor_code
+        when 4 then (@length_enabled ? 0x40 : 0x00) | 0xbf
+        else 0xff
+        end
+      end
+
+      def write_nr4x(x, val)
+        case x
+        when 0
+          # nop
+        when 1
+          @length_timer = 64 - (val & 0x3f)
+        when 2
+          @is_upwards = (val & 0x08) > 0
+          @initial_volume = val >> 4
+          @period = val & 0x07
+          @dac_enabled = val & 0xf8 > 0
+          @enabled &= @dac_enabled
+        when 3
+          @shift_amount = (val >> 4) & 0x0f
+          @width_mode = (val & 0x08) > 0
+          @divisor_code = val & 0x07
+        when 4
+          @length_enabled = (val & 0x40) > 0
+          @length_timer = 64 if @length_timer == 0
+          return unless (val & 0x80) > 0
+
+          @enabled = true if @dac_enabled
+
+          @lfsr = 0x7fff
+          @period_timer = @period
+          @current_volume = @initial_volume
+        end
+      end
+    end
+  end
+end