Starting new tape implementation

BizHawk.Emulation.Cores/BizHawk.Emulation.Cores.csproj

@@ -275,6 +275,10 @@
     <Compile Include="Computers\SinclairSpectrum\Machine\ZXSpectrum128K\ZX128.ULA.cs" />
     <Compile Include="Computers\SinclairSpectrum\Machine\ZXSpectrum16K\ZX16.cs" />
     <Compile Include="Computers\SinclairSpectrum\Machine\ZXSpectrum48K\ZX48.ULA.cs" />
+    <Compile Include="Computers\SinclairSpectrum\Media\MediaSerializationType.cs" />
+    <Compile Include="Computers\SinclairSpectrum\Media\MediaSerializer.cs" />
+    <Compile Include="Computers\SinclairSpectrum\Media\Tape\TapeCommand.cs" />
+    <Compile Include="Computers\SinclairSpectrum\Media\Tape\TapeDataBlock.cs" />
     <Compile Include="Computers\SinclairSpectrum\SoundProviderMixer.cs" />
     <Compile Include="Computers\SinclairSpectrum\Machine\MachineType.cs" />
     <Compile Include="Computers\SinclairSpectrum\Machine\SpectrumBase.cs" />

BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Media/MediaSerializationType.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace BizHawk.Emulation.Cores.Computers.SinclairSpectrum
+{
+    /// <summary>
+    /// Represents the different types of media serializer avaiable
+    /// </summary>
+    public enum MediaSerializationType
+    {
+        NONE,
+        TZX,
+        TAP
+    }
+}

BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Media/MediaSerializer.cs

@@ -0,0 +1,114 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace BizHawk.Emulation.Cores.Computers.SinclairSpectrum
+{
+    /// <summary>
+    /// Abtract class that represents all Media Serializers
+    /// </summary>
+    public abstract class MediaSerializer
+    {
+        /// <summary>
+        /// The type of serializer
+        /// </summary>
+        public abstract MediaSerializationType FormatType { get; }
+
+        /// <summary>
+        /// Signs whether this class can be used to serialize
+        /// </summary>
+        public virtual bool IsSerializer
+        {
+            get
+            {
+                return false;
+            }
+        }
+
+        /// <summary>
+        /// Signs whether this class can be used to de-serialize
+        /// </summary>
+        public virtual bool IsDeSerializer
+        {
+            get
+            {
+                return false;
+            }
+        }
+
+        /// <summary>
+        /// Serialization method
+        /// </summary>
+        /// <param name="data"></param>
+        public virtual void Serialize(byte[] data)
+        {
+            throw new NotImplementedException(this.GetType().ToString() + 
+                "Serialize operation is not implemented for this serializer");
+        }
+
+        /// <summary>
+        /// DeSerialization method
+        /// </summary>
+        /// <param name="data"></param>
+        public virtual void DeSerialize(byte[] data)
+        {
+            throw new NotImplementedException(this.GetType().ToString() + 
+                "DeSerialize operation is not implemented for this serializer");
+        }
+
+        #region Static Tools
+
+        /// <summary>
+        /// Converts an int32 value into a byte array
+        /// </summary>
+        /// <param name="value"></param>
+        /// <returns></returns>
+        protected static byte[] GetBytes(int value)
+        {
+            byte[] buf = new byte[4];
+            buf[0] = (byte)value;
+            buf[1] = (byte)(value >> 8);
+            buf[2] = (byte)(value >> 16);
+            buf[3] = (byte)(value >> 24);
+            return buf;
+        }
+
+        /// <summary>
+        /// Returns an int32 from a byte array based on offset
+        /// </summary>
+        /// <param name="buf"></param>
+        /// <param name="offsetIndex"></param>
+        /// <returns></returns>
+        protected static int GetInt32(byte[] buf, int offsetIndex)
+        {
+            return buf[offsetIndex] | buf[offsetIndex + 1] << 8 | buf[offsetIndex + 2] << 16 | buf[offsetIndex + 3] << 24;
+        }
+
+        /// <summary>
+        /// Returns an uint16 from a byte array based on offset
+        /// </summary>
+        /// <param name="buf"></param>
+        /// <param name="offsetIndex"></param>
+        /// <returns></returns>
+        protected static ushort GetUInt16(byte[] buf, int offsetIndex)
+        {
+            return (ushort)(buf[offsetIndex] | buf[offsetIndex + 1] << 8);
+        }
+
+        /// <summary>
+        /// Updates a byte array with a uint16 value based on offset
+        /// </summary>
+        /// <param name="buf"></param>
+        /// <param name="offsetIndex"></param>
+        /// <param name="value"></param>
+        protected static void setUint16(byte[] buf, int offsetIndex, ushort value)
+        {
+            buf[offsetIndex] = (byte)value;
+            buf[offsetIndex + 1] = (byte)(value >> 8);
+        }
+
+        #endregion
+    }
+}

BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Media/Tape/TapeCommand.cs

@@ -0,0 +1,21 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace BizHawk.Emulation.Cores.Computers.SinclairSpectrum
+{
+    /// <summary>
+    /// Represents the possible commands that can be raised from each tape block
+    /// </summary>
+    public enum TapeCommand
+    {
+        NONE,
+        STOP_THE_TAPE,
+        STOP_THE_TAPE_48K,
+        BEGIN_GROUP,
+        END_GROUP,
+        SHOW_MESSAGE,
+    }
+}

BizHawk.Emulation.Cores/Computers/SinclairSpectrum/Media/Tape/TapeDataBlock.cs

@@ -0,0 +1,65 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace BizHawk.Emulation.Cores.Computers.SinclairSpectrum
+{
+    /// <summary>
+    /// Represents a tape block
+    /// </summary>
+    public class TapeDataBlock
+    {
+        /// <summary>
+        /// Either the TZX block ID, or -1 in the case of non-tzx blocks
+        /// </summary>
+        public int BlockID = -1;
+
+        /// <summary>
+        /// Description of the block
+        /// </summary>
+        public string BlockDescription { get; set; }
+
+        /// <summary>
+        /// Byte array containing the raw block data
+        /// </summary>
+        public byte[] BlockData = null;
+
+        /// <summary>
+        /// List containing the pulse timing values
+        /// </summary>
+        public List<int> DataPeriods = new List<int>();
+
+        /// <summary>
+        /// Command that is raised by this data block
+        /// (that may or may not need to be acted on)
+        /// </summary>
+        public TapeCommand Command = TapeCommand.NONE;
+
+        /// <summary>
+        /// Returns the data periods as an array
+        /// (primarily to aid in bizhawk state serialization)
+        /// </summary>
+        /// <returns></returns>
+        public int[] GetDataPeriodsArray()
+        {
+            return DataPeriods.ToArray();
+        }
+
+        /// <summary>
+        /// Accepts an array of data periods and updates the DataPeriods list accordingly
+        /// (primarily to aid in bizhawk state serialization)
+        /// </summary>
+        /// <returns></returns>
+        public void SetDataPeriodsArray(int[] periodArray)
+        {
+            DataPeriods = new List<int>();
+
+            if (periodArray == null)
+                return;
+
+            DataPeriods = periodArray.ToList();
+        }
+    }
+}