Add support for Apple's GameController.framework as an input device #9745

dhannema · 2021-05-23T06:39:58Z

Add support for input devices to be detected from Apple's GameController.framework.

So far, I have only tested this with a DualShock 4 and an Xbox One S controller.

This will allow Mac users to directly use accelerometer and gyroscope motion input (if available) without need for external DSU applications:

And will also allow Mac users to use the touchpad of the DS4 controller:

lioncash · 2021-05-23T07:05:39Z

Source/Core/InputCommon/ControllerInterface/GameController/GameControllerDevice.mm

+
+  for (GCControllerButtonInput* item in controller.physicalInputProfile.allButtons)
+  {
+    pairs.push_back(std::make_pair(std::string([item.aliases.allObjects[0] UTF8String]), item));


Suggested change

pairs.push_back(std::make_pair(std::string([item.aliases.allObjects[0] UTF8String]), item));

pairs.emplace_back(std::string([item.aliases.allObjects[0] UTF8String], item);

Is item.aliases.allObjects[0] guaranteed to be valid?
Feels like it should probably be checked, unless it's a c array.

According to https://developer.apple.com/documentation/gamecontroller/gccontrollerelement, the aliases object is always present, but I will add a check if the array contains more than 0 entries

lioncash · 2021-05-23T07:06:24Z

Source/Core/InputCommon/ControllerInterface/GameController/GameControllerDevice.mm

+    pairs.push_back(std::make_pair(std::string([item.aliases.allObjects[0] UTF8String]), item));
+  }
+
+  sort(pairs.begin(), pairs.end(), [=](std::pair<std::string, GCControllerButtonInput*>& a, std::pair<std::string, GCControllerButtonInput*>& b)


Suggested change

sort(pairs.begin(), pairs.end(), [=](std::pair<std::string, GCControllerButtonInput*>& a, std::pair<std::string, GCControllerButtonInput*>& b)

std::sort(pairs.begin(), pairs.end(), [](const auto& lhs, const auto& rhs)

lioncash · 2021-05-23T07:06:59Z

Source/Core/InputCommon/ControllerInterface/GameController/GameControllerDevice.mm

+    AddInput(new Button(pairs[i].second));
+  }
+
+  if (controller.motion)


Suggested change

if (controller.motion)

if (!controller.motion)

return;

Personal preference I guess, but I'd use m_controller instead of controller inside this function.

lioncash · 2021-05-23T07:08:16Z

Source/Core/InputCommon/ControllerInterface/GameController/GameControllerDevice.h

+
+class Controller : public Core::Device
+{
+private:


Private interface should be below the public interface.

lioncash · 2021-05-23T07:08:27Z

Source/Core/InputCommon/ControllerInterface/GameController/GameControllerDevice.h

+  class Motion : public Input
+  {
+  public:
+    enum button


Suggested change

enum button

enum class ButtonAxis

lioncash · 2021-05-23T07:13:44Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+  INFO_LOG_FMT(SERIALINTERFACE, "Controller '{}' connected with motion={}", vendorName, controller.motion.sensorsActive);
+  NOTICE_LOG_FMT(SERIALINTERFACE, "Controller '{}' connected with motion={} and id=", vendorName, controller.motion.sensorsActive);
+
+  std::shared_ptr<ciface::GameController::Controller> j=std::make_shared<Controller>(controller);


This can just collapse into:

Suggested change

std::shared_ptr<ciface::GameController::Controller> j=std::make_shared<Controller>(controller);

g_controller_interface.AddDevice(std::make_shared<Controller>(controller));

lioncash · 2021-05-23T07:14:07Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+{
+  controller.motion.sensorsActive = true;
+
+  std::string vendorName = std::string([controller.vendorName UTF8String]);


Suggested change

std::string vendorName = std::string([controller.vendorName UTF8String]);

std::string vendor_name = std::string([controller.vendorName UTF8String]);

I don't particularly care but I think this string could be const

lioncash · 2021-05-23T07:15:31Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+
+void Init(void* window)
+{
+  CFNotificationCenterAddObserver(CFNotificationCenterGetLocalCenter(), s_observer, &onControllerConnect, CFSTR("GCControllerDidConnectNotification"), NULL, CFNotificationSuspensionBehaviorDeliverImmediately);


Prefer using nullptr over NULL. Ditto for other applicable cases elsewhere.

Does this trigger the callback for devices that are connection on Init, or does it only call it for devices that will be connected after binding to it? I guess it's the second case, but please specify it in a comment.

Also there is a space between the two functions here, but there isn't in DeInit()

lioncash · 2021-05-23T07:16:43Z

Source/Core/InputCommon/ControllerInterface/GameController/GameControllerDevice.mm

+
+namespace ciface::GameController
+{
+using MathUtil::GRAVITY_ACCELERATION; // 9.80665


Maybe move this into the constructor, given it's only used in there.

Not like GRAVITY_ACCELERATION is likely to change, but why copy its value in the comment?

lioncash · 2021-05-23T07:17:50Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+  // I was unable to use [GCController controllers] in Objective-C++ and therefore needed to access this class method using objc_msgSend instead
+  typedef NSArray<GCController*>* (*send_type)(id, SEL);
+  send_type func = (send_type)objc_msgSend;
+  NSArray<GCController*>* controllers=(NSArray<GCController*>*)func(objc_getClass("GCController"), sel_getUid("controllers"));


Suggested change

NSArray<GCController*>* controllers=(NSArray<GCController*>*)func(objc_getClass("GCController"), sel_getUid("controllers"));

auto* controllers = func(objc_getClass("GCController"), sel_getUid("controllers"));

Filoppi · 2021-05-24T11:41:21Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.h

+namespace ciface::GameController
+{
+void Init(void* window);
+void PopulateDevices(void* window);


the window ptr is never used.
It would be better without it, especially after the changes I made to the controller interface in my pending PR:
#9702

Filoppi · 2021-05-24T11:43:11Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+}
+
+void DeInit()
+{


Could you add some safety measure to make sure DeInit doesn't break if called when Init hasn't been called? Or is that the case already?

I have checked this and the CFNotificationCenterRemoveObserver methods in DeInit() can already be called multiple times without any problems, so it looks like an explicit safety is not needed.

Ok, maybe specify that in a comment, it wouldn't hurt.

What does s_observer do? Is it assigned in Init? Maybe you could set it to null after DeInit?
Edit: nevermind.

Filoppi · 2021-05-24T11:44:49Z

Source/Core/InputCommon/ControllerInterface/GameController/GameControllerDevice.mm

+
+std::string Controller::GetSource() const
+{
+  return "GCF";


constexpr somewhere

Filoppi · 2021-05-24T11:45:56Z

Source/Core/InputCommon/ControllerInterface/GameController/GameControllerDevice.mm

+
+namespace ciface::GameController
+{
+using MathUtil::GRAVITY_ACCELERATION; // 9.80665


Not like GRAVITY_ACCELERATION is likely to change, but why copy its value in the comment?

Filoppi · 2021-05-24T11:50:36Z

Source/Core/InputCommon/ControllerInterface/ControllerInterface.cpp

@@ -16,6 +16,7 @@
 #include "InputCommon/ControllerInterface/Xlib/XInput2.h"
 #endif
 #ifdef CIFACE_USE_OSX
+#include "InputCommon/ControllerInterface/GameController/GameController.h"


Is this PR a Draft (work in progress)? Init/PopulateDevices/DeInit aren't plugged in in the ControllerInterface.
I don't understand how you even tested this.

I'm sorry for the confusion. I own an M1 Mac and had to test/develop in skylersaleh's fork as I am unable to build Dolphin on the main branch.
I forgot to manually copy the other changes I made in ControllerInterface.cpp

Filoppi · 2021-05-24T11:51:17Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+
+namespace ciface::GameController
+{
+static char *s_observer="";


Why assigning a "" to a ptr?

This is to ensure s_observer is an actual pointer to something. Otherwise the pointer will always be 0.

Not sure I understand.
I've never allocated a ptr like that.
Does that create a new object and assign it to the pointer?

If I understand what this is, you should probably assign "dolphin" to that char array.

Why isn't this a constexpr or a const which you then pass as a reference to the callbacks bindings functions?

What this does is to ensure that there is an empty string in the constant data segment of the binary and make the pointer point to it. If this is to be done, the variable should be marked const char* instead of just char*, because writing to such a string is not allowed. Or you can use Filoppi's suggestion of defining some simple variable (like an int) and then taking a pointer to it.

I double checked the manual (https://developer.apple.com/documentation/corefoundation/1543316-cfnotificationcenteraddobserver?language=objc) and it looks like I can completely remove the s_observer variable.
I will remove it and pass nullptr to the callback functions!

Filoppi · 2021-05-24T11:51:44Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+
+  std::string vendorName = std::string([controller.vendorName UTF8String]);
+  INFO_LOG_FMT(SERIALINTERFACE, "Controller '{}' connected with motion={}", vendorName, controller.motion.sensorsActive);
+  NOTICE_LOG_FMT(SERIALINTERFACE, "Controller '{}' connected with motion={} and id=", vendorName, controller.motion.sensorsActive);


This is CONTROLLERINTERFACE now, I've recently added a new log type. Same for any other log you might have here.

The ID for the notice log doesn't seem to be specified?
Do we really need two different logs of different verbosity?

Filoppi · 2021-05-24T11:56:48Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+
+  g_controller_interface.RemoveDevice([&inController](const auto* obj)
+  {
+    const Controller* controller = dynamic_cast<const Controller*>(obj);


I thought dynamic_cast was forbidden in dolphin, how does this even build?

I borrowed this code from the already existing OSX.mm, so I guess it is not a problem?

Yes I know it's there as well. Not a problem to me, but on MSVC if you try to add a dynamic_cast it refused to build as it's been disabled.

Filoppi · 2021-05-24T11:59:22Z

Source/Core/InputCommon/ControllerInterface/GameController/GameControllerDevice.mm

+
+  sort(pairs.begin(), pairs.end(), [=](std::pair<std::string, GCControllerButtonInput*>& a, std::pair<std::string, GCControllerButtonInput*>& b)
+  {
+    return a.first.compare(b.first)<0;


return a.first.compare(b.first) < 0;

Filoppi · 2021-05-24T12:07:08Z

Source/Core/InputCommon/ControllerInterface/GameController/GameControllerDevice.mm

+    AddInput(new Button(pairs[i].second));
+  }
+
+  if (controller.motion)


Personal preference I guess, but I'd use m_controller instead of controller inside this function.

Filoppi · 2021-05-24T12:07:55Z

Source/Core/InputCommon/ControllerInterface/GameController/GameControllerDevice.mm

+
+  for (GCControllerButtonInput* item in controller.physicalInputProfile.allButtons)
+  {
+    pairs.push_back(std::make_pair(std::string([item.aliases.allObjects[0] UTF8String]), item));


Is item.aliases.allObjects[0] guaranteed to be valid?
Feels like it should probably be checked, unless it's a c array.

Filoppi · 2021-05-24T12:08:31Z

Source/Core/InputCommon/ControllerInterface/GameController/GameControllerDevice.mm

+      AddInput(new Motion(controller, "Gyro Yaw Left", Motion::gyro_z, 1));
+      AddInput(new Motion(controller, "Gyro Yaw Right", Motion::gyro_z, -1));
+    }
+


Extra space

Filoppi · 2021-05-24T12:15:02Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+
+void Init(void* window)
+{
+  CFNotificationCenterAddObserver(CFNotificationCenterGetLocalCenter(), s_observer, &onControllerConnect, CFSTR("GCControllerDidConnectNotification"), NULL, CFNotificationSuspensionBehaviorDeliverImmediately);


Also there is a space between the two functions here, but there isn't in DeInit()

Filoppi · 2021-05-24T12:15:42Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+// Licensed under GPLv2+
+// Refer to the license.txt file included.
+
+#include <random>


This doesn't seem to be used?

Filoppi · 2021-05-24T12:16:43Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+
+void addController(GCController* controller)
+{
+  controller.motion.sensorsActive = true;


What is this for? Why is it not "deactivated" on disconnection? Is it relevant? Persistent?

Filoppi · 2021-05-24T12:17:52Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+
+  std::string vendorName = std::string([controller.vendorName UTF8String]);
+  INFO_LOG_FMT(SERIALINTERFACE, "Controller '{}' connected with motion={}", vendorName, controller.motion.sensorsActive);
+  NOTICE_LOG_FMT(SERIALINTERFACE, "Controller '{}' connected with motion={} and id=", vendorName, controller.motion.sensorsActive);


The ID for the notice log doesn't seem to be specified?
Do we really need two different logs of different verbosity?

Filoppi · 2021-05-24T12:19:40Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+
+  for (GCController* controller in controllers)
+  {
+    addController(controller);


You should remove all devices which have the same source name as ours before re-adding them.

@Filoppi during my tests, it seems like this is working properly. When I click 'Refresh' in the Device popup screen the controllers are added properly again.

It does work properly in the way the controller interface is currently setup, meaning that it cleans all devices before calling PopulateDevices() on each input backend, but it doesn't hurt to also remove your devices manually, and some input backends do. It would avoid duplicates if the controller interface design ever changed.

skylersaleh · 2021-06-02T19:16:34Z

@dhannema Could you please rebase your PR to the latest master to pick up the changes to support M1 builds, so that the osx-universal buildbot will be able to run?

OatmealDome · 2021-06-02T19:20:40Z

Source/Core/InputCommon/ControllerInterface/GameController/GameController.mm

+{
+static void AddController(GCController* controller)
+{
+  if (!@available(macOS 11.0, *)) {


You can't negate an @available check. An alternative might be

if (@available(macOS 11.0, *)) { } else { INFO_LOG_FMT(...); return; }

But admittedly, it is a bit ugly.

This reverts commit c62029b.

….0 target

canesalato · 2021-06-05T18:30:37Z

I tested this on my M1 MacBook and it seems to work well, both when running native (arm) and under Rosetta2

…dolphin-emu-master

adityajs12321 · 2022-03-15T06:43:33Z

Tested this on my m1 mac and a DualShock4, can confirm it works well

ghost · 2022-05-17T09:28:03Z

Can confirm this works even with a DS5 (DualSense) controller!

Rumi-Larry · 2022-05-18T02:13:39Z

Protip: When making small changes, is always better to ammend the main commits than create a new one... Also hit the weak spot for massive damage!

jordan-woyak · 2024-03-20T20:58:54Z

SDL should now provide accelerometer/gyroscope input.
Does this "GameController Famework" provide any additional functionality on macOS over our SDL input backend?
Unfortunately macOS-specific code can tend to quickly become unmaintained in dolphin so if SDL does everything we need I think it might be best to just rely on SDL for macOS gamepad input.

dhannema · 2024-03-21T08:15:31Z

Does this "GameController Famework" provide any additional functionality on macOS over our SDL input backend?

You are correct. We are 3 years later and indeed SDL also provides this functionality now.
This PR can be closed !

lioncash reviewed May 23, 2021

View reviewed changes

Filoppi reviewed May 24, 2021

View reviewed changes

OatmealDome reviewed Jun 2, 2021

View reviewed changes

dhannema added 7 commits June 3, 2021 15:15

Add support for Apple's GameController.framework as an input device

9ff5e8a

Processed code review comments from @lioncash

3431a1b

Revert "Processed code review comments from @lioncash"

777f1be

This reverts commit c62029b.

Processed comments from @lioncash, @Filoppi & @JosJuice

1993178

Changed SERIALINTERFACE to CONTROLLERINTERFACE

2e877c2

fix build errors

a187a92

fix lint problem & review feedback

1fc0d57

dhannema force-pushed the master branch from a1888b8 to 1fc0d57 Compare June 3, 2021 13:15

another attempt to fix the compilation of macos 11.0 code on a pre 11…

5d6f1f6

….0 target

dhannema added 2 commits March 3, 2022 11:32

Merge branch 'master' of https://github.com/dolphin-emu/dolphin into …

a7cd13c

…dolphin-emu-master

Merge branch 'dolphin-emu-master'

be4245b

OatmealDome mentioned this pull request Jun 3, 2022

Sdl motion #10561

Merged

jordan-woyak closed this Mar 21, 2024

	pairs.push_back(std::make_pair(std::string([item.aliases.allObjects[0] UTF8String]), item));
	pairs.emplace_back(std::string([item.aliases.allObjects[0] UTF8String], item);

	sort(pairs.begin(), pairs.end(), [=](std::pair<std::string, GCControllerButtonInput>& a, std::pair<std::string, GCControllerButtonInput>& b)
	std::sort(pairs.begin(), pairs.end(), [](const auto& lhs, const auto& rhs)

	std::shared_ptr<ciface::GameController::Controller> j=std::make_shared<Controller>(controller);
	g_controller_interface.AddDevice(std::make_shared<Controller>(controller));

	std::string vendorName = std::string([controller.vendorName UTF8String]);
	std::string vendor_name = std::string([controller.vendorName UTF8String]);

	NSArray<GCController> controllers=(NSArray<GCController>)func(objc_getClass("GCController"), sel_getUid("controllers"));
	auto* controllers = func(objc_getClass("GCController"), sel_getUid("controllers"));

Add support for Apple's GameController.framework as an input device #9745

Add support for Apple's GameController.framework as an input device #9745

Conversation

dhannema commented May 23, 2021

Choose a reason for hiding this comment

Filoppi May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Filoppi May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Filoppi May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Filoppi May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Filoppi May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Filoppi May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JosJuice May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Filoppi May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Filoppi May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Filoppi May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Filoppi May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

skylersaleh commented Jun 2, 2021 • edited Loading

Choose a reason for hiding this comment

canesalato commented Jun 5, 2021

adityajs12321 commented Mar 15, 2022

ghost commented May 17, 2022

Rumi-Larry commented May 18, 2022

jordan-woyak commented Mar 20, 2024

dhannema commented Mar 21, 2024

Filoppi May 24, 2021 •

edited

Loading

Filoppi May 24, 2021 •

edited

Loading

Filoppi May 24, 2021 •

edited

Loading

Filoppi May 24, 2021 •

edited

Loading

Filoppi May 24, 2021 •

edited

Loading

Filoppi May 24, 2021 •

edited

Loading

JosJuice May 24, 2021 •

edited

Loading

Filoppi May 24, 2021 •

edited

Loading

Filoppi May 24, 2021 •

edited

Loading

Filoppi May 24, 2021 •

edited

Loading

Filoppi May 24, 2021 •

edited

Loading

skylersaleh commented Jun 2, 2021 •

edited

Loading