input: export additional info for joysticks inputs

 Added some extra info to help RetroPie's auto-configuration scripts:

 * export the joystick Vendor and Product IDs, which should help with RetroArch's joypad profile generation.
 * export device path (`/dev/input/eventXY`), which can help finding the system's (joystick/udev) name for the joystick (which can be retrived with a new 2.24.0 call).

 Since 2.0.14, SDL's joystick name (`SDL_CreateJoystickName`) is a normalized version of the name reported by the OS (culled consecutive spaces, trimming trailing spaces, renaming known joystick names like Xbox/PS). This breaks the input auto-configuration scripts in RetroPie, which generate a config with new name, while the emulators/ports expect to find the OS reported name (e.g. RetroArch - see #3398 [1] for an example).

 This issue is affecting especially PC users, which are not using RetroPie's (old) SDL version and who's RetroArch configuration is incomplete. Using the Vendor/Product ID would help alleviate these situations and new SDL versions in RetroPie.

[1] RetroPie/RetroPie-Setup#3398

Author: cmitu

es-core/src/InputConfig.cpp

@@ -1,6 +1,7 @@
 #include "InputConfig.h"
 
 #include "Log.h"
+#include "utils/StringUtil.h"
 #include <pugixml/src/pugixml.hpp>
 
 //some util functions
@@ -39,19 +40,11 @@ InputType stringToInputType(const std::string& type)
 }
 
 
-std::string toLower(std::string str)
-{
-	for(unsigned int i = 0; i < str.length(); i++)
-	{
-		str[i] = (char)tolower(str[i]);
-	}
-
-	return str;
-}
-//end util functions
-
 InputConfig::InputConfig(int deviceId, const std::string& deviceName, const std::string& deviceGUID) : mDeviceId(deviceId), mDeviceName(deviceName), mDeviceGUID(deviceGUID)
 {
+	mVendorId   =  0;
+	mProductId  =  0;
+	mDevicePath = "";
 }
 
 void InputConfig::clear()
@@ -66,19 +59,19 @@ bool InputConfig::isConfigured()
 
 void InputConfig::mapInput(const std::string& name, Input input)
 {
-	mNameMap[toLower(name)] = input;
+	mNameMap[Utils::String::toLower(name)] = input;
 }
 
 void InputConfig::unmapInput(const std::string& name)
 {
-	auto it = mNameMap.find(toLower(name));
+	auto it = mNameMap.find(Utils::String::toLower(name));
 	if(it != mNameMap.cend())
 		mNameMap.erase(it);
 }
 
 bool InputConfig::getInputByName(const std::string& name, Input* result)
 {
-	auto it = mNameMap.find(toLower(name));
+	auto it = mNameMap.find(Utils::String::toLower(name));
 	if(it != mNameMap.cend())
 	{
 		*result = it->second;
@@ -188,7 +181,7 @@ void InputConfig::loadFromXML(pugi::xml_node& node)
 		if(value == 0)
 			LOG(LogWarning) << "WARNING: InputConfig value is 0 for " << type << " " << id << "!\n";
 
-		mNameMap[toLower(name)] = Input(mDeviceId, typeEnum, id, value, true);
+		mNameMap[Utils::String::toLower(name)] = Input(mDeviceId, typeEnum, id, value, true);
 	}
 }
 
@@ -210,6 +203,15 @@ void InputConfig::writeToXML(pugi::xml_node& parent)
 	{
 		cfg.append_attribute("type") = "joystick";
 		cfg.append_attribute("deviceName") = mDeviceName.c_str();
+		if(mVendorId && mProductId)
+		{
+			cfg.append_attribute("vendorId") = mVendorId;
+			cfg.append_attribute("productId") = mProductId;
+		}
+		if(!mDevicePath.empty())
+		{
+			cfg.append_attribute("devicePath") = mDevicePath.c_str();
+		}
 	}
 
 	cfg.append_attribute("deviceGUID") = mDeviceGUID.c_str();

es-core/src/InputConfig.h

@@ -102,9 +102,15 @@ class InputConfig
 	void mapInput(const std::string& name, Input input);
 	void unmapInput(const std::string& name); // unmap all Inputs mapped to this name
 
-	inline int getDeviceId() const { return mDeviceId; };
+	inline int getDeviceId() const { return mDeviceId; }
 	inline const std::string& getDeviceName() { return mDeviceName; }
 	inline const std::string& getDeviceGUIDString() { return mDeviceGUID; }
+	inline const unsigned short getVendorId() { return mVendorId; }
+	inline const unsigned short getProductId() { return mProductId; }
+
+	inline void setVendorId(unsigned short vendorID) { mVendorId = vendorID; }
+	inline void setProductId(unsigned short productID) { mProductId = productID; }
+	inline void setDevicePath(const char *devPath) { if(devPath != NULL) mDevicePath = devPath; }
 
 	//Returns true if Input is mapped to this name, false otherwise.
 	bool isMappedTo(const std::string& name, Input input);
@@ -127,6 +133,10 @@ class InputConfig
 	const int mDeviceId;
 	const std::string mDeviceName;
 	const std::string mDeviceGUID;
+
+	unsigned short mVendorId;
+	unsigned short mProductId;
+	std::string mDevicePath;
 };
 
 #endif // ES_CORE_INPUT_CONFIG_H

es-core/src/InputManager.cpp

@@ -99,6 +99,22 @@ void InputManager::addJoystickByDeviceIndex(int id)
 
 	// create the InputConfig
 	mInputConfigs[joyId] = new InputConfig(joyId, SDL_JoystickName(joy), guid);
+
+	// add Vendor and Product IDs
+	mInputConfigs[joyId]->setVendorId(SDL_JoystickGetVendor(joy));
+	mInputConfigs[joyId]->setProductId(SDL_JoystickGetProduct(joy));
+
+	// SDL version 2.24.0 adds the 'SDL_JoystickPathForIndex' function to get the (udev) device path
+#if SDL_VERSION_ATLEAST(2,24,0)
+	SDL_version sdl_runtime;
+	SDL_GetVersion(&sdl_runtime);
+	if ((sdl_runtime.major >= 2) && (sdl_runtime.major > 2 || sdl_runtime.minor >= 24) && \
+		(sdl_runtime.major > 2 || sdl_runtime.minor > 24 || sdl_runtime.patch >= 0))
+	{
+		mInputConfigs[joyId]->setDevicePath(SDL_JoystickPathForIndex(id));
+	}
+#endif
+
 	if(!loadInputConfig(mInputConfigs[joyId]))
 	{
 		LOG(LogInfo) << "Added unconfigured joystick " << SDL_JoystickName(joy) << " (GUID: " << guid << ", instance ID: " << joyId << ", device index: " << id << ").";