Refactor TapeManager and related classes: Consolidate tape management logic, improve encapsulation, and standardize method naming. (#29)

Author: voytas

src/Spectron.Emulation/Emulator.cs

@@ -62,7 +62,6 @@ public bool IsFloatingBusEnabled
 
     public ComputerType ComputerType { get; }
     public RomType RomType { get; }
-    public TapeSpeed TapeLoadSpeed { get; set; }
 
     public Z80 Cpu { get; }
     public IEmulatorMemory Memory => _memory;
@@ -310,7 +309,7 @@ private void BeforeInstruction(Word pc)
         switch (pc)
         {
             case RomRoutines.LD_START:
-                switch (TapeLoadSpeed)
+                switch (TapeManager.TapeLoadSpeed)
                 {
                     case TapeSpeed.Instant:
                         TapeManager.FastLoad();

src/Spectron.Emulation/Tape/Cassette.cs

@@ -31,29 +31,29 @@ public sealed class Cassette
     public event BlockSelectedEvent? BlockSelected;
     public event EventHandler? EndOfTape;
 
-    internal void Load(Stream stream, FileType fileType)
+    internal void SetContent(Stream stream, FileType fileType)
     {
         Position = 0;
 
         switch (fileType)
         {
             case FileType.Tap:
                 var tapFile = TapFile.Load(stream);
-                Load(tapFile.ToTzx());
+                SetContent(tapFile.ToTzx());
 
                 break;
 
             case FileType.Tzx:
                 var tzxFile = TzxFile.Load(stream);
-                Load(tzxFile);
+                SetContent(tzxFile);
 
                 break;
         }
 
         _contentBytes = null;
     }
 
-    internal void Load(TzxFile tzxFile, int currentPosition = 0)
+    internal void SetContent(TzxFile tzxFile, int currentPosition = 0)
     {
         Position = currentPosition;
         Content = tzxFile;

src/Spectron.Emulation/Tape/DirectAccess.cs

@@ -24,6 +24,7 @@ internal DirectAccess(Z80 cpu, IMemory memory)
     internal void FastLoad(Cassette cassette)
     {
         var tap = cassette.GetNextTapData();
+
         if (tap == null)
         {
             return;
@@ -77,7 +78,7 @@ internal void FastLoad(Cassette cassette)
         _cpu.Registers.PC = 0x05E0;     // CP $01; RET
     }
 
-    internal void FastSave(Cassette cassette, TapeSpeed speed)
+    internal void FastSave(Cassette cassette)
     {
         var blockType = _cpu.Registers.A;
         var length = _cpu.Registers.DE;
@@ -88,9 +89,6 @@ internal void FastSave(Cassette cassette, TapeSpeed speed)
 
         cassette.Content.Blocks.Add(new StandardSpeedDataBlock(tapData));
 
-        if (speed == TapeSpeed.Instant)
-        {
-            _cpu.Registers.PC = RomRoutines.SA_DELAY - 2;
-        }
+        _cpu.Registers.PC = RomRoutines.SA_DELAY - 2;
     }
 }

src/Spectron.Emulation/Tape/TapeManager.cs

@@ -13,18 +13,23 @@ public sealed class TapeManager
 {
     private DirectAccess? _directAccess;
 
-    public Cassette Cassette { get; private set; } = new();
+    public Cassette Cassette { get; private set; }
 
     public bool IsTapeLoaded { get; private set; }
     public bool IsTapeSaveEnabled { get; set; }
+
+    public TapeSpeed TapeLoadSpeed { get; set; }
     public TapeSpeed TapeSaveSpeed { get; set; }
+
     public double BlockReadProgressPercentage => CassettePlayer?.BlockReadProgressPercentage ?? 0;
 
     internal CassettePlayer? CassettePlayer { get; private set; }
 
     public delegate void TapeStateChangedEvent(TapeStateEventArgs e);
     public event TapeStateChangedEvent? TapeStateChanged;
 
+    public TapeManager() => Cassette = CreateCassette();
+
     internal void Attach(Z80 cpu, IMemory memory, HardwareSettings hardware)
     {
         CassettePlayer = new CassettePlayer(Cassette, cpu.Clock, hardware);
@@ -35,7 +40,7 @@ internal void Attach(Z80 cpu, IMemory memory, HardwareSettings hardware)
 
     public void NewTape()
     {
-        Cassette = new Cassette();
+        Cassette = CreateCassette();
 
         TapeStateChanged?.Invoke(new TapeStateEventArgs(TapeAction.TapeInserted));
 
@@ -56,14 +61,14 @@ public void FastSave()
             NewTape();
         }
 
-        _directAccess?.FastSave(Cassette, TapeSaveSpeed);
+        _directAccess?.FastSave(Cassette);
     }
 
     public void InsertTape(Stream stream, FileType fileType, bool autoPlay = false)
     {
         StopTape();
 
-        Cassette.Load(stream, fileType);
+        Cassette.SetContent(stream, fileType);
         InsertTape();
 
         if (autoPlay)
@@ -72,17 +77,17 @@ public void InsertTape(Stream stream, FileType fileType, bool autoPlay = false)
         }
     }
 
-    public void InsertTape(string fileName, bool autoPlay = false)
+    public void InsertTape(string fileName)
     {
         var fileType = FileTypes.GetFileType(fileName);
         var stream = File.OpenRead(fileName);
 
-        InsertTape(stream, fileType, autoPlay);
+        InsertTape(stream, fileType);
     }
 
     public void InsertTape(TzxFile tzxFile, int currentBlockIndex)
     {
-        Cassette.Load(tzxFile, currentBlockIndex);
+        Cassette.SetContent(tzxFile, currentBlockIndex);
         InsertTape();
     }
 
@@ -111,9 +116,38 @@ public void EjectTape()
         StopTape();
         TapeStateChanged?.Invoke(new TapeStateEventArgs(TapeAction.TapeEjected));
 
-        Cassette = new Cassette();
+        Cassette = CreateCassette();
         IsTapeLoaded = false;
     }
 
     public void RewindTape() => CassettePlayer?.Rewind();
+
+    private Cassette CreateCassette()
+    {
+        var cassette = new Cassette();
+
+        cassette.BlockSelected += CassetteOnBlockSelected;
+
+        return cassette;
+    }
+
+    private void CassetteOnBlockSelected(BlockSelectedEventArgs e)
+    {
+        if (CassettePlayer?.IsPlaying == true)
+        {
+            return;
+        }
+
+        if (e.Position == Cassette.Content.Blocks.Count - 1)
+        {
+            return;
+        }
+
+        if (Cassette.Content.Blocks[e.Position + 1].BlockId == BlockCode.TurboSpeedData)
+        {
+            //PlayTape();
+        }
+
+        Console.WriteLine($"Block selected: {e.Position}");
+    }
 }

src/Spectron.Emulation/Tape/TapeSpeed.cs

@@ -1,7 +1,7 @@
 namespace OldBit.Spectron.Emulation.Tape;
 
 /// <summary>
-/// Specifies the speed at which the tape should be loaded or saved
+/// Specifies the speed at which the tape should be loaded or saved.
 /// </summary>
 public enum TapeSpeed
 {

src/Spectron/Extensions/EmulatorExtensions.cs

@@ -15,7 +15,7 @@ public static void SetTapeLoadingSpeed(this Emulator? emulator, TapeSpeed tapeSp
             return;
         }
 
-        emulator.TapeLoadSpeed = tapeSpeed;
+        emulator.TapeManager.TapeLoadSpeed = tapeSpeed;
     }
 
     public static void SetTapeSettings(this Emulator? emulator, TapeSettings tapeSettings)
@@ -27,7 +27,7 @@ public static void SetTapeSettings(this Emulator? emulator, TapeSettings tapeSet
 
         emulator.TapeManager.IsTapeSaveEnabled = tapeSettings.IsSaveEnabled;
         emulator.TapeManager.TapeSaveSpeed = tapeSettings.SaveSpeed;
-        emulator.TapeLoadSpeed = tapeSettings.LoadSpeed;
+        emulator.TapeManager.TapeLoadSpeed = tapeSettings.LoadSpeed;
     }
 
     public static void SetAudioSettings(this Emulator? emulator, AudioSettings audioSettings)

src/Spectron/ViewModels/MainWindowViewModel.Emulator.cs

@@ -78,7 +78,7 @@ private void InitializeEmulator(Emulator emulator)
         MouseType = Emulator.MouseManager.MouseType;
         IsUlaPlusEnabled = Emulator.IsUlaPlusEnabled;
 
-        Emulator.TapeLoadSpeed = TapeLoadSpeed;
+        Emulator.TapeManager.TapeLoadSpeed = TapeLoadSpeed;
         Emulator.FrameCompleted += EmulatorFrameCompleted;
 
         ConfigureEmulatorSettings();