badline 0.17.0 → 0.19.0

data/lib/badline/snapshot/vice/vic20_vici.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module Badline
+  module Snapshot
+    module Vice
+      module Vic20
+        # The VIC-I as xvic 3.10 saves it, VIC-I 0.4. The layout was inferred
+        # from xvic's snapshots of known states, set from its monitor and
+        # stepped an instruction at a time, against what its monitor's io
+        # command and its registers showed:
+        #
+        # - $00 dword: 1 while the frame is interlaced, $04 dword: the field,
+        #   0 the long one and 1 the short one; $08 qword: the clock at the
+        #   frame's first cycle
+        # - $10 byte: the cycle in the line; $11 word: the raster line; $13
+        #   byte: the text window, 0 before it, 1 on its first line until
+        #   the column in $9000, 2 on its lines after that and 3 after it;
+        #   $15 byte: the line's fetches, 0 off the window or before the
+        #   column in $9000, 1 from there, 2 from the cycle before the first
+        #   fetch, then 3 with a pattern fetch next and 2 with a code fetch
+        #   next, 4 once done; $17 word: the line again
+        # - $1B dword: the columns; $1F dword: the rows; $23 dword: the
+        #   columns again; $27 dword: 0 on a line after one of the
+        #   window's, 1 on the others; $2B dword: the video matrix
+        #   offset the text row starts at; $33 dword: the text rows done;
+        #   $37 dword: while the fetches wait, the cycles left until the
+        #   cycle before the first, then the characters fetched, and the
+        #   columns while $15 is 0
+        # - $3D and $41 dwords: the light pen's latch, $9006 and $9007;
+        #   $45 dword: 1 in every snapshot xvic wrote; $49: 8 bytes of $FF;
+        #   $51 byte: the last character code fetched
+        # - $52: the colour RAM, 1,024 bytes; $452: the registers, 16
+        #   bytes, with $9003 bit 7 and $9004 as written; $462 dword: the
+        #   raster line again
+        # - $466 dword: the width of xvic's picture, $46A dword: its lines,
+        #   312 on the 6561 and 262 on the 6560; $46E dword: its pitch,
+        #   then the picture itself, twice its lines and 8 more of pitch
+        #   bytes, and 4 bytes after it, 0 in every snapshot
+        #
+        # Bytes the layout leaves out, $14, $16, $19-$1A, $2F-$32 and
+        # $3B-$3C, were 0 in every snapshot.
+        #
+        # Written: all of it from badline's VIC, the picture as zeros. The
+        # cycle is badline's column, which is where xvic's monitor puts
+        # the cycle at an instruction boundary. Read: the registers, the
+        # beam, the frame and field, the text window's counters and the
+        # line's fetches, the light pen and the colour RAM; the character
+        # line is worked out from the line and $9001, as xvic's monitor
+        # works it out. The picture is painted afresh.
+        module VICI
+          NAME = "VIC-I"
+          MAJOR = 0
+          MINOR = 4
+          HEADER = 0x472
+          COLOR_RAM = 0x52
+          REGISTERS = 0x452
+          # xvic's picture: width, lines and pitch, by model.
+          PICTURES = { "pal" => [1648, 312, 1648], "ntsc" => [1536, 262, 1536] }.freeze
+          AREA_BEFORE = 0
+          AREA_FIRST = 1
+          AREA_IN = 2
+          AREA_AFTER = 3
+          FETCH_WAITING = 1
+          FETCH_CODE = 2
+          FETCH_PATTERN = 3
+          FETCH_DONE = 4
+          LIGHT_PEN_FLAG = 1
+          FILLER = 0xff
+
+          module_function
+
+          def reads?(section) = section.major == MAJOR && section.minor == MINOR && section.data.bytesize >= HEADER
+
+          # The model whose picture the module's size says, or nil.
+          def model(section)
+            lines = FieldReader.new(section).skip(0x46a).dword
+            PICTURES.find { |_, picture| picture[1] == lines }&.first
+          end
+
+          # The module for `machine` from its BL-VICI and BL-COLORRAM fields.
+          def export(machine, vic, color_ram)
+            profile = machine.vic.profile
+            registers = vic.bytes("registers", "\0".b * 16).bytes
+            line = vic.int("raster", 0)
+            column = vic.int("column", 0)
+            frame_lines = vic.int("frame_lines", profile.lines_per_frame)
+            fields = FieldWriter.new
+            interlaced = frame_lines != profile.lines_per_frame
+            fields.dword(interlaced ? 1 : 0).dword(interlaced && frame_lines != profile.interlaced_lines ? 1 : 0)
+            fields.qword(machine.cycles - (line * profile.cycles_per_line) - column)
+            window(fields, vic, registers, line, column)
+            fields.dword(vic.int("pen.x", 0)).dword(vic.int("pen.y", 0)).dword(LIGHT_PEN_FLAG)
+            fields.bytes(Array.new(8, FILLER)).byte(vic.int("code", 0))
+            colors = color_ram.bytes("ram", "".b).bytes
+            fields.bytes(Array.new(0x400) { |cell| colors.fetch(cell, 0) & 0x0f })
+            fields.bytes(registers).dword(line)
+            picture(fields, PICTURES.fetch(machine.model))
+            fields.section(NAME, MAJOR, MINOR)
+          end
+
+          def window(fields, vic, registers, line, column)
+            open = vic.bool("window_open", false)
+            done = vic.bool("window_done", false)
+            columns = registers[2] & 0x7f
+            rows = (registers[3] >> 1) & 0x3f
+            first = open && vic.int("text_rows", 0).zero? && vic.int("char_line", 0).zero?
+            origin = registers[0] & 0x7f
+            area = if open then first && column < origin ? AREA_FIRST : AREA_IN
+                   else done ? AREA_AFTER : AREA_BEFORE
+                   end
+            state, count = fetches(vic, open && column >= origin, columns, column)
+            fields.byte(column).word(line).byte(area).byte(0).byte(state).byte(0).word(line).word(0)
+            fields.dword(columns).dword(rows).dword(columns)
+            fields.dword(border?(open, first, done, registers, line) ? 1 : 0)
+            fields.dword(vic.int("row_start", 0)).dword(0).dword(vic.int("text_rows", 0)).dword(count).word(0)
+          end
+
+          # The line's fetches as xvic counts them, from the column in
+          # $9000 on: waiting, with the cycles left until the cycle before
+          # the first fetch, then fetching, with the characters fetched.
+          # Before that column, and off the window's lines, the count is
+          # the columns.
+          def fetches(vic, started, columns, column)
+            return [0, columns] unless started
+
+            from = vic.int("fetch_from", 0)
+            return [FETCH_WAITING, from - 1 - column] if column < from - 1
+            return [FETCH_CODE, 0] if column < from
+
+            fetched = vic.int("fetched", 0)
+            return [FETCH_DONE, columns] if fetched >= columns
+
+            [(column - from).even? ? FETCH_PATTERN : FETCH_CODE, fetched]
+          end
+
+          # Whether xvic's flag at $27 is set: unless the window was open
+          # on the line before.
+          def border?(open, first, done, registers, line)
+            return first if open
+            return true unless done
+
+            height = registers[3].anybits?(0x01) ? 16 : 8
+            line != (registers[1] * 2) + (((registers[3] >> 1) & 0x3f) * height)
+          end
+
+          def picture(fields, (width, lines, pitch))
+            fields.dword(width).dword(lines).dword(pitch).zeros((((2 * lines) + 8) * pitch) + 4)
+          end
+
+          # The colour RAM's cells, low nibbles.
+          def colors(section) = FieldReader.new(section).skip(COLOR_RAM).bytes(0x400).map { |cell| cell & 0x0f }
+
+          # BL-VICI's fields for `machine`'s profile, in a keyed module's
+          # writer.
+          def import(section, out, profile)
+            fields = FieldReader.new(section)
+            interlaced = fields.dword == 1
+            short = fields.dword == 1
+            fields.skip(8)
+            column = fields.byte
+            line = fields.word
+            area = fields.byte
+            fields.skip(1)
+            state = fields.byte
+            fields.skip(5 + 16)
+            row_start = fields.dword
+            fields.skip(4)
+            text_rows = fields.dword
+            count = fields.dword
+            fields.skip(2)
+            pen_x = fields.dword
+            pen_y = fields.dword
+            fields.skip(4 + 8)
+            code = fields.byte
+            registers = FieldReader.new(section).skip(REGISTERS).bytes(16)
+            out.bytes("registers", registers).int("raster", line).int("column", column)
+            frame_lines = if interlaced then short ? profile.interlaced_lines - 1 : profile.interlaced_lines
+                          else profile.lines_per_frame
+                          end
+            out.int("frame_lines", frame_lines).bool("long_field", !interlaced || short)
+            open = [AREA_FIRST, AREA_IN].include?(area)
+            out.bool("window_open", open).bool("window_done", area == AREA_AFTER)
+            fetching = open && state != FETCH_WAITING && state != 0
+            out.int("row_start", row_start).int("matrix", row_start + (fetching ? count : 0))
+            out.int("char_line", open ? char_line(registers, line) : 0).int("text_rows", text_rows)
+            out.int("fetch_from", open ? (registers[0] & 0x7f) + Chips::VICI::FETCH_DELAY : 0)
+            out.int("fetched", fetching ? count : 0).int("code", code)
+            out.int("pen.x", pen_x & 0xff).int("pen.y", pen_y & 0xff)
+          end
+
+          # The line of the character row the window is on.
+          def char_line(registers, line)
+            height = registers[3].anybits?(0x01) ? 16 : 8
+            (line - (registers[1] * 2)) % height
+          end
+        end
+      end
+    end
+  end
+end

data/lib/badline/snapshot/vice.rb

@@ -14,6 +14,7 @@ require "badline/snapshot/vice/vicii"
 require "badline/snapshot/vice/vicii_import"
 require "badline/snapshot/vice/restore"
 require "badline/snapshot/vice/pet"
+require "badline/snapshot/vice/vic20"
 require "badline/snapshot/vice/cbm2"
 require "badline/snapshot/vice/p500"
 require "badline/snapshot/vice/p500_restore"

data/lib/badline/snapshot.rb

@@ -25,8 +25,8 @@ module Badline
       path
     end
 
-    # Saves the machine's snapshot with VICE's modules ahead of its own for
-    # a C64, so x64sc opens it too.
+    # Saves the machine's snapshot with VICE's modules ahead of its own, so
+    # x64sc, xvic, xpet, xcbm2 or xcbm5x0 opens it too (Image.exported).
     def export(computer, path)
       File.binwrite(path, Image.exported(computer).to_s)
       path
@@ -56,8 +56,8 @@ module Badline
     module Files
       def save_snapshot(path) = Snapshot.save(self, path)
 
-      # Saves the snapshot with VICE's modules too, for a C64, so x64sc
-      # opens it as well as badline.
+      # Saves the snapshot with VICE's modules too, so VICE's emulator for
+      # the machine opens it as well as badline (Image.exported).
       def export_snapshot(path) = Snapshot.export(self, path)
 
       def restore_snapshot(path, &) = Snapshot.restore(self, path, &)
@@ -100,6 +100,10 @@ module Badline
     include Snapshot::Files
   end
 
+  class KIM1
+    include Snapshot::Files
+  end
+
   class CBM2
     include Snapshot::Files
 

data/lib/badline/status.rb

@@ -36,7 +36,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x01 : @value & ~0x01
     end
 
-    def carry? = @value & 0x01 != 0
+    def carry? = @value.anybits?(0x01)
 
     def carry = @value.nobits?(0x01) ? 0 : 1
 
@@ -44,7 +44,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x02 : @value & ~0x02
     end
 
-    def zero? = @value & 0x02 != 0
+    def zero? = @value.anybits?(0x02)
 
     def zero = @value.nobits?(0x02) ? 0 : 1
 
@@ -52,7 +52,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x04 : @value & ~0x04
     end
 
-    def interrupt? = @value & 0x04 != 0
+    def interrupt? = @value.anybits?(0x04)
 
     def interrupt = @value.nobits?(0x04) ? 0 : 1
 
@@ -60,7 +60,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x08 : @value & ~0x08
     end
 
-    def decimal? = @value & 0x08 != 0
+    def decimal? = @value.anybits?(0x08)
 
     def decimal = @value.nobits?(0x08) ? 0 : 1
 
@@ -68,7 +68,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x10 : @value & ~0x10
     end
 
-    def break? = @value & 0x10 != 0
+    def break? = @value.anybits?(0x10)
 
     def break = @value.nobits?(0x10) ? 0 : 1
 
@@ -76,7 +76,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x40 : @value & ~0x40
     end
 
-    def overflow? = @value & 0x40 != 0
+    def overflow? = @value.anybits?(0x40)
 
     def overflow = @value.nobits?(0x40) ? 0 : 1
 
@@ -84,7 +84,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x80 : @value & ~0x80
     end
 
-    def negative? = @value & 0x80 != 0
+    def negative? = @value.anybits?(0x80)
 
     def negative = @value.nobits?(0x80) ? 0 : 1
   end
@@ -95,7 +95,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x01 : @value & ~0x01
     end
 
-    def basic? = @value & 0x01 != 0
+    def basic? = @value.anybits?(0x01)
 
     def basic = @value.nobits?(0x01) ? 0 : 1
 
@@ -103,7 +103,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x02 : @value & ~0x02
     end
 
-    def kernal? = @value & 0x02 != 0
+    def kernal? = @value.anybits?(0x02)
 
     def kernal = @value.nobits?(0x02) ? 0 : 1
 
@@ -111,7 +111,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x04 : @value & ~0x04
     end
 
-    def io? = @value & 0x04 != 0
+    def io? = @value.anybits?(0x04)
 
     def io = @value.nobits?(0x04) ? 0 : 1
 
@@ -119,7 +119,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x08 : @value & ~0x08
     end
 
-    def tape_out? = @value & 0x08 != 0
+    def tape_out? = @value.anybits?(0x08)
 
     def tape_out = @value.nobits?(0x08) ? 0 : 1
 
@@ -127,7 +127,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x10 : @value & ~0x10
     end
 
-    def tape_switch? = @value & 0x10 != 0
+    def tape_switch? = @value.anybits?(0x10)
 
     def tape_switch = @value.nobits?(0x10) ? 0 : 1
 
@@ -135,7 +135,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x20 : @value & ~0x20
     end
 
-    def tape_motor? = @value & 0x20 != 0
+    def tape_motor? = @value.anybits?(0x20)
 
     def tape_motor = @value.nobits?(0x20) ? 0 : 1
   end
@@ -146,7 +146,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x01 : @value & ~0x01
     end
 
-    def start? = @value & 0x01 != 0
+    def start? = @value.anybits?(0x01)
 
     def start = @value.nobits?(0x01) ? 0 : 1
 
@@ -154,7 +154,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x02 : @value & ~0x02
     end
 
-    def output? = @value & 0x02 != 0
+    def output? = @value.anybits?(0x02)
 
     def output = @value.nobits?(0x02) ? 0 : 1
 
@@ -162,7 +162,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x04 : @value & ~0x04
     end
 
-    def out_mode? = @value & 0x04 != 0
+    def out_mode? = @value.anybits?(0x04)
 
     def out_mode = @value.nobits?(0x04) ? 0 : 1
 
@@ -170,7 +170,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x08 : @value & ~0x08
     end
 
-    def run_mode? = @value & 0x08 != 0
+    def run_mode? = @value.anybits?(0x08)
 
     def run_mode = @value.nobits?(0x08) ? 0 : 1
 
@@ -178,7 +178,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x10 : @value & ~0x10
     end
 
-    def load? = @value & 0x10 != 0
+    def load? = @value.anybits?(0x10)
 
     def load = @value.nobits?(0x10) ? 0 : 1
 
@@ -186,7 +186,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x20 : @value & ~0x20
     end
 
-    def in_mode? = @value & 0x20 != 0
+    def in_mode? = @value.anybits?(0x20)
 
     def in_mode = @value.nobits?(0x20) ? 0 : 1
 
@@ -194,7 +194,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x40 : @value & ~0x40
     end
 
-    def serial_mode? = @value & 0x40 != 0
+    def serial_mode? = @value.anybits?(0x40)
 
     def serial_mode = @value.nobits?(0x40) ? 0 : 1
 
@@ -202,7 +202,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x80 : @value & ~0x80
     end
 
-    def clock_frequency? = @value & 0x80 != 0
+    def clock_frequency? = @value.anybits?(0x80)
 
     def clock_frequency = @value.nobits?(0x80) ? 0 : 1
 
@@ -210,7 +210,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x20 : @value & ~0x20
     end
 
-    def in_cnt? = @value & 0x20 != 0
+    def in_cnt? = @value.anybits?(0x20)
 
     def in_cnt = @value.nobits?(0x20) ? 0 : 1
 
@@ -218,7 +218,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x40 : @value & ~0x40
     end
 
-    def in_timer_a? = @value & 0x40 != 0
+    def in_timer_a? = @value.anybits?(0x40)
 
     def in_timer_a = @value.nobits?(0x40) ? 0 : 1
 
@@ -226,7 +226,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x80 : @value & ~0x80
     end
 
-    def alarm? = @value & 0x80 != 0
+    def alarm? = @value.anybits?(0x80)
 
     def alarm = @value.nobits?(0x80) ? 0 : 1
   end
@@ -237,7 +237,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x01 : @value & ~0x01
     end
 
-    def timer_a? = @value & 0x01 != 0
+    def timer_a? = @value.anybits?(0x01)
 
     def timer_a = @value.nobits?(0x01) ? 0 : 1
 
@@ -245,7 +245,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x02 : @value & ~0x02
     end
 
-    def timer_b? = @value & 0x02 != 0
+    def timer_b? = @value.anybits?(0x02)
 
     def timer_b = @value.nobits?(0x02) ? 0 : 1
 
@@ -253,7 +253,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x04 : @value & ~0x04
     end
 
-    def alarm? = @value & 0x04 != 0
+    def alarm? = @value.anybits?(0x04)
 
     def alarm = @value.nobits?(0x04) ? 0 : 1
 
@@ -261,7 +261,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x08 : @value & ~0x08
     end
 
-    def serial? = @value & 0x08 != 0
+    def serial? = @value.anybits?(0x08)
 
     def serial = @value.nobits?(0x08) ? 0 : 1
 
@@ -269,7 +269,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x10 : @value & ~0x10
     end
 
-    def flag? = @value & 0x10 != 0
+    def flag? = @value.anybits?(0x10)
 
     def flag = @value.nobits?(0x10) ? 0 : 1
 
@@ -277,7 +277,7 @@ module Badline
       @value = enabled && enabled != 0 ? @value | 0x80 : @value & ~0x80
     end
 
-    def interrupt? = @value & 0x80 != 0
+    def interrupt? = @value.anybits?(0x80)
 
     def interrupt = @value.nobits?(0x80) ? 0 : 1
   end

data/lib/badline/storage/d67_image.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Badline
+  module Storage
+    # A 2040's disk, as DOS 1 formats it: the 1541's 35 tracks and speed
+    # zones, with 20 sectors on tracks 18 to 24 in place of 19, 690 blocks
+    # in all. The BAM and the directory are where a 1541's are, on 18/0
+    # and 18/1, but the BAM's format byte is $01 and the header has no DOS
+    # type after the ID, as c1541 formats a .d67.
+    class D67Image < DiskImage
+      ERROR_TABLES = { 177_330 => 690 }.freeze
+
+      # The sectors a track holds in each of the 1541's speed zones, by its
+      # number, from zone 0, the innermost.
+      ZONE_SECTORS = [17, 18, 20, 21].freeze
+
+      # The tracks the image holds.
+      def track_count = 35
+
+      def sides = 1
+
+      def sectors_in(track) = ZONE_SECTORS[D64Image.zone(track)]
+
+      private
+
+      def error_tables = ERROR_TABLES
+
+      def header_name = 0x90
+      def directory_track = 18
+      def directory_sector = 1
+      def directory_interleave = 3
+      def interleave = 10
+      def reserved_tracks = [18]
+
+      def bam_tracks = 1..35
+      def bam_count(track) = [18, 0, 4 * track]
+      def bam_bitmap(track) = [18, 0, (4 * track) + 1]
+      def bitmap_size = 3
+
+      def header_link = [18, 1]
+      def dos_type = "  "
+      def header_tail = 5
+      def bam_headers(_id) = []
+
+      # The link to the directory, the format byte $01, and after the name
+      # the ID and two spaces.
+      def write_header(name, id)
+        write_at(*header_block, 0, [*header_link, 0x01, 0])
+        write_at(*header_block, header_name,
+                 encode_name(name) + [NAME_PADDING, NAME_PADDING] + id + dos_type.bytes +
+                 Array.new(header_tail, NAME_PADDING))
+      end
+    end
+  end
+end