Details

Reviewers

Sybren A. Stüvel (sybren)
Porteries Tristan (panzergame)
Thomas Szepe (hg1)
Sergey Sharybin (sergey)
Mitchell Stokes (moguri)

Summary

The issue comes with the migration to SDL2. SDL2 uses Xinput library for Windows and it works different from old mm and dinput libraries.

To mitigate this issue SDL2 implements a new Game Controller API. This new API use a intermediate file (gamecontrollerdb.txt) where the joysticks are mapped to follow a similar configuration than Xbox 360 game controller.

To perform this mapping there are several tools availables (Steam Big Mode, controllermapping in SDL2 test sources and antimicro).

I have tested this patch in Linux/Windows with a Xbox 360 controller and a PS2 clone. Xbox 360 worked out the box and for the PS2 clone I had to do the mapping using a controllermapping program. After this, it works like a charm. The behaviour was consistent between linux and windows (not as now).

This patch is NOT BACKWARD COMPATIBLE due to new API. Between other things the new API has not "hat" concept and it processes "hat/dpad" control as any other button (BUTTON_DPAD_UP, BUTTON_DPAD_DOWN, BUTTON_DPAD_LEFT and BUTTON_DPAD_RIGHT). Also, it implement Shoulder trigger buttons (left/right) as independent axis.

Moreover, to implement a "do_version" it is very hard because we would have to differentiate between MacOS&Linux and Windows, and between Joysticks and Game Controllers. The only way to make it compatible with previous versions is to compile SDL2 disabling XINPUT and enabling MM/DINPUT but this way we would loose hottpluggin, haptic (vibration) and standatization (at last) features.

To clarify a little how it works now regarding our unintuitive Joystick sensor:
A Game Controller is composed of:

6 axis availables (in order from 0 to 5):
AXIS_LEFTSTICK_X, AXIS_LEFTSTICK_Y, AXIS_RIGHTSTICK_X, AXIS_RIGHTSTICK_Y, AXIS_TRIGGERLEFT and AXIS_TRIGGERRIGHT.

and 15 buttons availables (in order from 0 to 14):
BUTTON_A, BUTTON_B, BUTTON_X, BUTTON_Y, BUTTON_BACK, BUTTON_GUIDE, BUTTON_START, BUTTON_LEFTSTICK, BUTTON_RIGHTSTICK, BUTTON_LEFTSHOULDER, BUTTON_RIGHTSHOULDER, BUTTON_DPAD_UP, BUTTON_DPAD_DOWN, BUTTON_DPAD_LEFT and BUTTON_DPAD_RIGHT.

Then with a game controller we would expect the following behaviour:

Event type = Single Axis:

"Index" means joystick/device
Axis Number 1 -> Left Stick horizontal movement
Axis Number 2 -> Left Stick vertical movement
Axis Number 3 -> Right Stick horizontal movement
Axis Number 4 -> Right Stick vertical movement
Axis Number 5 -> Left Shoulder trigger movement
Axis Number 6 -> Right Soulder trigger movement

Event type = Hat:

There is no Hat concept in new game controller API. It is treaty as a normal button

Hat Number 1 or 2 (left or right) -> Only Hat Number 1 is simulated through the buttons
Hat direction (8 directions) -> Now you only have 4 buttons (BUTTON_DPAD_UP, BUTTON_DPAD_DOWN, BUTTON_DPAD_LEFT and BUTTON_DPAD_RIGHT), if you want to check a diagonal direction (i.e top/left) you will have to add 2 sensors (BUTTON_DPAD_LEFT and BUTTON_DPAD_UP) with an AND controller to simulate the same behaviour.

Having said that, this mode will not work in current patch.

Event type = Axis

Similar to Single Axis mode but taken the Axis in pairs and after splitting them in 4 directions (Up/Down/Left/Right).

Axis Number 1 -> Left Stick (Up/Down/Left/Right)
Axis Number 2 -> Right Stick (Up/Down/Left/Right)
Axis Number 3 -> Both Shoulder triggers. Left/Right -> Left trigger (active when unpressed / active when pressed), Up/Down Right trigger (active when unpressed / active when pressed).

Event type = Button

Button number 0 -> BUTTON_A
Button number 1 -> BUTTON_B
Button number 2 -> BUTTON_X
Button number 3 -> BUTTON_Y
Button number 4 -> BUTTON_BACK
Button number 5 -> BUTTON_GUIDE
Button number 6 -> BUTTON_START
Button number 7 -> BUTTON_LEFTSTICK
Button number 8 -> BUTTON_RIGHTSTICK
Button number 9 -> BUTTON_LEFTSHOULDER
Button number 10 -> BUTTON_RIGHTSHOULDER
Button number 11 -> BUTTON_DPAD_UP
Button number 12 -> BUTTON_DPAD_DOWN
Button number 13 -> BUTTON_DPAD_LEFT
Button number 14 -> BUTTON_DPAD_RIGHT

TODO:

I have no tested in MacOsX yet

Diff Detail

Repository: rB Blender
Branch: bge-bug-SDL2gamecontroller

Event Timeline

Jorge Bernal (lordloki) retitled this revision from to BGE: Fix T43883 joystick Xbox does not work properly since Blender 2.73 in Windows.Aug 25 2015, 1:35 AM

Jorge Bernal (lordloki) added reviewers: Campbell Barton (campbellbarton), Mitchell Stokes (moguri), Thomas Szepe (hg1), Porteries Tristan (panzergame), Sybren A. Stüvel (sybren).

Jorge Bernal (lordloki) updated this object.

Jorge Bernal (lordloki) added a subscriber: Michele Scaciga (scaciga).

Jorge Bernal (lordloki) updated this revision to Diff 4925.

Jorge Bernal (lordloki) updated this object.Aug 25 2015, 1:38 AM

Jorge Bernal (lordloki) updated this object.Aug 25 2015, 1:55 AM

Little fixes

Porteries Tristan (panzergame) edited edge metadata.Aug 25 2015, 1:55 PM

Porteries Tristan (panzergame) requested changes to this revision.

Porteries Tristan (panzergame) added inline comments.

source/gameengine/GameLogic/Joystick/SCA_Joystick.cpp
122	errrmhh, can you use relative path ?

This revision now requires changes to proceed.Aug 25 2015, 1:55 PM

Jorge Bernal (lordloki) added inline comments.Aug 27 2015, 1:58 PM

source/gameengine/GameLogic/Joystick/SCA_Joystick.cpp
122	No, i can't because datafiles folder is under 2.7X folder which name changes in every release. I think that the proper way is to use the BKE function but i can't compile it.

I have tested your patch with my changes. The patch looks OK and there is no load error with SDL_GameControllerAddMappingsFromFile.
But the axis are still not correct on my Windows PC (broken since Blender 2.73a). It seems that there is no X360 Controller mapping in the gamecontrollerdb.txt for windows.

I can upload my changed patch, if you want (I removed also some whitespace only changes for the patch).

source/gameengine/GameLogic/Joystick/SCA_Joystick.cpp
43–45	You need to change this, otherwise BKE_appdir_folder_id will not compile. #if SDL_VERSION_ATLEAST(2, 0, 0) extern "C" { # include "BKE_appdir.h" } #endif
122	You need to use relative path, otherwise it will not compile on other PC's. const char *path = BKE_appdir_folder_id(BLENDER_DATAFILES, "gamecontroller"); if (path) { char fullpath[FILE_MAX]; BLI_join_dirfile(fullpath, sizeof(fullpath), path, "gamecontrollerdb.txt"); if ((SDL_GameControllerAddMappingsFromFile(fullpath)) == -1) { JOYSTICK_ECHO("gamecontrollerdb.txt not loaded"); } }

source/gameengine/GameLogic/Joystick/SCA_Joystick.cpp

43–45

You need to change this, otherwise BKE_appdir_folder_id will not compile.

#if SDL_VERSION_ATLEAST(2, 0, 0)
extern "C" {
#  include "BKE_appdir.h"
}
#endif

122

You need to use relative path, otherwise it will not compile on other PC's.

	const char *path = BKE_appdir_folder_id(BLENDER_DATAFILES, "gamecontroller");
	if (path) {
		char fullpath[FILE_MAX];
		BLI_join_dirfile(fullpath, sizeof(fullpath), path, "gamecontrollerdb.txt");

		if ((SDL_GameControllerAddMappingsFromFile(fullpath)) == -1) {
			JOYSTICK_ECHO("gamecontrollerdb.txt not loaded");
		}
	}

Fixes from @Thomas Szepe (hg1) to be able of loading gamecontrollerdb.txt properly

Thanks for the fixes @Thomas Szepe (hg1). Now it is obvious but I was ofuscated with library linking order :-).

Regarding to Windows testing. Tomorrow I hope to have time to test/compile the patch in windows. I will come back with the results.

Jorge Bernal (lordloki) updated this object.Aug 29 2015, 2:02 AM

Jorge Bernal (lordloki) added a reviewer: Sergey Sharybin (sergey).

Jorge Bernal (lordloki) added a project: Game Engine.

In D1484#31538, @Thomas Szepe (hg1) wrote:

I have tested your patch with my changes. The patch looks OK and there is no load error with SDL_GameControllerAddMappingsFromFile.
But the axis are still not correct on my Windows PC (broken since Blender 2.73a). It seems that there is no X360 Controller mapping in the gamecontrollerdb.txt for windows.

Hi @Thomas Szepe (hg1), I have just tested in windows with a X360 controller and with a Ps2 clone joystick and the behaviour is correct but I see what you are saying. There is no mapping for X360 Controllers because they are XInput compatibles and they don't need the mapping.

WARNING: I have updated the description pointing out which should be the expected behaviour as this patch is NOT backward compatible. The patch makes the behaviour consistent between linux and windows (and I hope Mac) and follows the expected process of standarization performed by SDL (rather STEAM).

In my point of view we should discard the old API and to use only the new API (reworking the Joystick sensor) but we can wait to 2.8 updating process.

Jorge Bernal (lordloki) updated this object.Aug 29 2015, 2:26 AM

There is no mapping for X360 Controllers because they are XInput compatibles and they don't need the mapping.

I thought something like this. The problem is that the actual assignment is different to the old one and so the old files are not working any more.
You should mentioned this in the Blender 2.77 release notes.

Old behaviour:
Axis Number 3 -> Left Shoulder trigger movement -32768 to 0 / Right Shoulder trigger movement 0 to +32767
Axis Number 5 -> Right Stick horizontal movement

Please remove these files from the patch. Because there is no code change, there are only whitespace changes in this files. Such changes should be done in an cleanup patch.
source/blenderplayer/CMakeLists.txt
source/gameengine/GameLogic/Joystick/SCA_Joystick.h

Remove whitespaces

I don't know how discard the blenderplayer/CMakeLists.txt "change". I have compared it against old one and they are the same file.

I don't know how discard the blenderplayer/CMakeLists.txt "change". I have compared it against old one and they are the same file.

In the old there was one space after ge_player_common and on after ge_converter.

You can visualize the changes in the Phabricator if you choose "Show All" in "Whitespace Changes:" and update the view with the Show Diff button.

I am using SourceTree, with it is much easier to do such things. But there is no Linux version available.

Remove unwanted CMakeLists.txt whitespace changes

Talked over IRC.

For release we can aparently build SDL without Xinput support on Windows, to get the same kind of compatibility we had w/ SDL1.2.

For 2.76 release I think this is the best option.

@Martijn Berger (juicyfruit), since you build SDL last... is this something you're able to do before release?

In D1484#31847, @Campbell Barton (campbellbarton) wrote:

Talked over IRC.
For release we can aparently build SDL without Xinput support on Windows, to get the same kind of compatibility we had w/ SDL1.2.
For 2.76 release I think this is the best option.
@Martijn Berger (juicyfruit), since you build SDL last... is this something you're able to do before release?

@Martijn Berger (juicyfruit),

the changes would be:

at SDL_config_windows.h in include dir:

- #define SDL_JOYSTICK_DINPUT 1
- #define SDL_JOYSTICK_XINPUT 1
- #define SDL_HAPTIC_DINPUT   1
- #define SDL_HAPTIC_XINPUT   1
---
+ #define SDL_HAPTIC_DISABLED 1
+ #define SDL_JOYSTICK_WINMM 1

Ulysse Martin (youle) added a subscriber: Ulysse Martin (youle).Sep 18 2015, 9:30 PM

what is the status here?

In D1484#34596, @Aaron Carlisle (Blendify) wrote:

what is the status here?

Basically:

There is no clear deal about the use of gamecontrollerdb.txt (external file or datatoc) yet

Nowadays, I'm doing a refactor of SDL Joystick code to convert it completely to the new SDL Game Controller API. To finish this refactor I will need 2-3 more weeks at least.

This refactor will include in at first stage:

Hotpluggin (not done)
Joystick sensor rework (done)
New Joystick actuator to load an external gamecontrollerdb.txt and to be able to generate a mapping (partially done)

At second stage:

Add support for force feedback.

I will update the diff after I finish each stage

Dongping Xie (dongping) added a subscriber: Dongping Xie (dongping).Nov 23 2015, 8:02 PM

Jacob Merrill (blueprintrandom) awarded a token.Feb 3 2016, 9:29 PM

Jacob Merrill (blueprintrandom) added a subscriber: Jacob Merrill (blueprintrandom).

Any luck with this?

I was going to add Xbox controls to wrectified soon :D

Campbell Barton (campbellbarton) removed a reviewer: Campbell Barton (campbellbarton).Aug 11 2016, 6:08 AM

Closing.
Current changes have been incorporated in UPBGE Joystick refactor (including hotpluggin and vibration not present here). They will available after future merge.
With respect to extern gamecontrollerdb.txt extern file controversy exposed here, we converted the gamecontrollerdb.txt in a char* and added it into joystick sources. This way no extern file is necessary.
Thanks for reviewing

		Path
A	M	release/datafiles/gamecontroller/License_gamecontrollerdb.txt (20 lines)
A	M	release/datafiles/gamecontroller/gamecontrollerdb.txt (92 lines)
M		source/creator/CMakeLists.txt (8 lines)
M		source/gameengine/GameLogic/CMakeLists.txt (1 line)
M		source/gameengine/GameLogic/Joystick/SCA_Joystick.cpp (121 lines)
M		source/gameengine/GameLogic/Joystick/SCA_JoystickEvents.cpp (18 lines)
M		source/gameengine/GameLogic/Joystick/SCA_JoystickPrivate.h (9 lines)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	4925	3633499		Aug 25 2015, 1:35 AM	★	★
Diff 2	4926	3633499	- Little fixes	Aug 25 2015, 1:57 AM	★	★
Diff 3	4953	3633499	- Fixes from @HG1 to be able of loading gamecontrollerdb.txt properly	Aug 28 2015, 12:40 AM	★	★
Diff 4	4965	3633499	- Remove whitespaces	Aug 29 2015, 4:52 PM	★	★
Diff 5	4970	3633499	- Remove unwanted CMakeLists.txt whitespace changes	Aug 29 2015, 9:37 PM	★	★

Commit	Tree	Parents	Author	Summary	Date
651c8013530c	58def6df9660	8166ed736b7a	Jorge Bernal	Remove unwanted CMakeLists.txt whitespace changes	Aug 29 2015, 9:37 PM
8166ed736b7a	18be994a1e50	d202fe21d924	Jorge Bernal	Remove whitespaces	Aug 29 2015, 4:52 PM
d202fe21d924	b09730665aa4	497d858d8c16	Jorge Bernal	Fixes from @HG1 to be able of loading gamecontrollerdb.txt properly	Aug 28 2015, 12:39 AM
497d858d8c16	b5c6802e1cc0	da472a9108f2	Jorge Bernal	Little fixes	Aug 25 2015, 1:56 AM
da472a9108f2	83a791f64a53	563cb7ce6e47	Jorge Bernal	BGE: Fix T43883 joystick Xbox does not work properly since Blender 2.73 in… (Show More…)	Aug 25 2015, 1:01 AM
563cb7ce6e47	d1b5e0ae0f9b	515c5eb56f0a	Jorge Bernal	Fix some #ifdefs	Aug 24 2015, 8:55 PM
515c5eb56f0a	4482ad6c010f	31d9fbea683f	Jorge Bernal	Correct data base loading and fix handle events	Aug 24 2015, 6:16 PM
31d9fbea683f	01f9ea0390c1	19cac942eb93	Jorge Bernal	gamecontrollerdb.txt and license added to datafiles directory	Aug 23 2015, 1:33 AM
19cac942eb93	8f5214fa2a27	8b9f294ca48a	Jorge Bernal	Added SDL events for Game controllers	Aug 23 2015, 1:19 AM
8b9f294ca48a	7cb5bc1939c0	cfa7dfe6aac6	Jorge Bernal	Rework CreateJoystickDevice and DestroyJoystickDevice using SDL_GameController… (Show More…)	Aug 22 2015, 1:45 AM
cfa7dfe6aac6	af81ee73963e	21d75e563c1c	Jorge Bernal	more wip	Aug 17 2015, 6:21 PM
21d75e563c1c	5f599ac98c78	9eac77dc79e5	Jorge Bernal	more wip	May 12 2015, 6:32 AM
9eac77dc79e5	3382fd8ee22d	3633499f4ea9	Jorge Bernal	WIP	Apr 13 2015, 1:02 AM

BGE: Fix T43883 joystick Xbox does not work properly since Blender 2.73 in Windows
AbandonedPublic
Actions

Details

Diff Detail

Event Timeline

Revision Contents
Changeset List

Diff 4970

release/datafiles/gamecontroller/License_gamecontrollerdb.txt

release/datafiles/gamecontroller/gamecontrollerdb.txt

source/creator/CMakeLists.txt

source/gameengine/GameLogic/CMakeLists.txt

source/gameengine/GameLogic/Joystick/SCA_Joystick.cpp

source/gameengine/GameLogic/Joystick/SCA_JoystickEvents.cpp

source/gameengine/GameLogic/Joystick/SCA_JoystickPrivate.h

BGE: Fix T43883 joystick Xbox does not work properly since Blender 2.73 in WindowsAbandonedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 4970

release/datafiles/gamecontroller/License_gamecontrollerdb.txt

release/datafiles/gamecontroller/gamecontrollerdb.txt

source/creator/CMakeLists.txt

source/gameengine/GameLogic/CMakeLists.txt

source/gameengine/GameLogic/Joystick/SCA_Joystick.cpp

source/gameengine/GameLogic/Joystick/SCA_JoystickEvents.cpp

source/gameengine/GameLogic/Joystick/SCA_JoystickPrivate.h

BGE: Fix T43883 joystick Xbox does not work properly since Blender 2.73 in Windows
AbandonedPublic
Actions

Revision Contents
Changeset List