BSNESv115+: Implement snes_controller_latch function, cleanup input polling behavior (#3084)

* BSNESv115+: get rid of input_state + input_poll; just poll

* call `snes_controller_latch` on latches done in the core,

- this now also actually calls the InputCallbackSystem
- needed some edits in the core to support executing the callback even when no controller is connected in port 1

* Fix and somewhat normalize the SnesCallbacks order

Author: Morilli

Assets/dll/bsnes.wbx.gz

@@ -146,10 +146,10 @@ public void Dispose()
 		}
 
 		public delegate void snes_video_frame_t(ushort* data, int width, int height, int pitch);
-		public delegate void snes_input_poll_t();
-		public delegate short snes_input_state_t(int port, int index, int id);
-		public delegate void snes_no_lag_t(bool sgb_poll);
 		public delegate void snes_audio_sample_t(short left, short right);
+		public delegate short snes_input_poll_t(int port, int index, int id);
+		public delegate void snes_controller_latch_t();
+		public delegate void snes_no_lag_t(bool sgb_poll);
 		public delegate string snes_path_request_t(int slot, string hint, bool required);
 		public delegate void snes_trace_t(string disassembly, string register_info);
 		public delegate void snes_read_hook_t(uint address);
@@ -192,11 +192,11 @@ public struct LayerEnables
 		[StructLayout(LayoutKind.Sequential)]
 		public class SnesCallbacks
 		{
-			public snes_input_poll_t inputPollCb;
-			public snes_input_state_t inputStateCb;
-			public snes_no_lag_t noLagCb;
 			public snes_video_frame_t videoFrameCb;
 			public snes_audio_sample_t audioSampleCb;
+			public snes_input_poll_t inputPollCb;
+			public snes_controller_latch_t controllerLatchCb;
+			public snes_no_lag_t noLagCb;
 			public snes_path_request_t pathRequestCb;
 			public snes_trace_t traceCb;
 			public snes_read_hook_t readHookCb;

src/BizHawk.Emulation.Cores/Consoles/Nintendo/BSNES/BsnesApi.cs

@@ -56,32 +56,20 @@ public BsnesControllers(BsnesCore.SnesSyncSettings ss)
 			Definition.MakeImmutable();
 		}
 
-		public void CoreInputPoll(IController controller)
+		public short CoreInputPoll(IController controller, int port, int index, int id)
 		{
-			// i hope this is correct lol
-			for (int i = 0; i < 2; i++)
-			{
-				_ports[i].UpdateState(_mergers[i].UnMerge(controller));
-			}
-		}
-
-		public short CoreInputState(int port, int index, int id)
-		{
-			return _ports[port].GetState(index, id);
+			return _ports[port].GetState(_mergers[port].UnMerge(controller), index, id);
 		}
 	}
 
 	public interface IBsnesController
 	{
-		// Updates the internal state; gets called once per frame from the core
-		void UpdateState(IController controller);
-
 		/// <summary>
-		/// Returns the internal state; gets called potentially many times per frame
+		/// Corresponds to an InputPoll call from the core; gets called potentially many times per frame
 		/// </summary>
 		/// <param name="index">bsnes specific value, sometimes multitap number</param>
 		/// <param name="id">bsnes specific value, sometimes button number</param>
-		short GetState(int index, int id);
+		short GetState(IController controller, int index, int id);
 
 		ControllerDefinition Definition { get; }
 	}
@@ -92,15 +80,11 @@ internal class BsnesUnpluggedController : IBsnesController
 
 		public ControllerDefinition Definition => _definition;
 
-		public void UpdateState(IController controller) { }
-
-		public short GetState(int index, int id) => 0;
+		public short GetState(IController controller, int index, int id) => 0;
 	}
 
 	internal class BsnesController : IBsnesController
 	{
-		private readonly bool[] _state = new bool[12];
-
 		private static readonly string[] Buttons =
 		{
 			"0Up", "0Down", "0Left", "0Right", "0B", "0A", "0Y", "0X", "0L", "0R", "0Select", "0Start"
@@ -129,67 +113,54 @@ internal class BsnesController : IBsnesController
 
 		public ControllerDefinition Definition => _definition;
 
-		public void UpdateState(IController controller)
-		{
-			for (int i = 0; i < 12; i++)
-			{
-				_state[i] = controller.IsPressed(Buttons[i]);
-			}
-		}
-
-		public short GetState(int index, int id)
+		public short GetState(IController controller, int index, int id)
 		{
 			if (id >= 12)
 				return 0;
 
-			return (short) (_state[id] ? 1 : 0);
+			return (short) (controller.IsPressed(Buttons[id]) ? 1 : 0);
 		}
 	}
 
 	internal class BsnesMouseController : IBsnesController
 	{
-		private readonly short[] _state = new short[4];
-
 		private static readonly ControllerDefinition _definition = new ControllerDefinition("(SNES Controller fragment)")
 				{ BoolButtons = { "0Mouse Left", "0Mouse Right" } }
 			.AddXYPair("0Mouse {0}", AxisPairOrientation.RightAndDown, (-127).RangeTo(127), 0); //TODO verify direction against hardware, R+D inferred from behaviour in Mario Paint
 
 		public ControllerDefinition Definition => _definition;
 		public bool LimitAnalogChangeSensitivity { get; init; } = true;
 
-		public void UpdateState(IController controller)
+		public short GetState(IController controller, int index, int id)
 		{
-			int x = controller.AxisValue("0Mouse X");
-			if (LimitAnalogChangeSensitivity)
-			{
-				x = x.Clamp(-10, 10);
-			}
-			_state[0] = (short) x;
-
-			int y = controller.AxisValue("0Mouse Y");
-			if (LimitAnalogChangeSensitivity)
+			switch (id)
 			{
-				y = y.Clamp(-10, 10);
+				case 0:
+					int x = controller.AxisValue("0Mouse X");
+					if (LimitAnalogChangeSensitivity)
+					{
+						x = x.Clamp(-10, 10);
+					}
+					return (short) x;
+				case 1:
+					int y = controller.AxisValue("0Mouse Y");
+					if (LimitAnalogChangeSensitivity)
+					{
+						y = y.Clamp(-10, 10);
+					}
+					return (short) y;
+				case 2:
+					return (short) (controller.IsPressed("0Mouse Left") ? 1 : 0);
+				case 3:
+					return (short) (controller.IsPressed("0Mouse Right") ? 1 : 0);
+				default:
+					return 0;
 			}
-			_state[1] = (short) y;
-
-			_state[2] = (short) (controller.IsPressed("0Mouse Left") ? 1 : 0);
-			_state[3] = (short) (controller.IsPressed("0Mouse Right") ? 1 : 0);
-		}
-
-		public short GetState(int index, int id)
-		{
-			if (id >= 4)
-				return 0;
-
-			return _state[id];
 		}
 	}
 
 	internal class BsnesMultitapController : IBsnesController
 	{
-		private readonly bool[,] _state = new bool[4, 12];
-
 		private static readonly string[] Buttons =
 		{
 			"Up", "Down", "Left", "Right", "B", "A", "Y", "X", "L", "R", "Select", "Start"
@@ -221,28 +192,17 @@ internal class BsnesMultitapController : IBsnesController
 
 		public ControllerDefinition Definition => _definition;
 
-		public void UpdateState(IController controller)
-		{
-			for (int port = 0; port < 4; port++)
-			for (int i = 0; i < 12; i++)
-			{
-				_state[port, i] = controller.IsPressed(port + Buttons[i]);
-			}
-		}
-
-		public short GetState(int index, int id)
+		public short GetState(IController controller, int index, int id)
 		{
 			if (id >= 12 || index >= 4)
 				return 0;
 
-			return (short) (_state[index, id] ? 1 : 0);
+			return (short) (controller.IsPressed(index + Buttons[id]) ? 1 : 0);
 		}
 	}
 
 	internal class BsnesPayloadController : IBsnesController
 	{
-		private readonly bool[,] _state = new bool[2, 16];
-
 		private readonly int[] _buttonsOrder = {4, 5, 6, 7, 0, 8, 1, 9, 10, 11, 2, 3, 12, 13, 14, 15};
 
 		private static readonly ControllerDefinition _definition = new("(SNES Controller fragment)")
@@ -252,50 +212,32 @@ internal class BsnesPayloadController : IBsnesController
 
 		public ControllerDefinition Definition => _definition;
 
-		public void UpdateState(IController controller)
-		{
-			for (int index = 0; index < 2; index++)
-			for (int i = 0; i < 16; i++)
-			{
-				_state[index, i] = controller.IsPressed(Definition.BoolButtons[index * 16 + _buttonsOrder[i]]);
-			}
-		}
-
-		public short GetState(int index, int id)
+		public short GetState(IController controller, int index, int id)
 		{
 			if (index >= 2 || id >= 16)
 				return 0;
 
-			return (short) (_state[index, id] ? 1 : 0);
+			return (short) (controller.IsPressed(Definition.BoolButtons[index * 16 + _buttonsOrder[id]]) ? 1 : 0);
 		}
 	}
 
 	internal class BsnesSuperScopeController : IBsnesController
 	{
-		private readonly short[] _state = new short[6];
-
 		private static readonly ControllerDefinition _definition = new ControllerDefinition("(SNES Controller fragment)")
 			{ BoolButtons = { "0Trigger", "0Cursor", "0Turbo", "0Pause" } }
 			.AddLightGun("0Scope {0}");
 
 		public ControllerDefinition Definition => _definition;
 
-		public void UpdateState(IController controller)
+		public short GetState(IController controller, int index, int id)
 		{
-			_state[0] = (short) controller.AxisValue("0Scope X");
-			_state[1] = (short) controller.AxisValue("0Scope Y");
-			for (int i = 0; i < 4; i++)
+			return id switch
 			{
-				_state[i + 2] = (short) (controller.IsPressed(_definition.BoolButtons[i]) ? 1 : 0);
-			}
-		}
-
-		public short GetState(int index, int id)
-		{
-			if (id >= 6)
-				return 0;
-
-			return _state[id];
+				0 => (short) controller.AxisValue("0Scope X"),
+				1 => (short) controller.AxisValue("0Scope Y"),
+				2 or 3 or 4 or 5 => (short) (controller.IsPressed(_definition.BoolButtons[id - 2]) ? 1 : 0),
+				_ => 0
+			};
 		}
 	}
 
@@ -311,35 +253,25 @@ public BsnesJustifierController(bool chained)
 				: new ControllerDefinition("(SNES Controller fragment)")
 					{BoolButtons = { "0Trigger", "0Start"} }
 					.AddLightGun("0Justifier {0}");
-			_state = new short[chained ? 8 : 4];
 			_chained = chained;
 		}
 
 		private readonly bool _chained;
-		private readonly short[] _state;
 
 		public ControllerDefinition Definition { get; }
 
-		public void UpdateState(IController controller)
+		public short GetState(IController controller, int index, int id)
 		{
-			_state[0] = (short) controller.AxisValue("0Justifier X");
-			_state[1] = (short) controller.AxisValue("0Justifier Y");
-			_state[2] = (short) (controller.IsPressed(Definition.BoolButtons[0]) ? 1 : 0);
-			_state[3] = (short) (controller.IsPressed(Definition.BoolButtons[1]) ? 1 : 0);
-			if (_chained)
-			{
-				_state[4] = (short) controller.AxisValue("1Justifier X");
-				_state[5] = (short) controller.AxisValue("1Justifier Y");
-				_state[6] = (short) (controller.IsPressed(Definition.BoolButtons[2]) ? 1 : 0);
-				_state[7] = (short) (controller.IsPressed(Definition.BoolButtons[3]) ? 1 : 0);
-			}
-		}
-		public short GetState(int index, int id)
-		{
-			if (index >= 2 || id >= 4 || (index == 1 && !_chained))
+			if (index == 1 && !_chained)
 				return 0;
 
-			return _state[index * 4 + id];
+			return id switch
+			{
+				0 => (short) controller.AxisValue($"{index}Justifier X"),
+				1 => (short) controller.AxisValue($"{index}Justifier Y"),
+				2 or 3 => (short) (controller.IsPressed(Definition.BoolButtons[index * 2 + id]) ? 1 : 0),
+				_ => 0
+			};
 		}
 	}
 }

src/BizHawk.Emulation.Cores/Consoles/Nintendo/BSNES/BsnesControllers.cs

@@ -54,8 +54,8 @@ public BsnesCore(GameInfo game, byte[] romData, byte[] xmlData, string baseRomPa
 			BsnesApi.SnesCallbacks callbacks = new()
 			{
 				inputPollCb = snes_input_poll,
-				inputStateCb = snes_input_state,
 				noLagCb = snes_no_lag,
+				controllerLatchCb = snes_controller_latch,
 				videoFrameCb = snes_video_refresh,
 				audioSampleCb = snes_audio_sample,
 				pathRequestCb = snes_path_request,
@@ -283,30 +283,29 @@ private void LoadCurrent()
 			_region = Api.core.snes_get_region();
 		}
 
-		// poll which updates the controller state
-		private void snes_input_poll()
-		{
-			_controllers.CoreInputPoll(_controller);
-		}
-
 		/// <param name="port">0 or 1, corresponding to L and R physical ports on the snes</param>
 		/// <param name="index">meaningless for most controllers.  for multitap, 0-3 for which multitap controller</param>
 		/// <param name="id">button ID enum; in the case of a regular controller, this corresponds to shift register position</param>
 		/// <returns>for regular controllers, one bit D0 of button status.  for other controls, varying ranges depending on id</returns>
-		private short snes_input_state(int port, int index, int id)
+		private short snes_input_poll(int port, int index, int id)
 		{
-			return _controllers.CoreInputState(port, index, id);
+			return _controllers.CoreInputPoll(_controller, port, index, id);
 		}
 
 		private void snes_no_lag(bool sgbPoll)
 		{
-			// gets called whenever there was input polled, aka no lag
+			// gets called whenever there was input read in the core
 			if (!IsSGB || sgbPoll)
 			{
 				IsLagFrame = false;
 			}
 		}
 
+		private void snes_controller_latch()
+		{
+			InputCallbacks.Call();
+		}
+
 		private readonly int[] palette = new int[0x8000];
 
 		private void generate_palette()

src/BizHawk.Emulation.Cores/Consoles/Nintendo/BSNES/BsnesCore.cs

@@ -14,7 +14,7 @@ public IDictionary<string, RegisterValue> GetCpuFlagsAndRegisters()
 
 			int n = Core.gpgx_getregs(regs);
 			if (n > regs.Length)
-					throw new InvalidOperationException("A buffer overrun has occured!");
+				throw new InvalidOperationException("A buffer overrun has occured!");
 			var ret = new Dictionary<string, RegisterValue>();
 			using (_elf.EnterExit())
 			{

src/BizHawk.Emulation.Cores/Consoles/Sega/gpgx64/GPGX.IDebuggable.cs

@@ -16,6 +16,13 @@ Controller::Controller(uint port) : port(port) {
 Controller::~Controller() {
 }
 
+auto Controller::latch(bool data) -> void {
+  if(latched == data) return;
+  latched = data;
+
+  if (latched == 0 && port == ID::Port::Controller1) platform->notify("LATCH");
+}
+
 auto Controller::iobit() -> bool {
   switch(port) {
   case ID::Port::Controller1: return cpu.pio() & 0x40;

waterbox/bsnescore/bsnes/sfc/controller/controller.cpp

@@ -18,11 +18,14 @@ struct Controller {
   auto iobit() -> bool;
   auto iobit(bool data) -> void;
   virtual auto data() -> uint2 { return 0; }
-  virtual auto latch(bool data) -> void {}
+  virtual auto latch(bool data) -> void;
   virtual auto latch() -> void {}  //light guns
   virtual auto draw(uint16_t* output, uint pitch, uint width, uint height) -> void {}  //light guns
 
   const uint port;
+
+protected:
+  bool latched;
 };
 
 struct ControllerPort {