badline 0.16.1 → 0.17.0

data/lib/badline/options/family.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "badline/storage/crt_file"
 require "badline/storage/p00"
 require "badline/storage/tap"
 
@@ -13,7 +14,8 @@ module Badline
 
       private
 
-      # Takes `sid`, `c64`, `vic20`, `c128`, `plus4` or `pet` when given first.
+      # Takes `sid`, `c64`, `vic20`, `c128`, `plus4`, `pet` or `cbm2` when
+      # given first.
       def subcommand(args)
         case args.first
         when "sid" then @sid_command = true
@@ -22,6 +24,7 @@ module Badline
         when "c128" then @family = :c128
         when "plus4" then @family = :plus4
         when "pet" then @family = :pet
+        when "cbm2" then @family = :cbm2
         else return
         end
         @family_named = !@sid_command
@@ -34,23 +37,32 @@ module Badline
         when :c128 then C128_MODELS
         when :plus4 then PLUS4_MODELS
         when :pet then PET_MODELS
+        when :cbm2 then CBM2_MODELS
         else MODELS
         end
       end
 
       # Without a family named, a program that loads at C128_BASIC_START is
-      # the C128's, and an 8050's or 8250's disk or a PET tape the PET's. A
-      # program that loads where PET BASIC starts could be a VIC-20's too.
+      # the C128's, an 8050's or 8250's disk or a PET tape the PET's, and a
+      # cartridge signed as a CBM-II's the CBM-II's. A program that loads
+      # where PET BASIC starts could be a VIC-20's too.
       def pick_family
         return if @family_named || @sid_command || @media_path.nil? || !File.file?(@media_path)
 
         if pet_media?
           @family = :pet
+        elsif cbm2_cartridge?
+          @family = :cbm2
         elsif Media::Extensions::PROGRAMS.include?(File.extname(@media_path).downcase)
           @family = :c128 if Storage::P00.load_address(@media_path) == C128_BASIC_START
         end
       end
 
+      # Whether the media is a cartridge signed as a CBM-II's.
+      def cbm2_cartridge?
+        Media::Extensions.kind(@media_path) == :cartridge && Storage::CRTFile.cbm2?(@media_path)
+      end
+
       # Whether the media is an 8050's or 8250's disk or a PET tape.
       def pet_media?
         kind = Media::Extensions.kind(@media_path)

data/lib/badline/options/help.rb

@@ -86,6 +86,7 @@ module Badline
                #{@program} c128 [options] [media]
                #{@program} plus4 [options] [media]
                #{@program} pet [options] [media]
+               #{@program} cbm2 [options] [media]
                #{@program} --headless [options] tune.sid
                #{@program} [options] tune.sid --audio-out FILE
                #{@program} sid [options] FILE|DIR...
@@ -96,6 +97,7 @@ module Badline
             c128                             Run a C128 in C128 mode, the one --model names
             plus4                            Run a Plus/4 or a C16, the one --model names
             pet                              Run a PET or a CBM, the one --model names
+            cbm2                             Run a CBM-II, a B series or a P500, the one --model names
             sid                              Play .sid tunes and directories of them
 
         #{media_kinds}
@@ -135,6 +137,18 @@ module Badline
         it with the DIN character ROM, and --jumpers ram9,rama puts RAM at
         $9000 and $A000, as xpet's -petram9 and -petramA do.
 
+        The CBM-II takes programs, disks, .d80 and .d82 among them, and
+        cartridges, and a cartridge made for it starts one without `cbm2`.
+        --kernal 03b fits the 1983 KERNAL in place of 04a, and --60hz runs
+        it on 60 Hz mains. Its --true-drive makes device 8 an emulated 2031
+        on its IEEE-488 bus, which reads .d64 and .g64 images, and a .d80
+        or a .d82 then goes in an emulated 8050 or 8250. Its keys type what
+        the host's keys type, F12 is RUN/STOP, Alt with F9 or F10 presses
+        its F9 or F10, and the pause menu's KEYBOARD page says where the
+        rest are. --model 510 or 510ntsc runs the P500, on the VIC-II with
+        KERNAL 02, whose keys are the B series' and whose two joysticks Tab
+        switches to.
+
         --headless plays a .sid tune on the host's audio device without the
         window, and --audio-out renders it to 16-bit PCM instead. The
         container follows the file's extension, .wav or .aiff. Played on a
@@ -156,8 +170,8 @@ module Badline
         in --at 3500:key=space or --at 250,500:screenshot=shot%05d.bmp.
         key=NAME presses a key (space, return, a, f1, run_stop, restore, and
         on the C128 esc, help, keypad1 and the rest, on the Plus/4
-        esc, help and f1 to f3, and on the PET rvs, escape and kp1) or a
-        joystick's
+        esc, help and f1 to f3, on the PET rvs, escape and kp1, and on
+        the CBM-II escape, norm_graph and kp00) or a joystick's
         direction or fire (joy1-up, joy2-fire) for #{Event::HOLD} frames, and
         pushes the C128's caps_lock or forty_eighty, which lock. type=TEXT
         types it, with \\n for RETURN. insert=FILE swaps in a disk, a list's

data/lib/badline/options/table.rb

@@ -22,6 +22,16 @@ module Badline
     # default.
     PET_MODELS = %w[8032 8096 8296 4032 3032 3032b 2001].freeze
 
+    # The CBM-II's B series, as CBM2::Model names them, the 610 first, the
+    # default, and the P500, as CBM2::P500::Model names them.
+    CBM2_MODELS = %w[610 620 710 720 510 510ntsc].freeze
+
+    # The B series' KERNALs --kernal names, 901244-04a first, the default.
+    CBM2_KERNALS = %w[04a 03b].freeze
+
+    # The P500's one KERNAL, 901234-02.
+    P500_KERNALS = %w[02].freeze
+
     # The true drives --drive-type names for the Plus/4.
     PLUS4_DRIVE_TYPES = %w[1541 1551].freeze
 
@@ -47,7 +57,8 @@ module Badline
                  section: "Window options", needs: :window),
       Option.new("--no-sound", "Don't play the SID", section: "Window options", needs: :window, build: :native),
       Option.new("--true-drive", "Put a true 1541 on device 8 instead of the KERNAL traps, a 1571 on the C128, " \
-                                 "a 1551 on the Plus/4, a 2031 on the PET",
+                                 "a 1551 on the Plus/4, a 2031 on the PET or the CBM-II, or for a .d80 or .d82 " \
+                                 "an 8050 or 8250",
                  section: "Window options", needs: :window),
       Option.new("--drive-type MODEL", "The Plus/4's true drive: 1541 or 1551 (default: 1551); implies --true-drive",
                  section: "Window options", needs: :window),
@@ -55,7 +66,7 @@ module Badline
                  section: "Window options", needs: :window),
       Option.new("--model NAME", "C64 to run: #{MODELS.join(', ')} (default: #{MODELS.first}); VIC-20: pal; " \
                                  "C128: #{C128_MODELS.join(', ')}; Plus/4: #{PLUS4_MODELS.join(', ')}; " \
-                                 "PET: #{PET_MODELS.join(', ')}",
+                                 "PET: #{PET_MODELS.join(', ')}; CBM-II: #{CBM2_MODELS.join(', ')}",
                  section: "Window options", needs: :window),
       Option.new("--ntsc", "Run an NTSC C64, as --model ntsc does", section: "Window options", needs: :window),
       Option.new("--c64", "Start the C128 in C64 mode, holding C= at power-on",
@@ -63,7 +74,10 @@ module Badline
       Option.new("--ram SIZE", "VIC-20 RAM expansion: #{RAM_NAMES.join(', ')} (default: unexpanded); " \
                                "Plus/4 RAM: 16k, 32k or 64k; PET RAM: 4k, 8k, 16k or 32k (default: the model's own)",
                  section: "Window options", needs: :window),
-      Option.new("--60hz", "Run a CRTC PET's 60 Hz editor instead of its 50 Hz one",
+      Option.new("--60hz", "Run a CRTC PET's 60 Hz editor instead of its 50 Hz one, or a CBM-II on 60 Hz mains",
+                 section: "Window options", needs: :window),
+      Option.new("--kernal VERSION", "Fit a CBM-II with KERNAL #{CBM2_KERNALS.join(' or ')} " \
+                                     "(default: #{CBM2_KERNALS.first}); the P500 takes #{P500_KERNALS.first}",
                  section: "Window options", needs: :window),
       Option.new("--basic VERSION", "Fit a PET with BASIC 1, 2 or 4, as its board takes (default: its own)",
                  section: "Window options", needs: :window),
@@ -118,7 +132,7 @@ module Badline
                  section: "Testing options", needs: :window),
       Option.new("--save-snapshot FILE", "Save the machine as a .vsf snapshot after the last frame",
                  section: "Testing options", needs: :window),
-      Option.new("--vice", "Add VICE's modules to --save-snapshot's C64 or PET snapshot, for x64sc or xpet",
+      Option.new("--vice", "Add VICE's modules to --save-snapshot's C64, PET or CBM-II snapshot",
                  section: "Testing options", needs: :window),
       Option.new("--at FRAME:EVENT", "Run EVENT once FRAME frames have run (see above)",
                  section: "Testing options", needs: :window),

data/lib/badline/options/validation.rb

@@ -57,6 +57,12 @@ module Badline
         value
       end
 
+      def kernal_for(value)
+        raise Error, "invalid argument: --kernal #{value}" unless (CBM2_KERNALS + P500_KERNALS).include?(value)
+
+        value
+      end
+
       def reu_size(value)
         raise Error, "invalid argument: --reu #{value}" unless REU_SIZES.include?(value)
 
@@ -102,6 +108,7 @@ module Badline
         validate_vic20 if @family == :vic20
         @family == :plus4 ? validate_plus4 : refuse_plus4_options
         @family == :pet ? validate_pet : refuse_pet_options
+        @family == :cbm2 ? validate_cbm2 : refuse_cbm2_options
         if @family == :c128
           validate_c128
         elsif @c64_mode
@@ -170,10 +177,10 @@ module Badline
         raise Error, "--sid-card-address needs --sid-card" unless @sid_card_address.nil? || @sid_card
       end
 
-      # Only the PET has a frame rate to pick and BASIC and editor ROMs to
-      # fit.
+      # Only the PET has BASIC and editor ROMs to fit, and only it and the
+      # CBM-II a frame rate to pick.
       def refuse_pet_options
-        raise Error, "--60hz needs pet" unless @refresh_hz.nil?
+        raise Error, "--60hz needs pet or cbm2" unless @refresh_hz.nil? || @family == :cbm2
         raise Error, "--basic needs pet" unless @basic.nil?
         raise Error, "--editor needs pet" unless @editor.nil?
         raise Error, "--characters needs pet" unless @characters.nil?
@@ -232,6 +239,23 @@ module Badline
         @refresh_hz = editor_hz
       end
 
+      # Only the CBM-II has a KERNAL to pick.
+      def refuse_cbm2_options
+        raise Error, "--kernal needs cbm2" unless @kernal.nil?
+      end
+
+      # The CBM-II runs in the window, without the C64's SID and REU, and
+      # its model takes the KERNAL named.
+      def validate_cbm2
+        raise Error, "--ntsc needs the C64; a CBM-II on 60 Hz mains is --60hz" if @models.include?("ntsc")
+        raise Error, "--sid needs the C64" unless @sid_model.nil?
+        raise Error, "--reu needs the C64" unless @reu.nil?
+        raise Error, "the CBM-II needs the window" if headless?
+
+        kernals = p500? ? P500_KERNALS : CBM2_KERNALS
+        raise Error, "the #{model} takes KERNAL #{kernals.join(' or ')}" unless kernals.include?(kernal)
+      end
+
       # `sid` takes directories as well as tunes.
       def validate_tune(path)
         return if !File.exist?(path) || File.extname(path).casecmp?(".sid")

data/lib/badline/options.rb

@@ -13,10 +13,11 @@ module Badline
   # Either opens the window for any media, or with --headless or
   # --audio-out plays or renders a .sid tune without one. `sid`, given
   # first, plays .sid tunes and directories of them in the terminal.
-  # `c64`, `vic20`, `c128`, `plus4` or `pet`, given first, names the
-  # machine family, and without one the family is the C64, the C128 for a
-  # program that loads where C128 BASIC starts, or the PET for an 8050's
-  # or 8250's disk or a PET tape.
+  # `c64`, `vic20`, `c128`, `plus4`, `pet` or `cbm2`, given first, names
+  # the machine family, and without one the family is the C64, the C128
+  # for a program that loads where C128 BASIC starts, the PET for an
+  # 8050's or 8250's disk or a PET tape, or the CBM-II for a cartridge
+  # signed as its own.
   # The native build adds --no-sound and --version, and badline-ruby adds
   # --disable-jit.
   #
@@ -77,7 +78,7 @@ module Badline
                 :audio_out, :seconds, :songlengths, :filter_chunk, :timeline
 
     # The machine family to build (Badline::Machine), :c64, :vic20, :c128,
-    # :plus4 or :pet.
+    # :plus4, :pet or :cbm2.
     attr_reader :family
 
     # The ROMs --basic, --editor and --characters fit a PET with, keys of
@@ -137,6 +138,7 @@ module Badline
       @ram_kb = nil
       @ram_name = nil
       initialize_pet
+      @kernal = nil
       @cartridges = {}
       @autostart = true
       @writable = false
@@ -246,9 +248,20 @@ module Badline
     def c64_mode? = @c64_mode
 
     # The frame rate of a CRTC PET's editor: 60 with --60hz or a 60 Hz
-    # --editor, else 50.
+    # --editor, else 50. A B series CBM-II's mains, which its editor
+    # follows.
     def refresh_hz = @refresh_hz || 50
 
+    # The CBM-II's mains, 60 with --60hz, or nil for the model's own.
+    def mains_hz = @refresh_hz
+
+    # The CBM-II's KERNAL --kernal names, one of CBM2_KERNALS or, on the
+    # P500, P500_KERNALS, the first of them without it.
+    def kernal = @kernal || (p500? ? P500_KERNALS : CBM2_KERNALS).first
+
+    # Whether the CBM-II to run is a P500, a 510 of either region.
+    def p500? = @family == :cbm2 && model.start_with?("510")
+
     def help? = @help
 
     def version? = @version
@@ -264,7 +277,7 @@ module Badline
     # A .sid on its own plays in the SID player, as `sid` would, unless an
     # option of the emulator's window asks for the machine.
     def play_lone_tune
-      return if @sid_command || %i[vic20 plus4 pet].include?(@family) || headless? || !@window_only.empty?
+      return if @sid_command || %i[vic20 plus4 pet cbm2].include?(@family) || headless? || !@window_only.empty?
       return if @media_path.nil?
 
       @sid_command = File.extname(@media_path).casecmp?(".sid")
@@ -326,6 +339,7 @@ module Badline
       when "--ram" then @ram_name = value
       when "--basic", "--editor", "--characters", "--jumpers" then pet_option(name, value)
       when "--drive-type" then @drive_type = drive_type_for(value)
+      when "--kernal" then @kernal = kernal_for(value)
       when "--c1lo", "--c1hi", "--c2lo", "--c2hi" then @cartridges[CARTRIDGE_SLOTS.fetch(name)] = value
       when "--frames" then @frames = number(flag, value)
       when "--screenshot" then @screenshot = value

data/lib/badline/pet/cassettes.rb

@@ -11,7 +11,8 @@ module Badline
     # Both record from VIA PB3. The KERNAL reads each tape as the falling
     # edges its read line makes, as the C64 and VIC-20 do. The machine
     # passes the motor and write lines on after each write to the I/O
-    # chips (#lines_written).
+    # chips (#lines_written), and clocks the decks only while a tape runs
+    # (#running?).
     class Cassettes
       attr_reader :datasette1, :datasette2
 
@@ -22,6 +23,18 @@ module Badline
         @datasette2 = Drives::Datasette.new
         @datasette1.on_flag { pulse1 }
         @datasette2.on_flag { pulse2 }
+        @running = false
+        @running_handler = nil
+        @datasette1.on_running_change { update_running }
+        @datasette2.on_running_change { update_running }
+      end
+
+      # Whether either deck's tape runs.
+      def running? = @running
+
+      # Whether either deck's tape runs, each time that changes.
+      def on_running_change(&handler)
+        @running_handler = handler
       end
 
       def cycle!
@@ -48,6 +61,14 @@ module Badline
 
       private
 
+      def update_running
+        running = @datasette1.running? || @datasette2.running?
+        return if running == @running
+
+        @running = running
+        @running_handler&.call
+      end
+
       # A falling edge on a read line, and the line back up.
       def pulse1
         @pia1.ca1 = false

data/lib/badline/pet/ieee_drive.rb

@@ -1,76 +1,17 @@
 # frozen_string_literal: true
 
-require "badline/drives/model2031"
+require "badline/machine/ieee_drives"
 
 module Badline
   class PET
-    # The PET's true drive: a Drives::Model2031 on the IEEE-488 bus
-    # (IEEEPorts), clocked after the CPU each cycle and reset with it, as
-    # the PET's RES line reaches IFC. The traps on the KERNAL's primitives
-    # (IEEETraps) leave device 8 to the drive while it is device 8.
+    # The PET's true drive, a 2031, 8050 or 8250 on its IEEE-488 bus
+    # (IEEEPorts), as Machine::IEEEDrives has it, at the PET's 1 MHz.
     module IEEEDrive
-      # The 2031 on the bus, or nil.
-      attr_reader :drive2031
-
-      # Plugs in a Drives::Model2031, in place of the one there.
-      def attach_drive2031(drive)
-        detach_drive2031
-        drive.host_clock_hz = 1_000_000
-        drive.connect(@ieee.bus)
-        @drive2031 = drive
-        @ieee.lines_written
-        @ieee_trap&.device = trap_device
-        @init_threshold = [@init_threshold, Badline::Drives::Model2031::BOOT_CYCLES].max if @cycles < @init_threshold
-      end
-
-      # Unplugs the 2031, leaving it on a bus of its own.
-      def detach_drive2031
-        drive = @drive2031
-        return unless drive
-
-        drive.connect(Badline::Drives::IEEEBus.new)
-        @drive2031 = nil
-        @ieee_trap&.device = trap_device
-      end
-
-      # The true drive on the bus, or nil.
-      def true_drive = @drive2031
-
-      # Plugs in a 2031 as device 8, in place of the drive there, and
-      # returns it.
-      def plug_true_drive
-        Badline::Drives::Model2031.new.tap { |drive| attach_drive2031(drive) }
-      end
+      include Machine::IEEEDrives
 
       private
 
-      # The 2031 as keyed snapshot modules named from its device number:
-      # BL-D8, BL-D8-CPU and so on for device 8.
-      def save_drive_modules(sections)
-        drive = @drive2031
-        drive&.save_modules(sections, "BL-D#{drive.device}")
-        sections
-      end
-
-      # The 2031 a snapshot's modules hold, built afresh unless one is on
-      # the bus as the same device, or none when they hold no drive. The
-      # bus then carries the PET's lines as its chips left them.
-      def load_drive_modules(modules)
-        device = 8
-        input = modules.optional("BL-D8")
-        while input.nil? && device < 11
-          device += 1
-          input = modules.optional("BL-D#{device}")
-        end
-        if input
-          detach_drive2031 if @drive2031 && @drive2031.device != device
-          attach_drive2031(Badline::Drives::Model2031.new(device:)) unless @drive2031
-          @drive2031.load_modules(modules, input, "BL-D#{device}")
-        else
-          detach_drive2031
-        end
-        @ieee.lines_written
-      end
+      def ieee_host_clock_hz = 1_000_000
     end
   end
 end

data/lib/badline/pet/ieee_ports.rb

@@ -57,6 +57,13 @@ module Badline
         bus.host_lines = controller_lines unless bus.drives.empty?
       end
 
+      # The drives on the bus see the lines the PET pulls now.
+      def push_lines = lines_written
+
+      # Nothing to push once a cycle: the PET pushes its lines as its chips
+      # are written.
+      def cycle_lines = nil
+
       private
 
       def low_lines = @bus.low_lines(controller_lines)

data/lib/badline/pet.rb

@@ -106,6 +106,7 @@ module Badline
       @via = VIA.new(start: 0xe800, peripheral: VIAPorts.new(self))
       @sound = Sound.new(@via)
       @cassettes = Cassettes.new(@pia1, @via)
+      watch_tapes
       keyboard_ports.connect(@pia1, @ieee, @cassettes)
       characters = Characters.new(@model.characters)
       @crtc_output = CRTCVideo.new(characters, @via, registers, columns80: @model.video == :crtc80,
@@ -130,7 +131,7 @@ module Badline
       @dos = nil
       @ieee_trap = nil
       @capture_output = nil
-      @drive2031 = nil
+      init_ieee_drives
       @init_threshold = boot_cycles(ram_kb)
     end
 
@@ -177,10 +178,10 @@ module Badline
       @pia2.cycle!
       @via.cycle!
       @sound.cycle! if @sound.recording?
-      @cassettes.cycle!
+      @cassettes.cycle! if @tapes_running
       @cpu.irq = @pia1.irq? || @pia2.irq? || @via.irq?
       @cpu.cycle!
-      @drive2031&.host_cycle!
+      clock_ieee_drives
 
       @cycles += 1
     end
@@ -197,7 +198,7 @@ module Badline
       @via.reset!
       @crtc.reset!
       @bus.reset!
-      @drive2031&.reset!
+      reset_ieee_drives
       @ieee.lines_written
       @cpu.reset!
     end
@@ -234,6 +235,16 @@ module Badline
     # on a 3032 and 1,980,000 on an 8032.
     def boot_cycles(ram_kb) = (@model.basic == "pet/basic4.rom" ? 700_000 : 150_000) + (46_000 * ram_kb)
 
+    # The decks are clocked only while a tape runs.
+    def watch_tapes
+      @tapes_running = false
+      @cassettes.on_running_change { tapes_changed }
+    end
+
+    def tapes_changed
+      @tapes_running = @cassettes.running?
+    end
+
     def drive_retrace(high)
       return if high == @vertical_drive