Adding Opera (3DO) as emulation core in Bizhawk

.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 opera/opera-libretro;
     - name: Install clang 18
       run: wget https://apt.llvm.org/llvm.sh;
             chmod u+x llvm.sh;
@@ -68,6 +69,7 @@ jobs:
           Assets/dll/libsnes.wbx.zst
           Assets/dll/melonDS.wbx.zst
           Assets/dll/ngp.wbx.zst
+          Assets/dll/opera.wbx.zst
           Assets/dll/pcfx.wbx.zst
           Assets/dll/picodrive.wbx.zst
           Assets/dll/shock.wbx.zst

.gitmodules

@@ -89,3 +89,6 @@
 	path = waterbox/dsda/core
 	url = https://github.com/TASEmulators/dsda-doom.git
 	branch = wbx
+[submodule "waterbox/opera/opera-libretro"]
+	path = waterbox/opera/opera-libretro
+	url = https://github.com/TASEmulators/opera-libretro.git

Assets/defctrl.json

@@ -1108,6 +1108,48 @@
 				"Mult": 1.0,
 				"Deadzone": 0.0
 			}
+		},
+		"3DO Controller": {
+			"P1 Mouse X": {
+				"Value": "RMouse X",
+				"Mult": 1.0,
+				"Deadzone": 0.0
+			},
+			"P1 Mouse Y": {
+				"Value": "RMouse Y",
+				"Mult": 1.0,
+				"Deadzone": 0.0
+			},
+			"P1 Flight Stick Horizontal Axis": {
+				"Value": "RMouse X",
+				"Mult": 1.0,
+				"Deadzone": 0.0
+			},
+			"P1 Flight Stick Vertical Axis": {
+				"Value": "RMouse Y",
+				"Mult": 1.0,
+				"Deadzone": 0.0
+			},
+			"P1 Light Gun Screen X": {
+				"Value": "RMouse X",
+				"Mult": 1.0,
+				"Deadzone": 0.0
+			},
+			"P1 Light Gun Screen Y": {
+				"Value": "RMouse Y",
+				"Mult": 1.0,
+				"Deadzone": 0.0
+			},
+			"P1 Trackball X": {
+				"Value": "RMouse X",
+				"Mult": 1.0,
+				"Deadzone": 0.0
+			},
+			"P1 Trackball Y": {
+				"Value": "RMouse Y",
+				"Mult": 1.0,
+				"Deadzone": 0.0
+			}
 		}
 	},
 	"AllTrollersFeedbacks": {

src/BizHawk.Client.Common/movie/PlatformFrameRates.cs

@@ -15,6 +15,7 @@ public static class PlatformFrameRates
 
 		private static readonly Dictionary<string, double> Rates = new Dictionary<string, double>
 		{
+			["3DO"] = 60.0, // The emulator (Opera-Libretro) reports exact 60.0 for NTSC https://github.com/libretro/opera-libretro/blob/67a29e60a4d194b675c9272b21b61eaa022f3ba3/libopera/opera_region.c#L10
 			["3DS"] = 268111856.0 / 4481136.0, // 59.8312249394
 			// while the number of scanlines per frame is software controlled and variable, we
 			// enforce exactly 262 (NTSC) 312 (PAL) per reference time frame

src/BizHawk.Client.EmuHawk/config/FirmwareConfig.cs

@@ -61,6 +61,7 @@ public partial class FirmwareConfig : Form, IDialogParent
 		// Redundant with SystemLookup? Not so fast. That data drives things. This is one step abstracted. Don't be such a smart guy. Keep this redundant list up to date.
 		private static readonly Dictionary<string, string> SystemGroupNames = new Dictionary<string, string>
 		{
+			["3DO"] = "3DO / 3DO Arcade / 3DO M2",
 			["Amiga"] = "Amiga",
 			["NES"] = "NES",
 			["SNES"] = "SNES",

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

@@ -33,6 +33,7 @@ public MultiDiskBundler()
 			InitializeComponent();
 			Icon = ToolIcon;
 			SystemDropDown.Items.AddRange([
+				VSystemID.Raw._3DO,
 				VSystemID.Raw.Amiga,
 				VSystemID.Raw.AmstradCPC,
 				VSystemID.Raw.AppleII,

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

@@ -179,6 +179,25 @@ public static string LookupAxis(string button, string systemId)
 
 		private static readonly Dictionary<string, Dictionary<string, char>> SystemOverrides = new Dictionary<string, Dictionary<string, char>>
 		{
+			[VSystemID.Raw._3DO] = new()
+			{
+				["LT"] = 'l',
+				["RT"] = 'r',
+				["P"] = 'P',
+				["Trigger"] = 'T',
+				["Reload"] = 'R',
+				["Is Off-Screen"] = 'O',
+				["Aux A"] = 'A',
+				["Start P1"] = '1',
+				["Start P2"] = '2',
+				["Coin P1"] = 'C',
+				["Coin P2"] = 'c',
+				["Service"] = 'S',
+				["Fourth Button"] = '4',
+				["Next Disc"] = '>',
+				["Prev Disc"] = '<',
+			},
+
 			[VSystemID.Raw.NES] = new()
 			{
 				["FDS Eject"] = 'E',
@@ -863,6 +882,16 @@ public static string LookupAxis(string button, string systemId)
 
 		private static readonly Dictionary<string, Dictionary<string, string>> AxisSystemOverrides = new Dictionary<string, Dictionary<string, string>>
 		{
+			[VSystemID.Raw._3DO] = new()
+			{
+				["Flight Stick Horizontal Axis"] = "fsX",
+				["Flight Stick Vertical Axis"] = "fsY",
+				["Flight Stick Altitude Axis"] = "fsZ",
+				["Light Gun Screen X"] = "lgX",
+				["Light Gun Screen Y"] = "lgY",
+				["Trackball X"] = "tX",
+				["Trackball Y"] = "tY",
+			},
 			[VSystemID.Raw.A78] = new()
 			{
 				["VPos"] = "X",

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

@@ -82,6 +82,60 @@ void AddPatchAndMaybeReverse(FirmwarePatchOption fpo)
 			FirmwareAndOption("1E5B0B2441A4979B6966D942B20CC76C413B8C5E", 2048, "32X", "M", "32X_M_BIOS.BIN", "32x SH2 MASTER BIOS");
 			FirmwareAndOption("4103668C1BBD66C5E24558E73D4F3F92061A109A", 1024, "32X", "S", "32X_S_BIOS.BIN", "32x SH2 SLAVE BIOS");
 
+			// 3DO
+			// Information obtained from https://3dodev.com/software/roms
+
+			Firmware("3DO", "Panasonic_FZ1_U", "Panasonic FZ-1 (U)");
+			Option("3DO", "Panasonic_FZ1_U", File("34BF189111295F74D7B7DFC1F304D98B8D36325A", 1048576, "panafz1.bin", "Panasonic FZ-1 (U)"), FirmwareOptionStatus.Ideal);
+			Option("3DO", "Panasonic_FZ1_U", File("DE3C55490733E6C69724D87E149B52ED955638ED", 1048576, "panafz1_dev_0.9.bin", "Panasonic FZ-1 (U) v0.9 dev build"));
+			Option("3DO", "Panasonic_FZ1_U", File("4CB4EE36E0F5BC0995D34992B4F241C420D49B2E", 1048576, "panafz1_dev.bin", "Panasonic FZ-1 (U) dev build"));
+
+			Firmware("3DO", "Panasonic_FZ1_E", "Panasonic FZ-1 (E)");
+			Option("3DO", "Panasonic_FZ1_E", File("1D0DB81E171EBC1D07CEFC8CE8AB082306186E56", 1048576, "panafz1e.bin", "Panasonic FZ-1 (E)"), FirmwareOptionStatus.Ideal);
+			Option("3DO", "Panasonic_FZ1_E", File("4696951E492E5526772A860EA2C0F35411A80927", 1048576, "panafz1e-unencrypted.bin", "Panasonic FZ-1 (E) (unencrypted)"));
+
+			Firmware("3DO", "Panasonic_FZ1_J", "Panasonic FZ-1 (J)");
+			Option("3DO", "Panasonic_FZ1_J", File("EC7EC62D60EC0459A14ED56EBC66761EF3C80EFC", 1048576, "panafz1j.bin", "Panasonic FZ-1 (J)"), FirmwareOptionStatus.Ideal);
+			Option("3DO", "Panasonic_FZ1_J", File("A417587AE3B0B8EF00C830920C21AF8BEE88E419", 1048576, "panafz1j - norsa.bin", "Panasonic FZ-1(J)(RSA check disabled)"));
+
+			Firmware("3DO", "Panasonic_FZ10_U", "Panasonic FZ-10 (U)");
+			Option("3DO", "Panasonic_FZ10_U", File("3C912300775D1AD730DC35757E279C274C0ACAAD", 1048576, "panafz10.bin", "Panasonic FZ-10 (U)"), FirmwareOptionStatus.Ideal);
+			Option("3DO", "Panasonic_FZ10_U", File("F05E642322C03694F06A809C0B90FC27AC73C002", 1048576, "panafz10-norsa.bin", "Panasonic FZ-10 (U) (RSA check disabled)"));
+
+			Firmware("3DO", "Panasonic_FZ10_E", "Panasonic FZ-10 (E)");
+			Option("3DO", "Panasonic_FZ10_E", File("A900371F0CDCDC03F79557F11D406FD71251A5FD", 1048576, "panafz10e-anvil.bin", "Panasonic FZ-10 (E) [ANVIL]"), FirmwareOptionStatus.Ideal);
+			Option("3DO", "Panasonic_FZ10_E", File("2765C7B4557CC838B32567D2428D088980295159", 1048576, "panafz10e-anvil-norsa.bin", "Panasonic FZ-10 (E) [ANVIL] (RSA check disabled)"));
+
+			Firmware("3DO", "Panasonic_FZ10_J", "Panasonic FZ-10 (J)");
+			Option("3DO", "Panasonic_FZ10_J", File("FE7F9C9C6A98910013BF13F2CF798DE9FEA52ACD", 1048576, "panafz10j.bin", "Panasonic FZ-10 (J)"), FirmwareOptionStatus.Ideal);
+
+			Firmware("3DO", "Goldstar_GDO101P", "Goldstar GDO-101P");
+			Option("3DO", "Goldstar_GDO101P", File("C4A2E5336F77FB5F743DE1EEA2CDA43675EE2DE7", 1048576, "goldstar.bin", "Goldstar GDO-101P"), FirmwareOptionStatus.Ideal);
+
+			Firmware("3DO", "Goldstar_FC1", "Goldstar FC-1");
+			Option("3DO", "Goldstar_FC1", File("8EF7503C948314D242DA47B7FDC272F68DAC2AEE", 1048576, "goldstar_fc1_enc.bin", "Goldstar FC-1 (encrypted)"), FirmwareOptionStatus.Ideal);
+
+			Firmware("3DO", "Sanyo_IMP21J_Try", "Sanyo IMP-21J Try");
+			Option("3DO", "Sanyo_IMP21J_Try", File("B01C53DA256DDE43FFEC4AD3FC3ADFA8D635E943", 1048576, "sanyotry.bin", "Sanyo IMP-21J Try"), FirmwareOptionStatus.Ideal);
+
+			Firmware("3DO", "Sanyo_HC21", "Sanyo HC-21");
+			Option("3DO", "Sanyo_HC21", File("C389AF32BCADF0D86826927DC3D20B7072F90069", 1048576, "sanyo_hc21_b3_unenc.bin", "Sanyo HC-21 B3 (unencrypted)"), FirmwareOptionStatus.Ideal);
+			Option("3DO", "Sanyo_HC21", File("29C40515DC1174FF13975BAA59EB532083E4A3D3", 1048576, "sanyo_hc21_alpha.bin", "Sanyo HC-21 (alpha 3/21/94)"));
+
+			Firmware("3DO", "Shootout_At_Old_Tucson", "(3DO Arcade) Shootout At Old Tucson");
+			Option("3DO", "Shootout_At_Old_Tucson", File("520D3D1B5897800AF47F92EFD2444A26B7A7DEAD", 524288, "3do_arcade_saot.bin", "Shootout At Old Tucson"), FirmwareOptionStatus.Ideal);
+
+			Firmware("3DO", "3DO_NTSC_1fc2", "3DO-NTSC-1.0fc2");
+			Option("3DO", "3DO_NTSC_1fc2", File("BD325C869E1DDE8A3872FC21565E0646A3D5B525", 1048576, "3do_devkit_1.0fc2.bin", "3DO-NTSC-1.0fc2 encrypted development kit"), FirmwareOptionStatus.Ideal);
+
+			Firmware("3DO", "Kanji_ROM_Panasonic_FZ1", "Kanji ROM for Panasonic FZ-1");
+			Option("3DO", "Kanji_ROM_Panasonic_FZ1", File("ACD39A8FEE1B9D2950D5AB447846C11FB31AF63E", 933636, "panafz1-kanji.bin", "Kanji ROM for Panasonic FZ-1 (J)"), FirmwareOptionStatus.Ideal);
+			Option("3DO", "Kanji_ROM_Panasonic_FZ1", File("884515605EE243577AB20767EF8C1A7368E4E407", 1048576, "panafz1j-kanji.bin", "Kanji ROM for Panasonic FZ-1 (J) / Panasonic FZ-10 (J)"));
+
+			Firmware("3DO", "Kanji_ROM_Panasonic_FZ10", "Kanji ROM for Panasonic FZ-10");
+			Option("3DO", "Kanji_ROM_Panasonic_FZ10", File("2E857B957803D0331FD229328DF01F3FFAB69EEE", 1048576, "panafz10ja-anvil-kanji.bin", "Kanji ROM for: Panasonic FZ-10 (J) [ANVIL]"), FirmwareOptionStatus.Ideal);
+			Option("3DO", "Kanji_ROM_Panasonic_FZ10", File("884515605EE243577AB20767EF8C1A7368E4E407", 1048576, "panafz1j-kanji.bin", "Kanji ROM for Panasonic FZ-1 (J) / Panasonic FZ-10 (J)"));
+
 			// 3DS
 			// bleh, undefined hash AND size...
 			FirmwareAndOption(SHA1Checksum.Dummy, 0, "3DS", "aes_keys", "aes_keys.txt", "AES Keys");

src/BizHawk.Emulation.Common/Extensions.cs

@@ -16,6 +16,7 @@ public static class EmulatorExtensions
 		/// <remarks>need to think about e.g. Genesis / Mega Drive using one sysID but having a different display name depending on the BIOS region --yoshi</remarks>
 		public static readonly IReadOnlyDictionary<string, string> SystemIDDisplayNames = new Dictionary<string, string>
 		{
+			[VSystemID.Raw._3DO] = "3DO",
 			[VSystemID.Raw.Amiga] = "Amiga",
 			[VSystemID.Raw.A26] = "Atari 2600",
 			[VSystemID.Raw.A78] = "Atari 7800",

src/BizHawk.Emulation.Common/VSystemID.cs

@@ -14,6 +14,7 @@ public static class VSystemID
 	{
 		public static class Raw
 		{
+			public const string _3DO = "3DO";
 			public const string A26 = "A26";
 			public const string A78 = "A78";
 			public const string Amiga = "Amiga";

src/BizHawk.Emulation.Cores/Consoles/3DO/LibOpera.cs

@@ -0,0 +1,154 @@
+using System.Runtime.InteropServices;
+using BizHawk.BizInvoke;
+using BizHawk.Emulation.Cores.Waterbox;
+
+namespace BizHawk.Emulation.Consoles.ThreeDO
+{
+	public abstract class LibOpera : LibWaterboxCore
+	{
+		// NTSC Specifications
+		public const int NTSC_WIDTH = 320;
+		public const int NTSC_HEIGHT = 240;
+		public const int NTSC_VIDEO_NUMERATOR = 60;
+		public const int NTSC_VIDEO_DENOMINATOR = 1;
+
+		// PAL1 Specifications
+		public const int PAL1_WIDTH = 320;
+		public const int PAL1_HEIGHT = 288;
+		public const int PAL1_VIDEO_NUMERATOR = 50;
+		public const int PAL1_VIDEO_DENOMINATOR = 1;
+
+		// PAL2 Specifications
+		public const int PAL2_WIDTH = 384;
+		public const int PAL2_HEIGHT = 288;
+		public const int PAL2_VIDEO_NUMERATOR = 50;
+		public const int PAL2_VIDEO_DENOMINATOR = 1;
+
+		[UnmanagedFunctionPointer(CC)]
+		public delegate void CDReadCallback(int lba, IntPtr dst);
+
+		[UnmanagedFunctionPointer(CC)]
+		public delegate int CDSectorCountCallback();
+
+		[BizImport(CC)]
+		public abstract void SetCdCallbacks(CDReadCallback cdrc, CDSectorCountCallback cdscc);
+
+		[BizImport(CC, Compatibility = true)]
+		public abstract bool Init(string gameFile, string biosFile, string fontFile, int port1Type, int port2Type, int videoStandard);
+
+		[BizImport(CC, Compatibility = true)]
+		public abstract bool sram_changed();
+
+		[BizImport(CC, Compatibility = true)]
+		public abstract int get_sram_size();
+
+		[BizImport(CC, Compatibility = true)]
+		public abstract void get_sram(IntPtr sramBuffer);
+
+		[BizImport(CC, Compatibility = true)]
+		public abstract void set_sram(IntPtr sramBuffer);
+
+		[StructLayout(LayoutKind.Sequential)]
+		public struct GamepadInputs
+		{
+			public int up;
+			public int down;
+			public int left;
+			public int right;
+			public int start;
+			public int select;
+			public int buttonA;
+			public int buttonB;
+			public int buttonX;
+			public int buttonY;
+			public int buttonL;
+			public int buttonR;
+		}
+
+		[StructLayout(LayoutKind.Sequential)]
+		public struct MouseInputs
+		{
+			public int dX;
+			public int dY;
+			public int leftButton;
+			public int middleButton;
+			public int rightButton;
+			public int fourthButton;
+		}
+
+		[StructLayout(LayoutKind.Sequential)]
+		public struct FlightStickInputs
+		{
+			public int up;
+			public int down;
+			public int left;
+			public int right;
+			public int fire;
+			public int buttonA;
+			public int buttonB;
+			public int buttonC;
+			public int buttonX;
+			public int buttonP;
+			public int leftTrigger;
+			public int rightTrigger;
+			public int horizontalAxis;
+			public int verticalAxis;
+			public int altitudeAxis;
+		}
+
+		[StructLayout(LayoutKind.Sequential)]
+		public struct LightGunInputs
+		{
+			public int trigger;
+			public int select;
+			public int reload;
+			public int isOffScreen;
+			public int screenX;
+			public int screenY;
+		}
+
+		[StructLayout(LayoutKind.Sequential)]
+		public struct ArcadeLightGunInputs
+		{
+			public int trigger;
+			public int select;
+			public int start;
+			public int reload;
+			public int auxA;
+			public int isOffScreen;
+			public int screenX;
+			public int screenY;
+		}
+
+		[StructLayout(LayoutKind.Sequential)]
+		public struct OrbatakTrackballInputs
+		{
+			public int dX;
+			public int dY;
+			public int startP1;
+			public int startP2;
+			public int coinP1;
+			public int coinP2;
+			public int service;
+		}
+
+		[StructLayout(LayoutKind.Sequential)]
+		public struct GameInput
+		{
+			public GamepadInputs gamepad;
+			public MouseInputs mouse;
+			public FlightStickInputs flightStick;
+			public LightGunInputs lightGun;
+			public ArcadeLightGunInputs arcadeLightGun;
+			public OrbatakTrackballInputs orbatakTrackball;
+		}
+
+		[StructLayout(LayoutKind.Sequential)]
+		public new class FrameInfo : LibWaterboxCore.FrameInfo
+		{
+			public GameInput port1;
+			public GameInput port2;
+			public int isReset = 0;
+		}
+	}
+}