1 /* DirectInput Generic Joystick device
3 * Copyright 1998 Marcus Meissner
4 * Copyright 1998,1999 Lionel Ulmer
5 * Copyright 2000-2001 TransGaming Technologies Inc.
6 * Copyright 2009 Aric Stewart, CodeWeavers
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
29 #include "joystick_private.h"
30 #include "wine/debug.h"
33 WINE_DEFAULT_DEBUG_CHANNEL(dinput
);
35 static inline JoystickGenericImpl
*impl_from_IDirectInputDevice8A(IDirectInputDevice8A
*iface
)
37 return CONTAINING_RECORD(CONTAINING_RECORD(iface
, IDirectInputDeviceImpl
, IDirectInputDevice8A_iface
), JoystickGenericImpl
, base
);
39 static inline JoystickGenericImpl
*impl_from_IDirectInputDevice8W(IDirectInputDevice8W
*iface
)
41 return CONTAINING_RECORD(CONTAINING_RECORD(iface
, IDirectInputDeviceImpl
, IDirectInputDevice8W_iface
), JoystickGenericImpl
, base
);
43 static inline IDirectInputDevice8A
*IDirectInputDevice8A_from_impl(JoystickGenericImpl
*This
)
45 return &This
->base
.IDirectInputDevice8A_iface
;
47 static inline IDirectInputDevice8W
*IDirectInputDevice8W_from_impl(JoystickGenericImpl
*This
)
49 return &This
->base
.IDirectInputDevice8W_iface
;
52 /******************************************************************************
53 * SetProperty : change input device properties
55 HRESULT WINAPI
JoystickWGenericImpl_SetProperty(LPDIRECTINPUTDEVICE8W iface
, REFGUID rguid
, LPCDIPROPHEADER ph
)
57 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8W(iface
);
60 TRACE("(%p,%s,%p)\n",This
,debugstr_guid(rguid
),ph
);
63 WARN("invalid parameter: ph == NULL\n");
64 return DIERR_INVALIDPARAM
;
68 _dump_DIPROPHEADER(ph
);
70 if (IS_DIPROP(rguid
)) {
71 switch (LOWORD(rguid
)) {
72 case (DWORD_PTR
)DIPROP_RANGE
: {
73 LPCDIPROPRANGE pr
= (LPCDIPROPRANGE
)ph
;
74 if (ph
->dwHow
== DIPH_DEVICE
) {
75 TRACE("proprange(%d,%d) all\n", pr
->lMin
, pr
->lMax
);
76 for (i
= 0; i
< This
->base
.data_format
.wine_df
->dwNumObjs
; i
++) {
77 This
->props
[i
].lMin
= pr
->lMin
;
78 This
->props
[i
].lMax
= pr
->lMax
;
81 int obj
= find_property(&This
->base
.data_format
, ph
);
83 TRACE("proprange(%d,%d) obj=%d\n", pr
->lMin
, pr
->lMax
, obj
);
85 This
->props
[obj
].lMin
= pr
->lMin
;
86 This
->props
[obj
].lMax
= pr
->lMax
;
92 case (DWORD_PTR
)DIPROP_DEADZONE
: {
93 LPCDIPROPDWORD pd
= (LPCDIPROPDWORD
)ph
;
94 if (ph
->dwHow
== DIPH_DEVICE
) {
95 TRACE("deadzone(%d) all\n", pd
->dwData
);
96 for (i
= 0; i
< This
->base
.data_format
.wine_df
->dwNumObjs
; i
++)
97 This
->props
[i
].lDeadZone
= pd
->dwData
;
99 int obj
= find_property(&This
->base
.data_format
, ph
);
101 TRACE("deadzone(%d) obj=%d\n", pd
->dwData
, obj
);
103 This
->props
[obj
].lDeadZone
= pd
->dwData
;
109 case (DWORD_PTR
)DIPROP_SATURATION
: {
110 LPCDIPROPDWORD pd
= (LPCDIPROPDWORD
)ph
;
111 if (ph
->dwHow
== DIPH_DEVICE
) {
112 TRACE("saturation(%d) all\n", pd
->dwData
);
113 for (i
= 0; i
< This
->base
.data_format
.wine_df
->dwNumObjs
; i
++)
114 This
->props
[i
].lSaturation
= pd
->dwData
;
116 int obj
= find_property(&This
->base
.data_format
, ph
);
118 TRACE("saturation(%d) obj=%d\n", pd
->dwData
, obj
);
120 This
->props
[obj
].lSaturation
= pd
->dwData
;
127 return IDirectInputDevice2WImpl_SetProperty(iface
, rguid
, ph
);
134 HRESULT WINAPI
JoystickAGenericImpl_SetProperty(LPDIRECTINPUTDEVICE8A iface
, REFGUID rguid
, LPCDIPROPHEADER ph
)
136 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8A(iface
);
137 return JoystickWGenericImpl_SetProperty(IDirectInputDevice8W_from_impl(This
), rguid
, ph
);
140 void _dump_DIDEVCAPS(const DIDEVCAPS
*lpDIDevCaps
)
142 TRACE("dwSize: %d\n", lpDIDevCaps
->dwSize
);
143 TRACE("dwFlags: %08x\n", lpDIDevCaps
->dwFlags
);
144 TRACE("dwDevType: %08x %s\n", lpDIDevCaps
->dwDevType
,
145 lpDIDevCaps
->dwDevType
== DIDEVTYPE_DEVICE
? "DIDEVTYPE_DEVICE" :
146 lpDIDevCaps
->dwDevType
== DIDEVTYPE_DEVICE
? "DIDEVTYPE_DEVICE" :
147 lpDIDevCaps
->dwDevType
== DIDEVTYPE_MOUSE
? "DIDEVTYPE_MOUSE" :
148 lpDIDevCaps
->dwDevType
== DIDEVTYPE_KEYBOARD
? "DIDEVTYPE_KEYBOARD" :
149 lpDIDevCaps
->dwDevType
== DIDEVTYPE_JOYSTICK
? "DIDEVTYPE_JOYSTICK" :
150 lpDIDevCaps
->dwDevType
== DIDEVTYPE_HID
? "DIDEVTYPE_HID" : "UNKNOWN");
151 TRACE("dwAxes: %d\n", lpDIDevCaps
->dwAxes
);
152 TRACE("dwButtons: %d\n", lpDIDevCaps
->dwButtons
);
153 TRACE("dwPOVs: %d\n", lpDIDevCaps
->dwPOVs
);
154 if (lpDIDevCaps
->dwSize
> sizeof(DIDEVCAPS_DX3
)) {
155 TRACE("dwFFSamplePeriod: %d\n", lpDIDevCaps
->dwFFSamplePeriod
);
156 TRACE("dwFFMinTimeResolution: %d\n", lpDIDevCaps
->dwFFMinTimeResolution
);
157 TRACE("dwFirmwareRevision: %d\n", lpDIDevCaps
->dwFirmwareRevision
);
158 TRACE("dwHardwareRevision: %d\n", lpDIDevCaps
->dwHardwareRevision
);
159 TRACE("dwFFDriverVersion: %d\n", lpDIDevCaps
->dwFFDriverVersion
);
163 HRESULT WINAPI
JoystickWGenericImpl_GetCapabilities(LPDIRECTINPUTDEVICE8W iface
, LPDIDEVCAPS lpDIDevCaps
)
165 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8W(iface
);
168 TRACE("%p->(%p)\n",iface
,lpDIDevCaps
);
170 if (lpDIDevCaps
== NULL
) {
171 WARN("invalid pointer\n");
175 size
= lpDIDevCaps
->dwSize
;
177 if (!(size
== sizeof(DIDEVCAPS
) || size
== sizeof(DIDEVCAPS_DX3
))) {
178 WARN("invalid parameter\n");
179 return DIERR_INVALIDPARAM
;
182 CopyMemory(lpDIDevCaps
, &This
->devcaps
, size
);
183 lpDIDevCaps
->dwSize
= size
;
185 if (TRACE_ON(dinput
))
186 _dump_DIDEVCAPS(lpDIDevCaps
);
191 HRESULT WINAPI
JoystickAGenericImpl_GetCapabilities(LPDIRECTINPUTDEVICE8A iface
, LPDIDEVCAPS lpDIDevCaps
)
193 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8A(iface
);
194 return JoystickWGenericImpl_GetCapabilities(IDirectInputDevice8W_from_impl(This
), lpDIDevCaps
);
197 /******************************************************************************
198 * GetObjectInfo : get object info
200 HRESULT WINAPI
JoystickWGenericImpl_GetObjectInfo(LPDIRECTINPUTDEVICE8W iface
,
201 LPDIDEVICEOBJECTINSTANCEW pdidoi
, DWORD dwObj
, DWORD dwHow
)
203 static const WCHAR axisW
[] = {'A','x','i','s',' ','%','d',0};
204 static const WCHAR povW
[] = {'P','O','V',' ','%','d',0};
205 static const WCHAR buttonW
[] = {'B','u','t','t','o','n',' ','%','d',0};
208 res
= IDirectInputDevice2WImpl_GetObjectInfo(iface
, pdidoi
, dwObj
, dwHow
);
209 if (res
!= DI_OK
) return res
;
211 if (pdidoi
->dwType
& DIDFT_AXIS
)
212 sprintfW(pdidoi
->tszName
, axisW
, DIDFT_GETINSTANCE(pdidoi
->dwType
));
213 else if (pdidoi
->dwType
& DIDFT_POV
)
214 sprintfW(pdidoi
->tszName
, povW
, DIDFT_GETINSTANCE(pdidoi
->dwType
));
215 else if (pdidoi
->dwType
& DIDFT_BUTTON
)
216 sprintfW(pdidoi
->tszName
, buttonW
, DIDFT_GETINSTANCE(pdidoi
->dwType
));
218 _dump_OBJECTINSTANCEW(pdidoi
);
222 HRESULT WINAPI
JoystickAGenericImpl_GetObjectInfo(LPDIRECTINPUTDEVICE8A iface
,
223 LPDIDEVICEOBJECTINSTANCEA pdidoi
, DWORD dwObj
, DWORD dwHow
)
225 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8A(iface
);
227 DIDEVICEOBJECTINSTANCEW didoiW
;
228 DWORD dwSize
= pdidoi
->dwSize
;
230 didoiW
.dwSize
= sizeof(didoiW
);
231 res
= JoystickWGenericImpl_GetObjectInfo(IDirectInputDevice8W_from_impl(This
), &didoiW
, dwObj
, dwHow
);
232 if (res
!= DI_OK
) return res
;
234 memset(pdidoi
, 0, pdidoi
->dwSize
);
235 memcpy(pdidoi
, &didoiW
, FIELD_OFFSET(DIDEVICEOBJECTINSTANCEW
, tszName
));
236 pdidoi
->dwSize
= dwSize
;
237 WideCharToMultiByte(CP_ACP
, 0, didoiW
.tszName
, -1, pdidoi
->tszName
,
238 sizeof(pdidoi
->tszName
), NULL
, NULL
);
243 /******************************************************************************
244 * GetProperty : get input device properties
246 HRESULT WINAPI
JoystickWGenericImpl_GetProperty(LPDIRECTINPUTDEVICE8W iface
, REFGUID rguid
, LPDIPROPHEADER pdiph
)
248 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8W(iface
);
250 TRACE("(%p,%s,%p)\n", iface
, debugstr_guid(rguid
), pdiph
);
252 if (TRACE_ON(dinput
))
253 _dump_DIPROPHEADER(pdiph
);
255 if (IS_DIPROP(rguid
)) {
256 switch (LOWORD(rguid
)) {
257 case (DWORD_PTR
) DIPROP_RANGE
: {
258 LPDIPROPRANGE pr
= (LPDIPROPRANGE
)pdiph
;
259 int obj
= find_property(&This
->base
.data_format
, pdiph
);
261 /* The app is querying the current range of the axis
262 * return the lMin and lMax values */
264 pr
->lMin
= This
->props
[obj
].lMin
;
265 pr
->lMax
= This
->props
[obj
].lMax
;
266 TRACE("range(%d, %d) obj=%d\n", pr
->lMin
, pr
->lMax
, obj
);
271 case (DWORD_PTR
) DIPROP_DEADZONE
: {
272 LPDIPROPDWORD pd
= (LPDIPROPDWORD
)pdiph
;
273 int obj
= find_property(&This
->base
.data_format
, pdiph
);
276 pd
->dwData
= This
->props
[obj
].lDeadZone
;
277 TRACE("deadzone(%d) obj=%d\n", pd
->dwData
, obj
);
282 case (DWORD_PTR
) DIPROP_SATURATION
: {
283 LPDIPROPDWORD pd
= (LPDIPROPDWORD
)pdiph
;
284 int obj
= find_property(&This
->base
.data_format
, pdiph
);
287 pd
->dwData
= This
->props
[obj
].lSaturation
;
288 TRACE("saturation(%d) obj=%d\n", pd
->dwData
, obj
);
294 return IDirectInputDevice2WImpl_GetProperty(iface
, rguid
, pdiph
);
301 HRESULT WINAPI
JoystickAGenericImpl_GetProperty(LPDIRECTINPUTDEVICE8A iface
, REFGUID rguid
, LPDIPROPHEADER pdiph
)
303 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8A(iface
);
304 return JoystickWGenericImpl_GetProperty(IDirectInputDevice8W_from_impl(This
), rguid
, pdiph
);
307 /******************************************************************************
308 * GetDeviceInfo : get information about a device's identity
310 HRESULT WINAPI
JoystickAGenericImpl_GetDeviceInfo(
311 LPDIRECTINPUTDEVICE8A iface
,
312 LPDIDEVICEINSTANCEA pdidi
)
314 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8A(iface
);
316 TRACE("(%p,%p)\n", iface
, pdidi
);
319 WARN("invalid pointer\n");
323 if ((pdidi
->dwSize
!= sizeof(DIDEVICEINSTANCE_DX3A
)) &&
324 (pdidi
->dwSize
!= sizeof(DIDEVICEINSTANCEA
))) {
325 WARN("invalid parameter: pdidi->dwSize = %d\n", pdidi
->dwSize
);
326 return DIERR_INVALIDPARAM
;
329 /* Return joystick */
330 pdidi
->guidInstance
= This
->guidInstance
;
331 pdidi
->guidProduct
= This
->guidProduct
;
332 /* we only support traditional joysticks for now */
333 pdidi
->dwDevType
= This
->devcaps
.dwDevType
;
334 strcpy(pdidi
->tszInstanceName
, "Joystick");
335 strcpy(pdidi
->tszProductName
, This
->name
);
336 if (pdidi
->dwSize
> sizeof(DIDEVICEINSTANCE_DX3A
)) {
337 pdidi
->guidFFDriver
= GUID_NULL
;
338 pdidi
->wUsagePage
= 0;
345 /******************************************************************************
346 * GetDeviceInfo : get information about a device's identity
348 HRESULT WINAPI
JoystickWGenericImpl_GetDeviceInfo(
349 LPDIRECTINPUTDEVICE8W iface
,
350 LPDIDEVICEINSTANCEW pdidi
)
352 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8W(iface
);
354 TRACE("(%p,%p)\n", iface
, pdidi
);
356 if ((pdidi
->dwSize
!= sizeof(DIDEVICEINSTANCE_DX3W
)) &&
357 (pdidi
->dwSize
!= sizeof(DIDEVICEINSTANCEW
))) {
358 WARN("invalid parameter: pdidi->dwSize = %d\n", pdidi
->dwSize
);
359 return DIERR_INVALIDPARAM
;
362 /* Return joystick */
363 pdidi
->guidInstance
= This
->guidInstance
;
364 pdidi
->guidProduct
= This
->guidProduct
;
365 /* we only support traditional joysticks for now */
366 pdidi
->dwDevType
= This
->devcaps
.dwDevType
;
367 MultiByteToWideChar(CP_ACP
, 0, "Joystick", -1, pdidi
->tszInstanceName
, MAX_PATH
);
368 MultiByteToWideChar(CP_ACP
, 0, This
->name
, -1, pdidi
->tszProductName
, MAX_PATH
);
369 if (pdidi
->dwSize
> sizeof(DIDEVICEINSTANCE_DX3W
)) {
370 pdidi
->guidFFDriver
= GUID_NULL
;
371 pdidi
->wUsagePage
= 0;
378 HRESULT WINAPI
JoystickWGenericImpl_Poll(LPDIRECTINPUTDEVICE8W iface
)
380 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8W(iface
);
382 TRACE("(%p)\n",This
);
384 if (!This
->base
.acquired
) {
385 WARN("not acquired\n");
386 return DIERR_NOTACQUIRED
;
389 This
->joy_polldev(IDirectInputDevice8A_from_impl(This
));
393 HRESULT WINAPI
JoystickAGenericImpl_Poll(LPDIRECTINPUTDEVICE8A iface
)
395 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8A(iface
);
396 return JoystickWGenericImpl_Poll(IDirectInputDevice8W_from_impl(This
));
399 /******************************************************************************
400 * GetDeviceState : returns the "state" of the joystick.
403 HRESULT WINAPI
JoystickWGenericImpl_GetDeviceState(LPDIRECTINPUTDEVICE8W iface
, DWORD len
, LPVOID ptr
)
405 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8W(iface
);
407 TRACE("(%p,0x%08x,%p)\n", This
, len
, ptr
);
409 if (!This
->base
.acquired
) {
410 WARN("not acquired\n");
411 return DIERR_NOTACQUIRED
;
414 /* update joystick state */
415 This
->joy_polldev(IDirectInputDevice8A_from_impl(This
));
417 /* convert and copy data to user supplied buffer */
418 fill_DataFormat(ptr
, len
, &This
->js
, &This
->base
.data_format
);
423 HRESULT WINAPI
JoystickAGenericImpl_GetDeviceState(LPDIRECTINPUTDEVICE8A iface
, DWORD len
, LPVOID ptr
)
425 JoystickGenericImpl
*This
= impl_from_IDirectInputDevice8A(iface
);
426 return JoystickWGenericImpl_GetDeviceState(IDirectInputDevice8W_from_impl(This
), len
, ptr
);
430 * This maps the read value (from the input event) to a value in the
433 * Dead zone is in % multiplied by a 100 (range 0..10000)
435 LONG
joystick_map_axis(ObjProps
*props
, int val
)
438 LONG dead_zone
= MulDiv( props
->lDeadZone
, props
->lDevMax
- props
->lDevMin
, 10000 );
439 LONG dev_range
= props
->lDevMax
- props
->lDevMin
- dead_zone
;
442 val
-= (props
->lDevMin
+ props
->lDevMax
) / 2;
444 /* Remove dead zone */
445 if (abs( val
) <= dead_zone
/ 2)
448 val
= val
< 0 ? val
+ dead_zone
/ 2 : val
- dead_zone
/ 2;
450 /* Scale and map the value from the device range into the required range */
451 ret
= MulDiv( val
, props
->lMax
- props
->lMin
, dev_range
) +
452 (props
->lMin
+ props
->lMax
) / 2;
454 /* Clamp in case or rounding errors */
455 if (ret
> props
->lMax
) ret
= props
->lMax
;
456 else if (ret
< props
->lMin
) ret
= props
->lMin
;
458 TRACE( "(%d <%d> %d) -> (%d <%d> %d): val=%d ret=%d\n",
459 props
->lDevMin
, dead_zone
, props
->lDevMax
,
460 props
->lMin
, props
->lDeadZone
, props
->lMax
,
467 * Maps POV x & y event values to a DX "clock" position:
474 DWORD
joystick_map_pov(const POINTL
*p
)
477 return p
->y
< 0 ? 4500 : !p
->y
? 9000 : 13500;
479 return p
->y
< 0 ? 31500 : !p
->y
? 27000 : 22500;
481 return p
->y
< 0 ? 0 : !p
->y
? -1 : 18000;
485 * Setup the dinput options.
488 HRESULT
setup_dinput_options(JoystickGenericImpl
*This
, const int *default_axis_map
)
490 char buffer
[MAX_PATH
+16];
496 get_app_key(&hkey
, &appkey
);
500 if (!get_config_key(hkey
, appkey
, "DefaultDeadZone", buffer
, sizeof(buffer
)))
502 This
->deadzone
= atoi(buffer
);
503 TRACE("setting default deadzone to: \"%s\" %d\n", buffer
, This
->deadzone
);
506 This
->axis_map
= HeapAlloc(GetProcessHeap(), 0, This
->device_axis_count
* sizeof(int));
507 if (!This
->axis_map
) return DIERR_OUTOFMEMORY
;
509 if (!get_config_key(hkey
, appkey
, This
->name
, buffer
, sizeof(buffer
)))
511 static const char *axis_names
[] = {"X", "Y", "Z", "Rx", "Ry", "Rz",
512 "Slider1", "Slider2",
513 "POV1", "POV2", "POV3", "POV4"};
514 const char *delim
= ",";
516 TRACE("\"%s\" = \"%s\"\n", This
->name
, buffer
);
518 if ((ptr
= strtok(buffer
, delim
)) != NULL
)
524 for (i
= 0; i
< sizeof(axis_names
) / sizeof(axis_names
[0]); i
++)
526 if (!strcmp(ptr
, axis_names
[i
]))
528 if (!strncmp(ptr
, "POV", 3))
532 WARN("Only 4 POVs supported - ignoring extra\n");
537 /* Pov takes two axes */
538 This
->axis_map
[tokens
++] = i
;
546 FIXME("Only 8 Axes supported - ignoring extra\n");
556 if (i
== sizeof(axis_names
) / sizeof(axis_names
[0]))
558 ERR("invalid joystick axis type: \"%s\"\n", ptr
);
562 This
->axis_map
[tokens
] = i
;
564 } while ((ptr
= strtok(NULL
, delim
)) != NULL
);
566 if (tokens
!= This
->device_axis_count
)
568 ERR("not all joystick axes mapped: %d axes(%d,%d), %d arguments\n",
569 This
->device_axis_count
, axis
, pov
, tokens
);
570 while (tokens
< This
->device_axis_count
)
572 This
->axis_map
[tokens
] = -1;
582 if (default_axis_map
)
584 /* Use default mapping from the driver */
585 for (i
= 0; i
< This
->device_axis_count
; i
++)
587 This
->axis_map
[i
] = default_axis_map
[i
];
588 tokens
= default_axis_map
[i
];
593 else if (tokens
< 15)
597 This
->axis_map
[i
] = default_axis_map
[i
];
603 /* No config - set default mapping. */
604 for (i
= 0; i
< This
->device_axis_count
; i
++)
607 This
->axis_map
[i
] = axis
++;
610 This
->axis_map
[i
++] = 8 + pov
;
611 This
->axis_map
[i
] = 8 + pov
++;
614 This
->axis_map
[i
] = -1;
618 This
->devcaps
.dwAxes
= axis
;
619 This
->devcaps
.dwPOVs
= pov
;
621 if (appkey
) RegCloseKey(appkey
);
622 if (hkey
) RegCloseKey(hkey
);