Adding DOSBox as core for DOS TASing

.github/workflows/waterbox-cores.yml

@@ -37,6 +37,7 @@ jobs:
            git submodule update --init uae/libretro-uae;
            git submodule update --init stella/core;
            git submodule update --init dsda/core;
+           git submodule update --init --recursive dosbox/dosbox-x;
     - name: Install clang 18
       run: wget https://apt.llvm.org/llvm.sh;
             chmod u+x llvm.sh;
@@ -61,6 +62,7 @@ jobs:
           Assets/dll/ares64_interpreter.wbx.zst
           Assets/dll/ares64_recompiler.wbx.zst
           Assets/dll/bsnes.wbx.zst
+          Assets/dll/dosbox.wbx.zst
           Assets/dll/dsda.wbx.zst
           Assets/dll/faust.wbx.zst
           Assets/dll/gpgx.wbx.zst

.gitmodules

@@ -85,6 +85,9 @@
 [submodule "ExternalProjects/FlooohChips/chips"]
 	path = ExternalProjects/FlooohChips/chips
 	url = https://github.com/floooh/chips.git
+[submodule "waterbox/dosbox/dosbox-x"]
+	path = waterbox/dosbox/dosbox-x
+	url = https://github.com/TASEmulators/dosbox-x.git
 [submodule "waterbox/dsda/core"]
 	path = waterbox/dsda/core
 	url = https://github.com/TASEmulators/dsda-doom.git

Assets/defctrl.json

@@ -1108,6 +1108,28 @@
 				"Mult": 1.0,
 				"Deadzone": 0.0
 			}
+		},
+		"DOSBox Controller": {
+			"Mouse Position X": {
+				"Value": "WMouse X",
+				"Mult": 1.0,
+				"Deadzone": 0.0
+			},
+			"Mouse Position Y": {
+				"Value": "WMouse Y",
+				"Mult": 1.0,
+				"Deadzone": 0.0
+			},
+			"Mouse Speed X": {
+				"Value": "RMouse X",
+				"Mult": 1.0,
+				"Deadzone": 0.0
+			},
+			"Mouse Speed Y": {
+				"Value": "RMouse Y",
+				"Mult": 1.0,
+				"Deadzone": 0.0
+			}
 		}
 	},
 	"AllTrollersFeedbacks": {

src/BizHawk.Client.Common/RomLoader.cs

@@ -251,6 +251,10 @@ void NoCoreForSystem(string sysID)
 			}
 			switch (discType)
 			{
+				case DiscType.DOS:
+					game.System = VSystemID.Raw.DOS;
+					break;
+
 				case DiscType.SegaSaturn:
 					game.System = VSystemID.Raw.SAT;
 					break;
@@ -998,6 +1002,8 @@ private static class RomFileExtensions
 
 			public static readonly IReadOnlyCollection<string> Doom = new[] { "wad" };
 
+			public static readonly IReadOnlyCollection<string> DOS = new[] { "ima", "img", "xdf", "dmf", "fdd", "fdi", "nfd", "d88" };
+
 			public static readonly IReadOnlyCollection<string> GB = new[] { "gb", "gbc", "sgb" };
 
 			public static readonly IReadOnlyCollection<string> GBA = new[] { "gba" };
@@ -1056,6 +1062,7 @@ private static class RomFileExtensions
 				.Concat(C64)
 				.Concat(Coleco)
 				.Concat(Doom)
+				.Concat(DOS)
 				.Concat(GB)
 				.Concat(GBA)
 				.Concat(GEN)
@@ -1099,6 +1106,7 @@ private static class RomFileExtensions
 			new FilesystemFilter(/*VSystemID.Raw.C64*/"SID Commodore 64 Music File", Array.Empty<string>(), devBuildExtraExts: new[] { "sid" }, devBuildAddArchiveExts: true),
 			new FilesystemFilter(/*VSystemID.Raw.Coleco*/"ColecoVision", RomFileExtensions.Coleco, addArchiveExts: true),
 			new FilesystemFilter(/*VSystemID.Raw.Doom*/"Doom / Hexen / Heretic WAD File", RomFileExtensions.Doom),
+			new FilesystemFilter(/*VSystemID.Raw.DOS*/"DOS", RomFileExtensions.DOS),
 			new FilesystemFilter(/*VSystemID.Raw.GB*/"Gameboy", RomFileExtensions.GB.Concat(new[] { "gbs" }).ToList(), addArchiveExts: true),
 			new FilesystemFilter(/*VSystemID.Raw.GBA*/"Gameboy Advance", RomFileExtensions.GBA, addArchiveExts: true),
 			new FilesystemFilter(/*VSystemID.Raw.GEN*/"Genesis", RomFileExtensions.GEN.Concat(FilesystemFilter.DiscExtensions).ToList(), addArchiveExts: true),

src/BizHawk.Client.EmuHawk/MainForm.VSystem.cs

@@ -20,6 +20,7 @@
 using BizHawk.Emulation.Cores.Computers.AmstradCPC;
 using BizHawk.Emulation.Cores.Computers.AppleII;
 using BizHawk.Emulation.Cores.Computers.Commodore64;
+using BizHawk.Emulation.Cores.Computers.DOS;
 using BizHawk.Emulation.Cores.Computers.Doom;
 using BizHawk.Emulation.Cores.Computers.MSX;
 using BizHawk.Emulation.Cores.Computers.SinclairSpectrum;
@@ -1192,6 +1193,9 @@ ToolStripMenuItemEx CreateCoreSubmenu(VSystemCategory cat, string coreName, para
 			// Cygne
 			items.Add(CreateCoreSubmenu(VSystemCategory.Handhelds, CoreNames.Cygne, CreateGenericCoreConfigItem<WonderSwan>(CoreNames.Cygne)));
 
+			// DOSBox
+			items.Add(CreateCoreSubmenu(VSystemCategory.PCs, CoreNames.DOSBox, CreateGenericCoreConfigItem<DOSBox>(CoreNames.DOSBox)));
+
 			// DSDA-Doom
 			items.Add(CreateCoreSubmenu(VSystemCategory.Other, CoreNames.DSDA, CreateGenericCoreConfigItem<DSDA>(CoreNames.DSDA)));
 

src/BizHawk.Client.EmuHawk/MainForm.cs

@@ -28,6 +28,7 @@
 using BizHawk.Emulation.Cores;
 using BizHawk.Emulation.Cores.Computers.AppleII;
 using BizHawk.Emulation.Cores.Computers.Commodore64;
+using BizHawk.Emulation.Cores.Computers.DOS;
 using BizHawk.Emulation.Cores.Consoles.Nintendo.QuickNES;
 using BizHawk.Emulation.Cores.Consoles.SNK;
 using BizHawk.Emulation.Cores.Nintendo.GBA;
@@ -2015,7 +2016,7 @@ private void LoadSaveRam()
 					byte[] sram;
 
 					// some cores might not know how big the saveram ought to be, so just send it the whole file
-					if (Emulator is AppleII or C64 or MGBAHawk or NeoGeoPort or NES { BoardName: "FDS" })
+					if (Emulator is AppleII or C64 or DOSBox or MGBAHawk or NeoGeoPort or NES { BoardName: "FDS" })
 					{
 						sram = File.ReadAllBytes(saveRamPath);
 					}

src/BizHawk.Client.EmuHawk/tools/MultiDiskBundler/MultiDiskBundler.cs

@@ -39,6 +39,7 @@ public MultiDiskBundler()
 				VSystemID.Raw.Arcade,
 				VSystemID.Raw.C64,
 				VSystemID.Raw.Doom,
+				VSystemID.Raw.DOS,
 				VSystemID.Raw.GBL,
 				VSystemID.Raw.GEN,
 				VSystemID.Raw.GGL,

src/BizHawk.Emulation.Common/Base Implementations/Bk2MnemonicLookup.cs

@@ -853,6 +853,86 @@ public static string LookupAxis(string button, string systemId)
 				["Weapon Select 6"] = '6',
 				["Weapon Select 7"] = '7',
 			},
+			[VSystemID.Raw.DOS] = new()
+			{
+				["Joystick Button 1"] = '1',
+				["Joystick Button 2"] = '2',
+				["Joystick Up"] = 'U',
+				["Joystick Down"] = 'D',
+				["Joystick Left"] = 'L',
+				["Joystick Right"] = 'R',
+				["Mouse Left Button"] = 'l',
+				["Mouse Middle Button"] = 'm',
+				["Mouse Right Button"] = 'r',
+				["Next Floppy Disk"] = '>',
+				["Next CDROM"] = '}',
+				["F1"] = 'F',
+				["F2"] = 'F',
+				["F3"] = 'F',
+				["F4"] = 'F',
+				["F5"] = 'F',
+				["F6"] = 'F',
+				["F7"] = 'F',
+				["F8"] = 'F',
+				["F9"] = 'F',
+				["F10"] = 'F',
+				["F11"] = 'F',
+				["F12"] = 'F',
+				["Escape"] = 'e',
+				["Tab"] = 't',
+				["Backspace"] = 'b',
+				["Enter"] = 'e',
+				["Space"] = 's',
+				["LeftAlt"] = 'a',
+				["RightAlt"] = 'a',
+				["LeftCtrl"] = 'c',
+				["RightCtrl"] = 'c',
+				["LeftShift"] = 's',
+				["RightShift"] = 's',
+				["CapsLock"] = 'C',
+				["ScrollLock"] = 'S',
+				["NumLock"] = 'N',
+				["Grave"] = '`',
+				["Minus"] = '-',
+				["Equals"] = '=',
+				["Backslash"] = 'b',
+				["LeftBracket"] = '[',
+				["RightBracket"] = ']',
+				["Semicolon"] = ';',
+				["Quote"] = '\'',
+				["Period"] = '.',
+				["Comma"] = ',',
+				["Slash"] = '/',
+				["ExtraLtGt"] = '>',
+				["PrintScreen"] = 'p',
+				["Pause"] = 'p',
+				["Insert"] = 'i',
+				["Home"] = 'h',
+				["Pageup"] = 'p',
+				["Delete"] = 'd',
+				["End"] = 'e',
+				["Pagedown"] = 'p',
+				["Left"] = 'l',
+				["Up"] = 'u',
+				["Down"] = 'd',
+				["Right"] = 'r',
+				["Keypad1"] = '1',
+				["Keypad2"] = '2',
+				["KeyPad3"] = '3',
+				["KeyPad4"] = '4',
+				["KeyPad5"] = '5',
+				["KeyPad6"] = '6',
+				["KeyPad7"] = '7',
+				["KeyPad8"] = '8',
+				["KeyPad9"] = '9',
+				["KeyPad0"] = '0',
+				["KeyPadDivide"] = '/',
+				["KeyPadMultiply"] = '*',
+				["KeyPadMinus"] = '-',
+				["keyPadPlus"] = '+',
+				["KeyPadEnter"] = 'e',
+				["KeyPadPeriod"] = '.',
+			}
 		};
 
 		private static readonly Dictionary<string, string> BaseAxisLookupTable = new Dictionary<string, string>

src/BizHawk.Emulation.Common/Database/Database.cs

@@ -463,6 +463,10 @@ public static GameInfo GetGameInfo(byte[] romData, string fileName)
 					game.System = VSystemID.Raw.Amiga;
 					break;
 
+				case ".D88" or ".DMF" or ".FDD" /*or ".FDI"*/ or ".IMA" or ".IMG" or ".NFD" or ".XDF":
+					game.System = VSystemID.Raw.DOS;
+					break;
+
 				case ".IPF":
 					var ipfId = new IpfIdentifier(romData);
 					game.System = ipfId.IdentifiedSystem;

src/BizHawk.Emulation.Common/Extensions.cs

@@ -27,6 +27,7 @@ public static class EmulatorExtensions
 			[VSystemID.Raw.Coleco] = "ColecoVision",
 			// DEBUG
 			[VSystemID.Raw.Doom] = "Doom",
+			[VSystemID.Raw.DOS] = "DOS",
 			[VSystemID.Raw.GBL] = "Game Boy Link",
 			[VSystemID.Raw.GB] = "GB",
 			[VSystemID.Raw.SGB] = "SGB",

src/BizHawk.Emulation.Common/VSystemID.cs

@@ -25,6 +25,7 @@ public static class Raw
 			public const string Coleco = "Coleco";
 			public const string DEBUG = "DEBUG";
 			public const string Doom = "Doom";
+			public const string DOS = "DOS";
 			public const string Dreamcast = "Dreamcast";
 			public const string GameCube = "GameCube";
 			public const string GB = "GB";

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

@@ -26,6 +26,7 @@
 		<Compile Update="Computers/AppleII/AppleII.*.cs" DependentUpon="AppleII.cs" />
 		<Compile Update="Computers/Commodore64/C64.*.cs" DependentUpon="C64.cs" />
 		<Compile Update="Computers/Doom/DSDA.*.cs" DependentUpon="DSDA.cs" />
+		<Compile Update="Computers/DOS/DOSBox.*.cs" DependentUpon="DOSBox.cs" />
 		<Compile Update="Computers/SinclairSpectrum/Hardware/Disk/NECUPD765.*.cs" DependentUpon="NECUPD765.cs" />
 		<Compile Update="Computers/SinclairSpectrum/Hardware/Disk/NECUPS765.Static.cs" DependentUpon="NECUPD765.cs" />
 		<Compile Update="Computers/SinclairSpectrum/Machine/Pentagon128K/Pentagon128.*.cs" DependentUpon="Pentagon128.cs" />

src/BizHawk.Emulation.Cores/Computers/DOS/DOSBox.Controllers.cs

@@ -0,0 +1,128 @@
+using System.Collections.Generic;
+using BizHawk.Common;
+using BizHawk.Emulation.Common;
+
+namespace BizHawk.Emulation.Cores.Computers.DOS
+{
+	public partial class DOSBox
+	{
+		// A class to store the current state of the mouse for delta and button activation calculation
+		private class MouseState
+		{
+			public int PosX = 0;
+			public int PosY = 0;
+			public bool LeftButtonHeld = false;
+			public bool MiddleButtonHeld = false;
+			public bool RightButtonHeld = false;
+		}
+
+		private MouseState _lastMouseState = new MouseState();
+
+		private static readonly (string Name, LibDOSBox.DOSBoxKeyboard Key)[] _keyboardMap = CreateKeyboardMap();
+
+		private static (string Name, LibDOSBox.DOSBoxKeyboard Value)[] CreateKeyboardMap()
+		{
+			var keyboardMap = new List<(string, LibDOSBox.DOSBoxKeyboard)>();
+			// ReSharper disable once LoopCanBeConvertedToQuery
+			foreach (var k in Enum.GetValues(typeof(LibDOSBox.DOSBoxKeyboard)))
+			{
+				if (k is LibDOSBox.DOSBoxKeyboard.Key_None) continue;
+				var name = Enum.GetName(typeof(LibDOSBox.DOSBoxKeyboard), k)!.Replace('_', ' ');
+				keyboardMap.Add((name, (LibDOSBox.DOSBoxKeyboard) k));
+			}
+
+			return keyboardMap.ToArray();
+		}
+
+		private static ControllerDefinition CreateControllerDefinition(SyncSettings settings, int floppyDiskCount, int cdROMCount)
+		{
+			var controller = new ControllerDefinition("DOSBox Controller");
+
+			// Adding joystick buttons
+			if (settings.EnableJoystick1)
+			{
+				foreach (var button in JoystickButtonCollection)
+				{
+					controller.BoolButtons.Add("P1 " + Inputs.Joystick + " " + button);
+				}
+			}
+
+			if (settings.EnableJoystick2)
+			{
+				foreach (var button in JoystickButtonCollection)
+				{
+					controller.BoolButtons.Add("P2 " + Inputs.Joystick + " " + button);
+				}
+			}
+
+			// Adding mouse inputs
+			if (settings.EnableMouse)
+			{
+				controller.BoolButtons.Add(Inputs.Mouse + " " + MouseInputs.LeftButton);
+				controller.BoolButtons.Add(Inputs.Mouse + " " + MouseInputs.MiddleButton);
+				controller.BoolButtons.Add(Inputs.Mouse + " " + MouseInputs.RightButton);
+
+				// Although most apps (including windows) use speed to compute the mouse position, some games (SimCity) use the absolute value
+				// The absolute values needs to be 1:1 with the video size, as this is translated 1:1 to the core.
+				// The effect is that the position on BK's window translates perfectly to the core
+				controller.AddAxis(Inputs.Mouse + " " + MouseInputs.PosX, (0).RangeTo(LibDOSBox.SVGA_MAX_WIDTH), LibDOSBox.SVGA_MAX_WIDTH / 2);
+				controller.AddAxis(Inputs.Mouse + " " + MouseInputs.PosY, (0).RangeTo(LibDOSBox.SVGA_MAX_HEIGHT), LibDOSBox.SVGA_MAX_HEIGHT / 2);
+
+				// Range above 180 results in minimal mouse movement values bigger than 1, and we need 1 as a basis before sensitivity is applied
+				// To adjust sensitivity, use the corresponding sync setting (global sensitivity for raw deltas is a TODO)
+				controller.AddAxis(Inputs.Mouse + " " + MouseInputs.SpeedX, (-180).RangeTo(180), 0);
+				controller.AddAxis(Inputs.Mouse + " " + MouseInputs.SpeedY, (-180).RangeTo(180), 0);
+			}
+
+			// Adding drive management buttons
+			if (floppyDiskCount > 1) controller.BoolButtons.Add(Inputs.NextFloppyDisk);
+			if (cdROMCount > 1) controller.BoolButtons.Add(Inputs.NextCDROM);
+
+			foreach (var (name, _) in _keyboardMap)
+			{
+				controller.BoolButtons.Add(name);
+				controller.CategoryLabels[name] = "Keyboard";
+			}
+
+			return controller.MakeImmutable();
+		}
+
+		private static string[] JoystickButtonCollection = [
+			JoystickButtons.Up,
+			JoystickButtons.Down,
+			JoystickButtons.Left,
+			JoystickButtons.Right,
+			JoystickButtons.Button1,
+			JoystickButtons.Button2
+		];
+
+		private static class JoystickButtons
+		{
+			public const string Up = "Up";
+			public const string Down = "Down";
+			public const string Left = "Left";
+			public const string Right = "Right";
+			public const string Button1 = "Button 1";
+			public const string Button2 = "Button 2";
+		}
+
+		private static class MouseInputs
+		{
+			public const string LeftButton = "Left Button";
+			public const string RightButton = "Right Button";
+			public const string MiddleButton = "Middle Button";
+			public const string PosX = "Position X";
+			public const string PosY = "Position Y";
+			public const string SpeedX = "Speed X"; // How many pixels has it changed in a single frame
+			public const string SpeedY = "Speed Y";
+		}
+
+		private static class Inputs
+		{
+			public const string Joystick = "Joystick";
+			public const string Mouse = "Mouse";
+			public const string NextFloppyDisk = "Next Floppy Disk";
+			public const string NextCDROM = "Next CDROM";
+		}
+	}
+}

src/BizHawk.Emulation.Cores/Computers/DOS/DOSBox.ICycleTiming.cs

@@ -0,0 +1,10 @@
+using BizHawk.Emulation.Common;
+
+namespace BizHawk.Emulation.Cores.Computers.DOS
+{
+	public partial class DOSBox : ICycleTiming
+	{
+		// DOSBox emulates the internal core at stable 1ms increments, regardless of the configuration. Therefore, this is basis for time calculation.
+		public double ClockRate => 1000.0;
+	}
+}